key

Documentation

Index

• Variables
• type Key
• type Keys
• type KeysPage
• type Options
• type Service

Variables

var (
	ErrKeyNotFound         = errors.New("key not found")
	ErrKeyRefAlreadyExists = errors.New("key reference already exists")
	ErrKeyRefRequired      = errors.New("key reference required")
)

Errors that are related to the Key Service.

Types

type Key

type Key struct {
	Secret             string      `json:"secret"`
	Ref                string      `json:"ref"`
	AuthorizedNetworks []net.IPNet `json:"authorized-networks,omitempty"`
}

type Keys

type Keys []Key

type KeysPage

type KeysPage struct {
	Keys     Keys   `json:"keys"`
	Previous string `json:"previous,omitempty"`
	Next     string `json:"next,omitempty"`
	Count    int    `json:"count,omitempty"`
}

type Options

type Options struct {
	AuthorizedNetworks *[]net.IPNet `json:"authorized-networks,omitempty"`
}

type Service

type Service interface {
	KeyByRef(ref string) (*Key, error)
	KeyBySecret(secret string) (*Key, error)
	CreateKey(ref string, o *Options) (*Key, error)
	UpdateKey(ref string, o *Options) (*Key, error)
	DeleteKey(ref string) error
	RegenerateSecret(ref string) (string, error)
	Keys(startID string, limit int) (KeysPage, error)
}