summaryrefslogtreecommitdiff
path: root/include/nsutils/base64.h
blob: fb26426c35b2adab3f4d21edaed8560b8aeef898 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
 * Copyright 2014 Vincent Sanders <vince@netsurf-browser.org>
 *
 * This file is part of libnsutils.
 *
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 */

/**
 * \file
 * Base64 encoding and decoding interface.
 */

#ifndef NSUTILS_BASE64_H_
#define NSUTILS_BASE64_H_

#include <inttypes.h>

#include <nsutils/errors.h>

/**
 * Base 64 encode data.
 *
 * allocate a buffer and encode source data into it using the Base64 encoding.
 *
 * \param input The source data to encode.
 * \param input_length The length of the source data.
 * \param output The buffer to recive data into, the caller must free.
 * \param output_length The length of data placed in \a output
 * \return NSUERROR_OK on success and \a output updated else error code.
 */
nsuerror nsu_base64_encode_alloc(const uint8_t *input,
                                 size_t input_length,
                                 uint8_t **output,
                                 size_t *output_length);

/**
 * Base 64 encode data.
 *
 * encode source data into buffer it using the Base64 encoding.
 *
 * \param input The source data to encode.
 * \param input_length The length of the source data.
 * \param output The output buffer
 * \param output_length The size of the \a output buffer on entry updated with length written on exit.
 * \return NSUERROR_OK on success and \a output_length updated else error code.
 */
nsuerror nsu_base64_encode(const uint8_t *input,
                           size_t input_length,
                           uint8_t *output,
                           size_t *output_length);

/**
 * Base 64 encode data.
 *
 * allocate a buffer and encode source data into it using the base64 URL safe
 *   encoding.
 *
 * \param input The source data to encode.
 * \param input_length The length of the source data.
 * \param output The buffer to recive data into, the caller must free.
 * \param output_length The length of data placed in \a output
 * \return NSERROR_OK on success and \a output updated else error code.
 */
nsuerror nsu_base64_encode_alloc_url(const uint8_t *input,
                                     size_t input_length,
                                     uint8_t **output,
                                     size_t *output_length);


/**
 * Base 64 encode data.
 *
 * encode source data into buffer using the Base64 URL safe encoding.
 *
 * \param input The source data to encode.
 * \param input_length The length of the source data.
 * \param output The output buffer
 * \param output_length The size of the \a output buffer on entry updated with length written on exit.
 * \return NSUERROR_OK on success and \a output_length updated else error code.
 */
nsuerror nsu_base64_encode_url(const uint8_t *input,
                           size_t input_length,
                           uint8_t *output,
                           size_t *output_length);

/**
 * Base 64 decode data.
 *
 * allocate a buffer and decode source data into it using the Base64 encoding.
 *
 * \param input The source data to decode.
 * \param input_length The length of the source data.
 * \param output The buffer to recive data into, the caller must free.
 * \param output_length The length of data placed in \a output
 * \return NSERROR_OK on success and \a output updated else error code.
 */
nsuerror nsu_base64_decode_alloc(const uint8_t *input,
                                 size_t input_length,
                                 uint8_t **output,
                                 size_t *output_length);

/**
 * Base 64 decode data.
 *
 * Allocate a buffer and decode source data into it using the Base64 URL safe
 *   encoding.
 *
 * \param input The source data to decode.
 * \param input_length The length of the source data.
 * \param output The buffer to recive data into, the caller must free.
 * \param output_length The length of data placed in \a output
 * \return NSERROR_OK on success and \a output updated else error code.
 */
nsuerror nsu_base64_decode_alloc_url(const uint8_t *input,
                                     size_t input_length,
                                     uint8_t **output,
                                     size_t *output_length);

#endif