Skip to content

A tiny Go-powered package for detecting malicious network scans. Configurable alerting for SMTP, SNMP, Webhook, and Winlog.

Notifications You must be signed in to change notification settings

basht0p/Chickadee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Chickadee

alt text

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, 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.

Event ID Description
500 Application Crash
501 Starting Service
502 Stopping Service
503 Generic Warning
510 Generic Info
511 Detector Initiated
515 Network Scan Detected

Installation

On 64-bit Windows systems, just run the latest installer from the Releases tab of this repository

Configuration

The configuration file for chickadee can be located at:

C:\Program Files\Chickadee\config.ini

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 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:

  • Configurable Whitelisted IPs
  • 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. There are definitely a lot of places I could be using GoRoutines and pointers.