projects / exim.git / blame
| Commit | Line | Data |
|---|---|---|
| 80a47a2c TK |
1 | /** |
| 2 | * \file base64.h | |
| 3 | * | |
| 62d3e98d TK |
4 | * Copyright (C) 2006-2010, Brainspark B.V. |
| 5 | * | |
| 6 | * This file is part of PolarSSL (http://www.polarssl.org) | |
| 7 | * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org> | |
| 80a47a2c | 8 | * |
| 62d3e98d | 9 | * All rights reserved. |
| 80a47a2c TK |
10 | * |
| 11 | * This program is free software; you can redistribute it and/or modify | |
| 12 | * it under the terms of the GNU General Public License as published by | |
| 13 | * the Free Software Foundation; either version 2 of the License, or | |
| 14 | * (at your option) any later version. | |
| 15 | * | |
| 16 | * This program is distributed in the hope that it will be useful, | |
| 17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 19 | * GNU General Public License for more details. | |
| 20 | * | |
| 21 | * You should have received a copy of the GNU General Public License along | |
| 22 | * with this program; if not, write to the Free Software Foundation, Inc., | |
| 23 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 24 | */ | |
| 80a47a2c TK |
25 | #ifndef POLARSSL_BASE64_H |
| 26 | #define POLARSSL_BASE64_H | |
| 27 | ||
| 67932e54 TK |
28 | #define POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL 0x0010 |
| 29 | #define POLARSSL_ERR_BASE64_INVALID_CHARACTER 0x0012 | |
| 80a47a2c TK |
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 buffer | |
| 40 | * \param src source buffer | |
| 41 | * \param slen amount of data to be encoded | |
| 42 | * | |
| 43 | * \return 0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL. | |
| 44 | * *dlen is always updated to reflect the amount | |
| 45 | * of data that has (or would have) been written. | |
| 46 | * | |
| 47 | * \note Call this function with *dlen = 0 to obtain the | |
| 48 | * required buffer size in *dlen | |
| 49 | */ | |
| 50 | int base64_encode( unsigned char *dst, int *dlen, | |
| 62d3e98d | 51 | const unsigned char *src, int slen ); |
| 80a47a2c TK |
52 | |
| 53 | /** | |
| 54 | * \brief Decode a base64-formatted buffer | |
| 55 | * | |
| 56 | * \param dst destination buffer | |
| 57 | * \param dlen size of the buffer | |
| 58 | * \param src source buffer | |
| 59 | * \param slen amount of data to be decoded | |
| 60 | * | |
| 61 | * \return 0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or | |
| 62 | * POLARSSL_ERR_BASE64_INVALID_DATA if the input data is not | |
| 63 | * correct. *dlen is always updated to reflect the amount | |
| 64 | * of data that has (or would have) been written. | |
| 65 | * | |
| 66 | * \note Call this function with *dlen = 0 to obtain the | |
| 67 | * required buffer size in *dlen | |
| 68 | */ | |
| 69 | int base64_decode( unsigned char *dst, int *dlen, | |
| 62d3e98d | 70 | const unsigned char *src, int slen ); |
| 80a47a2c | 71 | |
| ac3ad426 AM |
72 | /** |
| 73 | * \brief Checkup routine | |
| 74 | * | |
| 75 | * \return 0 if successful, or 1 if the test failed | |
| 76 | */ | |
| 77 | int base64_self_test( int verbose ); | |
| 78 | ||
| 80a47a2c TK |
79 | #ifdef __cplusplus |
| 80 | } | |
| 81 | #endif | |
| 82 | ||
| 83 | #endif /* base64.h */ |