#include <emsa_pkcs1.h>

Inheritance diagram for Botan::EMSA_PKCS1v15_Raw:

Public Member Functions
virtual AlgorithmIdentifier	config_for_x509 (const Private_Key &key, const std::string &cert_hash_name) const

	EMSA_PKCS1v15_Raw ()

	EMSA_PKCS1v15_Raw (const std::string &hash_algo)

secure_vector< uint8_t >	encoding_of (const secure_vector< uint8_t > &, size_t, RandomNumberGenerator &rng) override

std::string	name () const override

std::unique_ptr< EMSA >	new_object () override

secure_vector< uint8_t >	raw_data () override

bool	requires_message_recovery () const override

void	update (const uint8_t[], size_t) override

bool	verify (const secure_vector< uint8_t > &, const secure_vector< uint8_t > &, size_t) override

Static Public Member Functions
static std::unique_ptr< EMSA >	create (const std::string &algo_spec)

static std::unique_ptr< EMSA >	create_or_throw (const std::string &algo_spec)

Detailed Description

EMSA_PKCS1v15_Raw which is EMSA_PKCS1v15 without a hash or digest id (which according to QCA docs is "identical to PKCS#11's CKM_RSA_PKCS mechanism", something I have not confirmed)

Definition at line 61 of file emsa_pkcs1.h.

Constructor & Destructor Documentation

◆ EMSA_PKCS1v15_Raw() [1/2]

Botan::EMSA_PKCS1v15_Raw::EMSA_PKCS1v15_Raw ( )

Definition at line 111 of file emsa_pkcs1.cpp.

   {
   m_hash_output_len = 0;
   // m_hash_id, m_hash_name left empty
   }

◆ EMSA_PKCS1v15_Raw() [2/2]

Botan::EMSA_PKCS1v15_Raw::EMSA_PKCS1v15_Raw ( const std::string & hash_algo )

Parameters

hash_algo the digest id for that hash is included in the signature.

Definition at line 117 of file emsa_pkcs1.cpp.

   {
   std::unique_ptr<HashFunction> hash(HashFunction::create_or_throw(hash_algo));
   m_hash_id = pkcs_hash_id(hash_algo);
   m_hash_name = hash->name();
   m_hash_output_len = hash->output_length();
   }

References Botan::HashFunction::create_or_throw(), hash, hash_algo, and Botan::pkcs_hash_id().

Member Function Documentation

◆ config_for_x509()

AlgorithmIdentifier Botan::EMSA::config_for_x509	(	const Private_Key &	key,
		const std::string &	cert_hash_name
	)		const

virtualinherited

Prepare sig_algo for use in choose_sig_format for x509 certs

Parameters

key	used for checking compatibility with the encoding scheme
cert_hash_name	is checked to equal the hash for the encoding

Returns: algorithm identifier to signatures created using this key, padding method and hash.

Reimplemented in Botan::EMSA1, Botan::EMSA_PKCS1v15, and Botan::PSSR.

Definition at line 38 of file emsa.cpp.

   {
   throw Not_Implemented("Encoding " + name() + " not supported for signing X509 objects");
   }

References Botan::EMSA::name().

◆ create()

std::unique_ptr< EMSA > Botan::EMSA::create ( const std::string & algo_spec )

staticinherited

Factory method for EMSA (message-encoding methods for signatures with appendix) objects

Parameters

algo_spec the name of the EMSA to create

Returns: pointer to newly allocated object of that type, or nullptr

