Kickass Crypto

KickassOpenSsl extends KickassCrypto
in package

Application

Uses KICKASS_WRAPPER_PHP_OPENSSL

2023-04-05 jj5 - this is the base class for the OpenSSL crypto services.

$active : array<string|int, mixed>: 2023-04-07 jj5 - this map is for tracking active functions which are presently on the call stack; see the enter() and leave() functions to understand how this field is used.
$error_list : array<string|int, mixed>: 2023-03-29 jj5 - our list of errors is private, implementations can override the access interface methods defined below.
$inject_delay : bool: 2023-04-02 jj5 - this flag indicates whether we need to inject a random delay or not, it gets set when a call to either encrypt() or decrypt() is made. It gets set back to false after a delay has been injected so that multiple errors won't trigger multiple delays.
$openssl_error : string|null: 2023-03-30 jj5 - this is for tracking the first openssl error that occurs, if any.
$telemetry : array<string|int, mixed>: 2023-03-30 jj5 - our counters are stored here
__construct() : mixed: 2023-04-07 jj5 - the constructor will throw if the environment is invalid.
clear_error() : void: 2023-04-07 jj5 - clears the current errors, if any.
decrypt() : mixed: 2023-04-05 jj5 - decrypts the ciphertext and returns the deserialized value; returns false on failure.
delay() : void: 2023-04-05 jj5 - delays the process for a random amount of time between 1 millisecond and 10 seconds; this is used as a timing attack mitigation, it slows down attackers trying to brute force errors.
encrypt() : string|false: 2023-04-05 jj5 - encrypts the input and returns the ciphertext; returns false on failure.
GenerateSecret() : string: 2023-03-30 jj5 - this function will generate a secret key suitable for use in the config file.
get_error() : string|null: 2023-04-07 jj5 - gets the latest error as a string description or returns null if there's no error.
get_error_list() : array<string|int, mixed>: 2023-04-07 jj5 - gets the current list of errors, the list is empty if there are no errors, otherwise it contains strings which describe the errors that have occurred.
get_openssl_error() : string|null: 2023-04-07 jj5 - returns the earliest error message returned from the OpenSSL library or null if no error.
GetTelemetry() : array<string|int, mixed>: 2023-04-01 jj5 - NOTE: the telemetry might be considered sensitive data... but probably not so sensitive that it can't be logged. It's not at the same level as secrets or passphrases.
ReportCounters() : void: 2023-04-05 jj5 - this will report a list of counts to STDOUT.
ReportTelemetry() : void: 2023-04-05 jj5 - this function will print the telemetry data to STDOUT; it's suitable for use in a console.
convert_secret_to_passphrase() : string|false: 2023-04-07 jj5 - converts a secret key to a passphrase by applying the hashing function.
count_class() : int: 2023-04-05 jj5 - will increment a class count metric.
count_function() : int: 2023-04-05 jj5 - will increment a function count metric.
count_length() : int: 2023-04-05 jj5 - will increment a length count metric.
count_this() : int: 2023-04-05 jj5 - will count this instance.
data_decode() : mixed: 2023-04-07 jj5 - decodes the encoded data using the nominated encoding.
data_encode() : string|false: 2023-04-05 jj5 - serializes the data based on the data encoding in use; defers to a virtual do_data_encode() method.
decode_message() : string|false: 2023-04-05 jj5 - decodes a message; defers to virtual do_decode_message().
decrypt_string() : mixed: 2023-04-05 jj5 - decrypts a binary string using the passphrase.
do_clear_error() : void: 2023-04-07 jj5 - clears the error list and the OpenSSL error.
do_convert_secret_to_passphrase() : string|false: 2023-04-07 jj5 - the default implementation of the passphrase hashing logic.
do_count_class() : int: 2023-04-05 jj5 - by default will increment the count for this class metric; can be overridden by implementations.
do_count_function() : int: 2023-04-05 jj5 - by default will increment the counter for this function metric; can be overridden by implementations.
do_count_length() : int: 2023-04-05 jj5 - by default will increment the count for this length metric; can be overridden by implementations.
do_count_this() : int: 2023-04-07 jj5 - does the actual work of registering the telemetry for a new instance of this class.
do_data_decode() : mixed: 2023-04-07 jj5 - provides the default implementation for data decoding, which provides support for decoding one of JSON, PHPS, or text.
do_data_encode() : string|false: 2023-04-05 jj5 - by default serializes data based on the data encoding in use; can be overridden by implementations.
do_decode_message() : string: 2023-04-05 jj5 - by default will decode the message and determine the data encoding using; can be overridden by implementations.
do_decrypt() : mixed: 2023-04-05 jj5 - by default handles the standard decryption process; can be overridden by implementations.
do_decrypt_string() : string|false: 2023-04-07 jj5 - this does the actual work of decrypting a string by deferring to the OpenSSL library to do the heavy lifting; returns false on failure or the decrypted result otherwise.
do_delay() : mixed: 2023-04-05 jj5 - by default sleeps for a random amount of time between the minimum time given in nanoseconds and the maximum time also given in nanoseconds; can be overridden by implementations.
do_encrypt() : string|false: 2023-04-05 jj5 - by default encrypts the input value; can be overridden by implementations.
do_encrypt_string() : string|null: 2023-04-07 jj5 - this does the actual work of encrypting a string by deferring to the OpenSSL library to do the heavy lifting; returns false on failure or the encrypted result otherwise.
do_error() : bool: 2023-04-07 jj5 - does the actual work of registering an error; keeps the error list up to date but also keeps the OpenSSL error string up to date as well.
do_get_config_chunk_size() : int: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_CHUNK_SIZE constant or the default value if CONFIG_ENCRYPTION_CHUNK_SIZE is not defined; can be overridden by implementations.
do_get_config_chunk_size_max() : int: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_CHUNK_SIZE_MAX constant or the default value if CONFIG_ENCRYPTION_CHUNK_SIZE_MAX is not defined; can be overridden by implementations.
do_get_config_data_encoding() : string: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_DATA_ENCODING constant or the default value if CONFIG_ENCRYPTION_DATA_ENCODING is not defined; can be overridden by implementations.
do_get_config_data_length_max() : int: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_DATA_LENGTH_MAX constant or the default value if CONFIG_ENCRYPTION_DATA_LENGTH_MAX is not defined; can be overridden by implementations.
do_get_config_false_enable() : bool: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_FALSE_ENABLE constant of the default value if CONFIG_ENCRYPTION_FALSE_ENABLE is not defined; can be overridden by implementations.
do_get_config_json_decode_options() : int: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_JSON_DECODE_OPTIONS constant or the default value if CONFIG_ENCRYPTION_JSON_DECODE_OPTIONS is not defined; can be overridden by implementations.
do_get_config_json_encode_options() : int: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_JSON_ENCODE_OPTIONS constant or the default value if CONFIG_ENCRYPTION_JSON_ENCODE_OPTIONS is not defined; can be overridden by implementations.
do_get_config_phps_enable() : bool: 2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_PHPS_ENABLE constant or the default value if CONFIG_ENCRYPTION_PHPS_ENABLE is not defined; can be overridden by implementations.
do_get_const() : mixed: 2023-04-05 jj5 - by default returns the value of the constant, or returns the default value if the constant is not defined; can be overridden by implementations.
do_get_const_data_format() : string: 2023-04-07 jj5 - gets the data format to use for OpenSSL; the data format is a string like "KA0" which identifies the data format used by the encryption library so we can know what to do when we receive it, unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_DATA_FORMAT_OPENSSL.
do_get_const_key_hash() : string: 2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_KEY_HASH constant; can be overridden by implementations.
do_get_const_key_length_min() : int: 2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_KEY_LENGTH_MIN constant; can be overridden by implementations.
do_get_const_passphrase_length_min() : int: 2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_PASSPHRASE_LENGTH_MIN constant; can be overridden by implementations.
do_get_data_encoding() : string: 2023-04-05 jj5 - by default gets the data encoding from the config option as returned from get_config_data_encoding().
do_get_delay() : bool: 2023-04-07 jj5 - provides the default implementation of the delay calculations; can be overridden by implementations.
do_get_encryption_passphrase() : string|null: 2023-04-05 jj5 - by default returns the first passphrase from the passphrase list; can be overridden by implementations.
do_get_error() : string|null: 2023-04-07 jj5 - gets the most recent error as a string or returns null if there are no errors.
do_get_error_list() : array<string|int, mixed>: 2023-04-07 jj5 - returns the list of errors; errors are strings with a description of the problem, the list is empty if there are no errors.
do_get_padding() : string|false: 2023-04-07 jj5 - does the actual work of generating the random padding; can be overridden by implementations.
do_get_passphrase_list() : array<string|int, mixed>: 2023-04-05 jj5 - the list of passphrases; the passphrases are generated by using the secret key hashing function on the secret keys defined in the config file.
do_handle() : void: 2023-04-01 jj5 - implementations can decide what to do when errors are handled; by default we write a log entry; can be overridden by implementations.
do_ignore() : void: 2023-04-01 jj5 - implementations can decide what to do when errors are ignored; by default we write a log entry; can be overridden by implementations.
do_increment_counter() : int: 2023-04-05 jj5 - by default will increment the value for a key in an array; will initialize to zero if missing; can be overridden by implementations.
do_is_cli() : bool: 2023-04-05 jj5 - by default checks to see if php_sapi_name() === 'cli'; can be overridden by implementations.
do_is_debug() : bool: 2023-04-05 jj5 - by default checks to see if the DEBUG constant is defined and true; can be overridden by implementations.
do_is_valid_base64() : bool: 2023-04-05 jj5 - by default checks to make sure the input is a non-empty string and then validates it with the KICKASS_CRYPTO_REGEX_BASE64 regular expression; can be overridden by implementations.
do_is_valid_config() : bool: 2023-03-30 jj5 - implementations need to define what a valid configuration is.
do_is_valid_data_encoding() : bool: 2023-04-05 jj5 - by default checks that the data encoding is one of the two supported data encodings; can be overridden by implementations.
do_is_valid_passphrase() : bool: 2023-04-06 jj5 - by default checks the string length; can be overridden by implementations.
do_is_valid_secret() : bool: 2023-04-05 jj5 - my default checks that the secret key is a string and meets the minimum length requirements; this function can be overridden by implementations.
do_json_decode() : mixed: 2023-04-07 jj5 - does the actual work of JSON decoding by calling the PHP function via its wrapper.
do_json_encode() : mixed: 2023-04-05 jj5 - by default encodes the input as JSON using the JSON encoding options read from the config file; can be overridden by implementations.
do_log_error() : bool: 2023-04-07 jj5 - provides a default implementation for log writing; can be overridden by implementations.
do_message_decode() : string|false: 2023-04-07 jj5 - does the actual work of message decoding; can be overridden by implementations.
do_message_encode() : string|false: 2023-04-07 jj5 - does the actual work of message encoding; can be overridden by implementations.
do_notify() : void: 2023-04-01 jj5 - implementations can decide what to do when errors are notified; by default we write a log entry; can be overridden by implementations.
do_parse_binary() : bool: 2023-04-07 jj5 - does the actual work of splitting the concatenated binary data into its constituent initialization vector, ciphertext, and authentication tag.
do_php_base64_decode() : mixed
do_php_base64_encode() : mixed
do_php_json_decode() : mixed
do_php_json_encode() : mixed
do_php_json_last_error() : mixed
do_php_openssl_cipher_iv_length() : mixed
do_php_openssl_decrypt() : mixed
do_php_openssl_encrypt() : mixed
do_php_openssl_error_string() : mixed
do_php_openssl_get_cipher_methods() : mixed
do_php_random_bytes() : mixed
do_php_random_int() : mixed
do_php_sapi_name() : mixed
do_php_serialize() : mixed
do_php_strval() : mixed
do_php_time_nanosleep() : mixed
do_php_unserialize() : mixed
do_phps_decode() : mixed: 2023-04-07 jj5 - does the actual work of PHP deserialization by deferring to the implementation on the PHP wrapper.
do_phps_encode() : string|false: 2023-04-07 jj5 - does the actual work of PHP serialization; can be overridden by implementers; by default calls the PHP serialize() function via its wrapper.
do_report_emergency_delay() : void: 2023-04-05 jj5 - by default writes a message to the error log; can be overridden by implementations.
do_text_decode() : mixed: 2023-04-07 jj5 - does the actual work of text deserialization by deferring to the implementation on the PHP wrapper.
do_text_encode() : string|false: 2023-04-07 jj5 - does the actual work of text serialization; can be overridden by implementers; by default calls the PHP strval() function via its wrapper.
do_throw() : mixed: 2023-04-05 jj5 - by default this finds the message for the given exception code and then throws an exception with the relevant code and message; can be overridden by implementations.
emergency_delay() : void: 2023-04-05 jj5 - does an emergency delay; this doesn't give the caller any option to interfere so the emergency delay should run reliably if it's necessary.
encrypt_string() : string|false: 2023-04-05 jj5 - encrypts a plaintext string using the passphrase; defers to do_encrypt_string().
enter() : void: 2023-04-07 jj5 - registers when a function gets called so as to track the depth of a function on the call stack.
error() : bool: 2023-04-05 jj5 - registers an error; if this is the first error a random delay is injected as a timing attack mitigation.
get_config_chunk_size() : int: 2023-04-05 jj5 - gets the chunk size, it's used for padding encrypted messages.
get_config_chunk_size_max() : int: 2023-04-05 jj5 - gets the maximum chunk size, it's used for validating the chunk size.
get_config_data_encoding() : string: 2023-04-05 jj5 - gets the data encoding.
get_config_data_length_max() : int: 2023-04-05 jj5 - gets the maximum supported data length, it's used for validating the encoded data.
get_config_false_enable() : bool: 2023-04-05 jj5 - gets a boolean value indicating whether the boolean value false can be encrypted or not.
get_config_json_decode_options() : int: 2023-04-05 jj5 - gets the JSON decoding options which will be passed to the PHP json_decode() function.
get_config_json_encode_options() : int: 2023-04-05 jj5 - gets the JSON encoding options which will be passed to the PHP json_encode() function.
get_config_phps_enable() : bool: 2023-04-05 jj5 - gets a boolean value indicating whether PHPS serialization and deserialization is enabled or not.
get_config_secret_curr() : string|false: 2023-04-07 jj5 - gets the current secret key to use for encryption, and the first key to try for decryption; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_CURR which should always be defined in a config file; this secret key is required by the round-trip use case and not relevant to the at-rest use case.
get_config_secret_list() : array<string|int, mixed>: 2023-04-07 jj5 - gets an array of strings containing secret keys to use for the at-rest use case; this list is not relevant to the round-trip use case; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_LIST which should be defined in the config file if you're using the library support for the OpenSSL at-rest use case.
get_config_secret_prev() : string|false: 2023-04-07 jj5 - gets an optional extra secret key, known as the previous secret key, to try when decrypting input data; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_PREV which can optionally be defined in the config file; this secret key is optional in the round-trip use case and not relevant to the at-rest use case.
get_const() : mixed: 2023-04-05 jj5 - gets a constant value, or returns the default value if the constant is not defined.
get_const_data_format() : string: 2023-04-05 jj5 - gets the data format constant; defers to abstract method for implementation.
get_const_key_hash() : string: 2023-04-05 jj5 - gets the name of the hashing algorithm to use for secret key hashing.
get_const_key_length_min() : int: 2023-04-05 jj5 - gets the minimum length of a secret key.
get_const_openssl_cipher() : string: 2023-04-07 jj5 - gets the OpenSSL cipher algorithm to use with the the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_CIPHER.
get_const_openssl_iv_length() : int: 2023-04-07 jj5 - gets the length of the initialization vector expected by the cipher used with the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_IV_LENGTH.
get_const_openssl_options() : int: 2023-04-07 jj5 - gets the options to use when calling the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_OPTIONS.
get_const_openssl_tag_length() : int: 2023-04-07 jj5 - gets the tag length expected by the cipher used with the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_TAG_LENGTH.
get_const_passphrase_length() : int: 2023-04-07 jj5 - gets the length of a valid passphrase; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_PASSPHRASE_LENGTH.
get_const_passphrase_length_min() : int: 2023-04-05 jj5 - gets the minimum length of a passphrase.
get_data_encoding() : string: 2023-04-05 jj5 - gets the data encoding; defers to virtual do_get_data_encoding().
get_data_format() : string|false: 2023-04-07 jj5 - gets the data format; the data format can be "KA0" for OpenSSL implementations and "KAS0" for Sodium implementations; if not the official implementation then the string 'X' is prepended to the data format.
get_delay() : bool: 2023-04-07 jj5 - calculates the seconds and extra nanoseconds which will be needed by the delay implementation; this function defers to do_get_delay() which can be overridden by implementations.
get_encryption_passphrase() : string: 2023-04-05 jj5 - returns the passphrase to use for encryption or null if it's missing.
get_padding() : string|false: 2023-04-07 jj5 - gets the string to use as padding; it's usually just a string of random bytes.
get_passphrase_list() : array<string|int, mixed>: 2023-04-05 jj5 - returns the list of passphrases; defers to abstract implementation.
handle() : void: 2023-04-01 jj5 - the point of handle() is simply to notify that an exception has been caught and "handled"; sometimes "handling" the exception is tantamount to ignoring it, so we call this method that we may make some noise about it (during debugging, usually). See do_handle() for the rest of the story.
ignore() : void: 2023-04-06 jj5 - the point of ignore() is simply to notify that an exception has been caught and it will be ignored.
increment_counter() : int: 2023-04-05 jj5 - will increment the value for a key in an array; will initialize to zero if missing.
is_cli() : bool: 2023-04-05 jj5 - reports if the program is running from the command-line.
is_debug() : bool: 2023-04-05 jj5 - checks to see if the program is running in DEBUG mode.
is_valid_base64() : bool: 2023-04-05 jj5 - checks the input is in valid base64 format; defers to virtual do_is_valid_base64().
is_valid_config() : bool: 2023-04-05 jj5 - checks to see if the environment configuration is valid; this function defers to the abstract method do_is_valid_config().
is_valid_data_encoding() : bool: 2023-04-05 jj5 - checks to see if the data encoding is a valid supported encoding; defers to the virtual do_is_valid_encoding() method.
is_valid_data_format() : bool: 2023-04-05 jj5 - checks to see if the data format is valid; this behavior cannot be overridden by implementations.
is_valid_passphrase() : bool: 2023-04-06 jj5 - checks to see if a passphrase is valid; this function defers to do_is_valid_passphrase();
is_valid_secret() : bool: 2023-04-05 jj5 - checks to see if a secret is valid; this function defers to do_is_valid_secret();
json_decode() : mixed: 2023-04-07 jj5 - deserialized JSON data.
json_encode() : string|false: 2023-04-05 jj5 - encodes a valud as JSON; defers to do_json_encode() for implementation.
leave() : mixed: 2023-04-07 jj5 - registers when a runction returns so as to track the depth of a function on the call stack.
log_error() : bool: 2023-04-07 jj5 - logs an error.
message_decode() : string|false: 2023-04-07 jj5 - decodes a message into binary.
message_encode() : string|false: 2023-04-07 jj5 - encodes a message.
notify() : void: 2023-04-01 jj5 - the point of notify() is simply to notify that an exception has been caught but it's going to be rethrown; it's best if this function doesn't throw an exception but it shouldn't be a huge problem if it does, the caller will throw when this function returns anyway.
parse_binary() : bool: 2023-04-05 jj5 - parses the binary message into its fixed length components.
php_base64_decode() : mixed
php_base64_encode() : mixed
php_json_decode() : mixed
php_json_encode() : mixed
php_json_last_error() : mixed
php_openssl_cipher_iv_length() : mixed
php_openssl_decrypt() : mixed
php_openssl_encrypt() : mixed
php_openssl_error_string() : mixed
php_openssl_get_cipher_methods() : mixed
php_random_bytes() : mixed
php_random_int() : mixed
php_sapi_name() : mixed
php_serialize() : mixed
php_strval() : mixed
php_time_nanosleep() : mixed
php_unserialize() : mixed
phps_decode() : mixed: 2023-04-07 jj5 - deserializes the input data using the PHP unserialize() function.
phps_encode() : string|false: 2023-04-05 jj5 - serializes a value using PHP serialization; defers to virtual method do_phps_encode() for implementation.
text_decode() : mixed: 2023-04-07 jj5 - deserializes the input data using the PHP strval() function.
text_encode() : string|false: 2023-04-05 jj5 - serializes a value as text; defers to virtual method do_text_encode() for implementation.
throw() : void: 2023-04-05 jj5 - this function throws an exception.
try_decrypt() : mixed: 2023-04-05 jj5 - tries to decrypt a binary string using the passphrase.
write_log() : bool: 2023-04-07 jj5 - provides our internal direct implementation of log writing, in case we need to use it ourselves without potential interference from inheritors of our class.
increment_counter_internal() : mixed: 2023-04-07 jj5 - this is our private implementation for incrementing a counter for a key, we use it in enter().
report_emergency_delay() : void: 2023-04-05 jj5 - this function makes some noice is the emergency delay is invoked; the emergency delay should not usually be activated so if it is we want to give ourself our best chance of finding out about it.

