| blob | 93c4f178f898b6580a130452c96e2bfbe4ac26a3 |
1 <?php
2 /**
3 * Automatically generated by running "php schema.php mcrypt".
4 *
5 * You may modify the file, but re-running schema.php against this file will
6 * standardize the format without losing your schema changes. It does lose
7 * any changes that are not part of schema. Use "note" field to comment on
8 * schema itself, and "note" fields are not used in any code generation but
9 * only staying within this file.
10 */
11 ///////////////////////////////////////////////////////////////////////////////
12 // Preamble: C++ code inserted at beginning of ext_{name}.h
16 CPP
17 );
19 ///////////////////////////////////////////////////////////////////////////////
20 // Constants
21 //
22 // array (
23 // 'name' => name of the constant
24 // 'type' => type of the constant
25 // 'note' => additional note about this constant's schema
26 // )
29 ///////////////////////////////////////////////////////////////////////////////
30 // Functions
31 //
32 // array (
33 // 'name' => name of the function
34 // 'desc' => description of the function's purpose
35 // 'flags' => attributes of the function, see base.php for possible values
36 // 'opt' => optimization callback function's name for compiler
37 // 'note' => additional note about this function's schema
38 // 'return' =>
39 // array (
40 // 'type' => return type, use Reference for ref return
41 // 'desc' => description of the return value
42 // )
43 // 'args' => arguments
44 // array (
45 // 'name' => name of the argument
46 // 'type' => type of the argument, use Reference for output parameter
47 // 'value' => default value of the argument
48 // 'desc' => description of the argument
49 // )
50 // )
55 'desc' => "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().",
60 ),
66 ),
70 'desc' => "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).",
71 ),
76 ),
80 ),
81 ),
83 ));
93 ),
99 ),
100 ),
102 ));
112 ),
118 'desc' => "Specifies the directory where all algorithms are located. If not specifies, the value of the mcrypt.algorithms_dir php.ini directive is used.",
119 ),
120 ),
122 ));
132 ),
138 'desc' => "Specifies the directory where all modes are located. If not specifies, the value of the mcrypt.modes_dir php.ini directive is used.",
139 ),
140 ),
142 ));
152 ),
158 ),
163 'desc' => "This optional parameter can contain the location where the mode module is on the system.",
164 ),
165 ),
167 ));
176 'desc' => "This function returns the maximum supported key size of the algorithm specified in bytes.",
177 ),
183 ),
188 'desc' => "This optional parameter can contain the location where the mode module is on the system.",
189 ),
190 ),
192 ));
197 'desc' => "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.",
201 'desc' => "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.",
202 ),
208 ),
213 'desc' => "The optional lib_dir parameter can contain the location of where the algorithm module is on the system.",
214 ),
215 ),
217 ));
222 'desc' => "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).",
226 'desc' => "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).",
227 ),
233 ),
238 'desc' => "The optional lib_dir parameter can contain the location of where the algorithm module is on the system.",
239 ),
240 ),
242 ));
247 'desc' => "This function returns TRUE if the specified algorithm is a block algorithm, or FALSE is it is a stream algorithm.",
251 'desc' => "This function returns TRUE if the specified algorithm is a block algorithm, or FALSE is it is a stream algorithm.",
252 ),
258 ),
263 'desc' => "The optional lib_dir parameter can contain the location of where the algorithm module is on the system.",
264 ),
265 ),
267 ));
272 'desc' => "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).",
276 'desc' => "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).",
277 ),
283 ),
288 'desc' => "The optional lib_dir parameter can contain the location of where the algorithm module is on the system.",
289 ),
290 ),
292 ));
302 ),
308 ),
313 'desc' => "The optional lib_dir parameter can contain the location of where the algorithm module is on the system.",
314 ),
315 ),
317 ));
322 'desc' => "Create an initialization vector (IV) from a random source.\n\nThe IV is only meant to give an alternative seed to the encryption routines. This IV does not need to be secret at all, though it can be desirable. You even can send it along with your ciphertext without losing security.",
327 ),
332 'desc' => "Determines the size of the IV, parameter source (defaults to random value) specifies the source of the IV.",
333 ),
338 'desc' => "The source can be MCRYPT_RAND (system random number generator), MCRYPT_DEV_RANDOM (read data from /dev/random) and MCRYPT_DEV_URANDOM (read data from /dev/urandom). Prior to 5.3.0, MCRYPT_RAND was the only one supported on Windows.",
339 ),
340 ),
342 ));
352 ),
358 ),
362 'desc' => "The key with which the data will be encrypted. If it's smaller that the required keysize, it is padded with '\\0'. It is better not to use ASCII strings for keys.\n\nIt is recommended to use the mhash functions to create a key from a string.",
363 ),
367 'desc' => "The data that will be encrypted with the given cipher and mode. If the size of the data is not n * blocksize, the data will be padded with '\\0'.\n\nThe returned crypttext can be larger that the size of the data that is given by data.",
368 ),
372 'desc' => "One of the MCRYPT_MODE_modename constants of one of \"ecb\", \"cbc\", \"cfb\", \"ofb\", \"nofb\" or \"stream\".",
373 ),
378 'desc' => "Used for the initialisation in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you do not supply an IV, while it is needed for an algorithm, the function issues a warning and uses an IV with all bytes set to '\\0'.",
379 ),
380 ),
384 ),
385 ));
395 ),
400 'desc' => "cipher is one of the MCRYPT_ciphername constants of the name of the algorithm as string.",
401 ),
405 'desc' => "key is the key with which the data is encrypted. If it's smaller that the required keysize, it is padded with '\\0'.",
406 ),
410 'desc' => "data is the data that will be decrypted with the given cipher and mode. If the size of the data is not n * blocksize, the data will be padded with '\\0'.",
411 ),
415 'desc' => "mode is one of the MCRYPT_MODE_modename constants of one of \"ecb\", \"cbc\", \"cfb\", \"ofb\", \"nofb\" or \"stream\".",
416 ),
421 'desc' => "The iv parameter is used for the initialisation in CBC, CFB, OFB modes, and in some algorithms in STREAM mode. If you do not supply an IV, while it is needed for an algorithm, the function issues a warning and uses an IV with all bytes set to '\\0'.",
422 ),
423 ),
427 ),
428 ));
436 ),
441 ),
445 ),
449 ),
453 ),
458 ),
459 ),
463 ),
464 ));
472 ),
477 ),
481 ),
485 ),
489 ),
494 ),
495 ),
499 ),
500 ));
508 ),
513 ),
517 ),
521 ),
525 ),
530 ),
531 ),
535 ),
536 ));
544 ),
549 ),
553 ),
557 ),
561 ),
566 ),
567 ),
571 ),
572 ));
577 'desc' => "The first prototype is when linked against libmcrypt 2.2.x, the second when linked against libmcrypt 2.4.x or 2.5.x.\n\nmcrypt_get_block_size() is used to get the size of a block of the specified cipher (in combination with an encryption mode).\n\nIt is more useful to use the mcrypt_enc_get_block_size() function as this uses the resource returned by mcrypt_module_open().",
582 ),
588 ),
594 ),
595 ),
597 ));
602 'desc' => "mcrypt_get_cipher_name() is used to get the name of the specified cipher.\n\nmcrypt_get_cipher_name() takes the cipher number as an argument (libmcrypt 2.2.x) or takes the cipher name as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher or FALSE, if the cipher does not exist.",
606 'desc' => "This function returns the name of the cipher or FALSE, if the cipher does not exist.",
607 ),
613 ),
614 ),
616 ));
621 'desc' => "Gets the size of the IV belonging to a specific cipher/mode combination.\n\nIt is more useful to use the mcrypt_enc_get_iv_size() function as this uses the resource returned by mcrypt_module_open().",
625 'desc' => "Returns the size of the Initialisation Vector (IV) in bytes. On error the function returns FALSE. If the IV is ignored in the specified cipher/mode combination zero is returned.",
626 ),
632 ),
636 'desc' => "mode is one of the MCRYPT_MODE_modename constants or one of \"ecb\", \"cbc\", \"cfb\", \"ofb\", \"nofb\" or \"stream\". The IV is ignored in ECB mode as this mode does not require it. You will need to have the same IV (think: starting point) both at encryption and decryption stages, otherwise your encryption will fail.",
637 ),
638 ),
640 ));
648 ),
653 ),
657 ),
658 ),
660 ));
670 ),
676 ),
677 ),
679 ));
689 ),
695 ),
696 ),
698 ));
703 'desc' => "This function returns the size of the IV of the algorithm specified by the encryption descriptor in bytes. An IV is used in cbc, cfb and ofb modes, and in some algorithms in stream mode.",
708 ),
714 ),
715 ),
717 ));
727 ),
733 ),
734 ),
736 ));
746 ),
752 ),
753 ),
755 ));
764 'desc' => "Returns an array with the key sizes supported by the algorithm specified by the encryption descriptor. If it returns an empty array then all key sizes between 1 and mcrypt_enc_get_key_size() are supported by the algorithm.",
765 ),
771 ),
772 ),
774 ));
779 'desc' => "Tells whether the algorithm of the opened mode works on blocks (e.g. FALSE for stream, and TRUE for cbc, cfb, ofb)..",
783 'desc' => "Returns TRUE if the mode is for use with block algorithms, otherwise it returns FALSE.",
784 ),
790 ),
791 ),
793 ));
803 ),
809 ),
810 ),
812 ));
817 'desc' => "Tells whether the opened mode outputs blocks (e.g. TRUE for cbc and ecb, and FALSE for cfb and stream).",
822 ),
828 ),
829 ),
831 ));
841 ),
847 ),
848 ),
850 ));
855 'desc' => "This function encrypts data. The data is padded with \"\\0\" to make sure the length of the data is n * blocksize. This function returns the encrypted data. Note that the length of the returned string can in fact be longer then the input, due to the padding of the data.\n\nIf you want to store the encrypted data in a database make sure to store the entire string as returned by mcrypt_generic, or the string will not entirely decrypt properly. If your original string is 10 characters long and the block size is 8 (use mcrypt_enc_get_block_size() to determine the blocksize), you would need at least 16 characters in your database field. Note the string returned by mdecrypt_generic() will be 16 characters as well...use rtrim(\$str, \"\\0\") to remove the padding.\n\nIf you are for example storing the data in a MySQL database remember that varchar fields automatically have trailing spaces removed during insertion. As encrypted data can end in a space (ASCII 32), the data will be damaged by this removal. Store data in a tinyblob/tinytext (or larger) field instead.",
860 ),
865 'desc' => "The encryption descriptor.\n\nThe encryption handle should always be initialized with mcrypt_generic_init() with a key and an IV before calling this function. Where the encryption is done, you should free the encryption buffers by calling mcrypt_generic_deinit(). See mcrypt_module_open() for an example.",
866 ),
871 ),
872 ),
876 ),
877 ));
882 'desc' => "You need to call this function before every call to mcrypt_generic() or mdecrypt_generic().",
886 'desc' => "The function returns a negative value on error, -3 when the key length was incorrect, -4 when there was a memory allocation problem and any other return value is an unknown error. If an error occurs a warning will be displayed accordingly. FALSE is returned if incorrect parameters were passed.",
887 ),
893 ),
897 'desc' => "The maximum length of the key should be the one obtained by calling mcrypt_enc_get_key_size() and every value smaller than this is legal.",
898 ),
902 'desc' => "The IV should normally have the size of the algorithms block size, but you must obtain the size by calling mcrypt_enc_get_iv_size(). IV is ignored in ECB. IV MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and unique (but not secret). The same IV must be used for encryption/decryption. If you do not want to use it you should set it to zeros, but this is not recommended.",
903 ),
904 ),
906 ));
911 'desc' => "This function decrypts data. Note that the length of the returned string can in fact be longer then the unencrypted string, due to the padding of the data.",
915 ),
921 ),
926 ),
927 ),
931 ),
932 ));
937 'desc' => "This function terminates encryption specified by the encryption descriptor (td). It clears all buffers, but does not close the module. You need to call mcrypt_module_close() yourself. (But PHP does this for you at the end of the script.)",
942 ),
948 ),
949 ),
951 ));
959 ),
964 ),
965 ),
967 ));
970 ///////////////////////////////////////////////////////////////////////////////
971 // Classes
972 //
973 // BeginClass
974 // array (
975 // 'name' => name of the class
976 // 'desc' => description of the class's purpose
977 // 'flags' => attributes of the class, see base.php for possible values
978 // 'note' => additional note about this class's schema
979 // 'parent' => parent class name, if any
980 // 'ifaces' => array of interfaces tihs class implements
981 // 'bases' => extra internal and special base classes this class requires
982 // 'footer' => extra C++ inserted at end of class declaration
983 // )
984 //
985 // DefineConstant(..)
986 // DefineConstant(..)
987 // ...
988 // DefineFunction(..)
989 // DefineFunction(..)
990 // ...
991 // DefineProperty
992 // DefineProperty
993 //
994 // array (
995 // 'name' => name of the property
996 // 'type' => type of the property
997 // 'flags' => attributes of the property
998 // 'desc' => description of the property
999 // 'note' => additional note about this property's schema
1000 // )
1001 //
1002 // EndClass()