oauth2

Documentation

Index

• func Auth(provider string, request *http.Request, response http.ResponseWriter) error
• func ClearProviders()
• func GetDefaultAuthURL(provider string) string
• func GetDefaultEmailURL(provider string) string
• func GetDefaultProfileURL(provider string) string
• func GetDefaultTokenURL(provider string) string
• func Init(x *xorm.Engine) error
• func InitSigningKey() error
• func ProviderCallback(provider string, request *http.Request, response http.ResponseWriter) (goth.User, error)
• func RegisterProvider(providerName, providerType, clientID, clientSecret, ... string, ...) error
• func RemoveProvider(providerName string)
• type CustomURLMapping
• type ErrInvalidAlgorithmType
  • func (err ErrInvalidAlgorithmType) Error() string
• type JWTSigningKey
  • func CreateJWTSingingKey(algorithm string, key interface{}) (JWTSigningKey, error)

Functions

func Auth

func Auth(provider string, request *http.Request, response http.ResponseWriter) error

Auth OAuth2 auth service

func ClearProviders

func ClearProviders()

ClearProviders clears all OAuth2 providers from the goth lib

func GetDefaultAuthURL

func GetDefaultAuthURL(provider string) string

GetDefaultAuthURL return the default authorize url for the given provider

func GetDefaultEmailURL

func GetDefaultEmailURL(provider string) string

GetDefaultEmailURL return the default email url for the given provider

func GetDefaultProfileURL

func GetDefaultProfileURL(provider string) string

GetDefaultProfileURL return the default profile url for the given provider

func GetDefaultTokenURL

func GetDefaultTokenURL(provider string) string

GetDefaultTokenURL return the default token url for the given provider

func Init

func Init(x *xorm.Engine) error

Init initialize the setup of the OAuth2 library

func InitSigningKey

func InitSigningKey() error

InitSigningKey creates the default signing key from settings or creates a random key.

func ProviderCallback

func ProviderCallback(provider string, request *http.Request, response http.ResponseWriter) (goth.User, error)

ProviderCallback handles OAuth callback, resolve to a goth user and send back to original url this will trigger a new authentication request, but because we save it in the session we can use that

func RegisterProvider

func RegisterProvider(providerName, providerType, clientID, clientSecret, openIDConnectAutoDiscoveryURL string, customURLMapping *CustomURLMapping) error

RegisterProvider register a OAuth2 provider in goth lib

func RemoveProvider

func RemoveProvider(providerName string)

RemoveProvider removes the given OAuth2 provider from the goth lib

Types

type CustomURLMapping

type CustomURLMapping struct {
	AuthURL    string
	TokenURL   string
	ProfileURL string
	EmailURL   string
}

CustomURLMapping describes the urls values to use when customizing OAuth2 provider URLs

type ErrInvalidAlgorithmType

type ErrInvalidAlgorithmType struct {
	Algorightm string
}

ErrInvalidAlgorithmType represents an invalid algorithm error.

func (ErrInvalidAlgorithmType) Error

func (err ErrInvalidAlgorithmType) Error() string

type JWTSigningKey

type JWTSigningKey interface {
	IsSymmetric() bool
	SigningMethod() jwt.SigningMethod
	SignKey() interface{}
	VerifyKey() interface{}
	ToJWK() (map[string]string, error)
	PreProcessToken(*jwt.Token)
}

JWTSigningKey represents a algorithm/key pair to sign JWTs

var DefaultSigningKey JWTSigningKey

DefaultSigningKey is the default signing key for JWTs.

func CreateJWTSingingKey

func CreateJWTSingingKey(algorithm string, key interface{}) (JWTSigningKey, error)

CreateJWTSingingKey creates a signing key from an algorithm / key pair.