oidc

package

v0.22.0-test2 Latest Latest Go to latest Published: Sep 3, 2026 License: Apache-2.0, Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/epithet-ssh/epithet

Links

Open Source Insights

Documentation ¶

Overview ¶

Package oidc performs OIDC/OAuth2 authentication and returns an ID token. It is a plain library: callers own how the token state and user-facing progress are surfaced (the broker streams progress to ssh sessions; other callers may just discard it).

Index ¶

Variables
func Authenticate(ctx context.Context, cfg Config, prev *oauth2.Token, out io.Writer) (idToken string, next *oauth2.Token, err error)
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var Scopes = []string{"openid", "profile", "email"}

Scopes is fixed: nothing in epithet consumes claims beyond email/sub.

Functions ¶

func Authenticate ¶ added in v0.18.0

func Authenticate(ctx context.Context, cfg Config, prev *oauth2.Token, out io.Writer) (idToken string, next *oauth2.Token, err error)

Authenticate returns a fresh ID token. prev carries refresh state from the previous call (nil on first use); the returned token is the next state. User-facing progress ("visit this URL…") is written to out.

Types ¶

type Config ¶

type Config struct {
	IssuerURL    string
	ClientID     string
	ClientSecret string // Optional for PKCE.
	TLSConfig    tlsconfig.Config
}

Config holds OIDC authentication configuration.

Source Files ¶

View all Source files

oidc.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL