oauth2

Jun 21, 2023

Changes in this version

+ var ErrAccessToken = errors.New("OAuth2 Server AccessToken Is Nil")

+ type AccessTokener interface

+ Generate func(ctx context.Context, issuer, clientID, scope, openID string, code *CodeValue) (token *TokenResponse, err error)

+ Parse func(ctx context.Context, accessToken string) (claims *JwtClaims, err error)

+ Refresh func(ctx context.Context, clientID, refreshToken string) (token *TokenResponse, err error)

+ type DefaultAccessToken struct

+ JwtVerifyKey []byte

+ func NewDefaultAccessToken(jwtVerifyKey []byte) *DefaultAccessToken

+ func (d *DefaultAccessToken) Generate(ctx context.Context, issuer, clientID, scope, openID string, code *CodeValue) (token *TokenResponse, err error)

+ func (d *DefaultAccessToken) Parse(ctx context.Context, accessToken string) (claims *JwtClaims, err error)

+ func (d *DefaultAccessToken) Refresh(ctx context.Context, clientID, refreshToken string) (token *TokenResponse, err error)

type Server

+ AccessToken AccessTokener

Aug 11, 2021

Changes in this version

+ const ImplicitKey

+ var ErrVerifyGrantTypeFuncNil = errors.New("OAuth2 Server VerifyGrantType Is Nil")

type Server

+ VerifyGrantType VerifyGrantTypeFunc

+ type VerifyGrantTypeFunc func(clientID, grantType string) (err error)

Jul 8, 2021

Changes in this version

type Client

+ func (c *Client) Token(grantType string, values url.Values) (token *TokenResponse, err error)

+ type CustomGrantTypeAuthenticationFunc func(client *ClientBasic, req *http.Request) (openID string, err error)

type ServerOption

+ func ServerCustomGrantTypeAuthentication(customGrantTypeAuthentication map[string]CustomGrantTypeAuthenticationFunc) ServerOption

+ func ServerCustomGrantTypeEnabled(customGrantTypeEnabled bool) ServerOption

type ServerOptions

+ CustomGrantTypeAuthentication map[string]CustomGrantTypeAuthenticationFunc

+ CustomGrantTypeEnabled bool

Nov 28, 2020

Changes in this version

type DeviceAuthorizationResponse

+ VerificationURIComplete string

Sep 24, 2020

Changes in this version

+ var ErrVerifyClientIDFuncNil = errors.New("OAuth2 Server VerifyClientID Is Nil")

type Server

+ VerifyClientID VerifyClientIDFunc

+ type VerifyClientIDFunc func(clientID string) (err error)

May 17, 2020

Changes in this version

+ func NewHS256JwtClaimsToken(claims *JwtClaims, jwtVerifyKey []byte) (string, error)

+ func NewJwtClaimsToken(claims *JwtClaims, algorithm string, key interface{}) (string, error)

+ func NewJwtStandardClaimsToken(claims *JwtStandardClaims, algorithm string, key interface{}) (string, error)

type JwtClaims

+ func ParseHS256JwtClaimsToken(token string, jwtVerifyKey []byte) (claims *JwtClaims, err error)

+ func ParseJwtClaimsToken(token string, key interface{}) (claims *JwtClaims, err error)

type JwtStandardClaims

+ func ParseJwtStandardClaimsToken(token string, key interface{}) (claims *JwtStandardClaims, err error)

May 17, 2020

Changes in this version

+ const DeviceCodeKey

+ const TokenTypeHintKey

+ const UrnIetfParamsOAuthGrantTypeDeviceCodeKey

+ var ErrAuthorizationPending = errors.New("authorization_pending")

+ var ErrExpiredToken = errors.New("expired_token")

+ var ErrGenerateDeviceAuthorizationFuncNil = errors.New("OAuth2 Server GenerateDeviceAuthorizationFunc Is Nil")

+ var ErrSlowDown = errors.New("slow_down")

+ var ErrTokenRevocationFuncNil = errors.New("OAuth2 Server TokenRevocation Is Nil")

+ var ErrUnsupportedTokenType = errors.New("unsupported_token_type")

+ var ErrVerifyDeviceCodeFuncNil = errors.New("OAuth2 Server ErrVerifyDeviceCodeFunc Is Nil")

+ var ErrVerifyIntrospectionTokenFuncNil = errors.New("OAuth2 Server VerifyIntrospectionToken Is Nil")

+ func NewHS256JwtToken(claims *JwtClaims, jwtVerifyKey []byte) (string, error)

+ func NewJwtToken(claims *JwtClaims, algorithm string, key interface{}) (string, error)

