base64.h
1 /*
2  * Copyright (C) 2014 Hochschule für Angewandte Wissenschaften Hamburg (HAW)
3  * Copyright (C) 2014 Martin Landsmann <Martin.Landsmann@HAW-Hamburg.de>
4  *
5  * This file is subject to the terms and conditions of the GNU Lesser
6  * General Public License v2.1. See the file LICENSE in the top level
7  * directory for more details.
8  */
9 
10 #pragma once
11 
22 #include <stddef.h> /* for size_t */
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 #define BASE64_SUCCESS (0)
29 #define BASE64_ERROR_BUFFER_OUT (-1)
30 #define BASE64_ERROR_BUFFER_OUT_SIZE (-2)
31 #define BASE64_ERROR_DATA_IN (-3)
32 #define BASE64_ERROR_DATA_IN_SIZE (-4)
41 static inline size_t base64_estimate_decode_size(size_t base64_in_size)
42 {
43  return (((base64_in_size + 3) / 4) * 3);
44 }
45 
53 static inline size_t base64_estimate_encode_size(size_t data_in_size)
54 {
55  return (4 * ((data_in_size + 2) / 3));
56 }
57 
75 int base64_encode(const void *data_in, size_t data_in_size,
76  void *base64_out, size_t *base64_out_size);
77 
101 int base64url_encode(const void *data_in, size_t data_in_size,
102  void *base64_out, size_t *base64_out_size);
103 
122 int base64_decode(const void *base64_in, size_t base64_in_size,
123  void *data_out, size_t *data_out_size);
124 
125 #ifdef __cplusplus
126 }
127 #endif
128 
base64_decode
int base64_decode(const void *base64_in, size_t base64_in_size, void *data_out, size_t *data_out_size)
Decodes a given base64 string and save the result to the given destination.
base64_estimate_encode_size
static size_t base64_estimate_encode_size(size_t data_in_size)
Estimates the length of the resulting string after encoding data_in_size bytes into base64.
Definition: base64.h:53
base64url_encode
int base64url_encode(const void *data_in, size_t data_in_size, void *base64_out, size_t *base64_out_size)
Encodes a given datum to base64 with URL and Filename Safe Alphabet and save the result to the given ...
base64_encode
int base64_encode(const void *data_in, size_t data_in_size, void *base64_out, size_t *base64_out_size)
Encodes a given datum to base64 and save the result to the given destination.
base64_estimate_decode_size
static size_t base64_estimate_decode_size(size_t base64_in_size)
Estimates the amount of bytes needed for decoding base64_in_size characters from base64.
Definition: base64.h:41