OLD | NEW |
| (Empty) |
1 /* pkcs12.h */ | |
2 /* Written by Dr Stephen N Henson (steve@openssl.org) 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 #include <openssl/bio.h> | |
63 #include <openssl/x509.h> | |
64 | |
65 #ifdef __cplusplus | |
66 extern "C" { | |
67 #endif | |
68 | |
69 #define PKCS12_KEY_ID 1 | |
70 #define PKCS12_IV_ID 2 | |
71 #define PKCS12_MAC_ID 3 | |
72 | |
73 /* Default iteration count */ | |
74 #ifndef PKCS12_DEFAULT_ITER | |
75 #define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER | |
76 #endif | |
77 | |
78 #define PKCS12_MAC_KEY_LENGTH 20 | |
79 | |
80 #define PKCS12_SALT_LEN 8 | |
81 | |
82 /* Uncomment out next line for unicode password and names, otherwise ASCII */ | |
83 | |
84 /*#define PBE_UNICODE*/ | |
85 | |
86 #ifdef PBE_UNICODE | |
87 #define PKCS12_key_gen PKCS12_key_gen_uni | |
88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni | |
89 #else | |
90 #define PKCS12_key_gen PKCS12_key_gen_asc | |
91 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc | |
92 #endif | |
93 | |
94 /* MS key usage constants */ | |
95 | |
96 #define KEY_EX 0x10 | |
97 #define KEY_SIG 0x80 | |
98 | |
99 typedef struct { | |
100 X509_SIG *dinfo; | |
101 ASN1_OCTET_STRING *salt; | |
102 ASN1_INTEGER *iter; /* defaults to 1 */ | |
103 } PKCS12_MAC_DATA; | |
104 | |
105 typedef struct { | |
106 ASN1_INTEGER *version; | |
107 PKCS12_MAC_DATA *mac; | |
108 PKCS7 *authsafes; | |
109 } PKCS12; | |
110 | |
111 typedef struct { | |
112 ASN1_OBJECT *type; | |
113 union { | |
114 struct pkcs12_bag_st *bag; /* secret, crl and certbag */ | |
115 struct pkcs8_priv_key_info_st *keybag; /* keybag */ | |
116 X509_SIG *shkeybag; /* shrouded key bag */ | |
117 STACK_OF(PKCS12_SAFEBAG) *safes; | |
118 ASN1_TYPE *other; | |
119 }value; | |
120 STACK_OF(X509_ATTRIBUTE) *attrib; | |
121 } PKCS12_SAFEBAG; | |
122 | |
123 DECLARE_STACK_OF(PKCS12_SAFEBAG) | |
124 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) | |
125 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) | |
126 | |
127 typedef struct pkcs12_bag_st { | |
128 ASN1_OBJECT *type; | |
129 union { | |
130 ASN1_OCTET_STRING *x509cert; | |
131 ASN1_OCTET_STRING *x509crl; | |
132 ASN1_OCTET_STRING *octet; | |
133 ASN1_IA5STRING *sdsicert; | |
134 ASN1_TYPE *other; /* Secret or other bag */ | |
135 }value; | |
136 } PKCS12_BAGS; | |
137 | |
138 #define PKCS12_ERROR 0 | |
139 #define PKCS12_OK 1 | |
140 | |
141 /* Compatibility macros */ | |
142 | |
143 #define M_PKCS12_x5092certbag PKCS12_x5092certbag | |
144 #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag | |
145 | |
146 #define M_PKCS12_certbag2x509 PKCS12_certbag2x509 | |
147 #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl | |
148 | |
149 #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data | |
150 #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes | |
151 #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes | |
152 #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata | |
153 | |
154 #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey | |
155 #define M_PKCS8_decrypt PKCS8_decrypt | |
156 | |
157 #define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type) | |
158 #define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type) | |
159 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type | |
160 | |
161 #define PKCS12_get_attr(bag, attr_nid) \ | |
162 PKCS12_get_attr_gen(bag->attrib, attr_nid) | |
163 | |
164 #define PKCS8_get_attr(p8, attr_nid) \ | |
165 PKCS12_get_attr_gen(p8->attributes, attr_nid) | |
166 | |
167 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) | |
168 | |
169 | |
170 PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509); | |
171 PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl); | |
172 X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag); | |
173 X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag); | |
174 | |
175 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid
1, | |
176 int nid2); | |
177 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); | |
178 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen); | |
179 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass, | |
180 int passlen); | |
181 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, | |
182 const char *pass, int passlen, | |
183 unsigned char *salt, int saltlen, int iter, | |
184 PKCS8_PRIV_KEY_INFO *p8); | |
185 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, | |
186 int passlen, unsigned char *salt, | |
187 int saltlen, int iter, | |
188 PKCS8_PRIV_KEY_INFO *p8); | |
189 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); | |
190 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7); | |
191 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, | |
192 unsigned char *salt, int saltlen, int iter, | |
193 STACK_OF(PKCS12_SAFEBAG) *bags); | |
194 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, i
nt passlen); | |
195 | |
196 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); | |
197 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12); | |
198 | |
199 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen)
; | |
200 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, | |
201 int namelen); | |
202 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, | |
203 int namelen); | |
204 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, | |
205 int namelen); | |
206 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); | |
207 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); | |
208 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); | |
209 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, | |
210 int passlen, unsigned char *in, int inlen, | |
211 unsigned char **data, int *datalen, int en_de); | |
212 void * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it, | |
213 const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf); | |
214 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *i
t, | |
215 const char *pass, int passlen, | |
216 void *obj, int zbuf); | |
217 PKCS12 *PKCS12_init(int mode); | |
218 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, | |
219 int saltlen, int id, int iter, int n, | |
220 unsigned char *out, const EVP_MD *md_type); | |
221 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, in
t saltlen, int id, int iter, int n, unsigned char *out, const EVP_MD *md_type); | |
222 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, | |
223 ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_M
D *md_type, | |
224 int en_de); | |
225 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, | |
226 unsigned char *mac, unsigned int *maclen); | |
227 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); | |
228 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, | |
229 unsigned char *salt, int saltlen, int iter, | |
230 const EVP_MD *md_type); | |
231 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, | |
232 int saltlen, const EVP_MD *md_type); | |
233 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen, unsigned char **uni,
int *unilen); | |
234 char *OPENSSL_uni2asc(unsigned char *uni, int unilen); | |
235 | |
236 DECLARE_ASN1_FUNCTIONS(PKCS12) | |
237 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA) | |
238 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG) | |
239 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS) | |
240 | |
241 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS) | |
242 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES) | |
243 | |
244 void PKCS12_PBE_add(void); | |
245 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, | |
246 STACK_OF(X509) **ca); | |
247 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, | |
248 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter
, | |
249 int mac_iter, int keytype); | |
250 | |
251 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert); | |
252 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key, | |
253 int key_usage, int iter, | |
254 int key_nid, char *pass); | |
255 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, | |
256 int safe_nid, int iter, char *pass); | |
257 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); | |
258 | |
259 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); | |
260 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); | |
261 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); | |
262 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); | |
263 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); | |
264 | |
265 /* BEGIN ERROR CODES */ | |
266 /* The following lines are auto generated by the script mkerr.pl. Any changes | |
267 * made after this point may be overwritten when the script is next run. | |
268 */ | |
269 void ERR_load_PKCS12_strings(void); | |
270 | |
271 /* Error codes for the PKCS12 functions. */ | |
272 | |
273 /* Function codes. */ | |
274 #define PKCS12_F_PARSE_BAG 129 | |
275 #define PKCS12_F_PARSE_BAGS 103 | |
276 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 | |
277 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 | |
278 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 | |
279 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 | |
280 #define PKCS12_F_PKCS12_CREATE 105 | |
281 #define PKCS12_F_PKCS12_GEN_MAC 107 | |
282 #define PKCS12_F_PKCS12_INIT 109 | |
283 #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106 | |
284 #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108 | |
285 #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117 | |
286 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110 | |
287 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111 | |
288 #define PKCS12_F_PKCS12_MAKE_KEYBAG 112 | |
289 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 | |
290 #define PKCS12_F_PKCS12_NEWPASS 128 | |
291 #define PKCS12_F_PKCS12_PACK_P7DATA 114 | |
292 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 | |
293 #define PKCS12_F_PKCS12_PARSE 118 | |
294 #define PKCS12_F_PKCS12_PBE_CRYPT 119 | |
295 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 | |
296 #define PKCS12_F_PKCS12_SETUP_MAC 122 | |
297 #define PKCS12_F_PKCS12_SET_MAC 123 | |
298 #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130 | |
299 #define PKCS12_F_PKCS12_UNPACK_P7DATA 131 | |
300 #define PKCS12_F_PKCS12_VERIFY_MAC 126 | |
301 #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 | |
302 #define PKCS12_F_PKCS8_ENCRYPT 125 | |
303 | |
304 /* Reason codes. */ | |
305 #define PKCS12_R_CANT_PACK_STRUCTURE 100 | |
306 #define PKCS12_R_CONTENT_TYPE_NOT_DATA 121 | |
307 #define PKCS12_R_DECODE_ERROR 101 | |
308 #define PKCS12_R_ENCODE_ERROR 102 | |
309 #define PKCS12_R_ENCRYPT_ERROR 103 | |
310 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 | |
311 #define PKCS12_R_INVALID_NULL_ARGUMENT 104 | |
312 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 | |
313 #define PKCS12_R_IV_GEN_ERROR 106 | |
314 #define PKCS12_R_KEY_GEN_ERROR 107 | |
315 #define PKCS12_R_MAC_ABSENT 108 | |
316 #define PKCS12_R_MAC_GENERATION_ERROR 109 | |
317 #define PKCS12_R_MAC_SETUP_ERROR 110 | |
318 #define PKCS12_R_MAC_STRING_SET_ERROR 111 | |
319 #define PKCS12_R_MAC_VERIFY_ERROR 112 | |
320 #define PKCS12_R_MAC_VERIFY_FAILURE 113 | |
321 #define PKCS12_R_PARSE_ERROR 114 | |
322 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 | |
323 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 | |
324 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 | |
325 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 | |
326 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 | |
327 | |
328 #ifdef __cplusplus | |
329 } | |
330 #endif | |
331 #endif | |
OLD | NEW |