Remove product_name from authentication directory (#53993)
This commit is contained in:
Isaac Brown
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Authenticating with SAML single sign-on
|
||||
intro: 'You can authenticate to {% data variables.product.product_name %} with SAML single sign-on (SSO){% ifversion ghec %} and view your active sessions{% endif %}.'
|
||||
intro: 'You can authenticate to {% data variables.product.github %} with SAML single sign-on (SSO){% ifversion ghec %} and view your active sessions{% endif %}.'
|
||||
redirect_from:
|
||||
- /articles/authenticating-to-a-github-organization-with-saml-single-sign-on
|
||||
- /articles/authenticating-with-saml-single-sign-on
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About SSH
|
||||
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.product_name %} without supplying your username and {% data variables.product.pat_generic %} at each visit. You can also use an SSH key to sign commits.'
|
||||
intro: 'Using the SSH protocol, you can connect and authenticate to remote servers and services. With SSH keys, you can connect to {% data variables.product.github %} without supplying your username and {% data variables.product.pat_generic %} at each visit. You can also use an SSH key to sign commits.'
|
||||
redirect_from:
|
||||
- /articles/about-ssh
|
||||
- /github/authenticating-to-github/about-ssh
|
||||
@@ -15,7 +15,7 @@ topics:
|
||||
|
||||
{% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia.
|
||||
|
||||
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.product_name %} before you use the key to authenticate or sign commits. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) and [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification).
|
||||
When you set up SSH, you will need to generate a new private SSH key and add it to the SSH agent. You must also add the public SSH key to your account on {% data variables.product.github %} before you use the key to authenticate or sign commits. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent), [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) and [AUTOTITLE](/authentication/managing-commit-signature-verification/about-commit-signature-verification).
|
||||
|
||||
You can further secure your SSH key by using a hardware security key, which requires the physical hardware security key to be attached to your computer when the key pair is used to authenticate with SSH. You can also secure your SSH key by adding your key to the ssh-agent and using a passphrase. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases).
|
||||
|
||||
@@ -28,7 +28,7 @@ If you haven't used your SSH key for a year, then {% data variables.product.prod
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.product_name %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.github %}. If you're using an SSH certificate, you cannot use the certificate to access forks of the organization's repositories, if the fork is owned by your personal account. For more information, see [AUTOTITLE](/enterprise-cloud@latest/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities) in the {% data variables.product.prodname_ghe_cloud %} documentation.
|
||||
|
||||
{% else ghec or ghes %}
|
||||
Organizations that use {% data variables.product.prodname_ghe_cloud %} can provide SSH certificates, which members can use to access that organization's repositories without adding the certificate to their account on {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
@@ -34,7 +34,7 @@ Before you generate a new SSH key, you should check your local machine for exist
|
||||
# Lists the files in your .ssh directory, if they exist
|
||||
```
|
||||
|
||||
1. Check the directory listing to see if you already have a public SSH key. By default, the filenames of supported public keys for {% data variables.product.product_name %} are one of the following.
|
||||
1. Check the directory listing to see if you already have a public SSH key. By default, the filenames of supported public keys for {% data variables.product.github %} are one of the following.
|
||||
* _id_rsa.pub_
|
||||
* _id_ecdsa.pub_
|
||||
* _id_ed25519.pub_
|
||||
@@ -44,6 +44,6 @@ Before you generate a new SSH key, you should check your local machine for exist
|
||||
|
||||
1. 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.
|
||||
* 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.github %}, you can add the key to the ssh-agent.
|
||||
|
||||
For more information about generation of a new SSH key or addition of an existing key to the ssh-agent, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent).
|
||||
|
||||
@@ -24,7 +24,7 @@ When you generate an SSH key, you can add a passphrase to further secure the key
|
||||
|
||||
If you don't already have an SSH key, you must generate a new SSH key to use for authentication. If you're unsure whether you already have an SSH key, you can check for existing keys. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).
|
||||
|
||||
If you want to use a hardware security key to authenticate to {% data variables.product.product_name %}, you must generate a new SSH key for your hardware security key. You must connect your hardware security key to your computer when you authenticate with the key pair. For more information, see the [OpenSSH 8.2 release notes](https://www.openssh.com/txt/release-8.2).
|
||||
If you want to use a hardware security key to authenticate to {% data variables.product.github %}, you must generate a new SSH key for your hardware security key. You must connect your hardware security key to your computer when you authenticate with the key pair. For more information, see the [OpenSSH 8.2 release notes](https://www.openssh.com/txt/release-8.2).
|
||||
|
||||
## Generating a new SSH key
|
||||
|
||||
@@ -39,7 +39,7 @@ If you are a site administrator for {% data variables.location.product_location_
|
||||
{% data reusables.ssh.key-type-support %}
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Paste the text below, replacing the email used in the example with your {% data variables.product.product_name %} email address.
|
||||
1. Paste the text below, replacing the email used in the example with your {% data variables.product.github %} email address.
|
||||
|
||||
```shell
|
||||
ssh-keygen -t ed25519 -C "your_email@example.com"
|
||||
@@ -188,7 +188,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta
|
||||
1. Insert your hardware security key into your computer.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
|
||||
1. Paste the text below, replacing the email address in the example with the email address associated with your account on {% data variables.product.product_name %}.
|
||||
1. Paste the text below, replacing the email address in the example with the email address associated with your {% data variables.product.github %} account.
|
||||
|
||||
{% mac %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Connecting to GitHub with SSH
|
||||
intro: 'You can connect to {% data variables.product.product_name %} using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network.'
|
||||
intro: 'You can connect to {% data variables.product.github %} using the Secure Shell Protocol (SSH), which provides a secure channel over an unsecured network.'
|
||||
redirect_from:
|
||||
- /key-setup-redirect
|
||||
- /linux-key-setup
|
||||
|
||||
@@ -133,7 +133,7 @@ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com
|
||||
|
||||
If your server needs to access repositories across one or more organizations, you can use a {% data variables.product.prodname_github_app %} to define the access you need, and then generate _tightly-scoped_, installation access tokens from that {% data variables.product.prodname_github_app %}. The installation access tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents.
|
||||
|
||||
Since {% data variables.product.prodname_github_apps %} are a first class actor on {% data variables.product.product_name %}, the installation access tokens are decoupled from any {% data variables.product.prodname_dotcom %} user, which makes them comparable to "service tokens". Additionally, installation access tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps).
|
||||
Since {% data variables.product.prodname_github_apps %} are a first class actor on {% data variables.product.github %}, the installation access tokens are decoupled from any {% data variables.product.github %} user, which makes them comparable to "service tokens". Additionally, installation access tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/apps/creating-github-apps/setting-up-a-github-app/rate-limits-for-github-apps).
|
||||
|
||||
### Pros of installation access tokens
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ You'll need to authenticate this action using your password, which is the SSH ke
|
||||
|
||||
```shell copy
|
||||
ssh -T git@{% data variables.product.product_url %}
|
||||
# Attempts to ssh to {% data variables.product.product_name %}
|
||||
# Attempts to ssh to {% data variables.product.github %}
|
||||
```
|
||||
|
||||
You may see a warning like this:
|
||||
|
||||
@@ -19,7 +19,7 @@ shortTitle: SSH agent forwarding
|
||||
|
||||
SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server.
|
||||
|
||||
If you've already set up an SSH key to interact with {% data variables.product.product_name %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer.
|
||||
If you've already set up an SSH key to interact with {% data variables.product.github %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer.
|
||||
|
||||
Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explanation of SSH agent forwarding.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About anonymized URLs
|
||||
intro: 'If you upload an image or video to {% data variables.product.product_name %}, the URL of the image or video will be modified so your information is not trackable.'
|
||||
intro: 'If you upload an image or video to {% data variables.product.github %}, the URL of the image or video will be modified so your information is not trackable.'
|
||||
redirect_from:
|
||||
- /articles/why-do-my-images-have-strange-urls
|
||||
- /articles/about-anonymized-image-urls
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
- Identity
|
||||
- Access management
|
||||
---
|
||||
To host your images, {% data variables.product.product_name %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. On {% data variables.product.prodname_dotcom_the_website %}, the URL starts `https://<subdomain>.githubusercontent.com/`, with different subdomains depending on how you uploaded the image.
|
||||
To host your images, {% data variables.product.github %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. On {% data variables.product.prodname_dotcom_the_website %}, the URL starts `https://<subdomain>.githubusercontent.com/`, with different subdomains depending on how you uploaded the image.
|
||||
|
||||
Videos also get anonymized URLs with the same format as image URLs, but are not processed through Camo. This is because {% data variables.product.prodname_dotcom %} does not support externally hosted videos, so the anonymized URL is a link to the uploaded video hosted by {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About authentication to GitHub
|
||||
intro: 'You can securely access your account''s resources by authenticating to {% data variables.product.product_name %}, using different credentials depending on where you authenticate.'
|
||||
intro: 'You can securely access your account''s resources by authenticating to {% data variables.product.github %}, using different credentials depending on where you authenticate.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -13,11 +13,11 @@ redirect_from:
|
||||
- /github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github
|
||||
shortTitle: Authentication to GitHub
|
||||
---
|
||||
## About authentication to {% data variables.product.prodname_dotcom %}
|
||||
## About authentication to {% data variables.product.github %}
|
||||
|
||||
To keep your account secure, you must authenticate before you can access certain resources on {% data variables.product.product_name %}. When you authenticate to {% data variables.product.product_name %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
|
||||
To keep your account secure, you must authenticate before you can access certain resources on {% data variables.product.github %}. When you authenticate to {% data variables.product.github %}, you supply or confirm credentials that are unique to you to prove that you are exactly who you declare to be.
|
||||
|
||||
You can access your resources in {% data variables.product.product_name %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.product_name %} supports different modes of authentication.
|
||||
You can access your resources in {% data variables.product.github %} in a variety of ways: in the browser, via {% data variables.product.prodname_desktop %} or another desktop application, with the API, or via the command line. Each way of accessing {% data variables.product.github %} supports different modes of authentication.
|
||||
{%- ifversion not fpt %}
|
||||
* Your identity provider (IdP){% endif %}
|
||||
* Username and password with two-factor authentication{% ifversion passkeys %}, or a passkey{% endif %}
|
||||
@@ -28,13 +28,13 @@ You can access your resources in {% data variables.product.product_name %} in a
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.product_name %} in your browser using your IdP. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %}
|
||||
If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you will authenticate to {% data variables.product.github %} in your browser using your IdP. For more information, see [AUTOTITLE](/enterprise-cloud@latest/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#authenticating-as-a-managed-user){% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}.{% endif %}
|
||||
|
||||
If you're not a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you will authenticate using your {% data variables.product.prodname_dotcom %} username and password{% ifversion passkeys %}, or a passkey{% endif %}. You may also use two-factor authentication and SAML single sign-on, which can be required by organization and enterprise owners.
|
||||
|
||||
{% else %}
|
||||
|
||||
You can authenticate to {% data variables.product.product_name %} in your browser in a number of ways.
|
||||
You can authenticate to {% data variables.product.github %} in your browser in a number of ways.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -49,8 +49,8 @@ If you need to use multiple accounts on {% data variables.location.product_locat
|
||||
{% endif %}
|
||||
|
||||
* **Username and password only**
|
||||
* You'll create a password when you create your account on {% data variables.product.product_name %}. We recommend that you use a password manager to generate a random and unique password. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password).{% ifversion fpt or ghec %}
|
||||
* If you have not enabled 2FA, {% data variables.product.product_name %} may ask for additional verification when you first sign in from a new or unrecognized device, such as a new browser profile, a browser where the cookies have been deleted, or a new computer. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in).{% endif %}
|
||||
* You'll create a password when you create your account on {% data variables.product.github %}. We recommend that you use a password manager to generate a random and unique password. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password).{% ifversion fpt or ghec %}
|
||||
* If you have not enabled 2FA, {% data variables.product.github %} may ask for additional verification when you first sign in from a new or unrecognized device, such as a new browser profile, a browser where the cookies have been deleted, or a new computer. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in).{% endif %}
|
||||
* **Two-factor authentication (2FA)** (recommended)
|
||||
* If you enable 2FA, after you successfully enter your username and password, we'll also prompt you to provide a code that's generated by a time-based one time password (TOTP) application on your mobile device{% ifversion fpt or ghec %} or sent as a text message (SMS).{% endif %}{% ifversion 2fa-check-up-period %}
|
||||
* After you configure 2FA, your account enters a check up period for 28 days. You can leave the check up period by successfully performing 2FA within those 28 days. If you don't perform 2FA in that timespan, you'll then be asked to perform 2FA inside one of your existing {% data variables.product.prodname_dotcom %} sessions.
|
||||
@@ -74,11 +74,11 @@ If you need to use multiple accounts on {% data variables.location.product_locat
|
||||
|
||||
### Session cookies
|
||||
|
||||
{% data variables.product.company_short %} uses cookies to provide services and secure {% data variables.location.product_location %}. {% ifversion fpt or ghec %}You can review details about {% data variables.product.company_short %}'s cookies in the [privacy/cookies repository](https://github.com/privacy/cookies).{% endif %}
|
||||
{% data variables.product.company_short %} uses cookies to provide services and increase security. {% ifversion fpt or ghec %}You can review details about {% data variables.product.company_short %}'s cookies in the [privacy/cookies repository](https://github.com/privacy/cookies).{% endif %}
|
||||
|
||||
* The gist.{% ifversion fpt or ghec %}github.com{% elsif ghes %}HOSTNAME domain{% endif %} and {% ifversion fpt or ghec %}github.com domains{% elsif ghes %}base domain for your instance{% endif %} use separate cookies.
|
||||
* {% data variables.product.product_name %} typically marks a user session for deletion after two weeks of inactivity.
|
||||
* {% data variables.product.product_name %} does not immediately delete a session when you sign out. Periodically, {% data variables.product.product_name %} automatically deletes expired sessions.
|
||||
* {% data variables.product.github %} typically marks a user session for deletion after two weeks of inactivity.
|
||||
* {% data variables.product.github %} does not immediately delete a session when you sign out. Periodically, {% data variables.product.github %} automatically deletes expired sessions.
|
||||
|
||||
## Authenticating with {% data variables.product.prodname_desktop %}
|
||||
|
||||
@@ -108,23 +108,23 @@ For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-a
|
||||
|
||||
## Authenticating with the command line
|
||||
|
||||
You can access repositories on {% data variables.product.product_name %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see [AUTOTITLE](/get-started/getting-started-with-git/about-remote-repositories).
|
||||
You can access repositories on {% data variables.product.github %} from the command line in two ways, HTTPS and SSH, and both have a different way of authenticating. The method of authenticating is determined based on whether you choose an HTTPS or SSH remote URL when you clone the repository. For more information about which way to access, see [AUTOTITLE](/get-started/getting-started-with-git/about-remote-repositories).
|
||||
|
||||
### HTTPS
|
||||
|
||||
You can work with all repositories on {% data variables.product.product_name %} over HTTPS, even if you are behind a firewall or proxy.
|
||||
You can work with all repositories on {% data variables.product.github %} over HTTPS, even if you are behind a firewall or proxy.
|
||||
|
||||
If you authenticate with {% data variables.product.prodname_cli %}, you can either authenticate with a {% data variables.product.pat_generic %} or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login).
|
||||
|
||||
If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a {% data variables.product.pat_generic %}. {% data reusables.user-settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your credentials to authenticate with {% data variables.product.product_name %}, unless you cache them with a [credential helper](/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
|
||||
If you authenticate without {% data variables.product.prodname_cli %}, you must authenticate with a {% data variables.product.pat_generic %}. {% data reusables.user-settings.password-authentication-deprecation %} Every time you use Git to authenticate with {% data variables.product.github %}, you'll be prompted to enter your credentials, unless you cache them with a [credential helper](/get-started/getting-started-with-git/caching-your-github-credentials-in-git).
|
||||
|
||||
### SSH
|
||||
|
||||
You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxies might refuse to allow SSH connections.
|
||||
You can work with all repositories on {% data variables.product.github %} over SSH, although firewalls and proxies might refuse to allow SSH connections.
|
||||
|
||||
If you authenticate with {% data variables.product.prodname_cli %}, the CLI will find SSH public keys on your machine and will prompt you to select one for upload. If {% data variables.product.prodname_cli %} does not find a SSH public key for upload, it can generate a new SSH public/private keypair and upload the public key to your account on {% data variables.location.product_location %}. Then, you can either authenticate with a {% data variables.product.pat_generic %} or via the web browser. For more information about authenticating with {% data variables.product.prodname_cli %}, see [`gh auth login`](https://cli.github.com/manual/gh_auth_login).
|
||||
|
||||
If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent).
|
||||
If you authenticate without {% data variables.product.prodname_cli %}, you will need to generate an SSH public/private keypair on your local machine and add the public key to your account on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Every time you use Git to authenticate with {% data variables.product.github %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent).
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About GitHub's IP addresses
|
||||
intro: '{% data variables.product.product_name %} serves applications from multiple IP address ranges, which are available using the API.'
|
||||
intro: '{% data variables.product.github %} serves applications from multiple IP address ranges, which are available using the API.'
|
||||
redirect_from:
|
||||
- /articles/what-ip-addresses-does-github-use-that-i-should-whitelist
|
||||
- /categories/73/articles
|
||||
|
||||
@@ -21,14 +21,14 @@ You must choose or generate a password for your account on {% data variables.pro
|
||||
|
||||
To keep your account secure, we recommend you follow these best practices:
|
||||
* Use a password manager to generate a password of at least 15 characters.
|
||||
* Generate a unique password for {% data variables.product.product_name %}. If you use your {% data variables.product.product_name %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your account.
|
||||
* Generate a unique password for {% data variables.product.github %}. If you use your {% data variables.product.github %} password elsewhere and that service is compromised, then attackers or other malicious actors could use that information to access your account.
|
||||
* Configure two-factor authentication for your personal account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication).{% ifversion passkeys %}
|
||||
* {% data reusables.passkeys.add-passkey-option %}{% endif %}
|
||||
* Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.product_name %}. For more information on ways to collaborate, see: [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository), [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), or [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations).
|
||||
* Never share your password, even with a potential collaborator. Each person should use their own personal account on {% data variables.product.github %}. For more information on ways to collaborate, see: [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository), [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models), or [AUTOTITLE](/organizations/collaborating-with-groups-in-organizations).
|
||||
|
||||
{% data reusables.repositories.blocked-passwords %}
|
||||
|
||||
You can only use your password to log on to {% data variables.product.product_name %} using your browser. When you authenticate to {% data variables.product.product_name %} with other means, such as the command line or API, you should use other credentials. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
You can only use your password to log on to {% data variables.product.github %} using your browser. When you authenticate to {% data variables.product.github %} with other means, such as the command line or API, you should use other credentials. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
|
||||
{% ifversion fpt or ghec %}{% data reusables.user-settings.password-authentication-deprecation %}{% endif %}
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@ topics:
|
||||
|
||||
## About {% data variables.product.pat_generic %}s
|
||||
|
||||
{% data variables.product.pat_generic_caps %}s are an alternative to using passwords for authentication to {% data variables.product.product_name %} when using the [{% data variables.product.prodname_dotcom %} API](/rest/overview/authenticating-to-the-rest-api) or the [command line](#using-a-personal-access-token-on-the-command-line).
|
||||
{% data variables.product.pat_generic_caps %}s are an alternative to using passwords for authentication to {% data variables.product.github %} when using the [{% data variables.product.github %} API](/rest/overview/authenticating-to-the-rest-api) or the [command line](#using-a-personal-access-token-on-the-command-line).
|
||||
|
||||
{% data variables.product.pat_generic_caps %}s are intended to access {% data variables.product.company_short %} resources on behalf of yourself. To access resources on behalf of an organization, or for long-lived integrations, you should use a {% data variables.product.prodname_github_app %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/setting-up-a-github-app/about-creating-github-apps).
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
- Access management
|
||||
shortTitle: Unauthorized access
|
||||
---
|
||||
{% data variables.product.product_name %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members.
|
||||
{% data variables.product.github %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members.
|
||||
|
||||
After changing your password, you should perform these actions to make sure that your account is secure:
|
||||
|
||||
|
||||
@@ -49,10 +49,10 @@ Removing sensitive data from a repository involves four high-level steps:
|
||||
If you only rewrite your history and force push it, the commits with sensitive data may still be accessible elsewhere:
|
||||
|
||||
* In any clones or forks of your repository
|
||||
* Directly via their SHA-1 hashes in cached views on {% data variables.product.product_name %}
|
||||
* Directly via their SHA-1 hashes in cached views on {% data variables.product.github %}
|
||||
* Through any pull requests that reference them
|
||||
|
||||
You cannot remove sensitive data from other users' clones of your repository; you will have to send them the instructions from [Make sure other copies are cleaned up: clones of colleagues](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html#_make_sure_other_copies_are_cleaned_up_clones_of_colleagues) in the `git filter-repo` manual to have them do so themselves. However, you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %} by contacting {% data variables.contact.contact_support %}.
|
||||
You cannot remove sensitive data from other users' clones of your repository; you will have to send them the instructions from [Make sure other copies are cleaned up: clones of colleagues](https://htmlpreview.github.io/?https://github.com/newren/git-filter-repo/blob/docs/html/git-filter-repo.html#_make_sure_other_copies_are_cleaned_up_clones_of_colleagues) in the `git filter-repo` manual to have them do so themselves. However, you can permanently remove cached views and references to the sensitive data in pull requests on {% data variables.product.github %} by contacting {% data variables.contact.contact_support %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
@@ -129,11 +129,11 @@ Consider these limitations and challenges in your decision to rewrite your repos
|
||||
git push --force --mirror origin
|
||||
```
|
||||
|
||||
This command will fail to push any refs starting with `refs/pull/`, since {% data variables.product.product_name %} marks those as read-only. Those push failures will be handled in the next section. If any other refs fail to push, you likely have branch protection turned on for that branch and will need to turn it off temporarily and redo the push. Repeat until the only failures to update are refs starting with `refs/pull/`.
|
||||
This command will fail to push any refs starting with `refs/pull/`, since {% data variables.product.github %} marks those as read-only. Those push failures will be handled in the next section. If any other refs fail to push, you likely have branch protection turned on for that branch and will need to turn it off temporarily and redo the push. Repeat until the only failures to update are refs starting with `refs/pull/`.
|
||||
|
||||
## Fully removing the data from {% data variables.product.prodname_dotcom %}
|
||||
## Fully removing the data from {% data variables.product.github %}
|
||||
|
||||
After using `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.product_name %}, you must take a few more steps to fully remove the data from {% data variables.product.product_name %}.
|
||||
After using `git filter-repo` to remove the sensitive data and pushing your changes to {% data variables.product.github %}, you must take a few more steps to fully remove the data from {% data variables.product.github %}.
|
||||
|
||||
1. Contact {% data variables.contact.contact_support %}, and provide the following information:
|
||||
|
||||
@@ -144,7 +144,7 @@ After using `git filter-repo` to remove the sensitive data and pushing your chan
|
||||
|
||||
If you have successfully cleaned up all references other than PRs, and no forks have references to the sensitive data, Support will then:
|
||||
|
||||
* Dereference or delete any affected PRs on {% data variables.product.product_name %}.
|
||||
* Dereference or delete any affected PRs on {% data variables.product.github %}.
|
||||
* Run a garbage collection on the server to expunge the sensitive data from storage.
|
||||
* Remove cached views.
|
||||
* If LFS Objects are involved, delete and/or purge the orphaned LFS objects.
|
||||
|
||||
@@ -37,7 +37,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
|
||||
> 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA)
|
||||
```
|
||||
|
||||
1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer.
|
||||
1. The SSH keys on {% data variables.product.github %} _should_ match the same keys on your computer.
|
||||
|
||||
{% endmac %}
|
||||
|
||||
@@ -65,7 +65,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
|
||||
> 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA)
|
||||
```
|
||||
|
||||
1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer.
|
||||
1. The SSH keys on {% data variables.product.github %} _should_ match the same keys on your computer.
|
||||
|
||||
{% endwindows %}
|
||||
|
||||
@@ -89,9 +89,9 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an
|
||||
> 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA)
|
||||
```
|
||||
|
||||
1. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer.
|
||||
1. The SSH keys on {% data variables.product.github %} _should_ match the same keys on your computer.
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
> [!WARNING]
|
||||
> If you see an SSH key you're not familiar with on {% data variables.product.product_name %}, delete it immediately and contact {% data variables.contact.contact_support %} for further help. An unidentified public key may indicate a possible security concern.
|
||||
> If you see an SSH key you're not familiar with on {% data variables.product.github %}, delete it immediately and contact {% data variables.contact.contact_support %} for further help. An unidentified public key may indicate a possible security concern.
|
||||
|
||||
@@ -23,7 +23,7 @@ To maintain the security of your account when you perform a potentially sensitiv
|
||||
* Addition of a new SSH key
|
||||
* Creation of a PAT or application
|
||||
|
||||
After you authenticate to perform a sensitive action, your session is temporarily in "sudo mode." In sudo mode, you can perform sensitive actions without authentication. {% data variables.product.product_name %} has a two-hour session timeout period before prompting you for authentication again. During this time, any sensitive action that you perform will reset the timer.
|
||||
After you authenticate to perform a sensitive action, your session is temporarily in "sudo mode." In sudo mode, you can perform sensitive actions without authentication. {% data variables.product.github %} has a two-hour session timeout period before prompting you for authentication again. During this time, any sensitive action that you perform will reset the timer.
|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
@@ -34,7 +34,7 @@ After you authenticate to perform a sensitive action, your session is temporaril
|
||||
{% ifversion ghec %}
|
||||
|
||||
> [!NOTE]
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, only the setup user will receive prompts to enter sudo mode, as {% data variables.enterprise.prodname_managed_users %} don't have credentials stored on {% data variables.product.product_name %}.
|
||||
> If your enterprise uses {% data variables.product.prodname_emus %}, only the setup user will receive prompts to enter sudo mode, as {% data variables.enterprise.prodname_managed_users %} don't have credentials stored on {% data variables.product.github %}.
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ If you need to use multiple accounts on {% data variables.product.prodname_dotco
|
||||
|
||||
When you are signed in to multiple accounts and using the account switcher, those sessions remain on your computer or browser. If you access {% data variables.product.prodname_dotcom %} on another computer or browser, the same accounts will not be available until you add them.
|
||||
|
||||
If you are signed in to multiple accounts and follow a link to {% data variables.product.product_name %} from an external source, such as a request to install or approve a {% data variables.product.prodname_github_app %}, you will first be prompted to choose which account you want to use.
|
||||
If you are signed in to multiple accounts and follow a link to {% data variables.product.github %} from an external source, such as a request to install or approve a {% data variables.product.prodname_github_app %}, you will first be prompted to choose which account you want to use.
|
||||
|
||||
Your SSO sessions will persist when you switch away from an account and return. This means you will not always need to authenticate with your identity provider (IdP) each time you want to use your SSO-linked account. {% ifversion fpt or ghec %}If you're a member of an enterprise that uses {% data variables.product.prodname_emus %} and add your {% data variables.enterprise.prodname_managed_user %} to the account switcher, the {% data variables.enterprise.prodname_managed_user %} will appear grayed out if your session has expired. Selecting the expired account will send you to reauthenticate with your IdP.{% endif %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Token expiration and revocation
|
||||
intro: 'Your tokens can expire and can also be revoked by you, applications you have authorized, and {% data variables.product.product_name %} itself.'
|
||||
intro: 'Your tokens can expire and can also be revoked by you, applications you have authorized, and {% data variables.product.github %} itself.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
@@ -15,7 +15,7 @@ redirect_from:
|
||||
|
||||
When a token has expired or has been revoked, it can no longer be used to authenticate Git and API requests. It is not possible to restore an expired or revoked token, you or the application will need to create a new token.
|
||||
|
||||
This article explains the possible reasons your {% data variables.product.product_name %} token might be revoked or expire.
|
||||
This article explains the possible reasons your {% data variables.product.github %} token might be revoked or expire.
|
||||
|
||||
> [!NOTE]
|
||||
> When a {% data variables.product.pat_generic %} or OAuth token expires or is revoked, you may see an `oauth_authorization.destroy` action in your security log. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log).
|
||||
@@ -36,7 +36,7 @@ If a valid OAuth token, {% data variables.product.prodname_github_app %} token,
|
||||
|
||||
## Token expired due to lack of use
|
||||
|
||||
{% data variables.product.product_name %} will automatically revoke an OAuth token or {% data variables.product.pat_generic %} when the token hasn't been used in one year.
|
||||
{% data variables.product.github %} will automatically revoke an OAuth token or {% data variables.product.pat_generic %} when the token hasn't been used in one year.
|
||||
{% endif %}
|
||||
|
||||
## Token revoked by the user
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Updating your GitHub access credentials
|
||||
intro: '{% data variables.product.product_name %} credentials include not only your password, but also the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.product_name %}. Should you have the need, you can reset all of these access credentials yourself.'
|
||||
intro: '{% data variables.product.github %} credentials include not only your password, but also the access tokens, SSH keys, and application API tokens you use to communicate with {% data variables.product.github %}. Should you have the need, you can reset all of these access credentials yourself.'
|
||||
redirect_from:
|
||||
- /articles/rolling-your-credentials
|
||||
- /articles/how-can-i-reset-my-password
|
||||
@@ -50,7 +50,7 @@ shortTitle: Update access credentials
|
||||
|
||||
{% data reusables.repositories.blocked-passwords %}
|
||||
|
||||
1. Sign in to {% data variables.product.product_name %}.
|
||||
1. Sign in to {% data variables.product.github %}.
|
||||
{% data reusables.user-settings.access_settings %}
|
||||
{% data reusables.user-settings.security %}
|
||||
1. Under "Change password", type your old password, a strong new password, and confirm your new password. For help creating a strong password, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-strong-password).
|
||||
@@ -71,7 +71,7 @@ See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-y
|
||||
|
||||
## Resetting API tokens
|
||||
|
||||
If you have any applications registered with {% data variables.product.product_name %}, you'll want to reset their OAuth tokens. For more information, see the `PATCH /applications/{client_id}/token` endpoint in [AUTOTITLE](/rest/apps/oauth-applications#reset-a-token).
|
||||
If you have any applications registered with {% data variables.product.github %}, you'll want to reset their OAuth tokens. For more information, see the `PATCH /applications/{client_id}/token` endpoint in [AUTOTITLE](/rest/apps/oauth-applications#reset-a-token).
|
||||
|
||||
## Preventing unauthorized access
|
||||
|
||||
|
||||
@@ -20,9 +20,9 @@ You will only need to verify a new device once. If you clear your cookies, or us
|
||||
|
||||
## Verifying your sign-in attempt
|
||||
|
||||
1. Sign in to {% data variables.product.product_name %}, using your username and password.
|
||||
1. Sign in to {% data variables.product.github %}, using your username and password.
|
||||
1. If you are signing in from an unrecognized device, {% data variables.product.prodname_dotcom %} may ask to you pass a "Device verification" prompt. The verification code is sent to all primary and backup email addresses associated with your account. The code is valid for one hour.
|
||||
* If you have the {% data variables.product.prodname_mobile %} application installed, {% data variables.product.product_name %} sends a verification request to your mobile device, instead of sending an email. Enter the code displayed in your browser into the {% data variables.product.prodname_mobile %} app to verify your sign-in. You can request an email code if your mobile device is unavailable.
|
||||
* If you have the {% data variables.product.prodname_mobile %} application installed, {% data variables.product.github %} sends a verification request to your mobile device, instead of sending an email. Enter the code displayed in your browser into the {% data variables.product.prodname_mobile %} app to verify your sign-in. You can request an email code if your mobile device is unavailable.
|
||||
1. Enter the verification code into your browser to verify your sign-in.
|
||||
|
||||
## Troubleshooting device verification
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: About commit signature verification
|
||||
intro: 'Using GPG, SSH, or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.product_name %} so other people can be confident that the changes come from a trusted source.'
|
||||
intro: 'Using GPG, SSH, or S/MIME, you can sign tags and commits locally. These tags or commits are marked as verified on {% data variables.product.github %} so other people can be confident that the changes come from a trusted source.'
|
||||
redirect_from:
|
||||
- /articles/about-gpg-commit-and-tag-signatures
|
||||
- /articles/about-gpg
|
||||
@@ -18,15 +18,15 @@ shortTitle: Commit signature verification
|
||||
---
|
||||
## About commit signature verification
|
||||
|
||||
You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG, SSH, or S/MIME signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %}
|
||||
You can sign commits and tags locally, to give other people confidence about the origin of a change you have made. If a commit or tag has a GPG, SSH, or S/MIME signature that is cryptographically verifiable, {% data variables.product.github %} marks the commit or tag {% ifversion fpt or ghec %}"Verified" or "Partially verified."{% else %}"Verified."{% endif %}
|
||||
|
||||
|
||||
|
||||
{% ifversion ghes %}
|
||||
If a commit or tag has a signature that can't be verified, {% data variables.product.product_name %} marks the commit or tag "Unverified."
|
||||
If a commit or tag has a signature that can't be verified, {% data variables.product.github %} marks the commit or tag "Unverified."
|
||||
{% endif %}
|
||||
|
||||
For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.product_name %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. The GPG signature may include the information about it being expired or revoked.
|
||||
For most individual users, GPG or SSH will be the best choice for signing commits. S/MIME signatures are usually required in the context of a larger organization. SSH signatures are the simplest to generate. You can even upload your existing authentication key to {% data variables.product.github %} to also use as a signing key. Generating a GPG signing key is more involved than generating an SSH key, but GPG has features that SSH does not. A GPG key can expire or be revoked when no longer used. The GPG signature may include the information about it being expired or revoked.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
@@ -46,19 +46,19 @@ Signing commits differs from signing off on a commit. For more information about
|
||||
|
||||
Regardless of the signature choice - GPG, SSH, or S/MIME - once a commit signature is verified, it remains verified within its repository's network. See [AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories).
|
||||
|
||||
When a commit signature is verified upon being pushed to {% data variables.product.product_name %}, a verification record is stored alongside the commit. This record can't be edited and will persist so that signatures remain verified over time, even if signing keys are rotated, revoked, or if contributors leave the organization.
|
||||
When a commit signature is verified upon being pushed to {% data variables.product.github %}, a verification record is stored alongside the commit. This record can't be edited and will persist so that signatures remain verified over time, even if signing keys are rotated, revoked, or if contributors leave the organization.
|
||||
|
||||
The verification record includes a timestamp marking when the verification was completed. This persistent record ensures a consistent verified state, providing a stable history of contributions within the repository. You can view this timestamp by hovering over the "Verified" badge on {% data variables.product.product_name %} or by accessing the commit via the REST API, which includes a `verified_at` field. See [AUTOTITLE](/rest/commits/commits).
|
||||
The verification record includes a timestamp marking when the verification was completed. This persistent record ensures a consistent verified state, providing a stable history of contributions within the repository. You can view this timestamp by hovering over the "Verified" badge on {% data variables.product.github %} or by accessing the commit via the REST API, which includes a `verified_at` field. See [AUTOTITLE](/rest/commits/commits).
|
||||
|
||||
Persistent commit signature verification applies to new commits pushed to {% data variables.product.product_name %}. For any commits that predate this feature, a persistent record will be created the next time the commit's signature is verified on {% data variables.product.product_name %}, helping ensure that verified statuses remain stable and reliable across the repository's history.
|
||||
Persistent commit signature verification applies to new commits pushed to {% data variables.product.github %}. For any commits that predate this feature, a persistent record will be created the next time the commit's signature is verified on {% data variables.product.github %}, helping ensure that verified statuses remain stable and reliable across the repository's history.
|
||||
|
||||
#### Records persist even after revocation and expiration
|
||||
|
||||
Persistent commit signature verification reflects the verified state of a commit at the time of verification. This means that if a signing key is later revoked, expired, or otherwise altered, previously verified commits retain their verified status based on the record created during the initial verification. {% data variables.product.product_name %} will not re-verify previously signed commits or retroactively adjust their verification status in response to changes in the key's state. Organizations may need to manage key states directly to align with their security policies, especially if frequent key rotation or revocation is planned.
|
||||
Persistent commit signature verification reflects the verified state of a commit at the time of verification. This means that if a signing key is later revoked, expired, or otherwise altered, previously verified commits retain their verified status based on the record created during the initial verification. {% data variables.product.github %} will not re-verify previously signed commits or retroactively adjust their verification status in response to changes in the key's state. Organizations may need to manage key states directly to align with their security policies, especially if frequent key rotation or revocation is planned.
|
||||
|
||||
#### The verification record is scoped to its repository network
|
||||
|
||||
The verification record is persistent across the repository network, meaning that if the same commit is pushed again to the same repository or to any of its forks, the existing verification record is reused. This allows {% data variables.product.product_name %} to maintain a consistent verified status across related repositories without re-verifying the commit each time it appears within the network. This persistence reinforces a unified and reliable view of commit authenticity across all instances of the commit within the repository network.
|
||||
The verification record is persistent across the repository network, meaning that if the same commit is pushed again to the same repository or to any of its forks, the existing verification record is reused. This allows {% data variables.product.github %} to maintain a consistent verified status across related repositories without re-verifying the commit each time it appears within the network. This persistence reinforces a unified and reliable view of commit authenticity across all instances of the commit within the repository network.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -82,7 +82,7 @@ Repository administrators can enforce required commit signing on a branch to blo
|
||||
|
||||
{% data reusables.identity-and-permissions.verification-status-check %}
|
||||
|
||||
{% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.product_name %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.product_name %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing).
|
||||
{% ifversion ghes %}If a site administrator has enabled web commit signing, {% data variables.product.github %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.github %} will have a verified status. You can verify the signature locally using the public key available at `https://HOSTNAME/web-flow.gpg`. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing).
|
||||
{% else %}{% data variables.product.prodname_dotcom %} will automatically use GPG to sign commits you make using the web interface. Commits signed by {% data variables.product.prodname_dotcom %} will have a verified status. You can verify the signature locally using the public key available at https://github.com/web-flow.gpg.
|
||||
|
||||
You can optionally choose to have {% data variables.product.prodname_dotcom %} GPG sign commits you make in {% data variables.product.prodname_github_codespaces %}. For more information about enabling GPG verification for your codespaces, see [AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces).{% endif %}
|
||||
@@ -91,9 +91,9 @@ You can optionally choose to have {% data variables.product.prodname_dotcom %} G
|
||||
|
||||
You can use GPG to sign commits with a GPG key that you generate yourself.
|
||||
|
||||
{% data variables.product.product_name %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}.
|
||||
{% data variables.product.github %} uses OpenPGP libraries to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}.
|
||||
|
||||
To sign commits using GPG and have those commits verified on {% data variables.product.product_name %}, follow these steps:
|
||||
To sign commits using GPG and have those commits verified on {% data variables.product.github %}, follow these steps:
|
||||
|
||||
1. [Check for existing GPG keys](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys)
|
||||
1. [Generate a new GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
|
||||
@@ -104,14 +104,14 @@ To sign commits using GPG and have those commits verified on {% data variables.p
|
||||
|
||||
## SSH commit signature verification
|
||||
|
||||
You can use SSH to sign commits with an SSH key that you generate yourself. For more information, see the [Git reference documentation](https://git-scm.com/docs/git-config#Documentation/git-config.txt-usersigningKey) for `user.Signingkey`. If you already use an SSH key to authenticate with {% data variables.product.product_name %},
|
||||
You can use SSH to sign commits with an SSH key that you generate yourself. For more information, see the [Git reference documentation](https://git-scm.com/docs/git-config#Documentation/git-config.txt-usersigningKey) for `user.Signingkey`. If you already use an SSH key to authenticate with {% data variables.product.github %},
|
||||
you can also upload that same key again for use as a signing key. There's no limit on the number of signing keys you can add to your account.
|
||||
|
||||
{% data variables.product.product_name %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}.
|
||||
{% data variables.product.github %} uses [ssh_data](https://github.com/github/ssh_data), an open source Ruby library, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key you have added to your account on {% data variables.location.product_location %}.
|
||||
|
||||
{% data reusables.gpg.ssh-git-version %}
|
||||
|
||||
To sign commits using SSH and have those commits verified on {% data variables.product.product_name %}, follow these steps:
|
||||
To sign commits using SSH and have those commits verified on {% data variables.product.github %}, follow these steps:
|
||||
|
||||
1. [Check for existing SSH keys](/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)
|
||||
1. [Generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
|
||||
@@ -124,23 +124,23 @@ To sign commits using SSH and have those commits verified on {% data variables.p
|
||||
|
||||
You can use S/MIME to sign commits with an X.509 key issued by your organization.
|
||||
|
||||
{% data variables.product.product_name %} uses [the Debian ca-certificates package](https://packages.debian.org/bullseye/ca-certificates), the same trust store used by Mozilla browsers, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key in a trusted root certificate.
|
||||
{% data variables.product.github %} uses [the Debian ca-certificates package](https://packages.debian.org/bullseye/ca-certificates), the same trust store used by Mozilla browsers, to confirm that your locally signed commits and tags are cryptographically verifiable against a public key in a trusted root certificate.
|
||||
|
||||
{% data reusables.gpg.smime-git-version %}
|
||||
|
||||
To sign commits using S/MIME and have those commits verified on {% data variables.product.product_name %}, follow these steps:
|
||||
To sign commits using S/MIME and have those commits verified on {% data variables.product.github %}, follow these steps:
|
||||
|
||||
1. [Tell Git about your signing key](/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key)
|
||||
1. [Sign commits](/authentication/managing-commit-signature-verification/signing-commits)
|
||||
1. [Sign tags](/authentication/managing-commit-signature-verification/signing-tags)
|
||||
|
||||
You don't need to upload your public key to {% data variables.product.product_name %}.
|
||||
You don't need to upload your public key to {% data variables.product.github %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
## Signature verification for bots
|
||||
|
||||
Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.product_name %} marks the commit or tag as verified.
|
||||
Organizations and {% data variables.product.prodname_github_apps %} that require commit signing can use bots to sign commits. If a commit or tag has a bot signature that is cryptographically verifiable, {% data variables.product.github %} marks the commit or tag as verified.
|
||||
|
||||
Signature verification for bots will only work if the request is verified and authenticated as the {% data variables.product.prodname_github_app %} or bot and contains no custom author information, custom committer information, and no custom signature information, such as Commits API.
|
||||
{% endif %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Adding a GPG key to your GitHub account
|
||||
intro: 'To configure your account on {% data variables.product.product_name %} to use your new (or existing) GPG key, you''ll also need to add the key to your account.'
|
||||
intro: 'To configure your account on {% data variables.product.github %} to use your new (or existing) GPG key, you''ll also need to add the key to your account.'
|
||||
redirect_from:
|
||||
- /articles/adding-a-gpg-key-to-your-github-account
|
||||
- /github/authenticating-to-github/adding-a-new-gpg-key-to-your-github-account
|
||||
@@ -22,9 +22,9 @@ shortTitle: Add a GPG key
|
||||
|
||||
## About addition of GPG keys to your account
|
||||
|
||||
To sign commits associated with your account on {% data variables.product.product_name %}, you can add a public GPG key to your personal account. Before you add a key, you should check for existing keys. If you don't find any existing keys, you can generate and copy a new key. For more information, see [AUTOTITLE](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys) and [AUTOTITLE](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
|
||||
To sign commits associated with your account on {% data variables.product.github %}, you can add a public GPG key to your personal account. Before you add a key, you should check for existing keys. If you don't find any existing keys, you can generate and copy a new key. For more information, see [AUTOTITLE](/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys) and [AUTOTITLE](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
|
||||
|
||||
You can add multiple public keys to your account on {% data variables.product.product_name %}. Commits signed by any of the corresponding private keys will show as verified. {% ifversion persistent-commit-verification %}Once a commit has been verified, any commits signed by the corresponding private key will continue to show as verified, even if the public key is removed.{% else %}If you remove a public key, any commits signed by the corresponding private key will no longer show as verified.{% endif %}
|
||||
You can add multiple public keys to your account on {% data variables.product.github %}. Commits signed by any of the corresponding private keys will show as verified. {% ifversion persistent-commit-verification %}Once a commit has been verified, any commits signed by the corresponding private key will continue to show as verified, even if the public key is removed.{% else %}If you remove a public key, any commits signed by the corresponding private key will no longer show as verified.{% endif %}
|
||||
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ To verify as many of your commits as possible, you can add expired and revoked k
|
||||
|
||||
{% data reusables.gpg.supported-gpg-key-algorithms %}
|
||||
|
||||
When verifying a signature, {% data variables.product.product_name %} extracts the signature and attempts to parse its key ID. The key ID is then matched with keys added to {% data variables.product.product_name %}. Until a matching GPG key is added to {% data variables.product.product_name %}, it cannot verify your signatures.
|
||||
When verifying a signature, {% data variables.product.github %} extracts the signature and attempts to parse its key ID. The key ID is then matched with keys added to {% data variables.product.github %}. Until a matching GPG key is added to {% data variables.product.github %}, it cannot verify your signatures.
|
||||
|
||||
## Adding a GPG key
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Associating an email with your GPG key
|
||||
intro: 'Your GPG key must be associated with a {% data variables.product.product_name %} verified email that matches your committer identity.'
|
||||
intro: 'Your GPG key must be associated with a verified email that matches your committer identity.'
|
||||
redirect_from:
|
||||
- /articles/associating-an-email-with-your-gpg-key
|
||||
- /github/authenticating-to-github/associating-an-email-with-your-gpg-key
|
||||
|
||||
@@ -24,7 +24,7 @@ However, you can give other users increased confidence in the identity attribute
|
||||
|
||||
{% data reusables.identity-and-permissions.vigilant-mode-verification-statuses %}
|
||||
|
||||
You should only enable vigilant mode if you sign all of your commits and tags and use an email address that is verified for your account on {% data variables.product.product_name %} as your committer email address. After enabling this mode, any unsigned commits or tags that you generate locally and push to {% data variables.product.prodname_dotcom %} will be marked "Unverified."
|
||||
You should only enable vigilant mode if you sign all of your commits and tags and use an email address that is verified for your {% data variables.product.github %} account as your committer email address. After enabling this mode, any unsigned commits or tags that you generate locally and push to {% data variables.product.github %} will be marked "Unverified."
|
||||
|
||||
{% data reusables.identity-and-permissions.verification-status-check %}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing commit signature verification
|
||||
intro: '{% data variables.product.product_name %} will verify GPG, SSH, or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.product_name %} will automatically sign commits you make using the {% data variables.product.product_name %} web interface.{% endif %}'
|
||||
intro: '{% data variables.product.github %} will verify GPG, SSH, or S/MIME signatures so other people will know that your commits come from a trusted source.{% ifversion fpt %} {% data variables.product.github %} will automatically sign commits you make using the web interface.{% endif %}'
|
||||
redirect_from:
|
||||
- /articles/generating-a-gpg-key
|
||||
- /articles/signing-commits-with-gpg
|
||||
|
||||
@@ -36,14 +36,14 @@ If you have multiple keys or are attempting to sign commits or tags with a key t
|
||||
```
|
||||
|
||||
1. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/authentication/managing-commit-signature-verification/generating-a-new-gpg-key).
|
||||
1. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.product_name %}:
|
||||
1. When you've finished creating commits locally, push them to your remote repository on {% data variables.product.github %}:
|
||||
|
||||
```shell
|
||||
$ git push
|
||||
# Pushes your local commits to the remote repository
|
||||
```
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to your pull request.
|
||||
1. On {% data variables.product.github %}, navigate to your pull request.
|
||||
{% data reusables.repositories.review-pr-commits %}
|
||||
1. To view more detailed information about the verified signature, click **Verified.**
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ shortTitle: About mandatory 2FA
|
||||
|
||||
## About eligibility for mandatory 2FA
|
||||
|
||||
Your account is selected for mandatory 2FA if you have taken some action on {% data variables.product.product_name %} that shows you are a contributor. Eligible actions include:
|
||||
Your account is selected for mandatory 2FA if you have taken some action on {% data variables.product.github %} that shows you are a contributor. Eligible actions include:
|
||||
* Publishing an app or action for others
|
||||
* Creating a release for your repository
|
||||
* Contributing to specific high-importance repositories, such as [the projects tracked by the Open Source Security Foundation](https://github.com/ossf/wg-securing-critical-projects#current-work)
|
||||
|
||||
@@ -18,7 +18,7 @@ shortTitle: About 2FA
|
||||
{% data reusables.two_fa.mandatory-2fa-contributors-2023 %}
|
||||
{% endif %}
|
||||
|
||||
For {% data variables.product.product_name %}, the second form of authentication is a code that's generated by an application on your mobile device{% ifversion fpt or ghec %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.product_name %} generates an authentication code any time someone attempts to sign into your account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
|
||||
For {% data variables.product.github %}, the second form of authentication is a code that's generated by an application on your mobile device{% ifversion fpt or ghec %} or sent as a text message (SMS){% endif %}. After you enable 2FA, {% data variables.product.github %} generates an authentication code any time someone attempts to sign into your account. The only way someone can sign into your account is if they know both your password and have access to the authentication code on your phone.
|
||||
|
||||
{% data reusables.two_fa.after-2fa-add-security-key %}
|
||||
|
||||
@@ -39,10 +39,10 @@ You can also configure additional recovery methods in case you lose access to yo
|
||||
|
||||
{% endif %}
|
||||
|
||||
We **strongly** urge you to enable 2FA for the safety of your account, not only on {% data variables.product.product_name %}, but on other websites and apps that support 2FA. You can enable 2FA to access {% data variables.product.product_name %} and {% data variables.product.prodname_desktop %}.
|
||||
We **strongly** urge you to enable 2FA for the safety of your account, not only on {% data variables.product.github %}, but on other websites and apps that support 2FA. You can enable 2FA to access {% data variables.product.github %} and {% data variables.product.prodname_desktop %}.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
If you don't enable 2FA, {% data variables.product.product_name %} may ask for additional verification to confirm that it is you when you sign in for the first time from a new or unrecognized device. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in).
|
||||
If you don't enable 2FA, {% data variables.product.github %} may ask for additional verification to confirm that it is you when you sign in for the first time from a new or unrecognized device. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in).
|
||||
{% endif %}
|
||||
|
||||
For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Accessing GitHub using two-factor authentication
|
||||
intro: 'With 2FA enabled, you''ll be asked to provide your 2FA authentication code, as well as your password, when you sign in to {% data variables.product.product_name %}.'
|
||||
intro: 'With 2FA enabled, you''ll be asked to provide your 2FA authentication code, as well as your password, when you sign in to {% data variables.product.github %}.'
|
||||
redirect_from:
|
||||
- /articles/providing-your-2fa-security-code
|
||||
- /articles/providing-your-2fa-authentication-code
|
||||
@@ -19,25 +19,25 @@ shortTitle: Access GitHub with 2FA
|
||||
|
||||
{% ifversion 2fa-check-up-period %}
|
||||
|
||||
With two-factor authentication (2FA) enabled, you'll need to use a second factor when accessing {% data variables.product.product_name %} through your browser. When you first configure 2FA, your account will enter a check up period for 28 days to ensure your account's 2FA methods are setup correctly. You can exit the check up period by successfully performing 2FA within 28 days. If you don't authenticate within 28 days, you'll be asked to perform 2FA inside one of your existing {% data variables.product.prodname_dotcom %} sessions. If you cannot perform 2FA to pass the 28th day checkup, use the provided shortcut to reconfigure your 2FA settings and retain access to {% data variables.product.prodname_dotcom %}. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication).
|
||||
With two-factor authentication (2FA) enabled, you'll need to use a second factor when accessing {% data variables.product.github %}through your browser. When you first configure 2FA, your account will enter a check up period for 28 days to ensure your account's 2FA methods are setup correctly. You can exit the check up period by successfully performing 2FA within 28 days. If you don't authenticate within 28 days, you'll be asked to perform 2FA inside one of your existing {% data variables.product.github %} sessions. If you cannot perform 2FA to pass the 28th day checkup, use the provided shortcut to reconfigure your 2FA settings and retain access to {% data variables.product.github %}. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication).
|
||||
|
||||
If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll authenticate using a token, application, or SSH key. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
If you access {% data variables.product.github %} using other methods, such as the API or the command line, you'll authenticate using a token, application, or SSH key. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
|
||||
{% else %}
|
||||
|
||||
With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a security key when accessing {% data variables.product.product_name %} through your browser. If you access {% data variables.product.product_name %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
With two-factor authentication enabled, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in GitHub Mobile,{% endif %} or use a security key when accessing {% data variables.product.github %} through your browser. If you access {% data variables.product.github %} using other methods, such as the API or the command line, you'll need to use an alternative form of authentication. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/about-authentication-to-github).
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Performing 2FA when signing in to the website
|
||||
|
||||
After you sign in to {% data variables.product.product_name %} using your password, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in {% data variables.product.prodname_mobile %},{% endif %} or use a security key to perform 2FA.
|
||||
After you sign in to {% data variables.product.github %} using your password, you'll need to provide an authentication code{% ifversion fpt or ghec %}, tap a notification in {% data variables.product.prodname_mobile %},{% endif %} or use a security key to perform 2FA.
|
||||
|
||||
{% data variables.product.product_name %} will only ask you to provide your 2FA authentication code again if you've logged out, are using a new device, are performing a sensitive action, or your session expires. For more information on 2FA for sensitive actions, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/sudo-mode).
|
||||
{% data variables.product.github %} will only ask you to provide your 2FA authentication code again if you've logged out, are using a new device, are performing a sensitive action, or your session expires. For more information on 2FA for sensitive actions, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/sudo-mode).
|
||||
|
||||
### Generating a code through a TOTP application
|
||||
|
||||
If you chose to set up two-factor authentication using a TOTP application, you can generate an authentication code for {% data variables.product.product_name %} at any time. In most cases, just launching the application will generate a new code. You should refer to your application's documentation for specific instructions.
|
||||
If you chose to set up two-factor authentication using a TOTP application, you can generate an authentication code for {% data variables.product.github %} at any time. In most cases, just launching the application will generate a new code. You should refer to your application's documentation for specific instructions.
|
||||
|
||||
If you delete your authenticator application after configuring two-factor authentication, you'll need to provide your recovery code to get access to your account. Many TOTP apps support the secure backup of your authentication codes in the cloud and can be restored if you lose access to your device. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials).
|
||||
|
||||
@@ -45,7 +45,7 @@ If you delete your authenticator application after configuring two-factor authen
|
||||
|
||||
If you've set up a security key on your account, and your browser supports security keys, you can use it to complete your sign in.
|
||||
|
||||
1. Using your username and password, sign in to {% data variables.product.product_name %} through your browser.
|
||||
1. Using your username and password, sign in to {% data variables.product.github %} through your browser.
|
||||
1. If you use a physical security key, ensure it's connected to your device.
|
||||
1. To trigger the security key prompt from your operating system, select "Use security key."
|
||||
1. Select the appropriate option in the prompt. Depending on your security key configuration, you may type a PIN, complete a biometric prompt, or use a physical security key.
|
||||
@@ -62,14 +62,14 @@ If you have enabled 2FA, and you have added a passkey to your account, you can u
|
||||
|
||||
### Receiving a text message
|
||||
|
||||
If you set up two-factor authentication via text messages, {% data variables.product.product_name %} will send you a text message with your authentication code.
|
||||
If you set up two-factor authentication via text messages, {% data variables.product.github %} will send you a text message with your authentication code.
|
||||
|
||||
### Verifying with {% data variables.product.prodname_mobile %}
|
||||
|
||||
If you have installed and signed in to {% data variables.product.prodname_mobile %}, you may choose to authenticate with {% data variables.product.prodname_mobile %} for two-factor authentication.
|
||||
|
||||
1. Sign in to {% data variables.product.product_name %} with your browser, using your username and password.
|
||||
1. {% data variables.product.product_name %} will send you a push notification to verify your sign in attempt. Opening the push notification or opening the {% data variables.product.prodname_mobile %} app will display a prompt, asking you to approve or reject this sign in attempt.
|
||||
1. Sign in to {% data variables.product.github %} with your browser, using your username and password.
|
||||
1. {% data variables.product.github %} will send you a push notification to verify your sign in attempt. Opening the push notification or opening the {% data variables.product.prodname_mobile %} app will display a prompt, asking you to approve or reject this sign in attempt.
|
||||
|
||||
> [!NOTE]
|
||||
> This prompt may require you to enter a two-digit number displayed within the browser you are signing in to.
|
||||
@@ -82,7 +82,7 @@ If you have installed and signed in to {% data variables.product.prodname_mobile
|
||||
## Using two-factor authentication with the command line
|
||||
|
||||
{% ifversion ghes %}
|
||||
After you've enabled 2FA, you will no longer use your password to access {% data variables.product.product_name %} on the command line. Instead, use Git Credential Manager, a {% data variables.product.pat_generic %}, or an SSH key.
|
||||
After you've enabled 2FA, you will no longer use your password to access {% data variables.product.github %} on the command line. Instead, use Git Credential Manager, a {% data variables.product.pat_generic %}, or an SSH key.
|
||||
{% endif %}
|
||||
|
||||
### Authenticating on the command line using Git Credential Manager
|
||||
@@ -93,15 +93,15 @@ Setup instructions vary based on your computer's operating system. For more info
|
||||
|
||||
### Authenticating on the command line using HTTPS
|
||||
|
||||
You must create a {% data variables.product.pat_generic %} to use as a password when authenticating to {% data variables.product.product_name %} on the command line using HTTPS URLs.
|
||||
You must create a {% data variables.product.pat_generic %} to use as a password when authenticating to {% data variables.product.github %} on the command line using HTTPS URLs.
|
||||
|
||||
When prompted for a username and password on the command line, use your {% data variables.product.product_name %} username and {% data variables.product.pat_generic %}. The command line prompt won't specify that you should enter your {% data variables.product.pat_generic %} when it asks for your password.
|
||||
When prompted for a username and password on the command line, use your {% data variables.product.github %} username and {% data variables.product.pat_generic %}. The command line prompt won't specify that you should enter your {% data variables.product.pat_generic %} when it asks for your password.
|
||||
|
||||
For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
||||
|
||||
### Authenticating on the command line using SSH
|
||||
|
||||
Enabling 2FA doesn't change how you authenticate to {% data variables.product.product_name %} on the command line using SSH URLs. For more information about setting up and using an SSH key, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh).
|
||||
Enabling 2FA doesn't change how you authenticate to {% data variables.product.github %} on the command line using SSH URLs. For more information about setting up and using an SSH key, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh).
|
||||
|
||||
{% ifversion ghes < 3.13 %}
|
||||
|
||||
|
||||
@@ -132,7 +132,7 @@ Once you have configured a TOTP application, or SMS, you can also use {% data va
|
||||
|
||||
1. You must have already configured 2FA via a TOTP mobile app or via SMS.
|
||||
1. Install [{% data variables.product.prodname_mobile %}](https://github.com/mobile).
|
||||
1. Sign in to your {% data variables.product.product_name %} account from {% data variables.product.prodname_mobile %}.
|
||||
1. Sign in to your {% data variables.product.github %} account from {% data variables.product.prodname_mobile %}.
|
||||
1. Ensure {% data variables.product.prodname_mobile %} can send push notifications. If you have not opted in to push notifications, you can turn them on within notification settings in {% data variables.product.prodname_mobile %}.
|
||||
|
||||
After signing in and turning on push notifications, you can now use your device for 2FA.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Countries where SMS authentication is supported
|
||||
intro: 'Because of delivery success rates, {% data variables.product.product_name %} only supports two-factor authentication via SMS for certain countries.'
|
||||
intro: 'Because of delivery success rates, {% data variables.product.github %} only supports two-factor authentication via SMS for certain countries.'
|
||||
redirect_from:
|
||||
- /articles/countries-where-sms-authentication-is-supported
|
||||
- /github/authenticating-to-github/countries-where-sms-authentication-is-supported
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Checking your commit and tag signature verification status
|
||||
intro: 'You can check the verification status of your commit and tag signatures on {% data variables.product.product_name %}.'
|
||||
intro: 'You can check the verification status of your commit and tag signatures on {% data variables.product.github %}.'
|
||||
redirect_from:
|
||||
- /articles/checking-your-gpg-commit-and-tag-signature-verification-status
|
||||
- /articles/checking-your-commit-and-tag-signature-verification-status
|
||||
@@ -18,7 +18,7 @@ shortTitle: Check verification status
|
||||
|
||||
## Checking your commit signature verification status
|
||||
|
||||
1. On {% data variables.product.product_name %}, navigate to your pull request.
|
||||
1. On {% data variables.product.github %}, navigate to your pull request.
|
||||
{% data reusables.repositories.review-pr-commits %}
|
||||
1. Next to your commit's abbreviated commit hash, there is a box that shows whether your commit signature is verified{% ifversion fpt or ghec %}, partially verified,{% endif %} or unverified.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Troubleshooting commit signature verification
|
||||
intro: 'You may need to troubleshoot unexpected issues that arise when signing commits locally for verification on {% data variables.product.product_name %}.'
|
||||
intro: 'You may need to troubleshoot unexpected issues that arise when signing commits locally for verification on {% data variables.product.github %}.'
|
||||
redirect_from:
|
||||
- /articles/troubleshooting-gpg
|
||||
- /articles/troubleshooting-commit-signature-verification
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using a verified email address in your GPG key
|
||||
intro: 'When verifying a signature, {% data variables.product.product_name %} checks that the committer or tagger email address matches an email address from the GPG key''s identities and is a verified email address on the user''s account. This ensures that the key belongs to you and that you created the commit or tag.'
|
||||
intro: 'When verifying a signature, {% data variables.product.github %} checks that the committer or tagger email address matches an email address from the GPG key''s identities and is a verified email address on the user''s account. This ensures that the key belongs to you and that you created the commit or tag.'
|
||||
redirect_from:
|
||||
- /articles/using-a-verified-email-address-in-your-gpg-key
|
||||
- /github/authenticating-to-github/using-a-verified-email-address-in-your-gpg-key
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 'Error: Agent admitted failure to sign'
|
||||
intro: 'In rare circumstances, connecting to {% data variables.product.product_name %} via SSH on Linux produces the error `"Agent admitted failure to sign using the key"`. Follow these steps to resolve the problem.'
|
||||
intro: 'In rare circumstances, connecting to {% data variables.product.github %} via SSH on Linux produces the error `"Agent admitted failure to sign using the key"`. Follow these steps to resolve the problem.'
|
||||
redirect_from:
|
||||
- /articles/error-agent-admitted-failure-to-sign-using-the-key
|
||||
- /articles/error-agent-admitted-failure-to-sign
|
||||
|
||||
@@ -40,7 +40,7 @@ $ git clone https://{% data variables.product.product_url %}/USERNAME/REPO-NAME.
|
||||
|
||||
### Test from a different network
|
||||
|
||||
If you can connect the computer to another network that doesn't have a firewall, you can try testing your SSH connection to {% data variables.product.product_name %}. If everything works as it should, contact your network administrator for help on changing the firewall settings to allow your SSH connection to {% data variables.product.product_name %} to succeed.
|
||||
If you can connect the computer to another network that doesn't have a firewall, you can try testing your SSH connection to {% data variables.product.github %}. If everything works as it should, contact your network administrator for help on changing the firewall settings to allow your SSH connection to succeed.
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
|
||||
@@ -47,14 +47,14 @@ The connection should be made on port 22{% ifversion fpt or ghec %}, unless you'
|
||||
|
||||
## Always use the "git" user
|
||||
|
||||
All connections, including those for remote URLs, must be made as the "git" user. If you try to connect with your {% data variables.product.product_name %} username, it will fail:
|
||||
All connections, including those for remote URLs, must be made as the "git" user. If you try to connect with your {% data variables.product.github %} username, it will fail:
|
||||
|
||||
```shell
|
||||
$ ssh -T GITHUB-USERNAME@{% data variables.product.product_url %}
|
||||
> Permission denied (publickey).
|
||||
```
|
||||
|
||||
If your connection failed and you're using a remote URL with your {% data variables.product.product_name %} username, you can [change the remote URL to use the "git" user](/get-started/getting-started-with-git/managing-remote-repositories).
|
||||
If your connection failed and you're using a remote URL with your {% data variables.product.github %} username, you can [change the remote URL to use the "git" user](/get-started/getting-started-with-git/managing-remote-repositories).
|
||||
|
||||
You should verify your connection by typing:
|
||||
|
||||
@@ -117,7 +117,7 @@ You should see this output:
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
The `ssh-add` command _should_ print out a long string of numbers and letters. If it does not print anything, you will need to [generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and associate it with {% data variables.product.product_name %}.
|
||||
The `ssh-add` command _should_ print out a long string of numbers and letters. If it does not print anything, you will need to [generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and associate it with {% data variables.product.github %}.
|
||||
|
||||
> [!TIP]
|
||||
> On most systems the default private keys (`~/.ssh/id_rsa` and `~/.ssh/identity`) are automatically added to the SSH authentication agent. You shouldn't need to run `ssh-add path/to/key` unless you override the file name when you generate a key.
|
||||
@@ -164,7 +164,7 @@ If a file existed, those lines would be "1" and "Offering public key", as in thi
|
||||
|
||||
## Verify the public key is attached to your account
|
||||
|
||||
You must provide your public key to {% data variables.product.product_name %} to establish a secure connection.
|
||||
You must provide your public key to {% data variables.product.github %} to establish a secure connection.
|
||||
|
||||
{% mac %}
|
||||
|
||||
@@ -242,7 +242,7 @@ You must provide your public key to {% data variables.product.product_name %} to
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
If you don't see your public key in {% data variables.product.product_name %}, you'll need to [add your SSH key to {% data variables.product.product_name %}](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) to associate it with your computer.
|
||||
If you don't see your public key in {% data variables.product.github %}, you'll need to [add your SSH key to {% data variables.product.github %}](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) to associate it with your computer.
|
||||
|
||||
> [!WARNING]
|
||||
> If you see an SSH key you're not familiar with on {% data variables.product.product_name %}, delete it immediately and contact {% data variables.contact.contact_support %} for further help. An unidentified public key may indicate a possible security concern. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys).
|
||||
> If you see an SSH key you're not familiar with on {% data variables.product.github %}, delete it immediately and contact {% data variables.contact.contact_support %} for further help. An unidentified public key may indicate a possible security concern. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys).
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 'Error: SSL certificate problem, verify that the CA cert is OK'
|
||||
intro: 'This error means your CA root certificate is out of date. If your CA root certificate needs to be updated, you won''t be able to push or pull from {% data variables.product.product_name %} repositories.'
|
||||
intro: 'This error means your CA root certificate is out of date. If your CA root certificate needs to be updated, you won''t be able to push or pull from {% data variables.product.github %} repositories.'
|
||||
redirect_from:
|
||||
- /articles/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok
|
||||
- /github/authenticating-to-github/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Troubleshooting SSH
|
||||
intro: 'When using SSH to connect and authenticate to {% data variables.product.product_name %}, you may need to troubleshoot unexpected issues that may arise.'
|
||||
intro: 'When using SSH to connect and authenticate to {% data variables.product.github %}, you may need to troubleshoot unexpected issues that may arise.'
|
||||
redirect_from:
|
||||
- /articles/troubleshooting-ssh
|
||||
- /github/authenticating-to-github/troubleshooting-ssh
|
||||
|
||||
Reference in New Issue
Block a user