Metadata-Version: 1.0
Name: ioc-finder
Version: 1.0.2
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

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)
        - 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:
        
        - Ability to remove an indicator type after it is parsed - For example, if you would like to parse all URLs, but do not want to parse the domain name from each URL, you specify this.
        
        ## Installation
        
        To install this package:
        
        ```
        pip install ioc-finder
        ```
        
        ## Usage
        
        To use this package:
        
        ```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']))
        ```
        
        See [test_ioc_finder.py](https://github.com/fhightower/ioc-finder/blob/master/tests/test_ioc_finder.py) for more examples.
        
        ## 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
