https://github.com/k1nky/netbox-otp-plugin
This netbox plugin adds support for one-time password (OTP) to Netbox.
https://github.com/k1nky/netbox-otp-plugin
netbox netbox-plugin otp-verification
Last synced: 4 months ago
JSON representation
This netbox plugin adds support for one-time password (OTP) to Netbox.
- Host: GitHub
- URL: https://github.com/k1nky/netbox-otp-plugin
- Owner: k1nky
- License: apache-2.0
- Created: 2022-12-21T19:00:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-12T14:11:05.000Z (7 months ago)
- Last Synced: 2026-03-06T09:22:35.495Z (4 months ago)
- Topics: netbox, netbox-plugin, otp-verification
- Language: Python
- Homepage:
- Size: 334 KB
- Stars: 34
- Watchers: 6
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Netbox OTP Plugin
Two-factor authentication for [NetBox](https://github.com/netbox-community/netbox). The plugin provides user OTP token verification and OTP device management is provided and bases on [django-otp](https://github.com/django-otp/django-otp) with Time-based One-time Password algorithm.
## Compatibility
| NetBox Version| Plugin Version|
|---------------|---------------|
| 4.4 | >= 1.3.4 |
| 4.3 | >= 1.3.3 |
| 4.2 | >= 1.3.2 |
| 4.1 | >= 1.3.0 |
| 4.0 | >= 1.1.0 |
| 3.X | 1.0.7 |
## Installation
The plugin is available as a [Python package](https://pypi.org/project/netbox-otp-plugin/) in pypi and can be installed with pip
```
source /opt/netbox/venv/bin/activate
python -m pip install netbox-otp-plugin
# or
# python -m pip install netbox-otp-plugin==
```
Enable the plugin in /opt/netbox/netbox/netbox/configuration.py:
```
PLUGINS = ['netbox_otp_plugin']
```
Run migration:
```
./manage.py migrate netbox_otp_plugin
```
To ensure the plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the NetBox root directory (alongside `requirements.txt`) and append the `netbox-otp-plugin` package:
```no-highlight
echo netbox-otp-plugin >> local_requirements.txt
```
## Configuration
An OTP device can be attached to a user on your NetBox site or using the command:
```
./manage.py addtotp
```
Then you will see a QR code that you can add to an TOTP authenticator.
To reset user OTP device use the site or the command:
```
./manage.py resettotp
```
The plugin has additional options:
* `otp_required` - if set to True then two-factor authentication will be always required even if a user doesn't have an OTP device yet. False value required to authenticate users only with an OTP device attached only. Default: `True`.
* `issuer` - the issuer parameter for the otpauth URL (see more https://github.com/google/google-authenticator/wiki/Key-Uri-Format). Default: `'Netbox'`.
* `top_level_menu` - if set to True then the plugin menu will be placed at the top level of the menu.
### Example
```
PLUGINS_CONFIG = {
'netbox_otp_plugin': {
'otp_required': False,
'issuer': 'MyOrgNetbox'
}
}
```
## OTP Self-registration
To allow users to register their devices themselves, you need to grant them the following permissions:
| Objects | Actions | Constraints |
|---------------------------|-----------|-------------------|
| Otp_Totp > TOTP Device | view, add | {"user": "$user"} |
| Users > User | view | {"pk": "$user"} |
Note: `otp_required` the plugin options should be set to `False`.
## Screenshots
