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 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
|
<html>
<head>
<title>Docs For Class Crypt_RSA</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_RSA</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_RSA.html" class="menu">class tree: Crypt_RSA</a> ]
[ <a href="../elementindex_Crypt_RSA.html" class="menu">index: Crypt_RSA</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_RSA/_lib---3rdParty---phpseclib---Crypt---RSA.php.html"> RSA.php
</a><br>
</div><br />
<b>Classes:</b><br />
<div class="package">
<a href="../Crypt_RSA/Crypt_RSA.html">Crypt_RSA</a><br />
</div>
</td>
<td>
<table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
<h1>Class: Crypt_RSA</h1>
Source Location: /lib/3rdParty/phpseclib/Crypt/RSA.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 PKCS#1 compliant implementation of RSA.</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_vars">Variables</a></h3>
<ul>
<li><a href="../Crypt_RSA/Crypt_RSA.html#var$publicKeyFormat">$publicKeyFormat</a></li>
</ul>
</td>
<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodCrypt_RSA">Crypt_RSA</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodcreateKey">createKey</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methoddecrypt">decrypt</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodencrypt">encrypt</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodgetPublicKey">getPublicKey</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodloadKey">loadKey</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetEncryptionMode">setEncryptionMode</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetHash">setHash</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetMGFHash">setMGFHash</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetPassword">setPassword</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetPrivateKeyFormat">setPrivateKeyFormat</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetPublicKey">setPublicKey</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetPublicKeyFormat">setPublicKeyFormat</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetSaltLength">setSaltLength</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsetSignatureMode">setSignatureMode</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodsign">sign</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#methodverify">verify</a></li>
<li><a href="../Crypt_RSA/Crypt_RSA.html#method_random">_random</a></li>
</ul>
</td>
</tr></table>
<hr />
<table width="100%" border="0"><tr>
</tr></table>
<hr />
<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 229]<br />
Pure-PHP PKCS#1 compliant implementation of RSA.<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_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
<a name="var$publicKeyFormat"></a>
<p></p>
<h4>$publicKeyFormat = <span class="value"> CRYPT_RSA_PUBLIC_FORMAT_PKCS1</span></h4>
<p>[line 260]</p>
Public Key Format<br /><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 />
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td><b>Type:</b> </td>
<td>Integer</td>
</tr>
</table>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />
<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
<hr />
<a name="methodCrypt_RSA"></a>
<h3>constructor Crypt_RSA <span class="smalllinenumber">[line 424]</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_RSA/Crypt_RSA.html">Crypt_RSA</a> Crypt_RSA(
)</code>
</td></tr></table>
</td></tr></table><br />
The constructor<br /><br /><p>If you want to make use of the openssl extension, you'll need to set the mode manually, yourself. The reason Crypt_RSA doesn't do it is because OpenSSL doesn't fail gracefully. openssl_pkey_new(), in particular, requires openssl.cnf be present somewhere and, unfortunately, the only real way to find out is too late.</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 />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodcreateKey"></a>
<h3>method createKey <span class="smalllinenumber">[line 460]</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 createKey(
[optional
$bits = 1024], [optional
$timeout = false], [optional
$partial = array()])</code>
</td></tr></table>
</td></tr></table><br />
Create public / private key pair<br /><br /><p>Returns an array with the following three elements: <ul><li>'privatekey': The private key.</li><li>'publickey': The public key.</li><li>'partialkey': A partially computed key (if the execution time exceeded $timeout).
Will need to be passed back to Crypt_RSA::createKey() as the third parameter for further processing.</li></ul></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>$bits</b> </td>
<td>Integer $bits</td>
</tr>
<tr>
<td class="type">optional </td>
<td><b>$timeout</b> </td>
<td>Integer $timeout</td>
</tr>
<tr>
<td class="type">optional </td>
<td><b>$partial</b> </td>
<td>Math_BigInteger $p</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 2281]</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>String decrypt(
$ciphertext, String
$plaintext)</code>
</td></tr></table>
</td></tr></table><br />
Decryption<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_RSA/Crypt_RSA.html#methodencrypt">Crypt_RSA::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">String </td>
<td><b>$plaintext</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </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 2242]</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>String encrypt(
String
$plaintext)</code>
</td></tr></table>
</td></tr></table><br />
Encryption<br /><br /><p>Both CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1 both place limits on how long $plaintext can be. If $plaintext exceeds those limits it will be broken up so that it does and the resultant ciphertext's will be concatenated together.</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_RSA/Crypt_RSA.html#methoddecrypt">Crypt_RSA::decrypt()</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">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="methodgetPublicKey"></a>
<h3>method getPublicKey <span class="smalllinenumber">[line 1260]</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 getPublicKey(
[Integer
$type = CRYPT_RSA_PUBLIC_FORMAT_PKCS1], String
$key)</code>
</td></tr></table>
</td></tr></table><br />
Returns the public key<br /><br /><p>The public key is only returned under two circumstances - if the private key had the public key embedded within it or if the public key was set via setPublicKey(). If the currently loaded key is supposed to be the public key this function won't return it since this library, for the most part, doesn't distinguish between public and private keys.</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_RSA/Crypt_RSA.html#methodgetPublicKey">Crypt_RSA::getPublicKey()</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">String </td>
<td><b>$key</b> </td>
<td></td>
</tr>
<tr>
<td class="type">Integer </td>
<td><b>$type</b> </td>
<td>optional</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodloadKey"></a>
<h3>method loadKey <span class="smalllinenumber">[line 1156]</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 loadKey(
String
$key, [Integer
$type = false])</code>
</td></tr></table>
</td></tr></table><br />
Loads a public or private key<br /><br /><p>Returns true on success and false on failure (ie. an incorrect password was provided or the key was malformed)</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>
<tr>
<td class="type">Integer </td>
<td><b>$type</b> </td>
<td>optional</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetEncryptionMode"></a>
<h3>method setEncryptionMode <span class="smalllinenumber">[line 2212]</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 setEncryptionMode(
Integer
$mode)</code>
</td></tr></table>
</td></tr></table><br />
Set Encryption Mode<br /><br /><p>Valid values include CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1.</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>$mode</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetHash"></a>
<h3>method setHash <span class="smalllinenumber">[line 1390]</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 setHash(
String
$hash)</code>
</td></tr></table>
</td></tr></table><br />
Determines which hashing function should be used<br /><br /><p>Used with signature production / verification and (if the encryption mode is CRYPT_RSA_ENCRYPTION_OAEP) encryption and decryption. If $hash isn't supported, sha1 is 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">String </td>
<td><b>$hash</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetMGFHash"></a>
<h3>method setMGFHash <span class="smalllinenumber">[line 1419]</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 setMGFHash(
String
$hash)</code>
</td></tr></table>
</td></tr></table><br />
Determines which hashing function should be used for the mask generation function<br /><br /><p>The mask generation function is used by CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_SIGNATURE_PSS and although it's best if Hash and MGFHash are set to the same thing this is not a requirement.</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>$hash</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPassword"></a>
<h3>method setPassword <span class="smalllinenumber">[line 1210]</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 setPassword(
String
$password)</code>
</td></tr></table>
</td></tr></table><br />
Sets the password<br /><br /><p>Private keys can be encrypted with a password. To unset the password, pass in the empty string or false. Or rather, pass in $password such that empty($password) is true.</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_RSA/Crypt_RSA.html#methodcreateKey">Crypt_RSA::createKey()</a></td>
</tr>
<tr>
<td><b>see:</b> </td><td><a href="../Crypt_RSA/Crypt_RSA.html#methodloadKey">Crypt_RSA::loadKey()</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">String </td>
<td><b>$password</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPrivateKeyFormat"></a>
<h3>method setPrivateKeyFormat <span class="smalllinenumber">[line 1364]</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 setPrivateKeyFormat(
Integer
$format)</code>
</td></tr></table>
</td></tr></table><br />
Determines the private key format<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_RSA/Crypt_RSA.html#methodcreateKey">Crypt_RSA::createKey()</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>$format</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPublicKey"></a>
<h3>method setPublicKey <span class="smalllinenumber">[line 1234]</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>Boolean setPublicKey(
String
$key, [Integer
$type = CRYPT_RSA_PUBLIC_FORMAT_PKCS1])</code>
</td></tr></table>
</td></tr></table><br />
Defines the public key<br /><br /><p>Some private key formats define the public exponent and some don't. Those that don't define it are problematic when used in certain contexts. For example, in SSH-2, RSA authentication works by sending the public key along with a message signed by the private key to the server. The SSH-2 server looks the public key up in an index of public keys and if it's present then proceeds to verify the signature. Problem is, if your private key doesn't include the public exponent this won't work unless you manually add the public exponent.</p><p>Do note that when a new key is loaded the index will be cleared.</p><p>Returns true on success, false on failure</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_RSA/Crypt_RSA.html#methodgetPublicKey">Crypt_RSA::getPublicKey()</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">String </td>
<td><b>$key</b> </td>
<td></td>
</tr>
<tr>
<td class="type">Integer </td>
<td><b>$type</b> </td>
<td>optional</td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetPublicKeyFormat"></a>
<h3>method setPublicKeyFormat <span class="smalllinenumber">[line 1376]</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 setPublicKeyFormat(
Integer
$format)</code>
</td></tr></table>
</td></tr></table><br />
Determines the public key format<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_RSA/Crypt_RSA.html#methodcreateKey">Crypt_RSA::createKey()</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>$format</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetSaltLength"></a>
<h3>method setSaltLength <span class="smalllinenumber">[line 1448]</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 setSaltLength(
$sLen, Integer
$format)</code>
</td></tr></table>
</td></tr></table><br />
Determines the salt length<br /><br /><p>To quote from <a href="http://tools.ietf.org/html/rfc3447#page-38">RFC3447#page-38</a>:</p><p>Typical salt lengths in octets are hLen (the length of the output of the hash function Hash) and 0.</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>$format</b> </td>
<td></td>
</tr>
<tr>
<td class="type"> </td>
<td><b>$sLen</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsetSignatureMode"></a>
<h3>method setSignatureMode <span class="smalllinenumber">[line 2225]</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 setSignatureMode(
Integer
$mode)</code>
</td></tr></table>
</td></tr></table><br />
Set Signature Mode<br /><br /><p>Valid values include CRYPT_RSA_SIGNATURE_PSS and CRYPT_RSA_SIGNATURE_PKCS1</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>$mode</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodsign"></a>
<h3>method sign <span class="smalllinenumber">[line 2318]</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>String sign(
String
$message)</code>
</td></tr></table>
</td></tr></table><br />
Create a signature<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_RSA/Crypt_RSA.html#methodverify">Crypt_RSA::verify()</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">String </td>
<td><b>$message</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="methodverify"></a>
<h3>method verify <span class="smalllinenumber">[line 2342]</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>Boolean verify(
String
$message, String
$signature)</code>
</td></tr></table>
</td></tr></table><br />
Verifies a signature<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_RSA/Crypt_RSA.html#methodsign">Crypt_RSA::sign()</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">String </td>
<td><b>$message</b> </td>
<td></td>
</tr>
<tr>
<td class="type">String </td>
<td><b>$signature</b> </td>
<td></td>
</tr>
</table>
</div><br />
<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<hr />
<a name="method_random"></a>
<h3>method _random <span class="smalllinenumber">[line 1461]</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>String _random(
Integer
$bytes, [optional
$nonzero = false])</code>
</td></tr></table>
</td></tr></table><br />
Generates a random string x bytes long<br /><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>$bytes</b> </td>
<td></td>
</tr>
<tr>
<td class="type">optional </td>
<td><b>$nonzero</b> </td>
<td>Integer $nonzero</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:54 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
</div>
</td></tr></table>
</td>
</tr>
</table>
</body>
</html>
|