LDAP import error when enabling "netbox.authentication.LDAPBackend"

[KodySalak]

When I enable "netbox.authentication.LDAPBackend" on the "REMOTE_AUTH_BACKEND" and restart Netbox, I get a "Server Error" on the webpage stating the following:

<class 'ImportError'>

cannot import name 'ldap_config' from 'netbox' (/opt/netbox/netbox/netbox/__init__.py)

Python version: 3.10.15
NetBox version: 4.1.0
Plugins: None installed

My logging is enabled with the following:

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'file': {
            'level': 'DEBUG',
            'class': 'logging.FileHandler',
            'filename': '/opt/netbox/log/netbox.log',
        },
    },
    'loggers': {
        'django': {
            'handlers': ['file'],
            'level': 'DEBUG',
        },
    },
}

and I get the following (I am running through a reverse proxy, is that a potential issue?):

Internal Server Error: /
Exception while resolving variable 'url_name' in template '404.html'.
Traceback (most recent call last):
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/core/handlers/exception.py", line 55, in inner
    response = get_response(request)
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/core/handlers/base.py", line 181, in _get_response
    callback, callback_args, callback_kwargs = self.resolve_request(request)
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/core/handlers/base.py", line 313, in resolve_request
    resolver_match = resolver.resolve(request.path_info)
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/urls/resolvers.py", line 725, in resolve
    raise Resolver404({"tried": tried, "path": new_path})
django.urls.exceptions.Resolver404: {'tried': [[<URLResolver <URLPattern list> (None:None) ''>, <URLPattern '' [name='home']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'search/' [name='search']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'login/' [name='login']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'logout/' [name='logout']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'social_django.urls' from '/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/social_django/urls.py'> (social:social) 'oauth/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'circuits.urls' from '/opt/netbox/netbox/circuits/urls.py'> (circuits:circuits) 'circuits/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'core.urls' from '/opt/netbox/netbox/core/urls.py'> (core:core) 'core/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'dcim.urls' from '/opt/netbox/netbox/dcim/urls.py'> (dcim:dcim) 'dcim/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'extras.urls' from '/opt/netbox/netbox/extras/urls.py'> (extras:extras) 'extras/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'ipam.urls' from '/opt/netbox/netbox/ipam/urls.py'> (ipam:ipam) 'ipam/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'tenancy.urls' from '/opt/netbox/netbox/tenancy/urls.py'> (tenancy:tenancy) 'tenancy/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'users.urls' from '/opt/netbox/netbox/users/urls.py'> (users:users) 'users/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'virtualization.urls' from '/opt/netbox/netbox/virtualization/urls.py'> (virtualization:virtualization) 'virtualization/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'vpn.urls' from '/opt/netbox/netbox/vpn/urls.py'> (vpn:vpn) 'vpn/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'wireless.urls' from '/opt/netbox/netbox/wireless/urls.py'> (wireless:wireless) 'wireless/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'account.urls' from '/opt/netbox/netbox/account/urls.py'> (account:account) 'user/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'htmx/object-selector/' [name='htmx_object_selector']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'api/' [name='api-root']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'circuits.api.urls' from '/opt/netbox/netbox/circuits/api/urls.py'> (circuits-api:circuits-api) 'api/circuits/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'core.api.urls' from '/opt/netbox/netbox/core/api/urls.py'> (core-api:core-api) 'api/core/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'dcim.api.urls' from '/opt/netbox/netbox/dcim/api/urls.py'> (dcim-api:dcim-api) 'api/dcim/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'extras.api.urls' from '/opt/netbox/netbox/extras/api/urls.py'> (extras-api:extras-api) 'api/extras/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'ipam.api.urls' from '/opt/netbox/netbox/ipam/api/urls.py'> (ipam-api:ipam-api) 'api/ipam/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'tenancy.api.urls' from '/opt/netbox/netbox/tenancy/api/urls.py'> (tenancy-api:tenancy-api) 'api/tenancy/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'users.api.urls' from '/opt/netbox/netbox/users/api/urls.py'> (users-api:users-api) 'api/users/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'virtualization.api.urls' from '/opt/netbox/netbox/virtualization/api/urls.py'> (virtualization-api:virtualization-api) 'api/virtualization/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'vpn.api.urls' from '/opt/netbox/netbox/vpn/api/urls.py'> (vpn-api:vpn-api) 'api/vpn/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <module 'wireless.api.urls' from '/opt/netbox/netbox/wireless/api/urls.py'> (wireless-api:wireless-api) 'api/wireless/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'api/status/' [name='api-status']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'api/schema/' [name='schema']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'api/schema/swagger-ui/' [name='api_docs']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'api/schema/redoc/' [name='api_redocs']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'graphql/' [name='graphql']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'media/<path:path>'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLPattern 'media-failure/' [name='media_failure']>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver [] (plugins:plugins) 'plugins/'>], [<URLResolver <URLPattern list> (None:None) ''>, <URLResolver <URLPattern list> (plugins-api:plugins-api) 'api/plugins/'>]], 'path': 'favicon.ico'}

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/template/base.py", line 875, in _resolve_lookup
    current = current[bit]
TypeError: 'NoneType' object is not subscriptable

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/template/base.py", line 885, in _resolve_lookup
    current = getattr(current, bit)
AttributeError: 'NoneType' object has no attribute 'url_name'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/template/base.py", line 891, in _resolve_lookup
    current = current[int(bit)]
