django-ai-kit-auth 2.0.0

Index

• Quick Start

• Api Documentation

  • Login

  • Logout

  • Me

  • Registration

  • Initiate Password Reset

  • Password Reset

  • Validate Password

  • Activate User

• Error Codes

• Signals

Quick Start

1.) Add ai_kit_auth to your INSTALLED_APPS like so:

INSTALLED_APPS = (
    # ...
    "rest_framework",
    # ...
    "ai_kit_auth",
    # ...
    "corsheaders",
)

rest_framework from the pip package djangorestframework and corsheaders from the pip package django-cors-headers are dependencies and must be installed.

The cors headers middleware has to be put into the middleware configuration like so:

MIDDLEWARE = (
    "corsheaders.middleware.CorsMiddleware",
    # ...
)

This middleware has to be put as high as possible in the middlware list.

For more details see the django-cors-headers documentation.

2.) Configuration is namespaced unter AI_KIT_AUTH like so:

AI_KIT_AUTH = {
    "FRONTEND": {
        "URL": "example.com",
    },
    # ...
}

Note that FRONTEND.URL is a required configuration that does not have a default. Default configurations are:

AI_KIT_AUTH = {
    # You can disable any or all of the endpoints created by ai-kit-auth
    # by setting the respective entry in this section to False.
    "ENABLE_ENDPOINTS": {
        "LOGIN": True,
        # Route to activate an email address after registration
        "ACTIVATE_EMAIL": True,
        "LOGOUT": True,
        # Endpoint which checks whether the client making the request is
        # logged in, and if so returns user information
        "ME": True,
        # endpoint to check whether the backend will accept a certain password
        "VALIDATE_PASSWORD": True,
        # Calling this endpoint triggers an email for password recovery to be sent
        "SEND_PW_RESET_MAIL": True,
        # endpoint for actually changing the password
        "RESET_PASSWORD": True,
        # registers a new user
        "REGISTER": True,
    },
    # Templates for all the email notifications to the user
    "EMAIL_TEMPLATES": {
        # Here you can supply a function taking no arguments and returning
        # a dictionary with entries, that you would like to pass to the
        # email template in case you want to provide your own.
        # By default it points to a function that returns an empty dictionary.
        "CUSTOM_DATA_FUNCTION": "ai_kit_auth.services.custom_email_data",
        # is send when the user is created by registration
        "USER_CREATED": {
            "TITLE": "ai_kit_auth/user_created_title.txt",
            "BODY_PLAINTEXT": "ai_kit_auth/user_created_body.txt",
            "BODY_HTML": "ai_kit_auth/user_created_body.html",
        },
        # is send to the user after they triggered the forget password
        # feature. Contains the time limited password reset link
        "RESET_PASSWORD": {
            "TITLE": "ai_kit_auth/reset_password_title.txt",
            "BODY_PLAINTEXT": "ai_kit_auth/reset_password_body.txt",
            "BODY_HTML": "ai_kit_auth/reset_password_body.html",
        },
    },
    # If you need complete control over how the activation email is sent,
    # override this setting with your own function. Ai-kit-auth will pass
    # two arguments: a user object and url as a string, which points to the
    # frontend page which needs to be visited in order to activate the account
    "SEND_USER_ACTIVATION_MAIL": "ai_kit_auth.services.default_send_user_activation_mail",
    # If you need complete control over how the activation email is sent,
    # override this setting with your own function. Ai-kit-auth will pass
    # two arguments: a user object and url as a string, which points to the
    # frontend page which needs to be visited in order to activate the account
    "SEND_ACTIVATION_BY_ADMIN_MAIL": "ai_kit_auth.services.default_send_activation_by_admin_mail",
    # If you need complete control over how the password reset email is sent,
    # override this setting with your own function. Ai-kit-auth will pass
    # two arguments: a user object and url as a string, which points to the
    # frontend page which needs to be visited in order to reset the password
    "SEND_RESET_PW_MAIL": "ai_kit_auth.services.default_send_reset_pw_mail",
    # Set this to False to prevent ai-kit-auth to register its own admin forms
    # with django admin. It will then use the default admin forms from
    # django.contrib.auth.admin or your own forms.
    "USE_AI_KIT_AUTH_ADMIN": True,
    # If you want to configure the layout of the admin form or you use a
    # use model doesn't have all the fields you need, you can supply your
    # own fieldsets.
    "ADMIN_FIELDSETS": (
        (None, {"fields": ("username", "email", "password")}),
        (_("Personal info"), {"fields": ("first_name", "last_name")}),
        (
            _("Permissions"),
            {
                "fields": (
                    "is_active",
                    "is_staff",
                    "is_superuser",
                    "groups",
                    "user_permissions",
                ),
            },
        ),
        (_("Important dates"), {"fields": ("last_login", "date_joined")}),
    ),
    "ADMIN_ADD_FIELDSETS": (
        (
            None,
            {
                "classes": ("wide",),
                "fields": ("username", "email", "password1", "password2"),
            },
        ),
    ),
    # If true, the user has to specify a username in addition to the
    # mail address
    "USERNAME_REQUIRED": False,
    # A serializer which is used by the ai-kit-auth endpoints for
    # sending user information to the frontend. Override it if you need
    # additional information about a user in the frontend, like e.g. avatar
    # image, user role etc.
    # The default USER_SERIALIZER contains id, email and username.
    "USER_SERIALIZER": "ai_kit_auth.serializers.UserSerializer",
    # A serializer which is used by the registration endpoint. Override if
    # you need additional information about the user directly in the
    # registration. The default serializer sets username, password and email
    "REGISTRATION_SERIALIZER": "ai_kit_auth.serializers.RegistrationSerializer",
    # The user model fields which are used to identify a user.
    # They are iterated over in the given order to find a user from the "ident" parameter
    # provided to the views.
    "USER_IDENTITY_FIELDS": ("email", "username"),
    # information about the frontend, mostly the used routes. In most cases
    # the defaults are fine, but can be changed for localisation of the
    # urls.
    # Only the actual frontend url is unset and you will get an
    # configuration error if you don't specify it.
    "FRONTEND": {
        "URL": "",
        "ACTIVATION_ROUTE": "/auth/activation/",
        "RESET_PW_ROUTE": "/auth/reset_password/",
    },
}

