README
¶
krab
krab is a "semi secure" keystore that satisfies the IPFS keystore interface, allowing it to be used natively with many existing IPFS implementations, and tools. It stores keys on disk in a badger datastore, encrypting the keys before being stored in the datastore. Each time a key is fetched, it is decrypted first. A single password is used to encrypt all keys.
Multi-Language
usage
There are two ways to use krab, one is to import with import "github.com/RTradeLtd/krab/v4", the other is to use RTradeLtd/kaas which exposes krab functionality via a gRPC API.
limitations
Because badger is used as the underlying data store, a single badger datastore is unable to have multiple indepent readers/writers, only readers. If you are writing to the datastore (aka, storing keys) then you must use the gRPC version, as it enables usage of a single badger datastore via multiple different services.
future improvements
- Define groups of keys, with each group having a separate encryption password
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNoSuchKey is returned if a key of the given name is not found in the store ErrNoSuchKey = "no key by the given name was found" // ErrKeyExists is returned when writing a key would overwrite an existing key ErrKeyExists = "key by that name already exists, refusing to overwrite" // ErrKeyFmt is returned when the key's format is invalid ErrKeyFmt = "key has invalid format" )
Functions ¶
func ExportKeyAsMnemonic ¶
ExportKeyAsMnemonic is used to take an IPFS key, and return a human-readable friendly version. The idea is to allow users to easily export the keys they create, allowing them to take control of their records (ipns, tns, etc..)
Types ¶
type Keystore ¶
type Keystore struct {
// contains filtered or unexported fields
}
Keystore is used to manage an encrypted IPFS keystore
func NewKeystore ¶
NewKeystore is used to create a new krab ipfs keystore manager
Source Files