keys: Index | Examples | Files | Directories

package keys

import ""



Package Files

address.go box.go cert.go convert.go detect.go ed25519.go edx25519.go encode.go errors.go func.go hkdf.go id.go key.go log.go parse.go password.go rand.go secretbox.go sha.go sigchain.go sigchains.go ssh.go statement.go x25519.go


var ErrVerifyFailed = errors.New("verify failed")

ErrVerifyFailed if key verify failed.

func BoxOpen Uses

func BoxOpen(encrypted []byte, sender *X25519PublicKey, recipient *X25519Key) ([]byte, error)

BoxOpen decrypts a message from a sender.

func BoxSeal Uses

func BoxSeal(b []byte, recipient *X25519PublicKey, sender *X25519Key) []byte

BoxSeal encrypts a message to a recipient.


ak := keys.GenerateX25519Key()
bk := keys.GenerateX25519Key()

msg := "Hey bob, it's alice. The passcode is 12345."
encrypted := keys.BoxSeal([]byte(msg), bk.PublicKey(), ak)

out, err := keys.BoxOpen(encrypted, ak.PublicKey(), bk)
if err != nil {

fmt.Printf("%s\n", string(out))


Hey bob, it's alice. The passcode is 12345.

func Bytes16 Uses

func Bytes16(b []byte) *[16]byte

Bytes16 converts byte slice to *[16]byte.

func Bytes24 Uses

func Bytes24(b []byte) *[24]byte

Bytes24 converts byte slice to *[24]byte.

func Bytes32 Uses

func Bytes32(b []byte) *[32]byte

Bytes32 converts byte slice to *[32]byte.

func Bytes64 Uses

func Bytes64(b []byte) *[64]byte

Bytes64 converts byte slice to *[64]byte.

func DecryptWithPassword Uses

func DecryptWithPassword(encrypted []byte, password string) ([]byte, error)

DecryptWithPassword decrypts bytes using a password. It assumes a 16 byte salt before the encrypted bytes.

func EncodeKey Uses

func EncodeKey(key Key, enc Encoding, password string) (string, error)

EncodeKey encodes the key using the specified encoding.

func EncodeSSHKey Uses

func EncodeSSHKey(key Key, password string) (string, error)

EncodeSSHKey encodes key to SSH.


sk := keys.GenerateEdX25519Key()

privateKey, err := keys.EncodeSSHKey(sk, "testpassword")
if err != nil {
log.Printf("%s\n", privateKey)

publicKey, err := keys.EncodeSSHKey(sk.PublicKey(), "")
if err != nil {
log.Printf("%s\n", publicKey)

func EncodeSaltpackKey Uses

func EncodeSaltpackKey(key Key, password string) (string, error)

EncodeSaltpackKey encrypts a key to saltpack with password.

func EncryptWithPassword Uses

func EncryptWithPassword(b []byte, password string) []byte

EncryptWithPassword encrypts bytes with a password. Uses argon2.IDKey(password, salt, 1, 64*1024, 4, 32) with 16 byte salt. The salt bytes are prepended to the encrypted bytes. This uses nacl.secretbox, so the bytes/message should be small. If you need to encrypt large amounts of data, use Saltpack instead (TODO: More details here).

func HKDFSHA256 Uses

func HKDFSHA256(secret []byte, len int, salt []byte, info []byte) []byte

HKDFSHA256 expands a secret into another secret using HKDF with SHA256. The `len` for output byte length. The `salt` is non-secret salt, optional (can be nil), recommended: hash-length random value. The `info` is non-secret context info, optional (can be empty).

func HMACSHA256 Uses

func HMACSHA256(key []byte, msg []byte) []byte

HMACSHA256 does a HMAC-SHA256 on msg with key.

func IDsToString Uses

func IDsToString(ids []ID, delim string) string

IDsToString returns string for joined Ikeys.

func IDsToStrings Uses

func IDsToStrings(ids []ID) []string

IDsToStrings returns []strings for []ID.

func IsTemporaryError Uses

func IsTemporaryError(err error) bool

IsTemporaryError returns true if the error has Temporary() function and that returns true

func IsValidID Uses

func IsValidID(s string) bool

IsValidID returns true if string is a valid ID.

func KeyForPassword Uses

func KeyForPassword(password string, salt []byte) (*[32]byte, error)

KeyForPassword generates a key from a password and salt.

func NewErrNotFound Uses

func NewErrNotFound(id string) error

NewErrNotFound constructs a ErrNotFound.

func Rand16 Uses

func Rand16() *[16]byte

Rand16 generates random 16 bytes.

func Rand24 Uses

func Rand24() *[24]byte

Rand24 generates random 24 bytes.

func Rand32 Uses

func Rand32() *[32]byte

Rand32 generates random 32 bytes.

func RandBytes Uses

func RandBytes(length int) []byte

RandBytes returns random bytes of length.

func RandFileName Uses

func RandFileName() string

RandFileName returns a unique random file name. RandFileName() => CTGMMOLLZCXMGP7VR4BHKAI7PE

func RandPassword Uses

func RandPassword(length int) string

RandPassword returns a random password. It uses a-zA-Z0-9. It will contain an uppercase, a lowercase and a number. It will try not to repeat characters.

func RandPhrase Uses

func RandPhrase() string

RandPhrase creates random phrase (BIP39 encoded random 32 bytes).

func RandTempPath Uses

func RandTempPath() string

RandTempPath returns a unique random file name in os.TempDir. RandTempPath() => "/tmp/CTGMMOLLZCXMGP7VR4BHKAI7PE"

func RandUsername Uses

func RandUsername(length int) string

RandUsername returns random lowercase string of length.

func RandWords Uses

func RandWords(numWords int) string

RandWords returns random (BIP39) words. numWords must be 1 to 24.

func RetryE Uses

func RetryE(fn func() error) error

RetryE will retry the fn (error) if the error is temporary (such as a temporary net.Error)

func RetrySE Uses

func RetrySE(fn func() (string, error)) (string, error)

RetrySE will retry the fn (string, error) if the error is temporary (such as a temporary net.Error)

func SecretBoxOpen Uses

func SecretBoxOpen(encrypted []byte, secretKey *[32]byte) ([]byte, error)

SecretBoxOpen decrypt using a key. It assumes a 24 byte nonce before the encrypted bytes.

func SecretBoxSeal Uses

func SecretBoxSeal(b []byte, secretKey *[32]byte) []byte

SecretBoxSeal encrypts using a key. It prepends a 24 byte nonce to the the encrypted bytes.

func SetLogger Uses

func SetLogger(l Logger)

SetLogger sets logger for the package.

func SigchainHash Uses

func SigchainHash(st *Statement) (*[32]byte, error)

SigchainHash returns hash for Sigchain Statement.

func StatementID Uses

func StatementID(kid ID, seq int) string

StatementID returns and identifier for a Statement as kid-seq. If seq is <= 0, returns kid. The idenfifier looks like "kex1a4yj333g68pvd6hfqvufqkv4vy54jfe6t33ljd3kc9rpfty8xlgsfte2sn-000000000000001".

func X25519Match Uses

func X25519Match(expected ID, kid ID) bool

X25519Match returns true if key IDs are equal or if either key matches their X25519 counterpart.

type Address Uses

type Address struct {
    // contains filtered or unexported fields

Address is a canonical list of IDs.

func NewAddress Uses

func NewAddress(ids ...ID) (*Address, error)

NewAddress returns an Address from a list of IDs.

func ParseAddress Uses

func ParseAddress(saddrs ...string) (*Address, error)

ParseAddress returns address from a string.

func (*Address) Contains Uses

func (a *Address) Contains(id ID) bool

Contains returns true if address contains the specified id.

func (*Address) String Uses

func (a *Address) String() string

String returns a canonical string representation of an address. The first address part is less than the second part.

NewAddress("bob", "alice").String() => "alice:bob"

func (*Address) Strings Uses

func (a *Address) Strings() []string

Strings returns IDs as strings.

type Brand Uses

type Brand string

Brand is saltpack brand.

const EdX25519Brand Brand = "EDX25519 KEY"

EdX25519Brand is saltpack brand for EdX25519 key.

const X25519Brand Brand = "X25519 KEY"

X25519Brand is saltpack brand for X25519 key.

type CertificateKey Uses

type CertificateKey struct {
    // contains filtered or unexported fields

CertificateKey with is a PEM encoded X.509v3 certificate (public key) and a PEM encoded EC private key.

func GenerateCertificateKey Uses

func GenerateCertificateKey(commonName string, isCA bool, parent *x509.Certificate) (*CertificateKey, error)

GenerateCertificateKey creates a certificate key.

func NewCertificateKey Uses

func NewCertificateKey(private string, public string) (*CertificateKey, error)

NewCertificateKey from PEM encoded X.509v3 certificate data and PEM encoded EC private key ASN.1, DER format

func (CertificateKey) Private Uses

func (c CertificateKey) Private() string

Private returns a PEM encoded EC private key ASN.1, DER format.

func (CertificateKey) Public Uses

func (c CertificateKey) Public() string

Public returns a PEM encoded X.509v3 certificate.

func (CertificateKey) TLSCertificate Uses

func (c CertificateKey) TLSCertificate() tls.Certificate

TLSCertificate returns a tls.Certificate.

func (CertificateKey) X509Certificate Uses

func (c CertificateKey) X509Certificate() (*x509.Certificate, error)

X509Certificate returns a x509.Certificate.

type EdX25519Key Uses

type EdX25519Key struct {
    // contains filtered or unexported fields

EdX25519Key is a EdX25519 key capable of signing and encryption (converted to a X25519 key).

func GenerateEdX25519Key Uses

func GenerateEdX25519Key() *EdX25519Key

GenerateEdX25519Key generates a EdX25519Key (EdX25519).


alice := keys.GenerateEdX25519Key()
fmt.Printf("Alice: %s\n", alice.ID())

func NewEdX25519KeyFromPrivateKey Uses

func NewEdX25519KeyFromPrivateKey(privateKey *[ed25519.PrivateKeySize]byte) *EdX25519Key

NewEdX25519KeyFromPrivateKey constructs EdX25519Key from a private key. The public key is derived from the private key.

func NewEdX25519KeyFromSeed Uses

func NewEdX25519KeyFromSeed(seed *[ed25519.SeedSize]byte) *EdX25519Key

NewEdX25519KeyFromSeed constructs EdX25519Key from an ed25519 seed. The private key is derived from this seed and the public key is derived from the private key.

func (*EdX25519Key) Bytes Uses

func (k *EdX25519Key) Bytes() []byte

Bytes for key.

func (*EdX25519Key) Bytes64 Uses

func (k *EdX25519Key) Bytes64() *[64]byte

Bytes64 for key.

func (*EdX25519Key) EncodeToSSH Uses

func (k *EdX25519Key) EncodeToSSH(password []byte) ([]byte, error)

EncodeToSSH encodes a EdX25519Key for SSH.

func (*EdX25519Key) Equal Uses

func (k *EdX25519Key) Equal(o *EdX25519Key) bool

Equal returns true if equal to key.

func (*EdX25519Key) ID Uses

func (k *EdX25519Key) ID() ID

ID ...

func (*EdX25519Key) MarshalText Uses

func (k *EdX25519Key) MarshalText() ([]byte, error)

MarshalText for encoding.TextMarshaler interface.

func (*EdX25519Key) PrivateKey Uses

func (k *EdX25519Key) PrivateKey() *[ed25519.PrivateKeySize]byte

PrivateKey returns private key part.

func (*EdX25519Key) PublicKey Uses

func (k *EdX25519Key) PublicKey() *EdX25519PublicKey

PublicKey returns public part.

func (*EdX25519Key) SSHSigner Uses

func (k *EdX25519Key) SSHSigner() ssh.Signer

SSHSigner interface.

func (*EdX25519Key) Seed Uses

func (k *EdX25519Key) Seed() *[ed25519.SeedSize]byte

Seed returns information on how to generate this key from ed25519 package seed.

func (*EdX25519Key) Sign Uses

func (k *EdX25519Key) Sign(b []byte) []byte

Sign bytes with the (sign) private key.


alice := keys.GenerateEdX25519Key()
msg := "I'm alice 🤓"
sig := alice.Sign([]byte(msg))
out, err := alice.PublicKey().Verify(sig)
if err != nil {
fmt.Printf("%s\n", string(out))


I'm alice 🤓

func (*EdX25519Key) SignDetached Uses

func (k *EdX25519Key) SignDetached(b []byte) []byte

SignDetached sign bytes detached.

func (*EdX25519Key) Signer Uses

func (k *EdX25519Key) Signer() crypto.Signer

Signer interface.

func (*EdX25519Key) String Uses

func (k *EdX25519Key) String() string

func (*EdX25519Key) Type Uses

func (k *EdX25519Key) Type() KeyType

Type ...

func (*EdX25519Key) UnmarshalText Uses

func (k *EdX25519Key) UnmarshalText(s []byte) error

UnmarshalText for encoding.TextUnmarshaler interface.

func (*EdX25519Key) X25519Key Uses

func (k *EdX25519Key) X25519Key() *X25519Key

X25519Key converts EdX25519Key to X25519Key.

type EdX25519PublicKey Uses

type EdX25519PublicKey struct {
    // contains filtered or unexported fields

EdX25519PublicKey is the public part of EdX25519 key pair.

func NewEdX25519PublicKey Uses

func NewEdX25519PublicKey(b *[ed25519.PublicKeySize]byte) *EdX25519PublicKey

NewEdX25519PublicKey creates a EdX25519PublicKey.

func NewEdX25519PublicKeyFromID Uses

func NewEdX25519PublicKeyFromID(id ID) (*EdX25519PublicKey, error)

NewEdX25519PublicKeyFromID creates a EdX25519PublicKey from an ID.

func (*EdX25519PublicKey) Bytes Uses

func (s *EdX25519PublicKey) Bytes() []byte

Bytes for key.

func (*EdX25519PublicKey) Bytes32 Uses

func (s *EdX25519PublicKey) Bytes32() *[32]byte

Bytes32 for key.

func (*EdX25519PublicKey) EncodeToSSHAuthorized Uses

func (k *EdX25519PublicKey) EncodeToSSHAuthorized() []byte

EncodeToSSHAuthorized encodes a EdX25519PublicKey for SSH.

func (*EdX25519PublicKey) ID Uses

func (s *EdX25519PublicKey) ID() ID

ID for EdX25519Key.

func (*EdX25519PublicKey) String Uses

func (s *EdX25519PublicKey) String() string

func (*EdX25519PublicKey) Type Uses

func (s *EdX25519PublicKey) Type() KeyType

Type ...

func (*EdX25519PublicKey) Verify Uses

func (s *EdX25519PublicKey) Verify(b []byte) ([]byte, error)

Verify verifies a message and signature with public key.

func (*EdX25519PublicKey) VerifyDetached Uses

func (s *EdX25519PublicKey) VerifyDetached(sig []byte, b []byte) error

VerifyDetached verifies a detached message.

func (*EdX25519PublicKey) X25519PublicKey Uses

func (s *EdX25519PublicKey) X25519PublicKey() *X25519PublicKey

X25519PublicKey converts the ed25519 public key to a x25519 public key.

type Encoding Uses

type Encoding string

Encoding is the type of data.

const (
    // UnknownEncoding is unknown.
    UnknownEncoding Encoding = ""

    // IDEncoding is a key ID string.
    IDEncoding Encoding = "id"

    // SaltpackEncoding is armored saltpack encoding.
    SaltpackEncoding Encoding = "saltpack"

    // SSHEncoding is ssh private key "-----BEGIN OPENSSH PRIVATE..."
    // or public key as "ssh-ed25519 AAAAC3Nz..."
    SSHEncoding Encoding = "ssh"

func DetectEncoding Uses

func DetectEncoding(b []byte) ([]byte, Encoding)

DetectEncoding tries to find out what encoding the bytes are. Returns bytes which may be different from input (for example, if whitespace is stripped).

type ErrNotFound Uses

type ErrNotFound struct {
    ID string

ErrNotFound describes a key not found error when a key is required.

func (ErrNotFound) Error Uses

func (e ErrNotFound) Error() string

type ID Uses

type ID string

ID is a bech32 encoded string.

func MustID Uses

func MustID(hrp string, b []byte) ID

MustID returns a (bech32) ID with HRP (human readable part) and bytes, or panics if invalid.

func NewID Uses

func NewID(hrp string, b []byte) (ID, error)

NewID creates ID from HRP (human readable part) and bytes.

func ParseID Uses

func ParseID(s string) (ID, error)

ParseID parses a string and validates an ID.

func ParseIDs Uses

func ParseIDs(strs []string) ([]ID, error)

ParseIDs returns IDs from strings.

func RandID Uses

func RandID(hrp string) ID

RandID returns a random (bech32) ID.

func (ID) Bytes Uses

func (i ID) Bytes() []byte

Bytes are public key data (for Key interface).

func (ID) Decode Uses

func (i ID) Decode() (string, []byte, error)

Decode ID into HRP (human readable part) and bytes (data).

func (ID) ID Uses

func (i ID) ID() ID

ID for Keys interface.

func (ID) IsEdX25519 Uses

func (i ID) IsEdX25519() bool

IsEdX25519 returns true if ID represents a EdX25519 key.

func (ID) IsX25519 Uses

func (i ID) IsX25519() bool

IsX25519 returns true if ID represents a X25519 key.

func (ID) PublicKeyType Uses

func (i ID) PublicKeyType() KeyType

PublicKeyType returns public key type that ID represents or empty string if unknown.

func (ID) String Uses

func (i ID) String() string

func (ID) Type Uses

func (i ID) Type() KeyType

Type of key.

func (ID) WithSeq Uses

func (i ID) WithSeq(seq int) string

WithSeq returns string with a sequence value appended to the ID.

type IDSet Uses

type IDSet struct {
    // contains filtered or unexported fields

IDSet is a set of strings.

func NewIDSet Uses

func NewIDSet(ids ...ID) *IDSet

NewIDSet creates IDSet.

func NewIDSetWithCapacity Uses

func NewIDSetWithCapacity(capacity int) *IDSet

NewIDSetWithCapacity ..

func (*IDSet) Add Uses

func (s *IDSet) Add(id ID)

Add to set.

func (*IDSet) AddAll Uses

func (s *IDSet) AddAll(ids []ID)

AddAll to set.

func (*IDSet) Clear Uses

func (s *IDSet) Clear()

Clear set.

func (*IDSet) Contains Uses

func (s *IDSet) Contains(id ID) bool

Contains returns true if set contains string.

func (*IDSet) IDs Uses

func (s *IDSet) IDs() []ID

IDs returns IDs in set.

func (*IDSet) Size Uses

func (s *IDSet) Size() int

Size for set.

type Key Uses

type Key interface {
    // ID for the key.
    ID() ID

    // Type of key.
    Type() KeyType

    // Bytes are key data.
    Bytes() []byte

Key with identifier, bytes and a type.

func Convert Uses

func Convert(key Key, to KeyType) (Key, error)

Convert tries to convert a Key to another key type. This currently only converts a EdX25519Public key to a X25519Public key.

func DecodeKey Uses

func DecodeKey(s string, enc Encoding, password string) (Key, error)

DecodeKey decodes a key using the specified encoding. If you don't know the encoding you can try ParseKey instead.

func DecodeSSHKey Uses

func DecodeSSHKey(s string, password string) (Key, error)

DecodeSSHKey decodes SSH key.


pk, err := keys.DecodeSSHKey("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIqI4910CfGV/VLbLTy6XXLKZwm/HZQSG/N0iAG0D29c", "")
if err != nil {
fmt.Printf("%s\n", pk.ID())



func DecodeSaltpackKey Uses

func DecodeSaltpackKey(msg string, password string, isHTML bool) (Key, error)

DecodeSaltpackKey decrypts a saltpack encrypted key.


	AY6gPAVx9JSUsLg 3K8CNqUyNY87qiL FNNp7UBsIcvObJK mRtDzpcwQU1XpYa
	64FF0g4O0sDrhV4 qlp52vdQ5PG77D8 046ZdckukUl6reZ inOEqkDuOg5hynz
	k95BEExR31Sqenh rdqT3ADIdPu8f4f aXQaFejAp3Cb.
key, err := keys.DecodeSaltpackKey(msg, "testpassword", true)
if err != nil {
fmt.Printf("%s\n", key.ID())



func ParseKey Uses

func ParseKey(b []byte, password string) (Key, error)

ParseKey tries to determine what key type and parses the key bytes.

func ParseSSHKey Uses

func ParseSSHKey(pemBytes []byte, passphrase []byte, trim bool) (Key, error)

ParseSSHKey parses a SSH private key.

func ParseSSHPublicKey Uses

func ParseSSHPublicKey(s string) (Key, error)

ParseSSHPublicKey parses a SSH public key.

type KeyType Uses

type KeyType string

KeyType ...

const EdX25519 KeyType = "edx25519"

EdX25519 key type.

const EdX25519Public KeyType = "ed25519-public"

EdX25519Public public key type. TODO: Public key type name should be edx25519-public?

const X25519 KeyType = "x25519"

X25519 key type.

const X25519Public KeyType = "x25519-public"

X25519Public public key type.

type LogLevel Uses

type LogLevel int

LogLevel ...

const (
    // DebugLevel ...
    DebugLevel LogLevel = 3
    // InfoLevel ...
    InfoLevel LogLevel = 2
    // WarnLevel ...
    WarnLevel LogLevel = 1
    // ErrLevel ...
    ErrLevel LogLevel = 0

func (LogLevel) String Uses

func (l LogLevel) String() string

type Logger Uses

type Logger interface {
    Debugf(format string, args ...interface{})
    Infof(format string, args ...interface{})
    Warningf(format string, args ...interface{})
    Errorf(format string, args ...interface{})
    Fatalf(format string, args ...interface{})

Logger interface used in this package.

func NewLogger Uses

func NewLogger(lev LogLevel) Logger

NewLogger ...

type Sigchain Uses

type Sigchain struct {
    // contains filtered or unexported fields

Sigchain is a chain of signed statements by a sign key.

func NewSigchain Uses

func NewSigchain(kid ID) *Sigchain

NewSigchain creates an empty Sigchain.


clock := tsutil.NewTestClock()
alice := keys.GenerateEdX25519Key()
sc := keys.NewSigchain(alice.ID())

// Create root statement
st, err := keys.NewSigchainStatement(sc, []byte("hi! 🤓"), alice, "example", clock.Now())
if err != nil {
if err := sc.Add(st); err != nil {

// Add 2nd statement
st2, err := keys.NewSigchainStatement(sc, []byte("2nd message"), alice, "example", clock.Now())
if err != nil {
if err := sc.Add(st2); err != nil {

// Revoke 2nd statement
_, err = sc.Revoke(2, alice)
if err != nil {

// Spew
spew := sc.Spew()

func (*Sigchain) Add Uses

func (s *Sigchain) Add(st *Statement) error

Add signed statement to the Sigchain.

func (*Sigchain) AddAll Uses

func (s *Sigchain) AddAll(statements []*Statement) error

AddAll pushes signed statements to the Sigchain.

func (*Sigchain) FindAll Uses

func (s *Sigchain) FindAll(typ string) []*Statement

FindAll returns statements of type.

func (*Sigchain) FindLast Uses

func (s *Sigchain) FindLast(typ string) *Statement

FindLast search from the last statement to the first, returning after If type is specified, we will search for that statement type. If we found a statement and it was revoked, we return nil.

func (*Sigchain) IsRevoked Uses

func (s *Sigchain) IsRevoked(seq int) bool

IsRevoked returns true if statement was revoked.

func (*Sigchain) KID Uses

func (s *Sigchain) KID() ID

KID ...

func (*Sigchain) Last Uses

func (s *Sigchain) Last() *Statement

Last returns last statement or nil if none.

func (*Sigchain) LastSeq Uses

func (s *Sigchain) LastSeq() int

LastSeq returns last signed statment seq (or 0 if no signed statements exist).

func (*Sigchain) Length Uses

func (s *Sigchain) Length() int

Length of Sigchain.

func (*Sigchain) Revoke Uses

func (s *Sigchain) Revoke(revoke int, sk *EdX25519Key) (*Statement, error)

Revoke a signed statement in the Sigchain.

func (*Sigchain) Spew Uses

func (s *Sigchain) Spew() *bytes.Buffer

Spew shows formatted sigchain output.

func (*Sigchain) Statements Uses

func (s *Sigchain) Statements() []*Statement

Statements returns all the signed statements.

func (*Sigchain) VerifyStatement Uses

func (s *Sigchain) VerifyStatement(st *Statement, prev *Statement) error

VerifyStatement verifies a signed statement against a previous statement (in a Sigchain).

type Sigchains Uses

type Sigchains struct {
    // contains filtered or unexported fields

Sigchains stores sigchains.

func NewSigchains Uses

func NewSigchains(ds dstore.Documents) *Sigchains

NewSigchains creates a Sigchains from Documents.

func (*Sigchains) Delete Uses

func (s *Sigchains) Delete(kid ID) (bool, error)

Delete sigchain.

func (*Sigchains) Exists Uses

func (s *Sigchains) Exists(kid ID) (bool, error)

Exists returns true if sigchain exists.

func (*Sigchains) Index Uses

func (s *Sigchains) Index(key Key) error

Index key identifier.

func (*Sigchains) KIDs Uses

func (s *Sigchains) KIDs() ([]ID, error)

KIDs returns all keys.

func (*Sigchains) Lookup Uses

func (s *Sigchains) Lookup(kid ID) (ID, error)

Lookup key identifier.

func (*Sigchains) Save Uses

func (s *Sigchains) Save(sc *Sigchain) error

Save sigchain.

func (*Sigchains) SetClock Uses

func (s *Sigchains) SetClock(clock tsutil.Clock)

SetClock to use a custom time.Now.

func (*Sigchains) Sigchain Uses

func (s *Sigchains) Sigchain(kid ID) (*Sigchain, error)

Sigchain returns sigchain for key.

type Statement Uses

type Statement struct {
    // Sig is the signature bytes.
    Sig []byte

    // KID is the key that signed.
    KID ID

    // Data (optional).
    Data []byte

    // Seq in a sigchain (1 is root, optional).
    Seq int
    // Prev is a hash of the previous item in the sigchain (optional).
    Prev []byte
    // Revoke refers to a previous signed seq to revoke (optional).
    Revoke int

    // Type (optional).
    Type string

    // Timestamp (optional).
    Timestamp time.Time

    // Nonce (optional).
    Nonce []byte

Statement with signature. Use NewSigchainStatement to create a signed Sigchain Statement.


sk := keys.NewEdX25519KeyFromSeed(testSeed(0x01))

st := &keys.Statement{
    KID:  sk.ID(),
    Data: bytes.Repeat([]byte{0x01}, 16),
    Type: "test",
if err := st.Sign(sk); err != nil {

data := st.BytesToSign()
fmt.Printf("%s\n", string(data))

b, err := st.Bytes()
if err != nil {
fmt.Printf("%s\n", string(b))

b, err = json.Marshal(st)
if err != nil {
fmt.Printf("%s\n", string(b))



func NewRevokeStatement Uses

func NewRevokeStatement(sc *Sigchain, revoke int, sk *EdX25519Key) (*Statement, error)

NewRevokeStatement creates a revoke Statement.

func NewSigchainStatement Uses

func NewSigchainStatement(sc *Sigchain, b []byte, sk *EdX25519Key, typ string, ts time.Time) (*Statement, error)

NewSigchainStatement creates a signed Statement to be added to the Sigchain.

func (*Statement) Bytes Uses

func (s *Statement) Bytes() ([]byte, error)

Bytes is the serialized Statement.

func (*Statement) BytesToSign Uses

func (s *Statement) BytesToSign() []byte

BytesToSign returns bytes to sign.

func (*Statement) MarshalJSON Uses

func (s *Statement) MarshalJSON() ([]byte, error)

MarshalJSON marshals statement to JSON.

func (*Statement) Sign Uses

func (s *Statement) Sign(signKey *EdX25519Key) error

Sign the statement. Returns an error if already signed.

func (*Statement) URL Uses

func (s *Statement) URL() string

URL returns path string for a Statement in the HTTP API. If Seq is not set, then there is no path. Path looks like "/kex1a4yj333g68pvd6hfqvufqkv4vy54jfe6t33ljd3kc9rpfty8xlgsfte2sn/1".

func (*Statement) UnmarshalJSON Uses

func (s *Statement) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals a statement from JSON.

func (*Statement) Verify Uses

func (s *Statement) Verify() error

Verify statement. If you have the original bytes use VerifySpecific.

func (*Statement) VerifySpecific Uses

func (s *Statement) VerifySpecific(bytesToSign []byte) error

VerifySpecific and check that bytesToSign match the statement's BytesToSign, to verify the original bytes match the specific serialization.

type StatementPublicKey Uses

type StatementPublicKey interface {
    ID() ID
    Verify(b []byte) ([]byte, error)
    VerifyDetached(sig []byte, b []byte) error

StatementPublicKey describes a public key for a Statement.

func StatementPublicKeyFromID Uses

func StatementPublicKeyFromID(id ID) (StatementPublicKey, error)

StatementPublicKeyFromID converts ID to StatementPublicKey. TODO: Support other key types.

type X25519Key Uses

type X25519Key struct {
    // contains filtered or unexported fields

X25519Key is a X25519 assymmetric encryption key.

func GenerateX25519Key Uses

func GenerateX25519Key() *X25519Key

GenerateX25519Key creates a new X25519Key.


alice := keys.GenerateX25519Key()
fmt.Printf("Alice: %s\n", alice.ID())

func NewX25519KeyFromPrivateKey Uses

func NewX25519KeyFromPrivateKey(privateKey *[32]byte) *X25519Key

NewX25519KeyFromPrivateKey creates a X25519Key from private key bytes.

func NewX25519KeyFromSeed Uses

func NewX25519KeyFromSeed(seed *[32]byte) *X25519Key

NewX25519KeyFromSeed from seed.

func (*X25519Key) BoxOpen Uses

func (k *X25519Key) BoxOpen(b []byte, nonce *[24]byte, sender *X25519PublicKey) ([]byte, bool)

BoxOpen decrypts message with Open.

func (*X25519Key) BoxSeal Uses

func (k *X25519Key) BoxSeal(b []byte, nonce *[24]byte, recipient *X25519PublicKey) []byte

BoxSeal encrypts message with Seal.

func (*X25519Key) Bytes Uses

func (k *X25519Key) Bytes() []byte

Bytes for key.

func (*X25519Key) Bytes32 Uses

func (k *X25519Key) Bytes32() *[32]byte

Bytes32 for key.

func (*X25519Key) ID Uses

func (k *X25519Key) ID() ID

ID is key identifer.

func (*X25519Key) PrivateKey Uses

func (k *X25519Key) PrivateKey() *[32]byte

PrivateKey returns private part of this X25519Key.

func (*X25519Key) PublicKey Uses

func (k *X25519Key) PublicKey() *X25519PublicKey

PublicKey returns public part of this X25519Key.

func (*X25519Key) Type Uses

func (k *X25519Key) Type() KeyType

Type of key.

type X25519PublicKey Uses

type X25519PublicKey struct {
    // contains filtered or unexported fields

X25519PublicKey is the public key part of a x25519 key.

func NewX25519PublicKey Uses

func NewX25519PublicKey(b *[32]byte) *X25519PublicKey

NewX25519PublicKey creates X25519PublicKey. Metadata is optional.

func NewX25519PublicKeyFromID Uses

func NewX25519PublicKeyFromID(id ID) (*X25519PublicKey, error)

NewX25519PublicKeyFromID converts ID to X25519PublicKey.

func (*X25519PublicKey) Bytes Uses

func (k *X25519PublicKey) Bytes() []byte

Bytes for key.

func (*X25519PublicKey) Bytes32 Uses

func (k *X25519PublicKey) Bytes32() *[32]byte

Bytes32 for key.

func (*X25519PublicKey) ID Uses

func (k *X25519PublicKey) ID() ID

ID for box public key.

func (*X25519PublicKey) Type Uses

func (k *X25519PublicKey) Type() KeyType

Type of key.


apiPackage api provides a standard key format for serialization to JSON or msgpack, and conversions to and from specific key types.
bech32Package bech32 is a modified version of the reference implementation of BIP173.
docsPackage docs provides a document store.
dstorePackage dstore describes a document store.
dstore/eventsPackage events provides an event log.
encodingPackage encoding provides encoding and decoding of different formats like Base62, Saltpack, BIP39.
envPackage env provides paths on different platforms.
jsonPackage json provides a simpler JSON marshaller for strings and ints only.
keyringPackage keyring provides a cross-platform secure keyring.
linkPackage link defines services capable of linking keys to users.
noisePackage noise integrates keys with the Noise protocol.
requestPackage request provides clients for requesting data.
saltpackPackage saltpack integrates keys with Saltpack (
tsutilPackage tsutil provides timestamp and time utilities.
userPackage user defines user statements, store and search.

Package keys imports 46 packages (graph) and is imported by 22 packages. Updated 2020-11-25. Refresh now. Tools for package owners.