Botan 3.9.0
Crypto and TLS for C&
Botan::PEM_Code Namespace Reference

Functions

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

Function Documentation

◆ decode() [1/2]

secure_vector< uint8_t > 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 62 of file pem.cpp.

62 {
63 const size_t RANDOM_CHAR_LIMIT = 8;
64
65 label.clear();
66
67 const std::string PEM_HEADER1 = "-----BEGIN ";
68 const std::string PEM_HEADER2 = "-----";
69 size_t position = 0;
70
71 while(position != PEM_HEADER1.length()) {
72 auto b = source.read_byte();
73
74 if(!b) {
75 throw Decoding_Error("PEM: No PEM header found");
76 }
77 if(static_cast<char>(*b) == PEM_HEADER1[position]) {
78 ++position;
79 } else if(position >= RANDOM_CHAR_LIMIT) {
80 throw Decoding_Error("PEM: Malformed PEM header");
81 } else {
82 position = 0;
83 }
84 }
85 position = 0;
86 while(position != PEM_HEADER2.length()) {
87 auto b = source.read_byte();
88
89 if(!b) {
90 throw Decoding_Error("PEM: No PEM header found");
91 }
92 if(static_cast<char>(*b) == PEM_HEADER2[position]) {
93 ++position;
94 } else if(position > 0) {
95 throw Decoding_Error("PEM: Malformed PEM header");
96 }
97
98 if(position == 0) {
99 label += static_cast<char>(*b);
100 }
101 }
102
103 std::vector<char> b64;
104
105 const std::string PEM_TRAILER = fmt("-----END {}-----", label);
106 position = 0;
107 while(position != PEM_TRAILER.length()) {
108 auto b = source.read_byte();
109
110 if(!b) {
111 throw Decoding_Error("PEM: No PEM trailer found");
112 }
113 if(static_cast<char>(*b) == PEM_TRAILER[position]) {
114 ++position;
115 } else if(position > 0) {
116 throw Decoding_Error("PEM: Malformed PEM trailer");
117 }
118
119 if(position == 0) {
120 b64.push_back(*b);
121 }
122 }
123
124 return base64_decode(b64.data(), b64.size());
125}
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53
size_t base64_decode(uint8_t out[], const char in[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition base64.cpp:168

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

Referenced by decode(), decode_check_label(), Botan::DL_Group::DL_Group(), Botan::DL_Group::from_PEM(), and Botan::X509_Object::load_data().

◆ decode() [2/2]

secure_vector< uint8_t > Botan::PEM_Code::decode ( std::string_view 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 132 of file pem.cpp.

132 {
133 DataSource_Memory src(pem);
134 return decode(src, label);
135}
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
Definition pem.cpp:62

References decode().

◆ decode_check_label() [1/2]

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

Decode PEM data

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

Definition at line 49 of file pem.cpp.

49 {
50 std::string label_got;
51 secure_vector<uint8_t> ber = decode(source, label_got);
52 if(label_got != label_want) {
53 throw Decoding_Error(fmt("PEM: Label mismatch, wanted '{}' got '{}'", label_want, label_got));
54 }
55
56 return ber;
57}
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:69

References decode(), and Botan::fmt().

Referenced by decode_check_label(), Botan::CryptoBox::decrypt_bin(), Botan::EC_Group::EC_Group(), Botan::EC_Group::from_PEM(), and Botan::X509::load_key().

◆ decode_check_label() [2/2]

secure_vector< uint8_t > Botan::PEM_Code::decode_check_label ( std::string_view pem,
std::string_view label )

Decode PEM data

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

Definition at line 127 of file pem.cpp.

127 {
128 DataSource_Memory src(pem);
129 return decode_check_label(src, label_want);
130}
secure_vector< uint8_t > decode_check_label(DataSource &source, std::string_view label_want)
Definition pem.cpp:49

References decode_check_label().

◆ encode() [1/2]

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

Encode some binary data in PEM format

Parameters
databinary data to encode
labelPEM label
line_widthafter this many characters, a new line is inserted

Definition at line 38 of file pem.h.

38 {
39 return encode(data.data(), data.size(), label, line_width);
40}
std::string encode(const uint8_t der[], size_t length, std::string_view label, size_t width)
Definition pem.cpp:39

References encode().

◆ encode() [2/2]

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

Encode some binary data in PEM format

Parameters
databinary data to encode
data_lenlength of binary data in bytes
labelPEM label put after BEGIN and END
line_widthafter this many characters, a new line is inserted

Definition at line 39 of file pem.cpp.

39 {
40 const std::string PEM_HEADER = fmt("-----BEGIN {}-----\n", label);
41 const std::string PEM_TRAILER = fmt("-----END {}-----\n", label);
42
43 return (PEM_HEADER + linewrap(width, base64_encode(der, length)) + PEM_TRAILER);
44}
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition base64.cpp:160

References Botan::base64_encode(), and Botan::fmt().

Referenced by botan_privkey_rsa_get_privkey(), encode(), Botan::CryptoBox::encrypt(), Botan::DL_Group::PEM_encode(), Botan::EC_Group::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::PKCS8::PEM_encode(), Botan::TLS::Session::PEM_encode(), Botan::X509::PEM_encode(), Botan::X509_Object::PEM_encode(), Botan::PKCS8::PEM_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::PEM_encode_encrypted_pbkdf_msec().

◆ matches()

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

Heuristic test for PEM data.

Definition at line 140 of file pem.cpp.

140 {
141 const std::string PEM_HEADER = fmt("-----BEGIN {}", extra);
142
143 secure_vector<uint8_t> search_buf(search_range);
144 const size_t got = source.peek(search_buf.data(), search_buf.size(), 0);
145
146 if(got < PEM_HEADER.length()) {
147 return false;
148 }
149
150 size_t index = 0;
151
152 for(size_t j = 0; j != got; ++j) {
153 if(static_cast<char>(search_buf[j]) == PEM_HEADER[index]) {
154 ++index;
155 } else {
156 index = 0;
157 }
158
159 if(index == PEM_HEADER.size()) {
160 return true;
161 }
162 }
163
164 return false;
165}
virtual size_t peek(uint8_t out[], size_t length, size_t peek_offset) const =0

References Botan::fmt(), and Botan::DataSource::peek().

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