Coverage Report

Created: 2024-08-15 14:03

/src/openssl/include/openssl/pkcs12.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 1999-2016 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
0
# define PKCS12_KEY_ID   1
28
0
# define PKCS12_IV_ID    2
29
0
# 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
0
# 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_STACK_OF(PKCS12_SAFEBAG)
56
57
typedef struct pkcs12_bag_st PKCS12_BAGS;
58
59
0
# 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
97
X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
98
X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
99
const STACK_OF(PKCS12_SAFEBAG) *
100
PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
101
const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
102
const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);
103
104
PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_cert(X509 *x509);
105
PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_crl(X509_CRL *crl);
106
PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_p8inf(PKCS8_PRIV_KEY_INFO *p8);
107
PKCS12_SAFEBAG *PKCS12_SAFEBAG_create0_pkcs8(X509_SIG *p8);
108
PKCS12_SAFEBAG *PKCS12_SAFEBAG_create_pkcs8_encrypt(int pbe_nid,
109
                                                    const char *pass,
110
                                                    int passlen,
111
                                                    unsigned char *salt,
112
                                                    int saltlen, int iter,
113
                                                    PKCS8_PRIV_KEY_INFO *p8inf);
114
115
PKCS12_SAFEBAG *PKCS12_item_pack_safebag(void *obj, const ASN1_ITEM *it,
116
                                         int nid1, int nid2);
117
PKCS8_PRIV_KEY_INFO *PKCS8_decrypt(const X509_SIG *p8, const char *pass,
118
                                   int passlen);
119
PKCS8_PRIV_KEY_INFO *PKCS12_decrypt_skey(const PKCS12_SAFEBAG *bag,
120
                                         const char *pass, int passlen);
121
X509_SIG *PKCS8_encrypt(int pbe_nid, const EVP_CIPHER *cipher,
122
                        const char *pass, int passlen, unsigned char *salt,
123
                        int saltlen, int iter, PKCS8_PRIV_KEY_INFO *p8);
124
X509_SIG *PKCS8_set0_pbe(const char *pass, int passlen,
125
                        PKCS8_PRIV_KEY_INFO *p8inf, X509_ALGOR *pbe);
126
PKCS7 *PKCS12_pack_p7data(STACK_OF(PKCS12_SAFEBAG) *sk);
127
STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7data(PKCS7 *p7);
128
PKCS7 *PKCS12_pack_p7encdata(int pbe_nid, const char *pass, int passlen,
129
                             unsigned char *salt, int saltlen, int iter,
130
                             STACK_OF(PKCS12_SAFEBAG) *bags);
131
STACK_OF(PKCS12_SAFEBAG) *PKCS12_unpack_p7encdata(PKCS7 *p7, const char *pass,
132
                                                  int passlen);
133
134
int PKCS12_pack_authsafes(PKCS12 *p12, STACK_OF(PKCS7) *safes);
135
STACK_OF(PKCS7) *PKCS12_unpack_authsafes(const PKCS12 *p12);
136
137
int PKCS12_add_localkeyid(PKCS12_SAFEBAG *bag, unsigned char *name,
138
                          int namelen);
139
int PKCS12_add_friendlyname_asc(PKCS12_SAFEBAG *bag, const char *name,
140
                                int namelen);
141
int PKCS12_add_friendlyname_utf8(PKCS12_SAFEBAG *bag, const char *name,
142
                                 int namelen);
143
int PKCS12_add_CSPName_asc(PKCS12_SAFEBAG *bag, const char *name,
144
                           int namelen);
145
int PKCS12_add_friendlyname_uni(PKCS12_SAFEBAG *bag,
146
                                const unsigned char *name, int namelen);
147
int PKCS8_add_keyusage(PKCS8_PRIV_KEY_INFO *p8, int usage);
148
ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
149
                               int attr_nid);
150
char *PKCS12_get_friendlyname(PKCS12_SAFEBAG *bag);
151
const STACK_OF(X509_ATTRIBUTE) *
152
PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
153
unsigned char *PKCS12_pbe_crypt(const X509_ALGOR *algor,
154
                                const char *pass, int passlen,
155
                                const unsigned char *in, int inlen,
156
                                unsigned char **data, int *datalen,
157
                                int en_de);
158
void *PKCS12_item_decrypt_d2i(const X509_ALGOR *algor, const ASN1_ITEM *it,
159
                              const char *pass, int passlen,
160
                              const ASN1_OCTET_STRING *oct, int zbuf);
