Crypt_GPG
[ class tree: Crypt_GPG ] [ index: Crypt_GPG ] [ all elements ]

Element index for package Crypt_GPG

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ n ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

_addKey
in file GPG.php, method Crypt_GPG::_addKey()
    Adds a key to one of the internal key arrays
_decrypt
in file GPG.php, method Crypt_GPG::_decrypt()
    Decrypts data
_decryptAndVerify
in file GPG.php, method Crypt_GPG::_decryptAndVerify()
    Decrypts and verifies encrypted, signed data
_encrypt
in file GPG.php, method Crypt_GPG::_encrypt()
    Encrypts data
_encryptAndSign
in file GPG.php, method Crypt_GPG::_encryptAndSign()
    Encrypts and signs data
_getKeys
in file GPGAbstract.php, method Crypt_GPGAbstract::_getKeys()
    Gets the available keys in the keyring
_importKey
in file GPG.php, method Crypt_GPG::_importKey()
    Imports a public or private key into the keyring
_setPinEntryEnv
in file GPG.php, method Crypt_GPG::_setPinEntryEnv()
    Sets the PINENTRY_USER_DATA environment variable with the currently added keys and passphrases
_sign
in file GPG.php, method Crypt_GPG::_sign()
    Signs data
_verify
in file GPG.php, method Crypt_GPG::_verify()
    Verifies data
__construct
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::__construct()
    Creates a new GnuPG key generator
__construct
in file Exceptions.php, method Crypt_GPG_FileException::__construct()
    Creates a new Crypt_GPG_FileException
__construct
in file GPGAbstract.php, method Crypt_GPGAbstract::__construct()
    Creates a new GPG object
__construct
in file ProcessControl.php, method Crypt_GPG_ProcessControl::__construct()
    Creates a new process controller from the given PID (process identifier)
__construct
in file Signature.php, method Crypt_GPG_Signature::__construct()
    Creates a new signature
__construct
in file UserId.php, method Crypt_GPG_UserId::__construct()
    Creates a new user id
__construct
in file SubKey.php, method Crypt_GPG_SubKey::__construct()
    Creates a new sub-key object
__construct
in file Exceptions.php, method Crypt_GPG_BadPassphraseException::__construct()
    Creates a new Crypt_GPG_BadPassphraseException
__construct
in file Exceptions.php, method Crypt_GPG_OpenSubprocessException::__construct()
    Creates a new Crypt_GPG_OpenSubprocessException
__construct
in file DecryptStatusHandler.php, method Crypt_GPG_DecryptStatusHandler::__construct()
    Creates a new decryption status handler
__construct
in file Engine.php, method Crypt_GPG_Engine::__construct()
    Creates a new GPG engine
__construct
in file Exceptions.php, method Crypt_GPG_InvalidOperationException::__construct()
    Creates a new Crypt_GPG_OpenSubprocessException
__construct
in file Exceptions.php, method Crypt_GPG_InvalidKeyParamsException::__construct()
    Creates a new Crypt_GPG_InvalidKeyParamsException
__construct
in file Exceptions.php, method Crypt_GPG_DeletePrivateKeyException::__construct()
    Creates a new Crypt_GPG_DeletePrivateKeyException
__construct
in file Exceptions.php, method Crypt_GPG_KeyNotFoundException::__construct()
    Creates a new Crypt_GPG_KeyNotFoundException
__destruct
in file Engine.php, method Crypt_GPG_Engine::__destruct()
    Closes open GPG subprocesses when this object is destroyed
__invoke
in file PinEntry.php, method Crypt_GPG_PinEntry::__invoke()
    Runs this pinentry
__toString
in file UserId.php, method Crypt_GPG_UserId::__toString()
    Gets a string representation of this user id
top

a

addDecryptKey
in file GPG.php, method Crypt_GPG::addDecryptKey()
    Adds a key to use for decryption
addEncryptKey
in file GPG.php, method Crypt_GPG::addEncryptKey()
    Adds a key to use for encryption
addErrorHandler
in file Engine.php, method Crypt_GPG_Engine::addErrorHandler()
    Adds an error handler method
addSignKey
in file GPG.php, method Crypt_GPG::addSignKey()
    Adds a key to use for signing
addStatusHandler
in file Engine.php, method Crypt_GPG_Engine::addStatusHandler()
    Adds a status handler method
addSubKey
in file Key.php, method Crypt_GPG_Key::addSubKey()
    Adds a sub-key to this key
addUserId
in file Key.php, method Crypt_GPG_Key::addUserId()
    Adds a user id to this key
ALGORITHM_DSA
in file SubKey.php, class constant Crypt_GPG_SubKey::ALGORITHM_DSA
    DSA encryption algorithm (sometimes called DH, sign only).
ALGORITHM_ELGAMAL_ENC
in file SubKey.php, class constant Crypt_GPG_SubKey::ALGORITHM_ELGAMAL_ENC
    Elgamal encryption algorithm (encryption only).
ALGORITHM_ELGAMAL_ENC_SGN
in file SubKey.php, class constant Crypt_GPG_SubKey::ALGORITHM_ELGAMAL_ENC_SGN
    Elgamal encryption algorithm (signage and encryption - should not be used).
