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 #if !defined(MBEDTLS_CONFIG_FILE) 26 #include "mbedtls/config.h" 27 #else 28 #include MBEDTLS_CONFIG_FILE 29 #endif 30 31 #include <stddef.h> 32 33 #define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL -0x002A /**< Output buffer too small. */ 34 #define MBEDTLS_ERR_BASE64_INVALID_CHARACTER -0x002C /**< Invalid character in input. */ 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 /** 41 * \brief Encode a buffer into base64 format 42 * 43 * \param dst destination buffer 44 * \param dlen size of the destination buffer 45 * \param olen number of bytes written 46 * \param src source buffer 47 * \param slen amount of data to be encoded 48 * 49 * \return 0 if successful, or MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL. 50 * *olen is always updated to reflect the amount 51 * of data that has (or would have) been written. 52 * If that length cannot be represented, then no data is 53 * written to the buffer and *olen is set to the maximum 54 * length representable as a size_t. 55 * 56 * \note Call this function with dlen = 0 to obtain the 57 * required buffer size in *olen 58 */ 59 int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen, 60 const unsigned char *src, size_t slen ); 61 62 /** 63 * \brief Decode a base64-formatted buffer 64 * 65 * \param dst destination buffer (can be NULL for checking size) 66 * \param dlen size of the destination buffer 67 * \param olen number of bytes written 68 * \param src source buffer 69 * \param slen amount of data to be decoded 70 * 71 * \return 0 if successful, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or 72 * MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is 73 * not correct. *olen is always updated to reflect the amount 74 * of data that has (or would have) been written. 75 * 76 * \note Call this function with *dst = NULL or dlen = 0 to obtain 77 * the required buffer size in *olen 78 */ 79 int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen, 80 const unsigned char *src, size_t slen ); 81 82 #if defined(MBEDTLS_SELF_TEST) 83 /** 84 * \brief Checkup routine 85 * 86 * \return 0 if successful, or 1 if the test failed 87 */ 88 int mbedtls_base64_self_test( int verbose ); 89 90 #endif /* MBEDTLS_SELF_TEST */ 91 92 #ifdef __cplusplus 93 } 94 #endif 95 96 #endif /* base64.h */ 97