sociable

package module

Go to main page

Versions in this module

v0

v0.5.0

Sep 18, 2026

Changes in this version

+ func WithClient(client *http.Client) option

type DriverContract

+ AuthURL func(w http.ResponseWriter, r *http.Request) (string, error)

v0.4.0

Sep 18, 2026

Changes in this version

+ var ErrDriverNotConfigured = errors.New("sociable: driver not configured")

+ var ErrMissingKeyOrSession = errors.New("sociable: a Key or a Session is required")

+ var ErrSessionSealed = errors.New("sociable: the cookie cannot be opened")

+ func WithAPIURL(url string) option

+ func WithDriver[T Provider](name string, credentials Credentials) option

+ func WithKey(key string) option

+ func WithSession(session Session) option

+ type BitbucketProvider struct

+ func (self BitbucketProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self BitbucketProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self BitbucketProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self BitbucketProvider) Scoping() Scoping

type Credentials

+ BaseURL string

+ RedirectURL string

+ type DriverContract interface

+ Callback func(w http.ResponseWriter, r *http.Request) (*oauth2.Token, error)

+ Redirect func(w http.ResponseWriter, r *http.Request) error

+ RedirectURL func(url string) DriverContract

+ RefreshToken func(ctx context.Context, refreshToken string) (*oauth2.Token, error)

+ Scopes func(scopes ...string) DriverContract

+ SetScopes func(scopes ...string) DriverContract

+ Stateless func() DriverContract

+ User func(w http.ResponseWriter, r *http.Request) (*User, error)

+ UserFromToken func(ctx context.Context, token *oauth2.Token) (*User, error)

+ With func(params map[string]string) DriverContract

+ type FacebookProvider struct

+ func (self FacebookProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self FacebookProvider) GetUserByToken(ctx context.Context, client *http.Client, token *oauth2.Token, ...) (*fastjson.Value, error)

+ func (self FacebookProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self FacebookProvider) Scoping() Scoping

+ type GitHubProvider struct

+ func (self GitHubProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self GitHubProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self GitHubProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self GitHubProvider) Scoping() Scoping

+ type GitLabProvider struct

+ func (self GitLabProvider) Endpoint(credentials Credentials) oauth2.Endpoint

+ func (self GitLabProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, ...) (*fastjson.Value, error)

+ func (self GitLabProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self GitLabProvider) Scoping() Scoping

+ type GoogleProvider struct

+ func (self GoogleProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self GoogleProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self GoogleProvider) Issuer() string

+ func (self GoogleProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self GoogleProvider) Scoping() Scoping

+ type LinkedInProvider struct

+ func (self LinkedInProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self LinkedInProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self LinkedInProvider) Issuer() string

+ func (self LinkedInProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self LinkedInProvider) Scoping() Scoping

type Manager

+ func (self *Manager) Configure(options ...option)

type Provider

+ Endpoint func(credentials Credentials) oauth2.Endpoint

+ GetUserByToken func(ctx context.Context, client *http.Client, token *oauth2.Token, ...) (*fastjson.Value, error)

+ MapUserToStruct func(json *fastjson.Value) (*User, error)

+ Scoping func() Scoping

+ type Scoping struct

+ Scopes []string

+ Separator string

+ type SlackProvider struct

+ func (self SlackProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self SlackProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self SlackProvider) Issuer() string

+ func (self SlackProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self SlackProvider) Scoping() Scoping

+ type TwitchProvider struct

+ func (self TwitchProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self TwitchProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, ...) (*fastjson.Value, error)

+ func (self TwitchProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self TwitchProvider) Scoping() Scoping

+ type XProvider struct

+ func (self XProvider) Endpoint(Credentials) oauth2.Endpoint

+ func (self XProvider) GetUserByToken(ctx context.Context, client *http.Client, _ *oauth2.Token, _ Credentials) (*fastjson.Value, error)

+ func (self XProvider) MapUserToStruct(json *fastjson.Value) (*User, error)

+ func (self XProvider) Scoping() Scoping

v0.3.0

Sep 17, 2026

Changes in this version

+ var ErrAccessDenied = fmt.Errorf("%w: access denied", ErrAuthorization)

+ var ErrAuthorization = errors.New("sociable: the provider refused")

+ var ErrExchange = errors.New("sociable: token exchange failed")

+ var ErrIDToken = errors.New("sociable: the id token could not be verified")

+ var ErrInvalidState = errors.New("sociable: invalid state")

+ var ErrNoKey = errors.New("sociable: a Key or a Session is required")

+ var ErrNotConfigured = errors.New("sociable: driver not configured")

