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