Metadata-Version: 1.0
Name: Heralding
Version: 0.2.0
Summary: Credentials catching honeypot.
Home-page: https://github.com/johnnykv/heralding
Author: Johnny Vestergaard
Author-email: jkv@unixcluster.dk
License: GPL 3
Description: Heralding |travis badge| |landscape badge| |version badge|
        =======================
        
        .. |travis badge| image:: https://img.shields.io/travis/johnnykv/heralding/master.svg
           :target: https://travis-ci.org/johnnykv/heralding
        .. |landscape badge| image:: https://landscape.io/github/johnnykv/heralding/master/landscape.png
           :target: https://landscape.io/github/johnnykv/heralding/
           :alt: Code Health
        .. |version badge| image:: https://img.shields.io/pypi/v/heralding.svg
           :target: https://pypi.python.org/pypi/Heralding/
        
        About
        -----
        
        Sometimes you just want a simple honeypot that collects credentials, nothing more. Heralding is that honeypot!
        Currently the following protocols are supported: ftp, telnet, ssh, http, https, pop3, pop3s, imap, imaps and smtp.
        
        Starting the honeypot
        -----------------------
        
        .. code-block:: shell
        
          $ sudo heralding
          2017-05-14 21:55:55,948 (root) Initializing Heralding version 0.1.17
          2017-05-14 21:55:55,968 (root) Using default config file: "/home/kajoj/heralding/bin/heralding/heralding.yml", if you want to customize values please copy this file to the current working directory
          2017-05-14 21:55:55,998 (heralding.reporting.file_logger) File logger started, using file: heralding_activity.log
          2017-05-14 21:55:55,999 (heralding.honeypot) Started Telnet capability listening on port 23
          2017-05-14 21:55:55,999 (heralding.honeypot) Started Http capability listening on port 80
          2017-05-14 21:55:55,999 (heralding.honeypot) Started Pop3 capability listening on port 110
          2017-05-14 21:55:56,000 (heralding.honeypot) Started https capability listening on port 443
          2017-05-14 21:55:56,000 (heralding.honeypot) Started Imap capability listening on port 143
          2017-05-14 21:55:56,000 (heralding.honeypot) Started ftp capability listening on port 21
          2017-05-14 21:55:56,000 (heralding.honeypot) Started Imaps capability listening on port 993
          2017-05-14 21:55:56,001 (heralding.honeypot) Started Pop3S capability listening on port 995
          2017-05-14 21:55:56,116 (heralding.honeypot) Started SSH capability listening on port 22
          2017-05-14 21:55:56,117 (heralding.honeypot) Started smtp capability listening on port 25
          2017-05-14 21:55:56,118 (root) Privileges dropped, running as nobody/nogroup.
        
        Viewing the collected data
        --------------------------
        
        .. code-block:: shell
        
          $ tail -f heralding_activity.log
          timestamp,auth_id,auth_type,session_id,source_ip,source_port,destination_port,protocol,username,password
          2016-03-12 20:35:02.258198,192.168.2.129,51551,23,telnet,bond,james
          2016-03-12 20:35:09.658593,192.168.2.129,51551,23,telnet,clark,P@SSw0rd123
          2016-03-18 19:31:38.064700,192.168.2.129,53416,22,ssh,NOP_Manden,M@MS3
          2016-03-18 19:31:38.521047,192.168.2.129,53416,22,ssh,guest,guest
          2016-03-18 19:31:39.376768,192.168.2.129,53416,22,ssh,HundeMad,katNIPkat
          2016-03-18 19:33:07.064504,192.168.2.129,53431,110,pop3,charles,N00P1SH
          2016-03-18 19:33:12.504483,192.168.2.129,53431,110,pop3,NektarManden,mANDENnEktar
          2016-03-18 19:33:24.952645,192.168.2.129,53433,21,ftp,Jamie,brainfreeze
          2016-03-18 19:33:47.008562,192.168.2.129,53436,21,ftp,NektarKongen,SuperS@cretP4ssw0rd1
          2016-03-18 19:36:56.077840,192.168.2.129,53445,21,ftp,Joooop,Pooop
        
        
        Installing Heralding
        ---------------------
        
        To install the latest stable (well, semi-stable) version, use pip:
        
        .. code-block:: shell
        
          pip install heralding
        
        Make sure that requirements and pip is installed.
        Simple way to do this on a Debian-based OS is:
        
        .. code-block:: shell
        
          sudo apt-get install python-pip python-dev build-essential libssl-dev libffi-dev
          sudo pip install -r requirements.txt
          
        And finally start the honeypot:
          
        .. code-block:: shell
        
          mkdir tmp
          cd tmp
          sudo heralding
          
        
Platform: UNKNOWN
