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_KEY_ID 1
70 #define PKCS12_IV_ID 2
71 #define PKCS12_MAC_ID 3
73 #define PKCS12_MAC_KEY_LENGTH 20
75 #define PKCS12_SALT_LEN 8
77 /* Uncomment out next line for unicode password and names, otherwise ASCII */
79 /*#define PBE_UNICODE*/
82 #define PKCS12_key_gen PKCS12_key_gen_uni
83 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
85 #define PKCS12_key_gen PKCS12_key_gen_asc
86 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
89 /* MS key usage constants */
96 ASN1_OCTET_STRING *salt;
97 ASN1_INTEGER *iter; /* defaults to 1 */
101 ASN1_INTEGER *version;
102 PKCS12_MAC_DATA *mac;
109 struct pkcs12_bag_st *bag; /* secret, crl and certbag */
110 struct pkcs8_priv_key_info_st *keybag; /* keybag */
111 X509_SIG *shkeybag; /* shrouded key bag */
112 STACK /* PKCS12_SAFEBAG */ *safes;
119 typedef struct pkcs12_bag_st {
122 ASN1_OCTET_STRING *x509cert;
123 ASN1_OCTET_STRING *x509crl;
124 ASN1_OCTET_STRING *octet;
125 ASN1_IA5STRING *sdsicert;
126 ASN1_TYPE *other; /* Secret or other bag */
130 #define PKCS12_ERROR 0
133 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
134 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
135 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
137 #define M_PKCS12_x5092certbag(x509) \
138 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
140 #define M_PKCS12_x509crl2certbag(crl) \
141 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
143 #define M_PKCS12_certbag2x509(bg) \
144 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
145 (char *(*)())d2i_X509)
147 #define M_PKCS12_certbag2x509crl(bg) \
148 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
149 (char *(*)())d2i_X509CRL)
151 /*#define M_PKCS12_pkcs82rsa(p8) \
152 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
154 #define M_PKCS12_unpack_p7data(p7) \
155 ASN1_seq_unpack ((p7)->d.data->data, p7->d.data->length, \
156 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
158 #define M_PKCS12_pack_authsafes(p12, safes) \
159 ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
160 &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
162 #define M_PKCS12_unpack_authsafes(p12) \
163 ASN1_seq_unpack((p12)->authsafes->d.data->data, \
164 (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
167 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
168 (STACK *) PKCS12_decrypt_d2i ((p7)->d.encrypted->enc_data->algorithm,\
169 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
171 (p7)->d.encrypted->enc_data->enc_data, 3)
173 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
174 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
175 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
177 (bag)->value.shkeybag->digest, 2)
179 #define M_PKCS8_decrypt(p8, pass, passlen) \
180 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
181 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (pass), (passlen), (p8)->digest, 2)
183 #define PKCS12_get_attr(bag, attr_nid) \
184 PKCS12_get_attr_gen(bag->attrib, attr_nid)
186 #define PKCS8_get_attr(p8, attr_nid) \
187 PKCS12_get_attr_gen(p8->attributes, attr_nid)
189 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
193 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
194 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
195 X509_SIG *PKCS8_encrypt(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
196 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);
197 PKCS7 *PKCS12_pack_p7data(STACK *sk);
198 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, STACK *bags);
199 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
200 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
201 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
202 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
203 ASN1_TYPE *PKCS12_get_attr_gen(STACK *attrs, int attr_nid);
204 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
205 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);
206 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(), void (*free_func)(), unsigned char *pass, int passlen, ASN1_STRING *oct, int seq);
207 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(), unsigned char *pass, int passlen, char *obj, int seq);
208 PKCS12 *PKCS12_init(int mode);
209 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);
210 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);
211 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);
212 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
213 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
214 int PKCS12_verify_mac(PKCS12 *p12, unsigned char *pass, int passlen);
215 int PKCS12_set_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, EVP_MD *md_type);
216 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, int saltlen, EVP_MD *md_type);
217 unsigned char *asc2uni(unsigned char *asc, unsigned char **uni, int *unilen);
218 char *uni2asc(unsigned char *uni, int unilen);
219 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
220 PKCS12_BAGS *PKCS12_BAGS_new(void);
221 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
222 void PKCS12_BAGS_free(PKCS12_BAGS *a);
223 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
224 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
225 PKCS12 *PKCS12_new(void);
226 void PKCS12_free(PKCS12 *a);
227 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
228 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
229 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp, long length);
230 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
231 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
232 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
233 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp, long length);
234 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
235 void ERR_load_PKCS12_strings(void);
236 void PKCS12_PBE_add(void);
237 int PKCS12_parse(PKCS12 *p12, char *pass, EVP_PKEY **pkey, X509 **cert, STACK **ca);
238 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);
239 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
240 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
241 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
242 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
246 PKCS12_SAFEBAG *PKCS12_pack_safebag();
247 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG();
248 X509_SIG *PKCS8_encrypt();
249 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG();
250 PKCS7 *PKCS12_pack_p7data();
251 PKCS7 *PKCS12_pack_p7encdata();
252 int PKCS12_add_localkeyid();
253 int PKCS12_add_friendlyname_asc();
254 int PKCS12_add_friendlyname_uni();
255 char *PKCS12_get_friendlyname();
256 unsigned char *PKCS12_pbe_crypt();
257 char *PKCS12_decrypt_d2i();
258 ASN1_STRING *PKCS12_i2d_encrypt();
259 PKCS12 *PKCS12_init();
260 int PKCS12_key_gen_asc();
261 int PKCS12_key_gen_uni();
262 int PKCS12_gen_mac();
263 int PKCS12_verify_mac();
264 int PKCS12_set_mac();
265 int PKCS12_setup_mac();
266 unsigned char *asc2uni();
268 int i2d_PKCS12_BAGS();
269 PKCS12_BAGS *PKCS12_BAGS_new();
270 PKCS12_BAGS *d2i_PKCS12_BAGS();
271 void PKCS12_BAGS_free();
273 PKCS12 *d2i_PKCS12();
274 PKCS12 *PKCS12_new();
276 int i2d_PKCS12_MAC_DATA();
277 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new();
278 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA();
279 void PKCS12_MAC_DATA_free();
280 int i2d_PKCS12_SAFEBAG();
281 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new();
282 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG();
283 void PKCS12_SAFEBAG_free();
284 void ERR_load_PKCS12_strings();
285 void PKCS12_PBE_add();
286 int PKCS8_add_keyusage();
287 ASN1_TYPE *PKCS12_get_attr_gen();
289 PKCS12 *PKCS12_create();
290 int i2d_PKCS12_bio();
292 PKCS12 *d2i_PKCS12_bio();
293 PKCS12 *d2i_PKCS12_fp();
297 /* BEGIN ERROR CODES */
298 /* Error codes for the PKCS12 functions. */
300 /* Function codes. */
301 #define PKCS12_F_ADD_FRIENDLYNAME 100
302 #define PKCS12_F_ADD_FRIENDLYNAME_ASC 101
303 #define PKCS12_F_ADD_FRIENDLYNAME_UNI 102
304 #define PKCS12_F_PARSE_BAGS 103
305 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104
306 #define PKCS12_F_PKCS12_CREATE 105
307 #define PKCS12_F_PKCS12_DECRYPT_D2I 106
308 #define PKCS12_F_PKCS12_GEN_MAC 107
309 #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
310 #define PKCS12_F_PKCS12_INIT 109
311 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
312 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
313 #define PKCS12_F_PKCS12_MAKE_SAFEBAG 112
314 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
315 #define PKCS12_F_PKCS12_PACK_P7DATA 114
316 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
317 #define PKCS12_F_PKCS12_PACK_P7_DATA 116
318 #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
319 #define PKCS12_F_PKCS12_PARSE 118
320 #define PKCS12_F_PKCS12_PBE_CRYPT 119
321 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
322 #define PKCS12_F_PKCS12_PKCS12_SET_MAC 121
323 #define PKCS12_F_PKCS12_SETUP_MAC 122
324 #define PKCS12_F_PKCS12_SET_MAC 123
325 #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124
326 #define PKCS12_F_PKCS8_ENCRYPT 125
327 #define PKCS12_F_VERIFY_MAC 126
330 #define PKCS12_R_CANT_PACK_STRUCTURE 100
331 #define PKCS12_R_DECODE_ERROR 101
332 #define PKCS12_R_ENCODE_ERROR 102
333 #define PKCS12_R_ENCRYPT_ERROR 103
334 #define PKCS12_R_INVALID_NULL_ARGUMENT 104
335 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
336 #define PKCS12_R_IV_GEN_ERROR 106
337 #define PKCS12_R_KEY_GEN_ERROR 107
338 #define PKCS12_R_MAC_ABSENT 108
339 #define PKCS12_R_MAC_GENERATION_ERROR 109
340 #define PKCS12_R_MAC_SETUP_ERROR 110
341 #define PKCS12_R_MAC_STRING_SET_ERROR 111
342 #define PKCS12_R_MAC_VERIFY_ERROR 112
343 #define PKCS12_R_MAC_VERIFY_FAILURE 113
344 #define PKCS12_R_PARSE_ERROR 114
345 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
346 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
347 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
348 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
349 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119