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

oauth2

package

Go to main page

Versions in this module

v0

v0.1.12

Apr 22, 2024

v0.1.11

Apr 22, 2024

v0.1.10

Apr 11, 2024

v0.1.9

Apr 7, 2024

v0.1.8

Apr 6, 2024

v0.1.7

Apr 5, 2024

v0.1.6

Apr 2, 2024

v0.1.5

Apr 1, 2024

v0.1.4

Mar 31, 2024

v0.1.3

Mar 27, 2024

v0.1.2

Mar 16, 2024

v0.1.1

Mar 15, 2024

v0.1.0

Mar 13, 2024

Changes in this version

+ func AccessTokenJWTToRequest(token *jwt.Token) oauth2.Requester

+ func IsJWTProfileAccessToken(token *jwt.Token) bool

+ type AccessTokenStorage interface

+ CreateAccessTokenSession func(ctx context.Context, signature string, request oauth2.Requester) (err error)

+ DeleteAccessTokenSession func(ctx context.Context, signature string) (err error)

+ GetAccessTokenSession func(ctx context.Context, signature string, session oauth2.Session) (request oauth2.Requester, err error)

+ type AccessTokenStrategy interface

+ AccessTokenSignature func(ctx context.Context, token string) string

+ GenerateAccessToken func(ctx context.Context, requester oauth2.Requester) (token string, signature string, err error)

+ ValidateAccessToken func(ctx context.Context, requester oauth2.Requester, token string) (err error)

+ type AuthorizeCodeStorage interface

+ CreateAuthorizeCodeSession func(ctx context.Context, code string, request oauth2.Requester) (err error)

+ GetAuthorizeCodeSession func(ctx context.Context, code string, session oauth2.Session) (request oauth2.Requester, err error)

+ InvalidateAuthorizeCodeSession func(ctx context.Context, code string) (err error)

+ type AuthorizeCodeStrategy interface

+ AuthorizeCodeSignature func(ctx context.Context, token string) string

+ GenerateAuthorizeCode func(ctx context.Context, requester oauth2.Requester) (token string, signature string, err error)

+ ValidateAuthorizeCode func(ctx context.Context, requester oauth2.Requester, token string) (err error)

+ type AuthorizeExplicitGrantHandler struct

+ AccessTokenStrategy AccessTokenStrategy

+ AuthorizeCodeStrategy AuthorizeCodeStrategy

+ Config interface{ ... }

+ CoreStorage CoreStorage

+ RefreshTokenStrategy RefreshTokenStrategy

+ TokenRevocationStorage TokenRevocationStorage

+ func (c *AuthorizeExplicitGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *AuthorizeExplicitGrantHandler) CanSkipClientAuth(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *AuthorizeExplicitGrantHandler) GetSanitationWhiteList(ctx context.Context) []string

+ func (c *AuthorizeExplicitGrantHandler) HandleAuthorizeEndpointRequest(ctx context.Context, requester oauth2.AuthorizeRequester, ...) error

