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 PROTO_AMISSL_H
60 #include <proto/amissl.h>
61 #endif /* PROTO_AMISSL_H */
63 #ifndef HEADER_PKCS12_H
64 #define HEADER_PKCS12_H
66 #include <openssl/bio.h>
67 #include <openssl/x509.h>
73 #define PKCS12_KEY_ID 1
74 #define PKCS12_IV_ID 2
75 #define PKCS12_MAC_ID 3
77 /* Default iteration count */
78 #ifndef PKCS12_DEFAULT_ITER
79 #define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
82 #define PKCS12_MAC_KEY_LENGTH 20
84 #define PKCS12_SALT_LEN 8
86 /* Uncomment out next line for unicode password and names, otherwise ASCII */
88 /*#define PBE_UNICODE*/
91 #define PKCS12_key_gen PKCS12_key_gen_uni
92 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
94 #define PKCS12_key_gen PKCS12_key_gen_asc
95 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
98 /* MS key usage constants */
105 ASN1_OCTET_STRING
*salt
;
106 ASN1_INTEGER
*iter
; /* defaults to 1 */
110 ASN1_INTEGER
*version
;
111 PKCS12_MAC_DATA
*mac
;
115 PREDECLARE_STACK_OF(PKCS12_SAFEBAG
)
120 struct pkcs12_bag_st
*bag
; /* secret, crl and certbag */
121 struct pkcs8_priv_key_info_st
*keybag
; /* keybag */
122 X509_SIG
*shkeybag
; /* shrouded key bag */
123 STACK_OF(PKCS12_SAFEBAG
) *safes
;
126 STACK_OF(X509_ATTRIBUTE
) *attrib
;
129 DECLARE_STACK_OF(PKCS12_SAFEBAG
)
130 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG
)
131 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG
)
133 typedef struct pkcs12_bag_st
{
136 ASN1_OCTET_STRING
*x509cert
;
137 ASN1_OCTET_STRING
*x509crl
;
138 ASN1_OCTET_STRING
*octet
;
139 ASN1_IA5STRING
*sdsicert
;
140 ASN1_TYPE
*other
; /* Secret or other bag */
144 #define PKCS12_ERROR 0
147 /* Compatibility macros */
149 #define M_PKCS12_x5092certbag PKCS12_x5092certbag
150 #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
152 #define M_PKCS12_certbag2x509 PKCS12_certbag2x509
153 #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl
155 #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
156 #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
157 #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
158 #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
160 #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
161 #define M_PKCS8_decrypt PKCS8_decrypt
163 #define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)
164 #define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)
165 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
167 #define PKCS12_get_attr(bag, attr_nid) \
168 PKCS12_get_attr_gen(bag->attrib, attr_nid)
170 #define PKCS8_get_attr(p8, attr_nid) \
171 PKCS12_get_attr_gen(p8->attributes, attr_nid)
173 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
176 PKCS12_SAFEBAG
*PKCS12_x5092certbag(X509
*x509
);
177 PKCS12_SAFEBAG
*PKCS12_x509crl2certbag(X509_CRL
*crl
);
178 X509
*PKCS12_certbag2x509(PKCS12_SAFEBAG
*bag
);
179 X509_CRL
*PKCS12_certbag2x509crl(PKCS12_SAFEBAG
*bag
);
181 PKCS12_SAFEBAG
*PKCS12_item_pack_safebag(void *obj
, const ASN1_ITEM
*it
, int nid1
,
183 PKCS12_SAFEBAG
*PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO
*p8
);
184 PKCS8_PRIV_KEY_INFO
*PKCS8_decrypt(X509_SIG
*p8
, const char *pass
, int passlen
);
185 PKCS8_PRIV_KEY_INFO
*PKCS12_decrypt_skey(PKCS12_SAFEBAG
*bag
, const char *pass
,
187 X509_SIG
*PKCS8_encrypt(int pbe_nid
, const EVP_CIPHER
*cipher
,
188 const char *pass
, int passlen
,
189 unsigned char *salt
, int saltlen
, int iter
,
190 PKCS8_PRIV_KEY_INFO
*p8
);
191 PKCS12_SAFEBAG
*PKCS12_MAKE_SHKEYBAG(int pbe_nid
, const char *pass
,
192 int passlen
, unsigned char *salt
,
193 int saltlen
, int iter
,
194 PKCS8_PRIV_KEY_INFO
*p8
);
195 PKCS7
*PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG
) *sk
);
196 STACK_OF(PKCS12_SAFEBAG
) *PKCS12_unpack_p7data(PKCS7
*p7
);
197 PKCS7
*PKCS12_pack_p7encdata(int pbe_nid
, const char *pass
, int passlen
,
198 unsigned char *salt
, int saltlen
, int iter
,
199 STACK_OF(PKCS12_SAFEBAG
) *bags
);
200 STACK_OF(PKCS12_SAFEBAG
) *PKCS12_unpack_p7encdata(PKCS7
*p7
, const char *pass
, int passlen
);
202 int PKCS12_pack_authsafes(PKCS12
*p12
, STACK_OF(PKCS7
) *safes
);
203 STACK_OF(PKCS7
) *PKCS12_unpack_authsafes(PKCS12
*p12
);
205 int PKCS12_add_localkeyid(PKCS12_SAFEBAG
*bag
, unsigned char *name
, int namelen
);
206 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG
*bag
, const char *name
,
208 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG
*bag
, const char *name
,
210 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG
*bag
, const unsigned char *name
,
212 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO
*p8
, int usage
);
213 ASN1_TYPE
*PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE
) *attrs
, int attr_nid
);
214 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG
*bag
);
215 unsigned char *PKCS12_pbe_crypt(X509_ALGOR
*algor
, const char *pass
,
216 int passlen
, unsigned char *in
, int inlen
,
217 unsigned char **data
, int *datalen
, int en_de
);
218 void * PKCS12_item_decrypt_d2i(X509_ALGOR
*algor
, const ASN1_ITEM
*it
,
219 const char *pass
, int passlen
, ASN1_OCTET_STRING
*oct
, int zbuf
);
220 ASN1_OCTET_STRING
*PKCS12_item_i2d_encrypt(X509_ALGOR
*algor
, const ASN1_ITEM
*it
,
221 const char *pass
, int passlen
,
222 void *obj
, int zbuf
);
223 PKCS12
*PKCS12_init(int mode
);
224 int PKCS12_key_gen_asc(const char *pass
, int passlen
, unsigned char *salt
,
225 int saltlen
, int id
, int iter
, int n
,
226 unsigned char *out
, const EVP_MD
*md_type
);
227 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
);
228 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX
*ctx
, const char *pass
, int passlen
,
229 ASN1_TYPE
*param
, const EVP_CIPHER
*cipher
, const EVP_MD
*md_type
,
231 int PKCS12_gen_mac(PKCS12
*p12
, const char *pass
, int passlen
,
232 unsigned char *mac
, unsigned int *maclen
);
233 int PKCS12_verify_mac(PKCS12
*p12
, const char *pass
, int passlen
);
234 int PKCS12_set_mac(PKCS12
*p12
, const char *pass
, int passlen
,
235 unsigned char *salt
, int saltlen
, int iter
,
236 const EVP_MD
*md_type
);
237 int PKCS12_setup_mac(PKCS12
*p12
, int iter
, unsigned char *salt
,
238 int saltlen
, const EVP_MD
*md_type
);
239 unsigned char *asc2uni(const char *asc
, int asclen
, unsigned char **uni
, int *unilen
);
240 char *uni2asc(unsigned char *uni
, int unilen
);
242 DECLARE_ASN1_FUNCTIONS(PKCS12
)
243 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA
)
244 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG
)
245 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS
)
247 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS
)
248 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES
)
250 void PKCS12_PBE_add(void);
251 int PKCS12_parse(PKCS12
*p12
, const char *pass
, EVP_PKEY
**pkey
, X509
**cert
,
252 STACK_OF(X509
) **ca
);
253 PKCS12
*PKCS12_create(char *pass
, char *name
, EVP_PKEY
*pkey
, X509
*cert
,
254 STACK_OF(X509
) *ca
, int nid_key
, int nid_cert
, int iter
,
255 int mac_iter
, int keytype
);
256 int i2d_PKCS12_bio(BIO
*bp
, PKCS12
*p12
);
257 #ifndef OPENSSL_NO_FP_API
258 int i2d_PKCS12_fp(FILE *fp
, PKCS12
*p12
);
260 PKCS12
*d2i_PKCS12_bio(BIO
*bp
, PKCS12
**p12
);
261 #ifndef OPENSSL_NO_FP_API
262 PKCS12
*d2i_PKCS12_fp(FILE *fp
, PKCS12
**p12
);
264 int PKCS12_newpass(PKCS12
*p12
, char *oldpass
, char *newpass
);
266 /* BEGIN ERROR CODES */
267 /* The following lines are auto generated by the script mkerr.pl. Any changes
268 * made after this point may be overwritten when the script is next run.
270 void ERR_load_PKCS12_strings(void);
272 /* Error codes for the PKCS12 functions. */
274 /* Function codes. */
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_DECRYPT_D2I 106
282 #define PKCS12_F_PKCS12_GEN_MAC 107
283 #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
284 #define PKCS12_F_PKCS12_INIT 109
285 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
286 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
287 #define PKCS12_F_PKCS12_MAKE_KEYBAG 112
288 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
289 #define PKCS12_F_PKCS12_NEWPASS 128
290 #define PKCS12_F_PKCS12_PACK_P7DATA 114
291 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
292 #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
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_PKCS8_ADD_KEYUSAGE 124
299 #define PKCS12_F_PKCS8_ENCRYPT 125
300 #define PKCS12_F_VERIFY_MAC 126
303 #define PKCS12_R_CANT_PACK_STRUCTURE 100
304 #define PKCS12_R_DECODE_ERROR 101
305 #define PKCS12_R_ENCODE_ERROR 102
306 #define PKCS12_R_ENCRYPT_ERROR 103
307 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120
308 #define PKCS12_R_INVALID_NULL_ARGUMENT 104
309 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
310 #define PKCS12_R_IV_GEN_ERROR 106
311 #define PKCS12_R_KEY_GEN_ERROR 107
312 #define PKCS12_R_MAC_ABSENT 108
313 #define PKCS12_R_MAC_GENERATION_ERROR 109
314 #define PKCS12_R_MAC_SETUP_ERROR 110
315 #define PKCS12_R_MAC_STRING_SET_ERROR 111
316 #define PKCS12_R_MAC_VERIFY_ERROR 112
317 #define PKCS12_R_MAC_VERIFY_FAILURE 113
318 #define PKCS12_R_PARSE_ERROR 114
319 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
320 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
321 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
322 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
323 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119