76aa2c41a4c90c7892e4e773dfb3587489592202
[openssl.git] / include / openssl / pkcs12.h
1 /*
2  * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #ifndef HEADER_PKCS12_H
11 # define HEADER_PKCS12_H
12
13 # include <openssl/bio.h>
14 # include <openssl/x509.h>
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 # define PKCS12_KEY_ID   1
21 # define PKCS12_IV_ID    2
22 # define PKCS12_MAC_ID   3
23
24 /* Default iteration count */
25 # ifndef PKCS12_DEFAULT_ITER
26 #  define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER
27 # endif
28
29 # define PKCS12_MAC_KEY_LENGTH 20
30
31 # define PKCS12_SALT_LEN 8
32
33 /* Uncomment out next line for unicode password and names, otherwise ASCII */
34
35 /*
36  * #define PBE_UNICODE
37  */
38
39 # ifdef PBE_UNICODE
40 #  define PKCS12_key_gen PKCS12_key_gen_uni
41 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
42 # else
43 #  define PKCS12_key_gen PKCS12_key_gen_asc
44 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
45 # endif
46
47 /* MS key usage constants */
48
49 # define KEY_EX  0x10
50 # define KEY_SIG 0x80
51
52 typedef struct PKCS12_MAC_DATA_st PKCS12_MAC_DATA;
53
54 typedef struct PKCS12_st PKCS12;
55
56 typedef struct PKCS12_SAFEBAG_st PKCS12_SAFEBAG;
57
58 DEFINE_STACK_OF(PKCS12_SAFEBAG)
59
60 typedef struct pkcs12_bag_st PKCS12_BAGS;
61
62 # define PKCS12_ERROR    0
63 # define PKCS12_OK       1
64
65 /* Compatibility macros */
66
67 #if OPENSSL_API_COMPAT < 0x10100000L
68
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
72
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
81
82 #endif
83
84 DEPRECATEDIN_1_1_0(ASN1_TYPE *PKCS12_get_attr(const PKCS12_SAFEBAG *bag, int attr_nid))
85
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,
92                      const PKCS12 *p12);
93
94 const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
95                                           int attr_nid);
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);
99
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);
106
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,
112                                                     const char *pass,
113                                                     int passlen,
114                                                     unsigned char *salt,
115                                                     int saltlen, int iter,
116                                                     PKCS8_PRIV_KEY_INFO *p8inf);
117
118 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
119                                          int nid1, int nid2);
120 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
121                                    int passlen);
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,
135                                                   int passlen);
136
137 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
138 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12);
139
140 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
141                           int namelen);
142 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
143                                 int namelen);
144 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
145                            int namelen);
146 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
147                                 const unsigned char *name, int namelen);
148 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
149 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
150                                int attr_nid);
151 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
152 const STACK_OF(X509_ATTRIBUTE) *
153 PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
154 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
155                                 const char *pass, int passlen,
156                                 const unsigned char *in, int inlen,
157                                 unsigned char **data, int *datalen,
158                                 int en_de);
159 void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it,
160                               const char *pass, int passlen,
161                               const ASN1_OCTET_STRING *oct, int zbuf);
162 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
163                                            const ASN1_ITEM *it,
164                                            const char *pass, int passlen,
165                                            void *obj, int zbuf);
166 PKCS12 *PKCS12_init(int mode);
167 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
168                        int saltlen, int id, int iter, int n,
169                        unsigned char *out, const EVP_MD *md_type);
170 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
171                        int saltlen, int id, int iter, int n,
172                        unsigned char *out, const EVP_MD *md_type);
173 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
174                         ASN1_TYPE *param, const EVP_CIPHER *cipher,
175                         const EVP_MD *md_type, int en_de);
176 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
177                    unsigned char *mac, unsigned int *maclen);
178 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
179 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
180                    unsigned char *salt, int saltlen, int iter,
181                    const EVP_MD *md_type);
182 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
183                      int saltlen, const EVP_MD *md_type);
184 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
185                                unsigned char **uni, int *unilen);
186 char *OPENSSL_uni2asc(unsigned char *uni, int unilen);
187
188 DECLARE_ASN1_FUNCTIONS(PKCS12)
189 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
190 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
191 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
192
193 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
194 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
195
196 void PKCS12_PBE_add(void);
197 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
198                  STACK_OF(X509) **ca);
199 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
200                       X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
201                       int iter, int mac_iter, int keytype);
202
203 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
204 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
205                                EVP_PKEY *key, int key_usage, int iter,
206                                int key_nid, const char *pass);
207 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
208                     int safe_nid, int iter, const char *pass);
209 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
210
211 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
212 # ifndef OPENSSL_NO_STDIO
213 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
214 # endif
215 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
216 # ifndef OPENSSL_NO_STDIO
217 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
218 # endif
219 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
220
221 /* BEGIN ERROR CODES */
222 /*
223  * The following lines are auto generated by the script mkerr.pl. Any changes
224  * made after this point may be overwritten when the script is next run.
225  */
226
227 int ERR_load_PKCS12_strings(void);
228
229 /* Error codes for the PKCS12 functions. */
230
231 /* Function codes. */
232 # define PKCS12_F_PKCS12_CREATE                           105
233 # define PKCS12_F_PKCS12_GEN_MAC                          107
234 # define PKCS12_F_PKCS12_INIT                             109
235 # define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I                 106
236 # define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT                 108
237 # define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG                117
238 # define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
239 # define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
240 # define PKCS12_F_PKCS12_NEWPASS                          128
241 # define PKCS12_F_PKCS12_PACK_P7DATA                      114
242 # define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
243 # define PKCS12_F_PKCS12_PARSE                            118
244 # define PKCS12_F_PKCS12_PBE_CRYPT                        119
245 # define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
246 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_P8INF            112
247 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_PKCS8            113
248 # define PKCS12_F_PKCS12_SAFEBAG_CREATE_PKCS8_ENCRYPT     133
249 # define PKCS12_F_PKCS12_SETUP_MAC                        122
250 # define PKCS12_F_PKCS12_SET_MAC                          123
251 # define PKCS12_F_PKCS12_UNPACK_AUTHSAFES                 130
252 # define PKCS12_F_PKCS12_UNPACK_P7DATA                    131
253 # define PKCS12_F_PKCS12_VERIFY_MAC                       126
254 # define PKCS12_F_PKCS8_ENCRYPT                           125
255 # define PKCS12_F_PKCS8_SET0_PBE                          132
256
257 /* Reason codes. */
258 # define PKCS12_R_CANT_PACK_STRUCTURE                     100
259 # define PKCS12_R_CONTENT_TYPE_NOT_DATA                   121
260 # define PKCS12_R_DECODE_ERROR                            101
261 # define PKCS12_R_ENCODE_ERROR                            102
262 # define PKCS12_R_ENCRYPT_ERROR                           103
263 # define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
264 # define PKCS12_R_INVALID_NULL_ARGUMENT                   104
265 # define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
266 # define PKCS12_R_IV_GEN_ERROR                            106
267 # define PKCS12_R_KEY_GEN_ERROR                           107
268 # define PKCS12_R_MAC_ABSENT                              108
269 # define PKCS12_R_MAC_GENERATION_ERROR                    109
270 # define PKCS12_R_MAC_SETUP_ERROR                         110
271 # define PKCS12_R_MAC_STRING_SET_ERROR                    111
272 # define PKCS12_R_MAC_VERIFY_FAILURE                      113
273 # define PKCS12_R_PARSE_ERROR                             114
274 # define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
275 # define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
276 # define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
277 # define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
278 # define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
279
280 # ifdef  __cplusplus
281 }
282 # endif
283 #endif