common/mbedtls/pkcs12.c

   1 /*
   2  *  PKCS#12 Personal Information Exchange Syntax
   3  *
   4  *  Copyright The Mbed TLS Contributors
   5  *  SPDX-License-Identifier: Apache-2.0
   6  *
   7  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
   8  *  not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *
  11  *  http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  */
  19 /*
  20  *  The PKCS #12 Personal Information Exchange Syntax Standard v1.1
  21  *
  22  *  http://www.rsa.com/rsalabs/pkcs/files/h11301-wp-pkcs-12v1-1-personal-information-exchange-syntax.pdf
  23  *  ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-12/pkcs-12v1-1.asn
  24  */
  25
  26 #include "common.h"
  27
  28 #if defined(MBEDTLS_PKCS12_C)
  29
  30 #include "mbedtls/pkcs12.h"
  31 #include "mbedtls/asn1.h"
  32 #include "mbedtls/cipher.h"
  33 #include "mbedtls/platform_util.h"
  34 #include "mbedtls/error.h"
  35
  36 #include <string.h>
  37
  38 #if defined(MBEDTLS_ARC4_C)
  39 #include "mbedtls/arc4.h"
  40 #endif
  41
  42 #if defined(MBEDTLS_DES_C)
  43 #include "mbedtls/des.h"
  44 #endif
  45
  46 #if defined(MBEDTLS_ASN1_PARSE_C)
  47
  48 static int pkcs12_parse_pbe_params(mbedtls_asn1_buf *params,
  49                                    mbedtls_asn1_buf *salt, int *iterations) {
  50     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  51     unsigned char **p = &params->p;
  52     const unsigned char *end = params->p + params->len;
  53
  54     /*
  55      *  pkcs-12PbeParams ::= SEQUENCE {
  56      *    salt          OCTET STRING,
  57      *    iterations    INTEGER
  58      *  }
  59      *
  60      */
  61     if (params->tag != (MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE))
  62         return (MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT +
  63                 MBEDTLS_ERR_ASN1_UNEXPECTED_TAG);
  64
  65     if ((ret = mbedtls_asn1_get_tag(p, end, &salt->len, MBEDTLS_ASN1_OCTET_STRING)) != 0)
  66         return (MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT + ret);
  67
  68     salt->p = *p;
  69     *p += salt->len;
  70
  71     if ((ret = mbedtls_asn1_get_int(p, end, iterations)) != 0)
  72         return (MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT + ret);
  73
  74     if (*p != end)
  75         return (MBEDTLS_ERR_PKCS12_PBE_INVALID_FORMAT +
  76                 MBEDTLS_ERR_ASN1_LENGTH_MISMATCH);
  77
  78     return (0);
  79 }
  80
  81 #define PKCS12_MAX_PWDLEN 128
  82
  83 static int pkcs12_pbe_derive_key_iv(mbedtls_asn1_buf *pbe_params, mbedtls_md_type_t md_type,
  84                                     const unsigned char *pwd,  size_t pwdlen,
  85                                     unsigned char *key, size_t keylen,
  86                                     unsigned char *iv,  size_t ivlen) {
  87     int ret, iterations = 0;
  88     mbedtls_asn1_buf salt;
  89     size_t i;
  90     unsigned char unipwd[PKCS12_MAX_PWDLEN * 2 + 2];
  91
  92     if (pwdlen > PKCS12_MAX_PWDLEN)
  93         return (MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA);
  94
  95     memset(&salt, 0, sizeof(mbedtls_asn1_buf));
  96     memset(&unipwd, 0, sizeof(unipwd));
  97
  98     if ((ret = pkcs12_parse_pbe_params(pbe_params, &salt,
  99                                        &iterations)) != 0)
 100         return (ret);
 101
 102     for (i = 0; i < pwdlen; i++)
 103         unipwd[i * 2 + 1] = pwd[i];
 104
 105     if ((ret = mbedtls_pkcs12_derivation(key, keylen, unipwd, pwdlen * 2 + 2,
 106                                          salt.p, salt.len, md_type,
 107                                          MBEDTLS_PKCS12_DERIVE_KEY, iterations)) != 0) {
 108         return (ret);
 109     }
 110
 111     if (iv == NULL || ivlen == 0)
 112         return (0);
 113
 114     if ((ret = mbedtls_pkcs12_derivation(iv, ivlen, unipwd, pwdlen * 2 + 2,
 115                                          salt.p, salt.len, md_type,
 116                                          MBEDTLS_PKCS12_DERIVE_IV, iterations)) != 0) {
 117         return (ret);
 118     }
 119     return (0);
 120 }
 121
 122 #undef PKCS12_MAX_PWDLEN
 123
 124 int mbedtls_pkcs12_pbe_sha1_rc4_128(mbedtls_asn1_buf *pbe_params, int mode,
 125                                     const unsigned char *pwd,  size_t pwdlen,
 126                                     const unsigned char *data, size_t len,
 127                                     unsigned char *output) {
 128 #if !defined(MBEDTLS_ARC4_C)
 129     ((void) pbe_params);
 130     ((void) mode);
 131     ((void) pwd);
 132     ((void) pwdlen);
 133     ((void) data);
 134     ((void) len);
 135     ((void) output);
 136     return (MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE);
 137 #else
 138     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
 139     unsigned char key[16];
 140     mbedtls_arc4_context ctx;
 141     ((void) mode);
 142
 143     mbedtls_arc4_init(&ctx);
 144
 145     if ((ret = pkcs12_pbe_derive_key_iv(pbe_params, MBEDTLS_MD_SHA1,
 146                                         pwd, pwdlen,
 147                                         key, 16, NULL, 0)) != 0) {
 148         return (ret);
 149     }
 150
 151     mbedtls_arc4_setup(&ctx, key, 16);
 152     if ((ret = mbedtls_arc4_crypt(&ctx, len, data, output)) != 0)
 153         goto exit;
 154
 155 exit:
 156     mbedtls_platform_zeroize(key, sizeof(key));
 157     mbedtls_arc4_free(&ctx);
 158
 159     return (ret);
 160 #endif /* MBEDTLS_ARC4_C */
 161 }
 162
 163 int mbedtls_pkcs12_pbe(mbedtls_asn1_buf *pbe_params, int mode,
 164                        mbedtls_cipher_type_t cipher_type, mbedtls_md_type_t md_type,
 165                        const unsigned char *pwd,  size_t pwdlen,
 166                        const unsigned char *data, size_t len,
 167                        unsigned char *output) {
 168     int ret, keylen = 0;
 169     unsigned char key[32];
 170     unsigned char iv[16];
 171     const mbedtls_cipher_info_t *cipher_info;
 172     mbedtls_cipher_context_t cipher_ctx;
 173     size_t olen = 0;
 174
 175     cipher_info = mbedtls_cipher_info_from_type(cipher_type);
 176     if (cipher_info == NULL)
 177         return (MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE);
 178
 179     keylen = cipher_info->key_bitlen / 8;
 180
 181     if ((ret = pkcs12_pbe_derive_key_iv(pbe_params, md_type, pwd, pwdlen,
 182                                         key, keylen,
 183                                         iv, cipher_info->iv_size)) != 0) {
 184         return (ret);
 185     }
 186
 187     mbedtls_cipher_init(&cipher_ctx);
 188
 189     if ((ret = mbedtls_cipher_setup(&cipher_ctx, cipher_info)) != 0)
 190         goto exit;
 191
 192     if ((ret = mbedtls_cipher_setkey(&cipher_ctx, key, 8 * keylen, (mbedtls_operation_t) mode)) != 0)
 193         goto exit;
 194
 195     if ((ret = mbedtls_cipher_set_iv(&cipher_ctx, iv, cipher_info->iv_size)) != 0)
 196         goto exit;
 197
 198     if ((ret = mbedtls_cipher_reset(&cipher_ctx)) != 0)
 199         goto exit;
 200
 201     if ((ret = mbedtls_cipher_update(&cipher_ctx, data, len,
 202                                      output, &olen)) != 0) {
 203         goto exit;
 204     }
 205
 206     if ((ret = mbedtls_cipher_finish(&cipher_ctx, output + olen, &olen)) != 0)
 207         ret = MBEDTLS_ERR_PKCS12_PASSWORD_MISMATCH;
 208
 209 exit:
 210     mbedtls_platform_zeroize(key, sizeof(key));
 211     mbedtls_platform_zeroize(iv,  sizeof(iv));
 212     mbedtls_cipher_free(&cipher_ctx);
 213
 214     return (ret);
 215 }
 216
 217 #endif /* MBEDTLS_ASN1_PARSE_C */
 218
 219 static void pkcs12_fill_buffer(unsigned char *data, size_t data_len,
 220                                const unsigned char *filler, size_t fill_len) {
 221     unsigned char *p = data;
 222     size_t use_len;
 223
 224     while (data_len > 0) {
 225         use_len = (data_len > fill_len) ? fill_len : data_len;
 226         memcpy(p, filler, use_len);
 227         p += use_len;
 228         data_len -= use_len;
 229     }
 230 }
 231
 232 int mbedtls_pkcs12_derivation(unsigned char *data, size_t datalen,
 233                               const unsigned char *pwd, size_t pwdlen,
 234                               const unsigned char *salt, size_t saltlen,
 235                               mbedtls_md_type_t md_type, int id, int iterations) {
 236     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
 237     unsigned int j;
 238
 239     unsigned char diversifier[128];
 240     unsigned char salt_block[128], pwd_block[128], hash_block[128];
 241     unsigned char hash_output[MBEDTLS_MD_MAX_SIZE];
 242     unsigned char *p;
 243     unsigned char c;
 244
 245     size_t hlen, use_len, v, i;
 246
 247     const mbedtls_md_info_t *md_info;
 248     mbedtls_md_context_t md_ctx;
 249
 250     // This version only allows max of 64 bytes of password or salt
 251     if (datalen > 128 || pwdlen > 64 || saltlen > 64)
 252         return (MBEDTLS_ERR_PKCS12_BAD_INPUT_DATA);
 253
 254     md_info = mbedtls_md_info_from_type(md_type);
 255     if (md_info == NULL)
 256         return (MBEDTLS_ERR_PKCS12_FEATURE_UNAVAILABLE);
 257
 258     mbedtls_md_init(&md_ctx);
 259
 260     if ((ret = mbedtls_md_setup(&md_ctx, md_info, 0)) != 0)
 261         return (ret);
 262     hlen = mbedtls_md_get_size(md_info);
 263
 264     if (hlen <= 32)
 265         v = 64;
 266     else
 267         v = 128;
 268
 269     memset(diversifier, (unsigned char) id, v);
 270
 271     pkcs12_fill_buffer(salt_block, v, salt, saltlen);
 272     pkcs12_fill_buffer(pwd_block,  v, pwd,  pwdlen);
 273
 274     p = data;
 275     while (datalen > 0) {
 276         // Calculate hash( diversifier || salt_block || pwd_block )
 277         if ((ret = mbedtls_md_starts(&md_ctx)) != 0)
 278             goto exit;
 279
 280         if ((ret = mbedtls_md_update(&md_ctx, diversifier, v)) != 0)
 281             goto exit;
 282
 283         if ((ret = mbedtls_md_update(&md_ctx, salt_block, v)) != 0)
 284             goto exit;
 285
 286         if ((ret = mbedtls_md_update(&md_ctx, pwd_block, v)) != 0)
 287             goto exit;
 288
 289         if ((ret = mbedtls_md_finish(&md_ctx, hash_output)) != 0)
 290             goto exit;
 291
 292         // Perform remaining ( iterations - 1 ) recursive hash calculations
 293         for (i = 1; i < (size_t) iterations; i++) {
 294             if ((ret = mbedtls_md(md_info, hash_output, hlen, hash_output)) != 0)
 295                 goto exit;
 296         }
 297
 298         use_len = (datalen > hlen) ? hlen : datalen;
 299         memcpy(p, hash_output, use_len);
 300         datalen -= use_len;
 301         p += use_len;
 302
 303         if (datalen == 0)
 304             break;
 305
 306         // Concatenating copies of hash_output into hash_block (B)
 307         pkcs12_fill_buffer(hash_block, v, hash_output, hlen);
 308
 309         // B += 1
 310         for (i = v; i > 0; i--)
 311             if (++hash_block[i - 1] != 0)
 312                 break;
 313
 314         // salt_block += B
 315         c = 0;
 316         for (i = v; i > 0; i--) {
 317             j = salt_block[i - 1] + hash_block[i - 1] + c;
 318             c = (unsigned char)(j >> 8);
 319             salt_block[i - 1] = j & 0xFF;
 320         }
 321
 322         // pwd_block  += B
 323         c = 0;
 324         for (i = v; i > 0; i--) {
 325             j = pwd_block[i - 1] + hash_block[i - 1] + c;
 326             c = (unsigned char)(j >> 8);
 327             pwd_block[i - 1] = j & 0xFF;
 328         }
 329     }
 330
 331     ret = 0;
 332
 333 exit:
 334     mbedtls_platform_zeroize(salt_block, sizeof(salt_block));
 335     mbedtls_platform_zeroize(pwd_block, sizeof(pwd_block));
 336     mbedtls_platform_zeroize(hash_block, sizeof(hash_block));
 337     mbedtls_platform_zeroize(hash_output, sizeof(hash_output));
 338
 339     mbedtls_md_free(&md_ctx);
 340
 341     return (ret);
 342 }
 343
 344 #endif /* MBEDTLS_PKCS12_C */