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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
<?php
require_once IMP_BASE . '/lib/Crypt/SMIME.php';
require_once 'Horde/MIME/Structure.php';
/**
* The IMP_MIME_Viewer_pkcs7 class allows viewing/decrypting of S/MIME
* messages.
* This class implements parts of RFC 2630, RFC 2632, and RFC 2633.
*
* This class handles the following MIME types:
* application/pkcs7-mime
* application/pkcs7-signature
* application/x-pkcs7-mime
* application/x-pkcs7-signature
*
* This class may add the following parameters to the URL:
* 'smime_verify_msg' -- Do verification of S/MIME signed data.
*
* $Horde: imp/lib/MIME/Viewer/pkcs7.php,v 1.68.2.26 2008/05/08 07:03:23 slusarz Exp $
*
* Copyright 2002-2008 The Horde Project (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (GPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/gpl.html.
*
* @author Mike Cochrane <mike@graftonhall.co.nz>
* @author Michael Slusarz <slusarz@horde.org>
* @package Horde_MIME_Viewer
*/
class IMP_MIME_Viewer_pkcs7 extends MIME_Viewer {
/**
* IMP_SMIME object.
*
* @var IMP_SMIME
*/
var $_impSmime;
/**
* Classwide cache for icons for status messages.
*
* @var string
*/
var $_icon = null;
/**
* Pointer to the MIME_Contents item.
*
* @var MIME_Contents
*/
var $_contents = null;
/**
* Classwide cache for status messages.
*
* @var array
*/
var $_status = array();
/**
* The IMP_Headers object for the message data.
*
* @var IMP_Headers
*/
var $_headers;
/**
* Some mailers set S/MIME messages to always be attachments. However,
* most of the time S/MIME is used to secure the contents of the message,
* so displaying as an attachment makes no sense. Therefore, force
* viewing inline (or at least let MIME_Viewer/MIME_Contents make the
* determination on whether the data can be viewed inline or not).
*
* @var boolean
*/
var $_forceinline = true;
/**
* Render out the currently set contents.
*
* @param array $params An array with a reference to a MIME_Contents
* object.
*
* @return string The rendered text in HTML.
*/
function render($params)
{
/* Set the MIME_Contents class variable. */
$this->_contents = &$params[0];
$msg = '';
if (empty($this->_impSmime)) {
$this->_impSmime = new IMP_SMIME();
}
/* Check to see if S/MIME support is available. */
$openssl_check = $this->_impSmime->checkForOpenSSL();
if ($GLOBALS['prefs']->getValue('use_smime') &&
!is_a($openssl_check, 'PEAR_Error')) {
/* We need to insert JavaScript code now if S/MIME support is
active. */
$msg = Util::bufferOutput(array('Horde', 'addScriptFile'), 'prototype.js', 'imp', true);
$msg .= Util::bufferOutput(array('Horde', 'addScriptFile'), 'popup.js', 'imp', true);
}
/* Get the type of message now. */
$type = $this->_getSMIMEType();
switch ($type) {
case 'signed':
$msg .= $this->_outputSMIMESigned();
break;
case 'encrypted':
$msg .= $this->_outputSMIMEEncrypted();
break;
}
return $msg;
}
/**
* Generates HTML output for the S/MIME key in
* 'application/pkcs7-signature' MIME_Parts.
*
* @access private
*
* @return string The HTML output.
*/
function _outputSMIMEKey()
{
if (!$GLOBALS['prefs']->getValue('use_smime')) {
return _("S/MIME support is not enabled.");
} else {
$mime = &$this->mime_part;
$signenc = $mime->getInformation('smime_signenc');
$raw_text = $this->_getRawSMIMEText();
if ($signenc && $mime->getInformation('smime_from')) {
$smime_from = $mime->getInformation('smime_from');
$raw_text = "From: $smime_from\n" . $raw_text;
}
$sig_result = $this->_impSmime->verifySignature($raw_text);
return $this->_impSmime->certToHTML($sig_result->cert);
}
}
/**
* Generates HTML output for 'multipart/signed',
* 'application/pkcs7-signature' and
* 'application/x-pkcs7-signature' MIME_Parts.
*
* @access private
*
* @return string The HTML output.
*/
function _outputSMIMESigned()
{
if (Util::getFormData('viewkey')) {
return $this->_outputSMIMEKey();
}
$cert = $text = '';
$mime = &$this->mime_part;
$mimetype = $mime->getType();
$active = $GLOBALS['prefs']->getValue('use_smime');
$signenc = $mime->getInformation('smime_signenc');
if ($signenc) {
$this->_status[] = _("This message has been encrypted via S/MIME.");
}
$this->_initStatus($this->getIcon($mimetype), _("S/MIME"));
$this->_status[] = _("This message has been digitally signed via S/MIME.");
if (!$active) {
$this->_status[] = _("S/MIME support is not enabled so the digital signature is unable to be verified.");
}
/* Store S/MIME results in $sig_result. */
$sig_result = null;
if ($mimetype == 'multipart/signed') {
if (!$signenc) {
if (($mimeID = $mime->getMIMEId())) {
$mime->setContents($this->_contents->getBodyPart($mimeID));
} else {
$mime->setContents($this->_contents->getBody());
}
$mime->splitContents();
}
/* Data that is signed appears in the first MIME subpart. */
$signed_part = $mime->getPart($mime->getRelativeMIMEId(1));
$signed_data = rtrim($signed_part->getCanonicalContents(), "\r");
$mime_message = &MIME_Structure::parseTextMIMEMessage($signed_data);
/* The S/MIME signature appears in the second MIME subpart. */
$subpart = $mime->getPart($mime->getRelativeMIMEId(2));
if (!$subpart ||
!in_array($subpart->getType(), array('application/pkcs7-signature', 'application/x-pkcs7-signature'))) {
$this->_status[] = _("This message does not appear to be in the correct S/MIME format.");
}
} elseif (!$active) {
$this->_status[] = _("S/MIME support is not enabled so the contents of this signed message cannot be displayed.");
}
if ($active) {
$raw_text = $this->_getRawSMIMEText();
if ($signenc && $mime->getInformation('smime_from')) {
$smime_from = $mime->getInformation('smime_from');
$raw_text = "From: $smime_from\n" . $raw_text;
}
if ($GLOBALS['prefs']->getValue('smime_verify') ||
Util::getFormData('smime_verify_msg')) {
$sig_result = $this->_impSmime->verifySignature($raw_text);
} elseif (isset($_SESSION['imp']['viewmode']) &&
($_SESSION['imp']['viewmode'] == 'imp')) {
// TODO: Fix to work with DIMP
$this->_status[] = Horde::link(Util::addParameter(Horde::selfUrl(true), 'smime_verify_msg', 1)) . _("Click HERE to verify the message.") . '</a>';
}
if (!isset($subpart)) {
$msg_data = $this->_impSmime->extractSignedContents($raw_text);
if (is_a($msg_data, 'PEAR_Error')) {
$this->_status[] = $msg_data->getMessage();
$mime_message = $mime;
} else {
$mime_message = &MIME_Structure::parseTextMIMEMessage($msg_data);
}
}
$text = $this->_outputStatus();
if ($sig_result !== null) {
$text .= $this->_outputSMIMESignatureTest($sig_result->result, $sig_result->email);
if (!empty($sig_result->cert)) {
$cert_details = $this->_impSmime->parseCert($sig_result->cert);
if (isset($cert_details['certificate']['subject']['CommonName'])) {
$subject = $cert_details['certificate']['subject']['CommonName'];
} elseif (isset($cert_details['certificate']['subject']['Email'])) {
$subject = $cert_details['certificate']['subject']['Email'];
} elseif (isset($sig_result->email)) {
$subject = $sig_result->email;
} elseif (isset($smime_from)) {
$subject = $smime_from;
} elseif (isset($this->_headers['from'])) {
$subject = $this->_headers['from'];
} else {
$subject = null;
}
if (isset($subpart) &&
!empty($subject) &&
$GLOBALS['registry']->hasMethod('contacts/addField') &&
$GLOBALS['prefs']->getValue('add_source')) {
$this->_status[] = sprintf(_("The S/MIME certificate of %s: "), @htmlspecialchars($subject, ENT_COMPAT, NLS::getCharset())) .
$this->_contents->linkViewJS($subpart, 'view_attach', _("View"), '', null, array('viewkey' => 1)) . '/' .
Horde::link('#', '', null, null, $this->_impSmime->savePublicKeyURL($sig_result->cert) . ' return false;') . _("Save in your Address Book") . '</a>';
$text .= $this->_outputStatus();
}
}
}
}
if (isset($mime_message)) {
/* We need to stick the output into a MIME_Contents object. */
$mc = new MIME_Contents($mime_message, array('download' => 'download_attach', 'view' => 'view_attach'), array(&$this->_contents));
$mc->buildMessage();
$text .= '<table cellpadding="0" cellspacing="0">' . $mc->getMessage(true) . '</table>';
} else {
$text = $this->_outputStatus();
}
return $text;
}
/**
* Generates HTML output for 'multipart/encrypted',
* 'application/pkcs7-mime' and
* 'application/x-pkcs7-mime' MIME_Parts.
*
* @access private
*
* @return string The HTML output.
*/
function _outputSMIMEEncrypted()
{
$active = $GLOBALS['prefs']->getValue('use_smime');
$mime = &$this->mime_part;
$mimetype = $mime->getType();
$msg = '';
$this->_initStatus($this->getIcon($mime->getType()), _("S/MIME"));
$this->_status[] = _("This message has been encrypted via S/MIME.");
if (!$active) {
$this->_status[] = _("S/MIME support is not currently enabled so the message is unable to be decrypted.");
return $this->_outputStatus();
}
if (!$this->_impSmime->getPersonalPrivateKey()) {
$this->_status[] = _("No personal private key exists so the message is unable to be decrypted.");
return $this->_outputStatus();
}
/* Make sure we have a passphrase. */
$passphrase = $this->_impSmime->getPassphrase();
if ($passphrase === false) {
if (isset($_SESSION['imp']['viewmode']) &&
($_SESSION['imp']['viewmode'] == 'imp')) {
// TODO: Fix to work with DIMP
$url = $this->_impSmime->getJSOpenWinCode('open_passphrase_dialog');
$this->_status[] = Horde::link('#', _("You must enter the passphrase for your S/MIME private key to view this message"), null, null, $url . ' return false;') . '<em>' . _("You must enter the passphrase for your S/MIME private key to view this message") . '</em></a>.';
$msg .= $this->_outputStatus() .
'<script type="text/javascript">' . $url . ';</script>';
}
return $msg;
}
$raw_text = $this->_getRawSMIMEText();
$decrypted_data = $this->_impSmime->decryptMessage($raw_text);
if (is_a($decrypted_data, 'PEAR_Error')) {
$this->_status[] = $decrypted_data->getMessage();
return $this->_outputStatus();
}
/* We need to check if this is a signed/encrypted message. */
$mime_message = &MIME_Structure::parseTextMIMEMessage($decrypted_data);
if ($mime_message) {
/* Check for signed and encoded data. */
if (in_array($mime_message->getType(), array('multipart/signed', 'application/pkcs7-mime', 'application/x-pkcs7-mime'))) {
$mime_message->setContents($decrypted_data);
$mime_message->splitContents();
$mime_message->setInformation('smime_signenc', true);
if (isset($this->_headers['from'])) {
$mime_message->setInformation('smime_from', $this->_headers['from']);
}
} else {
$msg .= $this->_outputStatus();
}
/* We need to stick the output into a MIME_Contents object. */
$mc = new MIME_Contents($mime_message, array('download' => 'download_attach', 'view' => 'view_attach'), array(&$this->_contents));
$mc->buildMessage();
$msg .= '<table cellpadding="0" cellspacing="0">' . $mc->getMessage(true) . '</table>';
} else {
require_once 'Horde/Text/Filter.php';
$msg .= $this->_outputStatus() .
'<span class="fixed">' . Text_Filter::filter($decrypted_data, 'text2html', array('parselevel' => TEXT_HTML_SYNTAX)) . '</span>';
}
return $msg;
}
/**
* Return text/html as the content-type.
*
* @return string "text/html" constant.
*/
function getType()
{
return 'text/html; charset=' . NLS::getCharset();
}
/**
* Get the headers of the S/MIME message.
*
* @access private
*/
function _getRawSMIMEText()
{
$mime = &$this->mime_part;
$mime->setContents($this->_contents->getBody());
if (is_a($this->_contents, 'IMP_Contents') &&
(($mime->getMIMEId() == 0) ||
($mime->splitContents() == false))) {
$imp_headers = &$this->_contents->getHeaderOb();
$this->_headers = MIME_Structure::parseMIMEHeaders($imp_headers->getHeaderText(), true, true);
return $this->_contents->fullMessageText();
} else {
require_once IMP_BASE . '/lib/MIME/Headers.php';
$header_text = $mime->getCanonicalContents();
$header_text = substr($header_text, 0, strpos($header_text, "\r\n\r\n"));
$this->_headers = MIME_Structure::parseMIMEHeaders($header_text, true, true);
$imp_headers = new IMP_Headers();
if (isset($this->_headers['content-type'])) {
$imp_headers->addHeader('Content-Type', $this->_headers['content-type']);
}
if (isset($this->_headers['from'])) {
$imp_headers->addHeader('From', $this->_headers['from']);
}
if (isset($this->_headers['to'])) {
$imp_headers->addHeader('To', $this->_headers['to']);
}
return $imp_headers->toString() . $mime->toCanonicalString();
}
}
/* Various formatting helper functions. */
function _initStatus($src, $alt = '')
{
if ($this->_icon === null) {
$this->_icon = Horde::img($src, $alt, 'height="16" width="16"', '');
}
}
function _outputStatus()
{
$output = '';
if (!empty($this->_status)) {
$output = $this->_contents->formatStatusMsg($this->_status, $this->_icon);
}
$this->_icon = null;
$this->_status = array();
return $output;
}
/**
* Generates HTML output for the S/MIME signature test.
*
* @access private
*
* @param string $result Result string of the S/MIME output concerning
* the signature test.
* @param string $email The email of the sender.
*
* @return string The HTML output.
*/
function _outputSMIMESignatureTest($result, $email)
{
$text = '';
if (is_a($result, 'PEAR_Error')) {
if ($result->getCode() == 'horde.warning') {
$this->_initStatus($GLOBALS['registry']->getImageDir('horde') . '/alerts/warning.png', _("Warning"));
} else {
$this->_initStatus($GLOBALS['registry']->getImageDir('horde') . '/alerts/error.png', _("Error"));
}
$result = $result->getMessage();
} else {
$this->_initStatus($GLOBALS['registry']->getImageDir('horde') . '/alerts/success.png', _("Success"));
/* This message has been verified but there was no output
from the PGP program. */
if (empty($result) || ($result === true)) {
$email = (is_array($email)) ? implode(', ', $email): $email;
$result = sprintf(_("The message has been verified. Sender: %s."), htmlspecialchars($email));
}
}
require_once 'Horde/Text/Filter.php';
$this->_status[] = Text_Filter::filter($result, 'text2html', array('parselevel' => TEXT_HTML_NOHTML));
return $this->_outputStatus();
}
/**
* Render out attachment information.
*
* @param array $params An array with a reference to a MIME_Contents
* object.
*
* @return string The rendered text in HTML.
*/
function renderAttachmentInfo($params)
{
$this->_contents = &$params[0];
$type = $this->_getSMIMEType();
switch ($type) {
case 'signed':
$this->_status[] = _("This message contains an attachment that has been digitally signed via S/MIME.");
break;
case 'encrypted':
$this->_status[] = _("This message contains an attachment that has been encrypted via S/MIME.");
break;
}
$this->_status[] = sprintf(_("Click %s to view the attachment in a separate window."), $this->_contents->linkViewJS($this->mime_part, 'view_attach', _("HERE"), _("View attachment in a separate window")));
$this->_initStatus($this->getIcon($this->mime_part->getType()), _("S/MIME"));
return $this->_outputStatus();
}
/**
* Deterimne the S/MIME type of the message.
*
* @access private
*
* @return string Either 'encrypted' or 'signed'.
*/
function _getSMIMEType()
{
$type = $this->mime_part->getType();
if (in_array($type, array('application/pkcs7-mime', 'application/x-pkcs7-mime'))) {
$smime_type = $this->mime_part->getContentTypeParameter('smime-type');
if ($smime_type == 'signed-data') {
return 'signed';
} elseif (!$smime_type || ($smime_type == 'enveloped-data')) {
return 'encrypted';
}
}
switch ($type) {
case 'multipart/signed':
case 'application/pkcs7-signature':
case 'application/x-pkcs7-signature':
return 'signed';
}
}
}
|
