Segredos criptografados

Sobre os segredos encriptados

Os segredos são variáveis de ambiente criptografadas que você cria em uma organização ou repositório. Os segredos que você cria estão disponíveis para utilização nos fluxos de trabalho em GitHub Actions. GitHub usa uma caixa selada libsodium para ajudar a garantir que os segredos sejam criptografados antes de chegarem a GitHub e permaneçam criptografados até que você os use em um fluxo de trabalho.

Para segredos armazenados no nível da organização, é possível usar políticas de acesso para controlar quais repositórios podem usar segredos da organização. Segredos no nível da organização permitem que você compartilhe segredos entre vários repositórios, o que reduz a necessidade de criar segredos duplicados. A atualização de um segredo de organização em um único local também garante que a alteração tenha efeito em todos os fluxos de trabalho do repositório que usam esse segredo.

Nomear os seus segredos

As regras a seguir aplicam-se aos nomes dos segredos:

• Os nomes dos segredos podem conter apenas caracteres alfanuméricos ([a-z], [A-Z], [0-9]) or sublinhado (_). Não são permitidos espaços.

• Os nomes dos segredos não devem começar com o prefixo GITHUB_.

• Os nomes dos segredos não devem começar com um número.

• Nomes dos segredos não diferenciam maiúsculas de minúsculas.

• Os nomes dos segredos devem ser únicos no nível em que são criados.

  Por exemplo, um segredo criado no nível do repositório deve ter um nome exclusivo nesse repositório, e um segredo criado no nível da organização deve ter um nome exclusivo nesse nível.

  Se existir um segredo com o mesmo nome em vários níveis, o segredo no nível inferior tem prioridade. Por exemplo, se um segredo a nível de organização tiver o mesmo nome que um segredo a nível de repositório, o segredo a nível de repositório terá prioridade.

Para ajudar a garantir que GitHub remova o seu segredo dos registros, evite usar dados estruturados como valores dos segredos. Por exemplo, evite criar segredos que contêm JSON ou Git blobs.

Acessar os seus segredos

Para disponibilizar um segredo para uma ação, você deve configurá-lo como uma entrada ou variável de ambiente no arquivo do fluxo de trabalho. Revise o arquivo README da ação para saber quais entradas e variáveis de ambientes a ação exige. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub Actions".

Você pode usar e ler segredos encriptados em um arquivo de fluxo de trabalho se tiver permissão para editar o arquivo. Para obter mais informações, consulte "Permissões de acesso em GitHub."

Você também pode gerenciar segredos usando o API REST. Para obter mais informações, consulte "Segredos".

Permissões limitadas de credenciais

Ao gerar credenciais, recomendamos que você conceda as permissões mínimas possíveis. Por exemplo, em vez de usar credenciais pessoais, use chaves de implantação ou uma conta de serviço. Considere conceder permissões somente leitura se isso o necessário e limite o acesso tanto quanto possível. Ao gerar um token de acesso pessoal (PAT), selecione o menor escopo necessário.

Criar segredos encriptados para um repositório

Para criar segredos para um repositório de conta de usuário, você deve ser o proprietário do repositório. Para criar segredos para o repositório de uma organização, você deve ter acesso admin.

gh secret set secret-name

gh secret set secret-name < secret.txt

Criar segredos encriptados para uma organização

Ao criar um segredo em uma organização, você pode usar uma política para limitar quais repositórios podem acessar esse segredo. Por exemplo, você pode conceder acesso a todos os repositórios ou limitar o acesso a apenas repositórios privados ou a uma lista específica de repositórios.

Para criar segredos no nível da organização, você deve ter acesso admin.

gh auth login --scopes "admin:org"

gh secret set --org organization-name secret-name

gh secret set --org organization-name secret-name --visibility all

gh secret set --org organization-name secret-name --repos repo-name-1,repo-name-2"

gh secret list --org organization-name

Rever o acesso para os segredos do nível da organização

Você pode verificar quais políticas de acesso são aplicadas a um segredo na sua organização.

1. No your GitHub Enterprise Server instance, navegue para a página principal da organização.
2. Abaixo do nome da sua organização, clique em Settings.

1. Na barra lateral esquerda, clique em Secrets (Segredos).

2. A lista de segredos inclui quaisquer permissões e políticas configuradas. Por exemplo:

3. Para obter mais detalhes sobre as permissões configuradas para cada segredo, clique em Atualizar.

Usando segredos encriptados em um fluxo de trabalho

Para fornecer uma ação com um segredo como uma entrada ou variável de ambiente, você pode usar o contexto de segredos para acessar os segredos que você criou no seu repositório. Para obter mais informações, consulte "Contextos" e "Sintaxe de fluxo de trabalho para GitHub Actions".

steps:
  - name: Hello world action
    with: # Configura o segredo como uma entrada
      super_secret: ${{ secrets.SuperSecret }}
    env: # Ou como uma variável de ambiente
      super_secret: ${{ secrets.SuperSecret }}

Evite a transmissão de segredos entre processos da linha de comando sempre que possível. Os processos da linha de comando podem ser visíveis para outros usuários (usando o comando ps) ou capturado por eventos de auditoria de segurança. Para ajudar a proteger os segredos, considere o uso de variáveis de ambiente, STDIN, ou outros mecanismos compatíveis com o processo de destino.

