Zend_Crypt_Rsa Class Reference

Public Member Functions
	__construct (array $options=null)
	setOptions (array $options)
	getPrivateKey ()
	getPublicKey ()
	sign ($data, Zend_Crypt_Rsa_Key_Private $privateKey=null, $format=null)
	verifySignature ($data, $signature, $format=null)
	encrypt ($data, Zend_Crypt_Rsa_Key $key, $format=null)
	decrypt ($data, Zend_Crypt_Rsa_Key $key, $format=null)
	generateKeys (array $configargs=null)
	setPemString ($value)
	setPemPath ($value)
	setCertificateString ($value)
	setCertificatePath ($value)
	setHashAlgorithm ($name)
	getPemString ()
	getPemPath ()
	getCertificateString ()
	getCertificatePath ()
	getHashAlgorithm ()

Data Fields
const	BINARY = 'binary'
const	BASE64 = 'base64'

Protected Member Functions
	_parseConfigArgs (array $config=null)

Protected Attributes
	$_privateKey
	$_publicKey
	$_pemString
	$_pemPath
	$_certificateString
	$_certificatePath
	$_hashAlgorithm
	$_passPhrase

Detailed Description

Definition at line 39 of file Rsa.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = null

)

Class constructor

Parameters

array

$options

Exceptions

Zend_Crypt_Rsa_Exception

