Botan 3.4.0
Crypto and TLS for C&
Public Member Functions | List of all members
Botan::PK_Signer Class Referencefinal

#include <pubkey.h>

Public Member Functions

AlgorithmIdentifier algorithm_identifier () const
 
std::string hash_function () const
 
PK_Signeroperator= (const PK_Signer &)=delete
 
PK_Signeroperator= (PK_Signer &&) noexcept
 
 PK_Signer (const PK_Signer &)=delete
 
 PK_Signer (const Private_Key &key, RandomNumberGenerator &rng, std::string_view padding, Signature_Format format=Signature_Format::Standard, std::string_view provider="")
 
 PK_Signer (PK_Signer &&) noexcept
 
void set_output_format (Signature_Format format)
 
std::vector< uint8_t > sign_message (const uint8_t in[], size_t length, RandomNumberGenerator &rng)
 
std::vector< uint8_t > sign_message (std::span< const uint8_t > in, RandomNumberGenerator &rng)
 
std::vector< uint8_t > signature (RandomNumberGenerator &rng)
 
size_t signature_length () const
 
void update (const uint8_t in[], size_t length)
 
void update (std::span< const uint8_t > in)
 
void update (std::string_view in)
 
void update (uint8_t in)
 
 ~PK_Signer ()
 

Detailed Description

Public Key Signer. Use the sign_message() functions for small messages. Use multiple calls update() to process large messages and generate the signature by finally calling signature().

Definition at line 155 of file pubkey.h.

Constructor & Destructor Documentation

◆ PK_Signer() [1/3]

Botan::PK_Signer::PK_Signer ( const Private_Key & key,
RandomNumberGenerator & rng,
std::string_view padding,
Signature_Format format = Signature_Format::Standard,
std::string_view provider = "" )

Construct a PK Signer.

Parameters
keythe key to use inside this signer
rngthe random generator to use
paddingthe padding/hash to use, eg "EMSA_PKCS1(SHA-256)"
formatthe signature format to use
providerthe provider to use

Definition at line 246 of file pubkey.cpp.

250 {
251 m_op = key.create_signature_op(rng, emsa, provider);
252 if(!m_op) {
253 throw Invalid_Argument(fmt("Key type {} does not support signature generation", key.algo_name()));
254 }
255 m_sig_format = format;
256 m_parts = key.message_parts();
257 m_part_size = key.message_part_size();
258 check_der_format_supported(format, m_parts);
259}
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References Botan::Asymmetric_Key::algo_name(), Botan::Private_Key::create_signature_op(), Botan::fmt(), Botan::Public_Key::message_part_size(), and Botan::Public_Key::message_parts().

◆ ~PK_Signer()

Botan::PK_Signer::~PK_Signer ( )
default

◆ PK_Signer() [2/3]

Botan::PK_Signer::PK_Signer ( const PK_Signer & )
delete

◆ PK_Signer() [3/3]

Botan::PK_Signer::PK_Signer ( PK_Signer && )
defaultnoexcept

Member Function Documentation

◆ algorithm_identifier()

AlgorithmIdentifier Botan::PK_Signer::algorithm_identifier ( ) const

Return an AlgorithmIdentifier appropriate for identifying the signature method being generated by this PK_Signer. Throws an exception if this is not available for the current signature scheme.

Definition at line 261 of file pubkey.cpp.

261 {
262 return m_op->algorithm_identifier();
263}

◆ hash_function()

std::string Botan::PK_Signer::hash_function ( ) const

Return the hash function which is being used to create signatures. This should never return an empty string however it may return a string which does not map directly to a hash function, in particular if "Raw" (unhashed) encoding is being used.

Definition at line 265 of file pubkey.cpp.

265 {
266 return m_op->hash_function();
267}

◆ operator=() [1/2]

PK_Signer & Botan::PK_Signer::operator= ( const PK_Signer & )
delete

◆ operator=() [2/2]

PK_Signer & Botan::PK_Signer::operator= ( PK_Signer && )
defaultnoexcept

◆ set_output_format()

void Botan::PK_Signer::set_output_format ( Signature_Format format)
inline

Set the output format of the signature.

Parameters
formatthe signature format to use

Definition at line 238 of file pubkey.h.

