GitLab.TokenRotation 1.3.0

GitLab.TokenRotation

NuGet библиотека для автоматического продления токенов GitLab через self-rotate API.

Установка

dotnet add package GitLab.TokenRotation

Быстрый старт

1. Настройка appsettings.json

{
  "TokenRotation": {
    "GitLabBaseUrl": "https://gitlab.example.com",
    "ProjectId": 123,
    "RotationInterval": "30.00:00:00",
    "ExpirationThreshold": "7.00:00:00",
    "MaxRetryAttempts": 3,
    "RetryDelay": "00:05:00",
    "EnableBackgroundService": true,
    "Tokens": [
      {
        "Name": "BotToken",
        "TokenId": 456,
        "CurrentToken": "glpat-xxxxxxxxxxxxxxxxxxxx",
        "ConfigurationPath": "appsettings.json",
        "EnableRotation": true
      },
      {
        "Name": "GraphQlToken", 
        "TokenId": 789,
        "CurrentToken": "glpat-yyyyyyyyyyyyyyyyyyyy",
        "ConfigurationPath": "appsettings.json",
        "EnableRotation": true
      }
    ]
  }
}

2. Регистрация сервисов в Program.cs

using GitLab.TokenRotation.Extensions;

var builder = WebApplication.CreateBuilder(args);

// Добавление сервисов ротации токенов с фоновым сервисом
builder.Services.AddGitLabTokenRotationWithBackgroundService(
    builder.Configuration,
    options =>
    {
        // Дополнительная настройка при необходимости
        options.RotationInterval = TimeSpan.FromDays(30);
        options.ExpirationThreshold = TimeSpan.FromDays(7);
    });

var app = builder.Build();

3. Использование сервиса

public class MyService
{
    private readonly ITokenRotationService _tokenRotationService;
    
    public MyService(ITokenRotationService tokenRotationService)
    {
        _tokenRotationService = tokenRotationService;
    }
    
    public async Task CheckAndRotateTokenAsync()
    {
        var tokenConfig = new TokenConfiguration
        {
            Name = "BotToken",
            TokenId = 456,
            CurrentToken = "glpat-xxxxxxxxxxxxxxxxxxxx",
            ConfigurationPath = "appsettings.json",
            EnableRotation = true
        };
        
        var result = await _tokenRotationService.RotateTokenIfNeededAsync(tokenConfig);
        
        if (result.Success)
        {
            Console.WriteLine($"Token rotated successfully. New token: {result.NewToken}");
        }
        else
        {
            Console.WriteLine($"Token rotation failed: {result.ErrorMessage}");
        }
    }
}

Настройки

TokenRotationSettings

• GitLabBaseUrl - Базовый URL GitLab сервера
• ProjectId - ID проекта в GitLab
• RotationInterval - Интервал проверки токенов фоновым сервисом
• ExpirationThreshold - За сколько времени до истечения начинать ротацию
• MaxRetryAttempts - Максимальное количество попыток ротации
• RetryDelay - Задержка между попытками
• EnableBackgroundService - Включить фоновый сервис автоматической ротации

TokenConfiguration

• Name - Имя токена для идентификации
• TokenId - ID токена в GitLab
• CurrentToken - Текущий токен
• ConfigurationPath - Путь к файлу конфигурации для автоматического обновления
• EnableRotation - Включить ротацию для этого токена

Расширенное использование

Кастомный конфигурационный updater

public class CustomTokenUpdater : ITokenConfigurationUpdater
{
    public async Task UpdateTokenAsync(TokenConfiguration tokenConfig, string newToken, CancellationToken cancellationToken = default)
    {
        // Кастомная логика обновления конфигурации
        // Например, обновление в базе данных или внешнем сервисе
    }
}

// Регистрация кастомного updater'а
builder.Services.AddGitLabTokenRotation(builder.Configuration)
               .AddTokenConfigurationUpdater<CustomTokenUpdater>();

Только основные сервисы без фонового процесса

builder.Services.AddGitLabTokenRotation(builder.Configuration);

API GitLab

Библиотека использует GitLab self-rotate API:

• GET /api/v4/projects/{id}/access_tokens/{token_id} - получение информации о токене
• POST /api/v4/projects/{id}/access_tokens/{token_id}/rotate - ротация токена

Логирование

Библиотека использует стандартный ILogger для логирования операций:

• Информация о успешных ротациях
• Предупреждения о проблемах
• Ошибки при неудачных ротациях

Требования

• .NET 6.0 или выше
• Токены GitLab с правами на self-rotate
• Доступ к GitLab API

Лицензия

MIT License