oidc

package

Go to main page

Versions in this module

v2

v2.12.0

Nov 16, 2023

v2.11.0

Sep 7, 2023

v2.10.0

Sep 1, 2023

v2.9.0

Aug 31, 2023

v2.8.3

Aug 21, 2023

v2.8.2

Aug 18, 2023

v2.8.1

Aug 18, 2023

v2.8.0

Aug 14, 2023

v2.7.0

Jul 18, 2023

v2.6.4

Jun 23, 2023

v2.6.3

Jun 9, 2023

Changes in this version

type Locales

+ func ParseLocales(locales []string) Locales

+ func (l *Locales) UnmarshalJSON(data []byte) error

v2.6.2

May 26, 2023

v2.6.1

May 24, 2023

v2.6.0

May 3, 2023

Changes in this version

type AuthRequest

+ func (a *AuthRequest) GetResponseMode() ResponseMode

v2.5.0

Apr 13, 2023

v2.4.0

Apr 13, 2023

v2.3.0

Apr 11, 2023

v2.2.6

Apr 5, 2023

v2.2.5

Apr 4, 2023

v2.2.4

Apr 4, 2023

v2.2.3

Mar 29, 2023

v2.2.2

Mar 28, 2023

v2.2.1

Mar 27, 2023

v2.2.0

Mar 24, 2023

v2.1.2

Mar 21, 2023

v2.1.1

Mar 20, 2023

v2.1.0

Mar 20, 2023

Changes in this version

type IDTokenClaims

+ func (t *IDTokenClaims) GetUserInfo() *UserInfo

v2.0.0

Mar 16, 2023

Changes in this version

+ const AccessDenied

+ const AuthorizationPending

+ const BearerToken

+ const DiscoveryEndpoint

+ const DisplayPage

+ const DisplayPopup

+ const DisplayTouch

+ const DisplayWAP

+ const ExpiredToken

+ const InteractionRequired

+ const InvalidClient

+ const InvalidGrant

+ const InvalidRequest

+ const InvalidScope

+ const KeyUseSignature

+ const LoginRequired

+ const PrefixBearer

+ const PromptConsent

+ const PromptLogin

+ const PromptNone

+ const PromptSelectAccount

+ const RequestNotSupported

+ const ResponseModeFragment

+ const ResponseModeQuery

+ const ResponseTypeCode

+ const ResponseTypeIDToken

+ const ResponseTypeIDTokenOnly

+ const ScopeAddress

+ const ScopeEmail

+ const ScopeOfflineAccess

+ const ScopeOpenID

+ const ScopePhone

+ const ScopeProfile

+ const ServerError

+ const SlowDown

+ const UnauthorizedClient

+ const UnsupportedGrantType

+ var AllAuthMethods = []AuthMethod

+ var AllGrantTypes = []GrantType

+ var AllTokenTypes = []TokenType

+ var ErrAccessDenied = func() *Error

+ var ErrAcrInvalid = errors.New("acr is invalid")

+ var ErrAtHash = errors.New("at_hash does not correspond to access token")

+ var ErrAudience = errors.New("audience is not valid")

+ var ErrAuthTimeNotPresent = errors.New("claim `auth_time` of token is missing")

+ var ErrAuthTimeToOld = errors.New("auth time of token is to old")

+ var ErrAuthorizationPending = func() *Error

+ var ErrAzpInvalid = errors.New("authorized party is not valid")

+ var ErrAzpMissing = errors.New(...)

+ var ErrExpired = errors.New("token has expired")

+ var ErrExpiredDeviceCode = func() *Error

+ var ErrIatInFuture = errors.New("issuedAt of token is in the future")

+ var ErrIatMissing = errors.New("issuedAt of token is missing")

+ var ErrIatToOld = errors.New("issuedAt of token is to old")

+ var ErrInteractionRequired = func() *Error

+ var ErrInvalidClient = func() *Error

+ var ErrInvalidGrant = func() *Error

+ var ErrInvalidRequest = func() *Error

+ var ErrInvalidRequestRedirectURI = func() *Error

+ var ErrInvalidScope = func() *Error

+ var ErrIssuerInvalid = errors.New("issuer does not match")

+ var ErrKeyMultiple = errors.New("multiple possible keys match")

+ var ErrKeyNone = errors.New("no possible keys matches")

+ var ErrLoginRequired = func() *Error

+ var ErrNonceInvalid = errors.New("nonce does not match")

+ var ErrParse = errors.New("parsing of request failed")

+ var ErrRequestNotSupported = func() *Error

+ var ErrServerError = func() *Error

+ var ErrSignatureInvalid = errors.New("invalid signature")

+ var ErrSignatureInvalidPayload = errors.New("signature does not match Payload")

+ var ErrSignatureMissing = errors.New("id_token does not contain a signature")

+ var ErrSignatureMultiple = errors.New("id_token contains multiple signatures")

+ var ErrSignatureUnsupportedAlg = errors.New("signature algorithm not supported")

+ var ErrSlowDown = func() *Error

+ var ErrSubjectMissing = errors.New("subject missing")

+ var ErrUnauthorizedClient = func() *Error

+ var ErrUnsupportedGrantType = func() *Error

+ func AppendClientIDToAudience(clientID string, audience []string) []string

+ func CheckAudience(claims Claims, clientID string) error

+ func CheckAuthTime(claims Claims, maxAge time.Duration) error

+ func CheckAuthorizationContextClassReference(claims Claims, acr ACRVerifier) error

+ func CheckAuthorizedParty(claims Claims, clientID string) error

+ func CheckExpiration(claims Claims, offset time.Duration) error

+ func CheckIssuedAt(claims Claims, maxAgeIAT, offset time.Duration) error

+ func CheckIssuer(claims Claims, issuer string) error

+ func CheckNonce(claims Claims, nonce string) error

+ func CheckSignature(ctx context.Context, token string, payload []byte, claims ClaimsSignature, ...) error

+ func CheckSubject(claims Claims) error

+ func ClaimHash(claim string, sigAlgorithm jose.SignatureAlgorithm) (string, error)

+ func DecryptToken(tokenString string) (string, error)

+ func FindKey(keyID, use, expectedAlg string, keys ...jose.JSONWebKey) (jose.JSONWebKey, bool)

+ func FindMatchingKey(keyID, use, expectedAlg string, keys ...jose.JSONWebKey) (key jose.JSONWebKey, err error)

+ func GenerateJWTProfileToken(assertion *JWTProfileAssertionClaims) (string, error)

+ func GetKeyIDAndAlg(jws *jose.JSONWebSignature) (string, string)

+ func JWTProfileCustomClaim(key string, value interface{}) func(*JWTProfileAssertionClaims)

+ func JWTProfileDelegatedSubject(sub string) func(*JWTProfileAssertionClaims)

+ func NewEncoder() *schema.Encoder

+ func NewJWTProfileAssertionStringFromFileData(data []byte, audience []string, opts ...AssertionOption) (string, error)

+ func NewSHACodeChallenge(code string) string

+ func ParseToken(tokenString string, claims interface{}) ([]byte, error)

+ func VerifyCodeChallenge(c *CodeChallenge, codeVerifier string) bool

+ type ACRVerifier func(string) error

+ func DefaultACRVerifier(possibleValues []string) ACRVerifier

+ type AccessTokenClaims struct

+ Claims map[string]any

+ Scopes SpaceDelimitedArray

+ func NewAccessTokenClaims(issuer, subject string, audience []string, expiration time.Time, ...) *AccessTokenClaims

+ func (a *AccessTokenClaims) MarshalJSON() ([]byte, error)

+ func (a *AccessTokenClaims) UnmarshalJSON(data []byte) error

+ type AccessTokenRequest struct

+ ClientAssertion string

+ ClientAssertionType string

+ ClientID string

+ ClientSecret string

+ Code string

+ CodeVerifier string

+ RedirectURI string

+ func (a *AccessTokenRequest) GrantType() GrantType

+ func (a *AccessTokenRequest) SetClientID(clientID string)

+ func (a *AccessTokenRequest) SetClientSecret(clientSecret string)

+ type AccessTokenResponse struct

+ AccessToken string

+ ExpiresIn uint64

+ IDToken string

+ RefreshToken string

+ State string

+ TokenType string

+ type AssertionOption func(*JWTProfileAssertionClaims)

+ type Audience []string

+ func (a *Audience) UnmarshalJSON(text []byte) error

+ type AuthMethod string

+ const AuthMethodBasic

+ const AuthMethodNone

+ const AuthMethodPost

+ const AuthMethodPrivateKeyJWT

+ type AuthRequest struct

+ ACRValues []string

+ ClientID string

+ CodeChallenge string

+ CodeChallengeMethod CodeChallengeMethod

+ Display Display

+ IDTokenHint string

+ LoginHint string

+ MaxAge *uint

+ Nonce string

+ Prompt SpaceDelimitedArray

+ RedirectURI string

+ RequestParam string

+ ResponseMode ResponseMode

+ ResponseType ResponseType

+ Scopes SpaceDelimitedArray

+ State string

+ UILocales Locales

+ func (a *AuthRequest) GetRedirectURI() string

+ func (a *AuthRequest) GetResponseType() ResponseType

+ func (a *AuthRequest) GetState() string

+ type Bool bool

+ func (bs *Bool) UnmarshalJSON(data []byte) error

+ type Claims interface

+ GetAudience func() []string

+ GetAuthTime func() time.Time

+ GetAuthenticationContextClassReference func() string

+ GetAuthorizedParty func() string

+ GetExpiration func() time.Time

+ GetIssuedAt func() time.Time

+ GetIssuer func() string

+ GetNonce func() string

+ GetSubject func() string

+ type ClaimsSignature interface

+ SetSignatureAlgorithm func(algorithm jose.SignatureAlgorithm)

+ type ClientAssertionParams struct

+ ClientAssertion string

+ ClientAssertionType string

+ type ClientCredentialsRequest struct

+ ClientAssertion string

+ ClientAssertionType string

+ ClientID string

+ ClientSecret string

+ GrantType GrantType

+ Scope SpaceDelimitedArray

+ type CodeChallenge struct

+ Challenge string

+ Method CodeChallengeMethod

+ type CodeChallengeMethod string

+ const CodeChallengeMethodPlain

+ const CodeChallengeMethodS256

+ type DeviceAccessTokenRequest struct

+ DeviceCode string

+ GrantType GrantType

+ type DeviceAuthorizationRequest struct

+ ClientID string

+ Scopes SpaceDelimitedArray

+ type DeviceAuthorizationResponse struct

+ DeviceCode string

+ ExpiresIn int

+ Interval int

+ UserCode string

+ VerificationURI string

+ VerificationURIComplete string

+ type DiscoveryConfiguration struct

+ ACRValuesSupported []string

+ AuthorizationEndpoint string

+ CheckSessionIframe string

+ ClaimTypesSupported []string

+ ClaimsLocalesSupported []language.Tag

+ ClaimsParameterSupported bool

+ ClaimsSupported []string

+ CodeChallengeMethodsSupported []CodeChallengeMethod

+ DeviceAuthorizationEndpoint string

+ DisplayValuesSupported []Display

+ EndSessionEndpoint string

+ GrantTypesSupported []GrantType

+ IDTokenEncryptionAlgValuesSupported []string

+ IDTokenEncryptionEncValuesSupported []string

+ IDTokenSigningAlgValuesSupported []string

+ IntrospectionEndpoint string

+ IntrospectionEndpointAuthMethodsSupported []AuthMethod

+ IntrospectionEndpointAuthSigningAlgValuesSupported []string

+ Issuer string

+ JwksURI string

+ OPPolicyURI string

+ OPTermsOfServiceURI string

+ RegistrationEndpoint string

+ RequestObjectEncryptionAlgValuesSupported []string

+ RequestObjectEncryptionEncValuesSupported []string

+ RequestObjectSigningAlgValuesSupported []string

+ RequestParameterSupported bool

+ RequestURIParameterSupported bool

+ RequireRequestURIRegistration bool

+ ResponseModesSupported []string

+ ResponseTypesSupported []string

+ RevocationEndpoint string

+ RevocationEndpointAuthMethodsSupported []AuthMethod

+ RevocationEndpointAuthSigningAlgValuesSupported []string

+ ScopesSupported []string

+ ServiceDocumentation string

+ SubjectTypesSupported []string

+ TokenEndpoint string

+ TokenEndpointAuthMethodsSupported []AuthMethod

+ TokenEndpointAuthSigningAlgValuesSupported []string

+ UILocalesSupported []language.Tag

+ UserinfoEncryptionAlgValuesSupported []string

+ UserinfoEncryptionEncValuesSupported []string

+ UserinfoEndpoint string

+ UserinfoSigningAlgValuesSupported []string

+ type Display string

+ func (d *Display) UnmarshalText(text []byte) error

+ type EndSessionRequest struct

+ ClientID string

+ IdTokenHint string

+ PostLogoutRedirectURI string

+ State string

+ type Error struct

+ Description string

+ ErrorType errorType

+ Parent error

+ State string

+ func DefaultToServerError(err error, description string) *Error

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) IsRedirectDisabled() bool

+ func (e *Error) Unwrap() error

+ func (e *Error) WithDescription(desc string, args ...interface{}) *Error

+ func (e *Error) WithParent(err error) *Error

+ type Gender string

+ type GrantType string

+ const ClientAssertionTypeJWTAssertion

+ const GrantTypeBearer

+ const GrantTypeClientCredentials

+ const GrantTypeCode

+ const GrantTypeDeviceCode

+ const GrantTypeImplicit

+ const GrantTypeRefreshToken

+ const GrantTypeTokenExchange

+ type IDClaims interface

+ GetAccessTokenHash func() string

+ GetSignatureAlgorithm func() jose.SignatureAlgorithm

+ type IDTokenClaims struct

+ AccessTokenHash string

+ Address *UserInfoAddress

+ Claims map[string]any

+ CodeHash string

+ NotBefore Time

+ SessionID string

+ func NewIDTokenClaims(issuer, subject string, audience []string, expiration, authTime time.Time, ...) *IDTokenClaims

+ func (i *IDTokenClaims) MarshalJSON() ([]byte, error)

+ func (i *IDTokenClaims) UnmarshalJSON(data []byte) error

+ func (t *IDTokenClaims) GetAccessTokenHash() string

+ func (t *IDTokenClaims) SetUserInfo(i *UserInfo)

+ type IntrospectionRequest struct

+ Token string

+ type IntrospectionResponse struct

+ Active bool

+ Address *UserInfoAddress

+ Audience Audience

+ Claims map[string]any

+ ClientID string

+ Expiration Time

+ IssuedAt Time

+ Issuer string

+ JWTID string

+ NotBefore Time

+ Scope SpaceDelimitedArray

+ Subject string

+ TokenType string

+ Username string

+ func (i *IntrospectionResponse) GetAddress() *UserInfoAddress

+ func (i *IntrospectionResponse) MarshalJSON() ([]byte, error)

+ func (i *IntrospectionResponse) SetUserInfo(u *UserInfo)

+ func (i *IntrospectionResponse) UnmarshalJSON(data []byte) error

+ type JWTProfileAssertionClaims struct

+ Audience Audience

+ Claims map[string]interface{}

+ Expiration Time

+ IssuedAt Time

+ Issuer string

+ PrivateKey []byte

+ PrivateKeyID string

+ Subject string

+ func NewJWTProfileAssertion(userID, keyID string, audience []string, key []byte, opts ...AssertionOption) *JWTProfileAssertionClaims

+ func NewJWTProfileAssertionFromFileData(data []byte, audience []string, opts ...AssertionOption) (*JWTProfileAssertionClaims, error)

+ func NewJWTProfileAssertionFromKeyJSON(filename string, audience []string, opts ...AssertionOption) (*JWTProfileAssertionClaims, error)

