falcon

Documentation

Index

• Constants
• Variables
• func GenerateKey() (publicKey []byte, secretKey []byte, err error)
• func Sign(secretKey []byte, message []byte) ([]byte, error)
• func Verify(message []byte, signature []byte, publicKey []byte) error
• type FalconSig
  • func CreateFalconSig() FalconSig
  • func (s FalconSig) CombinePublicKeySignature(sigBytes []byte, pubKeyBytes []byte) (combinedSignature []byte, err error)
  • func (s FalconSig) DecodePublicKey(encoded []byte) (*signaturealgorithm.PublicKey, error)
  • func (s FalconSig) DeserializePrivateKey(priv []byte) (*signaturealgorithm.PrivateKey, error)
  • func (s FalconSig) DeserializePublicKey(pub []byte) (*signaturealgorithm.PublicKey, error)
  • func (s FalconSig) EncodePublicKey(pubKey *signaturealgorithm.PublicKey) []byte
  • func (s FalconSig) GenerateKey() (*signaturealgorithm.PrivateKey, error)
  • func (s FalconSig) HexToPrivateKey(hexkey string) (*signaturealgorithm.PrivateKey, error)
  • func (s FalconSig) HexToPrivateKeyNoError(hexkey string) *signaturealgorithm.PrivateKey
  • func (s FalconSig) HexToPublicKey(hexkey string) (*signaturealgorithm.PublicKey, error)
  • func (s FalconSig) LoadPrivateKeyFromFile(file string) (*signaturealgorithm.PrivateKey, error)
  • func (s FalconSig) PrivateKeyLength() int
  • func (s FalconSig) PrivateKeyToHex(priv *signaturealgorithm.PrivateKey) (string, error)
  • func (s FalconSig) PublicKeyAndSignatureFromCombinedSignature(digestHash []byte, sig []byte) (signature []byte, pubKey []byte, err error)
  • func (s FalconSig) PublicKeyBytesFromSignature(digestHash []byte, sig []byte) ([]byte, error)
  • func (s FalconSig) PublicKeyFromSignature(digestHash []byte, sig []byte) (*signaturealgorithm.PublicKey, error)
  • func (s FalconSig) PublicKeyLength() int
  • func (s FalconSig) PublicKeyStartValue() byte
  • func (s FalconSig) PublicKeyToAddress(p *signaturealgorithm.PublicKey) (common.Address, error)
  • func (s FalconSig) PublicKeyToAddressNoError(p *signaturealgorithm.PublicKey) common.Address
  • func (s FalconSig) PublicKeyToHex(pub *signaturealgorithm.PublicKey) (string, error)
  • func (s FalconSig) SavePrivateKeyToFile(file string, key *signaturealgorithm.PrivateKey) error
  • func (s FalconSig) SerializePrivateKey(priv *signaturealgorithm.PrivateKey) ([]byte, error)
  • func (s FalconSig) SerializePublicKey(pub *signaturealgorithm.PublicKey) ([]byte, error)
  • func (s FalconSig) Sign(digestHash []byte, prv *signaturealgorithm.PrivateKey) (sig []byte, err error)
  • func (s FalconSig) SignatureLength() int
  • func (s FalconSig) SignatureName() string
  • func (s FalconSig) SignatureStartValue() byte
  • func (s FalconSig) SignatureWithPublicKeyLength() int
  • func (osig FalconSig) ValidateSignatureValues(v byte, r, s *big.Int, homestead bool) bool
  • func (s FalconSig) Verify(pubKey []byte, digestHash []byte, signature []byte) bool
  • func (s FalconSig) Zeroize(prv *signaturealgorithm.PrivateKey)

Constants

const (
	OK                                 = 0
	CRYPTO_SECRETKEY_BYTES             = 1281
	CRYPTO_PUBLICKEY_BYTES             = 897
	CRYPTO_MESSAGE_LEN                 = 32                                //todo: validate this
	CRYPTO_SIGNATURE_BYTES             = 690 + 40 + 2 + CRYPTO_MESSAGE_LEN //Nonce + 2 for size
	CRYPTO_SIGNATURE_BYTES_WITH_LENGTH = CRYPTO_SIGNATURE_BYTES + common.LengthByteSize
	SIG_NAME                           = "Falcon-512"
)

Variables

var (
	ErrSignatureInitial       = errors.New("signature mechanism is not supported by OQS")
	ErrInvalidMsgLen          = errors.New("invalid message length, need 32 bytes")
	ErrInvalidSignatureLen    = errors.New("invalid signature length")
	ErrInvalidPublicKeyLen    = errors.New("invalid public key length")
	ErrInvalidPrivateKeyLen   = errors.New("invalid private key length")
	ErrInvalidRecoveryID      = errors.New("invalid signature recovery id")
	ErrInvalidKey             = errors.New("invalid private key")
	ErrInvalidPubkey          = errors.New("invalid public key")
	ErrMismatchPublicKey      = errors.New("mismatch public key")
	ErrSignFailed             = errors.New("signing failed")
	ErrRecoverFailed          = errors.New("recovery failed")
	ErrKeypairFailed          = errors.New("can not generate keypair")
	ErrInvalidLen             = errors.New("invalid length")
	ErrVerifyFailed           = errors.New("verify length")
	ErrRecoverPublicKeyFailed = errors.New("recover public key length")
)

