PolarSSL v1.3.9
pkcs12.c
Go to the documentation of this file.
1 /*
2  * PKCS#12 Personal Information Exchange Syntax
3  *
4  * Copyright (C) 2006-2014, Brainspark B.V.
5  *
6  * This file is part of PolarSSL (http://www.polarssl.org)
7  * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
8  *
9  * All rights reserved.
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License along
22  * with this program; if not, write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24  */
25 /*
26  * The PKCS #12 Personal Information Exchange Syntax Standard v1.1
27  *
28  * http://www.rsa.com/rsalabs/pkcs/files/h11301-wp-pkcs-12v1-1-personal-information-exchange-syntax.pdf
29  * ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-12/pkcs-12v1-1.asn
30  */
31 
32 #if !defined(POLARSSL_CONFIG_FILE)
33 #include "polarssl/config.h"
34 #else
35 #include POLARSSL_CONFIG_FILE
36 #endif
37 
38 #if defined(POLARSSL_PKCS12_C)
39 
40 #include "polarssl/pkcs12.h"
41 #include "polarssl/asn1.h"
42 #include "polarssl/cipher.h"
43 
44 #if defined(POLARSSL_ARC4_C)
45 #include "polarssl/arc4.h"
46 #endif
47 
48 #if defined(POLARSSL_DES_C)
49 #include "polarssl/des.h"
50 #endif
51 
52 /* Implementation that should never be optimized out by the compiler */
53 static void polarssl_zeroize( void *v, size_t n ) {
54  volatile unsigned char *p = v; while( n-- ) *p++ = 0;
55 }
56 
57 static int pkcs12_parse_pbe_params( asn1_buf *params,
58  asn1_buf *salt, int *iterations )
59 {
60  int ret;
61  unsigned char **p = &params->p;
62  const unsigned char *end = params->p + params->len;
63 
64  /*
65  * pkcs-12PbeParams ::= SEQUENCE {
66  * salt OCTET STRING,
67  * iterations INTEGER
68  * }
69  *
70  */
71  if( params->tag != ( ASN1_CONSTRUCTED | ASN1_SEQUENCE ) )
74 
75  if( ( ret = asn1_get_tag( p, end, &salt->len, ASN1_OCTET_STRING ) ) != 0 )
77 
78  salt->p = *p;
79  *p += salt->len;
80 
81  if( ( ret = asn1_get_int( p, end, iterations ) ) != 0 )
83 
84  if( *p != end )
87 
88  return( 0 );
89 }
90 
91 static int pkcs12_pbe_derive_key_iv( asn1_buf *pbe_params, md_type_t md_type,
92  const unsigned char *pwd, size_t pwdlen,
93  unsigned char *key, size_t keylen,
94  unsigned char *iv, size_t ivlen )
95 {
96  int ret, iterations;
97  asn1_buf salt;
98  size_t i;
99  unsigned char unipwd[258];
100 
101  memset( &salt, 0, sizeof(asn1_buf) );
102  memset( &unipwd, 0, sizeof(unipwd) );
103 
104  if( ( ret = pkcs12_parse_pbe_params( pbe_params, &salt,
105  &iterations ) ) != 0 )
106  return( ret );
107 
108  for( i = 0; i < pwdlen; i++ )
109  unipwd[i * 2 + 1] = pwd[i];
110 
111  if( ( ret = pkcs12_derivation( key, keylen, unipwd, pwdlen * 2 + 2,
112  salt.p, salt.len, md_type,
113  PKCS12_DERIVE_KEY, iterations ) ) != 0 )
114  {
115  return( ret );
116  }
117 
118  if( iv == NULL || ivlen == 0 )
119  return( 0 );
120 
121  if( ( ret = pkcs12_derivation( iv, ivlen, unipwd, pwdlen * 2 + 2,
122  salt.p, salt.len, md_type,
123  PKCS12_DERIVE_IV, iterations ) ) != 0 )
124  {
125  return( ret );
126  }
127  return( 0 );
128 }
129 
130 int pkcs12_pbe_sha1_rc4_128( asn1_buf *pbe_params, int mode,
131  const unsigned char *pwd, size_t pwdlen,
132  const unsigned char *data, size_t len,
133  unsigned char *output )
134 {
135 #if !defined(POLARSSL_ARC4_C)
136  ((void) pbe_params);
137  ((void) mode);
138  ((void) pwd);
139  ((void) pwdlen);
140  ((void) data);
141  ((void) len);
142  ((void) output);
144 #else
145  int ret;
146  unsigned char key[16];
147  arc4_context ctx;
148  ((void) mode);
149 
150  arc4_init( &ctx );
151 
152  if( ( ret = pkcs12_pbe_derive_key_iv( pbe_params, POLARSSL_MD_SHA1,
153  pwd, pwdlen,
154  key, 16, NULL, 0 ) ) != 0 )
155  {
156  return( ret );
157  }
158 
159  arc4_setup( &ctx, key, 16 );
160  if( ( ret = arc4_crypt( &ctx, len, data, output ) ) != 0 )
161  goto exit;
162 
163 exit:
164  polarssl_zeroize( key, sizeof( key ) );
165  arc4_free( &ctx );
166 
167  return( ret );
168 #endif /* POLARSSL_ARC4_C */
169 }
170 
171 int pkcs12_pbe( asn1_buf *pbe_params, int mode,
172  cipher_type_t cipher_type, md_type_t md_type,
173  const unsigned char *pwd, size_t pwdlen,
174  const unsigned char *data, size_t len,
175  unsigned char *output )
176 {
177  int ret, keylen = 0;
178  unsigned char key[32];
179  unsigned char iv[16];
180  const cipher_info_t *cipher_info;
181  cipher_context_t cipher_ctx;
182  size_t olen = 0;
183 
184  cipher_info = cipher_info_from_type( cipher_type );
185  if( cipher_info == NULL )
187 
188  keylen = cipher_info->key_length / 8;
189 
190  if( ( ret = pkcs12_pbe_derive_key_iv( pbe_params, md_type, pwd, pwdlen,
191  key, keylen,
192  iv, cipher_info->iv_size ) ) != 0 )
193  {
194  return( ret );
195  }
196 
197  cipher_init( &cipher_ctx );
198 
199  if( ( ret = cipher_init_ctx( &cipher_ctx, cipher_info ) ) != 0 )
200  goto exit;
201 
202  if( ( ret = cipher_setkey( &cipher_ctx, key, 8 * keylen, mode ) ) != 0 )
203  goto exit;
204 
205  if( ( ret = cipher_set_iv( &cipher_ctx, iv, cipher_info->iv_size ) ) != 0 )
206  goto exit;
207 
208  if( ( ret = cipher_reset( &cipher_ctx ) ) != 0 )
209  goto exit;
210 
211  if( ( ret = cipher_update( &cipher_ctx, data, len,
212  output, &olen ) ) != 0 )
213  {
214  goto exit;
215  }
216 
217  if( ( ret = cipher_finish( &cipher_ctx, output + olen, &olen ) ) != 0 )
219 
220 exit:
221  polarssl_zeroize( key, sizeof( key ) );
222  polarssl_zeroize( iv, sizeof( iv ) );
223  cipher_free( &cipher_ctx );
224 
225  return( ret );
226 }
227 
228 static void pkcs12_fill_buffer( unsigned char *data, size_t data_len,
229  const unsigned char *filler, size_t fill_len )
230 {
231  unsigned char *p = data;
232  size_t use_len;
233 
234  while( data_len > 0 )
235  {
236  use_len = ( data_len > fill_len ) ? fill_len : data_len;
237  memcpy( p, filler, use_len );
238  p += use_len;
239  data_len -= use_len;
240  }
241 }
242 
243 int pkcs12_derivation( unsigned char *data, size_t datalen,
244  const unsigned char *pwd, size_t pwdlen,
245  const unsigned char *salt, size_t saltlen,
246  md_type_t md_type, int id, int iterations )
247 {
248  int ret;
249  unsigned int j;
250 
251  unsigned char diversifier[128];
252  unsigned char salt_block[128], pwd_block[128], hash_block[128];
253  unsigned char hash_output[POLARSSL_MD_MAX_SIZE];
254  unsigned char *p;
255  unsigned char c;
256 
257  size_t hlen, use_len, v, i;
258 
259  const md_info_t *md_info;
260  md_context_t md_ctx;
261 
262  // This version only allows max of 64 bytes of password or salt
263  if( datalen > 128 || pwdlen > 64 || saltlen > 64 )
265 
266  md_info = md_info_from_type( md_type );
267  if( md_info == NULL )
269 
270  md_init( &md_ctx );
271 
272  if( ( ret = md_init_ctx( &md_ctx, md_info ) ) != 0 )
273  return( ret );
274  hlen = md_get_size( md_info );
275 
276  if( hlen <= 32 )
277  v = 64;
278  else
279  v = 128;
280 
281  memset( diversifier, (unsigned char) id, v );
282 
283  pkcs12_fill_buffer( salt_block, v, salt, saltlen );
284  pkcs12_fill_buffer( pwd_block, v, pwd, pwdlen );
285 
286  p = data;
287  while( datalen > 0 )
288  {
289  // Calculate hash( diversifier || salt_block || pwd_block )
290  if( ( ret = md_starts( &md_ctx ) ) != 0 )
291  goto exit;
292 
293  if( ( ret = md_update( &md_ctx, diversifier, v ) ) != 0 )
294  goto exit;
295 
296  if( ( ret = md_update( &md_ctx, salt_block, v ) ) != 0 )
297  goto exit;
298 
299  if( ( ret = md_update( &md_ctx, pwd_block, v ) ) != 0 )
300  goto exit;
301 
302  if( ( ret = md_finish( &md_ctx, hash_output ) ) != 0 )
303  goto exit;
304 
305  // Perform remaining ( iterations - 1 ) recursive hash calculations
306  for( i = 1; i < (size_t) iterations; i++ )
307  {
308  if( ( ret = md( md_info, hash_output, hlen, hash_output ) ) != 0 )
309  goto exit;
310  }
311 
312  use_len = ( datalen > hlen ) ? hlen : datalen;
313  memcpy( p, hash_output, use_len );
314  datalen -= use_len;
315  p += use_len;
316 
317  if( datalen == 0 )
318  break;
319 
320  // Concatenating copies of hash_output into hash_block (B)
321  pkcs12_fill_buffer( hash_block, v, hash_output, hlen );
322 
323  // B += 1
324  for( i = v; i > 0; i-- )
325  if( ++hash_block[i - 1] != 0 )
326  break;
327 
328  // salt_block += B
329  c = 0;
330  for( i = v; i > 0; i-- )
331  {
332  j = salt_block[i - 1] + hash_block[i - 1] + c;
333  c = (unsigned char) (j >> 8);
334  salt_block[i - 1] = j & 0xFF;
335  }
336 
337  // pwd_block += B
338  c = 0;
339  for( i = v; i > 0; i-- )
340  {
341  j = pwd_block[i - 1] + hash_block[i - 1] + c;
342  c = (unsigned char) (j >> 8);
343  pwd_block[i - 1] = j & 0xFF;
344  }
345  }
346 
347  ret = 0;
348 
349 exit:
350  polarssl_zeroize( salt_block, sizeof( salt_block ) );
351  polarssl_zeroize( pwd_block, sizeof( pwd_block ) );
352  polarssl_zeroize( hash_block, sizeof( hash_block ) );
353  polarssl_zeroize( hash_output, sizeof( hash_output ) );
354 
355  md_free( &md_ctx );
356 
357  return( ret );
358 }
359 
360 #endif /* POLARSSL_PKCS12_C */
#define POLARSSL_ERR_PKCS12_FEATURE_UNAVAILABLE
Feature not available, e.g.
Definition: pkcs12.h:37
int md(const md_info_t *md_info, const unsigned char *input, size_t ilen, unsigned char *output)
Output = message_digest( input buffer )
int cipher_finish(cipher_context_t *ctx, unsigned char *output, size_t *olen)
Generic cipher finalisation function.
Generic cipher context.
Definition: cipher.h:258
int arc4_crypt(arc4_context *ctx, size_t length, const unsigned char *input, unsigned char *output)
ARC4 cipher function.
void arc4_init(arc4_context *ctx)
Initialize ARC4 context.
void arc4_setup(arc4_context *ctx, const unsigned char *key, unsigned int keylen)
ARC4 key schedule.
#define POLARSSL_ERR_ASN1_LENGTH_MISMATCH
Actual length differs from expected length.
Definition: asn1.h:57
int pkcs12_pbe(asn1_buf *pbe_params, int mode, cipher_type_t cipher_type, md_type_t md_type, const unsigned char *pwd, size_t pwdlen, const unsigned char *input, size_t len, unsigned char *output)
PKCS12 Password Based function (encryption / decryption) for cipher-based and md-based PBE's...
void cipher_init(cipher_context_t *ctx)
Initialize a cipher_context (as NONE)
int md_starts(md_context_t *ctx)
Set-up the given context for a new message digest.
void md_init(md_context_t *ctx)
Initialize a md_context (as NONE)
Cipher information.
Definition: cipher.h:226
const cipher_info_t * cipher_info_from_type(const cipher_type_t cipher_type)
Returns the cipher information structure associated with the given cipher type.
int asn1_get_int(unsigned char **p, const unsigned char *end, int *val)
Retrieve an integer ASN.1 tag and its value.
int md_init_ctx(md_context_t *ctx, const md_info_t *md_info)
Initialises and fills the message digest context structure with the appropriate values.
#define POLARSSL_ERR_PKCS12_PASSWORD_MISMATCH
Given private key password does not allow for correct decryption.
Definition: pkcs12.h:39
#define ASN1_SEQUENCE
Definition: asn1.h:82
Configuration options (set of defines)
#define ASN1_CONSTRUCTED
Definition: asn1.h:92
static unsigned char md_get_size(const md_info_t *md_info)
Returns the size of the message digest output.
Definition: md.h:225
#define POLARSSL_ERR_PKCS12_PBE_INVALID_FORMAT
PBE ASN.1 data not as expected.
Definition: pkcs12.h:38
void arc4_free(arc4_context *ctx)
Clear ARC4 context.
md_type_t
Definition: md.h:51
const md_info_t * md_info_from_type(md_type_t md_type)
Returns the message digest information associated with the given digest type.
Generic ASN.1 parsing.
void md_free(md_context_t *ctx)
Free and clear the message-specific context of ctx.
cipher_type_t
Definition: cipher.h:82
unsigned int key_length
Cipher key length, in bits (default length for variable sized ciphers) (Includes parity bits for ciph...
Definition: cipher.h:235
int cipher_set_iv(cipher_context_t *ctx, const unsigned char *iv, size_t iv_len)
Set the initialization vector (IV) or nonce.
int cipher_update(cipher_context_t *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
Generic cipher update function.
int pkcs12_derivation(unsigned char *data, size_t datalen, const unsigned char *pwd, size_t pwdlen, const unsigned char *salt, size_t saltlen, md_type_t md, int id, int iterations)
The PKCS#12 derivation function uses a password and a salt to produce pseudo-random bits for a partic...
unsigned char * p
ASN1 data, e.g.
Definition: asn1.h:128
#define PKCS12_DERIVE_IV
initialization vector
Definition: pkcs12.h:42
Generic cipher wrapper.
int tag
ASN1 type, e.g.
Definition: asn1.h:126
int cipher_reset(cipher_context_t *ctx)
Finish preparation of the given context.
DES block cipher.
void cipher_free(cipher_context_t *ctx)
Free and clear the cipher-specific context of ctx.
int cipher_init_ctx(cipher_context_t *ctx, const cipher_info_t *cipher_info)
Initialises and fills the cipher context structure with the appropriate values.
int cipher_setkey(cipher_context_t *ctx, const unsigned char *key, int key_length, const operation_t operation)
Set the key to use with the given context.
Type-length-value structure that allows for ASN1 using DER.
Definition: asn1.h:124
int pkcs12_pbe_sha1_rc4_128(asn1_buf *pbe_params, int mode, const unsigned char *pwd, size_t pwdlen, const unsigned char *input, size_t len, unsigned char *output)
PKCS12 Password Based function (encryption / decryption) for pbeWithSHAAnd128BitRC4.
size_t len
ASN1 length, e.g.
Definition: asn1.h:127
#define POLARSSL_MD_MAX_SIZE
Definition: md.h:67
int asn1_get_tag(unsigned char **p, const unsigned char *end, size_t *len, int tag)
Get the tag and length of the tag.
ARC4 context structure.
Definition: arc4.h:49
#define PKCS12_DERIVE_KEY
encryption/decryption key
Definition: pkcs12.h:41
#define ASN1_OCTET_STRING
Definition: asn1.h:78
int md_finish(md_context_t *ctx, unsigned char *output)
Generic message digest final digest.
The ARCFOUR stream cipher.
Message digest information.
Definition: md.h:74
int md_update(md_context_t *ctx, const unsigned char *input, size_t ilen)
Generic message digest process buffer.
#define POLARSSL_ERR_PKCS12_BAD_INPUT_DATA
Bad input parameters to function.
Definition: pkcs12.h:36
#define POLARSSL_ERR_ASN1_UNEXPECTED_TAG
ASN1 tag was of an unexpected value.
Definition: asn1.h:55
unsigned int iv_size
IV/NONCE size, in bytes.
Definition: cipher.h:242
PKCS#12 Personal Information Exchange Syntax.
Generic message digest context.
Definition: md.h:132