Botan 3.14.1
Crypto and TLS for C&
Botan::PKCS1v15_SignaturePaddingScheme Class Referencefinal

#include <pkcs1_sig_padding.h>

Inheritance diagram for Botan::PKCS1v15_SignaturePaddingScheme:
Botan::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_SignaturePaddingScheme (const PK_Signature_Options_Reader &options)
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_or_throw (const PK_Signature_Options_Reader &options)

Detailed Description

PKCS #1 v1.5 signature padding aka PKCS #1 block type 1 aka EMSA3 from IEEE 1363

Definition at line 27 of file pkcs1_sig_padding.h.

Constructor & Destructor Documentation

◆ PKCS1v15_SignaturePaddingScheme()

Botan::PKCS1v15_SignaturePaddingScheme::PKCS1v15_SignaturePaddingScheme ( const PK_Signature_Options_Reader & options)
explicit

Definition at line 81 of file pkcs1_sig_padding.cpp.

81 :
82 m_hash(HashFunction::create_or_throw(options.hash_function_name())) {
84 m_hash_id = pkcs_hash_id(m_hash->name());
85}
static std::unique_ptr< HashFunction > create_or_throw(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:311
void acknowledge_always_deterministic(const PK_Signature_Options_Reader &options)
std::vector< uint8_t > pkcs_hash_id(std::string_view name)
Definition hash_id.cpp:78

References Botan::acknowledge_always_deterministic(), Botan::SignaturePaddingScheme::create_or_throw(), and Botan::pkcs_hash_id().

Member Function Documentation

◆ create_or_throw()

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

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()

std::vector< uint8_t > Botan::PKCS1v15_SignaturePaddingScheme::encoding_of ( std::span< const uint8_t > msg,
size_t output_bits,
RandomNumberGenerator & rng )
overridevirtual

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

Implements Botan::SignaturePaddingScheme.

Definition at line 56 of file pkcs1_sig_padding.cpp.

58 {
59 if(msg.size() != m_hash->output_length()) {
60 throw Encoding_Error("PKCS1v15_SignaturePaddingScheme::encoding_of: Bad input length");
61 }
62
63 return pkcs1v15_sig_encoding(msg, output_bits, m_hash_id);
64}

◆ hash_function()

std::string Botan::PKCS1v15_SignaturePaddingScheme::hash_function ( ) const
overridevirtual

Return the hash function being used by this padding scheme

Implements Botan::SignaturePaddingScheme.

Definition at line 87 of file pkcs1_sig_padding.cpp.

87 {
88 return m_hash->name();
89}

◆ name()

std::string Botan::PKCS1v15_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.

91 {
92 return fmt("PKCS1v15({})", m_hash->name());
93}

References Botan::fmt().

◆ raw_data()

std::vector< uint8_t > Botan::PKCS1v15_SignaturePaddingScheme::raw_data ( )
overridevirtual
Returns
raw hash

Implements Botan::SignaturePaddingScheme.

Definition at line 52 of file pkcs1_sig_padding.cpp.

52 {
53 return m_hash->final_stdvec();
54}

◆ update()

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

Add more data to the signature computation

Parameters
inputsome data
lengthlength of input in bytes

Implements Botan::SignaturePaddingScheme.

Definition at line 48 of file pkcs1_sig_padding.cpp.

48 {
49 m_hash->update(input, length);
50}

◆ verify()

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

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

Implements Botan::SignaturePaddingScheme.

Definition at line 66 of file pkcs1_sig_padding.cpp.

68 {
69 if(raw.size() != m_hash->output_length()) {
70 return false;
71 }
72
73 try {
74 const auto pkcs1 = pkcs1v15_sig_encoding(raw, key_bits, m_hash_id);
75 return constant_time_compare(coded, pkcs1);
76 } catch(...) {
77 return false;
78 }
79}
bool constant_time_compare(std::span< const uint8_t > x, std::span< const uint8_t > y)
Definition mem_ops.cpp:17

References Botan::constant_time_compare().


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