Zend_Crypt_DiffieHellman Class Reference

Public Member Functions
	__construct ($prime, $generator, $privateKey=null, $privateKeyType=self::NUMBER)
	generateKeys ()
	setPublicKey ($number, $type=self::NUMBER)
	getPublicKey ($type=self::NUMBER)
	computeSecretKey ($publicKey, $type=self::NUMBER, $output=self::NUMBER)
	getSharedSecretKey ($type=self::NUMBER)
	setPrime ($number)
	getPrime ()
	setGenerator ($number)
	getGenerator ()
	setPrivateKey ($number, $type=self::NUMBER)
	getPrivateKey ($type=self::NUMBER)
	hasPrivateKey ()
	setBigIntegerMath ($extension=null)

Data Fields
const	BINARY = 'binary'
const	NUMBER = 'number'
const	BTWOC = 'btwoc'

Static Public Attributes
static	$useOpenssl = true

Protected Member Functions
	_generatePrivateKey ()

Detailed Description

Definition at line 33 of file DiffieHellman.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$prime,
			$generator,
			$privateKey = null,
			$privateKeyType = self::NUMBER
	)

Constructor; if set construct the object using the parameter array to set values for Prime, Generator and Private. If a Private Key is not set, one will be generated at random.

Parameters

string	$prime
string	$generator
string	$privateKey
string	$privateKeyType

Definition at line 106 of file DiffieHellman.php.

    {
        $this->setPrime($prime);
        $this->setGenerator($generator);
        if ($privateKey !== null) {
            $this->setPrivateKey($privateKey, $privateKeyType);
        }
        $this->setBigIntegerMath();
    }

Member Function Documentation

_generatePrivateKey()

_generatePrivateKey ( )

protected

In the event a private number/key has not been set by the user, or generated by ext/openssl, a best attempt will be made to generate a random key. Having a random number generator installed on linux/bsd is highly recommended! The alternative is not recommended for production unless without any other option.

Returns

string

Definition at line 382 of file DiffieHellman.php.

    {
        $rand = $this->_math->rand($this->getGenerator(), $this->getPrime());
        return $rand;
    }

computeSecretKey()

computeSecretKey	(		$publicKey,
			$type = self::NUMBER,
			$output = self::NUMBER
	)

Compute the shared secret key based on the public key received from the the second party to this transaction. This should agree to the secret key the second party computes on our own public key. Once in agreement, the key is known to only to both parties. By default, the function expects the public key to be in binary form which is the typical format when being transmitted.

If you need the binary form of the shared secret key, call getSharedSecretKey() with the optional parameter for Binary output.

Parameters

string	$publicKey
string	$type
string	$output

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

mixed

Definition at line 203 of file DiffieHellman.php.

    {
        if ($type == self::BINARY) {
            $publicKey = $this->_math->fromBinary($publicKey);
        }
        if (!preg_match("/^\d+$/", $publicKey)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('invalid parameter; not a positive natural number');
        }
        if (function_exists('openssl_dh_compute_key') && self::$useOpenssl !== false) {
            $this->_secretKey = openssl_dh_compute_key($publicKey, $this->getPublicKey());
        } else {
            $this->_secretKey = $this->_math->powmod($publicKey, $this->getPrivateKey(), $this->getPrime());
        }
        return $this->getSharedSecretKey($output);
    }

generateKeys()

generateKeys

(

)

Generate own public key. If a private number has not already been set, one will be generated at this stage.

Returns

Zend_Crypt_DiffieHellman

Definition at line 122 of file DiffieHellman.php.

    {
        if (function_exists('openssl_dh_compute_key') && self::$useOpenssl !== false) {
            $details = array();
            $details['p'] = $this->getPrime();
            $details['g'] = $this->getGenerator();
            if ($this->hasPrivateKey()) {
                $details['priv_key'] = $this->getPrivateKey();
            }
            $opensslKeyResource = openssl_pkey_new( array('dh' => $details) );
            $data = openssl_pkey_get_details($opensslKeyResource);
            $this->setPrivateKey($data['dh']['priv_key'], self::BINARY);
            $this->setPublicKey($data['dh']['pub_key'], self::BINARY);
        } else {
            // Private key is lazy generated in the absence of PHP 5.3's ext/openssl
            $publicKey = $this->_math->powmod($this->getGenerator(), $this->getPrivateKey(), $this->getPrime());
            $this->setPublicKey($publicKey);
        }
        return $this;
    }

getGenerator()

getGenerator

(

)

Getter for the value of the generator number

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

string

Definition at line 296 of file DiffieHellman.php.

    {
        if (!isset($this->_generator)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('No generator number has been set');
        }
        return $this->_generator;
    }

getPrime()

getPrime

(

)

Getter for the value of the prime number

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

string

Definition at line 264 of file DiffieHellman.php.

    {
        if (!isset($this->_prime)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('No prime number has been set');
        }
        return $this->_prime;
    }

getPrivateKey()

getPrivateKey

(

$type = self::NUMBER

)

Getter for the value of the private number

Parameters

string

$type

Returns

string

