File: mcrypt.php

package info (click to toggle)
codelite 12.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 95,112 kB
  • sloc: cpp: 424,040; ansic: 18,284; php: 9,569; lex: 4,186; yacc: 2,820; python: 2,294; sh: 312; makefile: 51; xml: 13
file content (559 lines) | stat: -rw-r--r-- 20,238 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
<?php

// Start of mcrypt v.

/**
 * Deprecated: Encrypts/decrypts data in ECB mode
 * @link http://www.php.net/manual/en/function.mcrypt-ecb.php
 * @param cipher int 
 * @param key string 
 * @param data string 
 * @param mode int 
 * @return string 
 */
function mcrypt_ecb ($cipher, $key, $data, $mode) {}

/**
 * Encrypts/decrypts data in CBC mode
 * @link http://www.php.net/manual/en/function.mcrypt-cbc.php
 * @param cipher int 
 * @param key string 
 * @param data string 
 * @param mode int 
 * @param iv string[optional] 
 * @return string 
 */
function mcrypt_cbc ($cipher, $key, $data, $mode, $iv = null) {}

/**
 * Encrypts/decrypts data in CFB mode
 * @link http://www.php.net/manual/en/function.mcrypt-cfb.php
 * @param cipher int 
 * @param key string 
 * @param data string 
 * @param mode int 
 * @param iv string 
 * @return string 
 */
function mcrypt_cfb ($cipher, $key, $data, $mode, $iv) {}

/**
 * Encrypts/decrypts data in OFB mode
 * @link http://www.php.net/manual/en/function.mcrypt-ofb.php
 * @param cipher int 
 * @param key string 
 * @param data string 
 * @param mode int 
 * @param iv string 
 * @return string 
 */
function mcrypt_ofb ($cipher, $key, $data, $mode, $iv) {}

/**
 * Gets the key size of the specified cipher
 * @link http://www.php.net/manual/en/function.mcrypt-get-key-size.php
 * @param cipher int &mcrypt.parameter.cipher;
 * @return int the maximum supported key size of the algorithm in bytes
 *   &return.falseforfailure;.
 */
function mcrypt_get_key_size ($cipher) {}

/**
 * Gets the block size of the specified cipher
 * @link http://www.php.net/manual/en/function.mcrypt-get-block-size.php
 * @param cipher int &mcrypt.parameter.cipher;
 * @return int Gets the block size, as an integer.
 */
function mcrypt_get_block_size ($cipher) {}

/**
 * Gets the name of the specified cipher
 * @link http://www.php.net/manual/en/function.mcrypt-get-cipher-name.php
 * @param cipher int &mcrypt.parameter.cipher;
 * @return string This function returns the name of the cipher or false if the cipher does
 *   not exist.
 */
function mcrypt_get_cipher_name ($cipher) {}

/**
 * Creates an initialization vector (IV) from a random source
 * @link http://www.php.net/manual/en/function.mcrypt-create-iv.php
 * @param size int <p>
 *       The size of the IV.
 *      </p>
 * @param source int[optional] <p>
 *       The source of the IV. 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.
 *      </p>
 *      <p>
 *       Note that the default value of this parameter was
 *       MCRYPT_DEV_RANDOM prior to PHP 5.6.0.
 *      </p>
 * @return string the initialization vector, or false on error.
 */
function mcrypt_create_iv ($size, $source = null) {}

/**
 * Gets an array of all supported ciphers
 * @link http://www.php.net/manual/en/function.mcrypt-list-algorithms.php
 * @param lib_dir string[optional] <p>
 *       Specifies the directory where all algorithms are located. If not
 *       specified, the value of the mcrypt.algorithms_dir
 *       &php.ini; directive is used.
 *      </p>
 * @return array an array with all the supported algorithms.
 */
function mcrypt_list_algorithms ($lib_dir = null) {}

/**
 * Gets an array of all supported modes
 * @link http://www.php.net/manual/en/function.mcrypt-list-modes.php
 * @param lib_dir string[optional] <p>
 *       Specifies the directory where all modes are located. If not
 *       specified, the value of the mcrypt.modes_dir
 *       &php.ini; directive is used.
 *      </p>
 * @return array an array with all the supported modes.
 */
function mcrypt_list_modes ($lib_dir = null) {}

