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 class contain an RSA key pair. Its purpose is to keep to keys and transfer these keys between other PHP classes.

Definition at line 21 of file Keypair.php.

Member Function Documentation

getExponent()

TYPO3\CMS\Rsaauth\Keypair::getExponent

(

)

Retrieves the exponent.

Returns

int 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 97 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

int the public key modulus

Definition at line 135 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

bool

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

bool

Definition at line 125 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

bool

Definition at line 163 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

bool

Definition at line 49 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

int

$exponent

the new exponent

Returns

void

Exceptions

Definition at line 73 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

int

$publicKeyModulus

the new public key modulus

Returns

void

Exceptions

Definition at line 149 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 28 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 35 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 42 of file Keypair.php.

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