williamr@2: /* pkcs12.h */
williamr@2: /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
williamr@2:  * project 1999.
williamr@2:  */
williamr@2: /* ====================================================================
williamr@2:  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
williamr@2:  *
williamr@2:  * Redistribution and use in source and binary forms, with or without
williamr@2:  * modification, are permitted provided that the following conditions
williamr@2:  * are met:
williamr@2:  *
williamr@2:  * 1. Redistributions of source code must retain the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer. 
williamr@2:  *
williamr@2:  * 2. Redistributions in binary form must reproduce the above copyright
williamr@2:  *    notice, this list of conditions and the following disclaimer in
williamr@2:  *    the documentation and/or other materials provided with the
williamr@2:  *    distribution.
williamr@2:  *
williamr@2:  * 3. All advertising materials mentioning features or use of this
williamr@2:  *    software must display the following acknowledgment:
williamr@2:  *    "This product includes software developed by the OpenSSL Project
williamr@2:  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
williamr@2:  *
williamr@2:  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
williamr@2:  *    endorse or promote products derived from this software without
williamr@2:  *    prior written permission. For written permission, please contact
williamr@2:  *    licensing@OpenSSL.org.
williamr@2:  *
williamr@2:  * 5. Products derived from this software may not be called "OpenSSL"
williamr@2:  *    nor may "OpenSSL" appear in their names without prior written
williamr@2:  *    permission of the OpenSSL Project.
williamr@2:  *
williamr@2:  * 6. Redistributions of any form whatsoever must retain the following
williamr@2:  *    acknowledgment:
williamr@2:  *    "This product includes software developed by the OpenSSL Project
williamr@2:  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
williamr@2:  *
williamr@2:  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
williamr@2:  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
williamr@2:  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
williamr@2:  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
williamr@2:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
williamr@2:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
williamr@2:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
williamr@2:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
williamr@2:  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
williamr@2:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
williamr@2:  * OF THE POSSIBILITY OF SUCH DAMAGE.
williamr@2:  * ====================================================================
williamr@2:  *
williamr@2:  * This product includes cryptographic software written by Eric Young
williamr@2:  * (eay@cryptsoft.com).  This product includes software written by Tim
williamr@2:  * Hudson (tjh@cryptsoft.com).
williamr@2:  *
williamr@2:  */
williamr@2: /*
williamr@2:  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2:  */
williamr@2: 
williamr@2: #ifndef HEADER_PKCS12_H
williamr@2: #define HEADER_PKCS12_H
williamr@2: 
williamr@2: #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
williamr@2: #define SYMBIAN
williamr@2: #endif
williamr@2: 
williamr@2: #ifdef SYMBIAN
williamr@2: #include <e32def.h>
williamr@2: #endif
williamr@2: #include <openssl/bio.h>
williamr@2: #include <openssl/x509.h>
williamr@2: 
williamr@2: #ifdef __cplusplus
williamr@2: extern "C" {
williamr@2: #endif
williamr@2: 
williamr@2: #define PKCS12_KEY_ID	1
williamr@2: #define PKCS12_IV_ID	2
williamr@2: #define PKCS12_MAC_ID	3
williamr@2: 
williamr@2: /* Default iteration count */
williamr@2: #ifndef PKCS12_DEFAULT_ITER
williamr@2: #define PKCS12_DEFAULT_ITER	PKCS5_DEFAULT_ITER
williamr@2: #endif
williamr@2: 
williamr@2: #define PKCS12_MAC_KEY_LENGTH 20
williamr@2: 
williamr@2: #define PKCS12_SALT_LEN	8
williamr@2: 
williamr@2: /* Uncomment out next line for unicode password and names, otherwise ASCII */
williamr@2: 
williamr@2: /*#define PBE_UNICODE*/
williamr@2: 
williamr@2: #ifdef PBE_UNICODE
williamr@2: #define PKCS12_key_gen PKCS12_key_gen_uni
williamr@2: #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
williamr@2: #else
williamr@2: #define PKCS12_key_gen PKCS12_key_gen_asc
williamr@2: #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
williamr@2: #endif
williamr@2: 
williamr@2: /* MS key usage constants */
williamr@2: 
williamr@2: #define KEY_EX	0x10
williamr@2: #define KEY_SIG 0x80
williamr@2: 
williamr@2: typedef struct {
williamr@2: X509_SIG *dinfo;
williamr@2: ASN1_OCTET_STRING *salt;
williamr@2: ASN1_INTEGER *iter;	/* defaults to 1 */
williamr@2: } PKCS12_MAC_DATA;
williamr@2: 
williamr@2: typedef struct {
williamr@2: ASN1_INTEGER *version;
williamr@2: PKCS12_MAC_DATA *mac;
williamr@2: PKCS7 *authsafes;
williamr@2: } PKCS12;
williamr@2: 
williamr@2: PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
williamr@2: 
williamr@2: typedef struct {
williamr@2: ASN1_OBJECT *type;
williamr@2: union {
williamr@2: 	struct pkcs12_bag_st *bag; /* secret, crl and certbag */
williamr@2: 	struct pkcs8_priv_key_info_st	*keybag; /* keybag */
williamr@2: 	X509_SIG *shkeybag; /* shrouded key bag */
williamr@2: 	STACK_OF(PKCS12_SAFEBAG) *safes;
williamr@2: 	ASN1_TYPE *other;
williamr@2: }value;
williamr@2: STACK_OF(X509_ATTRIBUTE) *attrib;
williamr@2: } PKCS12_SAFEBAG;
williamr@2: 
williamr@2: DECLARE_STACK_OF(PKCS12_SAFEBAG)
williamr@2: DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
williamr@2: DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
williamr@2: 
williamr@2: typedef struct pkcs12_bag_st {
williamr@2: ASN1_OBJECT *type;
williamr@2: union {
williamr@2: 	ASN1_OCTET_STRING *x509cert;
williamr@2: 	ASN1_OCTET_STRING *x509crl;
williamr@2: 	ASN1_OCTET_STRING *octet;
williamr@2: 	ASN1_IA5STRING *sdsicert;
williamr@2: 	ASN1_TYPE *other; /* Secret or other bag */
williamr@2: }value;
williamr@2: } PKCS12_BAGS;
williamr@2: 
williamr@2: #define PKCS12_ERROR	0
williamr@2: #define PKCS12_OK	1
williamr@2: 
williamr@2: /* Compatibility macros */
williamr@2: 
williamr@2: #define M_PKCS12_x5092certbag PKCS12_x5092certbag
williamr@2: #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
williamr@2: 
williamr@2: #define M_PKCS12_certbag2x509 PKCS12_certbag2x509
williamr@2: #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl 
williamr@2: 
williamr@2: #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
williamr@2: #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
williamr@2: #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
williamr@2: #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
williamr@2: 
williamr@2: #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
williamr@2: #define M_PKCS8_decrypt PKCS8_decrypt
williamr@2: 
williamr@2: #define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)
williamr@2: #define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)
williamr@2: #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
williamr@2: 
williamr@2: #define PKCS12_get_attr(bag, attr_nid) \
williamr@2: 			 PKCS12_get_attr_gen(bag->attrib, attr_nid)
williamr@2: 
williamr@2: #define PKCS8_get_attr(p8, attr_nid) \
williamr@2: 		PKCS12_get_attr_gen(p8->attributes, attr_nid)
williamr@2: 
williamr@2: #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
williamr@2: 
williamr@2: 
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509);
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl);
williamr@2: IMPORT_C X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag);
williamr@2: IMPORT_C X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag);
williamr@2: 
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1,
williamr@2: 	     int nid2);
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
williamr@2: IMPORT_C PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen);
williamr@2: IMPORT_C PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass,
williamr@2: 								int passlen);
williamr@2: IMPORT_C X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 
williamr@2: 			const char *pass, int passlen,
williamr@2: 			unsigned char *salt, int saltlen, int iter,
williamr@2: 			PKCS8_PRIV_KEY_INFO *p8);
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
williamr@2: 				     int passlen, unsigned char *salt,
williamr@2: 				     int saltlen, int iter,
williamr@2: 				     PKCS8_PRIV_KEY_INFO *p8);
williamr@2: IMPORT_C PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
williamr@2: IMPORT_C STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
williamr@2: IMPORT_C PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
williamr@2: 			     unsigned char *salt, int saltlen, int iter,
williamr@2: 			     STACK_OF(PKCS12_SAFEBAG) *bags);
williamr@2: IMPORT_C STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen);
williamr@2: 
williamr@2: IMPORT_C int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
williamr@2: IMPORT_C STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);
williamr@2: 
williamr@2: IMPORT_C int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
williamr@2: IMPORT_C int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
williamr@2: 				int namelen);
williamr@2: IMPORT_C int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
williamr@2: 				int namelen);
williamr@2: IMPORT_C int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
williamr@2: 				int namelen);
williamr@2: IMPORT_C int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
williamr@2: IMPORT_C ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
williamr@2: IMPORT_C char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
williamr@2: IMPORT_C unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
williamr@2: 				int passlen, unsigned char *in, int inlen,
williamr@2: 				unsigned char **data, int *datalen, int en_de);
williamr@2: IMPORT_C void * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it,
williamr@2: 	     const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf);
williamr@2: IMPORT_C ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it,
williamr@2: 				       const char *pass, int passlen,
williamr@2: 				       void *obj, int zbuf);
williamr@2: IMPORT_C PKCS12 *PKCS12_init(int mode);
williamr@2: IMPORT_C int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
williamr@2: 		       int saltlen, int id, int iter, int n,
williamr@2: 		       unsigned char *out, const EVP_MD *md_type);
williamr@2: IMPORT_C int 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);
williamr@2: IMPORT_C int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
williamr@2: 			 ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type,
williamr@2: 			 int en_de);
williamr@2: IMPORT_C int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
williamr@2: 			 unsigned char *mac, unsigned int *maclen);
williamr@2: IMPORT_C int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
williamr@2: IMPORT_C int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
williamr@2: 		   unsigned char *salt, int saltlen, int iter,
williamr@2: 		   const EVP_MD *md_type);
williamr@2: IMPORT_C int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
williamr@2: 					 int saltlen, const EVP_MD *md_type);
williamr@2: IMPORT_C unsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen);
williamr@2: IMPORT_C char *uni2asc(unsigned char *uni, int unilen);
williamr@2: 
williamr@2: DECLARE_ASN1_FUNCTIONS(PKCS12)
williamr@2: DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
williamr@2: DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
williamr@2: DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
williamr@2: 
williamr@2: DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
williamr@2: DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
williamr@2: 
williamr@2: IMPORT_C void PKCS12_PBE_add(void);
williamr@2: IMPORT_C int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
williamr@2: 		 STACK_OF(X509) **ca);
williamr@2: IMPORT_C PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
williamr@2: 			 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
williamr@2: 						 int mac_iter, int keytype);
williamr@2: 
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
williamr@2: IMPORT_C PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key,
williamr@2: 						int key_usage, int iter,
williamr@2: 						int key_nid, char *pass);
williamr@2: IMPORT_C int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
williamr@2: 					int safe_nid, int iter, char *pass);
williamr@2: IMPORT_C PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
williamr@2: 
williamr@2: IMPORT_C int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
williamr@2: IMPORT_C int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
williamr@2: IMPORT_C PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
williamr@2: IMPORT_C PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
williamr@2: IMPORT_C int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
williamr@2: 
williamr@2: /* BEGIN ERROR CODES */
williamr@2: /* The following lines are auto generated by the script mkerr.pl. Any changes
williamr@2:  * made after this point may be overwritten when the script is next run.
williamr@2:  */
williamr@2: IMPORT_C void ERR_load_PKCS12_strings(void);
williamr@2: 
williamr@2: /* Error codes for the PKCS12 functions. */
williamr@2: 
williamr@2: /* Function codes. */
williamr@2: #define PKCS12_F_PARSE_BAG				 129
williamr@2: #define PKCS12_F_PARSE_BAGS				 103
williamr@2: #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME		 100
williamr@2: #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC		 127
williamr@2: #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI		 102
williamr@2: #define PKCS12_F_PKCS12_ADD_LOCALKEYID			 104
williamr@2: #define PKCS12_F_PKCS12_CREATE				 105
williamr@2: #define PKCS12_F_PKCS12_GEN_MAC				 107
williamr@2: #define PKCS12_F_PKCS12_INIT				 109
williamr@2: #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I		 106
williamr@2: #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT		 108
williamr@2: #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG		 117
williamr@2: #define PKCS12_F_PKCS12_KEY_GEN_ASC			 110
williamr@2: #define PKCS12_F_PKCS12_KEY_GEN_UNI			 111
williamr@2: #define PKCS12_F_PKCS12_MAKE_KEYBAG			 112
williamr@2: #define PKCS12_F_PKCS12_MAKE_SHKEYBAG			 113
williamr@2: #define PKCS12_F_PKCS12_NEWPASS				 128
williamr@2: #define PKCS12_F_PKCS12_PACK_P7DATA			 114
williamr@2: #define PKCS12_F_PKCS12_PACK_P7ENCDATA			 115
williamr@2: #define PKCS12_F_PKCS12_PARSE				 118
williamr@2: #define PKCS12_F_PKCS12_PBE_CRYPT			 119
williamr@2: #define PKCS12_F_PKCS12_PBE_KEYIVGEN			 120
williamr@2: #define PKCS12_F_PKCS12_SETUP_MAC			 122
williamr@2: #define PKCS12_F_PKCS12_SET_MAC				 123
williamr@2: #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES		 130
williamr@2: #define PKCS12_F_PKCS12_UNPACK_P7DATA			 131
williamr@2: #define PKCS12_F_PKCS12_VERIFY_MAC			 126
williamr@2: #define PKCS12_F_PKCS8_ADD_KEYUSAGE			 124
williamr@2: #define PKCS12_F_PKCS8_ENCRYPT				 125
williamr@2: 
williamr@2: /* Reason codes. */
williamr@2: #define PKCS12_R_CANT_PACK_STRUCTURE			 100
williamr@2: #define PKCS12_R_CONTENT_TYPE_NOT_DATA			 121
williamr@2: #define PKCS12_R_DECODE_ERROR				 101
williamr@2: #define PKCS12_R_ENCODE_ERROR				 102
williamr@2: #define PKCS12_R_ENCRYPT_ERROR				 103
williamr@2: #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE	 120
williamr@2: #define PKCS12_R_INVALID_NULL_ARGUMENT			 104
williamr@2: #define PKCS12_R_INVALID_NULL_PKCS12_POINTER		 105
williamr@2: #define PKCS12_R_IV_GEN_ERROR				 106
williamr@2: #define PKCS12_R_KEY_GEN_ERROR				 107
williamr@2: #define PKCS12_R_MAC_ABSENT				 108
williamr@2: #define PKCS12_R_MAC_GENERATION_ERROR			 109
williamr@2: #define PKCS12_R_MAC_SETUP_ERROR			 110
williamr@2: #define PKCS12_R_MAC_STRING_SET_ERROR			 111
williamr@2: #define PKCS12_R_MAC_VERIFY_ERROR			 112
williamr@2: #define PKCS12_R_MAC_VERIFY_FAILURE			 113
williamr@2: #define PKCS12_R_PARSE_ERROR				 114
williamr@2: #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR		 115
williamr@2: #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR		 116
williamr@2: #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR			 117
williamr@2: #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM		 118
williamr@2: #define PKCS12_R_UNSUPPORTED_PKCS12_MODE		 119
williamr@2: 
williamr@2: #ifdef  __cplusplus
williamr@2: }
williamr@2: #endif
williamr@2: #endif