Docs For Class JKeychain

Description

Keychain Class

since: 12.3

Located in /libraries/joomla/keychain/keychain.php (line 19)

JRegistry
   |
   --JKeychain

Variable Summary

string $iv

string $method

Method Summary

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

mixed deleteValue (string $path)

string getPassphraseFromFile (string $passphraseFile, string $publicKeyFile)

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

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

Variables

string $iv = "1234567890123456" (line 31)

var: Initialisation vector for encryption method.
since: 12.3
access: public

string $method = 'aes-128-cbc' (line 25)

var: Method to use for encryption.
since: 12.3
access: public

Inherited Variables

Inherited from JRegistry

JRegistry::$data
JRegistry::$instances

Methods

createPassphraseFile (line 46)

Create a passphrase file

return: Result of writing the passphrase file to disk.
since: 12.3
throws: RuntimeException
access: public

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

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.

deleteValue (line 74)

Delete a registry value (very simple method)

return: Value of old value or boolean false if operation failed
since: 12.3
access: public

mixed deleteValue (string $path)

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

getPassphraseFromFile (line 172)

Get the passphrase for this keychain

return: The passphrase in from passphraseFile
since: 12.3
throws: RuntimeException
access: protected

string getPassphraseFromFile (string $passphraseFile, string $publicKeyFile)

string $passphraseFile: The file containing the passphrase to encrypt and decrypt.
string $publicKeyFile: The file containing the public key to decrypt the passphrase file.

loadKeychain (line 116)

Load a keychain file into this object.

return: Result of loading the object.
since: 12.3
throws: RuntimeException
access: public

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

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.

saveKeychain (line 146)

Save this keychain to a file.

return: Result of storing the file.
since: 12.3
throws: RuntimeException
access: public

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

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.

Inherited Methods

Inherited From JRegistry

JRegistry::__construct()
JRegistry::asArray()
JRegistry::bindData()
JRegistry::def()
JRegistry::exists()
JRegistry::get()
JRegistry::getInstance()
JRegistry::jsonSerialize()
JRegistry::loadArray()
JRegistry::loadFile()
JRegistry::loadObject()
JRegistry::loadString()
JRegistry::merge()
JRegistry::set()
JRegistry::toArray()
JRegistry::toObject()
JRegistry::toString()
JRegistry::__clone()
JRegistry::__toString()