1 /** 2 * \file base64.h 3 * 4 * \brief RFC 1521 base64 encoding/decoding 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 8 * SPDX-License-Identifier: Apache-2.0 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 */ 22 #ifndef MBEDTLS_BASE64_H 23 #define MBEDTLS_BASE64_H 24 25 #include "mbedtls/build_info.h" 26 27 #include <stddef.h> 28 29 /** Output buffer too small. */ 30 #define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL -0x002A 31 /** Invalid character in input. */ 32 #define MBEDTLS_ERR_BASE64_INVALID_CHARACTER -0x002C 33 34 #ifdef __cplusplus 35 extern "C" { 36 #endif 37 38 /** 39 * \brief Encode a buffer into base64 format 40 * 41 * \param dst destination buffer 42 * \param dlen size of the destination buffer 43 * \param olen number of bytes written 44 * \param src source buffer 45 * \param slen amount of data to be encoded 46 * 47 * \return 0 if successful, or MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL. 48 * *olen is always updated to reflect the amount 49 * of data that has (or would have) been written. 50 * If that length cannot be represented, then no data is 51 * written to the buffer and *olen is set to the maximum 52 * length representable as a size_t. 53 * 54 * \note Call this function with dlen = 0 to obtain the 55 * required buffer size in *olen 56 */ 57 int mbedtls_base64_encode(unsigned char *dst, size_t dlen, size_t *olen, 58 const unsigned char *src, size_t slen); 59 60 /** 61 * \brief Decode a base64-formatted buffer 62 * 63 * \param dst destination buffer (can be NULL for checking size) 64 * \param dlen size of the destination buffer 65 * \param olen number of bytes written 66 * \param src source buffer 67 * \param slen amount of data to be decoded 68 * 69 * \return 0 if successful, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or 70 * MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is 71 * not correct. *olen is always updated to reflect the amount 72 * of data that has (or would have) been written. 73 * 74 * \note Call this function with *dst = NULL or dlen = 0 to obtain 75 * the required buffer size in *olen 76 */ 77 int mbedtls_base64_decode(unsigned char *dst, size_t dlen, size_t *olen, 78 const unsigned char *src, size_t slen); 79 80 #if defined(MBEDTLS_SELF_TEST) 81 /** 82 * \brief Checkup routine 83 * 84 * \return 0 if successful, or 1 if the test failed 85 */ 86 int mbedtls_base64_self_test(int verbose); 87 88 #endif /* MBEDTLS_SELF_TEST */ 89 90 #ifdef __cplusplus 91 } 92 #endif 93 94 #endif /* base64.h */ 95