Class JKeychain

Keychain Class

Joomla\Registry\Registry implements JsonSerializable, ArrayAccess, IteratorAggregate, Countable

JKeychain

Package: Joomla\Platform\Keychain
Deprecated: 4.0 Deprecated without replacement
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/keychain/keychain.php

Methods summary

`public boolean`	# `createPassphraseFile( string $passphrase, string $passphraseFile, string $privateKeyFile, string $privateKeyPassphrase )` Create a passphrase file Create a passphrase file Parameters `$passphrase` `string` - $passphrase The passphrase to store in the passphrase file. `$passphraseFile` `string` - $passphraseFile Path to the passphrase file to create. `$privateKeyFile` `string` - $privateKeyFile Path to the private key file to encrypt the passphrase file. `$privateKeyPassphrase` `string` - $privateKeyPassphrase The passphrase for the private key. Returns `boolean` - Result of writing the passphrase file to disk. Throws `RuntimeException` Since 12.3
`public mixed`	# `deleteValue( string $path )` Delete a registry value (very simple method) Delete a registry value (very simple method) Parameters `$path` `string` - $path Registry Path (e.g. joomla.content.showauthor) Returns `mixed` - Value of old value or boolean false if operation failed Since 12.3
`public boolean`	# `loadKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile )` Load a keychain file into this object. Load a keychain file into this object. Parameters `$keychainFile` `string` - $keychainFile Path to the keychain file. `$passphraseFile` `string` - $passphraseFile The path to the passphrase file to decript the keychain. `$publicKeyFile` `string` - $publicKeyFile The file containing the public key to decrypt the passphrase file. Returns `boolean` - Result of loading the object. Throws `RuntimeException` Since 12.3
`public boolean`	# `saveKeychain( string $keychainFile, string $passphraseFile, string $publicKeyFile )` Save this keychain to a file. Save this keychain to a file. Parameters `$keychainFile` `string` - $keychainFile The path to the keychain file. `$passphraseFile` `string` - $passphraseFile The path to the passphrase file to encrypt the keychain. `$publicKeyFile` `string` - $publicKeyFile The file containing the public key to decrypt the passphrase file. Returns `boolean` - Result of storing the file. Throws `RuntimeException` Since 12.3
`protected string`	# `getPassphraseFromFile( string $passphraseFile, string $publicKeyFile )` Get the passphrase for this keychain Get the passphrase for this keychain Parameters `$passphraseFile` `string` - $passphraseFile The file containing the passphrase to encrypt and decrypt. `$publicKeyFile` `string` - $publicKeyFile The file containing the public key to decrypt the passphrase file. Returns `string` - The passphrase in from passphraseFile Throws `RuntimeException` Since 12.3

Methods inherited from Joomla\Registry\Registry

__clone(), __construct(), __toString(), append(), asArray(), bindData(), count(), def(), exists(), extract(), flatten(), get(), getInstance(), getIterator(), jsonSerialize(), loadArray(), loadFile(), loadObject(), loadString(), merge(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), set(), toArray(), toFlatten(), toObject(), toString()

Magic methods summary

Properties summary

`public string`	`$method`	# Method to use for encryption. Method to use for encryption. Since 12.3
`public string`	`$iv`	# Initialisation vector for encryption method. Initialisation vector for encryption method. Since 12.3

Properties inherited from Joomla\Registry\Registry

$data, $initialized, $instances, $separator

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JKeychain

Methods summary

Parameters

Returns

Throws

Since

Parameters

Returns

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Parameters

Returns

Throws

Since

Methods inherited from Joomla\Registry\Registry

Magic methods summary

Properties summary

Since

Since

Properties inherited from Joomla\Registry\Registry