pkcs12.h revision 68651
155714Skris/* pkcs12.h */ 255714Skris/* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL 355714Skris * project 1999. 455714Skris */ 555714Skris/* ==================================================================== 655714Skris * Copyright (c) 1999 The OpenSSL Project. All rights reserved. 755714Skris * 855714Skris * Redistribution and use in source and binary forms, with or without 955714Skris * modification, are permitted provided that the following conditions 1055714Skris * are met: 1155714Skris * 1255714Skris * 1. Redistributions of source code must retain the above copyright 1355714Skris * notice, this list of conditions and the following disclaimer. 1455714Skris * 1555714Skris * 2. Redistributions in binary form must reproduce the above copyright 1655714Skris * notice, this list of conditions and the following disclaimer in 1755714Skris * the documentation and/or other materials provided with the 1855714Skris * distribution. 1955714Skris * 2055714Skris * 3. All advertising materials mentioning features or use of this 2155714Skris * software must display the following acknowledgment: 2255714Skris * "This product includes software developed by the OpenSSL Project 2355714Skris * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)" 2455714Skris * 2555714Skris * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 2655714Skris * endorse or promote products derived from this software without 2755714Skris * prior written permission. For written permission, please contact 2855714Skris * licensing@OpenSSL.org. 2955714Skris * 3055714Skris * 5. Products derived from this software may not be called "OpenSSL" 3155714Skris * nor may "OpenSSL" appear in their names without prior written 3255714Skris * permission of the OpenSSL Project. 3355714Skris * 3455714Skris * 6. Redistributions of any form whatsoever must retain the following 3555714Skris * acknowledgment: 3655714Skris * "This product includes software developed by the OpenSSL Project 3755714Skris * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" 3855714Skris * 3955714Skris * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 4055714Skris * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 4155714Skris * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 4255714Skris * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 4355714Skris * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4455714Skris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 4555714Skris * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 4655714Skris * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 4755714Skris * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 4855714Skris * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 4955714Skris * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 5055714Skris * OF THE POSSIBILITY OF SUCH DAMAGE. 5155714Skris * ==================================================================== 5255714Skris * 5355714Skris * This product includes cryptographic software written by Eric Young 5455714Skris * (eay@cryptsoft.com). This product includes software written by Tim 5555714Skris * Hudson (tjh@cryptsoft.com). 5655714Skris * 5755714Skris */ 5855714Skris 5955714Skris#ifndef HEADER_PKCS12_H 6055714Skris#define HEADER_PKCS12_H 6155714Skris 6268651Skris#include <openssl/bio.h> 6368651Skris#include <openssl/x509.h> 6468651Skris 6555714Skris#ifdef __cplusplus 6655714Skrisextern "C" { 6755714Skris#endif 6855714Skris 6955714Skris#define PKCS12_KEY_ID 1 7055714Skris#define PKCS12_IV_ID 2 7155714Skris#define PKCS12_MAC_ID 3 7255714Skris 7355714Skris/* Default iteration count */ 7455714Skris#ifndef PKCS12_DEFAULT_ITER 7555714Skris#define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER 7655714Skris#endif 7755714Skris 7855714Skris#define PKCS12_MAC_KEY_LENGTH 20 7955714Skris 8055714Skris#define PKCS12_SALT_LEN 8 8155714Skris 8255714Skris/* Uncomment out next line for unicode password and names, otherwise ASCII */ 8355714Skris 8455714Skris/*#define PBE_UNICODE*/ 8555714Skris 8655714Skris#ifdef PBE_UNICODE 8755714Skris#define PKCS12_key_gen PKCS12_key_gen_uni 8855714Skris#define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni 8955714Skris#else 9055714Skris#define PKCS12_key_gen PKCS12_key_gen_asc 9155714Skris#define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc 9255714Skris#endif 9355714Skris 9455714Skris/* MS key usage constants */ 9555714Skris 9655714Skris#define KEY_EX 0x10 9755714Skris#define KEY_SIG 0x80 9855714Skris 9955714Skristypedef struct { 10055714SkrisX509_SIG *dinfo; 10155714SkrisASN1_OCTET_STRING *salt; 10255714SkrisASN1_INTEGER *iter; /* defaults to 1 */ 10355714Skris} PKCS12_MAC_DATA; 10455714Skris 10555714Skristypedef struct { 10655714SkrisASN1_INTEGER *version; 10755714SkrisPKCS12_MAC_DATA *mac; 10855714SkrisPKCS7 *authsafes; 10955714Skris} PKCS12; 11055714Skris 11168651SkrisPREDECLARE_STACK_OF(PKCS12_SAFEBAG) 11268651Skris 11355714Skristypedef struct { 11455714SkrisASN1_OBJECT *type; 11555714Skrisunion { 11655714Skris struct pkcs12_bag_st *bag; /* secret, crl and certbag */ 11755714Skris struct pkcs8_priv_key_info_st *keybag; /* keybag */ 11855714Skris X509_SIG *shkeybag; /* shrouded key bag */ 11968651Skris STACK_OF(PKCS12_SAFEBAG) *safes; 12055714Skris ASN1_TYPE *other; 12155714Skris}value; 12255714SkrisSTACK_OF(X509_ATTRIBUTE) *attrib; 12355714SkrisASN1_TYPE *rest; 12455714Skris} PKCS12_SAFEBAG; 12555714Skris 12668651SkrisDECLARE_STACK_OF(PKCS12_SAFEBAG) 12768651SkrisDECLARE_ASN1_SET_OF(PKCS12_SAFEBAG) 12868651SkrisDECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG) 12968651Skris 13055714Skristypedef struct pkcs12_bag_st { 13155714SkrisASN1_OBJECT *type; 13255714Skrisunion { 13355714Skris ASN1_OCTET_STRING *x509cert; 13455714Skris ASN1_OCTET_STRING *x509crl; 13555714Skris ASN1_OCTET_STRING *octet; 13655714Skris ASN1_IA5STRING *sdsicert; 13755714Skris ASN1_TYPE *other; /* Secret or other bag */ 13855714Skris}value; 13955714Skris} PKCS12_BAGS; 14055714Skris 14155714Skris#define PKCS12_ERROR 0 14255714Skris#define PKCS12_OK 1 14355714Skris 14455714Skris#define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type) 14555714Skris#define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type) 14655714Skris#define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type 14755714Skris 14855714Skris#define M_PKCS12_x5092certbag(x509) \ 14968651SkrisPKCS12_pack_safebag((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag) 15055714Skris 15155714Skris#define M_PKCS12_x509crl2certbag(crl) \ 15268651SkrisPKCS12_pack_safebag((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag) 15355714Skris 15455714Skris#define M_PKCS12_certbag2x509(bg) \ 15568651Skris(X509 *) ASN1_unpack_string((bg)->value.bag->value.octet, \ 15655714Skris(char *(*)())d2i_X509) 15755714Skris 15855714Skris#define M_PKCS12_certbag2x509crl(bg) \ 15968651Skris(X509CRL *) ASN1_unpack_string((bg)->value.bag->value.octet, \ 16055714Skris(char *(*)())d2i_X509CRL) 16155714Skris 16255714Skris/*#define M_PKCS12_pkcs82rsa(p8) \ 16368651Skris(RSA *) ASN1_unpack_string((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/ 16455714Skris 16555714Skris#define M_PKCS12_unpack_p7data(p7) \ 16668651SkrisASN1_seq_unpack_PKCS12_SAFEBAG((p7)->d.data->data, p7->d.data->length, \ 16768651Skris d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free) 16855714Skris 16955714Skris#define M_PKCS12_pack_authsafes(p12, safes) \ 17068651SkrisASN1_seq_pack_PKCS7((safes), i2d_PKCS7,\ 17155714Skris &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length) 17255714Skris 17355714Skris#define M_PKCS12_unpack_authsafes(p12) \ 17468651SkrisASN1_seq_unpack_PKCS7((p12)->authsafes->d.data->data, \ 17568651Skris (p12)->authsafes->d.data->length, d2i_PKCS7, PKCS7_free) 17655714Skris 17755714Skris#define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \ 17868651SkrisPKCS12_decrypt_d2i_PKCS12_SAFEBAG((p7)->d.encrypted->enc_data->algorithm,\ 17968651Skris d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \ 18068651Skris (pass), (passlen), \ 18168651Skris (p7)->d.encrypted->enc_data->enc_data, 3) 18255714Skris 18355714Skris#define M_PKCS12_decrypt_skey(bag, pass, passlen) \ 18468651Skris(PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i((bag)->value.shkeybag->algor, \ 18568651Skris(char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (void (*)(void *))PKCS8_PRIV_KEY_INFO_free, \ 18655714Skris (pass), (passlen), \ 18755714Skris (bag)->value.shkeybag->digest, 2) 18855714Skris 18955714Skris#define M_PKCS8_decrypt(p8, pass, passlen) \ 19068651Skris(PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i((p8)->algor, \ 19168651Skris(char *(*)())d2i_PKCS8_PRIV_KEY_INFO, (void (*)(void *))PKCS8_PRIV_KEY_INFO_free,\ 19255714Skris (pass), (passlen), (p8)->digest, 2) 19355714Skris 19455714Skris#define PKCS12_get_attr(bag, attr_nid) \ 19555714Skris PKCS12_get_attr_gen(bag->attrib, attr_nid) 19655714Skris 19755714Skris#define PKCS8_get_attr(p8, attr_nid) \ 19855714Skris PKCS12_get_attr_gen(p8->attributes, attr_nid) 19955714Skris 20055714Skris#define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0) 20155714Skris 20255714Skris 20355714SkrisPKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2); 20455714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8); 20555714SkrisX509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher, 20655714Skris const char *pass, int passlen, 20755714Skris unsigned char *salt, int saltlen, int iter, 20855714Skris PKCS8_PRIV_KEY_INFO *p8); 20955714SkrisPKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass, 21055714Skris int passlen, unsigned char *salt, 21155714Skris int saltlen, int iter, 21255714Skris PKCS8_PRIV_KEY_INFO *p8); 21368651SkrisPKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk); 21455714SkrisPKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen, 21555714Skris unsigned char *salt, int saltlen, int iter, 21668651Skris STACK_OF(PKCS12_SAFEBAG) *bags); 21755714Skrisint PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen); 21855714Skrisint PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name, 21955714Skris int namelen); 22055714Skrisint PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name, 22155714Skris int namelen); 22255714Skrisint PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage); 22355714SkrisASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid); 22455714Skrischar *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag); 22555714Skrisunsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass, 22655714Skris int passlen, unsigned char *in, int inlen, 22755714Skris unsigned char **data, int *datalen, int en_de); 22855714Skrischar *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(), 22968651Skris void (*free_func)(void *), const char *pass, int passlen, 23055714Skris ASN1_STRING *oct, int seq); 23155714SkrisASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(), 23255714Skris const char *pass, int passlen, char *obj, 23355714Skris int seq); 23455714SkrisPKCS12 *PKCS12_init(int mode); 23555714Skrisint PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt, 23655714Skris int saltlen, int id, int iter, int n, 23755714Skris unsigned char *out, const EVP_MD *md_type); 23855714Skrisint 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); 23955714Skrisint PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen, 24055714Skris ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type, 24155714Skris int en_de); 24255714Skrisint PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen, 24355714Skris unsigned char *mac, unsigned int *maclen); 24455714Skrisint PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen); 24555714Skrisint PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen, 24655714Skris unsigned char *salt, int saltlen, int iter, 24755714Skris EVP_MD *md_type); 24855714Skrisint PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt, 24955714Skris int saltlen, EVP_MD *md_type); 25055714Skrisunsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen); 25155714Skrischar *uni2asc(unsigned char *uni, int unilen); 25255714Skrisint i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp); 25355714SkrisPKCS12_BAGS *PKCS12_BAGS_new(void); 25455714SkrisPKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length); 25555714Skrisvoid PKCS12_BAGS_free(PKCS12_BAGS *a); 25655714Skrisint i2d_PKCS12(PKCS12 *a, unsigned char **pp); 25755714SkrisPKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length); 25855714SkrisPKCS12 *PKCS12_new(void); 25955714Skrisvoid PKCS12_free(PKCS12 *a); 26055714Skrisint i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp); 26155714SkrisPKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void); 26255714SkrisPKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp, 26355714Skris long length); 26455714Skrisvoid PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a); 26555714Skrisint i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp); 26655714SkrisPKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void); 26755714SkrisPKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp, 26855714Skris long length); 26955714Skrisvoid PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a); 27055714Skrisvoid ERR_load_PKCS12_strings(void); 27155714Skrisvoid PKCS12_PBE_add(void); 27255714Skrisint PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert, 27359191Skris STACK_OF(X509) **ca); 27455714SkrisPKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert, 27559191Skris STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter, 27655714Skris int mac_iter, int keytype); 27755714Skrisint i2d_PKCS12_bio(BIO *bp, PKCS12 *p12); 27855714Skrisint i2d_PKCS12_fp(FILE *fp, PKCS12 *p12); 27955714SkrisPKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12); 28055714SkrisPKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12); 28159191Skrisint PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass); 28255714Skris 28355714Skris/* BEGIN ERROR CODES */ 28455714Skris/* The following lines are auto generated by the script mkerr.pl. Any changes 28555714Skris * made after this point may be overwritten when the script is next run. 28655714Skris */ 28755714Skris 28855714Skris/* Error codes for the PKCS12 functions. */ 28955714Skris 29055714Skris/* Function codes. */ 29155714Skris#define PKCS12_F_PARSE_BAGS 103 29255714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100 29355714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127 29455714Skris#define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102 29555714Skris#define PKCS12_F_PKCS12_ADD_LOCALKEYID 104 29655714Skris#define PKCS12_F_PKCS12_CREATE 105 29755714Skris#define PKCS12_F_PKCS12_DECRYPT_D2I 106 29855714Skris#define PKCS12_F_PKCS12_GEN_MAC 107 29955714Skris#define PKCS12_F_PKCS12_I2D_ENCRYPT 108 30055714Skris#define PKCS12_F_PKCS12_INIT 109 30155714Skris#define PKCS12_F_PKCS12_KEY_GEN_ASC 110 30255714Skris#define PKCS12_F_PKCS12_KEY_GEN_UNI 111 30355714Skris#define PKCS12_F_PKCS12_MAKE_KEYBAG 112 30455714Skris#define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113 30559191Skris#define PKCS12_F_PKCS12_NEWPASS 128 30655714Skris#define PKCS12_F_PKCS12_PACK_P7DATA 114 30755714Skris#define PKCS12_F_PKCS12_PACK_P7ENCDATA 115 30855714Skris#define PKCS12_F_PKCS12_PACK_SAFEBAG 117 30955714Skris#define PKCS12_F_PKCS12_PARSE 118 31055714Skris#define PKCS12_F_PKCS12_PBE_CRYPT 119 31155714Skris#define PKCS12_F_PKCS12_PBE_KEYIVGEN 120 31255714Skris#define PKCS12_F_PKCS12_SETUP_MAC 122 31355714Skris#define PKCS12_F_PKCS12_SET_MAC 123 31455714Skris#define PKCS12_F_PKCS8_ADD_KEYUSAGE 124 31555714Skris#define PKCS12_F_PKCS8_ENCRYPT 125 31655714Skris#define PKCS12_F_VERIFY_MAC 126 31755714Skris 31855714Skris/* Reason codes. */ 31955714Skris#define PKCS12_R_CANT_PACK_STRUCTURE 100 32055714Skris#define PKCS12_R_DECODE_ERROR 101 32155714Skris#define PKCS12_R_ENCODE_ERROR 102 32255714Skris#define PKCS12_R_ENCRYPT_ERROR 103 32359191Skris#define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120 32455714Skris#define PKCS12_R_INVALID_NULL_ARGUMENT 104 32555714Skris#define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105 32655714Skris#define PKCS12_R_IV_GEN_ERROR 106 32755714Skris#define PKCS12_R_KEY_GEN_ERROR 107 32855714Skris#define PKCS12_R_MAC_ABSENT 108 32955714Skris#define PKCS12_R_MAC_GENERATION_ERROR 109 33055714Skris#define PKCS12_R_MAC_SETUP_ERROR 110 33155714Skris#define PKCS12_R_MAC_STRING_SET_ERROR 111 33255714Skris#define PKCS12_R_MAC_VERIFY_ERROR 112 33355714Skris#define PKCS12_R_MAC_VERIFY_FAILURE 113 33455714Skris#define PKCS12_R_PARSE_ERROR 114 33555714Skris#define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115 33655714Skris#define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116 33755714Skris#define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117 33855714Skris#define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118 33955714Skris#define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119 34055714Skris 34155714Skris#ifdef __cplusplus 34255714Skris} 34355714Skris#endif 34455714Skris#endif 34555714Skris 346