$active

2023-04-07 jj5 - this map is for tracking active functions which are presently on the call stack; see the enter() and leave() functions to understand how this field is used.


    private
        array<string|int, mixed>
    $active
     = []

keys are strings containing function names and values are a count of the number of instances of the function that are presently on the call stack.

$error_list

2023-03-29 jj5 - our list of errors is private, implementations can override the access interface methods defined below.


    private
        array<string|int, mixed>
    $error_list
     = []

$inject_delay

2023-04-02 jj5 - this flag indicates whether we need to inject a random delay or not, it gets set when a call to either encrypt() or decrypt() is made. It gets set back to false after a delay has been injected so that multiple errors won't trigger multiple delays.


    private
        bool
    $inject_delay
     = false

$openssl_error

2023-03-30 jj5 - this is for tracking the first openssl error that occurs, if any.


    private
        string|null
    $openssl_error
     = null

$telemetry

2023-03-30 jj5 - our counters are stored here


    private
    static    array<string|int, mixed>
    $telemetry
     = ['function' => [], 'class' => [], 'length' => []]

count_function() will increment the 'function' counter
count_class() will increment the 'class' counter
count_length() will increment the 'length' counter

2023-04-02 jj5 - the function counters count how many times some key functions were called.

2023-04-02 jj5 - the class counters count how many times certain classes were constructed.

