Botan::PK_Signer Class Reference

#include <pubkey.h>

Public Member Functions
	PK_Signer (const Private_Key &key, const std::string &emsa, Signature_Format format=IEEE_1363, const std::string &provider="")
void	set_output_format (Signature_Format format)
std::vector< byte >	sign_message (const byte in[], size_t length, RandomNumberGenerator &rng)
std::vector< byte >	sign_message (const std::vector< byte > &in, RandomNumberGenerator &rng)
std::vector< byte >	sign_message (const secure_vector< byte > &in, RandomNumberGenerator &rng)
std::vector< byte >	signature (RandomNumberGenerator &rng)
void	update (byte in)
void	update (const byte in[], size_t length)
void	update (const std::vector< byte > &in)
void	update (const std::string &in)

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 156 of file pubkey.h.

Constructor & Destructor Documentation

Botan::PK_Signer::PK_Signer	(	const Private_Key &	key,
		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
emsa	the EMSA to use An example would be "EMSA1(SHA-224)".
format	the signature format to use

Definition at line 236 of file pubkey.cpp.

   {
   m_op.reset(get_pk_op<PK_Ops::Signature>("Signing", key, emsa, provider));
   m_sig_format = format;
   }

Member Function Documentation

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 240 of file pubkey.h.

{ m_sig_format = format; }

std::vector<byte> Botan::PK_Signer::sign_message ( const byte  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 179 of file pubkey.h.

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

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

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

inline

Sign a message.

Parameters

in	the message to sign
rng	the rng to use

Returns

signature

Definition at line 192 of file pubkey.h.

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

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

inline

Definition at line 196 of file pubkey.h.

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

std::vector< byte > 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 250 of file pubkey.cpp.

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

Referenced by Botan::TLS::Server_Key_Exchange::Server_Key_Exchange().

   {
   const std::vector<byte> plain_sig = unlock(m_op->sign(rng));
   const size_t parts = m_op->message_parts();

   if(parts == 1 || m_sig_format == IEEE_1363)
      return plain_sig;
   else if(m_sig_format == DER_SEQUENCE)
      return der_encode_signature(plain_sig, parts);
   else
      throw Encoding_Error("PK_Signer: Unknown signature format " +
                           std::to_string(m_sig_format));
   }

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

inline

Add a message part (single byte).

Parameters

in	the byte to add

Definition at line 204 of file pubkey.h.

References update().

Referenced by botan_pk_op_sign_update(), Botan::TLS::Server_Key_Exchange::Server_Key_Exchange(), and update().

{ update(&in, 1); }

void Botan::PK_Signer::update	(	const byte	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 245 of file pubkey.cpp.

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

void Botan::PK_Signer::update ( const std::vector< byte > &  in )

inline

Add a message part.

Parameters

in	the message part to add

Definition at line 217 of file pubkey.h.

References update().

Referenced by update().

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

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

inline

Add a message part.

Parameters

in	the message part to add

Definition at line 223 of file pubkey.h.

         {
         update(reinterpret_cast<const byte*>(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