| Harald Welte | c757239 | 2021-09-17 08:23:09 +0200 | [diff] [blame^] | 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 | * |
| 8 | * This file is part of mbed TLS (https://tls.mbed.org) |
| 9 | * |
| 10 | * This program is free software; you can redistribute it and/or modify |
| 11 | * it under the terms of the GNU General Public License as published by |
| 12 | * the Free Software Foundation; either version 2 of the License, or |
| 13 | * (at your option) any later version. |
| 14 | * |
| 15 | * This program is distributed in the hope that it will be useful, |
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | * GNU General Public License for more details. |
| 19 | * |
| 20 | * You should have received a copy of the GNU General Public License along |
| 21 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 22 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 23 | */ |
| 24 | #ifndef MBEDTLS_BASE64_H |
| 25 | #define MBEDTLS_BASE64_H |
| 26 | |
| 27 | #include <stddef.h> |
| 28 | |
| 29 | #define MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL -0x002A /**< Output buffer too small. */ |
| 30 | #define MBEDTLS_ERR_BASE64_INVALID_CHARACTER -0x002C /**< Invalid character in input. */ |
| 31 | |
| 32 | #ifdef __cplusplus |
| 33 | extern "C" { |
| 34 | #endif |
| 35 | |
| 36 | /** |
| 37 | * \brief Encode a buffer into base64 format |
| 38 | * |
| 39 | * \param dst destination buffer |
| 40 | * \param dlen size of the destination buffer |
| 41 | * \param olen number of bytes written |
| 42 | * \param src source buffer |
| 43 | * \param slen amount of data to be encoded |
| 44 | * |
| 45 | * \return 0 if successful, or MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL. |
| 46 | * *olen is always updated to reflect the amount |
| 47 | * of data that has (or would have) been written. |
| 48 | * |
| 49 | * \note Call this function with dlen = 0 to obtain the |
| 50 | * required buffer size in *olen |
| 51 | */ |
| 52 | int mbedtls_base64_encode( unsigned char *dst, size_t dlen, size_t *olen, |
| 53 | const unsigned char *src, size_t slen ); |
| 54 | |
| 55 | /** |
| 56 | * \brief Decode a base64-formatted buffer |
| 57 | * |
| 58 | * \param dst destination buffer (can be NULL for checking size) |
| 59 | * \param dlen size of the destination buffer |
| 60 | * \param olen number of bytes written |
| 61 | * \param src source buffer |
| 62 | * \param slen amount of data to be decoded |
| 63 | * |
| 64 | * \return 0 if successful, MBEDTLS_ERR_BASE64_BUFFER_TOO_SMALL, or |
| 65 | * MBEDTLS_ERR_BASE64_INVALID_CHARACTER if the input data is |
| 66 | * not correct. *olen is always updated to reflect the amount |
| 67 | * of data that has (or would have) been written. |
| 68 | * |
| 69 | * \note Call this function with *dst = NULL or dlen = 0 to obtain |
| 70 | * the required buffer size in *olen |
| 71 | */ |
| 72 | int mbedtls_base64_decode( unsigned char *dst, size_t dlen, size_t *olen, |
| 73 | const unsigned char *src, size_t slen ); |
| 74 | |
| 75 | /** |
| 76 | * \brief Checkup routine |
| 77 | * |
| 78 | * \return 0 if successful, or 1 if the test failed |
| 79 | */ |
| 80 | int mbedtls_base64_self_test( int verbose ); |
| 81 | |
| 82 | #ifdef __cplusplus |
| 83 | } |
| 84 | #endif |
| 85 | |
| 86 | #endif /* base64.h */ |