oauth

Documentation

Index

• func NewClientTokenStore(database *db.Database, metrics *metrics.Metrics, logger *zap.Logger) oauth2.ClientStore
• func NewTokenStore(database *db.Database, metrics *metrics.Metrics, logger *zap.Logger) oauth2.TokenStore
• type ClientTokenStore
  • func (clientstore *ClientTokenStore) GetByID(ctx context.Context, id string) (oauth2.ClientInfo, error)
• type Config
• type Server
  • func New(config Config, db *db.Database, metrics *metrics.Metrics, logger *zap.Logger) *Server
  • func (oauth *Server) LoadAccessToken(ctx context.Context, accessToken string) (oauth2.TokenInfo, error)
  • func (oauth *Server) Start(applicationName string) error
• type TokenStore
  • func (tokenstore *TokenStore) Create(ctx context.Context, info oauth2.TokenInfo) (err error)
  • func (tokenstore *TokenStore) GetByAccess(ctx context.Context, access string) (oauth2.TokenInfo, error)
  • func (tokenstore *TokenStore) GetByCode(ctx context.Context, code string) (oauth2.TokenInfo, error)
  • func (tokenstore *TokenStore) GetByRefresh(ctx context.Context, refresh string) (oauth2.TokenInfo, error)
  • func (tokenstore *TokenStore) RemoveByAccess(ctx context.Context, access string) error
  • func (tokenstore *TokenStore) RemoveByCode(ctx context.Context, code string) (err error)
  • func (tokenstore *TokenStore) RemoveByRefresh(ctx context.Context, refresh string) error

Functions

func NewClientTokenStore

func NewClientTokenStore(database *db.Database, metrics *metrics.Metrics,
	logger *zap.Logger) oauth2.ClientStore

NewClientTokenStore creates client token store instance

func NewTokenStore

func NewTokenStore(database *db.Database, metrics *metrics.Metrics,
	logger *zap.Logger) oauth2.TokenStore

NewTokenStore creates token store instance

Types

type ClientTokenStore

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

ClientTokenStore is our interface to our OAuth token database.

func (*ClientTokenStore) GetByID

func (clientstore *ClientTokenStore) GetByID(ctx context.Context, id string) (oauth2.ClientInfo, error)

GetByID retrieves access token based upon tokenid (which is OAuth consumerkey)

type Config

type Config struct {
	Logger shared.Logger // log configuration of webadmin accesslog
	Listen string        // OAuth Address and port to listen
	TLS    struct {
		// contains filtered or unexported fields
	}
	TokenIssuePath string // Path to request access tokens (e.g. "/oauth2/token")
	TokenInfoPath  string // Path to request info about token (e.g. "/oauth2/info")
}

Config contains our configuration

type Server

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

Server is an oauth server instance

func New

func New(config Config, db *db.Database, metrics *metrics.Metrics,
	logger *zap.Logger) *Server

New returns a new oauth server instance

func (*Server) LoadAccessToken

func (oauth *Server) LoadAccessToken(ctx context.Context, accessToken string) (oauth2.TokenInfo, error)

LoadAccessToken returns the details of token

func (*Server) Start

func (oauth *Server) Start(applicationName string) error

Start starts OAuth2 public endpoints to request new access token or get info about an access info

type TokenStore

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

TokenStore holds our database config

func (*TokenStore) Create

func (tokenstore *TokenStore) Create(ctx context.Context, info oauth2.TokenInfo) (err error)

Create stores token in database

func (*TokenStore) GetByAccess

func (tokenstore *TokenStore) GetByAccess(ctx context.Context, access string) (oauth2.TokenInfo, error)

GetByAccess gets token by access name

func (*TokenStore) GetByCode

func (tokenstore *TokenStore) GetByCode(ctx context.Context, code string) (oauth2.TokenInfo, error)

GetByCode gets token by code name

func (*TokenStore) GetByRefresh

func (tokenstore *TokenStore) GetByRefresh(ctx context.Context, refresh string) (oauth2.TokenInfo, error)

GetByRefresh gets token by refresh name

func (*TokenStore) RemoveByAccess

func (tokenstore *TokenStore) RemoveByAccess(ctx context.Context, access string) error

RemoveByAccess removes token from database

func (*TokenStore) RemoveByCode

func (tokenstore *TokenStore) RemoveByCode(ctx context.Context, code string) (err error)

RemoveByCode removes token from database

func (*TokenStore) RemoveByRefresh

func (tokenstore *TokenStore) RemoveByRefresh(ctx context.Context, refresh string) error

RemoveByRefresh removes token from database