abcrypt_error_code(3)

NAME

abcrypt_error_code - API type

SYNOPSIS

#include <abcrypt.h>

typedef enum abcrypt_error_code {
  ABCRYPT_ERROR_CODE_OK,
  ABCRYPT_ERROR_CODE_ERROR,
  ABCRYPT_ERROR_CODE_INVALID_LENGTH,
  ABCRYPT_ERROR_CODE_INVALID_MAGIC_NUMBER,
  ABCRYPT_ERROR_CODE_UNKNOWN_VERSION,
  ABCRYPT_ERROR_CODE_INVALID_ARGON2_PARAMS,
  ABCRYPT_ERROR_CODE_INVALID_ARGON2_CONTEXT,
  ABCRYPT_ERROR_CODE_INVALID_HEADER_MAC,
  ABCRYPT_ERROR_CODE_INVALID_MAC,
} abcrypt_error_code;

DESCRIPTION

This type represents the error code for the abcrypt encrypted data format.

Variants

ABCRYPT_ERROR_CODE_OK

Everything is ok.

ABCRYPT_ERROR_CODE_ERROR

General error.

ABCRYPT_ERROR_CODE_INVALID_LENGTH

The encrypted data was shorter than 156 bytes.

ABCRYPT_ERROR_CODE_INVALID_MAGIC_NUMBER

The magic number (file signature) was invalid.

ABCRYPT_ERROR_CODE_UNKNOWN_VERSION

The version was the unrecognized abcrypt version number.

ABCRYPT_ERROR_CODE_INVALID_ARGON2_PARAMS

The Argon2 parameters were invalid.

ABCRYPT_ERROR_CODE_INVALID_ARGON2_CONTEXT

The Argon2 context was invalid.

ABCRYPT_ERROR_CODE_INVALID_HEADER_MAC

The MAC (authentication tag) of the header was invalid.

ABCRYPT_ERROR_CODE_INVALID_MAC

The MAC (authentication tag) of the ciphertext was invalid.

VERSIONS

This type was added in version 0.1.0.

Copyright © 2022-2024 Shun Sakai

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

SEE ALSO

abcrypt_error_message(3), abcrypt_error_message_out_len(3)