/**
 * Returns the size of the IV belonging to a specific cipher/mode combination
 * @link http://www.php.net/manual/en/function.mcrypt-get-iv-size.php
 * @param cipher string &mcrypt.parameter.cipher;
 * @param mode string &mcrypt.parameter.mode;
 *      <p>
 *       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.
 *      </p>
 * @return int the size of the Initialization Vector (IV) in bytes. On error the
 *   function returns false. If the IV is ignored in the specified cipher/mode
 *   combination zero is returned.
 */
function mcrypt_get_iv_size ($cipher, $mode) {}

/**
 * Encrypts plaintext with given parameters
 * @link http://www.php.net/manual/en/function.mcrypt-encrypt.php
 * @param cipher string &mcrypt.parameter.cipher;
 * @param key string <p>
 *       The key with which the data will be encrypted. If it's smaller than
 *       the required keysize, it is padded with '\0'. It is
 *       better not to use ASCII strings for keys.
 *      </p>
 *      <p>
 *       It is recommended to use the mhash functions to create a key from a
 *       string.
 *      </p>
 * @param data string <p>
 *       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'.
 *      </p>
 *      <p>
 *       The returned crypttext can be larger than the size of the data that was
 *       given by data.
 *      </p>
 * @param mode string &mcrypt.parameter.mode;
 * @param iv string[optional] &mcrypt.parameter.iv;
 * @return string the encrypted data, as a string.
 */
function mcrypt_encrypt ($cipher, $key, $data, $mode, $iv = null) {}

/**
 * Decrypts crypttext with given parameters
 * @link http://www.php.net/manual/en/function.mcrypt-decrypt.php
 * @param cipher string &mcrypt.parameter.cipher;
 * @param key string <p>
 *       The key with which the data was encrypted. If it's smaller
 *       than the required keysize, it is padded with
 *       '\0'.
 *      </p>
 * @param data string <p>
 *       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'.
 *      </p>
 * @param mode string &mcrypt.parameter.mode;
 * @param iv string[optional] &mcrypt.parameter.iv;
 * @return string the decrypted data as a string.
 */
function mcrypt_decrypt ($cipher, $key, $data, $mode, $iv = null) {}

/**
 * Opens the module of the algorithm and the mode to be used
 * @link http://www.php.net/manual/en/function.mcrypt-module-open.php
 * @param algorithm string &mcrypt.parameter.cipher;
 * @param algorithm_directory string <p>
 *       The algorithm_directory parameter is used to locate
 *       the encryption module. When you supply a directory name, it is used.  When
 *       you set it to an empty string (""), the value set by the
 *       mcrypt.algorithms_dir &php.ini; directive is used. When
 *       it is not set, the default directory that is used is the one that was compiled
 *       into libmcrypt (usually /usr/local/lib/libmcrypt).
 *      </p>
 * @param mode string &mcrypt.parameter.mode;
 * @param mode_directory string <p>
 *       The mode_directory parameter is used to locate
 *       the encryption module. When you supply a directory name, it is used.  When
 *       you set it to an empty string (""), the value set by the
 *       mcrypt.modes_dir &php.ini; directive is used. When
 *       it is not set, the default directory that is used is the one that was compiled-in
 *       into libmcrypt (usually /usr/local/lib/libmcrypt).
 *      </p>
 * @return resource Normally it returns an encryption descriptor, or false on error.
 */
function mcrypt_module_open ($algorithm, $algorithm_directory, $mode, $mode_directory) {}

/**
 * This function initializes all buffers needed for encryption
 * @link http://www.php.net/manual/en/function.mcrypt-generic-init.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @param key string <p>
 *       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.
 *      </p>
 * @param iv string <p>
 *       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.
 *      </p>
 * @return int 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.
 */
function mcrypt_generic_init ($td, $key, $iv) {}

/**
 * This function encrypts data
 * @link http://www.php.net/manual/en/function.mcrypt-generic.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 *      <p>
 *       The 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.
 *      </p>
 * @param data string <p>
 *       The data to encrypt.
 *      </p>
 * @return string the encrypted data.
 */
function mcrypt_generic ($td, $data) {}

/**
 * Decrypts data
 * @link http://www.php.net/manual/en/function.mdecrypt-generic.php
 * @param td resource <p>
 *       An encryption descriptor returned by
 *       mcrypt_module_open
 *      </p>
 * @param data string <p>
 *       Encrypted data.
 *      </p>
 * @return string 
 */
function mdecrypt_generic ($td, $data) {}

/**
 * This function terminates encryption
 * @link http://www.php.net/manual/en/function.mcrypt-generic-end.php
 * @param td resource 
 * @return bool 
 */
