bls

package

v0.1.3 Latest Latest Go to latest Published: Jul 30, 2025 License: BSD-3-Clause Imports: 3 Imported by: 64

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/luxfi/crypto

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func PublicKeyToCompressedBytes(pk *PublicKey) []byte
func PublicKeyToUncompressedBytes(key *PublicKey) []byte
func SecretKeyToBytes(sk *SecretKey) []byte
func SignatureToBytes(sig *Signature) []byte
func Verify(pk *PublicKey, sig *Signature, msg []byte) bool
func VerifyProofOfPossession(pk *PublicKey, sig *Signature, msg []byte) bool
type AggregatePublicKey
type AggregateSignature
type Ciphersuite
- func (c Ciphersuite) Bytes() []byte
- func (c Ciphersuite) String() string
type PublicKey
- func AggregatePublicKeys(pks []*PublicKey) (*PublicKey, error)
- func PublicKeyFromCompressedBytes(pkBytes []byte) (*PublicKey, error)
- func PublicKeyFromValidUncompressedBytes(pkBytes []byte) *PublicKey
type SecretKey
- func NewSecretKey() (*SecretKey, error)
- func SecretKeyFromBytes(skBytes []byte) (*SecretKey, error)
- func (sk *SecretKey) PublicKey() *PublicKey
- func (sk *SecretKey) Sign(msg []byte) *Signature
- func (sk *SecretKey) SignProofOfPossession(msg []byte) *Signature
type Signature
- func AggregateSignatures(sigs []*Signature) (*Signature, error)
- func SignatureFromBytes(sigBytes []byte) (*Signature, error)
type Signer

Constants ¶

View Source

const (
	SecretKeyLen = 32
	PublicKeyLen = 48 // Compressed G1 point
	SignatureLen = 96 // Compressed G2 point
)

Variables ¶

View Source

var (
	ErrNoPublicKeys              = errors.New("no public keys")
	ErrFailedPublicKeyDecompress = errors.New("couldn't decompress public key")

	ErrFailedSignatureDecompress  = errors.New("couldn't decompress signature")
	ErrInvalidSignature           = errors.New("invalid signature")
	ErrNoSignatures               = errors.New("no signatures")
	ErrFailedSignatureAggregation = errors.New("couldn't aggregate signatures")
)

Functions ¶

func PublicKeyToCompressedBytes ¶

func PublicKeyToCompressedBytes(pk *PublicKey) []byte

PublicKeyToCompressedBytes returns the compressed big-endian format of the public key.

func PublicKeyToUncompressedBytes ¶

func PublicKeyToUncompressedBytes(key *PublicKey) []byte

PublicKeyToUncompressedBytes returns the uncompressed big-endian format of the public key. For circl/bls, this is the same as compressed.

func SecretKeyToBytes ¶ added in v0.1.3

func SecretKeyToBytes(sk *SecretKey) []byte

SecretKeyToBytes returns the big-endian format of the secret key.

func SignatureToBytes ¶

func SignatureToBytes(sig *Signature) []byte

SignatureToBytes returns the compressed big-endian format of the signature.

func Verify ¶

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

Verify the [sig] of [msg] against the [pk].

func VerifyProofOfPossession ¶

func VerifyProofOfPossession(pk *PublicKey, sig *Signature, msg []byte) bool

VerifyProofOfPossession verifies the possession of the secret pre-image of [sk]

Types ¶

type AggregatePublicKey ¶

type AggregatePublicKey = PublicKey

Types wrapping the circl BLS types

type AggregateSignature ¶

type AggregateSignature = Signature

Types wrapping the circl BLS types

type Ciphersuite ¶

type Ciphersuite int

const (
	CiphersuiteSignature Ciphersuite = iota
	CiphersuiteProofOfPossession
)

func (Ciphersuite) Bytes ¶

func (c Ciphersuite) Bytes() []byte

func (Ciphersuite) String ¶

func (c Ciphersuite) String() string

type PublicKey ¶

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

Types wrapping the circl BLS types

func AggregatePublicKeys ¶

func AggregatePublicKeys(pks []*PublicKey) (*PublicKey, error)

AggregatePublicKeys aggregates a non-zero number of public keys into a single aggregated public key.

func PublicKeyFromCompressedBytes ¶

func PublicKeyFromCompressedBytes(pkBytes []byte) (*PublicKey, error)

PublicKeyFromCompressedBytes parses the compressed big-endian format of the public key into a public key.

func PublicKeyFromValidUncompressedBytes ¶

func PublicKeyFromValidUncompressedBytes(pkBytes []byte) *PublicKey

PublicKeyFromValidUncompressedBytes parses the uncompressed big-endian format of the public key into a public key. It is assumed that the provided bytes are valid.

type SecretKey ¶ added in v0.1.3

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

Types wrapping the circl BLS types

func NewSecretKey ¶ added in v0.1.3

func NewSecretKey() (*SecretKey, error)

NewSecretKey generates a new secret key from the local source of cryptographically secure randomness.

func SecretKeyFromBytes ¶ added in v0.1.3

func SecretKeyFromBytes(skBytes []byte) (*SecretKey, error)

SecretKeyFromBytes parses the big-endian format of the secret key into a secret key.

func (*SecretKey) PublicKey ¶ added in v0.1.3

func (sk *SecretKey) PublicKey() *PublicKey

PublicKey returns the public key associated with the secret key.

func (*SecretKey) Sign ¶ added in v0.1.3

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

Sign [msg] to authorize that this private key signed [msg].

func (*SecretKey) SignProofOfPossession ¶ added in v0.1.3

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

SignProofOfPossession signs a [msg] to prove the ownership of this secret key.

type Signature ¶

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

Types wrapping the circl BLS types

func AggregateSignatures ¶

func AggregateSignatures(sigs []*Signature) (*Signature, error)

AggregateSignatures aggregates a non-zero number of signatures into a single aggregated signature.

func SignatureFromBytes ¶

func SignatureFromBytes(sigBytes []byte) (*Signature, error)

SignatureFromBytes parses the compressed big-endian format of the signature into a signature.

type Signer ¶

type Signer interface {
	PublicKey() *PublicKey
	Sign(msg []byte) (*Signature, error)
	SignProofOfPossession(msg []byte) (*Signature, error)
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
blstest
signer
localsigner

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