Iskra.Core.Auth.Abstractions 1.0.116

Документация к библиотеке Iskra.Core.Auth.Abstractions

Обзор

Библиотека Iskra.Core.Auth.Abstractions предоставляет абстракции и интерфейсы для работы с авторизованными пользователями в приложениях. Она включает модели, сервисы и утилиты для обработки информации о пользователях, а также для взаимодействия с токенами доступа.

Содержание

1. Модели
2. Сервисы
3. Утилиты

Модели

UserInfo

Класс UserInfo представляет информацию о текущем авторизованном пользователе.

Свойства

• Id: Уникальный идентификатор пользователя.
• Email: Электронная почта пользователя.
• Roles: Роли, которыми обладает пользователь.
• Permissions: Права доступа пользователя.
• Claims: Все утверждения о пользователе.

Методы

• HasPermission(string permissionClaimName): Проверяет наличие указанного права у пользователя.

FullName

Класс FullName представляет полное имя пользователя, включая имя, отчество и фамилию.

Свойства

• FirstName: Имя пользователя.
• MiddleName: Отчество пользователя (опционально).
• LastName: Фамилия пользователя.

Сервисы

IUserInfoService

Интерфейс IUserInfoService предоставляет методы для работы с авторизованным пользователем.

Методы

• GetUserInfoOrThrowAsync(CancellationToken token): Асинхронно получает информацию о текущем пользователе или выбрасывает исключение, если информация не может быть получена.
• GetAccessTokenAsync(CancellationToken token): Асинхронно получает токен доступа для текущего пользователя.
• GetUserIpAddress(): Получает IP адрес текущего пользователя.

Утилиты

ClaimsException

Класс ClaimsException представляет исключение, связанное с ошибками в утверждениях о пользователе.

Конструкторы

• ClaimsException(string message): Создает новое исключение с указанным сообщением.

Пример использования

using Iskra.Core.Auth.Abstractions;
using System.Threading.Tasks;

public class UserService
{
    private readonly IUserInfoService _userInfoService;

    public UserService(IUserInfoService userInfoService)
    {
        _userInfoService = userInfoService;
    }

    public async Task<UserInfo> GetCurrentUserInfoAsync(CancellationToken token)
    {
        return await _userInfoService.GetUserInfoOrThrowAsync(token);
    }

    public async Task<string?> GetAccessTokenAsync(CancellationToken token)
    {
        return await _userInfoService.GetAccessTokenAsync(token);
    }

    public string GetUserIpAddress()
    {
        return _userInfoService.GetUserIpAddress();
    }
}

Заключение

Библиотека Iskra.Core.Auth.Abstractions предоставляет удобные инструменты для работы с авторизованными пользователями, что упрощает разработку и поддержание безопасности в приложениях.