ALGORITHM_RSA
in file SubKey.php, class constant Crypt_GPG_SubKey::ALGORITHM_RSA
    RSA encryption algorithm.
ARMOR_ASCII
in file GPG.php, class constant Crypt_GPG::ARMOR_ASCII
    Use to specify ASCII armored mode for returned data
ARMOR_BINARY
in file GPG.php, class constant Crypt_GPG::ARMOR_BINARY
    Use to specify binary mode for returned data
top

b

$badPassphrases
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$badPassphrases
    Keys for which the passhprase is incorrect
BUG_URI
in file GPGAbstract.php, class constant Crypt_GPGAbstract::BUG_URI
    URI at which package bugs may be reported.
ByteUtils.php
procedural page ByteUtils.php
top

c

$currentPin
in file PinEntry.php, variable Crypt_GPG_PinEntry::$currentPin
    The PIN currently being requested by the Assuan server
$currentSubKey
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$currentSubKey
    The id of the current sub-key used for decryption
canEncrypt
in file Key.php, method Crypt_GPG_Key::canEncrypt()
    Gets whether or not this key can encrypt data
canEncrypt
in file SubKey.php, method Crypt_GPG_SubKey::canEncrypt()
    Gets whether or not this sub-key can encrypt data
canSign
in file Key.php, method Crypt_GPG_Key::canSign()
    Gets whether or not this key can sign data
canSign
in file SubKey.php, method Crypt_GPG_SubKey::canSign()
    Gets whether or not this sub-key can sign data
CHUNK_SIZE
in file Engine.php, class constant Crypt_GPG_Engine::CHUNK_SIZE
    Size of data chunks that are sent to and retrieved from the IPC pipes.
CHUNK_SIZE
in file PinEntry.php, class constant Crypt_GPG_PinEntry::CHUNK_SIZE
    Length of buffer for reading lines from the Assuan server.
clearDecryptKeys
in file GPG.php, method Crypt_GPG::clearDecryptKeys()
    Clears all decryption keys
clearEncryptKeys
in file GPG.php, method Crypt_GPG::clearEncryptKeys()
    Clears all encryption keys
clearSignKeys
in file GPG.php, method Crypt_GPG::clearSignKeys()
    Clears all signing keys
connect
in file PinEntry.php, method Crypt_GPG_PinEntry::connect()
    Connects this pinentry to the assuan server
Crypt_GPG
in file GPG.php, class Crypt_GPG
    A class to use GPG from PHP
Crypt_GPGAbstract
in file GPGAbstract.php, class Crypt_GPGAbstract
    Base class for implementing a user of Crypt_GPG_Engine
Crypt_GPG_BadPassphraseException
in file Exceptions.php, class Crypt_GPG_BadPassphraseException
    An exception thrown when a required passphrase is incorrect or missing
Crypt_GPG_ByteUtils
in file ByteUtils.php, class Crypt_GPG_ByteUtils
    A class for performing byte-wise string operations
Crypt_GPG_DecryptStatusHandler
in file DecryptStatusHandler.php, class Crypt_GPG_DecryptStatusHandler
    Status line handler for the decrypt operation
Crypt_GPG_DeletePrivateKeyException
in file Exceptions.php, class Crypt_GPG_DeletePrivateKeyException
    An exception thrown when an attempt is made to delete public key that has an associated private key on the keyring
Crypt_GPG_Engine
in file Engine.php, class Crypt_GPG_Engine
    Native PHP Crypt_GPG I/O engine
Crypt_GPG_Exception
in file Exceptions.php, class Crypt_GPG_Exception
    An exception thrown by the Crypt_GPG package
Crypt_GPG_FileException
in file Exceptions.php, class Crypt_GPG_FileException
    An exception thrown when a file is used in ways it cannot be used
Crypt_GPG_InvalidKeyParamsException
in file Exceptions.php, class Crypt_GPG_InvalidKeyParamsException
    An exception thrown when an attempt is made to generate a key and the key parameters set on the key generator are invalid
Crypt_GPG_InvalidOperationException
in file Exceptions.php, class Crypt_GPG_InvalidOperationException
    An exception thrown when an invalid GPG operation is attempted
Crypt_GPG_Key
in file Key.php, class Crypt_GPG_Key
    A data class for GPG key information
Crypt_GPG_KeyGenerator
in file KeyGenerator.php, class Crypt_GPG_KeyGenerator
    GnuPG key generator
Crypt_GPG_KeyGeneratorErrorHandler
in file KeyGeneratorErrorHandler.php, class Crypt_GPG_KeyGeneratorErrorHandler
    Error line handler for the key generation operation
Crypt_GPG_KeyGeneratorStatusHandler
in file KeyGeneratorStatusHandler.php, class Crypt_GPG_KeyGeneratorStatusHandler
    Status line handler for the key generation operation
Crypt_GPG_KeyNotCreatedException
in file Exceptions.php, class Crypt_GPG_KeyNotCreatedException
    An exception thrown when an attempt is made to generate a key and the attempt fails
