encrypteddb

Documentation

Index

• Variables
• func DecodeBox(ctx context.Context, b []byte, getSecretBoxKey KeyFn, res interface{}) error
• func EncodeBox(ctx context.Context, data interface{}, getSecretBoxKey KeyFn) ([]byte, error)
• func GetSecretBoxKey(ctx context.Context, g *libkb.GlobalContext, reason libkb.EncryptionReason, ...) (fkey [32]byte, err error)
• func GetSecretBoxKeyWithUID(ctx context.Context, g *libkb.GlobalContext, uid keybase1.UID, ...) (fkey [32]byte, err error)
• type DbFn
• type EncryptedDB
  • func New(g *libkb.GlobalContext, getDB DbFn, getSecretBoxKey KeyFn) *EncryptedDB
  • func (i *EncryptedDB) Delete(ctx context.Context, key libkb.DbKey) error
  • func (i *EncryptedDB) Get(ctx context.Context, key libkb.DbKey, res interface{}) (bool, error)
  • func (i *EncryptedDB) Put(ctx context.Context, key libkb.DbKey, data interface{}) error
• type EncryptedFile
  • func NewFile(g *libkb.GlobalContext, path string, getSecretBoxKey KeyFn) *EncryptedFile
  • func (f *EncryptedFile) Get(ctx context.Context, res interface{}) error
  • func (f *EncryptedFile) Put(ctx context.Context, data interface{}) error
  • func (f *EncryptedFile) Remove(ctx context.Context) error
• type KeyFn

Variables

var ErrDecryptionFailed = errors.New("failed to decrypt item")

ErrDecryptionFailed is returned when an encrypteddb box fails to decrypt

Functions

func DecodeBox

func DecodeBox(ctx context.Context, b []byte, getSecretBoxKey KeyFn,
	res interface{}) error

func EncodeBox

func EncodeBox(ctx context.Context, data interface{}, getSecretBoxKey KeyFn) ([]byte, error)

func GetSecretBoxKey

func GetSecretBoxKey(ctx context.Context, g *libkb.GlobalContext,
	reason libkb.EncryptionReason, reasonStr string) (fkey [32]byte, err error)

func GetSecretBoxKeyWithUID

func GetSecretBoxKeyWithUID(ctx context.Context, g *libkb.GlobalContext, uid keybase1.UID,
	reason libkb.EncryptionReason, reasonStr string) (fkey [32]byte, err error)

Types

type DbFn

type DbFn func(g *libkb.GlobalContext) *libkb.JSONLocalDb

type EncryptedDB

type EncryptedDB struct {
	libkb.Contextified
	// contains filtered or unexported fields
}

Handle to a db that encrypts values using nacl secretbox. Does not encrypt keys. Not threadsafe.

func New

func New(g *libkb.GlobalContext, getDB DbFn, getSecretBoxKey KeyFn) *EncryptedDB

func (*EncryptedDB) Delete

func (i *EncryptedDB) Delete(ctx context.Context, key libkb.DbKey) error

func (*EncryptedDB) Get

func (i *EncryptedDB) Get(ctx context.Context, key libkb.DbKey, res interface{}) (bool, error)

Get a value Decodes into res Returns (found, err). Res is valid only if (found && err == nil)

func (*EncryptedDB) Put

func (i *EncryptedDB) Put(ctx context.Context, key libkb.DbKey, data interface{}) error

type EncryptedFile

type EncryptedFile struct {
	libkb.Contextified
	// contains filtered or unexported fields
}

func NewFile

func NewFile(g *libkb.GlobalContext, path string, getSecretBoxKey KeyFn) *EncryptedFile

func (*EncryptedFile) Get

func (f *EncryptedFile) Get(ctx context.Context, res interface{}) error

func (*EncryptedFile) Put

func (f *EncryptedFile) Put(ctx context.Context, data interface{}) error

func (*EncryptedFile) Remove

func (f *EncryptedFile) Remove(ctx context.Context) error

type KeyFn

type KeyFn func(context.Context) ([32]byte, error)