Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating oidc information #366

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion content/en/certificate_authority/oidc-in-fulcio.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,32 @@
Email-based OIDC providers use the user's email as the subject of the certificate.

* Dex (`oauth2.sigstore.dev/auth`)
* GitHub (Note that this is the email of the user, not the GitHub username)

Check failure on line 22 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Unordered list indentation

content/en/certificate_authority/oidc-in-fulcio.md:22:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md007.md
* Google

Check failure on line 23 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Unordered list indentation

content/en/certificate_authority/oidc-in-fulcio.md:23:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md007.md
* Microsoft

Check failure on line 24 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Unordered list indentation

content/en/certificate_authority/oidc-in-fulcio.md:24:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md007.md
* Google (`accounts.google.com`)

### Source repository

#### GitHub

GitHub supports OIDC tokens for its workflows initiated from GitHub Actions. This removes the need for persisting authentication credentials. OIDC tokens include information about the workflow and source repository.

* GitHub Actions (`token.actions.githubusercontent.com`)
You must include the proper permissions in your workflow to use an OIDC token.

```yaml
permissions:
id-token: write
```

When verifying a signature generated through a workflow on GitHub, you can expect the following values:

* **certificate-oidc-issuer**: https://token.actions.githubusercontent.com
* **certificate-identity**: https://github.com/USERNAME/REPOSITORY_NAME/.github/workflows/WORKFLOW_NAME@refs/heads/BRANCH_NAME

Sigstore currently offers two different GitHub Actions ([`consign-installer`](https://github.com/marketplace/actions/cosign-installer) and [`gh-action-sigstore-installer`](https://github.com/sigstore/gh-action-sigstore-python)) to help you easily integrate Sigstore into your workflows. You can learn more about them in our [CI Quickstart]({{< relref "quickstart/quickstart-ci">}})
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Sigstore currently offers two different GitHub Actions ([`consign-installer`](https://github.com/marketplace/actions/cosign-installer) and [`gh-action-sigstore-installer`](https://github.com/sigstore/gh-action-sigstore-python)) to help you easily integrate Sigstore into your workflows. You can learn more about them in our [CI Quickstart]({{< relref "quickstart/quickstart-ci">}})
Sigstore currently offers two different GitHub Actions ([`cosign-installer`](https://github.com/marketplace/actions/cosign-installer) and [`gh-action-sigstore-installer`](https://github.com/sigstore/gh-action-sigstore-python)) to help you easily integrate Sigstore into your workflows. You can learn more about them in our [CI Quickstart]({{< relref "quickstart/quickstart-ci">}})


#### GitLab

GitLab supports OIDC tokens for its workflows initiated from GitLab CI/CD pipelines. This removes the need for persisting authentication credentials. OIDC tokens include information about the workflow and source repository.

Expand Down Expand Up @@ -69,7 +85,7 @@

For example, `iss` could be `https://oauth2.sigstore.dev/auth` or `https://token.actions.githubusercontent.com`.

```

Check failure on line 88 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified

content/en/certificate_authority/oidc-in-fulcio.md:88 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
{
"aud": "sigstore"
"iss": "<uri>"
Expand All @@ -84,7 +100,7 @@

In addition to the standard JWT claims, the token must include the following claims:

```

Check failure on line 103 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified

content/en/certificate_authority/oidc-in-fulcio.md:103 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
{
"email_verified": true
"email": "[email protected]"
Expand All @@ -97,7 +113,7 @@

The token must include the following claims:

```

Check failure on line 116 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified

content/en/certificate_authority/oidc-in-fulcio.md:116 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
{
"job_workflow_ref": "octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"
"sha": "example-sha",
Expand Down Expand Up @@ -143,7 +159,7 @@

The token must include the following claims:

```

Check failure on line 162 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified

content/en/certificate_authority/oidc-in-fulcio.md:162 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
{
"sub": "spiffe://foo.example.com"
}
Expand All @@ -159,11 +175,11 @@

The token must include the following claims:

```

Check failure on line 178 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Fenced code blocks should have a language specified

content/en/certificate_authority/oidc-in-fulcio.md:178 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md040.md
{
"kubernetes.io": {
"namespace": "default",

Check failure on line 181 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Hard tabs

content/en/certificate_authority/oidc-in-fulcio.md:181:1 MD010/no-hard-tabs Hard tabs [Column: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md010.md
"pod": {

Check failure on line 182 in content/en/certificate_authority/oidc-in-fulcio.md

View workflow job for this annotation

GitHub Actions / markdownlint

Hard tabs

content/en/certificate_authority/oidc-in-fulcio.md:182:1 MD010/no-hard-tabs Hard tabs [Column: 1] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md010.md
"name": "oidc-test",
"uid": "49ad3572-b3dd-43a6-8d77-5858d3660275"
},
Expand Down