Skip to main content

NetBox plugin to store Authorized Keys

Project description

NetBox Authorized Keys Plugin

NetBox Authorized Keys is a plugin for NetBox that allows you to store and manage SSH authorized keys.

Features

  • Store SSH authorized keys
  • Assign keys to devices or virtual machines
  • Manage keys through the NetBox UI
  • API support for managing keys

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/netbox_authorized_keys.git
    
  2. Navigate to the project directory:

    cd netbox_authorized_keys
    
  3. Install the plugin:

    pip install .
    
  4. Add the plugin to your NetBox configuration:

    PLUGINS = ["netbox_authorized_keys"]
    PLUGINS_CONFIG = {
        "netbox_authorized_keys": {
            # Add any plugin-specific configuration here
        }
    }
    
  5. Run the migrations:

    python manage.py migrate
    

Importing Keys through the GUI

  • Visit <NETBOX_URL>plugins/authorized-keys/authorized-keys/import/
  • Paste the authorized keys into the text area as YAML
  • Example:
- public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDQq ... user@host"
  username: "admin"
  full_name: "System Administrator"
  description: "Admin SSH key"
  devices: R121,R119,DEVICE_NAME3
  virtual_machines: krupa.vm.cesnet.cz, VM_NAME2
  comments: "Primary admin access key"


- public_key: "ssh-ed25519 AAAAC3aaNzaC1lZDI1NTE5AAAAIJEj2f9jQS3zGOVKUtEtQXFvFJ6YyB4hjQvQEXEsEZGk developer@laptop"
  username: "developer"
  full_name: "Jane Developer"
  description: "Developer access key"
  comments: "Development environment access"
  tags: "tag_slug1,tag_slug2"
  • Notes:
    • Tags slug need to be encased in quotes and separated by commas
    • Devices and virtual machines need to be specified by their name, enclosed in quotes, and separated by commas

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_authorized_keys-1.1.0.tar.gz (13.4 kB view details)

Uploaded Source

File details

Details for the file netbox_authorized_keys-1.1.0.tar.gz.

File metadata

  • Download URL: netbox_authorized_keys-1.1.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.28.2 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.14 CPython/3.10.12

File hashes

Hashes for netbox_authorized_keys-1.1.0.tar.gz
Algorithm Hash digest
SHA256 08d835a40ba2a1dbed7d5fa8b63741f289574833d011895db77527b3dbbc5da0
MD5 8be0a09f7ea8f61062b61e6611ad12cc
BLAKE2b-256 294977586944355e39217bd47c2ceec66597c0b4e83f7a6f2e4aa17b9d403f3e

See more details on using hashes here.

Supported by

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