pkcs12.h revision 205128
155714Skris/* pkcs12.h */ 2194206Ssimon/* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL 355714Skris * project 1999. 455714Skris */ 555714Skris/* ==================================================================== 655714Skris * Copyright (c) 1999 The OpenSSL Project. All rights reserved. 755714Skris * 855714Skris * Redistribution and use in source and binary forms, with or without 955714Skris * modification, are permitted provided that the following conditions 1055714Skris * are met: 1155714Skris * 1255714Skris * 1. Redistributions of source code must retain the above copyright 1355714Skris * notice, this list of conditions and the following disclaimer. 1455714Skris * 1555714Skris * 2. Redistributions in binary form must reproduce the above copyright 1655714Skris * notice, this list of conditions and the following disclaimer in 1755714Skris * the documentation and/or other materials provided with the 1855714Skris * distribution. 1955714Skris * 2055714Skris * 3. All advertising materials mentioning features or use of this 2155714Skris * software must display the following acknowledgment: 2255714Skris * "This product includes software developed by the OpenSSL Project 2355714Skris * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 2455714Skris * 2555714Skris * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 2655714Skris * endorse or promote products derived from this software without 2755714Skris * prior written permission. For written permission, please contact 2855714Skris * licensing@OpenSSL.org. 2955714Skris * 3055714Skris * 5. Products derived from this software may not be called "OpenSSL" 3155714Skris * nor may "OpenSSL" appear in their names without prior written 3255714Skris * permission of the OpenSSL Project. 3355714Skris * 3455714Skris * 6. Redistributions of any form whatsoever must retain the following 3555714Skris * acknowledgment: 3655714Skris * "This product includes software developed by the OpenSSL Project 3755714Skris * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 3855714Skris * 3955714Skris * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 4055714Skris * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4155714Skris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 4255714Skris * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 4355714Skris * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4455714Skris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 4555714Skris * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 4655714Skris * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4755714Skris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 4855714Skris * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 4955714Skris * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 5055714Skris * OF THE POSSIBILITY OF SUCH DAMAGE. 5155714Skris * ==================================================================== 5255714Skris * 5355714Skris * This product includes cryptographic software written by Eric Young 5455714Skris * (eay@cryptsoft.com). This product includes software written by Tim 5555714Skris * Hudson (tjh@cryptsoft.com). 5655714Skris * 5755714Skris */ 5855714Skris 5955714Skris#ifndef HEADER_PKCS12_H 6055714Skris#define HEADER_PKCS12_H 6155714Skris 6268651Skris#include <openssl/bio.h> 6368651Skris#include <openssl/x509.h> 6468651Skris 6555714Skris#ifdef __cplusplus 6655714Skrisextern "C" { 6755714Skris#endif 6855714Skris 6955714Skris#define PKCS12_KEY_ID 1 7055714Skris#define PKCS12_IV_ID 2 7155714Skris#define PKCS12_MAC_ID 3 7255714Skris 7355714Skris/* Default iteration count */ 7455714Skris#ifndef PKCS12_DEFAULT_ITER 7555714Skris#define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER 7655714Skris#endif 7755714Skris 7855714Skris#define PKCS12_MAC_KEY_LENGTH 20 7955714Skris 8055714Skris#define PKCS12_SALT_LEN 8 8155714Skris 8255714Skris/* Uncomment out next line for unicode password and names, otherwise ASCII */ 8355714Skris 8455714Skris/*#define PBE_UNICODE*/ 8555714Skris 8655714Skris#ifdef PBE_UNICODE 8755714Skris#define PKCS12_key_gen PKCS12_key_gen_uni 8855714Skris#define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni 8955714Skris#else 9055714Skris#define PKCS12_key_gen PKCS12_key_gen_asc 9155714Skris#define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc 9255714Skris#endif 9355714Skris 9455714Skris/* MS key usage constants */ 9555714Skris 9655714Skris#define KEY_EX 0x10 9755714Skris#define KEY_SIG 0x80 9855714Skris 9955714Skristypedef struct { 10055714SkrisX509_SIG *dinfo; 10155714SkrisASN1_OCTET_STRING *salt; 10255714SkrisASN1_INTEGER *iter; /* defaults to 1 */ 10355714Skris} PKCS12_MAC_DATA; 10455714Skris 10555714Skristypedef struct { 10655714SkrisASN1_INTEGER *version; 10755714SkrisPKCS12_MAC_DATA *mac; 10855714SkrisPKCS7 *authsafes; 10955714Skris} PKCS12; 11055714Skris 11168651SkrisPREDECLARE_STACK_OF(PKCS12_SAFEBAG) 11268651Skris 11355714Skristypedef struct { 11455714SkrisASN1_OBJECT *type; 11555714Skrisunion { 11655714Skris struct pkcs12_bag_st *bag; /* secret, crl and certbag */ 11755714Skris struct pkcs8_priv_key_info_st *keybag; /* keybag */ 11855714Skris X509_SIG *shkeybag; /* shrouded key bag */ 11968651Skris STACK_OF(PKCS12_SAFEBAG) *safes; 12055714Skris ASN1_TYPE *other; 12155714Skris}value; 12255714SkrisSTACK_OF(X509_ATTRIBUTE) *attrib; 12355714Skris} PKCS12_SAFEBAG; 12455714Skris 12568651SkrisDECLARE_STACK_OF(PKCS12_SAFEBAG) 12668651SkrisDECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) 12768651SkrisDECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) 12868651Skris 12955714Skristypedef struct pkcs12_bag_st { 13055714SkrisASN1_OBJECT *type; 13155714Skrisunion { 13255714Skris ASN1_OCTET_STRING *x509cert; 13355714Skris ASN1_OCTET_STRING *x509crl; 13455714Skris ASN1_OCTET_STRING *octet; 13555714Skris ASN1_IA5STRING *sdsicert; 13655714Skris ASN1_TYPE *other; /* Secret or other bag */ 13755714Skris}value; 13855714Skris} PKCS12_BAGS; 13955714Skris 14055714Skris#define PKCS12_ERROR 0 14155714Skris#define PKCS12_OK 1 14255714Skris 143109998Smarkm/* Compatibility macros */ 14455714Skris 145109998Smarkm#define M_PKCS12_x5092certbag PKCS12_x5092certbag 146109998Smarkm#define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag 14755714Skris 148109998Smarkm#define M_PKCS12_certbag2x509 PKCS12_certbag2x509 149109998Smarkm#define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl 15055714Skris 151109998Smarkm#define M_PKCS12_unpack_p7data PKCS12_unpack_p7data 152109998Smarkm#define M_PKCS12_pack_authsafes PKCS12_pack_authsafes 153109998Smarkm#define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes 154109998Smarkm#define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata 15555714Skris 156109998Smarkm#define M_PKCS12_decrypt_skey PKCS12_decrypt_skey 157109998Smarkm#define M_PKCS8_decrypt PKCS8_decrypt 15855714Skris 159109998Smarkm#define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type) 160109998Smarkm#define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type) 161109998Smarkm#define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type 16255714Skris 16355714Skris#define PKCS12_get_attr(bag, attr_nid) \ 16455714Skris PKCS12_get_attr_gen(bag->attrib, attr_nid) 16555714Skris 16655714Skris#define PKCS8_get_attr(p8, attr_nid) \ 16755714Skris PKCS12_get_attr_gen(p8->attributes, attr_nid) 16855714Skris 16955714Skris#define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) 17055714Skris 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 177109998SmarkmPKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1, 178109998Smarkm int nid2); 17955714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); 180109998SmarkmPKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen); 181109998SmarkmPKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass, 182109998Smarkm int passlen); 18355714SkrisX509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 18455714Skris const char *pass, int passlen, 18555714Skris unsigned char *salt, int saltlen, int iter, 18655714Skris PKCS8_PRIV_KEY_INFO *p8); 18755714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, 18855714Skris int passlen, unsigned char *salt, 18955714Skris int saltlen, int iter, 19055714Skris 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, 19455714Skris unsigned char *salt, int saltlen, int iter, 19568651Skris STACK_OF(PKCS12_SAFEBAG) *bags); 196109998SmarkmSTACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen); 197109998Smarkm 198109998Smarkmint PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); 199109998SmarkmSTACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12); 200109998Smarkm 20155714Skrisint PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen); 20255714Skrisint PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, 20355714Skris int namelen); 204109998Smarkmint PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, 205109998Smarkm int namelen); 20655714Skrisint PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, 20755714Skris int namelen); 20855714Skrisint PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); 20955714SkrisASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); 21055714Skrischar *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); 21155714Skrisunsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, 21255714Skris int passlen, unsigned char *in, int inlen, 21355714Skris unsigned char **data, int *datalen, int en_de); 214109998Smarkmvoid * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it, 215109998Smarkm const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf); 216109998SmarkmASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it, 217109998Smarkm const char *pass, int passlen, 218109998Smarkm void *obj, int zbuf); 21955714SkrisPKCS12 *PKCS12_init(int mode); 22055714Skrisint PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, 22155714Skris int saltlen, int id, int iter, int n, 22255714Skris unsigned char *out, const EVP_MD *md_type); 22355714Skrisint 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); 22455714Skrisint PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, 225109998Smarkm ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type, 22655714Skris int en_de); 22755714Skrisint PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, 22855714Skris unsigned char *mac, unsigned int *maclen); 22955714Skrisint PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); 23055714Skrisint PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, 23155714Skris unsigned char *salt, int saltlen, int iter, 232109998Smarkm const EVP_MD *md_type); 23355714Skrisint PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, 234109998Smarkm int saltlen, const EVP_MD *md_type); 235205128Ssimon#if defined(NETWARE) || defined(OPENSSL_SYS_NETWARE) 236205128Ssimon/* Rename these functions to avoid name clashes on NetWare OS */ 237205128Ssimonunsigned char *OPENSSL_asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen); 238205128Ssimonchar *OPENSSL_uni2asc(unsigned char *uni, int unilen); 239205128Ssimon#else 24072613Skrisunsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen); 24155714Skrischar *uni2asc(unsigned char *uni, int unilen); 242205128Ssimon#endif 243109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12) 244109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA) 245109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG) 246109998SmarkmDECLARE_ASN1_FUNCTIONS(PKCS12_BAGS) 247109998Smarkm 248109998SmarkmDECLARE_ASN1_ITEM(PKCS12_SAFEBAGS) 249109998SmarkmDECLARE_ASN1_ITEM(PKCS12_AUTHSAFES) 250109998Smarkm 25155714Skrisvoid PKCS12_PBE_add(void); 25255714Skrisint PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, 25359191Skris STACK_OF(X509) **ca); 25455714SkrisPKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, 25559191Skris STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, 25655714Skris int mac_iter, int keytype); 257160814Ssimon 258160814SsimonPKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert); 259160814SsimonPKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key, 260160814Ssimon int key_usage, int iter, 261160814Ssimon int key_nid, char *pass); 262160814Ssimonint PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags, 263160814Ssimon int safe_nid, int iter, char *pass); 264160814SsimonPKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid); 265160814Ssimon 26655714Skrisint i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); 26755714Skrisint i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); 26855714SkrisPKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); 26955714SkrisPKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); 27059191Skrisint PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); 27155714Skris 27255714Skris/* BEGIN ERROR CODES */ 27355714Skris/* The following lines are auto generated by the script mkerr.pl. Any changes 27455714Skris * made after this point may be overwritten when the script is next run. 27555714Skris */ 27689837Skrisvoid ERR_load_PKCS12_strings(void); 27755714Skris 27855714Skris/* Error codes for the PKCS12 functions. */ 27955714Skris 28055714Skris/* Function codes. */ 281160814Ssimon#define PKCS12_F_PARSE_BAG 129 28255714Skris#define PKCS12_F_PARSE_BAGS 103 28355714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 28455714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 28555714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 28655714Skris#define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 28755714Skris#define PKCS12_F_PKCS12_CREATE 105 28855714Skris#define PKCS12_F_PKCS12_GEN_MAC 107 28955714Skris#define PKCS12_F_PKCS12_INIT 109 290160814Ssimon#define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I 106 291160814Ssimon#define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT 108 292160814Ssimon#define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG 117 29355714Skris#define PKCS12_F_PKCS12_KEY_GEN_ASC 110 29455714Skris#define PKCS12_F_PKCS12_KEY_GEN_UNI 111 29555714Skris#define PKCS12_F_PKCS12_MAKE_KEYBAG 112 29655714Skris#define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 29759191Skris#define PKCS12_F_PKCS12_NEWPASS 128 29855714Skris#define PKCS12_F_PKCS12_PACK_P7DATA 114 29955714Skris#define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 30055714Skris#define PKCS12_F_PKCS12_PARSE 118 30155714Skris#define PKCS12_F_PKCS12_PBE_CRYPT 119 30255714Skris#define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 30355714Skris#define PKCS12_F_PKCS12_SETUP_MAC 122 30455714Skris#define PKCS12_F_PKCS12_SET_MAC 123 305160814Ssimon#define PKCS12_F_PKCS12_UNPACK_AUTHSAFES 130 306160814Ssimon#define PKCS12_F_PKCS12_UNPACK_P7DATA 131 307160814Ssimon#define PKCS12_F_PKCS12_VERIFY_MAC 126 30855714Skris#define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 30955714Skris#define PKCS12_F_PKCS8_ENCRYPT 125 31055714Skris 31155714Skris/* Reason codes. */ 31255714Skris#define PKCS12_R_CANT_PACK_STRUCTURE 100 313160814Ssimon#define PKCS12_R_CONTENT_TYPE_NOT_DATA 121 31455714Skris#define PKCS12_R_DECODE_ERROR 101 31555714Skris#define PKCS12_R_ENCODE_ERROR 102 31655714Skris#define PKCS12_R_ENCRYPT_ERROR 103 31759191Skris#define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 31855714Skris#define PKCS12_R_INVALID_NULL_ARGUMENT 104 31955714Skris#define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 32055714Skris#define PKCS12_R_IV_GEN_ERROR 106 32155714Skris#define PKCS12_R_KEY_GEN_ERROR 107 32255714Skris#define PKCS12_R_MAC_ABSENT 108 32355714Skris#define PKCS12_R_MAC_GENERATION_ERROR 109 32455714Skris#define PKCS12_R_MAC_SETUP_ERROR 110 32555714Skris#define PKCS12_R_MAC_STRING_SET_ERROR 111 32655714Skris#define PKCS12_R_MAC_VERIFY_ERROR 112 32755714Skris#define PKCS12_R_MAC_VERIFY_FAILURE 113 32855714Skris#define PKCS12_R_PARSE_ERROR 114 32955714Skris#define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 33055714Skris#define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 33155714Skris#define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 33255714Skris#define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 33355714Skris#define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 33455714Skris 33555714Skris#ifdef __cplusplus 33655714Skris} 33755714Skris#endif 33855714Skris#endif 339