utvpn/utvpn-unix-v101-7101-public/src/Mayaqua/openssl/pkcs12.h

   1 /* pkcs12.h */\r
   2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL\r
   3  * project 1999.\r
   4  */\r
   5 /* ====================================================================\r
   6  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions\r
  10  * are met:\r
  11  *\r
  12  * 1. Redistributions of source code must retain the above copyright\r
  13  *    notice, this list of conditions and the following disclaimer. \r
  14  *\r
  15  * 2. Redistributions in binary form must reproduce the above copyright\r
  16  *    notice, this list of conditions and the following disclaimer in\r
  17  *    the documentation and/or other materials provided with the\r
  18  *    distribution.\r
  19  *\r
  20  * 3. All advertising materials mentioning features or use of this\r
  21  *    software must display the following acknowledgment:\r
  22  *    "This product includes software developed by the OpenSSL Project\r
  23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"\r
  24  *\r
  25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to\r
  26  *    endorse or promote products derived from this software without\r
  27  *    prior written permission. For written permission, please contact\r
  28  *    licensing@OpenSSL.org.\r
  29  *\r
  30  * 5. Products derived from this software may not be called "OpenSSL"\r
  31  *    nor may "OpenSSL" appear in their names without prior written\r
  32  *    permission of the OpenSSL Project.\r
  33  *\r
  34  * 6. Redistributions of any form whatsoever must retain the following\r
  35  *    acknowledgment:\r
  36  *    "This product includes software developed by the OpenSSL Project\r
  37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"\r
  38  *\r
  39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY\r
  40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
  42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR\r
  43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
  44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
  45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
  46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
  48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)\r
  49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED\r
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.\r
  51  * ====================================================================\r
  52  *\r
  53  * This product includes cryptographic software written by Eric Young\r
  54  * (eay@cryptsoft.com).  This product includes software written by Tim\r
  55  * Hudson (tjh@cryptsoft.com).\r
  56  *\r
  57  */\r
  58 \r
  59 #ifndef HEADER_PKCS12_H\r
  60 #define HEADER_PKCS12_H\r
  61 \r
  62 #include <openssl/bio.h>\r
  63 #include <openssl/x509.h>\r
  64 \r
  65 #ifdef __cplusplus\r
  66 extern "C" {\r
  67 #endif\r
  68 \r
  69 #define PKCS12_KEY_ID   1\r
  70 #define PKCS12_IV_ID    2\r
  71 #define PKCS12_MAC_ID   3\r
  72 \r
  73 /* Default iteration count */\r
  74 #ifndef PKCS12_DEFAULT_ITER\r
  75 #define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER\r
  76 #endif\r
  77 \r
  78 #define PKCS12_MAC_KEY_LENGTH 20\r
  79 \r
  80 #define PKCS12_SALT_LEN 8\r
  81 \r
  82 /* Uncomment out next line for unicode password and names, otherwise ASCII */\r
  83 \r
  84 /*#define PBE_UNICODE*/\r
  85 \r
  86 #ifdef PBE_UNICODE\r
  87 #define PKCS12_key_gen PKCS12_key_gen_uni\r
  88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni\r
  89 #else\r
  90 #define PKCS12_key_gen PKCS12_key_gen_asc\r
  91 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc\r
  92 #endif\r
  93 \r
  94 /* MS key usage constants */\r
  95 \r
  96 #define KEY_EX  0x10\r
  97 #define KEY_SIG 0x80\r
  98 \r
  99 typedef struct {\r
 100 X509_SIG *dinfo;\r
 101 ASN1_OCTET_STRING *salt;\r
 102 ASN1_INTEGER *iter;     /* defaults to 1 */\r
 103 } PKCS12_MAC_DATA;\r
 104 \r
 105 typedef struct {\r
 106 ASN1_INTEGER *version;\r
 107 PKCS12_MAC_DATA *mac;\r
 108 PKCS7 *authsafes;\r
 109 } PKCS12;\r
 110 \r
 111 PREDECLARE_STACK_OF(PKCS12_SAFEBAG)\r
 112 \r
 113 typedef struct {\r
 114 ASN1_OBJECT *type;\r
 115 union {\r
 116         struct pkcs12_bag_st *bag; /* secret, crl and certbag */\r
 117         struct pkcs8_priv_key_info_st   *keybag; /* keybag */\r
 118         X509_SIG *shkeybag; /* shrouded key bag */\r
 119         STACK_OF(PKCS12_SAFEBAG) *safes;\r
 120         ASN1_TYPE *other;\r
 121 }value;\r
 122 STACK_OF(X509_ATTRIBUTE) *attrib;\r
 123 } PKCS12_SAFEBAG;\r
 124 \r
 125 DECLARE_STACK_OF(PKCS12_SAFEBAG)\r
 126 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)\r
 127 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)\r
 128 \r
 129 typedef struct pkcs12_bag_st {\r
 130 ASN1_OBJECT *type;\r
 131 union {\r
 132         ASN1_OCTET_STRING *x509cert;\r
 133         ASN1_OCTET_STRING *x509crl;\r
 134         ASN1_OCTET_STRING *octet;\r
 135         ASN1_IA5STRING *sdsicert;\r
 136         ASN1_TYPE *other; /* Secret or other bag */\r
 137 }value;\r
 138 } PKCS12_BAGS;\r
 139 \r
 140 #define PKCS12_ERROR    0\r
 141 #define PKCS12_OK       1\r
 142 \r
 143 /* Compatibility macros */\r
 144 \r
 145 #define M_PKCS12_x5092certbag PKCS12_x5092certbag\r
 146 #define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag\r
 147 \r
 148 #define M_PKCS12_certbag2x509 PKCS12_certbag2x509\r
 149 #define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl \r
 150 \r
 151 #define M_PKCS12_unpack_p7data PKCS12_unpack_p7data\r
 152 #define M_PKCS12_pack_authsafes PKCS12_pack_authsafes\r
 153 #define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes\r
 154 #define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata\r
 155 \r
 156 #define M_PKCS12_decrypt_skey PKCS12_decrypt_skey\r
 157 #define M_PKCS8_decrypt PKCS8_decrypt\r
 158 \r
 159 #define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)\r
 160 #define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)\r
 161 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type\r
 162 \r
 163 #define PKCS12_get_attr(bag, attr_nid) \\r
 164                          PKCS12_get_attr_gen(bag->attrib, attr_nid)\r
 165 \r
 166 #define PKCS8_get_attr(p8, attr_nid) \\r
 167                 PKCS12_get_attr_gen(p8->attributes, attr_nid)\r
 168 \r
 169 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)\r
 170 \r
 171 \r
 172 PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509);\r
 173 PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl);\r
 174 X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag);\r
 175 X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag);\r
 176 \r
 177 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it, int nid1,\r
 178              int nid2);\r
 179 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);\r
 180 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass, int passlen);\r
 181 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag, const char *pass,\r
 182                                                                 int passlen);\r
 183 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, \r
 184                         const char *pass, int passlen,\r
 185                         unsigned char *salt, int saltlen, int iter,\r
 186                         PKCS8_PRIV_KEY_INFO *p8);\r
 187 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,\r
 188                                      int passlen, unsigned char *salt,\r
 189                                      int saltlen, int iter,\r
 190                                      PKCS8_PRIV_KEY_INFO *p8);\r
 191 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);\r
 192 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);\r
 193 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,\r
 194                              unsigned char *salt, int saltlen, int iter,\r
 195                              STACK_OF(PKCS12_SAFEBAG) *bags);\r
 196 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass, int passlen);\r
 197 \r
 198 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);\r
 199 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);\r
 200 \r
 201 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);\r
 202 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,\r
 203                                 int namelen);\r
 204 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,\r
 205                                 int namelen);\r
 206 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,\r
 207                                 int namelen);\r
 208 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);\r
 209 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);\r
 210 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);\r
 211 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,\r
 212                                 int passlen, unsigned char *in, int inlen,\r
 213                                 unsigned char **data, int *datalen, int en_de);\r
 214 void * PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it,\r
 215              const char *pass, int passlen, ASN1_OCTET_STRING *oct, int zbuf);\r
 216 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor, const ASN1_ITEM *it,\r
 217                                        const char *pass, int passlen,\r
 218                                        void *obj, int zbuf);\r
 219 PKCS12 *PKCS12_init(int mode);\r
 220 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,\r
 221                        int saltlen, int id, int iter, int n,\r
 222                        unsigned char *out, const EVP_MD *md_type);\r
 223 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);\r
 224 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,\r
 225                          ASN1_TYPE *param, const EVP_CIPHER *cipher, const EVP_MD *md_type,\r
 226                          int en_de);\r
 227 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,\r
 228                          unsigned char *mac, unsigned int *maclen);\r
 229 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);\r
 230 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,\r
 231                    unsigned char *salt, int saltlen, int iter,\r
 232                    const EVP_MD *md_type);\r
 233 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,\r
 234                                          int saltlen, const EVP_MD *md_type);\r
 235 unsigned char *asc2uni(const char *asc, int asclen, unsigned char **uni, int *unilen);\r
 236 char *uni2asc(unsigned char *uni, int unilen);\r
 237 \r
 238 DECLARE_ASN1_FUNCTIONS(PKCS12)\r
 239 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)\r
 240 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)\r
 241 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)\r
 242 \r
 243 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)\r
 244 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)\r
 245 \r
 246 void PKCS12_PBE_add(void);\r
 247 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,\r
 248                  STACK_OF(X509) **ca);\r
 249 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,\r
 250                          STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,\r
 251                                                  int mac_iter, int keytype);\r
 252 \r
 253 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);\r
 254 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags, EVP_PKEY *key,\r
 255                                                 int key_usage, int iter,\r
 256                                                 int key_nid, char *pass);\r
 257 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,\r
 258                                         int safe_nid, int iter, char *pass);\r
 259 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);\r
 260 \r
 261 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);\r
 262 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);\r
 263 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);\r
 264 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);\r
 265 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);\r
 266 \r
 267 /* BEGIN ERROR CODES */\r
 268 /* The following lines are auto generated by the script mkerr.pl. Any changes\r
 269  * made after this point may be overwritten when the script is next run.\r
 270  */\r
 271 void ERR_load_PKCS12_strings(void);\r
 272 \r
 273 /* Error codes for the PKCS12 functions. */\r
 274 \r
 275 /* Function codes. */\r
 276 #define PKCS12_F_PARSE_BAG                               129\r
 277 #define PKCS12_F_PARSE_BAGS                              103\r
 278 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100\r
 279 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127\r
 280 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102\r
 281 #define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104\r
 282 #define PKCS12_F_PKCS12_CREATE                           105\r
 283 #define PKCS12_F_PKCS12_GEN_MAC                          107\r
 284 #define PKCS12_F_PKCS12_INIT                             109\r
 285 #define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I                 106\r
 286 #define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT                 108\r
 287 #define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG                117\r
 288 #define PKCS12_F_PKCS12_KEY_GEN_ASC                      110\r
 289 #define PKCS12_F_PKCS12_KEY_GEN_UNI                      111\r
 290 #define PKCS12_F_PKCS12_MAKE_KEYBAG                      112\r
 291 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113\r
 292 #define PKCS12_F_PKCS12_NEWPASS                          128\r
 293 #define PKCS12_F_PKCS12_PACK_P7DATA                      114\r
 294 #define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115\r
 295 #define PKCS12_F_PKCS12_PARSE                            118\r
 296 #define PKCS12_F_PKCS12_PBE_CRYPT                        119\r
 297 #define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120\r
 298 #define PKCS12_F_PKCS12_SETUP_MAC                        122\r
 299 #define PKCS12_F_PKCS12_SET_MAC                          123\r
 300 #define PKCS12_F_PKCS12_UNPACK_AUTHSAFES                 130\r
 301 #define PKCS12_F_PKCS12_UNPACK_P7DATA                    131\r
 302 #define PKCS12_F_PKCS12_VERIFY_MAC                       126\r
 303 #define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124\r
 304 #define PKCS12_F_PKCS8_ENCRYPT                           125\r
 305 \r
 306 /* Reason codes. */\r
 307 #define PKCS12_R_CANT_PACK_STRUCTURE                     100\r
 308 #define PKCS12_R_CONTENT_TYPE_NOT_DATA                   121\r
 309 #define PKCS12_R_DECODE_ERROR                            101\r
 310 #define PKCS12_R_ENCODE_ERROR                            102\r
 311 #define PKCS12_R_ENCRYPT_ERROR                           103\r
 312 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120\r
 313 #define PKCS12_R_INVALID_NULL_ARGUMENT                   104\r
 314 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105\r
 315 #define PKCS12_R_IV_GEN_ERROR                            106\r
 316 #define PKCS12_R_KEY_GEN_ERROR                           107\r
 317 #define PKCS12_R_MAC_ABSENT                              108\r
 318 #define PKCS12_R_MAC_GENERATION_ERROR                    109\r
 319 #define PKCS12_R_MAC_SETUP_ERROR                         110\r
 320 #define PKCS12_R_MAC_STRING_SET_ERROR                    111\r
 321 #define PKCS12_R_MAC_VERIFY_ERROR                        112\r
 322 #define PKCS12_R_MAC_VERIFY_FAILURE                      113\r
 323 #define PKCS12_R_PARSE_ERROR                             114\r
 324 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115\r
 325 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116\r
 326 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117\r
 327 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118\r
 328 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119\r
 329 \r
 330 #ifdef  __cplusplus\r
 331 }\r
 332 #endif\r
 333 #endif\r