Botan::PK_Signer Class Reference

#include <pubkey.h>

Public Member Functions
PK_Signer &	operator= (const PK_Signer &)=delete
	PK_Signer (const Private_Key &key, RandomNumberGenerator &rng, const std::string &emsa, Signature_Format format=IEEE_1363, const std::string &provider="")
	PK_Signer (const PK_Signer &)=delete
void	set_output_format (Signature_Format format)
std::vector< uint8_t >	sign_message (const uint8_t in[], size_t length, RandomNumberGenerator &rng)
template<typename Alloc >
std::vector< uint8_t >	sign_message (const std::vector< uint8_t, Alloc > &in, RandomNumberGenerator &rng)
std::vector< uint8_t >	signature (RandomNumberGenerator &rng)
size_t	signature_length () const
void	update (uint8_t in)
void	update (const uint8_t in[], size_t length)
template<typename Alloc >
void	update (const std::vector< uint8_t, Alloc > &in)
void	update (const std::string &in)
	~PK_Signer ()

Detailed Description

Public Key Signer. Use the sign_message() functions for small messages. Use multiple calls update() to process large messages and generate the signature by finally calling signature().

Definition at line 171 of file pubkey.h.

Constructor & Destructor Documentation

PK_Signer() [1/2]

Botan::PK_Signer::PK_Signer	(	const Private_Key &	key,
		RandomNumberGenerator &	rng,
		const std::string &	emsa,
		Signature_Format	format = IEEE_1363,
		const std::string &	provider = ""
	)

Construct a PK Signer.

Parameters

key	the key to use inside this signer
rng	the random generator to use
emsa	the EMSA to use An example would be "EMSA1(SHA-224)".
format	the signature format to use
provider	the provider to use

Definition at line 226 of file pubkey.cpp.

References Botan::Public_Key::algo_name(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::message_part_size(), and Botan::Public_Key::message_parts().

   {
   m_op = key.create_signature_op(rng, emsa, provider);
   if(!m_op)
      throw Invalid_Argument("Key type " + key.algo_name() + " does not support signature generation");
   m_sig_format = format;
   m_parts = key.message_parts();
   m_part_size = key.message_part_size();
   }

~PK_Signer()

Botan::PK_Signer::~PK_Signer

(

)

Definition at line 240 of file pubkey.cpp.

{ /* for unique_ptr */ }

PK_Signer() [2/2]

Botan::PK_Signer::PK_Signer ( const PK_Signer &  )

delete

Member Function Documentation

operator=()

PK_Signer& Botan::PK_Signer::operator= ( const PK_Signer &  )

delete

set_output_format()

void Botan::PK_Signer::set_output_format ( Signature_Format  format )

inline

Set the output format of the signature.

Parameters

format

the signature format to use

Definition at line 284 of file pubkey.h.

{ m_sig_format = format; }

sign_message() [1/2]

std::vector<uint8_t> Botan::PK_Signer::sign_message ( const uint8_t  in[], size_t  length, RandomNumberGenerator &  rng  )

inline

Sign a message all in one go

Parameters

in	the message to sign as a byte array
length	the length of the above byte array
rng	the rng to use

Returns

signature

Definition at line 219 of file pubkey.h.

References update.

Referenced by Botan::X509_Object::make_signed(), Botan::KeyPair::signature_consistency_check(), and Botan::TLS::Callbacks::tls_sign_message().

         {
         this->update(in, length);
         return this->signature(rng);
         }

sign_message() [2/2]

template<typename Alloc >

std::vector<uint8_t> Botan::PK_Signer::sign_message ( const std::vector< uint8_t, Alloc > &  in, RandomNumberGenerator &  rng  )

inline

Sign a message.

Parameters

in	the message to sign
rng	the rng to use

Returns

signature

Definition at line 233 of file pubkey.h.

         {
         return sign_message(in.data(), in.size(), rng);
         }

signature()

std::vector< uint8_t > Botan::PK_Signer::signature

(

RandomNumberGenerator &

rng

)

Get the signature of the so far processed message (provided by the calls to update()).

Parameters

rng	the rng to use

Returns

signature of the total message

Definition at line 286 of file pubkey.cpp.

References Botan::DER_SEQUENCE, Botan::IEEE_1363, and Botan::unlock().

   {
   const std::vector<uint8_t> sig = unlock(m_op->sign(rng));

   if(m_sig_format == IEEE_1363)
      {
      return sig;
      }
   else if(m_sig_format == DER_SEQUENCE)
      {
      return der_encode_signature(sig, m_parts, m_part_size);
      }
   else
      throw Internal_Error("PK_Signer: Invalid signature format enum");
   }

signature_length()

size_t Botan::PK_Signer::signature_length

(

)

const

Return an upper bound on the length of the signatures this PK_Signer will produce

Definition at line 270 of file pubkey.cpp.

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

Referenced by botan_pk_op_sign_output_length().

   {
   if(m_sig_format == IEEE_1363)
      {
      return m_op->signature_length();
      }
   else if(m_sig_format == DER_SEQUENCE)
      {
      // This is a large over-estimate but its easier than computing
      // the exact value
      return m_op->signature_length() + (8 + 4*m_parts);
      }
   else
      throw Internal_Error("PK_Signer: Invalid signature format enum");
   }

update() [1/4]

void Botan::PK_Signer::update ( uint8_t  in )

inline

Add a message part (single byte).

Parameters

in	the byte to add

Definition at line 243 of file pubkey.h.

References update().

Referenced by botan_pk_op_sign_update(), and update().

{ update(&in, 1); }

update() [2/4]

void Botan::PK_Signer::update	(	const uint8_t	in[],
		size_t	length
	)

Add a message part.

Parameters

in	the message part to add as a byte array
length	the length of the above byte array

Definition at line 242 of file pubkey.cpp.

   {
   m_op->update(in, length);
   }

update() [3/4]

template<typename Alloc >

void Botan::PK_Signer::update ( const std::vector< uint8_t, Alloc > &  in )

inline

Add a message part.

Parameters

in	the message part to add

Definition at line 257 of file pubkey.h.

References update.

         {
         update(in.data(), in.size());
         }

update() [4/4]

void Botan::PK_Signer::update ( const std::string &  in )

inline

Add a message part.

Parameters

in	the message part to add

Definition at line 266 of file pubkey.h.

References Botan::cast_char_ptr_to_uint8(), and update.

         {
         update(cast_char_ptr_to_uint8(in.data()), in.size());
         }

---

The documentation for this class was generated from the following files:

• src/lib/pubkey/pubkey.h
• src/lib/pubkey/pubkey.cpp