mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

base64.h File Reference

base64.h File Reference

RFC 1521 base64 encoding/decoding. More...

Go to the source code of this file.

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.

Copyright (C) 2006-2013, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.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.


Function Documentation

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

Decode a base64-formatted buffer.

Parameters:
dstdestination buffer (can be NULL for checking size)
dlensize of the buffer
srcsource buffer
slenamount 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

Definition at line 147 of file base64.c.

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

Encode a buffer into base64 format.

Parameters:
dstdestination buffer
dlensize of the buffer
srcsource buffer
slenamount 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

Definition at line 81 of file base64.c.

int base64_self_test ( int  verbose )

Checkup routine.

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

Definition at line 247 of file base64.c.