+ func RandomDeviceCode() string

+ func RandomUserCode() string

type Client

+ DeviceAuthorizationEndpoint string

+ IntrospectEndpoint string

+ TokenRevocationEndpoint string

+ func (c *Client) DeviceAuthorization(w http.ResponseWriter, scope string) (err error)

+ func (c *Client) TokenDeviceCode(deviceCode string) (model *TokenResponse, err error)

+ func (c *Client) TokenIntrospect(token string, tokenTypeHint ...string) (introspection *IntrospectionResponse, err error)

+ func (c *Client) TokenRevocation(token string, tokenTypeHint ...string) (introspection *IntrospectionResponse, err error)

+ type DeviceAuthorizationResponse struct

+ DeviceCode string

+ ExpiresIn int64

+ Interval int

+ UserCode string

+ VerificationURI string

+ VerificationURIQrcode string

+ type DeviceCodeValue struct

+ ClientID string

+ DeviceCode string

+ OpenID string

+ Scope []string

+ UserCode string

+ func (code *DeviceCodeValue) MarshalBinary() ([]byte, error)

+ func (code *DeviceCodeValue) UnmarshalBinary(data []byte) error

+ type GenerateDeviceAuthorizationFunc func(issuer, verificationURI, clientID, scope string) (resp *DeviceAuthorizationResponse, err error)

+ type IntrospectionResponse struct

+ Active bool

+ Aud string

+ ClientID string

+ Exp int64

+ Iss int64

+ Scope string

+ Sub string

+ Username string

type JwtClaims

+ func ParseHS256JwtToken(token string, jwtVerifyKey []byte) (claims *JwtClaims, err error)

+ func ParseJwtToken(token string, key interface{}) (claims *JwtClaims, err error)

+ func (c *JwtClaims) VerifyScope(scope string, req bool) bool

+ type JwtStandardClaims struct

+ Audience []string

+ ExpiresAt int64

+ ID string

+ IssuedAt int64

+ Issuer string

+ NotBefore int64

+ Subject string

+ func (c *JwtStandardClaims) VerifyAudience(cmp []string, req bool) bool

+ func (c *JwtStandardClaims) VerifyExpiresAt(cmp int64, req bool) bool

+ func (c *JwtStandardClaims) VerifyIssuedAt(cmp int64, req bool) bool

+ func (c *JwtStandardClaims) VerifyIssuer(cmp string, req bool) bool

+ func (c *JwtStandardClaims) VerifyNotBefore(cmp int64, req bool) bool

+ func (c JwtStandardClaims) Valid() error

type Server

+ GenerateDeviceAuthorization GenerateDeviceAuthorizationFunc

+ TokenRevocation TokenRevocationFunc

+ VerifyDeviceCode VerifyDeviceCodeFunc

+ VerifyIntrospectionToken VerifyIntrospectionTokenFunc

+ func (srv *Server) HandleDeviceAuthorization(w http.ResponseWriter, r *http.Request)

+ func (srv *Server) HandleTokenIntrospection(w http.ResponseWriter, r *http.Request)

+ func (srv *Server) HandleTokenRevocation(w http.ResponseWriter, r *http.Request)

+ type ServerOption func(*ServerOptions)

+ func ServerDeviceAuthorizationEndpointEnabled(deviceAuthorizationEndpointEnabled bool) ServerOption

+ func ServerDeviceVerificationURI(deviceVerificationURI string) ServerOption

+ func ServerIntrospectEndpointEnabled(introspectEndpointEnabled bool) ServerOption

+ func ServerIssuer(issuer string) ServerOption

+ func ServerLogger(log Logger) ServerOption

+ func ServerTokenRevocationEnabled(tokenRevocationEnabled bool) ServerOption

+ type ServerOptions struct

+ DeviceAuthorizationEndpointEnabled bool

+ DeviceVerificationURI string

+ IntrospectEndpointEnabled bool

+ Issuer string

+ Log Logger

+ TokenRevocationEnabled bool

type TokenResponse

+ IDToken string

+ type TokenRevocationFunc func(token, clientID string, tokenTypeHint ...string)

+ type VerifyDeviceCodeFunc func(deviceCode, clientID string) (value *DeviceCodeValue, err error)

+ type VerifyIntrospectionTokenFunc func(token, clientID string, tokenTypeHint ...string) (resp *IntrospectionResponse, err error)

May 14, 2020

Changes in this version

type Server

+ Issuer string

Apr 2, 2020

Changes in this version

+ var ErrGenerateAccessTokenFuncNil = errors.New("OAuth2 Server GenerateAccessTokenFunc Is Nil")

