oidc

package

Go to main page

Versions in this module

v1

v1.13.5

Oct 13, 2023

v1.13.4

Mar 22, 2023

v1.13.3

Mar 22, 2023

v1.13.2

Mar 10, 2023

v1.13.1

Mar 6, 2023

v1.13.0

Feb 6, 2023

v1.12.2

Feb 3, 2023

v1.12.1

Jan 9, 2023

v1.12.0

Dec 6, 2022

Changes in this version

type IntrospectionResponse

+ GetAudience func() []string

+ GetClientID func() string

+ GetExpiration func() time.Time

+ GetIssuedAt func() time.Time

+ GetIssuer func() string

+ GetJWTID func() string

+ GetNotBefore func() time.Time

+ GetScope func() []string

+ GetSubject func() string

+ GetTokenType func() string

v1.11.0

Nov 15, 2022

v1.10.0

Nov 14, 2022

Changes in this version

+ var AllAuthMethods = []AuthMethod

v1.9.1

Oct 4, 2022

v1.9.0

Sep 30, 2022

v1.8.1

Sep 30, 2022

v1.8.0

Aug 30, 2022

Changes in this version

type UserInfo

+ GetClaims func() map[string]interface{}

v1.7.0

Aug 5, 2022

v1.6.1

Jul 27, 2022

Changes in this version

type EndSessionRequest

+ ClientID string

v1.6.0

Jul 25, 2022

Changes in this version

type IntrospectionResponse

+ SetAudience func(audience []string)

+ SetExpiration func(exp time.Time)

+ SetIssuedAt func(iat time.Time)

+ SetIssuer func(issuer string)

+ SetJWTID func(id string)

+ SetNotBefore func(nbf time.Time)

+ SetTokenType func(tokenType string)

v1.5.2

Jul 20, 2022

Changes in this version

+ var AllGrantTypes = []GrantType

type SpaceDelimitedArray

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

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

v1.5.1

Jun 21, 2022

Changes in this version

type AccessTokenResponse

+ State string

v1.5.0

May 13, 2022

v1.4.0

May 9, 2022

Changes in this version

+ type ClientCredentialsRequest struct

+ ClientID string

+ ClientSecret string

+ GrantType GrantType

+ Scope SpaceDelimitedArray

type GrantType

+ const GrantTypeClientCredentials

v1.3.1

Apr 26, 2022

Changes in this version

+ const BearerToken

+ const DiscoveryEndpoint

+ const DisplayPage

+ const DisplayPopup

+ const DisplayTouch

+ const DisplayWAP

+ 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 UnauthorizedClient

+ const UnsupportedGrantType

+ 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 ErrAzpInvalid = errors.New("authorized party is not valid")

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

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

+ 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 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(*jwtProfileAssertion)

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

+ 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 interface

+ GetSubject func() string

+ GetTokenID func() string

+ SetPrivateClaims func(map[string]interface{})

+ func EmptyAccessTokenClaims() AccessTokenClaims

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

+ 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

+ TokenType string

+ type AssertionOption func(*jwtProfileAssertion)

+ 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 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 CodeChallenge struct

+ Challenge string

+ Method CodeChallengeMethod

+ type CodeChallengeMethod string

+ const CodeChallengeMethodPlain

+ const CodeChallengeMethodS256

+ type DiscoveryConfiguration struct

+ ACRValuesSupported []string

+ AuthorizationEndpoint string

+ CheckSessionIframe string

+ ClaimTypesSupported []string

+ ClaimsLocalesSupported []language.Tag

+ ClaimsParameterSupported bool

+ ClaimsSupported []string

+ CodeChallengeMethodsSupported []CodeChallengeMethod

+ 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

+ 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 GrantTypeCode

+ const GrantTypeImplicit

+ const GrantTypeRefreshToken

+ const GrantTypeTokenExchange

+ type IDTokenClaims interface

+ GetAccessTokenHash func() string

+ GetAuthenticationMethodsReferences func() []string

+ GetClientID func() string

+ GetCodeHash func() string

