Base64

Utilities

Decode a base64-formatted buffer.

Parameters

dst	destination buffer
dlen	size of the destination buffer
olen	number of bytes written
src	source buffer
slen	amount of data to be decoded

Returns

0 if successful, MYKROSSL_ERR_BASE64_BUFFER_TOO_SMALL, or MYKROSSL_ERR_BASE64_INVALID_DATA 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 *dlen = 0 to obtain the required buffer size in *dlen

Base64 decode into binaryd data with reader callback.

Chunks of base64 encoded data are read using the supplied reader callback and decoded into the supplied buffer. This API is useful as it ensures each chunk of arbitrary length data is properly decoded without requiring base64 padding of the chunks.

Note

This API requires that the length of the non-base64 encoded data is known a priori. While this API may be called as many times as needed. The total sum of the supplied 'data_len' arguments must equal length of the non-base64 encoded binary data in bytes.

Parameters

[in]	context	Decoding context pre-initialized with gos_base64_init_decode_context()
[in]	data	Buffer to hold decoded binary data
[in]	data_len	Length of supplied data buffer
[in]	reader	Reader callback to read base64 encoded data

Returns

gos_result_t

Cleanup encode/decode context.

This cleans up (i.e de-allocates) a context allocated by gos_base64_init_encode_context() or gos_base64_init_decode_context()

Parameters

[in]

context

Context to be de-allocated

Encode a buffer into base64 format.

Parameters

dst	destination buffer
dlen	size of the buffer
olen	number of bytes written
src	source buffer
slen	amount of data to be encoded

Returns

0 if successful, or MYKROSSL_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 encode binary data with writer callback.

Arbitrary chunks of binary data are base64 encoded and written using the supplied 'writer' callback. This API is useful as the supplied chunks may be any length. The API ensures the written data is properly base64 encoded as a continuous stream of data (i.e. it ensures no base64 encode padding is applied to the end of the data chunks).

Note

To ensure proper base64 encode padding, once all data is written call this API a final time with a NULL data buffer, e.g. gos_base64_encode_with_writer(context, NULL, 0, base64_writer_callback);

Parameters

[in]	context	Encoding context pre-initialized with gos_base64_init_encode_context()
[in]	data	Binary data to base64 encode
[in]	data_len	Length of supplied data buffer
[in]	writer	Writer callback to write base64 encoded data

Returns

gos_result_t

Initialize gos_base64_decode_context_t .

This must be called before gos_base64_decode_with_reader()

Use gos_base64_destroy_context() to cleanup the context.

Parameters

[out]	context_ptr	Pointer to hold allocated gos_base64_decode_context_t
[in]	user	User specificied argument passed to gos_base64_reader_t
[in]	processing_buffer_size	size of decode processing buffer. A larger buffer typically means faster decoding. Typical value is 1024.

Initialize gos_base64_encode_context_t .

Use gos_base64_destroy_context() to cleanup the context.

Parameters

[out]	context_ptr	Pointer to hold allocated gos_base64_encode_context_t
[in]	user	User specificied argument passed to gos_base64_writer_t
[in]	processing_buffer_size	size of encoding processing buffer. A larger buffer typically means faster encoding. Typical value is 1024.