Sobre a verificação de assinatura de commit

Você pode assinar commits e tags localmente para dar a outras pessoas confiança sobre a origem de uma alteração que você fez. Se uma confirmação ou uma tag tiver uma assinatura GPG, SSH ou S/MIME que possa ser verificada criptograficamente, o marcará o commit ou a tag como "Verified" ou "Partially verified."

Captura de tela de um commit na lista de commits de um repositório. A opção "Verificado" é realçada com um contorno laranja.

Para a maioria dos usuários individuais, a melhor opção para assinar commits é GPG ou SSH. As assinaturas S/MIME geralmente são necessárias no contexto de uma organização maior. As assinaturas SSH são as mais simples de serem geradas. Você pode até mesmo carregar sua chave de autenticação existente no GitHub para também usar como uma chave de assinatura. A geração de uma chave de assinatura GPG está mais envolvida do que a geração de uma chave SSH, mas a GPG conta com recursos que a SSH não tem. Uma chave GPG pode expirar ou ser revogada quando não for mais usada. A assinatura do GPG pode incluir informações sobre ele ter expirado ou ter sido revogado.

Os commits e tags têm o seguinte status de verificação, dependendo se você habilitou o modo vigilante. Por padrão, o modo vigilante não está habilitado. Para obter informações sobre como habilitar o modo vigilante, confira Exibindo status de verificação para todos os seus commits.

A assinatura de commits é diferente da aprovação de um commit. Para obter mais informações sobre a aprovação de commits, confira Como gerenciar a política de aprovação de confirmação para seu repositório.

Status padrão

Status	Descrição
Verificado	O commit foi assinado e a assinatura foi verificada com sucesso.
Não verificado	O commit foi assinado, mas não foi possível verificar a assinatura.
Sem status de verificação	O commit não foi assinado.

Verificação da assinatura de commit persistente

Independentemente da opção de assinatura – GPG, SSH ou S/MIME –, uma vez que uma assinatura de commit é verificada, ela permanece verificada na rede de seu repositório. Confira Entender conexões entre repositórios.

Quando uma assinatura de confirmação é verificada ao ser enviada por push para o GitHub, um registro de verificação é armazenado junto com o commit. Esse registro não pode ser editado e persistirá para que as assinaturas permaneçam verificadas ao longo do tempo, mesmo se as chaves de assinatura forem giradas, revogadas ou se os colaboradores deixarem a organização.

O registro de verificação inclui uma marcação de carimbo de data/hora de quando a verificação foi concluída. Esse registro persistente garante um estado verificado consistente, fornecendo um histórico estável de contribuições dentro do repositório. Você pode exibir esse carimbo de data/hora passando o mouse sobre o selo "Verified" no GitHub ou acessando o commit por meio da API REST, que inclui um campo verified_at. Confira Pontos de extremidade da API REST para commits.

A verificação de assinatura de commit persistente aplica-se a novos commits enviados por push para o GitHub. Para quaisquer commits que antecedem esse recurso, um registro persistente será criado na próxima vez que a assinatura do commit for verificada no GitHub, ajudando a garantir que os status verificados permaneçam estáveis e confiáveis no histórico do repositório.

Os registros persistem mesmo após a revogação e expiração

A verificação de assinatura de commit persistente reflete o estado verificado de uma confirmação no momento da verificação. Isso significa que, se uma chave de assinatura for revogada, expirada ou alterada de outra forma, os commits verificados anteriormente manterão seu status verificado com base no registro criado durante a verificação inicial. O GitHub não verificará novamente commits assinados anteriormente nem ajustará retroativamente seu status de verificação em resposta a alterações no estado da chave. As organizações podem precisar gerenciar estados de chaves diretamente para se alinharem às suas políticas de segurança, especialmente se a rotação ou revogação de chaves frequentes for planejada.

O registro de verificação tem como escopo sua rede de repositório

O registro de verificação é persistente na rede do repositório, o que significa que, se o mesmo commit for enviado novamente para o mesmo repositório ou para qualquer uma de suas bifurcações, o registro de verificação existente será reutilizado. Isso permite que o GitHub mantenha um status verificado consistente entre repositórios relacionados sem verificar novamente o commit sempre que ele aparece na rede. Essa persistência reforça uma exibição unificada e confiável da autenticidade do commit em todas as instâncias do commit dentro da rede do repositório.

Verificação de assinatura para troca de base e mesclagem

Ao usar a opção Trocar base e Mesclar em uma solicitação de pull, é importante observar que os commits no branch principal são adicionados ao branch base sem verificação de assinatura de commit. Quando você usa essa opção, o GitHub cria um commit modificado usando os dados e o conteúdo do commit original. Isso significa que o GitHub não criou de fato esse commit e, portanto, não pode assiná-lo como um usuário genérico do sistema. O GitHub não tem acesso às chaves de assinatura privadas do responsável pelo commit, portanto, não pode assinar o commit em nome do usuário.

