From fd3d3d11d1f00dc28bc136afa1cccfd94419f4fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sat, 17 Oct 2020 23:09:26 +0200 Subject: [PATCH 01/14] Tiny refactoring --- configuration/configuration.py | 1 - startup_scripts/__main__.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/configuration/configuration.py b/configuration/configuration.py index f7c8ed5..7230927 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -1,6 +1,5 @@ import os import re -import socket # For reference see http://netbox.readthedocs.io/en/latest/configuration/mandatory-settings/ # Based on https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration.example.py diff --git a/startup_scripts/__main__.py b/startup_scripts/__main__.py index c41bba6..dc4cdc9 100644 --- a/startup_scripts/__main__.py +++ b/startup_scripts/__main__.py @@ -9,7 +9,7 @@ this_dir = dirname(abspath(__file__)) def filename(f): return f.name -with scandir(dirname(abspath(__file__))) as it: +with scandir(this_dir) as it: for f in sorted(it, key = filename): if not f.is_file(): continue From 43c05d816df73a9a4268543aa5691432379cd91a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:34:45 +0200 Subject: [PATCH 02/14] Dynamically load configuration files --- Dockerfile | 7 +-- configuration/{ => ldap}/ldap_config.py | 0 docker/configuration.docker.py | 62 ++++++++++++++++++-- {configuration => docker}/gunicorn_config.py | 0 docker/ldap_config.docker.py | 62 ++++++++++++++++++-- 5 files changed, 117 insertions(+), 14 deletions(-) rename configuration/{ => ldap}/ldap_config.py (100%) rename {configuration => docker}/gunicorn_config.py (100%) diff --git a/Dockerfile b/Dockerfile index 4347aa8..8db4cac 100644 --- a/Dockerfile +++ b/Dockerfile @@ -61,12 +61,12 @@ ARG NETBOX_PATH COPY ${NETBOX_PATH} /opt/netbox COPY docker/configuration.docker.py /opt/netbox/netbox/netbox/configuration.py -COPY configuration/gunicorn_config.py /etc/netbox/config/ +COPY docker/gunicorn_config.py /etc/netbox/ COPY docker/nginx.conf /etc/netbox-nginx/nginx.conf COPY docker/docker-entrypoint.sh /opt/netbox/docker-entrypoint.sh COPY startup_scripts/ /opt/netbox/startup_scripts/ COPY initializers/ /opt/netbox/initializers/ -COPY configuration/configuration.py /etc/netbox/config/configuration.py +COPY configuration/ /etc/netbox/config/ WORKDIR /opt/netbox/netbox @@ -79,7 +79,7 @@ RUN mkdir static && chmod -R g+w static media ENTRYPOINT [ "/opt/netbox/docker-entrypoint.sh" ] -CMD ["gunicorn", "-c /etc/netbox/config/gunicorn_config.py", "netbox.wsgi"] +CMD ["gunicorn", "-c /etc/netbox/gunicorn_config.py", "netbox.wsgi"] LABEL ORIGINAL_TAG="" \ NETBOX_GIT_BRANCH="" \ @@ -122,4 +122,3 @@ RUN apk add --no-cache \ util-linux COPY docker/ldap_config.docker.py /opt/netbox/netbox/netbox/ldap_config.py -COPY configuration/ldap_config.py /etc/netbox/config/ldap_config.py diff --git a/configuration/ldap_config.py b/configuration/ldap/ldap_config.py similarity index 100% rename from configuration/ldap_config.py rename to configuration/ldap/ldap_config.py diff --git a/docker/configuration.docker.py b/docker/configuration.docker.py index 733887f..3a4d2a2 100644 --- a/docker/configuration.docker.py +++ b/docker/configuration.docker.py @@ -1,10 +1,62 @@ +from os.path import abspath, isfile +from os import scandir import importlib.util import sys -try: - spec = importlib.util.spec_from_file_location('configuration', '/etc/netbox/config/configuration.py') +_CONFIG_DIR = '/etc/netbox/config/' +_MAIN_CONFIG = 'configuration' +_MODULE = 'netbox.configuration' +_loaded_configurations = [] + + +def __getattr__(name): + for config in _loaded_configurations: + try: + return getattr(config, name) + except: + pass + raise AttributeError + + +def _filename(f): + return f.name + + +def _import(module_name, path): + spec = importlib.util.spec_from_file_location('', path) module = importlib.util.module_from_spec(spec) spec.loader.exec_module(module) - sys.modules['netbox.configuration'] = module -except: - raise ImportError('') + sys.modules[module_name] = module + + _loaded_configurations.insert(0, module) + + print(f"🧬 loaded config '{path}'") + + +_main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') +if isfile(_main_config_path): + _import(f'{_MODULE}.configuration', _main_config_path) +else: + print(f"⚠️ Main configuration '{_main_config_path}' not found.") + +with scandir(_CONFIG_DIR) as it: + for f in sorted(it, key=_filename): + if not f.is_file(): + continue + + if f.name.startswith('__'): + continue + + if not f.name.endswith('.py'): + continue + + if f.name == f'{_MAIN_CONFIG}.py': + continue + + module_name = f"{_MODULE}.{f.name[:-len('.py')]}" + + _import(module_name, f.path) + +if len(_loaded_configurations) == 0: + print(f"‼️ No configuration files found in '{_CONFIG_DIR}'.") + raise ImportError(f"No configuration files found in '{_CONFIG_DIR}'.") diff --git a/configuration/gunicorn_config.py b/docker/gunicorn_config.py similarity index 100% rename from configuration/gunicorn_config.py rename to docker/gunicorn_config.py diff --git a/docker/ldap_config.docker.py b/docker/ldap_config.docker.py index 8d82173..601ba71 100644 --- a/docker/ldap_config.docker.py +++ b/docker/ldap_config.docker.py @@ -1,10 +1,62 @@ +from os.path import abspath, isfile +from os import scandir import importlib.util import sys -try: - spec = importlib.util.spec_from_file_location('ldap_config', '/etc/netbox/config/ldap_config.py') +_CONFIG_DIR = '/etc/netbox/config/ldap/' +_MAIN_CONFIG = 'ldap_config' +_MODULE = 'netbox.configuration.ldap' +_loaded_configurations = [] + + +def __getattr__(name): + for config in _loaded_configurations: + try: + return getattr(config, name) + except: + pass + raise AttributeError + + +def _filename(f): + return f.name + + +def _import(module_name, path): + spec = importlib.util.spec_from_file_location('', path) module = importlib.util.module_from_spec(spec) spec.loader.exec_module(module) - sys.modules['netbox.ldap_config'] = module -except: - raise ImportError('') + sys.modules[module_name] = module + + _loaded_configurations.insert(0, module) + + print(f"🧬 loaded config '{path}'") + + +_main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') +if isfile(_main_config_path): + _import(f'{_MODULE}.configuration', _main_config_path) +else: + print(f"⚠️ Main configuration '{_main_config_path}' not found.") + +with scandir(_CONFIG_DIR) as it: + for f in sorted(it, key=_filename): + if not f.is_file(): + continue + + if f.name.startswith('__'): + continue + + if not f.name.endswith('.py'): + continue + + if f.name == f'{_MAIN_CONFIG}.py': + continue + + module_name = f"{_MODULE}.{f.name[:-len('.py')]}" + + _import(module_name, f.path) + +if len(_loaded_configurations) == 0: + print(f"‼️ No configuration files found in '{_CONFIG_DIR}'.") + raise ImportError(f"No configuration files found in '{_CONFIG_DIR}'.") From 7429835970773416d6a0841261e65c5ddc85f9ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:34:57 +0200 Subject: [PATCH 03/14] Sample dynamic configuration file --- configuration/example.py | 49 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 configuration/example.py diff --git a/configuration/example.py b/configuration/example.py new file mode 100644 index 0000000..df74559 --- /dev/null +++ b/configuration/example.py @@ -0,0 +1,49 @@ +# Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of +# application errors (assuming correct email settings are provided). +# ADMINS = [ +# # ['John Doe', 'jdoe@example.com'], +# ] + + +# URL schemes that are allowed within links in NetBox +# ALLOWED_URL_SCHEMES = ( +# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp', +# ) + + +# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must +# be provided as a dictionary. +# NAPALM_ARGS = {} + + +# Enable installed plugins. Add the name of each plugin to the list. +# from netbox.configuration.configuration import PLUGINS +# PLUGINS.append('my_plugin') + +# Plugins configuration settings. These settings are used by various plugins that the user may have installed. +# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings. +# from netbox.configuration.configuration import PLUGINS_CONFIG +# PLUGINS_CONFIG['my_plugin'] = { +# 'foo': 'bar', +# 'buzz': 'bazz' +# } + + +# Remote authentication support +# REMOTE_AUTH_ENABLED = False +# REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend' +# REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER' +# REMOTE_AUTH_AUTO_CREATE_USER = True +# REMOTE_AUTH_DEFAULT_GROUPS = [] +# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} + + +# By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the +# class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: +# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' +# STORAGE_CONFIG = { +# 'AWS_ACCESS_KEY_ID': 'Key ID', +# 'AWS_SECRET_ACCESS_KEY': 'Secret', +# 'AWS_STORAGE_BUCKET_NAME': 'netbox', +# 'AWS_S3_REGION_NAME': 'eu-west-1', +# } From 811618b3591c7fac0f6441eff3319e6ecdd1c480 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:35:09 +0200 Subject: [PATCH 04/14] Lower gunicorn default loglevel --- docker/gunicorn_config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/gunicorn_config.py b/docker/gunicorn_config.py index 063d822..4ce7763 100644 --- a/docker/gunicorn_config.py +++ b/docker/gunicorn_config.py @@ -5,4 +5,4 @@ workers = 3 errorlog = '-' accesslog = '-' capture_output = False -loglevel = 'debug' +loglevel = 'info' From 553c8ea47026bb8aa8dfa9797aa3cfd1fd02d3de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:35:22 +0200 Subject: [PATCH 05/14] Update configuration.py --- configuration/configuration.py | 228 ++++++++++++++++++--------------- 1 file changed, 128 insertions(+), 100 deletions(-) diff --git a/configuration/configuration.py b/configuration/configuration.py index 7230927..5a9da1e 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -1,11 +1,13 @@ -import os import re -# For reference see http://netbox.readthedocs.io/en/latest/configuration/mandatory-settings/ -# Based on https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/configuration.example.py +from os.path import dirname, abspath, join +from os import environ + +# For reference see https://netbox.readthedocs.io/en/stable/configuration/ +# Based on https://github.com/netbox-community/netbox/blob/master/netbox/netbox/configuration.example.py # Read secret from file -def read_secret(secret_name, default=None): +def _read_secret(secret_name, default = None): try: f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8') except EnvironmentError: @@ -14,7 +16,7 @@ def read_secret(secret_name, default=None): with f: return f.readline().strip() -BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +_BASE_DIR = dirname(dirname(abspath(__file__))) ######################### # # @@ -26,55 +28,49 @@ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) # access to the server via any other hostnames. The first FQDN in the list will be treated as the preferred name. # # Example: ALLOWED_HOSTS = ['netbox.example.com', 'netbox.internal.local'] -ALLOWED_HOSTS = os.environ.get('ALLOWED_HOSTS', '*').split(' ') +ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ') -# PostgreSQL database configuration. +# PostgreSQL database configuration. See the Django documentation for a complete list of available parameters: +# https://docs.djangoproject.com/en/stable/ref/settings/#databases DATABASE = { - 'NAME': os.environ.get('DB_NAME', 'netbox'), # Database name - 'USER': os.environ.get('DB_USER', ''), # PostgreSQL username - 'PASSWORD': read_secret('db_password', os.environ.get('DB_PASSWORD', '')), + 'NAME': environ.get('DB_NAME', 'netbox'), # Database name + 'USER': environ.get('DB_USER', ''), # PostgreSQL username + 'PASSWORD': environ.get('DB_PASSWORD', _read_secret('db_password')), # PostgreSQL password - 'HOST': os.environ.get('DB_HOST', 'localhost'), # Database server - 'PORT': os.environ.get('DB_PORT', ''), # Database port (leave blank for default) - 'OPTIONS': {'sslmode': os.environ.get('DB_SSLMODE', 'prefer')}, + 'HOST': environ.get('DB_HOST', 'localhost'), # Database server + 'PORT': environ.get('DB_PORT', ''), # Database port (leave blank for default) + 'OPTIONS': {'sslmode': environ.get('DB_SSLMODE', 'prefer')}, # Database connection SSLMODE - 'CONN_MAX_AGE': int(os.environ.get('DB_CONN_MAX_AGE', '300')), - # Database connection persistence + 'CONN_MAX_AGE': int(environ.get('DB_CONN_MAX_AGE', '300')), + # Max database connection age +} + +# Redis database settings. Redis is used for caching and for queuing background tasks such as webhook events. A separate +# configuration exists for each. Full connection details are required in both sections, and it is strongly recommended +# to use two separate database IDs. +REDIS = { + 'tasks': { + 'HOST': environ.get('REDIS_HOST', 'localhost'), + 'PORT': int(environ.get('REDIS_PORT', 6379)), + 'PASSWORD': environ.get('REDIS_PASSWORD', _read_secret('redis_password')), + 'DATABASE': int(environ.get('REDIS_DATABASE', 0)), + 'SSL': environ.get('REDIS_SSL', 'False').lower() == 'true', + }, + 'caching': { + 'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')), + 'PORT': int(environ.get('REDIS_CACHE_PORT', environ.get('REDIS_PORT', 6379))), + 'PASSWORD': environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', _read_secret('redis_cache_password'))), + 'DATABASE': int(environ.get('REDIS_CACHE_DATABASE', 1)), + 'SSL': environ.get('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False')).lower() == 'true', + }, } # This key is used for secure generation of random numbers and strings. It must never be exposed outside of this file. # For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and # symbols. NetBox will not run without this defined. For more information, see -# https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-SECRET_KEY -SECRET_KEY = read_secret('secret_key', os.environ.get('SECRET_KEY', '')) +# https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY +SECRET_KEY = environ.get('SECRET_KEY', _read_secret('secret_key')) -# Redis database settings. The Redis database is used for caching and background processing such as webhooks -REDIS = { - 'tasks': { - 'HOST': os.environ.get('REDIS_HOST', 'localhost'), - 'PORT': int(os.environ.get('REDIS_PORT', 6379)), - 'PASSWORD': read_secret('redis_password', os.environ.get('REDIS_PASSWORD', ''), - 'DATABASE': int(os.environ.get('REDIS_DATABASE', 0)), - 'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_TIMEOUT', 300)), - 'SSL': os.environ.get('REDIS_SSL', 'False').lower() == 'true', - }, - 'webhooks': { # legacy setting, can be removed after Netbox seizes support for it - 'HOST': os.environ.get('REDIS_HOST', 'localhost'), - 'PORT': int(os.environ.get('REDIS_PORT', 6379)), - 'PASSWORD': read_secret('redis_password', os.environ.get('REDIS_PASSWORD', ''), - 'DATABASE': int(os.environ.get('REDIS_DATABASE', 0)), - 'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_TIMEOUT', 300)), - 'SSL': os.environ.get('REDIS_SSL', 'False').lower() == 'true', - }, - 'caching': { - 'HOST': os.environ.get('REDIS_CACHE_HOST', os.environ.get('REDIS_HOST', 'localhost')), - 'PORT': int(os.environ.get('REDIS_CACHE_PORT', os.environ.get('REDIS_PORT', 6379))), - 'PASSWORD': read_secret('redis_cache_password', os.environ.get('REDIS_CACHE_PASSWORD', read_secret('redis_password', os.environ.get('REDIS_PASSWORD', '')))), - 'DATABASE': int(os.environ.get('REDIS_CACHE_DATABASE', 1)), - 'DEFAULT_TIMEOUT': int(os.environ.get('REDIS_CACHE_TIMEOUT', os.environ.get('REDIS_TIMEOUT', 300))), - 'SSL': os.environ.get('REDIS_CACHE_SSL', os.environ.get('REDIS_SSL', 'False')).lower() == 'true', - }, -} ######################### # # @@ -88,135 +84,167 @@ ADMINS = [ # ['John Doe', 'jdoe@example.com'], ] +# URL schemes that are allowed within links in NetBox +ALLOWED_URL_SCHEMES = ( + 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp', +) + # Optionally display a persistent banner at the top and/or bottom of every page. HTML is allowed. To display the same # content in both banners, define BANNER_TOP and set BANNER_BOTTOM = BANNER_TOP. -BANNER_TOP = os.environ.get('BANNER_TOP', '') -BANNER_BOTTOM = os.environ.get('BANNER_BOTTOM', '') +BANNER_TOP = environ.get('BANNER_TOP', '') +BANNER_BOTTOM = environ.get('BANNER_BOTTOM', '') # Text to include on the login page above the login form. HTML is allowed. -BANNER_LOGIN = os.environ.get('BANNER_LOGIN', '') +BANNER_LOGIN = environ.get('BANNER_LOGIN', '') # Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set: # BASE_PATH = 'netbox/' -BASE_PATH = os.environ.get('BASE_PATH', '') +BASE_PATH = environ.get('BASE_PATH', '') # Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes) -CACHE_TIMEOUT = int(os.environ.get('CACHE_TIMEOUT', 900)) +CACHE_TIMEOUT = int(environ.get('CACHE_TIMEOUT', 900)) # Maximum number of days to retain logged changes. Set to 0 to retain changes indefinitely. (Default: 90) -CHANGELOG_RETENTION = int(os.environ.get('CHANGELOG_RETENTION', 90)) +CHANGELOG_RETENTION = int(environ.get('CHANGELOG_RETENTION', 90)) # API Cross-Origin Resource Sharing (CORS) settings. If CORS_ORIGIN_ALLOW_ALL is set to True, all origins will be # allowed. Otherwise, define a list of allowed origins using either CORS_ORIGIN_WHITELIST or # CORS_ORIGIN_REGEX_WHITELIST. For more information, see https://github.com/ottoyiu/django-cors-headers -CORS_ORIGIN_ALLOW_ALL = os.environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true' -CORS_ORIGIN_WHITELIST = list(filter(None, os.environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' '))) -CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, os.environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))] +CORS_ORIGIN_ALLOW_ALL = environ.get('CORS_ORIGIN_ALLOW_ALL', 'False').lower() == 'true' +CORS_ORIGIN_WHITELIST = list(filter(None, environ.get('CORS_ORIGIN_WHITELIST', 'https://localhost').split(' '))) +CORS_ORIGIN_REGEX_WHITELIST = [re.compile(r) for r in list(filter(None, environ.get('CORS_ORIGIN_REGEX_WHITELIST', '').split(' ')))] # Set to True to enable server debugging. WARNING: Debugging introduces a substantial performance penalty and may reveal # sensitive information about your installation. Only enable debugging while performing testing. Never enable debugging # on a production system. -DEBUG = os.environ.get('DEBUG', 'False').lower() == 'true' +DEBUG = environ.get('DEBUG', 'False').lower() == 'true' # Email settings EMAIL = { - 'SERVER': os.environ.get('EMAIL_SERVER', 'localhost'), - 'PORT': int(os.environ.get('EMAIL_PORT', 25)), - 'USERNAME': os.environ.get('EMAIL_USERNAME', ''), - 'PASSWORD': read_secret('email_password', os.environ.get('EMAIL_PASSWORD', '')), - 'TIMEOUT': int(os.environ.get('EMAIL_TIMEOUT', 10)), # seconds - 'FROM_EMAIL': os.environ.get('EMAIL_FROM', ''), - 'USE_SSL': os.environ.get('EMAIL_USE_SSL', 'False').lower() == 'true', - 'USE_TLS': os.environ.get('EMAIL_USE_TLS', 'False').lower() == 'true', - 'SSL_CERTFILE': os.environ.get('EMAIL_SSL_CERTFILE', ''), - 'SSL_KEYFILE': os.environ.get('EMAIL_SSL_KEYFILE', ''), + 'SERVER': environ.get('EMAIL_SERVER', 'localhost'), + 'PORT': int(environ.get('EMAIL_PORT', 25)), + 'USERNAME': environ.get('EMAIL_USERNAME', ''), + 'PASSWORD': environ.get('EMAIL_PASSWORD', _read_secret('email_password')), + 'USE_SSL': environ.get('EMAIL_USE_SSL', 'False').lower() == 'true', + 'USE_TLS': environ.get('EMAIL_USE_TLS', 'False').lower() == 'true', + 'SSL_CERTFILE': environ.get('EMAIL_SSL_CERTFILE', ''), + 'SSL_KEYFILE': environ.get('EMAIL_SSL_KEYFILE', ''), + 'TIMEOUT': int(environ.get('EMAIL_TIMEOUT', 10)), # seconds + 'FROM_EMAIL': environ.get('EMAIL_FROM', ''), } -# Enforcement of unique IP space can be toggled on a per-VRF basis. -# To enforce unique IP space within the global table (all prefixes and IP addresses not assigned to a VRF), -# set ENFORCE_GLOBAL_UNIQUE to True. -ENFORCE_GLOBAL_UNIQUE = os.environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true' +# Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table +# (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True. +ENFORCE_GLOBAL_UNIQUE = environ.get('ENFORCE_GLOBAL_UNIQUE', 'False').lower() == 'true' # Exempt certain models from the enforcement of view permissions. Models listed here will be viewable by all users and # by anonymous users. List models in the form `.`. Add '*' to this list to exempt all models. -EXEMPT_VIEW_PERMISSIONS = list(filter(None, os.environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' '))) +EXEMPT_VIEW_PERMISSIONS = list(filter(None, environ.get('EXEMPT_VIEW_PERMISSIONS', '').split(' '))) # Enable custom logging. Please see the Django documentation for detailed guidance on configuring custom logs: -# https://docs.djangoproject.com/en/1.11/topics/logging/ +# https://docs.djangoproject.com/en/stable/topics/logging/ LOGGING = {} # Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users # are permitted to access most data in NetBox (excluding secrets) but not make any changes. -LOGIN_REQUIRED = os.environ.get('LOGIN_REQUIRED', 'False').lower() == 'true' +LOGIN_REQUIRED = environ.get('LOGIN_REQUIRED', 'False').lower() == 'true' # The length of time (in seconds) for which a user will remain logged into the web UI before being prompted to # re-authenticate. (Default: 1209600 [14 days]) -LOGIN_TIMEOUT = os.environ.get('LOGIN_TIMEOUT', None) +LOGIN_TIMEOUT = environ.get('LOGIN_TIMEOUT', None) # Setting this to True will display a "maintenance mode" banner at the top of every page. -MAINTENANCE_MODE = os.environ.get('MAINTENANCE_MODE', 'False').lower() == 'true' +MAINTENANCE_MODE = environ.get('MAINTENANCE_MODE', 'False').lower() == 'true' # An API consumer can request an arbitrary number of objects =by appending the "limit" parameter to the URL (e.g. # "?limit=1000"). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request # all objects by specifying "?limit=0". -MAX_PAGE_SIZE = int(os.environ.get('MAX_PAGE_SIZE', 1000)) +MAX_PAGE_SIZE = int(environ.get('MAX_PAGE_SIZE', 1000)) # The file path where uploaded media such as image attachments are stored. A trailing slash is not needed. Note that # the default value of this setting is derived from the installed location. -MEDIA_ROOT = os.environ.get('MEDIA_ROOT', os.path.join(BASE_DIR, 'media')) +MEDIA_ROOT = environ.get('MEDIA_ROOT', join(_BASE_DIR, 'media')) # Expose Prometheus monitoring metrics at the HTTP endpoint '/metrics' -METRICS_ENABLED = os.environ.get('METRICS_ENABLED', 'False').lower() == 'true' +METRICS_ENABLED = environ.get('METRICS_ENABLED', 'False').lower() == 'true' -# Credentials that NetBox will use to access live devices. -NAPALM_USERNAME = os.environ.get('NAPALM_USERNAME', '') -NAPALM_PASSWORD = read_secret('napalm_password', os.environ.get('NAPALM_PASSWORD', '')) +# Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM. +NAPALM_USERNAME = environ.get('NAPALM_USERNAME', '') +NAPALM_PASSWORD = environ.get('NAPALM_PASSWORD', _read_secret('napalm_password')) # NAPALM timeout (in seconds). (Default: 30) -NAPALM_TIMEOUT = int(os.environ.get('NAPALM_TIMEOUT', 30)) +NAPALM_TIMEOUT = int(environ.get('NAPALM_TIMEOUT', 30)) # NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must # be provided as a dictionary. NAPALM_ARGS = {} # Determine how many objects to display per page within a list. (Default: 50) -PAGINATE_COUNT = int(os.environ.get('PAGINATE_COUNT', 50)) +PAGINATE_COUNT = int(environ.get('PAGINATE_COUNT', 50)) + +# Enable installed plugins. Add the name of each plugin to the list. +PLUGINS = [] + +# Plugins configuration settings. These settings are used by various plugins that the user may have installed. +# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings. +PLUGINS_CONFIG = { +} # When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to # prefer IPv4 instead. -PREFER_IPV4 = os.environ.get('PREFER_IPV4', 'False').lower() == 'true' +PREFER_IPV4 = environ.get('PREFER_IPV4', 'False').lower() == 'true' -# This determines how often the GitHub API is called to check the latest release of NetBox in seconds. Must be at least 1 hour. -RELEASE_CHECK_TIMEOUT = os.environ.get('RELEASE_CHECK_TIMEOUT', 24 * 3600) +# Rack elevation size defaults, in pixels. For best results, the ratio of width to height should be roughly 10:1. +RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 22)) +RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', 220)) + +# Remote authentication support +REMOTE_AUTH_ENABLED = False +# REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend' +# REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER' +# REMOTE_AUTH_AUTO_CREATE_USER = True +# REMOTE_AUTH_DEFAULT_GROUPS = [] +# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} + +# This determines how often the GitHub API is called to check the latest release of NetBox. Must be at least 1 hour. +RELEASE_CHECK_TIMEOUT = int(environ.get('RELEASE_CHECK_TIMEOUT', 24 * 3600)) # This repository is used to check whether there is a new release of NetBox available. Set to None to disable the # version check or use the URL below to check for release in the official NetBox repository. # https://api.github.com/repos/netbox-community/netbox/releases -RELEASE_CHECK_URL = os.environ.get('RELEASE_CHECK_URL', None) +RELEASE_CHECK_URL = environ.get('RELEASE_CHECK_URL', None) # The file path where custom reports will be stored. A trailing slash is not needed. Note that the default value of # this setting is derived from the installed location. -REPORTS_ROOT = os.environ.get('REPORTS_ROOT', '/etc/netbox/reports') +REPORTS_ROOT = environ.get('REPORTS_ROOT', '/etc/netbox/reports') + +# Maximum execution time for background tasks, in seconds. +RQ_DEFAULT_TIMEOUT = int(environ.get('RQ_DEFAULT_TIMEOUT', 300)) # The file path where custom scripts will be stored. A trailing slash is not needed. Note that the default value of # this setting is derived from the installed location. -SCRIPTS_ROOT = os.environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts') +SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts') + +# By default, NetBox will store session data in the database. Alternatively, a file path can be specified here to use +# local file storage instead. (This can be useful for enabling authentication on a standby instance with read-only +# database access.) Note that the user as which NetBox runs must have read and write permissions to this path. +SESSION_FILE_PATH = environ.get('REPORTS_ROOT', None) # Remote authentication support -REMOTE_AUTH_ENABLED = os.environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true' -REMOTE_AUTH_BACKEND = os.environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend') -REMOTE_AUTH_HEADER = os.environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') -REMOTE_AUTH_AUTO_CREATE_USER = os.environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true' -REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, os.environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' '))) +REMOTE_AUTH_ENABLED = environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true' +REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend') +REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') +REMOTE_AUTH_AUTO_CREATE_USER = environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true' +REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' '))) # Time zone (default: UTC) -TIME_ZONE = os.environ.get('TIME_ZONE', 'UTC') +TIME_ZONE = environ.get('TIME_ZONE', 'UTC') # Date/time formatting. See the following link for supported formats: -# https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date -DATE_FORMAT = os.environ.get('DATE_FORMAT', 'N j, Y') -SHORT_DATE_FORMAT = os.environ.get('SHORT_DATE_FORMAT', 'Y-m-d') -TIME_FORMAT = os.environ.get('TIME_FORMAT', 'g:i a') -SHORT_TIME_FORMAT = os.environ.get('SHORT_TIME_FORMAT', 'H:i:s') -DATETIME_FORMAT = os.environ.get('DATETIME_FORMAT', 'N j, Y g:i a') -SHORT_DATETIME_FORMAT = os.environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i') +# https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date +DATE_FORMAT = environ.get('DATE_FORMAT', 'N j, Y') +SHORT_DATE_FORMAT = environ.get('SHORT_DATE_FORMAT', 'Y-m-d') +TIME_FORMAT = environ.get('TIME_FORMAT', 'g:i a') +SHORT_TIME_FORMAT = environ.get('SHORT_TIME_FORMAT', 'H:i:s') +DATETIME_FORMAT = environ.get('DATETIME_FORMAT', 'N j, Y g:i a') +SHORT_DATETIME_FORMAT = environ.get('SHORT_DATETIME_FORMAT', 'Y-m-d H:i') From 20820e10c25a833c9d9d71cb66472d85e35bf5c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:38:06 +0200 Subject: [PATCH 06/14] Optimize Imports in ldap_config.py --- configuration/ldap/ldap_config.py | 48 +++++++++++++++---------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/configuration/ldap/ldap_config.py b/configuration/ldap/ldap_config.py index da6c6fe..b92a79a 100644 --- a/configuration/ldap/ldap_config.py +++ b/configuration/ldap/ldap_config.py @@ -1,11 +1,11 @@ import ldap -import os from django_auth_ldap.config import LDAPSearch from importlib import import_module +from os import environ # Read secret from file -def read_secret(secret_name, default=''): +def _read_secret(secret_name, default=None): try: f = open('/run/secrets/' + secret_name, 'r', encoding='utf-8') except EnvironmentError: @@ -15,7 +15,7 @@ def read_secret(secret_name, default=''): return f.readline().strip() # Import and return the group type based on string name -def import_group_type(group_type_name): +def _import_group_type(group_type_name): mod = import_module('django_auth_ldap.config') try: return getattr(mod, group_type_name)() @@ -23,7 +23,7 @@ def import_group_type(group_type_name): return None # Server URI -AUTH_LDAP_SERVER_URI = os.environ.get('AUTH_LDAP_SERVER_URI', '') +AUTH_LDAP_SERVER_URI = environ.get('AUTH_LDAP_SERVER_URI', '') # The following may be needed if you are binding to Active Directory. AUTH_LDAP_CONNECTION_OPTIONS = { @@ -31,54 +31,54 @@ AUTH_LDAP_CONNECTION_OPTIONS = { } # Set the DN and password for the NetBox service account. -AUTH_LDAP_BIND_DN = os.environ.get('AUTH_LDAP_BIND_DN', '') -AUTH_LDAP_BIND_PASSWORD = read_secret('auth_ldap_bind_password', os.environ.get('AUTH_LDAP_BIND_PASSWORD', '')) +AUTH_LDAP_BIND_DN = environ.get('AUTH_LDAP_BIND_DN', '') +AUTH_LDAP_BIND_PASSWORD = environ.get('AUTH_LDAP_BIND_PASSWORD', _read_secret('auth_ldap_bind_password')) # Set a string template that describes any user’s distinguished name based on the username. -AUTH_LDAP_USER_DN_TEMPLATE = os.environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None) +AUTH_LDAP_USER_DN_TEMPLATE = environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None) # Enable STARTTLS for ldap authentication. -AUTH_LDAP_START_TLS = os.environ.get('AUTH_LDAP_START_TLS', 'False').lower() == 'true' +AUTH_LDAP_START_TLS = environ.get('AUTH_LDAP_START_TLS', 'False').lower() == 'true' # Include this setting if you want to ignore certificate errors. This might be needed to accept a self-signed cert. # Note that this is a NetBox-specific setting which sets: # ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER) -LDAP_IGNORE_CERT_ERRORS = os.environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true' +LDAP_IGNORE_CERT_ERRORS = environ.get('LDAP_IGNORE_CERT_ERRORS', 'False').lower() == 'true' -AUTH_LDAP_USER_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '') -AUTH_LDAP_USER_SEARCH_ATTR = os.environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName') +AUTH_LDAP_USER_SEARCH_BASEDN = environ.get('AUTH_LDAP_USER_SEARCH_BASEDN', '') +AUTH_LDAP_USER_SEARCH_ATTR = environ.get('AUTH_LDAP_USER_SEARCH_ATTR', 'sAMAccountName') AUTH_LDAP_USER_SEARCH = LDAPSearch(AUTH_LDAP_USER_SEARCH_BASEDN, ldap.SCOPE_SUBTREE, "(" + AUTH_LDAP_USER_SEARCH_ATTR + "=%(user)s)") # This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group # heirarchy. -AUTH_LDAP_GROUP_SEARCH_BASEDN = os.environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '') -AUTH_LDAP_GROUP_SEARCH_CLASS = os.environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group') +AUTH_LDAP_GROUP_SEARCH_BASEDN = environ.get('AUTH_LDAP_GROUP_SEARCH_BASEDN', '') +AUTH_LDAP_GROUP_SEARCH_CLASS = environ.get('AUTH_LDAP_GROUP_SEARCH_CLASS', 'group') AUTH_LDAP_GROUP_SEARCH = LDAPSearch(AUTH_LDAP_GROUP_SEARCH_BASEDN, ldap.SCOPE_SUBTREE, "(objectClass=" + AUTH_LDAP_GROUP_SEARCH_CLASS + ")") -AUTH_LDAP_GROUP_TYPE = import_group_type(os.environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType')) +AUTH_LDAP_GROUP_TYPE = _import_group_type(environ.get('AUTH_LDAP_GROUP_TYPE', 'GroupOfNamesType')) # Define a group required to login. -AUTH_LDAP_REQUIRE_GROUP = os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', '') +AUTH_LDAP_REQUIRE_GROUP = environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', '') # Define special user types using groups. Exercise great caution when assigning superuser status. AUTH_LDAP_USER_FLAGS_BY_GROUP = { - "is_active": os.environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''), - "is_staff": os.environ.get('AUTH_LDAP_IS_ADMIN_DN', ''), - "is_superuser": os.environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '') + "is_active": environ.get('AUTH_LDAP_REQUIRE_GROUP_DN', ''), + "is_staff": environ.get('AUTH_LDAP_IS_ADMIN_DN', ''), + "is_superuser": environ.get('AUTH_LDAP_IS_SUPERUSER_DN', '') } # For more granular permissions, we can map LDAP groups to Django groups. -AUTH_LDAP_FIND_GROUP_PERMS = os.environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true' -AUTH_LDAP_MIRROR_GROUPS = os.environ.get('AUTH_LDAP_MIRROR_GROUPS', None).lower() == 'true' +AUTH_LDAP_FIND_GROUP_PERMS = environ.get('AUTH_LDAP_FIND_GROUP_PERMS', 'True').lower() == 'true' +AUTH_LDAP_MIRROR_GROUPS = environ.get('AUTH_LDAP_MIRROR_GROUPS', None).lower() == 'true' # Cache groups for one hour to reduce LDAP traffic -AUTH_LDAP_CACHE_TIMEOUT = int(os.environ.get('AUTH_LDAP_CACHE_TIMEOUT', 3600)) +AUTH_LDAP_CACHE_TIMEOUT = int(environ.get('AUTH_LDAP_CACHE_TIMEOUT', 3600)) # Populate the Django user from the LDAP directory. AUTH_LDAP_USER_ATTR_MAP = { - "first_name": os.environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'), - "last_name": os.environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'), - "email": os.environ.get('AUTH_LDAP_ATTR_MAIL', 'mail') + "first_name": environ.get('AUTH_LDAP_ATTR_FIRSTNAME', 'givenName'), + "last_name": environ.get('AUTH_LDAP_ATTR_LASTNAME', 'sn'), + "email": environ.get('AUTH_LDAP_ATTR_MAIL', 'mail') } From 16b567939c2742f9b2e8ed194c3944f6f3a2af5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Sun, 18 Oct 2020 02:50:51 +0200 Subject: [PATCH 07/14] Dot character has special meaning in module names Therefore we esacpe it using the underscore character. --- docker/configuration.docker.py | 2 +- docker/ldap_config.docker.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docker/configuration.docker.py b/docker/configuration.docker.py index 3a4d2a2..a47c353 100644 --- a/docker/configuration.docker.py +++ b/docker/configuration.docker.py @@ -53,7 +53,7 @@ with scandir(_CONFIG_DIR) as it: if f.name == f'{_MAIN_CONFIG}.py': continue - module_name = f"{_MODULE}.{f.name[:-len('.py')]}" + module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") _import(module_name, f.path) diff --git a/docker/ldap_config.docker.py b/docker/ldap_config.docker.py index 601ba71..7248195 100644 --- a/docker/ldap_config.docker.py +++ b/docker/ldap_config.docker.py @@ -53,7 +53,7 @@ with scandir(_CONFIG_DIR) as it: if f.name == f'{_MAIN_CONFIG}.py': continue - module_name = f"{_MODULE}.{f.name[:-len('.py')]}" + module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") _import(module_name, f.path) From dc77f1a0b170e336328d45960a79ffd553fc2a9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 20:03:35 +0200 Subject: [PATCH 08/14] Ignore non-default configuration files --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 3389e7a..22b3cee 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,8 @@ .initializers docker-compose.override.yml *.pem +configuration/* +!configuration/configuration.py +!configuration/example.py +configuration/ldap/* +!configuration/ldap/ldap_config.py From dad06088348c1a061331eedd000489d3496f2f4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 20:11:10 +0200 Subject: [PATCH 09/14] Rename example.py to extra.py And add some comments to the the file that hopefully guide the user. --- .gitignore | 2 +- configuration/configuration.py | 6 ++++ configuration/example.py | 49 ------------------------------ configuration/extra.py | 55 ++++++++++++++++++++++++++++++++++ 4 files changed, 62 insertions(+), 50 deletions(-) delete mode 100644 configuration/example.py create mode 100644 configuration/extra.py diff --git a/.gitignore b/.gitignore index 22b3cee..8e90907 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,6 @@ docker-compose.override.yml *.pem configuration/* !configuration/configuration.py -!configuration/example.py +!configuration/extra.py configuration/ldap/* !configuration/ldap/ldap_config.py diff --git a/configuration/configuration.py b/configuration/configuration.py index 5a9da1e..4d1a146 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -1,3 +1,9 @@ +#### +## We recommend to not edit this file. +## Create separate files to overwrite the settings. +## See `extra.py` as an example. +#### + import re from os.path import dirname, abspath, join diff --git a/configuration/example.py b/configuration/example.py deleted file mode 100644 index df74559..0000000 --- a/configuration/example.py +++ /dev/null @@ -1,49 +0,0 @@ -# Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of -# application errors (assuming correct email settings are provided). -# ADMINS = [ -# # ['John Doe', 'jdoe@example.com'], -# ] - - -# URL schemes that are allowed within links in NetBox -# ALLOWED_URL_SCHEMES = ( -# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp', -# ) - - -# NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must -# be provided as a dictionary. -# NAPALM_ARGS = {} - - -# Enable installed plugins. Add the name of each plugin to the list. -# from netbox.configuration.configuration import PLUGINS -# PLUGINS.append('my_plugin') - -# Plugins configuration settings. These settings are used by various plugins that the user may have installed. -# Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings. -# from netbox.configuration.configuration import PLUGINS_CONFIG -# PLUGINS_CONFIG['my_plugin'] = { -# 'foo': 'bar', -# 'buzz': 'bazz' -# } - - -# Remote authentication support -# REMOTE_AUTH_ENABLED = False -# REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend' -# REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER' -# REMOTE_AUTH_AUTO_CREATE_USER = True -# REMOTE_AUTH_DEFAULT_GROUPS = [] -# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} - - -# By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the -# class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: -# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' -# STORAGE_CONFIG = { -# 'AWS_ACCESS_KEY_ID': 'Key ID', -# 'AWS_SECRET_ACCESS_KEY': 'Secret', -# 'AWS_STORAGE_BUCKET_NAME': 'netbox', -# 'AWS_S3_REGION_NAME': 'eu-west-1', -# } diff --git a/configuration/extra.py b/configuration/extra.py new file mode 100644 index 0000000..46f1877 --- /dev/null +++ b/configuration/extra.py @@ -0,0 +1,55 @@ +#### +## This file contains extra configuration options that can't be configured +## directly through environment variables. +#### + +## Specify one or more name and email address tuples representing NetBox administrators. These people will be notified of +## application errors (assuming correct email settings are provided). +# ADMINS = [ +# # ['John Doe', 'jdoe@example.com'], +# ] + + +## URL schemes that are allowed within links in NetBox +# ALLOWED_URL_SCHEMES = ( +# 'file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp', +# ) + + +## NAPALM optional arguments (see http://napalm.readthedocs.io/en/latest/support/#optional-arguments). Arguments must +## be provided as a dictionary. +# NAPALM_ARGS = {} + + +## Enable installed plugins. Add the name of each plugin to the list. +# from netbox.configuration.configuration import PLUGINS +# PLUGINS.append('my_plugin') + +## Plugins configuration settings. These settings are used by various plugins that the user may have installed. +## Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings. +# from netbox.configuration.configuration import PLUGINS_CONFIG +# PLUGINS_CONFIG['my_plugin'] = { +# 'foo': 'bar', +# 'buzz': 'bazz' +# } + + +## Remote authentication support +# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} + + +## By default uploaded media is stored on the local filesystem. Using Django-storages is also supported. Provide the +## class path of the storage driver in STORAGE_BACKEND and any configuration options in STORAGE_CONFIG. For example: +# STORAGE_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage' +# STORAGE_CONFIG = { +# 'AWS_ACCESS_KEY_ID': 'Key ID', +# 'AWS_SECRET_ACCESS_KEY': 'Secret', +# 'AWS_STORAGE_BUCKET_NAME': 'netbox', +# 'AWS_S3_REGION_NAME': 'eu-west-1', +# } + + +## This file can contain arbitrary Python code, e.g.: +# from datetime import datetime +# now = datetime.now().strftime("%d/%m/%Y %H:%M:%S") +# BANNER_TOP = f'This instance started on {now}.' From 75554ef5b48dbb67df5eacd76bb24f47c8ac7617 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 21:29:08 +0200 Subject: [PATCH 10/14] Consistency in namespace name --- docker/configuration.docker.py | 2 +- docker/ldap_config.docker.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docker/configuration.docker.py b/docker/configuration.docker.py index a47c353..68a12e4 100644 --- a/docker/configuration.docker.py +++ b/docker/configuration.docker.py @@ -35,7 +35,7 @@ def _import(module_name, path): _main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') if isfile(_main_config_path): - _import(f'{_MODULE}.configuration', _main_config_path) + _import(f'{_MODULE}.{_MAIN_CONFIG}', _main_config_path) else: print(f"⚠️ Main configuration '{_main_config_path}' not found.") diff --git a/docker/ldap_config.docker.py b/docker/ldap_config.docker.py index 7248195..ca8329d 100644 --- a/docker/ldap_config.docker.py +++ b/docker/ldap_config.docker.py @@ -35,7 +35,7 @@ def _import(module_name, path): _main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') if isfile(_main_config_path): - _import(f'{_MODULE}.configuration', _main_config_path) + _import(f'{_MODULE}.{_MAIN_CONFIG}', _main_config_path) else: print(f"⚠️ Main configuration '{_main_config_path}' not found.") From ec3fd8a7907f19d406c87d7e6ef954a39e8cd972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 21:36:40 +0200 Subject: [PATCH 11/14] Revert accidential change to _read_secret order --- configuration/configuration.py | 12 ++++++------ configuration/ldap/ldap_config.py | 2 +- docker/configuration.docker.py | 1 - docker/ldap_config.docker.py | 1 - 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/configuration/configuration.py b/configuration/configuration.py index 4d1a146..f111c19 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -41,7 +41,7 @@ ALLOWED_HOSTS = environ.get('ALLOWED_HOSTS', '*').split(' ') DATABASE = { 'NAME': environ.get('DB_NAME', 'netbox'), # Database name 'USER': environ.get('DB_USER', ''), # PostgreSQL username - 'PASSWORD': environ.get('DB_PASSWORD', _read_secret('db_password')), + 'PASSWORD': _read_secret('db_password', environ.get('DB_PASSWORD', '')), # PostgreSQL password 'HOST': environ.get('DB_HOST', 'localhost'), # Database server 'PORT': environ.get('DB_PORT', ''), # Database port (leave blank for default) @@ -58,14 +58,14 @@ REDIS = { 'tasks': { 'HOST': environ.get('REDIS_HOST', 'localhost'), 'PORT': int(environ.get('REDIS_PORT', 6379)), - 'PASSWORD': environ.get('REDIS_PASSWORD', _read_secret('redis_password')), + 'PASSWORD': _read_secret('redis_password', environ.get('REDIS_PASSWORD', '')), 'DATABASE': int(environ.get('REDIS_DATABASE', 0)), 'SSL': environ.get('REDIS_SSL', 'False').lower() == 'true', }, 'caching': { 'HOST': environ.get('REDIS_CACHE_HOST', environ.get('REDIS_HOST', 'localhost')), 'PORT': int(environ.get('REDIS_CACHE_PORT', environ.get('REDIS_PORT', 6379))), - 'PASSWORD': environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', _read_secret('redis_cache_password'))), + 'PASSWORD': _read_secret('redis_cache_password', environ.get('REDIS_CACHE_PASSWORD', environ.get('REDIS_PASSWORD', ''))), 'DATABASE': int(environ.get('REDIS_CACHE_DATABASE', 1)), 'SSL': environ.get('REDIS_CACHE_SSL', environ.get('REDIS_SSL', 'False')).lower() == 'true', }, @@ -75,7 +75,7 @@ REDIS = { # For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and # symbols. NetBox will not run without this defined. For more information, see # https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY -SECRET_KEY = environ.get('SECRET_KEY', _read_secret('secret_key')) +SECRET_KEY = _read_secret('secret_key', environ.get('SECRET_KEY')) ######################### @@ -130,7 +130,7 @@ EMAIL = { 'SERVER': environ.get('EMAIL_SERVER', 'localhost'), 'PORT': int(environ.get('EMAIL_PORT', 25)), 'USERNAME': environ.get('EMAIL_USERNAME', ''), - 'PASSWORD': environ.get('EMAIL_PASSWORD', _read_secret('email_password')), + 'PASSWORD': _read_secret('email_password', environ.get('EMAIL_PASSWORD', '')), 'USE_SSL': environ.get('EMAIL_USE_SSL', 'False').lower() == 'true', 'USE_TLS': environ.get('EMAIL_USE_TLS', 'False').lower() == 'true', 'SSL_CERTFILE': environ.get('EMAIL_SSL_CERTFILE', ''), @@ -176,7 +176,7 @@ METRICS_ENABLED = environ.get('METRICS_ENABLED', 'False').lower() == 'true' # Credentials that NetBox will uses to authenticate to devices when connecting via NAPALM. NAPALM_USERNAME = environ.get('NAPALM_USERNAME', '') -NAPALM_PASSWORD = environ.get('NAPALM_PASSWORD', _read_secret('napalm_password')) +NAPALM_PASSWORD = _read_secret('napalm_password', environ.get('NAPALM_PASSWORD', '')) # NAPALM timeout (in seconds). (Default: 30) NAPALM_TIMEOUT = int(environ.get('NAPALM_TIMEOUT', 30)) diff --git a/configuration/ldap/ldap_config.py b/configuration/ldap/ldap_config.py index b92a79a..d1e4444 100644 --- a/configuration/ldap/ldap_config.py +++ b/configuration/ldap/ldap_config.py @@ -32,7 +32,7 @@ AUTH_LDAP_CONNECTION_OPTIONS = { # Set the DN and password for the NetBox service account. AUTH_LDAP_BIND_DN = environ.get('AUTH_LDAP_BIND_DN', '') -AUTH_LDAP_BIND_PASSWORD = environ.get('AUTH_LDAP_BIND_PASSWORD', _read_secret('auth_ldap_bind_password')) +AUTH_LDAP_BIND_PASSWORD = _read_secret('auth_ldap_bind_password', environ.get('AUTH_LDAP_BIND_PASSWORD', '')) # Set a string template that describes any user’s distinguished name based on the username. AUTH_LDAP_USER_DN_TEMPLATE = environ.get('AUTH_LDAP_USER_DN_TEMPLATE', None) diff --git a/docker/configuration.docker.py b/docker/configuration.docker.py index 68a12e4..1a3590d 100644 --- a/docker/configuration.docker.py +++ b/docker/configuration.docker.py @@ -54,7 +54,6 @@ with scandir(_CONFIG_DIR) as it: continue module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") - _import(module_name, f.path) if len(_loaded_configurations) == 0: diff --git a/docker/ldap_config.docker.py b/docker/ldap_config.docker.py index ca8329d..45ffe7c 100644 --- a/docker/ldap_config.docker.py +++ b/docker/ldap_config.docker.py @@ -54,7 +54,6 @@ with scandir(_CONFIG_DIR) as it: continue module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") - _import(module_name, f.path) if len(_loaded_configurations) == 0: From d0c7b87925b5d876e0f7a8f1609686ffa9e061f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 21:40:14 +0200 Subject: [PATCH 12/14] Improve order in configuration.py --- configuration/configuration.py | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/configuration/configuration.py b/configuration/configuration.py index f111c19..7d5477c 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -205,12 +205,11 @@ RACK_ELEVATION_DEFAULT_UNIT_HEIGHT = int(environ.get('RACK_ELEVATION_DEFAULT_UNI RACK_ELEVATION_DEFAULT_UNIT_WIDTH = int(environ.get('RACK_ELEVATION_DEFAULT_UNIT_WIDTH', 220)) # Remote authentication support -REMOTE_AUTH_ENABLED = False -# REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend' -# REMOTE_AUTH_HEADER = 'HTTP_REMOTE_USER' -# REMOTE_AUTH_AUTO_CREATE_USER = True -# REMOTE_AUTH_DEFAULT_GROUPS = [] -# REMOTE_AUTH_DEFAULT_PERMISSIONS = {} +REMOTE_AUTH_ENABLED = environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true' +REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend') +REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') +REMOTE_AUTH_AUTO_CREATE_USER = environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true' +REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' '))) # This determines how often the GitHub API is called to check the latest release of NetBox. Must be at least 1 hour. RELEASE_CHECK_TIMEOUT = int(environ.get('RELEASE_CHECK_TIMEOUT', 24 * 3600)) @@ -236,13 +235,6 @@ SCRIPTS_ROOT = environ.get('SCRIPTS_ROOT', '/etc/netbox/scripts') # database access.) Note that the user as which NetBox runs must have read and write permissions to this path. SESSION_FILE_PATH = environ.get('REPORTS_ROOT', None) -# Remote authentication support -REMOTE_AUTH_ENABLED = environ.get('REMOTE_AUTH_ENABLED', 'False').lower() == 'true' -REMOTE_AUTH_BACKEND = environ.get('REMOTE_AUTH_BACKEND', 'netbox.authentication.RemoteUserBackend') -REMOTE_AUTH_HEADER = environ.get('REMOTE_AUTH_HEADER', 'HTTP_REMOTE_USER') -REMOTE_AUTH_AUTO_CREATE_USER = environ.get('REMOTE_AUTH_AUTO_CREATE_USER', 'True').lower() == 'true' -REMOTE_AUTH_DEFAULT_GROUPS = list(filter(None, environ.get('REMOTE_AUTH_DEFAULT_GROUPS', '').split(' '))) - # Time zone (default: UTC) TIME_ZONE = environ.get('TIME_ZONE', 'UTC') From 2dba2b881131bc020724a9d95a84370bb94e9073 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20M=C3=A4der?= Date: Tue, 20 Oct 2020 21:45:37 +0200 Subject: [PATCH 13/14] Fix default for secret_key in configuration.py --- configuration/configuration.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configuration/configuration.py b/configuration/configuration.py index 7d5477c..639e1b6 100644 --- a/configuration/configuration.py +++ b/configuration/configuration.py @@ -75,7 +75,7 @@ REDIS = { # For optimal security, SECRET_KEY should be at least 50 characters in length and contain a mix of letters, numbers, and # symbols. NetBox will not run without this defined. For more information, see # https://docs.djangoproject.com/en/stable/ref/settings/#std:setting-SECRET_KEY -SECRET_KEY = _read_secret('secret_key', environ.get('SECRET_KEY')) +SECRET_KEY = _read_secret('secret_key', environ.get('SECRET_KEY', '')) ######################### From 58050e5287f92ad8c6d2c3ce2126c047678063d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Ma=CC=88der?= Date: Mon, 26 Oct 2020 14:43:11 +0100 Subject: [PATCH 14/14] Merge core functionality into `configuration.py` Which is the file `docker/configuration.docker.py` in our repo. The common code is then imported by `docker/ldap_config.docker.py`. --- docker/configuration.docker.py | 112 +++++++++++++++++++-------------- docker/ldap_config.docker.py | 56 ++--------------- 2 files changed, 70 insertions(+), 98 deletions(-) diff --git a/docker/configuration.docker.py b/docker/configuration.docker.py index 1a3590d..e7a7c55 100644 --- a/docker/configuration.docker.py +++ b/docker/configuration.docker.py @@ -1,12 +1,73 @@ +## Generic Parts +# These functions are providing the functionality to load +# arbitrary configuration files. +# +# They can be imported by other code (see `ldap_config.py` for an example). + from os.path import abspath, isfile from os import scandir import importlib.util import sys -_CONFIG_DIR = '/etc/netbox/config/' -_MAIN_CONFIG = 'configuration' -_MODULE = 'netbox.configuration' -_loaded_configurations = [] +def _filename(f): + return f.name + + +def _import(module_name, path, loaded_configurations): + spec = importlib.util.spec_from_file_location('', path) + module = importlib.util.module_from_spec(spec) + spec.loader.exec_module(module) + sys.modules[module_name] = module + + loaded_configurations.insert(0, module) + + print(f"🧬 loaded config '{path}'") + + +def read_configurations(config_module, config_dir, main_config): + loaded_configurations = [] + + main_config_path = abspath(f'{config_dir}/{main_config}.py') + if isfile(main_config_path): + _import(f'{config_module}.{main_config}', main_config_path, loaded_configurations) + else: + print(f"⚠️ Main configuration '{main_config_path}' not found.") + + with scandir(config_dir) as it: + for f in sorted(it, key=_filename): + if not f.is_file(): + continue + + if f.name.startswith('__'): + continue + + if not f.name.endswith('.py'): + continue + + if f.name == f'{config_dir}.py': + continue + + module_name = f"{config_module}.{f.name[:-len('.py')]}".replace(".", "_") + _import(module_name, f.path, loaded_configurations) + + if len(loaded_configurations) == 0: + print(f"‼️ No configuration files found in '{config_dir}'.") + raise ImportError(f"No configuration files found in '{config_dir}'.") + + return loaded_configurations + + +## Specific Parts +# This section's code actually loads the various configuration files +# into the module with the given name. +# It contains the logic to resolve arbitrary configuration options by +# levaraging dynamic programming using `__getattr__`. + + +_loaded_configurations = read_configurations( + config_dir = '/etc/netbox/config/', + config_module = 'netbox.configuration', + main_config = 'configuration') def __getattr__(name): @@ -16,46 +77,3 @@ def __getattr__(name): except: pass raise AttributeError - - -def _filename(f): - return f.name - - -def _import(module_name, path): - spec = importlib.util.spec_from_file_location('', path) - module = importlib.util.module_from_spec(spec) - spec.loader.exec_module(module) - sys.modules[module_name] = module - - _loaded_configurations.insert(0, module) - - print(f"🧬 loaded config '{path}'") - - -_main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') -if isfile(_main_config_path): - _import(f'{_MODULE}.{_MAIN_CONFIG}', _main_config_path) -else: - print(f"⚠️ Main configuration '{_main_config_path}' not found.") - -with scandir(_CONFIG_DIR) as it: - for f in sorted(it, key=_filename): - if not f.is_file(): - continue - - if f.name.startswith('__'): - continue - - if not f.name.endswith('.py'): - continue - - if f.name == f'{_MAIN_CONFIG}.py': - continue - - module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") - _import(module_name, f.path) - -if len(_loaded_configurations) == 0: - print(f"‼️ No configuration files found in '{_CONFIG_DIR}'.") - raise ImportError(f"No configuration files found in '{_CONFIG_DIR}'.") diff --git a/docker/ldap_config.docker.py b/docker/ldap_config.docker.py index 45ffe7c..bcaf7e7 100644 --- a/docker/ldap_config.docker.py +++ b/docker/ldap_config.docker.py @@ -1,12 +1,9 @@ -from os.path import abspath, isfile -from os import scandir -import importlib.util -import sys +from .configuration import read_configurations -_CONFIG_DIR = '/etc/netbox/config/ldap/' -_MAIN_CONFIG = 'ldap_config' -_MODULE = 'netbox.configuration.ldap' -_loaded_configurations = [] +_loaded_configurations = read_configurations( + config_dir = '/etc/netbox/config/ldap/', + config_module = 'netbox.configuration.ldap', + main_config = 'ldap_config') def __getattr__(name): @@ -16,46 +13,3 @@ def __getattr__(name): except: pass raise AttributeError - - -def _filename(f): - return f.name - - -def _import(module_name, path): - spec = importlib.util.spec_from_file_location('', path) - module = importlib.util.module_from_spec(spec) - spec.loader.exec_module(module) - sys.modules[module_name] = module - - _loaded_configurations.insert(0, module) - - print(f"🧬 loaded config '{path}'") - - -_main_config_path = abspath(f'{_CONFIG_DIR}/{_MAIN_CONFIG}.py') -if isfile(_main_config_path): - _import(f'{_MODULE}.{_MAIN_CONFIG}', _main_config_path) -else: - print(f"⚠️ Main configuration '{_main_config_path}' not found.") - -with scandir(_CONFIG_DIR) as it: - for f in sorted(it, key=_filename): - if not f.is_file(): - continue - - if f.name.startswith('__'): - continue - - if not f.name.endswith('.py'): - continue - - if f.name == f'{_MAIN_CONFIG}.py': - continue - - module_name = f"{_MODULE}.{f.name[:-len('.py')]}".replace(".", "_") - _import(module_name, f.path) - -if len(_loaded_configurations) == 0: - print(f"‼️ No configuration files found in '{_CONFIG_DIR}'.") - raise ImportError(f"No configuration files found in '{_CONFIG_DIR}'.")