diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml index d12db99669..49c1464c10 100644 --- a/reference/mcrypt/functions/mcrypt-get-block-size.xml +++ b/reference/mcrypt/functions/mcrypt-get-block-size.xml @@ -1,11 +1,11 @@ - + mcrypt_get_block_size Get the block size of the specified cipher - + &reftitle.description; @@ -32,7 +32,7 @@ mcrypt_module_open. - + &reftitle.parameters; @@ -41,7 +41,7 @@ cipher - One of the MCRYPT_ciphername constants of the name + One of the MCRYPT_ciphername constants or the name of the algorithm as string. diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml index a09ad7cae3..02481b8f56 100644 --- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml +++ b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml @@ -1,11 +1,11 @@ - + mcrypt_get_cipher_name Get the name of the specified cipher - + &reftitle.description; @@ -27,6 +27,30 @@ or &false;, if the cipher does not exist. + + &reftitle.parameters; + + + + cipher + + + One of the MCRYPT_ciphername constants or the name + of the algorithm as string. + + + + + + + + + &reftitle.returnvalues; + + This function returns the name of the cipher or &false;, if the cipher does + not exist. + + &reftitle.examples; diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml index f18f0ae4fe..7a6f4e6bb6 100644 --- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml +++ b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml @@ -1,11 +1,11 @@ - + mcrypt_module_get_supported_key_sizes Returns an array with the supported keysizes of the opened algorithm - + &reftitle.description; @@ -17,12 +17,50 @@ Returns an array with the key sizes supported by the specified algorithm. If it returns an empty array then all key sizes between 1 and mcrypt_module_get_algo_key_size are supported by the - algorithm. The optional lib_dir parameter can - contain the location where the mode module is on the system. + algorithm. + + + &reftitle.parameters; - See also mcrypt_enc_get_supported_key_sizes which is - used on open encryption modules. + + + algorithm + + + The algorithm to used. + + + + + lib_dir + + + The optional lib_dir parameter can contain the + location of where the algorithm module is on the system. + + + + + + + + + &reftitle.returnvalues; + + Returns an array with the key sizes supported by the specified algorithm. + If it returns an empty array then all key sizes between 1 and + mcrypt_module_get_algo_key_size are supported by the + algorithm. + + + + + &reftitle.seealso; + + + mcrypt_enc_get_supported_key_sizes + diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml index 18a7e0ccef..883822246d 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml @@ -1,11 +1,11 @@ - + mcrypt_module_is_block_algorithm_mode Returns if the specified module is a block algorithm or not - + &reftitle.description; @@ -16,9 +16,40 @@ This function returns &true; if the mode is for use with block algorithms, otherwise it returns &false;. (e.g. &false; for stream, and - &true; for cbc, cfb, ofb). The optional lib_dir - parameter can contain the location where the mode module is on the - system. + &true; for cbc, cfb, ofb). + + + + &reftitle.parameters; + + + + mode + + + The mode to check. + + + + + lib_dir + + + The optional lib_dir parameter can contain the + location of where the algorithm module is on the system. + + + + + + + + + &reftitle.returnvalues; + + This function returns &true; if the mode is for use with block + algorithms, otherwise it returns &false;. (e.g. &false; for stream, and + &true; for cbc, cfb, ofb). diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml index 6537c9d1aa..b488c6ec5d 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml @@ -1,11 +1,11 @@ - + mcrypt_module_is_block_algorithm This function checks whether the specified algorithm is a block algorithm - + &reftitle.description; @@ -15,9 +15,40 @@ This function returns &true; if the specified algorithm is a block - algorithm, or &false; is it is a stream algorithm. The optional - lib_dir parameter can contain the location where - the algorithm module is on the system. + algorithm, or &false; is it is a stream algorithm. + + + + + &reftitle.parameters; + + + + algorithm + + + The algorithm to check. + + + + + lib_dir + + + The optional lib_dir parameter can contain the + location of where the algorithm module is on the system. + + + + + + + + + &reftitle.returnvalues; + + This function returns &true; if the specified algorithm is a block + algorithm, or &false; is it is a stream algorithm. diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml index 5ccfa6f815..bf76e54d00 100644 --- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml +++ b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml @@ -1,11 +1,11 @@ - + mcrypt_module_is_block_mode Returns if the specified mode outputs blocks or not - + &reftitle.description; @@ -16,9 +16,41 @@ This function returns &true; if the mode outputs blocks of bytes or &false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and - &false; for cfb and stream). The optional lib_dir - parameter can contain the location where the mode module is on the - system. + &false; for cfb and stream). + + + + + &reftitle.parameters; + + + + mode + + + The mode to check. + + + + + lib_dir + + + The optional lib_dir parameter can contain the + location of where the algorithm module is on the system. + + + + + + + + + &reftitle.returnvalues; + + This function returns &true; if the mode outputs blocks of bytes or + &false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and + &false; for cfb and stream). diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml index e60a67af52..2918944182 100644 --- a/reference/mcrypt/functions/mcrypt-module-open.xml +++ b/reference/mcrypt/functions/mcrypt-module-open.xml @@ -1,11 +1,11 @@ - + mcrypt_module_open Opens the module of the algorithm and the mode to be used - + &reftitle.description; @@ -19,18 +19,61 @@ This function opens the module of the algorithm and the mode to be used. The name of the algorithm is specified in algorithm, e.g. "twofish" or is one of the MCRYPT_ciphername constants. The module is closed by calling - mcrypt_module_close. Normally it returns an - encryption descriptor, or &false; on error. + mcrypt_module_close. + + + + &reftitle.parameters; - The algorithm_directory and - mode_directory are used to locate the encryption - modules. When you supply a directory name, it is used. When you set one - of these to the empty string (""), the value set by the - mcrypt.algorithms_dir or - mcrypt.modes_dir ini-directive is used. When - these are not set, the default directories that are used are the ones - that were compiled in into libmcrypt (usually /usr/local/lib/libmcrypt). + + + algorithm + + + The algorithm to be used. + + + + + algorithm_directory + + + The algorithm_directory and + mode_directory are used to locate the encryption + modules. When you supply a directory name, it is used. When you set one + of these to the empty string (""), the value set by + the mcrypt.algorithms_dir or + mcrypt.modes_dir ini-directive is used. When + these are not set, the default directories that are used are the ones + that were compiled in into libmcrypt (usually + /usr/local/lib/libmcrypt). + + + + + mode + + + The mode to be used. + + + + + mode_directory + + + + + + + + + + + &reftitle.returnvalues; + + Normally it returns an encryption descriptor, or &false; on error. @@ -58,10 +101,7 @@ strings as name for the cipher and mode, this only works when the extension is linked against libmcrypt 2.4.x or 2.5.x. - - - &reftitle.examples; Using <function>mcrypt_module_open</function> in encryption @@ -105,13 +145,18 @@ + + + + &reftitle.seealso; - See also - mcrypt_module_close, - mcrypt_generic, - mdecrypt_generic, - mcrypt_generic_init, and - mcrypt_generic_deinit. + + mcrypt_module_close + mcrypt_generic + mdecrypt_generic + mcrypt_generic_init + mcrypt_generic_deinit + diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml index 26608cd6ec..1618f9581b 100644 --- a/reference/mcrypt/functions/mcrypt-module-self-test.xml +++ b/reference/mcrypt/functions/mcrypt-module-self-test.xml @@ -1,11 +1,11 @@ - + mcrypt_module_self_test This function runs a self test on the specified module - + &reftitle.description; @@ -14,10 +14,37 @@ stringlib_dir - This function runs the self test on the algorithm specified. The - optional lib_dir parameter can contain the - location of where the algorithm module is on the system. + This function runs the self test on the algorithm specified. + + + + &reftitle.parameters; + + + + algorithm + + + The algorithm to test. + + + + + lib_dir + + + The optional lib_dir parameter can contain the + location of where the algorithm module is on the system. + + + + + + + + + &reftitle.returnvalues; The function returns &true; if the self test succeeds, or &false; when if fails. diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml index f90807c730..63f3856dfc 100644 --- a/reference/mcrypt/functions/mdecrypt-generic.xml +++ b/reference/mcrypt/functions/mdecrypt-generic.xml @@ -1,11 +1,11 @@ - + mdecrypt_generic Decrypt data - + &reftitle.description; @@ -20,6 +20,31 @@ + + &reftitle.parameters; + + + + td + + + An encryption descriptor returned by + mcrypt_module_open + + + + + data + + + Encrypted data. + + + + + + + &reftitle.examples; @@ -78,10 +103,16 @@ encryption buffers by calling mcrypt_generic_deinit. See mcrypt_module_open for an example. + + + + &reftitle.seealso; - See also mcrypt_generic, - mcrypt_generic_init, and - mcrypt_generic_deinit. + + mcrypt_generic + mcrypt_generic_init + mcrypt_generic_deinit +