garin

README

Garin

Out of band HTTP and HTTPS destination decoding

This is a work in progress

Configuration

The configuration is located in /etc/garin.conf. Should you need to specify an alternate location, use the -c flag when launcing garin.

Logging

The logs will be sent to your operating system syslog service so make sure one is available.

The log level of the application is configurable in the configuration file via general.log-level

Basic optimization

The following will guide you through the basic parameters that will help you optimize your installation in depending on your available hardware.

First, general.parsing-concurrency should be set to the amount of CPUs you have if you are using a dedicated machine for this. Otherwise, gauge appropriately so this doesn't consume all your available CPU.

Then, you can be more aggressive into flushing the packets from stale connections via general.flush-after. This will help reduce the RAM usage but may make shuffle packets in case of a slow connection between a device and a remote server. By default it is set to 20 seconds (20s), it can be safely set to 5 seconds (5s).

Throughput

Environment:

• Tests made on Intel(R) Core(TM) i5-4670K CPU @ 3.40GHz
• Tests are parsing parsing HTTP packets on port 80 and HTTPS packets on port 443
• PCAP file contained 791615 packets total - accounting for 355417784 bytes
• 411194 packets were on port 80 and 443 - accounting for 264590701 bytes
• A pcap filter was used as an argument to the sniffer to reduce reconstructing useless packets.
• 4 concurrent parsing threads
• Databases, when used are hosted on the same machine as the processor using the default configuration

Parsing PPS (logged to file - not persisted to a database):

• Command : garin -connection-max-buffer 5 -parsing-concurrency 4 -o samples/bigFlows.pcap -dont-record-destinations
• Timing: 1.631s
• Pure HTTP - HTTPS parsing: 252111 PPS - 1297 Mbits/s
• Network parsing: 485355 PPS - 1743 Mbits/s

Parsing + Persisting PPS (SQLite3)

• Command : garin -connection-max-buffer 5 -parsing-concurrency 4 -o samples/bigFlows.pcap
• Timing: 42.169
• Pure HTTP - HTTPS parsing: 9751 PPS - 50 Mbits/s
• Network parsing: 18772 PPS - 67 Mbits/s
• As seen above, persisting in the SQLite3 backend is far from being performant and becomes the central bottleneck of the application. This should not be used other than for testing.

Parsing + Persisting PPS (MySQL)

• Command : garin -connection-max-buffer 5 -parsing-concurrency 4 -o samples/bigFlows.pcap
• Timing: 13.108
• Pure HTTP - HTTPS parsing: 31369 PPS - 161 Mbits/s
• Network parsing: 60391 PPS - 216 Mbits/s

Parsing + Persisting PPS (MongoDB)

• Command : garin -connection-max-buffer 5 -parsing-concurrency 4 -o samples/bigFlows.pcap
• Timing: 1.842
• Pure HTTP - HTTPS parsing: 223232 PPS - 1149 Mbits/s
• Network parsing: 429758 PPS - 1543 Mbits/s
• Given the nature of MongoDB and its fire and forget insertion, this seems to be the best candidate for fast insertion and is easily scalable. For this reason, it is the recommended choice when dealing with a large volume of traffic (> 1Gbit/s)

Licence

GPL