keys · pkg.go.dev

README

keys.pub

☢ This project is in development and has not been audited or reviewed. Use at your own risk. ☢

Documentation

Repositories

Repo	Description
keys-pub/keys	Key management, signing and encryption, including keys/saltpack and keys/keyring.
keys-pub/keys-ext	Extensions: Service (gRPC), command line client, DB, Firestore, HTTP API/Client/Server, Git, Wormhole, etc.
keys-pub/app	Desktop app.

Expand ▾ Collapse ▴

Documentation

Index ¶

Constants
Variables
func BoxOpen(encrypted []byte, sender *X25519PublicKey, recipient *X25519Key) ([]byte, error)
func BoxSeal(b []byte, recipient *X25519PublicKey, sender *X25519Key) []byte
func Bytes16(b []byte) *[16]byte
func Bytes24(b []byte) *[24]byte
func Bytes32(b []byte) *[32]byte
func Bytes64(b []byte) *[64]byte
func CryptoBoxSeal(b []byte, publicKey *X25519PublicKey) []byte
func CryptoBoxSealOpen(b []byte, key *X25519Key) ([]byte, error)
func DecryptWithPassword(encrypted []byte, password string) ([]byte, error)
func EncodeKey(key Key, enc Encoding, password string) (string, error)
func EncodeSSHKey(key Key, password string) (string, error)
func EncodeSaltpackKey(key Key, password string) (string, error)
func EncryptWithPassword(b []byte, password string) []byte
func HKDFSHA256(secret []byte, len int, salt []byte, info []byte) []byte
func HMACSHA256(key []byte, msg []byte) []byte
func IDsToString(ids []ID, delim string) string
func IDsToStrings(ids []ID) []string
func IsTemporaryError(err error) bool
func IsValidID(s string) bool
func KeyForPassword(password string, salt []byte) (*[32]byte, error)
func NewErrNotFound(id string) error
func Rand16() *[16]byte
func Rand24() *[24]byte
func Rand32() *[32]byte
func RandBytes(length int) []byte
func RandFileName() string
func RandHex(numBytes int) string
func RandPassword(length int) string
func RandPhrase() string
func RandTempPath() string
func RandUsername(length int) string
func RandWords(numWords int) string
func RetryE(fn func() error) error
func RetrySE(fn func() (string, error)) (string, error)
func SecretBoxOpen(encrypted []byte, secretKey *[32]byte) ([]byte, error)
func SecretBoxSeal(b []byte, secretKey *[32]byte) []byte
func SetLogger(l Logger)
func SigchainHash(st *Statement) (*[32]byte, error)
func StatementID(kid ID, seq int) string
func X25519Match(expected ID, kid ID) bool
type Address
- func NewAddress(ids ...ID) (*Address, error)
- func ParseAddress(saddrs ...string) (*Address, error)
- func (a *Address) Contains(id ID) bool
- func (a *Address) String() string
- func (a *Address) Strings() []string
type Brand
type CertificateKey
- func GenerateCertificateKey(commonName string, isCA bool, parent *x509.Certificate) (*CertificateKey, error)
- func NewCertificateKey(private string, public string) (*CertificateKey, error)
- func (c CertificateKey) Private() string
- func (c CertificateKey) Public() string
- func (c CertificateKey) TLSCertificate() tls.Certificate
- func (c CertificateKey) X509Certificate() (*x509.Certificate, error)
type EdX25519Key
- func GenerateEdX25519Key() *EdX25519Key
- func NewEdX25519KeyFromPrivateKey(privateKey *[ed25519.PrivateKeySize]byte) *EdX25519Key
- func NewEdX25519KeyFromSeed(seed *[ed25519.SeedSize]byte) *EdX25519Key
- func (k *EdX25519Key) EncodeToSSH(password []byte) ([]byte, error)
- func (k *EdX25519Key) Equal(o *EdX25519Key) bool
- func (k *EdX25519Key) ID() ID
- func (k *EdX25519Key) MarshalText() ([]byte, error)
- func (k *EdX25519Key) Private() []byte
- func (k *EdX25519Key) PrivateKey() *[ed25519.PrivateKeySize]byte
- func (k *EdX25519Key) Public() []byte
- func (k *EdX25519Key) PublicKey() *EdX25519PublicKey
- func (k *EdX25519Key) SSHSigner() ssh.Signer
- func (k *EdX25519Key) Seed() *[ed25519.SeedSize]byte
- func (k *EdX25519Key) Sign(b []byte) []byte
- func (k *EdX25519Key) SignDetached(b []byte) []byte
- func (k *EdX25519Key) Signer() crypto.Signer
- func (k *EdX25519Key) String() string
- func (k *EdX25519Key) Type() KeyType
- func (k *EdX25519Key) UnmarshalText(s []byte) error
- func (k *EdX25519Key) X25519Key() *X25519Key
type EdX25519PublicKey
- func NewEdX25519PublicKey(b *[ed25519.PublicKeySize]byte) *EdX25519PublicKey
- func NewEdX25519PublicKeyFromID(id ID) (*EdX25519PublicKey, error)
- func (k *EdX25519PublicKey) Bytes() []byte
- func (k *EdX25519PublicKey) EncodeToSSHAuthorized() []byte
- func (k *EdX25519PublicKey) ID() ID
- func (k *EdX25519PublicKey) Private() []byte
- func (k *EdX25519PublicKey) Public() []byte
- func (k *EdX25519PublicKey) String() string
- func (k *EdX25519PublicKey) Type() KeyType
- func (k *EdX25519PublicKey) Verify(b []byte) ([]byte, error)
- func (k *EdX25519PublicKey) VerifyDetached(sig []byte, b []byte) error
- func (k *EdX25519PublicKey) X25519PublicKey() *X25519PublicKey
type Encoding
- func DetectEncoding(b []byte) ([]byte, Encoding)
type ErrNotFound
- func (e ErrNotFound) Error() string
type ID
- func MustID(hrp string, b []byte) ID
- func NewID(hrp string, b []byte) (ID, error)
- func ParseID(s string) (ID, error)
- func ParseIDs(strs []string) ([]ID, error)
- func RandID(hrp string) ID
- func (i ID) Decode() (string, []byte, error)
- func (i ID) ID() ID
- func (i ID) IsEdX25519() bool
- func (i ID) IsX25519() bool
- func (i ID) Private() []byte
- func (i ID) Public() []byte
- func (i ID) String() string
- func (i ID) Type() KeyType
- func (i ID) UUID() *[16]byte
- func (i ID) WithSeq(seq int) string
type IDSet
- func NewIDSet(ids ...ID) *IDSet
- func NewIDSetWithCapacity(capacity int) *IDSet
- func (s *IDSet) Add(id ID)
- func (s *IDSet) AddAll(ids []ID)
- func (s *IDSet) Clear()
- func (s *IDSet) Contains(id ID) bool
- func (s *IDSet) IDs() []ID
- func (s *IDSet) Size() int
type Key
- func DecodeKey(s string, enc Encoding, password string) (Key, error)
- func DecodeSSHKey(s string, password string) (Key, error)
- func DecodeSaltpackKey(msg string, password string, isHTML bool) (Key, error)
- func ParseKey(b []byte, password string) (Key, error)
- func ParseSSHKey(pemBytes []byte, passphrase []byte, trim bool) (Key, error)
- func ParseSSHPublicKey(s string) (Key, error)
type KeyType
type LogLevel
- func (l LogLevel) String() string
type Logger
- func NewLogger(lev LogLevel) Logger
type RSAKey
- func GenerateRSAKey() *RSAKey
- func NewRSAKey(k *rsa.PrivateKey) *RSAKey
- func NewRSAKeyFromBytes(privateKey []byte) (*RSAKey, error)
- func (k *RSAKey) ID() ID
- func (k *RSAKey) Private() []byte
- func (k *RSAKey) Public() []byte
- func (k *RSAKey) PublicKey() *RSAPublicKey
- func (k *RSAKey) Type() KeyType
type RSAPublicKey
- func NewRSAPublicKey(pk *rsa.PublicKey) *RSAPublicKey
- func NewRSAPublicKeyFromBytes(publicKey []byte) (*RSAPublicKey, error)
- func (k *RSAPublicKey) Bytes() []byte
- func (k *RSAPublicKey) ID() ID
- func (k *RSAPublicKey) Private() []byte
- func (k *RSAPublicKey) Public() []byte
- func (k *RSAPublicKey) Type() KeyType
type Sigchain
- func NewSigchain(kid ID) *Sigchain
- func (s *Sigchain) Add(st *Statement) error
- func (s *Sigchain) AddAll(statements []*Statement) error
- func (s *Sigchain) FindAll(typ string) []*Statement
- func (s *Sigchain) FindLast(typ string) *Statement
- func (s *Sigchain) IsRevoked(seq int) bool
- func (s *Sigchain) KID() ID
- func (s *Sigchain) Last() *Statement
- func (s *Sigchain) LastSeq() int
- func (s *Sigchain) Length() int
- func (s *Sigchain) Revoke(revoke int, sk *EdX25519Key) (*Statement, error)
- func (s *Sigchain) Spew() *bytes.Buffer
- func (s *Sigchain) Statements() []*Statement
- func (s *Sigchain) VerifyStatement(st *Statement, prev *Statement) error
type Sigchains
- func NewSigchains(ds dstore.Documents) *Sigchains
- func (s *Sigchains) Delete(kid ID) (bool, error)
- func (s *Sigchains) Exists(kid ID) (bool, error)
- func (s *Sigchains) Index(key Key) error
- func (s *Sigchains) KIDs() ([]ID, error)
- func (s *Sigchains) Lookup(kid ID) (ID, error)
- func (s *Sigchains) Save(sc *Sigchain) error
- func (s *Sigchains) SetClock(clock tsutil.Clock)
- func (s *Sigchains) Sigchain(kid ID) (*Sigchain, error)
type Statement
- func NewRevokeStatement(sc *Sigchain, revoke int, sk *EdX25519Key) (*Statement, error)
- func NewSigchainStatement(sc *Sigchain, b []byte, sk *EdX25519Key, typ string, ts time.Time) (*Statement, error)
- func (s *Statement) Bytes() ([]byte, error)
- func (s *Statement) BytesToSign() []byte
- func (s *Statement) MarshalJSON() ([]byte, error)
- func (s *Statement) Sign(signKey *EdX25519Key) error
- func (s *Statement) URL() string
- func (s *Statement) UnmarshalJSON(b []byte) error
- func (s *Statement) Verify() error
- func (s *Statement) VerifySpecific(bytesToSign []byte) error
type StatementPublicKey
- func StatementPublicKeyFromID(id ID) (StatementPublicKey, error)
type X25519Key
- func GenerateX25519Key() *X25519Key
- func NewX25519KeyFromPrivateKey(privateKey *[32]byte) *X25519Key
- func NewX25519KeyFromSeed(seed *[32]byte) *X25519Key
- func (k *X25519Key) BoxOpen(b []byte, nonce *[24]byte, sender *X25519PublicKey) ([]byte, bool)
- func (k *X25519Key) BoxSeal(b []byte, nonce *[24]byte, recipient *X25519PublicKey) []byte
- func (k *X25519Key) Bytes32() *[32]byte
- func (k *X25519Key) ID() ID
- func (k *X25519Key) Private() []byte
- func (k *X25519Key) PrivateKey() *[32]byte
- func (k *X25519Key) Public() []byte
- func (k *X25519Key) PublicKey() *X25519PublicKey
- func (k *X25519Key) Type() KeyType
type X25519PublicKey
- func NewX25519PublicKey(b *[32]byte) *X25519PublicKey
- func NewX25519PublicKeyFromID(id ID) (*X25519PublicKey, error)
- func (k *X25519PublicKey) Bytes() []byte
- func (k *X25519PublicKey) Bytes32() *[32]byte
- func (k *X25519PublicKey) ID() ID
- func (k *X25519PublicKey) Private() []byte
- func (k *X25519PublicKey) Public() []byte
- func (k *X25519PublicKey) Type() KeyType

