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)
  • Resource 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

RPKI Organizations/Certificates/Resources

image

image

image

image

RPKI ROAs

image

image

Compatibility

netbox-plugin.yaml

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.3.5.7.tar.gz (4.1 MB view details)

Uploaded Source

Built Distribution

netbox_rpki-0.0.3.5.7-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netbox_rpki-0.0.3.5.7.tar.gz
  • Upload date:
  • Size: 4.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.3.5.7.tar.gz
Algorithm Hash digest
SHA256 25c0209b5ad0ff6b555c5a4b7eceba8df59fc69d386787ce73a3d36210b888de
MD5 2ad26e3493925aa02946007b0856afc1
BLAKE2b-256 19a363d04df87cb0368e662804b7f114e492d8f7ad7fd7134b942bbbec46d189

See more details on using hashes here.

Provenance

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

Publisher: publish-pypi.yaml on menckend/netbox_rpki

Attestations:

File details

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

File metadata

File hashes

Hashes for netbox_rpki-0.0.3.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d8a9ef1eac19adb560be2e11ad8f6b0fbbe411d5187f339b39972b22c24c997f
MD5 5c2c5069d4084fa137cf78f9aa09fc46
BLAKE2b-256 3edc029b7ba41af1a0fce01b83ea4122153984d0f2bed9c08862d0303a222d0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_rpki-0.0.3.5.7-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