Crypt_GPG_KeyNotFoundException
in file Exceptions.php, class Crypt_GPG_KeyNotFoundException
    An exception thrown when Crypt_GPG fails to find the key for various operations
Crypt_GPG_NoDataException
in file Exceptions.php, class Crypt_GPG_NoDataException
    An exception thrown when Crypt_GPG cannot find valid data for various operations
Crypt_GPG_OpenSubprocessException
in file Exceptions.php, class Crypt_GPG_OpenSubprocessException
    An exception thrown when the GPG subprocess cannot be opened
Crypt_GPG_PinEntry
in file PinEntry.php, class Crypt_GPG_PinEntry
    A command-line dummy pinentry program for use with gpg-agent and Crypt_GPG
Crypt_GPG_ProcessControl
in file ProcessControl.php, class Crypt_GPG_ProcessControl
    A class for monitoring and terminating processes by PID
Crypt_GPG_Signature
in file Signature.php, class Crypt_GPG_Signature
    A class for GPG signature information
Crypt_GPG_SubKey
in file SubKey.php, class Crypt_GPG_SubKey
    A class for GPG sub-key information
Crypt_GPG_UserId
in file UserId.php, class Crypt_GPG_UserId
    A class for GPG user id information
Crypt_GPG_VerifyStatusHandler
in file VerifyStatusHandler.php, class Crypt_GPG_VerifyStatusHandler
    Status line handler for the verify operation
top

d

$decryptionOkay
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$decryptionOkay
    Whether or not decryption succeeded
$decryptKeys
in file GPG.php, variable Crypt_GPG::$decryptKeys
    Keys used to sign
DecryptStatusHandler.php
procedural page DecryptStatusHandler.php
decrypt
in file GPG.php, method Crypt_GPG::decrypt()
    Decrypts string data
decryptAndVerify
in file GPG.php, method Crypt_GPG::decryptAndVerify()
    Decrypts and verifies string data
decryptAndVerifyFile
in file GPG.php, method Crypt_GPG::decryptAndVerifyFile()
    Decrypts and verifies a signed, encrypted file
decryptFile
in file GPG.php, method Crypt_GPG::decryptFile()
    Decrypts a file
deletePrivateKey
in file GPG.php, method Crypt_GPG::deletePrivateKey()
    Deletes a private key from the keyring
deletePublicKey
in file GPG.php, method Crypt_GPG::deletePublicKey()
    Deletes a public key from the keyring
disconnect
in file PinEntry.php, method Crypt_GPG_PinEntry::disconnect()
    Disconnects this pinentry from the Assuan server
top

e

$encryptKeys
in file GPG.php, variable Crypt_GPG::$encryptKeys
    Keys used to encrypt
$engine
in file GPGAbstract.php, variable Crypt_GPGAbstract::$engine
    Engine used to control the GPG subprocess
$engine
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$engine
    Engine used to which passphrases are passed
$engine
in file GPG.php, variable Crypt_GPG::$engine
    Engine used to control the GPG subprocess
$errorCode
in file KeyGeneratorErrorHandler.php, variable Crypt_GPG_KeyGeneratorErrorHandler::$errorCode
    Error code (if any) caused by key generation
$errorCode
in file KeyGeneratorStatusHandler.php, variable Crypt_GPG_KeyGeneratorStatusHandler::$errorCode
    Error code (if any) caused by key generation
$errorHandler
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$errorHandler
    The GnuPG error handler to use for key generation
$expirationDate
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$expirationDate
    The expiration date of generated keys
Engine.php
procedural page Engine.php
Exceptions.php
procedural page Exceptions.php
encrypt
in file GPG.php, method Crypt_GPG::encrypt()
    Encrypts string data
encryptAndSign
in file GPG.php, method Crypt_GPG::encryptAndSign()
    Encrypts and signs data
encryptAndSignFile
in file GPG.php, method Crypt_GPG::encryptAndSignFile()
    Encrypts and signs a file
encryptFile
in file GPG.php, method Crypt_GPG::encryptFile()
    Encrypts a file
ERROR_BAD_KEY_PARAMS
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_BAD_KEY_PARAMS
    Error code returned when bad key parameters are used during key generation.
ERROR_BAD_PASSPHRASE
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_BAD_PASSPHRASE
    Error code returned when a bad passphrase is used.
ERROR_BAD_SIGNATURE
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_BAD_SIGNATURE
    Error code returned when one or more bad signatures are detected.
ERROR_DELETE_PRIVATE_KEY
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_DELETE_PRIVATE_KEY
    Error code returned when an attempt to delete public key having a private key is made.
ERROR_DUPLICATE_KEY
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_DUPLICATE_KEY
    Error code returned when a key that is already in the keyring is imported.
ERROR_FILE_PERMISSIONS
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_FILE_PERMISSIONS
    Error code returned when there is a problem reading GnuPG data files.
ERROR_KEY_NOT_CREATED
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_KEY_NOT_CREATED
    Error code returned when a key could not be created.
ERROR_KEY_NOT_FOUND
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_KEY_NOT_FOUND
    Error code returned when a public or private key that is not in the keyring is used.
