auth

Documentation

Index

• Constants
• func New(pool Pool, opts ...Option) Auth
• func NewAuthToken(t *Token) *authtoken
• type Option
• type Token
  • func NewByte16(duration time.Duration, scope ...string) *Token
  • func (t *Token) IsScope(scopes ...string) bool
  • func (t *Token) IsValid() bool
  • func (t *Token) MarshalJSON() ([]byte, error)
  • func (t *Token) String() string
• type TokenType
• type TokenUpdateExpiry
• type TokenUpdateScope
• type TokenUpdateTime

Constants

const (
	// Scope for reading tokens
	ScopeRead = "github.com/mutablelogic/go-server/tokenauth:read"

	// Scope for updating, deleting and creating tokens
	ScopeWrite = "github.com/mutablelogic/go-server/tokenauth:write"
)

Functions

func New

func New(pool Pool, opts ...Option) Auth

Create a new authorization service with the given pool

func NewAuthToken

func NewAuthToken(t *Token) *authtoken

Types

type Option

type Option func(*auth) error

type Token

type Token struct {
	Key    string    `json:"key,omitempty" bson:"_id,omitempty"`               // Key
	Name   string    `json:"name" bson:"name"`                                 // Name of token
	Type   TokenType `json:"type" bson:"type"`                                 // Type of token
	Value  string    `json:"-" bson:"value"`                                   // Token value
	Expire time.Time `json:"expires_at,omitempty" bson:"expires_at,omitempty"` // Time of expiration for the token
	Time   time.Time `json:"access_at" bson:"access_at"`                       // Time of last access
	Scope  []string  `json:"scope,omitempty" bson:"scope,omitempty"`           // Authorization scopes
}

func NewByte16

func NewByte16(duration time.Duration, scope ...string) *Token

NewByte16 creates a new 16-byte token without a name

func (*Token) IsScope

func (t *Token) IsScope(scopes ...string) bool

Return true if the token has the specified scope, and is valid

func (*Token) IsValid

func (t *Token) IsValid() bool

Return true if the token is valid (not expired)

func (*Token) MarshalJSON

func (t *Token) MarshalJSON() ([]byte, error)

func (*Token) String

func (t *Token) String() string

type TokenType

type TokenType string

const (
	TokenByte16 TokenType = "byte16" // 16 byte value
)

type TokenUpdateExpiry

type TokenUpdateExpiry struct {
	Time   time.Time `bson:"access_at"`            // Time of last access
	Expire time.Time `bson:"expires_at,omitempty"` // Time of expiration for the token
}

type TokenUpdateScope

type TokenUpdateScope struct {
	Time  time.Time `bson:"access_at"`       // Time of last access
	Scope []string  `bson:"scope,omitempty"` // Authentication scopes
}

type TokenUpdateTime

type TokenUpdateTime struct {
	Time time.Time `bson:"access_at"` // Time of last access
}