Functions

func GenerateKey

func GenerateKey() (publicKey []byte, secretKey []byte, err error)

func Sign

func Sign(secretKey []byte, message []byte) ([]byte, error)

func Verify

func Verify(message []byte, signature []byte, publicKey []byte) error

Verify verifies the validity of a signed message, returning true if the signature is valid, and false otherwise.

Types

type FalconSig

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

func CreateFalconSig

func CreateFalconSig() FalconSig

func (FalconSig) CombinePublicKeySignature

func (s FalconSig) CombinePublicKeySignature(sigBytes []byte, pubKeyBytes []byte) (combinedSignature []byte, err error)

func (FalconSig) DecodePublicKey

func (s FalconSig) DecodePublicKey(encoded []byte) (*signaturealgorithm.PublicKey, error)

func (FalconSig) DeserializePrivateKey

func (s FalconSig) DeserializePrivateKey(priv []byte) (*signaturealgorithm.PrivateKey, error)

func (FalconSig) DeserializePublicKey

func (s FalconSig) DeserializePublicKey(pub []byte) (*signaturealgorithm.PublicKey, error)

func (FalconSig) EncodePublicKey

func (s FalconSig) EncodePublicKey(pubKey *signaturealgorithm.PublicKey) []byte

func (FalconSig) GenerateKey

func (s FalconSig) GenerateKey() (*signaturealgorithm.PrivateKey, error)

func (FalconSig) HexToPrivateKey

func (s FalconSig) HexToPrivateKey(hexkey string) (*signaturealgorithm.PrivateKey, error)

func (FalconSig) HexToPrivateKeyNoError

func (s FalconSig) HexToPrivateKeyNoError(hexkey string) *signaturealgorithm.PrivateKey

func (FalconSig) HexToPublicKey

func (s FalconSig) HexToPublicKey(hexkey string) (*signaturealgorithm.PublicKey, error)

func (FalconSig) LoadPrivateKeyFromFile

func (s FalconSig) LoadPrivateKeyFromFile(file string) (*signaturealgorithm.PrivateKey, error)

func (FalconSig) PrivateKeyLength

func (s FalconSig) PrivateKeyLength() int

func (FalconSig) PrivateKeyToHex

func (s FalconSig) PrivateKeyToHex(priv *signaturealgorithm.PrivateKey) (string, error)

func (FalconSig) PublicKeyAndSignatureFromCombinedSignature

func (s FalconSig) PublicKeyAndSignatureFromCombinedSignature(digestHash []byte, sig []byte) (signature []byte, pubKey []byte, err error)

func (FalconSig) PublicKeyBytesFromSignature

func (s FalconSig) PublicKeyBytesFromSignature(digestHash []byte, sig []byte) ([]byte, error)

func (FalconSig) PublicKeyFromSignature

func (s FalconSig) PublicKeyFromSignature(digestHash []byte, sig []byte) (*signaturealgorithm.PublicKey, error)

func (FalconSig) PublicKeyLength

func (s FalconSig) PublicKeyLength() int

func (FalconSig) PublicKeyStartValue

func (s FalconSig) PublicKeyStartValue() byte

func (FalconSig) PublicKeyToAddress

func (s FalconSig) PublicKeyToAddress(p *signaturealgorithm.PublicKey) (common.Address, error)

func (FalconSig) PublicKeyToAddressNoError

func (s FalconSig) PublicKeyToAddressNoError(p *signaturealgorithm.PublicKey) common.Address

func (FalconSig) PublicKeyToHex

func (s FalconSig) PublicKeyToHex(pub *signaturealgorithm.PublicKey) (string, error)

func (FalconSig) SavePrivateKeyToFile

func (s FalconSig) SavePrivateKeyToFile(file string, key *signaturealgorithm.PrivateKey) error

func (FalconSig) SerializePrivateKey

func (s FalconSig) SerializePrivateKey(priv *signaturealgorithm.PrivateKey) ([]byte, error)

func (FalconSig) SerializePublicKey

func (s FalconSig) SerializePublicKey(pub *signaturealgorithm.PublicKey) ([]byte, error)

func (FalconSig) Sign

func (s FalconSig) Sign(digestHash []byte, prv *signaturealgorithm.PrivateKey) (sig []byte, err error)

func (FalconSig) SignatureLength

func (s FalconSig) SignatureLength() int

func (FalconSig) SignatureName

func (s FalconSig) SignatureName() string

func (FalconSig) SignatureStartValue

func (s FalconSig) SignatureStartValue() byte

func (FalconSig) SignatureWithPublicKeyLength

func (s FalconSig) SignatureWithPublicKeyLength() int

func (FalconSig) ValidateSignatureValues

func (osig FalconSig) ValidateSignatureValues(v byte, r, s *big.Int, homestead bool) bool

ValidateSignatureValues verifies whether the signature values are valid with the given chain rules. The v value is assumed to be either 0 or 1.

func (FalconSig) Verify

func (s FalconSig) Verify(pubKey []byte, digestHash []byte, signature []byte) bool

func (FalconSig) Zeroize

func (s FalconSig) Zeroize(prv *signaturealgorithm.PrivateKey)