toolbox

Documentation

Index

• func ImportLegacyAddrTokenProvider(c *keycloak.Config) error
• func NewKeycloakURIProvider(entries map[string]string, defaultKey string) (keycloak.KeycloakURIProvider, error)
• func NewKeycloakURIProviderFromArray(uris []string) (keycloak.KeycloakURIProvider, error)
• type DefaultProfileProviderFunc
• type IssuerManager
  • func NewIssuerManager(config keycloak.Config) (IssuerManager, error)
• type Logger
• type OAuth2Config
  • func (oac *OAuth2Config) IsClientConfig() bool
• type OidcTokenProvider
  • func NewOAuth2TokenProvider(kcConfig keycloak.Config, oauth2Config OAuth2Config, logger Logger) OidcTokenProvider
  • func NewOidcTokenProvider(config keycloak.Config, realm, username, password, clientID string, ...) OidcTokenProvider
• type OidcVerifier
• type OidcVerifierProvider
  • func NewVerifierCache(tokenURL *url.URL) OidcVerifierProvider
• type ProfileRetriever
• type UserProfileCache
  • func NewUserProfileCache(retriever ProfileRetriever, tokenProvider OidcTokenProvider, ...) *UserProfileCache
  • func (upc *UserProfileCache) GetRealmUserProfile(ctx context.Context, realmName string) (keycloak.UserProfileRepresentation, error)
  • func (upc *UserProfileCache) GetRealmUserProfileWithToken(accessToken string, realmName string) (keycloak.UserProfileRepresentation, error)

Functions

func ImportLegacyAddrTokenProvider

func ImportLegacyAddrTokenProvider(c *keycloak.Config) error

ImportLegacyAddrTokenProvider

func NewKeycloakURIProvider

func NewKeycloakURIProvider(entries map[string]string, defaultKey string) (keycloak.KeycloakURIProvider, error)

NewKeycloakURIProvider creates a Keycloak URI provider

func NewKeycloakURIProviderFromArray

func NewKeycloakURIProviderFromArray(uris []string) (keycloak.KeycloakURIProvider, error)

NewKeycloakURIProviderFromArray creates a Keycloak URI provider

Types

type DefaultProfileProviderFunc

type DefaultProfileProviderFunc func(realmName string) (keycloak.UserProfileRepresentation, error)

DefaultProfileProviderFunc function type

type IssuerManager

type IssuerManager interface {
	GetOidcVerifierProvider(issuer string) (OidcVerifierProvider, error)
}

IssuerManager provides URL according to a given context

func NewIssuerManager

func NewIssuerManager(config keycloak.Config) (IssuerManager, error)

NewIssuerManager creates a new URLProvider

type Logger

type Logger interface {
	Warn(ctx context.Context, keyvals ...interface{})
}

Logger interface for logging with level

type OAuth2Config

type OAuth2Config struct {
	Realm        *string `mapstructure:"realm"`
	Username     *string `mapstructure:"username"`
	Password     *string `mapstructure:"password"`
	ClientID     *string `mapstructure:"client-id"`
	ClientSecret *string `mapstructure:"client-secret"`
}

OAuth2Config struct

func (*OAuth2Config) IsClientConfig

func (oac *OAuth2Config) IsClientConfig() bool

IsClientConfig checks if the config is a client config or a username/password one

type OidcTokenProvider

type OidcTokenProvider interface {
	ProvideToken(ctx context.Context) (string, error)
	ProvideTokenForRealm(ctx context.Context, realm string) (string, error)
}

OidcTokenProvider provides OIDC tokens

func NewOAuth2TokenProvider

func NewOAuth2TokenProvider(kcConfig keycloak.Config, oauth2Config OAuth2Config, logger Logger) OidcTokenProvider

NewOAuth2TokenProvider creates an OidcTokenProvider

func NewOidcTokenProvider

func NewOidcTokenProvider(config keycloak.Config, realm, username, password, clientID string, logger Logger) OidcTokenProvider

NewOidcTokenProvider creates an OidcTokenProvider

type OidcVerifier

type OidcVerifier interface {
	Verify(accessToken string) error
}

OidcVerifier is an interface for OIDC token verifiers

type OidcVerifierProvider

type OidcVerifierProvider interface {
	GetOidcVerifier(realm string) (OidcVerifier, error)
}

OidcVerifierProvider is an interface for a provider of OidcVerifier instances

func NewVerifierCache

func NewVerifierCache(tokenURL *url.URL) OidcVerifierProvider

NewVerifierCache create an instance of OIDC verifier cache

type ProfileRetriever

type ProfileRetriever interface {
	GetRealm(accessToken string, realmName string) (keycloak.RealmRepresentation, error)
	GetUserProfile(accessToken string, realmName string) (keycloak.UserProfileRepresentation, error)
}

ProfileRetriever interface

type UserProfileCache

type UserProfileCache struct {
	// contains filtered or unexported fields
}

UserProfileCache struct

func NewUserProfileCache

func NewUserProfileCache(retriever ProfileRetriever, tokenProvider OidcTokenProvider, defProfileProvider DefaultProfileProviderFunc) *UserProfileCache

func (*UserProfileCache) GetRealmUserProfile

func (upc *UserProfileCache) GetRealmUserProfile(ctx context.Context, realmName string) (keycloak.UserProfileRepresentation, error)

GetRealmUserProfile gets the realm users profile using the token provider provided when creating the UserProfileCache instance

func (*UserProfileCache) GetRealmUserProfileWithToken

func (upc *UserProfileCache) GetRealmUserProfileWithToken(accessToken string, realmName string) (keycloak.UserProfileRepresentation, error)

GetRealmUserProfileWithToken gets the realm users profile using the provided access token