Definition at line 70 of file Rsa.php.

    {
        if (!extension_loaded('openssl')) {
            #require_once 'Zend/Crypt/Rsa/Exception.php';
            throw new Zend_Crypt_Rsa_Exception('Zend_Crypt_Rsa requires openssl extension to be loaded.');
        }

        // Set _hashAlgorithm property when we are sure, that openssl extension is loaded
        // and OPENSSL_ALGO_SHA1 constant is available
        $this->_hashAlgorithm = OPENSSL_ALGO_SHA1;

        if (isset($options)) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

_parseConfigArgs()

_parseConfigArgs ( array  $config = null )

protected

Definition at line 323 of file Rsa.php.

    {
        $configs = array();
        if (isset($config['private_key_bits'])) {
            $configs['private_key_bits'] = $config['private_key_bits'];
        }
        if (isset($config['privateKeyBits'])) {
            $configs['private_key_bits'] = $config['privateKeyBits'];
        }
        if (!empty($configs)) {
            return $configs;
        }
        return null;
    }

decrypt()

decrypt	(		$data,
		Zend_Crypt_Rsa_Key	$key,
			$format = null
	)

Parameters

string	$data
Zend_Crypt_Rsa_Key	$key
string	$format

Returns

string

Definition at line 190 of file Rsa.php.

    {
        $decrypted = '';
        if ($format == self::BASE64) {
            $data = base64_decode($data);
        }
        $function = 'openssl_private_decrypt';
        if ($key instanceof Zend_Crypt_Rsa_Key_Public) {
            $function = 'openssl_public_decrypt';
        }
        $function($data, $decrypted, $key->getOpensslKeyResource());
        return $decrypted;
    }

encrypt()

encrypt	(		$data,
		Zend_Crypt_Rsa_Key	$key,
			$format = null
	)

Parameters

string	$data
Zend_Crypt_Rsa_Key	$key
string	$format

Returns

string

Definition at line 170 of file Rsa.php.

    {
        $encrypted = '';
        $function = 'openssl_public_encrypt';
        if ($key instanceof Zend_Crypt_Rsa_Key_Private) {
            $function = 'openssl_private_encrypt';
        }
        $function($data, $encrypted, $key->getOpensslKeyResource());
        if ($format == self::BASE64) {
            return base64_encode($encrypted);
        }
        return $encrypted;
    }

generateKeys()

generateKeys

(

array

$configargs = null

)

Parameters

array

$configargs

Exceptions

Zend_Crypt_Rsa_Exception

Returns

ArrayObject

Definition at line 211 of file Rsa.php.

    {
        $config = null;
        $passPhrase = null;
        if ($configargs !== null) {
            if (isset($configargs['passPhrase'])) {
                $passPhrase = $configargs['passPhrase'];
                unset($configargs['passPhrase']);
            }
            $config = $this->_parseConfigArgs($configargs);
        }
        $privateKey = null;
        $publicKey = null;
        $resource = openssl_pkey_new($config);
        if (!$resource) {
            #require_once 'Zend/Crypt/Rsa/Exception.php';
            throw new Zend_Crypt_Rsa_Exception('Failed to generate a new private key');
        }
        // above fails on PHP 5.3
        openssl_pkey_export($resource, $private, $passPhrase);
        $privateKey = new Zend_Crypt_Rsa_Key_Private($private, $passPhrase);
        $details = openssl_pkey_get_details($resource);
        $publicKey = new Zend_Crypt_Rsa_Key_Public($details['key']);
        $return = new ArrayObject(array(
           'privateKey'=>$privateKey,
           'publicKey'=>$publicKey
        ), ArrayObject::ARRAY_AS_PROPS);
        return $return;
    }

getCertificatePath()

getCertificatePath

(

)

Definition at line 313 of file Rsa.php.

    {
        return $this->_certificatePath;
    }

getCertificateString()

getCertificateString

(

)

Definition at line 308 of file Rsa.php.

    {
        return $this->_certificateString;
    }

getHashAlgorithm()

getHashAlgorithm

(

)

Definition at line 318 of file Rsa.php.

    {
        return $this->_hashAlgorithm;
    }

getPemPath()

getPemPath

(

)

Definition at line 303 of file Rsa.php.

    {
        return $this->_pemPath;
    }

getPemString()

getPemString

(

)

Returns

string

Definition at line 298 of file Rsa.php.

    {
        return $this->_pemString;
    }

getPrivateKey()

getPrivateKey

(

)

Definition at line 112 of file Rsa.php.

    {
        return $this->_privateKey;
    }

getPublicKey()

getPublicKey

(

)

Definition at line 117 of file Rsa.php.

    {
        return $this->_publicKey;
    }

setCertificatePath()

setCertificatePath

(

$value

)

Definition at line 268 of file Rsa.php.

    {
        $this->_certificatePath = $value;
        $this->setCertificateString(file_get_contents($this->_certificatePath));
    }

setCertificateString()

setCertificateString

(

$value

)

Definition at line 262 of file Rsa.php.

    {
        $this->_certificateString = $value;
        $this->_publicKey = new Zend_Crypt_Rsa_Key_Public($this->_certificateString, $this->_passPhrase);
    }

setHashAlgorithm()

setHashAlgorithm

(

$name

)

Definition at line 274 of file Rsa.php.

    {
        switch (strtolower($name)) {
            case 'md2':
                $this->_hashAlgorithm = OPENSSL_ALGO_MD2;
                break;
            case 'md4':
                $this->_hashAlgorithm = OPENSSL_ALGO_MD4;
                break;
            case 'md5':
                $this->_hashAlgorithm = OPENSSL_ALGO_MD5;
                break;
            case 'sha1':
                $this->_hashAlgorithm = OPENSSL_ALGO_SHA1;
                break;
            case 'dss1':
                $this->_hashAlgorithm = OPENSSL_ALGO_DSS1;
                break;
        }
    }

setOptions()

setOptions

(

array

$options

)

Definition at line 86 of file Rsa.php.

    {
        if (isset($options['passPhrase'])) {
            $this->_passPhrase = $options['passPhrase'];
        }
        foreach ($options as $option=>$value) {
            switch ($option) {
                case 'pemString':
                    $this->setPemString($value);
                    break;
                case 'pemPath':
                    $this->setPemPath($value);
                    break;
                case 'certificateString':
                    $this->setCertificateString($value);
                    break;
                case 'certificatePath':
                    $this->setCertificatePath($value);
                    break;
                case 'hashAlgorithm':
                    $this->setHashAlgorithm($value);
                    break;
            }
        }
    }

setPemPath()

setPemPath

(

$value

)

Definition at line 256 of file Rsa.php.

    {
        $this->_pemPath = $value;
        $this->setPemString(file_get_contents($this->_pemPath));
    }

setPemString()

setPemString

(

$value

)

Parameters

string

$value

Definition at line 244 of file Rsa.php.

    {
        $this->_pemString = $value;
        try {
            $this->_privateKey = new Zend_Crypt_Rsa_Key_Private($this->_pemString, $this->_passPhrase);
            $this->_publicKey = $this->_privateKey->getPublicKey();
        } catch (Zend_Crypt_Exception $e) {
            $this->_privateKey = null;
            $this->_publicKey = new Zend_Crypt_Rsa_Key_Public($this->_pemString);
        }
    }

sign()

sign	(		$data,
		Zend_Crypt_Rsa_Key_Private	$privateKey = null,
			$format = null
	)

Parameters

string	$data
Zend_Crypt_Rsa_Key_Private	$privateKey
string	$format

Returns

string

Definition at line 128 of file Rsa.php.

    {
        $signature = '';
        if (isset($privateKey)) {
            $opensslKeyResource = $privateKey->getOpensslKeyResource();
        } else {
            $opensslKeyResource = $this->_privateKey->getOpensslKeyResource();
        }
        $result = openssl_sign(
            $data, $signature,
            $opensslKeyResource,
            $this->getHashAlgorithm()
        );
        if ($format == self::BASE64) {
            return base64_encode($signature);
        }
        return $signature;
    }

verifySignature()

verifySignature	(		$data,
			$signature,
			$format = null
	)

Parameters

string	$data
string	$signature
string	$format

Returns

string

Definition at line 153 of file Rsa.php.

    {
        if ($format == self::BASE64) {
            $signature = base64_decode($signature);
        }
        $result = openssl_verify($data, $signature,
            $this->getPublicKey()->getOpensslKeyResource(),
            $this->getHashAlgorithm());
        return $result;
    }

Field Documentation

$_certificatePath

$_certificatePath

protected

Definition at line 58 of file Rsa.php.

$_certificateString

$_certificateString

protected

Definition at line 56 of file Rsa.php.

$_hashAlgorithm

$_hashAlgorithm

protected

Definition at line 60 of file Rsa.php.

$_passPhrase

$_passPhrase

protected

Definition at line 62 of file Rsa.php.

$_pemPath

$_pemPath

protected

Definition at line 54 of file Rsa.php.

$_pemString

$_pemString

protected

Definition at line 52 of file Rsa.php.

$_privateKey

$_privateKey

protected

Definition at line 45 of file Rsa.php.

$_publicKey

$_publicKey

protected

Definition at line 47 of file Rsa.php.

BASE64

const BASE64 = 'base64'

Definition at line 43 of file Rsa.php.

BINARY

const BINARY = 'binary'

Definition at line 42 of file Rsa.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Crypt/Rsa.php