add mysql store

Author: LyricTian

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Golang OAuth 2.0
+Copyright (c) 2018 Lyric
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,46 @@
-# mysql
-MySQL storage for OAuth 2.0
+# MySQL Storage for [OAuth 2.0](https://github.com/go-oauth2/oauth2)
+
+[![ReportCard][reportcard-image]][reportcard-url] [![GoDoc][godoc-image]][godoc-url] [![License][license-image]][license-url]
+
+## Install
+
+``` bash
+$ go get -u -v gopkg.in/go-oauth2/mysql.v3
+```
+
+## Usage
+
+``` go
+package main
+
+import (
+	"gopkg.in/go-oauth2/mysql.v3"
+    "gopkg.in/oauth2.v3/manage"
+    
+    _ "github.com/go-sql-driver/mysql"
+)
+
+func main() {
+	manager := manage.NewDefaultManager()
+
+	// use mysql token store
+	manager.MapTokenStorage(
+		mysql.NewStore(mysql.NewConfig("root:123456@tcp(127.0.0.1:3306)/myapp_test?charset=utf8") , "", 0),
+	)
+	// ...
+}
+```
+
+## MIT License
+
+```
+Copyright (c) 2018 Lyric
+```
+
+[reportcard-url]: https://goreportcard.com/report/gopkg.in/go-oauth2/mysql.v3
+[reportcard-image]: https://goreportcard.com/badge/gopkg.in/go-oauth2/mysql.v3
+[godoc-url]: https://godoc.org/gopkg.in/go-oauth2/mysql.v3
+[godoc-image]: https://godoc.org/gopkg.in/go-oauth2/mysql.v3?status.svg
+[license-url]: http://opensource.org/licenses/MIT
+[license-image]: https://img.shields.io/npm/l/express.svg
+

mysql.go

