Metadata-Version: 2.1
Name: ioc-finder
Version: 1.2.0
Summary: Python package for finding and parsing indicators of compromise from text.
Home-page: https://github.com/fhightower/ioc-finder
Author: Floyd Hightower
Author-email: UNKNOWN
License: MIT License
Requires-Dist: pyparsing
Requires-Dist: ioc-fanger

Copyright (c) 2018, Floyd Hightower

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Description: # IOC Finder
        
        [![PyPi](https://img.shields.io/pypi/v/ioc_finder.svg)](https://pypi.python.org/pypi/ioc_finder)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/4078c4e3e384431bbe69c35c7f6da7b7)](https://www.codacy.com/app/fhightower/ioc-finder)
        [![Build Status](https://travis-ci.org/fhightower/ioc-finder.svg?branch=master)](https://travis-ci.org/fhightower/ioc-finder)
        [![codecov](https://codecov.io/gh/fhightower/ioc-finder/branch/master/graph/badge.svg)](https://codecov.io/gh/fhightower/ioc-finder)
        
        Parse [indicators of compromise](https://searchsecurity.techtarget.com/definition/Indicators-of-Compromise-IOC) from text.
        
        ## Capabilities
        
        Currently, this package can the following items in a given text:
        
        - IP address (IPv4 and IPv6)
        - Email addresses (both standard format (e.g. `test@example.com`) and an email with an IP address as the domain (e.g. `test@[192.168.0.1]`))
        - Domain names (support for Unicode domain names (e.g. `ȩxample.com`) is coming soon)
        - URLs
        - File hashes (md5, sha1, sha256, and sha512)
        - Registry Key paths (e.g. `"HKEY_LOCAL_MACHINE\Software\Microsoft\Windows`)
        - Autonomous System Numbers (ASNs) (in multiple formats such as `asn1234` and `as 1234`)
        - CVEs (e.g. `CVE-2014-1234`)
        - CIDR ranges (currently ipv4 ranges; ipv6 ranges coming soon)
        - Google Adsense Publisher IDs
        - Google Analytics Tracker IDs
        - Bitcoin addresses (P2PKH, P2SH, and Bech32)
        - Others... if you have any requests, [let me know](https://github.com/fhightower/ioc-finder) (or you can contact me [here](https://hightower.space/contact/) to make private suggestions)!
        
        Also provides some helpful features like:
        
        - Option to parse domain name from a URL
        - Option to parse domain name from an email address
        - Option to parse IP address from a CIDR range
        
        ## Installation
        
        To install this package:
        
        ```
        pip install ioc-finder
        ```
        
        ## Usage
        
        The primary function in this package is the `ioc_finder.find_iocs()` function. A simple usage looks like:
        
        ```python
        from ioc_finder import find_iocs
        text = "This is just an example.com https://example.org/test/bingo.php"
        iocs = find_iocs(text)
        print('Domains: {}'.format(iocs['domains']))
        print('URLs: {}'.format(iocs['urls']))
        ```
        
        ### Inputs
        
        You must pass some text into the `find_iocs()` function as string (the iocs will be parsed from this text). You can also provide the options detailed below.
        
        #### Options
        
        The `find_iocs` takes the following keywords (all of them default to `True`):
        
        - `parse_domain_from_url` (default=True): Whether or not to parse domain names from URLs (e.g. `example.com` from `https://example.com/test`)
        - `parse_domain_from_email_address` (default=True): Whether or not to parse domain names from email addresses (e.g. `example.com` from `foo@example.com`)
        - `parse_address_from_cidr` (default=True): Whether or not to parse IP addresses from CIDR ranges (e.g. `0.0.0.1` from `0.0.0.1/24`)
        
        See [test_ioc_finder.py](https://github.com/fhightower/ioc-finder/blob/master/tests/test_ioc_finder.py) for more examples.
        
        ### Output
        
        The `find_iocs()` returns a dictionary in the following structure:
        
        ```json
        {
            "asns": [],
            "bitcoin_addresses": [],
            "complete_email_address": [],
            "cves": [],
            "domains": [],
            "email_addresses": [],
            "google_adsense_publisher_ids": [],
            "google_analytics_tracker_ids": [],
            "ipv4_cidrs": [],
            "ipv4s": [],
            "ipv6s": [],
            "md5s": [],
            "registry_key_paths": [],
            "sha1s": [],
            "sha256s": [],
            "sha512s": [],
            "urls": []
        }
        ```
        
        For example, running the example code shown at the start of the [usage](#usage) section above produces the following output:
        
        ```json
        {
            "asns": [],
            "bitcoin_addresses": [],
            "complete_email_address": [],
            "cves": [],
            "domains": ["example.org", "example.com"],
            "email_addresses": [],
            "google_adsense_publisher_ids": [],
            "google_analytics_tracker_ids": [],
            "ipv4_cidrs": [],
            "ipv4s": [],
            "ipv6s": [],
            "md5s": [],
            "registry_key_paths": [],
            "sha1s": [],
            "sha256s": [],
            "sha512s": [],
            "urls": ["https://example.org/test/bingo.php"]
        }
        ```
        
        #### Output Details
        
        There are two grammars for email addresses. There is a fairly complete grammar to find email addresses matching the spec (which is very broad). Any of these complete email addresses (e.g. `foo"bar@gmail.com`) will be sent as output to in `complete_email_addresses` key.
        
        Email addresses in the simple form we are familiar with (e.g. `bar@gmail.com`) will be sent as output in the `email_addresses` key.
        
        ## Credits
        
        This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [python-project-template](https://gitlab.com/fhightower-templates/python-project-template) project template.
        
        Previous iterations of this package were inspired by [https://github.com/mosesschwartz/extract_iocs](https://github.com/mosesschwartz/extract_iocs).
        
Keywords: iocs indicators of compromise parsing finding searching threat intelligence
Platform: UNKNOWN
