pkcs12.h revision 109998
154359Sroberto/* pkcs12.h */ 254359Sroberto/* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL 354359Sroberto * project 1999. 454359Sroberto */ 554359Sroberto/* ==================================================================== 654359Sroberto * Copyright (c) 1999 The OpenSSL Project. All rights reserved. 754359Sroberto * 854359Sroberto * Redistribution and use in source and binary forms, with or without 954359Sroberto * modification, are permitted provided that the following conditions 1054359Sroberto * are met: 1154359Sroberto * 1254359Sroberto * 1. Redistributions of source code must retain the above copyright 1354359Sroberto * notice, this list of conditions and the following disclaimer. 1454359Sroberto * 1554359Sroberto * 2. Redistributions in binary form must reproduce the above copyright 1654359Sroberto * notice, this list of conditions and the following disclaimer in 1754359Sroberto * the documentation and/or other materials provided with the 1854359Sroberto * distribution. 1954359Sroberto * 2054359Sroberto * 3. All advertising materials mentioning features or use of this 2154359Sroberto * software must display the following acknowledgment: 2254359Sroberto * "This product includes software developed by the OpenSSL Project 2354359Sroberto * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 2454359Sroberto * 2554359Sroberto * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 2654359Sroberto * endorse or promote products derived from this software without 2754359Sroberto * prior written permission. For written permission, please contact 2854359Sroberto * licensing@OpenSSL.org. 2954359Sroberto * 3054359Sroberto * 5. Products derived from this software may not be called "OpenSSL" 3154359Sroberto * nor may "OpenSSL" appear in their names without prior written 3254359Sroberto * permission of the OpenSSL Project. 3354359Sroberto * 3454359Sroberto * 6. Redistributions of any form whatsoever must retain the following 3554359Sroberto * acknowledgment: 3654359Sroberto * "This product includes software developed by the OpenSSL Project 3754359Sroberto * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 3854359Sroberto * 3954359Sroberto * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 4054359Sroberto * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4154359Sroberto * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 4254359Sroberto * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 4354359Sroberto * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4454359Sroberto * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 4554359Sroberto * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 4654359Sroberto * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4754359Sroberto * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 4854359Sroberto * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 4954359Sroberto * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 5054359Sroberto * OF THE POSSIBILITY OF SUCH DAMAGE. 5154359Sroberto * ==================================================================== 5254359Sroberto * 5354359Sroberto * This product includes cryptographic software written by Eric Young 5454359Sroberto * (eay@cryptsoft.com). This product includes software written by Tim 5554359Sroberto * Hudson (tjh@cryptsoft.com). 5654359Sroberto * 5754359Sroberto */ 5854359Sroberto 5954359Sroberto#ifndef HEADER_PKCS12_H 6054359Sroberto#define HEADER_PKCS12_H 6154359Sroberto 6254359Sroberto#include <openssl/bio.h> 6354359Sroberto#include <openssl/x509.h> 6454359Sroberto 6554359Sroberto#ifdef __cplusplus 6654359Srobertoextern "C" { 6754359Sroberto#endif 6854359Sroberto 6954359Sroberto#define PKCS12_KEY_ID 1 7054359Sroberto#define PKCS12_IV_ID 2 7154359Sroberto#define PKCS12_MAC_ID 3 7254359Sroberto 7354359Sroberto/* Default iteration count */ 7454359Sroberto#ifndef PKCS12_DEFAULT_ITER 7554359Sroberto#define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER 7654359Sroberto#endif 7754359Sroberto 7854359Sroberto#define PKCS12_MAC_KEY_LENGTH 20 7954359Sroberto 8054359Sroberto#define PKCS12_SALT_LEN 8 8154359Sroberto 8254359Sroberto/* Uncomment out next line for unicode password and names, otherwise ASCII */ 8354359Sroberto 8454359Sroberto/*#define PBE_UNICODE*/ 8554359Sroberto 8654359Sroberto#ifdef PBE_UNICODE 8754359Sroberto#define PKCS12_key_gen PKCS12_key_gen_uni 8854359Sroberto#define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni 8954359Sroberto#else 9054359Sroberto#define PKCS12_key_gen PKCS12_key_gen_asc 9154359Sroberto#define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc 9254359Sroberto#endif 9354359Sroberto 9454359Sroberto/* MS key usage constants */ 9554359Sroberto 9654359Sroberto#define KEY_EX 0x10 9754359Sroberto#define KEY_SIG 0x80 9854359Sroberto 9954359Srobertotypedef struct { 10054359SrobertoX509_SIG *dinfo; 10154359SrobertoASN1_OCTET_STRING *salt; 10254359SrobertoASN1_INTEGER *iter; /* defaults to 1 */ 10354359Sroberto} PKCS12_MAC_DATA; 10454359Sroberto 10554359Srobertotypedef struct { 10654359SrobertoASN1_INTEGER *version; 10754359SrobertoPKCS12_MAC_DATA *mac; 10854359SrobertoPKCS7 *authsafes; 10954359Sroberto} PKCS12; 11054359Sroberto 11154359SrobertoPREDECLARE_STACK_OF(PKCS12_SAFEBAG) 11254359Sroberto 11354359Srobertotypedef struct { 11454359SrobertoASN1_OBJECT *type; 11554359Srobertounion { 11654359Sroberto struct pkcs12_bag_st *bag; /* secret, crl and certbag */ 11754359Sroberto struct pkcs8_priv_key_info_st *keybag; /* keybag */ 11854359Sroberto X509_SIG *shkeybag; /* shrouded key bag */ 11954359Sroberto STACK_OF(PKCS12_SAFEBAG) *safes; 12054359Sroberto ASN1_TYPE *other; 12154359Sroberto}value; 12254359SrobertoSTACK_OF(X509_ATTRIBUTE) *attrib; 12354359Sroberto} PKCS12_SAFEBAG; 12454359Sroberto 12554359SrobertoDECLARE_STACK_OF(PKCS12_SAFEBAG) 12654359SrobertoDECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) 12754359SrobertoDECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) 12854359Sroberto 12954359Srobertotypedef struct pkcs12_bag_st { 13054359SrobertoASN1_OBJECT *type; 13154359Srobertounion { 13254359Sroberto ASN1_OCTET_STRING *x509cert; 13354359Sroberto ASN1_OCTET_STRING *x509crl; 13454359Sroberto ASN1_OCTET_STRING *octet; 13554359Sroberto ASN1_IA5STRING *sdsicert; 13654359Sroberto ASN1_TYPE *other; /* Secret or other bag */ 13754359Sroberto}value; 13854359Sroberto} PKCS12_BAGS; 13954359Sroberto 14054359Sroberto#define PKCS12_ERROR 0 14154359Sroberto#define PKCS12_OK 1 14254359Sroberto 14354359Sroberto/* Compatibility macros */ 14454359Sroberto 14554359Sroberto#define M_PKCS12_x5092certbag PKCS12_x5092certbag 14654359Sroberto#define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag 14754359Sroberto 14854359Sroberto#define M_PKCS12_certbag2x509 PKCS12_certbag2x509 14954359Sroberto#define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl 15054359Sroberto 15154359Sroberto#define M_PKCS12_unpack_p7data PKCS12_unpack_p7data 15254359Sroberto#define M_PKCS12_pack_authsafes PKCS12_pack_authsafes 15354359Sroberto#define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes 15454359Sroberto#define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata 15554359Sroberto 15654359Sroberto#define M_PKCS12_decrypt_skey PKCS12_decrypt_skey 15754359Sroberto#define M_PKCS8_decrypt PKCS8_decrypt 15854359Sroberto 15954359Sroberto#define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type) 16054359Sroberto#define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type) 16154359Sroberto#define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type 16254359Sroberto 16354359Sroberto#define PKCS12_get_attr(bag, attr_nid) \ 16454359Sroberto PKCS12_get_attr_gen(bag->attrib, attr_nid) 16554359Sroberto 16654359Sroberto#define PKCS8_get_attr(p8, attr_nid) \ 16754359Sroberto PKCS12_get_attr_gen(p8->attributes, attr_nid) 16854359Sroberto 16954359Sroberto#define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) 17054359Sroberto 17154359Sroberto 17254359SrobertoPKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509); 17354359SrobertoPKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl); 17454359SrobertoX509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag); 17554359SrobertoX509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag); 17654359Sroberto 17754359SrobertoPKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1, 17854359Sroberto int nid2); 17954359SrobertoPKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); 18054359SrobertoPKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen); 18154359SrobertoPKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass, 18254359Sroberto int passlen); 18354359SrobertoX509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 18454359Sroberto const char *pass, int passlen, 18554359Sroberto unsigned char *salt, int saltlen, int iter, 18654359Sroberto PKCS8_PRIV_KEY_INFO *p8); 18754359SrobertoPKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, 18854359Sroberto int passlen, unsigned char *salt, 18954359Sroberto int saltlen, int iter, 19054359Sroberto PKCS8_PRIV_KEY_INFO *p8); 19154359SrobertoPKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); 19254359SrobertoSTACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7); 19354359SrobertoPKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, 19454359Sroberto unsigned char *salt, int saltlen, int iter, 19554359Sroberto STACK_OF(PKCS12_SAFEBAG) *bags); 19654359SrobertoSTACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen); 19754359Sroberto 19854359Srobertoint PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes); 19954359SrobertoSTACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12); 20054359Sroberto 20154359Srobertoint PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen); 20254359Srobertoint PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, 20354359Sroberto int namelen); 20454359Srobertoint PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name, 20554359Sroberto int namelen); 20654359Srobertoint PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, 20754359Sroberto int namelen); 20854359Srobertoint PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); 20954359SrobertoASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); 21054359Srobertochar *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); 21154359Srobertounsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, 21254359Sroberto int passlen, unsigned char *in, int inlen, 21354359Sroberto unsigned char **data, int *datalen, int en_de); 21454359Srobertovoid * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it, 21554359Sroberto const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf); 21654359SrobertoASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it, 21754359Sroberto const char *pass, int passlen, 21854359Sroberto void *obj, int zbuf); 21954359SrobertoPKCS12 *PKCS12_init(int mode); 22054359Srobertoint PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, 22154359Sroberto int saltlen, int id, int iter, int n, 22254359Sroberto unsigned char *out, const EVP_MD *md_type); 22354359Srobertoint 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); 22454359Srobertoint PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, 22554359Sroberto ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type, 22654359Sroberto int en_de); 22754359Srobertoint PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, 22854359Sroberto unsigned char *mac, unsigned int *maclen); 22954359Srobertoint PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); 23054359Srobertoint PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, 23154359Sroberto unsigned char *salt, int saltlen, int iter, 23254359Sroberto const EVP_MD *md_type); 23354359Srobertoint PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, 23454359Sroberto int saltlen, const EVP_MD *md_type); 23554359Srobertounsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen); 23654359Srobertochar *uni2asc(unsigned char *uni, int unilen); 23754359Sroberto 23854359SrobertoDECLARE_ASN1_FUNCTIONS(PKCS12) 23954359SrobertoDECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA) 24054359SrobertoDECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG) 24154359SrobertoDECLARE_ASN1_FUNCTIONS(PKCS12_BAGS) 24254359Sroberto 24354359SrobertoDECLARE_ASN1_ITEM(PKCS12_SAFEBAGS) 24454359SrobertoDECLARE_ASN1_ITEM(PKCS12_AUTHSAFES) 24554359Sroberto 24654359Srobertovoid PKCS12_PBE_add(void); 24754359Srobertoint PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, 24854359Sroberto STACK_OF(X509) **ca); 24954359SrobertoPKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, 25054359Sroberto STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, 25154359Sroberto int mac_iter, int keytype); 25254359Srobertoint i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); 25354359Srobertoint i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); 25454359SrobertoPKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); 25554359SrobertoPKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); 25654359Srobertoint PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); 25754359Sroberto 25854359Sroberto/* BEGIN ERROR CODES */ 25954359Sroberto/* The following lines are auto generated by the script mkerr.pl. Any changes 26054359Sroberto * made after this point may be overwritten when the script is next run. 26154359Sroberto */ 26254359Srobertovoid ERR_load_PKCS12_strings(void); 26354359Sroberto 26454359Sroberto/* Error codes for the PKCS12 functions. */ 26554359Sroberto 26654359Sroberto/* Function codes. */ 26754359Sroberto#define PKCS12_F_PARSE_BAGS 103 26854359Sroberto#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 26954359Sroberto#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 27054359Sroberto#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 27154359Sroberto#define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 27254359Sroberto#define PKCS12_F_PKCS12_CREATE 105 27354359Sroberto#define PKCS12_F_PKCS12_DECRYPT_D2I 106 27454359Sroberto#define PKCS12_F_PKCS12_GEN_MAC 107 27554359Sroberto#define PKCS12_F_PKCS12_I2D_ENCRYPT 108 27654359Sroberto#define PKCS12_F_PKCS12_INIT 109 27754359Sroberto#define PKCS12_F_PKCS12_KEY_GEN_ASC 110 27854359Sroberto#define PKCS12_F_PKCS12_KEY_GEN_UNI 111 27954359Sroberto#define PKCS12_F_PKCS12_MAKE_KEYBAG 112 28054359Sroberto#define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 28154359Sroberto#define PKCS12_F_PKCS12_NEWPASS 128 28254359Sroberto#define PKCS12_F_PKCS12_PACK_P7DATA 114 28354359Sroberto#define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 28454359Sroberto#define PKCS12_F_PKCS12_PACK_SAFEBAG 117 28554359Sroberto#define PKCS12_F_PKCS12_PARSE 118 28654359Sroberto#define PKCS12_F_PKCS12_PBE_CRYPT 119 28754359Sroberto#define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 28854359Sroberto#define PKCS12_F_PKCS12_SETUP_MAC 122 28954359Sroberto#define PKCS12_F_PKCS12_SET_MAC 123 29054359Sroberto#define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 29154359Sroberto#define PKCS12_F_PKCS8_ENCRYPT 125 29254359Sroberto#define PKCS12_F_VERIFY_MAC 126 29354359Sroberto 29454359Sroberto/* Reason codes. */ 29554359Sroberto#define PKCS12_R_CANT_PACK_STRUCTURE 100 29654359Sroberto#define PKCS12_R_DECODE_ERROR 101 29754359Sroberto#define PKCS12_R_ENCODE_ERROR 102 29854359Sroberto#define PKCS12_R_ENCRYPT_ERROR 103 29954359Sroberto#define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 30054359Sroberto#define PKCS12_R_INVALID_NULL_ARGUMENT 104 30154359Sroberto#define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 30254359Sroberto#define PKCS12_R_IV_GEN_ERROR 106 30354359Sroberto#define PKCS12_R_KEY_GEN_ERROR 107 30454359Sroberto#define PKCS12_R_MAC_ABSENT 108 30554359Sroberto#define PKCS12_R_MAC_GENERATION_ERROR 109 30654359Sroberto#define PKCS12_R_MAC_SETUP_ERROR 110 30754359Sroberto#define PKCS12_R_MAC_STRING_SET_ERROR 111 30854359Sroberto#define PKCS12_R_MAC_VERIFY_ERROR 112 30954359Sroberto#define PKCS12_R_MAC_VERIFY_FAILURE 113 310#define PKCS12_R_PARSE_ERROR 114 311#define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 312#define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 313#define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 314#define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 315#define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 316 317#ifdef __cplusplus 318} 319#endif 320#endif 321