ARMOR_MESSAGE
ARMOR_MESSAGE
A framework for Horde applications to interact with the GNU Privacy Guard program ("GnuPG"). GnuPG implements the OpenPGP standard (RFC 4880).
GnuPG Website: (http://www.gnupg.org/)
factory(string $driver, array $params = array()) : \Horde_Crypt
Attempts to return a concrete Horde_Crypt instance based on $driver.
| string | $driver | Either a driver name, or the full class name to use (class must extend Horde_Crypt). |
| array | $params | A hash containing any additional configuration or parameters a subclass might need. |
The newly created concrete instance.
__construct(array $params = array())
Constructor.
| array | $params | Configuration parameters:
|
encrypt(string $text, array $params = array()) : string
Encrypts text using PGP.
This method should be provided by all classes that extend Horde_Crypt.
| string | $text | The text to be PGP encrypted. |
| array | $params | The parameters needed for encryption. See the individual _encrypt*() functions for the parameter requirements. |
The encrypted message.
decrypt(string $text, array $params = array()) : object
Decrypts text using PGP.
This method should be provided by all classes that extend Horde_Crypt.
| string | $text | The text to be PGP decrypted. |
| array | $params | The parameters needed for decryption. See the individual _decrypt*() functions for the parameter requirements. |
An object with the following properties:
generateKey(string $realname, string $email, string $passphrase, string $comment = '', integer $keylength = 1024, integer $expire = null, string $key_type = 'RSA', string $subkey_type = 'RSA') : array
Generates a personal Public/Private keypair combination.
| string | $realname | The name to use for the key. |
| string | The email to use for the key. |
|
| string | $passphrase | The passphrase to use for the key. |
| string | $comment | The comment to use for the key. |
| integer | $keylength | The keylength to use for the key. |
| integer | $expire | The expiration date (UNIX timestamp). No expiration if empty. |
| string | $key_type | Key type (@since 2.2.0). |
| string | $subkey_type | Subkey type (@since 2.2.0). |
An array consisting of the following keys/values:
pgpPacketInformation(string $pgpdata) : array
Returns information on a PGP data block.
If the data block contains multiple keys, only the first is returned. To return all keys of this block, use pgpPacketInformationMultiple() instead.
| string | $pgpdata | The PGP data block. |
An array with information on the PGP data block. If an element is not present in the data block, it will likewise not be set in the array.
Array Format:
-------------
[public_key]/[secret_key] => Array
(
[created] => Key creation - UNIX timestamp
[expires] => Key expiration - UNIX timestamp (0 = never expires)
[size] => Size of the key in bits
)
[keyid] => Key ID of the PGP data (if available)
16-bit hex value
[signature] => Array (
[id{n}/'_SIGNATURE'] => Array (
[name] => Full Name
[comment] => Comment
[email] => E-mail Address
[keyid] => 16-bit hex value
[created] => Signature creation - UNIX timestamp
[expires] => Signature expiration - UNIX timestamp
[micalg] => The hash used to create the signature
[sig_{hex}] => Array [details of a sig verifying the ID] (
[created] => Signature creation - UNIX timestamp
[expires] => Signature expiration - UNIX timestamp
[keyid] => 16-bit hex value
[micalg] => The hash used to create the signature
)
)
)
Each user ID will be stored in the array 'signature' and have data associated with it, including an array for information on each signature that has signed that UID. Signatures not associated with a UID (e.g. revocation signatures and sub keys) will be stored under the special keyword '_SIGNATURE'.
pgpPacketInformationMultiple(string $pgpdata) : array
Returns all information on a PGP data block.
| string | $pgpdata | The PGP data block. |
An array with information on the PGP data block. The array contains one or more entries as returned from pgpPacketInformation().
pgpPacketSignature(string $pgpdata, string $email) : array
Returns only information on the first ID that matches the email address input.
| string | $pgpdata | The PGP data block. |
| string | An e-mail address. |
An array with information on the PGP data block. If an element is not present in the data block, it will likewise not be set in the array. Array elements:
pgpPacketSignatureByUidIndex(string $pgpdata, string $uid_idx) : array
Returns information on a PGP signature embedded in PGP data. Similar to pgpPacketSignature(), but returns information by unique User ID Index (format id{n} where n is an integer of 1 or greater).
| string | $pgpdata | See pgpPacketSignature(). |
| string | $uid_idx | The UID index. |
See pgpPacketSignature().
verifyPassphrase(string $public_key, string $private_key, string $passphrase) : boolean
Verify a passphrase for a given public/private keypair.
| string | $public_key | The user's PGP public key. |
| string | $private_key | The user's PGP private key. |
| string | $passphrase | The user's passphrase. |
Returns true on valid passphrase, false on invalid passphrase.
putPublicKeyserver(string $pubkey, string $server = self::KEYSERVER_PUBLIC, float $timeout = self::KEYSERVER_TIMEOUT)
Sends a PGP public key to a public keyserver.
| string | $pubkey | The PGP public key |
| string | $server | The keyserver to use. |
| float | $timeout | The keyserver timeout. |
getKeyID(string $address, string $server = self::KEYSERVER_PUBLIC, float $timeout = self::KEYSERVER_TIMEOUT) : string
Returns the first matching key ID for an email address from a public keyserver.
| string | $address | The email address of the PGP key. |
| string | $server | The keyserver to use. |
| float | $timeout | The keyserver timeout. |
The PGP key ID.
signMIMEPart(\Horde_Mime_Part $mime_part, array $params = array()) : mixed
Signs a MIME part using PGP.
| \Horde_Mime_Part | $mime_part | The object to sign. |
| array | $params | The parameters required for signing. ({@see _encryptSignature()}). |
A Horde_Mime_Part object that is signed according to RFC 3156.
encryptMIMEPart(\Horde_Mime_Part $mime_part, array $params = array()) : mixed
Encrypts a MIME part using PGP.
| \Horde_Mime_Part | $mime_part | The object to encrypt. |
| array | $params | The parameters required for encryption ({@see _encryptMessage()}). |
A Horde_Mime_Part object that is encrypted according to RFC 3156.
signAndEncryptMIMEPart(\Horde_Mime_Part $mime_part, array $sign_params = array(), array $encrypt_params = array()) : mixed
Signs and encrypts a MIME part using PGP.
| \Horde_Mime_Part | $mime_part | The object to sign and encrypt. |
| array | $sign_params | The parameters required for signing ({@see _encryptSignature()}). |
| array | $encrypt_params | The parameters required for encryption ({@see _encryptMessage()}). |
A Horde_Mime_Part object that is signed and encrypted according to RFC 3156.