In addition to that some general configuration is required:

CORS_ORIGIN_WHITELIST = [
    "http://localhost:8000",
    "http://localhost:3000",
    # add other front-end backend urls
]

CORS_ALLOW_CREDENTIALS = True

CSRF_USE_SESSIONS = True

CSRF_TRUSTED_ORIGINS = [
    "http://localhost:8000",
    "http://localhost:3000",
    # add other front-end backend urls
]

The CSRF_USE_SESSIONS configuration doesn’t need to be set to enable Ai-Kit-Auth, but in prevents problems with double logins, for example if a user is logged into the Admin interface and also logged in the frontend. Django saves CSRF tokens in cookies by default.

Please note that CORS_ORIGIN_WHITELIST takes the whole URL including the scheme (e.g. ‘http://’), whereas CSRF_TRUSTED_ORIGINS takes only the domain, for example: “example.org”.

3.) Include the routes in your urls.py:

urlpatterns = [
    # ...
    path("api/v1/auth/", include("ai_kit_auth.urls"))
    # ...
]

4.) Run python manage.py migrate. Only required if you add the dependencies to your project since this package does not define models on its own.

Login

POST ../login/

visibility: everyone

expects

{
    ident: <username or email>,
    password: <the password>
}

both fields are required. In addition a csrf-token returned from the /me call is needed in the request header as X-CSRFTOKEN. The endpoint answers with the status code 200 and

{
    user: {
        username: <the username>,
        email: <the email address>,
        id: <the internal id>,
    },
    csrf: <csrf token>
}

Error cases:

Field specific errors are given back like so:

{
    <field name>: <error code>
}

fields are ident or password and the only possible error code is blank.

Errors that are not field specific are mapped to the key non_field_errors. Currently, the only error code that can be returned here is invalid_credentials.

Logout

POST ../logout/

visibility: authenticated users

expects

{}

and answers with status code 200 and

{
    csrf: <csrf token>
}

At least when the csrf token is stored via session storage, it changes at logout and you have to update it in the frontend.

Me

GET ../me/

visibility: everyone

The answer is very similar to login: status code 200 and

{
    user: null | {
        username: <the username>,
        email: <the email address>,
        id: <the internal id>,
    },
    csrf: <csrf token>
}

The only difference is that me is reachable for anonymous users that are not (yet) logged in. In that case, the user property is set to null.

Error Codes

The backend never sends user facing error messages, but general error codes. Internationalisation happens in the frontend.

Another reason for getting password_reset_link_invalid might be that you are logged in into the django admin view with the same user you are trying to reset the password for.

Signals

You can use the Signals AI-Kit Authentication emits when states are changed. The following Signals are available:

• user_pre_login is emitted before a login request is handled

• user_post_login is emitted after a login request is handled

• user_pre_logout is emitted before a logout request is handled

• user_post_logout is emitted after a logout request is handled

• user_pre_registered is emitted before a request to register is handled

• user_post_registered is emitted after a request to register is handled

• user_pre_activated is emitted before a request to activate a user is handled

• user_post_activated is emitted after a request to activate a user is handled

• user_pre_forgot_password is emitted before a forgot_password request is handled

• user_post_forgot_password is emitted after a forgot_password request is handled

• user_pre_reset_password is emitted before a reset_password request is handled

• user_post_reset_password is emitted after a reset_password request is handled