Definition at line 44 of file emsa.cpp.

   {
   SCAN_Name req(algo_spec);
 
#if defined(BOTAN_HAS_EMSA1)
   if(req.algo_name() == "EMSA1" && req.arg_count() == 1)
      {
      if(auto hash = HashFunction::create(req.arg(0)))
         return std::make_unique<EMSA1>(std::move(hash));
      }
#endif
 
#if defined(BOTAN_HAS_EMSA_PKCS1)
   if(req.algo_name() == "EMSA_PKCS1" ||
      req.algo_name() == "PKCS1v15" ||
      req.algo_name() == "EMSA-PKCS1-v1_5" ||
      req.algo_name() == "EMSA3")
      {
      if(req.arg_count() == 2 && req.arg(0) == "Raw")
         {
         return std::make_unique<EMSA_PKCS1v15_Raw>(req.arg(1));
         }
      else if(req.arg_count() == 1)
         {
         if(req.arg(0) == "Raw")
            {
            return std::make_unique<EMSA_PKCS1v15_Raw>();
            }
         else
            {
            if(auto hash = HashFunction::create(req.arg(0)))
               {
               return std::make_unique<EMSA_PKCS1v15>(std::move(hash));
               }
            }
         }
      }
#endif
 
#if defined(BOTAN_HAS_EMSA_PSSR)
   if(req.algo_name() == "PSS_Raw" ||
      req.algo_name() == "PSSR_Raw")
      {
      if(req.arg_count_between(1, 3) && req.arg(1, "MGF1") == "MGF1")
         {
         if(auto hash = HashFunction::create(req.arg(0)))
            {
            if(req.arg_count() == 3)
               {
               const size_t salt_size = req.arg_as_integer(2, 0);
               return std::make_unique<PSSR_Raw>(std::move(hash), salt_size);
               }
            else
               {
               return std::make_unique<PSSR_Raw>(std::move(hash));
               }
            }
         }
      }
 
   if(req.algo_name() == "PSS" ||
      req.algo_name() == "PSSR" ||
      req.algo_name() == "EMSA-PSS" ||
      req.algo_name() == "PSS-MGF1" ||
      req.algo_name() == "EMSA4")
      {
      if(req.arg_count_between(1, 3) && req.arg(1, "MGF1") == "MGF1")
         {
         if(auto hash = HashFunction::create(req.arg(0)))
            {
            if(req.arg_count() == 3)
               {
               const size_t salt_size = req.arg_as_integer(2, 0);
               return std::make_unique<PSSR>(std::move(hash), salt_size);
               }
            else
               {
               return std::make_unique<PSSR>(std::move(hash));
               }
            }
         }
      }
#endif
 
#if defined(BOTAN_HAS_ISO_9796)
   if(req.algo_name() == "ISO_9796_DS2")
      {
      if(req.arg_count_between(1, 3))
         {
         if(auto hash = HashFunction::create(req.arg(0)))
            {
            const size_t salt_size = req.arg_as_integer(2, hash->output_length());
            const bool implicit = req.arg(1, "exp") == "imp";
            return std::make_unique<ISO_9796_DS2>(std::move(hash), implicit, salt_size);
            }
         }
      }
   //ISO-9796-2 DS 3 is deterministic and DS2 without a salt
   if(req.algo_name() == "ISO_9796_DS3")
      {
      if(req.arg_count_between(1, 2))
         {
         if(auto hash = HashFunction::create(req.arg(0)))
            {
            const bool implicit = req.arg(1, "exp") == "imp";
            return std::make_unique<ISO_9796_DS3>(std::move(hash), implicit);
            }
         }
      }
#endif
 
#if defined(BOTAN_HAS_EMSA_X931)
   if(req.algo_name() == "EMSA_X931" ||
         req.algo_name() == "EMSA2" ||
         req.algo_name() == "X9.31")
      {
      if(req.arg_count() == 1)
         {
         if(auto hash = HashFunction::create(req.arg(0)))
            {
            return std::make_unique<EMSA_X931>(std::move(hash));
            }
         }
      }
#endif
 
#if defined(BOTAN_HAS_EMSA_RAW)
   if(req.algo_name() == "Raw")
      {
      if(req.arg_count() == 0)
         {
         return std::make_unique<EMSA_Raw>();
         }
      else
         {
         auto hash = HashFunction::create(req.arg(0));
         if(hash)
            return std::make_unique<EMSA_Raw>(hash->output_length());
         }
      }
#endif
 
   return nullptr;
   }

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_as_integer(), Botan::SCAN_Name::arg_count(), Botan::SCAN_Name::arg_count_between(), Botan::HashFunction::create(), hash, and salt_size.

Referenced by Botan::EMSA::create_or_throw().

◆ create_or_throw()

std::unique_ptr< EMSA > Botan::EMSA::create_or_throw ( const std::string & algo_spec )

staticinherited

Factory method for EMSA (message-encoding methods for signatures with appendix) objects

Parameters

algo_spec the name of the EMSA to create

Returns: pointer to newly allocated object of that type, or throws

