├── .github └── workflows │ └── main.yml ├── .gitignore ├── LICENSE ├── README.md ├── requirements.txt ├── rov ├── __init__.py └── __main__.py ├── setup.py └── tests └── test_rov.py /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: rov 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | strategy: 10 | matrix: 11 | python-version: [3.6, 3.7, 3.8, 3.9] 12 | 13 | steps: 14 | - uses: actions/checkout@v2 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v2 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - name: Install dependencies 20 | run: | 21 | python -m pip install --upgrade pip 22 | pip install flake8 pytest 23 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 24 | - name: Lint with flake8 25 | run: | 26 | # stop the build if there are Python syntax errors or undefined names 27 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 28 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 29 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 30 | - name: Test with pytest 31 | run: | 32 | python -m pytest 33 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # route-origin-validator 2 | Offline Internet route origin validation using RPKI, IRR, and RIRs delegated databases 3 | 4 | This python library is designed for validating a large number of routes in one shot. It downloads IRR, RPKI, and delegated databases to avoid network overhead for each query. 5 | 6 | ## Installation 7 | ``` 8 | pip install rov 9 | ``` 10 | 11 | ## Usage: 12 | Both the command line and python interfaces return status codes for each data 13 | source. 14 | For IRR and RPKI the possible status codes are: 15 | - NotFound 16 | - Invalid 17 | - Invalid,more-specific 18 | - Valid 19 | 20 | For delegated we expect globally reachable resources to be 'assigned'. Resources that are 'reserved' and 'available' should be considered as bogons. 21 | 22 | ### Command line 23 | The command line interface should be used only for a few queries, each query will reload all databases. 24 | ```zsh 25 | >> rov 8.8.8.0/24 15169 26 | { 27 | "query": { 28 | "prefix": "8.8.8.0/24", 29 | "asn": 15169 30 | }, 31 | "irr": { 32 | "status": "Valid", 33 | "prefix": "8.8.8.0/24", 34 | "descr": "Google", 35 | "source": "RADB" 36 | }, 37 | "rpki": { 38 | "status": "Valid", 39 | "prefix": "8.8.8.0/24", 40 | "maxLength": 24, 41 | "ta": "arin" 42 | }, 43 | "delegated": { 44 | "prefix": { 45 | "status": "assigned", 46 | "prefix": "8.0.0.0/9", 47 | "date": "19921201", 48 | "registry": "arin", 49 | "country": "US" 50 | }, 51 | "asn": { 52 | "status": "assigned", 53 | "registry": "arin" 54 | } 55 | } 56 | } 57 | 58 | >> rov 10.1.0.0/16 15169 59 | { 60 | "query": { 61 | "prefix": "10.1.0.0/16", 62 | "asn": "15169" 63 | }, 64 | "irr": { 65 | "status": "NotFound" 66 | }, 67 | "rpki": { 68 | "status": "NotFound" 69 | }, 70 | "delegated": { 71 | "prefix": { 72 | "status": "reserved", 73 | "prefix": "10.0.0.0/8", 74 | "date": "19940301", 75 | "registry": "iana", 76 | "country": "ZZ" 77 | }, 78 | "asn": { 79 | "status": "assigned", 80 | "registry": "arin" 81 | } 82 | } 83 | } 84 | ``` 85 | 86 | Past RPKI data can also be queried. 87 | Currently this only works for RPKI, so the results mix past and recent data. 88 | In the following example, the rpki results are for 2018/10/01 but other results 89 | correspond to the exectution date. 90 | ```zsh 91 | >> rov 8.8.8.0/24 15169 --rpki_archive 2018/10/01 92 | { 93 | "query": { 94 | "prefix": "8.8.8.0/24", 95 | "asn": 15169 96 | }, 97 | "irr": { 98 | "status": "Valid", 99 | "prefix": "8.8.8.0/24", 100 | "descr": "Google", 101 | "source": "RADB" 102 | }, 103 | "rpki": { 104 | "status": "NotFound" 105 | }, 106 | "delegated": { 107 | "prefix": { 108 | "status": "assigned", 109 | "prefix": "8.0.0.0/9", 110 | "date": "19921201", 111 | "registry": "arin", 112 | "country": "US" 113 | }, 114 | "asn": { 115 | "status": "assigned", 116 | "registry": "arin" 117 | } 118 | } 119 | } 120 | ``` 121 | 122 | ### In python 123 | For large batches use the python library as follows: 124 | 125 | ```python 126 | import json 127 | from rov import ROV 128 | 129 | # list of routes we want to validate 130 | routes = [ 131 | ['1.1.1.0/24', 13335], 132 | ['2.2.2.0/24', 3215], 133 | ['3.3.3.0/24', 16509], 134 | ['4.4.4.0/24', 198949], 135 | ['5.5.5.0/24', 6805], 136 | ] 137 | 138 | 139 | rov = ROV() 140 | 141 | # optional: download latest databases if needed 142 | rov.download_databases() 143 | 144 | # read databases, this may take a minute or so 145 | rov.load_databases() 146 | 147 | # this should be super fast 148 | for prefix, asn in routes: 149 | state = rov.check(prefix, asn) 150 | print(prefix) 151 | print(json.dumps(state, indent=4)) 152 | 153 | #1.1.1.0/24 154 | #{ 155 | # "query": { 156 | # "prefix": "1.1.1.0/24", 157 | # "asn": 13335 158 | # }, 159 | # "irr": { 160 | # "status": "Valid", 161 | # "prefix": "1.1.1.0/24", 162 | # "descr": "APNIC Research and Development\n6 Cordelia St", 163 | # "source": "APNIC" 164 | # }, 165 | # "rpki": { 166 | # "status": "Valid", 167 | # "prefix": "1.1.1.0/24", 168 | # "maxLength": 24, 169 | # "ta": "apnic" 170 | # }, 171 | # "delegated": { 172 | # "prefix": { 173 | # "status": "assigned", 174 | # "prefix": "1.1.1.0/24", 175 | # "date": "20110811", 176 | # "registry": "apnic", 177 | # "country": "AU" 178 | # }, 179 | # "asn": { 180 | # "status": "assigned", 181 | # "registry": "arin" 182 | # } 183 | # } 184 | #} 185 | #2.2.2.0/24 186 | #{ 187 | # "query": { 188 | # "prefix": "2.2.2.0/24", 189 | # "asn": 3215 190 | # }, 191 | # "irr": { 192 | # "status": "Invalid,more-specific", 193 | # "prefix": "2.2.0.0/16", 194 | # "descr": "France Telecom Orange", 195 | # "source": "RIPE" 196 | # }, 197 | # "rpki": { 198 | # "status": "Invalid,more-specific", 199 | # "prefix": "2.0.0.0/12", 200 | # "maxLength": 17, 201 | # "ta": "ripe" 202 | # }, 203 | # "delegated": { 204 | # "prefix": { 205 | # "status": "assigned", 206 | # "prefix": "2.0.0.0/12", 207 | # "date": "20100712", 208 | # "registry": "ripencc", 209 | # "country": "FR" 210 | # }, 211 | # "asn": { 212 | # "status": "assigned", 213 | # "registry": "ripencc" 214 | # } 215 | # } 216 | #} 217 | #3.3.3.0/24 218 | #{ 219 | # "query": { 220 | # "prefix": "3.3.3.0/24", 221 | # "asn": 16509 222 | # }, 223 | # "irr": { 224 | # "status": "NotFound" 225 | # }, 226 | # "rpki": { 227 | # "status": "Valid", 228 | # "prefix": "3.0.0.0/10", 229 | # "maxLength": 24, 230 | # "ta": "arin" 231 | # }, 232 | # "delegated": { 233 | # "prefix": { 234 | # "status": "assigned", 235 | # "prefix": "3.0.0.0/9", 236 | # "date": "20171220", 237 | # "registry": "arin", 238 | # "country": "US" 239 | # }, 240 | # "asn": { 241 | # "status": "assigned", 242 | # "registry": "arin" 243 | # } 244 | # } 245 | #} 246 | #4.4.4.0/24 247 | #{ 248 | # "query": { 249 | # "prefix": "4.4.4.0/24", 250 | # "asn": 198949 251 | # }, 252 | # "irr": { 253 | # "status": "Valid", 254 | # "prefix": "4.4.4.0/24", 255 | # "descr": "dima_training", 256 | # "source": "RADB" 257 | # }, 258 | # "rpki": { 259 | # "status": "NotFound" 260 | # }, 261 | # "delegated": { 262 | # "prefix": { 263 | # "status": "assigned", 264 | # "prefix": "4.0.0.0/9", 265 | # "date": "19921201", 266 | # "registry": "arin", 267 | # "country": "US" 268 | # }, 269 | # "asn": { 270 | # "status": "assigned", 271 | # "registry": "ripencc" 272 | # } 273 | # } 274 | #} 275 | #5.5.5.0/24 276 | #{ 277 | # "query": { 278 | # "prefix": "5.5.5.0/24", 279 | # "asn": 6805 280 | # }, 281 | # "irr": { 282 | # "status": "Invalid,more-specific", 283 | # "prefix": "5.4.0.0/14", 284 | # "descr": "Telefonica Germany GmbH & Co. OHG", 285 | # "source": "RIPE" 286 | # }, 287 | # "rpki": { 288 | # "status": "Invalid,more-specific", 289 | # "prefix": "5.4.0.0/14", 290 | # "maxLength": 14, 291 | # "ta": "ripe" 292 | # }, 293 | # "delegated": { 294 | # "prefix": { 295 | # "status": "assigned", 296 | # "prefix": "5.4.0.0/14", 297 | # "date": "20120425", 298 | # "registry": "ripencc", 299 | # "country": "DE" 300 | # }, 301 | # "asn": { 302 | # "status": "assigned", 303 | # "registry": "ripencc" 304 | # } 305 | # } 306 | #} 307 | ``` 308 | 309 | ## Acknowledgements 310 | 311 | This project is supported by MANRS/ISOC, thanks! 312 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | appdirs 2 | py-radix 3 | portion 4 | 5 | -------------------------------------------------------------------------------- /rov/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import appdirs 4 | from collections import defaultdict 5 | import glob 6 | import gzip 7 | import json 8 | import os 9 | import math 10 | import portion 11 | import radix 12 | import shutil 13 | import sys 14 | import csv 15 | import lzma 16 | from io import BytesIO 17 | 18 | import urllib 19 | import urllib.request as request 20 | from contextlib import closing 21 | 22 | CACHE_DIR = appdirs.user_cache_dir('rov', 'IHR') 23 | 24 | DEFAULT_IRR_DIR = CACHE_DIR+'/db/irr/' 25 | IRR_FNAME = '*.gz' 26 | DEFAULT_RPKI_DIR = CACHE_DIR+'/db/rpki/' 27 | RPKI_FNAME = '*.*' 28 | DEFAULT_DELEGATED_DIR = CACHE_DIR+'/db/delegated/' 29 | DELEGATED_FNAME = '*-stats' 30 | 31 | DEFAULT_IRR_URLS = [ 32 | # RADB 33 | 'ftp://ftp.radb.net/radb/dbase/altdb.db.gz', 34 | 'ftp://ftp.radb.net/radb/dbase/aoltw.db.gz', 35 | #'ftp://ftp.radb.net/radb/dbase/arin-nonauth.db.gz', 36 | #'ftp://ftp.radb.net/radb/dbase/arin.db.gz', 37 | 'ftp://ftp.radb.net/radb/dbase/bboi.db.gz', 38 | 'ftp://ftp.radb.net/radb/dbase/bell.db.gz', 39 | 'ftp://ftp.radb.net/radb/dbase/canarie.db.gz', 40 | 'ftp://ftp.radb.net/radb/dbase/easynet.db.gz', 41 | 'ftp://ftp.radb.net/radb/dbase/jpirr.db.gz', 42 | 'ftp://ftp.radb.net/radb/dbase/level3.db.gz', 43 | 'ftp://ftp.radb.net/radb/dbase/nestegg.db.gz', 44 | 'ftp://ftp.radb.net/radb/dbase/nttcom.db.gz', 45 | 'ftp://ftp.radb.net/radb/dbase/openface.db.gz', 46 | 'ftp://ftp.radb.net/radb/dbase/ottix.db.gz', 47 | 'ftp://ftp.radb.net/radb/dbase/panix.db.gz', 48 | 'ftp://ftp.radb.net/radb/dbase/radb.db.gz', 49 | 'ftp://ftp.radb.net/radb/dbase/reach.db.gz', 50 | 'ftp://ftp.radb.net/radb/dbase/rgnet.db.gz', 51 | 'ftp://ftp.radb.net/radb/dbase/risq.db.gz', 52 | 'ftp://ftp.radb.net/radb/dbase/rogers.db.gz', 53 | 'ftp://ftp.radb.net/radb/dbase/tc.db.gz', 54 | # RIRs 55 | 'ftp://ftp.arin.net/pub/rr/arin-nonauth.db.gz', 56 | 'ftp://ftp.arin.net/pub/rr/arin.db.gz', 57 | 'ftp://ftp.afrinic.net/pub/dbase/afrinic.db.gz', 58 | 'ftp://ftp.apnic.net/pub/apnic/whois/apnic.db.route.gz', 59 | 'https://ftp.lacnic.net/lacnic/irr/lacnic.db.gz', 60 | 'ftp://ftp.ripe.net/ripe/dbase/split/ripe-nonauth.db.route.gz', 61 | 'ftp://ftp.ripe.net/ripe/dbase/split/ripe-nonauth.db.route6.gz', 62 | 'ftp://ftp.ripe.net/ripe/dbase/split/ripe.db.route.gz', 63 | 'ftp://ftp.ripe.net/ripe/dbase/split/ripe.db.route6.gz', 64 | ] 65 | DEFAULT_RPKI_URLS = [ 66 | 'https://rpki.gin.ntt.net/api/export.json' 67 | ] 68 | RPKI_ARCHIVE_URLS = [ 69 | 'https://ftp.ripe.net/rpki/afrinic.tal/{year:04d}/{month:02d}/{day:02d}/roas.csv.xz', 70 | 'https://ftp.ripe.net/rpki/apnic.tal/{year:04d}/{month:02d}/{day:02d}/roas.csv.xz', 71 | 'https://ftp.ripe.net/rpki/arin.tal/{year:04d}/{month:02d}/{day:02d}/roas.csv.xz', 72 | 'https://ftp.ripe.net/rpki/lacnic.tal/{year:04d}/{month:02d}/{day:02d}/roas.csv.xz', 73 | 'https://ftp.ripe.net/rpki/ripencc.tal/{year:04d}/{month:02d}/{day:02d}/roas.csv.xz', 74 | 75 | ] 76 | DEFAULT_DELEGATED_URLS = [ 77 | 'https://www.nro.net/wp-content/uploads/delegated-stats/nro-extended-stats' 78 | ] 79 | 80 | def guess_ta_name(url): 81 | rirs = ['afrinic', 'arin', 'lacnic', 'ripencc', 'apnic'] 82 | 83 | for rir in rirs: 84 | if rir+'.tal' in url: 85 | return rir 86 | 87 | return 'unknown' 88 | 89 | 90 | class ROV(object): 91 | 92 | def __init__( self, irr_urls=DEFAULT_IRR_URLS, rpki_urls=DEFAULT_RPKI_URLS, 93 | delegated_urls=DEFAULT_DELEGATED_URLS, irr_dir=DEFAULT_IRR_DIR, 94 | rpki_dir=DEFAULT_RPKI_DIR, delegated_dir=DEFAULT_DELEGATED_DIR ): 95 | """Initialize ROV object with databases URLs""" 96 | 97 | self.urls = {} 98 | self.urls[irr_dir] = irr_urls 99 | self.urls[rpki_dir] = rpki_urls 100 | self.urls[delegated_dir] = delegated_urls 101 | 102 | self.irr_dir = irr_dir 103 | self.rpki_dir = rpki_dir 104 | self.delegated_dir = delegated_dir 105 | 106 | self.roas = { 107 | 'irr': radix.Radix(), 108 | 'rpki': radix.Radix() 109 | } 110 | self.delegated = { 111 | 'prefix': radix.Radix(), 112 | 'asn': portion.IntervalDict() 113 | } 114 | 115 | def load_databases(self): 116 | """Load databases into memory. Also download databases if it is not 117 | available locally.""" 118 | 119 | # Make sure we have databases to load 120 | self.download_databases(overwrite=False) 121 | 122 | self.load_delegated() 123 | self.load_irr() 124 | self.load_rpki() 125 | 126 | def load_delegated(self): 127 | """Parse the delegated data, load prefix data in a radix tree and ASN 128 | data in a IntervalDict""" 129 | 130 | intervals = defaultdict(list) 131 | for fname in glob.glob(self.delegated_dir+DELEGATED_FNAME): 132 | sys.stderr.write(f'Loading: {fname}\n') 133 | # Read delegated-stats file. see documentation: 134 | # https://www.nro.net/wp-content/uploads/nro-extended-stats-readme5.txt 135 | fields_name = ['registry', 'cc', 'type', 'start', 'value', 'date', 'status'] 136 | 137 | with open(fname, 'r') as fd: 138 | previous_rec = {f:'' for f in fields_name} 139 | start_interval = None 140 | 141 | for line in fd: 142 | # skip comments 143 | if line.strip().startswith('#'): 144 | continue 145 | 146 | # skip version and summary lines 147 | fields_value = line.split('|') 148 | if len(fields_value) < 8: 149 | continue 150 | 151 | # parse records 152 | rec = dict( zip(fields_name, fields_value)) 153 | rec['value'] = int(rec['value']) 154 | 155 | # ASN records 156 | if rec['type'] == 'asn': 157 | rec['start'] = int(rec['start']) 158 | # first record 159 | if start_interval is None: 160 | start_interval = rec 161 | 162 | else: 163 | if( previous_rec['registry'] == rec['registry'] 164 | and previous_rec['status'] == rec['status'] 165 | and previous_rec['start']+previous_rec['value'] == rec['start']): 166 | 167 | # continue reading the current interval 168 | pass 169 | 170 | else: 171 | # store the previous interval and start a new one 172 | key = '|'.join( [ 173 | previous_rec['registry'], 174 | previous_rec['status'] 175 | ]) 176 | interval = portion.closed( 177 | start_interval['start'], 178 | previous_rec['start']+previous_rec['value']-1 179 | ) 180 | intervals[key].append(interval) 181 | 182 | start_interval = rec 183 | 184 | previous_rec = rec 185 | 186 | 187 | # prefix records 188 | elif rec['type'] == 'ipv4' or rec['type'] == 'ipv6': 189 | 190 | if previous_rec['type'] == 'asn': 191 | # stored the last ASN interval 192 | interval = portion.closed( 193 | start_interval['start'], 194 | previous_rec['start']+previous_rec['value']-1 195 | ) 196 | self.delegated['asn'][interval] = { 197 | 'status': previous_rec['status'], 198 | 'registry': previous_rec['registry'] 199 | } 200 | start_interval = None 201 | previous_rec = {f:'' for f in fields_name} 202 | 203 | # compute prefix length 204 | if rec['type'] == 'ipv4': 205 | prefix_len = int(32-math.log2(rec['value'])) 206 | elif rec['type'] == 'ipv6': 207 | prefix_len = int(rec['value']) 208 | 209 | prefix = f"{rec['start']}/{prefix_len}" 210 | rnode = self.delegated['prefix'].search_exact(prefix) 211 | if rnode is None: 212 | rnode = self.delegated['prefix'].add(prefix) 213 | 214 | rnode.data['status'] = rec['status'] 215 | rnode.data['prefix'] = prefix 216 | rnode.data['date'] = rec['date'] 217 | rnode.data['registry'] = rec['registry'] 218 | rnode.data['country'] = rec['cc'] 219 | 220 | 221 | # Fast way to populate IntervalDict 222 | for value, interval_list in intervals.items(): 223 | 224 | registry, status = value.split('|') 225 | interval = portion.Interval(*interval_list) 226 | self.delegated['asn'][interval] = { 227 | 'status': status, 228 | 'registry': registry 229 | } 230 | 231 | 232 | def load_rpki(self): 233 | """Parse the RPKI data and load it in a radix tree""" 234 | 235 | for fname in glob.glob(self.rpki_dir+RPKI_FNAME): 236 | sys.stderr.write(f'Loading: {fname}\n') 237 | with open(fname, 'r') as fd: 238 | if fname.endswith('.json'): 239 | data = json.load(fd) 240 | elif fname.endswith('.csv'): 241 | ta = guess_ta_name(fname) 242 | data = {'roas': [] } 243 | rows = csv.reader(fd, delimiter=',') 244 | 245 | # skip the header 246 | next(rows) 247 | 248 | for row in rows: 249 | # Assume the same format as the one in RIPE archive 250 | # https://ftp.ripe.net/ripe/rpki/ 251 | maxLength = int(row[3]) if row[3] else int(row[2].rpartition('/')[2]) 252 | data['roas'].append( { 253 | 'uri': row[0], 254 | 'asn': row[1], 255 | 'prefix': row[2], 256 | 'maxLength': maxLength, 257 | 'startTime': row[4], 258 | 'endTime': row[5], 259 | 'ta': ta 260 | } ) 261 | 262 | else: 263 | sys.stderr.write('Error: Unknown file format for RPKI data!') 264 | return 265 | 266 | 267 | for rec in data['roas']: 268 | if( isinstance(rec['asn'], str) 269 | and rec['asn'].startswith('AS') ): 270 | asn = int(rec['asn'][2:]) 271 | else: 272 | asn = int(rec['asn']) 273 | 274 | rnode = self.roas['rpki'].search_exact(rec['prefix']) 275 | if rnode is None: 276 | rnode = self.roas['rpki'].add(rec['prefix']) 277 | 278 | if asn not in rnode.data: 279 | rnode.data[asn] = [] 280 | 281 | roa_details = { 282 | 'maxLength': rec['maxLength'], 283 | 'ta': rec['ta'] 284 | } 285 | 286 | if 'startTime' in rec: 287 | roa_details['startTime'] = rec['startTime'] 288 | roa_details['endTime'] = rec['endTime'] 289 | 290 | if 'uri' in rec: 291 | roa_details['uri'] = rec['uri'] 292 | 293 | rnode.data[asn].append( roa_details ) 294 | 295 | def load_irr(self): 296 | """Parse the IRR data and load it in a radix tree""" 297 | 298 | for fname in glob.glob(self.irr_dir+IRR_FNAME): 299 | sys.stderr.write(f'Loading: {fname}\n') 300 | with gzip.open(fname, 'rt', 301 | newline='\n', encoding='ISO-8859-1', errors='ignore') as fd: 302 | 303 | rec = {} 304 | field = '' 305 | for line in fd: 306 | line = line.strip() 307 | 308 | # Skip comments and remarks 309 | if line.startswith('#') or line.startswith('%'): 310 | continue 311 | 312 | if line == '': 313 | # Store the last record 314 | if 'route' in rec: 315 | if 'origin' not in rec: 316 | # we may be in a 'descr' empty line 317 | rec[field] += '\n'+line 318 | continue 319 | 320 | rnode = self.roas['irr'].search_exact(rec['route']) 321 | try: 322 | asn = int(rec['origin'][2:].partition('#')[0]) 323 | except ValueError: 324 | sys.stderr.write(f'Error in {fname}, invalid ASN!\n{rec}\n') 325 | continue 326 | 327 | if rnode is None: 328 | rnode = self.roas['irr'].add(rec['route']) 329 | 330 | if asn not in rnode.data: 331 | rnode.data[asn] = [] 332 | 333 | rnode.data[asn].append({ 334 | 'descr': rec.get('descr', '') , 335 | 'source': rec.get('source', '') 336 | }) 337 | 338 | rec = {} 339 | field = '' 340 | 341 | else: 342 | # New field 343 | if ':' in line: 344 | field, _, value = line.partition(":") 345 | # Make same field name for IPv4 and IPv6 346 | if field == 'route6': 347 | field = 'route' 348 | rec[field] = value.strip() 349 | else: 350 | # Multiline value 351 | if field in rec and field in ['descr', 'addr']: 352 | rec[field] += '\n'+line 353 | 354 | def lookup(self, prefix: int): 355 | """Search for entries for prefixes covering the given prefix. 356 | Return: dict will all matching entries""" 357 | 358 | res = defaultdict(dict) 359 | for name, rtree in self.roas.items(): 360 | rnodes = rtree.search_covering(prefix) 361 | for rnode in rnodes: 362 | res[name][rnode.prefix] = rnode.data 363 | 364 | # Check status in delegated stats 365 | rnode = self.delegated['prefix'].search_best(prefix) 366 | if rnode is not None: 367 | res['delegated'] = rnode.data 368 | 369 | return res 370 | 371 | 372 | def check(self, prefix: str, origin_asn: int): 373 | """Compute the state of the given prefix, origin ASN pair""" 374 | 375 | origin_asn = int(origin_asn) 376 | prefix_in = prefix.strip() 377 | prefixlen = int(prefix_in.partition('/')[2]) 378 | states = {} 379 | 380 | # include the query in the results 381 | states['query'] = { 382 | 'prefix': prefix, 383 | 'asn': origin_asn 384 | } 385 | 386 | # Check routing status 387 | for name, rtree in self.roas.items(): 388 | # Default to NotFound 389 | selected_roa = None 390 | status = {'status': 'NotFound'} 391 | 392 | rnodes = rtree.search_covering(prefix) 393 | if len(rnodes) > 0: 394 | # report invalid with the first roa of the most specific prefix 395 | rnode = rnodes[0] 396 | status = {'status': 'Invalid', 'prefix': rnode.prefix} 397 | key = next(iter(rnode.data.keys())) 398 | selected_roa = rnode.data[key][0] 399 | 400 | for rnode in rnodes: 401 | if origin_asn in rnode.data: # Matching ASN 402 | 403 | for roa in rnode.data[origin_asn]: 404 | status = {'status': 'Invalid,more-specific', 'prefix': rnode.prefix} 405 | selected_roa = roa 406 | 407 | # check prefix length 408 | if( ('maxLength' in roa and roa['maxLength'] >= prefixlen) 409 | or (prefix_in == rnode.prefix)): 410 | 411 | status = {'status': 'Valid', 'prefix': rnode.prefix} 412 | selected_roa = roa 413 | 414 | break 415 | 416 | if status['status'] == 'Valid': 417 | break 418 | 419 | # copy roa attributes in the status report 420 | if selected_roa is not None: 421 | for k,v in selected_roa.items(): 422 | status[k] = v 423 | 424 | states[name] = status 425 | 426 | # Check status in delegated stats 427 | rnode = self.delegated['prefix'].search_best(prefix) 428 | prefix_data = {'status': 'NotFound'} 429 | if rnode is not None: 430 | prefix_data = rnode.data 431 | 432 | asn = self.delegated['asn'].get(int(origin_asn), {'status': 'NotFound'}) 433 | 434 | states['delegated'] = { 435 | 'prefix': prefix_data, 436 | 'asn': asn 437 | } 438 | 439 | return states 440 | 441 | 442 | def download_databases(self, overwrite=True): 443 | """Download databases in the cache folder. 444 | 445 | Overwrite=True clears the cache before downloading new files. 446 | Set overwrite=False to download only missing databases.""" 447 | 448 | # TODO implement automatic update based on dates 449 | 450 | for folder, urls in self.urls.items(): 451 | 452 | # Clear the whole cache if overwrite 453 | if overwrite and os.path.exists(folder): 454 | shutil.rmtree(folder) 455 | 456 | # Create the folder if needed 457 | os.makedirs(folder, exist_ok=True) 458 | 459 | for url in urls: 460 | # Check if the file already exists 461 | fname = url.rpartition('/')[2] 462 | 463 | # all files from RIPE's RPKI archive have the same name 464 | # 'roas.csv', change it with the tal name 465 | if fname == 'roas.csv.xz': 466 | fname = guess_ta_name(url)+".csv" 467 | 468 | if os.path.exists(folder+fname) and not overwrite: 469 | continue 470 | 471 | sys.stderr.write(f'Downloading: {url}\n') 472 | 473 | try: 474 | # to separete csv.xz file to decompress 475 | if "roas.csv.xz" in url: 476 | with closing(request.urlopen(url)) as response: 477 | with lzma.open(BytesIO(response.read())) as r: 478 | with open(folder+fname, 'wb') as f: 479 | shutil.copyfileobj(r,f) 480 | else: 481 | with closing(request.urlopen(url)) as r: 482 | with open(folder+fname, 'wb') as f: 483 | shutil.copyfileobj(r, f) 484 | except urllib.error.URLError: 485 | sys.stderr.write(f'Error {url} is not available.\n') 486 | 487 | -------------------------------------------------------------------------------- /rov/__main__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import argparse 4 | import json 5 | 6 | from rov import ROV 7 | from rov import DEFAULT_RPKI_URLS 8 | from rov import DEFAULT_RPKI_DIR 9 | from rov import DEFAULT_IRR_URLS 10 | from rov import RPKI_ARCHIVE_URLS 11 | 12 | # Command line application 13 | def main(): 14 | # Parse command line arguments 15 | parser = argparse.ArgumentParser( 16 | description='Check the validity of the given prefix and origin ASN in \ 17 | the RPKI and IRR database') 18 | parser.add_argument( 19 | 'prefix', type=str, help='the prefix to validate') 20 | parser.add_argument( 21 | 'ASN', type=int, help='the autonomous system number to validate') 22 | parser.add_argument( 23 | '--update', '-u', help='Fetch the latest databases', 24 | action='store_true') 25 | parser.add_argument( 26 | '--irr_url', 27 | nargs='+', 28 | help='URL to an IRR database dump (default to dumps from RADB)', 29 | default=DEFAULT_IRR_URLS) 30 | parser.add_argument( 31 | '--rpki_url', 32 | nargs='+', 33 | help='URL to a RPKI JSON endpoint (default=https://rpki.gin.ntt.net/api/export.json) \ 34 | Ignored if --rpki_archive is set.', 35 | default=DEFAULT_RPKI_URLS) 36 | parser.add_argument( 37 | '--rpki_archive', 38 | help='Load past RPKI data for the given date (format is year/mo/da). \ 39 | The given date should be greater than 2018/04/04.', 40 | ) 41 | parser.add_argument( 42 | '--interactive', 43 | help='Open an interactive python shell with databases loaded in "rov".', 44 | action='store_true') 45 | args = parser.parse_args() 46 | 47 | 48 | rpki_url = args.rpki_url 49 | rpki_dir = DEFAULT_RPKI_DIR 50 | # Compute RPKI archive URLs if the rpki_archive option is given 51 | if args.rpki_archive is not None: 52 | year, month, day = args.rpki_archive.split('/') 53 | rpki_dir += '/'+args.rpki_archive+'/' 54 | rpki_url = [] 55 | for url in RPKI_ARCHIVE_URLS: 56 | rpki_url.append( url.format(year=int(year), month=int(month), day=int(day)) ) 57 | 58 | # Main program 59 | rov = ROV(args.irr_url, rpki_url, rpki_dir=rpki_dir) 60 | 61 | # Download databases 62 | rov.download_databases(args.update) 63 | 64 | rov.load_databases() 65 | 66 | validation_results = rov.check(args.prefix, args.ASN) 67 | print(json.dumps(validation_results, indent=4)) 68 | 69 | if args.interactive: 70 | import IPython 71 | IPython.embed() 72 | 73 | 74 | if __name__ == "__main__": 75 | main() 76 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | with open('README.md') as f: 4 | readme = f.read() 5 | 6 | setup( 7 | version = '0.5.0', 8 | name = 'rov', 9 | author = 'Romain Fontugne', 10 | author_email = 'romain.fontugne@gmail.com', 11 | url = 'https://github.com/InternetHealthReport/route-origin-validator/', 12 | description="Offline Internet route origin validation using RPKI, IRR, and RIRs delegated databases", 13 | long_description=readme, 14 | long_description_content_type="text/markdown", 15 | keywords = ['RPKI', 'IRR', 'delegated', 'Internet', 'routing', 'route origin validation'], 16 | packages = find_packages(), 17 | install_requires=[ 18 | 'appdirs', 19 | 'py-radix', 20 | 'portion' 21 | ], 22 | entry_points={'console_scripts': 23 | ['rov = rov.__main__:main']}, 24 | ) 25 | -------------------------------------------------------------------------------- /tests/test_rov.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | import rov 3 | 4 | @pytest.fixture(scope='session') 5 | def default_rov(): 6 | drov = rov.ROV(rov.DEFAULT_IRR_URLS, rov.DEFAULT_RPKI_URLS) 7 | drov.download_databases(False) 8 | drov.load_databases() 9 | 10 | return drov 11 | 12 | 13 | @pytest.fixture(scope='session') 14 | def archive_rov(): 15 | year, month, day = '2018', '10', '02' 16 | rpki_dir = rov.DEFAULT_RPKI_DIR+'/2018/10/02/' 17 | rpki_url = [] 18 | for url in rov.RPKI_ARCHIVE_URLS: 19 | rpki_url.append( url.format(year=int(year), month=int(month), day=int(day)) ) 20 | 21 | arov = rov.ROV(rov.DEFAULT_IRR_URLS, rpki_urls=rpki_url, rpki_dir=rpki_dir) 22 | arov.download_databases(False) 23 | arov.load_databases() 24 | 25 | return arov 26 | 27 | 28 | # RPKI statues 29 | def test_rpki_notfound(default_rov): 30 | validation_results = default_rov.check('10.1.0.0/16', 15169) 31 | assert validation_results['rpki']['status'] == 'NotFound' 32 | 33 | def test_rpki_invalid(default_rov): 34 | validation_results = default_rov.check('8.8.8.0/24', 123) 35 | assert validation_results['rpki']['status'] == 'Invalid' 36 | 37 | def test_rpki_morespecific(default_rov): 38 | validation_results = default_rov.check('8.8.8.0/25', 15169) 39 | assert validation_results['rpki']['status'] == 'Invalid,more-specific' 40 | 41 | def test_rpki_valid(default_rov): 42 | validation_results = default_rov.check('8.8.8.0/24', 15169) 43 | assert validation_results['rpki']['status'] == 'Valid' 44 | 45 | 46 | # IRR statues 47 | def test_irr_notfound(default_rov): 48 | validation_results = default_rov.check('10.1.0.0/16', 15169) 49 | assert validation_results['irr']['status'] == 'NotFound' 50 | 51 | def test_irr_invalid(default_rov): 52 | validation_results = default_rov.check('8.8.8.0/24', 123) 53 | assert validation_results['irr']['status'] == 'Invalid' 54 | 55 | def test_irr_morespecific(default_rov): 56 | validation_results = default_rov.check('8.8.8.0/25', 15169) 57 | assert validation_results['irr']['status'] == 'Invalid,more-specific' 58 | 59 | def test_irr_valid(default_rov): 60 | validation_results = default_rov.check('8.8.8.0/24', 15169) 61 | assert validation_results['irr']['status'] == 'Valid' 62 | 63 | 64 | # delegated statues 65 | def test_delegated_prefix_reserved(default_rov): 66 | validation_results = default_rov.check('10.0.0.0/8', 15169) 67 | assert validation_results['delegated']['prefix']['status'] == 'reserved' 68 | 69 | def test_delegated_prefix_assigned(default_rov): 70 | validation_results = default_rov.check('8.8.8.0/24', 15169) 71 | assert validation_results['delegated']['prefix']['status'] == 'assigned' 72 | 73 | def test_delegated_asn_reserved(default_rov): 74 | validation_results = default_rov.check('8.8.8.0/24', 0) 75 | assert validation_results['delegated']['asn']['status'] == 'reserved' 76 | 77 | def test_delegated_asn_assigned(default_rov): 78 | validation_results = default_rov.check('8.8.8.0/24', 15169) 79 | assert validation_results['delegated']['asn']['status'] == 'assigned' 80 | 81 | 82 | # archive RPKI 83 | def test_archive_notfound(archive_rov): 84 | validation_results = archive_rov.check('10.1.0.0/16', 15169) 85 | assert validation_results['rpki']['status'] == 'NotFound' 86 | 87 | def test_archive_invalid(archive_rov): 88 | validation_results = archive_rov.check('1.1.1.0/24', 123) 89 | assert validation_results['rpki']['status'] == 'Invalid' 90 | 91 | def test_archive_morespecific(archive_rov): 92 | validation_results = archive_rov.check('1.1.1.0/25', 13335) 93 | assert validation_results['rpki']['status'] == 'Invalid,more-specific' 94 | 95 | def test_archive_valid(archive_rov): 96 | validation_results = archive_rov.check('1.1.1.0/24', 13335) 97 | assert validation_results['rpki']['status'] == 'Valid' 98 | 99 | 100 | # Others 101 | def test_query(default_rov): 102 | res = default_rov.check('8.8.8.0/24', 15169) 103 | assert res["query"]["prefix"] == '8.8.8.0/24' 104 | assert res["query"]["asn"] == 15169 105 | 106 | --------------------------------------------------------------------------------