Se você passar segredos dentro de uma linha de comando, inclua-os dentro das regras de aspas corretas. Muitas vezes, os segredos contêm caracteres especiais que não intencionalmente podem afetar o seu shell. Para escapar desses caracteres especiais, use aspas com suas variáveis de ambiente. Por exemplo:

Exemplo de uso do Bash

etapas:
  - shell: bash
    env:
      SUPER_SECRET: ${{ secrets.SuperSecret }}
    run: |
      example-command "$SUPER_SECRET"

Exemplo de uso do PowerShell

etapas:
  - shell: pwsh
    env:
      SUPER_SECRET: ${{ secrets.SuperSecret }}
    run: |
      example-command "$env:SUPER_SECRET"

Exemplo de uso do Cmd.exe

etapas:
  - shell: cmd
    env:
      SUPER_SECRET: ${{ secrets.SuperSecret }}
    run: |
      example-command "%SUPER_SECRET%"

Limites para segredos

Você pode armazenar até 1.000 segredos de organização e 100 segredos de repositório.

Um fluxo de trabalho criado em um repositório pode acessar o seguinte número de segredos:

• Todos os 100 segredos do repositório.
• Se o repositório tiver acesso a mais de 100 segredos da organização, o fluxo de trabalho só poderá usar os primeiros 100 segredos da organização (ordem alfabética por nome de segredo).

Os segredos são limitados a 64 kB. Para usar segredos maiores que 64 kB, você pode armazenar segredos criptografados no seu repositório e salvar a frase secreta de descodificação como um segredo no GitHub. Por exemplo, você pode usar gpg para criptografar suas credenciais localmente antes de colocar o arquivo no repositório do GitHub. Para obter mais informações, consulte a "página do manual gpg".

1. Execute o seguinte comando no seu terminal para criptografar o arquivo my_secret.json usando gpg e o algoritmo de cifragem AES256.

   $ gpg --symmetric --cipher-algo AES256 my_secret.json

2. Você receberá a solicitação para inserir a frase secreta. Guarde a frase secreta, pois você precisará criar um novo segredo no GitHub que usa a frase secreta como valor.

3. Criar um novo segredo que contém a frase secreta. Por exemplo, crie um novo segredo com o nome LARGE_SECRET_PASSPHRASE e defina o valor do segredo para a frase secreta que você escolheu na etapa anterior.

4. Copie o arquivo criptografado no repositório e faça commit. Nesse exemplo, o arquivo criptografado é my_secret.json.gpg.

5. Crie um script shell para decifrar a senha. Salve o arquivo como decrypt_secret.sh.

   #!/bin/sh
   
   # Decrypt the file
   mkdir $HOME/secrets
   # --lote para evitar o comando interativo
   # --sim para supor "sim" para as perguntas
   gpg --quiet --batch --yes --decrypt --passphrase="$LARGE_SECRET_PASSPHRASE" \
   --output $HOME/secrets/my_secret.json my_secret.json.gpg

6. Confirme que o shell script é executável antes de colocá-lo no repositório.

   $ chmod +x decrypt_secret.sh
   $ git add decrypt_secret.sh
   $ git commit -m "Add new decryption script"
   $ git push

7. A partir de seu fluxo de trabalho, use step para chamar o shell script e decifrar o segredo. Para ter uma cópia do seu repositório no ambiente em que o seu fluxo de trabalho é executado, você deverá executar a ação actions/checkout. Faça referência ao shell script usando o comando run relativo �  raiz do repositório.

   name: Workflows with large secrets
   
   on: push
   
   jobs:
     my-job:
       name: My Job
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - name: Decrypt large secret
           run: ./.github/scripts/decrypt_secret.sh
           env:
             LARGE_SECRET_PASSPHRASE: ${{ secrets.LARGE_SECRET_PASSPHRASE }}
         # This command is just an example to show your secret being printed
         # Ensure you remove any print statements of your secrets. O GitHub
         # não oculta segredos que usam essa alternativa.
         - name: Test printing your secret (Remove this step in production)
           run: cat $HOME/secrets/my_secret.json
   

Armazenar Blobs binários de Base64 como segredos

Você pode usar a codificação de Base64 para armazenar pequenos blobs binários como segredos. Em seguida, você pode fazer referência ao segredo no seu fluxo de trabalho e decodificá-lo para usar no executor. Para os limites de tamanho, consulte "Limites para segredos".

1. Use base64 para codificar seu arquivo em uma string de Base64. Por exemplo:

   $ base64 -i cert.der -o cert.base64
   

2. Crie um segredo que contenha a string de Base64. Por exemplo:

   $ gh secret set CERTIFICATE_BASE64 < cert.base64
   ✓ Set secret CERTIFICATE_BASE64 for octocat/octorepo
   

3. Para acessar a string de Base64 do seu executor, transforme segredo em base64 --decode. Por exemplo:

   name: Retrieve Base64 secret
   on:
     push:
       branches: [ octo-branch ]
   jobs:
     decode-secret:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v2
         - name: Retrieve the secret and decode it to a file
           env:
             CERTIFICATE_BASE64: ${{ secrets.CERTIFICATE_BASE64 }}
           run: |
             echo $CERTIFICATE_BASE64 | base64 --decode > cert.der
         - name: Show certificate information
           run: |
             openssl x509 -in cert.der -inform DER -text -noout