4cf92b68eaa1c54af147aecc1a4c1aea2f798370
[openssl.git] / crypto / pkcs12 / pkcs12.h
1 /* pkcs12.h */
2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
3  * project 1999.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  *
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).
56  *
57  */
58
59 #ifndef HEADER_PKCS12_H
60 #define HEADER_PKCS12_H
61
62 #include <openssl/bio.h>
63 #include <openssl/x509.h>
64
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68
69 #define PKCS12_KEY_ID   1
70 #define PKCS12_IV_ID    2
71 #define PKCS12_MAC_ID   3
72
73 /* Default iteration count */
74 #ifndef PKCS12_DEFAULT_ITER
75 #define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER
76 #endif
77
78 #define PKCS12_MAC_KEY_LENGTH 20
79
80 #define PKCS12_SALT_LEN 8
81
82 /* Uncomment out next line for unicode password and names, otherwise ASCII */
83
84 /*#define PBE_UNICODE*/
85
86 #ifdef PBE_UNICODE
87 #define PKCS12_key_gen PKCS12_key_gen_uni
88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
89 #else
90 #define PKCS12_key_gen PKCS12_key_gen_asc
91 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
92 #endif
93
94 /* MS key usage constants */
95
96 #define KEY_EX  0x10
97 #define KEY_SIG 0x80
98
99 typedef struct {
100 X509_SIG *dinfo;
101 ASN1_OCTET_STRING *salt;
102 ASN1_INTEGER *iter;     /* defaults to 1 */
103 } PKCS12_MAC_DATA;
104
105 typedef struct {
106 ASN1_INTEGER *version;
107 PKCS12_MAC_DATA *mac;
108 PKCS7 *authsafes;
109 } PKCS12;
110
111 PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
112
113 typedef struct {
114 ASN1_OBJECT *type;
115 union {
116         struct pkcs12_bag_st *bag; /* secret, crl and certbag */
117         struct pkcs8_priv_key_info_st   *keybag; /* keybag */
118         X509_SIG *shkeybag; /* shrouded key bag */
119         STACK_OF(PKCS12_SAFEBAG) *safes;
120         ASN1_TYPE *other;
121 }value;
122 STACK_OF(X509_ATTRIBUTE) *attrib;
123 ASN1_TYPE *rest;
124 } PKCS12_SAFEBAG;
125
126 DECLARE_STACK_OF(PKCS12_SAFEBAG)
127 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
128 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
129
130 typedef struct pkcs12_bag_st {
131 ASN1_OBJECT *type;
132 union {
133         ASN1_OCTET_STRING *x509cert;
134         ASN1_OCTET_STRING *x509crl;
135         ASN1_OCTET_STRING *octet;
136         ASN1_IA5STRING *sdsicert;
137         ASN1_TYPE *other; /* Secret or other bag */
138 }value;
139 } PKCS12_BAGS;
140
141 #define PKCS12_ERROR    0
142 #define PKCS12_OK       1
143
144 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
145 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
146 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
147
148 #define M_PKCS12_x5092certbag(x509) \
149 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
150
151 #define M_PKCS12_x509crl2certbag(crl) \
152 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
153
154 #define M_PKCS12_certbag2x509(bg) \
155 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
156 (char *(*)())d2i_X509)
157
158 #define M_PKCS12_certbag2x509crl(bg) \
159 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
160 (char *(*)())d2i_X509CRL)
161
162 /*#define M_PKCS12_pkcs82rsa(p8) \
163 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
164
165 #define M_PKCS12_unpack_p7data(p7) \
166 ASN1_seq_unpack_PKCS12_SAFEBAG ((p7)->d.data->data, p7->d.data->length, \
167                                 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
168
169 #define M_PKCS12_pack_authsafes(p12, safes) \
170 ASN1_seq_pack_PKCS7((safes), i2d_PKCS7,\
171         &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
172
173 #define M_PKCS12_unpack_authsafes(p12) \
174 ASN1_seq_unpack_PKCS7((p12)->authsafes->d.data->data, \
175                 (p12)->authsafes->d.data->length, d2i_PKCS7, PKCS7_free)
176
177 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
178 PKCS12_decrypt_d2i_PKCS12_SAFEBAG ((p7)->d.encrypted->enc_data->algorithm,\
179                                    d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
180                                    (pass), (passlen), \
181                                    (p7)->d.encrypted->enc_data->enc_data, 3)
182
183 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
184 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
185 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
186                                                 (pass), (passlen), \
187                          (bag)->value.shkeybag->digest, 2)
188
189 #define M_PKCS8_decrypt(p8, pass, passlen) \
190 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
191 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free,\
192                          (pass), (passlen), (p8)->digest, 2)
193
194 #define PKCS12_get_attr(bag, attr_nid) \
195                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
196
197 #define PKCS8_get_attr(p8, attr_nid) \
198                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
199
200 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
201
202
203 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
204 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
205 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 
206                         const char *pass, int passlen,
207                         unsigned char *salt, int saltlen, int iter,
208                         PKCS8_PRIV_KEY_INFO *p8);
209 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
210                                      int passlen, unsigned char *salt,
211                                      int saltlen, int iter,
212                                      PKCS8_PRIV_KEY_INFO *p8);
213 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
214 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
215                              unsigned char *salt, int saltlen, int iter,
216                              STACK_OF(PKCS12_SAFEBAG) *bags);
217 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
218 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
219                                 int namelen);
220 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
221                                 int namelen);
222 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
223 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
224 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
225 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
226                                 int passlen, unsigned char *in, int inlen,
227                                 unsigned char **data, int *datalen, int en_de);
228 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
229                          void (*free_func)(), const char *pass, int passlen,
230                          ASN1_STRING *oct, int seq);
231 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
232                                 const char *pass, int passlen, char *obj,
233                                 int seq);
234 PKCS12 *PKCS12_init(int mode);
235 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
236                        int saltlen, int id, int iter, int n,
237                        unsigned char *out, const EVP_MD *md_type);
238 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);
239 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
240                          ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type,
241                          int en_de);
242 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
243                          unsigned char *mac, unsigned int *maclen);
244 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
245 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
246                    unsigned char *salt, int saltlen, int iter,
247                    EVP_MD *md_type);
248 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
249                                          int saltlen, EVP_MD *md_type);
250 unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
251 char *uni2asc(unsigned char *uni, int unilen);
252 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
253 PKCS12_BAGS *PKCS12_BAGS_new(void);
254 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
255 void PKCS12_BAGS_free(PKCS12_BAGS *a);
256 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
257 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
258 PKCS12 *PKCS12_new(void);
259 void PKCS12_free(PKCS12 *a);
260 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
261 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
262 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
263                                                                  long length);
264 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
265 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
266 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
267 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
268                                                                  long length);
269 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
270 void ERR_load_PKCS12_strings(void);
271 void PKCS12_PBE_add(void);
272 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
273                  STACK_OF(X509) **ca);
274 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
275                          STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
276                                                  int mac_iter, int keytype);
277 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
278 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
279 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
280 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
281 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
282
283 /* BEGIN ERROR CODES */
284 /* The following lines are auto generated by the script mkerr.pl. Any changes
285  * made after this point may be overwritten when the script is next run.
286  */
287
288 /* Error codes for the PKCS12 functions. */
289
290 /* Function codes. */
291 #define PKCS12_F_PARSE_BAGS                              103
292 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100
293 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127
294 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102
295 #define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
296 #define PKCS12_F_PKCS12_CREATE                           105
297 #define PKCS12_F_PKCS12_DECRYPT_D2I                      106
298 #define PKCS12_F_PKCS12_GEN_MAC                          107
299 #define PKCS12_F_PKCS12_I2D_ENCRYPT                      108
300 #define PKCS12_F_PKCS12_INIT                             109
301 #define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
302 #define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
303 #define PKCS12_F_PKCS12_MAKE_KEYBAG                      112
304 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
305 #define PKCS12_F_PKCS12_NEWPASS                          128
306 #define PKCS12_F_PKCS12_PACK_P7DATA                      114
307 #define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
308 #define PKCS12_F_PKCS12_PACK_SAFEBAG                     117
309 #define PKCS12_F_PKCS12_PARSE                            118
310 #define PKCS12_F_PKCS12_PBE_CRYPT                        119
311 #define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
312 #define PKCS12_F_PKCS12_SETUP_MAC                        122
313 #define PKCS12_F_PKCS12_SET_MAC                          123
314 #define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
315 #define PKCS12_F_PKCS8_ENCRYPT                           125
316 #define PKCS12_F_VERIFY_MAC                              126
317
318 /* Reason codes. */
319 #define PKCS12_R_CANT_PACK_STRUCTURE                     100
320 #define PKCS12_R_DECODE_ERROR                            101
321 #define PKCS12_R_ENCODE_ERROR                            102
322 #define PKCS12_R_ENCRYPT_ERROR                           103
323 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
324 #define PKCS12_R_INVALID_NULL_ARGUMENT                   104
325 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
326 #define PKCS12_R_IV_GEN_ERROR                            106
327 #define PKCS12_R_KEY_GEN_ERROR                           107
328 #define PKCS12_R_MAC_ABSENT                              108
329 #define PKCS12_R_MAC_GENERATION_ERROR                    109
330 #define PKCS12_R_MAC_SETUP_ERROR                         110
331 #define PKCS12_R_MAC_STRING_SET_ERROR                    111
332 #define PKCS12_R_MAC_VERIFY_ERROR                        112
333 #define PKCS12_R_MAC_VERIFY_FAILURE                      113
334 #define PKCS12_R_PARSE_ERROR                             114
335 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
336 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
337 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
338 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
339 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
340
341 #ifdef  __cplusplus
342 }
343 #endif
344 #endif
345