openwisp-controller/openwisp_controller/config/settings.py at 3816541c20124f9910174dc4cbc53f87fcb16261 · openwisp/openwisp-controller · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
import logging

from django.core.exceptions import ImproperlyConfigured
from django.utils.translation import gettext_lazy as _

from ..settings import get_setting

logger = logging.getLogger(__name__)


BACKENDS = get_setting(
    "BACKENDS",
    (
        ("netjsonconfig.OpenWrt", "OpenWRT"),
        ("netjsonconfig.OpenWisp", "OpenWISP Firmware 1.x"),
    ),
)

VPN_BACKENDS = get_setting(
    "VPN_BACKENDS",
    (
        ("openwisp_controller.vpn_backends.OpenVpn", "OpenVPN"),
        ("openwisp_controller.vpn_backends.Wireguard", "WireGuard"),
        ("openwisp_controller.vpn_backends.VxlanWireguard", "VXLAN over WireGuard"),
        ("openwisp_controller.vpn_backends.ZeroTier", "ZeroTier"),
    ),
)
DEFAULT_BACKEND = get_setting("DEFAULT_BACKEND", BACKENDS[0][0])
DEFAULT_VPN_BACKEND = get_setting("DEFAULT_VPN_BACKEND", VPN_BACKENDS[0][0])
REGISTRATION_ENABLED = get_setting("REGISTRATION_ENABLED", True)
CONSISTENT_REGISTRATION = get_setting("CONSISTENT_REGISTRATION", True)
REGISTRATION_SELF_CREATION = get_setting("REGISTRATION_SELF_CREATION", True)

CONTEXT = get_setting("CONTEXT", {})
assert isinstance(CONTEXT, dict), "OPENWISP_CONTROLLER_CONTEXT must be a dictionary"
DEFAULT_AUTO_CERT = get_setting("DEFAULT_AUTO_CERT", True)
CERT_PATH = get_setting("CERT_PATH", "/etc/x509")
COMMON_NAME_FORMAT = get_setting("COMMON_NAME_FORMAT", "{mac_address}-{name}")
MANAGEMENT_IP_DEVICE_LIST = get_setting("MANAGEMENT_IP_DEVICE_LIST", True)
CONFIG_BACKEND_FIELD_SHOWN = get_setting("CONFIG_BACKEND_FIELD_SHOWN", True)

HARDWARE_ID_ENABLED = get_setting("HARDWARE_ID_ENABLED", False)
HARDWARE_ID_OPTIONS = {
    "blank": not HARDWARE_ID_ENABLED,
    "null": True,
    "max_length": 32,
    "unique": False,
    "verbose_name": _("Serial number"),
    "help_text": _("Serial number of this device"),
}
HARDWARE_ID_OPTIONS.update(get_setting("HARDWARE_ID_OPTIONS", {}))
HARDWARE_ID_AS_NAME = get_setting("HARDWARE_ID_AS_NAME", True)
DEVICE_VERBOSE_NAME = get_setting("DEVICE_VERBOSE_NAME", (_("Device"), _("Devices")))
DEVICE_NAME_UNIQUE = get_setting("DEVICE_NAME_UNIQUE", True)
DEVICE_GROUP_SCHEMA = get_setting(
    "DEVICE_GROUP_SCHEMA", {"type": "object", "properties": {}}
)
SHARED_MANAGEMENT_IP_ADDRESS_SPACE = get_setting(
    "SHARED_MANAGEMENT_IP_ADDRESS_SPACE", True
)
DSA_OS_MAPPING = get_setting("DSA_OS_MAPPING", {})
DSA_DEFAULT_FALLBACK = get_setting("DSA_DEFAULT_FALLBACK", True)
GROUP_PIE_CHART = get_setting("GROUP_PIE_CHART", False)
API_TASK_RETRY_OPTIONS = get_setting(
    "API_TASK_RETRY_OPTIONS",
    dict(max_retries=5, retry_backoff=True, retry_backoff_max=600, retry_jitter=True),
)
WHOIS_GEOIP_ACCOUNT = get_setting("WHOIS_GEOIP_ACCOUNT", "")
WHOIS_GEOIP_KEY = get_setting("WHOIS_GEOIP_KEY", "")
WHOIS_ENABLED = get_setting("WHOIS_ENABLED", False)
WHOIS_CONFIGURED = bool(WHOIS_GEOIP_ACCOUNT and WHOIS_GEOIP_KEY)
if WHOIS_ENABLED and not WHOIS_CONFIGURED:
    raise ImproperlyConfigured(
        "OPENWISP_CONTROLLER_WHOIS_GEOIP_ACCOUNT and "
        "OPENWISP_CONTROLLER_WHOIS_GEOIP_KEY must be set "
        + "when OPENWISP_CONTROLLER_WHOIS_ENABLED is True."
    )
WHOIS_REFRESH_THRESHOLD_DAYS = get_setting("WHOIS_REFRESH_THRESHOLD_DAYS", 90)
if not (
    isinstance(WHOIS_REFRESH_THRESHOLD_DAYS, int) and WHOIS_REFRESH_THRESHOLD_DAYS > 0
):
    raise ImproperlyConfigured(
        "OPENWISP_CONTROLLER_WHOIS_REFRESH_THRESHOLD_DAYS must be a positive integer"
    )