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 #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 /*#define PBE_UNICODE*/
  85
  86 #ifdef PBE_UNICODE
  87 #define PKCS12_key_gen PKCS12_key_gen_uni
  88 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
  89 #else
  90 #define PKCS12_key_gen PKCS12_key_gen_asc
  91 #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
  92 #endif
  93
  94 /* MS key usage constants */
  95
  96 #define KEY_EX  0x10
  97 #define KEY_SIG 0x80
  98
  99 typedef struct {
 100 X509_SIG *dinfo;
 101 ASN1_OCTET_STRING *salt;
 102 ASN1_INTEGER *iter;     /* defaults to 1 */
 103 } PKCS12_MAC_DATA;
 104
 105 typedef struct {
 106 ASN1_INTEGER *version;
 107 PKCS12_MAC_DATA *mac;
 108 PKCS7 *authsafes;
 109 } PKCS12;
 110
 111 PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
 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 ASN1_TYPE *rest;
 124 } PKCS12_SAFEBAG;
 125
 126 DECLARE_STACK_OF(PKCS12_SAFEBAG)
 127 /* This block of defines is updated by a perl script, please do not touch! */
 128 #ifndef DEBUG_SAFESTACK
 129         #define sk_PKCS12_SAFEBAG_new(a) sk_new((int (*) \
 130                 (const char * const *, const char * const *))(a))
 131         #define sk_PKCS12_SAFEBAG_new_null() sk_new_null()
 132         #define sk_PKCS12_SAFEBAG_free(a) sk_free(a)
 133         #define sk_PKCS12_SAFEBAG_num(a) sk_num(a)
 134         #define sk_PKCS12_SAFEBAG_value(a,b) ((PKCS12_SAFEBAG *) \
 135                 sk_value((a),(b)))
 136         #define sk_PKCS12_SAFEBAG_set(a,b,c) ((PKCS12_SAFEBAG *) \
 137                 sk_set((a),(b),(char *)(c)))
 138         #define sk_PKCS12_SAFEBAG_zero(a) sk_zero(a)
 139         #define sk_PKCS12_SAFEBAG_push(a,b) sk_push((a),(char *)(b))
 140         #define sk_PKCS12_SAFEBAG_unshift(a,b) sk_unshift((a),(b))
 141         #define sk_PKCS12_SAFEBAG_find(a,b) sk_find((a), (char *)(b))
 142         #define sk_PKCS12_SAFEBAG_delete(a,b) ((PKCS12_SAFEBAG *) \
 143                 sk_delete((a),(b)))
 144         #define sk_PKCS12_SAFEBAG_delete_ptr(a,b) ((PKCS12_SAFEBAG *) \
 145                 sk_delete_ptr((a),(char *)(b)))
 146         #define sk_PKCS12_SAFEBAG_insert(a,b,c) sk_insert((a),(char *)(b),(c))
 147         #define sk_PKCS12_SAFEBAG_set_cmp_func(a,b) ((int (*) \
 148                 (const PKCS12_SAFEBAG * const *,const PKCS12_SAFEBAG * const *)) \
 149                 sk_set_cmp_func((a),(int (*) \
 150                 (const char * const *, const char * const *))(b)))
 151         #define sk_PKCS12_SAFEBAG_dup(a) sk_dup(a)
 152         #define sk_PKCS12_SAFEBAG_pop_free(a,b) sk_pop_free((a),(void (*)(void *))(b))
 153         #define sk_PKCS12_SAFEBAG_shift(a) ((PKCS12_SAFEBAG *)sk_shift(a))
 154         #define sk_PKCS12_SAFEBAG_pop(a) ((PKCS12_SAFEBAG *)sk_pop(a))
 155         #define sk_PKCS12_SAFEBAG_sort(a) sk_sort(a)
 156 #endif /* !DEBUG_SAFESTACK */
 157 /* End of perl script block, you may now edit :-) */
 158 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
 159 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
 160
 161 typedef struct pkcs12_bag_st {
 162 ASN1_OBJECT *type;
 163 union {
 164         ASN1_OCTET_STRING *x509cert;
 165         ASN1_OCTET_STRING *x509crl;
 166         ASN1_OCTET_STRING *octet;
 167         ASN1_IA5STRING *sdsicert;
 168         ASN1_TYPE *other; /* Secret or other bag */
 169 }value;
 170 } PKCS12_BAGS;
 171
 172 #define PKCS12_ERROR    0
 173 #define PKCS12_OK       1
 174
 175 #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
 176 #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
 177 #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
 178
 179 #define M_PKCS12_x5092certbag(x509) \
 180 PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
 181
 182 #define M_PKCS12_x509crl2certbag(crl) \
 183 PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
 184
 185 #define M_PKCS12_certbag2x509(bg) \
 186 (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
 187 (char *(*)())d2i_X509)
 188
 189 #define M_PKCS12_certbag2x509crl(bg) \
 190 (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
 191 (char *(*)())d2i_X509CRL)
 192
 193 /*#define M_PKCS12_pkcs82rsa(p8) \
 194 (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
 195
 196 #define M_PKCS12_unpack_p7data(p7) \
 197 ASN1_seq_unpack_PKCS12_SAFEBAG ((p7)->d.data->data, p7->d.data->length, \
 198                                 d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
 199
 200 #define M_PKCS12_pack_authsafes(p12, safes) \
 201 ASN1_seq_pack_PKCS7((safes), i2d_PKCS7,\
 202         &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
 203
 204 #define M_PKCS12_unpack_authsafes(p12) \
 205 ASN1_seq_unpack_PKCS7((p12)->authsafes->d.data->data, \
 206                 (p12)->authsafes->d.data->length, d2i_PKCS7, PKCS7_free)
 207
 208 #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
 209 PKCS12_decrypt_d2i_PKCS12_SAFEBAG ((p7)->d.encrypted->enc_data->algorithm,\
 210                                    d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
 211                                    (pass), (passlen), \
 212                                    (p7)->d.encrypted->enc_data->enc_data, 3)
 213
 214 #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
 215 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
 216 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
 217                                                 (pass), (passlen), \
 218                          (bag)->value.shkeybag->digest, 2)
 219
 220 #define M_PKCS8_decrypt(p8, pass, passlen) \
 221 (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
 222 (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free,\
 223                          (pass), (passlen), (p8)->digest, 2)
 224
 225 #define PKCS12_get_attr(bag, attr_nid) \
 226                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
 227
 228 #define PKCS8_get_attr(p8, attr_nid) \
 229                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
 230
 231 #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
 232
 233
 234 PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
 235 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
 236 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
 237                         const char *pass, int passlen,
 238                         unsigned char *salt, int saltlen, int iter,
 239                         PKCS8_PRIV_KEY_INFO *p8);
 240 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
 241                                      int passlen, unsigned char *salt,
 242                                      int saltlen, int iter,
 243                                      PKCS8_PRIV_KEY_INFO *p8);
 244 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
 245 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
 246                              unsigned char *salt, int saltlen, int iter,
 247                              STACK_OF(PKCS12_SAFEBAG) *bags);
 248 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
 249 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
 250                                 int namelen);
 251 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
 252                                 int namelen);
 253 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
 254 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
 255 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
 256 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
 257                                 int passlen, unsigned char *in, int inlen,
 258                                 unsigned char **data, int *datalen, int en_de);
 259 char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
 260                          void (*free_func)(), const char *pass, int passlen,
 261                          ASN1_STRING *oct, int seq);
 262 ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
 263                                 const char *pass, int passlen, char *obj,
 264                                 int seq);
 265 PKCS12 *PKCS12_init(int mode);
 266 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
 267                        int saltlen, int id, int iter, int n,
 268                        unsigned char *out, const EVP_MD *md_type);
 269 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);
 270 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 271                          ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type,
 272                          int en_de);
 273 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
 274                          unsigned char *mac, unsigned int *maclen);
 275 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
 276 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
 277                    unsigned char *salt, int saltlen, int iter,
 278                    EVP_MD *md_type);
 279 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
 280                                          int saltlen, EVP_MD *md_type);
 281 unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
 282 char *uni2asc(unsigned char *uni, int unilen);
 283 int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
 284 PKCS12_BAGS *PKCS12_BAGS_new(void);
 285 PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
 286 void PKCS12_BAGS_free(PKCS12_BAGS *a);
 287 int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
 288 PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
 289 PKCS12 *PKCS12_new(void);
 290 void PKCS12_free(PKCS12 *a);
 291 int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
 292 PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
 293 PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
 294                                                                  long length);
 295 void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
 296 int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
 297 PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
 298 PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
 299                                                                  long length);
 300 void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
 301 void ERR_load_PKCS12_strings(void);
 302 void PKCS12_PBE_add(void);
 303 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
 304                  STACK_OF(X509) **ca);
 305 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
 306                          STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
 307                                                  int mac_iter, int keytype);
 308 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
 309 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
 310 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
 311 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
 312 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
 313
 314 /* BEGIN ERROR CODES */
 315 /* The following lines are auto generated by the script mkerr.pl. Any changes
 316  * made after this point may be overwritten when the script is next run.
 317  */
 318
 319 /* Error codes for the PKCS12 functions. */
 320
 321 /* Function codes. */
 322 #define PKCS12_F_PARSE_BAGS                              103
 323 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100
 324 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127
 325 #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102
 326 #define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
 327 #define PKCS12_F_PKCS12_CREATE                           105
 328 #define PKCS12_F_PKCS12_DECRYPT_D2I                      106
 329 #define PKCS12_F_PKCS12_GEN_MAC                          107
 330 #define PKCS12_F_PKCS12_I2D_ENCRYPT                      108
 331 #define PKCS12_F_PKCS12_INIT                             109
 332 #define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
 333 #define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
 334 #define PKCS12_F_PKCS12_MAKE_KEYBAG                      112
 335 #define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
 336 #define PKCS12_F_PKCS12_NEWPASS                          128
 337 #define PKCS12_F_PKCS12_PACK_P7DATA                      114
 338 #define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
 339 #define PKCS12_F_PKCS12_PACK_SAFEBAG                     117
 340 #define PKCS12_F_PKCS12_PARSE                            118
 341 #define PKCS12_F_PKCS12_PBE_CRYPT                        119
 342 #define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
 343 #define PKCS12_F_PKCS12_SETUP_MAC                        122
 344 #define PKCS12_F_PKCS12_SET_MAC                          123
 345 #define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
 346 #define PKCS12_F_PKCS8_ENCRYPT                           125
 347 #define PKCS12_F_VERIFY_MAC                              126
 348
 349 /* Reason codes. */
 350 #define PKCS12_R_CANT_PACK_STRUCTURE                     100
 351 #define PKCS12_R_DECODE_ERROR                            101
 352 #define PKCS12_R_ENCODE_ERROR                            102
 353 #define PKCS12_R_ENCRYPT_ERROR                           103
 354 #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
 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