You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -167,7 +167,8 @@ You can check which access policies are being applied to a secret in your organi
167
167
> [!NOTE]
168
168
> * {% data reusables.actions.forked-secrets %}
169
169
> * Secrets are not automatically passed to reusable workflows. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#passing-inputs-and-secrets-to-a-reusable-workflow).
170
-
> {% data reusables.actions.about-oidc-short-overview %}
170
+
> * Secrets are not available to workflows triggered by {% data variables.product.prodname_dependabot %} events. For more information, see [AUTOTITLE](/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions#accessing-secrets).
171
+
> * {% data reusables.actions.about-oidc-short-overview %}
171
172
172
173
> [!WARNING] Mask all sensitive information that is not a {% data variables.product.prodname_dotcom %} secret by using `::add-mask::VALUE`. This causes the value to be treated as a secret and redacted from logs.
Copy file name to clipboardExpand all lines: content/admin/managing-iam/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-for-enterprise-managed-users.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,11 +108,14 @@ After the initial configuration of SAML SSO, the only setting you can update on
108
108
{% data reusables.enterprise-accounts.identity-provider-tab %}
109
109
{% data reusables.enterprise-accounts.sso-configuration %}
110
110
111
-
1. Under "SAML single sign-on", select **Add SAML configuration**.
111
+
1. Under "SAML single sign-on," select **Add SAML configuration**.
112
112
1. Under **Sign on URL**, type the HTTPS endpoint of your IdP for SSO requests that you noted while configuring your IdP.
113
113
1. Under **Issuer**, type your SAML issuer URL that you noted while configuring your IdP, to verify the authenticity of sent messages.
114
114
1. Under **Public Certificate**, paste the certificate that you noted while configuring your IdP, to verify SAML responses.
115
-
1. Under **Public Certificate**, select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer.
115
+
116
+
> [!NOTE]
117
+
> {% data variables.product.github %} does not enforce the expiration of this SAML IdP certificate. This means that even if this certificate expires, your SAML authentication will continue to work. However, if your IdP administrator regenerates the SAML certificate, and you don't update it on the {% data variables.product.github %} side, users will encounter a `digest mismatch` error during SAML authentication attempts due to the certificate mismatch. See [Error: Digest mismatch](/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication#error-digest-mismatch).
118
+
1. Under the same **Public Certificate** section, select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer.
116
119
1. Before enabling SAML SSO for your enterprise, to ensure that the information you've entered is correct, click **Test SAML configuration**. {% data reusables.saml.test-must-succeed %}
Copy file name to clipboardExpand all lines: content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,7 @@ For more detailed information about how to enable SAML using Okta, see [AUTOTITL
92
92
{% data reusables.enterprise-accounts.access-enterprise %}
93
93
{% data reusables.enterprise-accounts.settings-tab %}
94
94
{% data reusables.enterprise-accounts.security-tab %}
95
+
95
96
1. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %}
96
97
1. Under "SAML single sign-on", select **Require SAML authentication**.
97
98
1. In the **Sign on URL** field, type the HTTPS endpoint of your IdP for single sign-on requests. This value is available in your IdP configuration.
@@ -101,6 +102,7 @@ For more detailed information about how to enable SAML using Okta, see [AUTOTITL
101
102
To find the certificate, refer to the documentation for your IdP. Some IdPs call this an X.509 certificate.
102
103
103
104
{% data reusables.saml.edit-signature-and-digest-methods %}
105
+
104
106
1. Before enabling SAML SSO for your enterprise, to ensure that the information you've entered is correct, click **Test SAML configuration** . {% data reusables.saml.test-must-succeed %}
105
107
1. Click **Save**.
106
108
{% data reusables.enterprise-accounts.download-recovery-codes %}
@@ -117,6 +119,7 @@ You can enable or disable SAML authentication for {% data variables.location.pro
117
119
{% data reusables.enterprise_site_admin_settings.access-settings %}
118
120
{% data reusables.enterprise_site_admin_settings.management-console %}
119
121
{% data reusables.enterprise_management_console.authentication %}
122
+
120
123
1. Under "Authentication", select **SAML**.
121
124
1. {% data reusables.enterprise_user_management.built-in-authentication-option %}
122
125
1. Optionally, to enable unsolicited response SSO, select **IdP initiated SSO**. By default, {% data variables.product.prodname_ghe_server %} will reply to an unsolicited Identity Provider (IdP) initiated request with an `AuthnRequest` back to the IdP.
@@ -129,18 +132,23 @@ You can enable or disable SAML authentication for {% data variables.location.pro
129
132
130
133
You must ensure that your IdP supports encrypted assertions and that the encryption and key transport methods in the management console match the values configured on your IdP. You must also provide {% data variables.location.product_location %}'s public certificate to your IdP. For more information, see [AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/enabling-encrypted-assertions).
131
134
132
-
1.Under "Single sign-on URL," type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.location.product_location %} to use internal nameservers](/admin/configuration/configuring-network-settings/configuring-dns-nameservers).
135
+
1.In the **Single sign-on URL** field, type the HTTP or HTTPS endpoint on your IdP for single sign-on requests. This value is provided by your IdP configuration. If the host is only available from your internal network, you may need to [configure {% data variables.location.product_location %} to use internal nameservers](/admin/configuration/configuring-network-settings/configuring-dns-nameservers).
133
136
1. Optionally, in the **Issuer** field, type your SAML issuer's name. This verifies the authenticity of messages sent to {% data variables.location.product_location %}.
134
137
1. Select the **Signature Method** and **Digest Method** dropdown menus, then click the hashing algorithm used by your SAML issuer to verify the integrity of the requests from {% data variables.location.product_location %}.
135
138
1. Select the **Name Identifier Format** dropdown menu, then click a format.
136
-
1. Under "Verification certificate," click **Choose File**, then choose a certificate to validate SAML responses from the IdP.
139
+
1. Under "Verification certificate", click **Choose File**, then choose a certificate to validate SAML responses from the IdP.
140
+
141
+
> [!NOTE]
142
+
> {% data variables.product.github %} does not enforce the expiration of this SAML IdP certificate. This means that even if this certificate expires, your SAML authentication will continue to work. However, if your IdP administrator regenerates the SAML certificate, and you don't update it on the {% data variables.product.github %} side, users will encounter a `digest mismatch` error during SAML authentication attempts due to the certificate mismatch. See [Error: Digest mismatch](/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication#error-digest-mismatch).
143
+
137
144
1. Under "User attributes", modify the SAML attribute names to match your IdP if needed, or accept the default names.
Copy file name to clipboardExpand all lines: content/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md
+14-4Lines changed: 14 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,22 +31,24 @@ For more information about SAML response requirements, see [AUTOTITLE](/admin/id
31
31
You can configure {% data variables.product.prodname_ghe_server %} to write verbose debug logs for every SAML authentication attempt. You may be able to troubleshoot failed authentication attempts with this extra output.
32
32
33
33
> [!WARNING]
34
+
>
34
35
> * Only enable SAML debugging temporarily, and disable debugging immediately after you finish troubleshooting. If you leave debugging enabled, the size of the logs increases much faster than usual, which can negatively impact the performance of {% data variables.product.prodname_ghe_server %}.
35
36
> * Test new authentication settings for {% data variables.location.product_location %} in a staging environment before you apply the settings in your production environment. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance).
36
37
37
38
{% data reusables.enterprise-accounts.access-enterprise %}
38
39
{% data reusables.enterprise-accounts.policies-tab %}
39
40
{% data reusables.enterprise-accounts.options-tab %}
41
+
40
42
1. Under "SAML debugging", select the drop-down and click **Enabled**.
41
-
1. Attempt to sign into {% data variables.location.product_location %} through your SAML IdP.
42
-
1. Review the debug output in the systemd journal for `github-unicorn`on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs#system-logs-in-the-systemd-journal-for-github-enterprise-server).
43
+
1. Attempt to sign in to {% data variables.location.product_location %} through your SAML IdP.
44
+
1. Review the debug output in the `systemd` journal for `github-unicorn`on {% data variables.location.product_location %}. For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs#system-logs-in-the-systemd-journal-for-github-enterprise-server).
43
45
1. When you're done troubleshooting, select the drop-down and click **Disabled**.
44
46
45
47
## Decoding responses
46
48
47
-
Some output in the systemd journal for `github-unicorn` may be Base64-encoded. You can access the administrative shell and use the `base64` utility on {% data variables.location.product_location %} to decode these responses. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
49
+
Some output in the `systemd` journal for `github-unicorn` may be Base64-encoded. You can access the administrative shell and use the `base64` utility on {% data variables.location.product_location %} to decode these responses. For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh).
48
50
49
-
To decode the output, run the following command, replacing ENCODED_OUTPUT with the encoded output from the log.
51
+
To decode the output, run the following command, replacing `ENCODED_OUTPUT` with the encoded output from the log.
50
52
51
53
```shell
52
54
base64 --decode ENCODED_OUTPUT
@@ -110,3 +112,11 @@ This error can occur in version 3.17.0 or later of {% data variables.location.pr
110
112
{% ifversion ghec %}
111
113
{% data reusables.saml.authentication-loop %}
112
114
{% endif %}
115
+
116
+
## Error: Digest mismatch
117
+
118
+
A "Digest mismatch" error indicates that your SAML IdP is using a different SAML signing certificate than the one you have uploaded to {% data variables.product.github %}{% ifversion ghes %} or that the **Signature Method** or **Digest Method** configured on {% data variables.product.github %} differs from what your IdP is using{% endif %}.
119
+
120
+
{% ifversion ghes %}Re-download this SAML certificate from your IdP and validate it using an online tool, such as the [Format a x509 cert](https://www.samltool.com/format_x509cert.php) tool from OneLogin. Then upload the SAML certificate again in the "Authentication" section in your {% data variables.product.prodname_ghe_server %} management console. See [AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-management-console#accessing-the-management-console-as-an-unauthenticated-user).{% endif %}
121
+
122
+
{% ifversion ghec %}Re-download this SAML certificate from your IdP and validate it using a tool such as the [Format a x509 cert](https://www.samltool.com/format_x509cert.php) tool from OneLogin. Then update the certificate saved in the {% data variables.product.github %} SAML settings.{% endif %}
Copy file name to clipboardExpand all lines: content/organizations/managing-saml-single-sign-on-for-your-organization/enabling-and-testing-saml-single-sign-on-for-your-organization.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,8 @@ For more information about the identity providers (IdPs) that {% data variables.
35
35
{% data reusables.profile.access_org %}
36
36
{% data reusables.profile.org_settings %}
37
37
{% data reusables.organizations.security %}
38
-
1. Under "SAML single sign-on", select **Enable SAML authentication**.
38
+
39
+
1. Under "SAML single sign-on," select **Enable SAML authentication**.
39
40
40
41
> [!NOTE]
41
42
> After enabling SAML SSO, you can download your single sign-on recovery codes so that you can access your organization even if your IdP is unavailable. For more information, see [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/downloading-your-organizations-saml-single-sign-on-recovery-codes).
@@ -46,8 +47,13 @@ For more information about the identity providers (IdPs) that {% data variables.
46
47
> [!NOTE]
47
48
> If you want to enable team synchronization for your organization, the "Issuer" field is a required. For more information, see [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/managing-team-synchronization-for-your-organization).
48
49
49
-
1. Under "Public Certificate," paste a certificate to verify SAML responses.
50
+
1. Under "Public Certificate", paste a certificate to verify SAML responses.
51
+
52
+
> [!NOTE]
53
+
> {% data variables.product.github %} does not enforce the expiration of this SAML IdP certificate. This means that even if this certificate expires, your SAML authentication will continue to work. However, if your IdP administrator regenerates the SAML certificate, and you don't update it on the {% data variables.product.github %} side, users will encounter a `digest mismatch` error during SAML authentication attempts due to the certificate mismatch. See [Error: Digest mismatch](/admin/managing-iam/using-saml-for-enterprise-iam/troubleshooting-saml-authentication#error-digest-mismatch).
54
+
50
55
{% data reusables.saml.edit-signature-and-digest-methods %}
56
+
51
57
1. Before enabling SAML SSO for your organization, to ensure that the information you've entered is correct, click **Test SAML configuration**. {% data reusables.saml.test-must-succeed %}
0 commit comments