1 /*------------------------------------------------------------------------------ 2 * 3 * Copyright (c) 2011-2021, EURid vzw. All rights reserved. 4 * The YADIFA TM software product is provided under the BSD 3-clause license: 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 10 * * Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * * Neither the name of EURid nor the names of its contributors may be 16 * used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 * 31 *------------------------------------------------------------------------------ 32 * 33 */ 34 35 /** 36 * @defgroup base Base conversion functions 37 * @ingroup dnscore 38 * @brief Base 64 codec 39 * 40 * Base 64 codec functions 41 * @{ 42 * 43 *----------------------------------------------------------------------------*/ 44 #ifndef _BASE64_H 45 #define _BASE64_H 46 47 #include <dnscore/sys_types.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 #define BASE64_ENCODED_SIZE(binary_size) ((((binary_size)+2)/3)*4) 54 #define BASE64_DECODED_SIZE(text_size) ((((text_size)+3)/4)*3) 55 56 bool base64_character_set_contains(char c); 57 /** 58 * Encodes bytes into base64 59 * The output size must be at least size_in * 4/3 60 * 61 * @param buffer_in bytes to convert 62 * @param size_in number of bytes 63 * @param buffer_out output buffer of a size >= size_in * 4/3 64 * 65 * @return output size 66 */ 67 68 u32 base64_encode(const u8* buffer_in,u32 size_in,char* buffer_out); 69 70 /** 71 * Decodes base64 into bytes 72 * The output size must be at least size_in * 3/4 73 * 74 * @param buffer_in base64 text 75 * @param size_in number of chars 76 * @param buffer_out output buffer of a size >= size_in * 3/4 77 * 78 * @return output size 79 */ 80 81 ya_result base64_decode(const char* buffer_in,u32 size_in,u8* buffer_out); 82 83 #ifdef __cplusplus 84 } 85 #endif 86 87 #endif /* _BASE64_H */ 88 /** @} */ 89