LTKCPP-- LLRP Toolkit C Plus Plus Library
pkcs12.h
00001 /* pkcs12.h */
00002 /*
00003  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
00004  * 1999.
00005  */
00006 /* ====================================================================
00007  * Copyright (c) 1999 The OpenSSL Project.  All rights reserved.
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions
00011  * are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  *
00016  * 2. Redistributions in binary form must reproduce the above copyright
00017  *    notice, this list of conditions and the following disclaimer in
00018  *    the documentation and/or other materials provided with the
00019  *    distribution.
00020  *
00021  * 3. All advertising materials mentioning features or use of this
00022  *    software must display the following acknowledgment:
00023  *    "This product includes software developed by the OpenSSL Project
00024  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
00025  *
00026  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
00027  *    endorse or promote products derived from this software without
00028  *    prior written permission. For written permission, please contact
00029  *    licensing@OpenSSL.org.
00030  *
00031  * 5. Products derived from this software may not be called "OpenSSL"
00032  *    nor may "OpenSSL" appear in their names without prior written
00033  *    permission of the OpenSSL Project.
00034  *
00035  * 6. Redistributions of any form whatsoever must retain the following
00036  *    acknowledgment:
00037  *    "This product includes software developed by the OpenSSL Project
00038  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
00039  *
00040  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
00041  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00042  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00043  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
00044  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00045  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00046  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00047  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
00049  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00050  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
00051  * OF THE POSSIBILITY OF SUCH DAMAGE.
00052  * ====================================================================
00053  *
00054  * This product includes cryptographic software written by Eric Young
00055  * (eay@cryptsoft.com).  This product includes software written by Tim
00056  * Hudson (tjh@cryptsoft.com).
00057  *
00058  */
00059 
00060 #ifndef HEADER_PKCS12_H
00061 # define HEADER_PKCS12_H
00062 
00063 # include <openssl/bio.h>
00064 # include <openssl/x509.h>
00065 
00066 #ifdef __cplusplus
00067 extern "C" {
00068 #endif
00069 
00070 # define PKCS12_KEY_ID   1
00071 # define PKCS12_IV_ID    2
00072 # define PKCS12_MAC_ID   3
00073 
00074 /* Default iteration count */
00075 # ifndef PKCS12_DEFAULT_ITER
00076 #  define PKCS12_DEFAULT_ITER     PKCS5_DEFAULT_ITER
00077 # endif
00078 
00079 # define PKCS12_MAC_KEY_LENGTH 20
00080 
00081 # define PKCS12_SALT_LEN 8
00082 
00083 /* Uncomment out next line for unicode password and names, otherwise ASCII */
00084 
00085 /*
00086  * #define PBE_UNICODE
00087  */
00088 
00089 # ifdef PBE_UNICODE
00090 #  define PKCS12_key_gen PKCS12_key_gen_uni
00091 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
00092 # else
00093 #  define PKCS12_key_gen PKCS12_key_gen_asc
00094 #  define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
00095 # endif
00096 
00097 /* MS key usage constants */
00098 
00099 # define KEY_EX  0x10
00100 # define KEY_SIG 0x80
00101 
00102 typedef struct {
00103     X509_SIG *dinfo;
00104     ASN1_OCTET_STRING *salt;
00105     ASN1_INTEGER *iter;         /* defaults to 1 */
00106 } PKCS12_MAC_DATA;
00107 
00108 typedef struct {
00109     ASN1_INTEGER *version;
00110     PKCS12_MAC_DATA *mac;
00111     PKCS7 *authsafes;
00112 } PKCS12;
00113 
00114 typedef struct {
00115     ASN1_OBJECT *type;
00116     union {
00117         struct pkcs12_bag_st *bag; /* secret, crl and certbag */
00118         struct pkcs8_priv_key_info_st *keybag; /* keybag */
00119         X509_SIG *shkeybag;     /* shrouded key bag */
00120         STACK_OF(PKCS12_SAFEBAG) *safes;
00121         ASN1_TYPE *other;
00122     } value;
00123     STACK_OF(X509_ATTRIBUTE) *attrib;
00124 } PKCS12_SAFEBAG;
00125 
00126 DECLARE_STACK_OF(PKCS12_SAFEBAG)
00127 DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
00128 DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
00129 
00130 typedef struct pkcs12_bag_st {
00131     ASN1_OBJECT *type;
00132     union {
00133         ASN1_OCTET_STRING *x509cert;
00134         ASN1_OCTET_STRING *x509crl;
00135         ASN1_OCTET_STRING *octet;
00136         ASN1_IA5STRING *sdsicert;
00137         ASN1_TYPE *other;       /* Secret or other bag */
00138     } value;
00139 } PKCS12_BAGS;
00140 
00141 # define PKCS12_ERROR    0
00142 # define PKCS12_OK       1
00143 
00144 /* Compatibility macros */
00145 
00146 # define M_PKCS12_x5092certbag PKCS12_x5092certbag
00147 # define M_PKCS12_x509crl2certbag PKCS12_x509crl2certbag
00148 
00149 # define M_PKCS12_certbag2x509 PKCS12_certbag2x509
00150 # define M_PKCS12_certbag2x509crl PKCS12_certbag2x509crl
00151 
00152 # define M_PKCS12_unpack_p7data PKCS12_unpack_p7data
00153 # define M_PKCS12_pack_authsafes PKCS12_pack_authsafes
00154 # define M_PKCS12_unpack_authsafes PKCS12_unpack_authsafes
00155 # define M_PKCS12_unpack_p7encdata PKCS12_unpack_p7encdata
00156 
00157 # define M_PKCS12_decrypt_skey PKCS12_decrypt_skey
00158 # define M_PKCS8_decrypt PKCS8_decrypt
00159 
00160 # define M_PKCS12_bag_type(bg) OBJ_obj2nid((bg)->type)
00161 # define M_PKCS12_cert_bag_type(bg) OBJ_obj2nid((bg)->value.bag->type)
00162 # define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
00163 
00164 # define PKCS12_get_attr(bag, attr_nid) \
00165                          PKCS12_get_attr_gen(bag->attrib, attr_nid)
00166 
00167 # define PKCS8_get_attr(p8, attr_nid) \
00168                 PKCS12_get_attr_gen(p8->attributes, attr_nid)
00169 
00170 # define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
00171 
00172 PKCS12_SAFEBAG *PKCS12_x5092certbag(X509 *x509);
00173 PKCS12_SAFEBAG *PKCS12_x509crl2certbag(X509_CRL *crl);
00174 X509 *PKCS12_certbag2x509(PKCS12_SAFEBAG *bag);
00175 X509_CRL *PKCS12_certbag2x509crl(PKCS12_SAFEBAG *bag);
00176 
00177 PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
00178                                          int nid1, int nid2);
00179 PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
00180 PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(X509_SIG *p8, const char *pass,
00181                                    int passlen);
00182 PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(PKCS12_SAFEBAG *bag,
00183                                          const char *pass, int passlen);
00184 X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
00185                         const char *pass, int passlen, unsigned char *salt,
00186                         int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
00187 PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
00188                                      int passlen, unsigned char *salt,
00189                                      int saltlen, int iter,
00190                                      PKCS8_PRIV_KEY_INFO *p8);
00191 PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
00192 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
00193 PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
00194                              unsigned char *salt, int saltlen, int iter,
00195                              STACK_OF(PKCS12_SAFEBAG) *bags);
00196 STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
00197                                                   int passlen);
00198 
00199 int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
00200 STACK_OF(PKCS7) *PKCS12_unpack_authsafes(PKCS12 *p12);
00201 
00202 int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
00203                           int namelen);
00204 int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
00205                                 int namelen);
00206 int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
00207                            int namelen);
00208 int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
00209                                 const unsigned char *name, int namelen);
00210 int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
00211 ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
00212 char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
00213 unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
00214                                 int passlen, unsigned char *in, int inlen,
00215                                 unsigned char **data, int *datalen,
00216                                 int en_de);
00217 void *PKCS12_item_decrypt_d2i(X509_ALGOR *algor, const ASN1_ITEM *it,
00218                               const char *pass, int passlen,
00219                               ASN1_OCTET_STRING *oct, int zbuf);
00220 ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
00221                                            const ASN1_ITEM *it,
00222                                            const char *pass, int passlen,
00223                                            void *obj, int zbuf);
00224 PKCS12 *PKCS12_init(int mode);
00225 int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
00226                        int saltlen, int id, int iter, int n,
00227                        unsigned char *out, const EVP_MD *md_type);
00228 int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
00229                        int saltlen, int id, int iter, int n,
00230                        unsigned char *out, const EVP_MD *md_type);
00231 int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
00232                         ASN1_TYPE *param, const EVP_CIPHER *cipher,
00233                         const EVP_MD *md_type, int en_de);
00234 int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
00235                    unsigned char *mac, unsigned int *maclen);
00236 int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
00237 int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
00238                    unsigned char *salt, int saltlen, int iter,
00239                    const EVP_MD *md_type);
00240 int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
00241                      int saltlen, const EVP_MD *md_type);
00242 unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
00243                                unsigned char **uni, int *unilen);
00244 char *OPENSSL_uni2asc(unsigned char *uni, int unilen);
00245 
00246 DECLARE_ASN1_FUNCTIONS(PKCS12)
00247 DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
00248 DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
00249 DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
00250 
00251 DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
00252 DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
00253 
00254 void PKCS12_PBE_add(void);
00255 int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
00256                  STACK_OF(X509) **ca);
00257 PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
00258                       STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
00259                       int mac_iter, int keytype);
00260 
00261 PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
00262 PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
00263                                EVP_PKEY *key, int key_usage, int iter,
00264                                int key_nid, char *pass);
00265 int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
00266                     int safe_nid, int iter, char *pass);
00267 PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
00268 
00269 int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
00270 int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
00271 PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
00272 PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
00273 int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
00274 
00275 /* BEGIN ERROR CODES */
00276 /*
00277  * The following lines are auto generated by the script mkerr.pl. Any changes
00278  * made after this point may be overwritten when the script is next run.
00279  */
00280 void ERR_load_PKCS12_strings(void);
00281 
00282 /* Error codes for the PKCS12 functions. */
00283 
00284 /* Function codes. */
00285 # define PKCS12_F_PARSE_BAG                               129
00286 # define PKCS12_F_PARSE_BAGS                              103
00287 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME                 100
00288 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC             127
00289 # define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI             102
00290 # define PKCS12_F_PKCS12_ADD_LOCALKEYID                   104
00291 # define PKCS12_F_PKCS12_CREATE                           105
00292 # define PKCS12_F_PKCS12_GEN_MAC                          107
00293 # define PKCS12_F_PKCS12_INIT                             109
00294 # define PKCS12_F_PKCS12_ITEM_DECRYPT_D2I                 106
00295 # define PKCS12_F_PKCS12_ITEM_I2D_ENCRYPT                 108
00296 # define PKCS12_F_PKCS12_ITEM_PACK_SAFEBAG                117
00297 # define PKCS12_F_PKCS12_KEY_GEN_ASC                      110
00298 # define PKCS12_F_PKCS12_KEY_GEN_UNI                      111
00299 # define PKCS12_F_PKCS12_MAKE_KEYBAG                      112
00300 # define PKCS12_F_PKCS12_MAKE_SHKEYBAG                    113
00301 # define PKCS12_F_PKCS12_NEWPASS                          128
00302 # define PKCS12_F_PKCS12_PACK_P7DATA                      114
00303 # define PKCS12_F_PKCS12_PACK_P7ENCDATA                   115
00304 # define PKCS12_F_PKCS12_PARSE                            118
00305 # define PKCS12_F_PKCS12_PBE_CRYPT                        119
00306 # define PKCS12_F_PKCS12_PBE_KEYIVGEN                     120
00307 # define PKCS12_F_PKCS12_SETUP_MAC                        122
00308 # define PKCS12_F_PKCS12_SET_MAC                          123
00309 # define PKCS12_F_PKCS12_UNPACK_AUTHSAFES                 130
00310 # define PKCS12_F_PKCS12_UNPACK_P7DATA                    131
00311 # define PKCS12_F_PKCS12_VERIFY_MAC                       126
00312 # define PKCS12_F_PKCS8_ADD_KEYUSAGE                      124
00313 # define PKCS12_F_PKCS8_ENCRYPT                           125
00314 
00315 /* Reason codes. */
00316 # define PKCS12_R_CANT_PACK_STRUCTURE                     100
00317 # define PKCS12_R_CONTENT_TYPE_NOT_DATA                   121
00318 # define PKCS12_R_DECODE_ERROR                            101
00319 # define PKCS12_R_ENCODE_ERROR                            102
00320 # define PKCS12_R_ENCRYPT_ERROR                           103
00321 # define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE       120
00322 # define PKCS12_R_INVALID_NULL_ARGUMENT                   104
00323 # define PKCS12_R_INVALID_NULL_PKCS12_POINTER             105
00324 # define PKCS12_R_IV_GEN_ERROR                            106
00325 # define PKCS12_R_KEY_GEN_ERROR                           107
00326 # define PKCS12_R_MAC_ABSENT                              108
00327 # define PKCS12_R_MAC_GENERATION_ERROR                    109
00328 # define PKCS12_R_MAC_SETUP_ERROR                         110
00329 # define PKCS12_R_MAC_STRING_SET_ERROR                    111
00330 # define PKCS12_R_MAC_VERIFY_ERROR                        112
00331 # define PKCS12_R_MAC_VERIFY_FAILURE                      113
00332 # define PKCS12_R_PARSE_ERROR                             114
00333 # define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR           115
00334 # define PKCS12_R_PKCS12_CIPHERFINAL_ERROR                116
00335 # define PKCS12_R_PKCS12_PBE_CRYPT_ERROR                  117
00336 # define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM                118
00337 # define PKCS12_R_UNSUPPORTED_PKCS12_MODE                 119
00338 
00339 #ifdef  __cplusplus
00340 }
00341 #endif
00342 #endif