JKeychain

class JKeychain extends Registry

Keychain Class

Properties

string $method
string $iv

Methods

boolean
createPassphraseFile( string $passphrase, string $passphraseFile, string $privateKeyFile, string $privateKeyPassphrase)

Create a passphrase file

mixed
deleteValue( string $path)

Delete a registry value (very simple method)

boolean
loadKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile)

Load a keychain file into this object.

boolean
saveKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile)

Save this keychain to a file.

Details

boolean createPassphraseFile( string $passphrase, string $passphraseFile, string $privateKeyFile, string $privateKeyPassphrase)

Create a passphrase file

Parameters

string $passphrase The passphrase to store in the passphrase file.
string $passphraseFile Path to the passphrase file to create.
string $privateKeyFile Path to the private key file to encrypt the passphrase file.
string $privateKeyPassphrase The passphrase for the private key.

Return Value

boolean Result of writing the passphrase file to disk.

Exceptions

RuntimeException

mixed deleteValue( string $path)

Delete a registry value (very simple method)

Parameters

string $path Registry Path (e.g. joomla.content.showauthor)

Return Value

mixed Value of old value or boolean false if operation failed

boolean loadKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile)

Load a keychain file into this object.

Parameters

string $keychainFile Path to the keychain file.
string $passphraseFile The path to the passphrase file to decript the keychain.
string $publicKeyFile The file containing the public key to decrypt the passphrase file.

Return Value

boolean Result of loading the object.

Exceptions

RuntimeException

boolean saveKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile)

Save this keychain to a file.

Parameters

string $keychainFile The path to the keychain file.
string $passphraseFile The path to the passphrase file to encrypt the keychain.
string $publicKeyFile The file containing the public key to decrypt the passphrase file.

Return Value

boolean Result of storing the file.

Exceptions

RuntimeException