cryptosig

README

cryptosig

abstracted multi-algorithm cryptographic signature library

Documentation

Index

• func ListAlgo() []string
• func RegisterSigAlgo(algo SigningAlgo[any, any, any])
• func TestAlgo(algo SigningAlgo[any, any, any]) error
• type HashedPublicKey
  • func (p *HashedPublicKey) Equal(publicKey *PublicKey) bool
  • func (p *HashedPublicKey) MarshalText() (text []byte, err error)
  • func (p *HashedPublicKey) UnmarshalText(text []byte) error
• type PublicKey
  • func (pk *PublicKey) Algo() string
  • func (pk *PublicKey) Fork() *HashedPublicKey
  • func (pk *PublicKey) MarshalText() ([]byte, error)
  • func (pk *PublicKey) UnmarshalText(text []byte) error
  • func (pk *PublicKey) Unwrap() any
  • func (pk *PublicKey) Verify(sig *Signature, msg []byte) error
• type SecretKey
  • func GenerateSecretKey(algo string) *SecretKey
  • func (sk *SecretKey) Algo() string
  • func (sk *SecretKey) MarshalText() ([]byte, error)
  • func (sk *SecretKey) PublicKey() *PublicKey
  • func (sk *SecretKey) Sign(msg []byte) *Signature
  • func (sk *SecretKey) UnmarshalText(b []byte) error
  • func (sk *SecretKey) UnsafeUnmarshalText() ([]byte, error)
  • func (sk *SecretKey) Unwrap() any
• type Signature
  • func (sig *Signature) Algo() string
  • func (sig *Signature) MarshalText() ([]byte, error)
  • func (sig *Signature) UnmarshalText(text []byte) error
  • func (sig *Signature) Unwrap() any
  • func (sig *Signature) Verify(pk *PublicKey, msg []byte) error
• type SigningAlgo
  • func GetAlgo(name string) SigningAlgo[any, any, any]

Functions

func ListAlgo

func ListAlgo() []string

func RegisterSigAlgo

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

func TestAlgo

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

Types

type HashedPublicKey

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

func (*HashedPublicKey) Equal

func (p *HashedPublicKey) Equal(publicKey *PublicKey) bool

func (*HashedPublicKey) MarshalText

func (p *HashedPublicKey) MarshalText() (text []byte, err error)

func (*HashedPublicKey) UnmarshalText

func (p *HashedPublicKey) UnmarshalText(text []byte) error

type PublicKey

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

func (*PublicKey) Algo

func (pk *PublicKey) Algo() string

func (*PublicKey) Fork

func (pk *PublicKey) Fork() *HashedPublicKey

func (*PublicKey) MarshalText

func (pk *PublicKey) MarshalText() ([]byte, error)

func (*PublicKey) UnmarshalText

func (pk *PublicKey) UnmarshalText(text []byte) error

func (*PublicKey) Unwrap

func (pk *PublicKey) Unwrap() any

func (*PublicKey) Verify

func (pk *PublicKey) Verify(sig *Signature, msg []byte) error

type SecretKey

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

func GenerateSecretKey

func GenerateSecretKey(algo string) *SecretKey

func (*SecretKey) Algo

func (sk *SecretKey) Algo() string

func (*SecretKey) MarshalText

func (sk *SecretKey) MarshalText() ([]byte, error)

func (*SecretKey) PublicKey

func (sk *SecretKey) PublicKey() *PublicKey

func (*SecretKey) Sign

func (sk *SecretKey) Sign(msg []byte) *Signature

func (*SecretKey) UnmarshalText

func (sk *SecretKey) UnmarshalText(b []byte) error

func (*SecretKey) UnsafeUnmarshalText

func (sk *SecretKey) UnsafeUnmarshalText() ([]byte, error)

func (*SecretKey) Unwrap

func (sk *SecretKey) Unwrap() any

type Signature

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

func (*Signature) Algo

func (sig *Signature) Algo() string

func (*Signature) MarshalText

func (sig *Signature) MarshalText() ([]byte, error)

func (*Signature) UnmarshalText

func (sig *Signature) UnmarshalText(text []byte) error

func (*Signature) Unwrap

func (sig *Signature) Unwrap() any

func (*Signature) Verify

func (sig *Signature) Verify(pk *PublicKey, msg []byte) 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
}

func GetAlgo

func GetAlgo(name string) SigningAlgo[any, any, any]