Skip to content

Commit 1b9fef6

Browse files
mchammer01sunbrye
andauthored
Fix versioning for Dependabot OIDC support (#60958)
Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
1 parent 47670bf commit 1b9fef6

4 files changed

Lines changed: 52 additions & 0 deletions

File tree

content/actions/concepts/security/openid-connect.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,8 @@ You can use the `repo_property_*` claims in your cloud provider's trust conditio
166166

167167
{% endif %}
168168

169+
{% ifversion dependabot-oidc-support %}
170+
169171
## OIDC support for {% data variables.product.prodname_dependabot %}
170172

171173
{% data variables.product.prodname_dependabot %} can use OIDC to authenticate with private registries, eliminating the need to store long-lived credentials as repository secrets. With OIDC-based authentication, {% data variables.product.prodname_dependabot %} update jobs can dynamically obtain short-lived credentials from your cloud identity provider.
@@ -180,6 +182,8 @@ The benefits of OIDC authentication for {% data variables.product.prodname_depen
180182

181183
For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#using-oidc-for-authentication).
182184

185+
{% endif %}
186+
183187
## Next steps
184188

185189
For more information about configuring OIDC, see [AUTOTITLE](/actions/how-tos/security-for-github-actions/security-hardening-your-deployments).

content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ If your private registry is configured with an IP allow list, you can find the I
124124

125125
{% endif %}
126126

127+
{% ifversion dependabot-oidc-support %}
128+
127129
## Using OIDC for authentication
128130

129131
{% data variables.product.prodname_dependabot %} can use OpenID Connect (OIDC) to authenticate with private registries, eliminating the need to store long-lived credentials as repository secrets.
@@ -191,6 +193,8 @@ registries:
191193

192194
For more information about how OIDC works, see [AUTOTITLE](/actions/concepts/security/openid-connect).
193195

196+
{% endif %}
197+
194198
## Allowing external code execution
195199

196200
When you give {% data variables.product.prodname_dependabot %} access to one or more registries, external code execution is automatically disabled to protect your code from compromised packages. However, some version updates may fail.
@@ -430,6 +434,8 @@ registries:
430434

431435
{% endraw %}
432436

437+
{% ifversion dependabot-oidc-support %}
438+
433439
You can also use OIDC authentication to access JFrog Artifactory. {% data reusables.dependabot.dependabot-oidc-credentials %}
434440

435441
{% raw %}
@@ -446,6 +452,8 @@ registries:
446452

447453
{% endraw %}
448454

455+
{% endif %}
456+
449457
### `npm-registry`
450458

451459
The `npm-registry` type supports username and password, or token. {% data reusables.dependabot.password-definition %}
@@ -516,6 +524,8 @@ registries:
516524

517525
{% endraw %}
518526

527+
{% ifversion dependabot-oidc-support %}
528+
519529
You can also use OIDC authentication to access Azure DevOps Artifacts. {% data reusables.dependabot.dependabot-oidc-credentials %}
520530

521531
{% raw %}
@@ -533,6 +543,8 @@ registries:
533543

534544
The `AZURE_TENANT_ID` and `AZURE_CLIENT_ID` values can be obtained from the overview page of your Entra ID app registration.
535545

546+
{% endif %}
547+
536548
### `pub-repository`
537549

538550
The `pub-repository` type supports a URL and a token.
@@ -590,6 +602,8 @@ registries:
590602

591603
{% endraw %}
592604

605+
{% ifversion dependabot-oidc-support %}
606+
593607
You can also use OIDC authentication to access Azure DevOps Artifacts. {% data reusables.dependabot.dependabot-oidc-credentials %}
594608

595609
{% raw %}
@@ -606,6 +620,8 @@ registries:
606620

607621
{% endraw %}
608622

623+
{% endif %}
624+
609625
### `rubygems-server`
610626

611627
The `rubygems-server` type supports username and password, or token. {% data reusables.dependabot.password-definition %}

content/code-security/reference/supply-chain-security/dependabot-options-reference.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -980,6 +980,8 @@ updates:
980980

981981
The parameters used to provide authentication details for access to a private registry vary according to the registry `type`.
982982

983+
{% ifversion dependabot-oidc-support %}
984+
983985
| Registry `type` | Required authentication parameters |
984986
|--|--|
985987
| `cargo-registry` | `token` |
@@ -996,13 +998,37 @@ The parameters used to provide authentication details for access to a private re
996998
| `rubygems-server` | `username` and `password`<br>or `token`<br>or OIDC with `tenant-id` and `client-id` |
997999
| `terraform-registry` | `token` |
9981000

1001+
{% else %}
1002+
1003+
| Registry `type` | Required authentication parameters |
1004+
|--|--|
1005+
| `cargo-registry` | `token` |
1006+
| `composer-repository` | `username` and `password` |
1007+
| `docker-registry` | `username` and `password` |
1008+
| `git` | `username` and `password` |
1009+
| `hex-organization` | `organization` and `key` |
1010+
| `hex-repository` | `repo` and `auth-key` optionally with the corresponding `public-key-fingerprint` |
1011+
| `maven-repository` | `username` and `password` |
1012+
| `npm-registry` | `username` and `password`<br>or `token` |
1013+
| `nuget-feed` | `username` and `password`<br>or `token` |
1014+
| `pub-registry` | `token` |
1015+
| `python-index` | `username` and `password`<br>or `token` |
1016+
| `rubygems-server` | `username` and `password`<br>or `token` |
1017+
| `terraform-registry` | `token` |
1018+
1019+
{% endif %}
1020+
9991021
All sensitive data used for authentication should be stored securely and referenced from that secure location, see [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot).
10001022

10011023
> [!TIP]
10021024
> {% data reusables.dependabot.password-definition %}
10031025

1026+
{% ifversion dependabot-oidc-support %}
1027+
10041028
For more information about OIDC support for {% data variables.product.prodname_dependabot %}, see [AUTOTITLE](/actions/concepts/security/openid-connect#oidc-support-for-dependabot) and [AUTOTITLE](/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot#using-oidc-for-authentication).
10051029

1030+
{% endif %}
1031+
10061032
### `url` and `replaces-base`
10071033

10081034
The `url` parameter defines where to access a registry. When the optional `replaces-base` parameter is enabled (`true`), {% data variables.product.prodname_dependabot %} resolves dependencies using the value of `url` rather than the base URL of that specific ecosystem.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reference: #20672
2+
# Configure Dependabot to use GitHub OIDC [GA]
3+
versions:
4+
fpt: '*'
5+
ghec: '*'
6+
ghes: '>3.20'

0 commit comments

Comments
 (0)