1f03e2b0846883eff768d4e18ba64956d0dbf440
[openssl.git] / crypto / pkcs12 / pkcs12.h
1 /* pkcs12.h */
2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58
59 #ifndef HEADER_PKCS12_H
60 #define HEADER_PKCS12_H
61
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65
66 #include "bio.h"
67 #include "x509.h"
68
69 #define PKCS12_KEY_ID   1
70 #define PKCS12_IV_ID    2
71 #define PKCS12_MAC_ID   3
72
73 #define PKCS12_MAC_KEY_LENGTH 20
74
75 #define PKCS12_SALT_LEN 8
76
77 /* Uncomment out next line for unicode password and names, otherwise ASCII */
78
79 /*#define PBE_UNICODE*/
80
81 #ifdef PBE_UNICODE
82 #define PKCS12_key_gen PKCS12_key_gen_uni
83 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
84 #else
85 #define PKCS12_key_gen PKCS12_key_gen_asc
86 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
87 #endif
88
89 /* MS key usage constants */
90
91 #define KEY_EX  0x10
92 #define KEY_SIG 0x80
93
94 typedef struct {
95 X509_SIG *dinfo;
96 ASN1_OCTET_STRING *salt;
97 ASN1_INTEGER *iter;     /* defaults to 1 */
98 } PKCS12_MAC_DATA;
99
100 typedef struct {
101 ASN1_INTEGER *version;
102 PKCS12_MAC_DATA *mac;
103 PKCS7 *authsafes;
104 } PKCS12;
105
106 typedef struct {
107 ASN1_OBJECT *type;
108 union {
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;
113         ASN1_TYPE *other;
114 }value;
115 STACK *attrib;
116 ASN1_TYPE *rest;
117 } PKCS12_SAFEBAG;
118
119 typedef struct pkcs12_bag_st {
120 ASN1_OBJECT *type;
121 union {
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 */
127 }value;
128 } PKCS12_BAGS;
129
130 #define PKCS12_ERROR    0
131 #define PKCS12_OK       1
132
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
136
137 #define M_PKCS12_x5092certbag(x509) \
138 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
139
140 #define M_PKCS12_x509crl2certbag(crl) \
141 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
142
143 #define M_PKCS12_certbag2x509(bg) \
144 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
145 (char *(*)())d2i_X509)
146
147 #define M_PKCS12_certbag2x509crl(bg) \
148 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
149 (char *(*)())d2i_X509CRL)
150
151 /*#define M_PKCS12_pkcs82rsa(p8) \
152 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
153
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)
157
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)
161
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, \
165                                                         PKCS7_free)
166
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, \
170                                                         (pass), (passlen), \
171                         (p7)->d.encrypted->enc_data->enc_data, 3)
172
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, \
176                                                 (pass), (passlen), \
177                          (bag)->value.shkeybag->digest, 2)
178
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)
182
183 #define PKCS12_get_attr(bag, attr_nid) \
184                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
185
186 #define PKCS8_get_attr(p8, attr_nid) \
187                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
188
189 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
190
191 #define M_ASN1_OBJECT_set(obj, nid) \
192 {\
193 ASN1_OBJECT_free(obj); \
194 obj = OBJ_nid2obj((nid));\
195 }
196
197 #ifndef NOPROTO
198 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
199 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
200 X509_SIG *PKCS8_encrypt(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
201 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);
202 PKCS7 *PKCS12_pack_p7data(STACK *sk);
203 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, STACK *bags);
204 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
205 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
206 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
207 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
208 ASN1_TYPE *PKCS12_get_attr_gen(STACK *attrs, int attr_nid);
209 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
210 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);
211 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(), void (*free_func)(), unsigned char *pass, int passlen, ASN1_STRING *oct, int seq);
212 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(), unsigned char *pass, int passlen, char *obj, int seq);
213 PKCS12 *PKCS12_init(int mode);
214 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);
215 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);
216 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);
217 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
218 int PKCS12_gen_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
219 int PKCS12_verify_mac(PKCS12 *p12, unsigned char *pass, int passlen);
220 int PKCS12_set_mac(PKCS12 *p12, unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int iter, EVP_MD *md_type);
221 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, int saltlen, EVP_MD *md_type);
222 unsigned char *asc2uni(unsigned char *asc, unsigned char **uni, int *unilen);
223 char *uni2asc(unsigned char *uni, int unilen);
224 void PKCS12_add_obj_error(ASN1_OBJECT *obj);
225 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
226 PKCS12_BAGS *PKCS12_BAGS_new(void);
227 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
228 void PKCS12_BAGS_free(PKCS12_BAGS *a);
229 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
230 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
231 PKCS12 *PKCS12_new(void);
232 void PKCS12_free(PKCS12 *a);
233 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
234 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
235 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp, long length);
236 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
237 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
238 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
239 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp, long length);
240 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
241 void ERR_load_PKCS12_strings(void);
242 void ERR_PKCS12_error(int function, int reason, char *file, int line);
243 void PKCS12_add_obj(void);
244 void PKCS12_PBE_add(void);
245 int PKCS12_parse(PKCS12 *p12, char *pass, EVP_PKEY **pkey, X509 **cert, STACK **ca);
246 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);
247 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
248 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
249 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
250 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
251
252 #else
253
254 PKCS12_SAFEBAG *PKCS12_pack_safebag();
255 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG();
256 X509_SIG *PKCS8_encrypt();
257 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG();
258 PKCS7 *PKCS12_pack_p7data();
259 PKCS7 *PKCS12_pack_p7encdata();
260 int PKCS12_add_localkeyid();
261 int PKCS12_add_friendlyname_asc();
262 int PKCS12_add_friendlyname_uni();
263 char *PKCS12_get_friendlyname();
264 unsigned char *PKCS12_pbe_crypt();
265 char *PKCS12_decrypt_d2i();
266 ASN1_STRING *PKCS12_i2d_encrypt();
267 PKCS12 *PKCS12_init();
268 int PKCS12_key_gen_asc();
269 int PKCS12_key_gen_uni();
270 int PKCS12_gen_mac();
271 int PKCS12_verify_mac();
272 int PKCS12_set_mac();
273 int PKCS12_setup_mac();
274 unsigned char *asc2uni();
275 char *uni2asc();
276 void PKCS12_add_obj_error();
277 int i2d_PKCS12_BAGS();
278 PKCS12_BAGS *PKCS12_BAGS_new();
279 PKCS12_BAGS *d2i_PKCS12_BAGS();
280 void PKCS12_BAGS_free();
281 int i2d_PKCS12();
282 PKCS12 *d2i_PKCS12();
283 PKCS12 *PKCS12_new();
284 void PKCS12_free();
285 int i2d_PKCS12_MAC_DATA();
286 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new();
287 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA();
288 void PKCS12_MAC_DATA_free();
289 int i2d_PKCS12_SAFEBAG();
290 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new();
291 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG();
292 void PKCS12_SAFEBAG_free();
293 void ERR_load_PKCS12_strings();
294 void ERR_PKCS12_error ();
295 void PKCS12_add_obj();
296 void PKCS12_PBE_add();
297 int PKCS8_add_keyusage();
298 ASN1_TYPE *PKCS12_get_attr_gen();
299 int PKCS12_parse();
300 PKCS12 *PKCS12_create();
301 int i2d_PKCS12_bio();
302 int i2d_PKCS12_fp();
303 PKCS12 *d2i_PKCS12_bio();
304 PKCS12 *d2i_PKCS12_fp();
305
306 #endif
307
308 /* BEGIN ERROR CODES */
309 /* Error codes for the PKCS12 functions. */
310
311 /* Function codes. */
312 #define PKCS12_F_ADD_FRIENDLYNAME                        100
313 #define PKCS12_F_ADD_FRIENDLYNAME_ASC                    101
314 #define PKCS12_F_ADD_FRIENDLYNAME_UNI                    102
315 #define PKCS12_F_PARSE_BAGS                              103
316 #define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
317 #define PKCS12_F_PKCS12_CREATE                           105
318 #define PKCS12_F_PKCS12_DECRYPT_D2I                      106
319 #define PKCS12_F_PKCS12_GEN_MAC                          107
320 #define PKCS12_F_PKCS12_I2D_ENCRYPT                      108
321 #define PKCS12_F_PKCS12_INIT                             109
322 #define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
323 #define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
324 #define PKCS12_F_PKCS12_MAKE_SAFEBAG                     112
325 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
326 #define PKCS12_F_PKCS12_PACK_P7DATA                      114
327 #define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
328 #define PKCS12_F_PKCS12_PACK_P7_DATA                     116
329 #define PKCS12_F_PKCS12_PACK_SAFEBAG                     117
330 #define PKCS12_F_PKCS12_PARSE                            118
331 #define PKCS12_F_PKCS12_PBE_CRYPT                        119
332 #define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
333 #define PKCS12_F_PKCS12_PKCS12_SET_MAC                   121
334 #define PKCS12_F_PKCS12_SETUP_MAC                        122
335 #define PKCS12_F_PKCS12_SET_MAC                          123
336 #define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
337 #define PKCS12_F_PKCS8_ENCRYPT                           125
338 #define PKCS12_F_VERIFY_MAC                              126
339
340 /* Reason codes. */
341 #define PKCS12_R_CANT_PACK_STRUCTURE                     100
342 #define PKCS12_R_DECODE_ERROR                            101
343 #define PKCS12_R_ENCODE_ERROR                            102
344 #define PKCS12_R_ENCRYPT_ERROR                           103
345 #define PKCS12_R_INVALID_NULL_ARGUMENT                   104
346 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
347 #define PKCS12_R_IV_GEN_ERROR                            106
348 #define PKCS12_R_KEY_GEN_ERROR                           107
349 #define PKCS12_R_MAC_ABSENT                              108
350 #define PKCS12_R_MAC_GENERATION_ERROR                    109
351 #define PKCS12_R_MAC_SETUP_ERROR                         110
352 #define PKCS12_R_MAC_STRING_SET_ERROR                    111
353 #define PKCS12_R_MAC_VERIFY_ERROR                        112
354 #define PKCS12_R_MAC_VERIFY_FAILURE                      113
355 #define PKCS12_R_PARSE_ERROR                             114
356 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
357 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
358 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
359 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
360 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
361  
362 #ifdef  __cplusplus
363 }
364 #endif
365 #endif
366