AsymmetricKey
in package
AbstractYes
Base Class for all asymmetric cipher classes
Tags
Table of Contents
Properties
- $engines : array<string|int, bool>
- Available Engines
- $format : string
- Format of the loaded key
- $hash : Hash
- Hash function
- $one : BigInteger
- Precomputed One
- $zero : BigInteger
- Precomputed Zero
- $comment : null|string
- Key Comment
- $hmac : Hash
- HMAC function
- $invisiblePlugins : array<string|int, mixed>
- Invisible plugins
- $plugins : array<string|int, mixed>
- Supported plugins (lower case)
Methods
- __toString() : string
- __toString() magic method
- addFileFormat() : bool
- Add a fileformat plugin
- getComment() : null|string
- Returns the key's comment
- getHash() : mixed
- Returns the hash algorithm currently being used
- getLoadedFormat() : mixed
- Returns the format of the loaded key.
- getSupportedKeyFormats() : array<string|int, mixed>
- Returns a list of supported formats.
- load() : PublicKey|PrivateKey
- Load the key
- loadFormat() : static
- Load the key, assuming a specific format
- loadParameters() : AsymmetricKey
- Loads parameters
- loadParametersFormat() : AsymmetricKey
- Loads parameters
- loadPrivateKey() : PrivateKey
- Loads a private key
- loadPrivateKeyFormat() : PrivateKey
- Loads a private key
- loadPublicKey() : PublicKey
- Loads a public key
- loadPublicKeyFormat() : PublicKey
- Loads a public key
- toString() : array<string|int, mixed>|string
- useBestEngine() : mixed
- Tests engine validity
- useInternalEngine() : mixed
- Flag to use internal engine only (useful for unit testing)
- withHash() : mixed
- Determines which hashing function should be used
- __construct() : mixed
- The constructor
- bits2int() : BigInteger
- Bit String to Integer
- computek() : string
- Compute the pseudorandom k for signature generation, using the process specified for deterministic DSA.
- initialize_static_variables() : mixed
- Initialize static variables
- validatePlugin() : mixed
- Validate Plugin
- bits2octets() : string
- Bit String to Octet String
- int2octets() : string
- Integer to Octet String
- loadPlugins() : mixed
- Load Plugins
Properties
$engines
Available Engines
protected
static array<string|int, bool>
$engines
= []
$format
Format of the loaded key
protected
string
$format
$hash
Hash function
protected
Hash
$hash
$one
Precomputed One
protected
static BigInteger
$one
$zero
Precomputed Zero
protected
static BigInteger
$zero
$comment
Key Comment
private
null|string
$comment
$hmac
HMAC function
private
Hash
$hmac
$invisiblePlugins
Invisible plugins
private
static array<string|int, mixed>
$invisiblePlugins
= []
Tags
$plugins
Supported plugins (lower case)
private
static array<string|int, mixed>
$plugins
= []
Tags
Methods
__toString()
__toString() magic method
public
__toString() : string
Return values
stringaddFileFormat()
Add a fileformat plugin
public
static addFileFormat(string $fullname) : bool
The plugin needs to either already be loaded or be auto-loadable. Loading a plugin whose shortname overwrite an existing shortname will overwrite the old plugin.
Parameters
- $fullname : string
Tags
Return values
boolgetComment()
Returns the key's comment
public
getComment() : null|string
Not all key formats support comments. If you want to set a comment use toString()
Return values
null|stringgetHash()
Returns the hash algorithm currently being used
public
getHash() : mixed
getLoadedFormat()
Returns the format of the loaded key.
public
getLoadedFormat() : mixed
If the key that was loaded wasn't in a valid or if the key was auto-generated with RSA::createKey() then this will throw an exception.
Tags
getSupportedKeyFormats()
Returns a list of supported formats.
public
static getSupportedKeyFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>load()
Load the key
public
static load(string $key[, string $password = false ]) : PublicKey|PrivateKey
Parameters
- $key : string
- $password : string = false
-
optional
Return values
PublicKey|PrivateKeyloadFormat()
Load the key, assuming a specific format
public
static loadFormat(string $type, string $key[, string $password = false ]) : static
Parameters
- $type : string
- $key : string
- $password : string = false
-
optional
Return values
staticloadParameters()
Loads parameters
public
static loadParameters(string|array<string|int, mixed> $key) : AsymmetricKey
Parameters
- $key : string|array<string|int, mixed>
Return values
AsymmetricKeyloadParametersFormat()
Loads parameters
public
static loadParametersFormat(string $type, string|array<string|int, mixed> $key) : AsymmetricKey
Parameters
- $type : string
- $key : string|array<string|int, mixed>
Return values
AsymmetricKeyloadPrivateKey()
Loads a private key
public
static loadPrivateKey(string|array<string|int, mixed> $key[, string $password = '' ]) : PrivateKey
Parameters
- $key : string|array<string|int, mixed>
- $password : string = ''
-
optional
Return values
PrivateKeyloadPrivateKeyFormat()
Loads a private key
public
static loadPrivateKeyFormat(string $type, string $key[, string $password = false ]) : PrivateKey
Parameters
- $type : string
- $key : string
- $password : string = false
-
optional
Return values
PrivateKeyloadPublicKey()
Loads a public key
public
static loadPublicKey(string|array<string|int, mixed> $key) : PublicKey
Parameters
- $key : string|array<string|int, mixed>
Return values
PublicKeyloadPublicKeyFormat()
Loads a public key
public
static loadPublicKeyFormat(string $type, string $key) : PublicKey
Parameters
- $type : string
- $key : string
Return values
PublicKeytoString()
public
abstract toString(string $type[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|string
Parameters
- $type : string
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed>|stringuseBestEngine()
Tests engine validity
public
static useBestEngine() : mixed
useInternalEngine()
Flag to use internal engine only (useful for unit testing)
public
static useInternalEngine() : mixed
withHash()
Determines which hashing function should be used
public
withHash(string $hash) : mixed
Parameters
- $hash : string
__construct()
The constructor
protected
__construct() : mixed
bits2int()
Bit String to Integer
protected
bits2int(string $in) : BigInteger
Parameters
- $in : string
Return values
BigIntegercomputek()
Compute the pseudorandom k for signature generation, using the process specified for deterministic DSA.
protected
computek(string $h1) : string
Parameters
- $h1 : string
Return values
stringinitialize_static_variables()
Initialize static variables
protected
static initialize_static_variables() : mixed
validatePlugin()
Validate Plugin
protected
static validatePlugin(string $format, string $type[, string $method = null ]) : mixed
Parameters
- $format : string
- $type : string
- $method : string = null
-
optional
bits2octets()
Bit String to Octet String
private
bits2octets(string $in) : string
Parameters
- $in : string
Return values
stringint2octets()
Integer to Octet String
private
int2octets(BigInteger $v) : string
Parameters
- $v : BigInteger
Return values
stringloadPlugins()
Load Plugins
private
static loadPlugins(string $format) : mixed
Parameters
- $format : string