security

Documentation

Index

• func ToSHA512Hex(text string) (string, error)
• type Doorkeeper
  • func NewDoorkeeper(s Storage) *Doorkeeper
  • func (dk *Doorkeeper) VerifyTextToken(ctx context.Context, textToken string) (bool, error)
• type Issuer
  • func NewIssuer(s Storage) *Issuer
  • func (i *Issuer) CreateNewToken(ctx context.Context, ownerUID string, issueAt *time.Time, ...) (string, *Token, error)
  • func (i *Issuer) RevokeToken(ctx context.Context, token *Token) error
• type Storage
• type Token
  • func (token Token) IsExpirable() bool
  • func (token Token) IsValid() bool
• type TokenStorage

Functions

func ToSHA512Hex

func ToSHA512Hex(text string) (string, error)

Types

type Doorkeeper

type Doorkeeper struct {
	Storage
}

func NewDoorkeeper

func NewDoorkeeper(s Storage) *Doorkeeper

func (*Doorkeeper) VerifyTextToken

func (dk *Doorkeeper) VerifyTextToken(ctx context.Context, textToken string) (bool, error)

type Issuer

type Issuer struct {
	Storage
}

func NewIssuer

func NewIssuer(s Storage) *Issuer

func (*Issuer) CreateNewToken

func (i *Issuer) CreateNewToken(ctx context.Context, ownerUID string, issueAt *time.Time, duration *time.Duration) (string, *Token, error)

func (*Issuer) RevokeToken

func (i *Issuer) RevokeToken(ctx context.Context, token *Token) error

type Storage

type Storage interface {
	frameless.OnePhaseCommitProtocol
	SecurityToken(context.Context) TokenStorage
}

type Token

type Token struct {
	ID       string `ext:"ID"`
	SHA512   string
	OwnerUID string
	IssuedAt time.Time
	Duration time.Duration
}

func (Token) IsExpirable

func (token Token) IsExpirable() bool

IsExpirable states whether or not the token may expire; capable of being brought to an end.

p.s.: expirable is a valid word since 1913.

func (Token) IsValid

func (token Token) IsValid() bool

type TokenStorage

type TokenStorage interface {
	frameless.Creator
	frameless.Finder
	frameless.Updater
	frameless.Deleter
	frameless.CreatorPublisher
	frameless.UpdaterPublisher
	frameless.DeleterPublisher
	FindTokenBySHA512Hex(ctx context.Context, sha512hex string) (*Token, error)
}