authenticator

type IdentityProviderClient interface {
	// GetCurrentUser retrieves the currently authenticated user
	GetCurrentUser(ctx context.Context) (UserInfo, error)
}

type OAuthClient struct {
	logr.Logger
	OAuthConfig

	// for retrieving OTF system hostname to construct redirect URLs
	*internal.HostnameService
	// contains filtered or unexported fields
}

type OAuthConfig struct {
	// Name of oauth client. Should be a lowercase string because it is used
	// in URL paths.
	Name                string
	BaseURL             *internal.WebURL
	ClientID            string
	ClientSecret        string
	Endpoint            oauth2.Endpoint
	Scopes              []string
	SkipTLSVerification bool
	Icon                templ.Component
}

type OIDCConfig struct {
	// Name is the user-friendly identifier of the OIDC endpoint.
	Name string
	// IssuerURL is the issuer url for the OIDC provider.
	IssuerURL string
	// ClientID is the client id for the OIDC provider.
	ClientID string
	// ClientSecret is the client secret for the OIDC provider.
	ClientSecret string
	// Skip TLS Verification when communicating with issuer.
	SkipTLSVerification bool
	// Scopes to request from the OIDC provider.
	Scopes []string
	// UsernameClaim is the claim that provides the username.
	UsernameClaim string
}

type OpaqueHandlerConfig struct {
	OAuthConfig
	ClientConstructor func(cfg OAuthConfig, token *oauth2.Token) (IdentityProviderClient, error)
}

type Options struct {
	logr.Logger

	HostnameService      *internal.HostnameService
	UserService          userService
	TokensService        *tokens.Service
	IDTokenHandlerConfig OIDCConfig
	SkipTLSVerification  bool
}

type Service struct {
	logr.Logger

	HostnameService *internal.HostnameService
	UserService     userService
	TokensService   *tokens.Service
	// contains filtered or unexported fields
}

type UserInfo struct {
	Username  user.Username
	AvatarURL *string // Optional.
}