Botan
2.1.0
Crypto and TLS for C++11
|
#include <pipe.h>
Classes | |
struct | Invalid_Message_Number |
Public Types | |
typedef size_t | message_id |
Public Member Functions | |
void | append (Filter *filt) |
bool | check_available (size_t n) override |
bool | check_available_msg (size_t n, message_id msg) |
size_t | default_msg () const |
size_t | discard_next (size_t N) |
void | end_msg () |
bool | end_of_data () const override |
size_t | get_bytes_read () const override |
size_t | get_bytes_read (message_id msg) const |
virtual std::string | id () const |
message_id | message_count () const |
Pipe & | operator= (const Pipe &)=delete |
size_t | peek (uint8_t output[], size_t length, size_t offset) const override BOTAN_WARN_UNUSED_RESULT |
size_t | peek (uint8_t output[], size_t length, size_t offset, message_id msg) const BOTAN_WARN_UNUSED_RESULT |
size_t | peek (uint8_t &output, size_t offset, message_id msg=DEFAULT_MESSAGE) const BOTAN_WARN_UNUSED_RESULT |
size_t | peek_byte (uint8_t &out) const |
Pipe (Filter *=nullptr, Filter *=nullptr, Filter *=nullptr, Filter *=nullptr) | |
Pipe (std::initializer_list< Filter * > filters) | |
Pipe (const Pipe &)=delete | |
void | pop () |
void | prepend (Filter *filt) |
void | process_msg (const uint8_t in[], size_t length) |
void | process_msg (const secure_vector< uint8_t > &in) |
void | process_msg (const std::vector< uint8_t > &in) |
void | process_msg (const std::string &in) |
void | process_msg (DataSource &in) |
size_t | read (uint8_t output[], size_t length) override BOTAN_WARN_UNUSED_RESULT |
size_t | read (uint8_t output[], size_t length, message_id msg) BOTAN_WARN_UNUSED_RESULT |
size_t | read (uint8_t &output, message_id msg=DEFAULT_MESSAGE) BOTAN_WARN_UNUSED_RESULT |
secure_vector< uint8_t > | read_all (message_id msg=DEFAULT_MESSAGE) BOTAN_WARN_UNUSED_RESULT |
std::string | read_all_as_string (message_id=DEFAULT_MESSAGE) BOTAN_WARN_UNUSED_RESULT |
size_t | read_byte (uint8_t &out) |
size_t | remaining (message_id msg=DEFAULT_MESSAGE) const BOTAN_WARN_UNUSED_RESULT |
void | reset () |
void | set_default_msg (message_id msg) |
void | start_msg () |
void | write (const uint8_t in[], size_t length) |
void | write (const secure_vector< uint8_t > &in) |
void | write (const std::vector< uint8_t > &in) |
void | write (const std::string &in) |
void | write (DataSource &in) |
void | write (uint8_t in) |
~Pipe () | |
Static Public Attributes | |
static const message_id | DEFAULT_MESSAGE |
static const message_id | LAST_MESSAGE |
This class represents pipe objects. A set of filters can be placed into a pipe, and information flows through the pipe until it reaches the end, where the output is collected for retrieval. If you're familiar with the Unix shell environment, this design will sound quite familiar.
typedef size_t Botan::Pipe::message_id |
Botan::Pipe::Pipe | ( | Filter * | f1 = nullptr , |
Filter * | f2 = nullptr , |
||
Filter * | f3 = nullptr , |
||
Filter * | f4 = nullptr |
||
) |
|
explicit |
|
delete |
Botan::Pipe::~Pipe | ( | ) |
void Botan::Pipe::append | ( | Filter * | filt | ) |
|
overridevirtual |
Implements Botan::DataSource.
Definition at line 170 of file pipe_rw.cpp.
References default_msg(), and remaining().
bool Botan::Pipe::check_available_msg | ( | size_t | n, |
message_id | msg | ||
) |
Definition at line 175 of file pipe_rw.cpp.
References remaining().
|
inline |
Definition at line 236 of file pipe.h.
Referenced by check_available(), get_bytes_read(), read_all(), and read_all_as_string().
|
inherited |
Discard the next N bytes of the data
N | the number of bytes to discard |
Definition at line 38 of file data_src.cpp.
References Botan::CT::min(), and Botan::DataSource::read().
void Botan::Pipe::end_msg | ( | ) |
End the current message.
Definition at line 172 of file pipe.cpp.
References Botan::Output_Buffers::retire().
Referenced by process_msg().
|
overridevirtual |
Test whether this pipe has any data that can be read from.
Implements Botan::DataSource.
Definition at line 99 of file pipe.cpp.
References remaining().
|
overridevirtual |
Implements Botan::DataSource.
Definition at line 160 of file pipe_rw.cpp.
References default_msg(), and Botan::Output_Buffers::get_bytes_read().
size_t Botan::Pipe::get_bytes_read | ( | message_id | msg | ) | const |
Definition at line 165 of file pipe_rw.cpp.
References Botan::Output_Buffers::get_bytes_read().
|
inlinevirtualinherited |
return the id of this data source
Reimplemented in Botan::DataSource_Stream.
Definition at line 59 of file data_src.h.
Pipe::message_id Botan::Pipe::message_count | ( | ) | const |
Get the number of messages the are in this pipe.
Definition at line 288 of file pipe.cpp.
References Botan::Output_Buffers::message_count().
Referenced by set_default_msg().
|
overridevirtual |
Read from the default message but do not modify the internal offset. Consecutive calls to peek() will return portions of the message starting at the same position.
output | the byte array to write the peeked message part to |
length | the length of the byte array output |
offset | the offset from the current position in message |
Implements Botan::DataSource.
Definition at line 147 of file pipe_rw.cpp.
References DEFAULT_MESSAGE.
Referenced by peek().
size_t Botan::Pipe::peek | ( | uint8_t | output[], |
size_t | length, | ||
size_t | offset, | ||
message_id | msg | ||
) | const |
Read from the specified message but do not modify the internal offset. Consecutive calls to peek() will return portions of the message starting at the same position.
output | the byte array to write the peeked message part to |
length | the length of the byte array output |
offset | the offset from the current position in message |
msg | the number identifying the message to peek from |
Definition at line 138 of file pipe_rw.cpp.
References Botan::Output_Buffers::peek().
size_t Botan::Pipe::peek | ( | uint8_t & | output, |
size_t | offset, | ||
message_id | msg = DEFAULT_MESSAGE |
||
) | const |
Read a single byte from the specified message but do not modify the internal offset. Consecutive calls to peek() will return portions of the message starting at the same position.
output | the byte to write the peeked message byte to |
offset | the offset from the current position in message |
msg | the number identifying the message to peek from |
Definition at line 155 of file pipe_rw.cpp.
References peek().
|
inherited |
Peek at one byte.
out | an output byte |
Definition at line 30 of file data_src.cpp.
References Botan::DataSource::peek().
Referenced by Botan::ASN1::maybe_BER().
void Botan::Pipe::pop | ( | ) |
void Botan::Pipe::prepend | ( | Filter * | filt | ) |
void Botan::Pipe::process_msg | ( | const uint8_t | in[], |
size_t | length | ||
) |
Perform start_msg(), write() and end_msg() sequentially.
in | the byte array containing the data to write |
length | the length of the byte array to write |
Definition at line 117 of file pipe.cpp.
References end_msg(), start_msg(), and write().
Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::CryptoBox::decrypt(), Botan::CryptoBox::encrypt(), and process_msg().
void Botan::Pipe::process_msg | ( | const secure_vector< uint8_t > & | in | ) |
Perform start_msg(), write() and end_msg() sequentially.
in | the secure_vector containing the data to write |
Definition at line 127 of file pipe.cpp.
References process_msg().
void Botan::Pipe::process_msg | ( | const std::vector< uint8_t > & | in | ) |
Perform start_msg(), write() and end_msg() sequentially.
in | the secure_vector containing the data to write |
Definition at line 132 of file pipe.cpp.
References process_msg().
void Botan::Pipe::process_msg | ( | const std::string & | in | ) |
Perform start_msg(), write() and end_msg() sequentially.
in | the string containing the data to write |
Definition at line 140 of file pipe.cpp.
References process_msg().
void Botan::Pipe::process_msg | ( | DataSource & | in | ) |
Perform start_msg(), write() and end_msg() sequentially.
in | the DataSource providing the data to write |
Definition at line 148 of file pipe.cpp.
References end_msg(), start_msg(), and write().
|
overridevirtual |
Read the default message from the pipe. Moves the internal offset so that every call to read will return a new portion of the message.
output | the byte array to write the read bytes to |
length | the length of the byte array output |
Implements Botan::DataSource.
Definition at line 81 of file pipe_rw.cpp.
References DEFAULT_MESSAGE.
Referenced by Botan::aont_package(), Botan::aont_unpackage(), Botan::CryptoBox::decrypt(), Botan::CryptoBox::encrypt(), Botan::operator<<(), read(), read_all(), and read_all_as_string().
size_t Botan::Pipe::read | ( | uint8_t | output[], |
size_t | length, | ||
message_id | msg | ||
) |
Read a specified message from the pipe. Moves the internal offset so that every call to read will return a new portion of the message.
output | the byte array to write the read bytes to |
length | the length of the byte array output |
msg | the number identifying the message to read from |
Definition at line 73 of file pipe_rw.cpp.
References Botan::Output_Buffers::read().
size_t Botan::Pipe::read | ( | uint8_t & | output, |
message_id | msg = DEFAULT_MESSAGE |
||
) |
Read a single byte from the pipe. Moves the internal offset so that every call to read will return a new portion of the message.
output | the byte to write the result to |
msg | the message to read from |
Definition at line 89 of file pipe_rw.cpp.
References read().
secure_vector< uint8_t > Botan::Pipe::read_all | ( | message_id | msg = DEFAULT_MESSAGE | ) |
Read the full contents of the pipe.
msg | the number identifying the message to read from |
Definition at line 97 of file pipe_rw.cpp.
References DEFAULT_MESSAGE, default_msg(), read(), and remaining().
std::string Botan::Pipe::read_all_as_string | ( | message_id | msg = DEFAULT_MESSAGE | ) |
Read the full contents of the pipe.
msg | the number identifying the message to read from |
Definition at line 109 of file pipe_rw.cpp.
References DEFAULT_MESSAGE, default_msg(), read(), and remaining().
Referenced by Botan::CryptoBox::decrypt().
|
inherited |
Read one byte.
out | the byte to read to |
Definition at line 22 of file data_src.cpp.
References Botan::DataSource::read().
Referenced by Botan::PEM_Code::decode(), Botan::BER_Decoder::discard_remaining(), Botan::ASN1::maybe_BER(), and Botan::BER_Decoder::raw_bytes().
size_t Botan::Pipe::remaining | ( | message_id | msg = DEFAULT_MESSAGE | ) | const |
Find out how many bytes are ready to read.
msg | the number identifying the message for which the information is desired |
Definition at line 130 of file pipe_rw.cpp.
References Botan::Output_Buffers::remaining().
Referenced by Botan::aont_package(), Botan::aont_unpackage(), check_available(), check_available_msg(), Botan::CryptoBox::encrypt(), end_of_data(), Botan::operator<<(), read_all(), and read_all_as_string().
void Botan::Pipe::reset | ( | ) |
void Botan::Pipe::set_default_msg | ( | message_id | msg | ) |
Set the default message
msg | the number identifying the message which is going to be the new default message |
Definition at line 107 of file pipe.cpp.
References message_count().
void Botan::Pipe::start_msg | ( | ) |
Start a new message in the pipe. A potential other message in this pipe must be closed with end_msg() before this function may be called.
Definition at line 158 of file pipe.cpp.
Referenced by process_msg().
void Botan::Pipe::write | ( | const uint8_t | in[], |
size_t | length | ||
) |
Write input to the pipe, i.e. to its first filter.
in | the byte array to write |
length | the length of the byte array in |
Definition at line 34 of file pipe_rw.cpp.
References Botan::Filter::write().
Referenced by Botan::operator>>(), process_msg(), and write().
|
inline |
|
inline |
void Botan::Pipe::write | ( | const std::string & | in | ) |
Write input to the pipe, i.e. to its first filter.
in | the string containing the data to write |
Definition at line 44 of file pipe_rw.cpp.
References write().
void Botan::Pipe::write | ( | DataSource & | in | ) |
Write input to the pipe, i.e. to its first filter.
in | the DataSource to read the data from |
Definition at line 60 of file pipe_rw.cpp.
References Botan::DataSource::end_of_data(), Botan::DataSource::read(), and write().
void Botan::Pipe::write | ( | uint8_t | in | ) |
Write input to the pipe, i.e. to its first filter.
in | a single byte to be written |
Definition at line 52 of file pipe_rw.cpp.
References write().
|
static |
A meta-id for the default message (set with set_default_msg)
Definition at line 59 of file pipe.h.
Referenced by peek(), read(), read_all(), and read_all_as_string().
|
static |
A meta-id for whatever the last message is