Projetos e Desenvolvimento
Segredos da equipa de desenvolvimento: chaves API fora do código e revogação em caso de fuga
Intermédio | 4 páginas de quadro branco · Quadro de tarefas: 5 colunas (4 tarefas principais e 12 subtarefas)
Intermédio: Aparecem os nomes dos métodos, mas o essencial está explicado no quadro branco. Use os exemplos de preenchimento como guia e complete-o a pensar na sua própria situação.
Decida com a equipa como manter as chaves API, as palavras-passe de bases de dados e as chaves privadas fora do código, do chat e dos tickets, e como as revogar e substituir numa fuga. Uma tabela regista onde cada segredo é usado, onde está e quem o gere, com um só sítio por ambiente. A página 2 verifica três armadilhas (commits antigos que guardam o valor apagado, ecrãs e registos que o mostram e portáteis com valores de produção). Um valor enviado por engano conta como exposto e revoga-se no fornecedor antes de reescrever o histórico. Os 5 porquês e uma matriz de impacto levam a uma regra de não escrever, a um sistema de gestão e a uma verificação antes do commit. Um calendário de trocas com a forma de verificar o que para evita deixar chaves antigas por medo. As palavras-passe de acesso pessoais não se mudam por calendário, só se houver fuga ou suspeita. O quadro branco tem 4 páginas e o quadro de tarefas, 5 colunas, 4 tarefas principais e 12 subtarefas.
Com uma conta gratuita, pode copiar este modelo a partir do mercado
Pré-visualização do quadro branco
Ler o conteúdo do quadro branco em formato de texto
Gestão de segredos da equipa de desenvolvimento
Como usar (4 páginas): ① Faça o levantamento dos segredos e anote onde estão espalhados → ② Decida onde guardar cada um por ambiente e verifique as armadilhas → ③ Descubra a causa de irem parar ao código e escolha as proteções → ④ Crie o procedimento para fugas e o calendário de trocas
1/4 Levantar os segredos
① Objetivo e âmbito (comece aqui)
- Objetivo ex.: Tirar as chaves API e as palavras-passe do código e do chat, e conseguir parar qualquer uma que seja exposta em 30 minutos
- Âmbito ex.: Pagamentos, envio de e-mail e base de dados, em 2 repositórios
- Prazo e quem coordena ex.: 2 semanas. Coordena o líder de desenvolvimento e as verificações dividem-se por todos
② Lista de segredos (um por linha, sem nunca escrever o valor)
| Onde é usado | Onde está hoje | Responsável | Última troca | |
|---|---|---|---|---|
| Chave API de pagamentos | ex.: Processamento de encomendas em produção | ex.: Variável de ambiente do servidor | ex.: Líder de desenvolvimento | ex.: Desconhecida (sem registo) |
| Palavra-passe da BD | ex.: Aplicações de produção e de testes | ex.: Escrita diretamente num ficheiro de configuração | ex.: Responsável de infraestrutura | ex.: Há mais de um ano |
| Chave privada do certificado | ex.: Servidor web de produção | ex.: Ficheiro dentro do servidor | ex.: Responsável de infraestrutura | ex.: Renovado antes do último prazo |
| Chave de envio de e-mail | ex.: Envio de e-mails de aviso | ex.: Continua colada no chat | ex.: Por decidir | ex.: Nunca trocada desde que foi criada |
③ Dispersão: código e configuração
- ex.: Uma chave API escrita diretamente no código de testes
- ex.: O ficheiro de configuração de exemplo tem um valor verdadeiro
- Para cada caso, anote o nome do ficheiro e que valor é
④ Dispersão: chat e tickets
- ex.: Um ticket de instruções tem uma palavra-passe escrita
- ex.: Alguém colou um valor no chat com uma mensagem para usar essa chave
- Para cada caso, anote onde está e mais ou menos quando
⑤ Dispersão: dispositivos pessoais
- ex.: Um ficheiro de chave de certificado descarregado continua no ambiente de trabalho
- ex.: A palavra-passe de um certificado está guardada numa aplicação de notas
- Para cada caso, anote de quem é o dispositivo e que valor é
2/4 Decidir onde guardar
⑥ Regras de guarda por ambiente (para onde mover os segredos de ②)
| Desenvolvimento | Testes | Produção | |
|---|---|---|---|
| Onde guardar | ex.: Ficheiro de configuração de cada dispositivo (só valores de desenvolvimento) | ex.: Serviço de gestão de segredos | ex.: Serviço de gestão de segredos |
| Quem pode ler | ex.: Toda a equipa de desenvolvimento | ex.: Equipa de desenvolvimento e responsáveis de testes | ex.: Duas pessoas de operações e a própria aplicação |
| Como é entregue | ex.: Cada um vai buscá-lo ao serviço de gestão | ex.: Carregado automaticamente na implementação | ex.: Carregado em execução e nunca mostrado a ninguém |
| Onde nunca escrever | ex.: Código, chat e tickets | ex.: Código, chat e tickets | ex.: Código, chat, tickets e dispositivos pessoais |
⑦ Armadilha: um valor enviado fica no histórico
- O que acontece: ex.: Apagá-lo do ficheiro deixa-o nos commits antigos, e quem puder ver o repositório consegue lê-lo
- Como verificar: ex.: Veja se algum segredo de ② foi alguma vez enviado, com a pesquisa do repositório ou os resultados de uma ferramenta de deteção de segredos
- Como evitar: ex.: Dê por exposto o valor enviado e revogue-o e troque-o no fornecedor antes de reescrever o histórico
- Resultado da verificação: ex.: Verificados 2 repositórios. Há 1 caso → trocado com os passos de ⑮
⑧ Armadilha: os valores aparecem em ecrãs e registos
- O que acontece: ex.: Ecrãs partilhados, capturas, registos de erros e saídas de depuração mostram o valor tal e qual
- Como verificar: ex.: Veja nas definições e na saída dos registos se os campos secretos aparecem mascarados
- Como evitar: ex.: Mascare os valores antes de chegarem aos registos e feche os ficheiros de configuração antes de partilhar o ecrã
- Resultado da verificação: ex.: O registo de erros mostrava a palavra-passe da BD junto ao destino de ligação → acrescentado o mascaramento
⑨ Armadilha: configuração em dispositivos pessoais
- O que acontece: ex.: Um valor de produção fica num ficheiro de um portátil pessoal e continua a servir mesmo depois de o equipamento se perder ou a pessoa mudar de funções
- Como verificar: ex.: Pergunte aos donos dos dispositivos de ⑤ e aos responsáveis de ② se algum ficheiro de desenvolvimento tem um valor de produção, e veja na consola do fornecedor o nome da chave, a nota e o registo de utilização (o que se vê muda com o serviço, por isso consulte o respetivo guia)
- Como evitar: ex.: Deixe só valores de desenvolvimento nos dispositivos pessoais e faça com que os de produção sejam lidos do serviço de gestão durante a execução
- Resultado da verificação: ex.: Chaves de produção em 2 dispositivos → apagadas e trocadas
3/4 Descobrir porque entram
⑩ Os 5 porquês (escolha um caso de ③–⑤ e ⑦–⑨ e pergunte 5 vezes a razão de ter entrado)
- Porquê 1 ex.: Porque estava a palavra-passe da BD de produção escrita num ficheiro de configuração? → Queria que funcionasse logo no meu computador
- Porquê 2 ex.: Porque escrevê-la diretamente no ficheiro para funcionar logo? → Ninguém tinha decidido de onde ler o valor
- Porquê 3 ex.: Porque não estava decidido? → A guarda não estava separada por ambiente
- Porquê 4 ex.: Porque não estava separada? → No início desenvolvia-se sozinho e não dava problemas
- Porquê 5 ex.: Porque não se reviu quando a equipa cresceu? → Ninguém era responsável pelos segredos
- Causa de fundo ex.: Não há regras de guarda e entrega, e ninguém é responsável
⑪ Ordene os segredos de ② pelo impacto se houver fuga e pela facilidade de troca
Eixo vertical: Impacto se houver fuga (cima = maior) / Eixo horizontal: Facilidade de troca (esquerda = mais difícil, direita = mais fácil)
- Impacto alto, difícil de trocar Primeiro crie uma forma de trocar sem parar nada ex.: Palavra-passe da BD (muitas aplicações usam-na)
- Impacto alto, fácil de trocar Passe-o já para o serviço de gestão e troque-o ex.: Chave API de pagamentos (emite-se uma nova na consola)
- Impacto baixo, difícil de trocar Faça um calendário e passe-os por ordem ex.: Palavra-passe de ligação de uma ferramenta interna antiga
- Impacto baixo, fácil de trocar Passe-os todos juntos na próxima troca ex.: Chave de envio de e-mail de desenvolvimento
⑫ Regra de não escrever
- ex.: Não escrever valores no código, no chat nem nos tickets. Escreve-se só onde estão
- ex.: Pôr valores falsos no ficheiro de configuração de exemplo
- Anote quem trata da regra e quando começa
⑬ Sistema de gestão
- ex.: Escolher um serviço de gestão de segredos e reunir lá todos os locais de guarda
- ex.: Dividir quem pode ler por funções e limitar a produção a 2 pessoas
- Anote quem trata do sistema e quando começa
⑭ Verificação antes do commit
- ex.: Executar em todos os dispositivos uma ferramenta que deteta segredos antes de cada commit
- ex.: Acrescentar à lista da revisão de código um ponto sobre valores escritos diretamente no código
- Anote quem trata da verificação e quando começa
4/4 Montar passos e calendário
⑮ Os 5 passos numa fuga (aplique ao segredo de impacto alto de ⑪)
- Avisar Quem reparar avisa logo ex.: Escreva ao contacto combinado pela equipa o que apareceu e onde. Sem culpas
- Revogar Pare o valor antigo no fornecedor ex.: Desative a chave exposta na consola do serviço de pagamentos
- Trocar Emita um valor novo e substitua-o no local de guarda ex.: Ponha a chave nova no serviço de gestão e recarregue a produção
- Ver vestígios Procure sinais de utilização ex.: Veja o histórico de utilização e a faturação do fornecedor à procura de usos que não reconheça
- Registar a causa Anote porque saiu e use-o para melhorar o sistema ex.: Analise com ⑩ e acrescente regras a ⑫–⑭
⑯ Calendário de trocas (comece por cima à direita e por cima à esquerda de ⑪)
| Próxima troca | Como verificar o que para | Responsável | |
|---|---|---|---|
| Chave API de pagamentos | ex.: Segunda semana deste mês | ex.: Usar a chave nova e a antiga em simultâneo, ver as encomendas a passar e parar a antiga | ex.: Líder de desenvolvimento |
| Palavra-passe da BD | ex.: Primeira semana do mês seguinte | ex.: Contar em ② as aplicações que a usam, trocar primeiro nos testes e depois na produção | ex.: Responsável de infraestrutura |
| Chave privada do certificado | ex.: Um mês antes de expirar | ex.: Contar em ② os servidores com o certificado, trocá-lo nos testes e ver as ligações, e só depois na produção | ex.: Responsável de infraestrutura |
| Chave de envio de e-mail | ex.: Ainda este mês (mais cedo por ter estado colada no chat) | ex.: Ver nos testes se os e-mails de aviso chegam | ex.: Uma pessoa da equipa de desenvolvimento |
⑰ Explicação para os novos membros (entregue no primeiro dia)
- Onde não escrever e onde guardar ex.: Não escrever valores no código, no chat nem nos tickets. Leem-se do local de ⑥
- Armadilha: deixar uma chave por medo de que a troca pare algo O que acontece ex.: Uma chave antiga é usada durante anos e uma fuga passa despercebida Como verificar ex.: Ver se ⑯ tem responsável e data em todas as linhas Como evitar ex.: Usar a nova e a antiga em simultâneo e só depois parar a antiga
- Se achar que houve fuga ex.: Ninguém vai ser culpabilizado, por isso avise logo o contacto do passo 1 de ⑮
Conteúdo do quadro de tarefas
Por iniciar 16 itens
Levantar segredos
Na página 1, escreva o objetivo e o âmbito e liste os segredos e onde estão espalhados. Com a lista feita, as páginas seguintes decidem onde guardá-los e qual é a causa. Prima Ctrl+F (⌘F no Mac) e escreva 3/4 para ir à página 3.
Listar as chaves
Abra a lista de chaves API na consola de cada serviço externo que usa, como pagamentos, e-mail ou nuvem, e copie o nome e a utilização de cada chave para as linhas do quadro ②. Demora cerca de 15 minutos e termina quando houver 3 nomes ou mais. Nunca escreva o valor.
Objetivo e âmbito
No quadro ①, escreva o objetivo, os serviços e repositórios abrangidos, o prazo e quem coordena. Concluído quando as 3 notas estiverem preenchidas.
Mapear a dispersão
Nos quadros ③–⑤, escreva onde há segredos no código e nos ficheiros de configuração, no chat e nos tickets e nos dispositivos pessoais. Concluído quando cada caixa tiver pelo menos 1 caso real.
Definir os locais
Na página 2, decida onde vive cada segredo de ② em cada ambiente e verifique 3 armadilhas. Com um só sítio para cada um, na página 3 é mais fácil escolher as proteções.
Regras por ambiente
Na tabela do quadro ⑥, escreva onde se guarda, quem pode ler, como é entregue e onde nunca escrever em desenvolvimento, testes e produção. Concluído quando as 12 células estiverem preenchidas.
Histórico e registos
Nos quadros ⑦ e ⑧, verifique se ficam valores em commits antigos ou se aparecem em ecrãs e registos, e anote o resultado na nota de verificação.
Rever dispositivos
No quadro ⑨, use os dispositivos anotados em ⑤ como pista e pergunte aos donos se há valores de produção em ficheiros de configuração de desenvolvimento, e anote o resultado. Se encontrar um, troque essa chave com os passos de ⑮.
Procurar as causas
Na página 3, procure a razão de os segredos irem parar ao código e ao chat, e escolha os segredos a tratar primeiro e as proteções. O que decidir aqui é a base dos passos e do calendário da página 4.
Cinco porquês
No quadro ⑩, escolha um caso de ③–⑤ e ⑦–⑨, pergunte cinco vezes a razão de ter entrado e escreva a causa de fundo no último passo.
Ordenar por impacto
No quadro ⑪, divida os segredos de ② em 4 grupos pelo impacto se houver fuga e pela facilidade de troca. Os de cima à direita e de cima à esquerda tratam-se primeiro.
Escolher proteções
Nos quadros ⑫–⑭, decida uma regra de não escrever, um sistema de gestão e uma verificação antes do commit. Concluído quando tiverem responsável e data de início.
Criar procedimento
Na página 4, crie os passos para revogar e trocar um segredo exposto, o calendário de trocas e a explicação para os novos. Copie os passos prontos para o documento da equipa e deixe-os na coluna À espera de revisão até serem lidos em conjunto.
Definir os 5 passos
Nos 5 passos de ⑮, escreva quem é avisado, onde se revoga e o que se verifica. Experimente-os num segredo de impacto alto em ⑪ e termine quando não restar nenhuma dúvida.
Planear as trocas
Na tabela de ⑯, escreva para cada segredo quando se troca, como verificar o que para e quem trata. Concluído quando todas as linhas tiverem data.
Guia para novatos
Em ⑰, escreva onde não escrever e onde guardar, porque não deixar as trocas por fazer e a quem avisar se achar que houve fuga. Concluído quando um novo membro o conseguir ler no primeiro dia.