Constants ¶

View Source

const SignOverhead = sign.Overhead

SignOverhead alias for (nacl) sign.Overhead.

Variables ¶

View Source

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

ErrVerifyFailed if key verify failed.

Functions ¶

func BoxSeal ¶

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

BoxSeal uses nacl.box to encrypt.

Example ¶

package main

import (
	"fmt"
	"log"

	"github.com/keys-pub/keys"
)

func main() {
	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 {
		log.Fatal(err)
	}

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

Output:

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

func Bytes16 ¶

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

Bytes16 converts byte slice to *[16]byte.

func Bytes24 ¶

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

Bytes24 converts byte slice to *[24]byte.

func Bytes32 ¶

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

Bytes32 converts byte slice to *[32]byte.

func Bytes64 ¶

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

Bytes64 converts byte slice to *[64]byte.

func CryptoBoxSeal ¶

func CryptoBoxSeal(b []byte, publicKey *X25519PublicKey) []byte

CryptoBoxSeal implements libsodium crypto_box_seal.

func CryptoBoxSealOpen ¶

func CryptoBoxSealOpen(b []byte, key *X25519Key) ([]byte, error)

CryptoBoxSealOpen implements libsodium crypto_box_seal_open.

func DecryptWithPassword ¶

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 ¶

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

EncodeKey encodes the key using the specified encoding.

func EncodeSSHKey ¶

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

EncodeSSHKey encodes key to SSH.

Example ¶

package main

import (
	"log"

	"github.com/keys-pub/keys"
)

func main() {
	sk := keys.GenerateEdX25519Key()

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

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

}

Output:

func EncodeSaltpackKey ¶

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

EncodeSaltpackKey encrypts a key to saltpack with password.

func EncryptWithPassword ¶

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 ¶

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 ¶

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

HMACSHA256 does a HMAC-SHA256 on msg with key.

func IDsToString ¶

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

IDsToString returns string for joined Ikeys.

func IDsToStrings ¶

func IDsToStrings(ids []ID) []string

IDsToStrings returns []strings for []ID.

func IsTemporaryError ¶

func IsTemporaryError(err error) bool

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

func IsValidID ¶

func IsValidID(s string) bool

IsValidID returns true if string is a valid ID.

func KeyForPassword ¶

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

KeyForPassword generates a key from a password and salt.

func NewErrNotFound ¶

func NewErrNotFound(id string) error

NewErrNotFound constructs a ErrNotFound.

func Rand16 ¶

func Rand16() *[16]byte

Rand16 generates random 16 bytes.

func Rand24 ¶

func Rand24() *[24]byte

Rand24 generates random 24 bytes.

func Rand32 ¶

func Rand32() *[32]byte

Rand32 generates random 32 bytes.

func RandBytes ¶

func RandBytes(length int) []byte

RandBytes returns random bytes of length.

func RandFileName ¶

func RandFileName() string

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

func RandHex ¶

func RandHex(numBytes int) string

RandHex returns random hex.

func RandPassword ¶

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 ¶

func RandPhrase() string

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

func RandTempPath ¶

func RandTempPath() string

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

func RandUsername ¶

func RandUsername(length int) string

RandUsername returns random lowercase string of length.

func RandWords ¶

func RandWords(numWords int) string

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

func RetryE ¶

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 ¶

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 ¶

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 ¶

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 ¶

func SetLogger(l Logger)

SetLogger sets logger for the package.

func SigchainHash ¶

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

SigchainHash returns hash for Sigchain Statement.

func StatementID ¶

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 ¶

func X25519Match(expected ID, kid ID) bool

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

Types ¶

type Address ¶

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

Address is a canonical list of IDs.

func NewAddress ¶

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

NewAddress returns an Address from a list of IDs.

func ParseAddress ¶

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

ParseAddress returns address from a string.

func (*Address) Contains ¶

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

Contains returns true if address contains the specified id.

func (*Address) String ¶

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 ¶

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

Strings returns IDs as strings.

type Brand ¶

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 ¶

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 ¶

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

GenerateCertificateKey creates a certificate key.

func NewCertificateKey ¶

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 ¶

func (c CertificateKey) Private() string

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

func (CertificateKey) Public ¶

func (c CertificateKey) Public() string

Public returns a PEM encoded X.509v3 certificate.

func (CertificateKey) TLSCertificate ¶

func (c CertificateKey) TLSCertificate() tls.Certificate

TLSCertificate returns a tls.Certificate.

func (CertificateKey) X509Certificate ¶

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

X509Certificate returns a x509.Certificate.

type EdX25519Key ¶

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 ¶

func GenerateEdX25519Key() *EdX25519Key

GenerateEdX25519Key generates a EdX25519Key (EdX25519).

Example ¶

package main

import (
	"fmt"

	"github.com/keys-pub/keys"
)

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

Output:

func NewEdX25519KeyFromPrivateKey ¶

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 ¶

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) EncodeToSSH ¶

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

