#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 &	operator= (const PK_Verifier &)=delete

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

	PK_Verifier (const PK_Verifier &)=delete

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)

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)

	~PK_Verifier ()

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 220 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`
	)

Construct a PK Verifier.

Parameters

pub_key	the public key to verify against
emsa	the EMSA to use (eg "EMSA3(SHA-1)")
format	the signature format to use

Definition at line 245 of file pubkey.cpp.

References Botan::Public_Key::algo_name(), Botan::get_emsa(), Botan::Global_State_Management::global_state(), and Botan::Algorithm_Factory::Engine_Iterator::next().

    {
    Algorithm_Factory::Engine_Iterator i(global_state().algorithm_factory());
 
    while(const Engine* engine = i.next())
       {
       op = engine->get_verify_op(key);
       if(op)
          break;
       }
 
    if(!op)
       throw Lookup_Error("PK_Verifier: No working engine for " +
                          key.algo_name());
 
    emsa = get_emsa(emsa_name);
    sig_format = format;
    }

Botan::PK_Verifier::PK_Verifier ( const PK_Verifier & )

delete

Botan::PK_Verifier::~PK_Verifier ( )

inline

Definition at line 310 of file pubkey.h.

310 { delete op; delete emsa; }

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

sig	the signature to be verified as a byte array
length	the length of the above byte array

Returns: true if the signature is valid, false otherwise

Definition at line 297 of file pubkey.cpp.

References Botan::BER_Decoder::decode(), Botan::DER_SEQUENCE, Botan::BigInt::encode_1363(), Botan::IEEE_1363, Botan::PK_Ops::Verification::message_part_size(), Botan::PK_Ops::Verification::message_parts(), Botan::BER_Decoder::more_items(), Botan::EMSA::raw_data(), Botan::SEQUENCE, Botan::BER_Decoder::start_cons(), and Botan::ASN1::to_string().

Referenced by Botan::PK_Verifier_Filter::end_msg(), Botan::TLS::Server_Key_Exchange::verify(), and verify_message().

    {
    try {
       if(sig_format == IEEE_1363)
          return validate_signature(emsa->raw_data(), sig, length);
       else if(sig_format == DER_SEQUENCE)
          {
          BER_Decoder decoder(sig, length);
          BER_Decoder ber_sig = decoder.start_cons(SEQUENCE);
 
          size_t count = 0;
          std::vector<byte> real_sig;
          while(ber_sig.more_items())
             {
             BigInt sig_part;
             ber_sig.decode(sig_part);
             real_sig += BigInt::encode_1363(sig_part, op->message_part_size());
             ++count;
             }
 
          if(count != op->message_parts())
             throw Decoding_Error("PK_Verifier: signature size invalid");
 
          return validate_signature(emsa->raw_data(),
                                    &real_sig[0], real_sig.size());
          }
       else
          throw Decoding_Error("PK_Verifier: Unknown signature format " +
                               std::to_string(sig_format));
       }
    catch(Invalid_Argument) { return false; }
    }

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

sig	the signature to be verified

Returns: true if the signature is valid, false otherwise

Definition at line 286 of file pubkey.h.

          {
          return check_signature(&sig[0], sig.size());
          }

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

delete

void Botan::PK_Verifier::set_input_format ( Signature_Format format )

Set the format of the signatures fed to this verifier.

Parameters

format the signature format to use

Definition at line 269 of file pubkey.cpp.

References Botan::IEEE_1363, and Botan::PK_Ops::Verification::message_parts().

    {
    if(op->message_parts() == 1 && format != IEEE_1363)
       throw Invalid_State("PK_Verifier: This algorithm always uses IEEE 1363");
    sig_format = format;
    }

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

in	the byte to add

Definition at line 252 of file pubkey.h.

References update().

Referenced by update(), Botan::TLS::Server_Key_Exchange::verify(), verify_message(), and Botan::PK_Verifier_Filter::write().

252 { update(&in, 1); }

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_part	the new message part as a byte array
length	the length of the above byte array

Definition at line 289 of file pubkey.cpp.

References Botan::EMSA::update().

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

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

in	the new message part

Definition at line 267 of file pubkey.h.

References update().

Referenced by update().

268 { update(&in[0], in.size()); }

bool Botan::PK_Verifier::verify_message	(	const byte	msg[],
		size_t	msg_length,
		const byte	sig[],
		size_t	sig_length
	)

Verify a signature.

Parameters

msg	the message that the signature belongs to, as a byte array
msg_length	the length of the above byte array msg
sig	the signature as a byte array
sig_length	the length of the above byte array sig

Returns: true if the signature is valid

Definition at line 279 of file pubkey.cpp.

References check_signature(), and update().

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

    {
    update(msg, msg_length);
    return check_signature(sig, sig_length);
    }

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

msg	the message that the signature belongs to
sig	the signature

Returns: true if the signature is valid

Definition at line 240 of file pubkey.h.

          {
          return verify_message(&msg[0], msg.size(),
                                &sig[0], sig.size());
          }

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

src/pubkey/pubkey.h
src/pubkey/pubkey.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation