1 /* $OpenBSD: pkcs12.h,v 1.27 2022/09/11 17:30:13 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 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_cert(X509 *x509); 165 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_crl(X509_CRL *crl); 166 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_p8inf(PKCS8_PRIV_KEY_INFO *p8); 167 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_pkcs8(X509_SIG *p8); 168 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_pkcs8_encrypt(int pbe_nid, 169 const char *pass, int passlen, unsigned char *salt, int saltlen, int iter, 170 PKCS8_PRIV_KEY_INFO *p8); 171 172 const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag); 173 const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag); 174 const STACK_OF(PKCS12_SAFEBAG) * 175 PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag); 176 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag); 177 178 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, 179 int nid1, int nid2); 180 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass, 181 int passlen); 182 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag, 183 const char *pass, int passlen); 184 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 185 const char *pass, int passlen, unsigned char *salt, int saltlen, int iter, 186 PKCS8_PRIV_KEY_INFO *p8); 187 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); 188 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7); 189 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, 190 unsigned char *salt, int saltlen, int iter, STACK_OF(PKCS12_SAFEBAG) *bags); 191 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, 192 int passlen); 193 194 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); 195 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12); 196 197 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, 198 int namelen); 199 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, 200 int namelen); 201 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, 202 int namelen); 203 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, 204 int namelen); 205 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); 206 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs, 207 int attr_nid); 208 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); 209 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor, const char *pass, 210 int passlen, const unsigned char *in, int inlen, unsigned char **data, 211 int *datalen, int en_de); 212 void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it, 213 const char *pass, int passlen, const ASN1_OCTET_STRING *oct, int zbuf); 214 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, 215 const ASN1_ITEM *it, const char *pass, int passlen, void *obj, int zbuf); 216 PKCS12 *PKCS12_init(int mode); 217 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, 218 int saltlen, int id, int iter, int n, unsigned char *out, 219 const EVP_MD *md_type); 220 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, 221 int saltlen, int id, int iter, int n, unsigned char *out, 222 const EVP_MD *md_type); 223 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, 224 ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type, 225 int en_de); 226 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, 227 unsigned char *mac, unsigned int *maclen); 228 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); 229 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, 230 unsigned char *salt, int saltlen, int iter, 231 const EVP_MD *md_type); 232 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, 233 int saltlen, const EVP_MD *md_type); 234 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen, 235 unsigned char **uni, int *unilen); 236 char *OPENSSL_uni2asc(const unsigned char *uni, int unilen); 237 238 PKCS12 *PKCS12_new(void); 239 void PKCS12_free(PKCS12 *a); 240 PKCS12 *d2i_PKCS12(PKCS12 **a, const unsigned char **in, long len); 241 int i2d_PKCS12(PKCS12 *a, unsigned char **out); 242 extern const ASN1_ITEM PKCS12_it; 243 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void); 244 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a); 245 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, const unsigned char **in, long len); 246 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **out); 247 extern const ASN1_ITEM PKCS12_MAC_DATA_it; 248 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void); 249 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a); 250 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, const unsigned char **in, long len); 251 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **out); 252 extern const ASN1_ITEM PKCS12_SAFEBAG_it; 253 PKCS12_BAGS *PKCS12_BAGS_new(void); 254 void PKCS12_BAGS_free(PKCS12_BAGS *a); 255 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, const unsigned char **in, long len); 256 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **out); 257 extern const ASN1_ITEM PKCS12_BAGS_it; 258 259 extern const ASN1_ITEM PKCS12_SAFEBAGS_it; 260 extern const ASN1_ITEM PKCS12_AUTHSAFES_it; 261 262 void PKCS12_PBE_add(void); 263 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, 264 STACK_OF(X509) **ca); 265 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey, 266 X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, 267 int mac_iter, int keytype); 268 269 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert); 270 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key, 271 int key_usage, int iter, int key_nid, const char *pass); 272 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, 273 int safe_nid, int iter, const char *pass); 274 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); 275 276 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); 277 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); 278 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); 279 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); 280 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass); 281 282 void ERR_load_PKCS12_strings(void); 283 284 /* Error codes for the PKCS12 functions. */ 285 286 /* Function codes. */ 287 #define PKCS12_F_PARSE_BAG 129 288 #define PKCS12_F_PARSE_BAGS 103 289 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 290 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 291 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 292 #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 293 #define PKCS12_F_PKCS12_CREATE 105 294 #define PKCS12_F_PKCS12_GEN_MAC 107 295 #define PKCS12_F_PKCS12_INIT 109 296 #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106 297 #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108 298 #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117 299 #define PKCS12_F_PKCS12_KEY_GEN_ASC 110 300 #define PKCS12_F_PKCS12_KEY_GEN_UNI 111 301 #define PKCS12_F_PKCS12_MAKE_KEYBAG 112 302 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 303 #define PKCS12_F_PKCS12_NEWPASS 128 304 #define PKCS12_F_PKCS12_PACK_P7DATA 114 305 #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 306 #define PKCS12_F_PKCS12_PARSE 118 307 #define PKCS12_F_PKCS12_PBE_CRYPT 119 308 #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 309 #define PKCS12_F_PKCS12_SETUP_MAC 122 310 #define PKCS12_F_PKCS12_SET_MAC 123 311 #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130 312 #define PKCS12_F_PKCS12_UNPACK_P7DATA 131 313 #define PKCS12_F_PKCS12_VERIFY_MAC 126 314 #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 315 #define PKCS12_F_PKCS8_ENCRYPT 125 316 317 /* Reason codes. */ 318 #define PKCS12_R_CANT_PACK_STRUCTURE 100 319 #define PKCS12_R_CONTENT_TYPE_NOT_DATA 121 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