Docs For Class Crypt_KeyStore_SPI

Description

Implements interfaces:

Crypt_KeyStore_SecretKey

Default implementation of the SecretKey interface for use with mycrypt/mhash.

author: Steve Wamsley <swamsley@gmail.com>
version: Release: @package_version@
copyright: 2008 Katanaa
link: http://phpkeystore.org/Crypt_KeyStore
license: LGPL License 2.1

Located in /Crypt/KeyStore/SPI/DefaultSecretKey.php (line 35)

Method Summary

Crypt_KeyStore_SPI_DefaultSecretKey __construct (string $keyData, string $algorithm, int $size)

string getAlgorithm ()

string getEncoded ()

string getFormat ()

int getSize ()

string __toString ()

Methods

Constructor __construct (line 50)

Constructs a DefaultSecretKey using the $keyData and $algorithm.

access: public

Crypt_KeyStore_SPI_DefaultSecretKey __construct (string $keyData, string $algorithm, int $size)

string $keyData: the PEM encoded public key data
string $algorithm: the algorithm used to genereate the key
int $size: the size of the key in # of characters

getAlgorithm (line 63)

Returns the standard algorithm name for this key.

return: the name of the algorithm associated with this key
access: public

string getAlgorithm ()

Implementation of:

Crypt_KeyStore_Key::getAlgorithm(): Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key.

getEncoded (line 85)

Returns the key in its primary encoding format, or null if this key does not support encoding.

return: the encoded key, or null if the key does not support encoding.
access: public

string getEncoded ()

Implementation of:

Crypt_KeyStore_Key::getEncoded(): Returns the key in its primary encoding format, or null if this key does not support encoding.

getFormat (line 97)

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. For symmetric, secret keys, the formatting is 'HEX'.

return: the primary encoding format of the key
access: public

string getFormat ()

Implementation of:

Crypt_KeyStore_Key::getFormat(): Returns the name of the primary encoding format of this key, or null if

getSize (line 74)

Returns the size of the key in # of characters. In other words, a 256-bit key would be 32 characters (8 bits/character).

return: the size of key in # of characters.
access: public

int getSize ()

__toString (line 107)

Returns a string representation of this key.

access: public

string __toString ()

Class Crypt_KeyStore_SPI_DefaultSecretKey