Logger name syntax is invalid for authentication events

[markkuleinio]

Change Type

Correction

Area

Configuration parameters

Proposed Changes

In https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#available-loggers it says:

netbox.auth.* - Authentication events

But apparently it should be netbox.authentication.*:

2021-12-03 10:20:19,352 netbox.authentication.RemoteUserBackend DEBUG: trying to authenticate markku with groups None

Tested with NetBox 3.0.11.

[kkthxbye-code]

You sure the documentation isn't correct?

netbox/netbox/users/views.py

Lines 36 to 49 in e05fa5c

	def get(self, request):
	form = LoginForm(request)
	if request.user.is_authenticated:
	logger = logging.getLogger('netbox.auth.login')
	return self.redirect_to_next(request, logger)
	return render(request, self.template_name, {
	'form': form,
	})
	def post(self, request):
	logger = logging.getLogger('netbox.auth.login')
	form = LoginForm(request, data=request.POST)

netbox.authentication.RemoteUserBackend is the path to the class, not the name of the logger.

I actually think the issue is that the wrong logger is request in RemoteBackend.

netbox/netbox/netbox/authentication.py

Lines 99 to 108 in 83010e2

	class RemoteUserBackend(_RemoteUserBackend):
	"""
	Custom implementation of Django's RemoteUserBackend which provides configuration hooks for basic customization.
	"""
	@property
	def create_unknown_user(self):
	return settings.REMOTE_AUTH_AUTO_CREATE_USER
	def configure_groups(self, user, remote_groups):
	logger = logging.getLogger('netbox.authentication.RemoteUserBackend')

One of the places should be changed.

[markkuleinio]

Yes my logger format is '%(asctime)s %(name)s %(levelname)s: %(message)s' so netbox.authentication.RemoteUserBackend is the logger name that was used there as you pointed out.

Let me know if a new issue or PR is needed.

[jeremystretch]

I actually think the issue is that the wrong logger is request in RemoteBackend.

Agreed. I'm going to change it to netbox.auth.RemoteBackend.