keychain

Documentation

Index

• Constants
• Variables
• type Keychain
  • func New(store db.Store) *Keychain
  • func (kc *Keychain) GenerateKeyPair() ([]byte, []byte, error)
  • func (kc *Keychain) GenerateKeyPairWithForce() ([]byte, []byte, error)
  • func (kc *Keychain) GetStoredKeyPairInLibP2PFormat() (crypto.PrivKey, crypto.PubKey, error)
  • func (kc *Keychain) Sign(message []byte) ([]byte, error)

Constants

const PrivateKeyStoreKey = "private_key"

const PublicKeyStoreKey = "public_key"

Variables

var (
	ErrKeyPairNotFound = errors.New("No key pair found in the local db.")
)

Types

type Keychain

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

func New

func New(store db.Store) *Keychain

func (*Keychain) GenerateKeyPair

func (kc *Keychain) GenerateKeyPair() ([]byte, []byte, error)

Generates a public/private key pair using ed25519 algorithm. It stores it in the local db and returns the key pair key. If there's already a key pair stored, it returns an error. Use GenerateKeyPairWithForce if you want to override existing keys

func (*Keychain) GenerateKeyPairWithForce

func (kc *Keychain) GenerateKeyPairWithForce() ([]byte, []byte, error)

Generates a public/private key pair using ed25519 algorithm. It stores it in the local db and returns the key pair. Warning: If there's already a key pair stored, it overrides it.

func (*Keychain) GetStoredKeyPairInLibP2PFormat

func (kc *Keychain) GetStoredKeyPairInLibP2PFormat() (crypto.PrivKey, crypto.PubKey, error)

Returns the stored key pair using the same signature than libp2p's GenerateEd25519Key function

func (*Keychain) Sign

func (kc *Keychain) Sign(message []byte) ([]byte, error)

Signs a message using the stored private key. Returns an error if the private key cannot be found.