intranet.apps.auth package

Subpackages

• intranet.apps.auth.management package
  • Subpackages
    • intranet.apps.auth.management.commands package
      • Submodules
      • intranet.apps.auth.management.commands.grant_admin module
      • Module contents
  • Module contents

Submodules

intranet.apps.auth.apps module

class intranet.apps.auth.apps.AuthConfig(app_name, app_module)

Bases: django.apps.config.AppConfig

label = 'intranet.apps.auth'

name = 'intranet.apps.auth'

intranet.apps.auth.backends module

class intranet.apps.auth.backends.KerberosAuthenticationBackend

Bases: object

Authenticate using Kerberos.

This is the default authentication backend.

authenticate(request, username=None, password=None)

Authenticate a username-password pair.

Creates a new user if one is not already in the database.

Parameters

• username – The username of the User to authenticate.

• password – The password of the User to authenticate.

Returns

User

static get_kerberos_ticket(username, password)

Attempts to create a Kerberos ticket for a user.

Parameters

• username – The username.

• password – The password.

Returns

Boolean indicating success or failure of ticket creation

get_user(user_id)

Returns a user, given his or her user id. Required for a custom authentication backend. :param user_id: The user id of the user to fetch.

Returns

User or None

static kinit_timeout_handle(username, realm)

Check if the user exists before we throw an error.

static try_single_kinit(*, username: str, realm: str, password: str, krb5ccname: str, timeout: Union[int, float]) → intranet.apps.auth.backends.KerberosAuthenticationResult

class intranet.apps.auth.backends.KerberosAuthenticationResult

Bases: enum.Enum

An enumeration.

EXPIRED = -1

FAILURE = 0

SUCCESS = 1

class intranet.apps.auth.backends.MasterPasswordAuthenticationBackend

Bases: object

Authenticate as any user against a master password whose hash is in secret.py.

authenticate(request, username=None, password=None)

Authenticate a username-password pair.

Creates a new user if one is not already in the database.

Parameters

• username – The username of the User to authenticate.

• password – The master password.

Returns

User

get_user(user_id)

Returns a user, given his or her user id. Required for a custom authentication backend. :param user_id: The user id of the user to fetch.

Returns

User or None

intranet.apps.auth.decorators module

Decorators that restrict views to certain types of users.

intranet.apps.auth.decorators.admin_required(group)

Decorator that requires the user to be in a certain admin group.

For example, @admin_required(“polls”) would check whether a user is in the “admin_polls” group or in the “admin_all” group.

intranet.apps.auth.decorators.announcements_admin_required(view_func)

Restrict the wrapped view to announcements admins

intranet.apps.auth.decorators.attendance_taker_required(view_func)

Restrict the wrapped view to users who can take attendance

intranet.apps.auth.decorators.board_admin_required(view_func)

Restrict the wrapped view to board admins

intranet.apps.auth.decorators.deny_restricted(wrapped)

intranet.apps.auth.decorators.eighth_admin_required(view_func)

Restrict the wrapped view to eighth admins

intranet.apps.auth.decorators.events_admin_required(view_func)

Restrict the wrapped view to events admins

intranet.apps.auth.decorators.reauthentication_required(wrapped)

intranet.apps.auth.forms module

class intranet.apps.auth.forms.AuthenticateForm(request=None, *args, **kwargs)

Bases: django.contrib.auth.forms.AuthenticationForm

Implements a login form.

username

The username text field.

password

The password text field.

declared_fields = {'password': <django.forms.fields.CharField object>, 'trust_device': <django.forms.fields.BooleanField object>, 'username': <django.forms.fields.CharField object>}

is_valid()

Validates the username and password in the form.

intranet.apps.auth.helpers module

intranet.apps.auth.helpers.change_password(form_data)

intranet.apps.auth.helpers.get_login_theme() → Dict[str, Dict[str, str]]

Load a custom login theme (e.g. snow)

intranet.apps.auth.helpers.get_login_theme_name() → str

Get the name of the currently active login theme (e.g. “snow” or “piday”).

Returns

The name of the currently active login theme.

intranet.apps.auth.rest_permissions module

class intranet.apps.auth.rest_permissions.DenyRestrictedPermission

Bases: rest_framework.permissions.BasePermission

has_permission(request, view) → bool

intranet.apps.auth.signals module

intranet.apps.auth.signals.user_login(sender, request, **kwargs)

intranet.apps.auth.signals.user_logout(sender, request, **kwargs)

intranet.apps.auth.tests module

class intranet.apps.auth.tests.GrantAdminTest(methodName='runTest')

Bases: intranet.test.ion_test.IonTestCase

Tests granting admin to an user.

test_grant_admin()

Tests giving an valid user admin_all.

class intranet.apps.auth.tests.LoginViewTest(methodName='runTest')

Bases: intranet.test.ion_test.IonTestCase

Tests of the login page (but not actually auth)

static create_block_by_signup_datetime(signup_datetime, **kwargs)

does_login_redirect_to(url)

login_student()

test_authentication()

test_eighth_login_redirect()

test_login_page()

intranet.apps.auth.urls module

intranet.apps.auth.views module

class intranet.apps.auth.views.LoginView(**kwargs)

Bases: django.views.generic.base.View

Log in and redirect a user.

get(request)

Redirect to the login page.

post(request)

Validate and process the login POST request.

intranet.apps.auth.views.about_view(request)

Show an about page with credits.

intranet.apps.auth.views.do_logout(request)

Logout.

intranet.apps.auth.views.get_bg_pattern(request)

Choose a background pattern image.

One will be selected at random.

intranet.apps.auth.views.get_week_sports_school_events() → Tuple[Container[intranet.apps.events.models.Event], Container[intranet.apps.events.models.Event]]

Lists the sports/school events for the next week. This information is cached.

Returns

A 2-tuple of (sports events, school events) for the next week.

intranet.apps.auth.views.index_view(request, auth_form=None, force_login=False, added_context=None, has_next_page=False)

Process and show the main login page or dashboard if logged in.

intranet.apps.auth.views.log_auth(request, success)

intranet.apps.auth.views.logout_view(request)

Clear the Kerberos cache and logout.

intranet.apps.auth.views.reauthentication_view(request)

intranet.apps.auth.views.reset_password_view(request)

Module contents