StackSpot.Secrets 1.0.0

StackSpot secrets

Este componente foi projetado para padronizar a comunicação com a possibilidade de cacheamento de segredos da AWS Secrets Manager para aplicações .NET.

Versões suportadas

• net5.0
• net6.0

Uso

1. Adicione o pacote NuGet StackSpot.Secrets ao seu projeto.

dotnet add package StackSpot.Secrets

2. Configure as variáveis.

• CacheItemTTL - TTL do cache em milliseconds - Valor default: 3600000.
• MaxCacheSize - Quantidade máxima de items a serem cacheados antes de executar o LRU - Valor default: 1024.
• VersionStage - Versão que o cache irá requisitar ao recuperar o segredo do Secrets Manager - Valor default: AWSCURRENT.
• RegionEndpoint - Endpoint regional que será utilizado para requisitar o Secrets Manager - Campo Obrigatório.

Você pode sobrescrever a configuração padrão do cache adicionando a seção SecretsCache em seu appsettings.json.

  "SecretsCache": {
      "CacheItemTTL": 3700000,
      "MaxCacheSize": 1024,
      "VersionStage": "AWSCURRENT",
      "RegionEndpoint": "sa-east-1"
  }

3. Adicione ao seu IServiceCollection via services.AddSecretsManager() no Startup da aplicação ou Program tendo como parametro de entrada IConfiguration e IWebHostEnvironment.

services.AddSecretsManager(Configuration, Env);

Implementação

[ApiController]
[Route("[controller]")]
public class SampleController : ControllerBase
{
    private readonly ISecretsManagerCache _cache;

    public SampleController(ISecretsManagerCache cache)
    {
        _cache = cache;
    }

    [HttpGet]
    public async Task<IActionResult> Get()
    {
        var someEntity = await _cache.GetSecretString("Poc");
        return Ok(someEntity);
    }
}

Sobrecargas disponíveis.

• Em recuperações bem sucedidas, o cache irá retornar uma cópia cacheada do seu segredo.

   var secret = await ISecretsRepository.GetSecret<T>(secretKey);

• É possível utilizar a interface ISecretsRepository com tratamento de erros e API para deserializar o seu segredo.

Exceptions

• SecretsRepositoryException, acontece quando:
  • Secret não encontrada, retorna a mensagem No secret was found for key {secretKey}.
  • Erro inesperado, retorna a mensagem An error occurred while getting the secret for key {secretKey}., contendo a exception do erro.

4. Ambiente local

• Esta etapa não é obrigatória.
• Variável ASPNETCORE_ENVIRONMENT deverá ter o valor igual à Development.
• Você pode customizar o endpoint do localstack adicionando a chave LOCALSTACK_CUSTOM_SERVICE_URL. O valor padrão é http://localhost:4566