base64.hh 2.05 KB
Newer Older
Mark Haines's avatar
Mark Haines committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* Copyright 2015 OpenMarket Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Matthew Hodgson's avatar
Matthew Hodgson committed
15
16
#ifndef OLM_BASE64_HH_
#define OLM_BASE64_HH_
Mark Haines's avatar
Mark Haines committed
17
18
19
20

#include <cstddef>
#include <cstdint>

21
namespace olm {
Mark Haines's avatar
Mark Haines committed
22

23
24
25
/**
 * The number of bytes of unpadded base64 needed to encode a length of input.
 */
26
std::size_t encode_base64_length(
Mark Haines's avatar
Mark Haines committed
27
    std::size_t input_length
28
);
Mark Haines's avatar
Mark Haines committed
29

30
31
32
33
34
35
/**
 * Encode the raw input as unpadded base64.
 * Writes encode_base64_length(input_length) bytes to the output buffer.
 * The input can overlap with the last three quarters of the output buffer.
 * That is, the input pointer may be output + output_length - input_length.
 */
36
std::uint8_t * encode_base64(
Mark Haines's avatar
Mark Haines committed
37
38
39
40
    std::uint8_t const * input, std::size_t input_length,
    std::uint8_t * output
);

41
42
43
44
/**
 * The number of bytes of raw data a length of unpadded base64 will encode to.
 * Returns std::size_t(-1) if the length is not a valid length for base64.
 */
Mark Haines's avatar
Mark Haines committed
45
46
47
48
std::size_t decode_base64_length(
    std::size_t input_length
);

49
50
51
52
53
/**
 * Decodes the unpadded base64 input to raw bytes.
 * Writes decode_base64_length(input_length) bytes to the output buffer.
 * The output can overlap with the first three quarters of the input buffer.
 * That is, the input pointers and output pointer may be the same.
54
55
56
57
 *
 * Returns the number of bytes of raw data the base64 input decoded to. If the
 * input length supplied is not a valid length for base64, returns
 * std::size_t(-1) and does not decode.
58
 */
59
std::size_t decode_base64(
Mark Haines's avatar
Mark Haines committed
60
61
62
63
    std::uint8_t const * input, std::size_t input_length,
    std::uint8_t * output
);

64
} // namespace olm
Mark Haines's avatar
Mark Haines committed
65
66


Matthew Hodgson's avatar
Matthew Hodgson committed
67
#endif /* OLM_BASE64_HH_ */