PolarSSL v1.2.9
pkcs12.c
Go to the documentation of this file.
1 /*
2  * PKCS#12 Personal Information Exchange Syntax
3  *
4  * Copyright (C) 2006-2013, 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 #include "polarssl/config.h"
33 
34 #if defined(POLARSSL_PKCS12_C)
35 
36 #include "polarssl/pkcs12.h"
37 #include "polarssl/asn1.h"
38 #include "polarssl/cipher.h"
39 
40 #if defined(POLARSSL_ARC4_C)
41 #include "polarssl/arc4.h"
42 #endif
43 
44 #if defined(POLARSSL_DES_C)
45 #include "polarssl/des.h"
46 #endif
47 
48 static int pkcs12_parse_pbe_params( unsigned char **p,
49  const unsigned char *end,
50  asn1_buf *salt, int *iterations )
51 {
52  int ret;
53  size_t len = 0;
54 
55  /*
56  * pkcs-12PbeParams ::= SEQUENCE {
57  * salt OCTET STRING,
58  * iterations INTEGER
59  * }
60  *
61  */
62  if( ( ret = asn1_get_tag( p, end, &len,
63  ASN1_CONSTRUCTED | ASN1_SEQUENCE ) ) != 0 )
64  {
66  }
67 
68  end = *p + len;
69 
70  if( ( ret = asn1_get_tag( p, end, &salt->len, ASN1_OCTET_STRING ) ) != 0 )
72 
73  salt->p = *p;
74  *p += salt->len;
75 
76  if( ( ret = asn1_get_int( p, end, iterations ) ) != 0 )
78 
79  if( *p != end )
82 
83  return( 0 );
84 }
85 
86 static int pkcs12_pbe_derive_key_iv( asn1_buf *pbe_params, md_type_t md_type,
87  const unsigned char *pwd, size_t pwdlen,
88  unsigned char *key, size_t keylen,
89  unsigned char *iv, size_t ivlen )
90 {
91  int ret, iterations;
92  asn1_buf salt;
93  size_t i;
94  unsigned char *p, *end;
95  unsigned char unipwd[258];
96 
97  memset(&salt, 0, sizeof(asn1_buf));
98  memset(&unipwd, 0, sizeof(unipwd));
99 
100  p = pbe_params->p;
101  end = p + pbe_params->len;
102 
103  if( ( ret = pkcs12_parse_pbe_params( &p, end, &salt, &iterations ) ) != 0 )
104  return( ret );
105 
106  for(i = 0; i < pwdlen; i++)
107  unipwd[i * 2 + 1] = pwd[i];
108 
109  if( ( ret = pkcs12_derivation( key, keylen, unipwd, pwdlen * 2 + 2,
110  salt.p, salt.len, md_type,
111  PKCS12_DERIVE_KEY, iterations ) ) != 0 )
112  {
113  return( ret );
114  }
115 
116  if( iv == NULL || ivlen == 0 )
117  return( 0 );
118 
119  if( ( ret = pkcs12_derivation( iv, ivlen, unipwd, pwdlen * 2 + 2,
120  salt.p, salt.len, md_type,
121  PKCS12_DERIVE_IV, iterations ) ) != 0 )
122  {
123  return( ret );
124  }
125  return( 0 );
126 }
127 
128 int pkcs12_pbe_sha1_rc4_128( asn1_buf *pbe_params, int mode,
129  const unsigned char *pwd, size_t pwdlen,
130  const unsigned char *data, size_t len,
131  unsigned char *output )
132 {
133 #if !defined(POLARSSL_ARC4_C)
134  ((void) pbe_params);
135  ((void) mode);
136  ((void) pwd);
137  ((void) pwdlen);
138  ((void) data);
139  ((void) len);
140  ((void) output);
142 #else
143  int ret;
144  unsigned char key[16];
145  arc4_context ctx;
146  ((void) mode);
147 
148  if( ( ret = pkcs12_pbe_derive_key_iv( pbe_params, POLARSSL_MD_SHA1,
149  pwd, pwdlen,
150  key, 16, NULL, 0 ) ) != 0 )
151  {
152  return( ret );
153  }
154 
155  arc4_setup( &ctx, key, 16 );
156  if( ( ret = arc4_crypt( &ctx, len, data, output ) ) != 0 )
157  return( ret );
158 
159  return( 0 );
160 #endif /* POLARSSL_ARC4_C */
161 }
162 
163 int pkcs12_pbe( asn1_buf *pbe_params, int mode,
164  cipher_type_t cipher_type, 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 {
169  int ret, keylen = 0;
170  unsigned char key[32];
171  unsigned char iv[16];
172  const cipher_info_t *cipher_info;
173  cipher_context_t cipher_ctx;
174  size_t olen = 0;
175 
176  cipher_info = cipher_info_from_type( cipher_type );
177  if( cipher_info == NULL )
179 
180  keylen = cipher_info->key_length / 8;
181 
182  if( ( ret = pkcs12_pbe_derive_key_iv( pbe_params, md_type, pwd, pwdlen,
183  key, keylen,
184  iv, cipher_info->iv_size ) ) != 0 )
185  {
186  return( ret );
187  }
188 
189  if( ( ret = cipher_init_ctx( &cipher_ctx, cipher_info ) ) != 0 )
190  return( ret );
191 
192  if( ( ret = cipher_setkey( &cipher_ctx, key, keylen, mode ) ) != 0 )
193  return( ret );
194 
195  if( ( ret = cipher_reset( &cipher_ctx, iv ) ) != 0 )
196  return( ret );
197 
198  if( ( ret = cipher_update( &cipher_ctx, data, len,
199  output, &olen ) ) != 0 )
200  {
201  return( ret );
202  }
203 
204  if( ( ret = cipher_finish( &cipher_ctx, output + olen, &olen ) ) != 0 )
206 
207  return( 0 );
208 }
209 
210 static void pkcs12_fill_buffer( unsigned char *data, size_t data_len,
211  const unsigned char *filler, size_t fill_len )
212 {
213  unsigned char *p = data;
214  size_t use_len;
215 
216  while( data_len > 0 )
217  {
218  use_len = ( data_len > fill_len ) ? fill_len : data_len;
219  memcpy( p, filler, use_len );
220  p += use_len;
221  data_len -= use_len;
222  }
223 }
224 
225 int pkcs12_derivation( unsigned char *data, size_t datalen,
226  const unsigned char *pwd, size_t pwdlen,
227  const unsigned char *salt, size_t saltlen,
228  md_type_t md_type, int id, int iterations )
229 {
230  int ret, i;
231  unsigned int j;
232 
233  unsigned char diversifier[128];
234  unsigned char salt_block[128], pwd_block[128], hash_block[128];
235  unsigned char hash_output[POLARSSL_MD_MAX_SIZE];
236  unsigned char *p;
237  unsigned char c;
238 
239  size_t hlen, use_len, v;
240 
241  const md_info_t *md_info;
242  md_context_t md_ctx;
243 
244  // This version only allows max of 64 bytes of password or salt
245  if( datalen > 128 || pwdlen > 64 || saltlen > 64 )
247 
248  md_info = md_info_from_type( md_type );
249  if( md_info == NULL )
251 
252  if ( ( ret = md_init_ctx( &md_ctx, md_info ) ) != 0 )
253  return( ret );
254  hlen = md_get_size( md_info );
255 
256  if( hlen <= 32 )
257  v = 64;
258  else
259  v = 128;
260 
261  memset( diversifier, (unsigned char) id, v );
262 
263  pkcs12_fill_buffer( salt_block, v, salt, saltlen );
264  pkcs12_fill_buffer( pwd_block, v, pwd, pwdlen );
265 
266  p = data;
267  while( datalen > 0 )
268  {
269  // Calculate hash( diversifier || salt_block || pwd_block )
270  if( ( ret = md_starts( &md_ctx ) ) != 0 )
271  return( ret );
272 
273  if( ( ret = md_update( &md_ctx, diversifier, v ) ) != 0 )
274  return( ret );
275 
276  if( ( ret = md_update( &md_ctx, salt_block, v ) ) != 0 )
277  return( ret );
278 
279  if( ( ret = md_update( &md_ctx, pwd_block, v ) ) != 0 )
280  return( ret );
281 
282  if( ( ret = md_finish( &md_ctx, hash_output ) ) != 0 )
283  return( ret );
284 
285  // Perform remaining ( iterations - 1 ) recursive hash calculations
286  for( i = 1; i < iterations; i++ )
287  {
288  if( ( ret = md( md_info, hash_output, hlen, hash_output ) ) != 0 )
289  return( ret );
290  }
291 
292  use_len = ( datalen > hlen ) ? hlen : datalen;
293  memcpy( p, hash_output, use_len );
294  datalen -= use_len;
295  p += use_len;
296 
297  if( datalen == 0 )
298  break;
299 
300  // Concatenating copies of hash_output into hash_block (B)
301  pkcs12_fill_buffer( hash_block, v, hash_output, hlen );
302 
303  // B += 1
304  for( i = v; i > 0; i-- )
305  if( ++hash_block[i - 1] != 0 )
306  break;
307 
308  // salt_block += B
309  c = 0;
310  for( i = v; i > 0; i-- )
311  {
312  j = salt_block[i - 1] + hash_block[i - 1] + c;
313  c = (unsigned char) (j >> 8);
314  salt_block[i - 1] = j & 0xFF;
315  }
316 
317  // pwd_block += B
318  c = 0;
319  for( i = v; i > 0; i-- )
320  {
321  j = pwd_block[i - 1] + hash_block[i - 1] + c;
322  c = (unsigned char) (j >> 8);
323  pwd_block[i - 1] = j & 0xFF;
324  }
325  }
326 
327  return( 0 );
328 }
329 
330 #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:181
int arc4_crypt(arc4_context *ctx, size_t length, const unsigned char *input, unsigned char *output)
ARC4 cipher function.
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:53
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&#39;s...
int md_starts(md_context_t *ctx)
Set-up the given context for a new message digest.
Cipher information.
Definition: cipher.h:153
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:78
Configuration options (set of defines)
#define ASN1_CONSTRUCTED
Definition: asn1.h:88
static unsigned char md_get_size(const md_info_t *md_info)
Returns the size of the message digest output.
Definition: md.h:199
#define POLARSSL_ERR_PKCS12_PBE_INVALID_FORMAT
PBE ASN.1 data not as expected.
Definition: pkcs12.h:38
md_type_t
Definition: md.h:47
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.
cipher_type_t
Definition: cipher.h:59
unsigned int key_length
Cipher key length, in bits (default length for variable sized ciphers) (Includes parity bits for ciph...
Definition: cipher.h:162
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:112
#define PKCS12_DERIVE_IV
Definition: pkcs12.h:42
Generic cipher wrapper.
int cipher_reset(cipher_context_t *ctx, const unsigned char *iv)
Reset the given context, setting the IV to iv.
DES block cipher.
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:108
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:111
#define POLARSSL_MD_MAX_SIZE
Definition: md.h:59
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:41
#define PKCS12_DERIVE_KEY
Definition: pkcs12.h:41
#define ASN1_OCTET_STRING
Definition: asn1.h:74
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:65
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
unsigned int iv_size
IV size, in bytes.
Definition: cipher.h:168
PKCS#12 Personal Information Exchange Syntax.
Generic message digest context.
Definition: md.h:119