ERROR_MISSING_PASSPHRASE
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_MISSING_PASSPHRASE
    Error code returned when a required passphrase is missing.
ERROR_NONE
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_NONE
    Error code returned when there is no error.
ERROR_NOT_SELF_SIGNED
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_NOT_SELF_SIGNED
    Error code returned when a key that is not self-signed is used.
ERROR_NO_DATA
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_NO_DATA
    Error code returned the required data is missing for an operation.
ERROR_UNKNOWN
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_UNKNOWN
    Error code returned when an unknown or unhandled error occurs.
ERROR_UNSIGNED_KEY
in file GPGAbstract.php, class constant Crypt_GPGAbstract::ERROR_UNSIGNED_KEY
    Error code returned when an unsigned key is used.
exportPublicKey
in file GPG.php, method Crypt_GPG::exportPublicKey()
    Exports a public key from the keyring
top

f

FD_COMMAND
in file Engine.php, class constant Crypt_GPG_Engine::FD_COMMAND
    Command input file descriptor. This is used for methods requiring passphrases.
FD_ERROR
in file Engine.php, class constant Crypt_GPG_Engine::FD_ERROR
    Standard output file descriptor. This is used to receive error output from the GPG process.
FD_INPUT
in file Engine.php, class constant Crypt_GPG_Engine::FD_INPUT
    Standard input file descriptor. This is used to pass data to the GPG process.
FD_MESSAGE
in file Engine.php, class constant Crypt_GPG_Engine::FD_MESSAGE
    Extra message input file descriptor. This is used for passing signed data when verifying a detached signature.
FD_OUTPUT
in file Engine.php, class constant Crypt_GPG_Engine::FD_OUTPUT
    Standard output file descriptor. This is used to receive normal output from the GPG process.
FD_STATUS
in file Engine.php, class constant Crypt_GPG_Engine::FD_STATUS
    GPG status output file descriptor. The status file descriptor outputs
FORMAT_CANONICAL
in file GPG.php, class constant Crypt_GPG::FORMAT_CANONICAL
    Fingerprint is formatted in the format used by the GnuPG gpg command's default output.
FORMAT_NONE
in file GPG.php, class constant Crypt_GPG::FORMAT_NONE
    No formatting is performed.
FORMAT_X509
in file GPG.php, class constant Crypt_GPG::FORMAT_X509
    Fingerprint is formatted in the format used when displaying X.509 certificates
top

g

GPG.php
procedural page GPG.php
GPGAbstract.php
procedural page GPGAbstract.php
generateKey
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::generateKey()
    Generates a new key-pair in the current keyring
getAlgorithm
in file SubKey.php, method Crypt_GPG_SubKey::getAlgorithm()
    Gets the algorithm used by this sub-key
getAlgorithm
in file Exceptions.php, method Crypt_GPG_InvalidKeyParamsException::getAlgorithm()
    Gets the key algorithm
getBadPassphrases
in file Exceptions.php, method Crypt_GPG_BadPassphraseException::getBadPassphrases()
    Gets keys for which the passhprase is incorrect
getCommand
in file Exceptions.php, method Crypt_GPG_OpenSubprocessException::getCommand()
    Returns the contents of the internal _command property
getCommandLineParser
in file PinEntry.php, method Crypt_GPG_PinEntry::getCommandLineParser()
    Gets the CLI parser for this pinentry
getComment
in file PinEntry.php, method Crypt_GPG_PinEntry::getComment()
    Gets a comment ready to send to the assuan server
getComment
in file UserId.php, method Crypt_GPG_UserId::getComment()
    Gets the comments field of this user id
getCreationDate
in file Signature.php, method Crypt_GPG_Signature::getCreationDate()
    Gets the creation date of this signature
getCreationDate
in file SubKey.php, method Crypt_GPG_SubKey::getCreationDate()
    Gets the creation date of this sub-key
getData
in file PinEntry.php, method Crypt_GPG_PinEntry::getData()
    Gets data ready to send to the assuan server
getEmail
in file UserId.php, method Crypt_GPG_UserId::getEmail()
    Gets the email field of this user id
getErrorCode
in file Engine.php, method Crypt_GPG_Engine::getErrorCode()
    Gets the error code of the last executed operation
getErrorCode
in file KeyGeneratorErrorHandler.php, method Crypt_GPG_KeyGeneratorErrorHandler::getErrorCode()
    Gets the error code resulting from key gneration
getErrorCode
in file KeyGeneratorStatusHandler.php, method Crypt_GPG_KeyGeneratorStatusHandler::getErrorCode()
    Gets the error code resulting from key gneration
getErrorFilename
in file Engine.php, method Crypt_GPG_Engine::getErrorFilename()
    Gets the file related to the error code of the last executed operation
getErrorKeyId
in file Engine.php, method Crypt_GPG_Engine::getErrorKeyId()
    Gets the key id related to the error code of the last executed operation
getExpirationDate
in file SubKey.php, method Crypt_GPG_SubKey::getExpirationDate()
    Gets the date this sub-key expires
getExpirationDate
in file Signature.php, method Crypt_GPG_Signature::getExpirationDate()
    Gets the expiration date of the signature
