GSoC 2017 Project Summary: Glutton improvements, the new “all eating honeypot”

Student Mohammad Bilal contributed this post as a project summary of his GSoC2017 experience. 

Merged Pull Requests

1- Connection Timeout Added

Issues Resolved: #72#59
Description Glutton support number of services (protocol handlers) so each service mean number of connection on that service. So It crash after some time with error: [user.tcp] accept tcp [::]:5000: accept4: too many open files, and this error was due to the allowance of limited number of open file descriptors by the operating system. There was no deadline set for opened connections so most of the connections never get closed. In result, the number of opened connections gradually cross the maximum open file descriptors limit and cause panic. So I added connection timeout = 72 second, number of opened connection will never reach the open file descriptor limit. Another reason was Freki; Glutton useses freki as a networking core so freki handler crashes because of improper error handling in Glutton. So I improved error handling of protocol handlers and glutton stops crashing.

2- Logrus Replaced with ZAP

Issues Resolved: #66
Description
Logrus replaced with zap because of the performance and effecient of structured logging zap. In this enhancement following magor improvements were made:

  • Bumped up to Freki V2
    Previously Glutton logging depends upon Freki because freki initializes logger and return to Glutton. In latest version Freki provide access to its logger module beyond API boundaries so now glutton have own logger.
  • Improved Error Formatting
    Proper format for errors logging is now used by all modules of the system.

3- Context Implementation

Issues Resolved: #75#82
Description Following Packages are added:

  • ContextGlutton spawn a lot of go-routines so it was becoming challenging to keep go-routines in the application context, and because go-routines are not covered by garbage collector. So I used context package for having more control on go-routines so now glutton closes all go-routines gracefully on shutdown signal. Now its easier to pass values (flags) to any level in the application context hierarchy because it also support for carrying values and provide abstraction.
  • Docopt
    Docopt is used for automatically parsing flags for command line interface.

Pull Request submitted for review

1- Enhancement Plus TCP Proxy

Issues Resolved: #85
Description
TCP Proxy is added. TCP Proxy was used from freki so it was a kind of dependency, we cannot add glutton formatted logging or for any enhancement it required us to make a PR to Freki. Another factor, freki open a separate port for TCP Proxy but we can have this with conn_handler so tcp proxy is now a handler just like others, no need open other port.
Furthermore documentation examples for using glutton as SSH Proxy and TCP Proxy are added. Some code refactoring is done for removing some confusing configurations.

Closed Pull Requests

1- HTTP Proxy Added

Description
I got success with HTTP MITM but couldn't bring HTTPS MITM in work. In meantime we found some enhancement issues with existing modules like: no event based logging in SSH MITM and no examples/docs for existing proxies. So I closed this PR and saved it into TODO list.

On Going Development

1- SSH Proxy Enhancement

Description
Right now I am working on enhancement of SSH MITM. It logs every thing going between attacker and SSH Server but logs are not in consumable format. I am trying to add event based logging. So first I refactored code and writing it by following Decorator Design Pattern so that in future it support dependencies injection.

Others

I tried to integrate container spawning feature on base of new connection but I couldn't due to limited documentation of Docker Client Moby and different version of docker client used in Freki. So I discussed this issue with Freki author and also opened an issue and so in response he updated Freki existing docker client (deprecated) to Moby Docker and he is planning for Freki further enhancement.