Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://help.github.com/en/actions/reference/security/oidc below:

OpenID Connect reference - GitHub Docs

Find information about using OpenID Connect (OIDC) to authenticate GitHub Actions workflows with cloud providers.

To see all the claims supported by GitHub's OIDC provider, review the claims_supported entries at https://token.actions.githubusercontent.com/.well-known/openid-configuration.

The OIDC token includes the following claims.

Audience and subject claims are typically used in combination while setting conditions on the cloud role/resources to scope its access to the GitHub workflows.

• Audience: By default, this value uses the URL of the organization or repository owner. This can be used to set a condition that only the workflows in the specific organization can access the cloud role.
• Subject: By default, has a predefined format and is a concatenation of some of the key metadata about the workflow, such as the GitHub organization, repository, branch, or associated job environment. See Example subject claims to see how the subject claim is assembled from concatenated metadata.

If you need more granular trust conditions, you can customize the subject (sub) claim that's included with the JWT. For more information, see Customizing the token claims.

There are also many additional claims supported in the OIDC token that can be used for setting these conditions. In addition, your cloud provider could allow you to assign a role to the access tokens, letting you specify even more granular permissions.

Note

To control how your cloud provider issues access tokens, you must define at least one condition, so that untrusted repositories can’t request access tokens for your cloud resources.

The following examples demonstrate how to use "Subject" as a condition, and explain how the "Subject" is assembled from concatenated metadata. The subject uses information from the job context, and instructs your cloud provider that access token requests may only be granted for requests from workflows running in specific branches, environments. The following sections describe some common subjects you can use.

The subject claim includes the environment name when the job references an environment.

You can configure a subject that filters for a specific environment name. In this example, the workflow run must have originated from a job that has an environment named Production, in a repository named octo-repo that is owned by the octo-org organization:

• Syntax: repo:ORG-NAME/REPO-NAME:environment:ENVIRONMENT-NAME
• Example: repo:octo-org/octo-repo:environment:Production

The subject claim includes the pull_request string when the workflow is triggered by a pull request event, but only if the job doesn't reference an environment.

You can configure a subject that filters for the pull_request event. In this example, the workflow run must have been triggered by a pull_request event in a repository named octo-repo that is owned by the octo-org organization:

• Syntax: repo:ORG-NAME/REPO-NAME:pull_request
• Example: repo:octo-org/octo-repo:pull_request

The subject claim includes the branch name of the workflow, but only if the job doesn't reference an environment, and if the workflow is not triggered by a pull request event.

You can configure a subject that filters for a specific branch name. In this example, the workflow run must have originated from a branch named demo-branch, in a repository named octo-repo that is owned by the octo-org organization:

• Syntax: repo:ORG-NAME/REPO-NAME:ref:refs/heads/BRANCH-NAME
• Example: repo:octo-org/octo-repo:ref:refs/heads/demo-branch

The subject claim includes the tag name of the workflow, but only if the job doesn't reference an environment, and if the workflow is not triggered by a pull request event.

You can create a subject that filters for specific tag. In this example, the workflow run must have originated with a tag named demo-tag, in a repository named octo-repo that is owned by the octo-org organization:

• Syntax: repo:ORG-NAME/REPO-NAME:ref:refs/tags/TAG-NAME
• Example: repo:octo-org/octo-repo:ref:refs/tags/demo-tag

To configure the subject in your cloud provider's trust relationship, you must add the subject string to its trust configuration. The following examples demonstrate how various cloud providers can accept the same repo:octo-org/octo-repo:ref:refs/heads/demo-branch subject in different ways:

For more information about configuring specific cloud providers, see the guides listed in Security hardening your deployments.

You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customizations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud:

• You can customize values for audience claims. See Customizing the audience value.
• You can customize the format of your OIDC configuration by setting conditions on the subject (sub) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source.
• You can define granular OIDC policies by using additional OIDC token claims, such as repository_id and repository_visibility. See OpenID Connect.

