RSA instance options

category Zend
package Zend_Crypt
subpackage PublicKey

 Methods

__construct()

__construct(array | \Traversable | null $options) : \Zend\Stdlib\AbstractOptions
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::__construct()

Parameters

$options

array\Traversablenull

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Returns

__get()

__get(string $key) : mixed
Inherited

see \Zend\Stdlib\ParameterObject::__get()
inherited_from \Zend\Stdlib\AbstractOptions::__get()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

Returns

mixed

__isset()

__isset(string $key) : bool
Inherited

see \Zend\Stdlib\ParameterObject::__isset()
inherited_from \Zend\Stdlib\AbstractOptions::__isset()

Parameters

$key

string

Returns

bool

__set()

__set(string $key, mixed $value) : void
Inherited

see \Zend\Stdlib\ParameterObject::__set()
inherited_from \Zend\Stdlib\AbstractOptions::__set()

Parameters

$key

string

$value

mixed

Exceptions

\Zend\Stdlib\Exception\BadMethodCallException

__unset()

__unset(string $key) : void
Inherited

see \Zend\Stdlib\ParameterObject::__unset()
inherited_from \Zend\Stdlib\AbstractOptions::__unset()

Parameters

$key

string

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Generate new private/public key pair

generateKeys(array $opensslConfig) : \Zend\Crypt\PublicKey\RsaOptions

Get the value of binary output

getBinaryOutput() : bool

Returns

bool

Get hash algorithm

getHashAlgorithm() : string

Returns

string

getOpensslSignatureAlgorithm()

getOpensslSignatureAlgorithm() 

Get pass phrase

getPassPhrase() : string

Returns

string

Get private key

getPrivateKey() : null | \Zend\Crypt\PublicKey\Rsa\PrivateKey

Get public key

getPublicKey() : null | \Zend\Crypt\PublicKey\Rsa\PublicKey

Enable/disable the binary output

setBinaryOutput(bool $value) : \Zend\Crypt\PublicKey\RsaOptions

Parameters

$value

bool

Returns

setFromArray()

setFromArray(array | \Traversable $options) : void
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::setFromArray()

Parameters

$options

array\Traversable

Exceptions

\Zend\Stdlib\Exception\InvalidArgumentException

Set pass phrase

setPassPhrase(string $phrase) : \Zend\Crypt\PublicKey\RsaOptions

Parameters

$phrase

string

Returns

Set private key

setPrivateKey(\Zend\Crypt\PublicKey\Rsa\PrivateKey $key) : \Zend\Crypt\PublicKey\RsaOptions

Set public key

setPublicKey(\Zend\Crypt\PublicKey\Rsa\PublicKey $key) : \Zend\Crypt\PublicKey\RsaOptions

Cast to array

toArray() : array
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::toArray()

Returns

array

 Properties

 

We use the __ prefix to avoid collisions with properties in user-implementations.

$__strictMode__ : bool
Inherited

inherited_from \Zend\Stdlib\AbstractOptions::$$__strictMode__
 

Output is binary

$binaryOutput : bool

 

$hashAlgorithm

$hashAlgorithm : string

 

Signature hash algorithm defined by openss constants

$opensslSignatureAlgorithm : int

 

$passPhrase

$passPhrase : string

 

$privateKey

$privateKey : \Zend\Crypt\PublicKey\Rsa\PrivateKey

 

$publicKey

$publicKey : \Zend\Crypt\PublicKey\Rsa\PublicKey