README
¶
Mongo Storage for OAuth 2.0
Install
go get -u -v github.com/shkmv/go-oauth2-mongo-storage
Usage
package main
import (
mongo "github.com/shkmv/go-oauth2-mongo-storage"
"github.com/go-oauth2/oauth2/v4/manage"
)
func main() {
manager := manage.NewDefaultManager()
// use mongodb token store
manager.MapTokenStorage(
mongo.NewTokenStore(mongo.NewConfig(
"mongodb://127.0.0.1:27017",
"oauth2",
)),
)
// ...
}
MIT License
Copyright (c) 2016 Lyric
Documentation
¶
Index ¶
- type ClientConfig
- type ClientStore
- type Config
- type TokenConfig
- type TokenStore
- func (ts *TokenStore) Close()
- func (ts *TokenStore) Create(ctx context.Context, info oauth2.TokenInfo) (err error)
- func (ts *TokenStore) GetByAccess(ctx context.Context, access string) (ti oauth2.TokenInfo, err error)
- func (ts *TokenStore) GetByCode(ctx context.Context, code string) (ti oauth2.TokenInfo, err error)
- func (ts *TokenStore) GetByRefresh(ctx context.Context, refresh string) (ti oauth2.TokenInfo, err error)
- func (ts *TokenStore) RemoveByAccess(ctx context.Context, access string) (err error)
- func (ts *TokenStore) RemoveByCode(ctx context.Context, code string) (err error)
- func (ts *TokenStore) RemoveByRefresh(ctx context.Context, refresh string) (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientConfig ¶
type ClientConfig struct {
// store clients data collection name(The default is oauth2_clients)
ClientsCName string
}
ClientConfig client configuration parameters
func NewDefaultClientConfig ¶
func NewDefaultClientConfig() *ClientConfig
NewDefaultClientConfig create a default client configuration
type ClientStore ¶
type ClientStore struct {
// contains filtered or unexported fields
}
ClientStore MongoDB storage for OAuth 2.0
func NewClientStore ¶
func NewClientStore(cfg *Config, ccfgs ...*ClientConfig) *ClientStore
NewClientStore create a client store instance based on mongodb
func NewClientStoreWithSession ¶
func NewClientStoreWithSession(session *mgo.Session, dbName string, ccfgs ...*ClientConfig) *ClientStore
NewClientStoreWithSession create a client store instance based on mongodb
func (*ClientStore) GetByID ¶
func (cs *ClientStore) GetByID(ctx context.Context, id string) (info oauth2.ClientInfo, err error)
GetByID according to the ID for the client information
func (*ClientStore) RemoveByID ¶
func (cs *ClientStore) RemoveByID(ctx context.Context, id string) (err error)
RemoveByID use the client id to delete the client information
func (*ClientStore) Set ¶
func (cs *ClientStore) Set(info oauth2.ClientInfo) (err error)
Set set client information
type TokenConfig ¶
type TokenConfig struct {
// store txn collection name(The default is oauth2)
TxnCName string
// store token based data collection name(The default is oauth2_basic)
BasicCName string
// store access token data collection name(The default is oauth2_access)
AccessCName string
// store refresh token data collection name(The default is oauth2_refresh)
RefreshCName string
}
TokenConfig token configuration parameters
func NewDefaultTokenConfig ¶
func NewDefaultTokenConfig() *TokenConfig
NewDefaultTokenConfig create a default token configuration
type TokenStore ¶
type TokenStore struct {
// contains filtered or unexported fields
}
TokenStore MongoDB storage for OAuth 2.0
func NewTokenStore ¶
func NewTokenStore(cfg *Config, tcfgs ...*TokenConfig) (store *TokenStore)
NewTokenStore create a token store instance based on mongodb
func NewTokenStoreWithSession ¶
func NewTokenStoreWithSession(session *mgo.Session, dbName string, tcfgs ...*TokenConfig) (store *TokenStore)
NewTokenStoreWithSession create a token store instance based on mongodb
func (*TokenStore) Create ¶
func (ts *TokenStore) Create(ctx context.Context, info oauth2.TokenInfo) (err error)
Create create and store the new token information
func (*TokenStore) GetByAccess ¶
func (ts *TokenStore) GetByAccess(ctx context.Context, access string) (ti oauth2.TokenInfo, err error)
GetByAccess use the access token for token information data
func (*TokenStore) GetByCode ¶
func (ts *TokenStore) GetByCode(ctx context.Context, code string) (ti oauth2.TokenInfo, err error)
GetByCode use the authorization code for token information data
func (*TokenStore) GetByRefresh ¶
func (ts *TokenStore) GetByRefresh(ctx context.Context, refresh string) (ti oauth2.TokenInfo, err error)
GetByRefresh use the refresh token for token information data
func (*TokenStore) RemoveByAccess ¶
func (ts *TokenStore) RemoveByAccess(ctx context.Context, access string) (err error)
RemoveByAccess use the access token to delete the token information
func (*TokenStore) RemoveByCode ¶
func (ts *TokenStore) RemoveByCode(ctx context.Context, code string) (err error)
RemoveByCode use the authorization code to delete the token information
func (*TokenStore) RemoveByRefresh ¶
func (ts *TokenStore) RemoveByRefresh(ctx context.Context, refresh string) (err error)
RemoveByRefresh use the refresh token to delete the token information
Source Files