EncodeToSSH encodes a EdX25519Key for SSH.

func (*EdX25519Key) Equal ¶

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

Equal returns true if equal to key.

func (*EdX25519Key) ID ¶

func (k *EdX25519Key) ID() ID

ID ...

func (*EdX25519Key) MarshalText ¶

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

MarshalText for encoding.TextMarshaler interface.

func (*EdX25519Key) Private ¶

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

Private ...

func (*EdX25519Key) PrivateKey ¶

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

PrivateKey returns private key part.

func (*EdX25519Key) Public ¶

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

Public ...

func (*EdX25519Key) PublicKey ¶

func (k *EdX25519Key) PublicKey() *EdX25519PublicKey

PublicKey returns public part.

func (*EdX25519Key) SSHSigner ¶

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

SSHSigner interface.

func (*EdX25519Key) Seed ¶

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

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

func (*EdX25519Key) Sign ¶

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

Sign bytes with the (sign) private key.

Example ¶

package main

import (
	"fmt"
	"log"

	"github.com/keys-pub/keys"
)

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

Output:

I'm alice 🤓

func (*EdX25519Key) SignDetached ¶

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

SignDetached sign bytes detached.

func (*EdX25519Key) Signer ¶

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

Signer interface.

func (*EdX25519Key) String ¶

