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.0.4.tar.gz (10.7 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: netbox_authorized_keys-1.0.4.tar.gz
  • Upload date:
  • Size: 10.7 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.0.4.tar.gz
Algorithm Hash digest
SHA256 65a972a76bef38e6fd08444e14dd64299ba34a3915a21975e5c8d3c3abc369f3
MD5 4d2cd6eca62695b7038c7dfa155fd691
BLAKE2b-256 ab05a035b3e751e3fa0ba43606fdbf66bb96f29cd850b177667117e36f634501

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