From 1872776341c2c4dff554eb4b4a72f31135b1b7e8 Mon Sep 17 00:00:00 2001 From: Matt Pollard Date: Sat, 9 Oct 2021 10:18:51 +0200 Subject: [PATCH 1/2] Version section for GitHub AE (#22019) --- ...isabling-or-limiting-github-actions-for-your-organization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md index e5c6045f06f1..a5f19682e543 100644 --- a/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization.md @@ -37,7 +37,7 @@ Alternatively, you can enable {% data variables.product.prodname_actions %} for {% endif %} -{% ifversion fpt or ghes > 2.22 or ghae-next %} +{% ifversion fpt or ghes > 2.22 or ghae %} ## Managing {% data variables.product.prodname_actions %} permissions for your organization From 08c0a3a7c1f47b9e2f5c5a809b8ff8e4bd168b40 Mon Sep 17 00:00:00 2001 From: Matt Pollard Date: Sat, 9 Oct 2021 10:31:54 +0200 Subject: [PATCH 2/2] Favor RSA algorithm for SSH key pairs in documentation for GitHub AE (#22018) --- ...ng-a-new-ssh-key-to-your-github-account.md | 12 +++++------ .../checking-for-existing-ssh-keys.md | 20 +++++++++++-------- .../working-with-ssh-key-passphrases.md | 2 +- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index 657c775071cb..e9a0c4a54442 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -31,8 +31,8 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ pbcopy < ~/.ssh/id_ed25519.pub - # Copies the contents of the id_ed25519.pub file to your clipboard + $ pbcopy < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard ``` {% tip %} @@ -67,8 +67,8 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ clip < ~/.ssh/id_ed25519.pub - # Copies the contents of the id_ed25519.pub file to your clipboard + $ clip < ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Copies the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file to your clipboard ``` {% tip %} @@ -103,8 +103,8 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ cat ~/.ssh/id_ed25519.pub - # Then select and copy the contents of the id_ed25519.pub file + $ cat ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub + # Then select and copy the contents of the id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}.pub file # displayed in the terminal to your clipboard ``` diff --git a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md index a61e325339b7..4d0f52284e84 100644 --- a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md @@ -13,26 +13,30 @@ topics: - SSH shortTitle: Check for existing SSH key --- + {% data reusables.ssh.key-type-support %} {% data reusables.command_line.open_the_multi_os_terminal %} -2. Enter `ls -al ~/.ssh` to see if existing SSH keys are present: +2. Enter `ls -al ~/.ssh` to see if existing SSH keys are present. ```shell $ ls -al ~/.ssh # Lists the files in your .ssh directory, if they exist ``` -3. Check the directory listing to see if you already have a public SSH key. By default, the filenames of the public keys are one of the following: + +3. Check the directory listing to see if you already have a public SSH key. By default, the {% ifversion ghae %}filename of a supported public key for {% data variables.product.product_name %} is *id_rsa.pub*.{% elsif fpt or ghes %}filenames of supported public keys for {% data variables.product.product_name %} are one of the following. - *id_rsa.pub* - *id_ecdsa.pub* - - *id_ed25519.pub* + - *id_ed25519.pub*{% endif %} -If you don't have an existing public and private key pair, or don't wish to use any that are available to connect to {% data variables.product.product_name %}, then [generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). + {% tip %} -If you see an existing public and private key pair listed (for example *id_rsa.pub* and *id_rsa*) that you would like to use to connect to {% data variables.product.product_name %}, you can [add your SSH key to the ssh-agent](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#adding-your-ssh-key-to-the-ssh-agent). + **Tip**: If you receive an error that *~/.ssh* doesn't exist, you do not have an existing SSH key pair in the default location. You can create a new SSH key pair in the next step. -{% tip %} + {% endtip %} -**Tip:** If you receive an error that *~/.ssh* doesn't exist, don't worry! We'll create it when we [generate a new SSH key](/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). +4. Either generate a new SSH key or upload an existing key. + - If you don't have a supported public and private key pair, or don't wish to use any that are available, generate a new SSH key. + - If you see an existing public and private key pair listed (for example, *id_rsa.pub* and *id_rsa*) that you would like to use to connect to {% data variables.product.product_name %}, you can add the key to the ssh-agent. -{% endtip %} + For more information about generation of a new SSH key or addition of an existing key to the ssh-agent, see "[Generating a new SSH key and adding it to the ssh-agent](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." diff --git a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md index 240eaa3c3aa0..d56e13765560 100644 --- a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md +++ b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md @@ -22,7 +22,7 @@ With SSH keys, if someone gains access to your computer, they also gain access t You can change the passphrase for an existing private key without regenerating the keypair by typing the following command: ```shell -$ ssh-keygen -p -f ~/.ssh/id_ed25519 +$ ssh-keygen -p -f ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %} > Enter old passphrase: [Type old passphrase] > Key has comment 'your_email@example.com' > Enter new passphrase (empty for no passphrase): [Type new passphrase]