Package dev.sigstore.oidc.client

Class WebOidcClient

java.lang.Object

dev.sigstore.oidc.client.WebOidcClient

All Implemented Interfaces:

OidcClient

public class WebOidcClient
extends Object
implements OidcClient

A client to obtain oidc tokens from an oauth provider via web workflow for use with sigstore. By default this client is configued to use the public sigstore dex instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebOidcClient.BrowserHandler	Interface for allowing custom browser handlers for OauthClients.
static class	WebOidcClient.Builder
static class	WebOidcClient.OIDCEndpoints	Internal.

Method Summary

Modifier and Type	Method	Description
static WebOidcClient.Builder	builder()
OidcToken	getIDToken(Map<String,String> env)	Get an id token from the oidc provider with openid and email scopes
boolean	isEnabled(Map<String,String> env)	This provider is usually enabled unless we're in CI.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static WebOidcClient.Builder builder()

isEnabled

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

This provider is usually enabled unless we're in CI.

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

Get an id token from the oidc provider with openid and email scopes

Specified by:

getIDToken in interface OidcClient

Returns:

an openid token with additional email scopes

Throws:

OidcException - if an error occurs doing the authorization flow