| 1 |
# Copyright 2024 The Sigstore Authors |
| 2 |
# |
| 3 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
# you may not use this file except in compliance with the License. |
| 5 |
# You may obtain a copy of the License at |
| 6 |
# |
| 7 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
# |
| 9 |
# Unless required by applicable law or agreed to in writing, software |
| 10 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
# See the License for the specific language governing permissions and |
| 13 |
# limitations under the License. |
| 14 |
|
| 15 |
define: |
| 16 |
- &github-type "github-workflow" |
| 17 |
- &gitlab-type "gitlab-pipeline" |
| 18 |
- &codefresh-type "codefresh-workflow" |
| 19 |
- &buildkite-type "buildkite-job" |
| 20 |
- &circleci-type "circleci-job" |
| 21 |
oidc-issuers: |
| 22 |
https://accounts.google.com: |
| 23 |
issuer-url: https://accounts.google.com |
| 24 |
client-id: sigstore |
| 25 |
type: email |
| 26 |
contact: [email protected] |
| 27 |
description: "Google OIDC auth" |
| 28 |
https://agent.buildkite.com: |
| 29 |
issuer-url: https://agent.buildkite.com |
| 30 |
client-id: sigstore |
| 31 |
type: ci-provider |
| 32 |
ci-provider: *buildkite-type |
| 33 |
contact: [email protected] |
| 34 |
description: "Buildkite Agent OIDC tokens for job identity" |
| 35 |
https://auth.eclipse.org/auth/realms/foundation-service-accounts: |
| 36 |
issuer-url: https://auth.eclipse.org/auth/realms/foundation-service-accounts |
| 37 |
client-id: sigstore |
| 38 |
type: email |
| 39 |
contact: [email protected] |
| 40 |
description: "Eclipse Foundation Production OIDC provider" |
| 41 |
https://dev.gitlab.org: |
| 42 |
issuer-url: https://dev.gitlab.org |
| 43 |
client-id: sigstore |
| 44 |
type: ci-provider |
| 45 |
ci-provider: *gitlab-type |
| 46 |
contact: [email protected] |
| 47 |
description: "GitLab OIDC tokens for job identity" |
| 48 |
https://gitlab.archlinux.org: |
| 49 |
issuer-url: https://gitlab.archlinux.org |
| 50 |
client-id: sigstore |
| 51 |
type: ci-provider |
| 52 |
ci-provider: *gitlab-type |
| 53 |
contact: [email protected] |
| 54 |
description: "GitLab OIDC tokens for job identity" |
| 55 |
https://gitlab.com: |
| 56 |
issuer-url: https://gitlab.com |
| 57 |
client-id: sigstore |
| 58 |
type: ci-provider |
| 59 |
ci-provider: *gitlab-type |
| 60 |
contact: [email protected] |
| 61 |
description: "GitLab OIDC tokens for job identity" |
| 62 |
https://issuer.enforce.dev: |
| 63 |
issuer-url: https://issuer.enforce.dev |
| 64 |
client-id: sigstore |
| 65 |
type: chainguard-identity |
| 66 |
contact: [email protected] |
| 67 |
description: "Chainguard identity tokens" |
| 68 |
https://issuer.chainops.dev: |
| 69 |
issuer-url: https://issuer.chainops.dev |
| 70 |
client-id: sigstore |
| 71 |
type: chainguard-identity |
| 72 |
contact: [email protected] |
| 73 |
description: "Chainguard identity tokens" |
| 74 |
https://issuer.hello.coop: |
| 75 |
issuer-url: https://issuer.hello.coop |
| 76 |
client-id: sigstore |
| 77 |
type: email |
| 78 |
contact: [email protected] |
| 79 |
description: "Hellō OIDC auth" |
| 80 |
https://www.kaggle.com/api/v1/models/signing: |
| 81 |
issuer-url: https://www.kaggle.com/api/v1/models/signing |
| 82 |
client-id: sigstore |
| 83 |
type: email |
| 84 |
contact: [email protected] |
| 85 |
description: "Kaggle OIDC provider" |
| 86 |
https://oauth2.sigstore.dev/auth: |
| 87 |
issuer-url: https://oauth2.sigstore.dev/auth |
| 88 |
client-id: sigstore |
| 89 |
type: email |
| 90 |
issuer-claim: $.federated_claims.connector_id |
| 91 |
contact: [email protected] |
| 92 |
description: "dex address for fulcio" |
| 93 |
https://oidc.circleci.com: |
| 94 |
issuer-url: https://oidc.circleci.com |
| 95 |
client-id: sigstore |
| 96 |
type: ci-provider |
| 97 |
ci-provider: *circleci-type |
| 98 |
contact: [email protected] |
| 99 |
description: "CircleCI OIDC tokens" |
| 100 |
https://oidc.codefresh.io: |
| 101 |
issuer-url: https://oidc.codefresh.io |
| 102 |
client-id: sigstore |
| 103 |
type: ci-provider |
| 104 |
ci-provider: *codefresh-type |
| 105 |
contact: [email protected] |
| 106 |
description: "Codefresh OIDC tokens for job identity" |
| 107 |
https://ops.gitlab.net: |
| 108 |
issuer-url: https://ops.gitlab.net |
| 109 |
client-id: sigstore |
| 110 |
type: ci-provider |
| 111 |
ci-provider: *gitlab-type |
| 112 |
contact: [email protected] |
| 113 |
description: "GitLab OIDC tokens for job identity" |
| 114 |
https://token.actions.githubusercontent.com: |
| 115 |
issuer-url: https://token.actions.githubusercontent.com |
| 116 |
client-id: sigstore |
| 117 |
type: ci-provider |
| 118 |
ci-provider: *github-type |
| 119 |
contact: [email protected] |
| 120 |
description: "GitHub Actions OIDC auth" |
| 121 |
https://sigstore.verify.ibm.com/oauth2: |
| 122 |
issuer-url: https://sigstore.verify.ibm.com/oauth2 |
| 123 |
client-id: sigstore |
| 124 |
type: email |
| 125 |
contact: [email protected] |
| 126 |
description: "IBM OIDC auth" |
| 127 |
meta-issuers: |
| 128 |
# Matches https://{region}.oic.prod-aks.azure.com/{tenant-guid}/{random-guid} |
| 129 |
https://*.oic.prod-aks.azure.com/*/*: |
| 130 |
client-id: sigstore |
| 131 |
type: kubernetes |
| 132 |
# Matches https://{region}.oic.prod-aks.azure.com/{tenant-guid}/{random-guid}/ |
| 133 |
https://*.oic.prod-aks.azure.com/*/*/: |
| 134 |
client-id: sigstore |
| 135 |
type: kubernetes |
| 136 |
https://container.googleapis.com/v1/projects/*/locations/*/clusters/*: |
| 137 |
client-id: sigstore |
| 138 |
type: kubernetes |
| 139 |
https://oidc.circleci.com/org/*: |
| 140 |
client-id: sigstore |
| 141 |
type: ci-provider |
| 142 |
ci-provider: *circleci-type |
| 143 |
# contact: [email protected] |
| 144 |
# description: "CircleCI OIDC tokens" |
| 145 |
https://oidc.eks.*.amazonaws.com/id/*: |
| 146 |
client-id: sigstore |
| 147 |
type: kubernetes |
| 148 |
# Matches https://oidc.prod-aks.azure.com/{tenant-guid} |
| 149 |
https://oidc.prod-aks.azure.com/*: |
| 150 |
client-id: sigstore |
| 151 |
type: kubernetes |
| 152 |
# Matches https://oidc.prod-aks.azure.com/{tenant-guid}/ |
| 153 |
https://oidc.prod-aks.azure.com/*/: |
| 154 |
client-id: sigstore |
| 155 |
type: kubernetes |
| 156 |
# Matches https://oidc.prod-aks.azure.com/{tenant-guid}/{random-guid} |
| 157 |
https://oidc.prod-aks.azure.com/*/*: |
| 158 |
client-id: sigstore |
| 159 |
type: kubernetes |
| 160 |
https://token.actions.githubusercontent.com/*: |
| 161 |
client-id: sigstore |
| 162 |
type: ci-provider |
| 163 |
ci-provider: *github-type |
| 164 |
ci-issuer-metadata: |
| 165 |
*github-type: |
| 166 |
default-template-values: |
| 167 |
# url: URL of issuer, https://github.com |
| 168 |
url: "https://github.com" |
| 169 |
# Nil default value to handle optional environment claim |
| 170 |
environment: "" |
| 171 |
extension-templates: |
| 172 |
# event_name: Event that triggered this workflow run. E.g "push", "tag" |
| 173 |
github-workflow-trigger: "event_name" |
| 174 |
# sha: Commit SHA being built |
| 175 |
github-workflow-sha: "sha" |
| 176 |
# workflow (Deprecated): Name of workflow that is running (mutable) |
| 177 |
github-workflow-name: "workflow" |
| 178 |
# repository: Name of repository being built |
| 179 |
github-workflow-repository: "repository" |
| 180 |
# ref: Git ref being built |
| 181 |
github-workflow-ref: "ref" |
| 182 |
# job_workflow_ref: Specific build instructions (i.e. reusable workflow) |
| 183 |
build-signer-uri: "{{ .url }}/{{ .job_workflow_ref }}" |
| 184 |
# job_workflow_sha: Commit SHA to specific build instructions |
| 185 |
build-signer-digest: "job_workflow_sha" |
| 186 |
# runner_environment: Whether the build took place in cloud or self-hosted infrastructure |
| 187 |
runner-environment: "runner_environment" |
| 188 |
# repository: Name of repository being built |
| 189 |
source-repository-uri: "{{ .url }}/{{ .repository }}" |
| 190 |
source-repository-digest: "sha" |
| 191 |
source-repository-ref: "ref" |
| 192 |
# repository_id: ID to the source repo |
| 193 |
source-repository-identifier: "repository_id" |
| 194 |
# repository_owner: Owner of the source repo (mutable) |
| 195 |
source-repository-owner-uri: "{{ .url }}/{{ .repository_owner }}" |
| 196 |
# repository_owner_id: ID of the source repo |
| 197 |
source-repository-owner-identifier: "repository_owner_id" |
| 198 |
# workflow_ref: Ref of top-level workflow that is running |
| 199 |
build-config-uri: "{{ .url }}/{{ .workflow_ref }}" |
| 200 |
# workflow_sha: Commit SHA of top-level workflow that is running |
| 201 |
build-config-digest: "workflow_sha" |
| 202 |
build-trigger: "event_name" |
| 203 |
# run_id: ID of workflow run |
| 204 |
# run_attempt: Attempt number of workflow run |
| 205 |
run-invocation-uri: "{{ .url }}/{{ .repository }}/actions/runs/{{ .run_id }}/attempts/{{ .run_attempt }}" |
| 206 |
# repository_visibility: Visibility of the source repo |
| 207 |
source-repository-visibility-at-signing: "repository_visibility" |
| 208 |
# environment: Deployment target for workflow (optional) |
| 209 |
deployment-environment: "environment" |
| 210 |
subject-alternative-name-template: "{{ .url }}/{{ .job_workflow_ref }}" |
| 211 |
*gitlab-type: |
| 212 |
default-template-values: |
| 213 |
url: "https://gitlab.com" |
| 214 |
# Nil default value to handle optional environment claim |
| 215 |
environment: "" |
| 216 |
extension-templates: |
| 217 |
# url: The URL of the GitLab instance. https://gitlab.com |
| 218 |
# ci_config_ref_uri: Ref of top-level pipeline definition. |
| 219 |
# E.g. gitlab.com/my-group/my-project//.gitlab-ci.yml@refs/heads/main |
| 220 |
build-signer-uri: "https://{{ .ci_config_ref_uri }}" |
| 221 |
# ci_config_sha: Commit sha of top-level pipeline definition, and is |
| 222 |
# only populated when `ciConfigRefURI` is local to the GitLab instance |
| 223 |
build-signer-digest: "ci_config_sha" |
| 224 |
# runner_environment: The type of runner used by the job. May be one of gitlab-hosted or self-hosted. |
| 225 |
runner-environment: "runner_environment" |
| 226 |
# project_path: Repository path building built |
| 227 |
source-repository-uri: "{{ .url }}/{{ .project_path }}" |
| 228 |
# sha: Commit SHA being built |
| 229 |
source-repository-digest: "sha" |
| 230 |
# ref_type: The type of the ref |
| 231 |
# E.g. "branch", "tag" |
| 232 |
# ref: Git ref being built |
| 233 |
source-repository-ref: refs/{{if eq .ref_type "branch"}}heads/{{ else }}tags/{{end}}{{ .ref }} |
| 234 |
# project_id: ID to the source repo |
| 235 |
source-repository-identifier: "project_id" |
| 236 |
# namespace_path: Owner of the source repo (mutable) |
| 237 |
source-repository-owner-uri: "{{ .url }}/{{ .namespace_path }}" |
| 238 |
# namespace_id: ID of the source repo |
| 239 |
source-repository-owner-identifier: "namespace_id" |
| 240 |
build-config-uri: "https://{{ .ci_config_ref_uri }}" |
| 241 |
build-config-digest: "ci_config_sha" |
| 242 |
# pipeline_source: Event that triggered this workflow run. E.g "push", "tag" etc |
| 243 |
build-trigger: "pipeline_source" |
| 244 |
# project_path: Repository building built |
| 245 |
# job_id: job ID |
| 246 |
run-invocation-uri: "{{ .url }}/{{ .project_path }}/-/jobs/{{ .job_id }}" |
| 247 |
# project_visibility: Visibility of the source project |
| 248 |
source-repository-visibility-at-signing: "project_visibility" |
| 249 |
# environment: Deployment target for job (optional) |
| 250 |
deployment-environment: "environment" |
| 251 |
subject-alternative-name-template: "https://{{ .ci_config_ref_uri }}" |
| 252 |
*codefresh-type: |
| 253 |
default-template-values: |
| 254 |
# We are setting the default value for "platform_url" as the ci-provider |
| 255 |
# principal gives priority to the claimed value over the default |
| 256 |
# when they have the same name. Then it will use the default "platform_url" value |
| 257 |
# for cases that the claimed data doesn't exist. |
| 258 |
# platform_url: Codefresh platform url |
| 259 |
platform_url: "https://g.codefresh.io" |
| 260 |
scm_repo_url: "" |
| 261 |
scm_ref: "" |
| 262 |
runner_environment: "" |
| 263 |
extension-templates: |
| 264 |
# workflow_id: The ID of the specific workflow authorized in the claim. |
| 265 |
# For example, 64f447c02199f903000gh20. |
| 266 |
build-signer-uri: "{{.platform_url}}/build/{{ .workflow_id }}" |
| 267 |
# runner_environment: Whether the build took place in cloud or self-hosted infrastructure |
| 268 |
runner-environment: "runner_environment" |
| 269 |
# scm_repo_url: Applies to Git push, PR, and manual Git trigger types. |
| 270 |
# The SCM URL specifying the Git repository’s location. |
| 271 |
# For example, https://github.com/codefresh-user/oidc-test |
| 272 |
source-repository-uri: "scm_repo_url" |
| 273 |
# scm_ref: Applies to Git push, PR, and manual Git trigger types. |
| 274 |
# The SCM name of the branch or tag within the Git repository |
| 275 |
# for which the workflow should execute. For example, main or v1.0.0. |
| 276 |
source-repository-ref: "scm_ref" |
| 277 |
# pipeline_id: Codefresh Pipeline id |
| 278 |
build-config-uri: "{{.platform_url}}/api/pipelines/{{ .pipeline_id }}" |
| 279 |
# account_name: Codefresh account name |
| 280 |
# pipeline_name: Codefresh pipline name (project/pipeline) |
| 281 |
# account_id: Codefresh account id |
| 282 |
run-invocation-uri: "{{.platform_url}}/build/{{ .workflow_id }}" |
| 283 |
subject-alternative-name-template: "{{.platform_url}}/{{.account_name}}/{{.pipeline_name}}:{{.account_id}}/{{.pipeline_id}}" |
| 284 |
*buildkite-type: |
| 285 |
default-template-values: |
| 286 |
url: "https://buildkite.com" |
| 287 |
extension-templates: |
| 288 |
# Link to the specific Buildkite job that the OIDC token was generated from |
| 289 |
run-invocation-uri: "{{.url}}/{{.organization_slug}}/{{.pipeline_slug}}/builds/{{.build_number}}#{{.job_id}}" |
| 290 |
# Was the job executed on Buildkite operated compute or customer hosted compute? (valid values: self-hosted, buildkite-hosted) |
| 291 |
runner-environment: "runner_environment" |
| 292 |
# The git sha that job was running, available in the `build_commit` claim |
| 293 |
source-repository-digest: "build_commit" |
| 294 |
# build_source: Event that triggered this workflow run. (valid values: api, ui, webhook, trigger_job, schedule) |
| 295 |
build-trigger: "build_source" |
| 296 |
subject-alternative-name-template: "{{.url}}/{{.organization_slug}}/{{.pipeline_slug}}" # seems correct, do we still need the code in pkg/identity/buildkite/principal.go ? |
| 297 |
*circleci-type: |
| 298 |
default-template-values: |
| 299 |
# principal gives priority to the claimed value over the default |
| 300 |
api_url: "https://circleci.com/api/v2" |
| 301 |
platform_url: "https://app.circleci.com/" |
| 302 |
extension-templates: |
| 303 |
# NOTE: Because of how the text/template parsing works with / and . characters, |
| 304 |
# we use " inside our template fragments which is why we use ' to wrap |
| 305 |
|
| 306 |
# this API call leads back to the exact generated config used for this run |
| 307 |
build-config-uri: '{{.api_url}}/pipeline/{{(index . "oidc.circleci.com/pipeline-id")}}/config' |
| 308 |
# this API call leads back to the definition of the pipeline used for this run |
| 309 |
# https://circleci.com/api/v2/projects/{project_id}/pipeline-definitions/{pipeline_definition_id} |
| 310 |
build-signer-uri: '{{.api_url}}/projects/{{(index . "oidc.circleci.com/project-id")}}/pipeline-definitions/{{(index . "oidc.circleci.com/pipeline-definition-id")}}' |
| 311 |
run-invocation-uri: '{{.platform_url}}/workflow/{{(index . "oidc.circleci.com/workflow-id")}}/job/{{(index . "oidc.circleci.com/job-id")}}' |
| 312 |
runner-environment: '{{if eq (index . "oidc.circleci.com/ssh-rerun") "true"}}ssh-rerun{{ else }}""{{end}}' |
| 313 |
source-repository-ref: '{{index . "oidc.circleci.com/vcs-ref"}}' |
| 314 |
source-repository-uri: '{{index . "oidc.circleci.com/vcs-origin"}}' |
| 315 |
subject-alternative-name-template: '{{.api_url}}/projects/{{(index . "oidc.circleci.com/project-id")}}/pipeline-definitions/{{(index . "oidc.circleci.com/pipeline-definition-id")}}' |