Uma solução alternativa é trocar a base e fazer a mesclagem localmente e depois enviar as alterações por push ao branch base da solicitação de pull.

Para saber mais, confira Sobre métodos de merge no GitHub.

Status com modo vigilante habilitado

Status	Descrição
Verificado	O commit foi assinado, a assinatura foi verificada com sucesso e o committer é o único autor que habilitou o modo vigilante.
Parcialmente verificado	O commit foi assinado e a assinatura foi verificada com sucesso, mas o commit tem um autor que: a) não é o committer e b) habilitou o modo vigilante. Neste caso, a assinatura de commit não garante o consentimento do autor. Portanto o commit é verificado apenas parcialmente.
Não verificado	Qualquer uma das seguintes opções é verdadeira: – O commit foi assinado, mas não foi possível verificar a assinatura. – O commit não foi assinado, e o usuário que o fez habilitou o modo vigilante. – O commit não foi assinado, e um autor habilitou o modo vigilante.

Os administradores do repositório podem impor a assinatura de commit obrigatória em um branch para bloquear todos os commits que não estejam assinados e verificados. Para saber mais, confira Sobre branches protegidos.

Você pode conferir o status de verificação de seus commits ou tags assinados no GitHub e ver por que as assinaturas de commit podem não ter sido verificadas. Para saber mais, confira Confirmar o status de verificação da assinatura do commit e da tag.

GitHub usará automaticamente o GPG para assinar commits que você fizer usando a interface da Web. Os commits assinados por GitHub terão um status verificado. Você pode verificar a assinatura localmente usando a chave pública disponível em https://github.com/web-flow.gpg.

Opcionalmente, você pode fazer com que o GPG do GitHub assine as confirmações efetuados em GitHub Codespaces. Para obter mais informações sobre como habilitar a verificação de GPG nos seus codespaces, confira Como gerenciar a verificação GPG para o GitHub Codespaces.

Verificação da assinatura de commit GPG

É possível usar GPG para assinar commits com uma chave GPG que você mesmo gera.

O GitHub usa bibliotecas OpenPGP para confirmar que seus commits e suas marcas assinados localmente são criptograficamente verificáveis em relação a uma chave pública que você adicionou à sua conta em GitHub.com.

Para assinar commits usando GPG e para que esses commits sejam verificados no GitHub, siga estas etapas:

Verificação da assinatura de confirmação do GPG

É possível usar SSH para assinar commits com uma chave SSH que você mesmo gerou. Para saber mais, confira a documentação de referência do Git com relação a user.Signingkey. Se você já usa uma chave SSH para autenticar com o GitHub, também pode carregar essa mesma chave novamente para uso como uma chave de assinatura. Não há limite quanto ao número de chaves de assinatura que você pode adicionar à sua conta.

O GitHub usa ssh_data, uma biblioteca Ruby de código aberto, para confirmar que seus commits e suas marcas assinados localmente são criptograficamente verificáveis em relação a uma chave pública que você adicionou à sua conta em GitHub.com.

Observação

A verificação de assinatura SSH está disponível no Git 2.34 ou posterior. Para atualizar sua versão do Git, acesse o site do Git.

Para assinar commits usando SSH e para que esses commits sejam verificados no GitHub, siga estas etapas:

Verificação da assinatura de commit S/MIME

Você pode usar S/MIME para assinar commits com uma chave X.509 emitida pela organização.

O GitHub usa o pacote ca-certificates do Debian, o mesmo repositório confiável usado pelos navegadores Mozilla, para confirmar que as tags e os commits assinados localmente são criptograficamente verificáveis em relação a uma chave pública em um certificado raiz confiável.

Observação

A verificação de assinatura S/MIME está disponível no Git 2.19 ou posterior. Para atualizar sua versão do Git, acesse o site do Git.

Para assinar commits usando S/MIME e para que esses commits sejam verificados no GitHub, siga estas etapas:

Não é preciso fazer upload da chave pública no GitHub.

Verificação de assinatura para bots

As organizações e GitHub Apps que exigem a assinatura de commit podem usar bots para assinar commits. Se um commit ou uma tag tiver uma assinatura de bot que possa ser verificada de maneira criptográfica, o GitHub marcará o commit ou tag como verificado.

A verificação de assinatura para bots somente funcionará se a solicitação for verificada e autenticada como o GitHub App ou bot e se não tiver informações de autor personalizadas, informações de committer personalizadas e nenhuma informação de assinatura personalizada, como API de commits.

Sobre a verificação de assinatura de commit

Neste artigo