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