TYPO3\CMS\Rsaauth\Keypair Class Reference

Inheritance diagram for TYPO3\CMS\Rsaauth\Keypair:

Public Member Functions
	isReady ()
	getExponent ()
	setExponent ($exponent)
	getPrivateKey ()
	setPrivateKey ($privateKey)
	getPublicKeyModulus ()
	setPublicKey ($publicKeyModulus)

Protected Member Functions
	hasExponent ()
	hasPrivateKey ()
	hasPublicKeyModulus ()

Protected Attributes
	$exponent = 0
	$privateKey = ''
	$publicKeyModulus = 0

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! This class contain an RSA key pair. Its purpose is to keep to keys and transfer these keys between other PHP classes.

Author

Dmitry Dulepov dmitr.nosp@m.y@ty.nosp@m.po3.o.nosp@m.rg

Definition at line 23 of file Keypair.php.

Member Function Documentation

getExponent()

TYPO3\CMS\Rsaauth\Keypair::getExponent

(

)

Retrieves the exponent.

Returns

integer the exponent

Definition at line 59 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$exponent.

Referenced by TYPO3\CMS\Rsaauth\Keypair\hasExponent().

getPrivateKey()

TYPO3\CMS\Rsaauth\Keypair::getPrivateKey

(

)

Retrieves the private key.

Returns

string The private key

Definition at line 96 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$privateKey.

Referenced by TYPO3\CMS\Rsaauth\Keypair\hasPrivateKey().

getPublicKeyModulus()

TYPO3\CMS\Rsaauth\Keypair::getPublicKeyModulus

(

)

Retrieves the public key modulus

Returns

integer the public key modulus

Definition at line 133 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$publicKeyModulus.

Referenced by TYPO3\CMS\Rsaauth\Keypair\hasPublicKeyModulus().

hasExponent()

TYPO3\CMS\Rsaauth\Keypair::hasExponent ( )

protected

Checks whether an exponent already has been set.

Returns

boolean

Definition at line 87 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\getExponent().

Referenced by TYPO3\CMS\Rsaauth\Keypair\isReady(), and TYPO3\CMS\Rsaauth\Keypair\setExponent().

hasPrivateKey()

TYPO3\CMS\Rsaauth\Keypair::hasPrivateKey ( )

protected

Checks whether a private key already has been set.

Returns

boolean

Definition at line 124 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\getPrivateKey().

Referenced by TYPO3\CMS\Rsaauth\Keypair\isReady(), and TYPO3\CMS\Rsaauth\Keypair\setPrivateKey().

hasPublicKeyModulus()

TYPO3\CMS\Rsaauth\Keypair::hasPublicKeyModulus ( )

protected

Checks whether a public key modulus already has been set.

Returns

boolean

Definition at line 161 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\getPublicKeyModulus().

Referenced by TYPO3\CMS\Rsaauth\Keypair\isReady(), and TYPO3\CMS\Rsaauth\Keypair\setPublicKey().

isReady()

TYPO3\CMS\Rsaauth\Keypair::isReady

(

)

Checks if this key pair already has been provided with all data.

Returns

boolean

Definition at line 50 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\hasExponent(), TYPO3\CMS\Rsaauth\Keypair\hasPrivateKey(), and TYPO3\CMS\Rsaauth\Keypair\hasPublicKeyModulus().

setExponent()

TYPO3\CMS\Rsaauth\Keypair::setExponent

(

$exponent

)

Sets the exponent

Note: This method must not be called more than one time.

Parameters

integer

$exponent

the new exponent

Returns

void

Exceptions

Definition at line 74 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$exponent, and TYPO3\CMS\Rsaauth\Keypair\hasExponent().

setPrivateKey()

TYPO3\CMS\Rsaauth\Keypair::setPrivateKey

(

$privateKey

)

Sets the private key.

Note: This method must not be called more than one time.

Parameters

string

$privateKey

The new private key

Returns

void

Exceptions

Definition at line 111 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$privateKey, and TYPO3\CMS\Rsaauth\Keypair\hasPrivateKey().

setPublicKey()

TYPO3\CMS\Rsaauth\Keypair::setPublicKey

(

$publicKeyModulus

)

Sets the public key modulus.

Note: This method must not be called more than one time.

Parameters

integer

$publicKeyModulus

the new public key modulus

Returns

void

Exceptions

Definition at line 148 of file Keypair.php.

References TYPO3\CMS\Rsaauth\Keypair\$publicKeyModulus, and TYPO3\CMS\Rsaauth\Keypair\hasPublicKeyModulus().

Member Data Documentation

$exponent

TYPO3\CMS\Rsaauth\Keypair::$exponent = 0

protected

Definition at line 29 of file Keypair.php.

Referenced by TYPO3\CMS\Rsaauth\Keypair\getExponent(), and TYPO3\CMS\Rsaauth\Keypair\setExponent().

$privateKey

TYPO3\CMS\Rsaauth\Keypair::$privateKey = ''

protected

Definition at line 36 of file Keypair.php.

Referenced by TYPO3\CMS\Rsaauth\Keypair\getPrivateKey(), and TYPO3\CMS\Rsaauth\Keypair\setPrivateKey().

$publicKeyModulus

TYPO3\CMS\Rsaauth\Keypair::$publicKeyModulus = 0

protected

Definition at line 43 of file Keypair.php.

Referenced by TYPO3\CMS\Rsaauth\Keypair\getPublicKeyModulus(), and TYPO3\CMS\Rsaauth\Keypair\setPublicKey().