blob: 8b4c85c7ac3e0f0ed35cf1b01530573ea9578379 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Crypt_GPG is a package to use GPG from PHP
*
* This file contains an object that handles GPG's status output for the
* key generation operation.
*
* 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @category Encryption
* @package Crypt_GPG
* @author Michael Gauthier <mike@silverorange.com>
* @copyright 2011-2013 silverorange
* @license http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
* @version CVS: $Id:$
* @link http://pear.php.net/package/Crypt_GPG
* @link http://www.gnupg.org/
*/
/**
* Status line handler for the key generation operation
*
* 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 class is responsible for parsing the final key fingerprint from the
* status output and for updating the key generation progress file. See
* <b>doc/DETAILS</b> in the
* {@link http://www.gnupg.org/download/ GPG distribution} for detailed
* information on GPG's status output for the batch key generation operation.
*
* @category Encryption
* @package Crypt_GPG
* @author Michael Gauthier <mike@silverorange.com>
* @copyright 2011-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_KeyGeneratorStatusHandler
{
// {{{ protected properties
/**
* The key fingerprint
*
* Ths key fingerprint is emitted by GPG after the key generation is
* complete.
*
* @var string
*/
protected $keyFingerprint = '';
/**
* The unique key handle used by this handler
*
* The key handle is used to track GPG status output for a particular key
* before the key has its own identifier.
*
* @var string
*
* @see Crypt_GPG_KeyGeneratorStatusHandler::setHandle()
*/
protected $handle = '';
/**
* Error code (if any) caused by key generation
*
* @var integer
*/
protected $errorCode = Crypt_GPG::ERROR_NONE;
// }}}
// {{{ setHandle()
/**
* Sets the unique key handle used by this handler
*
* The key handle is used to track GPG status output for a particular key
* before the key has its own identifier.
*
* @param string $handle the key handle this status handle will use.
*
* @return Crypt_GPG_KeyGeneratorStatusHandler the current object, for
* fluent interface.
*/
public function setHandle($handle)
{
$this->handle = strval($handle);
return $this;
}
// }}}
// {{{ handle()
/**
* Handles a status line
*
* @param string $line the status line to handle.
*
* @return void
*/
public function handle($line)
{
$tokens = explode(' ', $line);
switch ($tokens[0]) {
case 'KEY_CREATED':
if ($tokens[3] == $this->handle) {
$this->keyFingerprint = $tokens[2];
}
break;
case 'KEY_NOT_CREATED':
if ($tokens[1] == $this->handle) {
$this->errorCode = Crypt_GPG::ERROR_KEY_NOT_CREATED;
}
break;
case 'PROGRESS':
// todo: at some point, support reporting status async
break;
}
}
// }}}
// {{{ getKeyFingerprint()
/**
* Gets the key fingerprint parsed by this handler
*
* @return array the key fingerprint parsed by this handler.
*/
public function getKeyFingerprint()
{
return $this->keyFingerprint;
}
// }}}
// {{{ getErrorCode()
/**
* Gets the error code resulting from key gneration
*
* @return integer the error code resulting from key generation.
*/
public function getErrorCode()
{
return $this->errorCode;
}
// }}}
}
?>
|
