Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
basht0p authored Aug 20, 2024
1 parent 390b317 commit 2ffe0f8
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
![alt text](chickadee_mini_lazer.png)


Chickadee is a tiny network scan detector written in Go, designed to run as a service, or interactively, on Windows systems.
Chickadee is a tiny network scan detector & alerter, written in Go, designed to run as a service or interactively, on Windows systems.

It features the ability to send alerts via SMTP. Additionally, it also logs to the Windows Application Event Log, so if you're using a collector for a SIEM on that endpoint, you can monitor the below event IDs and create alerts based on them.
It features the ability to send alerts via SMTP, Webhook, or SNMP Trap. Additionally, it also logs to the Windows Application Event Log, so if you're using a collector for a SIEM on that endpoint, you can monitor the below event IDs and create alerts based on them.

<table>
<thead>
Expand Down Expand Up @@ -57,17 +57,15 @@ The configuration file for chickadee can be located at:

Any changes in this document require the service `chickadee` to be restarted.

In the config, you can edit detection parameters, the endpoint's friendly name to include with alerts, SMTP Auth/TLS settings, and SMTP recipients. Currently, SMTP only supports a single recipient; this will be changing soon.
In the config, you can edit detection parameters, the endpoint's friendly name to include with alerts, SMTP settings, SNMP settings, and webhook endpoints. Currently, SMTP only supports a single recipient; this will be changing soon.

## Coming Soon

Some features that are planned to be added:

- SNMP Trap Alerting
- Webhook Alerting
- Configurable Whitelisted IPs
- More alert details
- More alert details w/ historics

## Contribute

If you like this software, and you can program in Go, feel free to fork this repo and make a PR. I'm new to Go so I'm sure there are a lot of rookie mistake I've made.
If you like this software, and you can program in Go, feel free to fork this repo and make a PR. I'm new to Go so I'm sure there are a lot of rookie mistake I've made. There are definitely a lot of places I could be using GoRoutines and pointers.

0 comments on commit 2ffe0f8

Please sign in to comment.