www-apps/gc-fallout - dev
[anomen-overlay.git] / www-apps / gc-fallout / dev / phpseclib / AES.php
blob2de8821e84cdb0765c82db0af49a99414dd70202
1 <?php
2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
4 /**
5 * Pure-PHP implementation of AES.
7 * Uses mcrypt, if available, and an internal implementation, otherwise.
9 * PHP versions 4 and 5
11 * If {@link Crypt_AES::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
12 * {@link Crypt_AES::setKey() setKey()}. ie. if the key is 128-bits, the key length will be 128-bits. If it's 136-bits
13 * it'll be null-padded to 160-bits and 160 bits will be the key length until {@link Crypt_Rijndael::setKey() setKey()}
14 * is called, again, at which point, it'll be recalculated.
16 * Since Crypt_AES extends Crypt_Rijndael, some functions are available to be called that, in the context of AES, don't
17 * make a whole lot of sense. {@link Crypt_AES::setBlockLength() setBlockLength()}, for instance. Calling that function,
18 * however possible, won't do anything (AES has a fixed block length whereas Rijndael has a variable one).
20 * Here's a short example of how to use this library:
21 * <code>
22 * <?php
23 * include('Crypt/AES.php');
25 * $aes = new Crypt_AES();
27 * $aes->setKey('abcdefghijklmnop');
29 * $size = 10 * 1024;
30 * $plaintext = '';
31 * for ($i = 0; $i < $size; $i++) {
32 * $plaintext.= 'a';
33 * }
35 * echo $aes->decrypt($aes->encrypt($plaintext));
36 * ?>
37 * </code>
39 * LICENSE: Permission is hereby granted, free of charge, to any person obtaining a copy
40 * of this software and associated documentation files (the "Software"), to deal
41 * in the Software without restriction, including without limitation the rights
42 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43 * copies of the Software, and to permit persons to whom the Software is
44 * furnished to do so, subject to the following conditions:
46 * The above copyright notice and this permission notice shall be included in
47 * all copies or substantial portions of the Software.
49 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
54 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
55 * THE SOFTWARE.
57 * @category Crypt
58 * @package Crypt_AES
59 * @author Jim Wigginton <terrafrost@php.net>
60 * @copyright MMVIII Jim Wigginton
61 * @license http://www.opensource.org/licenses/mit-license.html MIT License
62 * @version $Id: AES.php,v 1.7 2010/02/09 06:10:25 terrafrost Exp $
63 * @link http://phpseclib.sourceforge.net
66 /**
67 * Include Crypt_Rijndael
69 require_once 'Rijndael.php';
71 /**#@+
72 * @access public
73 * @see Crypt_AES::encrypt()
74 * @see Crypt_AES::decrypt()
76 /**
77 * Encrypt / decrypt using the Counter mode.
79 * Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.
81 * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29
83 define('CRYPT_AES_MODE_CTR', -1);
84 /**
85 * Encrypt / decrypt using the Electronic Code Book mode.
87 * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29
89 define('CRYPT_AES_MODE_ECB', 1);
90 /**
91 * Encrypt / decrypt using the Code Book Chaining mode.
93 * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29
95 define('CRYPT_AES_MODE_CBC', 2);
96 /**
97 * Encrypt / decrypt using the Cipher Feedback mode.
99 * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29
101 define('CRYPT_AES_MODE_CFB', 3);
103 * Encrypt / decrypt using the Cipher Feedback mode.
105 * @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29
107 define('CRYPT_AES_MODE_OFB', 4);
108 /**#@-*/
110 /**#@+
111 * @access private
112 * @see Crypt_AES::Crypt_AES()
115 * Toggles the internal implementation
117 define('CRYPT_AES_MODE_INTERNAL', 1);
119 * Toggles the mcrypt implementation
121 define('CRYPT_AES_MODE_MCRYPT', 2);
122 /**#@-*/
125 * Pure-PHP implementation of AES.
127 * @author Jim Wigginton <terrafrost@php.net>
128 * @version 0.1.0
129 * @access public
130 * @package Crypt_AES
132 class Crypt_AES extends Crypt_Rijndael {
134 * mcrypt resource for encryption
136 * The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
137 * Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
139 * @see Crypt_AES::encrypt()
140 * @var String
141 * @access private
143 var $enmcrypt;
146 * mcrypt resource for decryption
148 * The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
149 * Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
151 * @see Crypt_AES::decrypt()
152 * @var String
153 * @access private
155 var $demcrypt;
158 * mcrypt resource for CFB mode
160 * @see Crypt_AES::encrypt()
161 * @see Crypt_AES::decrypt()
162 * @var String
163 * @access private
165 var $ecb;
168 * Default Constructor.
170 * Determines whether or not the mcrypt extension should be used. $mode should only, at present, be
171 * CRYPT_AES_MODE_ECB or CRYPT_AES_MODE_CBC. If not explictly set, CRYPT_AES_MODE_CBC will be used.
173 * @param optional Integer $mode
174 * @return Crypt_AES
175 * @access public
177 function Crypt_AES($mode = CRYPT_AES_MODE_CBC)
179 if ( !defined('CRYPT_AES_MODE') ) {
180 switch (true) {
181 case extension_loaded('mcrypt'):
182 // i'd check to see if aes was supported, by doing in_array('des', mcrypt_list_algorithms('')),
183 // but since that can be changed after the object has been created, there doesn't seem to be
184 // a lot of point...
185 define('CRYPT_AES_MODE', CRYPT_AES_MODE_MCRYPT);
186 break;
187 default:
188 define('CRYPT_AES_MODE', CRYPT_AES_MODE_INTERNAL);
192 switch ( CRYPT_AES_MODE ) {
193 case CRYPT_AES_MODE_MCRYPT:
194 switch ($mode) {
195 case CRYPT_AES_MODE_ECB:
196 $this->paddable = true;
197 $this->mode = MCRYPT_MODE_ECB;
198 break;
199 case CRYPT_AES_MODE_CTR:
200 // ctr doesn't have a constant associated with it even though it appears to be fairly widely
201 // supported. in lieu of knowing just how widely supported it is, i've, for now, opted not to
202 // include a compatibility layer. the layer has been implemented but, for now, is commented out.
203 $this->mode = 'ctr';
204 //$this->mode = in_array('ctr', mcrypt_list_modes()) ? 'ctr' : CRYPT_AES_MODE_CTR;
205 break;
206 case CRYPT_AES_MODE_CFB:
207 $this->mode = 'ncfb';
208 break;
209 case CRYPT_AES_MODE_OFB:
210 $this->mode = MCRYPT_MODE_NOFB;
211 break;
212 case CRYPT_AES_MODE_CBC:
213 default:
214 $this->paddable = true;
215 $this->mode = MCRYPT_MODE_CBC;
218 $this->debuffer = $this->enbuffer = '';
220 break;
221 default:
222 switch ($mode) {
223 case CRYPT_AES_MODE_ECB:
224 $this->paddable = true;
225 $this->mode = CRYPT_RIJNDAEL_MODE_ECB;
226 break;
227 case CRYPT_AES_MODE_CTR:
228 $this->mode = CRYPT_RIJNDAEL_MODE_CTR;
229 break;
230 case CRYPT_AES_MODE_CFB:
231 $this->mode = CRYPT_RIJNDAEL_MODE_CFB;
232 break;
233 case CRYPT_AES_MODE_OFB:
234 $this->mode = CRYPT_RIJNDAEL_MODE_OFB;
235 break;
236 case CRYPT_AES_MODE_CBC:
237 default:
238 $this->paddable = true;
239 $this->mode = CRYPT_RIJNDAEL_MODE_CBC;
243 if (CRYPT_AES_MODE == CRYPT_AES_MODE_INTERNAL) {
244 parent::Crypt_Rijndael($this->mode);
249 * Dummy function
251 * Since Crypt_AES extends Crypt_Rijndael, this function is, technically, available, but it doesn't do anything.
253 * @access public
254 * @param Integer $length
256 function setBlockLength($length)
258 return;
262 * Encrypts a message.
264 * $plaintext will be padded with up to 16 additional bytes. Other AES implementations may or may not pad in the
265 * same manner. Other common approaches to padding and the reasons why it's necessary are discussed in the following
266 * URL:
268 * {@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}
270 * An alternative to padding is to, separately, send the length of the file. This is what SSH, in fact, does.
271 * strlen($plaintext) will still need to be a multiple of 16, however, arbitrary values can be added to make it that
272 * length.
274 * @see Crypt_AES::decrypt()
275 * @access public
276 * @param String $plaintext
278 function encrypt($plaintext)
280 if ( CRYPT_AES_MODE == CRYPT_AES_MODE_MCRYPT ) {
281 $changed = $this->changed;
282 $this->_mcryptSetup();
284 if ($this->mode == CRYPT_AES_MODE_CTR) {
285 $iv = $this->encryptIV;
286 $xor = mcrypt_generic($this->enmcrypt, $this->_generate_xor(strlen($plaintext), $iv));
287 $ciphertext = $plaintext ^ $xor;
288 if ($this->continuousBuffer) {
289 $this->encryptIV = $iv;
291 return $ciphertext;
294 // re: http://phpseclib.sourceforge.net/cfb-demo.phps
295 // using mcrypt's default handing of CFB the above would output two different things. using phpseclib's
296 // rewritten CFB implementation the above outputs the same thing twice.
297 if ($this->mode == 'ncfb') {
298 if ($changed) {
299 $this->ecb = mcrypt_module_open(MCRYPT_RIJNDAEL_128, '', MCRYPT_MODE_ECB, '');
300 mcrypt_generic_init($this->ecb, $this->key, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");
303 if (strlen($this->enbuffer)) {
304 $ciphertext = $plaintext ^ substr($this->encryptIV, strlen($this->enbuffer));
305 $this->enbuffer.= $ciphertext;
306 if (strlen($this->enbuffer) == 16) {
307 $this->encryptIV = $this->enbuffer;
308 $this->enbuffer = '';
309 mcrypt_generic_init($this->enmcrypt, $this->key, $this->encryptIV);
311 $plaintext = substr($plaintext, strlen($ciphertext));
312 } else {
313 $ciphertext = '';
316 $last_pos = strlen($plaintext) & 0xFFFFFFF0;
317 $ciphertext.= $last_pos ? mcrypt_generic($this->enmcrypt, substr($plaintext, 0, $last_pos)) : '';
319 if (strlen($plaintext) & 0xF) {
320 if (strlen($ciphertext)) {
321 $this->encryptIV = substr($ciphertext, -16);
323 $this->encryptIV = mcrypt_generic($this->ecb, $this->encryptIV);
324 $this->enbuffer = substr($plaintext, $last_pos) ^ $this->encryptIV;
325 $ciphertext.= $this->enbuffer;
328 return $ciphertext;
331 if ($this->paddable) {
332 $plaintext = $this->_pad($plaintext);
335 $ciphertext = mcrypt_generic($this->enmcrypt, $plaintext);
337 if (!$this->continuousBuffer) {
338 mcrypt_generic_init($this->enmcrypt, $this->key, $this->iv);
341 return $ciphertext;
344 return parent::encrypt($plaintext);
348 * Decrypts a message.
350 * If strlen($ciphertext) is not a multiple of 16, null bytes will be added to the end of the string until it is.
352 * @see Crypt_AES::encrypt()
353 * @access public
354 * @param String $ciphertext
356 function decrypt($ciphertext)
358 if ( CRYPT_AES_MODE == CRYPT_AES_MODE_MCRYPT ) {
359 $changed = $this->changed;
360 $this->_mcryptSetup();
362 if ($this->mode == CRYPT_AES_MODE_CTR) {
363 $iv = $this->decryptIV;
364 $xor = mcrypt_generic($this->enmcrypt, $this->_generate_xor(strlen($ciphertext), $iv));
365 $plaintext = $ciphertext ^ $xor;
366 if ($this->continuousBuffer) {
367 $this->decryptIV = $iv;
369 return $plaintext;
372 if ($this->mode == 'ncfb') {
373 if ($changed) {
374 $this->ecb = mcrypt_module_open(MCRYPT_RIJNDAEL_128, '', MCRYPT_MODE_ECB, '');
375 mcrypt_generic_init($this->ecb, $this->key, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");
378 if (strlen($this->debuffer)) {
379 $plaintext = $ciphertext ^ substr($this->decryptIV, strlen($this->debuffer));
381 $this->debuffer.= substr($ciphertext, 0, strlen($plaintext));
382 if (strlen($this->debuffer) == 16) {
383 $this->decryptIV = $this->debuffer;
384 $this->debuffer = '';
385 mcrypt_generic_init($this->demcrypt, $this->key, $this->decryptIV);
387 $ciphertext = substr($ciphertext, strlen($plaintext));
388 } else {
389 $plaintext = '';
392 $last_pos = strlen($ciphertext) & 0xFFFFFFF0;
393 $plaintext.= $last_pos ? mdecrypt_generic($this->demcrypt, substr($ciphertext, 0, $last_pos)) : '';
395 if (strlen($ciphertext) & 0xF) {
396 if (strlen($plaintext)) {
397 $this->decryptIV = substr($ciphertext, $last_pos - 16, 16);
399 $this->decryptIV = mcrypt_generic($this->ecb, $this->decryptIV);
400 $this->debuffer = substr($ciphertext, $last_pos);
401 $plaintext.= $this->debuffer ^ $this->decryptIV;
404 return $plaintext;
407 if ($this->paddable) {
408 // we pad with chr(0) since that's what mcrypt_generic does. to quote from http://php.net/function.mcrypt-generic :
409 // "The data is padded with "\0" to make sure the length of the data is n * blocksize."
410 $ciphertext = str_pad($ciphertext, (strlen($ciphertext) + 15) & 0xFFFFFFF0, chr(0));
413 $plaintext = mdecrypt_generic($this->demcrypt, $ciphertext);
415 if (!$this->continuousBuffer) {
416 mcrypt_generic_init($this->demcrypt, $this->key, $this->iv);
419 return $this->paddable ? $this->_unpad($plaintext) : $plaintext;
422 return parent::decrypt($ciphertext);
426 * Setup mcrypt
428 * Validates all the variables.
430 * @access private
432 function _mcryptSetup()
434 if (!$this->changed) {
435 return;
438 if (!$this->explicit_key_length) {
439 // this just copied from Crypt_Rijndael::_setup()
440 $length = strlen($this->key) >> 2;
441 if ($length > 8) {
442 $length = 8;
443 } else if ($length < 4) {
444 $length = 4;
446 $this->Nk = $length;
447 $this->key_size = $length << 2;
450 switch ($this->Nk) {
451 case 4: // 128
452 $this->key_size = 16;
453 break;
454 case 5: // 160
455 case 6: // 192
456 $this->key_size = 24;
457 break;
458 case 7: // 224
459 case 8: // 256
460 $this->key_size = 32;
463 $this->key = str_pad(substr($this->key, 0, $this->key_size), $this->key_size, chr(0));
464 $this->encryptIV = $this->decryptIV = $this->iv = str_pad(substr($this->iv, 0, 16), 16, chr(0));
466 if (!isset($this->enmcrypt)) {
467 $mode = $this->mode;
468 //$mode = $this->mode == CRYPT_AES_MODE_CTR ? MCRYPT_MODE_ECB : $this->mode;
470 $this->demcrypt = mcrypt_module_open(MCRYPT_RIJNDAEL_128, '', $mode, '');
471 $this->enmcrypt = mcrypt_module_open(MCRYPT_RIJNDAEL_128, '', $mode, '');
472 } // else should mcrypt_generic_deinit be called?
474 mcrypt_generic_init($this->demcrypt, $this->key, $this->iv);
475 mcrypt_generic_init($this->enmcrypt, $this->key, $this->iv);
477 $this->changed = false;
481 * Encrypts a block
483 * Optimized over Crypt_Rijndael's implementation by means of loop unrolling.
485 * @see Crypt_Rijndael::_encryptBlock()
486 * @access private
487 * @param String $in
488 * @return String
490 function _encryptBlock($in)
492 $state = unpack('N*word', $in);
494 $Nr = $this->Nr;
495 $w = $this->w;
496 $t0 = $this->t0;
497 $t1 = $this->t1;
498 $t2 = $this->t2;
499 $t3 = $this->t3;
501 // addRoundKey and reindex $state
502 $state = array(
503 $state['word1'] ^ $w[0][0],
504 $state['word2'] ^ $w[0][1],
505 $state['word3'] ^ $w[0][2],
506 $state['word4'] ^ $w[0][3]
509 // shiftRows + subWord + mixColumns + addRoundKey
510 // we could loop unroll this and use if statements to do more rounds as necessary, but, in my tests, that yields
511 // only a marginal improvement. since that also, imho, hinders the readability of the code, i've opted not to do it.
512 for ($round = 1; $round < $this->Nr; $round++) {
513 $state = array(
514 $t0[$state[0] & 0xFF000000] ^ $t1[$state[1] & 0x00FF0000] ^ $t2[$state[2] & 0x0000FF00] ^ $t3[$state[3] & 0x000000FF] ^ $w[$round][0],
515 $t0[$state[1] & 0xFF000000] ^ $t1[$state[2] & 0x00FF0000] ^ $t2[$state[3] & 0x0000FF00] ^ $t3[$state[0] & 0x000000FF] ^ $w[$round][1],
516 $t0[$state[2] & 0xFF000000] ^ $t1[$state[3] & 0x00FF0000] ^ $t2[$state[0] & 0x0000FF00] ^ $t3[$state[1] & 0x000000FF] ^ $w[$round][2],
517 $t0[$state[3] & 0xFF000000] ^ $t1[$state[0] & 0x00FF0000] ^ $t2[$state[1] & 0x0000FF00] ^ $t3[$state[2] & 0x000000FF] ^ $w[$round][3]
522 // subWord
523 $state = array(
524 $this->_subWord($state[0]),
525 $this->_subWord($state[1]),
526 $this->_subWord($state[2]),
527 $this->_subWord($state[3])
530 // shiftRows + addRoundKey
531 $state = array(
532 ($state[0] & 0xFF000000) ^ ($state[1] & 0x00FF0000) ^ ($state[2] & 0x0000FF00) ^ ($state[3] & 0x000000FF) ^ $this->w[$this->Nr][0],
533 ($state[1] & 0xFF000000) ^ ($state[2] & 0x00FF0000) ^ ($state[3] & 0x0000FF00) ^ ($state[0] & 0x000000FF) ^ $this->w[$this->Nr][1],
534 ($state[2] & 0xFF000000) ^ ($state[3] & 0x00FF0000) ^ ($state[0] & 0x0000FF00) ^ ($state[1] & 0x000000FF) ^ $this->w[$this->Nr][2],
535 ($state[3] & 0xFF000000) ^ ($state[0] & 0x00FF0000) ^ ($state[1] & 0x0000FF00) ^ ($state[2] & 0x000000FF) ^ $this->w[$this->Nr][3]
538 return pack('N*', $state[0], $state[1], $state[2], $state[3]);
542 * Decrypts a block
544 * Optimized over Crypt_Rijndael's implementation by means of loop unrolling.
546 * @see Crypt_Rijndael::_decryptBlock()
547 * @access private
548 * @param String $in
549 * @return String
551 function _decryptBlock($in)
553 $state = unpack('N*word', $in);
555 $Nr = $this->Nr;
556 $dw = $this->dw;
557 $dt0 = $this->dt0;
558 $dt1 = $this->dt1;
559 $dt2 = $this->dt2;
560 $dt3 = $this->dt3;
562 // addRoundKey and reindex $state
563 $state = array(
564 $state['word1'] ^ $dw[$this->Nr][0],
565 $state['word2'] ^ $dw[$this->Nr][1],
566 $state['word3'] ^ $dw[$this->Nr][2],
567 $state['word4'] ^ $dw[$this->Nr][3]
571 // invShiftRows + invSubBytes + invMixColumns + addRoundKey
572 for ($round = $this->Nr - 1; $round > 0; $round--) {
573 $state = array(
574 $dt0[$state[0] & 0xFF000000] ^ $dt1[$state[3] & 0x00FF0000] ^ $dt2[$state[2] & 0x0000FF00] ^ $dt3[$state[1] & 0x000000FF] ^ $dw[$round][0],
575 $dt0[$state[1] & 0xFF000000] ^ $dt1[$state[0] & 0x00FF0000] ^ $dt2[$state[3] & 0x0000FF00] ^ $dt3[$state[2] & 0x000000FF] ^ $dw[$round][1],
576 $dt0[$state[2] & 0xFF000000] ^ $dt1[$state[1] & 0x00FF0000] ^ $dt2[$state[0] & 0x0000FF00] ^ $dt3[$state[3] & 0x000000FF] ^ $dw[$round][2],
577 $dt0[$state[3] & 0xFF000000] ^ $dt1[$state[2] & 0x00FF0000] ^ $dt2[$state[1] & 0x0000FF00] ^ $dt3[$state[0] & 0x000000FF] ^ $dw[$round][3]
581 // invShiftRows + invSubWord + addRoundKey
582 $state = array(
583 $this->_invSubWord(($state[0] & 0xFF000000) ^ ($state[3] & 0x00FF0000) ^ ($state[2] & 0x0000FF00) ^ ($state[1] & 0x000000FF)) ^ $dw[0][0],
584 $this->_invSubWord(($state[1] & 0xFF000000) ^ ($state[0] & 0x00FF0000) ^ ($state[3] & 0x0000FF00) ^ ($state[2] & 0x000000FF)) ^ $dw[0][1],
585 $this->_invSubWord(($state[2] & 0xFF000000) ^ ($state[1] & 0x00FF0000) ^ ($state[0] & 0x0000FF00) ^ ($state[3] & 0x000000FF)) ^ $dw[0][2],
586 $this->_invSubWord(($state[3] & 0xFF000000) ^ ($state[2] & 0x00FF0000) ^ ($state[1] & 0x0000FF00) ^ ($state[0] & 0x000000FF)) ^ $dw[0][3]
589 return pack('N*', $state[0], $state[1], $state[2], $state[3]);
593 // vim: ts=4:sw=4:et:
594 // vim6: fdl=1: