1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
/**
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* @file cpkcs12.h
* @author Jacek Migacz (j.migacz@samsung.com)
* @author Bartlomiej Grzelewski (b.grzelewski@samsung.com)
* @brief This is part of C api for PKCS#12/PFX storage routines.
*/
#ifndef _CERTSVC_CPKCS12_H_
#define _CERTSVC_CPKCS12_H_
#include <cert-svc/cinstance.h>
#include <cert-svc/cstring.h>
#include <cert-svc/ccert.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* Check whenever PKCS#12 container is password protected.
*
* @param[in] instance CertSvcInstance object
* @param[in] filepath File path to check
* @param[out] has_password #1 if password protectedm, else #0
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
*/
int certsvc_pkcs12_has_password(CertSvcInstance instance,
CertSvcString filepath,
int *has_password);
/**
* Couter-routine for certsvc_pkcs12_private_key_dup.
*
* @param[in] buffer Memory claimed by private key
*/
void certsvc_pkcs12_private_key_free(char *buffer);
/**
* Load to memory of private key in cert-svc store with @a gname.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] gname Single certificate identifier. It has to be end user's
* to extract private key
* @param[out] buffer Private key buffer which must be freed after use
* @param[out] size Size of the returned buffer. Zero when no key is found
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_private_key_dup_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString gname,
char **buffer,
size_t *size);
/**
* Set the status for the specified certificate in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] is_root_app Should be #ENABLED if master application is changing the status,
* else #DISABLED for other applications
* @param[in] gname Single certificate identifier
* @param[in] status Status of the certificate to set. [#ENABLED | #DISABLED]
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
* @see #CertStatus
*/
int certsvc_pkcs12_set_certificate_status_to_store(CertSvcInstance instance,
CertStoreType storeType,
int is_root_app,
CertSvcString gname,
CertStatus status);
/**
* Get the status for the specified certificate in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in[ gname Single certificate identifier
* @param[out] status Status of the certificate. Enabled:1, Disabled:0, Fail:-1
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStroeType
*/
int certsvc_pkcs12_get_certificate_status_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString gname,
CertStatus *status);
/**
* Get the certificates in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] is_root_app Should be #ENABLED if master application is changing the
* status, else #DISABLED for other applications
* @param[out] certList cert list in store returned in linked list. Free by
* certsvc_pkcs12_free_certificate_list_loaded_from_store()
* after use
* @param[out] length length of output @a certList
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see #CertStoreType
* @see #CertSvcStoreCertList
*/
int certsvc_pkcs12_get_certificate_list_from_store(CertSvcInstance instance,
CertStoreType storeType,
int is_root_app,
CertSvcStoreCertList **certList,
size_t *length);
/**
* Get the end user certificates in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[out] certList cert list in store returned in linked list. Free by
* certsvc_pkcs12_free_certificate_list_loaded_from_store() after use
* @param[out] length length of output @a certList
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see #CertStoreType
* @see #CertSvcStoreCertList
*/
int certsvc_pkcs12_get_end_user_certificate_list_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcStoreCertList **certList,
size_t *length);
/**
* Get the root/trusted certificates in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[out] certList cert list in store returned in linked list. Free by
* certsvc_pkcs12_free_certificate_list_loaded_from_store() after use
* @param[out] length length of output @a certList
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_pkcs12_free_certificate_list_loaded_from_store()
* @see #CertStoreType
* @see #CertSvcStoreCertList
*/
int certsvc_pkcs12_get_root_certificate_list_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcStoreCertList **certList,
size_t *length);
/**
* Free all @a CertSvcStoreCertList in linked list of data structure.
*
* @param[in] instance CertSvcInstance object
* @param[in] certList The structure which need to be freed
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_pkcs12_get_certificate_list_from_store()
* @see certsvc_pkcs12_get_end_user_certificate_list_from_store()
* @see certsvc_pkcs12_get_root_certificate_list_from_store()
* @see #CertSvcStoreCertList
*/
int certsvc_pkcs12_free_certificate_list_loaded_from_store(CertSvcInstance instance,
CertSvcStoreCertList **certList);
/**
* Get the certificate with the gname provided from cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] gname Single certificate identifier
* @param[out] certificate output in @a CertSvcCertificate format
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_certificate_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_get_certificate_from_store(CertSvcInstance instance,
CertStoreType storeType,
const char *gname,
CertSvcCertificate *certificate);
/**
* Get the encoded certificate buffer with the gname provided from cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] gname Single certificate identifier
* @param[out] buffer The base64 encoded certificate which must be freed after
* use
* @param[out] size Size of the buffer
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_get_certificate_info_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString gname,
char **buffer,
size_t *size);
/**
* Import PKCS#12 bundle(with .pfx or .p12) or certificate(base64 form with .crt
* or .pem suffix) from file to specified store. If password isn't needed, create
* CertSvcString @a password with null input on certsvc_string_new(). Refer
* certsvc_string_new() API description
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] path Path of the certificate which needs to be imported
* @param[in] password Password if the file to import is password-protected which can be
* empty CertSvcString in case of not-password-protected
* @param[in] alias Primary key for certificate bundle identification (can't be empty)
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_import_from_file_to_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString path,
CertSvcString password,
CertSvcString alias);
/**
* Delete the certificate with gname provided from cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] gname Single certificate identifier
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_delete_certificate_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString gname);
/**
* Check the uniqueness of the alias in cert-svc store.
*
* @param[in] instance CertSvcInstance object
* @param[in] storeType cert-svc store type to query
* @param[in] alias Certificates bundle identifier used when importing
* @param[out] is_unique #CERTSVC_TRUE if the alias is unique, else #CERTSVC_FALSE
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_check_alias_exists_in_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString alias,
int *is_unique);
/**
* Get list of certificates from PKCS#12 bundle or single certificate which
* is saved in cert-svc store with the alias.
*
* @param[in] instance CertSvcInstance object
* @param[in] alias Certificates bundle identifier used when importing
* @param[out] certificateList List of certificates. Free by
* certsvc_certificate_list_free() after use
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see certsvc_certificate_free()
* @see certsvc_certificate_list_free()
* @see #CertStoreType
* @see #CertSvcStoreCertList
*/
int certsvc_pkcs12_load_certificate_list_from_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString alias,
CertSvcCertificateList *certificateList);
/**
* Get the alias name with the gname provided.
*
* @param[in] instance CertSvcInstance object
* @param[in] gname Single certificate identifier which is associated with alias
* @param[out] alias Certificates bundle identifier used when importing which must
* be freed after use
*
* @return #CERTSVC_SUCCESS on success, otherwise a zero or negative error value
*
* @see certsvc_instance_new()
* @see certsvc_instance_free()
* @see certsvc_string_new()
* @see certsvc_string_free()
* @see #CertStoreType
*/
int certsvc_pkcs12_get_alias_name_for_certificate_in_store(CertSvcInstance instance,
CertStoreType storeType,
CertSvcString gname,
char **alias);
#ifdef __cplusplus
}
#endif
#endif
|
