Botan::X931_SignaturePadding Class Reference

#include <x931_sig_padding.h>

Inheritance diagram for Botan::X931_SignaturePadding:

Public Member Functions
std::string	hash_function () const override
std::string	name () const override
	X931_SignaturePadding (std::unique_ptr< HashFunction > hash)

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

Padding scheme from X9.31 (aka EMSA2 in IEEE 1363)

Historically used for signature padding with Rabin-Williams, which is not implemented by Botan anymore.

Sometimes used with RSA in odd protocols.

Definition at line 24 of file x931_sig_padding.h.

Constructor & Destructor Documentation

X931_SignaturePadding()

Botan::X931_SignaturePadding::X931_SignaturePadding ( std::unique_ptr< HashFunction > hash )

explicit

Parameters

Hashes

the hash function to use

Definition at line 93 of file x931_sig_padding.cpp.

                                                                             : m_hash(std::move(hash)) {
   m_empty_hash = m_hash->final_stdvec();
 
   m_hash_id = ieee1363_hash_id(m_hash->name());
 
   if(m_hash_id == 0) {
      throw Encoding_Error("X931_SignaturePadding no hash identifier for " + m_hash->name());
   }
}

References Botan::ieee1363_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.

                                                                                             {
   const 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)) {
         const std::string trailer = req.arg(1, "exp");
         if(trailer != "imp" && trailer != "exp") {
            return nullptr;
         }
         if(auto hash = HashFunction::create(req.arg(0))) {
            const size_t salt_size = req.arg_as_integer(2, hash->output_length());
            return std::make_unique<ISO_9796_DS2>(std::move(hash), trailer == "imp", 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)) {
         const std::string trailer = req.arg(1, "exp");
         if(trailer != "imp" && trailer != "exp") {
            return nullptr;
         }
         if(auto hash = HashFunction::create(req.arg(0))) {
            return std::make_unique<ISO_9796_DS3>(std::move(hash), trailer == "imp");
         }
      }
   }
#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 141 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().

hash_function()

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

overridevirtual

Return the hash function being used by this padding scheme

Implements Botan::SignaturePaddingScheme.

Definition at line 53 of file x931_sig_padding.cpp.

                                                     {
   return m_hash->name();
}

name()

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

overridevirtual

Returns

the SCAN name of the encoding/padding scheme

Implements Botan::SignaturePaddingScheme.

Definition at line 57 of file x931_sig_padding.cpp.

                                            {
   return fmt("X9.31({})", m_hash->name());
}

References Botan::fmt().

---

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

• src/lib/pk_pad/sig_padding/emsa_x931/x931_sig_padding.h
• src/lib/pk_pad/sig_padding/emsa_x931/x931_sig_padding.cpp