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
62 #include <openssl/bio.h>
63 #include <openssl/x509.h>
69 #define DECLARE_PKCS12_STACK_OF(type) \
70 STACK_OF(type) *PKCS12_decrypt_d2i_##type(struct X509_algor_st *algor, \
71 type *(*d2i)(type **, \
74 void (*free_func)(type *), \
75 const char *pass, int passlen, \
76 ASN1_STRING *oct, int seq);
78 #define IMPLEMENT_PKCS12_STACK_OF(type) \
79 STACK_OF(type) *PKCS12_decrypt_d2i_##type(struct X509_algor_st *algor, \
80 type *(*d2i)(type **, \
83 void (*free_func)(type *), \
84 const char *pass, int passlen, \
85 ASN1_STRING *oct, int seq) \
86 { return (STACK_OF(type) *)PKCS12_decrypt_d2i(algor,(char *(*)())d2i, \
87 (void(*)(void *))free_func, \
88 pass,passlen,oct,seq); }
90 #define PKCS12_KEY_ID 1
91 #define PKCS12_IV_ID 2
92 #define PKCS12_MAC_ID 3
94 /* Default iteration count */
95 #ifndef PKCS12_DEFAULT_ITER
96 #define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
99 #define PKCS12_MAC_KEY_LENGTH 20
101 #define PKCS12_SALT_LEN 8
103 /* Uncomment out next line for unicode password and names, otherwise ASCII */
105 /*#define PBE_UNICODE*/
108 #define PKCS12_key_gen PKCS12_key_gen_uni
109 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
111 #define PKCS12_key_gen PKCS12_key_gen_asc
112 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
115 /* MS key usage constants */
122 ASN1_OCTET_STRING *salt;
123 ASN1_INTEGER *iter; /* defaults to 1 */
127 ASN1_INTEGER *version;
128 PKCS12_MAC_DATA *mac;
132 PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
137 struct pkcs12_bag_st *bag; /* secret, crl and certbag */
138 struct pkcs8_priv_key_info_st *keybag; /* keybag */
139 X509_SIG *shkeybag; /* shrouded key bag */
140 STACK_OF(PKCS12_SAFEBAG) *safes;
143 STACK_OF(X509_ATTRIBUTE) *attrib;
147 DECLARE_STACK_OF(PKCS12_SAFEBAG)
148 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
149 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
151 typedef struct pkcs12_bag_st {
154 ASN1_OCTET_STRING *x509cert;
155 ASN1_OCTET_STRING *x509crl;
156 ASN1_OCTET_STRING *octet;
157 ASN1_IA5STRING *sdsicert;
158 ASN1_TYPE *other; /* Secret or other bag */
162 #define PKCS12_ERROR 0
165 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
166 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
167 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
169 #define M_PKCS12_x5092certbag(x509) \
170 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
172 #define M_PKCS12_x509crl2certbag(crl) \
173 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
175 #define M_PKCS12_certbag2x509(bg) \
176 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
177 (char *(*)())d2i_X509)
179 #define M_PKCS12_certbag2x509crl(bg) \
180 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
181 (char *(*)())d2i_X509CRL)
183 /*#define M_PKCS12_pkcs82rsa(p8) \
184 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
186 #define M_PKCS12_unpack_p7data(p7) \
187 ASN1_seq_unpack_PKCS12_SAFEBAG ((p7)->d.data->data, p7->d.data->length, \
188 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
190 #define M_PKCS12_pack_authsafes(p12, safes) \
191 ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
192 &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
194 #define M_PKCS12_unpack_authsafes(p12) \
195 ASN1_seq_unpack((p12)->authsafes->d.data->data, \
196 (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
199 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
200 PKCS12_decrypt_d2i_PKCS12_SAFEBAG ((p7)->d.encrypted->enc_data->algorithm,\
201 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
203 (p7)->d.encrypted->enc_data->enc_data, 3)
205 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
206 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
207 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
209 (bag)->value.shkeybag->digest, 2)
211 #define M_PKCS8_decrypt(p8, pass, passlen) \
212 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
213 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free,\
214 (pass), (passlen), (p8)->digest, 2)
216 #define PKCS12_get_attr(bag, attr_nid) \
217 PKCS12_get_attr_gen(bag->attrib, attr_nid)
219 #define PKCS8_get_attr(p8, attr_nid) \
220 PKCS12_get_attr_gen(p8->attributes, attr_nid)
222 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
225 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
226 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
227 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
228 const char *pass, int passlen,
229 unsigned char *salt, int saltlen, int iter,
230 PKCS8_PRIV_KEY_INFO *p8);
231 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
232 int passlen, unsigned char *salt,
233 int saltlen, int iter,
234 PKCS8_PRIV_KEY_INFO *p8);
235 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
236 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
237 unsigned char *salt, int saltlen, int iter,
238 STACK_OF(PKCS12_SAFEBAG) *bags);
239 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
240 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
242 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
244 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
245 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
246 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
247 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
248 int passlen, unsigned char *in, int inlen,
249 unsigned char **data, int *datalen, int en_de);
250 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
251 void (*free_func)(), const char *pass, int passlen,
252 ASN1_STRING *oct, int seq);
253 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
254 const char *pass, int passlen, char *obj,
256 PKCS12 *PKCS12_init(int mode);
257 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
258 int saltlen, int id, int iter, int n,
259 unsigned char *out, const EVP_MD *md_type);
260 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, int saltlen, int id, int iter, int n, unsigned char *out, const EVP_MD *md_type);
261 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
262 ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type,
264 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
265 unsigned char *mac, unsigned int *maclen);
266 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
267 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
268 unsigned char *salt, int saltlen, int iter,
270 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
271 int saltlen, EVP_MD *md_type);
272 unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
273 char *uni2asc(unsigned char *uni, int unilen);
274 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
275 PKCS12_BAGS *PKCS12_BAGS_new(void);
276 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
277 void PKCS12_BAGS_free(PKCS12_BAGS *a);
278 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
279 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
280 PKCS12 *PKCS12_new(void);
281 void PKCS12_free(PKCS12 *a);
282 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
283 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
284 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
286 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
287 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
288 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
289 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
291 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
292 void ERR_load_PKCS12_strings(void);
293 void PKCS12_PBE_add(void);
294 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
295 STACK_OF(X509) **ca);
296 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
297 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
298 int mac_iter, int keytype);
299 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
300 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
301 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
302 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
303 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
305 /* BEGIN ERROR CODES */
306 /* The following lines are auto generated by the script mkerr.pl. Any changes
307 * made after this point may be overwritten when the script is next run.
310 /* Error codes for the PKCS12 functions. */
312 /* Function codes. */
313 #define PKCS12_F_PARSE_BAGS 103
314 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100
315 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127
316 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102
317 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104
318 #define PKCS12_F_PKCS12_CREATE 105
319 #define PKCS12_F_PKCS12_DECRYPT_D2I 106
320 #define PKCS12_F_PKCS12_GEN_MAC 107
321 #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
322 #define PKCS12_F_PKCS12_INIT 109
323 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
324 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
325 #define PKCS12_F_PKCS12_MAKE_KEYBAG 112
326 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
327 #define PKCS12_F_PKCS12_NEWPASS 128
328 #define PKCS12_F_PKCS12_PACK_P7DATA 114
329 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
330 #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
331 #define PKCS12_F_PKCS12_PARSE 118
332 #define PKCS12_F_PKCS12_PBE_CRYPT 119
333 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
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
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_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120
346 #define PKCS12_R_INVALID_NULL_ARGUMENT 104
347 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
348 #define PKCS12_R_IV_GEN_ERROR 106
349 #define PKCS12_R_KEY_GEN_ERROR 107
350 #define PKCS12_R_MAC_ABSENT 108
351 #define PKCS12_R_MAC_GENERATION_ERROR 109
352 #define PKCS12_R_MAC_SETUP_ERROR 110
353 #define PKCS12_R_MAC_STRING_SET_ERROR 111
354 #define PKCS12_R_MAC_VERIFY_ERROR 112
355 #define PKCS12_R_MAC_VERIFY_FAILURE 113
356 #define PKCS12_R_PARSE_ERROR 114
357 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
358 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
359 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
360 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
361 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119