RFC 1521 base64 encoding/decoding. More...

#include <string.h>

Include dependency graph for base64.h:

Macros
#define	POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL -0x002A
	Output buffer too small.

#define	POLARSSL_ERR_BASE64_INVALID_CHARACTER -0x002C
	Invalid character in input.

Functions
int	base64_encode (unsigned char dst, size_t dlen, const unsigned char *src, size_t slen)
	Encode a buffer into base64 format.

int	base64_decode (unsigned char dst, size_t dlen, const unsigned char *src, size_t slen)
	Decode a base64-formatted buffer.

int	base64_self_test (int verbose)
	Checkup routine.

Detailed Description

RFC 1521 base64 encoding/decoding.

This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file base64.h.

Macro Definition Documentation

◆ POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL

#define POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL -0x002A

Output buffer too small.

Definition at line 32 of file base64.h.

◆ POLARSSL_ERR_BASE64_INVALID_CHARACTER

#define POLARSSL_ERR_BASE64_INVALID_CHARACTER -0x002C

Invalid character in input.

Definition at line 33 of file base64.h.

Function Documentation

◆ base64_decode()

int base64_decode	(	unsigned char *	dst,
		size_t *	dlen,
		const unsigned char *	src,
		size_t	slen )

Decode a base64-formatted buffer.

Parameters

dst	destination buffer (can be NULL for checking size)
dlen	size of the buffer
src	source buffer
slen	amount of data to be decoded

Returns: 0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or POLARSSL_ERR_BASE64_INVALID_CHARACTER if the input data is not correct. *dlen is always updated to reflect the amount of data that has (or would have) been written.

Note: Call this function with *dst = NULL or *dlen = 0 to obtain the required buffer size in *dlen

◆ base64_encode()

int base64_encode	(	unsigned char *	dst,
		size_t *	dlen,
		const unsigned char *	src,
		size_t	slen )

Encode a buffer into base64 format.

Parameters

dst	destination buffer
dlen	size of the buffer
src	source buffer
slen	amount of data to be encoded

Returns: 0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL. *dlen is always updated to reflect the amount of data that has (or would have) been written.

Note: Call this function with *dlen = 0 to obtain the required buffer size in *dlen

◆ base64_self_test()

int base64_self_test ( int verbose )

Checkup routine.

Returns: 0 if successful, or 1 if the test failed

Macros

Functions