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