Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

storage

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

Changes in this version

type Client

+ func (c *Client) PostLogoutRedirectURIGlobs() []string

+ func (c *Client) RedirectURIGlobs() []string

v1.13.0

Feb 6, 2023

v1.12.2

Feb 3, 2023

v1.12.1

Jan 9, 2023

v1.12.0

Dec 6, 2022

v1.11.0

Nov 15, 2022

v1.10.0

Nov 14, 2022

v1.9.1

Oct 4, 2022

Changes in this version

+ const CustomClaim

+ const CustomScope

+ func CodeChallengeToOIDC(challenge *OIDCCodeChallenge) *oidc.CodeChallenge

+ func MaxAgeToInternal(maxAge *uint) *time.Duration

+ func PromptToInternal(oidcPrompt oidc.SpaceDelimitedArray) []string

+ func RefreshTokenRequestFromBusiness(token *RefreshToken) op.RefreshTokenRequest

+ func RegisterClients(registerClients ...*Client)

+ type AuthRequest struct

+ ApplicationID string

+ CallbackURI string

+ CodeChallenge *OIDCCodeChallenge

+ CreationDate time.Time

+ ID string

+ LoginHint string

+ MaxAuthAge *time.Duration

+ Nonce string

+ Prompt []string

+ ResponseType oidc.ResponseType

+ Scopes []string

+ TransferState string

+ UiLocales []language.Tag

+ UserID string

+ func (a *AuthRequest) Done() bool

+ func (a *AuthRequest) GetACR() string

+ func (a *AuthRequest) GetAMR() []string

+ func (a *AuthRequest) GetAudience() []string

+ func (a *AuthRequest) GetAuthTime() time.Time

+ func (a *AuthRequest) GetClientID() string

+ func (a *AuthRequest) GetCodeChallenge() *oidc.CodeChallenge

+ func (a *AuthRequest) GetID() string

+ func (a *AuthRequest) GetNonce() string

+ func (a *AuthRequest) GetRedirectURI() string

+ func (a *AuthRequest) GetResponseMode() oidc.ResponseMode

+ func (a *AuthRequest) GetResponseType() oidc.ResponseType

+ func (a *AuthRequest) GetScopes() []string

+ func (a *AuthRequest) GetState() string

+ func (a *AuthRequest) GetSubject() string

+ type Client struct

+ func NativeClient(id string, redirectURIs ...string) *Client

+ func WebClient(id, secret string, redirectURIs ...string) *Client

+ func (c *Client) AccessTokenType() op.AccessTokenType

+ func (c *Client) ApplicationType() op.ApplicationType

+ func (c *Client) AuthMethod() oidc.AuthMethod

+ func (c *Client) ClockSkew() time.Duration

+ func (c *Client) DevMode() bool

+ func (c *Client) GetID() string

+ func (c *Client) GrantTypes() []oidc.GrantType

+ func (c *Client) IDTokenLifetime() time.Duration

+ func (c *Client) IDTokenUserinfoClaimsAssertion() bool

+ func (c *Client) IsScopeAllowed(scope string) bool

+ func (c *Client) LoginURL(id string) string

+ func (c *Client) PostLogoutRedirectURIs() []string

+ func (c *Client) RedirectURIs() []string

+ func (c *Client) ResponseTypes() []oidc.ResponseType

+ func (c *Client) RestrictAdditionalAccessTokenScopes() func(scopes []string) []string

+ func (c *Client) RestrictAdditionalIdTokenScopes() func(scopes []string) []string

+ type OIDCCodeChallenge struct

+ Challenge string

+ Method string

+ type RefreshToken struct

+ AMR []string

+ ApplicationID string

+ Audience []string

+ AuthTime time.Time

+ Expiration time.Time

+ ID string

+ Scopes []string

+ Token string

+ UserID string

+ type RefreshTokenRequest struct

+ func (r *RefreshTokenRequest) GetAMR() []string

+ func (r *RefreshTokenRequest) GetAudience() []string

+ func (r *RefreshTokenRequest) GetAuthTime() time.Time

+ func (r *RefreshTokenRequest) GetClientID() string

+ func (r *RefreshTokenRequest) GetScopes() []string

+ func (r *RefreshTokenRequest) GetSubject() string

+ func (r *RefreshTokenRequest) SetCurrentScopes(scopes []string)

+ type Service struct

+ type Storage struct

+ func NewStorage(userStore UserStore) *Storage

+ func (s *Storage) AuthRequestByCode(ctx context.Context, code string) (op.AuthRequest, error)

+ func (s *Storage) AuthRequestByID(ctx context.Context, id string) (op.AuthRequest, error)

+ func (s *Storage) AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string) error

+ func (s *Storage) CheckUsernamePassword(username, password, id string) error

+ func (s *Storage) CreateAccessAndRefreshTokens(ctx context.Context, request op.TokenRequest, currentRefreshToken string) (accessTokenID string, newRefreshToken string, expiration time.Time, err error)

+ func (s *Storage) CreateAccessToken(ctx context.Context, request op.TokenRequest) (string, time.Time, error)

+ func (s *Storage) CreateAuthRequest(ctx context.Context, authReq *oidc.AuthRequest, userID string) (op.AuthRequest, error)

+ func (s *Storage) DeleteAuthRequest(ctx context.Context, id string) error

+ func (s *Storage) GetClientByClientID(ctx context.Context, clientID string) (op.Client, error)

+ func (s *Storage) GetKeyByIDAndUserID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error)

+ func (s *Storage) GetKeySet(ctx context.Context) (*jose.JSONWebKeySet, error)

+ func (s *Storage) GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]interface{}, err error)

+ func (s *Storage) GetSigningKey(ctx context.Context, keyCh chan<- jose.SigningKey)

+ func (s *Storage) Health(ctx context.Context) error

+ func (s *Storage) RevokeToken(ctx context.Context, token string, userID string, clientID string) *oidc.Error

+ func (s *Storage) SaveAuthCode(ctx context.Context, id string, code string) error

+ func (s *Storage) SetIntrospectionFromToken(ctx context.Context, introspection oidc.IntrospectionResponse, ...) error

+ func (s *Storage) SetUserinfoFromScopes(ctx context.Context, userinfo oidc.UserInfoSetter, userID, clientID string, ...) error

+ func (s *Storage) SetUserinfoFromToken(ctx context.Context, userinfo oidc.UserInfoSetter, ...) error

+ func (s *Storage) TerminateSession(ctx context.Context, userID string, clientID string) error

+ func (s *Storage) TokenRequestByRefreshToken(ctx context.Context, refreshToken string) (op.RefreshTokenRequest, error)

+ func (s *Storage) ValidateJWTProfileScopes(ctx context.Context, userID string, scopes []string) ([]string, error)

+ type Token struct

+ ApplicationID string

+ Audience []string

+ Expiration time.Time

+ ID string

+ RefreshTokenID string

+ Scopes []string

+ Subject string

+ type User struct

+ Email string

+ EmailVerified bool

+ FirstName string

+ ID string

+ LastName string

+ Password string

+ Phone string

+ PhoneVerified bool

+ PreferredLanguage language.Tag

+ Username string

+ type UserStore interface

+ ExampleClientID func() string

+ GetUserByID func(string) *User

+ GetUserByUsername func(string) *User

+ func NewUserStore() UserStore

Other modules containing this package

github.com/zitadel/oidc/v2

github.com/zitadel/oidc/v3