epoc32/include/stdapis/openssl/pkcs12.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /* pkcs12.h */
     2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) 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  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
    60  */
    61 
    62 #ifndef HEADER_PKCS12_H
    63 #define HEADER_PKCS12_H
    64 
    65 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
    66 #define SYMBIAN
    67 #endif
    68 
    69 #ifdef SYMBIAN
    70 #include <e32def.h>
    71 #endif
    72 #include <openssl/bio.h>
    73 #include <openssl/x509.h>
    74 
    75 #ifdef __cplusplus
    76 extern "C" {
    77 #endif
    78 
    79 #define PKCS12_KEY_ID	1
    80 #define PKCS12_IV_ID	2
    81 #define PKCS12_MAC_ID	3
    82 
    83 /* Default iteration count */
    84 #ifndef PKCS12_DEFAULT_ITER
    85 #define PKCS12_DEFAULT_ITER	PKCS5_DEFAULT_ITER
    86 #endif
    87 
    88 #define PKCS12_MAC_KEY_LENGTH 20
    89 
    90 #define PKCS12_SALT_LEN	8
    91 
    92 /* Uncomment out next line for unicode password and names, otherwise ASCII */
    93 
    94 /*#define PBE_UNICODE*/
    95 
    96 #ifdef PBE_UNICODE
    97 #define PKCS12_key_gen PKCS12_key_gen_uni
    98 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
    99 #else
   100 #define PKCS12_key_gen PKCS12_key_gen_asc
   101 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
   102 #endif
   103 
   104 /* MS key usage constants */
   105 
   106 #define KEY_EX	0x10
   107 #define KEY_SIG 0x80
   108 
   109 typedef struct {
   110 X509_SIG *dinfo;
   111 ASN1_OCTET_STRING *salt;
   112 ASN1_INTEGER *iter;	/* defaults to 1 */
   113 } PKCS12_MAC_DATA;
   114 
   115 typedef struct {
   116 ASN1_INTEGER *version;
   117 PKCS12_MAC_DATA *mac;
   118 PKCS7 *authsafes;
   119 } PKCS12;
   120 
   121 PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
   122 
   123 typedef struct {
   124 ASN1_OBJECT *type;
   125 union {
   126 	struct pkcs12_bag_st *bag; /* secret, crl and certbag */
   127 	struct pkcs8_priv_key_info_st	*keybag; /* keybag */
   128 	X509_SIG *shkeybag; /* shrouded key bag */
   129 	STACK_OF(PKCS12_SAFEBAG) *safes;
   130 	ASN1_TYPE *other;
   131 }value;
   132 STACK_OF(X509_ATTRIBUTE) *attrib;
   133 } PKCS12_SAFEBAG;
   134 
   135 DECLARE_STACK_OF(PKCS12_SAFEBAG)
   136 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
   137 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
   138 
   139 typedef struct pkcs12_bag_st {
   140 ASN1_OBJECT *type;
   141 union {
   142 	ASN1_OCTET_STRING *x509cert;
   143 	ASN1_OCTET_STRING *x509crl;
   144 	ASN1_OCTET_STRING *octet;
   145 	ASN1_IA5STRING *sdsicert;
   146 	ASN1_TYPE *other; /* Secret or other bag */
   147 }value;
   148 } PKCS12_BAGS;
   149 
   150 #define PKCS12_ERROR	0
   151 #define PKCS12_OK	1
   152 
   153 /* Compatibility macros */
   154 
   155 #define M_PKCS12_x5092certbag PKCS12_x5092certbag
   156 #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
   157 
   158 #define M_PKCS12_certbag2x509 PKCS12_certbag2x509
   159 #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl 
   160 
   161 #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
   162 #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
   163 #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
   164 #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
   165 
   166 #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
   167 #define M_PKCS8_decrypt PKCS8_decrypt
   168 
   169 #define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)
   170 #define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)
   171 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
   172 
   173 #define PKCS12_get_attr(bag, attr_nid) \
   174 			 PKCS12_get_attr_gen(bag->attrib, attr_nid)
   175 
   176 #define PKCS8_get_attr(p8, attr_nid) \
   177 		PKCS12_get_attr_gen(p8->attributes, attr_nid)
   178 
   179 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
   180 
   181 
   182 IMPORT_C PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509);
   183 IMPORT_C PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl);
   184 IMPORT_C X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag);
   185 IMPORT_C X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag);
   186 
   187 IMPORT_C PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1,
   188 	     int nid2);
   189 IMPORT_C PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
   190 IMPORT_C PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen);
   191 IMPORT_C PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass,
   192 								int passlen);
   193 IMPORT_C X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 
   194 			const char *pass, int passlen,
   195 			unsigned char *salt, int saltlen, int iter,
   196 			PKCS8_PRIV_KEY_INFO *p8);
   197 IMPORT_C PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
   198 				     int passlen, unsigned char *salt,
   199 				     int saltlen, int iter,
   200 				     PKCS8_PRIV_KEY_INFO *p8);
   201 IMPORT_C PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
   202 IMPORT_C STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
   203 IMPORT_C PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
   204 			     unsigned char *salt, int saltlen, int iter,
   205 			     STACK_OF(PKCS12_SAFEBAG) *bags);
   206 IMPORT_C STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen);
   207 
   208 IMPORT_C int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
   209 IMPORT_C STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);
   210 
   211 IMPORT_C int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
   212 IMPORT_C int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
   213 				int namelen);
   214 IMPORT_C int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
   215 				int namelen);
   216 IMPORT_C int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
   217 				int namelen);
   218 IMPORT_C int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
   219 IMPORT_C ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
   220 IMPORT_C char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
   221 IMPORT_C unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
   222 				int passlen, unsigned char *in, int inlen,
   223 				unsigned char **data, int *datalen, int en_de);
   224 IMPORT_C void * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it,
   225 	     const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf);
   226 IMPORT_C ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it,
   227 				       const char *pass, int passlen,
   228 				       void *obj, int zbuf);
   229 IMPORT_C PKCS12 *PKCS12_init(int mode);
   230 IMPORT_C int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
   231 		       int saltlen, int id, int iter, int n,
   232 		       unsigned char *out, const EVP_MD *md_type);
   233 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);
   234 IMPORT_C int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
   235 			 ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type,
   236 			 int en_de);
   237 IMPORT_C int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
   238 			 unsigned char *mac, unsigned int *maclen);
   239 IMPORT_C int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
   240 IMPORT_C int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
   241 		   unsigned char *salt, int saltlen, int iter,
   242 		   const EVP_MD *md_type);
   243 IMPORT_C int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
   244 					 int saltlen, const EVP_MD *md_type);
   245 IMPORT_C unsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen);
   246 IMPORT_C char *uni2asc(unsigned char *uni, int unilen);
   247 
   248 DECLARE_ASN1_FUNCTIONS(PKCS12)
   249 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
   250 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
   251 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
   252 
   253 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
   254 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
   255 
   256 IMPORT_C void PKCS12_PBE_add(void);
   257 IMPORT_C int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
   258 		 STACK_OF(X509) **ca);
   259 IMPORT_C PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
   260 			 STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
   261 						 int mac_iter, int keytype);
   262 
   263 IMPORT_C PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
   264 IMPORT_C PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key,
   265 						int key_usage, int iter,
   266 						int key_nid, char *pass);
   267 IMPORT_C int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
   268 					int safe_nid, int iter, char *pass);
   269 IMPORT_C PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
   270 
   271 IMPORT_C int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
   272 IMPORT_C int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
   273 IMPORT_C PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
   274 IMPORT_C PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
   275 IMPORT_C int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
   276 
   277 /* BEGIN ERROR CODES */
   278 /* The following lines are auto generated by the script mkerr.pl. Any changes
   279  * made after this point may be overwritten when the script is next run.
   280  */
   281 IMPORT_C void ERR_load_PKCS12_strings(void);
   282 
   283 /* Error codes for the PKCS12 functions. */
   284 
   285 /* Function codes. */
   286 #define PKCS12_F_PARSE_BAG				 129
   287 #define PKCS12_F_PARSE_BAGS				 103
   288 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME		 100
   289 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC		 127
   290 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI		 102
   291 #define PKCS12_F_PKCS12_ADD_LOCALKEYID			 104
   292 #define PKCS12_F_PKCS12_CREATE				 105
   293 #define PKCS12_F_PKCS12_GEN_MAC				 107
   294 #define PKCS12_F_PKCS12_INIT				 109
   295 #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I		 106
   296 #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT		 108
   297 #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG		 117
   298 #define PKCS12_F_PKCS12_KEY_GEN_ASC			 110
   299 #define PKCS12_F_PKCS12_KEY_GEN_UNI			 111
   300 #define PKCS12_F_PKCS12_MAKE_KEYBAG			 112
   301 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG			 113
   302 #define PKCS12_F_PKCS12_NEWPASS				 128
   303 #define PKCS12_F_PKCS12_PACK_P7DATA			 114
   304 #define PKCS12_F_PKCS12_PACK_P7ENCDATA			 115
   305 #define PKCS12_F_PKCS12_PARSE				 118
   306 #define PKCS12_F_PKCS12_PBE_CRYPT			 119
   307 #define PKCS12_F_PKCS12_PBE_KEYIVGEN			 120
   308 #define PKCS12_F_PKCS12_SETUP_MAC			 122
   309 #define PKCS12_F_PKCS12_SET_MAC				 123
   310 #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES		 130
   311 #define PKCS12_F_PKCS12_UNPACK_P7DATA			 131
   312 #define PKCS12_F_PKCS12_VERIFY_MAC			 126
   313 #define PKCS12_F_PKCS8_ADD_KEYUSAGE			 124
   314 #define PKCS12_F_PKCS8_ENCRYPT				 125
   315 
   316 /* Reason codes. */
   317 #define PKCS12_R_CANT_PACK_STRUCTURE			 100
   318 #define PKCS12_R_CONTENT_TYPE_NOT_DATA			 121
   319 #define PKCS12_R_DECODE_ERROR				 101
   320 #define PKCS12_R_ENCODE_ERROR				 102
   321 #define PKCS12_R_ENCRYPT_ERROR				 103
   322 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE	 120
   323 #define PKCS12_R_INVALID_NULL_ARGUMENT			 104
   324 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER		 105
   325 #define PKCS12_R_IV_GEN_ERROR				 106
   326 #define PKCS12_R_KEY_GEN_ERROR				 107
   327 #define PKCS12_R_MAC_ABSENT				 108
   328 #define PKCS12_R_MAC_GENERATION_ERROR			 109
   329 #define PKCS12_R_MAC_SETUP_ERROR			 110
   330 #define PKCS12_R_MAC_STRING_SET_ERROR			 111
   331 #define PKCS12_R_MAC_VERIFY_ERROR			 112
   332 #define PKCS12_R_MAC_VERIFY_FAILURE			 113
   333 #define PKCS12_R_PARSE_ERROR				 114
   334 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR		 115
   335 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR		 116
   336 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR			 117
   337 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM		 118
   338 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE		 119
   339 
   340 #ifdef  __cplusplus
   341 }
   342 #endif
   343 #endif