Remove obsolete $Cambridge$ CVS revision strings.
[exim.git] / src / src / pdkim / base64.h
CommitLineData
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 */
25
80a47a2c
TK
26#ifndef POLARSSL_BASE64_H
27#define POLARSSL_BASE64_H
28
67932e54
TK
29#define POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL 0x0010
30#define POLARSSL_ERR_BASE64_INVALID_CHARACTER 0x0012
80a47a2c
TK
31
32#ifdef __cplusplus
33extern "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 buffer
41 * \param src source buffer
42 * \param slen amount of data to be encoded
43 *
44 * \return 0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL.
45 * *dlen is always updated to reflect the amount
46 * of data that has (or would have) been written.
47 *
48 * \note Call this function with *dlen = 0 to obtain the
49 * required buffer size in *dlen
50 */
51int base64_encode( unsigned char *dst, int *dlen,
62d3e98d 52 const unsigned char *src, int slen );
80a47a2c
TK
53
54/**
55 * \brief Decode a base64-formatted buffer
56 *
57 * \param dst destination buffer
58 * \param dlen size of the buffer
59 * \param src source buffer
60 * \param slen amount of data to be decoded
61 *
62 * \return 0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or
63 * POLARSSL_ERR_BASE64_INVALID_DATA if the input data is not
64 * correct. *dlen is always updated to reflect the amount
65 * of data that has (or would have) been written.
66 *
67 * \note Call this function with *dlen = 0 to obtain the
68 * required buffer size in *dlen
69 */
70int base64_decode( unsigned char *dst, int *dlen,
62d3e98d 71 const unsigned char *src, int slen );
80a47a2c
TK
72
73#ifdef __cplusplus
74}
75#endif
76
77#endif /* base64.h */