base64.c File Reference

Base64 encoding scheme. More...

#include "core/crypto.h"
#include "encoding/base64.h"

Go to the source code of this file.

Macros
#define	TRACE_LEVEL   CRYPTO_TRACE_LEVEL

Functions
void	base64EncodeMultiline (const void *input, size_t inputLen, char_t *output, size_t *outputLen, size_t lineWidth)
	Base64 multiline encoding. More...
void	base64Encode (const void *input, size_t inputLen, char_t *output, size_t *outputLen)
	Base64 encoding algorithm. More...
error_t	base64Decode (const char_t *input, size_t inputLen, void *output, size_t *outputLen)
	Base64 decoding algorithm. More...

Detailed Description

Base64 encoding scheme.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2010-2024 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneCRYPTO Open.

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.

Description

Base64 is a encoding scheme that represents binary data in an ASCII string format by translating it into a radix-64 representation. Refer to RFC 4648 for more details

Author

Oryx Embedded SARL (www.oryx-embedded.com)

Version

2.4.4

Definition in file base64.c.

Macro Definition Documentation

TRACE_LEVEL

#define TRACE_LEVEL   CRYPTO_TRACE_LEVEL

Definition at line 38 of file base64.c.

Function Documentation

base64Decode()

error_t base64Decode	(	const char_t *	input,
		size_t	inputLen,
		void *	output,
		size_t *	outputLen
	)

Base64 decoding algorithm.

Parameters

[in]	input	Base64-encoded string
[in]	inputLen	Length of the encoded string
[out]	output	Resulting decoded data
[out]	outputLen	Length of the decoded data

Returns

Error code

Definition at line 258 of file base64.c.

base64Encode()

void base64Encode	(	const void *	input,
		size_t	inputLen,
		char_t *	output,
		size_t *	outputLen
	)

Base64 encoding algorithm.

Parameters

[in]	input	Input data to encode
[in]	inputLen	Length of the data to encode
[out]	output	NULL-terminated string encoded with Base64 algorithm
[out]	outputLen	Length of the encoded string (optional parameter)

Definition at line 142 of file base64.c.

base64EncodeMultiline()

void base64EncodeMultiline	(	const void *	input,
		size_t	inputLen,
		char_t *	output,
		size_t *	outputLen,
		size_t	lineWidth
	)

Base64 multiline encoding.

Parameters

[in]	input	Input data to encode
[in]	inputLen	Length of the data to encode
[out]	output	NULL-terminated string encoded with Base64 algorithm
[out]	outputLen	Length of the encoded string (optional parameter)
[in]	lineWidth	Number of characters per line

Definition at line 79 of file base64.c.