8#include <botan/base64.h>
10#include <botan/exceptn.h>
11#include <botan/internal/charset.h>
12#include <botan/internal/codec_base.h>
13#include <botan/internal/ct_utils.h>
14#include <botan/internal/fmt.h>
15#include <botan/internal/rounding.h>
23 static inline std::string
name() noexcept {
return "base64"; }
25 static inline size_t encoding_bytes_in() noexcept {
return m_encoding_bytes_in; }
27 static inline size_t encoding_bytes_out() noexcept {
return m_encoding_bytes_out; }
29 static inline size_t decoding_bytes_in() noexcept {
return m_encoding_bytes_out; }
31 static inline size_t decoding_bytes_out() noexcept {
return m_encoding_bytes_in; }
33 static inline size_t bits_consumed() noexcept {
return m_encoding_bits; }
35 static inline size_t remaining_bits_before_padding() noexcept {
return m_remaining_bits_before_padding; }
37 static inline size_t encode_max_output(
size_t input_length) {
38 return (
round_up(input_length, m_encoding_bytes_in) / m_encoding_bytes_in) * m_encoding_bytes_out;
41 static inline size_t decode_max_output(
size_t input_length) {
42 return (
round_up(input_length, m_encoding_bytes_out) * m_encoding_bytes_in) / m_encoding_bytes_out;
45 static void encode(
char out[8],
const uint8_t in[5])
noexcept;
47 static uint8_t lookup_binary_value(
char input)
noexcept;
49 static bool check_bad_char(uint8_t bin,
char input,
bool ignore_ws);
51 static void decode(uint8_t* out_ptr,
const uint8_t decode_buf[4]) {
52 out_ptr[0] = (decode_buf[0] << 2) | (decode_buf[1] >> 4);
53 out_ptr[1] = (decode_buf[1] << 4) | (decode_buf[2] >> 2);
54 out_ptr[2] = (decode_buf[2] << 6) | decode_buf[3];
57 static inline size_t bytes_to_remove(
size_t final_truncate) {
return final_truncate; }
60 static const size_t m_encoding_bits = 6;
61 static const size_t m_remaining_bits_before_padding = 8;
63 static const size_t m_encoding_bytes_in = 3;
64 static const size_t m_encoding_bytes_out = 4;
67char lookup_base64_char(uint8_t x) {
75 const char c_AZ =
'A' + x;
76 const char c_az =
'a' + (x - 26);
77 const char c_09 =
'0' + (x - 2 * 26);
78 const char c_plus =
'+';
79 const char c_slash =
'/';
82 ret = in_AZ.select(c_AZ, ret);
83 ret = in_09.select(c_09, ret);
84 ret = eq_plus.select(c_plus, ret);
85 ret = eq_slash.select(c_slash, ret);
91void Base64::encode(
char out[8],
const uint8_t in[5])
noexcept {
92 const uint8_t b0 = (in[0] & 0xFC) >> 2;
93 const uint8_t b1 = ((in[0] & 0x03) << 4) | (in[1] >> 4);
94 const uint8_t b2 = ((in[1] & 0x0F) << 2) | (in[2] >> 6);
95 const uint8_t b3 = in[2] & 0x3F;
96 out[0] = lookup_base64_char(b0);
97 out[1] = lookup_base64_char(b1);
98 out[2] = lookup_base64_char(b2);
99 out[3] = lookup_base64_char(b3);
103uint8_t Base64::lookup_binary_value(
char input)
noexcept {
104 const uint8_t c =
static_cast<uint8_t
>(input);
114 const auto is_whitespace =
117 const uint8_t c_upper = c - uint8_t(
'A');
118 const uint8_t c_lower = c - uint8_t(
'a') + 26;
119 const uint8_t c_decim = c - uint8_t(
'0') + 2 * 26;
123 ret = is_alpha_upper.select(c_upper, ret);
124 ret = is_alpha_lower.select(c_lower, ret);
125 ret = is_decimal.select(c_decim, ret);
126 ret = is_plus.select(62, ret);
127 ret = is_slash.select(63, ret);
129 ret = is_whitespace.select(0x80, ret);
135bool Base64::check_bad_char(uint8_t bin,
char input,
bool ignore_ws) {
138 }
else if(!(bin == 0x81 || (bin == 0x80 && ignore_ws))) {
146size_t base64_encode(
char out[],
const uint8_t in[],
size_t input_length,
size_t& input_consumed,
bool final_inputs) {
147 return base_encode(Base64(), out, in, input_length, input_consumed, final_inputs);
155 uint8_t out[],
const char in[],
size_t input_length,
size_t& input_consumed,
bool final_inputs,
bool ignore_ws) {
156 return base_decode(Base64(), out, in, input_length, input_consumed, final_inputs, ignore_ws);
159size_t base64_decode(uint8_t output[],
const char input[],
size_t input_length,
bool ignore_ws) {
163size_t base64_decode(uint8_t output[], std::string_view input,
bool ignore_ws) {
164 return base64_decode(output, input.data(), input.length(), ignore_ws);
167size_t base64_decode(std::span<uint8_t> output, std::string_view input,
bool ignore_ws) {
171 return base64_decode(output.data(), input.data(), input.length(), ignore_ws);
175 return base_decode_to_vec<secure_vector<uint8_t>>(Base64(), input, input_length, ignore_ws);
183 return Base64::encode_max_output(input_length);
187 return Base64::decode_max_output(input_length);
#define BOTAN_DEBUG_ASSERT(expr)
static constexpr Mask< T > is_within_range(T v, T l, T u)
static constexpr Mask< T > is_equal(T x, T y)
static constexpr Mask< T > is_lt(T x, T y)
static constexpr Mask< T > is_any_of(T v, std::initializer_list< T > accepted)
int(* final)(unsigned char *, CTX *)
constexpr CT::Mask< T > is_equal(const T x[], const T y[], size_t len)
std::string encode(const uint8_t der[], size_t length, std::string_view label, size_t width)
secure_vector< uint8_t > decode(DataSource &source, std::string &label)
std::string format_char_for_display(char c)
std::string fmt(std::string_view format, const T &... args)
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
size_t base64_decode(uint8_t out[], const char in[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
size_t base_encode(Base &&base, char output[], const uint8_t input[], size_t input_length, size_t &input_consumed, bool final_inputs)
size_t base64_encode_max_output(size_t input_length)
size_t base64_decode_max_output(size_t input_length)
size_t base_decode(Base &&base, uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws=true)
std::string base_encode_to_string(Base &&base, const uint8_t input[], size_t input_length)
std::vector< T, secure_allocator< T > > secure_vector
size_t round_up(size_t n, size_t align_to)
size_t base_decode_full(Base &&base, uint8_t output[], const char input[], size_t input_length, bool ignore_ws)