#include <pkcs1_sig_padding.h>

Inheritance diagram for Botan::PKCS1v15_Raw_SignaturePaddingScheme:

Public Member Functions
std::vector< uint8_t >	encoding_of (std::span< const uint8_t > msg, size_t output_bits, RandomNumberGenerator &rng) override
std::string	hash_function () const override
std::string	name () const override
	PKCS1v15_Raw_SignaturePaddingScheme ()
	PKCS1v15_Raw_SignaturePaddingScheme (std::string_view hash_algo)
std::vector< uint8_t >	raw_data () override
void	update (const uint8_t input[], size_t length) override
bool	verify (std::span< const uint8_t > coded, std::span< const uint8_t > raw, size_t key_bits) override

Static Public Member Functions
static std::unique_ptr< SignaturePaddingScheme >	create (std::string_view algo_spec)
static std::unique_ptr< SignaturePaddingScheme >	create_or_throw (std::string_view algo_spec)

Detailed Description

PKCS1v15_SignaturePaddingScheme_Raw which is PKCS1v15_SignaturePaddingScheme 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 58 of file pkcs1_sig_padding.h.

Constructor & Destructor Documentation

◆ PKCS1v15_Raw_SignaturePaddingScheme() [1/2]

Botan::PKCS1v15_Raw_SignaturePaddingScheme::PKCS1v15_Raw_SignaturePaddingScheme ( )

Definition at line 99 of file pkcs1_sig_padding.cpp.

                                                                         : m_hash_output_len(0) {
   // m_hash_id, m_hash_name left empty
}

◆ PKCS1v15_Raw_SignaturePaddingScheme() [2/2]

Botan::PKCS1v15_Raw_SignaturePaddingScheme::PKCS1v15_Raw_SignaturePaddingScheme ( std::string_view hash_algo )

explicit

Parameters

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

Definition at line 103 of file pkcs1_sig_padding.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(), and Botan::pkcs_hash_id().

Member Function Documentation

◆ create()

std::unique_ptr< SignaturePaddingScheme > Botan::SignaturePaddingScheme::create ( std::string_view algo_spec )

staticinherited

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

Parameters

algo_spec the name of the SignaturePaddingScheme to create

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

Definition at line 35 of file sig_padding.cpp.

                                                                                             {
   SCAN_Name req(algo_spec);
 
#if defined(BOTAN_HAS_EMSA_PKCS1)
   // TODO(Botan4) Remove all but "PKCS1v15"
   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<PKCS1v15_Raw_SignaturePaddingScheme>(req.arg(1));
      } else if(req.arg_count() == 1) {
         if(req.arg(0) == "Raw") {
            return std::make_unique<PKCS1v15_Raw_SignaturePaddingScheme>();
         } else {
            if(auto hash = HashFunction::create(req.arg(0))) {
               return std::make_unique<PKCS1v15_SignaturePaddingScheme>(std::move(hash));
            }
         }
      }
   }
#endif
 
#if defined(BOTAN_HAS_EMSA_PSSR)
   // TODO(Botan4) Remove all but "PSS_Raw"
   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<PSS_Raw>(std::move(hash), salt_size);
            } else {
               return std::make_unique<PSS_Raw>(std::move(hash));
            }
         }
      }
   }
 
   // TODO(Botan4) Remove all but "PSS"
   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_X931_SIGNATURE_PADDING)
   // TODO(Botan4) Remove all but "X9.31"
   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<X931_SignaturePadding>(std::move(hash));
         }
      }
   }
#endif
 
#if defined(BOTAN_HAS_RAW_SIGNATURE_PADDING)
   if(req.algo_name() == "Raw") {
      if(req.arg_count() == 0) {
         return std::make_unique<SignRawBytes>();
      } else {
         auto hash = HashFunction::create(req.arg(0));
         if(hash) {
            return std::make_unique<SignRawBytes>(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(), and Botan::HashFunction::create().

Referenced by create_or_throw(), and ~SignaturePaddingScheme().

◆ create_or_throw()

std::unique_ptr< SignaturePaddingScheme > Botan::SignaturePaddingScheme::create_or_throw ( std::string_view algo_spec )

staticinherited

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

Parameters

algo_spec the name of the SignaturePaddingScheme to create

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

Definition at line 135 of file sig_padding.cpp.

                                                                                                      {
   if(auto padding = SignaturePaddingScheme::create(algo_spec)) {
      return padding;
   } else {
      throw Algorithm_Not_Found(algo_spec);
   }
}

References create().

Referenced by ~SignaturePaddingScheme().

◆ encoding_of()

std::vector< uint8_t > Botan::PKCS1v15_Raw_SignaturePaddingScheme::encoding_of	(	std::span< const 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::SignaturePaddingScheme.

Definition at line 125 of file pkcs1_sig_padding.cpp.

                                                                                                {
   return pkcs1v15_sig_encoding(msg, output_bits, m_hash_id);
}

◆ hash_function()

std::string Botan::PKCS1v15_Raw_SignaturePaddingScheme::hash_function ( ) const

inlineoverridevirtual

Return the hash function being used by this padding scheme

Implements Botan::SignaturePaddingScheme.

Definition at line 78 of file pkcs1_sig_padding.h.

78{ return m_hash_name; }

◆ name()

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

overridevirtual

Returns: the SCAN name of the encoding/padding scheme

Implements Botan::SignaturePaddingScheme.

Definition at line 91 of file pkcs1_sig_padding.cpp.

                                                          {
   if(m_hash_name.empty()) {
      return "PKCS1v15(Raw)";
   } else {
      return fmt("PKCS1v15(Raw,{})", m_hash_name);
   }
}

References Botan::fmt().

◆ raw_data()

std::vector< uint8_t > Botan::PKCS1v15_Raw_SignaturePaddingScheme::raw_data ( )

overridevirtual

Returns: raw hash

Implements Botan::SignaturePaddingScheme.

Definition at line 114 of file pkcs1_sig_padding.cpp.

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

◆ update()

void Botan::PKCS1v15_Raw_SignaturePaddingScheme::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::SignaturePaddingScheme.

Definition at line 110 of file pkcs1_sig_padding.cpp.

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

◆ verify()

bool Botan::PKCS1v15_Raw_SignaturePaddingScheme::verify	(	std::span< const uint8_t >	encoding,
		std::span< const uint8_t >	raw_hash,
		size_t	key_bits )

overridevirtual

Verify the encoding

Parameters

encoding	the received (coded) message representative
raw_hash	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::SignaturePaddingScheme.

Definition at line 131 of file pkcs1_sig_padding.cpp.

                                                                  {
   if(m_hash_output_len > 0 && raw.size() != m_hash_output_len) {
      return false;
   }
 
   try {
      const auto pkcs1 = pkcs1v15_sig_encoding(raw, key_bits, m_hash_id);
      return constant_time_compare(coded, pkcs1);
   } catch(...) {
      return false;
   }
}

References Botan::constant_time_compare().

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PKCS1v15_Raw_SignaturePaddingScheme() [1/2]

◆ PKCS1v15_Raw_SignaturePaddingScheme() [2/2]

Member Function Documentation

◆ create()

◆ create_or_throw()

◆ encoding_of()

◆ hash_function()

◆ name()

◆ raw_data()

◆ update()

◆ verify()