@@ -0,0 +1,245 @@
+package mysql
+
+import (
+	"database/sql"
+	"fmt"
+	"io"
+	"os"
+	"time"
+
+	"github.com/json-iterator/go"
+	"gopkg.in/gorp.v2"
+	"gopkg.in/oauth2.v3"
+	"gopkg.in/oauth2.v3/models"
+)
+
+// StoreItem data item
+type StoreItem struct {
+	ID        int64  `db:"id,primarykey,autoincrement"`
+	ExpiredAt int64  `db:"expired_at"`
+	Code      string `db:"code,size:512"`
+	Access    string `db:"access,size:512"`
+	Refresh   string `db:"refresh,size:512"`
+	Data      string `db:"data,size:2048"`
+}
+
+// NewConfig create mysql configuration instance
+func NewConfig(dsn string) *Config {
+	return &Config{
+		DSN:          dsn,
+		MaxLifetime:  time.Hour * 2,
+		MaxOpenConns: 50,
+		MaxIdleConns: 25,
+	}
+}
+
+// Config mysql configuration
+type Config struct {
+	DSN          string
+	MaxLifetime  time.Duration
+	MaxOpenConns int
+	MaxIdleConns int
+}
+
+// NewStore create mysql store instance,
+func NewStore(config *Config, tableName string, gcInterval int) *Store {
+	db, err := sql.Open("mysql", config.DSN)
+	if err != nil {
+		panic(err)
+	}
+
+	db.SetMaxOpenConns(config.MaxOpenConns)
+	db.SetMaxIdleConns(config.MaxIdleConns)
+	db.SetConnMaxLifetime(config.MaxLifetime)
+
+	return NewStoreWithDB(db, tableName, gcInterval)
+}
+
+// NewStoreWithDB create mysql store instance
+func NewStoreWithDB(db *sql.DB, tableName string, gcInterval int) *Store {
+	store := &Store{
+		db:        &gorp.DbMap{Db: db, Dialect: gorp.MySQLDialect{Encoding: "UTF8", Engine: "MyISAM"}},
+		tableName: "oauth2_token",
+		stdout:    os.Stderr,
+		interval:  600,
+	}
+	if tableName != "" {
+		store.tableName = tableName
+	}
+
+	if gcInterval > 0 {
+		store.interval = gcInterval
+	}
+
+	table := store.db.AddTableWithName(StoreItem{}, store.tableName)
+	table.AddIndex("idx_code", "Btree", []string{"code"})
+	table.AddIndex("idx_access", "Btree", []string{"access"})
+	table.AddIndex("idx_refresh", "Btree", []string{"refresh"})
+	table.AddIndex("idx_expired_at", "Btree", []string{"expired_at"})
+
+	err := store.db.CreateTablesIfNotExists()
+	if err != nil {
+		panic(err)
+	}
+	store.db.CreateIndex()
+
+	go store.gc()
+	return store
+}
+
+// Store mysql token store
+type Store struct {
+	interval  int
+	tableName string
+	db        *gorp.DbMap
+	stdout    io.Writer
+}
+
+// SetStdout set error output
+func (s *Store) SetStdout(stdout io.Writer) *Store {
+	s.stdout = stdout
+	return s
+}
+
+// Close close the store
+func (s *Store) Close() {
+	s.db.Db.Close()
+}
+
+func (s *Store) errorf(format string, args ...interface{}) {
+	if s.stdout != nil {
+		buf := fmt.Sprintf(format, args...)
+		s.stdout.Write([]byte(buf))
+	}
+}
+
+func (s *Store) gc() {
+	ticker := time.NewTicker(time.Second * time.Duration(s.interval))
+	for range ticker.C {
+		now := time.Now().Unix()
+		query := fmt.Sprintf("SELECT COUNT(*) FROM %s WHERE expired_at<=?", s.tableName)
+		n, err := s.db.SelectInt(query, now)
+		if err != nil {
+			s.errorf("[ERROR]:%s", err.Error())
+			return
+		} else if n > 0 {
+			_, err = s.db.Exec(fmt.Sprintf("DELETE FROM %s WHERE expired_at<=?", s.tableName), now)
+			if err != nil {
+				s.errorf("[ERROR]:%s", err.Error())
+			}
+		}
+	}
+}
+
+// Create create and store the new token information
+func (s *Store) Create(info oauth2.TokenInfo) error {
+	buf, _ := jsoniter.Marshal(info)
+	item := &StoreItem{
+		Data: string(buf),
+	}
+
+	if code := info.GetCode(); code != "" {
+		item.Code = code
+		item.ExpiredAt = info.GetCodeCreateAt().Add(info.GetCodeExpiresIn()).Unix()
+	} else {
+		item.Access = info.GetAccess()
+		item.ExpiredAt = info.GetAccessCreateAt().Add(info.GetAccessExpiresIn()).Unix()
+
+		if refresh := info.GetRefresh(); refresh != "" {
+			item.Refresh = info.GetRefresh()
+			item.ExpiredAt = info.GetRefreshCreateAt().Add(info.GetRefreshExpiresIn()).Unix()
+		}
+	}
+
+	return s.db.Insert(item)
+}
+
+// RemoveByCode delete the authorization code
+func (s *Store) RemoveByCode(code string) error {
+	query := fmt.Sprintf("UPDATE %s SET code='' WHERE code=? LIMIT 1", s.tableName)
+	_, err := s.db.Exec(query, code)
+	if err != nil && err == sql.ErrNoRows {
+		return nil
+	}
+	return err
+}
+
+// RemoveByAccess use the access token to delete the token information
+func (s *Store) RemoveByAccess(access string) error {
+	query := fmt.Sprintf("UPDATE %s SET access='' WHERE access=? LIMIT 1", s.tableName)
+	_, err := s.db.Exec(query, access)
+	if err != nil && err == sql.ErrNoRows {
+		return nil
+	}
+	return err
+}
+
+// RemoveByRefresh use the refresh token to delete the token information
+func (s *Store) RemoveByRefresh(refresh string) error {
+	query := fmt.Sprintf("UPDATE %s SET refresh='' WHERE refresh=? LIMIT 1", s.tableName)
+	_, err := s.db.Exec(query, refresh)
+	if err != nil && err == sql.ErrNoRows {
+		return nil
+	}
+	return err
+}
+
+func (s *Store) toTokenInfo(data string) oauth2.TokenInfo {
+	var tm models.Token
+	jsoniter.Unmarshal([]byte(data), &tm)
+	return &tm
+}
+
+// GetByCode use the authorization code for token information data
+func (s *Store) GetByCode(code string) (oauth2.TokenInfo, error) {
+	if code == "" {
+		return nil, nil
+	}
+
+	query := fmt.Sprintf("SELECT * FROM %s WHERE code=? LIMIT 1", s.tableName)
+	var item StoreItem
+	err := s.db.SelectOne(&item, query, code)
+	if err != nil {
+		if err == sql.ErrNoRows {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return s.toTokenInfo(item.Data), nil
+}
+
+// GetByAccess use the access token for token information data
+func (s *Store) GetByAccess(access string) (oauth2.TokenInfo, error) {
+	if access == "" {
+		return nil, nil
+	}
+
+	query := fmt.Sprintf("SELECT * FROM %s WHERE access=? LIMIT 1", s.tableName)
+	var item StoreItem
+	err := s.db.SelectOne(&item, query, access)
+	if err != nil {
+		if err == sql.ErrNoRows {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return s.toTokenInfo(item.Data), nil
+}
+
+// GetByRefresh use the refresh token for token information data
+func (s *Store) GetByRefresh(refresh string) (oauth2.TokenInfo, error) {
+	if refresh == "" {
+		return nil, nil
+	}
+
+	query := fmt.Sprintf("SELECT * FROM %s WHERE refresh=? LIMIT 1", s.tableName)
+	var item StoreItem
+	err := s.db.SelectOne(&item, query, refresh)
+	if err != nil {
+		if err == sql.ErrNoRows {
+			return nil, nil
+		}
+		return nil, err
+	}
+	return s.toTokenInfo(item.Data), nil
+}