enclave

Documentation

Overview

Package enclave is a server-side Secure Enclave. It offers a secure and sealed storage to store indy wallet keys on the Agency server.

Urgent! This version does not implement internal hash(), encrypt, and decrypt() functions. We must implement these three functions before production. We will offer implementations of them when the server-side crypto solution and the Key Storage is selected. Possible candidates are AWS Nitro, etc. We also bring addon/plugin system for cryptos when first implementation is done.

Index

• func BackupTicker(interval time.Duration) (done chan<- struct{})
• func GetExistingSessionUser(userID []byte) (u *user.User, err error)
• func GetExistingUser(name string) (u *user.User, err error)
• func GetSessionUser(userID []byte) (u *user.User, exist bool, err error)
• func GetUser(name string) (u *user.User, exist bool, err error)
• func InitSealedBox(filename, backupName, key string) (err error)
• func PutSessionUser(userID []byte, u *user.User) (err error)
• func PutUser(u *user.User) (err error)
• func RemoveSessionUser(userID []byte) (err error)
• func RemoveUser(name string) (err error)
• func WipeSealedBox()

Functions

func BackupTicker

func BackupTicker(interval time.Duration) (done chan<- struct{})

func GetExistingSessionUser

func GetExistingSessionUser(userID []byte) (u *user.User, err error)

GetSessionExistingUser returns user by name if exists in enclave

func GetExistingUser

func GetExistingUser(name string) (u *user.User, err error)

GetExistingUser returns user by name if exists in enclave

func GetSessionUser

func GetSessionUser(userID []byte) (u *user.User, exist bool, err error)

GetSessionUser returns user by name if exists in enclave

func GetUser

func GetUser(name string) (u *user.User, exist bool, err error)

GetUser returns user by name if exists in enclave

func InitSealedBox

func InitSealedBox(filename, backupName, key string) (err error)

InitSealedBox initialize enclave's sealed box. This must be called once during the app life cycle.

func PutSessionUser

func PutSessionUser(userID []byte, u *user.User) (err error)

PutSessionUser saves the user to database.

func PutUser

func PutUser(u *user.User) (err error)

PutUser saves the user to database.

func RemoveSessionUser

func RemoveSessionUser(userID []byte) (err error)

func RemoveUser

func RemoveUser(name string) (err error)

func WipeSealedBox

func WipeSealedBox()

WipeSealedBox closes and destroys the enclave permanently. This version only removes the sealed box file. In the future we might add sector wiping functionality.