2023-04-02 jj5 - the length counter counts the lengths of successfully encrypted data that occur, these should group due to chunking.

__construct()

2023-04-07 jj5 - the constructor will throw if the environment is invalid.


    public
                    __construct() : mixed

Return values

mixed —

clear_error()

2023-04-07 jj5 - clears the current errors, if any.


    public
        final            clear_error() : void

Return values

void —

decrypt()

2023-04-05 jj5 - decrypts the ciphertext and returns the deserialized value; returns false on failure.


    public
        final            decrypt(string $ciphertext) : mixed

Parameters

$ciphertext : string: the ciphertext previously returned from the encrypt() method.

Return values

mixed —

the decrypted and deserialized value, or false on failure.

delay()

2023-04-05 jj5 - delays the process for a random amount of time between 1 millisecond and 10 seconds; this is used as a timing attack mitigation, it slows down attackers trying to brute force errors.


    public
        final            delay() : void

Return values

void —

encrypt()

2023-04-05 jj5 - encrypts the input and returns the ciphertext; returns false on failure.


    public
        final            encrypt(mixed $input) : string|false

Parameters

$input : mixed: the complex value you want encrypted.

Return values

string|false —

the ciphertext on success, or false on failure.

GenerateSecret()

2023-03-30 jj5 - this function will generate a secret key suitable for use in the config file.


    public
            static        GenerateSecret() : string

Return values

string —

an 88 character ASCII string for use as a secret key.

get_error()

2023-04-07 jj5 - gets the latest error as a string description or returns null if there's no error.


    public
        final            get_error() : string|null

Return values

string|null —

the error description or null if no error.

get_error_list()

2023-04-07 jj5 - gets the current list of errors, the list is empty if there are no errors, otherwise it contains strings which describe the errors that have occurred.


    public
        final            get_error_list() : array<string|int, mixed>

Return values

array<string|int, mixed> —

an array of strings, can be empty.

get_openssl_error()

2023-04-07 jj5 - returns the earliest error message returned from the OpenSSL library or null if no error.


    public
        final            get_openssl_error() : string|null

Return values

string|null —

the error from the OpenSSL library or null if no error.

GetTelemetry()

2023-04-01 jj5 - NOTE: the telemetry might be considered sensitive data... but probably not so sensitive that it can't be logged. It's not at the same level as secrets or passphrases.


    public
            static        GetTelemetry() : array<string|int, mixed>

2023-04-05 jj5 - the telemetry map will contain counters for the following:

function: the functions which have been called and how many times.
class: the classes which have been created and how many times.
length: the encrypted data lengths which have been generated and how many times.

Return values

array<string|int, mixed> —

the telemetry map.

ReportCounters()

2023-04-05 jj5 - this will report a list of counts to STDOUT.


    public
            static        ReportCounters(array<string|int, mixed> $table) : void

Parameters

$table : array<string|int, mixed>: a key-value list; keys are strings, values are integers.

Return values

void —

ReportTelemetry()

2023-04-05 jj5 - this function will print the telemetry data to STDOUT; it's suitable for use in a console.


    public
            static        ReportTelemetry() : void

Return values

void —

convert_secret_to_passphrase()

2023-04-07 jj5 - converts a secret key to a passphrase by applying the hashing function.


    protected
        final            convert_secret_to_passphrase(string $key) : string|false

Parameters

$key : string: the secret key to convert

Return values

string|false —

the generated passphrase or false on failure.

count_class()

2023-04-05 jj5 - will increment a class count metric.


    protected
        final            count_class(string $class) : int

Parameters

$class : string: the name of the class.

Return values

int —

the current count for the class.

count_function()

2023-04-05 jj5 - will increment a function count metric.


    protected
        final            count_function(string $function) : int

Parameters

$function : string: the name of the function.

Return values

int —

the current count for this function.

count_length()

2023-04-05 jj5 - will increment a length count metric.


    protected
        final            count_length(int $length) : int

Parameters

$length : int: the length of the encrypted data.

Return values

int —

the current count for the length.

count_this()

2023-04-05 jj5 - will count this instance.


    protected
        final            count_this(string $caller) : int

Parameters

$caller : string: the name of the invoking function.

Return values

int —

the count of instances made for this class.

data_decode()

2023-04-07 jj5 - decodes the encoded data using the nominated encoding.


    protected
        final            data_decode(string $encoded_data[, string $data_encoding = KICKASS_CRYPTO_DATA_ENCODING_JSON ][, bool &$is_false = null ]) : mixed

Parameters

$encoded_data : string: the serialized data.
$data_encoding : string = KICKASS_CRYPTO_DATA_ENCODING_JSON: the data encoding to use, can be JSON, PHPS, or text.
$is_false : bool = null: set to true if the encoded data is deserialized to the boolean value false.

Return values

mixed —

returns the decoded data (can be pretty much anything) or false on error; false can also be a valid return value, if it is then $is_false will be set.

data_encode()

2023-04-05 jj5 - serializes the data based on the data encoding in use; defers to a virtual do_data_encode() method.


    protected
        final            data_encode(mixed $data, string $data_encoding) : string|false

Parameters

