NAME
File::KDBX::Constants - All the KDBX-related constants you could ever want
VERSION
version 0.906
SYNOPSIS
use File::KDBX::Constants qw(:all);
say KDBX_VERSION_4_1;DESCRIPTION
This module provides importable constants related to KDBX. Constants can be imported individually or in groups (by tag). The available tags are:
:all- All of the above
View the source of this module to see the constant values (but really you shouldn't care).
FUNCTIONS
to_header_constant
$constant = to_header_constant($number);
$constant = to_header_constant($string);Get a header constant from an integer or string value.
to_compression_constant
$constant = to_compression_constant($number);
$constant = to_compression_constant($string);Get a compression constant from an integer or string value.
to_inner_header_constant
$constant = to_inner_header_constant($number);
$constant = to_inner_header_constant($string);Get an inner header constant from an integer or string value.
to_icon_constant
$constant = to_icon_constant($number);
$constant = to_icon_constant($string);Get an icon constant from an integer or string value.
CONSTANTS
:magic
Constants related to identifying the file types:
KDBX_SIG1KDBX_SIG1_FIRST_BYTEKDBX_SIG2_1KDBX_SIG2_2
:version
Constants related to identifying the format version of a file:
KDBX_VERSION_2_0KDBX_VERSION_3_0KDBX_VERSION_3_1KDBX_VERSION_4_0KDBX_VERSION_4_1KDBX_VERSION_OLDESTKDBX_VERSION_LATESTKDBX_VERSION_MAJOR_MASKKDBX_VERSION_MINOR_MASK
:header
Constants related to parsing and generating KDBX file headers:
HEADER_ENDHEADER_COMMENTHEADER_CIPHER_IDHEADER_COMPRESSION_FLAGSHEADER_MASTER_SEEDHEADER_TRANSFORM_SEEDHEADER_TRANSFORM_ROUNDSHEADER_ENCRYPTION_IVHEADER_INNER_RANDOM_STREAM_KEYHEADER_STREAM_START_BYTESHEADER_INNER_RANDOM_STREAM_IDHEADER_KDF_PARAMETERSHEADER_PUBLIC_CUSTOM_DATA
:compression
Constants related to identifying the compression state of a file:
COMPRESSION_NONECOMPRESSION_GZIP
:cipher
Constants related to ciphers:
CIPHER_UUID_AES128CIPHER_UUID_AES256CIPHER_UUID_CHACHA20CIPHER_UUID_SALSA20CIPHER_UUID_SERPENTCIPHER_UUID_TWOFISH
:random_stream
Constants related to memory protection stream ciphers:
STREAM_ID_RC4_VARIANT-
This is insecure and not implemented.
STREAM_ID_SALSA20STREAM_ID_CHACHA20STREAM_SALSA20_IV
:kdf
Constants related to key derivation functions and configuration:
KDF_UUID_AESKDF_UUID_AES_CHALLENGE_RESPONSE-
This is what KeePassXC calls
KDF_AES_KDBX4. KDF_UUID_ARGON2DKDF_UUID_ARGON2IDKDF_PARAM_UUIDKDF_PARAM_AES_ROUNDSKDF_PARAM_AES_SEEDKDF_PARAM_ARGON2_SALTKDF_PARAM_ARGON2_PARALLELISMKDF_PARAM_ARGON2_MEMORYKDF_PARAM_ARGON2_ITERATIONSKDF_PARAM_ARGON2_VERSIONKDF_PARAM_ARGON2_SECRETKDF_PARAM_ARGON2_ASSOCDATAKDF_DEFAULT_AES_ROUNDSKDF_DEFAULT_ARGON2_ITERATIONSKDF_DEFAULT_ARGON2_MEMORYKDF_DEFAULT_ARGON2_PARALLELISMKDF_DEFAULT_ARGON2_VERSION
:variant_map
Constants related to parsing and generating KDBX4 variant maps:
VMAP_VERSIONVMAP_VERSION_MAJOR_MASKVMAP_TYPE_ENDVMAP_TYPE_UINT32VMAP_TYPE_UINT64VMAP_TYPE_BOOLVMAP_TYPE_INT32VMAP_TYPE_INT64VMAP_TYPE_STRINGVMAP_TYPE_BYTEARRAY
:inner_header
Constants related to parsing and generating KDBX4 inner headers:
INNER_HEADER_ENDINNER_HEADER_INNER_RANDOM_STREAM_IDINNER_HEADER_INNER_RANDOM_STREAM_KEYINNER_HEADER_BINARYINNER_HEADER_BINARY_FLAG_PROTECT
:key_file
Constants related to identifying key file types:
KEY_FILE_TYPE_BINARYKEY_FILE_TYPE_HASHEDKEY_FILE_TYPE_HEXKEY_FILE_TYPE_XML
:history
Constants for history-related default values:
HISTORY_DEFAULT_MAX_AGEHISTORY_DEFAULT_MAX_ITEMSHISTORY_DEFAULT_MAX_SIZE
:iteration
Constants for searching algorithms.
ITERATION_IDS- Iterative deepening searchITERATION_BFS- Breadth-first searchITERATION_DFS- Depth-first search
:icon
Constants for default icons used by KeePass password safe implementations:
ICON_PASSWORDICON_PACKAGE_NETWORKICON_MESSAGEBOX_WARNINGICON_SERVERICON_KLIPPERICON_EDU_LANGUAGESICON_KCMDFICON_KATEICON_SOCKETICON_IDENTITYICON_KONTACTICON_CAMERAICON_IRKICKFLASHICON_KGPG_KEY3ICON_LAPTOP_POWERICON_SCANNERICON_MOZILLA_FIREBIRDICON_CDROM_UNMOUNTICON_DISPLAYICON_MAIL_GENERICICON_MISCICON_KORGANIZERICON_ASCIIICON_ICONSICON_CONNECT_ESTABLISHEDICON_FOLDER_MAILICON_FILESAVEICON_NFS_UNMOUNTICON_MESSAGEICON_KGPG_TERMICON_KONSOLEICON_FILEPRINTICON_FSVIEWICON_RUNICON_CONFIGUREICON_KRFBICON_ARKICON_KPERCENTAGEICON_SAMBA_UNMOUNTICON_HISTORYICON_MAIL_FINDICON_VECTORGFXICON_KCMMEMORYICON_TRASHCAN_FULLICON_KNOTESICON_CANCELICON_HELPICON_KPACKAGEICON_FOLDERICON_FOLDER_BLUE_OPENICON_FOLDER_TARICON_DECRYPTEDICON_ENCRYPTEDICON_APPLYICON_SIGNATUREICON_THUMBNAILICON_KADDRESSBOOKICON_VIEW_TEXTICON_KGPGICON_PACKAGE_DEVELOPMENTICON_KFM_HOMEICON_SERVICESICON_TUXICON_FEATHERICON_APPLEICON_WICON_MONEYICON_CERTIFICATEICON_SMARTPHONE
:bool
Boolean values:
FALSETRUE
:time
Constants related to time:
TIME_SECONDS_AD1_TO_UNIX_EPOCH
:yubikey
Constants related to working with YubiKeys:
YUBICO_VIDYUBIKEY_PIDNEO_OTP_PIDNEO_OTP_CCID_PIDNEO_CCID_PIDNEO_U2F_PIDNEO_OTP_U2F_PIDNEO_U2F_CCID_PIDNEO_OTP_U2F_CCID_PIDYK4_OTP_PIDYK4_U2F_PIDYK4_OTP_U2F_PIDYK4_CCID_PIDYK4_OTP_CCID_PIDYK4_U2F_CCID_PIDYK4_OTP_U2F_CCID_PIDPLUS_U2F_OTP_PIDONLYKEY_VIDONLYKEY_PIDYK_EUSBERRYK_EWRONGSIZYK_EWRITEERRYK_ETIMEOUTYK_ENOKEYYK_EFIRMWAREYK_ENOMEMYK_ENOSTATUSYK_ENOTYETIMPLYK_ECHECKSUMYK_EWOULDBLOCKYK_EINVALIDCMDYK_EMORETHANONEYK_ENODATACONFIG1_VALIDCONFIG2_VALIDCONFIG1_TOUCHCONFIG2_TOUCHCONFIG_LED_INVCONFIG_STATUS_MASK
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/chazmcgarvey/File-KDBX/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
Charles McGarvey <ccm@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2022 by Charles McGarvey.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.