func (k *EdX25519Key) String() string

func (*EdX25519Key) Type ¶

func (k *EdX25519Key) Type() KeyType

Type ...

func (*EdX25519Key) UnmarshalText ¶

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

UnmarshalText for encoding.TextUnmarshaler interface.

func (*EdX25519Key) X25519Key ¶

func (k *EdX25519Key) X25519Key() *X25519Key

X25519Key converts EdX25519Key to X25519Key.

type EdX25519PublicKey ¶

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

EdX25519PublicKey is the public part of EdX25519 key pair.

func NewEdX25519PublicKey ¶

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

NewEdX25519PublicKey creates a EdX25519PublicKey.

func NewEdX25519PublicKeyFromID ¶

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

NewEdX25519PublicKeyFromID creates a EdX25519PublicKey from an ID.

func (*EdX25519PublicKey) Bytes ¶

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

Bytes ...

func (*EdX25519PublicKey) EncodeToSSHAuthorized ¶

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

EncodeToSSHAuthorized encodes a EdX25519PublicKey for SSH.

func (*EdX25519PublicKey) ID ¶

func (k *EdX25519PublicKey) ID() ID

ID for EdX25519Key.

func (*EdX25519PublicKey) Private ¶

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

Private returns nil.

func (*EdX25519PublicKey) Public ¶

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

Public ...

func (*EdX25519PublicKey) String ¶

func (k *EdX25519PublicKey) String() string

func (*EdX25519PublicKey) Type ¶

func (k *EdX25519PublicKey) Type() KeyType

Type ...

func (*EdX25519PublicKey) Verify ¶

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

Verify verifies a message and signature with public key and returns the signed bytes without the signature.

func (*EdX25519PublicKey) VerifyDetached ¶

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

VerifyDetached verifies a detached message.

func (*EdX25519PublicKey) X25519PublicKey ¶

func (k *EdX25519PublicKey) X25519PublicKey() *X25519PublicKey

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

type Encoding ¶

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 ¶

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 ¶

type ErrNotFound struct {
	ID string
}

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

func (ErrNotFound) Error ¶

func (e ErrNotFound) Error() string

type ID ¶

type ID string

ID is a bech32 encoded string.

func MustID ¶

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 ¶

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

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

func ParseID ¶

func ParseID(s string) (ID, error)

ParseID parses a string and validates an ID.

func ParseIDs ¶

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

ParseIDs returns IDs from strings.

func RandID ¶

func RandID(hrp string) ID

RandID returns a random (bech32) ID.

func (ID) Decode ¶

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

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

func (ID) ID ¶

func (i ID) ID() ID

ID for Keys interface.

func (ID) IsEdX25519 ¶

func (i ID) IsEdX25519() bool

IsEdX25519 returns true if ID represents a EdX25519 key.

func (ID) IsX25519 ¶

func (i ID) IsX25519() bool

IsX25519 returns true if ID represents a X25519 key.

func (ID) Private ¶

func (i ID) Private() []byte

Private returns nil (for Key interface).

func (ID) Public ¶

func (i ID) Public() []byte

Public key data (for Key interface).

func (ID) String ¶

func (i ID) String() string

func (ID) Type ¶

func (i ID) Type() KeyType

Type of key.

func (ID) UUID ¶

func (i ID) UUID() *[16]byte

UUID returns a 16 byte hash of the public bytes.

func (ID) WithSeq ¶

func (i ID) WithSeq(seq int) string

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

type IDSet ¶

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

IDSet is a set of strings.

func NewIDSet ¶

func NewIDSet(ids ...ID) *IDSet

NewIDSet creates IDSet.

func NewIDSetWithCapacity ¶

func NewIDSetWithCapacity(capacity int) *IDSet

NewIDSetWithCapacity ..

func (*IDSet) Add ¶

func (s *IDSet) Add(id ID)

Add to set.

func (*IDSet) AddAll ¶

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

AddAll to set.

func (*IDSet) Clear ¶

func (s *IDSet) Clear()

Clear set.

func (*IDSet) Contains ¶

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

Contains returns true if set contains string.

func (*IDSet) IDs ¶

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

IDs returns IDs in set.

func (*IDSet) Size ¶

func (s *IDSet) Size() int

Size for set.

type Key ¶

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

	// Type of key.
	Type() KeyType

	// Private key data.
	Private() []byte

	// Public key data.
	Public() []byte
}

Key with id, type and private and/or public data.

func DecodeKey ¶

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 ¶

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

DecodeSSHKey decodes SSH key.

Example ¶

package main

import (
	"fmt"
	"log"

	"github.com/keys-pub/keys"
)

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

Output:

kex132yw8ht5p8cetl2jmvknewjawt9xwzdlrk2pyxlnwjyqrdq0dawqqph077

func DecodeSaltpackKey ¶

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

DecodeSaltpackKey decrypts a saltpack encrypted key.

Example ¶

package main

import (
	"fmt"
	"log"

	"github.com/keys-pub/keys"
)

func main() {
	msg := `BEGIN EDX25519 KEY MESSAGE.
	AY6gPAVx9JSUsLg 3K8CNqUyNY87qiL FNNp7UBsIcvObJK mRtDzpcwQU1XpYa
	64FF0g4O0sDrhV4 qlp52vdQ5PG77D8 046ZdckukUl6reZ inOEqkDuOg5hynz
	k95BEExR31Sqenh rdqT3ADIdPu8f4f aXQaFejAp3Cb.
	END EDX25519 KEY MESSAGE.`
	key, err := keys.DecodeSaltpackKey(msg, "testpassword", true)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", key.ID())
}

