Фиктивный провайдер аутентификации

Описание

Этот провайдер аутентификации позволяет войти в систему с любым именем пользователя и паролем, а затем выдаёт токен доступа.

После успешной аутентификации имя пользователя сохраняется в базе данных сервера.

Схема взаимодействия

sequenceDiagram
participant "Клиент"
participant "Сервер"

activate "Клиент"
alt Успешный кейс
"Клиент" ->> "Сервер" : логин + пароль
"Сервер" ->> "Сервер" : пароль полностью игнорируется
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" ->> "Сервер" : Создать пользователя, если  он еще не существует
"Сервер" ->> "Клиент" : Сгенерировать и вернуть токен доступа

else Пользователь заблокирован
"Клиент" ->> "Сервер" : логин + пароль
"Сервер" ->> "Сервер" : пароль полностью игнорируется
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" --x "Клиент" : 401 Неаторизован

else Пользователь удален
"Клиент" ->> "Сервер" : логин + пароль
"Сервер" ->> "Сервер" : пароль полностью игнорируется
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" --x "Клиент" : 404 Не найден
end

alt Успешный кейс
"Клиент" ->> "Сервер" : токен доступа
"Сервер" ->> "Сервер" : Валидация токена
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" ->> "Сервер" : Получение данных
"Сервер" ->> "Клиент" : Возврат данных

else Токен истек
"Клиент" ->> "Сервер" : токен доступа
"Сервер" ->> "Сервер" : Валидация токена
"Сервер" --x "Клиент" : 401 Неаторизован

else Пользователь заблокирован
"Клиент" ->> "Сервер" : токен доступа
"Сервер" ->> "Сервер" : Валидация токена
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" --x "Клиент" : 401 Неаторизован

else Пользователь удален
"Клиент" ->> "Сервер" : токен доступа
"Сервер" ->> "Сервер" : Валидация токена
"Сервер" ->> "Сервер" : Проверка пользователя во внутренней базе данных сервера
"Сервер" --x "Клиент" : 404 Не найден
end

deactivate "Клиент"

Конфигурация

Bases: BaseModel

Settings for DummyAuthProvider.

Examples

.. code-block:: yaml :caption: config.yml

auth:
    provider: syncmaster.server.providers.auth.dummy_provider.DummyAuthProvider
    access_key:
        secret_key: jwt_secret

Source code in syncmaster/server/settings/auth/dummy.py

class DummyAuthProviderSettings(BaseModel):
    """Settings for DummyAuthProvider.

    Examples
    --------

    .. code-block:: yaml
        :caption: config.yml

        auth:
            provider: syncmaster.server.providers.auth.dummy_provider.DummyAuthProvider
            access_key:
                secret_key: jwt_secret
    """

    access_token: JWTSettings = Field(description="Access-token related settings")

Bases: BaseModel

Settings related to JWT tokens.

Examples

.. code-block:: yaml :caption: config.yml

auth:
    access_key:
        secret_key: jwt_secret
        expire_seconds: 3600  # 1 hour

Source code in syncmaster/server/settings/auth/jwt.py

class JWTSettings(BaseModel):
    """Settings related to JWT tokens.

    Examples
    --------

    .. code-block:: yaml
        :caption: config.yml

        auth:
            access_key:
                secret_key: jwt_secret
                expire_seconds: 3600  # 1 hour
    """

    secret_key: SecretStr = Field(
        description=textwrap.dedent(
            """
            Secret key for signing JWT tokens.

            Can be any string. It is recommended to generate random value for every application instance, e.g.:

            .. code:: shell

                pwgen 32 1
            """,
        ),
    )
    security_algorithm: str = Field(
        default="HS256",
        description=textwrap.dedent(
            """
            Algorithm used for signing JWT tokens.

            See `pyjwt <https://pyjwt.readthedocs.io/en/latest/algorithms.html>`_
            documentation.
            """,
        ),
    )
    expire_seconds: int = Field(
        default=10 * 60 * 60,
        description="Token expiration time, in seconds",
    )