getFilename
in file Exceptions.php, method Crypt_GPG_FileException::getFilename()
    Returns the filename of the file that caused this exception
getFingerprint
in file GPG.php, method Crypt_GPG::getFingerprint()
    Gets a key fingerprint from the keyring
getFingerprint
in file SubKey.php, method Crypt_GPG_SubKey::getFingerprint()
    Gets the fingerprint of this sub-key
getId
in file SubKey.php, method Crypt_GPG_SubKey::getId()
    Gets the id of this sub-key
getId
in file Signature.php, method Crypt_GPG_Signature::getId()
    Gets the id of this signature
getKeyFingerprint
in file Signature.php, method Crypt_GPG_Signature::getKeyFingerprint()
    Gets the fingerprint of the key used to create this signature
getKeyFingerprint
in file KeyGeneratorStatusHandler.php, method Crypt_GPG_KeyGeneratorStatusHandler::getKeyFingerprint()
    Gets the key fingerprint parsed by this handler
getKeyId
in file Exceptions.php, method Crypt_GPG_DeletePrivateKeyException::getKeyId()
    Gets the key identifier of the key that was not found
getKeyId
in file Exceptions.php, method Crypt_GPG_KeyNotFoundException::getKeyId()
    Gets the key identifier of the key that was not found
getKeyId
in file Signature.php, method Crypt_GPG_Signature::getKeyId()
    Gets the id of the key used to create this signature
getKeys
in file GPG.php, method Crypt_GPG::getKeys()
    Gets the available keys in the keyring
getLength
in file SubKey.php, method Crypt_GPG_SubKey::getLength()
    Gets the length of this sub-key in bits
getLineNumber
in file KeyGeneratorErrorHandler.php, method Crypt_GPG_KeyGeneratorErrorHandler::getLineNumber()
    Gets the line number at which the error occurred
getMissingPassphrases
in file Exceptions.php, method Crypt_GPG_BadPassphraseException::getMissingPassphrases()
    Gets keys for which the passhprase is missing
getName
in file UserId.php, method Crypt_GPG_UserId::getName()
    Gets the name field of this user id
getOK
in file PinEntry.php, method Crypt_GPG_PinEntry::getOK()
    Gets an OK response to send to the assuan server
getOperation
in file Exceptions.php, method Crypt_GPG_InvalidOperationException::getOperation()
    Returns the contents of the internal _operation property
getPid
in file ProcessControl.php, method Crypt_GPG_ProcessControl::getPid()
    Gets the PID (process identifier) being controlled
getPrimaryKey
in file Key.php, method Crypt_GPG_Key::getPrimaryKey()
    Gets the primary sub-key of this key
getSignatures
in file VerifyStatusHandler.php, method Crypt_GPG_VerifyStatusHandler::getSignatures()
    Gets the Crypt_GPG_Signature objects parsed by this handler
getSize
in file Exceptions.php, method Crypt_GPG_InvalidKeyParamsException::getSize()
    Gets the key size
getSubKeys
in file Key.php, method Crypt_GPG_Key::getSubKeys()
    Gets the sub-keys of this key
getUIXML
in file PinEntry.php, method Crypt_GPG_PinEntry::getUIXML()
    Gets the CLI user-interface definition for this pinentry
getUsage
in file Exceptions.php, method Crypt_GPG_InvalidKeyParamsException::getUsage()
    Gets the key usage
getUsage
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::getUsage()
    Builds a GnuPG key usage string suitable for key generation
getUserId
in file Signature.php, method Crypt_GPG_Signature::getUserId()
    Gets the user id associated with this signature
getUserId
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::getUserId()
    Gets a user id object from parameters
getUserIds
in file Key.php, method Crypt_GPG_Key::getUserIds()
    Gets the user ids of this key
getVersion
in file Engine.php, method Crypt_GPG_Engine::getVersion()
    Gets the version of the GnuPG binary
getWordWrappedData
in file PinEntry.php, method Crypt_GPG_PinEntry::getWordWrappedData()
    Wraps strings at 1,000 bytes without splitting UTF-8 multibyte characters
top

h

$handle
in file KeyGeneratorStatusHandler.php, variable Crypt_GPG_KeyGeneratorStatusHandler::$handle
    The unique key handle used by this handler
handle
in file KeyGeneratorStatusHandler.php, method Crypt_GPG_KeyGeneratorStatusHandler::handle()
    Handles a status line
handle
in file VerifyStatusHandler.php, method Crypt_GPG_VerifyStatusHandler::handle()
    Handles a status line
handle
in file KeyGeneratorErrorHandler.php, method Crypt_GPG_KeyGeneratorErrorHandler::handle()
    Handles an error line
handle
in file DecryptStatusHandler.php, method Crypt_GPG_DecryptStatusHandler::handle()
    Handles a status line
handleImportKeyStatus
in file GPG.php, method Crypt_GPG::handleImportKeyStatus()
    Handles the status output from GPG for the import operation
handleSignStatus
in file GPG.php, method Crypt_GPG::handleSignStatus()
    Handles the status output from GPG for the sign operation
