mysql

README

MySQL Storage for OAuth 2.0

Install

$ go get -v github.com/go-oauth2/mysql/v4

Usage

package main

import (
	"github.com/go-oauth2/mysql/v4"
	"github.com/go-oauth2/oauth2/v4/manage"

	_ "github.com/go-sql-driver/mysql"
)

func main() {
	manager := manage.NewDefaultManager()

	// use mysql token store
	store := mysql.NewDefaultStore(
		mysql.NewConfig("root:123456@tcp(127.0.0.1:3306)/myapp_test?charset=utf8"),
	)

	defer store.Close()

	manager.MapTokenStorage(store)
	// ...
}

MIT License

Copyright (c) 2018 Lyric

Documentation

Index

• type Config
  • func NewConfig(dsn string) *Config
• type Store
  • func NewDefaultStore(config *Config) *Store
  • func NewStore(config *Config, tableName string, gcInterval int) *Store
  • func NewStoreWithDB(db *sql.DB, tableName string, gcInterval int) *Store
  • func (s *Store) Close()
  • func (s *Store) Create(ctx context.Context, info oauth2.TokenInfo) error
  • func (s *Store) GetByAccess(ctx context.Context, access string) (oauth2.TokenInfo, error)
  • func (s *Store) GetByCode(ctx context.Context, code string) (oauth2.TokenInfo, error)
  • func (s *Store) GetByRefresh(ctx context.Context, refresh string) (oauth2.TokenInfo, error)
  • func (s *Store) RemoveByAccess(ctx context.Context, access string) error
  • func (s *Store) RemoveByCode(ctx context.Context, code string) error
  • func (s *Store) RemoveByRefresh(ctx context.Context, refresh string) error
  • func (s *Store) SetStdout(stdout io.Writer) *Store
• type StoreItem

Types

type Config

type Config struct {
	DSN          string
	MaxLifetime  time.Duration
	MaxOpenConns int
	MaxIdleConns int
}

Config mysql configuration

func NewConfig

func NewConfig(dsn string) *Config

NewConfig create mysql configuration instance

type Store

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

Store mysql token store

func NewDefaultStore

func NewDefaultStore(config *Config) *Store

NewDefaultStore create mysql store instance

func NewStore

func NewStore(config *Config, tableName string, gcInterval int) *Store

NewStore create mysql store instance, config mysql configuration, tableName table name (default oauth2_token), GC time interval (in seconds, default 600)

func NewStoreWithDB

func NewStoreWithDB(db *sql.DB, tableName string, gcInterval int) *Store

NewStoreWithDB create mysql store instance, db sql.DB, tableName table name (default oauth2_token), GC time interval (in seconds, default 600)

func (*Store) Close

func (s *Store) Close()

Close close the store

func (*Store) Create

func (s *Store) Create(ctx context.Context, info oauth2.TokenInfo) error

Create create and store the new token information

func (*Store) GetByAccess

func (s *Store) GetByAccess(ctx context.Context, access string) (oauth2.TokenInfo, error)

GetByAccess use the access token for token information data

func (*Store) GetByCode

func (s *Store) GetByCode(ctx context.Context, code string) (oauth2.TokenInfo, error)

GetByCode use the authorization code for token information data

func (*Store) GetByRefresh

func (s *Store) GetByRefresh(ctx context.Context, refresh string) (oauth2.TokenInfo, error)

GetByRefresh use the refresh token for token information data

func (*Store) RemoveByAccess

func (s *Store) RemoveByAccess(ctx context.Context, access string) error

RemoveByAccess use the access token to delete the token information

func (*Store) RemoveByCode

func (s *Store) RemoveByCode(ctx context.Context, code string) error

RemoveByCode delete the authorization code

func (*Store) RemoveByRefresh

func (s *Store) RemoveByRefresh(ctx context.Context, refresh string) error

RemoveByRefresh use the refresh token to delete the token information

func (*Store) SetStdout

func (s *Store) SetStdout(stdout io.Writer) *Store

SetStdout set error output

type StoreItem

type StoreItem struct {
	ID        int64  `db:"id,primarykey,autoincrement"`
	ExpiredAt int64  `db:"expired_at"`
	Code      string `db:"code,size:255"`
	Access    string `db:"access,size:255"`
	Refresh   string `db:"refresh,size:255"`
	Data      string `db:"data,size:2048"`
}

StoreItem data item