Fast prefix origin pair lookups
Project description
Informational Badges:
Some Linting Badges (Where I could find them):
roa_checker
If you like the repo, it would be awesome if you could add a star to it! It really helps out the visibility. Also for any questions at all we'd love to hear from you at jfuruness@gmail.com
This package contains a trie of ROAs for fast prefix-origin pair lookups
Usage
I can expand these if anyone actually uses this repo (lmk @ jfuruness@gmail.com)
def test_tree():
# TODO: Break up into unit tests
trie = ROAChecker()
cidrs = [ip_network(x) for x in ["1.2.0.0/16", "1.2.3.0/24", "1.2.3.4"]]
routed_origin = 1
for cidr in cidrs:
trie.insert(cidr, ROA(cidr, routed_origin, cidr.prefixlen))
for cidr in cidrs:
outcome = trie.get_roa_outcome(cidr, routed_origin)
assert outcome == ROAOutcome(ROAValidity.VALID, ROARouted.ROUTED)
assert ROAValidity.is_unknown(outcome.validity) is False
assert ROAValidity.is_invalid(outcome.validity) is False
assert ROAValidity.is_valid(outcome.validity) is True
non_routed_cidrs = [ip_network(x) for x in ["2.2.0.0/16", "2.2.3.0/24", "2.2.3.4"]]
non_routed_origin = 0
for cidr in non_routed_cidrs:
trie.insert(cidr, ROA(cidr, non_routed_origin, cidr.prefixlen))
for cidr in non_routed_cidrs:
outcome = trie.get_roa_outcome(cidr, routed_origin)
assert outcome == ROAOutcome(ROAValidity.INVALID_ORIGIN, ROARouted.NON_ROUTED)
outcome = trie.get_roa_outcome(ip_network("1.0.0.0/8"), routed_origin)
assert outcome.validity == ROAValidity.UNKNOWN
assert outcome.routed_status == ROARouted.UNKNOWN
outcome = trie.get_roa_outcome(ip_network("255.255.255.255"), routed_origin)
assert outcome.validity == ROAValidity.UNKNOWN
assert outcome.routed_status == ROARouted.UNKNOWN
assert ROAValidity.is_unknown(outcome.validity) is True
assert ROAValidity.is_invalid(outcome.validity) is False
assert ROAValidity.is_valid(outcome.validity) is False
outcome = trie.get_roa_outcome(ip_network("1.2.4.0/24"), routed_origin)
assert outcome.validity == ROAValidity.INVALID_LENGTH
assert outcome.routed_status == ROARouted.ROUTED
assert ROAValidity.is_unknown(outcome.validity) is False
assert ROAValidity.is_invalid(outcome.validity) is True
assert ROAValidity.is_valid(outcome.validity) is False
outcome = trie.get_roa_outcome(ip_network("1.2.3.0/24"), routed_origin + 1)
assert outcome.validity == ROAValidity.INVALID_ORIGIN
assert outcome.routed_status == ROARouted.ROUTED
assert ROAValidity.is_unknown(outcome.validity) is False
assert ROAValidity.is_invalid(outcome.validity) is True
assert ROAValidity.is_valid(outcome.validity) is False
outcome = trie.get_roa_outcome(ip_network("1.2.4.0/24"), routed_origin + 1)
assert outcome.validity == ROAValidity.INVALID_LENGTH_AND_ORIGIN
assert outcome.routed_status == ROARouted.ROUTED
assert ROAValidity.is_unknown(outcome.validity) is False
assert ROAValidity.is_invalid(outcome.validity) is True
assert ROAValidity.is_valid(outcome.validity) is False
outcome = trie.get_roa_outcome(ip_network("1.2.0.255"), routed_origin)
assert outcome.validity == ROAValidity.INVALID_LENGTH
assert outcome.routed_status == ROARouted.ROUTED
outcome = trie.get_roa_outcome(ip_network("1.3.0.0/16"), routed_origin)
assert outcome.validity == ROAValidity.UNKNOWN
assert outcome.routed_status == ROARouted.UNKNOWN
outcome = trie.get_roa_outcome(ip_network("1.2.0.255"), routed_origin)
assert outcome.validity == ROAValidity.INVALID_LENGTH
assert outcome.routed_status == ROARouted.ROUTED
Installation
Install python and pip if you have not already. Then run:
pip3 install roa_checker
This will install the package and all of it's python dependencies.
If you want to install the project for development:
git clone https://github.com/jfuruness/roa_checker.git
cd roa_checker
pip3 install -e .[test]
pre-commit install
To test the development package: Testing
Testing
After installation for development:
cd roa_checker
python3 -m pytest roa_checker
ruff check roa_checker
ruff format roa_checker
To run all tests:
cd roa_checker
tox --skip-missing-interpreters
Development/Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request
- Email me at jfuruness@gmail.com if I don't see it after a while
History
-
3.1.0 Added get_roa_outcome_w_prefix_str_cached. It caches everything, don't cause a mem err!
-
3.0.2 Updated deps, testing, gh actions, etc
-
3.0.1 Updated dependencies for testing only
-
3.0.0 Added ta attribute to ROAs for the ROACollector, modified properties in the ROA for BGPy compatibility
-
2.0.0
- Previously the ROA checker would only look at the ROAs that were the most specific prefix (and then would check all of those ROAs)
- This is a problem because if there were two ROAs, one that is less specific and valid, and one that is more specific and invalid, the announcements would be considered invalid incorrectly.
- Fixing this unfortunately causes some of the public methods to change (they were wrong before anyways) like get_roa (you can't get a ROA for a prefix, you need to get all ROAs for that prefix)
- Previously the ROA checker would only look at the ROAs that were the most specific prefix (and then would check all of those ROAs)
-
1.1.4 Bug fix for multiple ROA case where multiple ROAs would result in the least valid ROA being selected, rather than the most valid ROA being selected. Thanks for finding this Cameron Morris!
-
1.1.3 Dependency updates
-
1.1.2 Added ROA to top level import
-
1.1.1 mypy and linter fixes
-
1.1.0 Updated test deps
-
1.0.0 Updated package structure, typing, linters, etc, made ROAValidity contains multiple invalid types
-
0.0.1 First working version
License
BSD License (see license file)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file roa_checker-3.1.0.tar.gz
.
File metadata
- Download URL: roa_checker-3.1.0.tar.gz
- Upload date:
- Size: 15.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44e4346ec8fa8f4697b69d2260d4c0b3a519c768497a914cb97adf6a28af0a09 |
|
MD5 | eb65b406da2e8f354766b4b80af487cd |
|
BLAKE2b-256 | 1128fd200339f87fafedffb9d4b9f64a40f6b907b27844d4b3bcefa7f5a1aff2 |
File details
Details for the file roa_checker-3.1.0-py3-none-any.whl
.
File metadata
- Download URL: roa_checker-3.1.0-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5de50a29291ebaf9293f610db23bc62f23510c0b3bf7a5286e29ba632e5c431c |
|
MD5 | 1c8f02d41d74becf905f4b5ba2c43b37 |
|
BLAKE2b-256 | 88098bca215d126f28ae94918776cdddc21bcadbaa9493e63d92d8e6a21a343f |