+ var ErrParseAccessTokenFuncNil = errors.New("OAuth2 Server ParseAccessTokenFunc Is Nil")

+ var ErrRefreshAccessTokenFuncNil = errors.New("OAuth2 Server ErrRefreshAccessTokenFuncNil Is Nil")

+ type GenerateAccessTokenFunc func(issuer, clientID, scope, openID string) (token *TokenResponse, err error)

+ func NewDefaultGenerateAccessToken(jwtVerifyKey []byte) GenerateAccessTokenFunc

+ type ParseAccessTokenFunc func(accessToken string) (claims *JwtClaims, err error)

+ func NewDefaultParseAccessToken(jwtVerifyKey []byte) ParseAccessTokenFunc

+ type RefreshAccessTokenFunc func(clientID, refreshToken string) (token *TokenResponse, err error)

+ func NewDefaultRefreshAccessToken(jwtVerifyKey []byte) RefreshAccessTokenFunc

type Server

+ GenerateAccessToken GenerateAccessTokenFunc

+ ParseAccessToken ParseAccessTokenFunc

+ RefreshAccessToken RefreshAccessTokenFunc

Apr 2, 2020

Changes in this version

+ func StringSplit(s, sep string) (results []string)

type CodeValue

+ func (code *CodeValue) MarshalBinary() ([]byte, error)

+ func (code *CodeValue) UnmarshalBinary(data []byte) error

Apr 2, 2020

Changes in this version

+ const ClientIDKey

+ const RedirectURIKey

+ var ErrContextNotFoundOpenID = errors.New("OAuth2上下文不存在OpenID")

+ var ErrInvalidRedirectURI = errors.New("invalid_redirect_uri")

+ var ErrVerifyRedirectURIFuncNil = errors.New("OAuth2 Server VerifyRedirectURI Is Nil")

+ var ErrVerifyScopeFuncNil = errors.New("OAuth2 Server VerifyScope Is Nil")

+ func NewOpenIDContext(ctx context.Context, openID string) context.Context

+ func OpenIDFromContext(ctx context.Context) (string, error)

type Client

+ ID string

+ ServerBaseURL string

type ClientBasic

+ func (client *ClientBasic) TokenVerifyKey() []byte

type CodeValue

+ OpenID string

+ RedirectURI string

type Server

+ VerifyRedirectURI VerifyRedirectURIFunc

+ VerifyScope VerifyScopeFunc

type TokenResponse

+ Data interface{}

+ type VerifyRedirectURIFunc func(clientID, redirectURI string) (err error)

+ type VerifyScopeFunc func(scope []string) (err error)

Aug 25, 2019

Changes in this version

+ const AccessTokenExpire

+ const AccessTokenKey

+ const AuthorizationCodeKey

+ const ClientCredentialsKey

+ const ClientIdKey

+ const ClientSecretKey

+ const CodeKey

+ const DefaultJwtIssuer

+ const ErrorKey

+ const GrantTypeKey

+ const PasswordKey

+ const RedirectUriKey

+ const RefreshTokenExpire

+ const RefreshTokenKey

+ const ResponseTypeKey

+ const ScopeKey

+ const ScopeRefreshToken

+ const StateKey

+ const TokenKey

+ const TokenTypeBearer

+ const TokenTypeKey

+ const UsernameKey

+ var ErrAccessDenied = errors.New("access_denied")

+ var ErrGenerateCodeFuncNil = errors.New("OAuth2 Server GenerateCode Is Nil")

+ var ErrInvalidAccessToken = errors.New("invalid_access_token")

+ var ErrInvalidClient = errors.New("invalid_client")

+ var ErrInvalidGrant = errors.New("invalid_grant")

+ var ErrInvalidRequest = errors.New("invalid_request")

+ var ErrInvalidScope = errors.New("invalid_scope")

+ var ErrMissingAccessToken = errors.New("missing access token")

+ var ErrRequestMethod = errors.New("incorrect request method")

+ var ErrServerError = errors.New("server_error")

+ var ErrStateValueDidNotMatch = errors.New("state value did not match")

+ var ErrStatusCodes = map[error]int

+ var ErrTemporarilyUnavailable = errors.New("temporarily_unavailable")

+ var ErrUnauthorizedClient = errors.New("unauthorized_client")

+ var ErrUnsupportedGrantType = errors.New("unsupported_grant_type")

+ var ErrUnsupportedResponseType = errors.New("unsupported_response_type")

+ var ErrVerifyAuthorizationFuncNil = errors.New("OAuth2 Server VerifyAuthorization Is Nil")