function mcrypt_generic_end ($td) {}

/**
 * This function deinitializes an encryption module
 * @link http://www.php.net/manual/en/function.mcrypt-generic-deinit.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return bool Returns true on success, false on failure.
 */
function mcrypt_generic_deinit ($td) {}

/**
 * Runs a self test on the opened module
 * @link http://www.php.net/manual/en/function.mcrypt-enc-self-test.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return int If the self test succeeds it returns false. In case of an error, it
 *   returns true.
 */
function mcrypt_enc_self_test ($td) {}

/**
 * Checks whether the encryption of the opened mode works on blocks
 * @link http://www.php.net/manual/en/function.mcrypt-enc-is-block-algorithm-mode.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return bool true if the mode is for use with block algorithms, otherwise it
 *   returns false.
 */
function mcrypt_enc_is_block_algorithm_mode ($td) {}

/**
 * Checks whether the algorithm of the opened mode is a block algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-enc-is-block-algorithm.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return bool true if the algorithm is a block algorithm or false if it is
 *   a stream one.
 */
function mcrypt_enc_is_block_algorithm ($td) {}

/**
 * Checks whether the opened mode outputs blocks
 * @link http://www.php.net/manual/en/function.mcrypt-enc-is-block-mode.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return bool true if the mode outputs blocks of bytes,
 *   or false if it outputs just bytes.
 */
function mcrypt_enc_is_block_mode ($td) {}

/**
 * Returns the blocksize of the opened algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-block-size.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return int the block size of the specified algorithm in bytes.
 */
function mcrypt_enc_get_block_size ($td) {}

/**
 * Returns the maximum supported keysize of the opened mode
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-key-size.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return int the maximum supported key size of the algorithm in bytes.
 */
function mcrypt_enc_get_key_size ($td) {}

/**
 * Returns an array with the supported keysizes of the opened algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-supported-key-sizes.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return array 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.
 */
function mcrypt_enc_get_supported_key_sizes ($td) {}

/**
 * Returns the size of the IV of the opened algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-iv-size.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return int the size of the IV, or 0 if the IV is ignored by the algorithm.
 */
function mcrypt_enc_get_iv_size ($td) {}

/**
 * Returns the name of the opened algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-algorithms-name.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return string the name of the opened algorithm as a string.
 */
function mcrypt_enc_get_algorithms_name ($td) {}

/**
 * Returns the name of the opened mode
 * @link http://www.php.net/manual/en/function.mcrypt-enc-get-modes-name.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return string the name as a string.
 */
function mcrypt_enc_get_modes_name ($td) {}

/**
 * This function runs a self test on the specified module
 * @link http://www.php.net/manual/en/function.mcrypt-module-self-test.php
 * @param algorithm string &mcrypt.parameter.cipher;
 * @param lib_dir string[optional] <p>
 *       The optional lib_dir parameter can contain the
 *       location where the algorithm module is on the system.
 *      </p>
 * @return bool The function returns true if the self test succeeds, or false when it
 *   fails.
 */
function mcrypt_module_self_test ($algorithm, $lib_dir = null) {}

/**
 * Returns if the specified module is a block algorithm or not
 * @link http://www.php.net/manual/en/function.mcrypt-module-is-block-algorithm-mode.php
 * @param mode string <p>
 *       The mode to check.
 *      </p>
 * @param lib_dir string[optional] <p>
 *       The optional lib_dir parameter can contain the
 *       location where the algorithm module is on the system.
 *      </p>
 * @return bool 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).
 */
function mcrypt_module_is_block_algorithm_mode ($mode, $lib_dir = null) {}

/**
 * This function checks whether the specified algorithm is a block algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-module-is-block-algorithm.php
 * @param algorithm string <p>
 *       The algorithm to check.
 *      </p>
 * @param lib_dir string[optional] <p>
 *       The optional lib_dir parameter can contain the
 *       location where the algorithm module is on the system.
 *      </p>
 * @return bool This function returns true if the specified algorithm is a block
 *   algorithm, or false if it is a stream one.
 */
function mcrypt_module_is_block_algorithm ($algorithm, $lib_dir = null) {}

/**
 * Returns if the specified mode outputs blocks or not
 * @link http://www.php.net/manual/en/function.mcrypt-module-is-block-mode.php
 * @param mode string &mcrypt.parameter.mode;
 * @param lib_dir string[optional] <p>
 *       The optional lib_dir parameter can contain the
 *       location where the algorithm module is on the system.
 *      </p>
 * @return bool 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).
 */
