2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 #ifndef HEADER_PKCS12_H
60 #define HEADER_PKCS12_H
69 #define PKCS12_LIB_NAME "PKCS12 library"
71 #define PKCS12_KEY_ID 1
72 #define PKCS12_IV_ID 2
73 #define PKCS12_MAC_ID 3
75 #define PKCS12_MAC_KEY_LENGTH 20
77 #define PKCS12_SALT_LEN 8
79 /* Uncomment out next line for unicode password and names, otherwise ASCII */
81 /*#define PBE_UNICODE*/
84 #define PKCS12_key_gen PKCS12_key_gen_uni
85 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
87 #define PKCS12_key_gen PKCS12_key_gen_asc
88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
91 /* MS key usage constants */
96 /* Various ASN1 macros */
98 #ifndef M_ASN1_D2I_get_set_opt
99 #define M_ASN1_D2I_get_set_opt(r,func) \
100 if ((c.slen != 0) && (M_ASN1_next == (V_ASN1_UNIVERSAL| \
101 V_ASN1_CONSTRUCTED|V_ASN1_SET)))\
102 { M_ASN1_D2I_get_set(r,func); }
105 #ifndef M_ASN1_I2D_len_SET_opt
106 #define M_ASN1_I2D_len_SET_opt(a,f) \
107 if (a != NULL) M_ASN1_I2D_len_SET(a,f);
110 #ifndef M_ASN1_I2D_put_SET_opt
111 #define M_ASN1_I2D_put_SET_opt(a,f) \
112 if (a != NULL) M_ASN1_I2D_put_SET(a,f);
118 ASN1_OCTET_STRING *salt;
119 ASN1_INTEGER *iter; /* defaults to 1 */
123 ASN1_INTEGER *version;
124 PKCS12_MAC_DATA *mac;
129 #define PKCS8_NO_OCTET 1
134 struct pkcs12_bag_st *bag; /* secret, crl and certbag */
135 struct pkcs8_priv_key_info_st *keybag; /* keybag */
136 X509_SIG *shkeybag; /* shrouded key bag */
137 STACK /* PKCS12_SAFEBAG */ *safes;
144 typedef struct pkcs12_bag_st {
147 ASN1_OCTET_STRING *x509cert;
148 ASN1_OCTET_STRING *x509crl;
149 ASN1_OCTET_STRING *octet;
150 ASN1_IA5STRING *sdsicert;
151 ASN1_TYPE *other; /* Secret or other bag */
155 #define PKCS12_ERROR 0
158 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
159 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
160 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
162 #define M_PKCS12_x5092certbag(x509) \
163 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
165 #define M_PKCS12_x509crl2certbag(crl) \
166 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
168 #define M_PKCS12_certbag2x509(bg) \
169 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
170 (char *(*)())d2i_X509)
172 #define M_PKCS12_certbag2x509crl(bg) \
173 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
174 (char *(*)())d2i_X509CRL)
176 /*#define M_PKCS12_pkcs82rsa(p8) \
177 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
179 #define M_PKCS12_unpack_p7data(p7) \
180 ASN1_seq_unpack ((p7)->d.data->data, p7->d.data->length, \
181 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
183 #define M_PKCS12_pack_authsafes(p12, safes) \
184 ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
185 &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
187 #define M_PKCS12_unpack_authsafes(p12) \
188 ASN1_seq_unpack((p12)->authsafes->d.data->data, \
189 (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
192 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
193 (STACK *) PKCS12_decrypt_d2i ((p7)->d.encrypted->enc_data->algorithm,\
194 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
196 (p7)->d.encrypted->enc_data->enc_data, 3)
198 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
199 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
200 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
202 (bag)->value.shkeybag->digest, 2)
204 #define M_PKCS8_decrypt(p8, pass, passlen) \
205 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
206 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (pass), (passlen), (p8)->digest, 2)
208 #define PKCS12_get_attr(bag, attr_nid) \
209 PKCS12_get_attr_gen(bag->attrib, attr_nid)
211 #define PKCS8_get_attr(p8, attr_nid) \
212 PKCS12_get_attr_gen(p8->attributes, attr_nid)
214 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
216 #define M_ASN1_OBJECT_set(obj, nid) \
218 ASN1_OBJECT_free(obj); \
219 obj = OBJ_nid2obj((nid));\
223 int i2d_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO *a, unsigned char **pp);
224 PKCS8_PRIV_KEY_INFO *PKCS8_PRIV_KEY_INFO_new(void);
225 PKCS8_PRIV_KEY_INFO *d2i_PKCS8_PRIV_KEY_INFO(PKCS8_PRIV_KEY_INFO **a, unsigned char **pp, long length);
226 void PKCS8_PRIV_KEY_INFO_free(PKCS8_PRIV_KEY_INFO *a);
227 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
228 PKCS8_PRIV_KEY_INFO *PKEY2PKCS8(EVP_PKEY *pkey);
229 EVP_PKEY *PKCS82PKEY(PKCS8_PRIV_KEY_INFO *p8);
230 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
231 X509_SIG *PKCS8_encrypt(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
232 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
233 PKCS7 *PKCS12_pack_p7data(STACK *sk);
234 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, STACK *bags);
235 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
236 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
237 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
238 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
239 ASN1_TYPE *PKCS12_get_attr_gen(STACK *attrs, int attr_nid);
240 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
241 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, unsigned char *pass, int passlen, unsigned char *in, int inlen, unsigned char **data, int *datalen, int en_de);
242 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(), void (*free_func)(), unsigned char *pass, int passlen, ASN1_STRING *oct, int seq);
243 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(), unsigned char *pass, int passlen, char *obj, int seq);
244 PKCS12 *PKCS12_init(int mode);
245 X509_ALGOR *PKCS12_pbe_set(int alg, int iter, unsigned char *salt, int saltlen);
246 int PKCS12_key_gen_asc(unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int id, int iter, int n, unsigned char *out, EVP_MD *md_type);
247 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int id, int iter, int n, unsigned char *out, EVP_MD *md_type);
248 int PKCS12_PBE_keyivgen(unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, EVP_CIPHER *cipher, EVP_MD *md_type, unsigned char *key, unsigned char *iv);
249 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
250 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
251 int PKCS12_verify_mac(PKCS12 *p12, unsigned char *pass, int passlen);
252 int PKCS12_set_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, EVP_MD *md_type);
253 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, int saltlen, EVP_MD *md_type);
254 unsigned char *asc2uni(unsigned char *asc, unsigned char **uni, int *unilen);
255 char *uni2asc(unsigned char *uni, int unilen);
256 void PKCS12_add_obj_error(ASN1_OBJECT *obj);
257 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
258 PKCS12_BAGS *PKCS12_BAGS_new(void);
259 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
260 void PKCS12_BAGS_free(PKCS12_BAGS *a);
261 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
262 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
263 PKCS12 *PKCS12_new(void);
264 void PKCS12_free(PKCS12 *a);
265 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
266 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
267 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp, long length);
268 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
269 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
270 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
271 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp, long length);
272 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
273 void ERR_load_PKCS12_strings(void);
274 void ERR_PKCS12_error(int function, int reason, char *file, int line);
275 void PKCS12_add_obj(void);
276 void PKCS12_lib_init(void);
277 void PKCS12_PBE_add(void);
278 int PKCS12_parse(PKCS12 *p12, char *pass, EVP_PKEY **pkey, X509 **cert, STACK **ca);
279 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, STACK *ca, int nid_key, int nid_cert, int iter, int mac_iter, int keytype);
280 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
281 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
282 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
283 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
287 int i2d_PKCS8_PRIV_KEY_INFO();
288 PKCS8_PRIV_KEY_INFO *PKCS8_PRIV_KEY_INFO_new();
289 PKCS8_PRIV_KEY_INFO *d2i_PKCS8_PRIV_KEY_INFO();
290 void PKCS8_PRIV_KEY_INFO_free();
291 PKCS12_SAFEBAG *PKCS12_pack_safebag();
292 PKCS8_PRIV_KEY_INFO *PKEY2PKCS8();
293 EVP_PKEY *PKCS82PKEY();
294 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG();
295 X509_SIG *PKCS8_encrypt();
296 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG();
297 PKCS7 *PKCS12_pack_p7data();
298 PKCS7 *PKCS12_pack_p7encdata();
299 int PKCS12_add_localkeyid();
300 int PKCS12_add_friendlyname_asc();
301 int PKCS12_add_friendlyname_uni();
302 char *PKCS12_get_friendlyname();
303 unsigned char *PKCS12_pbe_crypt();
304 char *PKCS12_decrypt_d2i();
305 ASN1_STRING *PKCS12_i2d_encrypt();
306 PKCS12 *PKCS12_init();
307 X509_ALGOR *PKCS12_pbe_set();
308 int PKCS12_key_gen_asc();
309 int PKCS12_key_gen_uni();
310 int PKCS12_gen_mac();
311 int PKCS12_verify_mac();
312 int PKCS12_set_mac();
313 int PKCS12_setup_mac();
314 unsigned char *asc2uni();
316 void PKCS12_add_obj_error();
317 int i2d_PKCS12_BAGS();
318 PKCS12_BAGS *PKCS12_BAGS_new();
319 PKCS12_BAGS *d2i_PKCS12_BAGS();
320 void PKCS12_BAGS_free();
322 PKCS12 *d2i_PKCS12();
323 PKCS12 *PKCS12_new();
325 int i2d_PKCS12_MAC_DATA();
326 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new();
327 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA();
328 void PKCS12_MAC_DATA_free();
329 int i2d_PKCS12_SAFEBAG();
330 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new();
331 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG();
332 void PKCS12_SAFEBAG_free();
333 void ERR_load_PKCS12_strings();
334 void ERR_PKCS12_error ();
335 void PKCS12_add_obj();
336 void PKCS12_lib_init();
337 void PKCS12_PBE_add();
338 int PKCS8_add_keyusage();
339 ASN1_TYPE *PKCS12_get_attr_gen();
341 PKCS12 *PKCS12_create();
342 int i2d_PKCS12_bio();
344 PKCS12 *d2i_PKCS12_bio();
345 PKCS12 *d2i_PKCS12_fp();
349 /* BEGIN ERROR CODES */
350 /* Error codes for the PKCS12 functions. */
352 /* Function codes. */
353 #define PKCS12_F_ADD_FRIENDLYNAME 100
354 #define PKCS12_F_ADD_FRIENDLYNAME_ASC 101
355 #define PKCS12_F_ADD_FRIENDLYNAME_UNI 102
356 #define PKCS12_F_PARSE_BAGS 103
357 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104
358 #define PKCS12_F_PKCS12_CREATE 105
359 #define PKCS12_F_PKCS12_DECRYPT_D2I 106
360 #define PKCS12_F_PKCS12_GEN_MAC 107
361 #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
362 #define PKCS12_F_PKCS12_INIT 109
363 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
364 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
365 #define PKCS12_F_PKCS12_MAKE_SAFEBAG 112
366 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
367 #define PKCS12_F_PKCS12_PACK_P7DATA 114
368 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
369 #define PKCS12_F_PKCS12_PACK_P7_DATA 116
370 #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
371 #define PKCS12_F_PKCS12_PARSE 118
372 #define PKCS12_F_PKCS12_PBE_CRYPT 119
373 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
374 #define PKCS12_F_PKCS12_PKCS12_SET_MAC 121
375 #define PKCS12_F_PKCS12_SETUP_MAC 122
376 #define PKCS12_F_PKCS12_SET_MAC 123
377 #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124
378 #define PKCS12_F_PKCS8_ENCRYPT 125
379 #define PKCS12_F_VERIFY_MAC 126
382 #define PKCS12_R_CANT_PACK_STRUCTURE 100
383 #define PKCS12_R_DECODE_ERROR 101
384 #define PKCS12_R_ENCODE_ERROR 102
385 #define PKCS12_R_ENCRYPT_ERROR 103
386 #define PKCS12_R_INVALID_NULL_ARGUMENT 104
387 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
388 #define PKCS12_R_IV_GEN_ERROR 106
389 #define PKCS12_R_KEY_GEN_ERROR 107
390 #define PKCS12_R_MAC_ABSENT 108
391 #define PKCS12_R_MAC_GENERATION_ERROR 109
392 #define PKCS12_R_MAC_SETUP_ERROR 110
393 #define PKCS12_R_MAC_STRING_SET_ERROR 111
394 #define PKCS12_R_MAC_VERIFY_ERROR 112
395 #define PKCS12_R_MAC_VERIFY_FAILURE 113
396 #define PKCS12_R_PARSE_ERROR 114
397 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
398 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
399 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
400 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
401 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119