Class GitHubActionsTokenProvider

Namespace

Sigstore.Oidc

Assembly

Sigstore.dll

Obtains an OIDC token from the GitHub Actions runtime via ACTIONS_ID_TOKEN_REQUEST_URL and ACTIONS_ID_TOKEN_REQUEST_TOKEN.

public sealed class GitHubActionsTokenProvider : IOidcTokenProvider

Inheritance

object

GitHubActionsTokenProvider

Implements

IOidcTokenProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GitHubActionsTokenProvider(HttpClient)

Creates a provider backed by the given httpClient.

public GitHubActionsTokenProvider(HttpClient httpClient)

Parameters

httpClient HttpClient

Properties

IsAvailable

Whether this provider can supply a token in the current environment.

public bool IsAvailable { get; }

Property Value

bool

Methods

GetTokenAsync(string, CancellationToken)

Returns an OIDC token for the specified audience.

public Task<string> GetTokenAsync(string audience, CancellationToken cancellationToken)

Parameters

audience string

OIDC audience (e.g. "sigstore").

cancellationToken CancellationToken

Cancellation token.

Returns

Task<string>