]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/pkcs12/pkcs12.h
Fixes for Win32 build.
[thirdparty/openssl.git] / crypto / pkcs12 / pkcs12.h
CommitLineData
8d8c7266
DSH
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
82271cee
RL
62#include <openssl/bio.h>
63#include <openssl/x509.h>
64
8d8c7266
DSH
65#ifdef __cplusplus
66extern "C" {
67#endif
68
8d8c7266
DSH
69#define PKCS12_KEY_ID 1
70#define PKCS12_IV_ID 2
71#define PKCS12_MAC_ID 3
72
e84240d4
DSH
73/* Default iteration count */
74#ifndef PKCS12_DEFAULT_ITER
b7d135b3 75#define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
e84240d4
DSH
76#endif
77
8d8c7266
DSH
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
8d8c7266
DSH
99typedef struct {
100X509_SIG *dinfo;
101ASN1_OCTET_STRING *salt;
102ASN1_INTEGER *iter; /* defaults to 1 */
103} PKCS12_MAC_DATA;
104
105typedef struct {
106ASN1_INTEGER *version;
107PKCS12_MAC_DATA *mac;
108PKCS7 *authsafes;
109} PKCS12;
110
f2716dad
BL
111PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
112
8d8c7266
DSH
113typedef struct {
114ASN1_OBJECT *type;
115union {
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 */
f2716dad 119 STACK_OF(PKCS12_SAFEBAG) *safes;
8d8c7266
DSH
120 ASN1_TYPE *other;
121}value;
84c15db5 122STACK_OF(X509_ATTRIBUTE) *attrib;
8d8c7266
DSH
123ASN1_TYPE *rest;
124} PKCS12_SAFEBAG;
125
f2716dad
BL
126DECLARE_STACK_OF(PKCS12_SAFEBAG)
127DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
128DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
129
8d8c7266
DSH
130typedef struct pkcs12_bag_st {
131ASN1_OBJECT *type;
132union {
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) \
7ef82068 149PKCS12_pack_safebag((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
8d8c7266
DSH
150
151#define M_PKCS12_x509crl2certbag(crl) \
7ef82068 152PKCS12_pack_safebag((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
8d8c7266
DSH
153
154#define M_PKCS12_certbag2x509(bg) \
7ef82068 155(X509 *) ASN1_unpack_string((bg)->value.bag->value.octet, \
8d8c7266
DSH
156(char *(*)())d2i_X509)
157
158#define M_PKCS12_certbag2x509crl(bg) \
7ef82068 159(X509CRL *) ASN1_unpack_string((bg)->value.bag->value.octet, \
8d8c7266
DSH
160(char *(*)())d2i_X509CRL)
161
162/*#define M_PKCS12_pkcs82rsa(p8) \
7ef82068 163(RSA *) ASN1_unpack_string((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
8d8c7266
DSH
164
165#define M_PKCS12_unpack_p7data(p7) \
7ef82068 166ASN1_seq_unpack_PKCS12_SAFEBAG((p7)->d.data->data, p7->d.data->length, \
f2716dad 167 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
8d8c7266
DSH
168
169#define M_PKCS12_pack_authsafes(p12, safes) \
5de603ab 170ASN1_seq_pack_PKCS7((safes), i2d_PKCS7,\
8d8c7266
DSH
171 &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
172
173#define M_PKCS12_unpack_authsafes(p12) \
5de603ab
BL
174ASN1_seq_unpack_PKCS7((p12)->authsafes->d.data->data, \
175 (p12)->authsafes->d.data->length, d2i_PKCS7, PKCS7_free)
8d8c7266
DSH
176
177#define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
7ef82068 178PKCS12_decrypt_d2i_PKCS12_SAFEBAG((p7)->d.encrypted->enc_data->algorithm,\
f2716dad
BL
179 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
180 (pass), (passlen), \
181 (p7)->d.encrypted->enc_data->enc_data, 3)
8d8c7266
DSH
182
183#define M_PKCS12_decrypt_skey(bag, pass, passlen) \
7ef82068 184(PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i((bag)->value.shkeybag->algor, \
13083215 185(char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (void (*)(void *))PKCS8_PRIV_KEY_INFO_free, \
8d8c7266
DSH
186 (pass), (passlen), \
187 (bag)->value.shkeybag->digest, 2)
188
189#define M_PKCS8_decrypt(p8, pass, passlen) \
7ef82068 190(PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i((p8)->algor, \
13083215 191(char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (void (*)(void *))PKCS8_PRIV_KEY_INFO_free,\
b0c6fb80 192 (pass), (passlen), (p8)->digest, 2)
8d8c7266
DSH
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
8d8c7266 202
8d8c7266 203PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
8d8c7266 204PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
8eb57af5
DSH
205X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
206 const char *pass, int passlen,
61f5b6f3
BL
207 unsigned char *salt, int saltlen, int iter,
208 PKCS8_PRIV_KEY_INFO *p8);
209PKCS12_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);
f2716dad 213PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
61f5b6f3
BL
214PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
215 unsigned char *salt, int saltlen, int iter,
f2716dad 216 STACK_OF(PKCS12_SAFEBAG) *bags);
8d8c7266 217int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
61f5b6f3
BL
218int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
219 int namelen);
220int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
221 int namelen);
8d8c7266 222int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
84c15db5 223ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
8d8c7266 224char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
61f5b6f3
BL
225unsigned 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);
228char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
13083215 229 void (*free_func)(void *), const char *pass, int passlen,
61f5b6f3
BL
230 ASN1_STRING *oct, int seq);
231ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
232 const char *pass, int passlen, char *obj,
233 int seq);
8d8c7266 234PKCS12 *PKCS12_init(int mode);
61f5b6f3
BL
235int 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);
e778802f 238int 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);
2bd83ca1
DSH
239int 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);
69cbf468
DSH
242int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
243 unsigned char *mac, unsigned int *maclen);
61f5b6f3
BL
244int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
245int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
246 unsigned char *salt, int saltlen, int iter,
247 EVP_MD *md_type);
69cbf468
DSH
248int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
249 int saltlen, EVP_MD *md_type);
61f5b6f3 250unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
8d8c7266 251char *uni2asc(unsigned char *uni, int unilen);
8d8c7266
DSH
252int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
253PKCS12_BAGS *PKCS12_BAGS_new(void);
254PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
255void PKCS12_BAGS_free(PKCS12_BAGS *a);
256int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
257PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
258PKCS12 *PKCS12_new(void);
259void PKCS12_free(PKCS12 *a);
260int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
261PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
69cbf468
DSH
262PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
263 long length);
8d8c7266
DSH
264void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
265int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
266PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
69cbf468
DSH
267PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
268 long length);
8d8c7266
DSH
269void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
270void ERR_load_PKCS12_strings(void);
8d8c7266 271void PKCS12_PBE_add(void);
61f5b6f3 272int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
e77066ea 273 STACK_OF(X509) **ca);
69cbf468 274PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
e77066ea 275 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
69cbf468 276 int mac_iter, int keytype);
8d8c7266
DSH
277int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
278int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
279PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
280PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
21131f00 281int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
8d8c7266 282
8d8c7266 283/* BEGIN ERROR CODES */
6d311938
DSH
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
8d8c7266
DSH
288/* Error codes for the PKCS12 functions. */
289
290/* Function codes. */
8d8c7266 291#define PKCS12_F_PARSE_BAGS 103
6e781e8e
DSH
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
8d8c7266
DSH
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
6e781e8e 303#define PKCS12_F_PKCS12_MAKE_KEYBAG 112
8d8c7266 304#define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
21131f00 305#define PKCS12_F_PKCS12_NEWPASS 128
8d8c7266
DSH
306#define PKCS12_F_PKCS12_PACK_P7DATA 114
307#define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
8d8c7266
DSH
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
8d8c7266
DSH
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
c6c34506 323#define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120
8d8c7266
DSH
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
6d311938 340
8d8c7266
DSH
341#ifdef __cplusplus
342}
343#endif
344#endif
345