wsgcrypt.h checks internally if we HAVE_LIBGCRYPT
[metze/wireshark/wip.git] / asn1 / pkcs12 / packet-pkcs12-template.c
1 /* packet-pkcs12.c
2  * Routines for PKCS#12: Personal Information Exchange packet dissection
3  * Graeme Lunt 2006
4  *
5  * See "PKCS #12 v1.1: Personal Information Exchange Syntax":
6  *
7  *    http://www.emc.com/emc-plus/rsa-labs/pkcs/files/h11301-wp-pkcs-12v1-1-personal-information-exchange-syntax.pdf
8  *
9  * Wireshark - Network traffic analyzer
10  * By Gerald Combs <gerald@wireshark.org>
11  * Copyright 1998 Gerald Combs
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26  */
27
28 #include "config.h"
29
30 #include <epan/packet.h>
31 #include <epan/expert.h>
32 #include <epan/oids.h>
33 #include <epan/asn1.h>
34 #include <epan/prefs.h>
35
36 #include "packet-ber.h"
37 #include "packet-pkcs12.h"
38 #include "packet-x509af.h"
39 #include "packet-x509if.h"
40 #include "packet-cms.h"
41
42 #include <wsutil/wsgcrypt.h>
43
44 #define PNAME  "PKCS#12: Personal Information Exchange"
45 #define PSNAME "PKCS12"
46 #define PFNAME "pkcs12"
47
48 #define PKCS12_PBE_ARCFOUR_SHA1_OID     "1.2.840.113549.1.12.1.1"
49 #define PKCS12_PBE_3DES_SHA1_OID        "1.2.840.113549.1.12.1.3"
50 #define PKCS12_PBE_RC2_40_SHA1_OID      "1.2.840.113549.1.12.1.6"
51
52 void proto_register_pkcs12(void);
53 void proto_reg_handoff_pkcs12(void);
54
55 /* Initialize the protocol and registered fields */
56 static int proto_pkcs12 = -1;
57
58 static int hf_pkcs12_X509Certificate_PDU = -1;
59 static int hf_pkcs12_AuthenticatedSafe_PDU = -1;  /* AuthenticatedSafe */
60 static gint ett_decrypted_pbe = -1;
61
62 static expert_field ei_pkcs12_octet_string_expected = EI_INIT;
63
64
65 static const char *object_identifier_id = NULL;
66 static int iteration_count = 0;
67 static tvbuff_t *salt = NULL;
68 static const char *password = NULL;
69 static gboolean try_null_password = FALSE;
70
71 static void dissect_AuthenticatedSafe_OCTETSTRING_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
72 static void dissect_SafeContents_OCTETSTRING_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
73 static int dissect_PrivateKeyInfo_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data);
74
75 #include "packet-pkcs12-hf.c"
76
77 /* Initialize the subtree pointers */
78 #include "packet-pkcs12-ett.c"
79
80 static void append_oid(proto_tree *tree, const char *oid)
81 {
82         const char *name = NULL;
83
84         name = oid_resolved_from_string(wmem_packet_scope(), oid);
85         proto_item_append_text(tree, " (%s)", name ? name : oid);
86 }
87
88 #ifdef HAVE_LIBGCRYPT
89
90 static int
91 generate_key_or_iv(unsigned int id, tvbuff_t *salt_tvb, unsigned int iter,
92                        const char *pw, unsigned int req_keylen, char * keybuf)
93 {
94   int rc;
95   unsigned int i, j;
96   gcry_md_hd_t md;
97   gcry_mpi_t num_b1 = NULL;
98   size_t pwlen;
99   char hash[20], buf_b[64], buf_i[128], *p;
100   char *salt_p;
101   int salt_size;
102   size_t cur_keylen;
103   size_t n;
104   gcry_error_t  err;
105
106   cur_keylen = 0;
107
108   salt_size = tvb_captured_length(salt_tvb);
109   salt_p = (char *)tvb_memdup(wmem_packet_scope(), salt_tvb, 0, salt_size);
110
111   if (pw == NULL)
112     pwlen = 0;
113   else
114     pwlen = strlen(pw);
115
116   if (pwlen > 63 / 2)
117     {
118       return FALSE;
119     }
120
121   /* Store salt and password in BUF_I */
122   p = buf_i;
123   for (i = 0; i < 64; i++)
124     *p++ = salt_p[i % salt_size];
125   if (pw)
126     {
127       for (i = j = 0; i < 64; i += 2)
128         {
129           *p++ = 0;
130           *p++ = pw[j];
131           if (++j > pwlen)      /* Note, that we include the trailing zero */
132             j = 0;
133         }
134     }
135   else
136     memset (p, 0, 64);
137
138   for (;;) {
139       err = gcry_md_open(&md, GCRY_MD_SHA1, 0);
140       if (gcry_err_code(err))
141         {
142           return FALSE;
143         }
144       for (i = 0; i < 64; i++)
145         {
146           unsigned char lid = id & 0xFF;
147           gcry_md_write (md, &lid, 1);
148         }
149
150       gcry_md_write(md, buf_i, pw ? 128 : 64);
151
152       gcry_md_final (md);
153       memcpy (hash, gcry_md_read (md, 0), 20);
154
155       gcry_md_close (md);
156
157       for (i = 1; i < iter; i++)
158         gcry_md_hash_buffer (GCRY_MD_SHA1, hash, hash, 20);
159
160       for (i = 0; i < 20 && cur_keylen < req_keylen; i++)
161         keybuf[cur_keylen++] = hash[i];
162
163       if (cur_keylen == req_keylen)
164       {
165         gcry_mpi_release (num_b1);
166         return TRUE;            /* ready */
167       }
168
169       /* need more bytes. */
170       for (i = 0; i < 64; i++)
171         buf_b[i] = hash[i % 20];
172
173       n = 64;
174
175       rc = gcry_mpi_scan (&num_b1, GCRYMPI_FMT_USG, buf_b, n, &n);
176
177       if (rc != 0)
178         {
179           return FALSE;
180         }
181
182       gcry_mpi_add_ui (num_b1, num_b1, 1);
183
184       for (i = 0; i < 128; i += 64)
185         {
186           gcry_mpi_t num_ij;
187
188           n = 64;
189           rc = gcry_mpi_scan (&num_ij, GCRYMPI_FMT_USG, buf_i + i, n, &n);
190
191           if (rc != 0)
192             {
193               return FALSE;
194             }
195
196           gcry_mpi_add (num_ij, num_ij, num_b1);
197           gcry_mpi_clear_highbit (num_ij, 64 * 8);
198
199           n = 64;
200
201           rc = gcry_mpi_print (GCRYMPI_FMT_USG, buf_i + i, n, &n, num_ij);
202           if (rc != 0)
203             {
204               return FALSE;
205             }
206
207           gcry_mpi_release (num_ij);
208         }
209   }
210 }
211
212 #endif
213
214 void PBE_reset_parameters(void)
215 {
216         iteration_count = 0;
217         salt = NULL;
218 }
219
220 int PBE_decrypt_data(const char *object_identifier_id_param _U_, tvbuff_t *encrypted_tvb _U_, asn1_ctx_t *actx _U_, proto_item *item _U_)
221 {
222 #ifdef HAVE_LIBGCRYPT
223         const char      *encryption_algorithm;
224         gcry_cipher_hd_t cipher;
225         gcry_error_t    err;
226         int             algo;
227         int             mode;
228         int             ivlen = 0;
229         int             keylen = 0;
230         int             datalen = 0;
231         char            *key = NULL;
232         char            *iv = NULL;
233         char            *clear_data = NULL;
234         tvbuff_t        *clear_tvb = NULL;
235         const gchar     *oidname;
236         GString         *name;
237         proto_tree      *tree;
238         char            byte;
239         gboolean        decrypt_ok = TRUE;
240
241         if(((password == NULL) || (*password == '\0')) && (try_null_password == FALSE)) {
242                 /* we are not configured to decrypt */
243                 return FALSE;
244         }
245
246         encryption_algorithm = x509af_get_last_algorithm_id();
247
248         /* these are the only encryption schemes we understand for now */
249         if(!strcmp(encryption_algorithm, PKCS12_PBE_3DES_SHA1_OID)) {
250                 ivlen = 8;
251                 keylen = 24;
252                 algo = GCRY_CIPHER_3DES;
253                 mode = GCRY_CIPHER_MODE_CBC;
254         } else if(!strcmp(encryption_algorithm, PKCS12_PBE_ARCFOUR_SHA1_OID)) {
255                 ivlen = 0;
256                 keylen = 16;
257                 algo = GCRY_CIPHER_ARCFOUR;
258                 mode = GCRY_CIPHER_MODE_NONE;
259         } else if(!strcmp(encryption_algorithm, PKCS12_PBE_RC2_40_SHA1_OID)) {
260                 ivlen = 8;
261                 keylen = 5;
262                 algo = GCRY_CIPHER_RFC2268_40;
263                 mode = GCRY_CIPHER_MODE_CBC;
264         } else {
265                 /* we don't know how to decrypt this */
266
267                 proto_item_append_text(item, " [Unsupported encryption algorithm]");
268                 return FALSE;
269         }
270
271         if((iteration_count == 0) || (salt == NULL)) {
272                 proto_item_append_text(item, " [Insufficient parameters]");
273                 return FALSE;
274         }
275
276         /* allocate buffers */
277         key = (char *)wmem_alloc(wmem_packet_scope(), keylen);
278
279         if(!generate_key_or_iv(1 /*LEY */, salt, iteration_count, password, keylen, key))
280                 return FALSE;
281
282         if(ivlen) {
283
284                 iv = (char *)wmem_alloc(wmem_packet_scope(), ivlen);
285
286                 if(!generate_key_or_iv(2 /* IV */, salt, iteration_count, password, ivlen, iv))
287                         return FALSE;
288         }
289
290         /* now try an internal function */
291         err = gcry_cipher_open(&cipher, algo, mode, 0);
292         if (gcry_err_code (err))
293                         return FALSE;
294
295         err = gcry_cipher_setkey (cipher, key, keylen);
296         if (gcry_err_code (err)) {
297                         gcry_cipher_close (cipher);
298                         return FALSE;
299         }
300
301         if(ivlen) {
302                   err = gcry_cipher_setiv (cipher, iv, ivlen);
303                   if (gcry_err_code (err)) {
304                           gcry_cipher_close (cipher);
305                           return FALSE;
306                   }
307         }
308
309         datalen = tvb_captured_length(encrypted_tvb);
310         clear_data = (char *)g_malloc(datalen);
311
312         err = gcry_cipher_decrypt (cipher, clear_data, datalen, (char *)tvb_memdup(wmem_packet_scope(), encrypted_tvb, 0, datalen), datalen);
313         if (gcry_err_code (err)) {
314
315                 proto_item_append_text(item, " [Failed to decrypt with password preference]");
316
317                 gcry_cipher_close (cipher);
318                 g_free(clear_data);
319                 return FALSE;
320         }
321
322         gcry_cipher_close (cipher);
323
324         /* We don't know if we have successfully decrypted the data or not so we:
325                 a) check the trailing bytes
326                 b) see if we start with a sequence or a set (is this too constraining?
327                 */
328
329         /* first the trailing bytes */
330         byte = clear_data[datalen-1];
331         if(byte <= 0x08) {
332                 int i;
333
334                 for(i = (int)byte; i > 0 ; i--) {
335                         if(clear_data[datalen - i] != byte) {
336                                 decrypt_ok = FALSE;
337                                 break;
338                         }
339                 }
340         } else {
341                 /* XXX: is this a failure? */
342         }
343
344         /* we assume the result is ASN.1 - check it is a SET or SEQUENCE */
345         byte = clear_data[0];
346         if((byte != 0x30) && (byte != 0x31)) { /* do we need more here? OCTET STRING? */
347                 decrypt_ok = FALSE;
348         }
349
350         if(!decrypt_ok) {
351                 g_free(clear_data);
352                 proto_item_append_text(item, " [Failed to decrypt with supplied password]");
353
354                 return FALSE;
355         }
356
357         proto_item_append_text(item, " [Decrypted successfully]");
358
359         tree = proto_item_add_subtree(item, ett_decrypted_pbe);
360
361         /* OK - so now clear_data contains the decrypted data */
362
363         clear_tvb = tvb_new_child_real_data(encrypted_tvb,(const guint8 *)clear_data, datalen, datalen);
364         tvb_set_free_cb(clear_tvb, g_free);
365
366         name = g_string_new("");
367         oidname = oid_resolved_from_string(wmem_packet_scope(), object_identifier_id_param);
368         g_string_printf(name, "Decrypted %s", oidname ? oidname : object_identifier_id_param);
369
370         /* add it as a new source */
371         add_new_data_source(actx->pinfo, clear_tvb, name->str);
372
373         g_string_free(name, TRUE);
374
375         /* now try and decode it */
376         call_ber_oid_callback(object_identifier_id_param, clear_tvb, 0, actx->pinfo, tree, NULL);
377
378         return TRUE;
379 #else
380         /* we cannot decrypt */
381         return FALSE;
382
383 #endif
384 }
385
386 #include "packet-pkcs12-fn.c"
387
388 static int strip_octet_string(tvbuff_t *tvb)
389 {
390   gint8 ber_class;
391   gboolean pc, ind;
392   gint32 tag;
393   guint32 len;
394   int offset = 0;
395
396   /* PKCS#7 encodes the content as OCTET STRING, whereas CMS is just any ANY */
397   /* if we use CMS (rather than PKCS#7) - which we are - we need to strip the OCTET STRING tag */
398   /* before proceeding */
399
400   offset = get_ber_identifier(tvb, 0, &ber_class, &pc, &tag);
401   offset = get_ber_length(tvb, offset, &len, &ind);
402
403   if((ber_class == BER_CLASS_UNI) && (tag == BER_UNI_TAG_OCTETSTRING))
404     return offset;
405
406   return 0;
407
408 }
409
410 static void dissect_AuthenticatedSafe_OCTETSTRING_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree) {
411   int offset = 0;
412   asn1_ctx_t asn1_ctx;
413   asn1_ctx_init(&asn1_ctx, ASN1_ENC_BER, TRUE, pinfo);
414
415   if((offset = strip_octet_string(tvb)) > 0)
416     dissect_pkcs12_AuthenticatedSafe(FALSE, tvb, offset, &asn1_ctx, tree, hf_pkcs12_AuthenticatedSafe_PDU);
417   else
418     proto_tree_add_expert(tree, pinfo, &ei_pkcs12_octet_string_expected, tvb, 0, 1);
419 }
420
421 static void dissect_SafeContents_OCTETSTRING_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
422 {
423   int offset = 0;
424   asn1_ctx_t asn1_ctx;
425   asn1_ctx_init(&asn1_ctx, ASN1_ENC_BER, TRUE, pinfo);
426
427   offset = strip_octet_string(tvb);
428
429   dissect_pkcs12_SafeContents(FALSE, tvb, offset, &asn1_ctx, tree, hf_pkcs12_SafeContents_PDU);
430 }
431
432 static void dissect_X509Certificate_OCTETSTRING_PDU(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
433 {
434   int offset = 0;
435   asn1_ctx_t asn1_ctx;
436   asn1_ctx_init(&asn1_ctx, ASN1_ENC_BER, TRUE, pinfo);
437
438   if((offset = strip_octet_string(tvb)) > 0)
439         dissect_x509af_Certificate(FALSE, tvb, offset, &asn1_ctx, tree, hf_pkcs12_X509Certificate_PDU);
440   else
441         proto_tree_add_expert(tree, pinfo, &ei_pkcs12_octet_string_expected, tvb, 0, 1);
442 }
443
444 /*--- proto_register_pkcs12 ----------------------------------------------*/
445 void proto_register_pkcs12(void) {
446
447   /* List of fields */
448   static hf_register_info hf[] = {
449     { &hf_pkcs12_X509Certificate_PDU,
450       { "X509Certificate", "pkcs12.X509Certificate",
451         FT_NONE, BASE_NONE, NULL, 0,
452         "pkcs12.X509Certificate", HFILL }},
453     { &hf_pkcs12_AuthenticatedSafe_PDU,
454       { "AuthenticatedSafe", "pkcs12.AuthenticatedSafe",
455         FT_UINT32, BASE_DEC, NULL, 0,
456         NULL, HFILL }},
457
458 #include "packet-pkcs12-hfarr.c"
459   };
460
461   /* List of subtrees */
462   static gint *ett[] = {
463           &ett_decrypted_pbe,
464 #include "packet-pkcs12-ettarr.c"
465   };
466   static ei_register_info ei[] = {
467       { &ei_pkcs12_octet_string_expected, { "pkcs12.octet_string_expected", PI_PROTOCOL, PI_WARN, "BER Error: OCTET STRING expected", EXPFILL }},
468   };
469
470   module_t *pkcs12_module;
471   expert_module_t* expert_pkcs12;
472
473   /* Register protocol */
474   proto_pkcs12 = proto_register_protocol(PNAME, PSNAME, PFNAME);
475
476   /* Register fields and subtrees */
477   proto_register_field_array(proto_pkcs12, hf, array_length(hf));
478   proto_register_subtree_array(ett, array_length(ett));
479   expert_pkcs12 = expert_register_protocol(proto_pkcs12);
480   expert_register_field_array(expert_pkcs12, ei, array_length(ei));
481
482   /* Register preferences */
483   pkcs12_module = prefs_register_protocol(proto_pkcs12, NULL);
484
485   prefs_register_string_preference(pkcs12_module, "password",
486         "Password to decrypt the file with",
487         "The password to used to decrypt the encrypted elements within"
488         " the PKCS#12 file", &password);
489
490   prefs_register_bool_preference(pkcs12_module, "try_null_password",
491         "Try to decrypt with a empty password",
492         "Whether to try and decrypt the encrypted data within the"
493         " PKCS#12 with a NULL password", &try_null_password);
494
495   new_register_ber_syntax_dissector("PKCS#12", proto_pkcs12, dissect_PFX_PDU);
496   register_ber_oid_syntax(".p12", NULL, "PKCS#12");
497   register_ber_oid_syntax(".pfx", NULL, "PKCS#12");
498 }
499
500
501 /*--- proto_reg_handoff_pkcs12 -------------------------------------------*/
502 void proto_reg_handoff_pkcs12(void) {
503 #include "packet-pkcs12-dis-tab.c"
504
505         register_ber_oid_dissector("1.2.840.113549.1.9.22.1", dissect_X509Certificate_OCTETSTRING_PDU, proto_pkcs12, "x509Certificate");
506
507 }
508