service

Documentation

Index

• Constants
• Variables
• func AddRecord(r micro.Request, app AppContext) error
• func AppGroup(svc micro.Service, logger *logr.Logger, appCtx AppContext)
• func AppHandler(logger *logr.Logger, h AppHandlerFunc, app AppContext) micro.HandlerFunc
• func DBGroup(svc micro.Service, logger *logr.Logger, appCtx AppContext)
• func DeleteRecord(r micro.Request, app AppContext) error
• func GetClientDBVerbs() []string
• func GetRecord(r micro.Request, app AppContext) error
• func HashPassword(s string) string
• func Initialize(r micro.Request, app AppContext) error
• func Lock(r micro.Request, app AppContext) error
• func RotateKey(r micro.Request, app AppContext) error
• func SanitizeKey(k string) string
• func Status(r micro.Request, app AppContext) error
• func Unlock(r micro.Request, app AppContext) error
• func WatchForConfig(logger *logr.Logger, js nats.JetStreamContext)
• type AppContext
  • func (a *AppContext) AddRecord(k KV) error
  • func (a *AppContext) DeleteRecord(k KV) error
  • func (a *AppContext) GetRecord(k KV) ([]byte, error)
  • func (a *AppContext) Rotate(currentKey string) ([]byte, error)
  • func (a *AppContext) Unlock(k KV) error
• type AppHandlerFunc
  • func SecretHandler(a AppHandlerFunc) AppHandlerFunc
• type Backend
• type Client
  • func (c *Client) Delete(key string) (string, error)
  • func (c *Client) Do(request Request) (string, error)
  • func (c *Client) Get(key string) (string, error)
  • func (c *Client) Post(key string, data []byte) (string, error)
• type ClientError
  • func NewClientError(err error, code int) ClientError
  • func (c ClientError) As(target any) bool
  • func (c *ClientError) Body() []byte
  • func (c *ClientError) CodeString() string
  • func (c ClientError) Error() string
• type DBVerb
  • func (d DBVerb) String() string
• type DatabaseKey
• type DbRequest
• type JetStreamRecord
  • func NewJSRecord() *JetStreamRecord
  • func (j *JetStreamRecord) Bucket() string
  • func (j *JetStreamRecord) Decrypt() ([]byte, error)
  • func (j *JetStreamRecord) Encrypt() error
  • func (j *JetStreamRecord) Key() string
  • func (j *JetStreamRecord) Value() []byte
• type KV
• type Password
  • func NewPassword() *Password
• type Request
  • func NewDBRequest(verb DBVerb, key string) (Request, error)
  • func NewRequest(verb Verb, key string) (Request, error)
• type ResponseError
• type ResponseMessage
• type RotateRequest
• type Verb
• type Watcher

Constants

const (
	DBInit   DBVerb = "init"
	DBLock   DBVerb = "lock"
	DBUnlock DBVerb = "unlock"
	DBStatus DBVerb = "status"
	DBRotate DBVerb = "rotate"
	GET      Verb   = "GET"
	POST     Verb   = "POST"
	DELETE   Verb   = "DELETE"
)

const (
	Bucket = "piggybank"
)

Variables

var SubjectVerbs = map[DBVerb]string{
	DBInit:   fmt.Sprintf("%s.%s", databaseSubject, databaseInitSubject),
	DBLock:   fmt.Sprintf("%s.%s", databaseSubject, databaseLockSubject),
	DBUnlock: fmt.Sprintf("%s.%s", databaseSubject, databaseUnlockSubject),
	DBStatus: fmt.Sprintf("%s.%s", databaseSubject, databaseStatusSubject),
	DBRotate: fmt.Sprintf("%s.%s", databaseSubject, databaseRotateSubject),
}

Functions

func AddRecord

func AddRecord(r micro.Request, app AppContext) error

func AppGroup

func AppGroup(svc micro.Service, logger *logr.Logger, appCtx AppContext)

func AppHandler

func AppHandler(logger *logr.Logger, h AppHandlerFunc, app AppContext) micro.HandlerFunc

ErrorHandler wraps a normal micro endpoint and allows for returning errors natively. Errors are checked and if an error is a client error, details are returned, otherwise a 500 is returned and logged

func DBGroup

func DBGroup(svc micro.Service, logger *logr.Logger, appCtx AppContext)

func DeleteRecord

func DeleteRecord(r micro.Request, app AppContext) error

func GetClientDBVerbs

func GetClientDBVerbs() []string

func GetRecord

