swh.web.auth.models module

class swh.web.auth.models.OIDCUser(*args, **kwargs)

Bases: django.contrib.auth.models.User

Custom User proxy model for remote users storing OpenID Connect related data: profile containing authentication tokens.

The model is also not saved to database as all users are already stored in the Keycloak one.

sub: str = ''

access_token: Optional[str] = None

expires_at: Optional[datetime.datetime] = None

id_token: Optional[str] = None

refresh_token: Optional[str] = None

refresh_expires_at: Optional[datetime.datetime] = None

scope: Optional[str] = None

session_state: Optional[str] = None

permissions: Set[str]

save(**kwargs)

Override django.db.models.Model.save to avoid saving the remote users to web application database.

get_group_permissions(obj=None) → Set[str]

Override django.contrib.auth.models.PermissionsMixin.get_group_permissions to get permissions from OIDC

get_all_permissions(obj=None) → Set[str]

Override django.contrib.auth.models.PermissionsMixin.get_all_permissions to get permissions from OIDC

has_perm(perm, obj=None) → bool

Override django.contrib.auth.models.PermissionsMixin.has_perm to check permission from OIDC

has_module_perms(app_label) → bool

Override django.contrib.auth.models.PermissionsMixin.has_module_perms to check permissions from OIDC.

exception DoesNotExist

Bases: django.contrib.auth.models.User.DoesNotExist

exception MultipleObjectsReturned

Bases: django.contrib.auth.models.User.MultipleObjectsReturned

class swh.web.auth.models.OIDCUserOfflineTokens(*args, **kwargs)

Bases: django.db.models.base.Model

Model storing encrypted bearer tokens generated by users.

user_id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

creation_date

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

offline_token

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

get_next_by_creation_date(*, field=<django.db.models.fields.DateTimeField: creation_date>, is_next=True, **kwargs)

get_previous_by_creation_date(*, field=<django.db.models.fields.DateTimeField: creation_date>, is_next=False, **kwargs)

id

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

objects = <django.db.models.manager.Manager object>