155714Skris/* pkcs12.h */ 2296465Sdelphij/* 3296465Sdelphij * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project 4296465Sdelphij * 1999. 555714Skris */ 655714Skris/* ==================================================================== 755714Skris * Copyright (c) 1999 The OpenSSL Project. All rights reserved. 855714Skris * 955714Skris * Redistribution and use in source and binary forms, with or without 1055714Skris * modification, are permitted provided that the following conditions 1155714Skris * are met: 1255714Skris * 1355714Skris * 1. Redistributions of source code must retain the above copyright 14296465Sdelphij * notice, this list of conditions and the following disclaimer. 1555714Skris * 1655714Skris * 2. Redistributions in binary form must reproduce the above copyright 1755714Skris * notice, this list of conditions and the following disclaimer in 1855714Skris * the documentation and/or other materials provided with the 1955714Skris * distribution. 2055714Skris * 2155714Skris * 3. All advertising materials mentioning features or use of this 2255714Skris * software must display the following acknowledgment: 2355714Skris * "This product includes software developed by the OpenSSL Project 2455714Skris * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 2555714Skris * 2655714Skris * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 2755714Skris * endorse or promote products derived from this software without 2855714Skris * prior written permission. For written permission, please contact 2955714Skris * licensing@OpenSSL.org. 3055714Skris * 3155714Skris * 5. Products derived from this software may not be called "OpenSSL" 3255714Skris * nor may "OpenSSL" appear in their names without prior written 3355714Skris * permission of the OpenSSL Project. 3455714Skris * 3555714Skris * 6. Redistributions of any form whatsoever must retain the following 3655714Skris * acknowledgment: 3755714Skris * "This product includes software developed by the OpenSSL Project 3855714Skris * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 3955714Skris * 4055714Skris * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 4155714Skris * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4255714Skris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 4355714Skris * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 4455714Skris * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4555714Skris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 4655714Skris * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 4755714Skris * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4855714Skris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 4955714Skris * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 5055714Skris * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 5155714Skris * OF THE POSSIBILITY OF SUCH DAMAGE. 5255714Skris * ==================================================================== 5355714Skris * 5455714Skris * This product includes cryptographic software written by Eric Young 5555714Skris * (eay@cryptsoft.com). This product includes software written by Tim 5655714Skris * Hudson (tjh@cryptsoft.com). 5755714Skris * 5855714Skris */ 5955714Skris 6055714Skris#ifndef HEADER_PKCS12_H 61296465Sdelphij# define HEADER_PKCS12_H 6255714Skris 63296465Sdelphij# include <openssl/bio.h> 64296465Sdelphij# include <openssl/x509.h> 6568651Skris 6655714Skris#ifdef __cplusplus 6755714Skrisextern "C" { 6855714Skris#endif 6955714Skris 70296465Sdelphij# define PKCS12_KEY_ID 1 71296465Sdelphij# define PKCS12_IV_ID 2 72296465Sdelphij# define PKCS12_MAC_ID 3 7355714Skris 7455714Skris/* Default iteration count */ 75296465Sdelphij# ifndef PKCS12_DEFAULT_ITER 76296465Sdelphij# define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER 77296465Sdelphij# endif 7855714Skris 79296465Sdelphij# define PKCS12_MAC_KEY_LENGTH 20 8055714Skris 81296465Sdelphij# define PKCS12_SALT_LEN 8 8255714Skris 8355714Skris/* Uncomment out next line for unicode password and names, otherwise ASCII */ 8455714Skris 85296465Sdelphij/* 86296465Sdelphij * #define PBE_UNICODE 87296465Sdelphij */ 8855714Skris 89296465Sdelphij# ifdef PBE_UNICODE 90296465Sdelphij# define PKCS12_key_gen PKCS12_key_gen_uni 91296465Sdelphij# define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni 92296465Sdelphij# else 93296465Sdelphij# define PKCS12_key_gen PKCS12_key_gen_asc 94296465Sdelphij# define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc 95296465Sdelphij# endif 9655714Skris 9755714Skris/* MS key usage constants */ 9855714Skris 99296465Sdelphij# define KEY_EX 0x10 100296465Sdelphij# define KEY_SIG 0x80 10155714Skris 10255714Skristypedef struct { 103296465Sdelphij X509_SIG *dinfo; 104296465Sdelphij ASN1_OCTET_STRING *salt; 105296465Sdelphij ASN1_INTEGER *iter; /* defaults to 1 */ 10655714Skris} PKCS12_MAC_DATA; 10755714Skris 10855714Skristypedef struct { 109296465Sdelphij ASN1_INTEGER *version; 110296465Sdelphij PKCS12_MAC_DATA *mac; 111296465Sdelphij PKCS7 *authsafes; 11255714Skris} PKCS12; 11355714Skris 114296465SdelphijPREDECLARE_STACK_OF(PKCS12_SAFEBAG) typedef struct { 115296465Sdelphij ASN1_OBJECT *type; 116296465Sdelphij union { 117296465Sdelphij struct pkcs12_bag_st *bag; /* secret, crl and certbag */ 118296465Sdelphij struct pkcs8_priv_key_info_st *keybag; /* keybag */ 119296465Sdelphij X509_SIG *shkeybag; /* shrouded key bag */ 120296465Sdelphij STACK_OF(PKCS12_SAFEBAG) *safes; 121296465Sdelphij ASN1_TYPE *other; 122296465Sdelphij } value; 123296465Sdelphij STACK_OF(X509_ATTRIBUTE) *attrib; 12455714Skris} PKCS12_SAFEBAG; 12555714Skris 12668651SkrisDECLARE_STACK_OF(PKCS12_SAFEBAG) 12768651SkrisDECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) 12868651SkrisDECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) 12968651Skris 13055714Skristypedef struct pkcs12_bag_st { 131296465Sdelphij ASN1_OBJECT *type; 132296465Sdelphij union { 133296465Sdelphij ASN1_OCTET_STRING *x509cert; 134296465Sdelphij ASN1_OCTET_STRING *x509crl; 135296465Sdelphij ASN1_OCTET_STRING *octet; 136296465Sdelphij ASN1_IA5STRING *sdsicert; 137296465Sdelphij ASN1_TYPE *other; /* Secret or other bag */ 138296465Sdelphij } value; 13955714Skris} PKCS12_BAGS; 14055714Skris 141296465Sdelphij# define PKCS12_ERROR 0 142296465Sdelphij# define PKCS12_OK 1 14355714Skris 144109998Smarkm/* Compatibility macros */ 14555714Skris 146296465Sdelphij# define M_PKCS12_x5092certbag PKCS12_x5092certbag 147296465Sdelphij# define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag 14855714Skris 149296465Sdelphij# define M_PKCS12_certbag2x509 PKCS12_certbag2x509 150296465Sdelphij# define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl 15155714Skris 152296465Sdelphij# define M_PKCS12_unpack_p7data PKCS12_unpack_p7data 153296465Sdelphij# define M_PKCS12_pack_authsafes PKCS12_pack_authsafes 154296465Sdelphij# define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes 155296465Sdelphij# define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata 15655714Skris 157296465Sdelphij# define M_PKCS12_decrypt_skey PKCS12_decrypt_skey 158296465Sdelphij# define M_PKCS8_decrypt PKCS8_decrypt 15955714Skris 160296465Sdelphij# define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type) 161296465Sdelphij# define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type) 162296465Sdelphij# define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type 16355714Skris 164296465Sdelphij# define PKCS12_get_attr(bag, attr_nid) \ 165296465Sdelphij PKCS12_get_attr_gen(bag->attrib, attr_nid) 16655714Skris 167296465Sdelphij# define PKCS8_get_attr(p8, attr_nid) \ 168296465Sdelphij PKCS12_get_attr_gen(p8->attributes, attr_nid) 16955714Skris 170296465Sdelphij# define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) 17155714Skris 172109998SmarkmPKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509); 173109998SmarkmPKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl); 174109998SmarkmX509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag); 175109998SmarkmX509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag); 176109998Smarkm 177296465SdelphijPKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, 178296465Sdelphij int nid1, int nid2); 17955714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); 180296465SdelphijPKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, 181296465Sdelphij int passlen); 182296465SdelphijPKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, 183296465Sdelphij const char *pass, int passlen); 184296465SdelphijX509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 185296465Sdelphij const char *pass, int passlen, unsigned char *salt, 186296465Sdelphij int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8); 18755714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, 188296465Sdelphij int passlen, unsigned char *salt, 189296465Sdelphij int saltlen, int iter, 190296465Sdelphij PKCS8_PRIV_KEY_INFO *p8); 19168651SkrisPKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); 192109998SmarkmSTACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7); 19355714SkrisPKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, 194296465Sdelphij unsigned char *salt, int saltlen, int iter, 195296465Sdelphij STACK_OF(PKCS12_SAFEBAG) *bags); 196296465SdelphijSTACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, 197296465Sdelphij int passlen); 198109998Smarkm 199109998Smarkmint PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); 200109998SmarkmSTACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12); 201109998Smarkm 202296465Sdelphijint PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, 203296465Sdelphij int namelen); 20455714Skrisint PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, 205296465Sdelphij int namelen); 206109998Smarkmint PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, 207296465Sdelphij int namelen); 208296465Sdelphijint PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, 209296465Sdelphij const unsigned char *name, int namelen); 21055714Skrisint PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); 21155714SkrisASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); 21255714Skrischar *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); 21355714Skrisunsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, 214296465Sdelphij int passlen, unsigned char *in, int inlen, 215296465Sdelphij unsigned char **data, int *datalen, 216296465Sdelphij int en_de); 217296465Sdelphijvoid *PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it, 218296465Sdelphij const char *pass, int passlen, 219296465Sdelphij ASN1_OCTET_STRING *oct, int zbuf); 220296465SdelphijASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, 221296465Sdelphij const ASN1_ITEM *it, 222296465Sdelphij const char *pass, int passlen, 223296465Sdelphij void *obj, int zbuf); 22455714SkrisPKCS12 *PKCS12_init(int mode); 22555714Skrisint PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, 226296465Sdelphij int saltlen, int id, int iter, int n, 227296465Sdelphij unsigned char *out, const EVP_MD *md_type); 228296465Sdelphijint PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt, 229296465Sdelphij int saltlen, int id, int iter, int n, 230296465Sdelphij unsigned char *out, const EVP_MD *md_type); 23155714Skrisint PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, 232296465Sdelphij ASN1_TYPE *param, const EVP_CIPHER *cipher, 233296465Sdelphij const EVP_MD *md_type, int en_de); 23455714Skrisint PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, 235296465Sdelphij unsigned char *mac, unsigned int *maclen); 23655714Skrisint PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); 23755714Skrisint PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, 238296465Sdelphij unsigned char *salt, int saltlen, int iter, 239296465Sdelphij const EVP_MD *md_type); 24055714Skrisint PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, 241296465Sdelphij int saltlen, const EVP_MD *md_type); 242296465Sdelphij# if defined(NETWARE) || defined(OPENSSL_SYS_NETWARE) 243205128Ssimon/* Rename these functions to avoid name clashes on NetWare OS */ 244296465Sdelphijunsigned char *OPENSSL_asc2uni(const char *asc, int asclen, 245296465Sdelphij unsigned char **uni, int *unilen); 246205128Ssimonchar *OPENSSL_uni2asc(unsigned char *uni, int unilen); 247296465Sdelphij# else 248296465Sdelphijunsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, 249296465Sdelphij int *unilen); 25055714Skrischar *uni2asc(unsigned char *uni, int unilen); 251296465Sdelphij# endif 252109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12) 253109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA) 254109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG) 255109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_BAGS) 256109998Smarkm 257109998SmarkmDECLARE_ASN1_ITEM(PKCS12_SAFEBAGS) 258109998SmarkmDECLARE_ASN1_ITEM(PKCS12_AUTHSAFES) 259109998Smarkm 26055714Skrisvoid PKCS12_PBE_add(void); 26155714Skrisint PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, 262296465Sdelphij STACK_OF(X509) **ca); 26355714SkrisPKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, 264296465Sdelphij STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, 265296465Sdelphij int mac_iter, int keytype); 266160814Ssimon 267160814SsimonPKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert); 268296465SdelphijPKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, 269296465Sdelphij EVP_PKEY *key, int key_usage, int iter, 270296465Sdelphij int key_nid, char *pass); 271160814Ssimonint PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, 272296465Sdelphij int safe_nid, int iter, char *pass); 273160814SsimonPKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); 274160814Ssimon 27555714Skrisint i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); 27655714Skrisint i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); 27755714SkrisPKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); 27855714SkrisPKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); 27959191Skrisint PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); 28055714Skris 28155714Skris/* BEGIN ERROR CODES */ 282296465Sdelphij/* 283296465Sdelphij * The following lines are auto generated by the script mkerr.pl. Any changes 28455714Skris * made after this point may be overwritten when the script is next run. 28555714Skris */ 28689837Skrisvoid ERR_load_PKCS12_strings(void); 28755714Skris 28855714Skris/* Error codes for the PKCS12 functions. */ 28955714Skris 29055714Skris/* Function codes. */ 291296465Sdelphij# define PKCS12_F_PARSE_BAG 129 292296465Sdelphij# define PKCS12_F_PARSE_BAGS 103 293296465Sdelphij# define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 294296465Sdelphij# define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 295296465Sdelphij# define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 296296465Sdelphij# define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 297296465Sdelphij# define PKCS12_F_PKCS12_CREATE 105 298296465Sdelphij# define PKCS12_F_PKCS12_GEN_MAC 107 299296465Sdelphij# define PKCS12_F_PKCS12_INIT 109 300296465Sdelphij# define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106 301296465Sdelphij# define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108 302296465Sdelphij# define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117 303296465Sdelphij# define PKCS12_F_PKCS12_KEY_GEN_ASC 110 304296465Sdelphij# define PKCS12_F_PKCS12_KEY_GEN_UNI 111 305296465Sdelphij# define PKCS12_F_PKCS12_MAKE_KEYBAG 112 306296465Sdelphij# define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 307296465Sdelphij# define PKCS12_F_PKCS12_NEWPASS 128 308296465Sdelphij# define PKCS12_F_PKCS12_PACK_P7DATA 114 309296465Sdelphij# define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 310296465Sdelphij# define PKCS12_F_PKCS12_PARSE 118 311296465Sdelphij# define PKCS12_F_PKCS12_PBE_CRYPT 119 312296465Sdelphij# define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 313296465Sdelphij# define PKCS12_F_PKCS12_SETUP_MAC 122 314296465Sdelphij# define PKCS12_F_PKCS12_SET_MAC 123 315296465Sdelphij# define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130 316296465Sdelphij# define PKCS12_F_PKCS12_UNPACK_P7DATA 131 317296465Sdelphij# define PKCS12_F_PKCS12_VERIFY_MAC 126 318296465Sdelphij# define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 319296465Sdelphij# define PKCS12_F_PKCS8_ENCRYPT 125 32055714Skris 32155714Skris/* Reason codes. */ 322296465Sdelphij# define PKCS12_R_CANT_PACK_STRUCTURE 100 323296465Sdelphij# define PKCS12_R_CONTENT_TYPE_NOT_DATA 121 324296465Sdelphij# define PKCS12_R_DECODE_ERROR 101 325296465Sdelphij# define PKCS12_R_ENCODE_ERROR 102 326296465Sdelphij# define PKCS12_R_ENCRYPT_ERROR 103 327296465Sdelphij# define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 328296465Sdelphij# define PKCS12_R_INVALID_NULL_ARGUMENT 104 329296465Sdelphij# define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 330296465Sdelphij# define PKCS12_R_IV_GEN_ERROR 106 331296465Sdelphij# define PKCS12_R_KEY_GEN_ERROR 107 332296465Sdelphij# define PKCS12_R_MAC_ABSENT 108 333296465Sdelphij# define PKCS12_R_MAC_GENERATION_ERROR 109 334296465Sdelphij# define PKCS12_R_MAC_SETUP_ERROR 110 335296465Sdelphij# define PKCS12_R_MAC_STRING_SET_ERROR 111 336296465Sdelphij# define PKCS12_R_MAC_VERIFY_ERROR 112 337296465Sdelphij# define PKCS12_R_MAC_VERIFY_FAILURE 113 338296465Sdelphij# define PKCS12_R_PARSE_ERROR 114 339296465Sdelphij# define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 340296465Sdelphij# define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 341296465Sdelphij# define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 342296465Sdelphij# define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 343296465Sdelphij# define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 34455714Skris 34555714Skris#ifdef __cplusplus 34655714Skris} 34755714Skris#endif 34855714Skris#endif 349