Botan::OctetString Class Reference

#include <symkey.h>

Public Member Functions
const uint8_t *	begin () const
secure_vector< uint8_t >	bits_of () const
bool	empty () const
const uint8_t *	end () const
size_t	length () const
	OctetString (const uint8_t in[], size_t len)
	OctetString (RandomNumberGenerator &rng, size_t len)
	OctetString (secure_vector< uint8_t > in)
	OctetString (std::span< const uint8_t > in)
	OctetString (std::string_view str="")
OctetString &	operator^= (const OctetString &other)
void	set_odd_parity ()
size_t	size () const
std::string	to_string () const

Detailed Description

Octet String

Definition at line 22 of file symkey.h.

Constructor & Destructor Documentation

OctetString() [1/5]

Botan::OctetString::OctetString ( std::string_view str = "" )

explicit

Create a new OctetString

Parameters

str	is a hex encoded string

Definition at line 27 of file symkey.cpp.

                                                  {
   if(!hex_string.empty()) {
      m_data.resize(1 + hex_string.length() / 2);
      m_data.resize(hex_decode(m_data.data(), hex_string));
   }
}

References Botan::hex_decode().

Referenced by OctetString(), and operator^=().

OctetString() [2/5]

Botan::OctetString::OctetString	(	RandomNumberGenerator &	rng,
		size_t	len )

Create a new random OctetString

Parameters

Random Number Generators	is a random number generator
len	is the desired length in bytes

Definition at line 20 of file symkey.cpp.

                                                               {
   rng.random_vec(m_data, len);
}

References Botan::RandomNumberGenerator::random_vec().

OctetString() [3/5]

Botan::OctetString::OctetString	(	const uint8_t	in[],
		size_t	len )

Create a new OctetString

Parameters

in	is an array
len	is the length of in in bytes

Definition at line 37 of file symkey.cpp.

                                                     {
   m_data.assign(in, in + n);
}

OctetString() [4/5]

Botan::OctetString::OctetString ( std::span< const uint8_t > in )

inlineexplicit

Create a new OctetString

Parameters

in	a bytestring

Definition at line 106 of file symkey.h.

: m_data(in.begin(), in.end()) {}

References begin(), end(), and OctetString().

OctetString() [5/5]

Botan::OctetString::OctetString ( secure_vector< uint8_t > in )

inlineexplicit

Create a new OctetString

Parameters

in	a bytestring

Definition at line 112 of file symkey.h.

: m_data(std::move(in)) {}

Member Function Documentation

begin()

const uint8_t * Botan::OctetString::begin ( ) const

inline

Return a pointer to the first byte

Returns

start of this string

Definition at line 52 of file symkey.h.

{ return m_data.data(); }

Referenced by Botan::ECIES_KA_Operation::derive_secret(), end(), OctetString(), Botan::operator^(), operator^=(), and Botan::SymmetricAlgorithm::set_key().

bits_of()

secure_vector< uint8_t > Botan::OctetString::bits_of ( ) const

inline

Return the contents of this octet string

Returns

this object as a secure_vector<uint8_t>

Definition at line 46 of file symkey.h.

{ return m_data; }

Referenced by Botan::check_passhash9(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::generate_passhash9(), Botan::operator+(), Botan::operator==(), Botan::Cipher_Mode_Filter::set_iv(), and Botan::TLS::Callbacks::tls_ephemeral_key_agreement().

empty()

bool Botan::OctetString::empty ( ) const

inline

Test whether this octet string is empty

Returns

true if this string holds no bytes

Definition at line 40 of file symkey.h.

{ return m_data.empty(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::get_cipher(), and Botan::Keyed_Filter::set_iv().

end()

const uint8_t * Botan::OctetString::end ( ) const

inline

Return a pointer one past the last byte

Returns

end of this string

Definition at line 58 of file symkey.h.

{ return begin() + m_data.size(); }

References begin().

Referenced by Botan::ECIES_KA_Operation::derive_secret(), and OctetString().

length()

size_t Botan::OctetString::length ( ) const

inline

Return the length of this octet string

Returns

size of this octet string in bytes

Definition at line 28 of file symkey.h.

{ return m_data.size(); }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::operator^(), operator^=(), Botan::Keyed_Filter::set_iv(), and Botan::SymmetricAlgorithm::set_key().

operator^=()

OctetString & Botan::OctetString::operator^=

(

const OctetString &

other

)

XOR the contents of another octet string into this one

Parameters

other

octet string

Returns

reference to this

Definition at line 73 of file symkey.cpp.

                                                       {
   if(&k == this) {
      zeroise(m_data);
      return (*this);
   }
   xor_buf(m_data.data(), k.begin(), std::min(length(), k.length()));
   return (*this);
}

References begin(), length(), OctetString(), Botan::xor_buf(), and Botan::zeroise().

set_odd_parity()

void Botan::OctetString::set_odd_parity

(

)

Force to have odd parity

Deprecated. There is no reason to use this outside of interacting with some very old or weird system which requires DES and also which do not automatically ignore the parity bits.

Definition at line 57 of file symkey.cpp.

                                 {
   for(auto& b : m_data) {
      b = odd_parity_of(b);
   }
}

size()

size_t Botan::OctetString::size ( ) const

inline

Return the length of this octet string

Returns

size of this octet string in bytes

Definition at line 34 of file symkey.h.

{ return m_data.size(); }

Referenced by Botan::rfc3394_keyunwrap(), and Botan::rfc3394_keywrap().

to_string()

std::string Botan::OctetString::to_string

(

)

const

Format this octet string as a hex string

Returns

this encoded as hex

Definition at line 66 of file symkey.cpp.

                                       {
   return hex_encode(m_data.data(), m_data.size());
}

References Botan::hex_encode().

---

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

• src/lib/base/symkey.h
• src/lib/base/symkey.cpp