Botan 3.8.1
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::EMSA_PKCS1v15 Class Referencefinal

#include <emsa_pkcs1.h>

Inheritance diagram for Botan::EMSA_PKCS1v15:
Botan::EMSA

Public Member Functions

 EMSA_PKCS1v15 (std::unique_ptr< HashFunction > hash)
 
std::vector< uint8_t > encoding_of (std::span< const uint8_t >, size_t, RandomNumberGenerator &rng) override
 
std::string hash_function () const override
 
std::string name () const override
 
std::vector< uint8_t > raw_data () override
 
void update (const uint8_t[], size_t) override
 
bool verify (std::span< const uint8_t >, std::span< const uint8_t >, size_t) override
 

Static Public Member Functions

static std::unique_ptr< EMSA > create (std::string_view algo_spec)
 
static std::unique_ptr< EMSA > create_or_throw (std::string_view algo_spec)
 

Detailed Description

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

Definition at line 21 of file emsa_pkcs1.h.

Constructor & Destructor Documentation

◆ EMSA_PKCS1v15()

Botan::EMSA_PKCS1v15::EMSA_PKCS1v15 ( std::unique_ptr< HashFunction > hash)
explicit
Parameters
hashthe hash function to use

Definition at line 74 of file emsa_pkcs1.cpp.

74 : m_hash(std::move(hash)) {
75 m_hash_id = pkcs_hash_id(m_hash->name());
76}
Botan::pkcs_hash_id
std::vector< uint8_t > pkcs_hash_id(std::string_view name)
Definition hash_id.cpp:78

References Botan::pkcs_hash_id().

Member Function Documentation

◆ create()

std::unique_ptr< EMSA > Botan::EMSA::create ( std::string_view algo_spec)
staticinherited

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

Parameters
algo_specthe name of the EMSA to create
Returns
pointer to newly allocated object of that type, or nullptr

Definition at line 35 of file emsa.cpp.

35 {
36 SCAN_Name req(algo_spec);
37
38#if defined(BOTAN_HAS_EMSA_PKCS1)
39 // TODO(Botan4) Remove all but "PKCS1v15"
40 if(req.algo_name() == "EMSA_PKCS1" || req.algo_name() == "PKCS1v15" || req.algo_name() == "EMSA-PKCS1-v1_5" ||
41 req.algo_name() == "EMSA3") {
42 if(req.arg_count() == 2 && req.arg(0) == "Raw") {
43 return std::make_unique<EMSA_PKCS1v15_Raw>(req.arg(1));
44 } else if(req.arg_count() == 1) {
45 if(req.arg(0) == "Raw") {
46 return std::make_unique<EMSA_PKCS1v15_Raw>();
47 } else {
48 if(auto hash = HashFunction::create(req.arg(0))) {
49 return std::make_unique<EMSA_PKCS1v15>(std::move(hash));
50 }
51 }
52 }
53 }
54#endif
55
56#if defined(BOTAN_HAS_EMSA_PSSR)
57 // TODO(Botan4) Remove all but "PSS_Raw"
58 if(req.algo_name() == "PSS_Raw" || req.algo_name() == "PSSR_Raw") {
59 if(req.arg_count_between(1, 3) && req.arg(1, "MGF1") == "MGF1") {
60 if(auto hash = HashFunction::create(req.arg(0))) {
61 if(req.arg_count() == 3) {
62 const size_t salt_size = req.arg_as_integer(2, 0);
63 return std::make_unique<PSSR_Raw>(std::move(hash), salt_size);
64 } else {
65 return std::make_unique<PSSR_Raw>(std::move(hash));
66 }
67 }
68 }
69 }
70
71 // TODO(Botan4) Remove all but "PSS"
72 if(req.algo_name() == "PSS" || req.algo_name() == "PSSR" || req.algo_name() == "EMSA-PSS" ||
73 req.algo_name() == "PSS-MGF1" || req.algo_name() == "EMSA4") {
74 if(req.arg_count_between(1, 3) && req.arg(1, "MGF1") == "MGF1") {
75 if(auto hash = HashFunction::create(req.arg(0))) {
76 if(req.arg_count() == 3) {
77 const size_t salt_size = req.arg_as_integer(2, 0);
78 return std::make_unique<PSSR>(std::move(hash), salt_size);
79 } else {
80 return std::make_unique<PSSR>(std::move(hash));
81 }
82 }
83 }
84 }
85#endif
86
87#if defined(BOTAN_HAS_ISO_9796)
88 if(req.algo_name() == "ISO_9796_DS2") {
89 if(req.arg_count_between(1, 3)) {
90 if(auto hash = HashFunction::create(req.arg(0))) {
91 const size_t salt_size = req.arg_as_integer(2, hash->output_length());
92 const bool implicit = req.arg(1, "exp") == "imp";
93 return std::make_unique<ISO_9796_DS2>(std::move(hash), implicit, salt_size);
94 }
95 }
96 }
97 //ISO-9796-2 DS 3 is deterministic and DS2 without a salt
98 if(req.algo_name() == "ISO_9796_DS3") {
99 if(req.arg_count_between(1, 2)) {
100 if(auto hash = HashFunction::create(req.arg(0))) {
101 const bool implicit = req.arg(1, "exp") == "imp";
102 return std::make_unique<ISO_9796_DS3>(std::move(hash), implicit);
103 }
104 }
105 }
106#endif
107
108#if defined(BOTAN_HAS_EMSA_X931)
109 // TODO(Botan4) Remove all but "X9.31"
110 if(req.algo_name() == "EMSA_X931" || req.algo_name() == "EMSA2" || req.algo_name() == "X9.31") {
111 if(req.arg_count() == 1) {
112 if(auto hash = HashFunction::create(req.arg(0))) {
113 return std::make_unique<EMSA_X931>(std::move(hash));
114 }
115 }
116 }
117#endif
118
119#if defined(BOTAN_HAS_EMSA_RAW)
120 if(req.algo_name() == "Raw") {
121 if(req.arg_count() == 0) {
122 return std::make_unique<EMSA_Raw>();
123 } else {
124 auto hash = HashFunction::create(req.arg(0));
125 if(hash) {
126 return std::make_unique<EMSA_Raw>(hash->output_length());
127 }
128 }
129 }
130#endif
131
132 return nullptr;
133}
Botan::HashFunction::create
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:107

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 ~EMSA().

