mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Add logging output to login/logout views

Browse Source
This commit is contained in:
Jeremy Stretch
2020-03-02 17:04:54 -05:00
parent 7a10748355
commit c983dac771
2 changed files with 28 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/configuration/logging.md
View File

@ -2,7 +2,8 @@
### Available Loggers ### Available Loggers
| Name | Function | | Name | Function |
|----------------------|----------| |---------------------------------|--------------------------------------------------------|
| `netbox.views.*` | Views which handle business logic for the web UI | | `netbox.auth.*` | Authentication events |
| `netbox.api.views.*` | Views which handle business logic for the web UI | | `netbox.api.views.*` | Views which handle business logic for the REST API |
| `netbox.views.*` | Views which handle business logic for the web UI |

26
netbox/users/views.py
View File

@ -1,3 +1,5 @@
import logging
from django.conf import settings from django.conf import settings
from django.contrib import messages from django.contrib import messages
from django.contrib.auth import login as auth_login, logout as auth_logout, update_session_auth_hash from django.contrib.auth import login as auth_login, logout as auth_logout, update_session_auth_hash
@ -24,6 +26,9 @@ from .models import Token
# #
class LoginView(View): class LoginView(View):
"""
Perform user authentication via the web UI.
"""
template_name = 'login.html' template_name = 'login.html'
@method_decorator(sensitive_post_parameters('password')) @method_decorator(sensitive_post_parameters('password'))
@ -38,36 +43,51 @@ class LoginView(View):
}) })
def post(self, request): def post(self, request):
logger = logging.getLogger('netbox.auth.login')
form = LoginForm(request, data=request.POST) form = LoginForm(request, data=request.POST)
if form.is_valid(): if form.is_valid():
logger.debug("Login form validation was successful")
# Determine where to direct user after successful login # Determine where to direct user after successful login
redirect_to = request.POST.get('next', '') redirect_to = request.POST.get('next')
if not is_safe_url(url=redirect_to, allowed_hosts=request.get_host()): if redirect_to and not is_safe_url(url=redirect_to, allowed_hosts=request.get_host()):
logger.warning(f"Ignoring unsafe 'next' URL passed to login form: {redirect_to}")
redirect_to = reverse('home') redirect_to = reverse('home')
# If maintenance mode is enabled, assume the database is read-only, and disable updating the user's # If maintenance mode is enabled, assume the database is read-only, and disable updating the user's
# last_login time upon authentication. # last_login time upon authentication.
if settings.MAINTENANCE_MODE: if settings.MAINTENANCE_MODE:
logger.warning("Maintenance mode enabled: disabling update of most recent login time")
user_logged_in.disconnect(update_last_login, dispatch_uid='update_last_login') user_logged_in.disconnect(update_last_login, dispatch_uid='update_last_login')
# Authenticate user # Authenticate user
auth_login(request, form.get_user()) auth_login(request, form.get_user())
logger.info(f"User {request.user} successfully authenticated")
messages.info(request, "Logged in as {}.".format(request.user)) messages.info(request, "Logged in as {}.".format(request.user))
logger.debug(f"Redirecting user to {redirect_to}")
return HttpResponseRedirect(redirect_to) return HttpResponseRedirect(redirect_to)
else:
logger.debug("Login form validation failed")
return render(request, self.template_name, { return render(request, self.template_name, {
'form': form, 'form': form,
}) })
class LogoutView(View): class LogoutView(View):
"""
Deauthenticate a web user.
"""
def get(self, request): def get(self, request):
logger = logging.getLogger('netbox.auth.logout')
# Log out the user # Log out the user
username = request.user
auth_logout(request) auth_logout(request)
logger.info(f"User {username} has logged out")
messages.info(request, "You have logged out.") messages.info(request, "You have logged out.")
# Delete session key cookie (if set) upon logout # Delete session key cookie (if set) upon logout