Skip to content

Remove 'your key must use RSA' for generating new GPG key #20380

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 25, 2023
Merged

Remove 'your key must use RSA' for generating new GPG key #20380

merged 3 commits into from
Apr 25, 2023

Conversation

Zhong-z
Copy link
Contributor

@Zhong-z Zhong-z commented Sep 3, 2022 •
edited
Loading

Why:

In the reusables.gpg.supported-gpg-key-algorithms section, it shows Github support more than RSA. However when generating a new key, we 'must' use RSA, which seems contradicts each other.

The purposed change assumes reusables.gpg.supported-gpg-key-algorithms is the source of truth.

Closes #20379

What's being changed (if available, include any code snippets, screenshots, or gifs):

Removed Your key must use RSA sentence.

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@Zhong-z
remove 'you must use RSA'
7a4d5a0 
this seems to be conflicted with the supported key algorithms listed in `reusables.gpg.supported-gpg-key-algorithms`
@welcome
Copy link

welcome bot commented Sep 3, 2022

Thanks for opening this pull request! 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 Sep 3, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 3, 2022 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
 fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@Zhong-z Thanks for opening a PR and linking it to your issue! ✨

I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review ssh Content related to SSH authentication Content relating to authentication and removed triage Do not begin working on this issue until triaged by the team labels Sep 6, 2022
@janiceilene janiceilene added the needs SME This proposal needs review from a subject matter expert label Sep 13, 2022
@github-actions
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@Ameralkashaan

This comment was marked as spam.

Sign in to view
@artur-666

This comment was marked as spam.

Sign in to view
rmjspaz

This comment was marked as spam.

Sign in to view

@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Dec 10, 2022
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Dec 12, 2022
@github-actions
Copy link
Contributor

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Jan 10, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Jan 11, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 8, 2023

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Feb 8, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Feb 9, 2023
@isaacmbrown
Copy link
Contributor

isaacmbrown commented Mar 1, 2023 •
edited
Loading

Hi @Zhong-z, you are right that this appears to be a contradiction in the article. I suspect the fix may need to be slightly more complex in the context of the procedure; we also say that Your key must be at least 4096 bits., but, at least with the GPG software I was using, only the RSA algorithm could generate a key of this length. We'll need to clarify our requirements and recommendations here, so I'll reach out to someone internally and get back to you when I hear back.

@akingatwork

This comment was marked as spam.

Sign in to view
@github-actions
Copy link
Contributor

github-actions bot commented Apr 6, 2023

This is a gentle bump for the docs team that this PR is waiting for technical review.

@github-actions github-actions bot added the SME stale The request for an SME has staled label Apr 6, 2023
@cmwilson21 cmwilson21 removed the SME stale The request for an SME has staled label Apr 7, 2023
@isaacmbrown
Copy link
Contributor

Hi @Zhong-z, thanks for your patience while I looked into this internally! 🙇

I can confirm that the algorithms listed at the top of the article are supported, so you are correct to be removing Your key must use RSA.

If you're still up for it, could you also update this PR to remove Your key must be at least 4096 bits.? It looks like this restriction on key length doesn't exist either. I'll approve once that's done so we can get this merged 🚀

@Zhong-z
Copy link
Contributor Author

Zhong-z commented Apr 25, 2023

@isaacmbrown Thanks for getting back me 😃. Deleted the key length sentence, please have another look. 👨🏼‍💻

isaacmbrown
isaacmbrown approved these changes Apr 25, 2023
View reviewed changes
Copy link
Contributor

@isaacmbrown isaacmbrown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this @Zhong-z! Looks good to merge to me 🚀

@isaacmbrown isaacmbrown added this pull request to the merge queue Apr 25, 2023
Merged via the queue into github:main with commit 33f5a3e Apr 25, 2023
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rmjspaz rmjspaz rmjspaz left review comments

@isaacmbrown isaacmbrown isaacmbrown approved these changes

Assignees
No one assigned
Labels
authentication Content relating to authentication content This issue or pull request belongs to the Docs Content team needs SME This proposal needs review from a subject matter expert ssh Content related to SSH waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

GPG supported key algorithms
8 participants
@Zhong-z @cmwilson21 @Ameralkashaan @artur-666 @isaacmbrown @akingatwork @rmjspaz @janiceilene