cryptosig

package module

v1.7.0 Latest Latest Go to latest Published: Aug 24, 2022 License: GPL-3.0 Imports: 8 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cryptonetworking/cryptosig

Links

Open Source Insights

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
type PublicKey
type SecretKey
- func GenerateSecretKey(algo string) *SecretKey
type Signature
type SigningAlgo
- func GetAlgo(name string) SigningAlgo[any, any, any]

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ListAlgo ¶ added in v1.5.0

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 ¶ added in v1.2.0

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

func (*HashedPublicKey) Equal ¶ added in v1.2.0

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

func (*HashedPublicKey) MarshalText ¶ added in v1.7.0

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

func (*HashedPublicKey) UnmarshalText ¶ added in v1.7.0

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 ¶ added in v1.2.0

func (pk *PublicKey) Fork() *HashedPublicKey

func (*PublicKey) MarshalText ¶ added in v1.7.0

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

func (*PublicKey) UnmarshalText ¶ added in v1.7.0

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 ¶ added in v1.3.0

func GenerateSecretKey(algo string) *SecretKey

func (*SecretKey) Algo ¶

func (sk *SecretKey) Algo() string

func (*SecretKey) MarshalText ¶ added in v1.7.0

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 ¶ added in v1.7.0

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

func (*SecretKey) UnsafeUnmarshalText ¶ added in v1.7.0

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 ¶ added in v1.7.0

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

func (*Signature) UnmarshalText ¶ added in v1.7.0

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 ¶ added in v1.3.2

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
pkg
ed25519

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL