include/openssl/pkcs12.h

   1 /*
   2  * Copyright 1999-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_PKCS12_H
  11 # define HEADER_PKCS12_H
  12
  13 # include <openssl/bio.h>
  14 # include <openssl/x509.h>
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 # define PKCS12_KEY_ID   1
  21 # define PKCS12_IV_ID    2
  22 # define PKCS12_MAC_ID   3
  23
  24 /* Default iteration count */
  25 # ifndef PKCS12_DEFAULT_ITER
  26 #  define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER
  27 # endif
  28
  29 # define PKCS12_MAC_KEY_LENGTH 20
  30
  31 # define PKCS12_SALT_LEN 8
  32
  33 /* Uncomment out next line for unicode password and names, otherwise ASCII */
  34
  35 /*
  36  * #define PBE_UNICODE
  37  */
  38
  39 # ifdef PBE_UNICODE
  40 #  define PKCS12_key_gen PKCS12_key_gen_uni
  41 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
  42 # else
  43 #  define PKCS12_key_gen PKCS12_key_gen_asc
  44 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
  45 # endif
  46
  47 /* MS key usage constants */
  48
  49 # define KEY_EX  0x10
  50 # define KEY_SIG 0x80
  51
  52 typedef struct PKCS12_MAC_DATA_st PKCS12_MAC_DATA;
  53
  54 typedef struct PKCS12_st PKCS12;
  55
  56 typedef struct PKCS12_SAFEBAG_st PKCS12_SAFEBAG;
  57
  58 DEFINE_STACK_OF(PKCS12_SAFEBAG)
  59
  60 typedef struct pkcs12_bag_st PKCS12_BAGS;
  61
  62 # define PKCS12_ERROR    0
  63 # define PKCS12_OK       1
  64
  65 /* Compatibility macros */
  66
  67 #if OPENSSL_API_COMPAT < 0x10100000L
  68
  69 # define M_PKCS12_bag_type PKCS12_bag_type
  70 # define M_PKCS12_cert_bag_type PKCS12_cert_bag_type
  71 # define M_PKCS12_crl_bag_type PKCS12_cert_bag_type
  72
  73 # define PKCS12_certbag2x509 PKCS12_SAFEBAG_get1_cert
  74 # define PKCS12_certbag2scrl PKCS12_SAFEBAG_get1_crl
  75 # define PKCS12_get_attr PKCS12_SAFEBAG_get0_attr
  76 # define PKCS12_bag_type PKCS12_SAFEBAG_get_nid
  77 # define PKCS12_cert_bag_type PKCS12_SAFEBAG_get_bag_nid
  78 # define PKCS12_x5092certbag PKCS12_SAFEBAG_create_cert
  79 # define PKCS12_x509crl2certbag PKCS12_SAFEBAG_create_crl
  80 # define PKCS12_MAKE_KEYBAG PKCS12_SAFEBAG_create0_p8inf
  81 # define PKCS12_MAKE_SHKEYBAG PKCS12_SAFEBAG_create_pkcs8_encrypt
  82
  83 #endif
  84
  85 ASN1_TYPE *PKCS8_get_attr(PKCS8_PRIV_KEY_INFO *p8, int attr_nid);
  86 int PKCS12_mac_present(PKCS12 *p12);
  87 void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
  88                      const X509_ALGOR **pmacalg,
  89                      const ASN1_OCTET_STRING **psalt,
  90                      const ASN1_INTEGER **piter,
  91                      const PKCS12 *p12);
  92
  93 ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(PKCS12_SAFEBAG *bag, int attr_nid);
  94 ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(PKCS12_SAFEBAG *bag);
  95 int PKCS12_SAFEBAG_get_nid(PKCS12_SAFEBAG *bag);
  96 int PKCS12_SAFEBAG_get_bag_nid(PKCS12_SAFEBAG *bag);
  97
  98 X509 *PKCS12_SAFEBAG_get1_cert(PKCS12_SAFEBAG *bag);
  99 X509_CRL *PKCS12_SAFEBAG_get1_crl(PKCS12_SAFEBAG *bag);
 100 STACK_OF(PKCS12_SAFEBAG) *PKCS12_SAFEBAG_get0_safes(PKCS12_SAFEBAG *bag);
 101 PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(PKCS12_SAFEBAG *bag);
 102 X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(PKCS12_SAFEBAG *bag);
 103
 104 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_cert(X509 *x509);
 105 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_crl(X509_CRL *crl);
 106 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_p8inf(PKCS8_PRIV_KEY_INFO *p8);
 107 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_pkcs8(X509_SIG *p8);
 108 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_pkcs8_encrypt(int pbe_nid,
 109                                                     const char *pass,
 110                                                     int passlen,
 111                                                     unsigned char *salt,
 112                                                     int saltlen, int iter,
 113                                                     PKCS8_PRIV_KEY_INFO *p8inf);
 114
 115 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
 116                                          int nid1, int nid2);
 117 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
 118                                    int passlen);
 119 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag,
 120                                          const char *pass, int passlen);
 121 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
 122                         const char *pass, int passlen, unsigned char *salt,
 123                         int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
 124 X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
 125                         PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
 126 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
 127 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
 128 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
 129                              unsigned char *salt, int saltlen, int iter,
 130                              STACK_OF(PKCS12_SAFEBAG) *bags);
 131 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
 132                                                   int passlen);
 133
 134 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
 135 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);
 136
 137 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
 138                           int namelen);
 139 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
 140                                 int namelen);
 141 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
 142                            int namelen);
 143 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
 144                                 const unsigned char *name, int namelen);
 145 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
 146 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
 147                                int attr_nid);
 148 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
 149 STACK_OF(X509_ATTRIBUTE) *PKCS12_SAFEBAG_get0_attrs(PKCS12_SAFEBAG *bag);
 150 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
 151                                 const char *pass, int passlen,
 152                                 const unsigned char *in, int inlen,
 153                                 unsigned char **data, int *datalen,
 154                                 int en_de);
 155 void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it,
 156                               const char *pass, int passlen,
 157                               const ASN1_OCTET_STRING *oct, int zbuf);
 158 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
 159                                            const ASN1_ITEM *it,
 160                                            const char *pass, int passlen,
 161                                            void *obj, int zbuf);
 162 PKCS12 *PKCS12_init(int mode);
 163 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
 164                        int saltlen, int id, int iter, int n,
 165                        unsigned char *out, const EVP_MD *md_type);
 166 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
 167                        int saltlen, int id, int iter, int n,
 168                        unsigned char *out, const EVP_MD *md_type);
 169 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 170                         ASN1_TYPE *param, const EVP_CIPHER *cipher,
 171                         const EVP_MD *md_type, int en_de);
 172 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
 173                    unsigned char *mac, unsigned int *maclen);
 174 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
 175 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
 176                    unsigned char *salt, int saltlen, int iter,
 177                    const EVP_MD *md_type);
 178 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
 179                      int saltlen, const EVP_MD *md_type);
 180 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
 181                                unsigned char **uni, int *unilen);
 182 char *OPENSSL_uni2asc(unsigned char *uni, int unilen);
 183
 184 DECLARE_ASN1_FUNCTIONS(PKCS12)
 185 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
 186 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
 187 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
 188
 189 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
 190 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
 191
 192 void PKCS12_PBE_add(void);
 193 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
 194                  STACK_OF(X509) **ca);
 195 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
 196                       X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
 197                       int iter, int mac_iter, int keytype);
 198
 199 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
 200 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
 201                                EVP_PKEY *key, int key_usage, int iter,
 202                                int key_nid, const char *pass);
 203 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
 204                     int safe_nid, int iter, const char *pass);
 205 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
 206
 207 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
 208 # ifndef OPENSSL_NO_STDIO
 209 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
 210 # endif
 211 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
 212 # ifndef OPENSSL_NO_STDIO
 213 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
 214 # endif
 215 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
 216
 217 /* BEGIN ERROR CODES */
 218 /*
 219  * The following lines are auto generated by the script mkerr.pl. Any changes
 220  * made after this point may be overwritten when the script is next run.
 221  */
 222
 223 int ERR_load_PKCS12_strings(void);
 224
 225 /* Error codes for the PKCS12 functions. */
 226
 227 /* Function codes. */
 228 # define PKCS12_F_PKCS12_CREATE                           105
 229 # define PKCS12_F_PKCS12_GEN_MAC                          107
 230 # define PKCS12_F_PKCS12_INIT                             109
 231 # define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I                 106
 232 # define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT                 108
 233 # define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG                117
 234 # define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
 235 # define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
 236 # define PKCS12_F_PKCS12_NEWPASS                          128
 237 # define PKCS12_F_PKCS12_PACK_P7DATA                      114
 238 # define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
 239 # define PKCS12_F_PKCS12_PARSE                            118
 240 # define PKCS12_F_PKCS12_PBE_CRYPT                        119
 241 # define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
 242 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_P8INF            112
 243 # define PKCS12_F_PKCS12_SAFEBAG_CREATE0_PKCS8            113
 244 # define PKCS12_F_PKCS12_SAFEBAG_CREATE_PKCS8_ENCRYPT     133
 245 # define PKCS12_F_PKCS12_SETUP_MAC                        122
 246 # define PKCS12_F_PKCS12_SET_MAC                          123
 247 # define PKCS12_F_PKCS12_UNPACK_AUTHSAFES                 130
 248 # define PKCS12_F_PKCS12_UNPACK_P7DATA                    131
 249 # define PKCS12_F_PKCS12_VERIFY_MAC                       126
 250 # define PKCS12_F_PKCS8_ENCRYPT                           125
 251 # define PKCS12_F_PKCS8_SET0_PBE                          132
 252
 253 /* Reason codes. */
 254 # define PKCS12_R_CANT_PACK_STRUCTURE                     100
 255 # define PKCS12_R_CONTENT_TYPE_NOT_DATA                   121
 256 # define PKCS12_R_DECODE_ERROR                            101
 257 # define PKCS12_R_ENCODE_ERROR                            102
 258 # define PKCS12_R_ENCRYPT_ERROR                           103
 259 # define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
 260 # define PKCS12_R_INVALID_NULL_ARGUMENT                   104
 261 # define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
 262 # define PKCS12_R_IV_GEN_ERROR                            106
 263 # define PKCS12_R_KEY_GEN_ERROR                           107
 264 # define PKCS12_R_MAC_ABSENT                              108
 265 # define PKCS12_R_MAC_GENERATION_ERROR                    109
 266 # define PKCS12_R_MAC_SETUP_ERROR                         110
 267 # define PKCS12_R_MAC_STRING_SET_ERROR                    111
 268 # define PKCS12_R_MAC_VERIFY_FAILURE                      113
 269 # define PKCS12_R_PARSE_ERROR                             114
 270 # define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
 271 # define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
 272 # define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
 273 # define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
 274 # define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
 275
 276 # ifdef  __cplusplus
 277 }
 278 # endif
 279 #endif