# find-and-check-hosts
[![PyPI version](https://img.shields.io/pypi/v/find-and-check-hosts)](https://pypi.org/project/find-and-check-hosts/)
![License](https://img.shields.io/pypi/l/find-and-check-hosts)
![Python versions](https://img.shields.io/pypi/pyversions/find-and-check-hosts)
Searches files for IPs and hostnames and checks them against a rule list to prevent accidentally leaking sensitive information.
## Installation
This repo can now be installed with pip:
```
pip install find-and-check-hosts
```
Or you can install it manually by following these steps:
1. Clone this repository
2. Install the dependencies listed in `./requirements.txt` with pip
3. (Optional) Do a `pip install .` to add the `find-and-check-hosts` command to your PATH
## Usage
If you did the pip installation, you should be able to just call the installed script:
```
find-and-check-hosts <arguments>
```
If you just cloned it, you need to call it by path:
```
./src/main.py <arguments>
```
## Notable changes
### Version 0.1.4
- Added `--extensions`, `--exclude-extensions` and `--ignore-directories` files.
### Version 0.1.3
- Added flags that can be used to check if results were returned (`--assert-results` and `--assert-no-results`).
- Made regexes case insensitive, so that they can find and properly handle domains such as `eXampLe.coM`.
### Version 0.1.2
- Added a `domain` filter, that will match a domain and any subdomains. For example `domain: example.com` will match `example.com`, `my.subdomain.example.com`, but not `my-example.com` or `example-com`.
- Allowed the `regex`, `glob` and `domain` fields to also accept a list of values. For example:
```
hostname_rules:
- status: ok
- domain:
- example.com
- example.org
```
## Tests
```bash
find-and-check-hosts -c src/find_and_check_hosts/example-config.yaml tests/
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/six-two/find-and-check-hosts",
"name": "find-and-check-hosts",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "six-two",
"author_email": "pip@six-two.dev",
"download_url": "https://files.pythonhosted.org/packages/a0/de/8a58026b98f1bb6661e77108acc83082bf6afb2735cd3daf52ea79122673/find-and-check-hosts-0.1.4.tar.gz",
"platform": null,
"description": "# find-and-check-hosts\n\n[![PyPI version](https://img.shields.io/pypi/v/find-and-check-hosts)](https://pypi.org/project/find-and-check-hosts/)\n![License](https://img.shields.io/pypi/l/find-and-check-hosts)\n![Python versions](https://img.shields.io/pypi/pyversions/find-and-check-hosts)\n\n\nSearches files for IPs and hostnames and checks them against a rule list to prevent accidentally leaking sensitive information.\n\n## Installation\n\nThis repo can now be installed with pip:\n```\npip install find-and-check-hosts\n```\n\nOr you can install it manually by following these steps:\n\n1. Clone this repository\n2. Install the dependencies listed in `./requirements.txt` with pip\n3. (Optional) Do a `pip install .` to add the `find-and-check-hosts` command to your PATH\n\n## Usage\n\nIf you did the pip installation, you should be able to just call the installed script:\n```\nfind-and-check-hosts <arguments>\n```\n\nIf you just cloned it, you need to call it by path:\n```\n./src/main.py <arguments>\n```\n\n## Notable changes\n\n### Version 0.1.4\n\n- Added `--extensions`, `--exclude-extensions` and `--ignore-directories` files.\n\n### Version 0.1.3\n\n- Added flags that can be used to check if results were returned (`--assert-results` and `--assert-no-results`).\n- Made regexes case insensitive, so that they can find and properly handle domains such as `eXampLe.coM`.\n\n### Version 0.1.2\n\n- Added a `domain` filter, that will match a domain and any subdomains. For example `domain: example.com` will match `example.com`, `my.subdomain.example.com`, but not `my-example.com` or `example-com`.\n- Allowed the `regex`, `glob` and `domain` fields to also accept a list of values. For example:\n ```\n hostname_rules:\n - status: ok\n - domain:\n - example.com\n - example.org\n ```\n\n## Tests\n\n```bash\nfind-and-check-hosts -c src/find_and_check_hosts/example-config.yaml tests/\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Find hostnames and IPv4 addresses in text files and check them against a set of rules",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://gitlab.com/six-two/find-and-check-hosts"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42246d3baaf2dd6ed984cf740a5741a41b9f3394f1a61e020bba5051820e8334",
"md5": "4c1795e529153faaa7d0b65cda8831e0",
"sha256": "3daa8187566d1e7632485575b8d105accf9155c1e9a98bb9ea7e1998f9783fcc"
},
"downloads": -1,
"filename": "find_and_check_hosts-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c1795e529153faaa7d0b65cda8831e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 17425,
"upload_time": "2024-02-26T19:14:01",
"upload_time_iso_8601": "2024-02-26T19:14:01.270761Z",
"url": "https://files.pythonhosted.org/packages/42/24/6d3baaf2dd6ed984cf740a5741a41b9f3394f1a61e020bba5051820e8334/find_and_check_hosts-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0de8a58026b98f1bb6661e77108acc83082bf6afb2735cd3daf52ea79122673",
"md5": "36d4ac1e2157107387976042eeb6d886",
"sha256": "f0d8df6ed8b4f9e97370411e8a5e8d540493ac71adf9ab5f91a2df54c7cad0f4"
},
"downloads": -1,
"filename": "find-and-check-hosts-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "36d4ac1e2157107387976042eeb6d886",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16849,
"upload_time": "2024-02-26T19:14:03",
"upload_time_iso_8601": "2024-02-26T19:14:03.417902Z",
"url": "https://files.pythonhosted.org/packages/a0/de/8a58026b98f1bb6661e77108acc83082bf6afb2735cd3daf52ea79122673/find-and-check-hosts-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 19:14:03",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "six-two",
"gitlab_project": "find-and-check-hosts",
"lcname": "find-and-check-hosts"
}