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

Index of all elements

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

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.
top

b

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

c

$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 SubKey.php, method Crypt_GPG_SubKey::canSign()
    Gets whether or not this sub-key can sign data
canSign
in file Key.php, method Crypt_GPG_Key::canSign()
    Gets whether or not this 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.
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
Crypt_GPG
in file GPG.php, class Crypt_GPG
    A class to use GPG from PHP
Crypt_GPG_BadPassphraseException
in file Exceptions.php, class Crypt_GPG_BadPassphraseException
    An exception thrown when a required passphrase is incorrect or missing
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_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_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_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
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
top

e

$encryptKeys
in file GPG.php, variable Crypt_GPG::$encryptKeys
    Keys used to encrypt
$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
Engine.php
procedural page Engine.php
Exceptions.php
procedural page Exceptions.php
encrypt
in file GPG.php, method Crypt_GPG::encrypt()
    Encrypts string data
encryptFile
in file GPG.php, method Crypt_GPG::encryptFile()
    Encrypts a file
ERROR_BAD_PASSPHRASE
in file GPG.php, class constant Crypt_GPG::ERROR_BAD_PASSPHRASE
    Error code returned when a bad passphrase is used.
ERROR_DELETE_PRIVATE_KEY
in file GPG.php, class constant Crypt_GPG::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 GPG.php, class constant Crypt_GPG::ERROR_DUPLICATE_KEY
    Error code returned when a key that is already in the keyring is imported.
ERROR_KEY_NOT_FOUND
in file GPG.php, class constant Crypt_GPG::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 GPG.php, class constant Crypt_GPG::ERROR_MISSING_PASSPHRASE
    Error code returned when a required passphrase is missing.
ERROR_NONE
in file GPG.php, class constant Crypt_GPG::ERROR_NONE
    Error code returned when there is no error.
ERROR_NOT_SELF_SIGNED
in file GPG.php, class constant Crypt_GPG::ERROR_NOT_SELF_SIGNED
    Error code returned when a key that is not self-signed is used.
ERROR_NO_DATA
in file GPG.php, class constant Crypt_GPG::ERROR_NO_DATA
    Error code returned the required data is missing for an operation.
ERROR_UNKNOWN
in file GPG.php, class constant Crypt_GPG::ERROR_UNKNOWN
    Error code returned when an unknown or unhandled error occurs.
ERROR_UNSIGNED_KEY
in file GPG.php, class constant Crypt_GPG::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
getAlgorithm
in file SubKey.php, method Crypt_GPG_SubKey::getAlgorithm()
    Gets the algorithm used by this sub-key
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
getComment
in file UserId.php, method Crypt_GPG_UserId::getComment()
    Gets the comments field of this user id
getCreationDate
in file SubKey.php, method Crypt_GPG_SubKey::getCreationDate()
    Gets the creation date of this sub-key
getCreationDate
in file Signature.php, method Crypt_GPG_Signature::getCreationDate()
    Gets the creation date of this signature
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
getExpirationDate
in file Signature.php, method Crypt_GPG_Signature::getExpirationDate()
    Gets the expiration date of the signature
getExpirationDate
in file SubKey.php, method Crypt_GPG_SubKey::getExpirationDate()
    Gets the date this sub-key expires
getFilename
in file Exceptions.php, method Crypt_GPG_FileException::getFilename()
    Returns the filename of the file that caused this exception
getFingerprint
in file SubKey.php, method Crypt_GPG_SubKey::getFingerprint()
    Gets the fingerprint of this sub-key
getFingerprint
in file GPG.php, method Crypt_GPG::getFingerprint()
    Gets a key fingerprint from the keyring
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
getKeyId
in file Exceptions.php, method Crypt_GPG_KeyNotFoundException::getKeyId()
    Gets the key identifier of the key that was not found
getKeyId
in file Exceptions.php, method Crypt_GPG_DeletePrivateKeyException::getKeyId()
    Gets the key identifier of the key that was not found
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
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
getOperation
in file Exceptions.php, method Crypt_GPG_InvalidOperationException::getOperation()
    Returns the contents of the internal _operation property
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
getSubKeys
in file Key.php, method Crypt_GPG_Key::getSubKeys()
    Gets the sub-keys of this key
