util-base64.c File Reference

#include "util-base64.h"
#include "util-debug.h"
#include "util-unittest.h"

Include dependency graph for util-base64.c:

Go to the source code of this file.

Macros
#define	BASE64_TABLE_MAX   122
#define	TEST_RFC2045(src, fin_str, dest_size, exp_decoded, exp_consumed, ecode)
#define	TEST_RFC4648(src, fin_str, dest_size, exp_decoded, exp_consumed, ecode)

Functions
bool	IsBase64Alphabet (uint8_t encoded_byte)
	Checks if the given char in a byte array is Base64 alphabet. More...
Base64Ecode	DecodeBase64 (uint8_t *dest, uint32_t dest_size, const uint8_t *src, uint32_t len, uint32_t *consumed_bytes, uint32_t *decoded_bytes, Base64Mode mode)
	Decodes a base64-encoded string buffer into an ascii-encoded byte buffer. More...
void	Base64RegisterTests (void)

Detailed Description

Author

David Abarbanel david.nosp@m..aba.nosp@m.rbane.nosp@m.l@ba.nosp@m.esyst.nosp@m.ems..nosp@m.com

Definition in file util-base64.c.

Macro Definition Documentation

BASE64_TABLE_MAX

#define BASE64_TABLE_MAX   122

Definition at line 30 of file util-base64.c.

TEST_RFC2045

#define TEST_RFC2045	(		src,
			fin_str,
			dest_size,
			exp_decoded,
			exp_consumed,
			ecode
	)

Value:

    {                                                                                              \
        uint32_t consumed_bytes = 0, num_decoded = 0;                                              \
        uint8_t dst[dest_size];                                                                    \
        Base64Ecode code = DecodeBase64(dst, dest_size, (const uint8_t *)src, strlen(src),         \
                &consumed_bytes, &num_decoded, BASE64_MODE_RFC2045);                               \
        FAIL_IF(code != ecode);                                                                    \
        FAIL_IF(memcmp(dst, fin_str, strlen(fin_str)) != 0);                                       \
        FAIL_IF(num_decoded != exp_decoded);                                                       \
        FAIL_IF(consumed_bytes != exp_consumed);                                                   \
    }

Definition at line 215 of file util-base64.c.

TEST_RFC4648

#define TEST_RFC4648	(		src,
			fin_str,
			dest_size,
			exp_decoded,
			exp_consumed,
			ecode
	)

Value:

    {                                                                                              \
        uint32_t consumed_bytes = 0, num_decoded = 0;                                              \
        uint8_t dst[dest_size];                                                                    \
        Base64Ecode code = DecodeBase64(dst, dest_size, (const uint8_t *)src, strlen(src),         \
                &consumed_bytes, &num_decoded, BASE64_MODE_RFC4648);                               \
        FAIL_IF(code != ecode);                                                                    \
        FAIL_IF(memcmp(dst, fin_str, strlen(fin_str)) != 0);                                       \
        FAIL_IF(num_decoded != exp_decoded);                                                       \
        FAIL_IF(consumed_bytes != exp_consumed);                                                   \
    }

Definition at line 227 of file util-base64.c.

Function Documentation

Base64RegisterTests()

void Base64RegisterTests

(

void

)

Definition at line 404 of file util-base64.c.

References UtRegisterTest().

Here is the call graph for this function:

DecodeBase64()

Base64Ecode DecodeBase64	(	uint8_t *	dest,
		uint32_t	dest_size,
		const uint8_t *	src,
		uint32_t	len,
		uint32_t *	consumed_bytes,
		uint32_t *	decoded_bytes,
		Base64Mode	mode
	)

Decodes a base64-encoded string buffer into an ascii-encoded byte buffer.

Parameters

dest	The destination byte buffer
dest_size	The destination byte buffer size
src	The source string
len	The length of the source string
consumed_bytes	The bytes that were actually processed/consumed
decoded_bytes	The bytes that were decoded
mode	The mode in which decoding should happen

Returns

Error code indicating success or failures with parsing

Definition at line 109 of file util-base64.c.

References B64_BLOCK, BASE64_ECODE_OK, len, and padding.

Referenced by DetectBase64DecodeDoMatch().

Here is the caller graph for this function:

IsBase64Alphabet()

bool IsBase64Alphabet

(

uint8_t

encoded_byte

)

Checks if the given char in a byte array is Base64 alphabet.

Parameters

Char	that needs to be checked

Returns

True if the char was Base64 alphabet, False otherwise

Definition at line 73 of file util-base64.c.