crypto

Documentation

Index

• Constants
• Variables
• func CalculateSharedKey(priv PrivateKey, pub PublicKey) ([]byte, error)
• func GenerateTLSCertificate(privateKey PrivateKey) (*tls.Certificate, error)
• type KeyAlgorithm
• type PrivateKey
  • func CalculateEphemeralSharedKey(pub PublicKey) (PrivateKey, []byte, error)
  • func NewEd25519PrivateKey() (PrivateKey, error)
  • func NewEd25519PrivateKeyFromBIP39(mnemonic string) (PrivateKey, error)
  • func NewEd25519PrivateKeyFromSeed(seed []byte) PrivateKey
  • func NewSharedKey(priv PrivateKey, pub PublicKey) (PrivateKey, []byte, error)
  • func (k PrivateKey) BIP39() string
  • func (k PrivateKey) IsEmpty() bool
  • func (k PrivateKey) MarshalJSON() ([]byte, error)
  • func (k PrivateKey) MarshalString() (string, error)
  • func (k PrivateKey) PublicKey() PublicKey
  • func (k PrivateKey) Seed() []byte
  • func (k PrivateKey) Sign(message []byte) []byte
  • func (k PrivateKey) String() string
  • func (k *PrivateKey) UnmarshalJSON(s []byte) error
  • func (k *PrivateKey) UnmarshalString(s string) error
  • func (k *PrivateKey) UnmarshalText(b []byte) error
• type PublicKey
  • func NewEd25519PublicKeyFromRaw(raw ed25519.PublicKey) PublicKey
  • func PublicKeyFromDID(d did.DID) (*PublicKey, error)
  • func (k PublicKey) DID() did.DID
  • func (k PublicKey) Equals(w PublicKey) bool
  • func (k PublicKey) Hash() tilde.Digest
  • func (k PublicKey) IsEmpty() bool
  • func (k PublicKey) MarshalJSON() ([]byte, error)
  • func (k PublicKey) MarshalString() (string, error)
  • func (k PublicKey) String() string
  • func (k *PublicKey) UnmarshalJSON(s []byte) error
  • func (k *PublicKey) UnmarshalString(s string) error
  • func (k *PublicKey) UnmarshalText(b []byte) error
  • func (k PublicKey) Verify(message []byte, signature []byte) error

Constants

const (
	// P256 curve
	P256 string = "P-256"
	// P384 curve
	P384 string = "P-384"
	// P521 curve
	P521 string = "P-521"
)

const (
	ErrUnsupportedKeyAlgorithm = errors.Error("key algorithm not supported")
	ErrInvalidSignature        = errors.Error("invalid signature")
)

Variables

var (
	EmptyPublicKey  = PublicKey{}
	EmptyPrivateKey = PrivateKey{}
)

Functions

func CalculateSharedKey

func CalculateSharedKey(
	priv PrivateKey,
	pub PublicKey,
) ([]byte, error)

CalculateSharedKey calculates a shared secret given a private an public key

func GenerateTLSCertificate

func GenerateTLSCertificate(privateKey PrivateKey) (*tls.Certificate, error)

GenerateTLSCertificate for TLS serverset

Types

type KeyAlgorithm

type KeyAlgorithm multicodec.Code

const (
	Ed25519Private KeyAlgorithm = KeyAlgorithm(multicodec.Ed25519Priv)
	Ed25519Public  KeyAlgorithm = KeyAlgorithm(multicodec.Ed25519Pub)
)

type PrivateKey

type PrivateKey struct {
	Algorithm KeyAlgorithm
	RawKey    ed25519.PrivateKey // TODO use crypto.PrivateKey
}

func CalculateEphemeralSharedKey

func CalculateEphemeralSharedKey(
	pub PublicKey,
) (PrivateKey, []byte, error)

CalculateEphemeralSharedKey creates a new ec25519 key pair, calculates a shared secret given a public key, and returns the created public key and secret

func NewEd25519PrivateKey

func NewEd25519PrivateKey() (PrivateKey, error)

func NewEd25519PrivateKeyFromBIP39

func NewEd25519PrivateKeyFromBIP39(mnemonic string) (PrivateKey, error)

TODO check validity and return error

func NewEd25519PrivateKeyFromSeed

func NewEd25519PrivateKeyFromSeed(seed []byte) PrivateKey

TODO check validity and return error

func NewSharedKey

func NewSharedKey(
	priv PrivateKey,
	pub PublicKey,
) (PrivateKey, []byte, error)

NewSharedKey calculates a shared secret given a private and a public key, and returns it

func (PrivateKey) BIP39

func (k PrivateKey) BIP39() string

func (PrivateKey) IsEmpty

func (k PrivateKey) IsEmpty() bool

func (PrivateKey) MarshalJSON

func (k PrivateKey) MarshalJSON() ([]byte, error)

func (PrivateKey) MarshalString

func (k PrivateKey) MarshalString() (string, error)

func (PrivateKey) PublicKey

func (k PrivateKey) PublicKey() PublicKey

func (PrivateKey) Seed

func (k PrivateKey) Seed() []byte

func (PrivateKey) Sign

func (k PrivateKey) Sign(message []byte) []byte

func (PrivateKey) String

func (k PrivateKey) String() string

func (*PrivateKey) UnmarshalJSON

func (k *PrivateKey) UnmarshalJSON(s []byte) error

func (*PrivateKey) UnmarshalString

func (k *PrivateKey) UnmarshalString(s string) error

func (*PrivateKey) UnmarshalText

func (k *PrivateKey) UnmarshalText(b []byte) error

UnmarshalText implements encoding.TextUnmarshaler mainly for use by envconfig.

type PublicKey

type PublicKey struct {
	Algorithm KeyAlgorithm
	RawKey    ed25519.PublicKey // TODO use crypto.PublicKey
}

func NewEd25519PublicKeyFromRaw

func NewEd25519PublicKeyFromRaw(raw ed25519.PublicKey) PublicKey

TODO check validity and return error

func PublicKeyFromDID

func PublicKeyFromDID(d did.DID) (*PublicKey, error)

func (PublicKey) DID

func (k PublicKey) DID() did.DID

func (PublicKey) Equals

func (k PublicKey) Equals(w PublicKey) bool

func (PublicKey) Hash

func (k PublicKey) Hash() tilde.Digest

func (PublicKey) IsEmpty

func (k PublicKey) IsEmpty() bool

func (PublicKey) MarshalJSON

func (k PublicKey) MarshalJSON() ([]byte, error)

func (PublicKey) MarshalString

func (k PublicKey) MarshalString() (string, error)

func (PublicKey) String

func (k PublicKey) String() string

func (*PublicKey) UnmarshalJSON

func (k *PublicKey) UnmarshalJSON(s []byte) error

func (*PublicKey) UnmarshalString

func (k *PublicKey) UnmarshalString(s string) error

func (*PublicKey) UnmarshalText

func (k *PublicKey) UnmarshalText(b []byte) error

UnmarshalText implements encoding.TextUnmarshaler mainly for use by envconfig.

func (PublicKey) Verify

func (k PublicKey) Verify(message []byte, signature []byte) error