+ var ErrVerifyClientFuncNil = errors.New("OAuth2 Server VerifyClient Is Nil")

+ var ErrVerifyCodeFuncNil = errors.New("OAuth2 Server VerifyCode Is Nil")

+ var ErrVerifyCredentialsScopeFuncNil = errors.New("OAuth2 Server VerifyCredentialsScope Is Nil")

+ var ErrVerifyPasswordFuncNil = errors.New("OAuth2 Server VerifyPassword Is Nil")

+ var Errors = map[string]error

+ func CheckClientBasicMiddleware(next http.Handler, check VerifyClientFunc) http.Handler

+ func CloseCacheMiddleware(next http.Handler) http.Handler

+ func NewAccessToken(claims *JwtClaims, jwtVerifyKey []byte) (string, error)

+ func RandomCode() string

+ func RandomState() string

+ func RedirectError(w http.ResponseWriter, r *http.Request, redirectURI *url.URL, err error)

+ func RedirectSuccess(w http.ResponseWriter, r *http.Request, redirectURI *url.URL, code string)

+ func WriterError(w http.ResponseWriter, err error)

+ func WriterJSON(w http.ResponseWriter, value interface{})

+ type Client struct

+ AuthorizationEndpoint string

+ Id string

+ Log Logger

+ Secret string

+ ServerBaseUrl string

+ TokenEndpoint string

+ func NewClient(serverBaseUrl, id, secret string) *Client

+ func (c *Client) AuthorizeAuthorizationCode(w http.ResponseWriter, redirectUri, scope, state string) (err error)

+ func (c *Client) AuthorizeImplicit(w http.ResponseWriter, redirectUri, scope, state string) (err error)

+ func (c *Client) RefreshToken(refreshToken string) (model *TokenResponse, err error)

+ func (c *Client) TokenAuthorizationCode(code, redirectUri, state string) (token *TokenResponse, err error)

+ func (c *Client) TokenClientCredentials() (model *TokenResponse, err error)

+ func (c *Client) TokenResourceOwnerPasswordCredentials(username, password string) (model *TokenResponse, err error)

+ type ClientBasic struct

+ ID string

+ Secret string

+ func RequestClientBasic(r *http.Request) (basic *ClientBasic, err error)

+ func (client *ClientBasic) GenerateAccessToken(claims *JwtClaims) (token string, err error)

+ func (client *ClientBasic) GenerateRefreshToken(issuer, accessToken string) (token string, err error)

+ func (client *ClientBasic) ParseAccessToken(accessToken string) (claims *JwtClaims, err error)

+ type CodeValue struct

+ ClientID string

+ RedirectUri string

+ Scope []string

+ type DefaultLogger struct

+ func (*DefaultLogger) Debugf(format string, args ...interface{})

+ func (*DefaultLogger) Debugln(args ...interface{})

+ func (*DefaultLogger) Errorf(format string, args ...interface{})

+ func (*DefaultLogger) Errorln(args ...interface{})

+ type ErrorResponse struct

+ Error string

+ type GenerateCodeFunc func(clientID, redirectUri string, scope []string) (code string, err error)

+ type JwtClaims struct

+ Scope string

+ func NewJwtClaims() *JwtClaims

+ func ParseAccessToken(accessToken string, jwtVerifyKey []byte) (claims *JwtClaims, err error)

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Debugln func(args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Errorln func(args ...interface{})

+ type Server struct

+ GenerateCode GenerateCodeFunc

+ HandleAuthorize http.HandlerFunc

+ HandleToken http.HandlerFunc

+ JwtIssuer string

+ Log Logger

+ VerifyAuthorization VerifyAuthorizationFunc

+ VerifyClient VerifyClientFunc

+ VerifyCode VerifyCodeFunc

+ VerifyCredentialsScope VerifyCredentialsScopeFunc

+ VerifyPassword VerifyPasswordFunc

+ func NewServer() *Server

+ func (srv *Server) Init()

+ func (srv *Server) ServeHTTP(res http.ResponseWriter, req *http.Request)

+ type TokenResponse struct

+ AccessToken string

+ ExampleParameter interface{}

+ ExpiresIn int64

+ RefreshToken string

+ Scope string

+ TokenType string

+ type VerifyAuthorizationFunc func(clientID, redirectUri string, scope []string) (err error)

+ type VerifyClientFunc func(clientID string) (basic *ClientBasic, err error)

+ type VerifyCodeFunc func(code, clientID, redirectUri string) (value *CodeValue, err error)

+ type VerifyCredentialsScopeFunc func(clientID string, scope []string) (err error)

+ type VerifyPasswordFunc func(username, password string, scope []string) (err error)