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 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
|
<html>
<head>
<title>Docs For Class Crypt_Rijndael</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>
<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
<tr>
<td class="header_top">Crypt_Rijndael</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
<tr>
<td class="header_menu">
[ <a href="../classtrees_Crypt_Rijndael.html" class="menu">class tree: Crypt_Rijndael</a> ]
[ <a href="../elementindex_Crypt_Rijndael.html" class="menu">index: Crypt_Rijndael</a> ]
[ <a href="../elementindex.html" class="menu">all elements</a> ]
</td>
</tr>
<tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
</table>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="200" class="menu">
<div id="ric">
<p><a href="../ric_README.html">README</a></p>
</div>
<div id="todolist">
<p><a href="../todolist.html">Todo List</a></p>
</div>
<b>Packages:</b><br />
<a href="../li_main.html">main</a><br />
<a href="../li_configuration.html">configuration</a><br />
<a href="../li_Crypt_AES.html">Crypt_AES</a><br />
<a href="../li_Crypt_DES.html">Crypt_DES</a><br />
<a href="../li_Crypt_Hash.html">Crypt_Hash</a><br />
<a href="../li_Crypt_Random.html">Crypt_Random</a><br />
<a href="../li_Crypt_RC4.html">Crypt_RC4</a><br />
<a href="../li_Crypt_Rijndael.html">Crypt_Rijndael</a><br />
<a href="../li_Crypt_RSA.html">Crypt_RSA</a><br />
<a href="../li_Crypt_TerraDES.html">Crypt_TerraDES</a><br />
<a href="../li_Crypt_TripleDES.html">Crypt_TripleDES</a><br />
<a href="../li_default.html">default</a><br />
<a href="../li_Help.html">Help</a><br />
<a href="../li_horde-cipher.html">horde-cipher</a><br />
<a href="../li_lam.html">lam</a><br />
<a href="../li_LDAP.html">LDAP</a><br />
<a href="../li_lib.html">lib</a><br />
<a href="../li_lists.html">lists</a><br />
<a href="../li_Math_BigInteger.html">Math_BigInteger</a><br />
<a href="../li_metaHTML.html">metaHTML</a><br />
<a href="../li_modules.html">modules</a><br />
<a href="../li_Net_SFTP.html">Net_SFTP</a><br />
<a href="../li_Net_SSH1.html">Net_SSH1</a><br />
<a href="../li_Net_SSH2.html">Net_SSH2</a><br />
<a href="../li_PDF.html">PDF</a><br />
<a href="../li_phpLDAPadmin.html">phpLDAPadmin</a><br />
<a href="../li_PHP_Compat.html">PHP_Compat</a><br />
<a href="../li_profiles.html">profiles</a><br />
<a href="../li_selfService.html">selfService</a><br />
<a href="../li_tools.html">tools</a><br />
<a href="../li_types.html">types</a><br />
<br /><br />
<b>Files:</b><br />
<div class="package">
<a href="../Crypt_Rijndael/_lib---3rdParty---phpseclib---Crypt---Rijndael.php.html"> Rijndael.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../Crypt_Rijndael/Crypt_Rijndael.html">Crypt_Rijndael</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: Crypt_Rijndael</h1>
Source Location: /lib/3rdParty/phpseclib/Crypt/Rijndael.php<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Pure-PHP implementation of Rijndael.</div><br /><br />
<h4>Author(s):</h4>
<ul>
<li>Jim Wigginton <<a href="mailto:terrafrost@php.net">terrafrost@php.net</a>></li>
</ul>
<h4>Version:</h4>
<ul>
<li>0.1.0</li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodCrypt_Rijndael">Crypt_Rijndael</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">decrypt</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisableContinuousBuffer">disableContinuousBuffer</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisablePadding">disablePadding</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenableContinuousBuffer">enableContinuousBuffer</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenablePadding">enablePadding</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetBlockLength">setBlockLength</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetIV">setIV</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetKey">setKey</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetKeyLength">setKeyLength</a></li>
<li><a href="../Crypt_Rijndael/Crypt_Rijndael.html#method_generate_xor">_generate_xor</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
<td valign="top">
<h3>Child classes:</h3>
<div class="tags">
<dl>
<dt><a href="../Crypt_AES/Crypt_AES.html">Crypt_AES</a></dt>
<dd>Pure-PHP implementation of AES.</dd>
</dl>
</div>
</td>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 135]<br />
Pure-PHP implementation of Rijndael.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>author:</b> </td><td>Jim Wigginton <<a href="mailto:terrafrost@php.net">terrafrost@php.net</a>></td>
</tr>
<tr>
<td><b>version:</b> </td><td>0.1.0</td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodCrypt_Rijndael"></a>
<h3>constructor Crypt_Rijndael <span class="smalllinenumber">[line 411]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code><a href="../Crypt_Rijndael/Crypt_Rijndael.html">Crypt_Rijndael</a> Crypt_Rijndael(
[optional
$mode = CRYPT_RIJNDAEL_MODE_CBC])</code>
</td></tr></table>
</td></tr></table><br />
Default Constructor.<br /><br /><p>Determines whether or not the mcrypt extension should be used. $mode should only, at present, be CRYPT_RIJNDAEL_MODE_ECB or CRYPT_RIJNDAEL_MODE_CBC. If not explictly set, CRYPT_RIJNDAEL_MODE_CBC will be used.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">optional </td>
<td><b>$mode</b> </td>
<td>Integer $mode</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methoddecrypt"></a>
<h3>method decrypt <span class="smalllinenumber">[line 778]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void decrypt(
String
$ciphertext)</code>
</td></tr></table>
</td></tr></table><br />
Decrypts a message.<br /><br /><p>If strlen($ciphertext) is not a multiple of the block size, null bytes will be added to the end of the string until it is.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">Crypt_Rijndael::encrypt()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../Crypt_AES/Crypt_AES.html#methoddecrypt">Crypt_AES::decrypt()</a></dt>
<dd>Decrypts a message.</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String </td>
<td><b>$ciphertext</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methoddisableContinuousBuffer"></a>
<h3>method disableContinuousBuffer <span class="smalllinenumber">[line 1398]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void disableContinuousBuffer(
)</code>
</td></tr></table>
</td></tr></table><br />
Treat consecutive packets as if they are a discontinuous buffer.<br /><br /><p>The default behavior.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenableContinuousBuffer">Crypt_Rijndael::enableContinuousBuffer()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methoddisablePadding"></a>
<h3>method disablePadding <span class="smalllinenumber">[line 1288]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void disablePadding(
)</code>
</td></tr></table>
</td></tr></table><br />
Do not pad packets.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenablePadding">Crypt_Rijndael::enablePadding()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodenableContinuousBuffer"></a>
<h3>method enableContinuousBuffer <span class="smalllinenumber">[line 1385]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void enableContinuousBuffer(
)</code>
</td></tr></table>
</td></tr></table><br />
Treat consecutive "packets" as if they are a continuous buffer.<br /><br /><p>Say you have a 32-byte plaintext $plaintext. Using the default behavior, the two following code snippets will yield different outputs:</p><p><ol><li><div class="src-line"> echo <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> echo <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
</ol> <ol><li><div class="src-line"> echo <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></p><p>The solution is to enable the continuous buffer. Although this will resolve the above discrepancy, it creates another, as demonstrated with the following:</p><p><ol><li><div class="src-line"> <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">))</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"> echo <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">decrypt</a><span class="src-sym">(</span><span class="src-var">$des</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">)))</span><span class="src-sym">;</span></div></li>
</ol> <ol><li><div class="src-line"> echo <span class="src-var">$rijndael</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">decrypt</a><span class="src-sym">(</span><span class="src-var">$des</span><span class="src-sym">-></span><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">encrypt</a><span class="src-sym">(</span><a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><span class="src-var">$plaintext</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">, </span><span class="src-num">16</span><span class="src-sym">)))</span><span class="src-sym">;</span></div></li>
</ol></p><p>With the continuous buffer disabled, these would yield the same output. With it enabled, they yield different outputs. The reason is due to the fact that the initialization vector's change after every encryption / decryption round when the continuous buffer is enabled. When it's disabled, they remain constant.</p><p>Put another way, when the continuous buffer is enabled, the state of the Crypt_Rijndael() object changes after each encryption / decryption round, whereas otherwise, it'd remain constant. For this reason, it's recommended that continuous buffers not be used. They do offer better security and are, in fact, sometimes required (SSH uses them), however, they are also less intuitive and more likely to cause you problems.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisableContinuousBuffer">Crypt_Rijndael::disableContinuousBuffer()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodenablePadding"></a>
<h3>method enablePadding <span class="smalllinenumber">[line 1277]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void enablePadding(
)</code>
</td></tr></table>
</td></tr></table><br />
Pad "packets".<br /><br /><p>Rijndael works by encrypting between sixteen and thirty-two bytes at a time, provided that number is also a multiple of four. If you ever need to encrypt or decrypt something that isn't of the proper length, it becomes necessary to pad the input so that it is of the proper length.</p><p>Padding is enabled by default. Sometimes, however, it is undesirable to pad strings. Such is the case in SSH, where "packets" are padded with random bytes before being encrypted. Unpad these packets and you risk stripping away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is transmitted separately)</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisablePadding">Crypt_Rijndael::disablePadding()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodencrypt"></a>
<h3>method encrypt <span class="smalllinenumber">[line 659]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void encrypt(
String
$plaintext)</code>
</td></tr></table>
</td></tr></table><br />
Encrypts a message.<br /><br /><p>$plaintext will be padded with additional bytes such that it's length is a multiple of the block size. Other Rjindael implementations may or may not pad in the same manner. Other common approaches to padding and the reasons why it's necessary are discussed in the following URL:</p><p><a href="http://www.di-mgt.com.au/cryptopad.html">http://www.di-mgt.com.au/cryptopad.html</a></p><p>An alternative to padding is to, separately, send the length of the file. This is what SSH, in fact, does. strlen($plaintext) will still need to be a multiple of 8, however, arbitrary values can be added to make it that length.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">Crypt_Rijndael::decrypt()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../Crypt_AES/Crypt_AES.html#methodencrypt">Crypt_AES::encrypt()</a></dt>
<dd>Encrypts a message.</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String </td>
<td><b>$plaintext</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetBlockLength"></a>
<h3>method setBlockLength <span class="smalllinenumber">[line 589]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setBlockLength(
Integer
$length)</code>
</td></tr></table>
</td></tr></table><br />
Sets the block length<br /><br /><p>Valid block lengths are 128, 160, 192, 224, and 256. If the length is less than 128, it will be rounded up to 128. If the length is greater then 128 and invalid, it will be rounded down to the closest valid amount.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<p>Overridden in child classes as:<br />
<dl>
<dt><a href="../Crypt_AES/Crypt_AES.html#methodsetBlockLength">Crypt_AES::setBlockLength()</a></dt>
<dd>Dummy function</dd>
</dl>
</p>
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Integer </td>
<td><b>$length</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetIV"></a>
<h3>method setIV <span class="smalllinenumber">[line 551]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setIV(
String
$iv)</code>
</td></tr></table>
</td></tr></table><br />
Sets the initialization vector. (optional)<br /><br /><p>SetIV is not required when CRYPT_RIJNDAEL_MODE_ECB is being used. If not explictly set, it'll be assumed to be all zero's.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String </td>
<td><b>$iv</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetKey"></a>
<h3>method setKey <span class="smalllinenumber">[line 536]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setKey(
String
$key)</code>
</td></tr></table>
</td></tr></table><br />
Sets the key.<br /><br /><p>Keys can be of any length. Rijndael, itself, requires the use of a key that's between 128-bits and 256-bits long and whose length is a multiple of 32. If the key is less than 256-bits and the key length isn't set, we round the length up to the closest valid key length, padding $key with null bytes. If the key is more than 256-bits, we trim the excess bits.</p><p>If the key is not explicitly set, it'll be assumed to be all null bytes.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">String </td>
<td><b>$key</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetKeyLength"></a>
<h3>method setKeyLength <span class="smalllinenumber">[line 565]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void setKeyLength(
Integer
$length)</code>
</td></tr></table>
</td></tr></table><br />
Sets the key length<br /><br /><p>Valid key lengths are 128, 160, 192, 224, and 256. If the length is less than 128, it will be rounded up to 128. If the length is greater then 128 and invalid, it will be rounded down to the closest valid amount.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Integer </td>
<td><b>$length</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_generate_xor"></a>
<h3>method _generate_xor <span class="smalllinenumber">[line 614]</span></h3>
<div class="function">
<table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
<table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
<code>void _generate_xor(
Integer
$length,
&$iv, String
$iv)</code>
</td></tr></table>
</td></tr></table><br />
Generate CTR XOR encryption key<br /><br /><p>Encrypt the output of this and XOR it against the ciphertext / plaintext to get the plaintext / ciphertext in CTR mode.</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">Crypt_Rijndael::decrypt()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">Crypt_Rijndael::encrypt()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
<h4>Parameters:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td class="type">Integer </td>
<td><b>$length</b> </td>
<td></td>
</tr>
<tr>
<td class="type">String </td>
<td><b>$iv</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>&$iv</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
</div><br />
<div class="credit">
<hr />
Documentation generated on Sun, 25 Mar 2012 19:35:53 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|