+ func (j *JWTProfileAssertionClaims) MarshalJSON() ([]byte, error)

+ func (j *JWTProfileAssertionClaims) UnmarshalJSON(data []byte) error

+ type JWTProfileGrantRequest struct

+ Assertion string

+ GrantType GrantType

+ Scope SpaceDelimitedArray

+ func NewJWTProfileGrantRequest(assertion string, scopes ...string) *JWTProfileGrantRequest

+ type JWTTokenRequest struct

+ Audience Audience

+ ExpiresAt Time

+ IssuedAt Time

+ Issuer string

+ Scopes SpaceDelimitedArray

+ Subject string

+ func (j *JWTTokenRequest) GetAudience() []string

+ func (j *JWTTokenRequest) GetAuthTime() time.Time

+ func (j *JWTTokenRequest) GetAuthenticationContextClassReference() string

+ func (j *JWTTokenRequest) GetAuthorizedParty() string

+ func (j *JWTTokenRequest) GetCustomClaim(key string) interface{}

+ func (j *JWTTokenRequest) GetExpiration() time.Time

+ func (j *JWTTokenRequest) GetIssuedAt() time.Time

+ func (j *JWTTokenRequest) GetIssuer() string

+ func (j *JWTTokenRequest) GetNonce() string

+ func (j *JWTTokenRequest) GetScopes() []string

+ func (j *JWTTokenRequest) GetSubject() string

+ func (j *JWTTokenRequest) MarshalJSON() ([]byte, error)

+ func (j *JWTTokenRequest) SetSignatureAlgorithm(_ jose.SignatureAlgorithm)

+ func (j *JWTTokenRequest) UnmarshalJSON(data []byte) error

+ type KeySet interface

+ VerifySignature func(ctx context.Context, jws *jose.JSONWebSignature) (payload []byte, err error)

+ type Locale struct

+ func NewLocale(tag language.Tag) *Locale

+ func (l *Locale) MarshalJSON() ([]byte, error)

+ func (l *Locale) String() string

+ func (l *Locale) Tag() language.Tag

+ func (l *Locale) UnmarshalJSON(data []byte) error

+ type Locales []language.Tag

+ func (l *Locales) UnmarshalText(text []byte) error

+ type MaxAge *uint

+ func NewMaxAge(i uint) MaxAge

+ type Prompt SpaceDelimitedArray

+ type RefreshTokenRequest struct

+ ClientAssertion string

+ ClientAssertionType string

+ ClientID string

+ ClientSecret string

+ RefreshToken string

+ Scopes SpaceDelimitedArray

+ func (a *RefreshTokenRequest) GrantType() GrantType

+ func (a *RefreshTokenRequest) SetClientID(clientID string)

+ func (a *RefreshTokenRequest) SetClientSecret(clientSecret string)

+ type RequestObject struct

+ Audience Audience

+ Issuer string

+ func (*RequestObject) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm)

+ func (r *RequestObject) GetIssuer() string

+ type ResponseMode string

+ type ResponseType string

+ type RevocationRequest struct

+ Token string

+ TokenTypeHint string

+ type SpaceDelimitedArray []string

+ func (s *SpaceDelimitedArray) Scan(src interface{}) error

+ func (s *SpaceDelimitedArray) UnmarshalJSON(data []byte) error

+ func (s *SpaceDelimitedArray) UnmarshalText(text []byte) error

+ func (s SpaceDelimitedArray) Encode() string

+ func (s SpaceDelimitedArray) MarshalJSON() ([]byte, error)

+ func (s SpaceDelimitedArray) MarshalText() ([]byte, error)

+ func (s SpaceDelimitedArray) Value() (driver.Value, error)

+ type Time int64

+ func FromTime(tt time.Time) Time

+ func NowTime() Time

+ func (ts *Time) UnmarshalJSON(data []byte) error

+ func (ts Time) AsTime() time.Time

+ type TokenClaims struct

+ Audience Audience

+ AuthTime Time

+ AuthenticationContextClassReference string

+ AuthenticationMethodsReferences []string

+ AuthorizedParty string

+ ClientID string

