[TASK] Clean up phpDoc comments in typo3/sysext/rsaauth
[Packages/TYPO3.CMS.git] / typo3 / sysext / rsaauth / sv1 / backends / class.tx_rsaauth_keypair.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009-2011 Dmitry Dulepov <dmitry@typo3.org>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24
25 /**
26 * This class contain an RSA keypair class. Its purpose is to keep to keys
27 * and trasnfer these keys between other PHP classes.
28 *
29 * @author Dmitry Dulepov <dmitry@typo3.org>
30 * @package TYPO3
31 * @subpackage tx_rsaauth
32 */
33 final class tx_rsaauth_keypair {
34
35 /**
36 * RSA public exponent (3 or 0x10001)
37 *
38 * @var integer
39 */
40 protected $exponent = 0x10001;
41
42 /**
43 * The private key
44 *
45 * @var string
46 */
47 protected $privateKey = '';
48
49 /**
50 * The public key modulus
51 *
52 * @var string
53 */
54 protected $publicKeyModulus = '';
55
56 /**
57 * Retrieves the exponent.
58 *
59 * @return string The exponent
60 */
61 public function getExponent() {
62 return $this->exponent;
63 }
64
65 /**
66 * Sets the private key
67 *
68 * @param string $privateKey The new private key
69 * @return void
70 */
71 public function setExponent($exponent) {
72 $this->exponent = $exponent;
73 }
74
75 /**
76 * Retrieves the private key.
77 *
78 * @return string The private key
79 */
80 public function getPrivateKey() {
81 return $this->privateKey;
82 }
83
84 /**
85 * Sets the private key
86 *
87 * @param string $privateKey The new private key
88 * @return void
89 */
90 public function setPrivateKey($privateKey) {
91 $this->privateKey = $privateKey;
92 }
93
94 /**
95 * Retrieves the public key modulus
96 *
97 * @return string The public key modulus
98 */
99 public function getPublicKeyModulus() {
100 return $this->publicKeyModulus;
101 }
102
103 /**
104 * Sets the public key modulus
105 *
106 * @param string $publicKeyModulus The new public key modulus
107 * @return void
108 */
109 public function setPublicKey($publicKeyModulus) {
110 $this->publicKeyModulus = $publicKeyModulus;
111 }
112 }
113 ?>