xref: /openbsd/lib/libcrypto/pkcs12/pkcs12.h (revision a49530d7)
1 /* $OpenBSD: pkcs12.h,v 1.28 2024/03/02 10:15:16 tb Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) 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 PKCS12_MAC_DATA_st PKCS12_MAC_DATA;
100 
101 typedef struct PKCS12_st PKCS12;
102 
103 typedef struct PKCS12_SAFEBAG_st PKCS12_SAFEBAG;
104 
105 DECLARE_STACK_OF(PKCS12_SAFEBAG)
106 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
107 
108 typedef struct pkcs12_bag_st PKCS12_BAGS;
109 
110 #define PKCS12_ERROR	0
111 #define PKCS12_OK	1
112 
113 #ifndef LIBRESSL_INTERNAL
114 
115 /* Compatibility macros */
116 
117 #define M_PKCS12_x5092certbag PKCS12_x5092certbag
118 #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
119 
120 #define M_PKCS12_certbag2x509 PKCS12_certbag2x509
121 #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl
122 
123 #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
124 #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
125 #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
126 #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
127 
128 #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
129 #define M_PKCS8_decrypt PKCS8_decrypt
130 
131 #endif /* !LIBRESSL_INTERNAL */
132 
133 #define M_PKCS12_bag_type	PKCS12_bag_type
134 #define M_PKCS12_cert_bag_type	PKCS12_cert_bag_type
135 #define M_PKCS12_crl_bag_type	PKCS12_cert_bag_type
136 
137 #define PKCS12_bag_type		PKCS12_SAFEBAG_get_nid
138 #define PKCS12_cert_bag_type	PKCS12_SAFEBAG_get_bag_nid
139 
140 #define PKCS12_certbag2x509	PKCS12_SAFEBAG_get1_cert
141 #define PKCS12_certbag2x509crl	PKCS12_SAFEBAG_get1_crl
142 
143 #define PKCS12_x5092certbag	PKCS12_SAFEBAG_create_cert
144 #define PKCS12_x509crl2certbag	PKCS12_SAFEBAG_create_crl
145 #define PKCS12_MAKE_KEYBAG	PKCS12_SAFEBAG_create0_p8inf
146 #define PKCS12_MAKE_SHKEYBAG	PKCS12_SAFEBAG_create_pkcs8_encrypt
147 
148 const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
149     int attr_nid);
150 const STACK_OF(X509_ATTRIBUTE) *
151     PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
152 int PKCS12_SAFEBAG_get_nid(const PKCS12_SAFEBAG *bag);
153 int PKCS12_SAFEBAG_get_bag_nid(const PKCS12_SAFEBAG *bag);
154 
155 X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
156 X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
157 
158 ASN1_TYPE *PKCS8_get_attr(PKCS8_PRIV_KEY_INFO *p8, int attr_nid);
159 int PKCS12_mac_present(const PKCS12 *p12);
160 void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac, const X509_ALGOR **pmacalg,
161     const ASN1_OCTET_STRING **psalt, const ASN1_INTEGER **piter,
162     const PKCS12 *p12);
163 
164 const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
165 const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);
166 const STACK_OF(PKCS12_SAFEBAG) *
167     PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
168 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag);
169 
170 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
171     int passlen);
172 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
173     const char *pass, int passlen);
174 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
175     const char *pass, int passlen, unsigned char *salt, int saltlen, int iter,
176     PKCS8_PRIV_KEY_INFO *p8);
177 
178 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
179 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
180     int passlen);
181 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12);
182 
183 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
184 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
185 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
186 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
187     unsigned char *salt, int saltlen, int iter,
188     const EVP_MD *md_type);
189 
190 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
191     unsigned char **uni, int *unilen);
192 char *OPENSSL_uni2asc(const unsigned char *uni, int unilen);
193 
194 PKCS12 *PKCS12_new(void);
195 void PKCS12_free(PKCS12 *a);
196 PKCS12 *d2i_PKCS12(PKCS12 **a, const unsigned char **in, long len);
197 int i2d_PKCS12(PKCS12 *a, unsigned char **out);
198 extern const ASN1_ITEM PKCS12_it;
199 
200 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
201 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
202 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, const unsigned char **in, long len);
203 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **out);
204 extern const ASN1_ITEM PKCS12_SAFEBAG_it;
205 
206 void PKCS12_PBE_add(void);
207 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
208     STACK_OF(X509) **ca);
209 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
210     X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
211     int mac_iter, int keytype);
212 
213 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
214 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
215 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
216 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
217 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
218 
219 void ERR_load_PKCS12_strings(void);
220 
221 /* Error codes for the PKCS12 functions. */
222 
223 /* Function codes. */
224 #define PKCS12_F_PARSE_BAG				 129
225 #define PKCS12_F_PARSE_BAGS				 103
226 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME		 100
227 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC		 127
228 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI		 102
229 #define PKCS12_F_PKCS12_ADD_LOCALKEYID			 104
230 #define PKCS12_F_PKCS12_CREATE				 105
231 #define PKCS12_F_PKCS12_GEN_MAC				 107
232 #define PKCS12_F_PKCS12_INIT				 109
233 #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I		 106
234 #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT		 108
235 #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG		 117
236 #define PKCS12_F_PKCS12_KEY_GEN_ASC			 110
237 #define PKCS12_F_PKCS12_KEY_GEN_UNI			 111
238 #define PKCS12_F_PKCS12_MAKE_KEYBAG			 112
239 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG			 113
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_SETUP_MAC			 122
247 #define PKCS12_F_PKCS12_SET_MAC				 123
248 #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES		 130
249 #define PKCS12_F_PKCS12_UNPACK_P7DATA			 131
250 #define PKCS12_F_PKCS12_VERIFY_MAC			 126
251 #define PKCS12_F_PKCS8_ADD_KEYUSAGE			 124
252 #define PKCS12_F_PKCS8_ENCRYPT				 125
253 
254 /* Reason codes. */
255 #define PKCS12_R_CANT_PACK_STRUCTURE			 100
256 #define PKCS12_R_CONTENT_TYPE_NOT_DATA			 121
257 #define PKCS12_R_DECODE_ERROR				 101
258 #define PKCS12_R_ENCODE_ERROR				 102
259 #define PKCS12_R_ENCRYPT_ERROR				 103
260 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE	 120
261 #define PKCS12_R_INVALID_NULL_ARGUMENT			 104
262 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER		 105
263 #define PKCS12_R_IV_GEN_ERROR				 106
264 #define PKCS12_R_KEY_GEN_ERROR				 107
265 #define PKCS12_R_MAC_ABSENT				 108
266 #define PKCS12_R_MAC_GENERATION_ERROR			 109
267 #define PKCS12_R_MAC_SETUP_ERROR			 110
268 #define PKCS12_R_MAC_STRING_SET_ERROR			 111
269 #define PKCS12_R_MAC_VERIFY_ERROR			 112
270 #define PKCS12_R_MAC_VERIFY_FAILURE			 113
271 #define PKCS12_R_PARSE_ERROR				 114
272 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR		 115
273 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR		 116
274 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR			 117
275 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM		 118
276 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE		 119
277 
278 #ifdef  __cplusplus
279 }
280 #endif
281 #endif
282