include/openssl/pkcs12.h

   1 /*
   2  * Copyright 1999-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 OPENSSL_PKCS12_H
  11 # define OPENSSL_PKCS12_H
  12 # pragma once
  13
  14 # include <openssl/macros.h>
  15 # ifndef OPENSSL_NO_DEPRECATED_3_0
  16 #  define HEADER_PKCS12_H
  17 # endif
  18
  19 # include <openssl/bio.h>
  20 # include <openssl/x509.h>
  21 # include <openssl/pkcs12err.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 # define PKCS12_KEY_ID   1
  28 # define PKCS12_IV_ID    2
  29 # define PKCS12_MAC_ID   3
  30
  31 /* Default iteration count */
  32 # ifndef PKCS12_DEFAULT_ITER
  33 #  define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER
  34 # endif
  35
  36 # define PKCS12_MAC_KEY_LENGTH 20
  37
  38 # define PKCS12_SALT_LEN 8
  39
  40 /* It's not clear if these are actually needed... */
  41 # define PKCS12_key_gen PKCS12_key_gen_utf8
  42 # define PKCS12_add_friendlyname PKCS12_add_friendlyname_utf8
  43
  44 /* MS key usage constants */
  45
  46 # define KEY_EX  0x10
  47 # define KEY_SIG 0x80
  48
  49 typedef struct PKCS12_MAC_DATA_st PKCS12_MAC_DATA;
  50
  51 typedef struct PKCS12_st PKCS12;
  52
  53 typedef struct PKCS12_SAFEBAG_st PKCS12_SAFEBAG;
  54
  55 DEFINE_OR_DECLARE_STACK_OF(PKCS12_SAFEBAG)
  56
  57 typedef struct pkcs12_bag_st PKCS12_BAGS;
  58
  59 # define PKCS12_ERROR    0
  60 # define PKCS12_OK       1
  61
  62 /* Compatibility macros */
  63
  64 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
  65
  66 # define M_PKCS12_bag_type PKCS12_bag_type
  67 # define M_PKCS12_cert_bag_type PKCS12_cert_bag_type
  68 # define M_PKCS12_crl_bag_type PKCS12_cert_bag_type
  69
  70 # define PKCS12_certbag2x509 PKCS12_SAFEBAG_get1_cert
  71 # define PKCS12_certbag2scrl PKCS12_SAFEBAG_get1_crl
  72 # define PKCS12_bag_type PKCS12_SAFEBAG_get_nid
  73 # define PKCS12_cert_bag_type PKCS12_SAFEBAG_get_bag_nid
  74 # define PKCS12_x5092certbag PKCS12_SAFEBAG_create_cert
  75 # define PKCS12_x509crl2certbag PKCS12_SAFEBAG_create_crl
  76 # define PKCS12_MAKE_KEYBAG PKCS12_SAFEBAG_create0_p8inf
  77 # define PKCS12_MAKE_SHKEYBAG PKCS12_SAFEBAG_create_pkcs8_encrypt
  78
  79 #endif
  80
  81 DEPRECATEDIN_1_1_0(ASN1_TYPE *PKCS12_get_attr(const PKCS12_SAFEBAG *bag, int attr_nid))
  82
  83 ASN1_TYPE *PKCS8_get_attr(PKCS8_PRIV_KEY_INFO *p8, int attr_nid);
  84 int PKCS12_mac_present(const PKCS12 *p12);
  85 void PKCS12_get0_mac(const ASN1_OCTET_STRING **pmac,
  86                      const X509_ALGOR **pmacalg,
  87                      const ASN1_OCTET_STRING **psalt,
  88                      const ASN1_INTEGER **piter,
  89                      const PKCS12 *p12);
  90
  91 const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
  92                                           int attr_nid);
  93 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag);
  94 int PKCS12_SAFEBAG_get_nid(const PKCS12_SAFEBAG *bag);
  95 int PKCS12_SAFEBAG_get_bag_nid(const PKCS12_SAFEBAG *bag);
  96 const ASN1_TYPE *PKCS12_SAFEBAG_get0_bag_obj(const PKCS12_SAFEBAG *bag);
  97 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_bag_type(const PKCS12_SAFEBAG *bag);
  98
  99 X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
 100 X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
 101 const STACK_OF(PKCS12_SAFEBAG) *
 102 PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
 103 const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
 104 const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);
 105
 106 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_cert(X509 *x509);
 107 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_crl(X509_CRL *crl);
 108 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_secret(int type, int vtype, const unsigned char *value, int len);
 109 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_p8inf(PKCS8_PRIV_KEY_INFO *p8);
 110 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_pkcs8(X509_SIG *p8);
 111 PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_pkcs8_encrypt(int pbe_nid,
 112                                                     const char *pass,
 113                                                     int passlen,
 114                                                     unsigned char *salt,
 115                                                     int saltlen, int iter,
 116                                                     PKCS8_PRIV_KEY_INFO *p8inf);
 117
 118 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
 119                                          int nid1, int nid2);
 120 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
 121                                    int passlen);
 122 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
 123                                          const char *pass, int passlen);
 124 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
 125                         const char *pass, int passlen, unsigned char *salt,
 126                         int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
 127 X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
 128                         PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
 129 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
 130 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
 131 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
 132                              unsigned char *salt, int saltlen, int iter,
 133                              STACK_OF(PKCS12_SAFEBAG) *bags);
 134 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
 135                                                   int passlen);
 136
 137 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
 138 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12);
 139
 140 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
 141                           int namelen);
 142 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
 143                                 int namelen);
 144 int PKCS12_add_friendlyname_utf8(PKCS12_SAFEBAG *bag, const char *name,
 145                                  int namelen);
 146 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
 147                            int namelen);
 148 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
 149                                 const unsigned char *name, int namelen);
 150 int PKCS12_add1_attr_by_NID(PKCS12_SAFEBAG *bag, int nid, int type,
 151                             const unsigned char *bytes, int len);
 152 int PKCS12_add1_attr_by_txt(PKCS12_SAFEBAG *bag, const char *attrname, int type,
 153                             const unsigned char *bytes, int len);
 154 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
 155 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
 156                                int attr_nid);
 157 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
 158 const STACK_OF(X509_ATTRIBUTE) *
 159 PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
 160 unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
 161                                 const char *pass, int passlen,
 162                                 const unsigned char *in, int inlen,
 163                                 unsigned char **data, int *datalen,
 164                                 int en_de);
 165 void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it,
 166                               const char *pass, int passlen,
 167                               const ASN1_OCTET_STRING *oct, int zbuf);
 168 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
 169                                            const ASN1_ITEM *it,
 170                                            const char *pass, int passlen,
 171                                            void *obj, int zbuf);
 172 PKCS12 *PKCS12_init(int mode);
 173 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
 174                        int saltlen, int id, int iter, int n,
 175                        unsigned char *out, const EVP_MD *md_type);
 176 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
 177                        int saltlen, int id, int iter, int n,
 178                        unsigned char *out, const EVP_MD *md_type);
 179 int PKCS12_key_gen_utf8(const char *pass, int passlen, unsigned char *salt,
 180                         int saltlen, int id, int iter, int n,
 181                         unsigned char *out, const EVP_MD *md_type);
 182 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
 183                         ASN1_TYPE *param, const EVP_CIPHER *cipher,
 184                         const EVP_MD *md_type, int en_de);
 185 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
 186                    unsigned char *mac, unsigned int *maclen);
 187 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
 188 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
 189                    unsigned char *salt, int saltlen, int iter,
 190                    const EVP_MD *md_type);
 191 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
 192                      int saltlen, const EVP_MD *md_type);
 193 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
 194                                unsigned char **uni, int *unilen);
 195 char *OPENSSL_uni2asc(const unsigned char *uni, int unilen);
 196 unsigned char *OPENSSL_utf82uni(const char *asc, int asclen,
 197                                 unsigned char **uni, int *unilen);
 198 char *OPENSSL_uni2utf8(const unsigned char *uni, int unilen);
 199
 200 DECLARE_ASN1_FUNCTIONS(PKCS12)
 201 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
 202 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
 203 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
 204
 205 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
 206 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
 207
 208 void PKCS12_PBE_add(void);
 209 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
 210                  STACK_OF(X509) **ca);
 211 PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
 212                       X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
 213                       int iter, int mac_iter, int keytype);
 214
 215 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
 216 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
 217                                EVP_PKEY *key, int key_usage, int iter,
 218                                int key_nid, const char *pass);
 219 PKCS12_SAFEBAG *PKCS12_add_secret(STACK_OF(PKCS12_SAFEBAG) **pbags,
 220                                   int nid_type, const unsigned char *value, int len);
 221 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
 222                     int safe_nid, int iter, const char *pass);
 223 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
 224
 225 int i2d_PKCS12_bio(BIO *bp, const PKCS12 *p12);
 226 # ifndef OPENSSL_NO_STDIO
 227 int i2d_PKCS12_fp(FILE *fp, const PKCS12 *p12);
 228 # endif
 229 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
 230 # ifndef OPENSSL_NO_STDIO
 231 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
 232 # endif
 233 int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
 234
 235 # ifdef  __cplusplus
 236 }
 237 # endif
 238 #endif