1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089 |
- <?php
-
- /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
- /**
- * Crypt_GPG is a package to use GPG from PHP
- *
- * This file contains an engine that handles GPG subprocess control and I/O.
- * PHP's process manipulation functions are used to handle the GPG subprocess.
- *
- * PHP version 5
- *
- * LICENSE:
- *
- * This library is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of the
- * License, or (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, see
- * <http://www.gnu.org/licenses/>
- *
- * @category Encryption
- * @package Crypt_GPG
- * @author Nathan Fredrickson <nathan@silverorange.com>
- * @author Michael Gauthier <mike@silverorange.com>
- * @copyright 2005-2013 silverorange
- * @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
- * @link http://pear.php.net/package/Crypt_GPG
- * @link http://www.gnupg.org/
- */
-
- /**
- * Crypt_GPG base class.
- */
- require_once 'Crypt/GPG.php';
-
- /**
- * GPG exception classes.
- */
- require_once 'Crypt/GPG/Exceptions.php';
-
- /**
- * Status/Error handler class.
- */
- require_once 'Crypt/GPG/ProcessHandler.php';
-
- /**
- * Process control methods.
- */
- require_once 'Crypt/GPG/ProcessControl.php';
-
- /**
- * Information about a created signature
- */
- require_once 'Crypt/GPG/SignatureCreationInfo.php';
-
- /**
- * Standard PEAR exception is used if GPG binary is not found.
- */
- require_once 'PEAR/Exception.php';
-
- // {{{ class Crypt_GPG_Engine
-
- /**
- * Native PHP Crypt_GPG I/O engine
- *
- * This class is used internally by Crypt_GPG and does not need be used
- * directly. See the {@link Crypt_GPG} class for end-user API.
- *
- * This engine uses PHP's native process control functions to directly control
- * the GPG process. The GPG executable is required to be on the system.
- *
- * All data is passed to the GPG subprocess using file descriptors. This is the
- * most secure method of passing data to the GPG subprocess.
- *
- * @category Encryption
- * @package Crypt_GPG
- * @author Nathan Fredrickson <nathan@silverorange.com>
- * @author Michael Gauthier <mike@silverorange.com>
- * @copyright 2005-2013 silverorange
- * @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
- * @link http://pear.php.net/package/Crypt_GPG
- * @link http://www.gnupg.org/
- */
- class Crypt_GPG_Engine
- {
- // {{{ constants
-
- /**
- * Size of data chunks that are sent to and retrieved from the IPC pipes.
- *
- * The value of 65536 has been chosen empirically
- * as the one with best performance.
- *
- * @see https://pear.php.net/bugs/bug.php?id=21077
- */
- const CHUNK_SIZE = 65536;
-
- /**
- * Standard input file descriptor. This is used to pass data to the GPG
- * process.
- */
- const FD_INPUT = 0;
-
- /**
- * Standard output file descriptor. This is used to receive normal output
- * from the GPG process.
- */
- const FD_OUTPUT = 1;
-
- /**
- * Standard output file descriptor. This is used to receive error output
- * from the GPG process.
- */
- const FD_ERROR = 2;
-
- /**
- * GPG status output file descriptor. The status file descriptor outputs
- * detailed information for many GPG commands. See the second section of
- * the file <b>doc/DETAILS</b> in the
- * {@link http://www.gnupg.org/download/ GPG package} for a detailed
- * description of GPG's status output.
- */
- const FD_STATUS = 3;
-
- /**
- * Command input file descriptor. This is used for methods requiring
- * passphrases.
- */
- const FD_COMMAND = 4;
-
- /**
- * Extra message input file descriptor. This is used for passing signed
- * data when verifying a detached signature.
- */
- const FD_MESSAGE = 5;
-
- /**
- * Minimum version of GnuPG that is supported.
- */
- const MIN_VERSION = '1.0.2';
-
- // }}}
- // {{{ private class properties
-
- /**
- * Whether or not to use strict mode
- *
- * When set to true, any clock problems (e.g. keys generate in future)
- * are errors, otherwise they are just warnings.
- *
- * Strict mode is disabled by default.
- *
- * @var boolean
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_strict = false;
-
- /**
- * Whether or not to use debugging mode
- *
- * When set to true, every GPG command is echoed before it is run. Sensitive
- * data is always handled using pipes and is not specified as part of the
- * command. As a result, sensitive data is never displayed when debug is
- * enabled. Sensitive data includes private key data and passphrases.
- *
- * This can be set to a callable function where first argument is the
- * debug line to process.
- *
- * Debugging is off by default.
- *
- * @var mixed
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_debug = false;
-
- /**
- * Location of GPG binary
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- * @see Crypt_GPG_Engine::_getBinary()
- */
- private $_binary = '';
-
- /**
- * Location of GnuPG agent binary
- *
- * Only used for GnuPG 2.x
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- * @see Crypt_GPG_Engine::_getAgent()
- */
- private $_agent = '';
-
- /**
- * Location of GnuPG conf binary
- *
- * Only used for GnuPG 2.1.x
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- * @see Crypt_GPG_Engine::_getGPGConf()
- */
- private $_gpgconf = null;
-
- /**
- * Directory containing the GPG key files
- *
- * This property only contains the path when the <i>homedir</i> option
- * is specified in the constructor.
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_homedir = '';
-
- /**
- * File path of the public keyring
- *
- * This property only contains the file path when the <i>public_keyring</i>
- * option is specified in the constructor.
- *
- * If the specified file path starts with <kbd>~/</kbd>, the path is
- * relative to the <i>homedir</i> if specified, otherwise to
- * <kbd>~/.gnupg</kbd>.
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_publicKeyring = '';
-
- /**
- * File path of the private (secret) keyring
- *
- * This property only contains the file path when the <i>private_keyring</i>
- * option is specified in the constructor.
- *
- * If the specified file path starts with <kbd>~/</kbd>, the path is
- * relative to the <i>homedir</i> if specified, otherwise to
- * <kbd>~/.gnupg</kbd>.
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_privateKeyring = '';
-
- /**
- * File path of the trust database
- *
- * This property only contains the file path when the <i>trust_db</i>
- * option is specified in the constructor.
- *
- * If the specified file path starts with <kbd>~/</kbd>, the path is
- * relative to the <i>homedir</i> if specified, otherwise to
- * <kbd>~/.gnupg</kbd>.
- *
- * @var string
- * @see Crypt_GPG_Engine::__construct()
- */
- private $_trustDb = '';
-
- /**
- * Array of pipes used for communication with the GPG binary
- *
- * This is an array of file descriptor resources.
- *
- * @var array
- */
- private $_pipes = array();
-
- /**
- * Array of pipes used for communication with the gpg-agent binary
- *
- * This is an array of file descriptor resources.
- *
- * @var array
- */
- private $_agentPipes = array();
-
- /**
- * Array of currently opened pipes
- *
- * This array is used to keep track of remaining opened pipes so they can
- * be closed when the GPG subprocess is finished. This array is a subset of
- * the {@link Crypt_GPG_Engine::$_pipes} array and contains opened file
- * descriptor resources.
- *
- * @var array
- * @see Crypt_GPG_Engine::_closePipe()
- */
- private $_openPipes = array();
-
- /**
- * A handle for the GPG process
- *
- * @var resource
- */
- private $_process = null;
-
- /**
- * A handle for the gpg-agent process
- *
- * @var resource
- */
- private $_agentProcess = null;
-
- /**
- * GPG agent daemon socket and PID for running gpg-agent
- *
- * @var string
- */
- private $_agentInfo = null;
-
- /**
- * Whether or not the operating system is Darwin (OS X)
- *
- * @var boolean
- */
- private $_isDarwin = false;
-
- /**
- * Message digest algorithm.
- *
- * @var string
- */
- private $_digest_algo = null;
-
- /**
- * Symmetric cipher algorithm.
- *
- * @var string
- */
- private $_cipher_algo = null;
-
- /**
- * Commands to be sent to GPG's command input stream
- *
- * @var string
- * @see Crypt_GPG_Engine::sendCommand()
- */
- private $_commandBuffer = '';
-
- /**
- * A status/error handler
- *
- * @var Crypt_GPG_ProcessHanler
- */
- private $_processHandler = null;
-
- /**
- * Array of status line handlers
- *
- * @var array
- * @see Crypt_GPG_Engine::addStatusHandler()
- */
- private $_statusHandlers = array();
-
- /**
- * Array of error line handlers
- *
- * @var array
- * @see Crypt_GPG_Engine::addErrorHandler()
- */
- private $_errorHandlers = array();
-
- /**
- * The input source
- *
- * This is data to send to GPG. Either a string or a stream resource.
- *
- * @var string|resource
- * @see Crypt_GPG_Engine::setInput()
- */
- private $_input = null;
-
- /**
- * The extra message input source
- *
- * Either a string or a stream resource.
- *
- * @var string|resource
- * @see Crypt_GPG_Engine::setMessage()
- */
- private $_message = null;
-
- /**
- * The output location
- *
- * This is where the output from GPG is sent. Either a string or a stream
- * resource.
- *
- * @var string|resource
- * @see Crypt_GPG_Engine::setOutput()
- */
- private $_output = '';
-
- /**
- * The GPG operation to execute
- *
- * @var string
- * @see Crypt_GPG_Engine::setOperation()
- */
- private $_operation;
-
- /**
- * Arguments for the current operation
- *
- * @var array
- * @see Crypt_GPG_Engine::setOperation()
- */
- private $_arguments = array();
-
- /**
- * The version number of the GPG binary
- *
- * @var string
- * @see Crypt_GPG_Engine::getVersion()
- */
- private $_version = '';
-
- // }}}
- // {{{ __construct()
-
- /**
- * Creates a new GPG engine
- *
- * Available options are:
- *
- * - <kbd>string homedir</kbd> - the directory where the GPG
- * keyring files are stored. If not
- * specified, Crypt_GPG uses the
- * default of <kbd>~/.gnupg</kbd>.
- * - <kbd>string publicKeyring</kbd> - the file path of the public
- * keyring. Use this if the public
- * keyring is not in the homedir, or
- * if the keyring is in a directory
- * not writable by the process
- * invoking GPG (like Apache). Then
- * you can specify the path to the
- * keyring with this option
- * (/foo/bar/pubring.gpg), and specify
- * a writable directory (like /tmp)
- * using the <i>homedir</i> option.
- * - <kbd>string privateKeyring</kbd> - the file path of the private
- * keyring. Use this if the private
- * keyring is not in the homedir, or
- * if the keyring is in a directory
- * not writable by the process
- * invoking GPG (like Apache). Then
- * you can specify the path to the
- * keyring with this option
- * (/foo/bar/secring.gpg), and specify
- * a writable directory (like /tmp)
- * using the <i>homedir</i> option.
- * - <kbd>string trustDb</kbd> - the file path of the web-of-trust
- * database. Use this if the trust
- * database is not in the homedir, or
- * if the database is in a directory
- * not writable by the process
- * invoking GPG (like Apache). Then
- * you can specify the path to the
- * trust database with this option
- * (/foo/bar/trustdb.gpg), and specify
- * a writable directory (like /tmp)
- * using the <i>homedir</i> option.
- * - <kbd>string binary</kbd> - the location of the GPG binary. If
- * not specified, the driver attempts
- * to auto-detect the GPG binary
- * location using a list of known
- * default locations for the current
- * operating system. The option
- * <kbd>gpgBinary</kbd> is a
- * deprecated alias for this option.
- * - <kbd>string agent</kbd> - the location of the GnuPG agent
- * binary. The gpg-agent is only
- * used for GnuPG 2.x. If not
- * specified, the engine attempts
- * to auto-detect the gpg-agent
- * binary location using a list of
- * know default locations for the
- * current operating system.
- * - <kbd>string|false gpgconf</kbd> - the location of the GnuPG conf
- * binary. The gpgconf is only
- * used for GnuPG >= 2.1. If not
- * specified, the engine attempts
- * to auto-detect the location using
- * a list of know default locations.
- * When set to FALSE `gpgconf --kill`
- * will not be executed via destructor.
- * - <kbd>string digest-algo</kbd> - Sets the message digest algorithm.
- * - <kbd>string cipher-algo</kbd> - Sets the symmetric cipher.
- * - <kbd>boolean strict</kbd> - In strict mode clock problems on
- * subkeys and signatures are not ignored
- * (--ignore-time-conflict
- * and --ignore-valid-from options)
- * - <kbd>mixed debug</kbd> - whether or not to use debug mode.
- * When debug mode is on, all
- * communication to and from the GPG
- * subprocess is logged. This can be
- * useful to diagnose errors when
- * using Crypt_GPG.
- *
- * @param array $options optional. An array of options used to create the
- * GPG object. All options are optional and are
- * represented as key-value pairs.
- *
- * @throws Crypt_GPG_FileException if the <kbd>homedir</kbd> does not exist
- * and cannot be created. This can happen if <kbd>homedir</kbd> is
- * not specified, Crypt_GPG is run as the web user, and the web
- * user has no home directory. This exception is also thrown if any
- * of the options <kbd>publicKeyring</kbd>,
- * <kbd>privateKeyring</kbd> or <kbd>trustDb</kbd> options are
- * specified but the files do not exist or are are not readable.
- * This can happen if the user running the Crypt_GPG process (for
- * example, the Apache user) does not have permission to read the
- * files.
- *
- * @throws PEAR_Exception if the provided <kbd>binary</kbd> is invalid, or
- * if no <kbd>binary</kbd> is provided and no suitable binary could
- * be found.
- *
- * @throws PEAR_Exception if the provided <kbd>agent</kbd> is invalid, or
- * if no <kbd>agent</kbd> is provided and no suitable gpg-agent
- * cound be found.
- */
- public function __construct(array $options = array())
- {
- $this->_isDarwin = (strncmp(strtoupper(PHP_OS), 'DARWIN', 6) === 0);
-
- // get homedir
- if (array_key_exists('homedir', $options)) {
- $this->_homedir = (string)$options['homedir'];
- } else {
- if (extension_loaded('posix')) {
- // note: this requires the package OS dep exclude 'windows'
- $info = posix_getpwuid(posix_getuid());
- $this->_homedir = $info['dir'].'/.gnupg';
- } else {
- if (isset($_SERVER['HOME'])) {
- $this->_homedir = $_SERVER['HOME'];
- } else {
- $this->_homedir = getenv('HOME');
- }
- }
-
- if ($this->_homedir === false) {
- throw new Crypt_GPG_FileException(
- 'Could not locate homedir. Please specify the homedir ' .
- 'to use with the \'homedir\' option when instantiating ' .
- 'the Crypt_GPG object.'
- );
- }
- }
-
- // attempt to create homedir if it does not exist
- if (!is_dir($this->_homedir)) {
- if (@mkdir($this->_homedir, 0777, true)) {
- // Set permissions on homedir. Parent directories are created
- // with 0777, homedir is set to 0700.
- chmod($this->_homedir, 0700);
- } else {
- throw new Crypt_GPG_FileException(
- 'The \'homedir\' "' . $this->_homedir . '" is not ' .
- 'readable or does not exist and cannot be created. This ' .
- 'can happen if \'homedir\' is not specified in the ' .
- 'Crypt_GPG options, Crypt_GPG is run as the web user, ' .
- 'and the web user has no home directory.',
- 0,
- $this->_homedir
- );
- }
- }
-
- // check homedir permissions (See Bug #19833)
- if (!is_executable($this->_homedir)) {
- throw new Crypt_GPG_FileException(
- 'The \'homedir\' "' . $this->_homedir . '" is not enterable ' .
- 'by the current user. Please check the permissions on your ' .
- 'homedir and make sure the current user can both enter and ' .
- 'write to the directory.',
- 0,
- $this->_homedir
- );
- }
- if (!is_writeable($this->_homedir)) {
- throw new Crypt_GPG_FileException(
- 'The \'homedir\' "' . $this->_homedir . '" is not writable ' .
- 'by the current user. Please check the permissions on your ' .
- 'homedir and make sure the current user can both enter and ' .
- 'write to the directory.',
- 0,
- $this->_homedir
- );
- }
-
- // get binary
- if (array_key_exists('binary', $options)) {
- $this->_binary = (string)$options['binary'];
- } elseif (array_key_exists('gpgBinary', $options)) {
- // deprecated alias
- $this->_binary = (string)$options['gpgBinary'];
- } else {
- $this->_binary = $this->_getBinary();
- }
-
- if ($this->_binary == '' || !is_executable($this->_binary)) {
- throw new PEAR_Exception(
- 'GPG binary not found. If you are sure the GPG binary is ' .
- 'installed, please specify the location of the GPG binary ' .
- 'using the \'binary\' driver option.'
- );
- }
-
- // get agent
- if (array_key_exists('agent', $options)) {
- $this->_agent = (string)$options['agent'];
-
- if ($this->_agent && !is_executable($this->_agent)) {
- throw new PEAR_Exception(
- 'Specified gpg-agent binary is not executable.'
- );
- }
- } else {
- $this->_agent = $this->_getAgent();
- }
-
- if (array_key_exists('gpgconf', $options)) {
- $this->_gpgconf = $options['gpgconf'];
-
- if ($this->_gpgconf && !is_executable($this->_gpgconf)) {
- throw new PEAR_Exception(
- 'Specified gpgconf binary is not executable.'
- );
- }
- }
-
- /*
- * Note:
- *
- * Normally, GnuPG expects keyrings to be in the homedir and expects
- * to be able to write temporary files in the homedir. Sometimes,
- * keyrings are not in the homedir, or location of the keyrings does
- * not allow writing temporary files. In this case, the <i>homedir</i>
- * option by itself is not enough to specify the keyrings because GnuPG
- * can not write required temporary files. Additional options are
- * provided so you can specify the location of the keyrings separately
- * from the homedir.
- */
-
- // get public keyring
- if (array_key_exists('publicKeyring', $options)) {
- $this->_publicKeyring = (string)$options['publicKeyring'];
- if (!is_readable($this->_publicKeyring)) {
- throw new Crypt_GPG_FileException(
- 'The \'publicKeyring\' "' . $this->_publicKeyring .
- '" does not exist or is not readable. Check the location ' .
- 'and ensure the file permissions are correct.',
- 0, $this->_publicKeyring
- );
- }
- }
-
- // get private keyring
- if (array_key_exists('privateKeyring', $options)) {
- $this->_privateKeyring = (string)$options['privateKeyring'];
- if (!is_readable($this->_privateKeyring)) {
- throw new Crypt_GPG_FileException(
- 'The \'privateKeyring\' "' . $this->_privateKeyring .
- '" does not exist or is not readable. Check the location ' .
- 'and ensure the file permissions are correct.',
- 0, $this->_privateKeyring
- );
- }
- }
-
- // get trust database
- if (array_key_exists('trustDb', $options)) {
- $this->_trustDb = (string)$options['trustDb'];
- if (!is_readable($this->_trustDb)) {
- throw new Crypt_GPG_FileException(
- 'The \'trustDb\' "' . $this->_trustDb .
- '" does not exist or is not readable. Check the location ' .
- 'and ensure the file permissions are correct.',
- 0, $this->_trustDb
- );
- }
- }
-
- if (array_key_exists('debug', $options)) {
- $this->_debug = $options['debug'];
- }
-
- $this->_strict = !empty($options['strict']);
-
- if (!empty($options['digest-algo'])) {
- $this->_digest_algo = $options['digest-algo'];
- }
-
- if (!empty($options['cipher-algo'])) {
- $this->_cipher_algo = $options['cipher-algo'];
- }
- }
-
- // }}}
- // {{{ __destruct()
-
- /**
- * Closes open GPG subprocesses when this object is destroyed
- *
- * Subprocesses should never be left open by this class unless there is
- * an unknown error and unexpected script termination occurs.
- */
- public function __destruct()
- {
- $this->_closeSubprocess();
- $this->_closeIdleAgents();
- }
-
- // }}}
- // {{{ addErrorHandler()
-
- /**
- * Adds an error handler method
- *
- * The method is run every time a new error line is received from the GPG
- * subprocess. The handler method must accept the error line to be handled
- * as its first parameter.
- *
- * @param callback $callback the callback method to use.
- * @param array $args optional. Additional arguments to pass as
- * parameters to the callback method.
- *
- * @return void
- */
- public function addErrorHandler($callback, array $args = array())
- {
- $this->_errorHandlers[] = array(
- 'callback' => $callback,
- 'args' => $args
- );
- }
-
- // }}}
- // {{{ addStatusHandler()
-
- /**
- * Adds a status handler method
- *
- * The method is run every time a new status line is received from the
- * GPG subprocess. The handler method must accept the status line to be
- * handled as its first parameter.
- *
- * @param callback $callback the callback method to use.
- * @param array $args optional. Additional arguments to pass as
- * parameters to the callback method.
- *
- * @return void
- */
- public function addStatusHandler($callback, array $args = array())
- {
- $this->_statusHandlers[] = array(
- 'callback' => $callback,
- 'args' => $args
- );
- }
-
- // }}}
- // {{{ sendCommand()
-
- /**
- * Sends a command to the GPG subprocess over the command file-descriptor
- * pipe
- *
- * @param string $command the command to send.
- *
- * @return void
- *
- * @sensitive $command
- */
- public function sendCommand($command)
- {
- if (array_key_exists(self::FD_COMMAND, $this->_openPipes)) {
- $this->_commandBuffer .= $command . PHP_EOL;
- }
- }
-
- // }}}
- // {{{ reset()
-
- /**
- * Resets the GPG engine, preparing it for a new operation
- *
- * @return void
- *
- * @see Crypt_GPG_Engine::run()
- * @see Crypt_GPG_Engine::setOperation()
- */
- public function reset()
- {
- $this->_operation = '';
- $this->_arguments = array();
- $this->_input = null;
- $this->_message = null;
- $this->_output = '';
- $this->_commandBuffer = '';
-
- $this->_statusHandlers = array();
- $this->_errorHandlers = array();
-
- if ($this->_debug) {
- $this->addStatusHandler(array($this, '_handleDebugStatus'));
- $this->addErrorHandler(array($this, '_handleDebugError'));
- }
-
- $this->_processHandler = new Crypt_GPG_ProcessHandler($this);
-
- $this->addStatusHandler(array($this->_processHandler, 'handleStatus'));
- $this->addErrorHandler(array($this->_processHandler, 'handleError'));
- }
-
- // }}}
- // {{{ run()
-
- /**
- * Runs the current GPG operation.
- *
- * This creates and manages the GPG subprocess.
- * This will close input/output file handles.
- *
- * The operation must be set with {@link Crypt_GPG_Engine::setOperation()}
- * before this method is called.
- *
- * @return void
- *
- * @throws Crypt_GPG_InvalidOperationException if no operation is specified.
- * @throws Crypt_GPG_Exception if an unknown or unexpected error occurs.
- *
- * @see Crypt_GPG_Engine::reset()
- * @see Crypt_GPG_Engine::setOperation()
- */
- public function run()
- {
- if ($this->_operation === '') {
- throw new Crypt_GPG_InvalidOperationException(
- 'No GPG operation specified. Use Crypt_GPG_Engine::setOperation() ' .
- 'before calling Crypt_GPG_Engine::run().'
- );
- }
-
- $this->_openSubprocess();
- $this->_process();
- $this->_closeSubprocess();
- }
-
- // }}}
- // {{{ setInput()
-
- /**
- * Sets the input source for the current GPG operation
- *
- * @param string|resource &$input either a reference to the string
- * containing the input data or an open
- * stream resource containing the input
- * data.
- *
- * @return void
- */
- public function setInput(&$input)
- {
- $this->_input =& $input;
- }
-
- // }}}
- // {{{ setMessage()
-
- /**
- * Sets the message source for the current GPG operation
- *
- * Detached signature data should be specified here.
- *
- * @param string|resource &$message either a reference to the string
- * containing the message data or an open
- * stream resource containing the message
- * data.
- *
- * @return void
- */
- public function setMessage(&$message)
- {
- $this->_message =& $message;
- }
-
- // }}}
- // {{{ setOutput()
-
- /**
- * Sets the output destination for the current GPG operation
- *
- * @param string|resource &$output either a reference to the string in
- * which to store GPG output or an open
- * stream resource to which the output data
- * should be written.
- *
- * @return void
- */
- public function setOutput(&$output)
- {
- $this->_output =& $output;
- }
-
- // }}}
- // {{{ setOperation()
-
- /**
- * Sets the operation to perform
- *
- * @param string $operation the operation to perform. This should be one
- * of GPG's operations. For example,
- * <kbd>--encrypt</kbd>, <kbd>--decrypt</kbd>,
- * <kbd>--sign</kbd>, etc.
- * @param array $arguments optional. Additional arguments for the GPG
- * subprocess. See the GPG manual for specific
- * values.
- *
- * @return void
- *
- * @see Crypt_GPG_Engine::reset()
- * @see Crypt_GPG_Engine::run()
- */
- public function setOperation($operation, array $arguments = array())
- {
- $this->_operation = $operation;
- $this->_arguments = $arguments;
-
- $this->_processHandler->setOperation($operation);
- }
-
- // }}}
- // {{{ setPins()
-
- /**
- * Sets the PINENTRY_USER_DATA environment variable with the currently
- * added keys and passphrases
- *
- * Keys and passphrases are stored as an indexed array of passphrases
- * in JSON encoded to a flat string.
- *
- * For GnuPG 2.x this is how passphrases are passed. For GnuPG 1.x the
- * environment variable is set but not used.
- *
- * @param array $keys the internal key array to use.
- *
- * @return void
- */
- public function setPins(array $keys)
- {
- $envKeys = array();
-
- foreach ($keys as $keyId => $key) {
- $envKeys[$keyId] = is_array($key) ? $key['passphrase'] : $key;
- }
-
- $_ENV['PINENTRY_USER_DATA'] = json_encode($envKeys);
- }
-
- // }}}
- // {{{ getVersion()
-
- /**
- * Gets the version of the GnuPG binary
- *
- * @return string a version number string containing the version of GnuPG
- * being used. This value is suitable to use with PHP's
- * version_compare() function.
- *
- * @throws Crypt_GPG_Exception if an unknown or unexpected error occurs.
- * Use the <kbd>debug</kbd> option and file a bug report if these
- * exceptions occur.
- *
- * @throws Crypt_GPG_UnsupportedException if the provided binary is not
- * GnuPG or if the GnuPG version is less than 1.0.2.
- */
- public function getVersion()
- {
- if ($this->_version == '') {
- $options = array(
- 'homedir' => $this->_homedir,
- 'binary' => $this->_binary,
- 'debug' => $this->_debug,
- 'agent' => $this->_agent,
- );
-
- $engine = new self($options);
- $info = '';
-
- // Set a garbage version so we do not end up looking up the version
- // recursively.
- $engine->_version = '1.0.0';
-
- $engine->reset();
- $engine->setOutput($info);
- $engine->setOperation('--version');
- $engine->run();
-
- $matches = array();
- $expression = '#gpg \(GnuPG[A-Za-z0-9/]*?\) (\S+)#';
-
- if (preg_match($expression, $info, $matches) === 1) {
- $this->_version = $matches[1];
- } else {
- throw new Crypt_GPG_Exception(
- 'No GnuPG version information provided by the binary "' .
- $this->_binary . '". Are you sure it is GnuPG?'
- );
- }
-
- if (version_compare($this->_version, self::MIN_VERSION, 'lt')) {
- throw new Crypt_GPG_Exception(
- 'The version of GnuPG being used (' . $this->_version .
- ') is not supported by Crypt_GPG. The minimum version ' .
- 'required by Crypt_GPG is ' . self::MIN_VERSION
- );
- }
- }
-
-
- return $this->_version;
- }
-
- // }}}
- // {{{ getProcessData()
-
- /**
- * Get data from the last process execution.
- *
- * @param string $name Data element name (e.g. 'SignatureInfo')
- *
- * @return mixed
- * @see Crypt_GPG_ProcessHandler::getData()
- */
- public function getProcessData($name)
- {
- if ($this->_processHandler) {
- switch ($name) {
- case 'SignatureInfo':
- if ($data = $this->_processHandler->getData('SigCreated')) {
- return new Crypt_GPG_SignatureCreationInfo($data);
- }
- break;
-
- case 'Signatures':
- return (array) $this->_processHandler->getData('Signatures');
-
- default:
- return $this->_processHandler->getData($name);
- }
- }
- }
-
- // }}}
- // {{{ setProcessData()
-
- /**
- * Set some data for the process execution.
- *
- * @param string $name Data element name (e.g. 'Handle')
- * @param mixed $value Data value
- *
- * @return void
- */
- public function setProcessData($name, $value)
- {
- if ($this->_processHandler) {
- $this->_processHandler->setData($name, $value);
- }
- }
-
- // }}}
- // {{{ _handleDebugStatus()
-
- /**
- * Displays debug output for status lines
- *
- * @param string $line the status line to handle.
- *
- * @return void
- */
- private function _handleDebugStatus($line)
- {
- $this->_debug('STATUS: ' . $line);
- }
-
- // }}}
- // {{{ _handleDebugError()
-
- /**
- * Displays debug output for error lines
- *
- * @param string $line the error line to handle.
- *
- * @return void
- */
- private function _handleDebugError($line)
- {
- $this->_debug('ERROR: ' . $line);
- }
-
- // }}}
- // {{{ _process()
-
- /**
- * Performs internal streaming operations for the subprocess using either
- * strings or streams as input / output points
- *
- * This is the main I/O loop for streaming to and from the GPG subprocess.
- *
- * The implementation of this method is verbose mainly for performance
- * reasons. Adding streams to a lookup array and looping the array inside
- * the main I/O loop would be siginficantly slower for large streams.
- *
- * @return void
- *
- * @throws Crypt_GPG_Exception if there is an error selecting streams for
- * reading or writing. If this occurs, please file a bug report at
- * http://pear.php.net/bugs/report.php?package=Crypt_GPG.
- */
- private function _process()
- {
- $this->_debug('BEGIN PROCESSING');
-
- $this->_commandBuffer = ''; // buffers input to GPG
- $messageBuffer = ''; // buffers input to GPG
- $inputBuffer = ''; // buffers input to GPG
- $outputBuffer = ''; // buffers output from GPG
- $statusBuffer = ''; // buffers output from GPG
- $errorBuffer = ''; // buffers output from GPG
- $inputComplete = false; // input stream is completely buffered
- $messageComplete = false; // message stream is completely buffered
-
- if (is_string($this->_input)) {
- $inputBuffer = $this->_input;
- $inputComplete = true;
- }
-
- if (is_string($this->_message)) {
- $messageBuffer = $this->_message;
- $messageComplete = true;
- }
-
- if (is_string($this->_output)) {
- $outputBuffer =& $this->_output;
- }
-
- // convenience variables
- $fdInput = $this->_pipes[self::FD_INPUT];
- $fdOutput = $this->_pipes[self::FD_OUTPUT];
- $fdError = $this->_pipes[self::FD_ERROR];
- $fdStatus = $this->_pipes[self::FD_STATUS];
- $fdCommand = $this->_pipes[self::FD_COMMAND];
- $fdMessage = $this->_pipes[self::FD_MESSAGE];
-
- // select loop delay in milliseconds
- $delay = 0;
- $inputPosition = 0;
- $eolLength = mb_strlen(PHP_EOL, '8bit');
-
- while (true) {
- $inputStreams = array();
- $outputStreams = array();
- $exceptionStreams = array();
-
- // set up input streams
- if (is_resource($this->_input) && !$inputComplete) {
- if (feof($this->_input)) {
- $inputComplete = true;
- } else {
- $inputStreams[] = $this->_input;
- }
- }
-
- // close GPG input pipe if there is no more data
- if ($inputBuffer == '' && $inputComplete) {
- $this->_debug('=> closing GPG input pipe');
- $this->_closePipe(self::FD_INPUT);
- }
-
- if (is_resource($this->_message) && !$messageComplete) {
- if (feof($this->_message)) {
- $messageComplete = true;
- } else {
- $inputStreams[] = $this->_message;
- }
- }
-
- // close GPG message pipe if there is no more data
- if ($messageBuffer == '' && $messageComplete) {
- $this->_debug('=> closing GPG message pipe');
- $this->_closePipe(self::FD_MESSAGE);
- }
-
- if (!feof($fdOutput)) {
- $inputStreams[] = $fdOutput;
- }
-
- if (!feof($fdStatus)) {
- $inputStreams[] = $fdStatus;
- }
-
- if (!feof($fdError)) {
- $inputStreams[] = $fdError;
- }
-
- // set up output streams
- if ($outputBuffer != '' && is_resource($this->_output)) {
- $outputStreams[] = $this->_output;
- }
-
- if ($this->_commandBuffer != '' && is_resource($fdCommand)) {
- $outputStreams[] = $fdCommand;
- }
-
- if ($messageBuffer != '' && is_resource($fdMessage)) {
- $outputStreams[] = $fdMessage;
- }
-
- if ($inputBuffer != '' && is_resource($fdInput)) {
- $outputStreams[] = $fdInput;
- }
-
- // no streams left to read or write, we're all done
- if (count($inputStreams) === 0 && count($outputStreams) === 0) {
- break;
- }
-
- $this->_debug('selecting streams');
-
- $ready = stream_select(
- $inputStreams,
- $outputStreams,
- $exceptionStreams,
- null
- );
-
- $this->_debug('=> got ' . $ready);
-
- if ($ready === false) {
- throw new Crypt_GPG_Exception(
- 'Error selecting stream for communication with GPG ' .
- 'subprocess. Please file a bug report at: ' .
- 'http://pear.php.net/bugs/report.php?package=Crypt_GPG'
- );
- }
-
- if ($ready === 0) {
- throw new Crypt_GPG_Exception(
- 'stream_select() returned 0. This can not happen! Please ' .
- 'file a bug report at: ' .
- 'http://pear.php.net/bugs/report.php?package=Crypt_GPG'
- );
- }
-
- // write input (to GPG)
- if (in_array($fdInput, $outputStreams, true)) {
- $this->_debug('GPG is ready for input');
-
- $chunk = mb_substr($inputBuffer, $inputPosition, self::CHUNK_SIZE, '8bit');
- $length = mb_strlen($chunk, '8bit');
-
- $this->_debug(
- '=> about to write ' . $length . ' bytes to GPG input'
- );
-
- $length = fwrite($fdInput, $chunk, $length);
- if ($length === 0) {
- // If we wrote 0 bytes it was either EAGAIN or EPIPE. Since
- // the pipe was seleted for writing, we assume it was EPIPE.
- // There's no way to get the actual error code in PHP. See
- // PHP Bug #39598. https://bugs.php.net/bug.php?id=39598
- $this->_debug('=> broken pipe on GPG input');
- $this->_debug('=> closing pipe GPG input');
- $this->_closePipe(self::FD_INPUT);
- } else {
- $this->_debug('=> wrote ' . $length . ' bytes');
- // Move the position pointer, don't modify $inputBuffer (#21081)
- if (is_string($this->_input)) {
- $inputPosition += $length;
- } else {
- $inputPosition = 0;
- $inputBuffer = mb_substr($inputBuffer, $length, null, '8bit');
- }
- }
- }
-
- // read input (from PHP stream)
- // If the buffer is too big wait until it's smaller, we don't want
- // to use too much memory
- if (in_array($this->_input, $inputStreams, true)
- && mb_strlen($inputBuffer, '8bit') < self::CHUNK_SIZE
- ) {
- $this->_debug('input stream is ready for reading');
- $this->_debug(
- '=> about to read ' . self::CHUNK_SIZE .
- ' bytes from input stream'
- );
-
- $chunk = fread($this->_input, self::CHUNK_SIZE);
- $length = mb_strlen($chunk, '8bit');
- $inputBuffer .= $chunk;
-
- $this->_debug('=> read ' . $length . ' bytes');
- }
-
- // write message (to GPG)
- if (in_array($fdMessage, $outputStreams, true)) {
- $this->_debug('GPG is ready for message data');
-
- $chunk = mb_substr($messageBuffer, 0, self::CHUNK_SIZE, '8bit');
- $length = mb_strlen($chunk, '8bit');
-
- $this->_debug(
- '=> about to write ' . $length . ' bytes to GPG message'
- );
-
- $length = fwrite($fdMessage, $chunk, $length);
- if ($length === 0) {
- // If we wrote 0 bytes it was either EAGAIN or EPIPE. Since
- // the pipe was seleted for writing, we assume it was EPIPE.
- // There's no way to get the actual error code in PHP. See
- // PHP Bug #39598. https://bugs.php.net/bug.php?id=39598
- $this->_debug('=> broken pipe on GPG message');
- $this->_debug('=> closing pipe GPG message');
- $this->_closePipe(self::FD_MESSAGE);
- } else {
- $this->_debug('=> wrote ' . $length . ' bytes');
- $messageBuffer = mb_substr($messageBuffer, $length, null, '8bit');
- }
- }
-
- // read message (from PHP stream)
- if (in_array($this->_message, $inputStreams, true)) {
- $this->_debug('message stream is ready for reading');
- $this->_debug(
- '=> about to read ' . self::CHUNK_SIZE .
- ' bytes from message stream'
- );
-
- $chunk = fread($this->_message, self::CHUNK_SIZE);
- $length = mb_strlen($chunk, '8bit');
- $messageBuffer .= $chunk;
-
- $this->_debug('=> read ' . $length . ' bytes');
- }
-
- // read output (from GPG)
- if (in_array($fdOutput, $inputStreams, true)) {
- $this->_debug('GPG output stream ready for reading');
- $this->_debug(
- '=> about to read ' . self::CHUNK_SIZE .
- ' bytes from GPG output'
- );
-
- $chunk = fread($fdOutput, self::CHUNK_SIZE);
- $length = mb_strlen($chunk, '8bit');
- $outputBuffer .= $chunk;
-
- $this->_debug('=> read ' . $length . ' bytes');
- }
-
- // write output (to PHP stream)
- if (in_array($this->_output, $outputStreams, true)) {
- $this->_debug('output stream is ready for data');
-
- $chunk = mb_substr($outputBuffer, 0, self::CHUNK_SIZE, '8bit');
- $length = mb_strlen($chunk, '8bit');
-
- $this->_debug(
- '=> about to write ' . $length . ' bytes to output stream'
- );
-
- $length = fwrite($this->_output, $chunk, $length);
- $outputBuffer = mb_substr($outputBuffer, $length, null, '8bit');
-
- $this->_debug('=> wrote ' . $length . ' bytes');
- }
-
- // read error (from GPG)
- if (in_array($fdError, $inputStreams, true)) {
- $this->_debug('GPG error stream ready for reading');
- $this->_debug(
- '=> about to read ' . self::CHUNK_SIZE .
- ' bytes from GPG error'
- );
-
- $chunk = fread($fdError, self::CHUNK_SIZE);
- $length = mb_strlen($chunk, '8bit');
- $errorBuffer .= $chunk;
-
- $this->_debug('=> read ' . $length . ' bytes');
-
- // pass lines to error handlers
- while (($pos = strpos($errorBuffer, PHP_EOL)) !== false) {
- $line = mb_substr($errorBuffer, 0, $pos, '8bit');
- foreach ($this->_errorHandlers as $handler) {
- array_unshift($handler['args'], $line);
- call_user_func_array(
- $handler['callback'],
- $handler['args']
- );
-
- array_shift($handler['args']);
- }
-
- $errorBuffer = mb_substr($errorBuffer, $pos + $eolLength, null, '8bit');
- }
- }
-
- // read status (from GPG)
- if (in_array($fdStatus, $inputStreams, true)) {
- $this->_debug('GPG status stream ready for reading');
- $this->_debug(
- '=> about to read ' . self::CHUNK_SIZE .
- ' bytes from GPG status'
- );
-
- $chunk = fread($fdStatus, self::CHUNK_SIZE);
- $length = mb_strlen($chunk, '8bit');
- $statusBuffer .= $chunk;
-
- $this->_debug('=> read ' . $length . ' bytes');
-
- // pass lines to status handlers
- while (($pos = strpos($statusBuffer, PHP_EOL)) !== false) {
- $line = mb_substr($statusBuffer, 0, $pos, '8bit');
- // only pass lines beginning with magic prefix
- if (mb_substr($line, 0, 9, '8bit') == '[GNUPG:] ') {
- $line = mb_substr($line, 9, null, '8bit');
- foreach ($this->_statusHandlers as $handler) {
- array_unshift($handler['args'], $line);
- call_user_func_array(
- $handler['callback'],
- $handler['args']
- );
-
- array_shift($handler['args']);
- }
- }
-
- $statusBuffer = mb_substr($statusBuffer, $pos + $eolLength, null, '8bit');
- }
- }
-
- // write command (to GPG)
- if (in_array($fdCommand, $outputStreams, true)) {
- $this->_debug('GPG is ready for command data');
-
- // send commands
- $chunk = mb_substr($this->_commandBuffer, 0, self::CHUNK_SIZE, '8bit');
- $length = mb_strlen($chunk, '8bit');
-
- $this->_debug(
- '=> about to write ' . $length . ' bytes to GPG command'
- );
-
- $length = fwrite($fdCommand, $chunk, $length);
- if ($length === 0) {
- // If we wrote 0 bytes it was either EAGAIN or EPIPE. Since
- // the pipe was seleted for writing, we assume it was EPIPE.
- // There's no way to get the actual error code in PHP. See
- // PHP Bug #39598. https://bugs.php.net/bug.php?id=39598
- $this->_debug('=> broken pipe on GPG command');
- $this->_debug('=> closing pipe GPG command');
- $this->_closePipe(self::FD_COMMAND);
- } else {
- $this->_debug('=> wrote ' . $length);
- $this->_commandBuffer = mb_substr($this->_commandBuffer, $length, null, '8bit');
- }
- }
-
- if (count($outputStreams) === 0 || count($inputStreams) === 0) {
- // we have an I/O imbalance, increase the select loop delay
- // to smooth things out
- $delay += 10;
- } else {
- // things are running smoothly, decrease the delay
- $delay -= 8;
- $delay = max(0, $delay);
- }
-
- if ($delay > 0) {
- usleep($delay);
- }
-
- } // end loop while streams are open
-
- $this->_debug('END PROCESSING');
- }
-
- // }}}
- // {{{ _openSubprocess()
-
- /**
- * Opens an internal GPG subprocess for the current operation
- *
- * Opens a GPG subprocess, then connects the subprocess to some pipes. Sets
- * the private class property {@link Crypt_GPG_Engine::$_process} to
- * the new subprocess.
- *
- * @return void
- *
- * @throws Crypt_GPG_OpenSubprocessException if the subprocess could not be
- * opened.
- *
- * @see Crypt_GPG_Engine::setOperation()
- * @see Crypt_GPG_Engine::_closeSubprocess()
- * @see Crypt_GPG_Engine::$_process
- */
- private function _openSubprocess()
- {
- $version = $this->getVersion();
-
- // log versions, but not when looking for the version number
- if ($version !== '1.0.0') {
- $this->_debug('USING GPG ' . $version . ' with PHP ' . PHP_VERSION);
- }
-
- // Binary operations will not work on Windows with PHP < 5.2.6. This is
- // in case stream_select() ever works on Windows.
- $rb = (version_compare(PHP_VERSION, '5.2.6') < 0) ? 'r' : 'rb';
- $wb = (version_compare(PHP_VERSION, '5.2.6') < 0) ? 'w' : 'wb';
-
- $env = $_ENV;
-
- // Newer versions of GnuPG return localized results. Crypt_GPG only
- // works with English, so set the locale to 'C' for the subprocess.
- $env['LC_ALL'] = 'C';
-
- // If using GnuPG 2.x < 2.1.13 start the gpg-agent
- if (version_compare($version, '2.0.0', 'ge')
- && version_compare($version, '2.1.13', 'lt')
- ) {
- if (!$this->_agent) {
- throw new Crypt_GPG_OpenSubprocessException(
- 'Unable to open gpg-agent subprocess (gpg-agent not found). ' .
- 'Please specify location of the gpg-agent binary ' .
- 'using the \'agent\' driver option.'
- );
- }
-
- $agentArguments = array(
- '--daemon',
- '--options /dev/null', // ignore any saved options
- '--csh', // output is easier to parse
- '--keep-display', // prevent passing --display to pinentry
- '--no-grab',
- '--ignore-cache-for-signing',
- '--pinentry-touch-file /dev/null',
- '--disable-scdaemon',
- '--no-use-standard-socket',
- '--pinentry-program ' . escapeshellarg($this->_getPinEntry())
- );
-
- if ($this->_homedir) {
- $agentArguments[] = '--homedir ' .
- escapeshellarg($this->_homedir);
- }
-
- if ($version21 = version_compare($version, '2.1.0', 'ge')) {
- // This is needed to get socket file location in stderr output
- // Note: This does not help when the agent already is running
- $agentArguments[] = '--verbose';
- }
-
- $agentCommandLine = $this->_agent . ' ' . implode(' ', $agentArguments);
-
- $agentDescriptorSpec = array(
- self::FD_INPUT => array('pipe', $rb), // stdin
- self::FD_OUTPUT => array('pipe', $wb), // stdout
- self::FD_ERROR => array('pipe', $wb) // stderr
- );
-
- $this->_debug('OPENING GPG-AGENT SUBPROCESS WITH THE FOLLOWING COMMAND:');
- $this->_debug($agentCommandLine);
-
- $this->_agentProcess = proc_open(
- $agentCommandLine,
- $agentDescriptorSpec,
- $this->_agentPipes,
- null,
- $env,
- array('binary_pipes' => true)
- );
-
- if (!is_resource($this->_agentProcess)) {
- throw new Crypt_GPG_OpenSubprocessException(
- 'Unable to open gpg-agent subprocess.',
- 0,
- $agentCommandLine
- );
- }
-
- // Get GPG_AGENT_INFO and set environment variable for gpg process.
- // This is a blocking read, but is only 1 line.
- $agentInfo = fread($this->_agentPipes[self::FD_OUTPUT], self::CHUNK_SIZE);
-
- // For GnuPG 2.1 we need to read both stderr and stdout
- if ($version21) {
- $agentInfo .= "\n" . fread($this->_agentPipes[self::FD_ERROR], self::CHUNK_SIZE);
- }
-
- if ($agentInfo) {
- foreach (explode("\n", $agentInfo) as $line) {
- if ($version21) {
- if (preg_match('/listening on socket \'([^\']+)/', $line, $m)) {
- $this->_agentInfo = $m[1];
- } else if (preg_match('/gpg-agent\[([0-9]+)\].* started/', $line, $m)) {
- $this->_agentInfo .= ':' . $m[1] . ':1';
- }
- } else if (preg_match('/GPG_AGENT_INFO[=\s]([^;]+)/', $line, $m)) {
- $this->_agentInfo = $m[1];
- break;
- }
- }
- }
-
- $this->_debug('GPG-AGENT-INFO: ' . $this->_agentInfo);
-
- $env['GPG_AGENT_INFO'] = $this->_agentInfo;
-
- // gpg-agent daemon is started, we can close the launching process
- $this->_closeAgentLaunchProcess();
-
- // Terminate processes if something went wrong
- register_shutdown_function(array($this, '__destruct'));
- }
-
- // "Register" GPGConf existence for _closeIdleAgents()
- if (version_compare($version, '2.1.0', 'ge')) {
- if ($this->_gpgconf === null) {
- $this->_gpgconf = $this->_getGPGConf();
- }
- } else {
- $this->_gpgconf = false;
- }
-
- $commandLine = $this->_binary;
-
- $defaultArguments = array(
- '--status-fd ' . escapeshellarg(self::FD_STATUS),
- '--command-fd ' . escapeshellarg(self::FD_COMMAND),
- '--no-secmem-warning',
- '--no-tty',
- '--no-default-keyring', // ignored if keying files are not specified
- '--no-options' // prevent creation of ~/.gnupg directory
- );
-
- if (version_compare($version, '1.0.7', 'ge')) {
- if (version_compare($version, '2.0.0', 'lt')) {
- $defaultArguments[] = '--no-use-agent';
- }
- $defaultArguments[] = '--no-permission-warning';
- }
-
- if (version_compare($version, '1.4.2', 'ge')) {
- $defaultArguments[] = '--exit-on-status-write-error';
- }
-
- if (version_compare($version, '1.3.2', 'ge')) {
- $defaultArguments[] = '--trust-model always';
- } else {
- $defaultArguments[] = '--always-trust';
- }
-
- // Since 2.1.13 we can use "loopback mode" instead of gpg-agent
- if (version_compare($version, '2.1.13', 'ge')) {
- $defaultArguments[] = '--pinentry-mode loopback';
- }
-
- if (!$this->_strict) {
- $defaultArguments[] = '--ignore-time-conflict';
- $defaultArguments[] = '--ignore-valid-from';
- }
-
- if (!empty($this->_digest_algo)) {
- $defaultArguments[] = '--digest-algo ' . escapeshellarg($this->_digest_algo);
- $defaultArguments[] = '--s2k-digest-algo ' . escapeshellarg($this->_digest_algo);
- }
-
- if (!empty($this->_cipher_algo)) {
- $defaultArguments[] = '--cipher-algo ' . escapeshellarg($this->_cipher_algo);
- $defaultArguments[] = '--s2k-cipher-algo ' . escapeshellarg($this->_cipher_algo);
- }
-
- $arguments = array_merge($defaultArguments, $this->_arguments);
-
- if ($this->_homedir) {
- $arguments[] = '--homedir ' . escapeshellarg($this->_homedir);
-
- // the random seed file makes subsequent actions faster so only
- // disable it if we have to.
- if (!is_writeable($this->_homedir)) {
- $arguments[] = '--no-random-seed-file';
- }
- }
-
- if ($this->_publicKeyring) {
- $arguments[] = '--keyring ' . escapeshellarg($this->_publicKeyring);
- }
-
- if ($this->_privateKeyring) {
- $arguments[] = '--secret-keyring ' .
- escapeshellarg($this->_privateKeyring);
- }
-
- if ($this->_trustDb) {
- $arguments[] = '--trustdb-name ' . escapeshellarg($this->_trustDb);
- }
-
- $commandLine .= ' ' . implode(' ', $arguments) . ' ' .
- $this->_operation;
-
- $descriptorSpec = array(
- self::FD_INPUT => array('pipe', $rb), // stdin
- self::FD_OUTPUT => array('pipe', $wb), // stdout
- self::FD_ERROR => array('pipe', $wb), // stderr
- self::FD_STATUS => array('pipe', $wb), // status
- self::FD_COMMAND => array('pipe', $rb), // command
- self::FD_MESSAGE => array('pipe', $rb) // message
- );
-
- $this->_debug('OPENING GPG SUBPROCESS WITH THE FOLLOWING COMMAND:');
- $this->_debug($commandLine);
-
- $this->_process = proc_open(
- $commandLine,
- $descriptorSpec,
- $this->_pipes,
- null,
- $env,
- array('binary_pipes' => true)
- );
-
- if (!is_resource($this->_process)) {
- throw new Crypt_GPG_OpenSubprocessException(
- 'Unable to open GPG subprocess.', 0, $commandLine
- );
- }
-
- // Set streams as non-blocking. See Bug #18618.
- foreach ($this->_pipes as $pipe) {
- stream_set_blocking($pipe, 0);
- stream_set_write_buffer($pipe, self::CHUNK_SIZE);
- stream_set_chunk_size($pipe, self::CHUNK_SIZE);
- stream_set_read_buffer($pipe, self::CHUNK_SIZE);
- }
-
- $this->_openPipes = $this->_pipes;
- }
-
- // }}}
- // {{{ _closeSubprocess()
-
- /**
- * Closes the internal GPG subprocess
- *
- * Closes the internal GPG subprocess. Sets the private class property
- * {@link Crypt_GPG_Engine::$_process} to null.
- *
- * @return void
- *
- * @see Crypt_GPG_Engine::_openSubprocess()
- * @see Crypt_GPG_Engine::$_process
- */
- private function _closeSubprocess()
- {
- // clear PINs from environment if they were set
- $_ENV['PINENTRY_USER_DATA'] = null;
-
- if (is_resource($this->_process)) {
- $this->_debug('CLOSING GPG SUBPROCESS');
-
- // close remaining open pipes
- foreach (array_keys($this->_openPipes) as $pipeNumber) {
- $this->_closePipe($pipeNumber);
- }
-
- $status = proc_get_status($this->_process);
- $exitCode = proc_close($this->_process);
-
- // proc_close() can return -1 in some cases,
- // get the real exit code from the process status
- if ($exitCode < 0 && $status && !$status['running']) {
- $exitCode = $status['exitcode'];
- }
-
- if ($exitCode > 0) {
- $this->_debug(
- '=> subprocess returned an unexpected exit code: ' .
- $exitCode
- );
- }
-
- $this->_process = null;
- $this->_pipes = array();
-
- // close file handles before throwing an exception
- if (is_resource($this->_input)) {
- fclose($this->_input);
- }
-
- if (is_resource($this->_output)) {
- fclose($this->_output);
- }
-
- $this->_processHandler->throwException($exitCode);
- }
-
- $this->_closeAgentLaunchProcess();
-
- if ($this->_agentInfo !== null) {
- $parts = explode(':', $this->_agentInfo, 3);
-
- if (!empty($parts[1])) {
- $this->_debug('STOPPING GPG-AGENT DAEMON');
-
- $process = new Crypt_GPG_ProcessControl($parts[1]);
-
- // terminate agent daemon
- $process->terminate();
-
- while ($process->isRunning()) {
- usleep(10000); // 10 ms
- $process->terminate();
- }
-
- $this->_debug('GPG-AGENT DAEMON STOPPED');
- }
-
- $this->_agentInfo = null;
- }
- }
-
- // }}}
- // {{{ _closeAgentLaunchProcess()
-
- /**
- * Closes a the internal GPG-AGENT subprocess
- *
- * Closes the internal GPG-AGENT subprocess. Sets the private class property
- * {@link Crypt_GPG_Engine::$_agentProcess} to null.
- *
- * @return void
- *
- * @see Crypt_GPG_Engine::_openSubprocess()
- * @see Crypt_GPG_Engine::$_agentProcess
- */
- private function _closeAgentLaunchProcess()
- {
- if (is_resource($this->_agentProcess)) {
- $this->_debug('CLOSING GPG-AGENT LAUNCH PROCESS');
-
- // close agent pipes
- foreach ($this->_agentPipes as $pipe) {
- fflush($pipe);
- fclose($pipe);
- }
-
- // close agent launching process
- proc_close($this->_agentProcess);
-
- $this->_agentProcess = null;
- $this->_agentPipes = array();
-
- $this->_debug('GPG-AGENT LAUNCH PROCESS CLOSED');
- }
- }
-
- // }}}
- // {{{ _closePipe()
-
- /**
- * Closes an opened pipe used to communicate with the GPG subprocess
- *
- * If the pipe is already closed, it is ignored. If the pipe is open, it
- * is flushed and then closed.
- *
- * @param integer $pipeNumber the file descriptor number of the pipe to
- * close.
- *
- * @return void
- */
- private function _closePipe($pipeNumber)
- {
- $pipeNumber = intval($pipeNumber);
- if (array_key_exists($pipeNumber, $this->_openPipes)) {
- fflush($this->_openPipes[$pipeNumber]);
- fclose($this->_openPipes[$pipeNumber]);
- unset($this->_openPipes[$pipeNumber]);
- }
- }
-
- // }}}
- // {{{ _closeIdleAgents()
-
- /**
- * Forces automatically started gpg-agent process to cleanup and exit
- * within a minute.
- *
- * This is needed in GnuPG 2.1 where agents are started
- * automatically by gpg process, not our code.
- *
- * @return void
- */
- private function _closeIdleAgents()
- {
- if ($this->_gpgconf) {
- // before 2.1.13 --homedir wasn't supported, use env variable
- $env = array('GNUPGHOME' => $this->_homedir);
- $cmd = $this->_gpgconf . ' --kill gpg-agent';
-
- if ($process = proc_open($cmd, array(), $pipes, null, $env)) {
- proc_close($process);
- }
- }
- }
-
- // }}}
- // {{{ _getBinary()
-
- /**
- * Gets the name of the GPG binary for the current operating system
- *
- * This method is called if the '<kbd>binary</kbd>' option is <i>not</i>
- * specified when creating this driver.
- *
- * @return string the name of the GPG binary for the current operating
- * system. If no suitable binary could be found, an empty
- * string is returned.
- */
- private function _getBinary()
- {
- if ($binary = $this->_findBinary('gpg')) {
- return $binary;
- }
-
- return $this->_findBinary('gpg2');
- }
-
- // }}}
- // {{{ _getAgent()
-
- /**
- * Gets the name of the GPG-AGENT binary for the current operating system
- *
- * @return string the name of the GPG-AGENT binary for the current operating
- * system. If no suitable binary could be found, an empty
- * string is returned.
- */
- private function _getAgent()
- {
- return $this->_findBinary('gpg-agent');
- }
-
- // }}}
- // {{{ _getGPGConf()
-
- /**
- * Gets the name of the GPGCONF binary for the current operating system
- *
- * @return string the name of the GPGCONF binary for the current operating
- * system. If no suitable binary could be found, an empty
- * string is returned.
- */
- private function _getGPGConf()
- {
- return $this->_findBinary('gpgconf');
- }
-
- // }}}
- // {{{ _findBinary()
-
- /**
- * Gets the location of a binary for the current operating system
- *
- * @param string $name Name of a binary program
- *
- * @return string The location of the binary for the current operating
- * system. If no suitable binary could be found, an empty
- * string is returned.
- */
- private function _findBinary($name)
- {
- $binary = '';
-
- if ($this->_isDarwin) {
- $locations = array(
- '/opt/local/bin/', // MacPorts
- '/usr/local/bin/', // Mac GPG
- '/sw/bin/', // Fink
- '/usr/bin/'
- );
- } else {
- $locations = array(
- '/usr/bin/',
- '/usr/local/bin/'
- );
- }
-
- foreach ($locations as $location) {
- if (is_executable($location . $name)) {
- $binary = $location . $name;
- break;
- }
- }
-
- return $binary;
- }
-
- // }}}
- // {{{ _getPinEntry()
-
- /**
- * Gets the location of the PinEntry script
- *
- * @return string the location of the PinEntry script.
- */
- private function _getPinEntry()
- {
- // Find PinEntry program depending on the way how the package is installed
- $ds = DIRECTORY_SEPARATOR;
- $root = __DIR__ . $ds . '..' . $ds . '..' . $ds;
- $paths = array(
- '@bin-dir@', // PEAR
- $root . 'scripts', // Git
- $root . 'bin', // Composer
- );
-
- foreach ($paths as $path) {
- if (file_exists($path . $ds . 'crypt-gpg-pinentry')) {
- return $path . $ds . 'crypt-gpg-pinentry';
- }
- }
- }
-
- // }}}
- // {{{ _debug()
-
- /**
- * Displays debug text if debugging is turned on
- *
- * Debugging text is prepended with a debug identifier and echoed to stdout.
- *
- * @param string $text the debugging text to display.
- *
- * @return void
- */
- private function _debug($text)
- {
- if ($this->_debug) {
- if (php_sapi_name() === 'cli') {
- foreach (explode(PHP_EOL, $text) as $line) {
- echo "Crypt_GPG DEBUG: ", $line, PHP_EOL;
- }
- } else if (is_callable($this->_debug)) {
- call_user_func($this->_debug, $text);
- } else {
- // running on a web server, format debug output nicely
- foreach (explode(PHP_EOL, $text) as $line) {
- echo "Crypt_GPG DEBUG: <strong>", htmlspecialchars($line),
- '</strong><br />', PHP_EOL;
- }
- }
- }
- }
-
- // }}}
- }
-
- // }}}
-
- ?>
|