Skip to content
IPv4 and IPv6 prefix aggregation tool
Python Roff Makefile
Branch: master
Clone or download
job Merge pull request #6 from kmosiejczuk/include-tests
Add tests so they get included in the PyPI tarball
Latest commit 956ae73 Nov 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
aggregate6 Revert "Possible speedup" May 12, 2018
tests
.coveragerc Omit tests for coverage Nov 28, 2017
.gitignore Add .gitignore Dec 1, 2014
.travis.yml Update .travis Nov 28, 2017
LICENSE Rework the repo Nov 28, 2017
MANIFEST.in Add tests so they get included in the PyPI tarball Nov 7, 2019
Makefile Update docs & add verbose mode Dec 4, 2017
README.md Update docs & add verbose mode Dec 4, 2017
aggregate6.7 Update docs & add verbose mode Dec 4, 2017
requirements.txt Fix typo in requirements Nov 28, 2017
setup.py Update manifest Nov 29, 2017

README.md

Build Status Requirements Status Coverage Status

aggregate6

aggregate6 will compress an unsorted list of IP prefixes (both IPv4 and IPv6).

Description

Takes a list of IPv6 prefixes in conventional format on stdin, and performs two optimisations to attempt to reduce the length of the prefix list. The first optimisation is to remove any supplied prefixes which are superfluous because they are already included in another supplied prefix. For example, 2001:67c:208c:10::/64 would be removed if 2001:67c:208c::/48 was also supplied.

The second optimisation identifies adjacent prefixes that can be combined under a single, shorter-length prefix. For example, 2001:67c:208c::/48 and 2001:67c:208d::/48 can be combined into the single prefix 2001:67c:208c::/47.

The above optimalisation steps are often useful in context of compressing firewall rules or BGP prefix-list filters.

The following command line options are available:

	-4          Only output IPv4 prefixes
	-6          Only output IPv6 prefixes
	-h, --help  show help message and exit
	-m N        Sets the maximum prefix length for entries read, longer prefixes will be discarded prior to processing
	-t          truncate IP/mask to network/mask
	-v          Display verbose information about the optimisations
	-V          Display aggregate6 version

Installation

OpenBSD 6.3:

$ doas pkg_add aggregate6

Other platforms:

$ pip3 install aggregate6

CLI Usage

Either provide the list of IPv4 and IPv6 prefixes on STDIN, or give filenames containing lists of IPv4 and IPv6 prefixes as arguments.

$ # via STDIN
$ cat file_with_list_of_prefixes | aggregate6
   ... output ...

$ # with a filename as argument
$ aggregate6 file_with_list_of_prefixes [ ... optional_other_prefix_lists ]
   ... output ...

$ # Whitespace separated works too
$ echo 2001:67c:208c::/48 2000::/3 | aggregate6
2000::/3

$ # You can combine IPv4 and IPv6
$ echo 10.0.0.0/16 10.0.0.0/24 2000::/3 | aggregate6
10.0.0.0/16
2000::/3

Library Usage

Aggregate6 can be used in your own pyp/python2/python3 project as python module. Currently there is just one simple public function: aggregate() which takes a list as parameter.

>>> import from aggregate6 import aggregate
>>> aggregate(["10.0.0.0/8", "10.0.0.0/24"])
['10.0.0.0/8']
>>>

Bugs

Please report bugs at https://github.com/job/aggregate6/issues

Author

Job Snijders job@instituut.net

You can’t perform that action at this time.