$data : mixed: input data, can be pretty much anything.
$data_encoding : string: the data encoding to use, usually either KICKASS_CRYPTO_DATA_ENCODING_JSON for JSON encoding, KICKASS_CRYPTO_DATA_ENCODING_PHPS for PHP serialization (if it's enabled), or KICKASS_CRYPTO_DATA_ENCODING_TEXT.

Return values

string|false —

the encoded string on success or false on failure.

decode_message()

2023-04-05 jj5 - decodes a message; defers to virtual do_decode_message().


    protected
        final            decode_message(string $message, string &$data_encoding) : string|false

Parameters

$message : string: the encoded message.
$data_encoding : string: a reference to the data encoding nominated in the message.

Return values

string|false —

the decoded message or false on failure.

decrypt_string()

2023-04-05 jj5 - decrypts a binary string using the passphrase.


    protected
        final            decrypt_string(string $binary, string $passphrase) : mixed

Parameters

$binary : string: the binary data to decrypt.
$passphrase : string: the passphrase to use for decryption.

Return values

mixed —

the decrypted string or false on error.

do_clear_error()

2023-04-07 jj5 - clears the error list and the OpenSSL error.


    protected
                    do_clear_error() : void

Return values

void —

do_convert_secret_to_passphrase()

2023-04-07 jj5 - the default implementation of the passphrase hashing logic.


    protected
                    do_convert_secret_to_passphrase(string $key) : string|false

Parameters

$key : string: the secret key to hash.

Return values

string|false —

the hashed string to use as the passphraser or false on error.

do_count_class()

2023-04-05 jj5 - by default will increment the count for this class metric; can be overridden by implementations.


    protected
                    do_count_class(string $class) : int

Parameters

$class : string: the name of the class.

Return values

int —

the current count for the class.

do_count_function()

2023-04-05 jj5 - by default will increment the counter for this function metric; can be overridden by implementations.


    protected
                    do_count_function(string $function) : int

Parameters

$function : string: the name of the function.

Return values

int —

the current count for the function.

do_count_length()

2023-04-05 jj5 - by default will increment the count for this length metric; can be overridden by implementations.


    protected
                    do_count_length(int $length) : int

Parameters

$length : int: the length of the encrypted data.

Return values

int —

the current count for the length.

do_count_this()

2023-04-07 jj5 - does the actual work of registering the telemetry for a new instance of this class.


    protected
                    do_count_this(string $caller) : int

Parameters

$caller : string: should be the name of the constructor, being '__construct'.

Return values

int —

the current count of instances created for this class.

do_data_decode()

2023-04-07 jj5 - provides the default implementation for data decoding, which provides support for decoding one of JSON, PHPS, or text.


    protected
                    do_data_decode(string $encoded_data, string $data_encoding, bool &$is_false) : mixed

Parameters

$encoded_data : string: the serialized data.
$data_encoding : string: the data encoding to use, can be JSON, PHPS, or text.
$is_false : bool: set to true if the deserialized value is the boolean value false.

Return values

mixed —

can return pretty much anything, will return false on error, but false can also be a valid return value.

do_data_encode()

2023-04-05 jj5 - by default serializes data based on the data encoding in use; can be overridden by implementations.


    protected
                    do_data_encode(mixed $data, string $data_encoding) : string|false

Parameters

$data : mixed: input data, can be pretty much anything.
$data_encoding : string: the data encoding to use, usually either KICKASS_CRYPTO_DATA_ENCODING_JSON for JSON encoding or KICKASS_CRYPTO_DATA_ENCODING_PHPS for PHP serialization (if it's enabled), or KICKASS_CRYPTO_DATA_ENCODING_TEXT.

Return values

string|false —

the encoded string on success or false on failure.

do_decode_message()

2023-04-05 jj5 - by default will decode the message and determine the data encoding using; can be overridden by implementations.


    protected
                    do_decode_message(string $message, string &$data_encoding) : string

Parameters

$message : string: the message to decode.
$data_encoding : string: a reference to the data encoding extracted from the message.

Return values

string —

the decoded string or false on error.

do_decrypt()

2023-04-05 jj5 - by default handles the standard decryption process; can be overridden by implementations.


    protected
                    do_decrypt(string $ciphertext) : mixed

Parameters

$ciphertext : string: the ciphertext to decrypt.

Return values

mixed —

the decrypted and deserialized value on success, false otherwise.

do_decrypt_string()

2023-04-07 jj5 - this does the actual work of decrypting a string by deferring to the OpenSSL library to do the heavy lifting; returns false on failure or the decrypted result otherwise.


    protected
                    do_decrypt_string(string $binary, string $passphrase) : string|false

Parameters

$binary : string: the ciphertext to decrypt.
$passphrase : string: the passphrase to use for decryption.

Return values

string|false —

returns the decrypted string on success or false on failure.

do_delay()

2023-04-05 jj5 - by default sleeps for a random amount of time between the minimum time given in nanoseconds and the maximum time also given in nanoseconds; can be overridden by implementations.


    protected
                    do_delay(int $ns_min, int $ns_max) : mixed

Parameters

$ns_min : int: minimum delay in nanoseconds.
$ns_max : int: maximum delay in nanoseconds.

Return values

mixed —

do_encrypt()

2023-04-05 jj5 - by default encrypts the input value; can be overridden by implementations.


    protected
                    do_encrypt(mixed $input) : string|false

Parameters

$input : mixed: the value to encrypt.

Return values

string|false —

the ciphertext or false on failure.

do_encrypt_string()

2023-04-07 jj5 - this does the actual work of encrypting a string by deferring to the OpenSSL library to do the heavy lifting; returns false on failure or the encrypted result otherwise.


    protected
                    do_encrypt_string(string $plaintext, string $passphrase) : string|null

Parameters

$plaintext : string: the string to encrypt.
$passphrase : string: the passphrase to use.

Return values

string|null —

the encrypted data on success or false on error.

do_error()

2023-04-07 jj5 - does the actual work of registering an error; keeps the error list up to date but also keeps the OpenSSL error string up to date as well.


    protected
                    do_error(string $error) : bool

Parameters

$error : string: the error string to register.

Return values

bool —

this function always returns the value false.

do_get_config_chunk_size()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_CHUNK_SIZE constant or the default value if CONFIG_ENCRYPTION_CHUNK_SIZE is not defined; can be overridden by implementations.


    protected
                    do_get_config_chunk_size(int $default) : int

Parameters

$default : int: the default chunk size.

Return values

int —

the chunk size.

do_get_config_chunk_size_max()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_CHUNK_SIZE_MAX constant or the default value if CONFIG_ENCRYPTION_CHUNK_SIZE_MAX is not defined; can be overridden by implementations.


    protected
                    do_get_config_chunk_size_max(int $default) : int

Parameters

$default : int: the default maximum chunk size.

Return values

int —

the maximum chunk size.

do_get_config_data_encoding()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_DATA_ENCODING constant or the default value if CONFIG_ENCRYPTION_DATA_ENCODING is not defined; can be overridden by implementations.


    protected
                    do_get_config_data_encoding(string $default) : string

Parameters

$default : string: the default data format.

Return values

string —

the data format.

do_get_config_data_length_max()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_DATA_LENGTH_MAX constant or the default value if CONFIG_ENCRYPTION_DATA_LENGTH_MAX is not defined; can be overridden by implementations.


    protected
                    do_get_config_data_length_max(int $default) : int

Parameters

$default : int: the default maximum data length.

Return values

int —

the maximum data length.

do_get_config_false_enable()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_FALSE_ENABLE constant of the default value if CONFIG_ENCRYPTION_FALSE_ENABLE is not defined; can be overridden by implementations.


    protected
                    do_get_config_false_enable(bool $default) : bool

Parameters

$default : bool: the value to use if the config option is not defined.

Return values

bool —

true if the boolean value false can be encrypted, false otherwise.

do_get_config_json_decode_options()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_JSON_DECODE_OPTIONS constant or the default value if CONFIG_ENCRYPTION_JSON_DECODE_OPTIONS is not defined; can be overridden by implementations.


    protected
                    do_get_config_json_decode_options(int $default) : int

Parameters

$default : int: the value to use if the config option is not defined.

Return values

int —

the JSON decoding options.

do_get_config_json_encode_options()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_JSON_ENCODE_OPTIONS constant or the default value if CONFIG_ENCRYPTION_JSON_ENCODE_OPTIONS is not defined; can be overridden by implementations.


    protected
                    do_get_config_json_encode_options(int $default) : int

Parameters

$default : int: the default JSON encoding options.

Return values

int —

the JSON encoding options.

do_get_config_phps_enable()

2023-04-05 jj5 - by default returns the value of the CONFIG_ENCRYPTION_PHPS_ENABLE constant or the default value if CONFIG_ENCRYPTION_PHPS_ENABLE is not defined; can be overridden by implementations.


    protected
                    do_get_config_phps_enable(bool $default) : bool

Parameters

$default : bool: the value to use if the config option is not defined.

Return values

bool —

true if PHPS serialization and deserialization is enabled, false otherwise.

do_get_const()

2023-04-05 jj5 - by default returns the value of the constant, or returns the default value if the constant is not defined; can be overridden by implementations.


    protected
                    do_get_const(string $const, mixed $default) : mixed

Parameters

$const : string: the name of the constant.
$default : mixed: the value to return if the constant is not defined.

Return values

mixed —

the value of the constant or the default value if the constant is not defined.

do_get_const_data_format()

2023-04-07 jj5 - gets the data format to use for OpenSSL; the data format is a string like "KA0" which identifies the data format used by the encryption library so we can know what to do when we receive it, unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_DATA_FORMAT_OPENSSL.


    protected
                    do_get_const_data_format() : string

Return values

string —

the data format string

do_get_const_key_hash()

2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_KEY_HASH constant; can be overridden by implementations.


    protected
                    do_get_const_key_hash() : string

Return values

string —

the name of the hash algorithm.

do_get_const_key_length_min()

2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_KEY_LENGTH_MIN constant; can be overridden by implementations.


    protected
                    do_get_const_key_length_min() : int

Return values

int —

the minimum length of a secret key.

do_get_const_passphrase_length_min()

2023-04-05 jj5 - by default returns the value of the KICKASS_CRYPTO_PASSPHRASE_LENGTH_MIN constant; can be overridden by implementations.


    protected
                    do_get_const_passphrase_length_min() : int

Return values

int —

the minimum length of a passphrase.

do_get_data_encoding()

2023-04-05 jj5 - by default gets the data encoding from the config option as returned from get_config_data_encoding().


    protected
                    do_get_data_encoding() : string

Return values

string —

the data encoding.

do_get_delay()

2023-04-07 jj5 - provides the default implementation of the delay calculations; can be overridden by implementations.


    protected
                    do_get_delay(int $ns_min, int $ns_max, int &$seconds, int &$nanoseconds) : bool

Parameters

$ns_min : int: the total number of nanoseconds, minimum.
$ns_max : int: the total number of nanoseconds, maximum.
$seconds : int: the number of whole seconds to delay.
$nanoseconds : int: the extra number of nanoseconds to delay beyond the number of seconds.

Return values

bool —

true on success or false on failure.

do_get_encryption_passphrase()

2023-04-05 jj5 - by default returns the first passphrase from the passphrase list; can be overridden by implementations.


    protected
                    do_get_encryption_passphrase() : string|null

Return values

string|null —

the passphrase or null if none.

do_get_error()

2023-04-07 jj5 - gets the most recent error as a string or returns null if there are no errors.


    protected
                    do_get_error() : string|null

Return values

string|null —

the error description or null if no error.

do_get_error_list()

2023-04-07 jj5 - returns the list of errors; errors are strings with a description of the problem, the list is empty if there are no errors.


    protected
                    do_get_error_list() : array<string|int, mixed>

Return values

array<string|int, mixed> —

an array of strings containing error descriptions, the list is empty if there are no errors.

do_get_padding()

2023-04-07 jj5 - does the actual work of generating the random padding; can be overridden by implementations.


    protected
                    do_get_padding(int $length) : string|false

Parameters

$length : int: the length of the padding to generate.

Return values

string|false —

the padding on success or false on failure.

do_get_passphrase_list()

2023-04-05 jj5 - the list of passphrases; the passphrases are generated by using the secret key hashing function on the secret keys defined in the config file.


    protected
    abstract                do_get_passphrase_list() : array<string|int, mixed>

Return values

array<string|int, mixed> —

do_handle()

2023-04-01 jj5 - implementations can decide what to do when errors are handled; by default we write a log entry; can be overridden by implementations.


    protected
                    do_handle(Throwable $ex, string $file, int $line, string $function) : void

Parameters

$ex : Throwable: the exception which was caught.
$file : string: the path to the file that caught the exception.
$line : int: the line in the file where the caught exception was reported.
$function : string: the function in which the exception was caught.

Return values

void —

do_ignore()

2023-04-01 jj5 - implementations can decide what to do when errors are ignored; by default we write a log entry; can be overridden by implementations.


    protected
                    do_ignore(Throwable $ex, string $file, int $line, string $function) : void

Parameters

$ex : Throwable: the exception which was caught and will be ignored.
$file : string: the path to the file that caught the exception.
$line : int: the line in the file where the caught exception was reported.
$function : string: the function in which the exception was caught.

Return values

void —

do_increment_counter()

2023-04-05 jj5 - by default will increment the value for a key in an array; will initialize to zero if missing; can be overridden by implementations.


    protected
                    do_increment_counter(array<string|int, mixed> &$array, string|int $key) : int

Parameters

$array : array<string|int, mixed>: a reference to the array to operate on.
$key : string|int: the key to operate on.

Return values

int —

the current count.

do_is_cli()

2023-04-05 jj5 - by default checks to see if php_sapi_name() === 'cli'; can be overridden by implementations.


    protected
                    do_is_cli() : bool

Return values

bool —

true if running from the command-line, false otherwise.

do_is_debug()

2023-04-05 jj5 - by default checks to see if the DEBUG constant is defined and true; can be overridden by implementations.


    protected
                    do_is_debug() : bool

Return values

bool —

true if running in DEBUG mode, false otherwise.

do_is_valid_base64()

2023-04-05 jj5 - by default checks to make sure the input is a non-empty string and then validates it with the KICKASS_CRYPTO_REGEX_BASE64 regular expression; can be overridden by implementations.


    protected
                    do_is_valid_base64(string $input) : bool

Parameters

$input : string: supposedly base64 encoded value.

Return values

bool —

true if value is in valid base64 format, false otherwise.

do_is_valid_config()

2023-03-30 jj5 - implementations need to define what a valid configuration is.


    protected
    abstract                do_is_valid_config(string|null &$problem) : bool

Parameters

$problem : string|null: a description of the problem if invalid, null otherwisej.

Return values

bool —

do_is_valid_data_encoding()

2023-04-05 jj5 - by default checks that the data encoding is one of the two supported data encodings; can be overridden by implementations.


    protected
                    do_is_valid_data_encoding(string $data_encoding) : bool

2023-04-05 jj5 - the two supported data encodings are:

KICKASS_CRYPTO_DATA_ENCODING_JSON
KICKASS_CRYPTO_DATA_ENCODING_PHPS
KICKASS_CRYPTO_DATA_ENCODING_TEXT

Note that the PHPS data encoding is only a valid and supported data encoding if get_config_phps_enable() is true.

Parameters

$data_encoding : string: the data encoding.

Return values

bool —

true if the data encoding is a valid supported value, false otherwise.

do_is_valid_passphrase()

2023-04-06 jj5 - by default checks the string length; can be overridden by implementations.


    protected
                    do_is_valid_passphrase(mixed $passphrase) : bool

Parameters

$passphrase : mixed: a passphrase to validate.

Return values

bool —

true on valid; false otherwise.

do_is_valid_secret()

2023-04-05 jj5 - my default checks that the secret key is a string and meets the minimum length requirements; this function can be overridden by implementations.


    protected
                    do_is_valid_secret(string $secret) : bool

Parameters

$secret : string: the secret key

Return values

bool —

true if the secret is valid, false otherwise.

do_json_decode()

2023-04-07 jj5 - does the actual work of JSON decoding by calling the PHP function via its wrapper.


    protected
                    do_json_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the JSON to decode.
$is_false : bool: set to true if the JSON decodes to the boolean value false.

Return values

mixed —

returns the decoded value on success or the value false on failure.

do_json_encode()

2023-04-05 jj5 - by default encodes the input as JSON using the JSON encoding options read from the config file; can be overridden by implementations.


    protected
                    do_json_encode(string $input) : mixed

Parameters

$input : string: JSON input.

Return values

mixed —

returns the decoded JSON value or false on failure.

do_log_error()

2023-04-07 jj5 - provides a default implementation for log writing; can be overridden by implementations.


    protected
                    do_log_error(string $message, string $file, int $line, string $function) : bool

Parameters

$message : string: the message to log.
$file : string: the path of the file writing the log entry.
$line : int: the line in the file writing the log entry.
$function : string: the name of the function writing the log entry.

Return values

bool —

true on success or false on failure.

do_message_decode()

2023-04-07 jj5 - does the actual work of message decoding; can be overridden by implementations.


    protected
                    do_message_decode(string $encoded) : string|false

Parameters

$encoded : string: the encoded message.

Return values

string|false —

the decoded message or false on failure.

do_message_encode()

2023-04-07 jj5 - does the actual work of message encoding; can be overridden by implementations.


    protected
                    do_message_encode(string $binary) : string|false

Parameters

$binary : string: the binary data to encode.

Return values

string|false —

the encoded string on success or false on failure.

do_notify()

2023-04-01 jj5 - implementations can decide what to do when errors are notified; by default we write a log entry; can be overridden by implementations.


    protected
                    do_notify(Throwable $ex, string $file, int $line, string $function) : void

Parameters

$ex : Throwable: the exception which was caught and will be rethrown.
$file : string: the path to the file that caught the exception.
$line : int: the line in the file where the caught exception was reported.
$function : string: the function in which the exception was caught.

Return values

void —

do_parse_binary()

2023-04-07 jj5 - does the actual work of splitting the concatenated binary data into its constituent initialization vector, ciphertext, and authentication tag.


    protected
                    do_parse_binary(string $binary, string &$iv, string &$ciphertext, string &$tag) : bool

Parameters

$binary : string: the binary data to extract the pieces from.
$iv : string: the initialization vector extracted from the binary data.
$ciphertext : string: the ciphertext extracted from the binary data.
$tag : string: the authentication tag extracted from the binary data.

Return values

bool —

true on success or false on error.

do_php_base64_decode()


    protected
                    do_php_base64_decode(mixed $input, mixed $strict) : mixed

Parameters

$input : mixed
$strict : mixed

Return values

mixed —

do_php_base64_encode()


    protected
                    do_php_base64_encode(mixed $input) : mixed

Parameters

$input : mixed

Return values

mixed —

do_php_json_decode()


    protected
                    do_php_json_decode(mixed $json, mixed $associative, mixed $depth, mixed $flags) : mixed

Parameters

$json : mixed
$associative : mixed
$depth : mixed
$flags : mixed

Return values

mixed —

do_php_json_encode()


    protected
                    do_php_json_encode(mixed $value, mixed $flags, mixed $depth) : mixed

Parameters

$value : mixed
$flags : mixed
$depth : mixed

Return values

mixed —

do_php_json_last_error()


    protected
                    do_php_json_last_error() : mixed

Return values

mixed —

do_php_openssl_cipher_iv_length()


    protected
                    do_php_openssl_cipher_iv_length(mixed $cipher) : mixed

Parameters

$cipher : mixed

Return values

mixed —

do_php_openssl_decrypt()


    protected
                    do_php_openssl_decrypt(mixed $ciphertext, mixed $cipher, mixed $passphrase, mixed $options, mixed $iv, mixed $tag) : mixed

Parameters

$ciphertext : mixed
$cipher : mixed
$passphrase : mixed
$options : mixed
$iv : mixed
$tag : mixed

Return values

mixed —

do_php_openssl_encrypt()


    protected
                    do_php_openssl_encrypt(mixed $plaintext, mixed $cipher, mixed $passphrase, mixed $options, mixed $iv, mixed &$tag) : mixed

Parameters

$plaintext : mixed
$cipher : mixed
$passphrase : mixed
$options : mixed
$iv : mixed
$tag : mixed

Return values

mixed —

do_php_openssl_error_string()


    protected
                    do_php_openssl_error_string() : mixed

Return values

mixed —

do_php_openssl_get_cipher_methods()


    protected
                    do_php_openssl_get_cipher_methods() : mixed

Return values

mixed —

do_php_random_bytes()


    protected
                    do_php_random_bytes(mixed $length) : mixed

Parameters

$length : mixed

Return values

mixed —

do_php_random_int()


    protected
                    do_php_random_int(mixed $min, mixed $max) : mixed

Parameters

$min : mixed
$max : mixed

Return values

mixed —

do_php_sapi_name()


    protected
                    do_php_sapi_name() : mixed

Return values

mixed —

do_php_serialize()


    protected
                    do_php_serialize(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

do_php_strval()


    protected
                    do_php_strval(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

do_php_time_nanosleep()


    protected
                    do_php_time_nanosleep(mixed $seconds, mixed $nanoseconds) : mixed

Parameters

$seconds : mixed
$nanoseconds : mixed

Return values

mixed —

do_php_unserialize()


    protected
                    do_php_unserialize(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

do_phps_decode()

2023-04-07 jj5 - does the actual work of PHP deserialization by deferring to the implementation on the PHP wrapper.


    protected
                    do_phps_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the serialized data to deserialize.
$is_false : bool: set to true if the deserialized value is the boolean value false.

Return values

mixed —

the deserialized data or false on error.

do_phps_encode()

2023-04-07 jj5 - does the actual work of PHP serialization; can be overridden by implementers; by default calls the PHP serialize() function via its wrapper.


    protected
                    do_phps_encode(mixed $input) : string|false

Parameters

$input : mixed: can be pretty much anything.

Return values

string|false —

the serialized value on success or false on failure.

do_report_emergency_delay()

2023-04-05 jj5 - by default writes a message to the error log; can be overridden by implementations.


    protected
                    do_report_emergency_delay(string $type, string $file, int $line, string $function) : void

Parameters

$type : string: the type of delay, could be 'nanosleep' or 'microsleep'.
$file : string: the file that reported the emergecny delay.
$line : int: the line in the file where the emergency delay was reported.
$function : string: the function from which the emergency delay was reported.

Return values

void —

do_text_decode()

2023-04-07 jj5 - does the actual work of text deserialization by deferring to the implementation on the PHP wrapper.


    protected
                    do_text_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the serialized data to deserialize.
$is_false : bool: set to false, the value false can't be represent.

Return values

mixed —

the deserialized data or false on error.

do_text_encode()

2023-04-07 jj5 - does the actual work of text serialization; can be overridden by implementers; by default calls the PHP strval() function via its wrapper.


    protected
                    do_text_encode(mixed $input) : string|false

Parameters

$input : mixed: something that is a string or can be turned into a string.

Return values

string|false —

the serialized value on success or false on failure.

do_throw()

2023-04-05 jj5 - by default this finds the message for the given exception code and then throws an exception with the relevant code and message; can be overridden by implementations.


    protected
                    do_throw(int $code, mixed $data, Throwable $previous) : mixed

Parameters

$code : int: the exception code is one of the KICKASS_CRYPTO_EXCEPTION_* constants.
$data : mixed: the data to associate with the exception, if any.
$previous : Throwable: the previous exception, if any.

Return values

mixed —

emergency_delay()

2023-04-05 jj5 - does an emergency delay; this doesn't give the caller any option to interfere so the emergency delay should run reliably if it's necessary.


    protected
        final            emergency_delay() : void

Return values

void —

encrypt_string()

2023-04-05 jj5 - encrypts a plaintext string using the passphrase; defers to do_encrypt_string().


    protected
        final            encrypt_string(string $plaintext, string $passphrase) : string|false

Parameters

$plaintext : string: the plaintext to encrypt.
$passphrase : string: the passphrase to use for encryption.

Return values

string|false —

the ciphertext on success or false on error.

enter()

2023-04-07 jj5 - registers when a function gets called so as to track the depth of a function on the call stack.


    protected
                    enter(string $function) : void

Parameters

$function : string: the name of the function.

Return values

void —

error()

2023-04-05 jj5 - registers an error; if this is the first error a random delay is injected as a timing attack mitigation.


    protected
        final            error(string $function, string $error[, mixed $data = null ]) : bool

Parameters

$function : string: the name of the function registering the error.
$error : string: the error description, usually one of the KICKASS_CRYPTO_ERROR_* constants.
$data : mixed = null: any error assoicated with the error; this could be sensitive, do not log without scrubbing or expose without thought.

Return values

bool —

always false.

get_config_chunk_size()

2023-04-05 jj5 - gets the chunk size, it's used for padding encrypted messages.


    protected
        final            get_config_chunk_size([int $default = KICKASS_CRYPTO_DEFAULT_CHUNK_SIZE ]) : int

Parameters

$default : int = KICKASS_CRYPTO_DEFAULT_CHUNK_SIZE: the value to use if the config option is not defined.

Return values

int —

the chunk size.

get_config_chunk_size_max()

2023-04-05 jj5 - gets the maximum chunk size, it's used for validating the chunk size.


    protected
        final            get_config_chunk_size_max([int $default = KICKASS_CRYPTO_DEFAULT_CHUNK_SIZE_MAX ]) : int

Parameters

$default : int = KICKASS_CRYPTO_DEFAULT_CHUNK_SIZE_MAX: the value to use if the config option is not defined.

Return values

int —

the maximum chunk size.

get_config_data_encoding()

2023-04-05 jj5 - gets the data encoding.


    protected
        final            get_config_data_encoding([string $default = KICKASS_CRYPTO_DEFAULT_DATA_ENCODING ]) : string

2023-04-05 jj5 - data formats which are supported directly are:

KICKASS_CRYPTO_DATA_ENCODING_JSON
KICKASS_CRYPTO_DATA_ENCODING_PHPS
KICKASS_CRYPTO_DATA_ENCODING_TEXT

2023-04-05 jj5 - implementations can define their own data formats. Data format codes must be ASCII values make from capital letters and numbers, see is_valid_data_format() for the gory details.

Parameters

$default : string = KICKASS_CRYPTO_DEFAULT_DATA_ENCODING: the value to use if the config option is not defined.

Return values

string —

the data encoding.

get_config_data_length_max()

2023-04-05 jj5 - gets the maximum supported data length, it's used for validating the encoded data.


    protected
        final            get_config_data_length_max([int $default = KICKASS_CRYPTO_DEFAULT_DATA_LENGTH_MAX ]) : int

Parameters

$default : int = KICKASS_CRYPTO_DEFAULT_DATA_LENGTH_MAX: the value to use if the config option is not defined.

Return values

int —

the maximum supported data length.

get_config_false_enable()

2023-04-05 jj5 - gets a boolean value indicating whether the boolean value false can be encrypted or not.


    protected
        final            get_config_false_enable([bool $default = KICKASS_CRYPTO_DEFAULT_FALSE_ENABLE ]) : bool

Parameters

$default : bool = KICKASS_CRYPTO_DEFAULT_FALSE_ENABLE: the value to use if the config option is not defined.

Return values

bool —

true if the boolean value false can be encrypted, false otherwise.

get_config_json_decode_options()

2023-04-05 jj5 - gets the JSON decoding options which will be passed to the PHP json_decode() function.


    protected
        final            get_config_json_decode_options([int $default = KICKASS_CRYPTO_DEFAULT_JSON_DECODE_OPTIONS ]) : int

Parameters

$default : int = KICKASS_CRYPTO_DEFAULT_JSON_DECODE_OPTIONS: the value to use if the config option is not defined.

Return values

int —

the JSON decoding options.

get_config_json_encode_options()

2023-04-05 jj5 - gets the JSON encoding options which will be passed to the PHP json_encode() function.


    protected
        final            get_config_json_encode_options([int $default = KICKASS_CRYPTO_DEFAULT_JSON_ENCODE_OPTIONS ]) : int

Parameters

$default : int = KICKASS_CRYPTO_DEFAULT_JSON_ENCODE_OPTIONS: the value to use if the config option is not defined.

Return values

int —

the JSON encoding options.

get_config_phps_enable()

2023-04-05 jj5 - gets a boolean value indicating whether PHPS serialization and deserialization is enabled or not.


    protected
        final            get_config_phps_enable([bool $default = KICKASS_CRYPTO_DEFAULT_PHPS_ENABLE ]) : bool

Parameters

$default : bool = KICKASS_CRYPTO_DEFAULT_PHPS_ENABLE: the value to use if the config option is not defined.

Return values

bool —

true if PHPS serialization and deserialization is enabled, false otherwise.

get_config_secret_curr()

2023-04-07 jj5 - gets the current secret key to use for encryption, and the first key to try for decryption; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_CURR which should always be defined in a config file; this secret key is required by the round-trip use case and not relevant to the at-rest use case.


    protected
                    get_config_secret_curr() : string|false

Return values

string|false —

the current secret key or false if it's missing.

get_config_secret_list()

2023-04-07 jj5 - gets an array of strings containing secret keys to use for the at-rest use case; this list is not relevant to the round-trip use case; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_LIST which should be defined in the config file if you're using the library support for the OpenSSL at-rest use case.


    protected
                    get_config_secret_list() : array<string|int, mixed>

Return values

array<string|int, mixed> —

an array of strings, must contain at least one, and they must be valid secret keys.

get_config_secret_prev()

2023-04-07 jj5 - gets an optional extra secret key, known as the previous secret key, to try when decrypting input data; unless overridden by implementations this function returns the constant value CONFIG_OPENSSL_SECRET_PREV which can optionally be defined in the config file; this secret key is optional in the round-trip use case and not relevant to the at-rest use case.


    protected
                    get_config_secret_prev() : string|false

Return values

string|false —

the previous secret key or false if it's missing.

get_const()

2023-04-05 jj5 - gets a constant value, or returns the default value if the constant is not defined.


    protected
        final            get_const(string $const[, mixed $default = false ]) : mixed

Parameters

$const : string: the name of the constant.
$default : mixed = false: the value to return if the constant is not defined.

Return values

mixed —

the constant value or the default value if the constant is not defined.

get_const_data_format()

2023-04-05 jj5 - gets the data format constant; defers to abstract method for implementation.


    protected
        final            get_const_data_format() : string

Return values

string —

the data format constant.

get_const_key_hash()

2023-04-05 jj5 - gets the name of the hashing algorithm to use for secret key hashing.


    protected
        final            get_const_key_hash() : string

Return values

string —

the name of the PHP hashing algorithm.

get_const_key_length_min()

2023-04-05 jj5 - gets the minimum length of a secret key.


    protected
        final            get_const_key_length_min() : int

Return values

int —

the minimum length of a secret key.

get_const_openssl_cipher()

2023-04-07 jj5 - gets the OpenSSL cipher algorithm to use with the the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_CIPHER.


    protected
                    get_const_openssl_cipher() : string

Return values

string —

get_const_openssl_iv_length()

2023-04-07 jj5 - gets the length of the initialization vector expected by the cipher used with the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_IV_LENGTH.


    protected
                    get_const_openssl_iv_length() : int

Return values

int —

get_const_openssl_options()

2023-04-07 jj5 - gets the options to use when calling the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_OPTIONS.


    protected
                    get_const_openssl_options() : int

Return values

int —

get_const_openssl_tag_length()

2023-04-07 jj5 - gets the tag length expected by the cipher used with the OpenSSL library; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_TAG_LENGTH.


    protected
                    get_const_openssl_tag_length() : int

Return values

int —

get_const_passphrase_length()

2023-04-07 jj5 - gets the length of a valid passphrase; unless overridden by implementations this function returns the constant value KICKASS_CRYPTO_OPENSSL_PASSPHRASE_LENGTH.


    protected
                    get_const_passphrase_length() : int

Return values

int —

get_const_passphrase_length_min()

2023-04-05 jj5 - gets the minimum length of a passphrase.


    protected
        final            get_const_passphrase_length_min() : int

Return values

int —

the minimum length of a passphrase.

get_data_encoding()

2023-04-05 jj5 - gets the data encoding; defers to virtual do_get_data_encoding().


    protected
        final            get_data_encoding() : string

Return values

string —

the data encoding.

get_data_format()

2023-04-07 jj5 - gets the data format; the data format can be "KA0" for OpenSSL implementations and "KAS0" for Sodium implementations; if not the official implementation then the string 'X' is prepended to the data format.


    protected
        final            get_data_format() : string|false

Return values

string|false —

the data format string or false on error.

get_delay()

2023-04-07 jj5 - calculates the seconds and extra nanoseconds which will be needed by the delay implementation; this function defers to do_get_delay() which can be overridden by implementations.


    protected
        final            get_delay(int $ns_min, int $ns_max, int &$seconds, int &$nanoseconds) : bool

Parameters

$ns_min : int: the total number of nanoseconds, minimum.
$ns_max : int: the total number of nanoseconds, maximum.
$seconds : int: the number of whole seconds to delay.
$nanoseconds : int: the extra number of nanoseconds to delay beyond the number of seconds.

Return values

bool —

true on success or false on failure.

get_encryption_passphrase()

2023-04-05 jj5 - returns the passphrase to use for encryption or null if it's missing.


    protected
        final            get_encryption_passphrase() : string

Return values

string —

the encryption passphrase or null.

get_padding()

2023-04-07 jj5 - gets the string to use as padding; it's usually just a string of random bytes.


    protected
        final            get_padding(int $length) : string|false

Parameters

$length : int: the length of the random padding to generate.

Return values

string|false —

the padding string to use or false on error.

get_passphrase_list()

2023-04-05 jj5 - returns the list of passphrases; defers to abstract implementation.


    protected
        final            get_passphrase_list() : array<string|int, mixed>

Return values

array<string|int, mixed> —

a list of strings to use as passphrases.

handle()

2023-04-01 jj5 - the point of handle() is simply to notify that an exception has been caught and "handled"; sometimes "handling" the exception is tantamount to ignoring it, so we call this method that we may make some noise about it (during debugging, usually). See do_handle() for the rest of the story.


    protected
        final            handle(mixed $ex, mixed $file, mixed $line, mixed $function) : void

It's very important that this function does not throw exceptions, except for AssertionError, which is allowed.

Parameters

$ex : mixed
$file : mixed
$line : mixed
$function : mixed

Return values

void —

ignore()

2023-04-06 jj5 - the point of ignore() is simply to notify that an exception has been caught and it will be ignored.


    protected
        final            ignore(mixed $ex, mixed $file, mixed $line, mixed $function) : void

It's very important that this function does not throw exceptions, except for AssertionError, which is allowed. This function is the safest of all.

Parameters

$ex : mixed
$file : mixed
$line : mixed
$function : mixed

Return values

void —

increment_counter()

2023-04-05 jj5 - will increment the value for a key in an array; will initialize to zero if missing.


    protected
        final            increment_counter(array<string|int, mixed> &$array, string|int $key) : int

Parameters

$array : array<string|int, mixed>: a reference to the array to operate on.
$key : string|int: the key to operate on.

Return values

int —

the current count.

is_cli()

2023-04-05 jj5 - reports if the program is running from the command-line.


    protected
        final            is_cli() : bool

Return values

bool —

true if running from the command-line, false otherwise.

is_debug()

2023-04-05 jj5 - checks to see if the program is running in DEBUG mode.


    protected
        final            is_debug() : bool

Return values

bool —

true if running in DEBUG mode, false otherwise.

is_valid_base64()

2023-04-05 jj5 - checks the input is in valid base64 format; defers to virtual do_is_valid_base64().


    protected
        final            is_valid_base64(string $input) : bool

Parameters

$input : string: the value which should be in base64 format.

Return values

bool —

true if the input is in base64 format, false otherwise.

is_valid_config()

2023-04-05 jj5 - checks to see if the environment configuration is valid; this function defers to the abstract method do_is_valid_config().


    protected
        final            is_valid_config([string|null &$problem = null ]) : bool

Parameters

$problem : string|null = null: a reference to the problem, if any.

Return values

bool —

true if the config is valid, false otherwise.

is_valid_data_encoding()

2023-04-05 jj5 - checks to see if the data encoding is a valid supported encoding; defers to the virtual do_is_valid_encoding() method.


    protected
        final            is_valid_data_encoding(string $data_encoding) : bool

Parameters

$data_encoding : string: the data encoding to validate.

Return values

bool —

true if the data encoding is value, false otherwise.

is_valid_data_format()

2023-04-05 jj5 - checks to see if the data format is valid; this behavior cannot be overridden by implementations.


    protected
        final            is_valid_data_format(string $data_format) : bool

Parameters

$data_format : string: the data format string.

Return values

bool —

true if the data format is valid, false otherwise.

is_valid_passphrase()

2023-04-06 jj5 - checks to see if a passphrase is valid; this function defers to do_is_valid_passphrase();


    protected
        final            is_valid_passphrase(string $passphrase) : bool

Parameters

$passphrase : string: the passphrase key

Return values

bool —

true if the passphrase key is valid, false otherwise.

is_valid_secret()

2023-04-05 jj5 - checks to see if a secret is valid; this function defers to do_is_valid_secret();


    protected
        final            is_valid_secret(string $secret) : bool

Parameters

$secret : string: the secret key

Return values

bool —

true if the secret key is valid, false otherwise.

json_decode()

2023-04-07 jj5 - deserialized JSON data.


    protected
        final            json_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the JSON.
$is_false : bool: set to true if the JSON deserializes to the boolean value false.

Return values

mixed —

can return pretty much anything, will return false on failure but false can be a valid return value.

json_encode()

2023-04-05 jj5 - encodes a valud as JSON; defers to do_json_encode() for implementation.


    protected
        final            json_encode(mixed $input) : string|false

Parameters

$input : mixed: input can be almost anything.

Return values

string|false —

the JSON string on success, false on failure.

leave()

2023-04-07 jj5 - registers when a runction returns so as to track the depth of a function on the call stack.


    protected
                    leave(string $function) : mixed

Parameters

$function : string: the name of the function.

Return values

mixed —

log_error()

2023-04-07 jj5 - logs an error.


    protected
        final            log_error(string $message, string $file, int $line, string $function) : bool

Parameters

$message : string: the message to log.
$file : string: the path of the file writing the log entry.
$line : int: the line in the file writing the log entry.
$function : string: the name of the function writing the log entry.

Return values

bool —

true on success or false on failure.

message_decode()

2023-04-07 jj5 - decodes a message into binary.


    protected
        final            message_decode(string $encoded) : string|false

Parameters

$encoded : string: the encoded message.

Return values

string|false —

the decoded message or false on failure.

message_encode()

2023-04-07 jj5 - encodes a message.


    protected
        final            message_encode(string $binary) : string|false

Parameters

$binary : string: the binary data to encode.

Return values

string|false —

the encoded value on success or false on failure.

notify()

2023-04-01 jj5 - the point of notify() is simply to notify that an exception has been caught but it's going to be rethrown; it's best if this function doesn't throw an exception but it shouldn't be a huge problem if it does, the caller will throw when this function returns anyway.


    protected
        final            notify(mixed $ex, mixed $file, mixed $line, mixed $function) : void

Parameters

$ex : mixed
$file : mixed
$line : mixed
$function : mixed

Return values

void —

parse_binary()

2023-04-05 jj5 - parses the binary message into its fixed length components.


    protected
        final            parse_binary(string $binary, string &$iv, string &$ciphertext, string &$tag) : bool

Parameters

$binary : string: the binary message.
$iv : string: the initialization vector for OpenSLL or the nonce for Sodium.
$ciphertext : string: the ciphertext.
$tag : string: the tag, only provided by OpenSSL, false for Sodium.

Return values

bool —

true on success, false otherwise.

php_base64_decode()


    protected
        final            php_base64_decode(mixed $input, mixed $strict) : mixed

Parameters

$input : mixed
$strict : mixed

Return values

mixed —

php_base64_encode()


    protected
        final            php_base64_encode(mixed $input) : mixed

Parameters

$input : mixed

Return values

mixed —

php_json_decode()


    protected
        final            php_json_decode(mixed $json, mixed $associative, mixed $depth, mixed $flags) : mixed

Parameters

$json : mixed
$associative : mixed
$depth : mixed
$flags : mixed

Return values

mixed —

php_json_encode()


    protected
        final            php_json_encode(mixed $value, mixed $flags[, mixed $depth = 512 ]) : mixed

Parameters

$value : mixed
$flags : mixed
$depth : mixed = 512

Return values

mixed —

php_json_last_error()


    protected
        final            php_json_last_error() : mixed

Return values

mixed —

php_openssl_cipher_iv_length()


    protected
        final            php_openssl_cipher_iv_length(mixed $cipher) : mixed

Parameters

$cipher : mixed

Return values

mixed —

php_openssl_decrypt()


    protected
        final            php_openssl_decrypt(mixed $ciphertext, mixed $cipher, mixed $passphrase, mixed $options, mixed $iv, mixed $tag) : mixed

Parameters

$ciphertext : mixed
$cipher : mixed
$passphrase : mixed
$options : mixed
$iv : mixed
$tag : mixed

Return values

mixed —

php_openssl_encrypt()


    protected
        final            php_openssl_encrypt(mixed $plaintext, mixed $cipher, mixed $passphrase, mixed $options, mixed $iv, mixed &$tag) : mixed

Parameters

$plaintext : mixed
$cipher : mixed
$passphrase : mixed
$options : mixed
$iv : mixed
$tag : mixed

Return values

mixed —

php_openssl_error_string()


    protected
        final            php_openssl_error_string() : mixed

Return values

mixed —

php_openssl_get_cipher_methods()


    protected
        final            php_openssl_get_cipher_methods() : mixed

Return values

mixed —

php_random_bytes()


    protected
        final            php_random_bytes(mixed $length) : mixed

Parameters

$length : mixed

Return values

mixed —

php_random_int()


    protected
        final            php_random_int(mixed $min, mixed $max) : mixed

Parameters

$min : mixed
$max : mixed

Return values

mixed —

php_sapi_name()


    protected
        final            php_sapi_name() : mixed

Return values

mixed —

php_serialize()


    protected
        final            php_serialize(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

php_strval()


    protected
        final            php_strval(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

php_time_nanosleep()


    protected
        final            php_time_nanosleep(mixed $seconds, mixed $nanoseconds) : mixed

Parameters

$seconds : mixed
$nanoseconds : mixed

Return values

mixed —

php_unserialize()


    protected
        final            php_unserialize(mixed $value) : mixed

Parameters

$value : mixed

Return values

mixed —

phps_decode()

2023-04-07 jj5 - deserializes the input data using the PHP unserialize() function.


    protected
        final            phps_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the serialized data.
$is_false : bool: set to true if the deserialized data is the boolean value false.

Return values

mixed —

the deserialized data on success or false on failure, the value false can be returned on success if that's what the serialized data represented.

phps_encode()

2023-04-05 jj5 - serializes a value using PHP serialization; defers to virtual method do_phps_encode() for implementation.


    protected
        final            phps_encode(mixed $input) : string|false

Parameters

$input : mixed: can be pretty much anything, the PHP serialization has good support for odd values such as object instances and weird floats.

Return values

string|false —

the serialized input or false on error.

text_decode()

2023-04-07 jj5 - deserializes the input data using the PHP strval() function.


    protected
        final            text_decode(string $input, bool &$is_false) : mixed

Parameters

$input : string: the serialized data.
$is_false : bool: always set to false, this format can't represent false.

Return values

mixed —

the deserialized data on success or false on failure.

text_encode()

2023-04-05 jj5 - serializes a value as text; defers to virtual method do_text_encode() for implementation.


    protected
        final            text_encode(mixed $input) : string|false

Parameters

$input : mixed: should be a string or something that strval() will turn into a string.

Return values

string|false —

the serialized input or false on error.

throw()

2023-04-05 jj5 - this function throws an exception.


    protected
        final            throw(int $code[, type $data = null ][, type $previous = null ]) : void

Parameters

$code : int: the exception code of the exception to throw, this is one of the KICKASS_CRYPTO_EXCEPTION_* constants.
$data : type = null: optional data to associate with the exception.
$previous : type = null: the previous exception, if any.

Return values

void —

try_decrypt()

2023-04-05 jj5 - tries to decrypt a binary string using the passphrase.


    protected
        final            try_decrypt(string $binary, string $passphrase[, string &$data_encoding = null ]) : mixed

Parameters

$binary : string: the binary data to decrypt.
$passphrase : string: the passphrase to use for decryption.
$data_encoding : string = null: a reference to the data encoding, this is set if its possible to determine.

Return values

mixed —

the decoded message on success, false otherwise.

write_log()

2023-04-07 jj5 - provides our internal direct implementation of log writing, in case we need to use it ourselves without potential interference from inheritors of our class.


    protected
        final            write_log(string $message, string $file, int $line, string $function) : bool

Parameters

$message : string: the message to log.
$file : string: the path of the file writing the log entry.
$line : int: the line in the file writing the log entry.
$function : string: the name of the function writing the log entry.

Return values

bool —

true on success or false on failure.

increment_counter_internal()

2023-04-07 jj5 - this is our private implementation for incrementing a counter for a key, we use it in enter().


    private
                    increment_counter_internal(array<string|int, mixed> &$array, string $key) : mixed

Parameters

$array : array<string|int, mixed>: a reference to the array to manage.
$key : string: the key of the counter to increment.

Return values

mixed —

report_emergency_delay()

2023-04-05 jj5 - this function makes some noice is the emergency delay is invoked; the emergency delay should not usually be activated so if it is we want to give ourself our best chance of finding out about it.


    private
                    report_emergency_delay(string $type, string $file, int $line, string $function) : void

Parameters

$type : string: the type of delay, could be 'nanosleep' or 'microsleep'.
$file : string: the file that reported the emergecny delay.
$line : int: the line in the file where the emergency delay was reported.
$function : string: the function from which the emergency delay was reported.

Return values

void —

KickassOpenSsl extends KickassCrypto in package Application Uses KICKASS_WRAPPER_PHP_OPENSSL

Table of Contents

Properties

$active

$error_list

$inject_delay

$openssl_error

$telemetry

Methods

__construct()

Tags

Return values

clear_error()

Tags

Return values

decrypt()

Parameters

Tags

Return values

delay()

Tags

Return values

encrypt()

Parameters

Tags

Return values

GenerateSecret()

Return values

get_error()

Tags

Return values

get_error_list()

Tags

Return values

get_openssl_error()

Return values

GetTelemetry()

Return values

ReportCounters()

Parameters

Return values

ReportTelemetry()

Return values

convert_secret_to_passphrase()

Parameters

Tags

Return values

count_class()

Parameters

Tags

Return values

count_function()

Parameters

Tags

Return values

count_length()

Parameters

Tags

Return values

count_this()

Parameters

Tags

Return values

data_decode()

Parameters

Tags

Return values

data_encode()

Parameters

Tags

Return values

decode_message()

Parameters

Tags

Return values

decrypt_string()

Parameters

Tags

Return values

do_clear_error()

KickassOpenSsl extends KickassCrypto
in package

Application

Uses KICKASS_WRAPPER_PHP_OPENSSL