Pular para o conteúdo principal

Gerenciar Secrets

Nesta página, você encontra detalhes sobre como cadastrar e gerenciar as Secrets em uma Organização.

Visão Geral

A StackSpot gerencia e armazena credenciais externas, como senhas ou chaves criadas em outras ferramentas. Essas credenciais são integradas à plataforma para uso seguro e eficiente em diferentes processos.

Secrets são credenciais sensíveis que permitem a comunicação segura entre sistemas e serviços. Exemplos:

  • Uma aplicação usa uma chave de API para acessar um sistema de pagamento.
  • Um banco de dados pede usuário e senha para liberar o acesso às informações.

Exemplos práticos de Secrets

  • Senha do Wi-Fi: você não deve compartilhar com qualquer pessoa.
  • PIN do cartão de crédito: protege seu dinheiro.
  • Senha de e-mail: protege suas mensagens e sua conta.

Na StackSpot EDP, você pode cadastrar estes tipos de Secrets:

  • API Key
  • Bearer Token
  • Client Credential (OAuth)
  • Certificado
  • Chave/Valor (Key/Value)

Por que proteger Secrets?

Se uma Secret for exposta, ela pode colocar sistemas em risco, causar acessos indevidos ou vazamento de dados. Por isso, é importante guardar Secrets em locais seguros, como gerenciadores de Secrets, que funcionam como cofres digitais.

Gerenciar Secrets na StackSpot

O Gerenciador de Secrets da StackSpot EDP ajuda a proteger informações como senhas, tokens e credenciais de serviços externos. Ele permite centralizar e controlar esses dados de forma segura, garantindo a proteção dos sistemas em três níveis:

  • Organização
  • Workspace
  • Pessoal

Como cadastrar Secrets externas em nível de Organização

Ao cadastrar Secrets na sua Organização, você protege essas informações contra vazamento e uso indevido por pessoas não autorizadas.

Confira como registrar Secrets para garantir o uso seguro por todas as pessoas usuárias da sua Organização:

Pré-requisitos

  • Ter permissão de Account Holder ou Account Manager;

Para mais informações, acesse a página de Permissões.

Passo a passo para Cadastrar uma Secret

Passo 1. Acesse o Portal da StackSpot. Você tem duas opções para acessar o Portal:

  1. Acessar diretamente o Portal da Conta;

  2. Após fazer login no Portal StackSpot EDP, clicar no seu avatar de perfil.

Passo 2. Clique na seção 'Organização' e depois clique em 'Identidade e Segurança';

Passo 3. Clique na seção 'Gerenciamento de Secrets';

Passo 4. Clique no botão 'Cadastrar secret' para iniciar o cadastro;

Passo 5. No campo de 'Disponibilidade', selecione a opção Toda a organização

Cada opção do campo de Disponibilidade gerará um outro tipo de campo, como na descrição a seguir. Selecione o Tipo de credencial:

1. API Key: usado para autenticar solicitações de Aplicações dos clientes para APIs. Preencha os campos a seguir:

  • Nome da Secret
  • Nome do Header
  • Valor
  • Data de Expiração (Opcional)

2. Bearer Tokens (OAuth): tokens são emitidos como parte do framework de autorização OAuth2, permitindo que os clientes acessem recursos protegidos. Preencha os campos a seguir:

  • Nome da Secret
  • Nome do Header
  • Valor do Header
  • Data de Expiração (Opcional)

3. Client Credentials: usado para comunicação de servidor para servidor, uma aplicação do cliente deve se autenticar usando credenciais de cliente. Preencha os campos a seguir:

  • Nome da Secret
  • Client ID
  • URL
  • Client Secret

4. Certificado: certificados de cliente são utilizados para autenticação mútua TLS, garantindo validação de identidade e comunicação criptografada. Preencha os campos a seguir:

  • Nome da Secret
  • Certificado: arraste e solte os arquivos.
  • Chave Privada (Opcional): arraste e solte os arquivos. Suporta apenas arquivos .key.
  • Data de Expiração: preenchida automaticamente ao adicionar o certificado.

5. Chave/Valor (Key/Value). Preencha os campos a seguir:

  • Nome da Secret
  • Método de Cadastro: escolha entre adicionar um arquivo ou inserir manualmente (adicione a chave e o valor).
  • Data de Expiração (Opcional)

Passo 6. Clique no botão 'Cadastrar Secret';

Passo 7. Após o cadastro, confira sua Secret na tela de listagem. Você poderá visualizar informações como:

  • Nome da secret
  • Tipo de Credencial
  • Disponibilidade
  • Data de Criação
  • Data de Expiração
  • Status da Secret


Como editar uma Secret

Utilize a funcionalidade de edição para verificar onde a Secret está sendo utilizada antes de realizar alterações ou exclusões.

Para editar uma Secret cadastrada, siga os passos a seguir:

Passo 1. No Portal da StackSpot, acesse a seção de 'Secrets';

Passo 2. Clique no botão 'Mais Opções' na Secret que você quer editar;

Passo 3. Clique no botão 'Editar' para editar a Secret. Preencha os campos necessários:

  • Novo Nome do Header
  • Novo Valor
  • Data de Expiração (Opcional)

Como excluir uma Secret

Se uma Secret ficar sem uso por 30 dias, ela muda automaticamente para o status Inativa.

O Portal da StackSpot avisa você sobre a exclusão da Secret faltando 15, 10 e 1 dia antes de ela ser removida. Quando a Secret ficar Inativa e você receber o aviso, você pode escolher:

  • Usar a Secret novamente para reativá-la. O status volta para Ativa e ela não será excluída. Isso pode ser feito dentro do prazo de 30 dias.
  • Excluir a Secret agora de forma imediata.
  • Agendar a exclusão para daqui a 30 dias.

Excluir uma Secret imediatamente

Você pode excluir uma Secret com status:

  • Ativa
  • Inativa
  • Exclusão programada
Atenção!

Excluir uma Secret é uma ação irreversível.

Passo 1. Na seção Secrets, clique no botão ‘Mais Opções‘;

Passo 2. Clique em ‘Excluir Secret‘;

Passo 3. Selecione a opção ‘Excluir agora‘;

Antes de excluir, você pode visualizar onde a Secret está sendo usada.

Passo 4. Digite EXCLUIR para confirmar e clique em Excluir secret.

Secret excluída com sucesso.

Agendar a exclusão de uma Secret

Passo 1. Na seção Secrets, clique no botão ‘Mais Opções‘;

Passo 2. Clique no botão ‘Excluir Secret‘;

Passo 3. Selecione ‘Agendar exclusão‘;

Passo 4. Digite EXCLUIR para confirmar e clique em Excluir secret.

A exclusão foi agendada.

Dica!

Você pode interromper a exclusão programada de uma Secret, caso mude de ideia:

Passo 1. Clique no botão ‘Mais opções‘ da Secret agendada para exclusão. Depois, clique no botão ‘Interromper exclusão‘.

Passo 2. Confirme novamente em ‘Interromper exclusão‘.

Pronto! A exclusão programada foi cancelada.

Leia Mais