Encryption adapter for openssl

category Zend
package Zend_Filter
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Class constructor Available options 'public' => public key 'private' => private key 'envelope' => envelope key 'passphrase' => passphrase 'compression' => compress value with this compression adapter 'package' => pack envelope keys into encrypted string, simplifies decryption

__construct(string|array $options = array()

Parameters

$options

stringarray

Options for this adapter

Defined by Zend_Filter_Interface

decrypt(string $value) : string

Decrypts $value with the defined settings

inherited_from \Zend_Filter_Encrypt_Interface::decrypt()

Parameters

$value

string

Content to decrypt

Exceptions

\Zend_Filter_Exception

Returns

stringThe decrypted content

Encrypts $value with the defined settings Note that you also need the "encrypted" keys to be able to decrypt

encrypt(string $value) : string
inherited_from \Zend_Filter_Encrypt_Interface::encrypt()

Parameters

$value

string

Content to encrypt

Exceptions

\Zend_Filter_Exception

Returns

stringThe encrypted content

Returns the compression

getCompression() : array

Returns

array

Returns all envelope keys

getEnvelopeKey() : array

Returns

array

Returns if header should be packaged

getPackage() : boolean

Returns

boolean

Returns the passphrase

getPassphrase() : string

Returns

string

Returns all private keys

getPrivateKey() : array

Returns

array

Returns all public keys

getPublicKey() : array

Returns

array

Sets a internal compression for values to encrypt

setCompression(string|array $compression) : \Zend_Filter_Encrypt_Openssl

Parameters

$compression

stringarray

Returns

\Zend_Filter_Encrypt_Openssl

Sets envelope keys

setEnvelopeKey($key) : \Zend_Filter_Encrypt_Openssl

Parameters

$key

Returns

\Zend_Filter_Encrypt_Openssl

Sets if the envelope keys should be included in the encrypted value

setPackage(boolean $package) : \Zend_Filter_Encrypt_Openssl

Parameters

$package

boolean

Returns

\Zend_Filter_Encrypt_Openssl

Sets a new passphrase

setPassphrase(string $passphrase) : \Zend_Filter_Encrypt_Openssl

Parameters

$passphrase

string

Returns

\Zend_Filter_Encrypt_Openssl

Sets private keys

setPrivateKey(string $key, string $passphrase = null) : \Zend_Filter_Encrypt_Openssl

Parameters

$key

string

Private key

$passphrase

string

Returns

\Zend_Filter_Encrypt_Openssl

Sets public keys

setPublicKey(string|array $key) : \Zend_Filter_Encrypt_Openssl

Parameters

$key

stringarray

Public keys

Returns

\Zend_Filter_Encrypt_Openssl

Returns the adapter name

toString() : string

Returns

string

Sets the encryption keys

_setKeys(string|array $keys) : \Zend_Filter_Encrypt_Openssl

Parameters

$keys

stringarray

Key with type association

Returns

\Zend_Filter_Encrypt_Openssl

 Properties

 

Internal compression

$_compression : array

Default

 

Definitions for encryption array( 'public' => public keys 'private' => private keys 'envelope' => resulting envelope keys )

$_keys 

Default

array('public' => array(), 'private' => array(), 'envelope' => array())
 

Internal create package

$_package : boolean

Default

false
 

Internal passphrase

$_passphrase : string

Default