+ GetJWTID func() string

+ GetNotBefore func() time.Time

+ GetSignatureAlgorithm func() jose.SignatureAlgorithm

+ SetAccessTokenHash func(hash string)

+ SetCodeHash func(hash string)

+ SetUserinfo func(userinfo UserInfo)

+ func EmptyIDTokenClaims() IDTokenClaims

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

+ type IntrospectionRequest struct

+ Token string

+ type IntrospectionResponse interface

+ IsActive func() bool

+ SetActive func(bool)

+ SetClientID func(id string)

+ SetScopes func(scopes []string)

+ func NewIntrospectionResponse() IntrospectionResponse

+ type JWTProfileAssertionClaims interface

+ GetAudience func() []string

+ GetCustomClaim func(key string) interface{}

+ GetExpiration func() time.Time

+ GetIssuedAt func() time.Time

+ GetIssuer func() string

+ GetKeyID func() string

+ GetPrivateKey func() []byte

+ GetSubject func() string

+ SetCustomClaim func(key string, value interface{})

+ 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)

+ 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 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 (r *RequestObject) GetIssuer() string

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

+ type ResponseMode string

+ type ResponseType string

+ type RevocationRequest struct

+ Token string

+ TokenTypeHint string

+ type SpaceDelimitedArray []string

+ 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)

+ type Time time.Time

+ func (t *Time) MarshalJSON() ([]byte, error)

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

+ type TokenExchangeRequest struct

+ Scope SpaceDelimitedArray

+ type TokenRequest interface

+ GrantType func() GrantType

+ type TokenRequestType GrantType

+ type Tokens struct

+ IDToken string

+ IDTokenClaims IDTokenClaims

+ type UserInfo interface

+ GetAddress func() UserInfoAddress

+ GetClaim func(key string) interface{}

+ GetSubject func() string

+ type UserInfoAddress interface

+ GetCountry func() string

+ GetFormatted func() string

+ GetLocality func() string

+ GetPostalCode func() string

+ GetRegion func() string

+ GetStreetAddress func() string

+ func NewUserInfoAddress(streetAddress, locality, region, postalCode, country, formatted string) UserInfoAddress

+ type UserInfoEmail interface

+ GetEmail func() string

+ IsEmailVerified func() bool

+ type UserInfoPhone interface

+ GetPhoneNumber func() string

+ IsPhoneNumberVerified func() bool

+ type UserInfoProfile interface

+ GetBirthdate func() string

+ GetFamilyName func() string

+ GetGender func() Gender

+ GetGivenName func() string

+ GetLocale func() language.Tag

+ GetMiddleName func() string

+ GetName func() string

+ GetNickname func() string

+ GetPicture func() string

+ GetPreferredUsername func() string

+ GetProfile func() string

+ GetWebsite func() string

+ GetZoneinfo func() string

+ type UserInfoProfileSetter interface

+ SetBirthdate func(birthdate string)

+ SetFamilyName func(name string)

+ SetGender func(gender Gender)

+ SetGivenName func(name string)

+ SetLocale func(locale language.Tag)

+ SetMiddleName func(name string)

+ SetName func(name string)

+ SetNickname func(name string)

+ SetPicture func(profile string)

+ SetPreferredUsername func(name string)

+ SetProfile func(profile string)

+ SetUpdatedAt func(date time.Time)

+ SetWebsite func(website string)

+ SetZoneinfo func(zoneInfo string)

+ type UserInfoRequest struct

+ AccessToken string

+ type UserInfoSetter interface

+ AppendClaims func(key string, values interface{})

+ SetAddress func(address UserInfoAddress)

+ SetEmail func(email string, verified bool)

+ SetPhone func(phone string, verified bool)

+ SetSubject func(sub string)

+ func NewUserInfo() UserInfoSetter

+ type Verifier interface

+ Issuer func() string

+ MaxAgeIAT func() time.Duration

+ Offset func() time.Duration

Other modules containing this package

github.com/zitadel/oidc/v2

github.com/zitadel/oidc/v3

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