Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iitoneloc/ngs-ieee-oui-db
A Python module for verifying Organizationally Unique Identifiers (OUIs) against the IEEE's OUI database.
https://github.com/iitoneloc/ngs-ieee-oui-db
Last synced: 20 days ago
JSON representation
A Python module for verifying Organizationally Unique Identifiers (OUIs) against the IEEE's OUI database.
- Host: GitHub
- URL: https://github.com/iitoneloc/ngs-ieee-oui-db
- Owner: iiTONELOC
- License: other
- Created: 2024-12-28T20:03:45.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2024-12-28T20:26:02.000Z (29 days ago)
- Last Synced: 2024-12-28T21:21:42.589Z (29 days ago)
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NGS IEEE OUI Database
A Python module for verifying Organizationally Unique Identifiers (OUIs) against the IEEE's OUI database.
Uses the [requests library](https://requests.readthedocs.io/en/latest/)
## Screenshot
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [As Module](#as-module)
- [As Script](#as-script)
- Documentation
- [Utils](./docs/utils.MD)
- [Validators](./docs/validators.MD)
- [IEE_OUI_DB](./docs/IEE_OUI.MD)
- [Is IoT Device](./docs/isIot.MD)
- [Command Line Interface](./docs/cli.MD)
- [Extract IoT Manufacturers](./docs/extractIot.MD)
- [Tests](#tests)
- [License](#license)
## Installation
The only method for installation at the moment is to clone the repo and install the module locally by adding the project to the `PYTHONPATH` environment variable. Or to install locally using Pip. In the future, this may be added to PyPi.
1. Clone the repo:
```bash
git clone https://github.com/iiTONELOC/ngs-ieee-oui-db.git
```
2. Install via pip:
For best results, ensure that the project using the module is configured for a virtual environment
```bash
pip install /absolute/or/relative/path/to/ngs-ieee-oui-db
# example output
Processing /home/developer/code/python-projects/NG_OUI_DB
Installing build dependencies ... done
Getting requirements to build wheel ... done
Preparing metadata (pyproject.toml) ... done
Requirement already satisfied: requests>=2.32.3 in ./venv/lib/python3.12/site-packages (from NG_OUI_DB==0.1.0) (2.32.3)
Requirement already satisfied: charset-normalizer<4,>=2 in ./venv/lib/python3.12/site-packages (from requests>=2.32.3->NG_OUI_DB==0.1.0) (3.4.0)
Requirement already satisfied: idna<4,>=2.5 in ./venv/lib/python3.12/site-packages (from requests>=2.32.3->NG_OUI_DB==0.1.0) (3.10)
Requirement already satisfied: urllib3<3,>=1.21.1 in ./venv/lib/python3.12/site-packages (from requests>=2.32.3->NG_OUI_DB==0.1.0) (2.2.3)
Requirement already satisfied: certifi>=2017.4.17 in ./venv/lib/python3.12/site-packages (from requests>=2.32.3->NG_OUI_DB==0.1.0) (2024.12.14)
Building wheels for collected packages: NG_OUI_DB
Building wheel for NG_OUI_DB (pyproject.toml) ... done
Created wheel for NG_OUI_DB: filename=NG_OUI_DB-0.1.0-py3-none-any.whl size=12378 sha256=829fbfe2fe3422a22d67a7c0536fa3711d718b2da73fae2fa42c91621da4bce6
Stored in directory: /tmp/pip-ephem-wheel-cache-ntsjdj26/wheels/d7/15/9f/23ba2c21ba1a35a37cb003b2dae0e826c7d3891100e1e7f9d2
Successfully built NG_OUI_DB
Installing collected packages: NG_OUI_DB
Attempting uninstall: NG_OUI_DB
Found existing installation: NG_OUI_DB 0.1.0
Uninstalling NG_OUI_DB-0.1.0:
Successfully uninstalled NG_OUI_DB-0.1.0
Successfully installed NG_OUI_DB-0.1.0
```
## Usage
### As Module
```python
from NG_OUI_DB import IeeOuiDb
db = IeeOuiDb()
# get information about the mac
man = db.getOrganization("00:00:00:00:00:00")
print(man)
#expects
{
"Registry": "MA-L",
"Assignment": "000000",
"Organization Name": "XEROX CORPORATION",
"Organization Address": "M/S 105-50C WEBSTER NY US 14580",
}
```
### As Script
```bash
python3 /absolute/path/to/ngs-ieee-oui-db
# expects
--------------------------------------------------------------------------------
Number of Records Found: 36671
URL: https://standards-oui.ieee.org/oui/oui.csv
Last Updated: Sun Dec 29 19:12:44 2024 (Retrieved from Cache)
Elapsed Time: 0.0208401680 seconds
IEE OUI DB Menu:
1. Get Organization Name from MAC Address
2. Get Organization Address from MAC Address
3. Get Assignment from MAC Address
4. Get Registry from MAC Address
5. Get Organization from MAC Address
6. Get Organization's Mac Addresses by Organization Name
7. Get Organizations List
8. Get Organizations Count
9. Get Organizations Mac Count
10. Get Organizations Mac Count By Organization
11. Get Organizations Mac Count By Assignment
12. Get Organizations Mac Count By Registry
13. Get Organizations By Assignment Name
14. Get Organizations By Registry Name
15. Get Organizations By Organization Name
16. Get Organizations By Organization And Assignment Name
17. Get Organizations By Organization And Registry Name
18. Get Organizations By Assignment And Registry Name
19. Get Organizations By Organization Assignment And Registry Name
Enter your choice:
```
For more usage information check out the documentation, which provides a basic overview for each item exported by the module:
- Documentation:
- [Utils](./docs/utils.MD)
- [Validators](./docs/validators.MD)
- [IEE_OUI_DB](./docs/IEE_OUI.MD)
- [Is IoT Device](./docs/isIot.MD)
- [Command Line Interface](./docs/cli.MD)
- [Extract IoT Manufacturers](./docs/extractIot.MD)
## Tests
Tests are included in the `./tests` directory and can be verified with pytest.
```bash
pytest -vv ./tests/
================================== test session starts ===================================
platform linux -- Python 3.12.3, pytest-7.4.4, pluggy-1.4.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /home/developer/code/python-projects/NG_OUI_DB
collected 25 items
tests/test_IeeOuiDb.py::test_getDb PASSED [ 4%]
tests/test_IeeOuiDb.py::test_getDbUrl PASSED [ 8%]
tests/test_IeeOuiDb.py::test_getOrganizationName PASSED [ 12%]
tests/test_IeeOuiDb.py::test_getOrganizationAddress PASSED [ 16%]
tests/test_IeeOuiDb.py::test_getAssignment PASSED [ 20%]
tests/test_IeeOuiDb.py::test_getRegistry PASSED [ 24%]
tests/test_IeeOuiDb.py::test_getOrganization PASSED [ 28%]
tests/test_IeeOuiDb.py::test_getOrganizationsMac PASSED [ 32%]
tests/test_IeeOuiDb.py::test_getOrganizations PASSED [ 36%]
tests/test_IeeOuiDb.py::test_getOrganizationsCount PASSED [ 40%]
tests/test_IeeOuiDb.py::test_getOrganizationsMacCount PASSED [ 44%]
tests/test_IeeOuiDb.py::test_getOrganizationsMacCountByOrganization PASSED [ 48%]
tests/test_IeeOuiDb.py::test_getOrganizationsMacCountByAssignment PASSED [ 52%]
tests/test_IeeOuiDb.py::test_getOrganizationsMacCountByRegistry PASSED [ 56%]
tests/test_IeeOuiDb.py::test_getOrganizationsByAssignment PASSED [ 60%]
tests/test_IeeOuiDb.py::test_getOrganizationsByRegistry PASSED [ 64%]
tests/test_IeeOuiDb.py::test_getOrganizationsByOrganization PASSED [ 68%]
tests/test_IeeOuiDb.py::test_getOrganizationsByOrganizationAndAssignment PASSED [ 72%]
tests/test_IeeOuiDb.py::test_getOrganizationsByOrganizationAndRegistry PASSED [ 76%]
tests/test_IeeOuiDb.py::test_getOrganizationsByAssignmentAndRegistry PASSED [ 80%]
tests/test_IeeOuiDb.py::test_getOrganizationsByOrganizationAssignmentAndRegistry PASSED [ 84%]
tests/test_extractIoTMans.py::test_getIotManufacturers PASSED [ 88%]
tests/test_isIoT.py::test_isIoT PASSED [ 92%]
tests/test_validators.py::test_AlphaNumericAsciiRegexPattern PASSED [ 96%]
tests/test_validators.py::test_MacAddressRegexPattern PASSED [100%]
=================================== 25 passed in 0.65s ===================================
```
## License
[License](./LICENSE)