oauth

Documentation

Index

• Constants
• type AuthorizedClient
• type GithubValidator
  • func NewGithubValidator(client *http.Client, clientID, clientSecret string, scopes []string) *GithubValidator
  • func (v GithubValidator) GetEndpoint() oauth2.Endpoint
  • func (v GithubValidator) Validate(accessToken string) error
• type GithubValidatorRequest
• type GithubValidatorResponse
• type Provider
  • func NewProvider(clientID, clientSecret string, scopes []string) Provider
  • func (p Provider) AddValidator(providerType ProviderType, validator Validator)
  • func (p Provider) AuthenticateUser(providerType ProviderType) (client *AuthorizedClient, err error)
  • func (p Provider) CallbackHandler(ctx context.Context, clientChan chan *AuthorizedClient, ...) func(w http.ResponseWriter, r *http.Request)
  • func (p Provider) ErrorHandler() func(w http.ResponseWriter, r *http.Request)
  • func (p Provider) GetValidator(providerType ProviderType) (Validator, error)
  • func (p Provider) ValidateAccessToken(providerType ProviderType, accessToken string) error
  • func (p Provider) ValidateToken(providerType ProviderType, token *oauth2.Token) (*oauth2.Token, error)
• type ProviderType
• type Validator

Constants

const (

	// AuthorizationPrefix is authorization prefix
	AuthorizationPrefix = "Bearer"
)

Types

type AuthorizedClient

type AuthorizedClient struct {
	Client *http.Client
	Token  *oauth2.Token
}

AuthorizedClient is authorized client and token

type GithubValidator

type GithubValidator struct {
	// contains filtered or unexported fields
}

GithubValidator is github oauth validator

func NewGithubValidator

func NewGithubValidator(client *http.Client, clientID, clientSecret string, scopes []string) *GithubValidator

NewGithubValidator creates new github validator

func (GithubValidator) GetEndpoint

func (v GithubValidator) GetEndpoint() oauth2.Endpoint

GetEndpoint returns endpoint

func (GithubValidator) Validate

func (v GithubValidator) Validate(accessToken string) error

Validate validates oauth token

type GithubValidatorRequest

type GithubValidatorRequest struct {
	AccessToken string `json:"access_token"`
}

GithubValidatorRequest contains github validation request

type GithubValidatorResponse

type GithubValidatorResponse struct {
	ExpiresAt *time.Time `json:"expires_at"`
	Scopes    []string   `json:"scopes"`
}

GithubValidatorResponse contains github validation response

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider contains oauth provider config

func NewProvider

func NewProvider(clientID, clientSecret string, scopes []string) Provider

NewProvider returns new provider

func (Provider) AddValidator

func (p Provider) AddValidator(providerType ProviderType, validator Validator)

AddValidator adds validator

func (Provider) AuthenticateUser

func (p Provider) AuthenticateUser(providerType ProviderType) (client *AuthorizedClient, err error)

AuthenticateUser starts the login process

func (Provider) CallbackHandler

func (p Provider) CallbackHandler(ctx context.Context, clientChan chan *AuthorizedClient,
	providerType ProviderType) func(w http.ResponseWriter, r *http.Request)

CallbackHandler is oauth callback handler

func (Provider) ErrorHandler

func (p Provider) ErrorHandler() func(w http.ResponseWriter, r *http.Request)

ErrorHandler is oauth error handler

func (Provider) GetValidator

func (p Provider) GetValidator(providerType ProviderType) (Validator, error)

GetValidator returns validator

func (Provider) ValidateAccessToken

func (p Provider) ValidateAccessToken(providerType ProviderType, accessToken string) error

ValidateAccessToken validates access token

func (Provider) ValidateToken

func (p Provider) ValidateToken(providerType ProviderType, token *oauth2.Token) (*oauth2.Token, error)

ValidateToken validates token

type ProviderType

type ProviderType string

ProviderType is provider type

const (
	// GithubProviderType is github provider type
	GithubProviderType ProviderType = "github"
)

type Validator

type Validator interface {
	// Validate validates oauth token
	Validate(accessToken string) error
	// GetEndpoint returns oauth endpoint
	GetEndpoint() oauth2.Endpoint
}

Validator describes ouath validation methods