Definition at line 189 of file emsa.cpp.

   {
   auto emsa = EMSA::create(algo_spec);
   if(emsa)
      return emsa;
   throw Algorithm_Not_Found(algo_spec);
   }

References Botan::EMSA::create().

◆ encoding_of()

secure_vector< uint8_t > Botan::EMSA_PKCS1v15_Raw::encoding_of	(	const secure_vector< uint8_t > &	msg,
		size_t	output_bits,
		RandomNumberGenerator &	rng
	)

overridevirtual

Return the encoding of a message

Parameters

msg	the result of raw_data()
output_bits	the desired output bit size
rng	a random number generator

Returns: encoded signature

Implements Botan::EMSA.

Definition at line 142 of file emsa_pkcs1.cpp.

   {
   return emsa3_encoding(msg, output_bits, m_hash_id.data(), m_hash_id.size());
   }

◆ name()

std::string Botan::EMSA_PKCS1v15_Raw::name ( ) const

inlineoverridevirtual

Returns: the SCAN name of the encoding/padding scheme

Implements Botan::EMSA.

Definition at line 84 of file emsa_pkcs1.h.

         {
         if(m_hash_name.empty()) return "EMSA3(Raw)";
         else return "EMSA3(Raw," + m_hash_name + ")";
         }

◆ new_object()

std::unique_ptr< EMSA > Botan::EMSA_PKCS1v15_Raw::new_object ( )

inlineoverridevirtual

Returns: a new object representing the same encoding method as *this

Implements Botan::EMSA.

Definition at line 64 of file emsa_pkcs1.h.

64{ return std::make_unique<EMSA_PKCS1v15_Raw>(); }

◆ raw_data()

secure_vector< uint8_t > Botan::EMSA_PKCS1v15_Raw::raw_data ( )

overridevirtual

Returns: raw hash

Implements Botan::EMSA.

Definition at line 130 of file emsa_pkcs1.cpp.

   {
   secure_vector<uint8_t> ret;
   std::swap(ret, m_message);
 
   if(m_hash_output_len > 0 && ret.size() != m_hash_output_len)
      throw Encoding_Error("EMSA_PKCS1v15_Raw::encoding_of: Bad input length");
 
   return ret;
   }

◆ requires_message_recovery()

bool Botan::EMSA_PKCS1v15_Raw::requires_message_recovery ( ) const

inlineoverridevirtual

Return true if using this EMSA correctly requires a signature scheme with message recovery

Implements Botan::EMSA.

Definition at line 90 of file emsa_pkcs1.h.

90{ return true; }

◆ update()

void Botan::EMSA_PKCS1v15_Raw::update	(	const uint8_t	input[],
		size_t	length
	)

overridevirtual

Add more data to the signature computation

Parameters

input	some data
length	length of input in bytes

Implements Botan::EMSA.

Definition at line 125 of file emsa_pkcs1.cpp.

   {
   m_message += std::make_pair(input, length);
   }

◆ verify()

bool Botan::EMSA_PKCS1v15_Raw::verify	(	const secure_vector< uint8_t > &	coded,
		const secure_vector< uint8_t > &	raw,
		size_t	key_bits
	)

overridevirtual

Verify the encoding

Parameters

coded	the received (coded) message representative
raw	the computed (local, uncoded) message representative
key_bits	the size of the key in bits

Returns: true if coded is a valid encoding of raw, otherwise false

Implements Botan::EMSA.

Definition at line 149 of file emsa_pkcs1.cpp.

   {
   if(m_hash_output_len > 0 && raw.size() != m_hash_output_len)
      return false;
 
   try
      {
      return (coded == emsa3_encoding(raw, key_bits, m_hash_id.data(), m_hash_id.size()));
      }
   catch(...)
      {
      return false;
      }
   }

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

src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.h
src/lib/pk_pad/emsa_pkcs1/emsa_pkcs1.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EMSA_PKCS1v15_Raw() [1/2]

◆ EMSA_PKCS1v15_Raw() [2/2]

Member Function Documentation

◆ config_for_x509()

◆ create()

◆ create_or_throw()

◆ encoding_of()

◆ name()

◆ new_object()

◆ raw_data()

◆ requires_message_recovery()

◆ update()

◆ verify()