Botan 3.13.0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
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 (std::string_view algo_spec)
static std::unique_ptr< SignaturePaddingScheme > create_or_throw (std::string_view algo_spec)

Detailed Description

RSA Signature Padding Scheme

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

Definition at line 25 of file sig_padding.h.

Constructor & Destructor Documentation

◆ ~SignaturePaddingScheme()

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

References create(), and create_or_throw().

Member Function Documentation

◆ create()

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

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

Parameters
algo_specthe 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.

35 {
36 const 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<PKCS1v15_Raw_SignaturePaddingScheme>(req.arg(1));
44 } else if(req.arg_count() == 1) {
45 if(req.arg(0) == "Raw") {
46 return std::make_unique<PKCS1v15_Raw_SignaturePaddingScheme>();
47 } else {
48 if(auto hash = HashFunction::create(req.arg(0))) {
49 return std::make_unique<PKCS1v15_SignaturePaddingScheme>(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<PSS_Raw>(std::move(hash), salt_size);
64 } else {
65 return std::make_unique<PSS_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 const std::string trailer = req.arg(1, "exp");
91 if(trailer != "imp" && trailer != "exp") {
92 return nullptr;
93 }
94 if(auto hash = HashFunction::create(req.arg(0))) {
95 const size_t salt_size = req.arg_as_integer(2, hash->output_length());
96 return std::make_unique<ISO_9796_DS2>(std::move(hash), trailer == "imp", salt_size);
97 }
98 }
99 }
100 //ISO-9796-2 DS 3 is deterministic and DS2 without a salt
101 if(req.algo_name() == "ISO_9796_DS3") {
102 if(req.arg_count_between(1, 2)) {
103 const std::string trailer = req.arg(1, "exp");
104 if(trailer != "imp" && trailer != "exp") {
105 return nullptr;
106 }
107 if(auto hash = HashFunction::create(req.arg(0))) {
108 return std::make_unique<ISO_9796_DS3>(std::move(hash), trailer == "imp");
109 }
110 }
111 }
112#endif
113
114#if defined(BOTAN_HAS_X931_SIGNATURE_PADDING)
115 // TODO(Botan4) Remove all but "X9.31"
116 if(req.algo_name() == "EMSA_X931" || req.algo_name() == "EMSA2" || req.algo_name() == "X9.31") {
117 if(req.arg_count() == 1) {
118 if(auto hash = HashFunction::create(req.arg(0))) {
119 return std::make_unique<X931_SignaturePadding>(std::move(hash));
120 }
121 }
122 }
123#endif
124
125#if defined(BOTAN_HAS_RAW_SIGNATURE_PADDING)
126 if(req.algo_name() == "Raw") {
127 if(req.arg_count() == 0) {
128 return std::make_unique<SignRawBytes>();
129 } else {
130 auto hash = HashFunction::create(req.arg(0));
131 if(hash) {
132 return std::make_unique<SignRawBytes>(hash->output_length());
133 }
134 }
135 }
136#endif
137
138 return nullptr;
139}
Botan::HashFunction::create
static std::unique_ptr< HashFunction > create(std::string_view algo_spec, std::string_view provider="")
Definition hash.cpp:111

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

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

Parameters
algo_specthe 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.

141 {
142 if(auto padding = SignaturePaddingScheme::create(algo_spec)) {
143 return padding;
144 } else {
145 throw Algorithm_Not_Found(algo_spec);
146 }
147}
Botan::SignaturePaddingScheme::create
static std::unique_ptr< SignaturePaddingScheme > create(std::string_view algo_spec)
Definition sig_padding.cpp:35

References create().

Referenced by ~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

Return the hash function being used by this padding scheme

Implemented in Botan::ISO_9796_DS2, Botan::ISO_9796_DS3, Botan::PKCS1v15_Raw_SignaturePaddingScheme, Botan::PKCS1v15_SignaturePaddingScheme, Botan::PSS_Raw, Botan::PSSR, Botan::SignRawBytes, and Botan::X931_SignaturePadding.

◆ name()

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

Implemented in Botan::ISO_9796_DS2, Botan::ISO_9796_DS3, Botan::PKCS1v15_Raw_SignaturePaddingScheme, Botan::PKCS1v15_SignaturePaddingScheme, Botan::PSS_Raw, Botan::PSSR, Botan::SignRawBytes, and Botan::X931_SignaturePadding.

◆ raw_data()

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

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

◆ 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:
Generated by doxygen 1.16.1