+ func (c *AuthorizeExplicitGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error

+ func (c *AuthorizeExplicitGrantHandler) IssueAuthorizeCode(ctx context.Context, requester oauth2.AuthorizeRequester, ...) error

+ func (c *AuthorizeExplicitGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester oauth2.AccessRequester, ...) (err error)

+ type AuthorizeImplicitGrantTypeHandler struct

+ AccessTokenStorage AccessTokenStorage

+ AccessTokenStrategy AccessTokenStrategy

+ Config interface{ ... }

+ func (c *AuthorizeImplicitGrantTypeHandler) HandleAuthorizeEndpointRequest(ctx context.Context, requester oauth2.AuthorizeRequester, ...) error

+ func (c *AuthorizeImplicitGrantTypeHandler) IssueImplicitAccessToken(ctx context.Context, requester oauth2.AuthorizeRequester, ...) error

+ type ClientCredentialsGrantHandler struct

+ Config interface{ ... }

+ func (c *ClientCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *ClientCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *ClientCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error

+ func (c *ClientCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, request oauth2.AccessRequester, ...) error

+ type ClientCredentialsGrantStorage interface

+ type CodeTokenEndpointHandler interface

+ CanHandleTokenEndpointRequest func(ctx context.Context, requester oauth2.AccessRequester) bool

+ CanSkipClientAuth func(ctx context.Context, requester oauth2.AccessRequester) bool

+ DeviceCodeSignature func(ctx context.Context, code string) (string, error)

+ GetCodeAndSession func(ctx context.Context, request oauth2.AccessRequester) (string, string, oauth2.Requester, error)

+ InvalidateSession func(ctx context.Context, signature string, authorizeRequest oauth2.Requester) error

+ UpdateLastChecked func(ctx context.Context, request oauth2.AccessRequester, ...) error

+ ValidateCodeAndSession func(ctx context.Context, request oauth2.AccessRequester, ...) error

+ ValidateGrantTypes func(ctx context.Context, requester oauth2.AccessRequester) error

+ type CoreStorage interface

+ type CoreStrategy interface

+ func NewCoreStrategy(config CoreStrategyConfigurator, prefix string, signer jwt.Signer) (strategy CoreStrategy)

+ type CoreStrategyConfigurator interface

+ type CoreValidator struct

+ Config coreValidatorConfigProvider

+ func (c *CoreValidator) IntrospectToken(ctx context.Context, token string, tokenUse oauth2.TokenUse, ...) (oauth2.TokenUse, error)

+ type DeviceCodeStrategy interface

+ GenerateRFC8628DeviceCode func(ctx context.Context) (code string, signature string, err error)

+ RFC8628DeviceCodeSignature func(ctx context.Context, code string) (signature string, err error)

+ ValidateRFC8628DeviceCode func(ctx context.Context, r oauth2.Requester, code string) (err error)

+ type GenericCodeTokenEndpointHandler struct

+ AccessTokenStrategy AccessTokenStrategy

+ Config interface{ ... }

+ CoreStorage CoreStorage

+ RefreshTokenStrategy RefreshTokenStrategy

+ TokenRevocationStorage TokenRevocationStorage

+ func (c *GenericCodeTokenEndpointHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *GenericCodeTokenEndpointHandler) CanSkipClientAuth(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *GenericCodeTokenEndpointHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error

+ func (c *GenericCodeTokenEndpointHandler) PopulateTokenEndpointResponse(ctx context.Context, requester oauth2.AccessRequester, ...) (err error)

+ type HMACCoreStrategy struct

+ Config interface{ ... }

+ Enigma *hmac.HMACStrategy

+ func NewHMACCoreStrategy(config HMACCoreStrategyConfigurator, prefix string) (strategy *HMACCoreStrategy)

+ func (s *HMACCoreStrategy) AccessTokenSignature(ctx context.Context, tokenString string) (signature string)

+ func (s *HMACCoreStrategy) AuthorizeCodeSignature(ctx context.Context, token string) string

+ func (s *HMACCoreStrategy) GenerateAccessToken(ctx context.Context, _ oauth2.Requester) (tokenString string, signature string, err error)

+ func (s *HMACCoreStrategy) GenerateAuthorizeCode(ctx context.Context, _ oauth2.Requester) (tokenString string, signature string, err error)

+ func (s *HMACCoreStrategy) GenerateRFC8628DeviceCode(ctx context.Context) (tokenString string, signature string, err error)

+ func (s *HMACCoreStrategy) GenerateRFC8628UserCode(ctx context.Context) (tokenString string, signature string, err error)

+ func (s *HMACCoreStrategy) GenerateRefreshToken(ctx context.Context, _ oauth2.Requester) (tokenString string, signature string, err error)

+ func (s *HMACCoreStrategy) RFC8628DeviceCodeSignature(ctx context.Context, tokenString string) (signature string, err error)

+ func (s *HMACCoreStrategy) RFC8628UserCodeSignature(ctx context.Context, tokenString string) (signature string, err error)

+ func (s *HMACCoreStrategy) RefreshTokenSignature(ctx context.Context, tokenString string) string

+ func (s *HMACCoreStrategy) ValidateAccessToken(ctx context.Context, r oauth2.Requester, tokenString string) (err error)

+ func (s *HMACCoreStrategy) ValidateAuthorizeCode(ctx context.Context, r oauth2.Requester, tokenString string) (err error)

+ func (s *HMACCoreStrategy) ValidateRFC8628DeviceCode(ctx context.Context, r oauth2.Requester, code string) (err error)

+ func (s *HMACCoreStrategy) ValidateRFC8628UserCode(ctx context.Context, r oauth2.Requester, code string) (err error)

+ func (s *HMACCoreStrategy) ValidateRefreshToken(ctx context.Context, r oauth2.Requester, tokenString string) (err error)

+ type HMACCoreStrategyConfigurator interface

+ type HandleHelper struct

+ AccessTokenStorage AccessTokenStorage

+ AccessTokenStrategy AccessTokenStrategy

+ Config HandleHelperConfigProvider

+ func (h *HandleHelper) IssueAccessToken(ctx context.Context, defaultLifespan time.Duration, ...) (err error)

+ type HandleHelperConfigProvider interface

+ type JWTProfileCoreStrategy struct

+ Config interface{ ... }

+ HMACCoreStrategy *HMACCoreStrategy

+ func (s *JWTProfileCoreStrategy) AccessTokenSignature(ctx context.Context, tokenString string) (signature string)

+ func (s *JWTProfileCoreStrategy) AuthorizeCodeSignature(ctx context.Context, tokenString string) string

+ func (s *JWTProfileCoreStrategy) GenerateAccessToken(ctx context.Context, requester oauth2.Requester) (token string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) GenerateAuthorizeCode(ctx context.Context, req oauth2.Requester) (tokenString string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) GenerateJWT(ctx context.Context, tokenType oauth2.TokenType, requester oauth2.Requester, ...) (tokenString string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) GenerateRFC8628DeviceCode(ctx context.Context) (tokenString string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) GenerateRFC8628UserCode(ctx context.Context) (tokenString string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) GenerateRefreshToken(ctx context.Context, req oauth2.Requester) (tokenString string, signature string, err error)

+ func (s *JWTProfileCoreStrategy) IsPossiblyJWTProfileAccessToken(ctx context.Context, tokenString string) (jwt bool, signature string)

+ func (s *JWTProfileCoreStrategy) RFC8628DeviceCodeSignature(ctx context.Context, tokenString string) (signature string, err error)

+ func (s *JWTProfileCoreStrategy) RFC8628UserCodeSignature(ctx context.Context, tokenString string) (signature string, err error)

+ func (s *JWTProfileCoreStrategy) RefreshTokenSignature(ctx context.Context, tokenString string) string

+ func (s *JWTProfileCoreStrategy) ValidateAccessToken(ctx context.Context, requester oauth2.Requester, tokenString string) (err error)

+ func (s *JWTProfileCoreStrategy) ValidateAuthorizeCode(ctx context.Context, req oauth2.Requester, tokenString string) error

+ func (s *JWTProfileCoreStrategy) ValidateRFC8628DeviceCode(ctx context.Context, r oauth2.Requester, tokenString string) (err error)

+ func (s *JWTProfileCoreStrategy) ValidateRFC8628UserCode(ctx context.Context, r oauth2.Requester, tokenString string) (err error)

+ func (s *JWTProfileCoreStrategy) ValidateRefreshToken(ctx context.Context, req oauth2.Requester, tokenString string) (err error)

+ type JWTSession struct

+ ExpiresAt map[oauth2.TokenType]time.Time

+ JWTClaims *jwt.JWTClaims

+ JWTHeader *jwt.Headers

+ Subject string

+ Username string

+ func (j *JWTSession) Clone() oauth2.Session

+ func (j *JWTSession) GetExpiresAt(key oauth2.TokenType) time.Time

+ func (j *JWTSession) GetExtraClaims() map[string]any

+ func (j *JWTSession) GetJWTClaims() jwt.JWTClaimsContainer

+ func (j *JWTSession) GetJWTHeader() *jwt.Headers

+ func (j *JWTSession) GetSubject() string

+ func (j *JWTSession) GetUsername() string

+ func (j *JWTSession) SetExpiresAt(key oauth2.TokenType, exp time.Time)

+ func (j *JWTSession) SetSubject(subject string)

+ type JWTSessionContainer interface

+ GetJWTClaims func() jwt.JWTClaimsContainer

+ GetJWTHeader func() *jwt.Headers

+ type NoneResponseTypeHandler struct

+ Config interface{ ... }

+ func (c *NoneResponseTypeHandler) GetRedirectSecureChecker(ctx context.Context) func(context.Context, *url.URL) bool

+ func (c *NoneResponseTypeHandler) HandleAuthorizeEndpointRequest(ctx context.Context, requester oauth2.AuthorizeRequester, ...) error

+ type RefreshTokenGrantHandler struct

+ AccessTokenStrategy AccessTokenStrategy

+ Config interface{ ... }

+ RefreshTokenStrategy RefreshTokenStrategy

+ TokenRevocationStorage TokenRevocationStorage

+ func (c *RefreshTokenGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *RefreshTokenGrantHandler) CanSkipClientAuth(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *RefreshTokenGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error

+ func (c *RefreshTokenGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester oauth2.AccessRequester, ...) (err error)

+ type RefreshTokenStorage interface

+ CreateRefreshTokenSession func(ctx context.Context, signature string, request oauth2.Requester) (err error)

+ DeleteRefreshTokenSession func(ctx context.Context, signature string) (err error)

+ GetRefreshTokenSession func(ctx context.Context, signature string, session oauth2.Session) (request oauth2.Requester, err error)

+ type RefreshTokenStrategy interface

+ GenerateRefreshToken func(ctx context.Context, requester oauth2.Requester) (token string, signature string, err error)

+ RefreshTokenSignature func(ctx context.Context, token string) string

+ ValidateRefreshToken func(ctx context.Context, requester oauth2.Requester, token string) (err error)

+ type ResourceOwnerPasswordCredentialsGrantHandler struct

+ Config interface{ ... }

+ RefreshTokenStrategy RefreshTokenStrategy

+ ResourceOwnerPasswordCredentialsGrantStorage ResourceOwnerPasswordCredentialsGrantStorage

+ func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool

+ func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, _ oauth2.AccessRequester) bool

+ func (c *ResourceOwnerPasswordCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error

+ func (c *ResourceOwnerPasswordCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester oauth2.AccessRequester, ...) error

+ type ResourceOwnerPasswordCredentialsGrantStorage interface

+ Authenticate func(ctx context.Context, name string, secret string) error

+ type RevocationTokenLookupFunc func(ctx context.Context, token string) (requester oauth2.Requester, tokenType oauth2.TokenType, err error)

+ type StatelessJWTValidator struct

+ Config interface{ ... }

+ func (v *StatelessJWTValidator) IntrospectToken(ctx context.Context, token string, tokenUse oauth2.TokenUse, ...) (oauth2.TokenUse, error)

+ type TokenRevocationHandler struct

+ AccessTokenStrategy AccessTokenStrategy

+ Config interface{ ... }

+ RefreshTokenStrategy RefreshTokenStrategy

+ TokenRevocationStorage TokenRevocationStorage

+ func (r *TokenRevocationHandler) RevokeToken(ctx context.Context, token string, tokenType oauth2.TokenType, ...) error

+ type TokenRevocationStorage interface

+ RevokeAccessToken func(ctx context.Context, requestID string) error

+ RevokeRefreshToken func(ctx context.Context, requestID string) error

+ RevokeRefreshTokenMaybeGracePeriod func(ctx context.Context, requestID string, signature string) error

+ type UserCodeStrategy interface

+ GenerateRFC8628UserCode func(ctx context.Context) (code string, signature string, err error)

+ RFC8628UserCodeSignature func(ctx context.Context, code string) (signature string, err error)

+ ValidateRFC8628UserCode func(ctx context.Context, r oauth2.Requester, code string) (err error)