timebox

README

timebox

Documentation

Index

• Variables
• type Boxer
  • func New(secret string) (*Boxer, error)
  • func (b *Boxer) Open(sealed string, output proto.Message) bool
  • func (b *Boxer) Seal(message proto.Message, maxAge time.Duration) (string, error)

Variables

var Clock = clock.NewClock()

Types

type Boxer

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

Boxer provides a limited API for encrypting protobuf messages that expire after some time

func New

func New(secret string) (*Boxer, error)

New returns a new Boxer

func (*Boxer) Open

func (b *Boxer) Open(sealed string, output proto.Message) bool

Open takes an encrypted timebox and attempts to decrypt and unmarshal it into output. If all operations succeed (decryption, verifying expiration, unmarshalling), Open returns true. Otherwise, Open returns false.

func (*Boxer) Seal

func (b *Boxer) Seal(message proto.Message, maxAge time.Duration) (string, error)

Seal encrypts the given message in a box that expires after maxAge has elapsed