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
66 #include <openssl/bio.h>
67 #include <openssl/x509.h>
69 #define PKCS12_KEY_ID 1
70 #define PKCS12_IV_ID 2
71 #define PKCS12_MAC_ID 3
73 /* Default iteration count */
74 #ifndef PKCS12_DEFAULT_ITER
75 #define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
78 #define PKCS12_MAC_KEY_LENGTH 20
80 #define PKCS12_SALT_LEN 8
82 /* Uncomment out next line for unicode password and names, otherwise ASCII */
84 /*#define PBE_UNICODE*/
87 #define PKCS12_key_gen PKCS12_key_gen_uni
88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
90 #define PKCS12_key_gen PKCS12_key_gen_asc
91 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
94 /* MS key usage constants */
101 ASN1_OCTET_STRING *salt;
102 ASN1_INTEGER *iter; /* defaults to 1 */
106 ASN1_INTEGER *version;
107 PKCS12_MAC_DATA *mac;
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 /* PKCS12_SAFEBAG */ *safes;
120 STACK_OF(X509_ATTRIBUTE) *attrib;
124 typedef struct pkcs12_bag_st {
127 ASN1_OCTET_STRING *x509cert;
128 ASN1_OCTET_STRING *x509crl;
129 ASN1_OCTET_STRING *octet;
130 ASN1_IA5STRING *sdsicert;
131 ASN1_TYPE *other; /* Secret or other bag */
135 #define PKCS12_ERROR 0
138 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
139 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
140 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
142 #define M_PKCS12_x5092certbag(x509) \
143 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
145 #define M_PKCS12_x509crl2certbag(crl) \
146 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
148 #define M_PKCS12_certbag2x509(bg) \
149 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
150 (char *(*)())d2i_X509)
152 #define M_PKCS12_certbag2x509crl(bg) \
153 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
154 (char *(*)())d2i_X509CRL)
156 /*#define M_PKCS12_pkcs82rsa(p8) \
157 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
159 #define M_PKCS12_unpack_p7data(p7) \
160 ASN1_seq_unpack ((p7)->d.data->data, p7->d.data->length, \
161 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
163 #define M_PKCS12_pack_authsafes(p12, safes) \
164 ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
165 &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
167 #define M_PKCS12_unpack_authsafes(p12) \
168 ASN1_seq_unpack((p12)->authsafes->d.data->data, \
169 (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
172 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
173 (STACK *) PKCS12_decrypt_d2i ((p7)->d.encrypted->enc_data->algorithm,\
174 (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
176 (p7)->d.encrypted->enc_data->enc_data, 3)
178 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
179 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
180 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
182 (bag)->value.shkeybag->digest, 2)
184 #define M_PKCS8_decrypt(p8, pass, passlen) \
185 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
186 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free,\
187 (pass), (passlen), (p8)->digest, 2)
189 #define PKCS12_get_attr(bag, attr_nid) \
190 PKCS12_get_attr_gen(bag->attrib, attr_nid)
192 #define PKCS8_get_attr(p8, attr_nid) \
193 PKCS12_get_attr_gen(p8->attributes, attr_nid)
195 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
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, const EVP_CIPHER *cipher,
201 const char *pass, int passlen,
202 unsigned char *salt, int saltlen, int iter,
203 PKCS8_PRIV_KEY_INFO *p8);
204 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
205 int passlen, unsigned char *salt,
206 int saltlen, int iter,
207 PKCS8_PRIV_KEY_INFO *p8);
208 PKCS7 *PKCS12_pack_p7data(STACK *sk);
209 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
210 unsigned char *salt, int saltlen, int iter,
212 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
213 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
215 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
217 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
218 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
219 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
220 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
221 int passlen, unsigned char *in, int inlen,
222 unsigned char **data, int *datalen, int en_de);
223 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
224 void (*free_func)(), const char *pass, int passlen,
225 ASN1_STRING *oct, int seq);
226 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
227 const char *pass, int passlen, char *obj,
229 PKCS12 *PKCS12_init(int mode);
230 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
231 int saltlen, int id, int iter, int n,
232 unsigned char *out, const EVP_MD *md_type);
233 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);
234 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
235 ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type,
237 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
238 unsigned char *mac, unsigned int *maclen);
239 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
240 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
241 unsigned char *salt, int saltlen, int iter,
243 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
244 int saltlen, EVP_MD *md_type);
245 unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
246 char *uni2asc(unsigned char *uni, int unilen);
247 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
248 PKCS12_BAGS *PKCS12_BAGS_new(void);
249 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
250 void PKCS12_BAGS_free(PKCS12_BAGS *a);
251 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
252 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
253 PKCS12 *PKCS12_new(void);
254 void PKCS12_free(PKCS12 *a);
255 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
256 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
257 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
259 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
260 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
261 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
262 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
264 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
265 void ERR_load_PKCS12_strings(void);
266 void PKCS12_PBE_add(void);
267 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
269 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
270 STACK *ca, int nid_key, int nid_cert, int iter,
271 int mac_iter, int keytype);
272 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
273 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
274 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
275 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
277 /* BEGIN ERROR CODES */
278 /* The following lines are auto generated by the script mkerr.pl. Any changes
279 * made after this point may be overwritten when the script is next run.
282 /* Error codes for the PKCS12 functions. */
284 /* Function codes. */
285 #define PKCS12_F_PARSE_BAGS 103
286 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100
287 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127
288 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102
289 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104
290 #define PKCS12_F_PKCS12_CREATE 105
291 #define PKCS12_F_PKCS12_DECRYPT_D2I 106
292 #define PKCS12_F_PKCS12_GEN_MAC 107
293 #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
294 #define PKCS12_F_PKCS12_INIT 109
295 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
296 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
297 #define PKCS12_F_PKCS12_MAKE_KEYBAG 112
298 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
299 #define PKCS12_F_PKCS12_PACK_P7DATA 114
300 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
301 #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
302 #define PKCS12_F_PKCS12_PARSE 118
303 #define PKCS12_F_PKCS12_PBE_CRYPT 119
304 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
305 #define PKCS12_F_PKCS12_SETUP_MAC 122
306 #define PKCS12_F_PKCS12_SET_MAC 123
307 #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124
308 #define PKCS12_F_PKCS8_ENCRYPT 125
309 #define PKCS12_F_VERIFY_MAC 126
312 #define PKCS12_R_CANT_PACK_STRUCTURE 100
313 #define PKCS12_R_DECODE_ERROR 101
314 #define PKCS12_R_ENCODE_ERROR 102
315 #define PKCS12_R_ENCRYPT_ERROR 103
316 #define PKCS12_R_INVALID_NULL_ARGUMENT 104
317 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
318 #define PKCS12_R_IV_GEN_ERROR 106
319 #define PKCS12_R_KEY_GEN_ERROR 107
320 #define PKCS12_R_MAC_ABSENT 108
321 #define PKCS12_R_MAC_GENERATION_ERROR 109
322 #define PKCS12_R_MAC_SETUP_ERROR 110
323 #define PKCS12_R_MAC_STRING_SET_ERROR 111
324 #define PKCS12_R_MAC_VERIFY_ERROR 112
325 #define PKCS12_R_MAC_VERIFY_FAILURE 113
326 #define PKCS12_R_PARSE_ERROR 114
327 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
328 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
329 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
330 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
331 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119