sodium.php
2023-04-04 jj5 - these constants are for use with the Sodium module.
2023-04-04 jj5 - NOTE: these constants are constants and not configuration settings. If you need to override any of these, for instance to test the correct handling of error scenarios, please override the relevant get_const_*() accessor in the KickassCrypto class, don't edit these... please see the documentation in README.md for an explanation of these values.
Tags
Table of Contents
- KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_CURR = 'config invalid: CONFIG_SODIUM_SECRET_CURR.'
- 2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_CURR is defined for the round-trip use case and the Sodium module but it is not valid.
- KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_LIST = 'config invalid: CONFIG_SODIUM_SECRET_LIST.'
- 2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_LIST is defined for the at-rest use case and the Sodium module but it is not valid.
- KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_PREV = 'config invalid: CONFIG_SODIUM_SECRET_PREV.'
- 2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_PREV is defined for the round-trip use case and the Sodium module but it is not valid.
- KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_CURR = 'config missing: CONFIG_SODIUM_SECRET_CURR.'
- 2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_CURR is not defined for the round-trip use case and the Sodium module.
- KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_LIST = 'config missing: CONFIG_SODIUM_SECRET_LIST.'
- 2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_LIST is not defined for the at-rest use case and the Sodium module.
- KICKASS_CRYPTO_SODIUM_PASSPHRASE_LENGTH = \SODIUM_CRYPTO_SECRETBOX_KEYBYTES
- 2023-04-05 jj5 - this is the length of the passphrase (it's the $key parameter) expected by the sodium_crypto_secretbox() function.
Constants
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_CURR
2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_CURR is defined for the round-trip use case and the Sodium module but it is not valid.
public
string
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_CURR
= 'config invalid: CONFIG_SODIUM_SECRET_CURR.'
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_LIST
2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_LIST is defined for the at-rest use case and the Sodium module but it is not valid.
public
string
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_LIST
= 'config invalid: CONFIG_SODIUM_SECRET_LIST.'
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_PREV
2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_PREV is defined for the round-trip use case and the Sodium module but it is not valid.
public
string
KICKASS_CRYPTO_CONFIG_PROBLEM_INVALID_SODIUM_SECRET_PREV
= 'config invalid: CONFIG_SODIUM_SECRET_PREV.'
KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_CURR
2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_CURR is not defined for the round-trip use case and the Sodium module.
public
string
KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_CURR
= 'config missing: CONFIG_SODIUM_SECRET_CURR.'
KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_LIST
2023-04-05 jj5 - this happens when CONFIG_SODIUM_SECRET_LIST is not defined for the at-rest use case and the Sodium module.
public
string
KICKASS_CRYPTO_CONFIG_PROBLEM_MISSING_SODIUM_SECRET_LIST
= 'config missing: CONFIG_SODIUM_SECRET_LIST.'
KICKASS_CRYPTO_SODIUM_PASSPHRASE_LENGTH
2023-04-05 jj5 - this is the length of the passphrase (it's the $key parameter) expected by the sodium_crypto_secretbox() function.
public
int
KICKASS_CRYPTO_SODIUM_PASSPHRASE_LENGTH
= \SODIUM_CRYPTO_SECRETBOX_KEYBYTES