Definition at line 332 of file DiffieHellman.php.

    {
        if (!$this->hasPrivateKey()) {
            $this->setPrivateKey($this->_generatePrivateKey(), self::BINARY);
        }
        if ($type == self::BINARY) {
            return $this->_math->toBinary($this->_privateKey);
        } elseif ($type == self::BTWOC) {
            return $this->_math->btwoc($this->_math->toBinary($this->_privateKey));
        }
        return $this->_privateKey;
    }

getPublicKey()

getPublicKey

(

$type = self::NUMBER

)

Returns own public key for communication to the second party to this transaction.

Parameters

string

$type

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

string

Definition at line 172 of file DiffieHellman.php.

    {
        if ($this->_publicKey === null) {
            #require_once 'Zend/Crypt/DiffieHellman/Exception.php';
            throw new Zend_Crypt_DiffieHellman_Exception('A public key has not yet been generated using a prior call to generateKeys()');
        }
        if ($type == self::BINARY) {
            return $this->_math->toBinary($this->_publicKey);
        } elseif ($type == self::BTWOC) {
            return $this->_math->btwoc($this->_math->toBinary($this->_publicKey));
        }
        return $this->_publicKey;
    }

getSharedSecretKey()

getSharedSecretKey

(

$type = self::NUMBER

)

Return the computed shared secret key from the DiffieHellman transaction

Parameters

string

$type

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

string

Definition at line 227 of file DiffieHellman.php.

    {
        if (!isset($this->_secretKey)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('A secret key has not yet been computed; call computeSecretKey()');
        }
        if ($type == self::BINARY) {
            return $this->_math->toBinary($this->_secretKey);
        } elseif ($type == self::BTWOC) {
            return $this->_math->btwoc($this->_math->toBinary($this->_secretKey));
        }
        return $this->_secretKey;
    }

hasPrivateKey()

hasPrivateKey

(

)

Check whether a private key currently exists.

Returns

boolean

Definition at line 350 of file DiffieHellman.php.

    {
        return isset($this->_privateKey);
    }

setBigIntegerMath()

setBigIntegerMath

(

$extension = null

)

Setter to pass an extension parameter which is used to create a specific BigInteger instance for a specific extension type. Allows manual setting of the class in case of an extension problem or bug.

Parameters

string

$extension

Returns

void

See also

Zend_Crypt_Math

Definition at line 364 of file DiffieHellman.php.

    {
        #require_once 'Zend/Crypt/Math.php';
        $this->_math = new Zend_Crypt_Math($extension);
    }

setGenerator()

setGenerator

(

$number

)

Setter for the value of the generator number

Parameters

string

$number

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

Zend_Crypt_DiffieHellman

Definition at line 280 of file DiffieHellman.php.

    {
        if (!preg_match("/^\d+$/", $number) || $number < 2) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('invalid parameter; not a positive natural number greater than 1');
        }
        $this->_generator = (string) $number;
        return $this;
    }

setPrime()

setPrime

(

$number

)

Setter for the value of the prime number

Parameters

string

$number

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

Zend_Crypt_DiffieHellman

Definition at line 248 of file DiffieHellman.php.

    {
        if (!preg_match("/^\d+$/", $number) || $number < 11) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('invalid parameter; not a positive natural number or too small: should be a large natural number prime');
        }
        $this->_prime = (string) $number;
        return $this;
    }

setPrivateKey()

setPrivateKey	(		$number,
			$type = self::NUMBER
	)

Setter for the value of the private number

Parameters

string	$number
string	$type

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

Zend_Crypt_DiffieHellman

Definition at line 313 of file DiffieHellman.php.

    {
        if ($type == self::BINARY) {
            $number = $this->_math->fromBinary($number);
        }
        if (!preg_match("/^\d+$/", $number)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('invalid parameter; not a positive natural number');
        }
        $this->_privateKey = (string) $number;
        return $this;
    }

setPublicKey()

setPublicKey	(		$number,
			$type = self::NUMBER
	)

Setter for the value of the public number

Parameters

string	$number
string	$type

Exceptions

Zend_Crypt_DiffieHellman_Exception

Returns

Zend_Crypt_DiffieHellman

Definition at line 151 of file DiffieHellman.php.

    {
        if ($type == self::BINARY) {
            $number = $this->_math->fromBinary($number);
        }
        if (!preg_match("/^\d+$/", $number)) {
            #require_once('Zend/Crypt/DiffieHellman/Exception.php');
            throw new Zend_Crypt_DiffieHellman_Exception('invalid parameter; not a positive natural number');
        }
        $this->_publicKey = (string) $number;
        return $this;
    }

Field Documentation

$useOpenssl

$useOpenssl = true

static

Definition at line 42 of file DiffieHellman.php.

BINARY

const BINARY = 'binary'

Constants

Definition at line 92 of file DiffieHellman.php.

BTWOC

const BTWOC = 'btwoc'

Definition at line 94 of file DiffieHellman.php.

NUMBER

const NUMBER = 'number'

Definition at line 93 of file DiffieHellman.php.

---

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

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