161
ASN1_OCTET_STRING *PKCS12_item_i2d_encrypt(X509_ALGOR *algor,
162
                                           const ASN1_ITEM *it,
163
                                           const char *pass, int passlen,
164
                                           void *obj, int zbuf);
165
PKCS12 *PKCS12_init(int mode);
166
int PKCS12_key_gen_asc(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);
169
int PKCS12_key_gen_uni(unsigned char *pass, int passlen, unsigned char *salt,
170
                       int saltlen, int id, int iter, int n,
171
                       unsigned char *out, const EVP_MD *md_type);
172
int PKCS12_key_gen_utf8(const char *pass, int passlen, unsigned char *salt,
173
                        int saltlen, int id, int iter, int n,
174
                        unsigned char *out, const EVP_MD *md_type);
175
int PKCS12_PBE_keyivgen(EVP_CIPHER_CTX *ctx, const char *pass, int passlen,
176
                        ASN1_TYPE *param, const EVP_CIPHER *cipher,
177
                        const EVP_MD *md_type, int en_de);
178
int PKCS12_gen_mac(PKCS12 *p12, const char *pass, int passlen,
179
                   unsigned char *mac, unsigned int *maclen);
180
int PKCS12_verify_mac(PKCS12 *p12, const char *pass, int passlen);
181
int PKCS12_set_mac(PKCS12 *p12, const char *pass, int passlen,
182
                   unsigned char *salt, int saltlen, int iter,
183
                   const EVP_MD *md_type);
184
int PKCS12_setup_mac(PKCS12 *p12, int iter, unsigned char *salt,
185
                     int saltlen, const EVP_MD *md_type);
186
unsigned char *OPENSSL_asc2uni(const char *asc, int asclen,
187
                               unsigned char **uni, int *unilen);
188
char *OPENSSL_uni2asc(const unsigned char *uni, int unilen);
189
unsigned char *OPENSSL_utf82uni(const char *asc, int asclen,
190
                                unsigned char **uni, int *unilen);
191
char *OPENSSL_uni2utf8(const unsigned char *uni, int unilen);
192
193
DECLARE_ASN1_FUNCTIONS(PKCS12)
194
DECLARE_ASN1_FUNCTIONS(PKCS12_MAC_DATA)
195
DECLARE_ASN1_FUNCTIONS(PKCS12_SAFEBAG)
196
DECLARE_ASN1_FUNCTIONS(PKCS12_BAGS)
197
198
DECLARE_ASN1_ITEM(PKCS12_SAFEBAGS)
199
DECLARE_ASN1_ITEM(PKCS12_AUTHSAFES)
200
201
void PKCS12_PBE_add(void);
202
int PKCS12_parse(PKCS12 *p12, const char *pass, EVP_PKEY **pkey, X509 **cert,
203
                 STACK_OF(X509) **ca);
204
PKCS12 *PKCS12_create(const char *pass, const char *name, EVP_PKEY *pkey,
205
                      X509 *cert, STACK_OF(X509) *ca, int nid_key, int nid_cert,
206
                      int iter, int mac_iter, int keytype);
207
208
PKCS12_SAFEBAG *PKCS12_add_cert(STACK_OF(PKCS12_SAFEBAG) **pbags, X509 *cert);
209
PKCS12_SAFEBAG *PKCS12_add_key(STACK_OF(PKCS12_SAFEBAG) **pbags,
210
                               EVP_PKEY *key, int key_usage, int iter,
211
                               int key_nid, const char *pass);
212
int PKCS12_add_safe(STACK_OF(PKCS7) **psafes, STACK_OF(PKCS12_SAFEBAG) *bags,
213
                    int safe_nid, int iter, const char *pass);
214
PKCS12 *PKCS12_add_safes(STACK_OF(PKCS7) *safes, int p7_nid);
215
216
int i2d_PKCS12_bio(BIO *bp, const PKCS12 *p12);
217
# ifndef OPENSSL_NO_STDIO
218
int i2d_PKCS12_fp(FILE *fp, const PKCS12 *p12);
219
# endif
220
PKCS12 *d2i_PKCS12_bio(BIO *bp, PKCS12 **p12);
221
# ifndef OPENSSL_NO_STDIO
222
PKCS12 *d2i_PKCS12_fp(FILE *fp, PKCS12 **p12);
223
# endif
224
int PKCS12_newpass(PKCS12 *p12, const char *oldpass, const char *newpass);
225
226
# ifdef  __cplusplus
227
}
228
# endif
229
#endif