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
|
<html>
<head>
<title>Docs For Class Crypt_AES</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_AES</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_AES.html" class="menu">class tree: Crypt_AES</a> ]
[ <a href="../elementindex_Crypt_AES.html" class="menu">index: Crypt_AES</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_AES/_lib---3rdParty---phpseclib---Crypt---AES.php.html"> AES.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../Crypt_AES/Crypt_AES.html">Crypt_AES</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: Crypt_AES</h1>
Source Location: /lib/3rdParty/phpseclib/Crypt/AES.php<br /><br />
<table width="100%" border="0">
<tr><td valign="top">
<h3><a href="#class_details">Class Overview</a></h3>
<pre><a href="../Crypt_Rijndael/Crypt_Rijndael.html">Crypt_Rijndael</a>
|
--Crypt_AES</pre><br />
<div class="description">Pure-PHP implementation of AES.</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_AES/Crypt_AES.html#methodCrypt_AES">Crypt_AES</a></li>
<li><a href="../Crypt_AES/Crypt_AES.html#methoddecrypt">decrypt</a></li>
<li><a href="../Crypt_AES/Crypt_AES.html#methodencrypt">encrypt</a></li>
<li><a href="../Crypt_AES/Crypt_AES.html#methodsetBlockLength">setBlockLength</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
<td valign="top">
<h3>Inherited Methods</h3>
<div class="tags">
<h4>Class: <a href="../Crypt_Rijndael/Crypt_Rijndael.html">Crypt_Rijndael</a></h4>
<dl>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodCrypt_Rijndael">Crypt_Rijndael::Crypt_Rijndael()</a>
</dt>
<dd>
Default Constructor.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">Crypt_Rijndael::decrypt()</a>
</dt>
<dd>
Decrypts a message.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisableContinuousBuffer">Crypt_Rijndael::disableContinuousBuffer()</a>
</dt>
<dd>
Treat consecutive packets as if they are a discontinuous buffer.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddisablePadding">Crypt_Rijndael::disablePadding()</a>
</dt>
<dd>
Do not pad packets.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenableContinuousBuffer">Crypt_Rijndael::enableContinuousBuffer()</a>
</dt>
<dd>
Treat consecutive "packets" as if they are a continuous buffer.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodenablePadding">Crypt_Rijndael::enablePadding()</a>
</dt>
<dd>
Pad "packets".
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">Crypt_Rijndael::encrypt()</a>
</dt>
<dd>
Encrypts a message.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetBlockLength">Crypt_Rijndael::setBlockLength()</a>
</dt>
<dd>
Sets the block length
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetIV">Crypt_Rijndael::setIV()</a>
</dt>
<dd>
Sets the initialization vector. (optional)
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetKey">Crypt_Rijndael::setKey()</a>
</dt>
<dd>
Sets the key.
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetKeyLength">Crypt_Rijndael::setKeyLength()</a>
</dt>
<dd>
Sets the key length
</dd>
<dt>
<a href="../Crypt_Rijndael/Crypt_Rijndael.html#method_generate_xor">Crypt_Rijndael::_generate_xor()</a>
</dt>
<dd>
Generate CTR XOR encryption key
</dd>
</dl>
</div>
</td>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 132]<br />
Pure-PHP implementation of AES.<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_AES"></a>
<h3>constructor Crypt_AES <span class="smalllinenumber">[line 177]</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_AES/Crypt_AES.html">Crypt_AES</a> Crypt_AES(
[optional
$mode = CRYPT_AES_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_AES_MODE_ECB or CRYPT_AES_MODE_CBC. If not explictly set, CRYPT_AES_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 356]</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 16, 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_AES/Crypt_AES.html#methodencrypt">Crypt_AES::encrypt()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
Overrides <a href="../Crypt_Rijndael/Crypt_Rijndael.html#methoddecrypt">Crypt_Rijndael::decrypt()</a> (Decrypts a message.)<br /><br />
<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="methodencrypt"></a>
<h3>method encrypt <span class="smalllinenumber">[line 278]</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 up to 16 additional bytes. Other AES 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 16, 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_AES/Crypt_AES.html#methoddecrypt">Crypt_AES::decrypt()</a></td>
</tr>
<tr>
<td><b>access:</b> </td><td>public</td>
</tr>
</table>
</div>
<br /><br />
Overrides <a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodencrypt">Crypt_Rijndael::encrypt()</a> (Encrypts a message.)<br /><br />
<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 256]</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 />
Dummy function<br /><br /><p>Since Crypt_AES extends Crypt_Rijndael, this function is, technically, available, but it doesn't do anything.</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 />
Overrides <a href="../Crypt_Rijndael/Crypt_Rijndael.html#methodsetBlockLength">Crypt_Rijndael::setBlockLength()</a> (Sets the block length)<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>
</div><br />
<div class="credit">
<hr />
Documentation generated on Sun, 25 Mar 2012 19:35:22 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|