Output:

kex10x6fdaazp2zy85m6cj7w57y4u0cc99xa3nmwjdldk9l4ajm3yadq70g0js

func ParseKey ¶

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

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

func ParseSSHKey ¶

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

ParseSSHKey parses a SSH private key.

func ParseSSHPublicKey ¶

func ParseSSHPublicKey(s string) (Key, error)

ParseSSHPublicKey parses a SSH public key.

type KeyType ¶

type KeyType string

KeyType ...

const EdX25519 KeyType = "edx25519"

EdX25519 key type.

const RSA KeyType = "rsa"

RSA key type.

const X25519 KeyType = "x25519"

X25519 key type.

type LogLevel ¶

type LogLevel int

LogLevel ...

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

func (LogLevel) String ¶

func (l LogLevel) String() string

type Logger ¶

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 ¶

func NewLogger(lev LogLevel) Logger

NewLogger ...

type RSAKey ¶

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

RSAKey implements Key interface for RSA.

func GenerateRSAKey ¶

func GenerateRSAKey() *RSAKey

GenerateRSAKey generates a RSA key.

func NewRSAKey ¶

func NewRSAKey(k *rsa.PrivateKey) *RSAKey

NewRSAKey from rsa.PrivateKey.

func NewRSAKeyFromBytes ¶

func NewRSAKeyFromBytes(privateKey []byte) (*RSAKey, error)

NewRSAKeyFromBytes constructs RSA from a private key (PKCS1).

func (*RSAKey) ID ¶

func (k *RSAKey) ID() ID

ID for the key.

func (*RSAKey) Private ¶

func (k *RSAKey) Private() []byte

Private key data (PKCS1).

func (*RSAKey) Public ¶

func (k *RSAKey) Public() []byte

Public key data (PKCS1).

func (*RSAKey) PublicKey ¶

func (k *RSAKey) PublicKey() *RSAPublicKey

PublicKey ...

func (*RSAKey) Type ¶

func (k *RSAKey) Type() KeyType

Type of key.

type RSAPublicKey ¶

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

RSAPublicKey is the public part of RSA key pair.

func NewRSAPublicKey ¶

func NewRSAPublicKey(pk *rsa.PublicKey) *RSAPublicKey

NewRSAPublicKey returns RSA public key.

func NewRSAPublicKeyFromBytes ¶

func NewRSAPublicKeyFromBytes(publicKey []byte) (*RSAPublicKey, error)

NewRSAPublicKeyFromBytes returns RSA public key from PKC1 bytes.

func (*RSAPublicKey) Bytes ¶

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

Bytes for public key (PKCS1).

func (*RSAPublicKey) ID ¶

func (k *RSAPublicKey) ID() ID

ID is key identifier.

func (*RSAPublicKey) Private ¶

func (k *RSAPublicKey) Private() []byte

Private returns nil.

func (*RSAPublicKey) Public ¶

func (k *RSAPublicKey) Public() []byte

Public key data.

func (*RSAPublicKey) Type ¶

func (k *RSAPublicKey) Type() KeyType

Type of key.

type Sigchain ¶

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

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

func NewSigchain ¶

func NewSigchain(kid ID) *Sigchain

NewSigchain creates an empty Sigchain.

Example ¶

package main

import (
	"log"

	"github.com/keys-pub/keys"
	"github.com/keys-pub/keys/tsutil"
)

func main() {
	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 {
		log.Fatal(err)
	}
	if err := sc.Add(st); err != nil {
		log.Fatal(err)
	}

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

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

	// Spew
	spew := sc.Spew()
	log.Println(spew.String())

}

Output:

func (*Sigchain) Add ¶

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

Add signed statement to the Sigchain.

func (*Sigchain) AddAll ¶

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

AddAll pushes signed statements to the Sigchain.

func (*Sigchain) FindAll ¶

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

FindAll returns statements of type.

func (*Sigchain) FindLast ¶

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 ¶

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

IsRevoked returns true if statement was revoked.

func (*Sigchain) KID ¶

func (s *Sigchain) KID() ID

KID ...

func (*Sigchain) Last ¶

func (s *Sigchain) Last() *Statement

Last returns last statement or nil if none.

func (*Sigchain) LastSeq ¶

func (s *Sigchain) LastSeq() int

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

func (*Sigchain) Length ¶

func (s *Sigchain) Length() int

Length of Sigchain.

func (*Sigchain) Revoke ¶

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

Revoke a signed statement in the Sigchain.

func (*Sigchain) Spew ¶

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

Spew shows formatted sigchain output.

