Skip to content

Commit 2302ec5

Browse files
authored
fix typos in function name, error messages, comments (#4154)
1 parent e3ac79c commit 2302ec5

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ _CrowdSec is an open-source and participative security solution offering crowdso
2727

2828
[CrowdSec Security Engine](https://doc.crowdsec.net/docs/next/intro/) is an all-in-one [IDS/IPS](https://doc.crowdsec.net/docs/next/log_processor/intro) and [WAF](https://doc.crowdsec.net/docs/next/appsec/intro).
2929

30-
It detects bad behaviors by analyzing log sources and HTTP requests, and allows active remedation thanks to the [Remediation Components](https://doc.crowdsec.net/u/bouncers/intro).
30+
It detects bad behaviors by analyzing log sources and HTTP requests, and allows active remediation thanks to the [Remediation Components](https://doc.crowdsec.net/u/bouncers/intro).
3131

3232
[Detection rules are available on our hub](https://hub.crowdsec.net) under MIT license.
3333

3434
### CrowdSec Community Blocklist
3535

3636
<a href="https://doc.crowdsec.net/docs/next/central_api/community_blocklist">
3737

38-
The "Community Blocklist" is a curated list of IP addresses identified as malicious by CrowdSec. The Security Engine proactively block the IP addresses of this blocklist, preventing malevolent IPs from reaching your systems.
38+
The "Community Blocklist" is a curated list of IP addresses identified as malicious by CrowdSec. The Security Engine proactively blocks the IP addresses of this blocklist, preventing malevolent IPs from reaching your systems.
3939

4040
[![CrowdSec Community Blocklist](https://doc.crowdsec.net/assets/images/data_insights-1e7678f47cb672122cc847d068b6eadf.png)](https://doc.crowdsec.net/docs/next/central_api/community_blocklist)
4141

@@ -52,7 +52,7 @@ The "Community Blocklist" is a curated list of IP addresses identified as malici
5252

5353
## Outnumbering hackers all together
5454

55-
By sharing the threat they faced, all users are protecting each-others (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyze logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
55+
By sharing the threat they faced, all users are protecting each other (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyze logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
5656

5757
CrowdSec ships by default with scenarios (brute force, port scan, web scan, etc.) adapted for most contexts, but you can easily extend it by picking more of them from the **[HUB](https://hub.crowdsec.net)**. It is also easy to adapt an existing one or create one yourself.
5858

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ This security policy applies to :
77
- Crowdsec Local API
88
- Crowdsec bouncers **developed and maintained** by the Crowdsec team [1]
99

10-
Reports regarding developements of community members that are not part of the crowdsecurity organization will be thoroughly investigated nonetheless.
10+
Reports regarding developments of community members that are not part of the crowdsecurity organization will be thoroughly investigated nonetheless.
1111

12-
[1] Projects developed and maintained by the Crowdsec team are under the **crowdsecurity** github organization. Bouncers developed by community members that are not part of the Crowdsec organization are explictely excluded.
12+
[1] Projects developed and maintained by the Crowdsec team are under the **crowdsecurity** github organization. Bouncers developed by community members that are not part of the Crowdsec organization are explicitly excluded.
1313

1414
## Reporting a Vulnerability
1515

cmd/crowdsec-cli/clinotifications/notifications.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ func (cli *cliNotifications) getPluginConfigs() (map[string]csplugin.PluginConfi
110110
}
111111

112112
if err := filepath.Walk(cfg.ConfigPaths.NotificationDir, wf); err != nil {
113-
return nil, fmt.Errorf("while loading notifification plugin configuration: %w", err)
113+
return nil, fmt.Errorf("while loading notification plugin configuration: %w", err)
114114
}
115115

116116
return pcfgs, nil

pkg/acquisition/acquisition.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,7 @@ func StartAcquisition(ctx context.Context, sources []DataSource, output chan pip
589589
}
590590

591591
for i := range sources {
592-
subsrc := sources[i] // ensure its a copy
592+
subsrc := sources[i] // ensure it's a copy
593593
log.Debugf("starting one source %d/%d ->> %T", i, len(sources), subsrc)
594594

595595
acquisTomb.Go(func() error {
@@ -616,7 +616,7 @@ func StartAcquisition(ctx context.Context, sources []DataSource, output chan pip
616616
}
617617

618618
if err := acquireSource(ctx, subsrc, subsrc.GetName(), output, acquisTomb); err != nil {
619-
// if one of the acqusition returns an error, we kill the others to properly shutdown
619+
// if one of the acquisitions returns an error, we kill the others to properly shutdown
620620
acquisTomb.Kill(err)
621621
}
622622

pkg/acquisition/modules/s3/run.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727
)
2828

2929
// For some reason, the aws sdk doesn't have a struct for this
30-
// The one aws-lamdbda-go/events is only intended when using S3 Notification without event bridge
30+
// The one aws-lambda-go/events is only intended when using S3 Notification without event bridge
3131
type S3Event struct {
3232
Version string `json:"version"`
3333
Id string `json:"id"`

pkg/csplugin/utils_windows.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ func CheckPerms(path string) error {
155155
return nil
156156
}
157157

158-
func getProcessAtr() (*syscall.SysProcAttr, error) {
158+
func getProcessAttr() (*syscall.SysProcAttr, error) {
159159
var procToken, token windows.Token
160160

161161
proc := windows.CurrentProcess()
@@ -209,7 +209,7 @@ func getProcessAtr() (*syscall.SysProcAttr, error) {
209209
func (*PluginBroker) CreateCmd(ctx context.Context, binaryPath string) (*exec.Cmd, error) {
210210
var err error
211211
cmd := exec.CommandContext(ctx, binaryPath)
212-
cmd.SysProcAttr, err = getProcessAtr()
212+
cmd.SysProcAttr, err = getProcessAttr()
213213
if err != nil {
214214
return nil, fmt.Errorf("while getting process attributes: %w", err)
215215
}

pkg/metrics/acquisition_cloudwatch.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const CloudWatchDatasourceLinesReadMetricName = "cs_cloudwatch_stream_hits_total
2121
var CloudWatchDatasourceLinesRead = prometheus.NewCounterVec(
2222
prometheus.CounterOpts{
2323
Name: CloudWatchDatasourceLinesReadMetricName,
24-
Help: "Number of event read from stream.",
24+
Help: "Number of events read from stream.",
2525
},
2626
[]string{"group", "stream", "datasource_type", "acquis_type"},
2727
)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ const KinesisDataSourceLinesReadMetricName = "cs_kinesis_stream_hits_total"
1111
var KinesisDataSourceLinesRead = prometheus.NewCounterVec(
1212
prometheus.CounterOpts{
1313
Name: KinesisDataSourceLinesReadMetricName,
14-
Help: "Number of event read per stream.",
14+
Help: "Number of events read per stream.",
1515
},
1616
[]string{"stream", "datasource_type", "acquis_type"},
1717
)
@@ -21,7 +21,7 @@ const KinesisDataSourceLinesReadShardsMetricName = "cs_kinesis_shards_hits_total
2121
var KinesisDataSourceLinesReadShards = prometheus.NewCounterVec(
2222
prometheus.CounterOpts{
2323
Name: KinesisDataSourceLinesReadShardsMetricName,
24-
Help: "Number of event read per shards.",
24+
Help: "Number of events read per shard.",
2525
},
2626
[]string{"stream", "shard"},
2727
)

test/bats/crowdsec-acquisition.bats

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ teardown() {
2424

2525
#----------
2626

27-
@test "malformed acqusition file" {
27+
@test "malformed acquisition file" {
2828
cat >"$ACQUIS_DIR/file.yaml" <<-EOT
2929
filename:
3030
- /path/to/file.log
@@ -36,14 +36,14 @@ teardown() {
3636
assert_stderr --partial "crowdsec init: while loading acquisition config: configuring datasource of type file from $ACQUIS_DIR/file.yaml (position 0): cannot parse FileAcquisition configuration: [2:1] cannot unmarshal []interface {} into Go struct field Configuration.Filename of type string"
3737
}
3838

39-
@test "empty acqusition file" {
39+
@test "empty acquisition file" {
4040
cat >"$ACQUIS_DIR/file.yaml" <<-EOT
4141
EOT
4242

4343
rune -0 "$CROWDSEC" -t
4444
}
4545

46-
@test "malformed acqusition file (missing keys)" {
46+
@test "malformed acquisition file (missing keys)" {
4747
cat >"$ACQUIS_DIR/file.yaml" <<-EOT
4848
labels:
4949
type: syslog
@@ -53,7 +53,7 @@ teardown() {
5353
assert_stderr --partial "crowdsec init: while loading acquisition config: missing 'source' field in $ACQUIS_DIR/file.yaml (position 0)"
5454
}
5555

56-
@test "malformed acqusition file (duplicate key)" {
56+
@test "malformed acquisition file (duplicate key)" {
5757
cat >"$ACQUIS_DIR/file.yaml" <<-EOT
5858
filename:
5959
- /path/to/file.log

test/localstack/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services:
1212
environment:
1313
AWS_HOST: localstack
1414
DEBUG: ""
15-
KINESYS_ERROR_PROBABILITY: ""
15+
KINESIS_ERROR_PROBABILITY: ""
1616
LOCALSTACK_HOST: "localstack"
1717
AWS_REGION: "us-east-1"
1818

0 commit comments

Comments
 (0)