Botan  1.11.10
Functions
Botan::PEM_Code Namespace Reference

Functions

secure_vector< bytedecode (DataSource &source, std::string &label)
 
secure_vector< bytedecode (const std::string &pem, std::string &label)
 
secure_vector< bytedecode_check_label (DataSource &source, const std::string &label_want)
 
secure_vector< bytedecode_check_label (const std::string &pem, 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 std::vector< byte > &data, const std::string &label, size_t line_width=64)
 
std::string encode (const secure_vector< byte > &data, const std::string &label, size_t line_width=64)
 
bool matches (DataSource &source, const std::string &extra, size_t search_range)
 

Function Documentation

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

Decode PEM data

Parameters
pema datasource containing PEM encoded data
labelis set to the PEM label found for later inspection

Definition at line 47 of file pem.cpp.

References 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().

48  {
49  const size_t RANDOM_CHAR_LIMIT = 8;
50 
51  const std::string PEM_HEADER1 = "-----BEGIN ";
52  const std::string PEM_HEADER2 = "-----";
53  size_t position = 0;
54 
55  while(position != PEM_HEADER1.length())
56  {
57  byte b;
58  if(!source.read_byte(b))
59  throw Decoding_Error("PEM: No PEM header found");
60  if(b == PEM_HEADER1[position])
61  ++position;
62  else if(position >= RANDOM_CHAR_LIMIT)
63  throw Decoding_Error("PEM: Malformed PEM header");
64  else
65  position = 0;
66  }
67  position = 0;
68  while(position != PEM_HEADER2.length())
69  {
70  byte b;
71  if(!source.read_byte(b))
72  throw Decoding_Error("PEM: No PEM header found");
73  if(b == PEM_HEADER2[position])
74  ++position;
75  else if(position)
76  throw Decoding_Error("PEM: Malformed PEM header");
77 
78  if(position == 0)
79  label += static_cast<char>(b);
80  }
81 
82  Pipe base64(new Base64_Decoder);
83  base64.start_msg();
84 
85  const std::string PEM_TRAILER = "-----END " + label + "-----";
86  position = 0;
87  while(position != PEM_TRAILER.length())
88  {
89  byte b;
90  if(!source.read_byte(b))
91  throw Decoding_Error("PEM: No PEM trailer found");
92  if(b == PEM_TRAILER[position])
93  ++position;
94  else if(position)
95  throw Decoding_Error("PEM: Malformed PEM trailer");
96 
97  if(position == 0)
98  base64.write(b);
99  }
100  base64.end_msg();
101  return base64.read_all();
102  }
uint8_t byte
Definition: types.h:30
BOTAN_DLL secure_vector< byte > Botan::PEM_Code::decode ( const std::string &  pem,
std::string &  label 
)

Decode PEM data

Parameters
pema string containing PEM encoded data
labelis set to the PEM label found for later inspection

Definition at line 111 of file pem.cpp.

References decode().

112  {
113  DataSource_Memory src(pem);
114  return decode(src, label);
115  }
secure_vector< byte > decode(const std::string &pem, std::string &label)
Definition: pem.cpp:111
BOTAN_DLL secure_vector< byte > Botan::PEM_Code::decode_check_label ( DataSource &  pem,
const std::string &  label 
)

Decode PEM data

Parameters
pema datasource containing PEM encoded data
labelis what we expect the label to be

Definition at line 33 of file pem.cpp.

References decode().

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

35  {
36  std::string label_got;
37  secure_vector<byte> ber = decode(source, label_got);
38  if(label_got != label_want)
39  throw Decoding_Error("PEM: Label mismatch, wanted " + label_want +
40  ", got " + label_got);
41  return ber;
42  }
secure_vector< byte > decode(const std::string &pem, std::string &label)
Definition: pem.cpp:111
BOTAN_DLL secure_vector< byte > Botan::PEM_Code::decode_check_label ( const std::string &  pem,
const std::string &  label 
)

Decode PEM data

Parameters
pema string containing PEM encoded data
labelis what we expect the label to be

Definition at line 104 of file pem.cpp.

References decode_check_label().

106  {
107  DataSource_Memory src(pem);
108  return decode_check_label(src, label_want);
109  }
secure_vector< byte > decode_check_label(const std::string &pem, const std::string &label_want)
Definition: pem.cpp:104
BOTAN_DLL std::string Botan::PEM_Code::encode ( const byte  data[],
size_t  data_len,
const std::string &  label,
size_t  line_width = 64 
)

Encode some binary data in PEM format

Definition at line 19 of file pem.cpp.

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

Referenced by Botan::X509::BER_encode(), Botan::PKCS8::BER_encode(), Botan::X509::create_cert_req(), Botan::X942_PRF::derive(), encode(), Botan::DER_Encoder::encode_list(), Botan::DER_Encoder::encode_optional(), Botan::CryptoBox::encrypt(), Botan::X509_CA::make_cert(), Botan::X509::PEM_encode(), Botan::DL_Group::PEM_encode(), Botan::EC_Group::PEM_encode(), Botan::X509_Object::PEM_encode(), Botan::TLS::Session::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::McEliece_PrivateKey::pkcs8_private_key(), and Botan::McEliece_PublicKey::x509_subject_public_key().

21  {
22  const std::string PEM_HEADER = "-----BEGIN " + label + "-----\n";
23  const std::string PEM_TRAILER = "-----END " + label + "-----\n";
24 
25  Pipe pipe(new Base64_Encoder(true, width));
26  pipe.process_msg(der, length);
27  return (PEM_HEADER + pipe.read_all_as_string() + PEM_TRAILER);
28  }
std::string Botan::PEM_Code::encode ( const std::vector< byte > &  data,
const std::string &  label,
size_t  line_width = 64 
)
inline

Encode some binary data in PEM format

Definition at line 28 of file pem.h.

References encode().

31  {
32  return encode(&data[0], data.size(), label, line_width);
33  }
std::string encode(const secure_vector< byte > &data, const std::string &label, size_t line_width=64)
Definition: pem.h:38
std::string Botan::PEM_Code::encode ( const secure_vector< byte > &  data,
const std::string &  label,
size_t  line_width = 64 
)
inline

Encode some binary data in PEM format

Definition at line 38 of file pem.h.

References encode().

41  {
42  return encode(&data[0], data.size(), label, line_width);
43  }
std::string encode(const secure_vector< byte > &data, const std::string &label, size_t line_width=64)
Definition: pem.h:38
BOTAN_DLL bool Botan::PEM_Code::matches ( DataSource &  source,
const std::string &  extra = "",
size_t  search_range = 4096 
)

Heuristic test for PEM data.

Definition at line 120 of file pem.cpp.

References Botan::DataSource::peek().

Referenced by Botan::X509::load_key().

122  {
123  const std::string PEM_HEADER = "-----BEGIN " + extra;
124 
125  secure_vector<byte> search_buf(search_range);
126  size_t got = source.peek(&search_buf[0], search_buf.size(), 0);
127 
128  if(got < PEM_HEADER.length())
129  return false;
130 
131  size_t index = 0;
132 
133  for(size_t j = 0; j != got; ++j)
134  {
135  if(search_buf[j] == PEM_HEADER[index])
136  ++index;
137  else
138  index = 0;
139  if(index == PEM_HEADER.size())
140  return true;
141  }
142  return false;
143  }