cryptosig

README

cryptosig

abstracted multi-algorithm cryptographic signature library

Documentation

Index

• func RegisterSigAlgo(algo SigningAlgo[any, any, any])
• func TestAlgo(algo SigningAlgo[any, any, any]) error
• type HashedPublicKey
• type PublicKey
  • func UnmarshalBinaryPublicKey(b []byte) (PublicKey, error)
• type SecretKey
  • func New(algo string) SecretKey
  • func UnmarshalBinarySecretKey(b []byte) (SecretKey, error)
  • func UnmarshalTextSecretKey(b []byte) (SecretKey, error)
• type Signature
  • func UnmarshalBinarySignature(b []byte) (Signature, error)
• type SigningAlgo

Functions

func RegisterSigAlgo

func RegisterSigAlgo(algo SigningAlgo[any, any, any])

func TestAlgo

func TestAlgo(algo SigningAlgo[any, any, any]) error

Types

type HashedPublicKey

type HashedPublicKey interface {
	Equal(PublicKey) bool
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
	json.Marshaler
	json.Unmarshaler
}

type PublicKey

type PublicKey interface {
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
	json.Marshaler
	json.Unmarshaler
	Algo() string
	Verify(Signature, []byte) error
	Unwrap() any
	Fork() HashedPublicKey
}

func UnmarshalBinaryPublicKey

func UnmarshalBinaryPublicKey(b []byte) (PublicKey, error)

type SecretKey

type SecretKey interface {
	encoding.BinaryUnmarshaler
	encoding.TextUnmarshaler
	UnsafeMarshalBinary() ([]byte, error)
	UnsafeMarshalText() ([]byte, error)
	Algo() string
	Sign(msg []byte) Signature
	Unwrap() any
	PublicKey() PublicKey
}

func New

func New(algo string) SecretKey

func UnmarshalBinarySecretKey

func UnmarshalBinarySecretKey(b []byte) (SecretKey, error)

func UnmarshalTextSecretKey

func UnmarshalTextSecretKey(b []byte) (SecretKey, error)

type Signature

type Signature interface {
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
	json.Marshaler
	json.Unmarshaler
	Algo() string
	Verify(PublicKey, []byte) error
	Unwrap() any
}

func UnmarshalBinarySignature

func UnmarshalBinarySignature(b []byte) (Signature, error)

type SigningAlgo

type SigningAlgo[S, P, Sig any] interface {
	Algo() string
	UnmarshalBinarySecretKey([]byte) (S, error)
	UnmarshalBinaryPublicKey([]byte) (P, error)
	UnmarshalBinarySignature([]byte) (Sig, error)
	MarshalBinarySecretKey(S) []byte
	MarshalBinaryPublicKey(P) []byte
	MarshalBinarySignature(Sig) []byte
	Sign(S, []byte) Sig
	Derive(S) P
	New() S
	Verify(Sig, P, []byte) error
}