Botan 3.4.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::EMSA Class Referenceabstract

#include <emsa.h>

Inheritance diagram for Botan::EMSA:
Botan::EMSA_PKCS1v15 Botan::EMSA_PKCS1v15_Raw Botan::EMSA_Raw Botan::EMSA_X931 Botan::ISO_9796_DS2 Botan::ISO_9796_DS3 Botan::PSSR Botan::PSSR_Raw

Public Member Functions

virtual std::vector< uint8_t > encoding_of (const std::vector< 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 (const std::vector< uint8_t > &coded, const std::vector< uint8_t > &raw, size_t key_bits)=0
 
virtual ~EMSA ()=default
 

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

EMSA, from IEEE 1363s Encoding Method for Signatures, Appendix

Any way of encoding/padding signatures

Definition at line 23 of file emsa.h.

Constructor & Destructor Documentation

◆ ~EMSA()

virtual Botan::EMSA::~EMSA ( )
virtualdefault

Member Function Documentation

◆ create()

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

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

◆ create_or_throw()

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

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 131 of file emsa.cpp.

131 {
132 auto emsa = EMSA::create(algo_spec);
133 if(emsa) {
134 return emsa;
135 }
136 throw Algorithm_Not_Found(algo_spec);
137}
Botan::EMSA::create
static std::unique_ptr< EMSA > create(std::string_view algo_spec)
Definition emsa.cpp:35

References create().

◆ encoding_of()

virtual std::vector< uint8_t > Botan::EMSA::encoding_of ( const std::vector< 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
rnga random number generator
Returns
encoded signature

Implemented in Botan::EMSA_PKCS1v15, and Botan::EMSA_PKCS1v15_Raw.

◆ hash_function()

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

Return the hash function being used by this padding scheme

Implemented in Botan::EMSA_PKCS1v15, Botan::EMSA_PKCS1v15_Raw, Botan::PSSR, Botan::PSSR_Raw, Botan::EMSA_Raw, Botan::EMSA_X931, Botan::ISO_9796_DS2, and Botan::ISO_9796_DS3.

◆ name()

virtual std::string Botan::EMSA::name ( ) const
pure virtual
Returns
the SCAN name of the encoding/padding scheme

Implemented in Botan::EMSA_PKCS1v15, Botan::EMSA_PKCS1v15_Raw, Botan::PSSR, Botan::PSSR_Raw, Botan::EMSA_Raw, Botan::EMSA_X931, Botan::ISO_9796_DS2, and Botan::ISO_9796_DS3.

◆ raw_data()

virtual std::vector< uint8_t > Botan::EMSA::raw_data ( )
pure virtual
Returns
raw hash

Implemented in Botan::EMSA_PKCS1v15, and Botan::EMSA_PKCS1v15_Raw.

◆ update()

virtual void Botan::EMSA::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::EMSA_PKCS1v15, and Botan::EMSA_PKCS1v15_Raw.

◆ verify()

virtual bool Botan::EMSA::verify ( const std::vector< uint8_t > & coded,
const std::vector< uint8_t > & raw,
size_t key_bits )
pure virtual

Verify the encoding

Parameters
codedthe received (coded) message representative
rawthe 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::EMSA_PKCS1v15, and Botan::EMSA_PKCS1v15_Raw.

The documentation for this class was generated from the following files:
Generated by doxygen 1.10.0