getUserId
in file Signature.php, method Crypt_GPG_Signature::getUserId()
    Gets the user id associated with this signature
getUserIds
in file Key.php, method Crypt_GPG_Key::getUserIds()
    Gets the user ids of this key
top

h

handle
in file VerifyStatusHandler.php, method Crypt_GPG_VerifyStatusHandler::handle()
    Handles a status 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
isRevoked
in file UserId.php, method Crypt_GPG_UserId::isRevoked()
    Gets whether or not this user id is revoked
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

$keys
in file DecryptStatusHandler.php, variable Crypt_GPG_DecryptStatusHandler::$keys
    Keys used to decrypt
Key.php
procedural page Key.php
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
top

n

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

p

parse
in file UserId.php, method Crypt_GPG_UserId::parse()
    Parses a user id object from a user id string
parse
in file SubKey.php, method Crypt_GPG_SubKey::parse()
    Parses a sub-key object from a sub-key string
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
Signature.php
procedural page Signature.php
SubKey.php
procedural page SubKey.php
sendCommand
in file Engine.php, method Crypt_GPG_Engine::sendCommand()
    Sends a command to the GPG subprocess over the command file-descriptor pipe
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
setExpirationDate
in file SubKey.php, method Crypt_GPG_SubKey::setExpirationDate()
    Sets the expiration date of this sub-key
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
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 SubKey.php, method Crypt_GPG_SubKey::setId()
    Sets the id of this sub-key
setId
in file Signature.php, method Crypt_GPG_Signature::setId()
    Sets the id of this signature
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
setLength
in file SubKey.php, method Crypt_GPG_SubKey::setLength()
    Sets the length of this sub-key in bits
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
setRevoked
in file UserId.php, method Crypt_GPG_UserId::setRevoked()
    Sets whether or not this user id is revoked
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
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.
top

t

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
top

v

VerifyStatusHandler.php
procedural page VerifyStatusHandler.php
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

_

__construct
in file GPG.php, method Crypt_GPG::__construct()
    Creates a new GPG object
__construct
in file Exceptions.php, method Crypt_GPG_OpenSubprocessException::__construct()
    Creates a new Crypt_GPG_OpenSubprocessException
__construct
in file Signature.php, method Crypt_GPG_Signature::__construct()
    Creates a new signature
__construct
in file SubKey.php, method Crypt_GPG_SubKey::__construct()
    Creates a new sub-key object
__construct
in file UserId.php, method Crypt_GPG_UserId::__construct()
    Creates a new user id
__construct
in file Exceptions.php, method Crypt_GPG_KeyNotFoundException::__construct()
    Creates a new Crypt_GPG_KeyNotFoundException
__construct
in file Exceptions.php, method Crypt_GPG_InvalidOperationException::__construct()
    Creates a new Crypt_GPG_OpenSubprocessException
__construct
in file Engine.php, method Crypt_GPG_Engine::__construct()
    Creates a new GPG engine
__construct
in file DecryptStatusHandler.php, method Crypt_GPG_DecryptStatusHandler::__construct()
    Creates a new decryption status handler
__construct
in file Exceptions.php, method Crypt_GPG_BadPassphraseException::__construct()
    Creates a new Crypt_GPG_BadPassphraseException
__construct
in file Exceptions.php, method Crypt_GPG_DeletePrivateKeyException::__construct()
    Creates a new Crypt_GPG_DeletePrivateKeyException
__construct
in file Exceptions.php, method Crypt_GPG_FileException::__construct()
    Creates a new Crypt_GPG_FileException
__destruct
in file Engine.php, method Crypt_GPG_Engine::__destruct()
    Closes open GPG subprocesses when this object is destroyed
__toString
in file UserId.php, method Crypt_GPG_UserId::__toString()
    Gets a string representation of this user id
top

Documentation generated on Thu, 22 Jan 2009 21:30:04 -0500 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.