Metadata-Version: 2.4
Name: netbox_rpki
Version: 0.1.6.2
Summary: NetBox plugin for BGP RPKI support.
Author-email: Mencken Davidson <mencken@gmail.com>
Maintainer-email: Mencken Davidson <mencken@gmail.com>
License: 
                                         Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
Project-URL: Documentation, https://menckend.github.io/netbox_rpki/
Project-URL: Source, https://github.com/menckend/netbox_rpki
Project-URL: Tracker, https://github.com/menckend/netbox_rpki/issues
Keywords: netbox,plugin,bgp,rpki,roa
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: build
Provides-Extra: test
Requires-Dist: black==24.3.0; extra == "test"
Requires-Dist: check-manifest==0.49; extra == "test"
Requires-Dist: flake8; extra == "test"
Requires-Dist: flake8-pyproject; extra == "test"
Requires-Dist: pre-commit==3.7.0; extra == "test"
Requires-Dist: pytest==8.1.1; extra == "test"
Dynamic: license-file

# NetBox RPKI Plugin

Netbox plugin for adding BGP RPKI elements.

* Free software: Apache-2.0
* [Documentation](https://menckend.github.io/netbox_rpki)
* [Repository](https://github.com/menckend/netbox_rpki)
* [Python Package](https://pypi.org/project/netbox_rpki/)

## Features

Implements NetBox models, forms, API endpoints, GraphQL types, tables, and standard UI views for modeling Resource Public Key Infrastructure (RPKI) data.

The plugin still covers the original core inventory objects for organizations, resource certificates, ROAs, and their prefix or ASN relationships, and now also includes the implemented standards-aligned data-model expansion for:

- repositories and publication points
- trust anchors, trust anchor locators, and trust anchor keys
- end-entity certificates and a generic signed-object layer
- certificate revocation lists, revoked certificate references, manifests, and manifest entries
- ASPAs, RSCs, and router certificates
- validator instances, validation runs, object validation results, and validated ROA or ASPA payload views
- routing-intent profiles, rules, overrides, and the initial ROA intent and reconciliation result model family

This newer model layer is implemented as schema plus registry-driven plugin surfaces. The writable intent-policy objects are available now, while derivation and reconciliation run or result objects are currently read-only reporting surfaces.

### Models / DB tables

#### Core inventory models

#### Organization
   - Represents a customer or consumer of Regional Internet Registry (RIR) RPKI services.
   - Fields include `org_id`, `name`, `ext_url`, and `parent_rir`.

#### Resource Certificate
   - Represents the resource certificate element of the RPKI architecture.
   - Tracks certificate identity and lifecycle fields such as `issuer`, `subject`, `serial`, `valid_from`, `valid_to`, `auto_renews`, `public_key`, `publication_url`, `ca_repository`, `self_hosted`, and `rpki_org`.
   - Now links into the newer architecture through optional trust-anchor and publication-point references.

#### Route Origination Authorization (ROA)
   - Represents an RPKI ROA authorizing origination of one or more prefixes by an ASN.
   - Tracks `origin_as`, validity dates, `auto_renews`, and the signing resource certificate.
   - Now links into the generic signed-object layer through an optional signed-object reference.

#### ROA Prefix
   - Represents the attestation relationship between a ROA and a prefix, including `max_length`.
   - This model is available through the plugin but is not a top-level menu item.

#### Certificate Prefix
   - Represents the relationship between a resource certificate and a prefix.
   - This model is available through the plugin but is not a top-level menu item.

#### Certificate ASN
   - Represents the relationship between a resource certificate and an ASN.
   - This model is available through the plugin but is not a top-level menu item.

#### Repository and publication models

#### Repository
   - Represents an rsync, RRDP, or mixed repository endpoint used to hold RPKI publication data.

#### Publication Point
   - Represents a publication location within a repository and tracks retrieval and validation state.

#### Trust and certificate hierarchy models

#### Trust Anchor
   - Represents a trust anchor and its rollover state.

#### Trust Anchor Locator
   - Stores TAL-style discovery information for a trust anchor.

#### Trust Anchor Key
   - Represents a published trust-anchor key object and rollover relationships.

#### End-Entity Certificate
   - Represents the EE certificate used to sign individual RPKI signed objects.

#### Signed object and repository-integrity models

#### Signed Object
   - Generic model for published RPKI signed objects such as ROAs, manifests, ASPAs, RSCs, and trust-anchor keys.
   - Tracks object type, publication metadata, manifest linkage, CMS metadata, validity, and validation state.

#### Certificate Revocation List
   - Represents a CRL issued by a resource certificate and linked to publication and manifest state.

#### Revoked Certificate
   - Represents an individual revoked certificate or EE certificate reference carried by a CRL.

#### Manifest
   - Represents an RPKI manifest object.

#### Manifest Entry
   - Represents an individual manifest member and can link to the referenced signed object, certificate, EE certificate, or CRL.

#### Additional signed-object families

#### ASPA
   - Represents an Autonomous System Provider Authorization object.

#### ASPA Provider
   - Represents a provider ASN authorized by an ASPA.

#### RSC
   - Represents an RPKI Signed Checklist object.

#### RSC File Hash
   - Represents an individual file-hash member of an RSC.

#### Router Certificate
   - Represents a BGPsec router certificate tied to an ASN, resource certificate, and publication point.

#### Validation and validated-payload models

#### Validator Instance
   - Represents an external validator and its current run state.

#### Validation Run
   - Represents one validation execution against repository content.

#### Object Validation Result
   - Stores validation outcome and disposition for an individual signed object.

#### Validated ROA Payload
   - Represents a validated prefix-origin payload produced from a ROA.

#### Validated ASPA Payload
   - Represents a validated customer-provider authorization payload produced from an ASPA.

#### Intent and reconciliation models

#### Routing Intent Profile
   - Defines routing-intent policy defaults and prefix or ASN selection behavior.

#### Routing Intent Rule
   - Represents an ordered rule used to include, exclude, or modify derived ROA intent.

#### ROA Intent Override
   - Represents an explicit per-prefix or per-scope exception to derived ROA intent.

#### Intent Derivation Run
   - Stores metadata for a derived-intent calculation run.
   - This is currently exposed as a read-only reporting surface.

#### ROA Intent
   - Represents a derived ROA intent row tied to a derivation run, profile, scope, and optional override.
   - This is currently exposed as a read-only reporting surface.

#### ROA Intent Match
   - Stores a candidate match between a derived intent row and a locally recorded ROA.
   - This is currently exposed as a read-only reporting surface.

#### ROA Reconciliation Run
   - Stores metadata for a reconciliation comparison between intent and published ROA records.
   - This is currently exposed as a read-only reporting surface.

#### ROA Intent Result
   - Stores the intent-side reconciliation result for a derived ROA intent row.
   - This is currently exposed as a read-only reporting surface.

#### Published ROA Result
   - Stores the published-side reconciliation result for a recorded ROA.
   - This is currently exposed as a read-only reporting surface.





## Screencaps

### RPKI Organizations/Certificates/Resources

![image](/images/rpki-org-detail.png)

![image](/images/rpki-cert-detail.png)

![image](/images/rpki-certasn-detail.png)

![image](/images/rpki-certprefix-detail.png)

### RPKI ROAs

![image](/images/rpki-roa-detail.png)

![image](/images/rpki-roaprefix-detail.png)




## Compatibility

[netbox-plugin.yaml](netbox-plugin.yaml)

The plugin currently declares NetBox compatibility for the 4.5.x release line.

Validation completed against real development installs of:

- NetBox 4.5.0
- NetBox 4.5.7

Validation evidence for both versions includes successful plugin bootstrap and `manage.py check` with the plugin enabled, plus the full Python test suite passing (`196` tests). Browser smoke coverage was also run successfully against the NetBox 4.5.0 environment (`7` Playwright specs passed).


## Installing

For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).

Install using pip:

```bash
pip install netbox_rpki
```

or by adding to your `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):

```bash
netbox_rpki
```

Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 or if you use netbox-docker, your `/configuration/plugins.py` file :

```python
PLUGINS = [
    'netbox_rpki'
]

PLUGINS_CONFIG = {
    "netbox_rpki": {'top_level_menu': False},
}
```

Run  `python -m manage.py migrate` from the .../netbox/netbox/ directory in your netbox installation. (or include the manage.py migrate command in Dockerfile-Plugins if using netbox-docker.)

## Browser E2E Tests

The repo includes a minimal Playwright suite under `tests/e2e/` for real plugin Web UI CRUD coverage.

- It targets a running local NetBox dev instance, defaulting to `http://127.0.0.1:8000`
- It logs in as the local `admin` user created by `devrun/dev.sh start`
- It prepares only the core NetBox prerequisites the plugin forms depend on and cleans up prior E2E-marked plugin objects
- It does not require `dev.sh seed`, though seeded data remains compatible with the suite
- The recommended entry point in WSL is `cd devrun && ./dev.sh e2e`

See `tests/e2e/README.md` for setup, environment variables, and exact commands.