+ var ErrProfile = errors.New("sociable: could not read the profile")

+ var ErrSealed = errors.New("sociable: the cookie cannot be opened")

+ var ErrUnknownDriver = errors.New("sociable: unknown driver")

+ func Bool(raw map[string]any, path string) bool

+ func Configure(config Config)

+ func Extend(name string, factory Factory)

+ func GetJSON(ctx context.Context, client *http.Client, url string, into any) error

+ func String(raw map[string]any, path string) string

+ type Authenticator interface

+ Callback func(r *http.Request) (*User, error)

+ type AuthorizationError struct

+ Code string

+ Description string

+ URI string

+ func (self *AuthorizationError) Error() string

+ func (self *AuthorizationError) Is(target error) bool

+ type Config struct

+ Client *http.Client

+ Drivers Drivers

+ Key string

+ Session Session

+ URL string

+ type Credentials struct

+ ClientID string

+ ClientSecret string

+ Redirect string

+ Scopes []string

+ type Drivers map[string]Credentials

+ type Factory func(credentials Credentials) Provider

+ type Faked struct

+ func Fake(name string, user User) *Faked

+ func (self *Faked) AssertNotRedirected(t testing.TB, conditions ...func(Redirect) bool)

+ func (self *Faked) AssertRedirected(t testing.TB, conditions ...func(Redirect) bool)

+ func (self *Faked) AssertRedirectedCount(t testing.TB, count int)

+ func (self *Faked) Redirects() []Redirect

+ func (self *Faked) Restore()

+ type Flow struct

+ func Driver(name string) Flow

+ func (self Flow) AuthURL(w http.ResponseWriter, r *http.Request) (string, error)

+ func (self Flow) Client(ctx context.Context, token *oauth2.Token) *http.Client

+ func (self Flow) Redirect(w http.ResponseWriter, r *http.Request) error

+ func (self Flow) RedirectURL(url string) Flow

+ func (self Flow) RefreshToken(ctx context.Context, refreshToken string) (*oauth2.Token, error)

+ func (self Flow) Scopes(scopes ...string) Flow

+ func (self Flow) SetScopes(scopes ...string) Flow

+ func (self Flow) Stateless() Flow

+ func (self Flow) User(w http.ResponseWriter, r *http.Request) (*User, error)

+ func (self Flow) UserFromToken(ctx context.Context, token *oauth2.Token) (*User, error)

+ func (self Flow) With(params map[string]string) Flow

+ func (self Flow) WithState(state map[string]string) Flow

+ type Manager struct

+ func New(config Config) (*Manager, error)

+ func (self *Manager) Driver(name string) Flow

+ func (self *Manager) Extend(name string, factory Factory)

+ func (self *Manager) Fake(name string, user User) *Faked

+ type OAuth2 struct

+ Credentials Credentials

+ Endpoint oauth2.Endpoint

+ Map func(raw map[string]any) User

+ ProfileURL string

+ Scopes []string

+ WithoutPKCE bool

+ func (self OAuth2) Config() *oauth2.Config

+ func (self OAuth2) User(ctx context.Context, client *http.Client, _ *oauth2.Token) (*User, error)

+ func (self OAuth2) UsesPKCE() bool

+ type Provider interface

+ Config func() *oauth2.Config

+ User func(ctx context.Context, client *http.Client, token *oauth2.Token) (*User, error)

+ func Bitbucket(credentials Credentials) Provider

+ func Facebook(credentials Credentials) Provider

+ func GitHub(credentials Credentials) Provider

+ func GitLab(credentials Credentials) Provider

+ func Google(credentials Credentials) Provider

+ func LinkedIn(credentials Credentials) Provider

+ func OpenID(credentials Credentials, issuer string) Provider

+ func Slack(credentials Credentials) Provider

+ func Twitch(credentials Credentials) Provider

+ func X(credentials Credentials) Provider

+ type Redirect struct

+ Params map[string]string

+ RedirectURL string

+ Scopes []string

+ State map[string]string

+ type Redirector interface

+ Redirect func(w http.ResponseWriter, r *http.Request, callback, state string) error

+ type Session interface

+ Pull func(w http.ResponseWriter, r *http.Request, key string) (string, error)

+ Put func(w http.ResponseWriter, r *http.Request, key, value string) error

+ type Unprotected interface

+ UsesPKCE func() bool

+ type User struct

+ ApprovedScopes []string

+ Avatar string

+ Email string

+ EmailVerified bool

+ ID string

+ Name string

+ Nickname string

+ Raw map[string]any

+ State map[string]string

+ Token *oauth2.Token

+ func Claims(claims map[string]any) User

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