Documentation
¶
Index ¶
- Variables
- type Client
- type ClientImpl
- func (c *ClientImpl) GenerateAuthorizationURL(redirectURI string, permissions discord.Permissions, ...) string
- func (c *ClientImpl) GenerateAuthorizationURLState(redirectURI string, permissions discord.Permissions, ...) (string, string)
- func (c *ClientImpl) GetConnections(session Session, opts ...rest.RequestOpt) ([]discord.Connection, error)
- func (c *ClientImpl) GetGuilds(session Session, opts ...rest.RequestOpt) ([]discord.OAuth2Guild, error)
- func (c *ClientImpl) GetUser(session Session, opts ...rest.RequestOpt) (*discord.OAuth2User, error)
- func (c *ClientImpl) ID() snowflake.Snowflake
- func (c *ClientImpl) RefreshSession(identifier string, session Session, opts ...rest.RequestOpt) (Session, error)
- func (c *ClientImpl) Rest() rest.OAuth2
- func (c *ClientImpl) Secret() string
- func (c *ClientImpl) SessionController() SessionController
- func (c *ClientImpl) StartSession(code string, state string, identifier string, opts ...rest.RequestOpt) (Session, error)
- func (c *ClientImpl) StateController() StateController
- type Config
- type ConfigOpt
- func WithLogger(logger log.Logger) ConfigOpt
- func WithOAuth2(oauth2 rest.OAuth2) ConfigOpt
- func WithRestClient(restClient rest.Client) ConfigOpt
- func WithRestClientConfigOpts(opts ...rest.ConfigOpt) ConfigOpt
- func WithSessionController(sessionController SessionController) ConfigOpt
- func WithStateController(stateController StateController) ConfigOpt
- func WithStateControllerOpts(opts ...StateControllerConfigOpt) ConfigOpt
- type Session
- type SessionController
- type StateController
- type StateControllerConfig
- type StateControllerConfigOpt
- type TTLMap
Constants ¶
This section is empty.
Variables ¶
var ( ErrStateNotFound = errors.New("state could not be found") ErrAccessTokenExpired = errors.New("access token expired. refresh the session") ErrMissingOAuth2Scope = func(scope discord.ApplicationScope) error { return fmt.Errorf("missing '%s' scope", scope) } )
errors returned by the OAuth2 client
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
// ID returns the configured client ID
ID() snowflake.Snowflake
// Secret returns the configured client secret
Secret() string
// Rest returns the underlying rest.OAuth2
Rest() rest.OAuth2
// SessionController returns the configured SessionController
SessionController() SessionController
// StateController returns the configured StateController
StateController() StateController
// GenerateAuthorizationURL generates an authorization URL with the given redirect URI, permissions, guildID, disableGuildSelect & scopes. State is automatically generated
GenerateAuthorizationURL(redirectURI string, permissions discord.Permissions, guildID snowflake.Snowflake, disableGuildSelect bool, scopes ...discord.ApplicationScope) string
// GenerateAuthorizationURLState generates an authorization URL with the given redirect URI, permissions, guildID, disableGuildSelect & scopes. State is automatically generated & returned
GenerateAuthorizationURLState(redirectURI string, permissions discord.Permissions, guildID snowflake.Snowflake, disableGuildSelect bool, scopes ...discord.ApplicationScope) (string, string)
// StartSession starts a new Session with the given authorization code & state
StartSession(code string, state string, identifier string, opts ...rest.RequestOpt) (Session, error)
// RefreshSession refreshes the given Session with the refresh token
RefreshSession(identifier string, session Session, opts ...rest.RequestOpt) (Session, error)
// GetUser returns the discord.OAuth2User associated with the given Session. Fields filled in the struct depend on the Session.Scopes
GetUser(session Session, opts ...rest.RequestOpt) (*discord.OAuth2User, error)
// GetGuilds returns the discord.OAuth2Guild(s) the user is a member of. This requires the discord.ApplicationScopeGuilds scope in the Session
GetGuilds(session Session, opts ...rest.RequestOpt) ([]discord.OAuth2Guild, error)
// GetConnections returns the discord.Connection(s) the user has connected. This requires the discord.ApplicationScopeConnections scope in the Session
GetConnections(session Session, opts ...rest.RequestOpt) ([]discord.Connection, error)
}
type ClientImpl ¶
type ClientImpl struct {
// contains filtered or unexported fields
}
ClientImpl is an OAuth2 client
func (*ClientImpl) GenerateAuthorizationURL ¶
func (c *ClientImpl) GenerateAuthorizationURL(redirectURI string, permissions discord.Permissions, guildID snowflake.Snowflake, disableGuildSelect bool, scopes ...discord.ApplicationScope) string
GenerateAuthorizationURL generates an authorization URL with the given redirect URI, permissions, guildID, disableGuildSelect & scopes, state is automatically generated
func (*ClientImpl) GenerateAuthorizationURLState ¶
func (c *ClientImpl) GenerateAuthorizationURLState(redirectURI string, permissions discord.Permissions, guildID snowflake.Snowflake, disableGuildSelect bool, scopes ...discord.ApplicationScope) (string, string)
GenerateAuthorizationURLState generates an authorization URL with the given redirect URI, permissions, guildID, disableGuildSelect & scopes, state is automatically generated & returned
func (*ClientImpl) GetConnections ¶
func (c *ClientImpl) GetConnections(session Session, opts ...rest.RequestOpt) ([]discord.Connection, error)
GetConnections returns the discord.Connection(s) the user has connected. This requires the discord.ApplicationScopeConnections scope in the session
func (*ClientImpl) GetGuilds ¶
func (c *ClientImpl) GetGuilds(session Session, opts ...rest.RequestOpt) ([]discord.OAuth2Guild, error)
GetGuilds returns the discord.OAuth2Guild(s) the user is a member of. This requires the discord.ApplicationScopeGuilds scope in the session
func (*ClientImpl) GetUser ¶
func (c *ClientImpl) GetUser(session Session, opts ...rest.RequestOpt) (*discord.OAuth2User, error)
GetUser returns the discord.OAuth2User associated with the given session. Fields filled in the struct depend on the Session.Scopes
func (*ClientImpl) ID ¶
func (c *ClientImpl) ID() snowflake.Snowflake
ID returns the configured client ID
func (*ClientImpl) RefreshSession ¶
func (c *ClientImpl) RefreshSession(identifier string, session Session, opts ...rest.RequestOpt) (Session, error)
RefreshSession refreshes the given session with the refresh token
func (*ClientImpl) Rest ¶
func (c *ClientImpl) Rest() rest.OAuth2
Rest returns the underlying rest.OAuth2
func (*ClientImpl) Secret ¶
func (c *ClientImpl) Secret() string
Secret returns the configured client secret
func (*ClientImpl) SessionController ¶
func (c *ClientImpl) SessionController() SessionController
SessionController returns the configured SessionController
func (*ClientImpl) StartSession ¶
func (c *ClientImpl) StartSession(code string, state string, identifier string, opts ...rest.RequestOpt) (Session, error)
StartSession starts a new session with the given authorization code & state
func (*ClientImpl) StateController ¶
func (c *ClientImpl) StateController() StateController
StateController returns the configured StateController
type Config ¶
type Config struct {
Logger log.Logger
RestClient rest.Client
RestClientConfigOpts []rest.ConfigOpt
OAuth2 rest.OAuth2
SessionController SessionController
StateController StateController
StateControllerConfigOpts []StateControllerConfigOpt
}
Config is the configuration for the OAuth2 client
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig is the configuration which is used by default
type ConfigOpt ¶
type ConfigOpt func(config *Config)
ConfigOpt can be used to supply optional parameters to New
func WithLogger ¶
WithLogger applies a custom logger to the OAuth2 client
func WithOAuth2 ¶
WithOAuth2 applies a custom rest.OAuth2 to the OAuth2 client
func WithRestClient ¶
WithRestClient applies a custom rest.Client to the OAuth2 client
func WithRestClientConfigOpts ¶
WithRestClientConfigOpts applies rest.ConfigOpt for the rest.Client to the OAuth2 client
func WithSessionController ¶
func WithSessionController(sessionController SessionController) ConfigOpt
WithSessionController applies a custom SessionController to the OAuth2 client
func WithStateController ¶
func WithStateController(stateController StateController) ConfigOpt
WithStateController applies a custom StateController to the OAuth2 client
func WithStateControllerOpts ¶
func WithStateControllerOpts(opts ...StateControllerConfigOpt) ConfigOpt
WithStateControllerOpts applies all StateControllerConfigOpt(s) to the StateController
type Session ¶
type Session interface {
// AccessToken allows requesting user information
AccessToken() string
// RefreshToken allows refreshing the AccessToken
RefreshToken() string
// Scopes returns the discord.ApplicationScope(s) of the Session
Scopes() []discord.ApplicationScope
// TokenType returns the discord.TokenType of the AccessToken
TokenType() discord.TokenType
// Expiration returns the time.Time when the AccessToken expires and needs to be refreshed
Expiration() time.Time
// Webhook returns the discord.IncomingWebhook when the discord.ApplicationScopeWebhookIncoming is set
Webhook() *discord.IncomingWebhook
}
Session represents a discord access token response (https://discord.com/developers/docs/topics/oauth2#authorization-code-grant-access-token-response)
type SessionController ¶
type SessionController interface {
// GetSession returns the Session for the given identifier or nil if none was found
GetSession(identifier string) Session
// CreateSession creates a new Session from the given identifier, access token, refresh token, scope, token type, expiration and webhook
CreateSession(identifier string, accessToken string, refreshToken string, scopes []discord.ApplicationScope, tokenType discord.TokenType, expiration time.Time, webhook *discord.IncomingWebhook) Session
// CreateSessionFromExchange creates a new Session from the given identifier and discord.AccessTokenExchange payload
CreateSessionFromExchange(identifier string, exchange discord.AccessTokenExchange) Session
}
SessionController lets you manage your Session(s)
func NewSessionController ¶
func NewSessionController() SessionController
NewSessionController returns a new empty SessionController
func NewSessionControllerWithSessions ¶
func NewSessionControllerWithSessions(sessions map[string]Session) SessionController
NewSessionControllerWithSessions returns a new SessionController with the given Session(s)
type StateController ¶
type StateController interface {
// GenerateNewState generates a new random state to be used as a state
GenerateNewState(redirectURI string) string
// ConsumeState validates a state and returns the redirect url or nil if it is invalid
ConsumeState(state string) string
}
StateController is responsible for generating, storing and validating states
func NewStateController ¶
func NewStateController(opts ...StateControllerConfigOpt) StateController
NewStateController returns a new empty StateController
type StateControllerConfig ¶
type StateControllerConfig struct {
States map[string]string
NewStateFunc func() string
MaxTTL time.Duration
}
StateControllerConfig is the configuration for the StateController
func DefaultStateControllerConfig ¶
func DefaultStateControllerConfig() *StateControllerConfig
DefaultStateControllerConfig is the default configuration for the StateController
func (*StateControllerConfig) Apply ¶
func (c *StateControllerConfig) Apply(opts []StateControllerConfigOpt)
Apply applies the given StateControllerConfigOpt(s) to the StateControllerConfig
type StateControllerConfigOpt ¶
type StateControllerConfigOpt func(config *StateControllerConfig)
StateControllerConfigOpt is used to pass optional parameters to NewStateController
func WithMaxTTL ¶
func WithMaxTTL(maxTTL time.Duration) StateControllerConfigOpt
WithMaxTTL sets the maximum time to live for a state
func WithNewStateFunc ¶
func WithNewStateFunc(newStateFunc func() string) StateControllerConfigOpt
WithNewStateFunc sets the function which is used to generate a new random state
func WithStates ¶
func WithStates(states map[string]string) StateControllerConfigOpt
WithStates loads states from an existing map