ValueError: invalid literal for int() with base 10: 'url_name'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/opt/netbox-4.1.0/venv/lib/python3.10/site-packages/django/template/base.py", line 898, in _resolve_lookup
    raise VariableDoesNotExist(
django.template.base.VariableDoesNotExist: Failed lookup for key [url_name] in None

My ldap_configuration.py:

import ldap
from django_auth_ldap.config import LDAPSearch, NestedGroupOfNamesType


# Server URI
AUTH_LDAP_SERVER_URI = "ldap://mydomain.local"

# The following may be needed if you are binding to Active Directory.
AUTH_LDAP_CONNECTION_OPTIONS = {
    ldap.OPT_REFERRALS: 0
}

# Set the DN and password for the NetBox service account.
AUTH_LDAP_BIND_DN = "CN=Netbox SA,OU=ServiceAccounts,OU=Users,OU=Default,DC=mydomain,DC=local"
AUTH_LDAP_BIND_PASSWORD = "VwSAFDcUGNx"
AUTH_LDAP_USER_DN_TEMPLATE = "uid=%(user)s,ou=AzureADSync,dc=mydomain,dc=local"


# This search matches users with the sAMAccountName equal to the provided username. This is required if the user's
# username is not in their DN (Active Directory).
AUTH_LDAP_USER_SEARCH = LDAPSearch(
    "dc=mydomain,dc=local",
    ldap.SCOPE_SUBTREE,
    "(|(userPrincipalName=%(user)s)(sAMAccountName=%(user)s))"
)

# If a user's DN is producible from their username, we don't need to search.
# AUTH_LDAP_USER_DN_TEMPLATE = None

# You can map user attributes to Django attributes as so.
AUTH_LDAP_USER_ATTR_MAP = {
    "first_name": "givenName",
    "last_name": "sn",
    "email": "mail"
}

AUTH_LDAP_USER_QUERY_FIELD = "username"

# This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
# hierarchy.
AUTH_LDAP_GROUP_SEARCH = LDAPSearch(
    "dc=mydomain,dc=local",
    ldap.SCOPE_SUBTREE,
    "(objectClass=group)"
)
AUTH_LDAP_GROUP_TYPE = NestedGroupOfNamesType()

# Define a group required to login.
AUTH_LDAP_REQUIRE_GROUP = "CN=Netbox-Admins,OU=Security,OU=Groups,OU=Default,DC=mydomain,DC=local"

# Mirror LDAP group assignments.
AUTH_LDAP_MIRROR_GROUPS = True

# Define special user types using groups. Exercise great caution when assigning superuser status.
AUTH_LDAP_USER_FLAGS_BY_GROUP = {
    "is_active": "CN=Netbox-Admins,OU=Security,OU=Groups,OU=Default,DC=mydomain,DC=local",
    "is_staff": "CN=Netbox-Staff,OU=Security,OU=Groups,OU=Default,DC=mydomain,DC=local",
    "is_superuser": "CN=Netbox.Admin,OU=Security,OU=FC Groups,dc=mydomain,dc=local"
}

# For more granular permissions, we can map LDAP groups to Django groups.
AUTH_LDAP_FIND_GROUP_PERMS = True

# Cache groups for one hour to reduce LDAP traffic
AUTH_LDAP_CACHE_TIMEOUT = 3600
AUTH_LDAP_ALWAYS_UPDATE_USER = True

Proof that the modules are installed in apt:

localadmin@netbox:/opt/netbox/netbox/netbox$ sudo apt install -y libldap2-dev libsasl2-dev libssl-dev
[sudo] password for localadmin:
Reading package lists... Done
Building dependency tree
Reading state information... Done
libldap2-dev is already the newest version (2.4.49+dfsg-2ubuntu1.10).
libsasl2-dev is already the newest version (2.1.27+dfsg-2ubuntu0.1).
libssl-dev is already the newest version (1.1.1f-1ubuntu2.23).
0 upgraded, 0 newly installed, 0 to remove and 7 not upgraded.

Proof of djanjo's LDAP module installed:

root@netbox:~# source /opt/netbox/venv/bin/activate
(venv) root@netbox:~# pip3 install django-auth-ldap
Requirement already satisfied: django-auth-ldap in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (4.8.0)
Requirement already satisfied: Django>=3.2 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from django-auth-ldap) (5.0.9)
Requirement already satisfied: python-ldap>=3.1 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from django-auth-ldap) (3.4.4)
Requirement already satisfied: asgiref<4,>=3.7.0 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from Django>=3.2->django-auth-ldap) (3.8.1)
Requirement already satisfied: sqlparse>=0.3.1 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from Django>=3.2->django-auth-ldap) (0.5.1)
Requirement already satisfied: pyasn1>=0.3.7 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from python-ldap>=3.1->django-auth-ldap) (0.6.1)
Requirement already satisfied: pyasn1-modules>=0.1.5 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from python-ldap>=3.1->django-auth-ldap) (0.4.1)
Requirement already satisfied: typing-extensions>=4 in /opt/netbox-4.1.0/venv/lib/python3.10/site-packages (from asgiref<4,>=3.7.0->Django>=3.2->django-auth-ldap) (4.12.2)

I had to switch to sudo -i because when I tried to pip as my user account I got a permissions issue, is that what's causing this?

Any help would be appreciated.

[candlerb]

cannot import name 'ldap_config' from 'netbox'

According to the documentation here, you are required to create the file /opt/netbox/netbox/netbox/ldap_config.py (not ldap_configuration.py as you said you had created)

But as to why you have a 404 error on /, and why the 404 error page itself generates an exception, I have no idea. Something else seems to be broken. I suggest you get Netbox working by itself first, without LDAP authentication. Then when it's working, add the LDAP part.

[candlerb]

Another thing you can try is to run from the Linux shell:

/opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py nbshell

If it fails, you may get a better backtrace showing where the error is. If it succeeds and gives a >>> prompt, then try

from netbox import ldap_config

[KodySalak]

It was working before switching the LDAP feature on.

Renaming that config file to the correct name fixed it.