Added gnutls_session_get_id2().
[gnutls.git] / lib / includes / gnutls / gnutls.h.in
blobe60914e68681c279d0ac976bb22e03b6aab4c03c
1 /* -*- c -*-
2 * Copyright (C) 2000-2012 Free Software Foundation, Inc.
4 * Author: Nikos Mavrogiannopoulos
6 * This file is part of GnuTLS.
8 * The GnuTLS is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 3 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>
23 /* This file contains the types and prototypes for all the
24 * high level functionality of the gnutls main library.
26 * If the optional C++ binding was built, it is available in
27 * gnutls/gnutlsxx.h.
29 * The openssl compatibility layer (which is under the GNU GPL
30 * license) is in gnutls/openssl.h.
32 * The low level cipher functionality is in gnutls/crypto.h.
36 #ifndef GNUTLS_H
37 #define GNUTLS_H
39 /* Get size_t. */
40 #include <stddef.h>
41 /* Get ssize_t. */
42 #ifndef HAVE_SSIZE_T
43 #define HAVE_SSIZE_T
44 /* *INDENT-OFF* */
45 @DEFINE_SSIZE_T@
46 /* *INDENT-ON* */
47 #endif
48 /* Get time_t. */
49 #include <time.h>
50 #ifdef __cplusplus
51 extern "C"
53 #endif
55 #define GNUTLS_VERSION "@VERSION@"
57 #define GNUTLS_VERSION_MAJOR @MAJOR_VERSION@
58 #define GNUTLS_VERSION_MINOR @MINOR_VERSION@
59 #define GNUTLS_VERSION_PATCH @PATCH_VERSION@
61 #define GNUTLS_VERSION_NUMBER @NUMBER_VERSION@
63 #define GNUTLS_CIPHER_RIJNDAEL_128_CBC GNUTLS_CIPHER_AES_128_CBC
64 #define GNUTLS_CIPHER_RIJNDAEL_256_CBC GNUTLS_CIPHER_AES_256_CBC
65 #define GNUTLS_CIPHER_RIJNDAEL_CBC GNUTLS_CIPHER_AES_128_CBC
66 #define GNUTLS_CIPHER_ARCFOUR GNUTLS_CIPHER_ARCFOUR_128
68 /**
69 * gnutls_cipher_algorithm_t:
70 * @GNUTLS_CIPHER_UNKNOWN: Unknown algorithm.
71 * @GNUTLS_CIPHER_NULL: NULL algorithm.
72 * @GNUTLS_CIPHER_ARCFOUR_128: ARCFOUR stream cipher with 128-bit keys.
73 * @GNUTLS_CIPHER_3DES_CBC: 3DES in CBC mode.
74 * @GNUTLS_CIPHER_AES_128_CBC: AES in CBC mode with 128-bit keys.
75 * @GNUTLS_CIPHER_AES_192_CBC: AES in CBC mode with 192-bit keys.
76 * @GNUTLS_CIPHER_AES_256_CBC: AES in CBC mode with 256-bit keys.
77 * @GNUTLS_CIPHER_ARCFOUR_40: ARCFOUR stream cipher with 40-bit keys.
78 * @GNUTLS_CIPHER_CAMELLIA_128_CBC: Camellia in CBC mode with 128-bit keys.
79 * @GNUTLS_CIPHER_CAMELLIA_192_CBC: Camellia in CBC mode with 192-bit keys.
80 * @GNUTLS_CIPHER_CAMELLIA_256_CBC: Camellia in CBC mode with 256-bit keys.
81 * @GNUTLS_CIPHER_RC2_40_CBC: RC2 in CBC mode with 40-bit keys.
82 * @GNUTLS_CIPHER_DES_CBC: DES in CBC mode (56-bit keys).
83 * @GNUTLS_CIPHER_AES_128_GCM: AES in GCM mode with 128-bit keys.
84 * @GNUTLS_CIPHER_AES_256_GCM: AES in GCM mode with 256-bit keys.
85 * @GNUTLS_CIPHER_IDEA_PGP_CFB: IDEA in CFB mode.
86 * @GNUTLS_CIPHER_3DES_PGP_CFB: 3DES in CFB mode.
87 * @GNUTLS_CIPHER_CAST5_PGP_CFB: CAST5 in CFB mode.
88 * @GNUTLS_CIPHER_BLOWFISH_PGP_CFB: Blowfish in CFB mode.
89 * @GNUTLS_CIPHER_SAFER_SK128_PGP_CFB: Safer-SK in CFB mode with 128-bit keys.
90 * @GNUTLS_CIPHER_AES128_PGP_CFB: AES in CFB mode with 128-bit keys.
91 * @GNUTLS_CIPHER_AES192_PGP_CFB: AES in CFB mode with 192-bit keys.
92 * @GNUTLS_CIPHER_AES256_PGP_CFB: AES in CFB mode with 256-bit keys.
93 * @GNUTLS_CIPHER_TWOFISH_PGP_CFB: Twofish in CFB mode.
95 * Enumeration of different symmetric encryption algorithms.
97 typedef enum gnutls_cipher_algorithm
99 GNUTLS_CIPHER_UNKNOWN = 0,
100 GNUTLS_CIPHER_NULL = 1,
101 GNUTLS_CIPHER_ARCFOUR_128 = 2,
102 GNUTLS_CIPHER_3DES_CBC = 3,
103 GNUTLS_CIPHER_AES_128_CBC = 4,
104 GNUTLS_CIPHER_AES_256_CBC = 5,
105 GNUTLS_CIPHER_ARCFOUR_40 = 6,
106 GNUTLS_CIPHER_CAMELLIA_128_CBC = 7,
107 GNUTLS_CIPHER_CAMELLIA_256_CBC = 8,
108 GNUTLS_CIPHER_RC2_40_CBC = 90,
109 GNUTLS_CIPHER_DES_CBC = 91,
110 GNUTLS_CIPHER_AES_192_CBC = 92,
111 GNUTLS_CIPHER_AES_128_GCM = 93,
112 GNUTLS_CIPHER_AES_256_GCM = 94,
113 GNUTLS_CIPHER_CAMELLIA_192_CBC = 95,
115 /* used only for PGP internals. Ignored in TLS/SSL
117 GNUTLS_CIPHER_IDEA_PGP_CFB = 200,
118 GNUTLS_CIPHER_3DES_PGP_CFB = 201,
119 GNUTLS_CIPHER_CAST5_PGP_CFB = 202,
120 GNUTLS_CIPHER_BLOWFISH_PGP_CFB = 203,
121 GNUTLS_CIPHER_SAFER_SK128_PGP_CFB = 204,
122 GNUTLS_CIPHER_AES128_PGP_CFB = 205,
123 GNUTLS_CIPHER_AES192_PGP_CFB = 206,
124 GNUTLS_CIPHER_AES256_PGP_CFB = 207,
125 GNUTLS_CIPHER_TWOFISH_PGP_CFB = 208
126 } gnutls_cipher_algorithm_t;
129 * gnutls_kx_algorithm_t:
130 * @GNUTLS_KX_UNKNOWN: Unknown key-exchange algorithm.
131 * @GNUTLS_KX_RSA: RSA key-exchange algorithm.
132 * @GNUTLS_KX_DHE_DSS: DHE-DSS key-exchange algorithm.
133 * @GNUTLS_KX_DHE_RSA: DHE-RSA key-exchange algorithm.
134 * @GNUTLS_KX_ECDHE_RSA: ECDHE-RSA key-exchange algorithm.
135 * @GNUTLS_KX_ECDHE_ECDSA: ECDHE-ECDSA key-exchange algorithm.
136 * @GNUTLS_KX_ANON_DH: Anon-DH key-exchange algorithm.
137 * @GNUTLS_KX_ANON_ECDH: Anon-ECDH key-exchange algorithm.
138 * @GNUTLS_KX_SRP: SRP key-exchange algorithm.
139 * @GNUTLS_KX_RSA_EXPORT: RSA-EXPORT key-exchange algorithm.
140 * @GNUTLS_KX_SRP_RSA: SRP-RSA key-exchange algorithm.
141 * @GNUTLS_KX_SRP_DSS: SRP-DSS key-exchange algorithm.
142 * @GNUTLS_KX_PSK: PSK key-exchange algorithm.
143 * @GNUTLS_KX_DHE_PSK: DHE-PSK key-exchange algorithm.
144 * @GNUTLS_KX_ECDHE_PSK: ECDHE-PSK key-exchange algorithm.
146 * Enumeration of different key exchange algorithms.
148 typedef enum
150 GNUTLS_KX_UNKNOWN = 0,
151 GNUTLS_KX_RSA = 1,
152 GNUTLS_KX_DHE_DSS = 2,
153 GNUTLS_KX_DHE_RSA = 3,
154 GNUTLS_KX_ANON_DH = 4,
155 GNUTLS_KX_SRP = 5,
156 GNUTLS_KX_RSA_EXPORT = 6,
157 GNUTLS_KX_SRP_RSA = 7,
158 GNUTLS_KX_SRP_DSS = 8,
159 GNUTLS_KX_PSK = 9,
160 GNUTLS_KX_DHE_PSK = 10,
161 GNUTLS_KX_ANON_ECDH = 11,
162 GNUTLS_KX_ECDHE_RSA = 12,
163 GNUTLS_KX_ECDHE_ECDSA = 13,
164 GNUTLS_KX_ECDHE_PSK = 14,
165 } gnutls_kx_algorithm_t;
168 * gnutls_params_type_t:
169 * @GNUTLS_PARAMS_RSA_EXPORT: Session RSA-EXPORT parameters.
170 * @GNUTLS_PARAMS_DH: Session Diffie-Hellman parameters.
171 * @GNUTLS_PARAMS_ECDH: Session Elliptic-Curve Diffie-Hellman parameters.
173 * Enumeration of different TLS session parameter types.
175 typedef enum
177 GNUTLS_PARAMS_RSA_EXPORT = 1,
178 GNUTLS_PARAMS_DH = 2,
179 GNUTLS_PARAMS_ECDH = 3,
180 } gnutls_params_type_t;
183 * gnutls_credentials_type_t:
184 * @GNUTLS_CRD_CERTIFICATE: Certificate credential.
185 * @GNUTLS_CRD_ANON: Anonymous credential.
186 * @GNUTLS_CRD_SRP: SRP credential.
187 * @GNUTLS_CRD_PSK: PSK credential.
188 * @GNUTLS_CRD_IA: IA credential.
190 * Enumeration of different credential types.
192 typedef enum
194 GNUTLS_CRD_CERTIFICATE = 1,
195 GNUTLS_CRD_ANON,
196 GNUTLS_CRD_SRP,
197 GNUTLS_CRD_PSK,
198 GNUTLS_CRD_IA
199 } gnutls_credentials_type_t;
201 #define GNUTLS_MAC_SHA GNUTLS_MAC_SHA1
202 #define GNUTLS_DIG_SHA GNUTLS_DIG_SHA1
205 * gnutls_mac_algorithm_t:
206 * @GNUTLS_MAC_UNKNOWN: Unknown MAC algorithm.
207 * @GNUTLS_MAC_NULL: NULL MAC algorithm (empty output).
208 * @GNUTLS_MAC_MD5: HMAC-MD5 algorithm.
209 * @GNUTLS_MAC_SHA1: HMAC-SHA-1 algorithm.
210 * @GNUTLS_MAC_RMD160: HMAC-RMD160 algorithm.
211 * @GNUTLS_MAC_MD2: HMAC-MD2 algorithm.
212 * @GNUTLS_MAC_SHA256: HMAC-SHA-256 algorithm.
213 * @GNUTLS_MAC_SHA384: HMAC-SHA-384 algorithm.
214 * @GNUTLS_MAC_SHA512: HMAC-SHA-512 algorithm.
215 * @GNUTLS_MAC_SHA224: HMAC-SHA-224 algorithm.
216 * @GNUTLS_MAC_AEAD: MAC implicit through AEAD cipher.
218 * Enumeration of different Message Authentication Code (MAC)
219 * algorithms.
221 typedef enum
223 GNUTLS_MAC_UNKNOWN = 0,
224 GNUTLS_MAC_NULL = 1,
225 GNUTLS_MAC_MD5 = 2,
226 GNUTLS_MAC_SHA1 = 3,
227 GNUTLS_MAC_RMD160 = 4,
228 GNUTLS_MAC_MD2 = 5,
229 GNUTLS_MAC_SHA256 = 6,
230 GNUTLS_MAC_SHA384 = 7,
231 GNUTLS_MAC_SHA512 = 8,
232 GNUTLS_MAC_SHA224 = 9,
233 /* If you add anything here, make sure you align with
234 gnutls_digest_algorithm_t. */
235 GNUTLS_MAC_AEAD = 200 /* indicates that MAC is on the cipher */
236 } gnutls_mac_algorithm_t;
239 * gnutls_digest_algorithm_t:
240 * @GNUTLS_DIG_UNKNOWN: Unknown hash algorithm.
241 * @GNUTLS_DIG_NULL: NULL hash algorithm (empty output).
242 * @GNUTLS_DIG_MD5: MD5 algorithm.
243 * @GNUTLS_DIG_SHA1: SHA-1 algorithm.
244 * @GNUTLS_DIG_RMD160: RMD160 algorithm.
245 * @GNUTLS_DIG_MD2: MD2 algorithm.
246 * @GNUTLS_DIG_SHA256: SHA-256 algorithm.
247 * @GNUTLS_DIG_SHA384: SHA-384 algorithm.
248 * @GNUTLS_DIG_SHA512: SHA-512 algorithm.
249 * @GNUTLS_DIG_SHA224: SHA-224 algorithm.
251 * Enumeration of different digest (hash) algorithms.
253 typedef enum
255 GNUTLS_DIG_UNKNOWN = GNUTLS_MAC_UNKNOWN,
256 GNUTLS_DIG_NULL = GNUTLS_MAC_NULL,
257 GNUTLS_DIG_MD5 = GNUTLS_MAC_MD5,
258 GNUTLS_DIG_SHA1 = GNUTLS_MAC_SHA1,
259 GNUTLS_DIG_RMD160 = GNUTLS_MAC_RMD160,
260 GNUTLS_DIG_MD2 = GNUTLS_MAC_MD2,
261 GNUTLS_DIG_SHA256 = GNUTLS_MAC_SHA256,
262 GNUTLS_DIG_SHA384 = GNUTLS_MAC_SHA384,
263 GNUTLS_DIG_SHA512 = GNUTLS_MAC_SHA512,
264 GNUTLS_DIG_SHA224 = GNUTLS_MAC_SHA224
265 /* If you add anything here, make sure you align with
266 gnutls_mac_algorithm_t. */
267 } gnutls_digest_algorithm_t;
269 /* exported for other gnutls headers. This is the maximum number of
270 * algorithms (ciphers, kx or macs).
272 #define GNUTLS_MAX_ALGORITHM_NUM 32
275 * gnutls_compression_method_t:
276 * @GNUTLS_COMP_UNKNOWN: Unknown compression method.
277 * @GNUTLS_COMP_NULL: The NULL compression method (no compression).
278 * @GNUTLS_COMP_DEFLATE: The DEFLATE compression method from zlib.
279 * @GNUTLS_COMP_ZLIB: Same as %GNUTLS_COMP_DEFLATE.
281 * Enumeration of different TLS compression methods.
283 typedef enum
285 GNUTLS_COMP_UNKNOWN = 0,
286 GNUTLS_COMP_NULL = 1,
287 GNUTLS_COMP_DEFLATE = 2,
288 GNUTLS_COMP_ZLIB = GNUTLS_COMP_DEFLATE,
289 } gnutls_compression_method_t;
292 * Flags for gnutls_init()
294 * @GNUTLS_SERVER: Connection end is a server.
295 * @GNUTLS_CLIENT: Connection end is a client.
296 * @GNUTLS_DATAGRAM: Connection is datagram oriented (DTLS).
297 * @GNUTLS_NONBLOCK: Connection should not block (DTLS).
298 * @GNUTLS_NO_EXTENSIONS: Do not enable any TLS extensions by default.
301 #define GNUTLS_SERVER 1
302 #define GNUTLS_CLIENT (1<<1)
303 #define GNUTLS_DATAGRAM (1<<2)
304 #define GNUTLS_NONBLOCK (1<<3)
305 #define GNUTLS_NO_EXTENSIONS (1<<4)
308 * gnutls_alert_level_t:
309 * @GNUTLS_AL_WARNING: Alert of warning severity.
310 * @GNUTLS_AL_FATAL: Alert of fatal severity.
312 * Enumeration of different TLS alert severities.
314 typedef enum
316 GNUTLS_AL_WARNING = 1,
317 GNUTLS_AL_FATAL
318 } gnutls_alert_level_t;
321 * gnutls_alert_description_t:
322 * @GNUTLS_A_CLOSE_NOTIFY: Close notify.
323 * @GNUTLS_A_UNEXPECTED_MESSAGE: Unexpected message.
324 * @GNUTLS_A_BAD_RECORD_MAC: Bad record MAC.
325 * @GNUTLS_A_DECRYPTION_FAILED: Decryption failed.
326 * @GNUTLS_A_RECORD_OVERFLOW: Record overflow.
327 * @GNUTLS_A_DECOMPRESSION_FAILURE: Decompression failed.
328 * @GNUTLS_A_HANDSHAKE_FAILURE: Handshake failed.
329 * @GNUTLS_A_SSL3_NO_CERTIFICATE: No certificate.
330 * @GNUTLS_A_BAD_CERTIFICATE: Certificate is bad.
331 * @GNUTLS_A_UNSUPPORTED_CERTIFICATE: Certificate is not supported.
332 * @GNUTLS_A_CERTIFICATE_REVOKED: Certificate was revoked.
333 * @GNUTLS_A_CERTIFICATE_EXPIRED: Certificate is expired.
334 * @GNUTLS_A_CERTIFICATE_UNKNOWN: Unknown certificate.
335 * @GNUTLS_A_ILLEGAL_PARAMETER: Illegal parameter.
336 * @GNUTLS_A_UNKNOWN_CA: CA is unknown.
337 * @GNUTLS_A_ACCESS_DENIED: Access was denied.
338 * @GNUTLS_A_DECODE_ERROR: Decode error.
339 * @GNUTLS_A_DECRYPT_ERROR: Decrypt error.
340 * @GNUTLS_A_EXPORT_RESTRICTION: Export restriction.
341 * @GNUTLS_A_PROTOCOL_VERSION: Error in protocol version.
342 * @GNUTLS_A_INSUFFICIENT_SECURITY: Insufficient security.
343 * @GNUTLS_A_USER_CANCELED: User canceled.
344 * @GNUTLS_A_INTERNAL_ERROR: Internal error.
345 * @GNUTLS_A_NO_RENEGOTIATION: No renegotiation is allowed.
346 * @GNUTLS_A_CERTIFICATE_UNOBTAINABLE: Could not retrieve the
347 * specified certificate.
348 * @GNUTLS_A_UNSUPPORTED_EXTENSION: An unsupported extension was
349 * sent.
350 * @GNUTLS_A_UNRECOGNIZED_NAME: The server name sent was not
351 * recognized.
352 * @GNUTLS_A_UNKNOWN_PSK_IDENTITY: The SRP/PSK username is missing
353 * or not known.
355 * Enumeration of different TLS alerts.
357 typedef enum
359 GNUTLS_A_CLOSE_NOTIFY,
360 GNUTLS_A_UNEXPECTED_MESSAGE = 10,
361 GNUTLS_A_BAD_RECORD_MAC = 20,
362 GNUTLS_A_DECRYPTION_FAILED,
363 GNUTLS_A_RECORD_OVERFLOW,
364 GNUTLS_A_DECOMPRESSION_FAILURE = 30,
365 GNUTLS_A_HANDSHAKE_FAILURE = 40,
366 GNUTLS_A_SSL3_NO_CERTIFICATE = 41,
367 GNUTLS_A_BAD_CERTIFICATE = 42,
368 GNUTLS_A_UNSUPPORTED_CERTIFICATE,
369 GNUTLS_A_CERTIFICATE_REVOKED,
370 GNUTLS_A_CERTIFICATE_EXPIRED,
371 GNUTLS_A_CERTIFICATE_UNKNOWN,
372 GNUTLS_A_ILLEGAL_PARAMETER,
373 GNUTLS_A_UNKNOWN_CA,
374 GNUTLS_A_ACCESS_DENIED,
375 GNUTLS_A_DECODE_ERROR = 50,
376 GNUTLS_A_DECRYPT_ERROR,
377 GNUTLS_A_EXPORT_RESTRICTION = 60,
378 GNUTLS_A_PROTOCOL_VERSION = 70,
379 GNUTLS_A_INSUFFICIENT_SECURITY,
380 GNUTLS_A_INTERNAL_ERROR = 80,
381 GNUTLS_A_USER_CANCELED = 90,
382 GNUTLS_A_NO_RENEGOTIATION = 100,
383 GNUTLS_A_UNSUPPORTED_EXTENSION = 110,
384 GNUTLS_A_CERTIFICATE_UNOBTAINABLE = 111,
385 GNUTLS_A_UNRECOGNIZED_NAME = 112,
386 GNUTLS_A_UNKNOWN_PSK_IDENTITY = 115,
387 } gnutls_alert_description_t;
390 * gnutls_handshake_description_t:
391 * @GNUTLS_HANDSHAKE_HELLO_REQUEST: Hello request.
392 * @GNUTLS_HANDSHAKE_HELLO_VERIFY_REQUEST: DTLS Hello verify request.
393 * @GNUTLS_HANDSHAKE_CLIENT_HELLO: Client hello.
394 * @GNUTLS_HANDSHAKE_SERVER_HELLO: Server hello.
395 * @GNUTLS_HANDSHAKE_NEW_SESSION_TICKET: New session ticket.
396 * @GNUTLS_HANDSHAKE_CERTIFICATE_PKT: Certificate packet.
397 * @GNUTLS_HANDSHAKE_SERVER_KEY_EXCHANGE: Server key exchange.
398 * @GNUTLS_HANDSHAKE_CERTIFICATE_REQUEST: Certificate request.
399 * @GNUTLS_HANDSHAKE_SERVER_HELLO_DONE: Server hello done.
400 * @GNUTLS_HANDSHAKE_CERTIFICATE_VERIFY: Certificate verify.
401 * @GNUTLS_HANDSHAKE_CLIENT_KEY_EXCHANGE: Client key exchange.
402 * @GNUTLS_HANDSHAKE_FINISHED: Finished.
403 * @GNUTLS_HANDSHAKE_CERTIFICATE_STATUS: Certificate status (OCSP).
404 * @GNUTLS_HANDSHAKE_SUPPLEMENTAL: Supplemental.
405 * @GNUTLS_HANDSHAKE_CHANGE_CIPHER_SPEC: Change Cipher Spec.
406 * @GNUTLS_HANDSHAKE_CLIENT_HELLO_V2: SSLv2 Client Hello.
408 * Enumeration of different TLS handshake packets.
410 typedef enum
412 GNUTLS_HANDSHAKE_HELLO_REQUEST = 0,
413 GNUTLS_HANDSHAKE_CLIENT_HELLO = 1,
414 GNUTLS_HANDSHAKE_SERVER_HELLO = 2,
415 GNUTLS_HANDSHAKE_HELLO_VERIFY_REQUEST = 3,
416 GNUTLS_HANDSHAKE_NEW_SESSION_TICKET = 4,
417 GNUTLS_HANDSHAKE_CERTIFICATE_PKT = 11,
418 GNUTLS_HANDSHAKE_SERVER_KEY_EXCHANGE = 12,
419 GNUTLS_HANDSHAKE_CERTIFICATE_REQUEST = 13,
420 GNUTLS_HANDSHAKE_SERVER_HELLO_DONE = 14,
421 GNUTLS_HANDSHAKE_CERTIFICATE_VERIFY = 15,
422 GNUTLS_HANDSHAKE_CLIENT_KEY_EXCHANGE = 16,
423 GNUTLS_HANDSHAKE_FINISHED = 20,
424 GNUTLS_HANDSHAKE_CERTIFICATE_STATUS = 22,
425 GNUTLS_HANDSHAKE_SUPPLEMENTAL = 23,
426 GNUTLS_HANDSHAKE_CHANGE_CIPHER_SPEC = 254,
427 GNUTLS_HANDSHAKE_CLIENT_HELLO_V2 = 1024,
428 } gnutls_handshake_description_t;
431 * gnutls_certificate_status_t:
432 * @GNUTLS_CERT_INVALID: The certificate is not signed by one of the
433 * known authorities or the signature is invalid.
434 * @GNUTLS_CERT_SIGNATURE_FAILURE: The signature verification failed.
435 * @GNUTLS_CERT_REVOKED: Certificate is revoked by its authority. In X.509 this will be
436 * set only if CRLs are checked.
437 * @GNUTLS_CERT_SIGNER_NOT_FOUND: The certificate's issuer is not known.
438 * This is the case if the issuer is not included in the trusted certificate list.
439 * @GNUTLS_CERT_SIGNER_NOT_CA: The certificate's signer was not a CA. This
440 * may happen if this was a version 1 certificate, which is common with
441 * some CAs, or a version 3 certificate without the basic constrains extension.
442 * @GNUTLS_CERT_INSECURE_ALGORITHM: The certificate was signed using an insecure
443 * algorithm such as MD2 or MD5. These algorithms have been broken and
444 * should not be trusted.
445 * @GNUTLS_CERT_NOT_ACTIVATED: The certificate is not yet activated.
446 * @GNUTLS_CERT_EXPIRED: The certificate has expired.
447 * @GNUTLS_CERT_REVOCATION_DATA_TOO_OLD: The OCSP revocation data are too old.
448 * @GNUTLS_CERT_REVOCATION_DATA_INVALID: The OCSP revocation data are invalid.
450 * Enumeration of certificate status codes. Note that the status
451 * bits may have different meanings in OpenPGP keys and X.509
452 * certificate verification.
454 typedef enum
456 GNUTLS_CERT_INVALID = 2,
457 GNUTLS_CERT_REVOKED = 32,
458 GNUTLS_CERT_SIGNER_NOT_FOUND = 64,
459 GNUTLS_CERT_SIGNER_NOT_CA = 128,
460 GNUTLS_CERT_INSECURE_ALGORITHM = 256,
461 GNUTLS_CERT_NOT_ACTIVATED = 512,
462 GNUTLS_CERT_EXPIRED = 1024,
463 GNUTLS_CERT_SIGNATURE_FAILURE = 2048,
464 GNUTLS_CERT_REVOCATION_DATA_TOO_OLD = 4096,
465 GNUTLS_CERT_REVOCATION_DATA_INVALID = 8192,
466 } gnutls_certificate_status_t;
469 * gnutls_certificate_request_t:
470 * @GNUTLS_CERT_IGNORE: Ignore certificate.
471 * @GNUTLS_CERT_REQUEST: Request certificate.
472 * @GNUTLS_CERT_REQUIRE: Require certificate.
474 * Enumeration of certificate request types.
476 typedef enum
478 GNUTLS_CERT_IGNORE = 0,
479 GNUTLS_CERT_REQUEST = 1,
480 GNUTLS_CERT_REQUIRE = 2
481 } gnutls_certificate_request_t;
484 * gnutls_openpgp_crt_status_t:
485 * @GNUTLS_OPENPGP_CERT: Send entire certificate.
486 * @GNUTLS_OPENPGP_CERT_FINGERPRINT: Send only certificate fingerprint.
488 * Enumeration of ways to send OpenPGP certificate.
490 typedef enum
492 GNUTLS_OPENPGP_CERT = 0,
493 GNUTLS_OPENPGP_CERT_FINGERPRINT = 1
494 } gnutls_openpgp_crt_status_t;
497 * gnutls_close_request_t:
498 * @GNUTLS_SHUT_RDWR: Disallow further receives/sends.
499 * @GNUTLS_SHUT_WR: Disallow further sends.
501 * Enumeration of how TLS session should be terminated. See gnutls_bye().
503 typedef enum
505 GNUTLS_SHUT_RDWR = 0,
506 GNUTLS_SHUT_WR = 1
507 } gnutls_close_request_t;
510 * gnutls_protocol_t:
511 * @GNUTLS_SSL3: SSL version 3.0.
512 * @GNUTLS_TLS1_0: TLS version 1.0.
513 * @GNUTLS_TLS1: Same as %GNUTLS_TLS1_0.
514 * @GNUTLS_TLS1_1: TLS version 1.1.
515 * @GNUTLS_TLS1_2: TLS version 1.2.
516 * @GNUTLS_DTLS1_0: DTLS version 1.0.
517 * @GNUTLS_DTLS0_9: DTLS version 0.9 (Cisco AnyConnect / OpenSSL 0.9.8e).
518 * @GNUTLS_VERSION_MAX: Maps to the highest supported TLS version.
519 * @GNUTLS_VERSION_UNKNOWN: Unknown SSL/TLS version.
521 * Enumeration of different SSL/TLS protocol versions.
523 typedef enum
525 GNUTLS_SSL3 = 1,
526 GNUTLS_TLS1_0 = 2,
527 GNUTLS_TLS1 = GNUTLS_TLS1_0,
528 GNUTLS_TLS1_1 = 3,
529 GNUTLS_TLS1_2 = 4,
530 GNUTLS_DTLS1_0 = 5,
531 GNUTLS_DTLS0_9 = 6,
532 GNUTLS_VERSION_MAX = GNUTLS_DTLS0_9,
533 GNUTLS_VERSION_UNKNOWN = 0xff
534 } gnutls_protocol_t;
537 * gnutls_certificate_type_t:
538 * @GNUTLS_CRT_UNKNOWN: Unknown certificate type.
539 * @GNUTLS_CRT_X509: X.509 Certificate.
540 * @GNUTLS_CRT_OPENPGP: OpenPGP certificate.
541 * @GNUTLS_CRT_RAW: Raw public key (SubjectPublicKey)
543 * Enumeration of different certificate types.
545 typedef enum
547 GNUTLS_CRT_UNKNOWN = 0,
548 GNUTLS_CRT_X509 = 1,
549 GNUTLS_CRT_OPENPGP = 2,
550 GNUTLS_CRT_RAW = 3
551 } gnutls_certificate_type_t;
554 * gnutls_x509_crt_fmt_t:
555 * @GNUTLS_X509_FMT_DER: X.509 certificate in DER format (binary).
556 * @GNUTLS_X509_FMT_PEM: X.509 certificate in PEM format (text).
558 * Enumeration of different certificate encoding formats.
560 typedef enum
562 GNUTLS_X509_FMT_DER = 0,
563 GNUTLS_X509_FMT_PEM = 1
564 } gnutls_x509_crt_fmt_t;
567 * gnutls_certificate_print_formats_t:
568 * @GNUTLS_CRT_PRINT_FULL: Full information about certificate.
569 * @GNUTLS_CRT_PRINT_COMPACT: Information about certificate name in one line, plus identification of the public key.
570 * @GNUTLS_CRT_PRINT_ONELINE: Information about certificate in one line.
571 * @GNUTLS_CRT_PRINT_UNSIGNED_FULL: All info for an unsigned certificate.
573 * Enumeration of different certificate printing variants.
575 typedef enum gnutls_certificate_print_formats
577 GNUTLS_CRT_PRINT_FULL = 0,
578 GNUTLS_CRT_PRINT_ONELINE = 1,
579 GNUTLS_CRT_PRINT_UNSIGNED_FULL = 2,
580 GNUTLS_CRT_PRINT_COMPACT = 3
581 } gnutls_certificate_print_formats_t;
583 #define GNUTLS_PK_ECC GNUTLS_PK_EC
585 * gnutls_pk_algorithm_t:
586 * @GNUTLS_PK_UNKNOWN: Unknown public-key algorithm.
587 * @GNUTLS_PK_RSA: RSA public-key algorithm.
588 * @GNUTLS_PK_DSA: DSA public-key algorithm.
589 * @GNUTLS_PK_DH: Diffie-Hellman algorithm. Used to generate parameters.
590 * @GNUTLS_PK_EC: Elliptic curve algorithm. Used to generate parameters.
592 * Enumeration of different public-key algorithms.
594 typedef enum
596 GNUTLS_PK_UNKNOWN = 0,
597 GNUTLS_PK_RSA = 1,
598 GNUTLS_PK_DSA = 2,
599 GNUTLS_PK_DH = 3,
600 GNUTLS_PK_EC = 4,
601 } gnutls_pk_algorithm_t;
603 const char *gnutls_pk_algorithm_get_name (gnutls_pk_algorithm_t algorithm);
606 * gnutls_sign_algorithm_t:
607 * @GNUTLS_SIGN_UNKNOWN: Unknown signature algorithm.
608 * @GNUTLS_SIGN_RSA_SHA1: Digital signature algorithm RSA with SHA-1
609 * @GNUTLS_SIGN_RSA_SHA: Same as %GNUTLS_SIGN_RSA_SHA1.
610 * @GNUTLS_SIGN_DSA_SHA1: Digital signature algorithm DSA with SHA-1
611 * @GNUTLS_SIGN_DSA_SHA224: Digital signature algorithm DSA with SHA-224
612 * @GNUTLS_SIGN_DSA_SHA256: Digital signature algorithm DSA with SHA-256
613 * @GNUTLS_SIGN_DSA_SHA: Same as %GNUTLS_SIGN_DSA_SHA1.
614 * @GNUTLS_SIGN_RSA_MD5: Digital signature algorithm RSA with MD5.
615 * @GNUTLS_SIGN_RSA_MD2: Digital signature algorithm RSA with MD2.
616 * @GNUTLS_SIGN_RSA_RMD160: Digital signature algorithm RSA with RMD-160.
617 * @GNUTLS_SIGN_RSA_SHA256: Digital signature algorithm RSA with SHA-256.
618 * @GNUTLS_SIGN_RSA_SHA384: Digital signature algorithm RSA with SHA-384.
619 * @GNUTLS_SIGN_RSA_SHA512: Digital signature algorithm RSA with SHA-512.
620 * @GNUTLS_SIGN_RSA_SHA224: Digital signature algorithm RSA with SHA-224.
621 * @GNUTLS_SIGN_ECDSA_SHA1: ECDSA with SHA1.
622 * @GNUTLS_SIGN_ECDSA_SHA256: Digital signature algorithm ECDSA with SHA-256.
623 * @GNUTLS_SIGN_ECDSA_SHA384: Digital signature algorithm ECDSA with SHA-384.
624 * @GNUTLS_SIGN_ECDSA_SHA512: Digital signature algorithm ECDSA with SHA-512.
625 * @GNUTLS_SIGN_ECDSA_SHA224: Digital signature algorithm ECDSA with SHA-224.
627 * Enumeration of different digital signature algorithms.
629 typedef enum
631 GNUTLS_SIGN_UNKNOWN = 0,
632 GNUTLS_SIGN_RSA_SHA1 = 1,
633 GNUTLS_SIGN_RSA_SHA = GNUTLS_SIGN_RSA_SHA1,
634 GNUTLS_SIGN_DSA_SHA1 = 2,
635 GNUTLS_SIGN_DSA_SHA = GNUTLS_SIGN_DSA_SHA1,
636 GNUTLS_SIGN_RSA_MD5 = 3,
637 GNUTLS_SIGN_RSA_MD2 = 4,
638 GNUTLS_SIGN_RSA_RMD160 = 5,
639 GNUTLS_SIGN_RSA_SHA256 = 6,
640 GNUTLS_SIGN_RSA_SHA384 = 7,
641 GNUTLS_SIGN_RSA_SHA512 = 8,
642 GNUTLS_SIGN_RSA_SHA224 = 9,
643 GNUTLS_SIGN_DSA_SHA224 = 10,
644 GNUTLS_SIGN_DSA_SHA256 = 11,
645 GNUTLS_SIGN_ECDSA_SHA1 = 12,
646 GNUTLS_SIGN_ECDSA_SHA224 = 13,
647 GNUTLS_SIGN_ECDSA_SHA256 = 14,
648 GNUTLS_SIGN_ECDSA_SHA384 = 15,
649 GNUTLS_SIGN_ECDSA_SHA512 = 16,
650 } gnutls_sign_algorithm_t;
653 * gnutls_ecc_curve_t:
654 * @GNUTLS_ECC_CURVE_INVALID: Cannot be known
655 * @GNUTLS_ECC_CURVE_SECP192R1: the SECP192R1 curve
656 * @GNUTLS_ECC_CURVE_SECP224R1: the SECP224R1 curve
657 * @GNUTLS_ECC_CURVE_SECP256R1: the SECP256R1 curve
658 * @GNUTLS_ECC_CURVE_SECP384R1: the SECP384R1 curve
659 * @GNUTLS_ECC_CURVE_SECP521R1: the SECP521R1 curve
661 * Enumeration of ECC curves.
663 typedef enum
665 GNUTLS_ECC_CURVE_INVALID=0,
666 GNUTLS_ECC_CURVE_SECP224R1,
667 GNUTLS_ECC_CURVE_SECP256R1,
668 GNUTLS_ECC_CURVE_SECP384R1,
669 GNUTLS_ECC_CURVE_SECP521R1,
670 GNUTLS_ECC_CURVE_SECP192R1,
671 } gnutls_ecc_curve_t;
674 * gnutls_sec_param_t:
675 * @GNUTLS_SEC_PARAM_INSECURE: Less than 72 bits of security
676 * @GNUTLS_SEC_PARAM_WEAK: 72 bits of security
677 * @GNUTLS_SEC_PARAM_UNKNOWN: Cannot be known
678 * @GNUTLS_SEC_PARAM_LOW: 80 bits of security
679 * @GNUTLS_SEC_PARAM_LEGACY: 96 bits of security
680 * @GNUTLS_SEC_PARAM_NORMAL: 112 bits of security
681 * @GNUTLS_SEC_PARAM_HIGH: 128 bits of security
682 * @GNUTLS_SEC_PARAM_ULTRA: 192 bits of security
684 * Enumeration of security parameters for passive attacks.
686 typedef enum
688 GNUTLS_SEC_PARAM_INSECURE = -20,
689 GNUTLS_SEC_PARAM_WEAK = -10,
690 GNUTLS_SEC_PARAM_UNKNOWN = 0,
691 GNUTLS_SEC_PARAM_LOW = 1,
692 GNUTLS_SEC_PARAM_LEGACY = 2,
693 GNUTLS_SEC_PARAM_NORMAL = 3,
694 GNUTLS_SEC_PARAM_HIGH = 4,
695 GNUTLS_SEC_PARAM_ULTRA = 5,
696 } gnutls_sec_param_t;
699 * gnutls_channel_binding_t:
700 * @GNUTLS_CB_TLS_UNIQUE: "tls-unique" (RFC 5929) channel binding
702 * Enumeration of support channel binding types.
704 typedef enum
706 GNUTLS_CB_TLS_UNIQUE
707 } gnutls_channel_binding_t;
710 /* If you want to change this, then also change the define in
711 * gnutls_int.h, and recompile.
713 typedef void *gnutls_transport_ptr_t;
715 struct gnutls_session_int;
716 typedef struct gnutls_session_int *gnutls_session_t;
718 struct gnutls_dh_params_int;
719 typedef struct gnutls_dh_params_int *gnutls_dh_params_t;
721 struct gnutls_ecdh_params_int;
722 typedef struct gnutls_ecdh_params_int *gnutls_ecdh_params_t;
724 /* XXX ugly. */
725 struct gnutls_x509_privkey_int;
726 typedef struct gnutls_x509_privkey_int *gnutls_rsa_params_t;
728 struct gnutls_priority_st;
729 typedef struct gnutls_priority_st *gnutls_priority_t;
731 typedef struct
733 unsigned char *data;
734 unsigned int size;
735 } gnutls_datum_t;
738 typedef struct gnutls_params_st
740 gnutls_params_type_t type;
741 union params
743 gnutls_dh_params_t dh;
744 gnutls_ecdh_params_t ecdh;
745 gnutls_rsa_params_t rsa_export;
746 } params;
747 int deinit;
748 } gnutls_params_st;
750 typedef int gnutls_params_function (gnutls_session_t, gnutls_params_type_t,
751 gnutls_params_st *);
753 /* internal functions */
755 int gnutls_init (gnutls_session_t * session,
756 unsigned int flags);
757 void gnutls_deinit (gnutls_session_t session);
758 #define _gnutls_deinit(x) gnutls_deinit(x)
760 int gnutls_bye (gnutls_session_t session, gnutls_close_request_t how);
762 int gnutls_handshake (gnutls_session_t session);
764 #define GNUTLS_DEFAULT_HANDSHAKE_TIMEOUT ((unsigned int)-1)
765 void gnutls_handshake_set_timeout (gnutls_session_t session,
766 unsigned int ms);
767 int gnutls_rehandshake (gnutls_session_t session);
769 gnutls_alert_description_t gnutls_alert_get (gnutls_session_t session);
770 int gnutls_alert_send (gnutls_session_t session,
771 gnutls_alert_level_t level,
772 gnutls_alert_description_t desc);
773 int gnutls_alert_send_appropriate (gnutls_session_t session, int err);
774 const char *gnutls_alert_get_name (gnutls_alert_description_t alert);
775 const char * gnutls_alert_get_strname (gnutls_alert_description_t alert);
777 gnutls_sec_param_t gnutls_pk_bits_to_sec_param (gnutls_pk_algorithm_t algo,
778 unsigned int bits);
779 const char *gnutls_sec_param_get_name (gnutls_sec_param_t param);
780 unsigned int gnutls_sec_param_to_pk_bits (gnutls_pk_algorithm_t algo,
781 gnutls_sec_param_t param);
783 /* Elliptic curves */
784 const char * gnutls_ecc_curve_get_name (gnutls_ecc_curve_t curve);
785 int gnutls_ecc_curve_get_size (gnutls_ecc_curve_t curve);
786 gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session);
788 /* get information on the current session */
789 gnutls_cipher_algorithm_t gnutls_cipher_get (gnutls_session_t session);
790 gnutls_kx_algorithm_t gnutls_kx_get (gnutls_session_t session);
791 gnutls_mac_algorithm_t gnutls_mac_get (gnutls_session_t session);
792 gnutls_compression_method_t
793 gnutls_compression_get (gnutls_session_t session);
794 gnutls_certificate_type_t
795 gnutls_certificate_type_get (gnutls_session_t session);
797 int gnutls_sign_algorithm_get (gnutls_session_t session);
799 int gnutls_sign_algorithm_get_requested (gnutls_session_t session,
800 size_t indx,
801 gnutls_sign_algorithm_t * algo);
803 size_t gnutls_cipher_get_key_size (gnutls_cipher_algorithm_t algorithm);
804 size_t gnutls_mac_get_key_size (gnutls_mac_algorithm_t algorithm);
806 /* the name of the specified algorithms */
807 const char *gnutls_cipher_get_name (gnutls_cipher_algorithm_t algorithm);
808 const char *gnutls_mac_get_name (gnutls_mac_algorithm_t algorithm);
809 const char *gnutls_compression_get_name (gnutls_compression_method_t
810 algorithm);
811 const char *gnutls_kx_get_name (gnutls_kx_algorithm_t algorithm);
812 const char *gnutls_certificate_type_get_name (gnutls_certificate_type_t
813 type);
814 const char *gnutls_pk_get_name (gnutls_pk_algorithm_t algorithm);
815 const char *gnutls_sign_get_name (gnutls_sign_algorithm_t algorithm);
816 gnutls_digest_algorithm_t
817 gnutls_sign_get_hash_algorithm (gnutls_sign_algorithm_t sign);
818 gnutls_pk_algorithm_t
819 gnutls_sign_get_pk_algorithm (gnutls_sign_algorithm_t sign);
820 gnutls_sign_algorithm_t
821 gnutls_pk_to_sign (gnutls_pk_algorithm_t pk,
822 gnutls_digest_algorithm_t hash);
824 #define gnutls_sign_algorithm_get_name gnutls_sign_get_name
826 gnutls_mac_algorithm_t gnutls_mac_get_id (const char *name);
827 gnutls_compression_method_t gnutls_compression_get_id (const char *name);
828 gnutls_cipher_algorithm_t gnutls_cipher_get_id (const char *name);
829 gnutls_kx_algorithm_t gnutls_kx_get_id (const char *name);
830 gnutls_protocol_t gnutls_protocol_get_id (const char *name);
831 gnutls_certificate_type_t gnutls_certificate_type_get_id (const char *name);
832 gnutls_pk_algorithm_t gnutls_pk_get_id (const char *name);
833 gnutls_sign_algorithm_t gnutls_sign_get_id (const char *name);
835 /* list supported algorithms */
836 const gnutls_ecc_curve_t * gnutls_ecc_curve_list (void);
837 const gnutls_cipher_algorithm_t *gnutls_cipher_list (void);
838 const gnutls_mac_algorithm_t *gnutls_mac_list (void);
839 const gnutls_compression_method_t *gnutls_compression_list (void);
840 const gnutls_protocol_t *gnutls_protocol_list (void);
841 const gnutls_certificate_type_t *gnutls_certificate_type_list (void);
842 const gnutls_kx_algorithm_t *gnutls_kx_list (void);
843 const gnutls_pk_algorithm_t *gnutls_pk_list (void);
844 const gnutls_sign_algorithm_t *gnutls_sign_list (void);
845 const char *gnutls_cipher_suite_info (size_t idx,
846 unsigned char *cs_id,
847 gnutls_kx_algorithm_t * kx,
848 gnutls_cipher_algorithm_t * cipher,
849 gnutls_mac_algorithm_t * mac,
850 gnutls_protocol_t * min_version);
852 /* error functions */
853 int gnutls_error_is_fatal (int error);
854 int gnutls_error_to_alert (int err, int *level);
856 void gnutls_perror (int error);
857 const char *gnutls_strerror (int error);
858 const char *gnutls_strerror_name (int error);
860 /* Semi-internal functions.
862 void gnutls_handshake_set_private_extensions (gnutls_session_t session,
863 int allow);
864 gnutls_handshake_description_t
865 gnutls_handshake_get_last_out (gnutls_session_t session);
866 gnutls_handshake_description_t
867 gnutls_handshake_get_last_in (gnutls_session_t session);
869 /* Record layer functions.
871 #define GNUTLS_HEARTBEAT_WAIT 1
872 int gnutls_heartbeat_ping (gnutls_session_t session, size_t data_size,
873 unsigned int max_tries, unsigned int flags);
874 int gnutls_heartbeat_pong (gnutls_session_t session, unsigned int flags);
876 ssize_t gnutls_record_send (gnutls_session_t session, const void *data,
877 size_t data_size);
878 ssize_t gnutls_record_recv (gnutls_session_t session, void *data,
879 size_t data_size);
880 #define gnutls_read gnutls_record_recv
881 #define gnutls_write gnutls_record_send
882 ssize_t gnutls_record_recv_seq (gnutls_session_t session, void *data, size_t data_size,
883 unsigned char *seq);
885 void gnutls_session_enable_compatibility_mode (gnutls_session_t session);
887 void gnutls_record_disable_padding (gnutls_session_t session);
889 int gnutls_record_get_direction (gnutls_session_t session);
891 size_t gnutls_record_get_max_size (gnutls_session_t session);
892 ssize_t gnutls_record_set_max_size (gnutls_session_t session, size_t size);
894 size_t gnutls_record_check_pending (gnutls_session_t session);
896 int gnutls_prf (gnutls_session_t session,
897 size_t label_size, const char *label,
898 int server_random_first,
899 size_t extra_size, const char *extra,
900 size_t outsize, char *out);
902 int gnutls_prf_raw (gnutls_session_t session,
903 size_t label_size, const char *label,
904 size_t seed_size, const char *seed,
905 size_t outsize, char *out);
908 * gnutls_server_name_type_t:
909 * @GNUTLS_NAME_DNS: Domain Name System name type.
911 * Enumeration of different server name types.
913 typedef enum
915 GNUTLS_NAME_DNS = 1
916 } gnutls_server_name_type_t;
918 int gnutls_server_name_set (gnutls_session_t session,
919 gnutls_server_name_type_t type,
920 const void *name, size_t name_length);
922 int gnutls_server_name_get (gnutls_session_t session,
923 void *data, size_t * data_length,
924 unsigned int *type, unsigned int indx);
926 unsigned int gnutls_heartbeat_get_timeout (gnutls_session_t session);
927 void gnutls_heartbeat_set_timeouts (gnutls_session_t session, unsigned int retrans_timeout,
928 unsigned int total_timeout);
930 #define GNUTLS_HB_PEER_ALLOWED_TO_SEND (1)
931 #define GNUTLS_HB_PEER_NOT_ALLOWED_TO_SEND (1<<1)
933 /* Heartbeat */
934 void gnutls_heartbeat_enable (gnutls_session_t session, unsigned int type);
936 #define GNUTLS_HB_LOCAL_ALLOWED_TO_SEND (1<<2)
937 int gnutls_heartbeat_allowed (gnutls_session_t session, unsigned int type);
939 /* Safe renegotiation */
940 int gnutls_safe_renegotiation_status (gnutls_session_t session);
943 * gnutls_supplemental_data_format_type_t:
944 * @GNUTLS_SUPPLEMENTAL_USER_MAPPING_DATA: Supplemental user mapping data.
946 * Enumeration of different supplemental data types (RFC 4680).
948 typedef enum
950 GNUTLS_SUPPLEMENTAL_USER_MAPPING_DATA = 0
951 } gnutls_supplemental_data_format_type_t;
953 const char
954 *gnutls_supplemental_get_name (gnutls_supplemental_data_format_type_t
955 type);
957 /* SessionTicket, RFC 5077. */
958 int gnutls_session_ticket_key_generate (gnutls_datum_t * key);
959 int gnutls_session_ticket_enable_client (gnutls_session_t session);
960 int gnutls_session_ticket_enable_server (gnutls_session_t session,
961 const gnutls_datum_t * key);
963 int gnutls_key_generate (gnutls_datum_t * key, unsigned int key_size);
965 /* if you just want some defaults, use the following.
967 int gnutls_priority_init (gnutls_priority_t * priority_cache,
968 const char *priorities, const char **err_pos);
969 void gnutls_priority_deinit (gnutls_priority_t priority_cache);
970 int gnutls_priority_get_cipher_suite_index (gnutls_priority_t pcache, unsigned int idx, unsigned int *sidx);
972 int gnutls_priority_set (gnutls_session_t session,
973 gnutls_priority_t priority);
974 int gnutls_priority_set_direct (gnutls_session_t session,
975 const char *priorities,
976 const char **err_pos);
978 int gnutls_priority_certificate_type_list (gnutls_priority_t pcache, const unsigned int** list);
979 int gnutls_priority_sign_list (gnutls_priority_t pcache, const unsigned int** list);
980 int gnutls_priority_protocol_list (gnutls_priority_t pcache, const unsigned int** list);
981 int gnutls_priority_compression_list (gnutls_priority_t pcache, const unsigned int** list);
982 int gnutls_priority_ecc_curve_list (gnutls_priority_t pcache, const unsigned int** list);
984 /* for compatibility
986 int gnutls_set_default_priority (gnutls_session_t session);
988 /* Returns the name of a cipher suite */
989 const char *gnutls_cipher_suite_get_name (gnutls_kx_algorithm_t
990 kx_algorithm,
991 gnutls_cipher_algorithm_t
992 cipher_algorithm,
993 gnutls_mac_algorithm_t
994 mac_algorithm);
996 /* get the currently used protocol version */
997 gnutls_protocol_t gnutls_protocol_get_version (gnutls_session_t session);
999 const char *gnutls_protocol_get_name (gnutls_protocol_t version);
1002 /* get/set session
1004 int gnutls_session_set_data (gnutls_session_t session,
1005 const void *session_data,
1006 size_t session_data_size);
1007 int gnutls_session_get_data (gnutls_session_t session, void *session_data,
1008 size_t * session_data_size);
1009 int gnutls_session_get_data2 (gnutls_session_t session,
1010 gnutls_datum_t * data);
1011 void gnutls_session_get_random (gnutls_session_t session, gnutls_datum_t* client,
1012 gnutls_datum_t* server);
1014 int gnutls_session_set_premaster (gnutls_session_t session, unsigned int entity,
1015 gnutls_protocol_t version,
1016 gnutls_kx_algorithm_t kx,
1017 gnutls_cipher_algorithm_t cipher,
1018 gnutls_mac_algorithm_t mac,
1019 gnutls_compression_method_t comp,
1020 const gnutls_datum_t* master,
1021 const gnutls_datum_t * session_id);
1023 /* returns the session ID */
1024 #define GNUTLS_MAX_SESSION_ID 32
1025 int gnutls_session_get_id (gnutls_session_t session, void *session_id,
1026 size_t * session_id_size);
1027 int gnutls_session_get_id2 (gnutls_session_t session, gnutls_datum_t *session_id);
1029 int gnutls_session_channel_binding (gnutls_session_t session,
1030 gnutls_channel_binding_t cbtype,
1031 gnutls_datum_t * cb);
1033 /* checks if this session is a resumed one
1035 int gnutls_session_is_resumed (gnutls_session_t session);
1036 int gnutls_session_resumption_requested (gnutls_session_t session);
1038 typedef int (*gnutls_db_store_func) (void *, gnutls_datum_t key,
1039 gnutls_datum_t data);
1040 typedef int (*gnutls_db_remove_func) (void *, gnutls_datum_t key);
1041 typedef gnutls_datum_t (*gnutls_db_retr_func) (void *, gnutls_datum_t key);
1043 void gnutls_db_set_cache_expiration (gnutls_session_t session, int seconds);
1045 void gnutls_db_remove_session (gnutls_session_t session);
1046 void gnutls_db_set_retrieve_function (gnutls_session_t session,
1047 gnutls_db_retr_func retr_func);
1048 void gnutls_db_set_remove_function (gnutls_session_t session,
1049 gnutls_db_remove_func rem_func);
1050 void gnutls_db_set_store_function (gnutls_session_t session,
1051 gnutls_db_store_func store_func);
1052 void gnutls_db_set_ptr (gnutls_session_t session, void *ptr);
1053 void *gnutls_db_get_ptr (gnutls_session_t session);
1054 int gnutls_db_check_entry (gnutls_session_t session,
1055 gnutls_datum_t session_entry);
1057 typedef int (*gnutls_handshake_post_client_hello_func) (gnutls_session_t);
1058 void
1059 gnutls_handshake_set_post_client_hello_function (gnutls_session_t session,
1060 gnutls_handshake_post_client_hello_func
1061 func);
1063 void gnutls_handshake_set_max_packet_length (gnutls_session_t session,
1064 size_t max);
1066 /* returns libgnutls version (call it with a NULL argument)
1068 const char *gnutls_check_version (const char *req_version);
1070 /* Functions for setting/clearing credentials
1072 void gnutls_credentials_clear (gnutls_session_t session);
1074 /* cred is a structure defined by the kx algorithm
1076 int gnutls_credentials_set (gnutls_session_t session,
1077 gnutls_credentials_type_t type, void *cred);
1078 #define gnutls_cred_set gnutls_credentials_set
1080 /* x.509 types */
1082 struct gnutls_x509_privkey_int;
1083 typedef struct gnutls_x509_privkey_int *gnutls_x509_privkey_t;
1085 struct gnutls_x509_crl_int;
1086 typedef struct gnutls_x509_crl_int *gnutls_x509_crl_t;
1088 struct gnutls_x509_crt_int;
1089 typedef struct gnutls_x509_crt_int *gnutls_x509_crt_t;
1091 struct gnutls_x509_crq_int;
1092 typedef struct gnutls_x509_crq_int *gnutls_x509_crq_t;
1094 struct gnutls_openpgp_keyring_int;
1095 typedef struct gnutls_openpgp_keyring_int *gnutls_openpgp_keyring_t;
1098 /* Credential structures - used in gnutls_credentials_set(); */
1100 struct gnutls_certificate_credentials_st;
1101 typedef struct gnutls_certificate_credentials_st
1102 *gnutls_certificate_credentials_t;
1103 typedef gnutls_certificate_credentials_t
1104 gnutls_certificate_server_credentials;
1105 typedef gnutls_certificate_credentials_t
1106 gnutls_certificate_client_credentials;
1108 typedef struct gnutls_anon_server_credentials_st
1109 *gnutls_anon_server_credentials_t;
1110 typedef struct gnutls_anon_client_credentials_st
1111 *gnutls_anon_client_credentials_t;
1113 void gnutls_anon_free_server_credentials (gnutls_anon_server_credentials_t
1114 sc);
1116 gnutls_anon_allocate_server_credentials (gnutls_anon_server_credentials_t
1117 * sc);
1119 void gnutls_anon_set_server_dh_params (gnutls_anon_server_credentials_t res,
1120 gnutls_dh_params_t dh_params);
1122 void
1123 gnutls_anon_set_server_params_function (gnutls_anon_server_credentials_t
1124 res,
1125 gnutls_params_function * func);
1127 void
1128 gnutls_anon_free_client_credentials (gnutls_anon_client_credentials_t sc);
1130 gnutls_anon_allocate_client_credentials (gnutls_anon_client_credentials_t
1131 * sc);
1133 /* CERTFILE is an x509 certificate in PEM form.
1134 * KEYFILE is a pkcs-1 private key in PEM form (for RSA keys).
1136 void
1137 gnutls_certificate_free_credentials (gnutls_certificate_credentials_t sc);
1139 gnutls_certificate_allocate_credentials (gnutls_certificate_credentials_t
1140 * res);
1143 gnutls_certificate_get_issuer (gnutls_certificate_credentials_t sc,
1144 gnutls_x509_crt_t cert, gnutls_x509_crt_t* issuer, unsigned int flags);
1146 void gnutls_certificate_free_keys (gnutls_certificate_credentials_t sc);
1147 void gnutls_certificate_free_cas (gnutls_certificate_credentials_t sc);
1148 void gnutls_certificate_free_ca_names (gnutls_certificate_credentials_t sc);
1149 void gnutls_certificate_free_crls (gnutls_certificate_credentials_t sc);
1151 void gnutls_certificate_set_dh_params (gnutls_certificate_credentials_t res,
1152 gnutls_dh_params_t dh_params);
1153 void gnutls_certificate_set_verify_flags (gnutls_certificate_credentials_t
1154 res, unsigned int flags);
1155 void gnutls_certificate_set_verify_limits (gnutls_certificate_credentials_t
1156 res, unsigned int max_bits,
1157 unsigned int max_depth);
1160 gnutls_certificate_set_x509_system_trust (gnutls_certificate_credentials_t cred);
1163 gnutls_certificate_set_x509_trust_file (gnutls_certificate_credentials_t
1164 cred, const char *cafile,
1165 gnutls_x509_crt_fmt_t type);
1166 int gnutls_certificate_set_x509_trust_mem (gnutls_certificate_credentials_t
1167 res, const gnutls_datum_t * ca,
1168 gnutls_x509_crt_fmt_t type);
1171 gnutls_certificate_set_x509_crl_file (gnutls_certificate_credentials_t
1172 res, const char *crlfile,
1173 gnutls_x509_crt_fmt_t type);
1174 int gnutls_certificate_set_x509_crl_mem (gnutls_certificate_credentials_t
1175 res, const gnutls_datum_t * CRL,
1176 gnutls_x509_crt_fmt_t type);
1179 gnutls_certificate_set_x509_key_file (gnutls_certificate_credentials_t
1180 res, const char *certfile,
1181 const char *keyfile,
1182 gnutls_x509_crt_fmt_t type);
1184 int gnutls_certificate_set_x509_key_mem (gnutls_certificate_credentials_t
1185 res, const gnutls_datum_t * cert,
1186 const gnutls_datum_t * key,
1187 gnutls_x509_crt_fmt_t type);
1189 void gnutls_certificate_send_x509_rdn_sequence (gnutls_session_t session,
1190 int status);
1192 int gnutls_certificate_set_x509_simple_pkcs12_file (gnutls_certificate_credentials_t res, const char *pkcs12file,
1193 gnutls_x509_crt_fmt_t type, const char *password);
1194 int gnutls_certificate_set_x509_simple_pkcs12_mem (gnutls_certificate_credentials_t res, const gnutls_datum_t * p12blob,
1195 gnutls_x509_crt_fmt_t type, const char *password);
1197 /* New functions to allow setting already parsed X.509 stuff.
1200 int gnutls_certificate_set_x509_key (gnutls_certificate_credentials_t res,
1201 gnutls_x509_crt_t * cert_list,
1202 int cert_list_size,
1203 gnutls_x509_privkey_t key);
1204 int gnutls_certificate_set_x509_trust (gnutls_certificate_credentials_t res,
1205 gnutls_x509_crt_t * ca_list,
1206 int ca_list_size);
1207 int gnutls_certificate_set_x509_crl (gnutls_certificate_credentials_t res,
1208 gnutls_x509_crl_t * crl_list,
1209 int crl_list_size);
1211 /* OCSP status request extension, RFC 6066 */
1212 typedef int (*gnutls_status_request_ocsp_func)
1213 (gnutls_session_t session, void *ptr, gnutls_datum_t *ocsp_response);
1215 void gnutls_certificate_set_ocsp_status_request_function (gnutls_certificate_credentials_t res,
1216 gnutls_status_request_ocsp_func ocsp_func,
1217 void *ptr);
1219 int gnutls_certificate_set_ocsp_status_request_file (gnutls_certificate_credentials_t res,
1220 const char* response_file, unsigned int flags);
1222 int gnutls_ocsp_status_request_enable_client (gnutls_session_t session,
1223 gnutls_datum_t *responder_id,
1224 size_t responder_id_size,
1225 gnutls_datum_t *request_extensions);
1227 int gnutls_ocsp_status_request_get (gnutls_session_t session, gnutls_datum_t *response);
1230 /* global state functions
1232 int gnutls_global_init (void);
1233 void gnutls_global_deinit (void);
1236 * gnutls_time_func:
1237 * @t: where to store time.
1239 * Function prototype for time()-like function. Set with
1240 * gnutls_global_set_time_function().
1242 * Returns: Number of seconds since the epoch, or (time_t)-1 on errors.
1244 typedef time_t (*gnutls_time_func) (time_t *t);
1246 typedef int (*mutex_init_func) (void **mutex);
1247 typedef int (*mutex_lock_func) (void **mutex);
1248 typedef int (*mutex_unlock_func) (void **mutex);
1249 typedef int (*mutex_deinit_func) (void **mutex);
1251 void gnutls_global_set_mutex (mutex_init_func init, mutex_deinit_func deinit,
1252 mutex_lock_func lock, mutex_unlock_func unlock);
1254 typedef void *(*gnutls_alloc_function) (size_t);
1255 typedef void *(*gnutls_calloc_function) (size_t, size_t);
1256 typedef int (*gnutls_is_secure_function) (const void *);
1257 typedef void (*gnutls_free_function) (void *);
1258 typedef void *(*gnutls_realloc_function) (void *, size_t);
1260 void
1261 gnutls_global_set_mem_functions (gnutls_alloc_function alloc_func,
1262 gnutls_alloc_function secure_alloc_func,
1263 gnutls_is_secure_function is_secure_func,
1264 gnutls_realloc_function realloc_func,
1265 gnutls_free_function free_func);
1267 void gnutls_global_set_time_function (gnutls_time_func time_func);
1269 /* For use in callbacks */
1270 extern gnutls_alloc_function gnutls_malloc;
1271 extern gnutls_alloc_function gnutls_secure_malloc;
1272 extern gnutls_realloc_function gnutls_realloc;
1273 extern gnutls_calloc_function gnutls_calloc;
1274 extern gnutls_free_function gnutls_free;
1276 extern char *(*gnutls_strdup) (const char *);
1278 typedef void (*gnutls_log_func) (int, const char *);
1279 typedef void (*gnutls_audit_log_func) (gnutls_session_t, const char *);
1280 void gnutls_global_set_log_function (gnutls_log_func log_func);
1281 void gnutls_global_set_audit_log_function (gnutls_audit_log_func log_func);
1282 void gnutls_global_set_log_level (int level);
1284 /* Diffie-Hellman parameter handling.
1286 int gnutls_dh_params_init (gnutls_dh_params_t * dh_params);
1287 void gnutls_dh_params_deinit (gnutls_dh_params_t dh_params);
1288 int gnutls_dh_params_import_raw (gnutls_dh_params_t dh_params,
1289 const gnutls_datum_t * prime,
1290 const gnutls_datum_t * generator);
1291 int gnutls_dh_params_import_pkcs3 (gnutls_dh_params_t params,
1292 const gnutls_datum_t * pkcs3_params,
1293 gnutls_x509_crt_fmt_t format);
1294 int gnutls_dh_params_generate2 (gnutls_dh_params_t params,
1295 unsigned int bits);
1296 int gnutls_dh_params_export_pkcs3 (gnutls_dh_params_t params,
1297 gnutls_x509_crt_fmt_t format,
1298 unsigned char *params_data,
1299 size_t * params_data_size);
1300 int gnutls_dh_params_export2_pkcs3 (gnutls_dh_params_t params,
1301 gnutls_x509_crt_fmt_t format,
1302 gnutls_datum_t *out);
1303 int gnutls_dh_params_export_raw (gnutls_dh_params_t params,
1304 gnutls_datum_t * prime,
1305 gnutls_datum_t * generator,
1306 unsigned int *bits);
1307 int gnutls_dh_params_cpy (gnutls_dh_params_t dst, gnutls_dh_params_t src);
1311 /* Session stuff
1313 typedef struct
1315 void *iov_base; /* Starting address */
1316 size_t iov_len; /* Number of bytes to transfer */
1317 } giovec_t;
1319 typedef ssize_t (*gnutls_pull_func) (gnutls_transport_ptr_t, void *,
1320 size_t);
1321 typedef ssize_t (*gnutls_push_func) (gnutls_transport_ptr_t, const void *,
1322 size_t);
1324 typedef int (*gnutls_pull_timeout_func) (gnutls_transport_ptr_t, unsigned int ms);
1326 typedef ssize_t (*gnutls_vec_push_func) (gnutls_transport_ptr_t,
1327 const giovec_t * iov, int iovcnt);
1329 typedef int (*gnutls_errno_func) (gnutls_transport_ptr_t);
1331 void gnutls_transport_set_ptr (gnutls_session_t session,
1332 gnutls_transport_ptr_t ptr);
1333 void gnutls_transport_set_ptr2 (gnutls_session_t session,
1334 gnutls_transport_ptr_t recv_ptr,
1335 gnutls_transport_ptr_t send_ptr);
1337 gnutls_transport_ptr_t gnutls_transport_get_ptr (gnutls_session_t session);
1338 void gnutls_transport_get_ptr2 (gnutls_session_t session,
1339 gnutls_transport_ptr_t * recv_ptr,
1340 gnutls_transport_ptr_t * send_ptr);
1342 void gnutls_transport_set_vec_push_function (gnutls_session_t session,
1343 gnutls_vec_push_func vec_func);
1344 void gnutls_transport_set_push_function (gnutls_session_t session,
1345 gnutls_push_func push_func);
1346 void gnutls_transport_set_pull_function (gnutls_session_t session,
1347 gnutls_pull_func pull_func);
1349 void gnutls_transport_set_pull_timeout_function (gnutls_session_t session,
1350 gnutls_pull_timeout_func func);
1352 void gnutls_transport_set_errno_function (gnutls_session_t session,
1353 gnutls_errno_func errno_func);
1355 void gnutls_transport_set_errno (gnutls_session_t session, int err);
1357 /* session specific
1359 void gnutls_session_set_ptr (gnutls_session_t session, void *ptr);
1360 void *gnutls_session_get_ptr (gnutls_session_t session);
1362 void gnutls_openpgp_send_cert (gnutls_session_t session,
1363 gnutls_openpgp_crt_status_t status);
1365 /* This function returns the hash of the given data.
1367 int gnutls_fingerprint (gnutls_digest_algorithm_t algo,
1368 const gnutls_datum_t * data, void *result,
1369 size_t * result_size);
1372 * gnutls_random_art_t:
1373 * @GNUTLS_RANDOM_ART_OPENSSH: OpenSSH-style random art.
1375 * Enumeration of different random art types.
1377 typedef enum gnutls_random_art
1379 GNUTLS_RANDOM_ART_OPENSSH=1,
1380 } gnutls_random_art_t;
1382 int gnutls_random_art (gnutls_random_art_t type,
1383 const char* key_type, unsigned int key_size,
1384 void * fpr, size_t fpr_size,
1385 gnutls_datum_t* art);
1387 /* SRP
1390 typedef struct gnutls_srp_server_credentials_st
1391 *gnutls_srp_server_credentials_t;
1392 typedef struct gnutls_srp_client_credentials_st
1393 *gnutls_srp_client_credentials_t;
1395 void
1396 gnutls_srp_free_client_credentials (gnutls_srp_client_credentials_t sc);
1398 gnutls_srp_allocate_client_credentials (gnutls_srp_client_credentials_t *
1399 sc);
1400 int gnutls_srp_set_client_credentials (gnutls_srp_client_credentials_t res,
1401 const char *username,
1402 const char *password);
1404 void
1405 gnutls_srp_free_server_credentials (gnutls_srp_server_credentials_t sc);
1407 gnutls_srp_allocate_server_credentials (gnutls_srp_server_credentials_t *
1408 sc);
1409 int gnutls_srp_set_server_credentials_file (gnutls_srp_server_credentials_t
1410 res, const char *password_file,
1411 const char *password_conf_file);
1413 const char *gnutls_srp_server_get_username (gnutls_session_t session);
1415 extern void gnutls_srp_set_prime_bits (gnutls_session_t session,
1416 unsigned int bits);
1418 int gnutls_srp_verifier (const char *username,
1419 const char *password,
1420 const gnutls_datum_t * salt,
1421 const gnutls_datum_t * generator,
1422 const gnutls_datum_t * prime,
1423 gnutls_datum_t * res);
1425 /* The static parameters defined in draft-ietf-tls-srp-05
1426 * Those should be used as input to gnutls_srp_verifier().
1428 extern const gnutls_datum_t gnutls_srp_4096_group_prime;
1429 extern const gnutls_datum_t gnutls_srp_4096_group_generator;
1431 extern const gnutls_datum_t gnutls_srp_3072_group_prime;
1432 extern const gnutls_datum_t gnutls_srp_3072_group_generator;
1434 extern const gnutls_datum_t gnutls_srp_2048_group_prime;
1435 extern const gnutls_datum_t gnutls_srp_2048_group_generator;
1437 extern const gnutls_datum_t gnutls_srp_1536_group_prime;
1438 extern const gnutls_datum_t gnutls_srp_1536_group_generator;
1440 extern const gnutls_datum_t gnutls_srp_1024_group_prime;
1441 extern const gnutls_datum_t gnutls_srp_1024_group_generator;
1443 typedef int gnutls_srp_server_credentials_function (gnutls_session_t,
1444 const char *username,
1445 gnutls_datum_t * salt,
1446 gnutls_datum_t *
1447 verifier,
1448 gnutls_datum_t *
1449 generator,
1450 gnutls_datum_t * prime);
1451 void
1452 gnutls_srp_set_server_credentials_function (
1453 gnutls_srp_server_credentials_t cred,
1454 gnutls_srp_server_credentials_function * func);
1456 typedef int gnutls_srp_client_credentials_function (gnutls_session_t,
1457 char **, char **);
1458 void
1459 gnutls_srp_set_client_credentials_function (
1460 gnutls_srp_client_credentials_t cred,
1461 gnutls_srp_client_credentials_function * func);
1463 int gnutls_srp_base64_encode (const gnutls_datum_t * data, char *result,
1464 size_t * result_size);
1465 int gnutls_srp_base64_encode_alloc (const gnutls_datum_t * data,
1466 gnutls_datum_t * result);
1468 int gnutls_srp_base64_decode (const gnutls_datum_t * b64_data, char *result,
1469 size_t * result_size);
1470 int gnutls_srp_base64_decode_alloc (const gnutls_datum_t * b64_data,
1471 gnutls_datum_t * result);
1473 /* PSK stuff */
1474 typedef struct gnutls_psk_server_credentials_st
1475 *gnutls_psk_server_credentials_t;
1476 typedef struct gnutls_psk_client_credentials_st
1477 *gnutls_psk_client_credentials_t;
1480 * gnutls_psk_key_flags:
1481 * @GNUTLS_PSK_KEY_RAW: PSK-key in raw format.
1482 * @GNUTLS_PSK_KEY_HEX: PSK-key in hex format.
1484 * Enumeration of different PSK key flags.
1486 typedef enum gnutls_psk_key_flags
1488 GNUTLS_PSK_KEY_RAW = 0,
1489 GNUTLS_PSK_KEY_HEX
1490 } gnutls_psk_key_flags;
1492 void
1493 gnutls_psk_free_client_credentials (gnutls_psk_client_credentials_t sc);
1495 gnutls_psk_allocate_client_credentials (gnutls_psk_client_credentials_t *
1496 sc);
1497 int gnutls_psk_set_client_credentials (gnutls_psk_client_credentials_t res,
1498 const char *username,
1499 const gnutls_datum_t * key,
1500 gnutls_psk_key_flags flags);
1502 void
1503 gnutls_psk_free_server_credentials (gnutls_psk_server_credentials_t sc);
1505 gnutls_psk_allocate_server_credentials (gnutls_psk_server_credentials_t *
1506 sc);
1507 int gnutls_psk_set_server_credentials_file (gnutls_psk_server_credentials_t
1508 res, const char *password_file);
1511 gnutls_psk_set_server_credentials_hint (gnutls_psk_server_credentials_t
1512 res, const char *hint);
1514 const char *gnutls_psk_server_get_username (gnutls_session_t session);
1515 const char *gnutls_psk_client_get_hint (gnutls_session_t session);
1517 typedef int gnutls_psk_server_credentials_function (gnutls_session_t,
1518 const char *username,
1519 gnutls_datum_t * key);
1520 void
1521 gnutls_psk_set_server_credentials_function (
1522 gnutls_psk_server_credentials_t cred,
1523 gnutls_psk_server_credentials_function * func);
1525 typedef int gnutls_psk_client_credentials_function (gnutls_session_t,
1526 char **username,
1527 gnutls_datum_t * key);
1528 void
1529 gnutls_psk_set_client_credentials_function (
1530 gnutls_psk_client_credentials_t cred,
1531 gnutls_psk_client_credentials_function * func);
1533 int gnutls_hex_encode (const gnutls_datum_t * data, char *result,
1534 size_t * result_size);
1535 int gnutls_hex_decode (const gnutls_datum_t * hex_data, void *result,
1536 size_t * result_size);
1538 void
1539 gnutls_psk_set_server_dh_params (gnutls_psk_server_credentials_t res,
1540 gnutls_dh_params_t dh_params);
1542 void
1543 gnutls_psk_set_server_params_function (gnutls_psk_server_credentials_t
1544 res,
1545 gnutls_params_function * func);
1548 * gnutls_x509_subject_alt_name_t:
1549 * @GNUTLS_SAN_DNSNAME: DNS-name SAN.
1550 * @GNUTLS_SAN_RFC822NAME: E-mail address SAN.
1551 * @GNUTLS_SAN_URI: URI SAN.
1552 * @GNUTLS_SAN_IPADDRESS: IP address SAN.
1553 * @GNUTLS_SAN_OTHERNAME: OtherName SAN.
1554 * @GNUTLS_SAN_DN: DN SAN.
1555 * @GNUTLS_SAN_OTHERNAME_XMPP: Virtual SAN, used by
1556 * gnutls_x509_crt_get_subject_alt_othername_oid.
1558 * Enumeration of different subject alternative names types.
1560 typedef enum gnutls_x509_subject_alt_name_t
1562 GNUTLS_SAN_DNSNAME = 1,
1563 GNUTLS_SAN_RFC822NAME = 2,
1564 GNUTLS_SAN_URI = 3,
1565 GNUTLS_SAN_IPADDRESS = 4,
1566 GNUTLS_SAN_OTHERNAME = 5,
1567 GNUTLS_SAN_DN = 6,
1568 /* The following are "virtual" subject alternative name types, in
1569 that they are represented by an otherName value and an OID.
1570 Used by gnutls_x509_crt_get_subject_alt_othername_oid. */
1571 GNUTLS_SAN_OTHERNAME_XMPP = 1000
1572 } gnutls_x509_subject_alt_name_t;
1574 struct gnutls_openpgp_crt_int;
1575 typedef struct gnutls_openpgp_crt_int *gnutls_openpgp_crt_t;
1577 struct gnutls_openpgp_privkey_int;
1578 typedef struct gnutls_openpgp_privkey_int *gnutls_openpgp_privkey_t;
1580 struct gnutls_pkcs11_privkey_st;
1581 typedef struct gnutls_pkcs11_privkey_st *gnutls_pkcs11_privkey_t;
1584 * gnutls_privkey_type_t:
1585 * @GNUTLS_PRIVKEY_X509: X.509 private key, #gnutls_x509_privkey_t.
1586 * @GNUTLS_PRIVKEY_OPENPGP: OpenPGP private key, #gnutls_openpgp_privkey_t.
1587 * @GNUTLS_PRIVKEY_PKCS11: PKCS11 private key, #gnutls_pkcs11_privkey_t.
1588 * @GNUTLS_PRIVKEY_EXT: External private key, operating using callbacks.
1590 * Enumeration of different private key types.
1592 typedef enum
1594 GNUTLS_PRIVKEY_X509,
1595 GNUTLS_PRIVKEY_OPENPGP,
1596 GNUTLS_PRIVKEY_PKCS11,
1597 GNUTLS_PRIVKEY_EXT
1598 } gnutls_privkey_type_t;
1600 typedef struct gnutls_retr2_st
1602 gnutls_certificate_type_t cert_type;
1603 gnutls_privkey_type_t key_type;
1605 union
1607 gnutls_x509_crt_t *x509;
1608 gnutls_openpgp_crt_t pgp;
1609 } cert;
1610 unsigned int ncerts; /* one for pgp keys */
1612 union
1614 gnutls_x509_privkey_t x509;
1615 gnutls_openpgp_privkey_t pgp;
1616 gnutls_pkcs11_privkey_t pkcs11;
1617 } key;
1619 unsigned int deinit_all; /* if non zero all keys will be deinited */
1620 } gnutls_retr2_st;
1623 /* Functions that allow auth_info_t structures handling
1626 gnutls_credentials_type_t gnutls_auth_get_type (gnutls_session_t session);
1627 gnutls_credentials_type_t
1628 gnutls_auth_server_get_type (gnutls_session_t session);
1629 gnutls_credentials_type_t
1630 gnutls_auth_client_get_type (gnutls_session_t session);
1632 /* DH */
1634 void gnutls_dh_set_prime_bits (gnutls_session_t session, unsigned int bits);
1635 int gnutls_dh_get_secret_bits (gnutls_session_t session);
1636 int gnutls_dh_get_peers_public_bits (gnutls_session_t session);
1637 int gnutls_dh_get_prime_bits (gnutls_session_t session);
1639 int gnutls_dh_get_group (gnutls_session_t session, gnutls_datum_t * raw_gen,
1640 gnutls_datum_t * raw_prime);
1641 int gnutls_dh_get_pubkey (gnutls_session_t session,
1642 gnutls_datum_t * raw_key);
1644 /* X509PKI */
1647 /* These are set on the credentials structure.
1650 /* use gnutls_certificate_set_retrieve_function2() in abstract.h
1651 * instead. It's much more efficient.
1654 typedef int gnutls_certificate_retrieve_function (gnutls_session_t,
1655 const
1656 gnutls_datum_t *
1657 req_ca_rdn,
1658 int nreqs,
1659 const
1660 gnutls_pk_algorithm_t
1661 * pk_algos,
1663 pk_algos_length,
1664 gnutls_retr2_st *);
1667 void gnutls_certificate_set_retrieve_function (
1668 gnutls_certificate_credentials_t cred,
1669 gnutls_certificate_retrieve_function * func);
1671 typedef int gnutls_certificate_verify_function (gnutls_session_t);
1672 void
1673 gnutls_certificate_set_verify_function (gnutls_certificate_credentials_t
1674 cred,
1675 gnutls_certificate_verify_function
1676 * func);
1678 void
1679 gnutls_certificate_server_set_request (gnutls_session_t session,
1680 gnutls_certificate_request_t req);
1682 /* get data from the session
1684 const gnutls_datum_t *gnutls_certificate_get_peers (gnutls_session_t
1685 session,
1686 unsigned int
1687 *list_size);
1688 const gnutls_datum_t *gnutls_certificate_get_ours (gnutls_session_t
1689 session);
1691 int gnutls_certificate_get_peers_subkey_id(gnutls_session_t session,
1692 gnutls_datum_t *id);
1694 time_t gnutls_certificate_activation_time_peers (gnutls_session_t session);
1695 time_t gnutls_certificate_expiration_time_peers (gnutls_session_t session);
1697 int gnutls_certificate_client_get_request_status (gnutls_session_t session);
1698 int gnutls_certificate_verify_peers2 (gnutls_session_t session,
1699 unsigned int *status);
1701 int gnutls_pem_base64_encode (const char *msg, const gnutls_datum_t * data,
1702 char *result, size_t * result_size);
1703 int gnutls_pem_base64_decode (const char *header,
1704 const gnutls_datum_t * b64_data,
1705 unsigned char *result, size_t * result_size);
1707 int gnutls_pem_base64_encode_alloc (const char *msg,
1708 const gnutls_datum_t * data,
1709 gnutls_datum_t * result);
1710 int gnutls_pem_base64_decode_alloc (const char *header,
1711 const gnutls_datum_t * b64_data,
1712 gnutls_datum_t * result);
1714 /* key_usage will be an OR of the following values:
1717 /* when the key is to be used for signing: */
1718 #define GNUTLS_KEY_DIGITAL_SIGNATURE 128
1719 #define GNUTLS_KEY_NON_REPUDIATION 64
1720 /* when the key is to be used for encryption: */
1721 #define GNUTLS_KEY_KEY_ENCIPHERMENT 32
1722 #define GNUTLS_KEY_DATA_ENCIPHERMENT 16
1723 #define GNUTLS_KEY_KEY_AGREEMENT 8
1724 #define GNUTLS_KEY_KEY_CERT_SIGN 4
1725 #define GNUTLS_KEY_CRL_SIGN 2
1726 #define GNUTLS_KEY_ENCIPHER_ONLY 1
1727 #define GNUTLS_KEY_DECIPHER_ONLY 32768
1729 void
1730 gnutls_certificate_set_params_function (gnutls_certificate_credentials_t
1731 res,
1732 gnutls_params_function * func);
1733 void gnutls_anon_set_params_function (gnutls_anon_server_credentials_t res,
1734 gnutls_params_function * func);
1735 void gnutls_psk_set_params_function (gnutls_psk_server_credentials_t res,
1736 gnutls_params_function * func);
1738 int gnutls_hex2bin (const char *hex_data, size_t hex_size,
1739 void *bin_data, size_t * bin_size);
1741 /* Trust on first use (or ssh like) functions */
1743 /* stores the provided information to a database
1745 typedef int (*gnutls_tdb_store_func) (const char* db_name,
1746 const char* host,
1747 const char* service,
1748 time_t expiration,
1749 const gnutls_datum_t* pubkey);
1751 typedef int (*gnutls_tdb_store_commitment_func) (const char* db_name,
1752 const char* host,
1753 const char* service,
1754 time_t expiration,
1755 gnutls_digest_algorithm_t hash_algo,
1756 const gnutls_datum_t* hash);
1758 /* searches for the provided host/service pair that match the
1759 * provided public key in the database. */
1760 typedef int (*gnutls_tdb_verify_func) (const char* db_name,
1761 const char* host,
1762 const char* service,
1763 const gnutls_datum_t *pubkey);
1766 struct gnutls_tdb_int;
1767 typedef struct gnutls_tdb_int *gnutls_tdb_t;
1769 int gnutls_tdb_init (gnutls_tdb_t *tdb);
1770 void gnutls_tdb_set_store_func (gnutls_tdb_t tdb,
1771 gnutls_tdb_store_func store);
1772 void gnutls_tdb_set_store_commitment_func (gnutls_tdb_t tdb,
1773 gnutls_tdb_store_commitment_func cstore);
1774 void gnutls_tdb_set_verify_func (gnutls_tdb_t tdb,
1775 gnutls_tdb_verify_func verify);
1776 void gnutls_tdb_deinit (gnutls_tdb_t tdb);
1778 int gnutls_verify_stored_pubkey (const char* db_name,
1779 gnutls_tdb_t tdb,
1780 const char* host,
1781 const char* service,
1782 gnutls_certificate_type_t cert_type,
1783 const gnutls_datum_t * cert,
1784 unsigned int flags);
1786 int gnutls_store_commitment (const char* db_name,
1787 gnutls_tdb_t tdb,
1788 const char* host,
1789 const char* service,
1790 gnutls_digest_algorithm_t hash_algo,
1791 const gnutls_datum_t* hash,
1792 time_t expiration,
1793 unsigned int flags);
1795 int gnutls_store_pubkey (const char* db_name,
1796 gnutls_tdb_t tdb,
1797 const char* host,
1798 const char* service,
1799 gnutls_certificate_type_t cert_type,
1800 const gnutls_datum_t * cert,
1801 time_t expiration,
1802 unsigned int flags);
1804 /* Other helper functions */
1805 int gnutls_load_file(const char* filename, gnutls_datum_t * data);
1807 int gnutls_url_is_supported (const char* url);
1809 /* PIN callback */
1812 * gnutls_pin_flag_t:
1813 * @GNUTLS_PIN_USER: The PIN for the user.
1814 * @GNUTLS_PIN_SO: The PIN for the security officer (admin).
1815 * @GNUTLS_PIN_CONTEXT_SPECIFIC: The PIN is for a specific action and key like signing.
1816 * @GNUTLS_PIN_FINAL_TRY: This is the final try before blocking.
1817 * @GNUTLS_PIN_COUNT_LOW: Few tries remain before token blocks.
1818 * @GNUTLS_PIN_WRONG: Last given PIN was not correct.
1820 * Enumeration of different flags that are input to the PIN function.
1822 typedef enum
1824 GNUTLS_PIN_USER = (1 << 0),
1825 GNUTLS_PIN_SO = (1 << 1),
1826 GNUTLS_PIN_FINAL_TRY = (1 << 2),
1827 GNUTLS_PIN_COUNT_LOW = (1 << 3),
1828 GNUTLS_PIN_CONTEXT_SPECIFIC = (1 << 4),
1829 GNUTLS_PIN_WRONG = (1 << 5),
1830 } gnutls_pin_flag_t;
1832 #define GNUTLS_PKCS11_PIN_USER GNUTLS_PIN_USER
1833 #define GNUTLS_PKCS11_PIN_SO GNUTLS_PIN_SO
1834 #define GNUTLS_PKCS11_PIN_FINAL_TRY GNUTLS_PIN_FINAL_TRY
1835 #define GNUTLS_PKCS11_PIN_COUNT_LOW GNUTLS_PIN_COUNT_LOW
1836 #define GNUTLS_PKCS11_PIN_CONTEXT_SPECIFIC GNUTLS_PIN_CONTEXT_SPECIFIC
1837 #define GNUTLS_PKCS11_PIN_WRONG GNUTLS_PIN_WRONG
1840 * gnutls_pin_callback_t:
1841 * @userdata: user-controlled data from gnutls_pkcs11_set_pin_function().
1842 * @attempt: pin-attempt counter, initially 0.
1843 * @token_url: URL of token.
1844 * @token_label: label of token.
1845 * @flags: a #gnutls_pin_flag_t flag.
1846 * @pin: buffer to hold PIN, of size @pin_max.
1847 * @pin_max: size of @pin buffer.
1849 * Callback function type for PKCS#11 or TPM PIN entry. It is set by
1850 * functions like gnutls_pkcs11_set_pin_function().
1852 * The callback should provides the PIN code to unlock the token with
1853 * label @token_label, specified by the URL @token_url.
1855 * The PIN code, as a NUL-terminated ASCII string, should be copied
1856 * into the @pin buffer (of maximum size @pin_max), and return 0 to
1857 * indicate success. Alternatively, the callback may return a
1858 * negative gnutls error code to indicate failure and cancel PIN entry
1859 * (in which case, the contents of the @pin parameter are ignored).
1861 * When a PIN is required, the callback will be invoked repeatedly
1862 * (and indefinitely) until either the returned PIN code is correct,
1863 * the callback returns failure, or the token refuses login (e.g. when
1864 * the token is locked due to too many incorrect PINs!). For the
1865 * first such invocation, the @attempt counter will have value zero;
1866 * it will increase by one for each subsequent attempt.
1868 * Returns: %GNUTLS_E_SUCCESS (0) on success or a negative error code on error.
1870 * Since: 2.12.0
1872 typedef int (*gnutls_pin_callback_t) (void *userdata, int attempt,
1873 const char *token_url,
1874 const char *token_label,
1875 unsigned int flags,
1876 char *pin, size_t pin_max);
1878 void gnutls_certificate_set_pin_function (gnutls_certificate_credentials_t,
1879 gnutls_pin_callback_t fn, void *userdata);
1882 /* Gnutls error codes. The mapping to a TLS alert is also shown in
1883 * comments.
1886 #define GNUTLS_E_SUCCESS 0
1887 #define GNUTLS_E_UNKNOWN_COMPRESSION_ALGORITHM -3
1888 #define GNUTLS_E_UNKNOWN_CIPHER_TYPE -6
1889 #define GNUTLS_E_LARGE_PACKET -7
1890 #define GNUTLS_E_UNSUPPORTED_VERSION_PACKET -8 /* GNUTLS_A_PROTOCOL_VERSION */
1891 #define GNUTLS_E_UNEXPECTED_PACKET_LENGTH -9 /* GNUTLS_A_RECORD_OVERFLOW */
1892 #define GNUTLS_E_INVALID_SESSION -10
1893 #define GNUTLS_E_FATAL_ALERT_RECEIVED -12
1894 #define GNUTLS_E_UNEXPECTED_PACKET -15 /* GNUTLS_A_UNEXPECTED_MESSAGE */
1895 #define GNUTLS_E_WARNING_ALERT_RECEIVED -16
1896 #define GNUTLS_E_ERROR_IN_FINISHED_PACKET -18
1897 #define GNUTLS_E_UNEXPECTED_HANDSHAKE_PACKET -19
1898 #define GNUTLS_E_UNKNOWN_CIPHER_SUITE -21 /* GNUTLS_A_HANDSHAKE_FAILURE */
1899 #define GNUTLS_E_UNWANTED_ALGORITHM -22
1900 #define GNUTLS_E_MPI_SCAN_FAILED -23
1901 #define GNUTLS_E_DECRYPTION_FAILED -24 /* GNUTLS_A_DECRYPTION_FAILED, GNUTLS_A_BAD_RECORD_MAC */
1902 #define GNUTLS_E_MEMORY_ERROR -25
1903 #define GNUTLS_E_DECOMPRESSION_FAILED -26 /* GNUTLS_A_DECOMPRESSION_FAILURE */
1904 #define GNUTLS_E_COMPRESSION_FAILED -27
1905 #define GNUTLS_E_AGAIN -28
1906 #define GNUTLS_E_EXPIRED -29
1907 #define GNUTLS_E_DB_ERROR -30
1908 #define GNUTLS_E_SRP_PWD_ERROR -31
1909 #define GNUTLS_E_INSUFFICIENT_CREDENTIALS -32
1910 #define GNUTLS_E_INSUFICIENT_CREDENTIALS GNUTLS_E_INSUFFICIENT_CREDENTIALS /* for backwards compatibility only */
1911 #define GNUTLS_E_INSUFFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS
1912 #define GNUTLS_E_INSUFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS /* for backwards compatibility only */
1914 #define GNUTLS_E_HASH_FAILED -33
1915 #define GNUTLS_E_BASE64_DECODING_ERROR -34
1917 #define GNUTLS_E_MPI_PRINT_FAILED -35
1918 #define GNUTLS_E_REHANDSHAKE -37 /* GNUTLS_A_NO_RENEGOTIATION */
1919 #define GNUTLS_E_GOT_APPLICATION_DATA -38
1920 #define GNUTLS_E_RECORD_LIMIT_REACHED -39
1921 #define GNUTLS_E_ENCRYPTION_FAILED -40
1923 #define GNUTLS_E_PK_ENCRYPTION_FAILED -44
1924 #define GNUTLS_E_PK_DECRYPTION_FAILED -45
1925 #define GNUTLS_E_PK_SIGN_FAILED -46
1926 #define GNUTLS_E_X509_UNSUPPORTED_CRITICAL_EXTENSION -47
1927 #define GNUTLS_E_KEY_USAGE_VIOLATION -48
1928 #define GNUTLS_E_NO_CERTIFICATE_FOUND -49 /* GNUTLS_A_BAD_CERTIFICATE */
1929 #define GNUTLS_E_INVALID_REQUEST -50
1930 #define GNUTLS_E_SHORT_MEMORY_BUFFER -51
1931 #define GNUTLS_E_INTERRUPTED -52
1932 #define GNUTLS_E_PUSH_ERROR -53
1933 #define GNUTLS_E_PULL_ERROR -54
1934 #define GNUTLS_E_RECEIVED_ILLEGAL_PARAMETER -55 /* GNUTLS_A_ILLEGAL_PARAMETER */
1935 #define GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE -56
1936 #define GNUTLS_E_PKCS1_WRONG_PAD -57
1937 #define GNUTLS_E_RECEIVED_ILLEGAL_EXTENSION -58
1938 #define GNUTLS_E_INTERNAL_ERROR -59
1939 #define GNUTLS_E_DH_PRIME_UNACCEPTABLE -63
1940 #define GNUTLS_E_FILE_ERROR -64
1941 #define GNUTLS_E_TOO_MANY_EMPTY_PACKETS -78
1942 #define GNUTLS_E_UNKNOWN_PK_ALGORITHM -80
1943 #define GNUTLS_E_TOO_MANY_HANDSHAKE_PACKETS -81
1945 /* returned if you need to generate temporary RSA
1946 * parameters. These are needed for export cipher suites.
1948 #define GNUTLS_E_NO_TEMPORARY_RSA_PARAMS -84
1950 #define GNUTLS_E_NO_COMPRESSION_ALGORITHMS -86
1951 #define GNUTLS_E_NO_CIPHER_SUITES -87
1953 #define GNUTLS_E_OPENPGP_GETKEY_FAILED -88
1954 #define GNUTLS_E_PK_SIG_VERIFY_FAILED -89
1956 #define GNUTLS_E_ILLEGAL_SRP_USERNAME -90
1957 #define GNUTLS_E_SRP_PWD_PARSING_ERROR -91
1958 #define GNUTLS_E_NO_TEMPORARY_DH_PARAMS -93
1960 /* For certificate and key stuff
1962 #define GNUTLS_E_ASN1_ELEMENT_NOT_FOUND -67
1963 #define GNUTLS_E_ASN1_IDENTIFIER_NOT_FOUND -68
1964 #define GNUTLS_E_ASN1_DER_ERROR -69
1965 #define GNUTLS_E_ASN1_VALUE_NOT_FOUND -70
1966 #define GNUTLS_E_ASN1_GENERIC_ERROR -71
1967 #define GNUTLS_E_ASN1_VALUE_NOT_VALID -72
1968 #define GNUTLS_E_ASN1_TAG_ERROR -73
1969 #define GNUTLS_E_ASN1_TAG_IMPLICIT -74
1970 #define GNUTLS_E_ASN1_TYPE_ANY_ERROR -75
1971 #define GNUTLS_E_ASN1_SYNTAX_ERROR -76
1972 #define GNUTLS_E_ASN1_DER_OVERFLOW -77
1973 #define GNUTLS_E_OPENPGP_UID_REVOKED -79
1974 #define GNUTLS_E_CERTIFICATE_ERROR -43
1975 #define GNUTLS_E_X509_CERTIFICATE_ERROR GNUTLS_E_CERTIFICATE_ERROR
1976 #define GNUTLS_E_CERTIFICATE_KEY_MISMATCH -60
1977 #define GNUTLS_E_UNSUPPORTED_CERTIFICATE_TYPE -61 /* GNUTLS_A_UNSUPPORTED_CERTIFICATE */
1978 #define GNUTLS_E_X509_UNKNOWN_SAN -62
1979 #define GNUTLS_E_OPENPGP_FINGERPRINT_UNSUPPORTED -94
1980 #define GNUTLS_E_X509_UNSUPPORTED_ATTRIBUTE -95
1981 #define GNUTLS_E_UNKNOWN_HASH_ALGORITHM -96
1982 #define GNUTLS_E_UNKNOWN_PKCS_CONTENT_TYPE -97
1983 #define GNUTLS_E_UNKNOWN_PKCS_BAG_TYPE -98
1984 #define GNUTLS_E_INVALID_PASSWORD -99
1985 #define GNUTLS_E_MAC_VERIFY_FAILED -100 /* for PKCS #12 MAC */
1986 #define GNUTLS_E_CONSTRAINT_ERROR -101
1988 #define GNUTLS_E_WARNING_IA_IPHF_RECEIVED -102
1989 #define GNUTLS_E_WARNING_IA_FPHF_RECEIVED -103
1991 #define GNUTLS_E_IA_VERIFY_FAILED -104
1992 #define GNUTLS_E_UNKNOWN_ALGORITHM -105
1993 #define GNUTLS_E_UNSUPPORTED_SIGNATURE_ALGORITHM -106
1994 #define GNUTLS_E_SAFE_RENEGOTIATION_FAILED -107
1995 #define GNUTLS_E_UNSAFE_RENEGOTIATION_DENIED -108
1996 #define GNUTLS_E_UNKNOWN_SRP_USERNAME -109
1997 #define GNUTLS_E_PREMATURE_TERMINATION -110
1999 #define GNUTLS_E_BASE64_ENCODING_ERROR -201
2000 #define GNUTLS_E_INCOMPATIBLE_GCRYPT_LIBRARY -202 /* obsolete */
2001 #define GNUTLS_E_INCOMPATIBLE_CRYPTO_LIBRARY -202
2002 #define GNUTLS_E_INCOMPATIBLE_LIBTASN1_LIBRARY -203
2004 #define GNUTLS_E_OPENPGP_KEYRING_ERROR -204
2005 #define GNUTLS_E_X509_UNSUPPORTED_OID -205
2007 #define GNUTLS_E_RANDOM_FAILED -206
2008 #define GNUTLS_E_BASE64_UNEXPECTED_HEADER_ERROR -207
2010 #define GNUTLS_E_OPENPGP_SUBKEY_ERROR -208
2012 #define GNUTLS_E_CRYPTO_ALREADY_REGISTERED -209
2014 #define GNUTLS_E_HANDSHAKE_TOO_LARGE -210
2016 #define GNUTLS_E_CRYPTODEV_IOCTL_ERROR -211
2017 #define GNUTLS_E_CRYPTODEV_DEVICE_ERROR -212
2019 #define GNUTLS_E_CHANNEL_BINDING_NOT_AVAILABLE -213
2020 #define GNUTLS_E_BAD_COOKIE -214
2021 #define GNUTLS_E_OPENPGP_PREFERRED_KEY_ERROR -215
2022 #define GNUTLS_E_INCOMPAT_DSA_KEY_WITH_TLS_PROTOCOL -216
2024 #define GNUTLS_E_HEARTBEAT_PONG_RECEIVED -292
2025 #define GNUTLS_E_HEARTBEAT_PING_RECEIVED -293
2027 /* PKCS11 related */
2028 #define GNUTLS_E_PKCS11_ERROR -300
2029 #define GNUTLS_E_PKCS11_LOAD_ERROR -301
2030 #define GNUTLS_E_PARSING_ERROR -302
2031 #define GNUTLS_E_PKCS11_PIN_ERROR -303
2033 #define GNUTLS_E_PKCS11_SLOT_ERROR -305
2034 #define GNUTLS_E_LOCKING_ERROR -306
2035 #define GNUTLS_E_PKCS11_ATTRIBUTE_ERROR -307
2036 #define GNUTLS_E_PKCS11_DEVICE_ERROR -308
2037 #define GNUTLS_E_PKCS11_DATA_ERROR -309
2038 #define GNUTLS_E_PKCS11_UNSUPPORTED_FEATURE_ERROR -310
2039 #define GNUTLS_E_PKCS11_KEY_ERROR -311
2040 #define GNUTLS_E_PKCS11_PIN_EXPIRED -312
2041 #define GNUTLS_E_PKCS11_PIN_LOCKED -313
2042 #define GNUTLS_E_PKCS11_SESSION_ERROR -314
2043 #define GNUTLS_E_PKCS11_SIGNATURE_ERROR -315
2044 #define GNUTLS_E_PKCS11_TOKEN_ERROR -316
2045 #define GNUTLS_E_PKCS11_USER_ERROR -317
2047 #define GNUTLS_E_CRYPTO_INIT_FAILED -318
2048 #define GNUTLS_E_TIMEDOUT -319
2049 #define GNUTLS_E_USER_ERROR -320
2050 #define GNUTLS_E_ECC_NO_SUPPORTED_CURVES -321
2051 #define GNUTLS_E_ECC_UNSUPPORTED_CURVE -322
2052 #define GNUTLS_E_PKCS11_REQUESTED_OBJECT_NOT_AVAILBLE -323
2053 #define GNUTLS_E_CERTIFICATE_LIST_UNSORTED -324
2054 #define GNUTLS_E_ILLEGAL_PARAMETER -325
2055 #define GNUTLS_E_NO_PRIORITIES_WERE_SET -326
2056 #define GNUTLS_E_X509_UNSUPPORTED_EXTENSION -327
2057 #define GNUTLS_E_SESSION_EOF -328
2059 #define GNUTLS_E_TPM_ERROR -329
2060 #define GNUTLS_E_TPM_KEY_PASSWORD_ERROR -330
2061 #define GNUTLS_E_TPM_SRK_PASSWORD_ERROR -331
2062 #define GNUTLS_E_TPM_SESSION_ERROR -332
2063 #define GNUTLS_E_TPM_KEY_NOT_FOUND -333
2064 #define GNUTLS_E_TPM_UNINITIALIZED -334
2066 #define GNUTLS_E_NO_CERTIFICATE_STATUS -340
2067 #define GNUTLS_E_OCSP_RESPONSE_ERROR -341
2069 #define GNUTLS_E_UNIMPLEMENTED_FEATURE -1250
2073 #define GNUTLS_E_APPLICATION_ERROR_MAX -65000
2074 #define GNUTLS_E_APPLICATION_ERROR_MIN -65500
2076 #ifdef __cplusplus
2078 #endif
2080 #include <gnutls/compat.h>
2082 #endif /* GNUTLS_H */