◆ create_or_throw()

std::unique_ptr< EMSA > Botan::EMSA::create_or_throw ( std::string_view algo_spec)
staticinherited

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

Parameters
algo_specthe name of the EMSA to create
Returns
pointer to newly allocated object of that type, or throws

Definition at line 135 of file emsa.cpp.

135 {
136 auto emsa = EMSA::create(algo_spec);
137 if(emsa) {
138 return emsa;
139 }
140 throw Algorithm_Not_Found(algo_spec);
141}
Botan::EMSA::create
static std::unique_ptr< EMSA > create(std::string_view algo_spec)
Definition emsa.cpp:35

References create().

Referenced by ~EMSA().

◆ encoding_of()

std::vector< uint8_t > Botan::EMSA_PKCS1v15::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
rnga random number generator
Returns
encoded signature

Implements Botan::EMSA.

Definition at line 51 of file emsa_pkcs1.cpp.

53 {
54 if(msg.size() != m_hash->output_length()) {
55 throw Encoding_Error("EMSA_PKCS1v15::encoding_of: Bad input length");
56 }
57
58 return pkcs1v15_sig_encoding(msg, output_bits, m_hash_id);
59}

◆ hash_function()

std::string Botan::EMSA_PKCS1v15::hash_function ( ) const
inlineoverridevirtual

Return the hash function being used by this padding scheme

Implements Botan::EMSA.

Definition at line 38 of file emsa_pkcs1.h.

38{ return m_hash->name(); }

◆ name()

std::string Botan::EMSA_PKCS1v15::name ( ) const
overridevirtual
Returns
the SCAN name of the encoding/padding scheme

Implements Botan::EMSA.

Definition at line 78 of file emsa_pkcs1.cpp.

78 {
79 return "PKCS1v15(" + m_hash->name() + ")";
80}

◆ raw_data()

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

Implements Botan::EMSA.

Definition at line 47 of file emsa_pkcs1.cpp.

47 {
48 return m_hash->final_stdvec();
49}

◆ update()

void Botan::EMSA_PKCS1v15::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::EMSA.

Definition at line 43 of file emsa_pkcs1.cpp.

43 {
44 m_hash->update(input, length);
45}

◆ verify()

bool Botan::EMSA_PKCS1v15::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_hashthe 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::EMSA.

Definition at line 61 of file emsa_pkcs1.cpp.

61 {
62 if(raw.size() != m_hash->output_length()) {
63 return false;
64 }
65
66 try {
67 const auto pkcs1 = pkcs1v15_sig_encoding(raw, key_bits, m_hash_id);
68 return constant_time_compare(coded, pkcs1);
69 } catch(...) {
70 return false;
71 }
72}
Botan::constant_time_compare
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:
Generated by doxygen 1.13.2