Botan 1.10.17
Botan::PK_Signer_Filter Class Reference

#include <pk_filts.h>

Inheritance diagram for Botan::PK_Signer_Filter:
Botan::Filter

Public Member Functions

virtual bool attachable ()
void end_msg ()
std::string name () const
 PK_Signer_Filter (PK_Signer *s, RandomNumberGenerator &rng_ref)
virtual void start_msg ()
void write (const byte[], size_t)
 ~PK_Signer_Filter ()

Protected Member Functions

void send (byte in)
void send (const byte in[], size_t length)
void send (const MemoryRegion< byte > &in)
void send (const MemoryRegion< byte > &in, size_t length)

Detailed Description

PK_Signer Filter

Definition at line 56 of file pk_filts.h.

Constructor & Destructor Documentation

◆ PK_Signer_Filter()

Botan::PK_Signer_Filter::PK_Signer_Filter ( PK_Signer * s,
RandomNumberGenerator & rng_ref )
inline

Definition at line 64 of file pk_filts.h.

65 :
66 signer(s), rng(rng_ref) {}

◆ ~PK_Signer_Filter()

Botan::PK_Signer_Filter::~PK_Signer_Filter ( )
inline

Definition at line 68 of file pk_filts.h.

68{ delete signer; }

Member Function Documentation

◆ attachable()

virtual bool Botan::Filter::attachable ( )
inlinevirtualinherited

Check whether this filter is an attachable filter.

Returns
true if this filter is attachable, false otherwise

Reimplemented in Botan::DataSink, and Botan::SecureQueue.

Definition at line 50 of file filter.h.

50{ return true; }

◆ end_msg()

void Botan::PK_Signer_Filter::end_msg ( )
virtual

Notify that the current message is finished; flush buffers and do end-of-message processing (if any).

Reimplemented from Botan::Filter.

Definition at line 57 of file pk_filts.cpp.

58 {
59 send(signer->signature(rng));
60 }
void send(const byte in[], size_t length)
Definition filter.cpp:28

References Botan::Filter::send().

◆ name()

std::string Botan::PK_Signer_Filter::name ( ) const
inlinevirtual
Returns
descriptive name for this filter

Implements Botan::Filter.

Definition at line 59 of file pk_filts.h.

59{ return "PK Signer"; }

◆ send() [1/4]

void Botan::Filter::send ( byte in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 63 of file filter.h.

63{ send(&in, 1); }

References send().

Referenced by send().

◆ send() [2/4]

void Botan::Filter::send ( const byte in[],
size_t length )
protectedinherited

◆ send() [3/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in)
inlineprotectedinherited
Parameters
insome input for the filter

Definition at line 68 of file filter.h.

68{ send(&in[0], in.size()); }

References send(), and Botan::MemoryRegion< T >::size().

Referenced by send().

◆ send() [4/4]

void Botan::Filter::send ( const MemoryRegion< byte > & in,
size_t length )
inlineprotectedinherited
Parameters
insome input for the filter
lengththe number of bytes of in to send

Definition at line 74 of file filter.h.

75 {
76 send(&in[0], length);
77 }

References send().

◆ start_msg()

virtual void Botan::Filter::start_msg ( )
inlinevirtualinherited

Start a new message. Must be closed by end_msg() before another message can be started.

Reimplemented in Botan::Bzip_Compression, Botan::Bzip_Decompression, Botan::EAX_Base, Botan::PBE_PKCS5v15, Botan::PBE_PKCS5v20, Botan::Zlib_Compression, and Botan::Zlib_Decompression.

Definition at line 38 of file filter.h.

38{}

◆ write()

void Botan::PK_Signer_Filter::write ( const byte input[],
size_t length )
virtual

Write a portion of a message to this filter.

Parameters
inputthe input as a byte array
lengththe length of the byte array input

Implements Botan::Filter.

Definition at line 49 of file pk_filts.cpp.

50 {
51 signer->update(input, length);
52 }

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