Skip to main content

NetBox plugin for BGP RPKI support.

Project description

NetBox RPKI Plugin

Netbox plugin for adding BGP RPKI elements.

Features

Implements data models and forms for Resource Public Key Infrastructure (RPKI) items. Models included are:

  • Organization
    • A customer/consumer of RIR services such as RPKI (and IP address and ASN allocations)
    • "Child" relationship to IPAM RIR "parent" model
    • Parent relationship to RPKI "Customer certificate" model (children)
    • Fields
      • org-id, name, ext_url, parent_rir (foreign key to IPAM ASN)
  • Customer Certificate
    • The X.509 certificate used to sign a customer's ROAs
    • May be either self-hosted/managed/published (managed by customer) or managed by the RIR (as part of a "managed" RPKI service)
    • Child relationship to a single RPKI Organization object (parent)
    • Parent relationship to RPKI ROA objects (children)
    • Fields
      • name, issuer, subject, serial, valid_from, valid_to, auto_renews, public_key, private_key, publication_url, ca_repository, self_hosted, rpki_org (foreign key to rpki organization)
  • Route Origination Authorization (ROA)
    • A statement that a specific AS number is authorized to originate a specific set of IP prefices.
    • Each ROA has a child->parent relationship to a single RPKI ROA object
    • Child relationship to RPKI Customer certificate object (parent)
    • Parent relationship to RPKI ROA Prefix object (children)
    • Fields
      • name, origin_as (foreign key to IPAM ASN model), valid_from, valid_to, auto_renews, signed_by (foreign key to rpki customer certificate)
  • ROA prefix
    • A specific prefix that is included in the scope of a specific ROA
    • Child relationship to RPKI ROA object (parent)
    • Fields
      • prefix (foreign key to IPAM Prefix model), max_length, roa_name (foreing key to rpki roa)

Screencaps

Compatibility

NetBox Version Plugin Version
4.1 0.0.2

Installing

For adding to a NetBox Docker setup see the general instructions for using netbox-docker with plugins.

Install using pip:

pip install netbox_rpki

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

netbox_rpki

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

PLUGINS = [
    'netbox_rpki'
]

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_rpki-0.0.2.13.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

netbox_rpki-0.0.2.13-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file netbox_rpki-0.0.2.13.tar.gz.

File metadata

  • Download URL: netbox_rpki-0.0.2.13.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for netbox_rpki-0.0.2.13.tar.gz
Algorithm Hash digest
SHA256 40a1660b60553f7a83ba7f1bdffc5caaf04e71f5817d9a154782f274bceb6cf1
MD5 8b87daaea0ed2b83f75ed48147a8bbb8
BLAKE2b-256 51201fb8028b9999ed1f952ad95a1bc7614089316cc74e1c43c3d3283eedec1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_rpki-0.0.2.13.tar.gz:

Publisher: publish-pypi.yaml on menckend/netbox_rpki

Attestations:

File details

Details for the file netbox_rpki-0.0.2.13-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_rpki-0.0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 1843832defbf7942b61a8b441249d25d8546670135ba37e978900f748bbbdf74
MD5 ae1c04135f4bdba51c742a82573f2516
BLAKE2b-256 d86afe1d80421c849082f2c5576d4b4ba64f88cca67a627ee7293aa904c44cd3

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_rpki-0.0.2.13-py3-none-any.whl:

Publisher: publish-pypi.yaml on menckend/netbox_rpki

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page