How to debug LDAP authentication

[bahner]

I have add the environment variables as I believe they should be and changed to using ldap-images, but there is nothing in the logs that suggests anything LDAP is taking place. Also there are no errors logged when checking the logs for either netbox_netbox or netbox_netbox-worker.

The service works fine otherwise, using the admin password.

[mpibpc-mroose]

What I do is to implement a custom logging:

# logging configuration from scratch
LOGLEVEL = environ.get('LOGLEVEL', 'INFO')

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'verbose': {
            'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',
            'style': '{',
        },
        'simple': {
            'format': '{levelname} {message}',
            'style': '{',
        },
    },
    'filters': {
        'require_debug_false': {
            '()': 'django.utils.log.RequireDebugFalse',
        },
    },
    'handlers': {
        'console': {
            'level': LOGLEVEL,
            'filters': ['require_debug_false'],
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'mail_admins': {
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['require_debug_false']
        }
    },
    'loggers': {
        'django': {
            'handlers': ['console'],
            'propagate': True,
        },
        'django.request': {
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        },
        'django_auth_ldap': {
            'handlers': ['console',],
            'level': LOGLEVEL,
        }
    }
}

Then LOGLEVEL in the netbox.env can be set to DEBUG allowing a deep view into the LDAP debug messages. This could be placed in an logging_conf.py in /configuration.

[ryanmerolle]

Great write up!

[bahner]

I will try that. If it works, I suggest you make this a pull request.

[ryanmerolle]

We can just add to the wiki.

[ryanmerolle]

It works. I have an issue for this and plugins extra config #461

[daniel-zook]

For those of us not well versed in Python yet, FYI: The top of the .py file for this script requires this line:
from os import environ

If that is missing, netbox won't start and the log will show this error:
NameError: name 'environ' is not defined

[bahner]

🤗 ons. 3. mar. 2021, 15:12 skrev Marco Roose <notifications@github.com>:

…

... and maybe check the REMOTE_AUTH_BACKEND = 'netbox.authentication.LDAPBackend'setting from within a running netbox container. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#454 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACNLSL667RJJHTXDUTRRXETTBY7UJANCNFSM4YRGLDQA> .

[HtHNightwolf]

For those of us not well versed in Python yet, FYI: The top of the .py file for this script requires this line: from os import environ

If that is missing, netbox won't start and the log will show this error: NameError: name 'environ' is not defined

Thanks. Now netbox can start with this configuration. But where (and how) do I see the logs then?Until now I have only worked with
'filename': '/opt/netbox/django-ldap-debug.log',
which ended up being a file (obviously).

[jCaffie]

Did you ever figure it out?