Repository navigation
Protect GitHub tutorial: correct the credential request and username mapping - #569
Open
J-Hunter-Hawke wants to merge 1 commit into
Open
J-Hunter-Hawke wants to merge 1 commit into
J-Hunter-Hawke wants to merge 1 commit into
Conversation
…mapping Create the SSH credential with the Create Endpoint Configuration request, and leave the authority out so certificates come from the team's SSH authority, the one Smallstep SSH uses. Say that the GitHub username reaches the certificate in the login@github.com extension, not in the principals, and describe what SSH.Principals holds. Add the key:: prefix to the user.signingkey command, so Git reads the value as a public key and not as a file path. Drop the dashboard check from the troubleshooting list; ssh-add -l already covers it. Refs PRO-606 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR corrects the tutorial Protect GitHub with SSH Certificates. It changes one file:
tutorials/protect-github-ssh.mdx.POST /api/endpoint-configurations) withkind: account. This is the request that creates an SSH user credential. It matches the request in the GitHub SSH guide that we already share with customers. The field list below the request uses the new field names.authorityIDfield from the request. With no authority in the request, Smallstep issues the certificates from the SSH authority of the team. Smallstep SSH uses the same authority. Thus the credential works with Smallstep SSH. In Step 2, the reader already copies the user CA key of that authority.login@github.comextension. Smallstep puts thegithubUsernameattribute in that extension. The text forSSH.Principalsnow says what it holds: POSIX usernames and SSH group principals.user.signingkeycommand now has the prefixkey::. Without the prefix, Git reads the value as a file path, unless the value starts withssh-. The default key of the agent is ECDSA P-256 (ecdsa-sha2-nistp256 ...).ssh-add -lcheck above that line is sufficient.updated_atis now October 13, 2026.For review
key::signed the commit.Related links/other PRs/issues:
user.signingKeyin git-config