Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
PHP implementation of the Diffie-Hellman public key encryption algorithm.
Allows two unassociated parties to establish a joint shared secret key to be used in encrypting subsequent communications.
BINARY = 'binary'
Constants
NUMBER = 'number'
BTWOC = 'btwoc'
string $_generator = 'null'
The default generator number. This number must be greater than 0 but less than the prime number set.
Zend_Crypt_Math_BigInteger $_math = 'null'
BigInteger support object courtesy of Zend_Crypt_Math
string $_prime = 'null'
Default large prime number; required by the algorithm.
string $_privateKey = 'null'
A private number set by the local user. It's optional and will be generated if not set.
string $_publicKey = 'null'
The public key generated by this instance after calling generateKeys().
string $_secretKey = 'null'
The shared secret key resulting from a completed Diffie Hellman exchange
boolean $useOpenssl = 'true'
Static flag to select whether to use PHP5.3's openssl extension if available.
__construct(
string $prime, string $generator, string $privateKey
=
null, string $privateKeyType
=
self
)
:
void
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.
_generatePrivateKey(
)
:
string
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.
computeSecretKey(
string $publicKey, string $type
=
self, $output
=
self
)
:
mixed
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.
generateKeys(
)
:
Zend_Crypt_DiffieHellman
Generate own public key. If a private number has not already been set, one will be generated at this stage.
getGenerator(
)
:
string
Getter for the value of the generator number
getPrime(
)
:
string
Getter for the value of the prime number
getPrivateKey(
string $type
=
self
)
:
string
Getter for the value of the private number
getPublicKey(
string $type
=
self
)
:
string
Returns own public key for communication to the second party to this transaction.
getSharedSecretKey(
string $type
=
self
)
:
string
Return the computed shared secret key from the DiffieHellman transaction
hasPrivateKey(
)
:
boolean
Check whether a private key currently exists.
setBigIntegerMath(
string $extension
=
null
)
:
void
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.
setGenerator(
string $number
)
:
Zend_Crypt_DiffieHellman
Setter for the value of the generator number
setPrime(
string $number
)
:
Zend_Crypt_DiffieHellman
Setter for the value of the prime number
setPrivateKey(
string $number, string $type
=
self
)
:
Zend_Crypt_DiffieHellman
Setter for the value of the private number
setPublicKey(
string $number, string $type
=
self
)
:
Zend_Crypt_DiffieHellman
Setter for the value of the public number