When you use custom actions in your workflows, those actions may use the GitHub Actions Toolkit to enable you to supply a custom value for the audience claim. Some cloud providers also use this in their official login actions to enforce a default value for the audience claim. For example, the GitHub Action for Azure Login provides a default aud value of api://AzureADTokenExchange, or it allows you to set a custom aud value in your workflows. For more information on the GitHub Actions Toolkit, see the OIDC token section in the documentation.

If you do not want to use the default aud value offered by an action, you can provide a custom value for the audience claim. This allows you to set a condition that only workflows in a specific repository or organization can access the cloud role. If the action you are using supports this, you can use the with keyword in your workflow to pass a custom aud value to the action. For more information, see Metadata syntax reference.

To help improve security, compliance, and standardization, you can customize the standard claims to suit your required access conditions. If your cloud provider supports conditions on subject claims, you can create a condition that checks whether the sub value matches the path of the reusable workflow, such as "job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main". The exact format will vary depending on your cloud provider's OIDC configuration. To configure the matching condition on GitHub, you can use the REST API to require that the sub claim must always include a specific custom claim, such as job_workflow_ref. You can use the REST API to apply a customization template for the OIDC subject claim; for example, you can require that the sub claim within the OIDC token must always include a specific custom claim, such as job_workflow_ref. For more information, see REST API endpoints for GitHub Actions OIDC.

Note

When the organization template is applied, it will not affect any workflows already using OIDC unless their repository has opted in to custom organization templates. For all repositories, existing and new, the repository owner will need to use the repository-level REST API to opt in to receive this configuration by setting use_default to false. Alternatively, the repository owner could use the REST API to apply a different configuration specific to the repository. For more information, see REST API endpoints for GitHub Actions OIDC.

Customizing the claims results in a new format for the entire sub claim, which replaces the default predefined sub format in the token described in Example subject claims.

Note

The sub claim uses the shortened form repo (for example, repo:ORG-NAME/REPO-NAME) instead of repository to reference the repository. Any : within the context value will be replaced with %3A.

The following example templates demonstrate various ways to customize the subject claim. To configure these settings on GitHub, admins use the REST API to specify a list of claims that must be included in the subject (sub) claim.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

To customize your subject claims, you should first create a matching condition in your cloud provider's OIDC configuration, before customizing the configuration using the REST API. Once the configuration is completed, each time a new job runs, the OIDC token generated during that job will follow the new customization template. If the matching condition doesn't exist in the cloud provider's OIDC configuration before the job runs, the generated token might not be accepted by the cloud provider, since the cloud conditions may not be synchronized.

This example template allows the sub claim to have a new format, using repository_owner and repository_visibility:

{
   "include_claim_keys": [
       "repository_owner",
       "repository_visibility"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include specific values for repository_owner and repository_visibility. For example: "sub": "repository_owner:monalisa:repository_visibility:private". The approach lets you restrict cloud role access to only private repositories within an organization or enterprise.

This example template enables the sub claim to have a new format with only the value of repository_owner.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

{
   "include_claim_keys": [
       "repository_owner"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include a specific value for repository_owner. For example: "sub": "repository_owner:monalisa"

This example template allows the sub claim to have a new format that contains the value of the job_workflow_ref claim. This enables an enterprise to use reusable workflows to enforce consistent deployments across its organizations and repositories.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

  {
     "include_claim_keys": [
         "job_workflow_ref"
     ]
  }

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include a specific value for job_workflow_ref. For example: "sub": "job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main".

The following example template combines the requirement of a specific reusable workflow with additional claims.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

This example also demonstrates how to use "context" to define your conditions. This is the part that follows the repository in the default sub format. For example, when the job references an environment, the context contains: environment:ENVIRONMENT-NAME.

{
   "include_claim_keys": [
       "repo",
       "context",
       "job_workflow_ref"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include specific values for repo, context, and job_workflow_ref.

This customization template requires that the sub uses the following format: repo:ORG-NAME/REPO-NAME:environment:ENVIRONMENT-NAME:job_workflow_ref:REUSABLE-WORKFLOW-PATH. For example: "sub": "repo:octo-org/octo-repo:environment:prod:job_workflow_ref:octo-org/octo-automation/.github/workflows/oidc.yml@refs/heads/main"

This example template lets you grant cloud access to all the workflows in a specific repository, across all branches/tags and environments.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

{
   "include_claim_keys": [
       "repo"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require a repo claim that matches the required value.

This example template enables predictable OIDC claims with system-generated GUIDs that do not change between renames of entities (such as renaming a repository).

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

  {
     "include_claim_keys": [
         "repository_id"
     ]
  }

In your cloud provider's OIDC configuration, configure the sub condition to require a repository_id claim that matches the required value.

or:

{
   "include_claim_keys": [
       "repository_owner_id"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require a repository_owner_id claim that matches the required value.

This example demonstrates how to handle context value with :. For example, when the job references an environment named production:eastus.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

{
   "include_claim_keys": [
       "environment",
       "repository_owner"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include a specific value for environment and repository_owner. For example: "sub": "environment:production%3Aeastus:repository_owner:octo-org".

This example template resets the subject claims to the default format. This template effectively opts out of any organization-level customization policy.

To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see REST API endpoints for GitHub Actions OIDC, and for repositories, see REST API endpoints for GitHub Actions OIDC.

{
   "include_claim_keys": [
       "repo",
       "context"
   ]
}

In your cloud provider's OIDC configuration, configure the sub condition to require that claims must include specific values for repo and context.

All repositories in an organization have the ability to opt in or opt out of (organization and repository-level) customized sub claim templates.

To opt out a repository and reset back to the default sub claim format, a repository administrator must use the REST API endpoint at REST API endpoints for GitHub Actions OIDC.

To configure repositories to use the default sub claim format, use the PUT /repos/{owner}/{repo}/actions/oidc/customization/sub REST API endpoint at with the following request body.

{
   "use_default": true
}

Once an organization has created a customized sub claim template, the REST API can be used to programmatically apply the template to repositories within the organization. A repository administrator can configure their repository to use the template created by the administrator of their organization.

To configure the repository to use the organization's template, a repository admin must use the PUT /repos/{owner}/{repo}/actions/oidc/customization/sub REST API endpoint at with the following request body. For more information, see REST API endpoints for GitHub Actions OIDC.

{
   "use_default": false
}

You can use the github/actions-oidc-debugger action to visualize the claims that would be sent, before integrating with a cloud provider. This action requests a JWT and prints the claims included within the JWT that were received from GitHub Actions.

• The job or workflow must grant the id-token: write permission to allow GitHub's OIDC provider to create a JSON Web Token (JWT):

  permissions:
    id-token: write
  

• Without id-token: write, the OIDC JWT ID token cannot be requested. This setting only enables fetching and setting the OIDC token; it does not grant write access to other resources.

• To fetch an OIDC token for a workflow, set the permission at the workflow level:

  permissions:
    id-token: write 
    contents: read 
  

• To fetch an OIDC token for a single job, set the permission within that job:

  permissions:
    id-token: write 
  

• Additional permissions may be required depending on workflow needs.

• For reusable workflows owned by the same user, organization, or enterprise as the caller, the OIDC token generated in the reusable workflow is accessible from the caller's context.
• For reusable workflows outside your enterprise or organization, set the permissions setting for id-token to write explicitly at the caller workflow or job level. This ensures the OIDC token is only available to intended caller workflows.

Custom actions can request the OIDC token using:

• The getIDToken() method from the Actions toolkit. For more information, see OIDC Token in the npm package documentation.

• The following environment variables on the runner.

  Variable Description ACTIONS_ID_TOKEN_REQUEST_URL The URL for GitHub's OIDC provider. ACTIONS_ID_TOKEN_REQUEST_TOKEN Bearer token for the request to the OIDC provider.

  For example:

  Shell

  curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=api://AzureADTokenExchange"
  

  curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOKEN_REQUEST_URL&audience=api://AzureADTokenExchange"
  

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4