PHP Class ParagonIE\Halite\Key

Base class for all cryptography secrets This library makes heavy use of return-type declarations, which are a PHP 7 only feature. Read more about them here:
Datei anzeigen Open project: paragonie/halite Class Usage Examples

Protected Properties

Property Type Description
$isAsymmetricKey boolean
$isPublicKey boolean
$isSigningKey boolean

Public Methods

Method Description
__clone ( ) Don't let this ever succeed
__construct ( HiddenString $keyMaterial ) You probably should not be using this directly.
__debugInfo ( ) : array Hide this from var_dump(), etc.
__destruct ( ) Make sure you wipe the key from memory on destruction
__sleep ( ) Don't allow this object to ever be serialized
__toString ( ) : string Get public keys
__wakeup ( ) Don't allow this object to ever be unserialized
getRawKeyMaterial ( ) : string Get the actual key material
isAsymmetricKey ( ) : boolean Is this a part of a key pair?
isEncryptionKey ( ) : boolean Is this a signing key?
isPublicKey ( ) : boolean Is this a public key?
isSecretKey ( ) : boolean Is this a secret key?
isSigningKey ( ) : boolean Is this a signing key?

Method Details

__clone() public method

Don't let this ever succeed
public __clone ( )

__construct() public method

You probably should not be using this directly.
public __construct ( HiddenString $keyMaterial )
$keyMaterial HiddenString - The actual key data

__debugInfo() public method

Hide this from var_dump(), etc.
public __debugInfo ( ) : array
return array

__destruct() public method

Make sure you wipe the key from memory on destruction
public __destruct ( )

__sleep() public method

Don't allow this object to ever be serialized
public __sleep ( )

__toString() public method

Get public keys
public __toString ( ) : string
return string

__wakeup() public method

Don't allow this object to ever be unserialized
public __wakeup ( )

getRawKeyMaterial() public method

Get the actual key material
public getRawKeyMaterial ( ) : string
return string

isAsymmetricKey() public method

Is this a part of a key pair?
public isAsymmetricKey ( ) : boolean
return boolean

isEncryptionKey() public method

Is this a signing key?
public isEncryptionKey ( ) : boolean
return boolean

isPublicKey() public method

Is this a public key?
public isPublicKey ( ) : boolean
return boolean

isSecretKey() public method

Is this a secret key?
public isSecretKey ( ) : boolean
return boolean

isSigningKey() public method

Is this a signing key?
public isSigningKey ( ) : boolean
return boolean

Property Details

$isAsymmetricKey protected_oe property

protected bool $isAsymmetricKey
return boolean

$isPublicKey protected_oe property

protected bool $isPublicKey
return boolean

$isSigningKey protected_oe property

protected bool $isSigningKey
return boolean