Pular para o conteúdo principal

Gerenciar Secrets

Visão Geral

A StackSpot gerencia e armazena credenciais externas, ou seja, credenciais previamente criadas em outras ferramentas. Essas credenciais são integradas à plataforma para serem utilizadas de forma segura e eficiente nos conteúdos e processos dentro da StackSpot.

As Secrets são credenciais sensíveis que garantem a comunicação segura entre sistemas e serviços. Por exemplo:

  • Uma Aplicação pode usar uma chave privada de uma API para se conectar a um sistema de pagamento.
  • Um banco de dados exige um usuário e senha para permitir o acesso aos dados armazenados.

Exemplos práticos de Secrets no dia a dia

  • Senha do Wi-Fi: um tipo de Secret que você não quer compartilhar com qualquer pessoa.
  • PIN do cartão de crédito: protege o acesso ao seu dinheiro.
  • Senha de e-mail: garante a privacidade das suas mensagens e protege sua conta contra invasões.

Dentro da StackSpot EDP, você pode cadastrar os seguintes tipos de Secrets:

  • API Keys
  • Bearer Token
  • Client Credential (OAuth)
  • Certificado
  • Chave valor(campo mais aberto)

Por que proteger Secrets é necessário?

A exposição de uma Secret pode comprometer gravemente a segurança de sistemas, resultando em acessos não autorizados, vazamento de dados e outros danos significativos. Para mitigar esses riscos, é essencial armazenar Secrets em locais seguros, como gerenciadores de Secrets. Esses gerenciadores funcionam como cofres digitais projetados especificamente para proteger informações sensíveis.

Gerenciar Secrets na StackSpot

O Gerenciador de Secrets da StackSpot EDP ajuda você a proteger informações sensíveis, como senhas, chaves de acesso, tokens de autenticação e credenciais de banco de dados externos. Esses dados, conhecidos como "Secrets", são essenciais para conectar sistemas e serviços de forma segura.

Com essa funcionalidade, você pode centralizar, proteger e gerenciar esses dados sensíveis dentro da Plataforma de forma eficiente, garantindo a segurança e a integridade dos seus sistemas em três níveis:

  • Organização
  • Workspace
  • Pessoal

Cadastrar Secrets externas no seu Workspace

Cadastrar Secrets no nível do Workspace é uma maneira eficaz de proteger informações sensíveis, como credenciais, contra vazamentos e uso indevido. Isso também facilita o gerenciamento de credenciais específicas do Workspace, como as necessárias para configurar ambientes de desenvolvimento, teste ou produçã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 EDP;

Passo 2: Selecione o seu Workspace;

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

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

Passo 5. Selecione o tipo de Secret que deseja cadastrar e preencha as informações específicas de acordo com o tipo escolhido. Confira os detalhes a seguir:

Tipos de Secrets e campos necessários 1. API Key: usado para autenticar solicitações de aplicações clientes para APIs. Preencha os campos:

  • 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 clientes acessem recursos protegidos. Preencha os campos:

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

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

  • Nome da Secret
  • Client ID
  • Client Secret
  • Scopes (Opcional): adicione múltiplos, como profile, edit, email, iam.role, etc.
  • Data de Expiração (Opcional)

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:

  • 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:

  • 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:

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

Como editar uma Secret

Atenção!
  • Certifique-se de copiar e salvar as informações da Secret ao cadastrá-la, pois alguns dados podem não ser exibidos novamente.
  • Utilize a funcionalidade de edição para verificar onde a Secret está sendo utilizada antes de realizar alterações ou exclusões.

Você pode editar uma Secret cadastrada seguindo os passos a seguir:

Passo 1. No Portal da StackSpot, vá até a seção 'Secrets';

Passo 2. Clique no botão 'Mais Opções' ao lado da Secret que deseja 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 desativar ou excluir uma Secret

Desativar uma Secret

Quando uma Secret é desativada no nível da Organização, ela se torna indisponível para uso. Caso a pessoa usuária tente utilizar Aplicações ou recursos que dependem dessa Secret, uma mensagem de erro será exibida.

Para desativar, siga as instruções a seguir:

  1. Na seção 'Secrets', clique no botão 'Mais Opções';
  2. Clique no botão 'Desativar'.

Você pode reativar a Secret, se necessário.

Excluir uma Secret

Atenção!

Excluir uma Secret é um processo irreversível.

  1. Na seção 'Secrets', clique no botão 'Mais Opções';
  2. Clique no botão 'Excluir Secret'.

A Secret será removida permanentemente dos locais listados em até 30 dias.

Leia Mais