abcrypt_params_read(3)

NAME

abcrypt_params_read - API function

SYNOPSIS

#include <abcrypt.h>

enum abcrypt_error_code abcrypt_params_read(uint8_t *ciphertext,
                                            uintptr_t ciphertext_len,
                                            struct abcrypt_params *params);

DESCRIPTION

This function reads the Argon2 parameters.

Arguments

ciphertext: A pointer to the ciphertext to read.
ciphertext_len: Length of ciphertext.
params: A pointer to the Argon2 parameters structure to write to.

Behavior is undefined if ciphertext or ciphertext_len is invalid.

RETURN VALUE

Returns ABCRYPT_ERROR_CODE_OK if successful, otherwise returns an error value defined in abcrypt_error_code(3).

VERSIONS

This function was added in version 0.1.0.

REPORTING BUGS

Report bugs to:: https://github.com/sorairolake/abcrypt/issues

COPYRIGHT

This manual page is distributed under the terms of the Creative Commons Attribution 4.0 International Public License.