model

Documentation

Index

• Variables
• type ApiKey
• type ApiKeyClient
• type DB
  • func NewDB(driver, dsn string) (*DB, error)
  • func (db *DB) CreateApiKey(uid, clientID, scopes string) (*ApiKey, string, error)
  • func (db *DB) CreateToken(uid, email string) (*Token, error)
  • func (db *DB) DestroyApiKey(user, clientID string) error
  • func (db *DB) DestroyApiKeys(uid string) error
  • func (db *DB) DestroyToken(token string) error
  • func (db *DB) DestroyTokenByUser(uid string) error
  • func (db *DB) FetchApiKey(key string) (*ApiKey, error)
  • func (db *DB) FetchApiKeys(uid string) ([]*ApiKey, error)
  • func (db *DB) FetchToken(token string, maxAge int) (*Token, error)
  • func (db *DB) FetchTokenByUser(uid string, maxAge int) (*Token, error)
  • func (db *DB) IncrementToken(token string) error
  • func (db *DB) RandKey() (string, error)
  • func (db *DB) RandToken() (string, error)
  • func (db *DB) RefreshApiKey(ak *ApiKey) error
  • func (db *DB) SignToken(salt, token string) string
  • func (db *DB) VerifyToken(salt, signedToken string) (string, bool)
• type Datastore
• type Token

Variables

var ErrNotFound = errors.New("Record not found in database")

Types

type ApiKey

type ApiKey struct {
	UserName     string     `db:"user_name"`
	Key          string     `db:"api_key"`
	ClientID     string     `db:"client_id"`
	Scopes       string     `db:"scopes"`
	CreatedAt    *time.Time `db:"created_at"`
	LastAccessed *time.Time `db:"last_accessed"`
}

type ApiKeyClient

type ApiKeyClient struct {
	Name        string
	ClientID    string `mapstructure:"client_id"`
	Description string `mapstructure:"desc"`
	Scopes      string
}

type DB

type DB struct {
	*sqlx.DB
}

func NewDB

func NewDB(driver, dsn string) (*DB, error)

func (*DB) CreateApiKey

func (db *DB) CreateApiKey(uid, clientID, scopes string) (*ApiKey, string, error)

func (*DB) CreateToken

func (db *DB) CreateToken(uid, email string) (*Token, error)

func (*DB) DestroyApiKey

func (db *DB) DestroyApiKey(user, clientID string) error

func (*DB) DestroyApiKeys

func (db *DB) DestroyApiKeys(uid string) error

func (*DB) DestroyToken

func (db *DB) DestroyToken(token string) error

func (*DB) DestroyTokenByUser

func (db *DB) DestroyTokenByUser(uid string) error

func (*DB) FetchApiKey

func (db *DB) FetchApiKey(key string) (*ApiKey, error)

func (*DB) FetchApiKeys

func (db *DB) FetchApiKeys(uid string) ([]*ApiKey, error)

func (*DB) FetchToken

func (db *DB) FetchToken(token string, maxAge int) (*Token, error)

func (*DB) FetchTokenByUser

func (db *DB) FetchTokenByUser(uid string, maxAge int) (*Token, error)

func (*DB) IncrementToken

func (db *DB) IncrementToken(token string) error

func (*DB) RandKey

func (db *DB) RandKey() (string, error)

func (*DB) RandToken

func (db *DB) RandToken() (string, error)

func (*DB) RefreshApiKey

func (db *DB) RefreshApiKey(ak *ApiKey) error

func (*DB) SignToken

func (db *DB) SignToken(salt, token string) string

func (*DB) VerifyToken

func (db *DB) VerifyToken(salt, signedToken string) (string, bool)

type Datastore

type Datastore interface {
	// API Key
	RandKey() (string, error)
	FetchApiKeys(uid string) ([]*ApiKey, error)
	FetchApiKey(key string) (*ApiKey, error)
	CreateApiKey(uid, clientID, scopes string) (*ApiKey, string, error)
	RefreshApiKey(ak *ApiKey) error
	DestroyApiKey(user, clientID string) error
	DestroyApiKeys(uid string) error

	// Token
	RandToken() (string, error)
	SignToken(salt, token string) string
	VerifyToken(salt, signedToken string) (string, bool)
	FetchTokenByUser(uid string, maxAge int) (*Token, error)
	FetchToken(token string, maxAge int) (*Token, error)
	CreateToken(uid, email string) (*Token, error)
	IncrementToken(token string) error
	DestroyToken(token string) error
	DestroyTokenByUser(uid string) error
}

type Token

type Token struct {
	UserName  string     `db:"user_name"`
	Email     string     `db:"email"`
	Token     string     `db:"token"`
	Attempts  int        `db:"attempts"`
	CreatedAt *time.Time `db:"created_at"`
}