238{ m_sig_format = format; }

◆ sign_message() [1/2]

std::vector< uint8_t > Botan::PK_Signer::sign_message ( const uint8_t in[],
size_t length,
RandomNumberGenerator & rng )
inline

Sign a message all in one go

Parameters
inthe message to sign as a byte array
lengththe length of the above byte array
rngthe rng to use
Returns
signature

Definition at line 186 of file pubkey.h.

186 {
187 this->update(in, length);
188 return this->signature(rng);
189 }
std::vector< uint8_t > signature(RandomNumberGenerator &rng)
Definition pubkey.cpp:313
int(* update)(CTX *, const void *, CC_LONG len)

References update.

Referenced by Botan::X509_Object::make_signed(), Botan::KeyPair::signature_consistency_check(), and Botan::TLS::Callbacks::tls_sign_message().

◆ sign_message() [2/2]

std::vector< uint8_t > Botan::PK_Signer::sign_message ( std::span< const uint8_t > in,
RandomNumberGenerator & rng )
inline

Sign a message.

Parameters
inthe message to sign
rngthe rng to use
Returns
signature

Definition at line 197 of file pubkey.h.

197 {
198 return sign_message(in.data(), in.size(), rng);
199 }
std::vector< uint8_t > sign_message(const uint8_t in[], size_t length, RandomNumberGenerator &rng)
Definition pubkey.h:186

References Botan::sign_message().

◆ signature()

std::vector< uint8_t > Botan::PK_Signer::signature ( RandomNumberGenerator & rng)

Get the signature of the so far processed message (provided by the calls to update()).

Parameters
rngthe rng to use
Returns
signature of the total message

Definition at line 313 of file pubkey.cpp.

313 {
314 std::vector<uint8_t> sig = unlock(m_op->sign(rng));
315
316 if(m_sig_format == Signature_Format::Standard) {
317 return sig;
318 } else if(m_sig_format == Signature_Format::DerSequence) {
319 return der_encode_signature(sig, m_parts, m_part_size);
320 } else {
321 throw Internal_Error("PK_Signer: Invalid signature format enum");
322 }
323}
std::vector< T > unlock(const secure_vector< T > &in)
Definition secmem.h:75

References Botan::DerSequence, Botan::Standard, and Botan::unlock().

◆ signature_length()

size_t Botan::PK_Signer::signature_length ( ) const

Return an upper bound on the length of the signatures this PK_Signer will produce

Definition at line 301 of file pubkey.cpp.

301 {
302 if(m_sig_format == Signature_Format::Standard) {
303 return m_op->signature_length();
304 } else if(m_sig_format == Signature_Format::DerSequence) {
305 // This is a large over-estimate but its easier than computing
306 // the exact value
307 return m_op->signature_length() + (8 + 4 * m_parts);
308 } else {
309 throw Internal_Error("PK_Signer: Invalid signature format enum");
310 }
311}

References Botan::DerSequence, and Botan::Standard.

◆ update() [1/4]

void Botan::PK_Signer::update ( const uint8_t in[],
size_t length )

Add a message part.

Parameters
inthe message part to add as a byte array
lengththe length of the above byte array

Definition at line 278 of file pubkey.cpp.

278 {
279 m_op->update(in, length);
280}

◆ update() [2/4]

void Botan::PK_Signer::update ( std::span< const uint8_t > in)
inline

Add a message part.

Parameters
inthe message part to add

Definition at line 218 of file pubkey.h.

218{ update(in.data(), in.size()); }

References update().

Referenced by update().

◆ update() [3/4]

void Botan::PK_Signer::update ( std::string_view in)

Add a message part.

Parameters
inthe message part to add

Definition at line 274 of file pubkey.cpp.

274 {
275 this->update(cast_char_ptr_to_uint8(in.data()), in.size());
276}
const uint8_t * cast_char_ptr_to_uint8(const char *s)
Definition mem_ops.h:275

References Botan::cast_char_ptr_to_uint8(), and update.

◆ update() [4/4]

void Botan::PK_Signer::update ( uint8_t in)
inline

Add a message part (single byte).

Parameters
inthe byte to add

Definition at line 205 of file pubkey.h.

205{ update(&in, 1); }

References update().

Referenced by update().


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