include/openssl/pkcs12.h

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