crypto/pkcs12/pkcs12.h

   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 #ifndef HEADER_PKCS12_H
  60 #define HEADER_PKCS12_H
  61
  62 #ifdef __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 #include <openssl/bio.h>
  67 #include <openssl/x509.h>
  68
  69 #define PKCS12_KEY_ID   1
  70 #define PKCS12_IV_ID    2
  71 #define PKCS12_MAC_ID   3
  72
  73 #define PKCS12_MAC_KEY_LENGTH 20
  74
  75 #define PKCS12_SALT_LEN 8
  76
  77 /* Uncomment out next line for unicode password and names, otherwise ASCII */
  78
  79 /*#define PBE_UNICODE*/
  80
  81 #ifdef PBE_UNICODE
  82 #define PKCS12_key_gen PKCS12_key_gen_uni
  83 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
  84 #else
  85 #define PKCS12_key_gen PKCS12_key_gen_asc
  86 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
  87 #endif
  88
  89 /* MS key usage constants */
  90
  91 #define KEY_EX  0x10
  92 #define KEY_SIG 0x80
  93
  94 typedef struct {
  95 X509_SIG *dinfo;
  96 ASN1_OCTET_STRING *salt;
  97 ASN1_INTEGER *iter;     /* defaults to 1 */
  98 } PKCS12_MAC_DATA;
  99
 100 typedef struct {
 101 ASN1_INTEGER *version;
 102 PKCS12_MAC_DATA *mac;
 103 PKCS7 *authsafes;
 104 } PKCS12;
 105
 106 typedef struct {
 107 ASN1_OBJECT *type;
 108 union {
 109         struct pkcs12_bag_st *bag; /* secret, crl and certbag */
 110         struct pkcs8_priv_key_info_st   *keybag; /* keybag */
 111         X509_SIG *shkeybag; /* shrouded key bag */
 112         STACK /* PKCS12_SAFEBAG */ *safes;
 113         ASN1_TYPE *other;
 114 }value;
 115 STACK *attrib;
 116 ASN1_TYPE *rest;
 117 } PKCS12_SAFEBAG;
 118
 119 typedef struct pkcs12_bag_st {
 120 ASN1_OBJECT *type;
 121 union {
 122         ASN1_OCTET_STRING *x509cert;
 123         ASN1_OCTET_STRING *x509crl;
 124         ASN1_OCTET_STRING *octet;
 125         ASN1_IA5STRING *sdsicert;
 126         ASN1_TYPE *other; /* Secret or other bag */
 127 }value;
 128 } PKCS12_BAGS;
 129
 130 #define PKCS12_ERROR    0
 131 #define PKCS12_OK       1
 132
 133 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
 134 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
 135 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
 136
 137 #define M_PKCS12_x5092certbag(x509) \
 138 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
 139
 140 #define M_PKCS12_x509crl2certbag(crl) \
 141 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
 142
 143 #define M_PKCS12_certbag2x509(bg) \
 144 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
 145 (char *(*)())d2i_X509)
 146
 147 #define M_PKCS12_certbag2x509crl(bg) \
 148 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
 149 (char *(*)())d2i_X509CRL)
 150
 151 /*#define M_PKCS12_pkcs82rsa(p8) \
 152 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
 153
 154 #define M_PKCS12_unpack_p7data(p7) \
 155 ASN1_seq_unpack ((p7)->d.data->data, p7->d.data->length, \
 156                          (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
 157
 158 #define M_PKCS12_pack_authsafes(p12, safes) \
 159 ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
 160         &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
 161
 162 #define M_PKCS12_unpack_authsafes(p12) \
 163 ASN1_seq_unpack((p12)->authsafes->d.data->data, \
 164                 (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
 165                                                         PKCS7_free)
 166
 167 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
 168 (STACK *) PKCS12_decrypt_d2i ((p7)->d.encrypted->enc_data->algorithm,\
 169                          (char *(*)())d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
 170                                                         (pass), (passlen), \
 171                         (p7)->d.encrypted->enc_data->enc_data, 3)
 172
 173 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
 174 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
 175 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
 176                                                 (pass), (passlen), \
 177                          (bag)->value.shkeybag->digest, 2)
 178
 179 #define M_PKCS8_decrypt(p8, pass, passlen) \
 180 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
 181 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (pass), (passlen), (p8)->digest, 2)
 182
 183 #define PKCS12_get_attr(bag, attr_nid) \
 184                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
 185
 186 #define PKCS8_get_attr(p8, attr_nid) \
 187                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
 188
 189 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
 190
 191
 192 #ifndef NOPROTO
 193 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
 194 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
 195 X509_SIG *PKCS8_encrypt(int pbe_nid, const char *pass, int passlen,
 196                         unsigned char *salt, int saltlen, int iter,
 197                         PKCS8_PRIV_KEY_INFO *p8);
 198 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
 199                                      int passlen, unsigned char *salt,
 200                                      int saltlen, int iter,
 201                                      PKCS8_PRIV_KEY_INFO *p8);
 202 PKCS7 *PKCS12_pack_p7data(STACK *sk);
 203 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
 204                              unsigned char *salt, int saltlen, int iter,
 205                              STACK *bags);
 206 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
 207 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
 208                                 int namelen);
 209 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
 210                                 int namelen);
 211 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
 212 ASN1_TYPE *PKCS12_get_attr_gen(STACK *attrs, int attr_nid);
 213 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
 214 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
 215                                 int passlen, unsigned char *in, int inlen,
 216                                 unsigned char **data, int *datalen, int en_de);
 217 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
 218                          void (*free_func)(), const char *pass, int passlen,
 219                          ASN1_STRING *oct, int seq);
 220 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
 221                                 const char *pass, int passlen, char *obj,
 222                                 int seq);
 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, int saltlen, int id, int iter, int n, unsigned char *out, const EVP_MD *md_type);
 228 int PKCS12_PBE_keyivgen(const char *pass, int passlen, unsigned char *salt, int saltlen, int iter, EVP_CIPHER *cipher, EVP_MD *md_type, unsigned char *key, unsigned char *iv);
 229 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, unsigned char *mac, unsigned int *maclen);
 230 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
 231 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
 232                    unsigned char *salt, int saltlen, int iter,
 233                    EVP_MD *md_type);
 234 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, int saltlen, EVP_MD *md_type);
 235 unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
 236 char *uni2asc(unsigned char *uni, int unilen);
 237 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
 238 PKCS12_BAGS *PKCS12_BAGS_new(void);
 239 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
 240 void PKCS12_BAGS_free(PKCS12_BAGS *a);
 241 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
 242 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
 243 PKCS12 *PKCS12_new(void);
 244 void PKCS12_free(PKCS12 *a);
 245 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
 246 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
 247 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp, long length);
 248 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
 249 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
 250 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
 251 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp, long length);
 252 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
 253 void ERR_load_PKCS12_strings(void);
 254 void PKCS12_PBE_add(void);
 255 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
 256                  STACK **ca);
 257 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, STACK *ca, int nid_key, int nid_cert, int iter, int mac_iter, int keytype);
 258 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
 259 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
 260 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
 261 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
 262
 263 #else
 264
 265 PKCS12_SAFEBAG *PKCS12_pack_safebag();
 266 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG();
 267 X509_SIG *PKCS8_encrypt();
 268 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG();
 269 PKCS7 *PKCS12_pack_p7data();
 270 PKCS7 *PKCS12_pack_p7encdata();
 271 int PKCS12_add_localkeyid();
 272 int PKCS12_add_friendlyname_asc();
 273 int PKCS12_add_friendlyname_uni();
 274 char *PKCS12_get_friendlyname();
 275 unsigned char *PKCS12_pbe_crypt();
 276 char *PKCS12_decrypt_d2i();
 277 ASN1_STRING *PKCS12_i2d_encrypt();
 278 PKCS12 *PKCS12_init();
 279 int PKCS12_key_gen_asc();
 280 int PKCS12_key_gen_uni();
 281 int PKCS12_gen_mac();
 282 int PKCS12_verify_mac();
 283 int PKCS12_set_mac();
 284 int PKCS12_setup_mac();
 285 unsigned char *asc2uni();
 286 char *uni2asc();
 287 int i2d_PKCS12_BAGS();
 288 PKCS12_BAGS *PKCS12_BAGS_new();
 289 PKCS12_BAGS *d2i_PKCS12_BAGS();
 290 void PKCS12_BAGS_free();
 291 int i2d_PKCS12();
 292 PKCS12 *d2i_PKCS12();
 293 PKCS12 *PKCS12_new();
 294 void PKCS12_free();
 295 int i2d_PKCS12_MAC_DATA();
 296 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new();
 297 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA();
 298 void PKCS12_MAC_DATA_free();
 299 int i2d_PKCS12_SAFEBAG();
 300 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new();
 301 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG();
 302 void PKCS12_SAFEBAG_free();
 303 void ERR_load_PKCS12_strings();
 304 void PKCS12_PBE_add();
 305 int PKCS8_add_keyusage();
 306 ASN1_TYPE *PKCS12_get_attr_gen();
 307 int PKCS12_parse();
 308 PKCS12 *PKCS12_create();
 309 int i2d_PKCS12_bio();
 310 int i2d_PKCS12_fp();
 311 PKCS12 *d2i_PKCS12_bio();
 312 PKCS12 *d2i_PKCS12_fp();
 313
 314 #endif
 315
 316 /* BEGIN ERROR CODES */
 317 /* The following lines are auto generated by the script mkerr.pl. Any changes
 318  * made after this point may be overwritten when the script is next run.
 319  */
 320
 321 /* Error codes for the PKCS12 functions. */
 322
 323 /* Function codes. */
 324 #define PKCS12_F_PARSE_BAGS                              103
 325 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100
 326 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127
 327 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102
 328 #define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
 329 #define PKCS12_F_PKCS12_CREATE                           105
 330 #define PKCS12_F_PKCS12_DECRYPT_D2I                      106
 331 #define PKCS12_F_PKCS12_GEN_MAC                          107
 332 #define PKCS12_F_PKCS12_I2D_ENCRYPT                      108
 333 #define PKCS12_F_PKCS12_INIT                             109
 334 #define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
 335 #define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
 336 #define PKCS12_F_PKCS12_MAKE_KEYBAG                      112
 337 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
 338 #define PKCS12_F_PKCS12_PACK_P7DATA                      114
 339 #define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
 340 #define PKCS12_F_PKCS12_PACK_SAFEBAG                     117
 341 #define PKCS12_F_PKCS12_PARSE                            118
 342 #define PKCS12_F_PKCS12_PBE_CRYPT                        119
 343 #define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
 344 #define PKCS12_F_PKCS12_SETUP_MAC                        122
 345 #define PKCS12_F_PKCS12_SET_MAC                          123
 346 #define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
 347 #define PKCS12_F_PKCS8_ENCRYPT                           125
 348 #define PKCS12_F_VERIFY_MAC                              126
 349
 350 /* Reason codes. */
 351 #define PKCS12_R_CANT_PACK_STRUCTURE                     100
 352 #define PKCS12_R_DECODE_ERROR                            101
 353 #define PKCS12_R_ENCODE_ERROR                            102
 354 #define PKCS12_R_ENCRYPT_ERROR                           103
 355 #define PKCS12_R_INVALID_NULL_ARGUMENT                   104
 356 #define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
 357 #define PKCS12_R_IV_GEN_ERROR                            106
 358 #define PKCS12_R_KEY_GEN_ERROR                           107
 359 #define PKCS12_R_MAC_ABSENT                              108
 360 #define PKCS12_R_MAC_GENERATION_ERROR                    109
 361 #define PKCS12_R_MAC_SETUP_ERROR                         110
 362 #define PKCS12_R_MAC_STRING_SET_ERROR                    111
 363 #define PKCS12_R_MAC_VERIFY_ERROR                        112
 364 #define PKCS12_R_MAC_VERIFY_FAILURE                      113
 365 #define PKCS12_R_PARSE_ERROR                             114
 366 #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
 367 #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
 368 #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
 369 #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
 370 #define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
 371
 372 #ifdef  __cplusplus
 373 }
 374 #endif
 375 #endif
 376