Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify gpg.ssh.allowedSignersFile for ssh key signing #34387

Open
1 task done
nguyenvulong opened this issue Aug 23, 2024 · 3 comments
Open
1 task done

Clarify gpg.ssh.allowedSignersFile for ssh key signing #34387

nguyenvulong opened this issue Aug 23, 2024 · 3 comments
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Comments

@nguyenvulong
Copy link

nguyenvulong commented Aug 23, 2024

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key?platform=linux#telling-git-about-your-ssh-key

What part(s) of the article would you like to see updated?

Telling Git about your SSH key

I believe it should mention adding

gpg.ssh.allowedsignersfile=/path/to/.config/git/allowed_signers

Otherwise, git would complain that

error: gpg.ssh.allowedSignersFile needs to be configured and exist for ssh signature verification

and in case rules were set, github will refuse push

remote: - Commits must have verified signatures.
remote:   Found 1 violation:
remote:
remote:   bd96ff44bfa007357c164fb564b3fdd781b31322
remote:
To github.com:just/a-repo.git
 ! [remote rejected] main -> main (push declined due to repository rule violations)
error: failed to push some refs to 'github.com:just/a-repo.git'

Additional information

Related issue #28577

@nguyenvulong nguyenvulong added the content This issue or pull request belongs to the Docs Content team label Aug 23, 2024
Copy link

welcome bot commented Aug 23, 2024

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 23, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review authentication Content relating to authentication and removed triage Do not begin working on this issue until triaged by the team labels Aug 23, 2024
@nguyenalex836
Copy link
Contributor

@nguyenvulong Thank you for opening an issue! I'll get this triaged for review ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

4 participants
@nguyenvulong @nguyenalex836 and others