Botan  1.11.30
Public Member Functions | List of all members
Botan::PK_Verifier Class Reference

#include <pubkey.h>

Public Member Functions

bool check_signature (const byte sig[], size_t length)
 
template<typename Alloc >
bool check_signature (const std::vector< byte, Alloc > &sig)
 
 PK_Verifier (const Public_Key &pub_key, const std::string &emsa, Signature_Format format=IEEE_1363, const std::string &provider="")
 
void set_input_format (Signature_Format format)
 
void update (byte in)
 
void update (const byte msg_part[], size_t length)
 
void update (const std::vector< byte > &in)
 
void update (const std::string &in)
 
bool verify_message (const byte msg[], size_t msg_length, const byte sig[], size_t sig_length)
 
template<typename Alloc , typename Alloc2 >
bool verify_message (const std::vector< byte, Alloc > &msg, const std::vector< byte, Alloc2 > &sig)
 

Detailed Description

Public Key Verifier. Use the verify_message() functions for small messages. Use multiple calls update() to process large messages and verify the signature by finally calling check_signature().

Definition at line 251 of file pubkey.h.

Constructor & Destructor Documentation

Botan::PK_Verifier::PK_Verifier ( const Public_Key pub_key,
const std::string &  emsa,
Signature_Format  format = IEEE_1363,
const std::string &  provider = "" 
)

Construct a PK Verifier.

Parameters
pub_keythe public key to verify against
emsathe EMSA to use (eg "EMSA3(SHA-1)")
formatthe signature format to use

Definition at line 264 of file pubkey.cpp.

268  {
269  m_op.reset(get_pk_op<PK_Ops::Verification>("Verification", key, emsa_name, provider));
270  m_sig_format = format;
271  }

Member Function Documentation

bool Botan::PK_Verifier::check_signature ( const byte  sig[],
size_t  length 
)

Check the signature of the buffered message, i.e. the one build by successive calls to update.

Parameters
sigthe signature to be verified as a byte array
lengththe length of the above byte array
Returns
true if the signature is valid, false otherwise

Definition at line 292 of file pubkey.cpp.

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

Referenced by botan_pk_op_verify_finish(), and Botan::TLS::Server_Key_Exchange::verify().

293  {
294  try {
295  if(m_sig_format == IEEE_1363)
296  {
297  return m_op->is_valid_signature(sig, length);
298  }
299  else if(m_sig_format == DER_SEQUENCE)
300  {
301  std::vector<byte> real_sig = der_decode_signature(sig, length,
302  m_op->message_part_size(),
303  m_op->message_parts());
304 
305  return m_op->is_valid_signature(real_sig.data(), real_sig.size());
306  }
307  else
308  throw Decoding_Error("PK_Verifier: Unknown signature format " +
309  std::to_string(m_sig_format));
310  }
311  catch(Invalid_Argument&) { return false; }
312  }
std::string to_string(const BER_Object &obj)
Definition: asn1_obj.cpp:47
template<typename Alloc >
bool Botan::PK_Verifier::check_signature ( const std::vector< byte, Alloc > &  sig)
inline

Check the signature of the buffered message, i.e. the one build by successive calls to update.

Parameters
sigthe signature to be verified
Returns
true if the signature is valid, false otherwise

Definition at line 337 of file pubkey.h.

338  {
339  return check_signature(sig.data(), sig.size());
340  }
bool check_signature(const byte sig[], size_t length)
Definition: pubkey.cpp:292
void Botan::PK_Verifier::set_input_format ( Signature_Format  format)

Set the format of the signatures fed to this verifier.

Parameters
formatthe signature format to use

Definition at line 273 of file pubkey.cpp.

References Botan::IEEE_1363.

274  {
275  if(m_op->message_parts() == 1 && format != IEEE_1363)
276  throw Invalid_State("PK_Verifier: This algorithm always uses IEEE 1363");
277  m_sig_format = format;
278  }
void Botan::PK_Verifier::update ( byte  in)
inline

Add a message part (single byte) of the message corresponding to the signature to be verified.

Parameters
inthe byte to add

Definition at line 294 of file pubkey.h.

References update().

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

294 { update(&in, 1); }
void update(byte in)
Definition: pubkey.h:294
void Botan::PK_Verifier::update ( const byte  msg_part[],
size_t  length 
)

Add a message part of the message corresponding to the signature to be verified.

Parameters
msg_partthe new message part as a byte array
lengththe length of the above byte array

Definition at line 287 of file pubkey.cpp.

288  {
289  m_op->update(in, length);
290  }
void Botan::PK_Verifier::update ( const std::vector< byte > &  in)
inline

Add a message part of the message corresponding to the signature to be verified.

Parameters
inthe new message part

Definition at line 309 of file pubkey.h.

310  { update(in.data(), in.size()); }
void update(byte in)
Definition: pubkey.h:294
void Botan::PK_Verifier::update ( const std::string &  in)
inline

Add a message part of the message corresponding to the signature to be verified.

Definition at line 316 of file pubkey.h.

317  {
318  update(reinterpret_cast<const byte*>(in.data()), in.size());
319  }
void update(byte in)
Definition: pubkey.h:294
bool Botan::PK_Verifier::verify_message ( const byte  msg[],
size_t  msg_length,
const byte  sig[],
size_t  sig_length 
)

Verify a signature.

Parameters
msgthe message that the signature belongs to, as a byte array
msg_lengththe length of the above byte array msg
sigthe signature as a byte array
sig_lengththe length of the above byte array sig
Returns
true if the signature is valid

Definition at line 280 of file pubkey.cpp.

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

282  {
283  update(msg, msg_length);
284  return check_signature(sig, sig_length);
285  }
bool check_signature(const byte sig[], size_t length)
Definition: pubkey.cpp:292
void update(byte in)
Definition: pubkey.h:294
template<typename Alloc , typename Alloc2 >
bool Botan::PK_Verifier::verify_message ( const std::vector< byte, Alloc > &  msg,
const std::vector< byte, Alloc2 > &  sig 
)
inline

Verify a signature.

Parameters
msgthe message that the signature belongs to
sigthe signature
Returns
true if the signature is valid

Definition at line 282 of file pubkey.h.

284  {
285  return verify_message(msg.data(), msg.size(),
286  sig.data(), sig.size());
287  }
bool verify_message(const byte msg[], size_t msg_length, const byte sig[], size_t sig_length)
Definition: pubkey.cpp:280

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