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 32 codec 39 * 40 * Base 32 codec functions 41 * 42 * @{ 43 * 44 *----------------------------------------------------------------------------*/ 45 #ifndef _BASE32_H 46 #define _BASE32_H 47 48 #include <dnscore/sys_types.h> 49 50 #ifdef __cplusplus 51 extern "C" { 52 #endif 53 54 /** 55 * Encodes bytes into base32 56 * The output size must be at least size_in * 8/5 57 * 58 * @param buffer_in bytes to convert 59 * @param size_in number of bytes 60 * @param buffer_out output buffer of a size >= size_in * 8/5 61 * 62 * @return output size 63 */ 64 65 u32 base32_encode(const u8* buffer_in,u32 size_in,char* buffer_out); 66 67 /** 68 * Decodes base32 into bytes 69 * The output size must be at least size_in * 5/8 70 * 71 * @param buffer_in base32 text 72 * @param size_in number of chars 73 * @param buffer_out output buffer of a size >= size_in * 5/8 74 * 75 * @return output size 76 */ 77 78 ya_result base32_decode(const char* buffer_in,u32 size_in,u8* buffer_out); 79 80 #ifdef __cplusplus 81 } 82 #endif 83 84 #endif /* _BASE32_H */ 85 /** @} */ 86