Metadata-Version: 1.1
Name: netgrep
Version: 0.3.7
Summary: Grep-like filter for files based on country codes and ASN
Home-page: http://pypi.python.org/pypi/netgrep/
Author: CSIRT Foundry / Chris Horsley
Author-email: chris.horsley@csirtfoundry.com
License: LICENSE.txt
Download-URL: https://github.com/csirtfoundry/netgrep/tarball/master
Description: =======
        netgrep
        =======
        
        Netgrep is a command line tool which tells you which lines in a text file
        contain network resources related to a particular country or Autonomous
        Network (AS).
        
        Given input, it will:
        
        - locate domain names and IP addresses
        - resolve domains to IP addresses
        - geo-locate IP addresses to country codes and ASNs
        - extract country codes from domain names 
        - output each line matching at least one country code or ASN specified.
        
        Use case
        --------
        
        You have a big list of infected botnet clients, URLs, or IP addresses, and you
        want to find out which ones are related to your country code or AS.
        
        Example usage
        -------------
        
        # a simple log file
        
        $ cat mylog.txt
        abc.net.au,Australian Broadcasting Corporation
        bbc.co.uk,British Broadcasting Corporation
        203.2.218.214,Australian Broadcasting Corporation IP address
        xs4all.com,Hosted in Netherlands with .com extension
        
        # match anything hosted in .nl
        
        $ netgrep NL mylog.txt
        xs4all.com,Hosted in Netherlands with .com extension
        
        # match Australian IPs and domain names
        
        $ netgrep AU mylog.txt
        abc.net.au,Australian Broadcasting Corporation
        203.2.218.214,Australian Broadcasting Corporation IP address
        
        # match IPs resolving to Autonomous System 2818, owned by BBC
        
        $ netgrep AS2818 mylog.txt
        bbc.co.uk,British Broadcasting Corporation
        
        # combination filter with both Australian IPs / domains and AS2818
        
        $ netgrep AU,AS2818 mylog.txt
        abc.net.au,Australian Broadcasting Corporation
        bbc.co.uk,British Broadcasting Corporation
        203.2.218.214,Australian Broadcasting Corporation IP address
        
        Advanced usage
        --------------
        
        * Multiple files
        
        You can use wildcards or pass in multiple files:
        
        $ netgrep AS444 logs/firstlog.txt logs/secondlog.txt
        ...
        $ netgrep AS444 logs/*.txt
        ...
        
        (Note that netgrep can't handle recursive subdirectories as yet.)
        
        * Piping standard input
        
        Netgrep supports piping from standard input like this:
        
        $ cat input1.txt | netgrep BR
        
        You can use netgrep as a quick little assertion tool. For example, does
        akamai.com resolve to any boxes in Singapore?
        
        $ echo "akamai.com" | netgrep SG
        akamai.com  
        $
        # got output - assertion proven
        
        $ echo "akamai.com" | netgrep FI
        $ 
        # no output - assertion failed
        
        Installation
        ============
        
        Quick install:
        --------------
        
        Method 1
        
        1. Make sure you have adns installed. 
        2. $ sudo easy_install netgrep
        
        Method 2
        
        1. Make sure you have adns installed
        2. Extract the tarball from 
        https://github.com/csirtfoundry/netgrep/tarball/master
        3. cd [directory it was unpacked to]
        4. $ sudo python setup.py install
        
        Detailed install:
        -----------------
        
        If the above didn't work out of the box, here's what you can do.
        
        You'll need:
        
        adns (http://www.chiark.greenend.org.uk/~ian/adns/)
        Python libraries:
          BulkWhois
          publicsuffix
          adns-python
        
        Here's some OS-specific ways to install the prerequisites and netgrep,
        assuming a clean system:
        
        * 1: Linux install with apt-get:
        
        $ sudo apt-get install python-setuptools gcc python-dev python-adns
        $ sudo easy_install netgrep
        
        * 2: OS X install:
        
        Using homebrew (or your choice of package manager):
        
        Install Xcode (needed for building lots of Homebrew packages)
        $ brew install adns
        $ sudo easy_install pip
        $ sudo pip install netgrep
        
        * 3: Download and extract the tarball and then (with apt-get):
        
        $ sudo apt-get install gcc python-dev python-setuptools python-adns
        $ sudo python setup.py install
        
        * Windows
        
        Untested, and suspect it may not work. If you like to report how it did or
        didn't work, please let me know.
        
        Installation issues:
        --------------------
        
        When installing adns-python, you may receive:
        
        adnsmodule.c:8:20: fatal error: Python.h: No such file or directory
        
        sudo apt-get install python-dev
        
        
        Implementation notes
        ====================
        
        1. Netgrep makes one pass of the logs, extracting any candidate domain name and 
        IP addresses it finds.
        
        2. Domain names are checked to see if they resolve to a TLD present in the
        Mozilla Public Suffix List. Anything not matching is ignored.
        
        3. IP addresses are checked to ensure they're valid IPv4. IPv6 is currently
        not supported, but there are plans to do add this later.
        
        4. Domains are resolved to IP addresses asynchronously. This should be quite
        fast for hundreds of IP addresses, but may take a little time if you have
        thousands.
        
        5. All IPs gathered both directly from the log and via DNS resolution are
        submitted via bulk query to Team Cymru's bulk whois service, retrieving
        country code and ASN.
        
        6. The file is scanned, the country code and ASN filters applied, and matching
        lines are output.
        
        Other notes
        -----------
        
        * This initial release is focusing on functionality rather than performance for
        matching. Because of the network lookups it uses, it's not going to be anywhere
        near as fast as mighty grep: 
        http://lists.freebsd.org/pipermail/freebsd-current/2010-August/019310.html?
        * Pains have been taken to keep the memory footprint low and network calls
        asynchronous / bulk where possible.
        * netgrep only handles one record per line for now, so that means no multiline
        XML parsing. If this might be useful, let me know 
        [chris.horsley at csirtfoundry dot com].
        
        
        Acknowledgements
        ================
        
        Rob Lowe for the concept
        
        Peteris Krumins (http://www.catonmat.net/blog/asynchronous-dns-resolution/)
        for his no-fuss interface to adns. Made one very slight tweak to return 
        multiple A records rather than just the first.
        
        
Platform: UNKNOWN