hasPrivate
in file SubKey.php, method Crypt_GPG_SubKey::hasPrivate()
    Gets whether or not the private key for this sub-key exists in the keyring
top

i

$index
in file VerifyStatusHandler.php, variable Crypt_GPG_VerifyStatusHandler::$index
    Array index of the current signature
importKey
in file GPG.php, method Crypt_GPG::importKey()
    Imports a public or private key into the keyring
importKeyFile
in file GPG.php, method Crypt_GPG::importKeyFile()
    Imports a public or private key file into the keyring
initPinsFromENV
in file PinEntry.php, method Crypt_GPG_PinEntry::initPinsFromENV()
    Initializes the PINs to be entered by this pinentry from the environment variable PINENTRY_USER_DATA
isRevoked
in file SubKey.php, method Crypt_GPG_SubKey::isRevoked()
    Gets whether or not this sub-key is revoked
isRevoked
in file UserId.php, method Crypt_GPG_UserId::isRevoked()
    Gets whether or not this user id is revoked
isRunning
in file ProcessControl.php, method Crypt_GPG_ProcessControl::isRunning()
    Checks if the process is running
isValid
in file Signature.php, method Crypt_GPG_Signature::isValid()
    Gets whether or no this signature is valid
isValid
in file UserId.php, method Crypt_GPG_UserId::isValid()
    Gets whether or not this user id is valid
top

k

$keyAlgorithm
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$keyAlgorithm
    The algorithm for generated primary keys
$keyFingerprint
in file KeyGeneratorStatusHandler.php, variable Crypt_GPG_KeyGeneratorStatusHandler::$keyFingerprint
    The key fingerprint
$keys
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$keys
    Keys used to decrypt
$keySize
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$keySize
    The size of generated primary keys
$keyUsage
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$keyUsage
    The usages of generated primary keys
Key.php
procedural page Key.php
KeyGenerator.php
procedural page KeyGenerator.php
KeyGeneratorErrorHandler.php
procedural page KeyGeneratorErrorHandler.php
KeyGeneratorStatusHandler.php
procedural page KeyGeneratorStatusHandler.php
top

l

$lineNumber
in file KeyGeneratorErrorHandler.php, variable Crypt_GPG_KeyGeneratorErrorHandler::$lineNumber
    Line number at which the error occurred
$logFile
in file PinEntry.php, variable Crypt_GPG_PinEntry::$logFile
    File handle for the log file if a log file is used
log
in file PinEntry.php, method Crypt_GPG_PinEntry::log()
    Logs a message at the specified verbosity level
top

m

$missingKeys
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$missingKeys
    Keys that can be used to decrypt the data but are missing from the keychain
$missingPassphrases
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$missingPassphrases
    Keys for which the passhprase is missing
$moribund
in file PinEntry.php, variable Crypt_GPG_PinEntry::$moribund
    Whether or not this pinentry is finished and is exiting
MIN_VERSION
in file Engine.php, class constant Crypt_GPG_Engine::MIN_VERSION
    Minimum version of GnuPG that is supported.
top

n

$noData
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$noData
    Whether or not there was no data for decryption
top

p

$parser
in file PinEntry.php, variable Crypt_GPG_PinEntry::$parser
    The command-line interface parser for this pinentry
$passphrase
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$passphrase
    The passphrase of generated keys
$pid
in file ProcessControl.php, variable Crypt_GPG_ProcessControl::$pid
    The PID (process identifier) being monitored
$pins
in file PinEntry.php, variable Crypt_GPG_PinEntry::$pins
    PINs to be entered by this pinentry
PinEntry.php
procedural page PinEntry.php
ProcessControl.php
procedural page ProcessControl.php
parse
in file SubKey.php, method Crypt_GPG_SubKey::parse()
    Parses a sub-key object from a sub-key string
parse
in file UserId.php, method Crypt_GPG_UserId::parse()
    Parses a user id object from a user id string
parseCommand
in file PinEntry.php, method Crypt_GPG_PinEntry::parseCommand()
    Parses an assuan command and performs the appropriate action
top

r

reset
in file Engine.php, method Crypt_GPG_Engine::reset()
    Resets the GPG engine, preparing it for a new operation
run
in file Engine.php, method Crypt_GPG_Engine::run()
    Runs the current GPG operation
top

s

$signatureId
in file VerifyStatusHandler.php, variable Crypt_GPG_VerifyStatusHandler::$signatureId
    The current signature id
$signatures
in file VerifyStatusHandler.php, variable Crypt_GPG_VerifyStatusHandler::$signatures
    List of parsed Crypt_GPG_Signature objects
$signKeys
in file GPG.php, variable Crypt_GPG::$signKeys
    Keys used to decrypt
$statusHandler
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$statusHandler
    The GnuPG status handler to use for key generation
$stdin
in file PinEntry.php, variable Crypt_GPG_PinEntry::$stdin
    File handle for the input stream
$stdout
in file PinEntry.php, variable Crypt_GPG_PinEntry::$stdout
    File handle for the output stream
$subKeyAlgorithm
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$subKeyAlgorithm
    The algorithm for generated sub-keys