func (*Sigchain) Statements ¶

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

Statements returns all the signed statements.

func (*Sigchain) VerifyStatement ¶

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

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

type Sigchains ¶

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

Sigchains stores sigchains.

func NewSigchains ¶

func NewSigchains(ds dstore.Documents) *Sigchains

NewSigchains creates a Sigchains from Documents.

func (*Sigchains) Delete ¶

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

Delete sigchain.

func (*Sigchains) Exists ¶

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

Exists returns true if sigchain exists.

func (*Sigchains) Index ¶

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

Index key. Adds reverse key lookup for EdX25519 to X25519 public key.

func (*Sigchains) KIDs ¶

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

KIDs returns all key ids.

func (*Sigchains) Lookup ¶

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

Lookup key. Returns key associated with the specified key.

func (*Sigchains) Save ¶

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

Save sigchain.

func (*Sigchains) SetClock ¶

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

SetClock to use a custom time.Now.

func (*Sigchains) Sigchain ¶

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

Sigchain returns sigchain for key.

type Statement ¶

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.

Example ¶

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 {
	log.Fatal(err)
}

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

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

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

Output:

{".sig":"","data":"AQEBAQEBAQEBAQEBAQEBAQ==","kid":"kex132yw8ht5p8cetl2jmvknewjawt9xwzdlrk2pyxlnwjyqrdq0dawqqph077","type":"test"}
{".sig":"CFD9cK9gIB3sAEqpDwmZM0JFFO4/+RpX9uoAD25G3F1o8Af+pTk6pI4GPqAZ5FhEw1rUDfL02Qnohtx05LQxAg==","data":"AQEBAQEBAQEBAQEBAQEBAQ==","kid":"kex132yw8ht5p8cetl2jmvknewjawt9xwzdlrk2pyxlnwjyqrdq0dawqqph077","type":"test"}
{".sig":"CFD9cK9gIB3sAEqpDwmZM0JFFO4/+RpX9uoAD25G3F1o8Af+pTk6pI4GPqAZ5FhEw1rUDfL02Qnohtx05LQxAg==","data":"AQEBAQEBAQEBAQEBAQEBAQ==","kid":"kex132yw8ht5p8cetl2jmvknewjawt9xwzdlrk2pyxlnwjyqrdq0dawqqph077","type":"test"}

func NewRevokeStatement ¶

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

NewRevokeStatement creates a revoke Statement.

func NewSigchainStatement ¶

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 ¶

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

Bytes is the serialized Statement.

func (*Statement) BytesToSign ¶

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

BytesToSign returns bytes to sign.

func (*Statement) MarshalJSON ¶

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

MarshalJSON marshals statement to JSON.

func (*Statement) Sign ¶

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

Sign the statement. Returns an error if already signed.

func (*Statement) URL ¶

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 ¶

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

UnmarshalJSON unmarshals a statement from JSON.

func (*Statement) Verify ¶

func (s *Statement) Verify() error

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

func (*Statement) VerifySpecific ¶

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 ¶

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 ¶

func StatementPublicKeyFromID(id ID) (StatementPublicKey, error)

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

type X25519Key ¶

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

X25519Key is a X25519 assymmetric encryption key.

func GenerateX25519Key ¶

func GenerateX25519Key() *X25519Key

GenerateX25519Key creates a new X25519Key.

Example ¶

package main

import (
	"fmt"

	"github.com/keys-pub/keys"
)

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

Output:

func NewX25519KeyFromPrivateKey ¶

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

NewX25519KeyFromPrivateKey creates a X25519Key from private key bytes.

func NewX25519KeyFromSeed ¶

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

NewX25519KeyFromSeed from seed.

func (*X25519Key) BoxOpen ¶

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

BoxOpen decrypts message with nacl.box Open.

func (*X25519Key) BoxSeal ¶

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

BoxSeal encrypts message with nacl.box Seal.

func (*X25519Key) Bytes32 ¶

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

Bytes32 private key bytes.

func (*X25519Key) ID ¶

func (k *X25519Key) ID() ID

ID is key identifer.

func (*X25519Key) Private ¶

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

Private key bytes.

func (*X25519Key) PrivateKey ¶

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

PrivateKey returns private part of this X25519Key.

func (*X25519Key) Public ¶

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

Public key bytes.

func (*X25519Key) PublicKey ¶

func (k *X25519Key) PublicKey() *X25519PublicKey

PublicKey returns public part of this X25519Key.

func (*X25519Key) Type ¶

func (k *X25519Key) Type() KeyType

Type of key.

type X25519PublicKey ¶

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

X25519PublicKey is the public key part of a x25519 key.

func NewX25519PublicKey ¶

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

NewX25519PublicKey creates X25519PublicKey. Metadata is optional.

func NewX25519PublicKeyFromID ¶

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

