diff options
author | Toni Uhlig <matzeton@googlemail.com> | 2021-03-24 14:35:54 +0100 |
---|---|---|
committer | Toni Uhlig <matzeton@googlemail.com> | 2021-03-24 14:44:27 +0100 |
commit | ef4a22ffac7b9dfd95e836e9c8152310365fec32 (patch) | |
tree | 2d0f002cc8d52d65eaf3b2a8f8049bb72da4547a /examples | |
parent | 1ab6b9e042060fab28be84f72af6df655d933f1d (diff) |
Updated README.md
* added examples/README.md and schema/README.md
Signed-off-by: Toni Uhlig <matzeton@googlemail.com>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..676e9a9d2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,43 @@ +# examples + +Some ready-2-use/ready-2-extend examples/utils. +All examples are prefixed with their used LANG. + +## c-captured + +A capture daemon suitable for low-resource devices. +It saves flows that were guessed/undetected/risky/midstream to a PCAP file for manual analysis. +Basicially a combination of `py-flow-undetected-to-pcap` and `py-risky-flow-to-pcap`. + +## c-collectd + +A collecd-exec compatible middleware that gathers statistic values from nDPId. + +## c-json-stdout + +Tiny nDPId json dumper. Does not provide any useful funcationality besides dumping parsed JSON objects. + +## go-dashboard + +A discontinued tty/ncurses nDPId dashboard. I've figured out that Go + NCurses is a bad idea. + +## py-flow-info + +Prints prettyfied information about flow events. + +## py-flow-undetected-to-pcap + +Captures and saves undetected flows to a PCAP file. + +## py-json-stdout + +Dump received and parsed JSON strings. + +## py-risky-flow-to-pcap + +Captures and saves risky flows to a PCAP file. + +## py-schema-validation + +Validate nDPId JSON strings against pre-defined JSON schema's. +See `schema/`. |