$subKeySize
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$subKeySize
    The size of generated sub-keys
$subKeyUsage
in file KeyGenerator.php, variable Crypt_GPG_KeyGenerator::$subKeyUsage
    The usages of generated sub-keys
Signature.php
procedural page Signature.php
SubKey.php
procedural page SubKey.php
send
in file PinEntry.php, method Crypt_GPG_PinEntry::send()
    Sends raw data to the assuan server
sendButtonInfo
in file PinEntry.php, method Crypt_GPG_PinEntry::sendButtonInfo()
    Sends information about pressed buttons to the assuan server
sendBye
in file PinEntry.php, method Crypt_GPG_PinEntry::sendBye()
    Flags this pinentry for disconnection and sends an OK response
sendCommand
in file Engine.php, method Crypt_GPG_Engine::sendCommand()
    Sends a command to the GPG subprocess over the command file-descriptor pipe
sendConfirm
in file PinEntry.php, method Crypt_GPG_PinEntry::sendConfirm()
    Tells the assuan server the PIN entry was confirmed (not cancelled) by pressing the fake 'close' button
sendGetInfo
in file PinEntry.php, method Crypt_GPG_PinEntry::sendGetInfo()
    Sends information about this pinentry
sendGetInfoPID
in file PinEntry.php, method Crypt_GPG_PinEntry::sendGetInfoPID()
    Sends the PID of this pinentry to the assuan server
sendGetPin
in file PinEntry.php, method Crypt_GPG_PinEntry::sendGetPin()
    Sends the PIN value for the currently requested key
sendMessage
in file PinEntry.php, method Crypt_GPG_PinEntry::sendMessage()
    Tells the assuan server that any requested pop-up messages were confirmed by pressing the fake 'close' button
sendNotImplementedOK
in file PinEntry.php, method Crypt_GPG_PinEntry::sendNotImplementedOK()
    Sends an OK response for a not implemented feature
sendReset
in file PinEntry.php, method Crypt_GPG_PinEntry::sendReset()
    Resets this pinentry and sends an OK response
sendSetDescription
in file PinEntry.php, method Crypt_GPG_PinEntry::sendSetDescription()
    Parses the currently requested key identifier and user identifier from the description passed to this pinentry
setAlgorithm
in file SubKey.php, method Crypt_GPG_SubKey::setAlgorithm()
    Sets the algorithm used by this sub-key
setCanEncrypt
in file SubKey.php, method Crypt_GPG_SubKey::setCanEncrypt()
    Sets whether of not this sub-key can encrypt data
setCanSign
in file SubKey.php, method Crypt_GPG_SubKey::setCanSign()
    Sets whether of not this sub-key can sign data
setComment
in file UserId.php, method Crypt_GPG_UserId::setComment()
    Sets the comment field of this user id
setCreationDate
in file SubKey.php, method Crypt_GPG_SubKey::setCreationDate()
    Sets the creation date of this sub-key
setCreationDate
in file Signature.php, method Crypt_GPG_Signature::setCreationDate()
    Sets the creation date of this signature
setEmail
in file UserId.php, method Crypt_GPG_UserId::setEmail()
    Sets the email field of this user id
setEngine
in file GPGAbstract.php, method Crypt_GPGAbstract::setEngine()
    Sets the I/O engine to use for GnuPG operations
setErrorHandler
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setErrorHandler()
    Sets the error handler to use for key generation
setExpirationDate
in file SubKey.php, method Crypt_GPG_SubKey::setExpirationDate()
    Sets the expiration date of this sub-key
setExpirationDate
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setExpirationDate()
    Sets the expiration date of generated keys
setExpirationDate
in file Signature.php, method Crypt_GPG_Signature::setExpirationDate()
    Sets the expiration date of this signature
setFingerprint
in file SubKey.php, method Crypt_GPG_SubKey::setFingerprint()
    Sets the fingerprint of this sub-key
setHandle
in file KeyGeneratorStatusHandler.php, method Crypt_GPG_KeyGeneratorStatusHandler::setHandle()
    Sets the unique key handle used by this handler
setHasPrivate
in file SubKey.php, method Crypt_GPG_SubKey::setHasPrivate()
    Sets whether of not the private key for this sub-key exists in the keyring
setId
in file Signature.php, method Crypt_GPG_Signature::setId()
    Sets the id of this signature
setId
in file SubKey.php, method Crypt_GPG_SubKey::setId()
    Sets the id of this sub-key
setInput
in file Engine.php, method Crypt_GPG_Engine::setInput()
    Sets the input source for the current GPG operation
setKeyFingerprint
in file Signature.php, method Crypt_GPG_Signature::setKeyFingerprint()
    Sets the key fingerprint of this signature
setKeyId
in file Signature.php, method Crypt_GPG_Signature::setKeyId()
    Sets the key id of this signature
setKeyParams
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setKeyParams()
    Sets the parameters for the primary key of generated key-pairs
setLength
in file SubKey.php, method Crypt_GPG_SubKey::setLength()
    Sets the length of this sub-key in bits
setLogFilename
in file PinEntry.php, method Crypt_GPG_PinEntry::setLogFilename()
    Sets the log file location