NewX25519PublicKeyFromID converts ID to X25519PublicKey.

func (*X25519PublicKey) Bytes ¶

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

Bytes ...

func (*X25519PublicKey) Bytes32 ¶

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

Bytes32 ...

func (*X25519PublicKey) ID ¶

func (k *X25519PublicKey) ID() ID

ID for box public key.

func (*X25519PublicKey) Private ¶

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

Private returns nil.

func (*X25519PublicKey) Public ¶

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

Public ...

func (*X25519PublicKey) Type ¶

func (k *X25519PublicKey) Type() KeyType

Type of key.

Source Files

View all

Directories

?	: This menu
/	: Search site
f or F	: Jump to

Path	Synopsis
api Package api provides a standard key format for serialization to JSON or msgpack, and conversions to and from specific key types.	Package api provides a standard key format for serialization to JSON or msgpack, and conversions to and from specific key types.
bech32 Package bech32 is a modified version of the reference implementation of BIP173.	Package bech32 is a modified version of the reference implementation of BIP173.
dstore Package dstore describes a document store.	Package dstore describes a document store.
events Package events provides an event log.	Package events provides an event log.
encoding Package encoding provides encoding and decoding of different formats like Base62, Saltpack, BIP39.	Package encoding provides encoding and decoding of different formats like Base62, Saltpack, BIP39.
env Package env provides paths on different platforms.	Package env provides paths on different platforms.
http Package http provides an http client for use with checking remote signed statements.	Package http provides an http client for use with checking remote signed statements.
json Package json provides a simpler JSON marshaller for strings and ints only.	Package json provides a simpler JSON marshaller for strings and ints only.
keyring Package keyring provides a cross-platform secure keyring.	Package keyring provides a cross-platform secure keyring.
noise Package noise integrates keys with the Noise protocol.	Package noise integrates keys with the Noise protocol.
saltpack Package saltpack integrates keys with Saltpack (saltpack.org).	Package saltpack integrates keys with Saltpack (saltpack.org).
tsutil Package tsutil provides timestamp and time utilities.	Package tsutil provides timestamp and time utilities.
user Package user defines user statements, store and search.	Package user defines user statements, store and search.
services Package services defines services capable of linking a key to a user.	Package services defines services capable of linking a key to a user.
validate
users

README

keys.pub

Documentation

Repositories

Documentation

Index ¶

Examples ¶

Constants ¶

Variables ¶

Functions ¶

func BoxOpen ¶

func BoxSeal ¶

func Bytes16 ¶

func Bytes24 ¶

func Bytes32 ¶

func Bytes64 ¶

func CryptoBoxSeal ¶

func CryptoBoxSealOpen ¶

func DecryptWithPassword ¶

func EncodeKey ¶

func EncodeSSHKey ¶

func EncodeSaltpackKey ¶

func EncryptWithPassword ¶

func HKDFSHA256 ¶

func HMACSHA256 ¶

func IDsToString ¶

func IDsToStrings ¶

func IsTemporaryError ¶

func IsValidID ¶

func KeyForPassword ¶

func NewErrNotFound ¶

func Rand16 ¶

func Rand24 ¶

func Rand32 ¶

func RandBytes ¶

func RandFileName ¶

func RandHex ¶

func RandPassword ¶

func RandPhrase ¶

func RandTempPath ¶

func RandUsername ¶

func RandWords ¶

func RetryE ¶

func RetrySE ¶

func SecretBoxOpen ¶

func SecretBoxSeal ¶

func SetLogger ¶

func SigchainHash ¶

func StatementID ¶

func X25519Match ¶

Types ¶

type Address ¶

func NewAddress ¶

func ParseAddress ¶

func (*Address) Contains ¶

func (*Address) String ¶

func (*Address) Strings ¶

type Brand ¶

type CertificateKey ¶

func GenerateCertificateKey ¶

func NewCertificateKey ¶

func (CertificateKey) Private ¶

func (CertificateKey) Public ¶

func (CertificateKey) TLSCertificate ¶

func (CertificateKey) X509Certificate ¶

type EdX25519Key ¶

func GenerateEdX25519Key ¶

func NewEdX25519KeyFromPrivateKey ¶

func NewEdX25519KeyFromSeed ¶

func (*EdX25519Key) EncodeToSSH ¶

func (*EdX25519Key) Equal ¶

func (*EdX25519Key) ID ¶

func (*EdX25519Key) MarshalText ¶

func (*EdX25519Key) Private ¶

func (*EdX25519Key) PrivateKey ¶

func (*EdX25519Key) Public ¶

func (*EdX25519Key) PublicKey ¶

func (*EdX25519Key) SSHSigner ¶

func (*EdX25519Key) Seed ¶

func (*EdX25519Key) Sign ¶