Debian Codegraph @

src/ksba.h.in

raw
1 /* ksba.h - X.509 library used by GnuPG
2 * Copyright (C) 2001-2006, 2010-2015, 2018-2026 g10 Code GmbH
3 *
4 * This file is part of KSBA.
5 *
6 * KSBA is free software; you can redistribute it and/or modify
7 * it under the terms of either
8 *
9 * - the GNU Lesser General Public License as published by the Free
10 * Software Foundation; either version 3 of the License, or (at
11 * your option) any later version.
12 *
13 * or
14 *
15 * - the GNU General Public License as published by the Free
16 * Software Foundation; either version 2 of the License, or (at
17 * your option) any later version.
18 *
19 * or both in parallel, as here.
20 *
21 * KSBA is distributed in the hope that it will be useful, but WITHOUT
22 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
23 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
24 * License for more details.
25 *
26 * You should have received a copies of the GNU General Public License
27 * and the GNU Lesser General Public License along with this program;
28 * if not, see <http://www.gnu.org/licenses/>.
29 * SPDX-License-Identifier: LGPL-3.0-or-later OR GPL-2.0-or-later
30 */
31
32 #ifndef KSBA_H
33 #define KSBA_H 1
34
35 #include <gpg-error.h>
36 #include <stdio.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #if 0
41 }
42 #endif
43 #endif
44
45 /* The version of this header should match the one of the library. Do
46 * not use this symbol in your application; use assuan_check_version
47 * instead. */
48 #define KSBA_VERSION "@VERSION@"
49
50 /* The version number of this header. It may be used to handle minor
51 * API incompatibilities. */
52 #define KSBA_VERSION_NUMBER @VERSION_NUMBER@
53
54
55
56 /* Check for compiler features. */
57 #ifdef __GNUC__
58 #define _KSBA_GCC_VERSION (__GNUC__ * 10000 \
59 + __GNUC_MINOR__ * 100 \
60 + __GNUC_PATCHLEVEL__)
61 #if _KSBA_GCC_VERSION > 30100
62 #define _KSBA_DEPRECATED __attribute__ ((__deprecated__))
63 #endif
64 #if _KSBA_GCC_VERSION >= 80000
65 #define _KSBA_NONSTRING __attribute__((__nonstring__))
66 #endif
67 #endif /*__GNUC__*/
68
69 #ifndef _KSBA_DEPRECATED
70 #define _KSBA_DEPRECATED
71 #endif
72
73 #ifndef _KSBA_NONSTRING
74 # define _KSBA_NONSTRING
75 #endif
76
77 #define KSBA_CLASS_UNIVERSAL 0
78 #define KSBA_CLASS_APPLICATION 1
79 #define KSBA_CLASS_CONTEXT 2
80 #define KSBA_CLASS_PRIVATE 3
81 #define KSBA_CLASS_ENCAPSULATE 0x80 /* Pseudo class. */
82
83 #define KSBA_TYPE_BOOLEAN 1
84 #define KSBA_TYPE_INTEGER 2
85 #define KSBA_TYPE_BIT_STRING 3
86 #define KSBA_TYPE_OCTET_STRING 4
87 #define KSBA_TYPE_NULL 5
88 #define KSBA_TYPE_OBJECT_ID 6
89 #define KSBA_TYPE_OBJECT_DESCRIPTOR 7
90 #define KSBA_TYPE_EXTERNAL 8
91 #define KSBA_TYPE_REAL 9
92 #define KSBA_TYPE_ENUMERATED 10
93 #define KSBA_TYPE_EMBEDDED_PDV 11
94 #define KSBA_TYPE_UTF8_STRING 12
95 #define KSBA_TYPE_RELATIVE_OID 13
96 #define KSBA_TYPE_TIME 14
97 #define KSBA_TYPE_SEQUENCE 16
98 #define KSBA_TYPE_SET 17
99 #define KSBA_TYPE_NUMERIC_STRING 18
100 #define KSBA_TYPE_PRINTABLE_STRING 19
101 #define KSBA_TYPE_TELETEX_STRING 20
102 #define KSBA_TYPE_VIDEOTEX_STRING 21
103 #define KSBA_TYPE_IA5_STRING 22
104 #define KSBA_TYPE_UTC_TIME 23
105 #define KSBA_TYPE_GENERALIZED_TIME 24
106 #define KSBA_TYPE_GRAPHIC_STRING 25
107 #define KSBA_TYPE_VISIBLE_STRING 26
108 #define KSBA_TYPE_GENERAL_STRING 27
109 #define KSBA_TYPE_UNIVERSAL_STRING 28
110 #define KSBA_TYPE_CHARACTER_STRING 29
111 #define KSBA_TYPE_BMP_STRING 30
112 #define KSBA_TYPE_DATE 31
113 #define KSBA_TYPE_TIME_OF_DAY 32
114 #define KSBA_TYPE_DATE_TIME 33
115 #define KSBA_TYPE_DURATION 34
116 #define KSBA_TYPE_OID_IRI 35
117 #define KSBA_TYPE_RELATIVE_OID_IRI 36
118
119
120
121 typedef gpg_error_t KsbaError _KSBA_DEPRECATED;
122
123 typedef enum
124 {
125 KSBA_CT_NONE = 0,
126 KSBA_CT_DATA = 1,
127 KSBA_CT_SIGNED_DATA = 2,
128 KSBA_CT_ENVELOPED_DATA = 3,
129 KSBA_CT_DIGESTED_DATA = 4,
130 KSBA_CT_ENCRYPTED_DATA = 5,
131 KSBA_CT_AUTH_DATA = 6,
132 KSBA_CT_PKCS12 = 7,
133 KSBA_CT_SPC_IND_DATA_CTX = 8,
134 KSBA_CT_OPENPGP_KEYBLOCK = 9,
135 KSBA_CT_AUTHENVELOPED_DATA = 10
136 }
137 ksba_content_type_t;
138 typedef ksba_content_type_t KsbaContentType _KSBA_DEPRECATED;
139
140
141
142 typedef enum
143 {
144 KSBA_SR_NONE = 0, /* Never seen by libksba user. */
145 KSBA_SR_RUNNING = 1, /* Never seen by libksba user. */
146 KSBA_SR_GOT_CONTENT = 2,
147 KSBA_SR_NEED_HASH = 3,
148 KSBA_SR_BEGIN_DATA = 4,
149 KSBA_SR_END_DATA = 5,
150 KSBA_SR_READY = 6,
151 KSBA_SR_NEED_SIG = 7,
152 KSBA_SR_DETACHED_DATA = 8,
153 KSBA_SR_BEGIN_ITEMS = 9,
154 KSBA_SR_GOT_ITEM = 10,
155 KSBA_SR_END_ITEMS = 11
156 }
157 ksba_stop_reason_t;
158 typedef ksba_stop_reason_t KsbaStopReason _KSBA_DEPRECATED;
159
160 typedef enum
161 {
162 KSBA_CRLREASON_UNSPECIFIED = 1,
163 KSBA_CRLREASON_KEY_COMPROMISE = 2,
164 KSBA_CRLREASON_CA_COMPROMISE = 4,
165 KSBA_CRLREASON_AFFILIATION_CHANGED = 8,
166 KSBA_CRLREASON_SUPERSEDED = 16,
167 KSBA_CRLREASON_CESSATION_OF_OPERATION = 32,
168 KSBA_CRLREASON_CERTIFICATE_HOLD = 64,
169 KSBA_CRLREASON_REMOVE_FROM_CRL = 256,
170 KSBA_CRLREASON_PRIVILEGE_WITHDRAWN = 512,
171 KSBA_CRLREASON_AA_COMPROMISE = 1024,
172 KSBA_CRLREASON_OTHER = 32768
173 }
174 ksba_crl_reason_t;
175 typedef ksba_crl_reason_t KsbaCRLReason _KSBA_DEPRECATED;
176
177 typedef enum
178 {
179 KSBA_OCSP_RSPSTATUS_SUCCESS = 0,
180 KSBA_OCSP_RSPSTATUS_MALFORMED = 1,
181 KSBA_OCSP_RSPSTATUS_INTERNAL = 2,
182 KSBA_OCSP_RSPSTATUS_TRYLATER = 3,
183 KSBA_OCSP_RSPSTATUS_SIGREQUIRED = 5,
184 KSBA_OCSP_RSPSTATUS_UNAUTHORIZED = 6,
185 KSBA_OCSP_RSPSTATUS_REPLAYED = 253,
186 KSBA_OCSP_RSPSTATUS_OTHER = 254,
187 KSBA_OCSP_RSPSTATUS_NONE = 255
188 }
189 ksba_ocsp_response_status_t;
190
191 typedef enum
192 {
193 KSBA_STATUS_NONE = 0,
194 KSBA_STATUS_UNKNOWN = 1,
195 KSBA_STATUS_GOOD = 2,
196 KSBA_STATUS_REVOKED = 4
197 }
198 ksba_status_t;
199
200
201 typedef enum
202 {
203 KSBA_KEYUSAGE_DIGITAL_SIGNATURE = 1,
204 KSBA_KEYUSAGE_NON_REPUDIATION = 2,
205 KSBA_KEYUSAGE_KEY_ENCIPHERMENT = 4,
206 KSBA_KEYUSAGE_DATA_ENCIPHERMENT = 8,
207 KSBA_KEYUSAGE_KEY_AGREEMENT = 16,
208 KSBA_KEYUSAGE_KEY_CERT_SIGN = 32,
209 KSBA_KEYUSAGE_CRL_SIGN = 64,
210 KSBA_KEYUSAGE_ENCIPHER_ONLY = 128,
211 KSBA_KEYUSAGE_DECIPHER_ONLY = 256
212 }
213 ksba_key_usage_t;
214 typedef ksba_key_usage_t KsbaKeyUsage _KSBA_DEPRECATED;
215
216 /* ISO format, e.g. "19610711T172059", assumed to be UTC. */
217 typedef char ksba_isotime_t[16];
218
219
220 /* X.509 certificates are represented by this object.
221 ksba_cert_new() creates such an object */
222 struct ksba_cert_s;
223 typedef struct ksba_cert_s *ksba_cert_t;
224 typedef struct ksba_cert_s *KsbaCert _KSBA_DEPRECATED;
225
226 /* CMS objects are controlled by this object.
227 ksba_cms_new() creates it */
228 struct ksba_cms_s;
229 typedef struct ksba_cms_s *ksba_cms_t;
230 typedef struct ksba_cms_s *KsbaCMS _KSBA_DEPRECATED;
231
232 /* CRL objects are controlled by this object.
233 ksba_crl_new() creates it */
234 struct ksba_crl_s;
235 typedef struct ksba_crl_s *ksba_crl_t;
236 typedef struct ksba_crl_s *KsbaCRL _KSBA_DEPRECATED;
237
238 /* OCSP objects are controlled by this object.
239 ksba_ocsp_new() creates it. */
240 struct ksba_ocsp_s;
241 typedef struct ksba_ocsp_s *ksba_ocsp_t;
242
243 /* PKCS-10 creation is controlled by this object.
244 ksba_certreq_new() creates it */
245 struct ksba_certreq_s;
246 typedef struct ksba_certreq_s *ksba_certreq_t;
247 typedef struct ksba_certreq_s *KsbaCertreq _KSBA_DEPRECATED;
248
249 /* This is a reader object for various purposes
250 see ksba_reader_new et al. */
251 struct ksba_reader_s;
252 typedef struct ksba_reader_s *ksba_reader_t;
253 typedef struct ksba_reader_s *KsbaReader _KSBA_DEPRECATED;
254
255 /* This is a writer object for various purposes
256 see ksba_writer_new et al. */
257 struct ksba_writer_s;
258 typedef struct ksba_writer_s *ksba_writer_t;
259 typedef struct ksba_writer_s *KsbaWriter _KSBA_DEPRECATED;
260
261 /* This is an object to store an ASN.1 parse tree as
262 create by ksba_asn_parse_file() */
263 struct ksba_asn_tree_s;
264 typedef struct ksba_asn_tree_s *ksba_asn_tree_t;
265 typedef struct ksba_asn_tree_s *KsbaAsnTree _KSBA_DEPRECATED;
266
267 /* This is an object to reference a General Name. Such an object is
268 returned by several functions. */
269 struct ksba_name_s;
270 typedef struct ksba_name_s *ksba_name_t;
271 typedef struct ksba_name_s *KsbaName _KSBA_DEPRECATED;
272
273 /* KsbaSexp is just an unsigned char * which should be used for
274 documentation purpose. The S-expressions returned by libksba are
275 always in canonical representation with an extra 0 byte at the end,
276 so that one can print the values in the debugger and at least see
277 the first bytes */
278 typedef unsigned char *ksba_sexp_t;
279 typedef unsigned char *KsbaSexp _KSBA_DEPRECATED;
280 typedef const unsigned char *ksba_const_sexp_t;
281 typedef const unsigned char *KsbaConstSexp _KSBA_DEPRECATED;
282
283
284 /* This is a generic object used by various functions. */
285 struct ksba_der_s;
286 typedef struct ksba_der_s *ksba_der_t;
287
288
289 /*-- cert.c --*/
290 gpg_error_t ksba_cert_new (ksba_cert_t *acert);
291 void ksba_cert_ref (ksba_cert_t cert);
292 void ksba_cert_release (ksba_cert_t cert);
293 gpg_error_t ksba_cert_set_user_data (ksba_cert_t cert, const char *key,
294 const void *data, size_t datalen);
295 gpg_error_t ksba_cert_get_user_data (ksba_cert_t cert, const char *key,
296 void *buffer, size_t bufferlen,
297 size_t *datalen);
298
299 gpg_error_t ksba_cert_read_der (ksba_cert_t cert, ksba_reader_t reader);
300 gpg_error_t ksba_cert_init_from_mem (ksba_cert_t cert,
301 const void *buffer, size_t length);
302 const unsigned char *ksba_cert_get_image (ksba_cert_t cert, size_t *r_length);
303 gpg_error_t ksba_cert_hash (ksba_cert_t cert,
304 int what,
305 void (*hasher)(void *,
306 const void *,
307 size_t length),
308 void *hasher_arg);
309 const char *ksba_cert_get_digest_algo (ksba_cert_t cert);
310 ksba_sexp_t ksba_cert_get_serial (ksba_cert_t cert);
311 char *ksba_cert_get_issuer (ksba_cert_t cert, int idx);
312 gpg_error_t ksba_cert_get_validity (ksba_cert_t cert, int what,
313 ksba_isotime_t r_time);
314 char *ksba_cert_get_subject (ksba_cert_t cert, int idx);
315 ksba_sexp_t ksba_cert_get_public_key (ksba_cert_t cert);
316 ksba_sexp_t ksba_cert_get_sig_val (ksba_cert_t cert);
317
318 gpg_error_t ksba_cert_get_extension (ksba_cert_t cert, int idx,
319 char const **r_oid, int *r_crit,
320 size_t *r_deroff, size_t *r_derlen);
321
322 gpg_error_t ksba_cert_is_ca (ksba_cert_t cert, int *r_ca, int *r_pathlen);
323 gpg_error_t ksba_cert_get_key_usage (ksba_cert_t cert, unsigned int *r_flags);
324 gpg_error_t ksba_cert_get_cert_policies (ksba_cert_t cert, char **r_policies);
325 gpg_error_t ksba_cert_get_ext_key_usages (ksba_cert_t cert, char **result);
326 gpg_error_t ksba_cert_get_crl_dist_point (ksba_cert_t cert, int idx,
327 ksba_name_t *r_distpoint,
328 ksba_name_t *r_issuer,
329 ksba_crl_reason_t *r_reason);
330 gpg_error_t ksba_cert_get_auth_key_id (ksba_cert_t cert,
331 ksba_sexp_t *r_keyid,
332 ksba_name_t *r_name,
333 ksba_sexp_t *r_serial);
334 gpg_error_t ksba_cert_get_subj_key_id (ksba_cert_t cert,
335 int *r_crit,
336 ksba_sexp_t *r_keyid);
337 gpg_error_t ksba_cert_get_authority_info_access (ksba_cert_t cert, int idx,
338 char **r_method,
339 ksba_name_t *r_location);
340 gpg_error_t ksba_cert_get_subject_info_access (ksba_cert_t cert, int idx,
341 char **r_method,
342 ksba_name_t *r_location);
343
344
345 /*-- cms.c --*/
346 ksba_content_type_t ksba_cms_identify (ksba_reader_t reader);
347
348 gpg_error_t ksba_cms_new (ksba_cms_t *r_cms);
349 void ksba_cms_release (ksba_cms_t cms);
350 gpg_error_t ksba_cms_set_reader_writer (ksba_cms_t cms,
351 ksba_reader_t r, ksba_writer_t w);
352
353 gpg_error_t ksba_cms_parse (ksba_cms_t cms, ksba_stop_reason_t *r_stopreason);
354 gpg_error_t ksba_cms_build (ksba_cms_t cms, ksba_stop_reason_t *r_stopreason);
355
356 ksba_content_type_t ksba_cms_get_content_type (ksba_cms_t cms, int what);
357 const char *ksba_cms_get_content_oid (ksba_cms_t cms, int what);
358 gpg_error_t ksba_cms_get_content_enc_iv (ksba_cms_t cms, void *iv,
359 size_t maxivlen, size_t *ivlen);
360 const char *ksba_cms_get_digest_algo_list (ksba_cms_t cms, int idx);
361 gpg_error_t ksba_cms_get_issuer_serial (ksba_cms_t cms, int idx,
362 char **r_issuer,
363 ksba_sexp_t *r_serial);
364 const char *ksba_cms_get_digest_algo (ksba_cms_t cms, int idx);
365 ksba_cert_t ksba_cms_get_cert (ksba_cms_t cms, int idx);
366 gpg_error_t ksba_cms_get_message_digest (ksba_cms_t cms, int idx,
367 char **r_digest, size_t *r_digest_len);
368 gpg_error_t ksba_cms_get_signing_time (ksba_cms_t cms, int idx,
369 ksba_isotime_t r_sigtime);
370 gpg_error_t ksba_cms_get_sigattr_oids (ksba_cms_t cms, int idx,
371 const char *reqoid, char **r_value);
372 gpg_error_t ksba_cms_get_attribute (ksba_cms_t cms, int signer, int idx,
373 int unprotected, char **r_oid,
374 unsigned char **r_der, size_t *r_derlen);
375 ksba_sexp_t ksba_cms_get_sig_val (ksba_cms_t cms, int idx);
376 ksba_sexp_t ksba_cms_get_enc_val (ksba_cms_t cms, int idx);
377
378 void ksba_cms_set_hash_function (ksba_cms_t cms,
379 void (*hash_fnc)(void *, const void *, size_t),
380 void *hash_fnc_arg);
381
382 gpg_error_t ksba_cms_hash_signed_attrs (ksba_cms_t cms, int idx);
383
384
385 gpg_error_t ksba_cms_set_content_type (ksba_cms_t cms, int what,
386 ksba_content_type_t type);
387 gpg_error_t ksba_cms_add_digest_algo (ksba_cms_t cms, const char *oid);
388 gpg_error_t ksba_cms_add_signer (ksba_cms_t cms, ksba_cert_t cert);
389 gpg_error_t ksba_cms_add_cert (ksba_cms_t cms, ksba_cert_t cert);
390 gpg_error_t ksba_cms_add_smime_capability (ksba_cms_t cms, const char *oid,
391 const unsigned char *der,
392 size_t derlen);
393 gpg_error_t ksba_cms_add_attribute (ksba_cms_t cms, int idx,
394 const char *oid, int unprotected,
395 const unsigned char *der, size_t derlen);
396 gpg_error_t ksba_cms_set_message_digest (ksba_cms_t cms, int idx,
397 const unsigned char *digest,
398 size_t digest_len);
399 gpg_error_t ksba_cms_set_signing_time (ksba_cms_t cms, int idx,
400 const ksba_isotime_t sigtime);
401 gpg_error_t ksba_cms_set_sig_val (ksba_cms_t cms,
402 int idx, ksba_const_sexp_t sigval);
403
404 gpg_error_t ksba_cms_set_content_enc_algo (ksba_cms_t cms,
405 const char *oid,
406 const void *iv,
407 size_t ivlen);
408 gpg_error_t ksba_cms_add_recipient (ksba_cms_t cms, ksba_cert_t cert);
409 gpg_error_t ksba_cms_set_enc_val (ksba_cms_t cms,
410 int idx, ksba_const_sexp_t encval);
411
412
413 /*-- crl.c --*/
414 gpg_error_t ksba_crl_new (ksba_crl_t *r_crl);
415 void ksba_crl_release (ksba_crl_t crl);
416 gpg_error_t ksba_crl_set_reader (ksba_crl_t crl, ksba_reader_t r);
417 void ksba_crl_set_hash_function (ksba_crl_t crl,
418 void (*hash_fnc)(void *,
419 const void *, size_t),
420 void *hash_fnc_arg);
421 const char *ksba_crl_get_digest_algo (ksba_crl_t crl);
422 gpg_error_t ksba_crl_get_issuer (ksba_crl_t crl, char **r_issuer);
423 gpg_error_t ksba_crl_get_extension (ksba_crl_t crl, int idx,
424 char const **oid, int *critical,
425 unsigned char const **der, size_t *derlen);
426 gpg_error_t ksba_crl_get_auth_key_id (ksba_crl_t crl,
427 ksba_sexp_t *r_keyid,
428 ksba_name_t *r_name,
429 ksba_sexp_t *r_serial);
430 gpg_error_t ksba_crl_get_crl_number (ksba_crl_t crl, ksba_sexp_t *number);
431 gpg_error_t ksba_crl_get_update_times (ksba_crl_t crl,
432 ksba_isotime_t this_update,
433 ksba_isotime_t next_update);
434 gpg_error_t ksba_crl_get_item (ksba_crl_t crl,
435 ksba_sexp_t *r_serial,
436 ksba_isotime_t r_revocation_date,
437 ksba_crl_reason_t *r_reason);
438 ksba_sexp_t ksba_crl_get_sig_val (ksba_crl_t crl);
439 gpg_error_t ksba_crl_parse (ksba_crl_t crl, ksba_stop_reason_t *r_stopreason);
440
441
442
443 /*-- ocsp.c --*/
444 gpg_error_t ksba_ocsp_new (ksba_ocsp_t *r_oscp);
445 void ksba_ocsp_release (ksba_ocsp_t ocsp);
446 gpg_error_t ksba_ocsp_set_digest_algo (ksba_ocsp_t ocsp, const char *oid);
447 gpg_error_t ksba_ocsp_set_requestor (ksba_ocsp_t ocsp, ksba_cert_t cert);
448 gpg_error_t ksba_ocsp_add_target (ksba_ocsp_t ocsp,
449 ksba_cert_t cert, ksba_cert_t issuer_cert);
450
451 /* Note that !NONCE and NONCELEN !=0 has a special semantic. */
452 size_t ksba_ocsp_set_nonce (ksba_ocsp_t ocsp,
453 unsigned char *nonce, size_t noncelen);
454
455 gpg_error_t ksba_ocsp_prepare_request (ksba_ocsp_t ocsp);
456 gpg_error_t ksba_ocsp_hash_request (ksba_ocsp_t ocsp,
457 void (*hasher)(void *, const void *,
458 size_t length),
459 void *hasher_arg);
460 gpg_error_t ksba_ocsp_set_sig_val (ksba_ocsp_t ocsp,
461 ksba_const_sexp_t sigval);
462 gpg_error_t ksba_ocsp_add_cert (ksba_ocsp_t ocsp, ksba_cert_t cert);
463 gpg_error_t ksba_ocsp_build_request (ksba_ocsp_t ocsp,
464 unsigned char **r_buffer,
465 size_t *r_buflen);
466
467 gpg_error_t ksba_ocsp_parse_response (ksba_ocsp_t ocsp,
468 const unsigned char *msg, size_t msglen,
469 ksba_ocsp_response_status_t *resp_status);
470
471 const char *ksba_ocsp_get_digest_algo (ksba_ocsp_t ocsp);
472 gpg_error_t ksba_ocsp_hash_response (ksba_ocsp_t ocsp,
473 const unsigned char *msg, size_t msglen,
474 void (*hasher)(void *, const void *,
475 size_t length),
476 void *hasher_arg);
477 ksba_sexp_t ksba_ocsp_get_sig_val (ksba_ocsp_t ocsp,
478 ksba_isotime_t produced_at);
479 gpg_error_t ksba_ocsp_get_responder_id (ksba_ocsp_t ocsp,
480 char **r_name,
481 ksba_sexp_t *r_keyid);
482 ksba_cert_t ksba_ocsp_get_cert (ksba_ocsp_t ocsp, int idx);
483 gpg_error_t ksba_ocsp_get_status (ksba_ocsp_t ocsp, ksba_cert_t cert,
484 ksba_status_t *r_status,
485 ksba_isotime_t r_this_update,
486 ksba_isotime_t r_next_update,
487 ksba_isotime_t r_revocation_time,
488 ksba_crl_reason_t *r_reason);
489 gpg_error_t ksba_ocsp_get_extension (ksba_ocsp_t ocsp, ksba_cert_t cert,
490 int idx,
491 char const **r_oid, int *r_crit,
492 unsigned char const **r_der,
493 size_t *r_derlen);
494
495
496 /*-- certreq.c --*/
497 gpg_error_t ksba_certreq_new (ksba_certreq_t *r_cr);
498 void ksba_certreq_release (ksba_certreq_t cr);
499 gpg_error_t ksba_certreq_set_writer (ksba_certreq_t cr, ksba_writer_t w);
500 void ksba_certreq_set_hash_function (
501 ksba_certreq_t cr,
502 void (*hash_fnc)(void *, const void *, size_t),
503 void *hash_fnc_arg);
504 gpg_error_t ksba_certreq_add_subject (ksba_certreq_t cr, const char *name);
505 gpg_error_t ksba_certreq_set_public_key (ksba_certreq_t cr,
506 ksba_const_sexp_t key);
507 gpg_error_t ksba_certreq_add_extension (ksba_certreq_t cr,
508 const char *oid, int is_crit,
509 const void *der,
510 size_t derlen);
511 gpg_error_t ksba_certreq_set_sig_val (ksba_certreq_t cr,
512 ksba_const_sexp_t sigval);
513 gpg_error_t ksba_certreq_build (ksba_certreq_t cr,
514 ksba_stop_reason_t *r_stopreason);
515
516 /* The functions below are used to switch to X.509 certificate creation. */
517 gpg_error_t ksba_certreq_set_serial (ksba_certreq_t cr, ksba_const_sexp_t sn);
518 gpg_error_t ksba_certreq_set_issuer (ksba_certreq_t cr, const char *name);
519 gpg_error_t ksba_certreq_set_validity (ksba_certreq_t cr, int what,
520 const ksba_isotime_t timebuf);
521 gpg_error_t ksba_certreq_set_siginfo (ksba_certreq_t cr,
522 ksba_const_sexp_t siginfo);
523
524
525
526 /*-- reader.c --*/
527 gpg_error_t ksba_reader_new (ksba_reader_t *r_r);
528 void ksba_reader_release (ksba_reader_t r);
529 gpg_error_t ksba_reader_set_release_notify (ksba_reader_t r,
530 void (*notify)(void*,ksba_reader_t),
531 void *notify_value);
532 gpg_error_t ksba_reader_clear (ksba_reader_t r,
533 unsigned char **buffer, size_t *buflen);
534 gpg_error_t ksba_reader_error (ksba_reader_t r);
535
536 gpg_error_t ksba_reader_set_mem (ksba_reader_t r,
537 const void *buffer, size_t length);
538 gpg_error_t ksba_reader_set_fd (ksba_reader_t r, int fd);
539 gpg_error_t ksba_reader_set_file (ksba_reader_t r, FILE *fp);
540 gpg_error_t ksba_reader_set_cb (ksba_reader_t r,
541 int (*cb)(void*,char *,size_t,size_t*),
542 void *cb_value );
543
544 gpg_error_t ksba_reader_read (ksba_reader_t r,
545 char *buffer, size_t length, size_t *nread);
546 gpg_error_t ksba_reader_unread (ksba_reader_t r, const void *buffer, size_t count);
547 unsigned long ksba_reader_tell (ksba_reader_t r);
548
549 /*-- writer.c --*/
550 gpg_error_t ksba_writer_new (ksba_writer_t *r_w);
551 void ksba_writer_release (ksba_writer_t w);
552 gpg_error_t ksba_writer_set_release_notify (ksba_writer_t w,
553 void (*notify)(void*,ksba_writer_t),
554 void *notify_value);
555 int ksba_writer_error (ksba_writer_t w);
556 unsigned long ksba_writer_tell (ksba_writer_t w);
557 gpg_error_t ksba_writer_set_fd (ksba_writer_t w, int fd);
558 gpg_error_t ksba_writer_set_file (ksba_writer_t w, FILE *fp);
559 gpg_error_t ksba_writer_set_cb (ksba_writer_t w,
560 int (*cb)(void*,const void *,size_t),
561 void *cb_value);
562 gpg_error_t ksba_writer_set_mem (ksba_writer_t w, size_t initial_size);
563 const void *ksba_writer_get_mem (ksba_writer_t w, size_t *nbytes);
564 void * ksba_writer_snatch_mem (ksba_writer_t w, size_t *nbytes);
565 gpg_error_t ksba_writer_set_filter (ksba_writer_t w,
566 gpg_error_t (*filter)(void*,
567 const void *,size_t, size_t *,
568 void *, size_t, size_t *),
569 void *filter_arg);
570
571 gpg_error_t ksba_writer_write (ksba_writer_t w, const void *buffer, size_t length);
572 gpg_error_t ksba_writer_write_octet_string (ksba_writer_t w,
573 const void *buffer, size_t length,
574 int flush);
575
576 /*-- asn1-parse.y --*/
577 int ksba_asn_parse_file (const char *filename, ksba_asn_tree_t *result,
578 int debug);
579 void ksba_asn_tree_release (ksba_asn_tree_t tree);
580
581 /*-- asn1-func.c --*/
582 void ksba_asn_tree_dump (ksba_asn_tree_t tree, const char *name, FILE *fp);
583 gpg_error_t ksba_asn_create_tree (const char *mod_name, ksba_asn_tree_t *result);
584
585 /*-- oid.c --*/
586 char *ksba_oid_to_str (const char *buffer, size_t length);
587 gpg_error_t ksba_oid_from_str (const char *string,
588 unsigned char **rbuf, size_t *rlength);
589
590 /*-- dn.c --*/
591 gpg_error_t ksba_dn_der2str (const void *der, size_t derlen, char **r_string);
592 gpg_error_t ksba_dn_str2der (const char *string,
593 unsigned char **rder, size_t *rderlen);
594 gpg_error_t ksba_dn_teststr (const char *string, int seq,
595 size_t *rerroff, size_t *rerrlen);
596
597
598 /*-- name.c --*/
599 gpg_error_t ksba_name_new (ksba_name_t *r_name);
600 void ksba_name_ref (ksba_name_t name);
601 void ksba_name_release (ksba_name_t name);
602 const char *ksba_name_enum (ksba_name_t name, int idx);
603 char *ksba_name_get_uri (ksba_name_t name, int idx);
604
605
606 /*-- der-builder.c --*/
607 void ksba_der_release (ksba_der_t d);
608
609 ksba_der_t ksba_der_builder_new (unsigned int nitems);
610 void ksba_der_builder_reset (ksba_der_t d);
611
612 void ksba_der_add_ptr (ksba_der_t d, int cls, int tag,
613 void *value, size_t valuelen);
614 void ksba_der_add_val (ksba_der_t d, int cls, int tag,
615 const void *value, size_t valuelen);
616 void ksba_der_add_int (ksba_der_t d, const void *value, size_t valuelen,
617 int force_positive);
618 void ksba_der_add_oid (ksba_der_t d, const char *oidstr);
619 void ksba_der_add_bts (ksba_der_t d, const void *value, size_t valuelen,
620 unsigned int unusedbits);
621 void ksba_der_add_der (ksba_der_t d, const void *der, size_t derlen);
622 void ksba_der_add_tag (ksba_der_t d, int cls, int tag);
623 void ksba_der_add_end (ksba_der_t d);
624
625 gpg_error_t ksba_der_builder_get (ksba_der_t d,
626 unsigned char **r_obj, size_t *r_objlen);
627
628
629
630 /*-- util.c --*/
631 void ksba_set_malloc_hooks ( void *(*new_alloc_func)(size_t n),
632 void *(*new_realloc_func)(void *p, size_t n),
633 void (*new_free_func)(void*) );
634 void ksba_set_hash_buffer_function ( gpg_error_t (*fnc)
635 (void *arg, const char *oid,
636 const void *buffer, size_t length,
637 size_t resultsize,
638 unsigned char *result,
639 size_t *resultlen),
640 void *fnc_arg);
641 void *ksba_malloc (size_t n );
642 void *ksba_calloc (size_t n, size_t m );
643 void *ksba_realloc (void *p, size_t n);
644 char *ksba_strdup (const char *p);
645 void ksba_free ( void *a );
646
647 /*--version.c --*/
648 const char *ksba_check_version (const char *req_version);
649
650 #ifdef __cplusplus
651 }
652 #endif
653 #endif /*KSBA_H*/