+ Expiration Time

+ IssuedAt Time

+ Issuer string

+ JWTID string

+ Nonce string

+ NotBefore Time

+ SignatureAlg jose.SignatureAlgorithm

+ Subject string

+ func (c *TokenClaims) GetAudience() []string

+ func (c *TokenClaims) GetAuthTime() time.Time

+ func (c *TokenClaims) GetAuthenticationContextClassReference() string

+ func (c *TokenClaims) GetAuthorizedParty() string

+ func (c *TokenClaims) GetExpiration() time.Time

+ func (c *TokenClaims) GetIssuedAt() time.Time

+ func (c *TokenClaims) GetIssuer() string

+ func (c *TokenClaims) GetNonce() string

+ func (c *TokenClaims) GetSignatureAlgorithm() jose.SignatureAlgorithm

+ func (c *TokenClaims) GetSubject() string

+ func (c *TokenClaims) SetSignatureAlgorithm(algorithm jose.SignatureAlgorithm)

+ type TokenExchangeRequest struct

+ ActorToken string

+ ActorTokenType TokenType

+ Audience Audience

+ GrantType GrantType

+ RequestedTokenType TokenType

+ Resource []string

+ Scopes SpaceDelimitedArray

+ SubjectToken string

+ SubjectTokenType TokenType

+ type TokenExchangeResponse struct

+ AccessToken string

+ ExpiresIn uint64

+ IssuedTokenType TokenType

+ RefreshToken string

+ Scopes SpaceDelimitedArray

+ TokenType string

+ type TokenRequest interface

+ GrantType func() GrantType

+ type TokenRequestType GrantType

+ type TokenType string

+ const AccessTokenType

+ const IDTokenType

+ const JWTTokenType

+ const RefreshTokenType

+ func (t TokenType) IsSupported() bool

+ type Tokens struct

+ IDToken string

+ IDTokenClaims C

+ type UserInfo struct

+ Address *UserInfoAddress

+ Claims map[string]any

+ Subject string

+ func (u *UserInfo) AppendClaims(k string, v any)

+ func (u *UserInfo) GetAddress() *UserInfoAddress

+ func (u *UserInfo) MarshalJSON() ([]byte, error)

+ func (u *UserInfo) UnmarshalJSON(data []byte) error

+ type UserInfoAddress struct

+ Country string

+ Formatted string

+ Locality string

+ PostalCode string

+ Region string

+ StreetAddress string

+ type UserInfoEmail struct

+ Email string

+ EmailVerified Bool

+ type UserInfoPhone struct

+ PhoneNumber string

+ PhoneNumberVerified bool

+ type UserInfoProfile struct

+ Birthdate string

+ FamilyName string

+ Gender Gender

+ GivenName string

+ Locale *Locale

+ MiddleName string

+ Name string

+ Nickname string

+ Picture string

+ PreferredUsername string

+ Profile string

+ UpdatedAt Time

+ Website string

+ Zoneinfo string

+ type UserInfoRequest struct

+ AccessToken string

+ type Verifier interface

+ Issuer func() string

+ MaxAgeIAT func() time.Duration

+ Offset func() time.Duration

v2.0.0-next.5

Mar 15, 2023

v2.0.0-next.4

Mar 15, 2023

v2.0.0-next.3

Mar 10, 2023

v2.0.0-next.2

Mar 8, 2023

v2.0.0-next.1

Mar 2, 2023

v2.0.0-dynamic-issuer.9

Mar 2, 2023

v2.0.0-dynamic-issuer.8

Feb 6, 2023

v2.0.0-dynamic-issuer.7

Jan 31, 2023

v2.0.0-dynamic-issuer.6

Jan 9, 2023

v2.0.0-dynamic-issuer.5

Jul 25, 2022

v2.0.0-dynamic-issuer.4

Jul 22, 2022

v2.0.0-dynamic-issuer.3

Jun 21, 2022

v2.0.0-dynamic-issuer.2

Apr 26, 2022

Other modules containing this package

github.com/zitadel/oidc

github.com/zitadel/oidc/v3

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