Botan::PEM_Code Namespace Reference

Functions
SecureVector< byte >	decode (DataSource &source, std::string &label)
SecureVector< byte >	decode_check_label (DataSource &source, const std::string &label_want)
std::string	encode (const byte der[], size_t length, const std::string &label, size_t width)
std::string	encode (const MemoryRegion< byte > &data, const std::string &label, size_t width)
bool	matches (DataSource &source, const std::string &extra, size_t search_range)

Function Documentation

decode()

BOTAN_DLL SecureVector< byte > Botan::PEM_Code::decode	(	DataSource &	source,
		std::string &	label )

Definition at line 56 of file pem.cpp.

   {
   const size_t RANDOM_CHAR_LIMIT = 8;
 
   const std::string PEM_HEADER1 = "-----BEGIN ";
   const std::string PEM_HEADER2 = "-----";
   size_t position = 0;
 
   while(position != PEM_HEADER1.length())
      {
      byte b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM header found");
      if(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())
      {
      byte b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM header found");
      if(b == PEM_HEADER2[position])
         ++position;
      else if(position)
         throw Decoding_Error("PEM: Malformed PEM header");
 
      if(position == 0)
         label += static_cast<char>(b);
      }
 
   Pipe base64(new Base64_Decoder);
   base64.start_msg();
 
   const std::string PEM_TRAILER = "-----END " + label + "-----";
   position = 0;
   while(position != PEM_TRAILER.length())
      {
      byte b;
      if(!source.read_byte(b))
         throw Decoding_Error("PEM: No PEM trailer found");
      if(b == PEM_TRAILER[position])
         ++position;
      else if(position)
         throw Decoding_Error("PEM: Malformed PEM trailer");
 
      if(position == 0)
         base64.write(b);
      }
   base64.end_msg();
   return base64.read_all();
   }

References decode(), Botan::Decoding_Error::Decoding_Error(), Botan::Pipe::end_msg(), Botan::Pipe::read_all(), Botan::DataSource::read_byte(), Botan::Pipe::start_msg(), and Botan::Pipe::write().

Referenced by decode(), decode_check_label(), and Botan::DL_Group::PEM_decode().

decode_check_label()

BOTAN_DLL SecureVector< byte > Botan::PEM_Code::decode_check_label	(	DataSource &	source,
		const std::string &	label_want )

Definition at line 42 of file pem.cpp.

   {
   std::string label_got;
   SecureVector<byte> 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(), decode_check_label(), and Botan::Decoding_Error::Decoding_Error().

Referenced by Botan::CMS_Decoder::CMS_Decoder(), decode_check_label(), Botan::CryptoBox::decrypt(), Botan::EC_Group::EC_Group(), Botan::X509::load_key(), and Botan::PKCS10_Request::raw_public_key().

encode() [1/2]

BOTAN_DLL std::string Botan::PEM_Code::encode	(	const byte	der[],
		size_t	length,
		const std::string &	label,
		size_t	width )

Definition at line 19 of file pem.cpp.

   {
   const std::string PEM_HEADER = "-----BEGIN " + label + "-----\n";
   const std::string PEM_TRAILER = "-----END " + label + "-----\n";
 
   Pipe pipe(new Base64_Encoder(true, width));
   pipe.process_msg(der, length);
   return (PEM_HEADER + pipe.read_all_as_string() + PEM_TRAILER);
   }

References Botan::Base64_Encoder::Base64_Encoder(), encode(), Botan::Pipe::process_msg(), and Botan::Pipe::read_all_as_string().

Referenced by encode(), encode(), Botan::CryptoBox::encrypt(), Botan::CMS_Encoder::PEM_contents(), Botan::DL_Group::PEM_encode(), Botan::EC_Group::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::X509::PEM_encode(), and Botan::X509_Object::PEM_encode().

encode() [2/2]

BOTAN_DLL std::string Botan::PEM_Code::encode	(	const MemoryRegion< byte > &	data,
		const std::string &	label,
		size_t	width )

Definition at line 33 of file pem.cpp.

   {
   return encode(&data[0], data.size(), label, width);
   }

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

matches()

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

Definition at line 116 of file pem.cpp.

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

References matches(), Botan::DataSource::peek(), and Botan::MemoryRegion< T >::size().

Referenced by Botan::CMS_Decoder::CMS_Decoder(), Botan::X509::load_key(), and matches().