Botan::PEM_Code Namespace Reference

Functions
secure_vector< uint8_t >	decode (const std::string &pem, std::string &label)
secure_vector< uint8_t >	decode (DataSource &source, std::string &label)
secure_vector< uint8_t >	decode_check_label (const std::string &pem, const std::string &label_want)
secure_vector< uint8_t >	decode_check_label (DataSource &source, const std::string &label_want)
template<typename Alloc >
std::string	encode (const std::vector< uint8_t, Alloc > &data, const std::string &label, size_t line_width=64)
std::string	encode (const uint8_t der[], size_t length, const std::string &label, size_t width)
bool	matches (DataSource &source, const std::string &extra, size_t search_range)

Function Documentation

decode() [1/2]

secure_vector< uint8_t > Botan::PEM_Code::decode	(	const std::string &	pem,
		std::string &	label
	)

Decode PEM data

Parameters

pem	a string containing PEM encoded data
label	is set to the PEM label found for later inspection

Definition at line 131 of file pem.cpp.

   {
   DataSource_Memory src(pem);
   return decode(src, label);
   }

References decode().

decode() [2/2]

secure_vector< uint8_t > Botan::PEM_Code::decode	(	DataSource &	pem,
		std::string &	label
	)

Decode PEM data

Parameters

pem	a datasource containing PEM encoded data
label	is set to the PEM label found for later inspection

Definition at line 66 of file pem.cpp.

   {
   const size_t RANDOM_CHAR_LIMIT = 8;
 
   label.clear();
 
   const std::string PEM_HEADER1 = "-----BEGIN ";
   const std::string PEM_HEADER2 = "-----";
   size_t position = 0;
 
   while(position != PEM_HEADER1.length())
      {
      uint8_t b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM header found");
      if(static_cast<char>(b) == PEM_HEADER1[position])
         ++position;
      else if(position >= RANDOM_CHAR_LIMIT)
         throw Decoding_Error("PEM: Malformed PEM header");
      else
         position = 0;
      }
   position = 0;
   while(position != PEM_HEADER2.length())
      {
      uint8_t b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM header found");
      if(static_cast<char>(b) == PEM_HEADER2[position])
         ++position;
      else if(position)
         throw Decoding_Error("PEM: Malformed PEM header");
 
      if(position == 0)
         label += static_cast<char>(b);
      }
 
   std::vector<char> b64;
 
   const std::string PEM_TRAILER = "-----END " + label + "-----";
   position = 0;
   while(position != PEM_TRAILER.length())
      {
      uint8_t b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM trailer found");
      if(static_cast<char>(b) == PEM_TRAILER[position])
         ++position;
      else if(position)
         throw Decoding_Error("PEM: Malformed PEM trailer");
 
      if(position == 0)
         b64.push_back(b);
      }
 
   return base64_decode(b64.data(), b64.size());
   }

References b, Botan::base64_decode(), and Botan::DataSource::read_byte().

Referenced by Botan::BER_Decoder::decode(), decode(), Botan::BER_Decoder::decode_and_check(), decode_check_label(), Botan::BER_Decoder::decode_optional_string(), Botan::DL_Group::DL_Group(), Botan::DL_Group::DL_Group_from_PEM(), Botan::BER_Decoder::get_next_octet_string(), Botan::Kyber_PrivateKey::Kyber_PrivateKey(), Botan::X509_Object::load_data(), and Botan::RSA_PrivateKey::RSA_PrivateKey().

decode_check_label() [1/2]

secure_vector< uint8_t > Botan::PEM_Code::decode_check_label	(	const std::string &	pem,
		const std::string &	label
	)

Decode PEM data

Parameters

pem	a string containing PEM encoded data
label	is what we expect the label to be

Definition at line 124 of file pem.cpp.

   {
   DataSource_Memory src(pem);
   return decode_check_label(src, label_want);
   }

References decode_check_label().

decode_check_label() [2/2]

