sawtooth_signing package

Submodules

sawtooth_signing.core module

exception sawtooth_signing.core.NoSuchAlgorithmError

Bases: Exception

Thrown when trying to create an algorithm which does not exist.

exception sawtooth_signing.core.SigningError

Bases: Exception

Thrown when an error occurs during the signing process.

exception sawtooth_signing.core.ParseError

Bases: Exception

Thrown when an error occurs during deserialization of a Private or Public key from various formats.

class sawtooth_signing.core.PrivateKey

Bases: object

A private key instance.

The underlying content is dependent on implementation.

get_algorithm_name()

Returns the algorithm name used for this private key.

as_hex()

Return the private key encoded as a hex string.

as_bytes()

Return the private key bytes.

class sawtooth_signing.core.PublicKey

Bases: object

A public key instance.

The underlying content is dependent on implementation.

get_algorithm_name()

Returns the algorithm name used for this public key.

as_hex()

Return the public key encoded as a hex string.

as_bytes()

Return the public key bytes.

class sawtooth_signing.core.Context

Bases: object

A context for a cryptographic signing algorithm.

get_algorithm_name()

Returns the algorithm name.

sign(message, private_key)

Sign a message

Given a private key for this algorithm, sign the given message bytes and return a hex-encoded string of the resulting signature.

Parameters:

• message (bytes) – the message bytes
• private_key (PrivateKey) – the private key

Returns:

The signature in a hex-encoded string

Raises:

SigningError – if any error occurs during the signing process

verify(signature, message, public_key)

Verifies that a signature of a message was produced with the associated public key.

Parameters:

• signature (str) – the hex-encoded signature
• message (bytes) – the message bytes
• public_key (PublicKey) – the public key to use for verification

Returns:

True if the public key is associated with the signature for that method, False otherwise

Return type:

boolean

new_random_private_key()

Generates a new random PrivateKey using this context.

Returns:a random private key Return type:(PrivateKey)

get_public_key(private_key)

Produce a public key for the given private key.

Parameters:private_key (PrivateKey) – a private key Returns:(PublicKey) the public key for the given private key

sawtooth_signing.secp256k1 module

class sawtooth_signing.secp256k1.Secp256k1PrivateKey(secp256k1_private_key)

Bases: sawtooth_signing.core.PrivateKey

get_algorithm_name()

as_hex()

as_bytes()

secp256k1_private_key

static from_hex(hex_str)

static new_random()

class sawtooth_signing.secp256k1.Secp256k1PublicKey(secp256k1_public_key)

Bases: sawtooth_signing.core.PublicKey

secp256k1_public_key

get_algorithm_name()

as_hex()

as_bytes()

static from_hex(hex_str)

class sawtooth_signing.secp256k1.Secp256k1Context

Bases: sawtooth_signing.core.Context

get_algorithm_name()

sign(message, private_key)

verify(signature, message, public_key)

new_random_private_key()

get_public_key(private_key)

Module contents

class sawtooth_signing.Signer(context, private_key)

Bases: object

A convenient wrapper of Context and PrivateKey

sign(message)

Signs the given message

Parameters:message (bytes) – the message bytes Returns:The signature in a hex-encoded string Raises:SigningError – if any error occurs during the signing process

get_public_key()

Return the public key for this Signer instance.

class sawtooth_signing.CryptoFactory(context)

Bases: object

Factory for generating Signers.

context

Return the context that backs this factory instance

new_signer(private_key)

Create a new signer for the given private key.

Parameters:private_key (PrivateKey) – a private key Returns:a signer instance Return type:(Signer)

sawtooth_signing.create_context(algorithm_name)

Returns an algorithm instance by name.

Parameters:algorithm_name (str) – the algorithm name Returns:a context instance for the given algorithm Return type:(Context) Raises:NoSuchAlgorithmError if the algorithm is unknown