token

Documentation

Index

• Variables
• func IsValidType(t Type) bool
• type CreateStruct
• type Manager
  • func NewManager(store Store, xor uint64, tokenMaxTTL time.Duration, certMaxTTL time.Duration, ...) *Manager
  • func (m *Manager) Create(parent string, options *CreateStruct) (string, error)
  • func (m *Manager) Delete(name string) error
  • func (m *Manager) Get(name string) (*Token, error)
• type Store
• type Token
  • func NewToken(t Type, expiration time.Time, maxTTL time.Duration, policies []string, ...) *Token
  • func (t *Token) GetExpiration() time.Time
  • func (t *Token) GetMetadata() map[string]string
  • func (t *Token) GetParent() string
  • func (t *Token) GetPolicies() []string
  • func (t *Token) GetType() Type
  • func (t *Token) MarshalBinary() ([]byte, error)
  • func (t *Token) UnmarshalBinary(data []byte) error
• type Type
• type TypeNumber

Variables

var AllTypes []Type = maps.Keys(TypeTypeNumber)

var ErrInvalidToken = errors.New("invalid token format")

var ErrParentTokenExpired = errors.New("parent token expired")

var ErrParentTokenNotFound = errors.New("parent token not found")

var ErrTTLOutOfRange = errors.New("ttl out of range")

var TypePrefix map[Type]string = map[Type]string{
	Root:             "ro",
	Parent:           "pa",
	ServerCert:       "sc",
	ClientCert:       "cc",
	ClientServerCert: "cs",
}

var TypeString map[TypeNumber]Type = map[TypeNumber]Type{
	RootNumber:             Root,
	ParentNumber:           Parent,
	ServerCertNumber:       ServerCert,
	ClientCertNumber:       ClientCert,
	ClientServerCertNumber: ClientServerCert,
}

var TypeTypeNumber map[Type]TypeNumber = map[Type]TypeNumber{
	Root:             RootNumber,
	ServerCert:       ServerCertNumber,
	ClientCert:       ClientCertNumber,
	ClientServerCert: ClientServerCertNumber,
	Parent:           ParentNumber,
}

Functions

func IsValidType

func IsValidType(t Type) bool

Types

type CreateStruct

type CreateStruct struct {
	Type      Type              `json:"type" example:"client_cert"`
	Policies  []string          `json:"Policies" example:"policy1,policy2"`
	Meta      map[string]string `json:"meta" example:"key1:value1,key2:value2"`
	TTL       string            `json:"ttl" example:"1000h"`
	MaxTTL    string            `json:"maxttl" example:"3h"`
	Renewable bool              `json:"renewable" example:"false"`
}

type Manager

type Manager struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewManager

func NewManager(store Store, xor uint64, tokenMaxTTL time.Duration, certMaxTTL time.Duration, parentMaxTTL time.Duration, rndSize int) *Manager

func (*Manager) Create

func (m *Manager) Create(parent string, options *CreateStruct) (string, error)

func (*Manager) Delete

func (m *Manager) Delete(name string) error

func (*Manager) Get

func (m *Manager) Get(name string) (*Token, error)

type Store

type Store interface {
	io.Closer
	Get(ctx context.Context, tokenID string) ([]byte, error)
	Put(ctx context.Context, tokenID string, token []byte, ttl time.Duration) error
	Delete(ctx context.Context, tokenID string) error
}

type Token

type Token struct {
	Type       Type
	Expiration time.Time
	Policies   []string
	Parent     string
	Metadata   map[string]string
	MaxTTL     time.Duration
}

func NewToken

func NewToken(t Type, expiration time.Time, maxTTL time.Duration, policies []string, meta map[string]string) *Token

func (*Token) GetExpiration

func (t *Token) GetExpiration() time.Time

func (*Token) GetMetadata

func (t *Token) GetMetadata() map[string]string

func (*Token) GetParent

func (t *Token) GetParent() string

func (*Token) GetPolicies

func (t *Token) GetPolicies() []string

func (*Token) GetType

func (t *Token) GetType() Type

func (*Token) MarshalBinary

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

func (*Token) UnmarshalBinary

func (t *Token) UnmarshalBinary(data []byte) error

type Type

type Type string

const (
	Root             Type = "root"
	Parent           Type = "Parent"
	ServerCert       Type = "server_cert"
	ClientCert       Type = "client_cert"
	ClientServerCert Type = "client_server_cert"
)

type TypeNumber

type TypeNumber uint16

const (
	RootNumber TypeNumber = iota
	ParentNumber
	ServerCertNumber
	ClientCertNumber
	ClientServerCertNumber
)