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 {
 102     X509_SIG *dinfo;
 103     ASN1_OCTET_STRING *salt;
 104     ASN1_INTEGER *iter;         /* defaults to 1 */
 105 } PKCS12_MAC_DATA;
 106
 107 typedef struct {
 108     ASN1_INTEGER *version;
 109     PKCS12_MAC_DATA *mac;
 110     PKCS7 *authsafes;
 111 } PKCS12;
 112
 113 typedef struct {
 114     ASN1_OBJECT *type;
 115     union {
 116         struct pkcs12_bag_st *bag; /* secret, crl and certbag */
 117         struct pkcs8_priv_key_info_st *keybag; /* keybag */
 118         X509_SIG *shkeybag;     /* shrouded key bag */
 119         STACK_OF(PKCS12_SAFEBAG) *safes;
 120         ASN1_TYPE *other;
 121     } value;
 122     STACK_OF(X509_ATTRIBUTE) *attrib;
 123 } PKCS12_SAFEBAG;
 124
 125 DEFINE_STACK_OF(PKCS12_SAFEBAG)
 126
 127 typedef struct pkcs12_bag_st {
 128     ASN1_OBJECT *type;
 129     union {
 130         ASN1_OCTET_STRING *x509cert;
 131         ASN1_OCTET_STRING *x509crl;
 132         ASN1_OCTET_STRING *octet;
 133         ASN1_IA5STRING *sdsicert;
 134         ASN1_TYPE *other;       /* Secret or other bag */
 135     } value;
 136 } PKCS12_BAGS;
 137
 138 # define PKCS12_ERROR    0
 139 # define PKCS12_OK       1
 140
 141 /* Compatibility macros */
 142
 143 # define M_PKCS12_x5092certbag PKCS12_x5092certbag
 144 # define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
 145
 146 # define M_PKCS12_certbag2x509 PKCS12_certbag2x509
 147 # define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl
 148
 149 # define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
 150 # define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
 151 # define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
 152 # define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
 153
 154 # define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
 155 # define M_PKCS8_decrypt PKCS8_decrypt
 156
 157 # define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)
 158 # define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)
 159 # define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
 160
 161 # define PKCS12_get_attr(bag, attr_nid) \
 162                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
 163
 164 # define PKCS8_get_attr(p8, attr_nid) \
 165                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
 166
 167 # define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
 168
 169 PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509);
 170 PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl);
 171 X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag);
 172 X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag);
 173
 174 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
 175                                          int nid1, int nid2);
 176 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
 177 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass,
 178                                    int passlen);
 179 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag,
 180                                          const char *pass, int passlen);
 181 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
 182                         const char *pass, int passlen, unsigned char *salt,
 183                         int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
 184 X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
 185                         PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
 186 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
 187                                      int passlen, unsigned char *salt,
 188                                      int saltlen, int iter,
 189                                      PKCS8_PRIV_KEY_INFO *p8);
 190 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
 191 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
 192 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
 193                              unsigned char *salt, int saltlen, int iter,
 194                              STACK_OF(PKCS12_SAFEBAG) *bags);
 195 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
 196                                                   int passlen);
 197
 198 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
 199 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);
 200
 201 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
 202                           int namelen);
 203 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
 204                                 int namelen);
 205 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
 206                            int namelen);
 207 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
 208                                 const unsigned char *name, int namelen);
 209 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
 210 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
 211 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
 212 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
 213                                 int passlen, unsigned char *in, int inlen,
 214                                 unsigned char **data, int *datalen,
 215                                 int en_de);
 216 void *PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it,
 217                               const char *pass, int passlen,
 218                               ASN1_OCTET_STRING *oct, int zbuf);
 219 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
 220                                            const ASN1_ITEM *it,
 221                                            const char *pass, int passlen,
 222                                            void *obj, int zbuf);
 223 PKCS12 *PKCS12_init(int mode);
 224 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
 225                        int saltlen, int id, int iter, int n,
 226                        unsigned char *out, const EVP_MD *md_type);
 227 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
 228                        int saltlen, int id, int iter, int n,
 229                        unsigned char *out, const EVP_MD *md_type);
 230 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 231                         ASN1_TYPE *param, const EVP_CIPHER *cipher,
 232                         const EVP_MD *md_type, int en_de);
 233 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
 234                    unsigned char *mac, unsigned int *maclen);
 235 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
 236 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
 237                    unsigned char *salt, int saltlen, int iter,
 238                    const EVP_MD *md_type);
 239 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
 240                      int saltlen, const EVP_MD *md_type);
 241 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
 242                                unsigned char **uni, int *unilen);
 243 char *OPENSSL_uni2asc(unsigned char *uni, int unilen);
 244
 245 DECLARE_ASN1_FUNCTIONS(PKCS12)
 246 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
 247 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
 248 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
 249
 250 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
 251 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
 252
 253 void PKCS12_PBE_add(void);
 254 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
 255                  STACK_OF(X509) **ca);
 256 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
 257                       STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
 258                       int mac_iter, int keytype);
 259
 260 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
 261 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
 262                                EVP_PKEY *key, int key_usage, int iter,
 263                                int key_nid, char *pass);
 264 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
 265                     int safe_nid, int iter, char *pass);
 266 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
 267
 268 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
 269 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
 270 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
 271 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
 272 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
 273
 274 /* BEGIN ERROR CODES */
 275 /*
 276  * The following lines are auto generated by the script mkerr.pl. Any changes
 277  * made after this point may be overwritten when the script is next run.
 278  */
 279 void ERR_load_PKCS12_strings(void);
 280
 281 /* Error codes for the PKCS12 functions. */
 282
 283 /* Function codes. */
 284 # define PKCS12_F_PARSE_BAG                               129
 285 # define PKCS12_F_PARSE_BAGS                              103
 286 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100
 287 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127
 288 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102
 289 # define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
 290 # define PKCS12_F_PKCS12_CREATE                           105
 291 # define PKCS12_F_PKCS12_GEN_MAC                          107
 292 # define PKCS12_F_PKCS12_INIT                             109
 293 # define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I                 106
 294 # define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT                 108
 295 # define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG                117
 296 # define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
 297 # define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
 298 # define PKCS12_F_PKCS12_MAKE_KEYBAG                      112
 299 # define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
 300 # define PKCS12_F_PKCS12_NEWPASS                          128
 301 # define PKCS12_F_PKCS12_PACK_P7DATA                      114
 302 # define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
 303 # define PKCS12_F_PKCS12_PARSE                            118
 304 # define PKCS12_F_PKCS12_PBE_CRYPT                        119
 305 # define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
 306 # define PKCS12_F_PKCS12_SETUP_MAC                        122
 307 # define PKCS12_F_PKCS12_SET_MAC                          123
 308 # define PKCS12_F_PKCS12_UNPACK_AUTHSAFES                 130
 309 # define PKCS12_F_PKCS12_UNPACK_P7DATA                    131
 310 # define PKCS12_F_PKCS12_VERIFY_MAC                       126
 311 # define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
 312 # define PKCS12_F_PKCS8_ENCRYPT                           125
 313 # define PKCS12_F_PKCS8_SET0_PBE                          132
 314
 315 /* Reason codes. */
 316 # define PKCS12_R_CANT_PACK_STRUCTURE                     100
 317 # define PKCS12_R_CONTENT_TYPE_NOT_DATA                   121
 318 # define PKCS12_R_DECODE_ERROR                            101
 319 # define PKCS12_R_ENCODE_ERROR                            102
 320 # define PKCS12_R_ENCRYPT_ERROR                           103
 321 # define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
 322 # define PKCS12_R_INVALID_NULL_ARGUMENT                   104
 323 # define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
 324 # define PKCS12_R_IV_GEN_ERROR                            106
 325 # define PKCS12_R_KEY_GEN_ERROR                           107
 326 # define PKCS12_R_MAC_ABSENT                              108
 327 # define PKCS12_R_MAC_GENERATION_ERROR                    109
 328 # define PKCS12_R_MAC_SETUP_ERROR                         110
 329 # define PKCS12_R_MAC_STRING_SET_ERROR                    111
 330 # define PKCS12_R_MAC_VERIFY_ERROR                        112
 331 # define PKCS12_R_MAC_VERIFY_FAILURE                      113
 332 # define PKCS12_R_PARSE_ERROR                             114
 333 # define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
 334 # define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
 335 # define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
 336 # define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
 337 # define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
 338
 339 #ifdef  __cplusplus
 340 }
 341 #endif
 342 #endif