Skip to content

Commit

Permalink
Extend README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kloyan committed Jan 2, 2023
1 parent 8da2030 commit 45cc8ab
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Canary FSWatcher

Canary FSWatcher is a CLI tool which monitors a file or directory and fires a [canarytokens.org](https://canarytokens.org/generate) URL webhook whenever the target is accessed.
Canary FSWatcher is a CLI tool which monitors a file or directory and fires a [canarytokens.org](https://canarytokens.org/generate) URL webhook whenever the target is accessed. The main use case is to quickly discover that a server has been breached. Create a [honeypot file](https://en.wikipedia.org/wiki/Honeypot_(computing)), put it into an easy to find location and monitor its access via this tool.

## Why?

Expand All @@ -17,6 +17,8 @@ X-Canary-Path-Name: /tmp/my-dir/my-file
X-Canary-Path-Op: WRITE
```

As noted in the [canaryfy](https://github.com/thinkst/canaryfy) it's good idea to move the binary of an unexpected location. This would make it harder to detect by an untrusted party :)

## Usage

```
Expand Down

0 comments on commit 45cc8ab

Please sign in to comment.