func GetRecord(r micro.Request, app AppContext) error

func HashPassword

func HashPassword(s string) string

func Initialize

func Initialize(r micro.Request, app AppContext) error

func Lock

func Lock(r micro.Request, app AppContext) error

func RotateKey

func RotateKey(r micro.Request, app AppContext) error

func SanitizeKey

func SanitizeKey(k string) string

func Status

func Status(r micro.Request, app AppContext) error

Wrap Status in secret handler so it will catch locked requests

func Unlock

func Unlock(r micro.Request, app AppContext) error

func WatchForConfig

func WatchForConfig(logger *logr.Logger, js nats.JetStreamContext)

Types

type AppContext

type AppContext struct {
	KV nats.KeyValue
	// contains filtered or unexported fields
}

func (*AppContext) AddRecord

func (a *AppContext) AddRecord(k KV) error

func (*AppContext) DeleteRecord

func (a *AppContext) DeleteRecord(k KV) error

func (*AppContext) GetRecord

func (a *AppContext) GetRecord(k KV) ([]byte, error)

func (*AppContext) Rotate

func (a *AppContext) Rotate(currentKey string) ([]byte, error)

func (*AppContext) Unlock

func (a *AppContext) Unlock(k KV) error

type AppHandlerFunc

type AppHandlerFunc func(micro.Request, AppContext) error

func SecretHandler

func SecretHandler(a AppHandlerFunc) AppHandlerFunc

SecretHandler wraps any secret handlers to check if database is currently locked

type Backend

type Backend interface {
	Watcher
}

type Client

type Client struct {
	Conn *nats.Conn
}

func (*Client) Delete

func (c *Client) Delete(key string) (string, error)

func (*Client) Do

func (c *Client) Do(request Request) (string, error)

func (*Client) Get

func (c *Client) Get(key string) (string, error)

func (*Client) Post

func (c *Client) Post(key string, data []byte) (string, error)

type ClientError

type ClientError struct {
	Code    int
	Details string
}

func NewClientError

func NewClientError(err error, code int) ClientError

func (ClientError) As

func (c ClientError) As(target any) bool

func (*ClientError) Body

func (c *ClientError) Body() []byte

func (*ClientError) CodeString

func (c *ClientError) CodeString() string

func (ClientError) Error

func (c ClientError) Error() string

type DBVerb

type DBVerb string

func (DBVerb) String

func (d DBVerb) String() string

type DatabaseKey

type DatabaseKey struct {
	DBKey string `json:"database_key"`
}

type DbRequest

type DbRequest struct {
	Verb DBVerb
	Key  string
}

type JetStreamRecord

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

func NewJSRecord

func NewJSRecord() *JetStreamRecord

NewJSRecord returns a new JetStreamRecord

func (*JetStreamRecord) Bucket

func (j *JetStreamRecord) Bucket() string

Bucket returns the Bucket value for the JetStreamRecord

func (*JetStreamRecord) Decrypt

func (j *JetStreamRecord) Decrypt() ([]byte, error)

Decrypt decrypts the value of the JetStreamRecord using the encryption key stored in the record

func (*JetStreamRecord) Encrypt

func (j *JetStreamRecord) Encrypt() error

Encrypt encrypts the value of the JetStreamRecord using the encryption key stored in the record

func (*JetStreamRecord) Key

func (j *JetStreamRecord) Key() string

Key returns the Key for the JetStreamRecord

func (*JetStreamRecord) Value

func (j *JetStreamRecord) Value() []byte

Value returns the JetStreamRecord value

type KV

type KV interface {
	Bucket() string
	Key() string
	Value() []byte
	Encrypt() error
}

type Password

type Password struct {
	PlainText string `json:"password"`
	// contains filtered or unexported fields
}

func NewPassword

func NewPassword() *Password

NewPassword returns a pointer to a new password.

type Request

type Request struct {
	Subject string
	Data    []byte
}

func NewDBRequest

func NewDBRequest(verb DBVerb, key string) (Request, error)

func NewRequest

func NewRequest(verb Verb, key string) (Request, error)

type ResponseError

type ResponseError struct {
	Error string `json:"error"`
}

type ResponseMessage

type ResponseMessage struct {
	Details string `json:"details,omitempty"`
}

ResponseMessage holds a response to the caller

type RotateRequest

type RotateRequest struct {
	CurrentKey string `json:"current_key"`
}

type Verb

type Verb string

type Watcher

type Watcher interface {
	Watch()
}