setMessage
in file Engine.php, method Crypt_GPG_Engine::setMessage()
    Sets the message source for the current GPG operation
setName
in file UserId.php, method Crypt_GPG_UserId::setName()
    Sets the name field of this user id
setOperation
in file Engine.php, method Crypt_GPG_Engine::setOperation()
    Sets the operation to perform
setOutput
in file Engine.php, method Crypt_GPG_Engine::setOutput()
    Sets the output destination for the current GPG operation
setPassphrase
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setPassphrase()
    Sets the passphrase of generated keys
setRevoked
in file SubKey.php, method Crypt_GPG_SubKey::setRevoked()
    Sets whether or not this sub-key is revoked
setRevoked
in file UserId.php, method Crypt_GPG_UserId::setRevoked()
    Sets whether or not this user id is revoked
setStatusHandler
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setStatusHandler()
    Sets the status handler to use for key generation
setSubKeyParams
in file KeyGenerator.php, method Crypt_GPG_KeyGenerator::setSubKeyParams()
    Sets the parameters for the sub-key of generated key-pairs
setUserId
in file Signature.php, method Crypt_GPG_Signature::setUserId()
    Sets the user id associated with this signature
setValid
in file UserId.php, method Crypt_GPG_UserId::setValid()
    Sets whether or not this user id is valid
setValid
in file Signature.php, method Crypt_GPG_Signature::setValid()
    Sets whether or not this signature is valid
setVerbosity
in file PinEntry.php, method Crypt_GPG_PinEntry::setVerbosity()
    Sets the verbosity of logging for this pinentry
sign
in file GPG.php, method Crypt_GPG::sign()
    Signs data
signFile
in file GPG.php, method Crypt_GPG::signFile()
    Signs a file
SIGN_MODE_CLEAR
in file GPG.php, class constant Crypt_GPG::SIGN_MODE_CLEAR
    Signing mode for clearsigning data. Clearsigned signatures are ASCII armored data and are readable without special software. If the signed message is unencrypted, the message will still be readable. The message text will be in the original encoding.
SIGN_MODE_DETACHED
in file GPG.php, class constant Crypt_GPG::SIGN_MODE_DETACHED
    Signing mode for creating a detached signature. When using detached
SIGN_MODE_NORMAL
in file GPG.php, class constant Crypt_GPG::SIGN_MODE_NORMAL
    Signing mode for normal signing of data. The signed message will not be readable without special software.
strlen
in file ByteUtils.php, method Crypt_GPG_ByteUtils::strlen()
    Gets the length of a string in bytes
substr
in file ByteUtils.php, method Crypt_GPG_ByteUtils::substr()
    Gets the substring of a string in bytes
top

t

$triedPins
in file PinEntry.php, variable Crypt_GPG_PinEntry::$triedPins
    PINs that have been tried for the current PIN
terminate
in file ProcessControl.php, method Crypt_GPG_ProcessControl::terminate()
    Ends the process gracefully
TEXT_NORMALIZED
in file GPG.php, class constant Crypt_GPG::TEXT_NORMALIZED
    Use to specify that line breaks in signed text should be normalized
TEXT_RAW
in file GPG.php, class constant Crypt_GPG::TEXT_RAW
    Use to specify that line breaks in signed text should not be normalized
throwException
in file DecryptStatusHandler.php, method Crypt_GPG_DecryptStatusHandler::throwException()
    Takes the final status of the decrypt operation and throws an appropriate exception
top

u

UserId.php
procedural page UserId.php
USAGE_AUTHENTICATION
in file SubKey.php, class constant Crypt_GPG_SubKey::USAGE_AUTHENTICATION
    Key can be used for authentication
USAGE_CERTIFY
in file SubKey.php, class constant Crypt_GPG_SubKey::USAGE_CERTIFY
    Key can be used to certify other keys
USAGE_ENCRYPT
in file SubKey.php, class constant Crypt_GPG_SubKey::USAGE_ENCRYPT
    Key can be used to encrypt
USAGE_SIGN
in file SubKey.php, class constant Crypt_GPG_SubKey::USAGE_SIGN
    Key can be used to sign
top

v

$verbosity
in file PinEntry.php, variable Crypt_GPG_PinEntry::$verbosity
    Verbosity level
VerifyStatusHandler.php
procedural page VerifyStatusHandler.php
VERBOSITY_ALL
in file PinEntry.php, class constant Crypt_GPG_PinEntry::VERBOSITY_ALL
    Verbosity level for showing all output, including Assuan protocol messages.
VERBOSITY_ERRORS
in file PinEntry.php, class constant Crypt_GPG_PinEntry::VERBOSITY_ERRORS
    Verbosity level for showing error output.
VERBOSITY_NONE
in file PinEntry.php, class constant Crypt_GPG_PinEntry::VERBOSITY_NONE
    Verbosity level for showing no output.
verify
in file GPG.php, method Crypt_GPG::verify()
    Verifies signed data
verifyFile
in file GPG.php, method Crypt_GPG::verifyFile()
    Verifies a signed file
top

Documentation generated on Wed, 13 Mar 2013 18:30:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.