README
¶
go-oauth2-mysql
MySQL storage for OAuth 2.0 Provides both client and token store.
Install
$ go get -u -v github.com/vnzernov/go-oauth2-mysql
Usage
package main
import (
"github.com/vnzernov/go-oauth2-mysql"
"gopkg.in/oauth2.v3/manage"
_ "github.com/go-sql-driver/mysql"
)
func main() {
manager := manage.NewDefaultManager()
dsn := "root:123456@tcp(127.0.0.1:3306)/myapp_test?charset=utf8"
// use mysql token store
store := mysql.NewDefaultStore(
mysql.NewConfig(dsn),
)
defer store.Close()
// use mysql client store
clientStore := mysql.NewClientDefaultStore(
mysql.NewConfig(dsn),
)
defer clientStore.Close()
clientStore.Set(&models.Client{
ID: "000000",
Secret: "999999",
Domain: "http://localhost",
})
manager.MapTokenStorage(store)
manager.MapClientStorage(clientStore)
// ...
}
Credits
Based on https://github.com/go-oauth2/mysql/
MIT License
Documentation
¶
Index ¶
- type ClientStore
- type ClientStoreItem
- type Config
- type Store
- func (s *Store) Close()
- func (s *Store) Create(info oauth2.TokenInfo) error
- func (s *Store) GetByAccess(access string) (oauth2.TokenInfo, error)
- func (s *Store) GetByCode(code string) (oauth2.TokenInfo, error)
- func (s *Store) GetByRefresh(refresh string) (oauth2.TokenInfo, error)
- func (s *Store) RemoveByAccess(access string) error
- func (s *Store) RemoveByCode(code string) error
- func (s *Store) RemoveByRefresh(refresh string) error
- func (s *Store) SetStdout(stdout io.Writer) *Store
- type StoreItem
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ClientStore ¶
type ClientStore struct {
// contains filtered or unexported fields
}
ClientStore mysql client store
func NewClientDefaultStore ¶
func NewClientDefaultStore(config *Config) *ClientStore
NewClientDefaultStore create mysql store instance
func NewClientStore ¶
func NewClientStore(config *Config, tableName string, gcInterval int) *ClientStore
NewClientStore create mysql store instance, config mysql configuration, tableName table name (default oauth2_client), GC time interval (in seconds, default 600)
func NewClientStoreWithDB ¶
func NewClientStoreWithDB(db *sql.DB, tableName string, gcInterval int) *ClientStore
NewClientStoreWithDB create mysql store instance, db sql.DB, tableName table name (default oauth2_token), GC time interval (in seconds, default 600)
func (*ClientStore) Create ¶
func (s *ClientStore) Create(info oauth2.ClientInfo) error
Create creates and stores the new client information
func (*ClientStore) Delete ¶
func (s *ClientStore) Delete(id string) error
Delete creates and stores the new client information
func (*ClientStore) GetByID ¶
func (s *ClientStore) GetByID(id string) (oauth2.ClientInfo, error)
GetByID retrieves and returns client information by id
func (*ClientStore) SetStdout ¶
func (s *ClientStore) SetStdout(stdout io.Writer) *ClientStore
SetStdout set error output
type ClientStoreItem ¶
type ClientStoreItem struct {
ID string `db:"id,primarykey"`
Secret string `db:"secret"`
Domain string `db:"domain"`
Data string `db:"data"`
}
ClientStoreItem data item
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store mysql token store
func NewDefaultStore ¶
NewDefaultStore create mysql store instance
func NewStore ¶
NewStore create mysql store instance, config mysql configuration, tableName table name (default oauth2_token), GC time interval (in seconds, default 600)
func NewStoreWithDB ¶
NewStoreWithDB create mysql store instance, db sql.DB, tableName table name (default oauth2_token), GC time interval (in seconds, default 600)
func (*Store) GetByAccess ¶
GetByAccess use the access token for token information data
func (*Store) GetByRefresh ¶
GetByRefresh use the refresh token for token information data
func (*Store) RemoveByAccess ¶
RemoveByAccess use the access token to delete the token information
func (*Store) RemoveByCode ¶
RemoveByCode delete the authorization code
func (*Store) RemoveByRefresh ¶
RemoveByRefresh use the refresh token to delete the token information
Source Files