function mcrypt_module_is_block_mode ($mode, $lib_dir = null) {}

/**
 * Returns the blocksize of the specified algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-module-get-algo-block-size.php
 * @param algorithm string <p>
 *       The algorithm name.
 *      </p>
 * @param lib_dir string[optional] <p>
 *       This optional parameter can contain the location where the mode module
 *       is on the system.
 *      </p>
 * @return int the block size of the algorithm specified in bytes.
 */
function mcrypt_module_get_algo_block_size ($algorithm, $lib_dir = null) {}

/**
 * Returns the maximum supported keysize of the opened mode
 * @link http://www.php.net/manual/en/function.mcrypt-module-get-algo-key-size.php
 * @param algorithm string <p>
 *       The algorithm name.
 *      </p>
 * @param lib_dir string[optional] <p>
 *       This optional parameter can contain the location where the mode module
 *       is on the system.
 *      </p>
 * @return int This function returns the maximum supported key size of the
 *   algorithm specified in bytes.
 */
function mcrypt_module_get_algo_key_size ($algorithm, $lib_dir = null) {}

/**
 * Returns an array with the supported keysizes of the opened algorithm
 * @link http://www.php.net/manual/en/function.mcrypt-module-get-supported-key-sizes.php
 * @param algorithm string <p>
 *       The algorithm to be used.
 *      </p>
 * @param lib_dir string[optional] <p>
 *       The optional lib_dir parameter can contain the
 *       location where the algorithm module is on the system.
 *      </p>
 * @return array 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.
 */
function mcrypt_module_get_supported_key_sizes ($algorithm, $lib_dir = null) {}

/**
 * Closes the mcrypt module
 * @link http://www.php.net/manual/en/function.mcrypt-module-close.php
 * @param td resource <p>
 *       The encryption descriptor.
 *      </p>
 * @return bool Returns true on success, false on failure.
 */
function mcrypt_module_close ($td) {}

define ('MCRYPT_ENCRYPT', 0);
define ('MCRYPT_DECRYPT', 1);
define ('MCRYPT_DEV_RANDOM', 0);
define ('MCRYPT_DEV_URANDOM', 1);
define ('MCRYPT_RAND', 2);
define ('MCRYPT_3DES', "tripledes");
define ('MCRYPT_ARCFOUR_IV', "arcfour-iv");
define ('MCRYPT_ARCFOUR', "arcfour");
define ('MCRYPT_BLOWFISH', "blowfish");
define ('MCRYPT_BLOWFISH_COMPAT', "blowfish-compat");
define ('MCRYPT_CAST_128', "cast-128");
define ('MCRYPT_CAST_256', "cast-256");
define ('MCRYPT_CRYPT', "crypt");
define ('MCRYPT_DES', "des");
define ('MCRYPT_ENIGNA', "crypt");
define ('MCRYPT_GOST', "gost");
define ('MCRYPT_LOKI97', "loki97");
define ('MCRYPT_PANAMA', "panama");
define ('MCRYPT_RC2', "rc2");
define ('MCRYPT_RIJNDAEL_128', "rijndael-128");
define ('MCRYPT_RIJNDAEL_192', "rijndael-192");
define ('MCRYPT_RIJNDAEL_256', "rijndael-256");
define ('MCRYPT_SAFER64', "safer-sk64");
define ('MCRYPT_SAFER128', "safer-sk128");
define ('MCRYPT_SAFERPLUS', "saferplus");
define ('MCRYPT_SERPENT', "serpent");
define ('MCRYPT_THREEWAY', "threeway");
define ('MCRYPT_TRIPLEDES', "tripledes");
define ('MCRYPT_TWOFISH', "twofish");
define ('MCRYPT_WAKE', "wake");
define ('MCRYPT_XTEA', "xtea");
define ('MCRYPT_IDEA', "idea");
define ('MCRYPT_MARS', "mars");
define ('MCRYPT_RC6', "rc6");
define ('MCRYPT_SKIPJACK', "skipjack");
define ('MCRYPT_MODE_CBC', "cbc");
define ('MCRYPT_MODE_CFB', "cfb");
define ('MCRYPT_MODE_ECB', "ecb");
define ('MCRYPT_MODE_NOFB', "nofb");
define ('MCRYPT_MODE_OFB', "ofb");
define ('MCRYPT_MODE_STREAM', "stream");

// End of mcrypt v.
?>