Botan 3.14.1
Crypto and TLS for C&
Botan::SignaturePaddingScheme Class Referenceabstract

#include <sig_padding.h>

Inheritance diagram for Botan::SignaturePaddingScheme:
Botan::ISO_9796_DS2 Botan::ISO_9796_DS3 Botan::PKCS1v15_Raw_SignaturePaddingScheme Botan::PKCS1v15_SignaturePaddingScheme Botan::PSSR Botan::PSS_Raw Botan::SignRawBytes Botan::X931_SignaturePadding

Public Member Functions

virtual std::vector< uint8_t > encoding_of (std::span< const uint8_t > msg, size_t output_bits, RandomNumberGenerator &rng)=0
virtual std::string hash_function () const =0
virtual std::string name () const =0
virtual std::vector< uint8_t > raw_data ()=0
virtual void update (const uint8_t input[], size_t length)=0
virtual bool verify (std::span< const uint8_t > encoding, std::span< const uint8_t > raw_hash, size_t key_bits)=0
virtual ~SignaturePaddingScheme ()=default

Static Public Member Functions

static std::unique_ptr< SignaturePaddingScheme > create_or_throw (const PK_Signature_Options_Reader &options)

Detailed Description

RSA Signature Padding Scheme

Previously called 'EMSA' from IEEE 1363's "Encoding Method for Signatures, Appendix"

Definition at line 26 of file sig_padding.h.

Constructor & Destructor Documentation

◆ ~SignaturePaddingScheme()

virtual Botan::SignaturePaddingScheme::~SignaturePaddingScheme ( )
virtualdefault

References create_or_throw().

Member Function Documentation

◆ create_or_throw()

std::unique_ptr< SignaturePaddingScheme > Botan::SignaturePaddingScheme::create_or_throw ( const PK_Signature_Options_Reader & options)
static

Factory method for SignaturePaddingScheme objects

Parameters
optionsthe algorithm parameters
Returns
pointer to newly allocated object of that type, or throws

Definition at line 36 of file sig_padding.cpp.

37 {
38 // Signing without padding is dangerous, so it must be requested explicitly
39 if(!options.using_padding()) {
40 throw Lookup_Error("RSA signatures require specifying a padding scheme");
41 }
42
43 const std::string padding = options.padding().value();
44
45 if(padding == "Raw") {
46#if defined(BOTAN_HAS_EMSA_RAW)
47 // Raw padding signs the input directly, so no hash function is involved
48 return std::make_unique<SignRawBytes>(options);
49#endif
50 } else {
51#if defined(BOTAN_HAS_EMSA_PKCS1)
52 // PKCS1v15 can also sign a digest the caller computed
53 if(padding == "PKCS1v15" && options.using_externally_computed_prehash()) {
54 return std::make_unique<PKCS1v15_Raw_SignaturePaddingScheme>(options);
55 }
56#endif
57
58 if(!options.using_hash()) {
59 throw Lookup_Error(fmt("RSA/{} signatures require specifying a hash function", padding));
60 }
61
62 const std::string& hash_fn = options.hash_function_name();
63 const bool hash_available = HashFunction::create(hash_fn) != nullptr;
64
65#if defined(BOTAN_HAS_EMSA_PKCS1)
66 if(padding == "PKCS1v15" && hash_available) {
67 return std::make_unique<PKCS1v15_SignaturePaddingScheme>(options);
68 }
69#endif
70
71#if defined(BOTAN_HAS_PSS)
72 if(padding == "PSS_Raw" && hash_available) {
73 return std::make_unique<PSS_Raw>(options);
74 }
75
76 if(padding == "PSS" && hash_available) {
77 return std::make_unique<PSSR>(options);
78 }
79#endif
80
81#if defined(BOTAN_HAS_ISO_9796)
82 if(padding == "ISO_9796_DS2" && hash_available) {
83 return std::make_unique<ISO_9796_DS2>(options);
84 }
85
86 if(padding == "ISO_9796_DS3" && hash_available) {
87 return std::make_unique<ISO_9796_DS3>(options);
88 }
89#endif
90
91#if defined(BOTAN_HAS_EMSA_X931)
92 if(padding == "X9.31" && hash_available) {
93 return std::make_unique<X931_SignaturePadding>(options);
94 }
95#endif
96 }
97
98 throw Lookup_Error("Invalid or unavailable signature padding scheme " + options.to_string());
99}
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:112
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References Botan::HashFunction::create(), Botan::fmt(), Botan::PK_Signature_Options_Reader::hash_function_name(), Botan::PK_Signature_Options_Reader::padding(), Botan::PK_Signature_Options_Reader::to_string(), Botan::PK_Signature_Options_Reader::using_externally_computed_prehash(), Botan::PK_Signature_Options_Reader::using_hash(), and Botan::PK_Signature_Options_Reader::using_padding().

Referenced by Botan::ISO_9796_DS2::ISO_9796_DS2(), Botan::ISO_9796_DS3::ISO_9796_DS3(), Botan::PKCS1v15_SignaturePaddingScheme::PKCS1v15_SignaturePaddingScheme(), Botan::PSS_Raw::PSS_Raw(), Botan::PSSR::PSSR(), Botan::X931_SignaturePadding::X931_SignaturePadding(), and ~SignaturePaddingScheme().

◆ encoding_of()

virtual std::vector< uint8_t > Botan::SignaturePaddingScheme::encoding_of ( std::span< const uint8_t > msg,
size_t output_bits,
RandomNumberGenerator & rng )
pure virtual

Return the encoding of a message

Parameters
msgthe result of raw_data()
output_bitsthe desired output bit size
Random Number Generatorsa random number generator
Returns
encoded signature

Implemented in Botan::PKCS1v15_Raw_SignaturePaddingScheme, and Botan::PKCS1v15_SignaturePaddingScheme.

◆ hash_function()

virtual std::string Botan::SignaturePaddingScheme::hash_function ( ) const
pure virtual

◆ name()

virtual std::string Botan::SignaturePaddingScheme::name ( ) const
pure virtual

◆ raw_data()

virtual std::vector< uint8_t > Botan::SignaturePaddingScheme::raw_data ( )
pure virtual

◆ update()

virtual void Botan::SignaturePaddingScheme::update ( const uint8_t input[],
size_t length )
pure virtual

Add more data to the signature computation

Parameters
inputsome data
lengthlength of input in bytes

Implemented in Botan::PKCS1v15_Raw_SignaturePaddingScheme, and Botan::PKCS1v15_SignaturePaddingScheme.

◆ verify()

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

Verify the encoding

Parameters
encodingthe received (coded) message representative
Raw Hash Functionthe computed (local, uncoded) message representative
key_bitsthe size of the key in bits
Returns
true if coded is a valid encoding of raw, otherwise false

Implemented in Botan::PKCS1v15_Raw_SignaturePaddingScheme, and Botan::PKCS1v15_SignaturePaddingScheme.


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