2 * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
10 #ifndef HEADER_PKCS12_H
11 # define HEADER_PKCS12_H
13 # include <openssl/bio.h>
14 # include <openssl/x509.h>
20 # define PKCS12_KEY_ID 1
21 # define PKCS12_IV_ID 2
22 # define PKCS12_MAC_ID 3
24 /* Default iteration count */
25 # ifndef PKCS12_DEFAULT_ITER
26 # define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
29 # define PKCS12_MAC_KEY_LENGTH 20
31 # define PKCS12_SALT_LEN 8
33 /* Uncomment out next line for unicode password and names, otherwise ASCII */
40 # define PKCS12_key_gen PKCS12_key_gen_uni
41 # define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
43 # define PKCS12_key_gen PKCS12_key_gen_utf8
44 # define PKCS12_add_friendlyname PKCS12_add_friendlyname_utf8
47 /* MS key usage constants */
52 typedef struct PKCS12_MAC_DATA_st PKCS12_MAC_DATA;
54 typedef struct PKCS12_st PKCS12;
56 typedef struct PKCS12_SAFEBAG_st PKCS12_SAFEBAG;
58 DEFINE_STACK_OF(PKCS12_SAFEBAG)
60 typedef struct pkcs12_bag_st PKCS12_BAGS;
62 # define PKCS12_ERROR 0
65 /* Compatibility macros */
67 #if OPENSSL_API_COMPAT < 0x10100000L
69 # define M_PKCS12_bag_type PKCS12_bag_type
70 # define M_PKCS12_cert_bag_type PKCS12_cert_bag_type
71 # define M_PKCS12_crl_bag_type PKCS12_cert_bag_type
73 # define PKCS12_certbag2x509 PKCS12_SAFEBAG_get1_cert
74 # define PKCS12_certbag2scrl PKCS12_SAFEBAG_get1_crl
75 # define PKCS12_bag_type PKCS12_SAFEBAG_get_nid
76 # define PKCS12_cert_bag_type PKCS12_SAFEBAG_get_bag_nid
77 # define PKCS12_x5092certbag PKCS12_SAFEBAG_create_cert
78 # define PKCS12_x509crl2certbag PKCS12_SAFEBAG_create_crl
79 # define PKCS12_MAKE_KEYBAG PKCS12_SAFEBAG_create0_p8inf
80 # define PKCS12_MAKE_SHKEYBAG PKCS12_SAFEBAG_create_pkcs8_encrypt
84 DEPRECATEDIN_1_1_0(ASN1_TYPE *PKCS12_get_attr(const PKCS12_SAFEBAG *bag, int attr_nid))
86 ASN1_TYPE *PKCS8_get_attr(PKCS8_PRIV_KEY_INFO *p8, int attr_nid);
87 int PKCS12_mac_present(const PKCS12 *p12);
88 void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
89 const X509_ALGOR **pmacalg,
90 const ASN1_OCTET_STRING **psalt,
91 const ASN1_INTEGER **piter,
94 const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
96 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag);
97 int PKCS12_SAFEBAG_get_nid(const PKCS12_SAFEBAG *bag);
98 int PKCS12_SAFEBAG_get_bag_nid(const PKCS12_SAFEBAG *bag);
100 X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
101 X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
102 const STACK_OF(PKCS12_SAFEBAG) *
103 PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
104 const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
105 const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);
107 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_cert(X509 *x509);
108 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_crl(X509_CRL *crl);
109 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_p8inf(PKCS8_PRIV_KEY_INFO *p8);
110 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_pkcs8(X509_SIG *p8);
111 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_pkcs8_encrypt(int pbe_nid,
115 int saltlen, int iter,
116 PKCS8_PRIV_KEY_INFO *p8inf);
118 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
120 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
122 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
123 const char *pass, int passlen);
124 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
125 const char *pass, int passlen, unsigned char *salt,
126 int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
127 X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
128 PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
129 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
130 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
131 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
132 unsigned char *salt, int saltlen, int iter,
133 STACK_OF(PKCS12_SAFEBAG) *bags);
134 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
137 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
138 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12);
140 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
142 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
144 int PKCS12_add_friendlyname_utf8(PKCS12_SAFEBAG *bag, const char *name,
146 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
148 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
149 const unsigned char *name, int namelen);
150 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
151 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
153 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
154 const STACK_OF(X509_ATTRIBUTE) *
155 PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
156 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
157 const char *pass, int passlen,
158 const unsigned char *in, int inlen,
159 unsigned char **data, int *datalen,
161 void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it,
162 const char *pass, int passlen,
163 const ASN1_OCTET_STRING *oct, int zbuf);
164 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
166 const char *pass, int passlen,
167 void *obj, int zbuf);
168 PKCS12 *PKCS12_init(int mode);
169 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
170 int saltlen, int id, int iter, int n,
171 unsigned char *out, const EVP_MD *md_type);
172 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
173 int saltlen, int id, int iter, int n,
174 unsigned char *out, const EVP_MD *md_type);
175 int PKCS12_key_gen_utf8(const char *pass, int passlen, unsigned char *salt,
176 int saltlen, int id, int iter, int n,
177 unsigned char *out, const EVP_MD *md_type);
178 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
179 ASN1_TYPE *param, const EVP_CIPHER *cipher,
180 const EVP_MD *md_type, int en_de);
181 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
182 unsigned char *mac, unsigned int *maclen);
183 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
184 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
185 unsigned char *salt, int saltlen, int iter,
186 const EVP_MD *md_type);
187 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
188 int saltlen, const EVP_MD *md_type);
189 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
190 unsigned char **uni, int *unilen);
191 char *OPENSSL_uni2asc(const unsigned char *uni, int unilen);
192 unsigned char *OPENSSL_utf82uni(const char *asc, int asclen,
193 unsigned char **uni, int *unilen);
194 char *OPENSSL_uni2utf8(const unsigned char *uni, int unilen);
196 DECLARE_ASN1_FUNCTIONS(PKCS12)
197 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
198 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
199 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
201 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
202 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
204 void PKCS12_PBE_add(void);
205 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
206 STACK_OF(X509) **ca);
207 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
208 X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
209 int iter, int mac_iter, int keytype);
211 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
212 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
213 EVP_PKEY *key, int key_usage, int iter,
214 int key_nid, const char *pass);
215 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
216 int safe_nid, int iter, const char *pass);
217 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
219 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
220 # ifndef OPENSSL_NO_STDIO
221 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
223 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
224 # ifndef OPENSSL_NO_STDIO
225 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
227 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
229 /* BEGIN ERROR CODES */
231 * The following lines are auto generated by the script mkerr.pl. Any changes
232 * made after this point may be overwritten when the script is next run.
235 int ERR_load_PKCS12_strings(void);
237 /* Error codes for the PKCS12 functions. */
239 /* Function codes. */
240 # define PKCS12_F_PKCS12_CREATE 105
241 # define PKCS12_F_PKCS12_GEN_MAC 107
242 # define PKCS12_F_PKCS12_INIT 109
243 # define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106
244 # define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108
245 # define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117
246 # define PKCS12_F_PKCS12_KEY_GEN_ASC 110
247 # define PKCS12_F_PKCS12_KEY_GEN_UNI 111
248 # define PKCS12_F_PKCS12_KEY_GEN_UTF8 116
249 # define PKCS12_F_PKCS12_NEWPASS 128
250 # define PKCS12_F_PKCS12_PACK_P7DATA 114
251 # define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
252 # define PKCS12_F_PKCS12_PARSE 118
253 # define PKCS12_F_PKCS12_PBE_CRYPT 119
254 # define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
255 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_P8INF 112
256 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_PKCS8 113
257 # define PKCS12_F_PKCS12_SAFEBAG_CREATE_PKCS8_ENCRYPT 133
258 # define PKCS12_F_PKCS12_SETUP_MAC 122
259 # define PKCS12_F_PKCS12_SET_MAC 123
260 # define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130
261 # define PKCS12_F_PKCS12_UNPACK_P7DATA 131
262 # define PKCS12_F_PKCS12_VERIFY_MAC 126
263 # define PKCS12_F_PKCS8_ENCRYPT 125
264 # define PKCS12_F_PKCS8_SET0_PBE 132
267 # define PKCS12_R_CANT_PACK_STRUCTURE 100
268 # define PKCS12_R_CONTENT_TYPE_NOT_DATA 121
269 # define PKCS12_R_DECODE_ERROR 101
270 # define PKCS12_R_ENCODE_ERROR 102
271 # define PKCS12_R_ENCRYPT_ERROR 103
272 # define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120
273 # define PKCS12_R_INVALID_NULL_ARGUMENT 104
274 # define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
275 # define PKCS12_R_IV_GEN_ERROR 106
276 # define PKCS12_R_KEY_GEN_ERROR 107
277 # define PKCS12_R_MAC_ABSENT 108
278 # define PKCS12_R_MAC_GENERATION_ERROR 109
279 # define PKCS12_R_MAC_SETUP_ERROR 110
280 # define PKCS12_R_MAC_STRING_SET_ERROR 111
281 # define PKCS12_R_MAC_VERIFY_FAILURE 113
282 # define PKCS12_R_PARSE_ERROR 114
283 # define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
284 # define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
285 # define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
286 # define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
287 # define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119