Package dev.sigstore.oidc.client

Class TokenStringOidcClient

java.lang.Object

dev.sigstore.oidc.client.TokenStringOidcClient

All Implemented Interfaces:

OidcClient

public class TokenStringOidcClient
extends Object
implements OidcClient

This should only be used when the user has an out of band mechanism for obtaining an OIDC token to be consumed by a sigstore signing event. So it should not be included in any defaults for OidcClients.

It's not explicitly designed for multi use, but implementers of the TokenStringOidcClient.TokenStringProvider may include mechanisms for longer lived signing events. Each time a token is requested, the provider may execute a fetch of the token.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TokenStringOidcClient.TokenStringProvider

Method Summary

Modifier and Type	Method	Description
static TokenStringOidcClient	from(TokenStringOidcClient.TokenStringProvider provider)
static TokenStringOidcClient	from(String token)
OidcToken	getIDToken(Map<String,String> env)
boolean	isEnabled(Map<String,String> env)	Determine if this client can be used in the current environment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public static TokenStringOidcClient from(TokenStringOidcClient.TokenStringProvider provider)

from

public static TokenStringOidcClient from(String token)

isEnabled

public boolean isEnabled(Map<String,String> env)

Description copied from interface: OidcClient

Determine if this client can be used in the current environment. For example, we can ignore Oidc Clients that are scoped to a specific CI environment

Specified by:

isEnabled in interface OidcClient

Parameters:

env - the configured system environment

Returns:

true if we should use credentials from this client

getIDToken

public OidcToken getIDToken(Map<String,String> env)
                     throws OidcException

Specified by:

getIDToken in interface OidcClient

Throws:

OidcException