TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
AbstractBackend Class Reference
Inheritance diagram for AbstractBackend:
CommandLineBackend PhpBackend

Public Member Functions

 createNewKeyPair ()
 
 decrypt ($privateKey, $data)
 
 isAvailable ()
 
 getLastError ()
 

Protected Attributes

 $error = ''
 

Detailed Description

This class contains an abstract SSL backend for the TYPO3 RSA authentication service.

There are two steps:

To prepare data for encoding, the createNewKeyPair() method should be called. This method returns an instance of class, which contains the private and public keys. Public key is sent to the client to encode data. Private key should be stored somewhere (preferably in user's session).

To decode data, the decrypt() method should be called with the private key created at the previous step and the data to decode. If the data is decoded successfully, the result is a string. Otherwise it is NULL.

Definition at line 34 of file rsaauth/Classes/Backend/AbstractBackend.php.

Member Function Documentation

createNewKeyPair ( )
abstract

Creates a new key pair for the encryption or gets the existing key pair (if one already has been generated).

There should only be one key pair per request because the second private key would overwrites the first private key. So the submitting the form with the first public key would not work anymore.

Returns
|NULL a key pair or NULL in case of error
decrypt (   $privateKey,
  $data 
)
abstract

Decripts the data using the private key.

Parameters
string$privateKeyThe private key (obtained from a call to createNewKeyPair())
string$dataData to decrypt (base64-encoded)
Returns
string Decrypted data or NULL in case of an error
getLastError ( )

Retrieves an error message.

Returns
string An error message or empty string if there were no error

Definition at line 75 of file rsaauth/Classes/Backend/AbstractBackend.php.

References AbstractBackend\$error.

isAvailable ( )
abstract

Checks if this backend is available for calling.

Returns
bool

Member Data Documentation

$error = ''
protected