1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
# Go CrowdSec Bouncer
`go-cs-bouncer` is a golang easy library to use to create golang CrowdSec bouncer.
## Installation
To install `go-cs-bouncer` package, you need to install Go and set your Go workspace first.
1. You can use the below Go command to install `go-cs-bouncer`:
```sh
$ go get -u github.com/crowdsecurity/go-cs-bouncer
```
2. Import it in your code:
```go
import "github.com/crowdsecurity/go-cs-bouncer"
```
## Quick Start
### Streaming Bouncer
```sh
# assume the following codes in main.go file
$ cat main.go
```
```go
package main
import (
"fmt"
"log"
csbouncer "github.com/crowdsecurity/go-cs-bouncer"
)
func main() {
bouncer := &csbouncer.StreamBouncer{
APIKey: "<API_TOKEN>",
APIUrl: "http://localhost:8080/",
TickerInterval: "20s",
}
if err := bouncer.Init(); err != nil {
log.Fatalf(err.Error())
}
go bouncer.Run()
for streamDecision := range bouncer.Stream {
for _, decision := range streamDecision.Deleted {
fmt.Printf("expired decisions: IP: %s | Scenario: %s | Duration: %s | Scope : %v\n", *decision.Value, *decision.Scenario, *decision.Duration, *decision.Scope)
}
for _, decision := range streamDecision.New {
fmt.Printf("new decisions: IP: %s | Scenario: %s | Duration: %s | Scope : %v\n", *decision.Value, *decision.Scenario, *decision.Duration, *decision.Scope)
}
}
}
```
```sh
# run main.go
$ go run main.go
```
### Live Bouncer
```sh
# assume the following codes in main.go file
$ cat main.go
```
```go
package main
import (
"fmt"
"log"
csbouncer "github.com/crowdsecurity/go-cs-bouncer"
)
func main() {
bouncer := &csbouncer.LiveBouncer{
APIKey: "<API_TOKEN>",
APIUrl: "http://localhost:8080/",
}
if err := bouncer.Init(); err != nil {
log.Fatalf(err.Error())
}
ipToQuery := "1.2.3.4"
response, err := bouncer.Get(ipToQuery)
if err != nil {
log.Fatalf("unable to get decision for ip '%s' : '%s'", ipToQuery, err)
}
if len(*response) == 0 {
log.Printf("no decision for '%s'", ipToQuery)
}
for _, decision := range *response {
fmt.Printf("decisions: IP: %s | Scenario: %s | Duration: %s | Scope : %v\n", *decision.Value, *decision.Scenario, *decision.Duration, *decision.Scope)
}
}
```
```sh
# run main.go
$ go run main.go
```
## Decision object
The decision objet correspond to the following structure:
```go
type Decision struct {
// duration
Duration *string `json:"duration"`
EndIP int64 `json:"end_ip,omitempty"`
ID int64 `json:"id,omitempty"`
// the origin of the decision : cscli, crowdsec
Origin *string `json:"origin"`
// scenario
Scenario *string `json:"scenario"`
// the scope of decision : does it apply to an IP, a range, a username, etc
Scope *string `json:"scope"`
StartIP int64 `json:"start_ip,omitempty"`
// the type of decision, might be 'ban', 'captcha' or something custom. Ignored when watcher (cscli/crowdsec) is pushing to APIL.
Type *string `json:"type"`
// the value of the decision scope : an IP, a range, a username, etc
Value *string `json:"value"`
}
```
|