secure_vector< uint8_t > Botan::PEM_Code::decode_check_label	(	DataSource &	pem,
		const std::string &	label
	)

Decode PEM data

Parameters

pem	a datasource containing PEM encoded data
label	is what we expect the label to be

Definition at line 52 of file pem.cpp.

   {
   std::string label_got;
   secure_vector<uint8_t> ber = decode(source, label_got);
   if(label_got != label_want)
      throw Decoding_Error("PEM: Label mismatch, wanted " + label_want +
                           ", got " + label_got);
   return ber;
   }

References decode().

Referenced by decode_check_label(), Botan::CryptoBox::decrypt_bin(), Botan::EC_Group::EC_Group(), Botan::EC_Group::EC_Group_from_PEM(), Botan::X509::load_key(), and Botan::TLS::Session::Session().

encode() [1/2]

template<typename Alloc >

std::string Botan::PEM_Code::encode	(	const std::vector< uint8_t, Alloc > &	data,
		const std::string &	label,
		size_t	line_width = 64
	)

Encode some binary data in PEM format

Parameters

data	binary data to encode
label	PEM label
line_width	after this many characters, a new line is inserted

Definition at line 39 of file pem.h.

   {
   return encode(data.data(), data.size(), label, line_width);
   }

References encode().

encode() [2/2]

std::string Botan::PEM_Code::encode	(	const uint8_t	data[],
		size_t	data_len,
		const std::string &	label,
		size_t	line_width = 64
	)

Encode some binary data in PEM format

Parameters

data	binary data to encode
data_len	length of binary data in bytes
label	PEM label put after BEGIN and END
line_width	after this many characters, a new line is inserted

Definition at line 41 of file pem.cpp.

   {
   const std::string PEM_HEADER = "-----BEGIN " + label + "-----\n";
   const std::string PEM_TRAILER = "-----END " + label + "-----\n";
 
   return (PEM_HEADER + linewrap(width, base64_encode(der, length)) + PEM_TRAILER);
   }

References Botan::base64_encode().

Referenced by botan_privkey_rsa_get_privkey(), Botan::EC_Group::DER_encode(), encode(), Botan::DER_Encoder::encode(), Botan::DER_Encoder::encode_if(), Botan::DER_Encoder::encode_list(), Botan::DER_Encoder::encode_optional(), Botan::CryptoBox::encrypt(), Botan::X942_PRF::kdf(), Botan::X509_CA::make_cert(), Botan::EC_Group::PEM_encode(), Botan::TLS::Session::PEM_encode(), Botan::X509_Object::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::X509::PEM_encode(), Botan::DL_Group::PEM_encode(), Botan::PKCS8::PEM_encode_encrypted_pbkdf_iter(), Botan::PKCS8::PEM_encode_encrypted_pbkdf_msec(), and Botan::McEliece_PrivateKey::private_key_bits().

matches()

bool Botan::PEM_Code::matches	(	DataSource &	source,
		const std::string &	extra = "",
		size_t	search_range = 4096
	)

Heuristic test for PEM data.

Definition at line 140 of file pem.cpp.

   {
   const std::string PEM_HEADER = "-----BEGIN " + extra;
 
   secure_vector<uint8_t> search_buf(search_range);
   const size_t got = source.peek(search_buf.data(), search_buf.size(), 0);
 
   if(got < PEM_HEADER.length())
      return false;
 
   size_t index = 0;
 
   for(size_t j = 0; j != got; ++j)
      {
      if(static_cast<char>(search_buf[j]) == PEM_HEADER[index])
         {
         ++index;
         }
      else
         {
         index = 0;
         }
 
      if(index == PEM_HEADER.size())
         {
         return true;
         }
      }
 
   return false;
   }

References Botan::DataSource::peek().

Referenced by Botan::Certificate_Store_In_Memory::find_all_certs(), Botan::X509_Object::load_data(), and Botan::X509::load_key().