A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

367 lines
14 KiB

  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. #ifndef HEADER_PKCS12_H
  59. #define HEADER_PKCS12_H
  60. #include <openssl/bio.h>
  61. #include <openssl/x509.h>
  62. #ifdef __cplusplus
  63. extern "C" {
  64. #endif
  65. #define DECLARE_PKCS12_STACK_OF(type) \
  66. STACK_OF(type) *PKCS12_decrypt_d2i_##type(struct X509_algor_st *algor, \
  67. type *(*d2i)(type **, \
  68. unsigned char **, \
  69. long), \
  70. void (*free_func)(type *), \
  71. const char *pass, int passlen, \
  72. ASN1_STRING *oct, int seq);
  73. #define IMPLEMENT_PKCS12_STACK_OF(type) \
  74. STACK_OF(type) *PKCS12_decrypt_d2i_##type(struct X509_algor_st *algor, \
  75. type *(*d2i)(type **, \
  76. unsigned char **, \
  77. long), \
  78. void (*free_func)(type *), \
  79. const char *pass, int passlen, \
  80. ASN1_STRING *oct, int seq) \
  81. { return (STACK_OF(type) *)PKCS12_decrypt_d2i(algor,(char *(*)())d2i, \
  82. (void(*)(void *))free_func, \
  83. pass,passlen,oct,seq); }
  84. #define PKCS12_KEY_ID 1
  85. #define PKCS12_IV_ID 2
  86. #define PKCS12_MAC_ID 3
  87. /* Default iteration count */
  88. #ifndef PKCS12_DEFAULT_ITER
  89. #define PKCS12_DEFAULT_ITER PKCS5_DEFAULT_ITER
  90. #endif
  91. #define PKCS12_MAC_KEY_LENGTH 20
  92. #define PKCS12_SALT_LEN 8
  93. /* Uncomment out next line for unicode password and names, otherwise ASCII */
  94. /*#define PBE_UNICODE*/
  95. #ifdef PBE_UNICODE
  96. #define PKCS12_key_gen PKCS12_key_gen_uni
  97. #define PKCS12_add_friendlyname PKCS12_add_friendlyname_uni
  98. #else
  99. #define PKCS12_key_gen PKCS12_key_gen_asc
  100. #define PKCS12_add_friendlyname PKCS12_add_friendlyname_asc
  101. #endif
  102. /* MS key usage constants */
  103. #define KEY_EX 0x10
  104. #define KEY_SIG 0x80
  105. typedef struct {
  106. X509_SIG *dinfo;
  107. ASN1_OCTET_STRING *salt;
  108. ASN1_INTEGER *iter; /* defaults to 1 */
  109. } PKCS12_MAC_DATA;
  110. typedef struct {
  111. ASN1_INTEGER *version;
  112. PKCS12_MAC_DATA *mac;
  113. PKCS7 *authsafes;
  114. } PKCS12;
  115. PREDECLARE_STACK_OF(PKCS12_SAFEBAG)
  116. typedef struct {
  117. ASN1_OBJECT *type;
  118. union {
  119. struct pkcs12_bag_st *bag; /* secret, crl and certbag */
  120. struct pkcs8_priv_key_info_st *keybag; /* keybag */
  121. X509_SIG *shkeybag; /* shrouded key bag */
  122. STACK_OF(PKCS12_SAFEBAG) *safes;
  123. ASN1_TYPE *other;
  124. }value;
  125. STACK_OF(X509_ATTRIBUTE) *attrib;
  126. ASN1_TYPE *rest;
  127. } PKCS12_SAFEBAG;
  128. DECLARE_STACK_OF(PKCS12_SAFEBAG)
  129. DECLARE_ASN1_SET_OF(PKCS12_SAFEBAG)
  130. DECLARE_PKCS12_STACK_OF(PKCS12_SAFEBAG)
  131. typedef struct pkcs12_bag_st {
  132. ASN1_OBJECT *type;
  133. union {
  134. ASN1_OCTET_STRING *x509cert;
  135. ASN1_OCTET_STRING *x509crl;
  136. ASN1_OCTET_STRING *octet;
  137. ASN1_IA5STRING *sdsicert;
  138. ASN1_TYPE *other; /* Secret or other bag */
  139. }value;
  140. } PKCS12_BAGS;
  141. #define PKCS12_ERROR 0
  142. #define PKCS12_OK 1
  143. #define M_PKCS12_bag_type(bag) OBJ_obj2nid(bag->type)
  144. #define M_PKCS12_cert_bag_type(bag) OBJ_obj2nid(bag->value.bag->type)
  145. #define M_PKCS12_crl_bag_type M_PKCS12_cert_bag_type
  146. #define M_PKCS12_x5092certbag(x509) \
  147. PKCS12_pack_safebag ((char *)(x509), i2d_X509, NID_x509Certificate, NID_certBag)
  148. #define M_PKCS12_x509crl2certbag(crl) \
  149. PKCS12_pack_safebag ((char *)(crl), i2d_X509CRL, NID_x509Crl, NID_crlBag)
  150. #define M_PKCS12_certbag2x509(bg) \
  151. (X509 *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
  152. (char *(*)())d2i_X509)
  153. #define M_PKCS12_certbag2x509crl(bg) \
  154. (X509CRL *) ASN1_unpack_string ((bg)->value.bag->value.octet, \
  155. (char *(*)())d2i_X509CRL)
  156. /*#define M_PKCS12_pkcs82rsa(p8) \
  157. (RSA *) ASN1_unpack_string ((p8)->pkey, (char *(*)())d2i_RSAPrivateKey)*/
  158. #define M_PKCS12_unpack_p7data(p7) \
  159. ASN1_seq_unpack_PKCS12_SAFEBAG ((p7)->d.data->data, p7->d.data->length, \
  160. d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free)
  161. #define M_PKCS12_pack_authsafes(p12, safes) \
  162. ASN1_seq_pack((safes), (int (*)())i2d_PKCS7,\
  163. &(p12)->authsafes->d.data->data, &(p12)->authsafes->d.data->length)
  164. #define M_PKCS12_unpack_authsafes(p12) \
  165. ASN1_seq_unpack((p12)->authsafes->d.data->data, \
  166. (p12)->authsafes->d.data->length, (char *(*)())d2i_PKCS7, \
  167. PKCS7_free)
  168. #define M_PKCS12_unpack_p7encdata(p7, pass, passlen) \
  169. PKCS12_decrypt_d2i_PKCS12_SAFEBAG ((p7)->d.encrypted->enc_data->algorithm,\
  170. d2i_PKCS12_SAFEBAG, PKCS12_SAFEBAG_free, \
  171. (pass), (passlen), \
  172. (p7)->d.encrypted->enc_data->enc_data, 3)
  173. #define M_PKCS12_decrypt_skey(bag, pass, passlen) \
  174. (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((bag)->value.shkeybag->algor, \
  175. (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free, \
  176. (pass), (passlen), \
  177. (bag)->value.shkeybag->digest, 2)
  178. #define M_PKCS8_decrypt(p8, pass, passlen) \
  179. (PKCS8_PRIV_KEY_INFO *) PKCS12_decrypt_d2i ((p8)->algor, \
  180. (char *(*)())d2i_PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO_free,\
  181. (pass), (passlen), (p8)->digest, 2)
  182. #define PKCS12_get_attr(bag, attr_nid) \
  183. PKCS12_get_attr_gen(bag->attrib, attr_nid)
  184. #define PKCS8_get_attr(p8, attr_nid) \
  185. PKCS12_get_attr_gen(p8->attributes, attr_nid)
  186. #define PKCS12_mac_present(p12) ((p12)->mac ? 1 : 0)
  187. PKCS12_SAFEBAG *PKCS12_pack_safebag(char *obj, int (*i2d)(), int nid1, int nid2);
  188. PKCS12_SAFEBAG *PKCS12_MAKE_KEYBAG(PKCS8_PRIV_KEY_INFO *p8);
  189. X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
  190. const char *pass, int passlen,
  191. unsigned char *salt, int saltlen, int iter,
  192. PKCS8_PRIV_KEY_INFO *p8);
  193. PKCS12_SAFEBAG *PKCS12_MAKE_SHKEYBAG(int pbe_nid, const char *pass,
  194. int passlen, unsigned char *salt,
  195. int saltlen, int iter,
  196. PKCS8_PRIV_KEY_INFO *p8);
  197. PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
  198. PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
  199. unsigned char *salt, int saltlen, int iter,
  200. STACK_OF(PKCS12_SAFEBAG) *bags);
  201. int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name, int namelen);
  202. int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
  203. int namelen);
  204. int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag, const unsigned char *name,
  205. int namelen);
  206. int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
  207. ASN1_TYPE *PKCS12_get_attr_gen(STACK_OF(X509_ATTRIBUTE) *attrs, int attr_nid);
  208. char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
  209. unsigned char *PKCS12_pbe_crypt(X509_ALGOR *algor, const char *pass,
  210. int passlen, unsigned char *in, int inlen,
  211. unsigned char **data, int *datalen, int en_de);
  212. char *PKCS12_decrypt_d2i(X509_ALGOR *algor, char *(*d2i)(),
  213. void (*free_func)(), const char *pass, int passlen,
  214. ASN1_STRING *oct, int seq);
  215. ASN1_STRING *PKCS12_i2d_encrypt(X509_ALGOR *algor, int (*i2d)(),
  216. const char *pass, int passlen, char *obj,
  217. int seq);
  218. PKCS12 *PKCS12_init(int mode);
  219. int PKCS12_key_gen_asc(const char *pass, int passlen, unsigned char *salt,
  220. int saltlen, int id, int iter, int n,
  221. unsigned char *out, const EVP_MD *md_type);
  222. 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);
  223. int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
  224. ASN1_TYPE *param, EVP_CIPHER *cipher, EVP_MD *md_type,
  225. int en_de);
  226. int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
  227. unsigned char *mac, unsigned int *maclen);
  228. int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
  229. int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
  230. unsigned char *salt, int saltlen, int iter,
  231. EVP_MD *md_type);
  232. int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
  233. int saltlen, EVP_MD *md_type);
  234. unsigned char *asc2uni(const char *asc, unsigned char **uni, int *unilen);
  235. char *uni2asc(unsigned char *uni, int unilen);
  236. int i2d_PKCS12_BAGS(PKCS12_BAGS *a, unsigned char **pp);
  237. PKCS12_BAGS *PKCS12_BAGS_new(void);
  238. PKCS12_BAGS *d2i_PKCS12_BAGS(PKCS12_BAGS **a, unsigned char **pp, long length);
  239. void PKCS12_BAGS_free(PKCS12_BAGS *a);
  240. int i2d_PKCS12(PKCS12 *a, unsigned char **pp);
  241. PKCS12 *d2i_PKCS12(PKCS12 **a, unsigned char **pp, long length);
  242. PKCS12 *PKCS12_new(void);
  243. void PKCS12_free(PKCS12 *a);
  244. int i2d_PKCS12_MAC_DATA(PKCS12_MAC_DATA *a, unsigned char **pp);
  245. PKCS12_MAC_DATA *PKCS12_MAC_DATA_new(void);
  246. PKCS12_MAC_DATA *d2i_PKCS12_MAC_DATA(PKCS12_MAC_DATA **a, unsigned char **pp,
  247. long length);
  248. void PKCS12_MAC_DATA_free(PKCS12_MAC_DATA *a);
  249. int i2d_PKCS12_SAFEBAG(PKCS12_SAFEBAG *a, unsigned char **pp);
  250. PKCS12_SAFEBAG *PKCS12_SAFEBAG_new(void);
  251. PKCS12_SAFEBAG *d2i_PKCS12_SAFEBAG(PKCS12_SAFEBAG **a, unsigned char **pp,
  252. long length);
  253. void PKCS12_SAFEBAG_free(PKCS12_SAFEBAG *a);
  254. void ERR_load_PKCS12_strings(void);
  255. void PKCS12_PBE_add(void);
  256. int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
  257. STACK_OF(X509) **ca);
  258. PKCS12 *PKCS12_create(char *pass, char *name, EVP_PKEY *pkey, X509 *cert,
  259. STACK_OF(X509) *ca, int nid_key, int nid_cert, int iter,
  260. int mac_iter, int keytype);
  261. int i2d_PKCS12_bio(BIO *bp, PKCS12 *p12);
  262. int i2d_PKCS12_fp(FILE *fp, PKCS12 *p12);
  263. PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
  264. PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
  265. int PKCS12_newpass(PKCS12 *p12, char *oldpass, char *newpass);
  266. /* BEGIN ERROR CODES */
  267. /* The following lines are auto generated by the script mkerr.pl. Any changes
  268. * made after this point may be overwritten when the script is next run.
  269. */
  270. /* Error codes for the PKCS12 functions. */
  271. /* Function codes. */
  272. #define PKCS12_F_PARSE_BAGS 103
  273. #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME 100
  274. #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_ASC 127
  275. #define PKCS12_F_PKCS12_ADD_FRIENDLYNAME_UNI 102
  276. #define PKCS12_F_PKCS12_ADD_LOCALKEYID 104
  277. #define PKCS12_F_PKCS12_CREATE 105
  278. #define PKCS12_F_PKCS12_DECRYPT_D2I 106
  279. #define PKCS12_F_PKCS12_GEN_MAC 107
  280. #define PKCS12_F_PKCS12_I2D_ENCRYPT 108
  281. #define PKCS12_F_PKCS12_INIT 109
  282. #define PKCS12_F_PKCS12_KEY_GEN_ASC 110
  283. #define PKCS12_F_PKCS12_KEY_GEN_UNI 111
  284. #define PKCS12_F_PKCS12_MAKE_KEYBAG 112
  285. #define PKCS12_F_PKCS12_MAKE_SHKEYBAG 113
  286. #define PKCS12_F_PKCS12_NEWPASS 128
  287. #define PKCS12_F_PKCS12_PACK_P7DATA 114
  288. #define PKCS12_F_PKCS12_PACK_P7ENCDATA 115
  289. #define PKCS12_F_PKCS12_PACK_SAFEBAG 117
  290. #define PKCS12_F_PKCS12_PARSE 118
  291. #define PKCS12_F_PKCS12_PBE_CRYPT 119
  292. #define PKCS12_F_PKCS12_PBE_KEYIVGEN 120
  293. #define PKCS12_F_PKCS12_SETUP_MAC 122
  294. #define PKCS12_F_PKCS12_SET_MAC 123
  295. #define PKCS12_F_PKCS8_ADD_KEYUSAGE 124
  296. #define PKCS12_F_PKCS8_ENCRYPT 125
  297. #define PKCS12_F_VERIFY_MAC 126
  298. /* Reason codes. */
  299. #define PKCS12_R_CANT_PACK_STRUCTURE 100
  300. #define PKCS12_R_DECODE_ERROR 101
  301. #define PKCS12_R_ENCODE_ERROR 102
  302. #define PKCS12_R_ENCRYPT_ERROR 103
  303. #define PKCS12_R_ERROR_SETTING_ENCRYPTED_DATA_TYPE 120
  304. #define PKCS12_R_INVALID_NULL_ARGUMENT 104
  305. #define PKCS12_R_INVALID_NULL_PKCS12_POINTER 105
  306. #define PKCS12_R_IV_GEN_ERROR 106
  307. #define PKCS12_R_KEY_GEN_ERROR 107
  308. #define PKCS12_R_MAC_ABSENT 108
  309. #define PKCS12_R_MAC_GENERATION_ERROR 109
  310. #define PKCS12_R_MAC_SETUP_ERROR 110
  311. #define PKCS12_R_MAC_STRING_SET_ERROR 111
  312. #define PKCS12_R_MAC_VERIFY_ERROR 112
  313. #define PKCS12_R_MAC_VERIFY_FAILURE 113
  314. #define PKCS12_R_PARSE_ERROR 114
  315. #define PKCS12_R_PKCS12_ALGOR_CIPHERINIT_ERROR 115
  316. #define PKCS12_R_PKCS12_CIPHERFINAL_ERROR 116
  317. #define PKCS12_R_PKCS12_PBE_CRYPT_ERROR 117
  318. #define PKCS12_R_UNKNOWN_DIGEST_ALGORITHM 118
  319. #define PKCS12_R_UNSUPPORTED_PKCS12_MODE 119
  320. #ifdef __cplusplus
  321. }
  322. #endif
  323. #endif