123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221 |
- package apiserver
- import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "net"
- "net/http"
- "net/url"
- "os"
- "reflect"
- "sync"
- "testing"
- "time"
- "github.com/jarcoal/httpmock"
- "github.com/sirupsen/logrus"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- "gopkg.in/tomb.v2"
- "github.com/crowdsecurity/go-cs-lib/pkg/cstest"
- "github.com/crowdsecurity/go-cs-lib/pkg/ptr"
- "github.com/crowdsecurity/go-cs-lib/pkg/version"
- "github.com/crowdsecurity/crowdsec/pkg/apiclient"
- "github.com/crowdsecurity/crowdsec/pkg/csconfig"
- "github.com/crowdsecurity/crowdsec/pkg/database"
- "github.com/crowdsecurity/crowdsec/pkg/database/ent/decision"
- "github.com/crowdsecurity/crowdsec/pkg/database/ent/machine"
- "github.com/crowdsecurity/crowdsec/pkg/models"
- "github.com/crowdsecurity/crowdsec/pkg/modelscapi"
- "github.com/crowdsecurity/crowdsec/pkg/types"
- )
- func getDBClient(t *testing.T) *database.Client {
- t.Helper()
- dbPath, err := os.CreateTemp("", "*sqlite")
- require.NoError(t, err)
- dbClient, err := database.NewClient(&csconfig.DatabaseCfg{
- Type: "sqlite",
- DbName: "crowdsec",
- DbPath: dbPath.Name(),
- })
- require.NoError(t, err)
- return dbClient
- }
- func getAPIC(t *testing.T) *apic {
- t.Helper()
- dbClient := getDBClient(t)
- return &apic{
- AlertsAddChan: make(chan []*models.Alert),
- //DecisionDeleteChan: make(chan []*models.Decision),
- dbClient: dbClient,
- mu: sync.Mutex{},
- startup: true,
- pullTomb: tomb.Tomb{},
- pushTomb: tomb.Tomb{},
- metricsTomb: tomb.Tomb{},
- scenarioList: make([]string, 0),
- consoleConfig: &csconfig.ConsoleConfig{
- ShareManualDecisions: ptr.Of(false),
- ShareTaintedScenarios: ptr.Of(false),
- ShareCustomScenarios: ptr.Of(false),
- ShareContext: ptr.Of(false),
- },
- isPulling: make(chan bool, 1),
- }
- }
- func absDiff(a int, b int) (c int) {
- if c = a - b; c < 0 {
- return -1 * c
- }
- return c
- }
- func assertTotalDecisionCount(t *testing.T, dbClient *database.Client, count int) {
- d := dbClient.Ent.Decision.Query().AllX(context.Background())
- assert.Len(t, d, count)
- }
- func assertTotalValidDecisionCount(t *testing.T, dbClient *database.Client, count int) {
- d := dbClient.Ent.Decision.Query().Where(
- decision.UntilGT(time.Now()),
- ).AllX(context.Background())
- assert.Len(t, d, count)
- }
- func jsonMarshalX(v interface{}) []byte {
- data, err := json.Marshal(v)
- if err != nil {
- panic(err)
- }
- return data
- }
- func assertTotalAlertCount(t *testing.T, dbClient *database.Client, count int) {
- d := dbClient.Ent.Alert.Query().AllX(context.Background())
- assert.Len(t, d, count)
- }
- func TestAPICCAPIPullIsOld(t *testing.T) {
- api := getAPIC(t)
- isOld, err := api.CAPIPullIsOld()
- require.NoError(t, err)
- assert.True(t, isOld)
- decision := api.dbClient.Ent.Decision.Create().
- SetUntil(time.Now().Add(time.Hour)).
- SetScenario("crowdsec/test").
- SetType("IP").
- SetScope("Country").
- SetValue("Blah").
- SetOrigin(types.CAPIOrigin).
- SaveX(context.Background())
- api.dbClient.Ent.Alert.Create().
- SetCreatedAt(time.Now()).
- SetScenario("crowdsec/test").
- AddDecisions(
- decision,
- ).
- SaveX(context.Background())
- isOld, err = api.CAPIPullIsOld()
- require.NoError(t, err)
- assert.False(t, isOld)
- }
- func TestAPICFetchScenariosListFromDB(t *testing.T) {
- tests := []struct {
- name string
- machineIDsWithScenarios map[string]string
- expectedScenarios []string
- }{
- {
- name: "Simple one machine with two scenarios",
- machineIDsWithScenarios: map[string]string{
- "a": "crowdsecurity/http-bf,crowdsecurity/ssh-bf",
- },
- expectedScenarios: []string{"crowdsecurity/ssh-bf", "crowdsecurity/http-bf"},
- },
- {
- name: "Multi machine with custom+hub scenarios",
- machineIDsWithScenarios: map[string]string{
- "a": "crowdsecurity/http-bf,crowdsecurity/ssh-bf,my_scenario",
- "b": "crowdsecurity/http-bf,crowdsecurity/ssh-bf,foo_scenario",
- },
- expectedScenarios: []string{"crowdsecurity/ssh-bf", "crowdsecurity/http-bf", "my_scenario", "foo_scenario"},
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- api := getAPIC(t)
- for machineID, scenarios := range tc.machineIDsWithScenarios {
- api.dbClient.Ent.Machine.Create().
- SetMachineId(machineID).
- SetPassword(testPassword.String()).
- SetIpAddress("1.2.3.4").
- SetScenarios(scenarios).
- ExecX(context.Background())
- }
- scenarios, err := api.FetchScenariosListFromDB()
- for machineID := range tc.machineIDsWithScenarios {
- api.dbClient.Ent.Machine.Delete().Where(machine.MachineIdEQ(machineID)).ExecX(context.Background())
- }
- require.NoError(t, err)
- assert.ElementsMatch(t, tc.expectedScenarios, scenarios)
- })
- }
- }
- func TestNewAPIC(t *testing.T) {
- var testConfig *csconfig.OnlineApiClientCfg
- setConfig := func() {
- testConfig = &csconfig.OnlineApiClientCfg{
- Credentials: &csconfig.ApiCredentialsCfg{
- URL: "http://foobar/",
- Login: "foo",
- Password: "bar",
- },
- }
- }
- type args struct {
- dbClient *database.Client
- consoleConfig *csconfig.ConsoleConfig
- }
- tests := []struct {
- name string
- args args
- expectedErr string
- action func()
- }{
- {
- name: "simple",
- action: func() {},
- args: args{
- dbClient: getDBClient(t),
- consoleConfig: LoadTestConfig(t).API.Server.ConsoleConfig,
- },
- },
- {
- name: "error in parsing URL",
- action: func() { testConfig.Credentials.URL = "foobar http://" },
- args: args{
- dbClient: getDBClient(t),
- consoleConfig: LoadTestConfig(t).API.Server.ConsoleConfig,
- },
- expectedErr: "first path segment in URL cannot contain colon",
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- setConfig()
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- httpmock.RegisterResponder("POST", "http://foobar/v3/watchers/login", httpmock.NewBytesResponder(
- 200, jsonMarshalX(
- models.WatcherAuthResponse{
- Code: 200,
- Expire: "2023-01-12T22:51:43Z",
- Token: "MyToken",
- },
- ),
- ))
- tc.action()
- _, err := NewAPIC(testConfig, tc.args.dbClient, tc.args.consoleConfig, nil)
- cstest.RequireErrorContains(t, err, tc.expectedErr)
- })
- }
- }
- func TestAPICHandleDeletedDecisions(t *testing.T) {
- api := getAPIC(t)
- _, deleteCounters := makeAddAndDeleteCounters()
- decision1 := api.dbClient.Ent.Decision.Create().
- SetUntil(time.Now().Add(time.Hour)).
- SetScenario("crowdsec/test").
- SetType("ban").
- SetScope("IP").
- SetValue("1.2.3.4").
- SetOrigin(types.CAPIOrigin).
- SaveX(context.Background())
- api.dbClient.Ent.Decision.Create().
- SetUntil(time.Now().Add(time.Hour)).
- SetScenario("crowdsec/test").
- SetType("ban").
- SetScope("IP").
- SetValue("1.2.3.4").
- SetOrigin(types.CAPIOrigin).
- SaveX(context.Background())
- assertTotalDecisionCount(t, api.dbClient, 2)
- nbDeleted, err := api.HandleDeletedDecisions([]*models.Decision{{
- Value: ptr.Of("1.2.3.4"),
- Origin: ptr.Of(types.CAPIOrigin),
- Type: &decision1.Type,
- Scenario: ptr.Of("crowdsec/test"),
- Scope: ptr.Of("IP"),
- }}, deleteCounters)
- assert.NoError(t, err)
- assert.Equal(t, 2, nbDeleted)
- assert.Equal(t, 2, deleteCounters[types.CAPIOrigin]["all"])
- }
- func TestAPICGetMetrics(t *testing.T) {
- cleanUp := func(api *apic) {
- api.dbClient.Ent.Bouncer.Delete().ExecX(context.Background())
- api.dbClient.Ent.Machine.Delete().ExecX(context.Background())
- }
- tests := []struct {
- name string
- machineIDs []string
- bouncers []string
- expectedMetric *models.Metrics
- }{
- {
- name: "no bouncers nor machines should still have bouncers/machines keys in output",
- machineIDs: []string{},
- bouncers: []string{},
- expectedMetric: &models.Metrics{
- ApilVersion: ptr.Of(version.String()),
- Bouncers: []*models.MetricsBouncerInfo{},
- Machines: []*models.MetricsAgentInfo{},
- },
- },
- {
- name: "simple",
- machineIDs: []string{"a", "b", "c"},
- bouncers: []string{"1", "2", "3"},
- expectedMetric: &models.Metrics{
- ApilVersion: ptr.Of(version.String()),
- Bouncers: []*models.MetricsBouncerInfo{
- {
- CustomName: "1",
- LastPull: time.Time{}.String(),
- }, {
- CustomName: "2",
- LastPull: time.Time{}.String(),
- }, {
- CustomName: "3",
- LastPull: time.Time{}.String(),
- },
- },
- Machines: []*models.MetricsAgentInfo{
- {
- Name: "a",
- LastPush: time.Time{}.String(),
- LastUpdate: time.Time{}.String(),
- },
- {
- Name: "b",
- LastPush: time.Time{}.String(),
- LastUpdate: time.Time{}.String(),
- },
- {
- Name: "c",
- LastPush: time.Time{}.String(),
- LastUpdate: time.Time{}.String(),
- },
- },
- },
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- apiClient := getAPIC(t)
- cleanUp(apiClient)
- for i, machineID := range tc.machineIDs {
- apiClient.dbClient.Ent.Machine.Create().
- SetMachineId(machineID).
- SetPassword(testPassword.String()).
- SetIpAddress(fmt.Sprintf("1.2.3.%d", i)).
- SetScenarios("crowdsecurity/test").
- SetLastPush(time.Time{}).
- SetUpdatedAt(time.Time{}).
- ExecX(context.Background())
- }
- for i, bouncerName := range tc.bouncers {
- apiClient.dbClient.Ent.Bouncer.Create().
- SetIPAddress(fmt.Sprintf("1.2.3.%d", i)).
- SetName(bouncerName).
- SetAPIKey("foobar").
- SetRevoked(false).
- SetLastPull(time.Time{}).
- ExecX(context.Background())
- }
- foundMetrics, err := apiClient.GetMetrics()
- require.NoError(t, err)
- assert.Equal(t, tc.expectedMetric.Bouncers, foundMetrics.Bouncers)
- assert.Equal(t, tc.expectedMetric.Machines, foundMetrics.Machines)
- })
- }
- }
- func TestCreateAlertsForDecision(t *testing.T) {
- httpBfDecisionList := &models.Decision{
- Origin: ptr.Of(types.ListOrigin),
- Scenario: ptr.Of("crowdsecurity/http-bf"),
- }
- sshBfDecisionList := &models.Decision{
- Origin: ptr.Of(types.ListOrigin),
- Scenario: ptr.Of("crowdsecurity/ssh-bf"),
- }
- httpBfDecisionCommunity := &models.Decision{
- Origin: ptr.Of(types.CAPIOrigin),
- Scenario: ptr.Of("crowdsecurity/http-bf"),
- }
- sshBfDecisionCommunity := &models.Decision{
- Origin: ptr.Of(types.CAPIOrigin),
- Scenario: ptr.Of("crowdsecurity/ssh-bf"),
- }
- type args struct {
- decisions []*models.Decision
- }
- tests := []struct {
- name string
- args args
- want []*models.Alert
- }{
- {
- name: "2 decisions CAPI List Decisions should create 2 alerts",
- args: args{
- decisions: []*models.Decision{
- httpBfDecisionList,
- sshBfDecisionList,
- },
- },
- want: []*models.Alert{
- createAlertForDecision(httpBfDecisionList),
- createAlertForDecision(sshBfDecisionList),
- },
- },
- {
- name: "2 decisions CAPI List same scenario decisions should create 1 alert",
- args: args{
- decisions: []*models.Decision{
- httpBfDecisionList,
- httpBfDecisionList,
- },
- },
- want: []*models.Alert{
- createAlertForDecision(httpBfDecisionList),
- },
- },
- {
- name: "5 decisions from community list should create 1 alert",
- args: args{
- decisions: []*models.Decision{
- httpBfDecisionCommunity,
- httpBfDecisionCommunity,
- sshBfDecisionCommunity,
- sshBfDecisionCommunity,
- sshBfDecisionCommunity,
- },
- },
- want: []*models.Alert{
- createAlertForDecision(sshBfDecisionCommunity),
- },
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- if got := createAlertsForDecisions(tc.args.decisions); !reflect.DeepEqual(got, tc.want) {
- t.Errorf("createAlertsForDecisions() = %v, want %v", got, tc.want)
- }
- })
- }
- }
- func TestFillAlertsWithDecisions(t *testing.T) {
- httpBfDecisionCommunity := &models.Decision{
- Origin: ptr.Of(types.CAPIOrigin),
- Scenario: ptr.Of("crowdsecurity/http-bf"),
- Scope: ptr.Of("ip"),
- }
- sshBfDecisionCommunity := &models.Decision{
- Origin: ptr.Of(types.CAPIOrigin),
- Scenario: ptr.Of("crowdsecurity/ssh-bf"),
- Scope: ptr.Of("ip"),
- }
- httpBfDecisionList := &models.Decision{
- Origin: ptr.Of(types.ListOrigin),
- Scenario: ptr.Of("crowdsecurity/http-bf"),
- Scope: ptr.Of("ip"),
- }
- sshBfDecisionList := &models.Decision{
- Origin: ptr.Of(types.ListOrigin),
- Scenario: ptr.Of("crowdsecurity/ssh-bf"),
- Scope: ptr.Of("ip"),
- }
- type args struct {
- alerts []*models.Alert
- decisions []*models.Decision
- }
- tests := []struct {
- name string
- args args
- want []*models.Alert
- }{
- {
- name: "1 CAPI alert should pair up with n CAPI decisions",
- args: args{
- alerts: []*models.Alert{createAlertForDecision(httpBfDecisionCommunity)},
- decisions: []*models.Decision{httpBfDecisionCommunity, sshBfDecisionCommunity, sshBfDecisionCommunity, httpBfDecisionCommunity},
- },
- want: []*models.Alert{
- func() *models.Alert {
- a := createAlertForDecision(httpBfDecisionCommunity)
- a.Decisions = []*models.Decision{httpBfDecisionCommunity, sshBfDecisionCommunity, sshBfDecisionCommunity, httpBfDecisionCommunity}
- return a
- }(),
- },
- },
- {
- name: "List alert should pair up only with decisions having same scenario",
- args: args{
- alerts: []*models.Alert{createAlertForDecision(httpBfDecisionList), createAlertForDecision(sshBfDecisionList)},
- decisions: []*models.Decision{httpBfDecisionList, httpBfDecisionList, sshBfDecisionList, sshBfDecisionList},
- },
- want: []*models.Alert{
- func() *models.Alert {
- a := createAlertForDecision(httpBfDecisionList)
- a.Decisions = []*models.Decision{httpBfDecisionList, httpBfDecisionList}
- return a
- }(),
- func() *models.Alert {
- a := createAlertForDecision(sshBfDecisionList)
- a.Decisions = []*models.Decision{sshBfDecisionList, sshBfDecisionList}
- return a
- }(),
- },
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- addCounters, _ := makeAddAndDeleteCounters()
- if got := fillAlertsWithDecisions(tc.args.alerts, tc.args.decisions, addCounters); !reflect.DeepEqual(got, tc.want) {
- t.Errorf("fillAlertsWithDecisions() = %v, want %v", got, tc.want)
- }
- })
- }
- }
- func TestAPICWhitelists(t *testing.T) {
- api := getAPIC(t)
- //one whitelist on IP, one on CIDR
- api.whitelists = &csconfig.CapiWhitelist{}
- ipwl1 := "9.2.3.4"
- ip := net.ParseIP(ipwl1)
- api.whitelists.Ips = append(api.whitelists.Ips, ip)
- ipwl1 = "7.2.3.4"
- ip = net.ParseIP(ipwl1)
- api.whitelists.Ips = append(api.whitelists.Ips, ip)
- cidrwl1 := "13.2.3.0/24"
- _, tnet, err := net.ParseCIDR(cidrwl1)
- if err != nil {
- t.Fatalf("unable to parse cidr : %s", err)
- }
- api.whitelists.Cidrs = append(api.whitelists.Cidrs, tnet)
- cidrwl1 = "11.2.3.0/24"
- _, tnet, err = net.ParseCIDR(cidrwl1)
- if err != nil {
- t.Fatalf("unable to parse cidr : %s", err)
- }
- api.whitelists.Cidrs = append(api.whitelists.Cidrs, tnet)
- api.dbClient.Ent.Decision.Create().
- SetOrigin(types.CAPIOrigin).
- SetType("ban").
- SetValue("9.9.9.9").
- SetScope("Ip").
- SetScenario("crowdsecurity/ssh-bf").
- SetUntil(time.Now().Add(time.Hour)).
- ExecX(context.Background())
- assertTotalDecisionCount(t, api.dbClient, 1)
- assertTotalValidDecisionCount(t, api.dbClient, 1)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/api/decisions/stream", httpmock.NewBytesResponder(
- 200, jsonMarshalX(
- modelscapi.GetDecisionsStreamResponse{
- Deleted: modelscapi.GetDecisionsStreamResponseDeleted{
- &modelscapi.GetDecisionsStreamResponseDeletedItem{
- Decisions: []string{
- "9.9.9.9", // This is already present in DB
- "9.1.9.9", // This not present in DB
- },
- Scope: ptr.Of("Ip"),
- }, // This is already present in DB
- },
- New: modelscapi.GetDecisionsStreamResponseNew{
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("13.2.3.4"), //wl by cidr
- Duration: ptr.Of("24h"),
- },
- },
- },
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("2.2.3.4"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test2"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("13.2.3.5"), //wl by cidr
- Duration: ptr.Of("24h"),
- },
- },
- }, // These two are from community list.
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("6.2.3.4"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("9.2.3.4"), //wl by ip
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- Links: &modelscapi.GetDecisionsStreamResponseLinks{
- Blocklists: []*modelscapi.BlocklistLink{
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist1"),
- Name: ptr.Of("blocklist1"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist2"),
- Name: ptr.Of("blocklist2"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- ),
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist1", httpmock.NewStringResponder(
- 200, "1.2.3.6",
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist2", httpmock.NewStringResponder(
- 200, "1.2.3.7",
- ))
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- err = api.PullTop(false)
- require.NoError(t, err)
- assertTotalDecisionCount(t, api.dbClient, 5) //2 from FIRE + 2 from bl + 1 existing
- assertTotalValidDecisionCount(t, api.dbClient, 4)
- assertTotalAlertCount(t, api.dbClient, 3) // 2 for list sub , 1 for community list.
- alerts := api.dbClient.Ent.Alert.Query().AllX(context.Background())
- validDecisions := api.dbClient.Ent.Decision.Query().Where(
- decision.UntilGT(time.Now())).
- AllX(context.Background())
- decisionScenarioFreq := make(map[string]int)
- decisionIp := make(map[string]int)
- alertScenario := make(map[string]int)
- for _, alert := range alerts {
- alertScenario[alert.SourceScope]++
- }
- assert.Equal(t, 3, len(alertScenario))
- assert.Equal(t, 1, alertScenario[SCOPE_CAPI_ALIAS_ALIAS])
- assert.Equal(t, 1, alertScenario["lists:blocklist1"])
- assert.Equal(t, 1, alertScenario["lists:blocklist2"])
- for _, decisions := range validDecisions {
- decisionScenarioFreq[decisions.Scenario]++
- decisionIp[decisions.Value]++
- }
- assert.Equal(t, 1, decisionIp["2.2.3.4"], 1)
- assert.Equal(t, 1, decisionIp["6.2.3.4"], 1)
- if _, ok := decisionIp["13.2.3.4"]; ok {
- t.Errorf("13.2.3.4 is whitelisted")
- }
- if _, ok := decisionIp["13.2.3.5"]; ok {
- t.Errorf("13.2.3.5 is whitelisted")
- }
- if _, ok := decisionIp["9.2.3.4"]; ok {
- t.Errorf("9.2.3.4 is whitelisted")
- }
- assert.Equal(t, 1, decisionScenarioFreq["blocklist1"], 1)
- assert.Equal(t, 1, decisionScenarioFreq["blocklist2"], 1)
- assert.Equal(t, 2, decisionScenarioFreq["crowdsecurity/test1"], 2)
- }
- func TestAPICPullTop(t *testing.T) {
- api := getAPIC(t)
- api.dbClient.Ent.Decision.Create().
- SetOrigin(types.CAPIOrigin).
- SetType("ban").
- SetValue("9.9.9.9").
- SetScope("Ip").
- SetScenario("crowdsecurity/ssh-bf").
- SetUntil(time.Now().Add(time.Hour)).
- ExecX(context.Background())
- assertTotalDecisionCount(t, api.dbClient, 1)
- assertTotalValidDecisionCount(t, api.dbClient, 1)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/api/decisions/stream", httpmock.NewBytesResponder(
- 200, jsonMarshalX(
- modelscapi.GetDecisionsStreamResponse{
- Deleted: modelscapi.GetDecisionsStreamResponseDeleted{
- &modelscapi.GetDecisionsStreamResponseDeletedItem{
- Decisions: []string{
- "9.9.9.9", // This is already present in DB
- "9.1.9.9", // This not present in DB
- },
- Scope: ptr.Of("Ip"),
- }, // This is already present in DB
- },
- New: modelscapi.GetDecisionsStreamResponseNew{
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("1.2.3.4"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test2"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("1.2.3.5"),
- Duration: ptr.Of("24h"),
- },
- },
- }, // These two are from community list.
- },
- Links: &modelscapi.GetDecisionsStreamResponseLinks{
- Blocklists: []*modelscapi.BlocklistLink{
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist1"),
- Name: ptr.Of("blocklist1"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist2"),
- Name: ptr.Of("blocklist2"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- ),
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist1", httpmock.NewStringResponder(
- 200, "1.2.3.6",
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist2", httpmock.NewStringResponder(
- 200, "1.2.3.7",
- ))
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- err = api.PullTop(false)
- require.NoError(t, err)
- assertTotalDecisionCount(t, api.dbClient, 5)
- assertTotalValidDecisionCount(t, api.dbClient, 4)
- assertTotalAlertCount(t, api.dbClient, 3) // 2 for list sub , 1 for community list.
- alerts := api.dbClient.Ent.Alert.Query().AllX(context.Background())
- validDecisions := api.dbClient.Ent.Decision.Query().Where(
- decision.UntilGT(time.Now())).
- AllX(context.Background())
- decisionScenarioFreq := make(map[string]int)
- alertScenario := make(map[string]int)
- for _, alert := range alerts {
- alertScenario[alert.SourceScope]++
- }
- assert.Equal(t, 3, len(alertScenario))
- assert.Equal(t, 1, alertScenario[SCOPE_CAPI_ALIAS_ALIAS])
- assert.Equal(t, 1, alertScenario["lists:blocklist1"])
- assert.Equal(t, 1, alertScenario["lists:blocklist2"])
- for _, decisions := range validDecisions {
- decisionScenarioFreq[decisions.Scenario]++
- }
- assert.Equal(t, 1, decisionScenarioFreq["blocklist1"], 1)
- assert.Equal(t, 1, decisionScenarioFreq["blocklist2"], 1)
- assert.Equal(t, 1, decisionScenarioFreq["crowdsecurity/test1"], 1)
- assert.Equal(t, 1, decisionScenarioFreq["crowdsecurity/test2"], 1)
- }
- func TestAPICPullTopBLCacheFirstCall(t *testing.T) {
- // no decision in db, no last modified parameter.
- api := getAPIC(t)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/api/decisions/stream", httpmock.NewBytesResponder(
- 200, jsonMarshalX(
- modelscapi.GetDecisionsStreamResponse{
- New: modelscapi.GetDecisionsStreamResponseNew{
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("1.2.3.4"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- Links: &modelscapi.GetDecisionsStreamResponseLinks{
- Blocklists: []*modelscapi.BlocklistLink{
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist1"),
- Name: ptr.Of("blocklist1"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- ),
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist1", func(req *http.Request) (*http.Response, error) {
- assert.Equal(t, "", req.Header.Get("If-Modified-Since"))
- return httpmock.NewStringResponse(200, "1.2.3.4"), nil
- })
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- err = api.PullTop(false)
- require.NoError(t, err)
- blocklistConfigItemName := "blocklist:blocklist1:last_pull"
- lastPullTimestamp, err := api.dbClient.GetConfigItem(blocklistConfigItemName)
- require.NoError(t, err)
- assert.NotEqual(t, "", *lastPullTimestamp)
- // new call should return 304 and should not change lastPullTimestamp
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist1", func(req *http.Request) (*http.Response, error) {
- assert.NotEqual(t, "", req.Header.Get("If-Modified-Since"))
- return httpmock.NewStringResponse(304, ""), nil
- })
- err = api.PullTop(false)
- require.NoError(t, err)
- secondLastPullTimestamp, err := api.dbClient.GetConfigItem(blocklistConfigItemName)
- require.NoError(t, err)
- assert.Equal(t, *lastPullTimestamp, *secondLastPullTimestamp)
- }
- func TestAPICPullTopBLCacheForceCall(t *testing.T) {
- api := getAPIC(t)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- // create a decision about to expire. It should force fetch
- alertInstance := api.dbClient.Ent.Alert.
- Create().
- SetScenario("update list").
- SetSourceScope("list:blocklist1").
- SetSourceValue("list:blocklist1").
- SaveX(context.Background())
- api.dbClient.Ent.Decision.Create().
- SetOrigin(types.ListOrigin).
- SetType("ban").
- SetValue("9.9.9.9").
- SetScope("Ip").
- SetScenario("blocklist1").
- SetUntil(time.Now().Add(time.Hour)).
- SetOwnerID(alertInstance.ID).
- ExecX(context.Background())
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/api/decisions/stream", httpmock.NewBytesResponder(
- 200, jsonMarshalX(
- modelscapi.GetDecisionsStreamResponse{
- New: modelscapi.GetDecisionsStreamResponseNew{
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/test1"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("1.2.3.4"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- Links: &modelscapi.GetDecisionsStreamResponseLinks{
- Blocklists: []*modelscapi.BlocklistLink{
- {
- URL: ptr.Of("http://api.crowdsec.net/blocklist1"),
- Name: ptr.Of("blocklist1"),
- Scope: ptr.Of("Ip"),
- Remediation: ptr.Of("ban"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- ),
- ))
- httpmock.RegisterResponder("GET", "http://api.crowdsec.net/blocklist1", func(req *http.Request) (*http.Response, error) {
- assert.Equal(t, "", req.Header.Get("If-Modified-Since"))
- return httpmock.NewStringResponse(304, ""), nil
- })
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- err = api.PullTop(false)
- require.NoError(t, err)
- }
- func TestAPICPush(t *testing.T) {
- tests := []struct {
- name string
- alerts []*models.Alert
- expectedCalls int
- }{
- {
- name: "simple single alert",
- alerts: []*models.Alert{
- {
- Scenario: ptr.Of("crowdsec/test"),
- ScenarioHash: ptr.Of("certified"),
- ScenarioVersion: ptr.Of("v1.0"),
- Simulated: ptr.Of(false),
- Source: &models.Source{},
- },
- },
- expectedCalls: 1,
- },
- {
- name: "simulated alert is not pushed",
- alerts: []*models.Alert{
- {
- Scenario: ptr.Of("crowdsec/test"),
- ScenarioHash: ptr.Of("certified"),
- ScenarioVersion: ptr.Of("v1.0"),
- Simulated: ptr.Of(true),
- Source: &models.Source{},
- },
- },
- expectedCalls: 0,
- },
- {
- name: "1 request per 50 alerts",
- expectedCalls: 2,
- alerts: func() []*models.Alert {
- alerts := make([]*models.Alert, 100)
- for i := 0; i < 100; i++ {
- alerts[i] = &models.Alert{
- Scenario: ptr.Of("crowdsec/test"),
- ScenarioHash: ptr.Of("certified"),
- ScenarioVersion: ptr.Of("v1.0"),
- Simulated: ptr.Of(false),
- Source: &models.Source{},
- }
- }
- return alerts
- }(),
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- api := getAPIC(t)
- api.pushInterval = time.Millisecond
- api.pushIntervalFirst = time.Millisecond
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- httpmock.RegisterResponder("POST", "http://api.crowdsec.net/api/signals", httpmock.NewBytesResponder(200, []byte{}))
- go func() {
- api.AlertsAddChan <- tc.alerts
- time.Sleep(time.Second)
- api.Shutdown()
- }()
- err = api.Push()
- require.NoError(t, err)
- assert.Equal(t, tc.expectedCalls, httpmock.GetTotalCallCount())
- })
- }
- }
- func TestAPICPull(t *testing.T) {
- api := getAPIC(t)
- tests := []struct {
- name string
- setUp func()
- expectedDecisionCount int
- logContains string
- }{
- {
- name: "test pull if no scenarios are present",
- setUp: func() {},
- logContains: "scenario list is empty, will not pull yet",
- },
- {
- name: "test pull",
- setUp: func() {
- api.dbClient.Ent.Machine.Create().
- SetMachineId("1.2.3.4").
- SetPassword(testPassword.String()).
- SetIpAddress("1.2.3.4").
- SetScenarios("crowdsecurity/ssh-bf").
- ExecX(context.Background())
- },
- expectedDecisionCount: 1,
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- api = getAPIC(t)
- api.pullInterval = time.Millisecond
- api.pullIntervalFirst = time.Millisecond
- url, err := url.ParseRequestURI("http://api.crowdsec.net/")
- require.NoError(t, err)
- httpmock.Activate()
- defer httpmock.DeactivateAndReset()
- apic, err := apiclient.NewDefaultClient(
- url,
- "/api",
- fmt.Sprintf("crowdsec/%s", version.String()),
- nil,
- )
- require.NoError(t, err)
- api.apiClient = apic
- httpmock.RegisterNoResponder(httpmock.NewBytesResponder(200, jsonMarshalX(
- modelscapi.GetDecisionsStreamResponse{
- New: modelscapi.GetDecisionsStreamResponseNew{
- &modelscapi.GetDecisionsStreamResponseNewItem{
- Scenario: ptr.Of("crowdsecurity/ssh-bf"),
- Scope: ptr.Of("Ip"),
- Decisions: []*modelscapi.GetDecisionsStreamResponseNewItemDecisionsItems0{
- {
- Value: ptr.Of("1.2.3.5"),
- Duration: ptr.Of("24h"),
- },
- },
- },
- },
- },
- )))
- tc.setUp()
- var buf bytes.Buffer
- go func() {
- logrus.SetOutput(&buf)
- if err := api.Pull(); err != nil {
- panic(err)
- }
- }()
- //Slightly long because the CI runner for windows are slow, and this can lead to random failure
- time.Sleep(time.Millisecond * 500)
- logrus.SetOutput(os.Stderr)
- assert.Contains(t, buf.String(), tc.logContains)
- assertTotalDecisionCount(t, api.dbClient, tc.expectedDecisionCount)
- })
- }
- }
- func TestShouldShareAlert(t *testing.T) {
- tests := []struct {
- name string
- consoleConfig *csconfig.ConsoleConfig
- alert *models.Alert
- expectedRet bool
- expectedTrust string
- }{
- {
- name: "custom alert should be shared if config enables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareCustomScenarios: ptr.Of(true),
- },
- alert: &models.Alert{Simulated: ptr.Of(false)},
- expectedRet: true,
- expectedTrust: "custom",
- },
- {
- name: "custom alert should not be shared if config disables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareCustomScenarios: ptr.Of(false),
- },
- alert: &models.Alert{Simulated: ptr.Of(false)},
- expectedRet: false,
- expectedTrust: "custom",
- },
- {
- name: "manual alert should be shared if config enables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareManualDecisions: ptr.Of(true),
- },
- alert: &models.Alert{
- Simulated: ptr.Of(false),
- Decisions: []*models.Decision{{Origin: ptr.Of(types.CscliOrigin)}},
- },
- expectedRet: true,
- expectedTrust: "manual",
- },
- {
- name: "manual alert should not be shared if config disables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareManualDecisions: ptr.Of(false),
- },
- alert: &models.Alert{
- Simulated: ptr.Of(false),
- Decisions: []*models.Decision{{Origin: ptr.Of(types.CscliOrigin)}},
- },
- expectedRet: false,
- expectedTrust: "manual",
- },
- {
- name: "manual alert should be shared if config enables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareTaintedScenarios: ptr.Of(true),
- },
- alert: &models.Alert{
- Simulated: ptr.Of(false),
- ScenarioHash: ptr.Of("whateverHash"),
- },
- expectedRet: true,
- expectedTrust: "tainted",
- },
- {
- name: "manual alert should not be shared if config disables it",
- consoleConfig: &csconfig.ConsoleConfig{
- ShareTaintedScenarios: ptr.Of(false),
- },
- alert: &models.Alert{
- Simulated: ptr.Of(false),
- ScenarioHash: ptr.Of("whateverHash"),
- },
- expectedRet: false,
- expectedTrust: "tainted",
- },
- }
- for _, tc := range tests {
- tc := tc
- t.Run(tc.name, func(t *testing.T) {
- ret := shouldShareAlert(tc.alert, tc.consoleConfig)
- assert.Equal(t, tc.expectedRet, ret)
- })
- }
- }
|