authorizations

Documentation

Index

• Variables
• func New(options ...Option) services.Service
• func Remove(ctx context.Context, account Id, ids ...Id) (err error)
• func ValidateContext(ctx context.Context) (err error)
• func With(ctx context.Context, authorization Authorization) context.Context
• type Attribute
• type Attributes
  • func (attributes *Attributes) Get(key []byte, value interface{}) (has bool, err error)
  • func (attributes *Attributes) Remove(key []byte)
  • func (attributes *Attributes) Set(key []byte, value interface{}) (err error)
• type Authorization
  • func List(ctx context.Context, account Id) (v []Authorization, err error)
  • func Load(ctx context.Context) (Authorization, bool, error)
  • func Validate(ctx context.Context, token Token) (authorization Authorization, err error)
  • func (authorization Authorization) Exist() bool
  • func (authorization Authorization) Validate() bool
• type Config
• type CreateParam
• type CreateResult
• type Id
  • func IntId(id int64) Id
  • func StringId(id []byte) Id
  • func (id Id) Exist() (ok bool)
  • func (id Id) Int() int64
  • func (id Id) MarshalJSON() ([]byte, error)
  • func (id Id) String() string
  • func (id *Id) UnmarshalJSON(p []byte) error
• type Option
  • func WithTokenEncoder(encoder TokenEncoder) Option
  • func WithTokenStore(store TokenStore) Option
• type Options
• type Token
  • func Create(ctx context.Context, param CreateParam) (token Token, err error)
  • func (token Token) String() string
• type TokenEncoder
  • func HmacTokenEncoder() TokenEncoder
• type TokenStore
  • func SharingTokenStore() TokenStore

Variables

var ErrUnauthorized = errors.Unauthorized("unauthorized")

Functions

func New

func New(options ...Option) services.Service

func Remove

func Remove(ctx context.Context, account Id, ids ...Id) (err error)

func ValidateContext

func ValidateContext(ctx context.Context) (err error)

func With

func With(ctx context.Context, authorization Authorization) context.Context

Types

type Attribute

type Attribute struct {
	Key   []byte          `json:"key" avro:"key"`
	Value json.RawMessage `json:"value" avro:"value"`
}

type Attributes

type Attributes []Attribute

func (*Attributes) Get

func (attributes *Attributes) Get(key []byte, value interface{}) (has bool, err error)

func (*Attributes) Remove

func (attributes *Attributes) Remove(key []byte)

func (*Attributes) Set

func (attributes *Attributes) Set(key []byte, value interface{}) (err error)

type Authorization

type Authorization struct {
	Id         Id         `json:"id" avro:"id"`
	Account    Id         `json:"account" avro:"account"`
	Attributes Attributes `json:"attributes" avro:"attributes"`
	ExpireAT   time.Time  `json:"expireAT" avro:"expireAt"`
}

func List

func List(ctx context.Context, account Id) (v []Authorization, err error)

func Load

func Load(ctx context.Context) (Authorization, bool, error)

func Validate

func Validate(ctx context.Context, token Token) (authorization Authorization, err error)

func (Authorization) Exist

func (authorization Authorization) Exist() bool

func (Authorization) Validate

func (authorization Authorization) Validate() bool

type Config

type Config struct {
	ExpireTTL         time.Duration `json:"expireTTL"`
	AutoRefresh       bool          `json:"autoRefresh"`
	AutoRefreshWindow time.Duration `json:"autoRefreshWindow"`
}

type CreateParam

type CreateParam struct {
	Id         Id         `json:"id" avro:"id"`
	Account    Id         `json:"account" avro:"account"`
	Attributes Attributes `json:"attributes" avro:"attributes"`
}

type CreateResult

type CreateResult struct {
	Token         Token         `json:"token" avro:"token"`
	Authorization Authorization `json:"authorization" avro:"authorization"`
}

type Id

type Id []byte

func IntId

func IntId(id int64) Id

func StringId

func StringId(id []byte) Id

func (Id) Exist

func (id Id) Exist() (ok bool)

func (Id) Int

func (id Id) Int() int64

func (Id) MarshalJSON

func (id Id) MarshalJSON() ([]byte, error)

func (Id) String

func (id Id) String() string

func (*Id) UnmarshalJSON

func (id *Id) UnmarshalJSON(p []byte) error

type Option

type Option func(options *Options)

func WithTokenEncoder

func WithTokenEncoder(encoder TokenEncoder) Option

func WithTokenStore

func WithTokenStore(store TokenStore) Option

type Options

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

type Token

type Token []byte

func Create

func Create(ctx context.Context, param CreateParam) (token Token, err error)

func (Token) String

func (token Token) String() string

type TokenEncoder

type TokenEncoder interface {
	services.Component
	Encode(ctx context.Context, param Authorization) (token Token, err error)
	Decode(ctx context.Context, token Token) (result Authorization, err error)
}

func HmacTokenEncoder

func HmacTokenEncoder() TokenEncoder

type TokenStore

type TokenStore interface {
	services.Component
	Get(ctx context.Context, account Id, id Id) (v Authorization, has bool, err error)
	List(ctx context.Context, account Id) (v []Authorization, err error)
	Save(ctx context.Context, v Authorization) (err error)
	Remove(ctx context.Context, account Id, ids []Id) (err error)
}

func SharingTokenStore

func SharingTokenStore() TokenStore