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 OR GPL-2.0-or-later 9 * 10 * This file is provided under the Apache License 2.0, or the 11 * GNU General Public License v2.0 or later. 12 * 13 * ********** 14 * Apache License 2.0: 15 * 16 * Licensed under the Apache License, Version 2.0 (the "License"); you may 17 * not use this file except in compliance with the License. 18 * You may obtain a copy of the License at 19 * 20 * http://www.apache.org/licenses/LICENSE-2.0 21 * 22 * Unless required by applicable law or agreed to in writing, software 23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 25 * See the License for the specific language governing permissions and 26 * limitations under the License. 27 * 28 * ********** 29 * 30 * ********** 31 * GNU General Public License v2.0 or later: 32 * 33 * This program is free software; you can redistribute it and/or modify 34 * it under the terms of the GNU General Public License as published by 35 * the Free Software Foundation; either version 2 of the License, or 36 * (at your option) any later version. 37 * 38 * This program is distributed in the hope that it will be useful, 39 * but WITHOUT ANY WARRANTY; without even the implied warranty of 40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 41 * GNU General Public License for more details. 42 * 43 * You should have received a copy of the GNU General Public License along 44 * with this program; if not, write to the Free Software Foundation, Inc., 45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 46 * 47 * ********** 48 */ 49 #ifndef MBEDTLS_BASE64_H 50 #define MBEDTLS_BASE64_H 51 52 #if !defined(MBEDTLS_CONFIG_FILE) 53 #include "config.h" 54 #else 55 #include MBEDTLS_CONFIG_FILE 56 #endif 57 58 #include <stddef.h> 59 60 #define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL -0x002A /**< Output buffer too small. */ 61 #define MBEDTLS_ERR_BASE64_INVALID_CHARACTER -0x002C /**< Invalid character in input. */ 62 63 #ifdef __cplusplus 64 extern "C" { 65 #endif 66 67 /** 68 * \brief Encode a buffer into base64 format 69 * 70 * \param dst destination buffer 71 * \param dlen size of the destination buffer 72 * \param olen number of bytes written 73 * \param src source buffer 74 * \param slen amount of data to be encoded 75 * 76 * \return 0 if successful, or MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL. 77 * *olen is always updated to reflect the amount 78 * of data that has (or would have) been written. 79 * If that length cannot be represented, then no data is 80 * written to the buffer and *olen is set to the maximum 81 * length representable as a size_t. 82 * 83 * \note Call this function with dlen = 0 to obtain the 84 * required buffer size in *olen 85 */ 86 int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen, 87 const unsigned char *src, size_t slen ); 88 89 /** 90 * \brief Decode a base64-formatted buffer 91 * 92 * \param dst destination buffer (can be NULL for checking size) 93 * \param dlen size of the destination buffer 94 * \param olen number of bytes written 95 * \param src source buffer 96 * \param slen amount of data to be decoded 97 * 98 * \return 0 if successful, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or 99 * MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is 100 * not correct. *olen is always updated to reflect the amount 101 * of data that has (or would have) been written. 102 * 103 * \note Call this function with *dst = NULL or dlen = 0 to obtain 104 * the required buffer size in *olen 105 */ 106 int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen, 107 const unsigned char *src, size_t slen ); 108 109 #if defined(MBEDTLS_SELF_TEST) 110 /** 111 * \brief Checkup routine 112 * 113 * \return 0 if successful, or 1 if the test failed 114 */ 115 int mbedtls_base64_self_test( int verbose ); 116 117 #endif /* MBEDTLS_SELF_TEST */ 118 119 #ifdef __cplusplus 120 } 121 #endif 122 123 #endif /* base64.h */ 124