Added Camellia-192-CBC algorithm identifier.
[gnutls.git] / lib / includes / gnutls / gnutls.h.in
blobd27070f4abef4322e2e1880774b64b47e7145622
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).
299 * Enumeration of different TLS connection end types.
301 #define GNUTLS_SERVER 1
302 #define GNUTLS_CLIENT (1<<1)
303 #define GNUTLS_DATAGRAM (1<<2)
304 #define GNUTLS_NONBLOCK (1<<3)
307 * gnutls_alert_level_t:
308 * @GNUTLS_AL_WARNING: Alert of warning severity.
309 * @GNUTLS_AL_FATAL: Alert of fatal severity.
311 * Enumeration of different TLS alert severities.
313 typedef enum
315 GNUTLS_AL_WARNING = 1,
316 GNUTLS_AL_FATAL
317 } gnutls_alert_level_t;
320 * gnutls_alert_description_t:
321 * @GNUTLS_A_CLOSE_NOTIFY: Close notify.
322 * @GNUTLS_A_UNEXPECTED_MESSAGE: Unexpected message.
323 * @GNUTLS_A_BAD_RECORD_MAC: Bad record MAC.
324 * @GNUTLS_A_DECRYPTION_FAILED: Decryption failed.
325 * @GNUTLS_A_RECORD_OVERFLOW: Record overflow.
326 * @GNUTLS_A_DECOMPRESSION_FAILURE: Decompression failed.
327 * @GNUTLS_A_HANDSHAKE_FAILURE: Handshake failed.
328 * @GNUTLS_A_SSL3_NO_CERTIFICATE: No certificate.
329 * @GNUTLS_A_BAD_CERTIFICATE: Certificate is bad.
330 * @GNUTLS_A_UNSUPPORTED_CERTIFICATE: Certificate is not supported.
331 * @GNUTLS_A_CERTIFICATE_REVOKED: Certificate was revoked.
332 * @GNUTLS_A_CERTIFICATE_EXPIRED: Certificate is expired.
333 * @GNUTLS_A_CERTIFICATE_UNKNOWN: Unknown certificate.
334 * @GNUTLS_A_ILLEGAL_PARAMETER: Illegal parameter.
335 * @GNUTLS_A_UNKNOWN_CA: CA is unknown.
336 * @GNUTLS_A_ACCESS_DENIED: Access was denied.
337 * @GNUTLS_A_DECODE_ERROR: Decode error.
338 * @GNUTLS_A_DECRYPT_ERROR: Decrypt error.
339 * @GNUTLS_A_EXPORT_RESTRICTION: Export restriction.
340 * @GNUTLS_A_PROTOCOL_VERSION: Error in protocol version.
341 * @GNUTLS_A_INSUFFICIENT_SECURITY: Insufficient security.
342 * @GNUTLS_A_USER_CANCELED: User canceled.
343 * @GNUTLS_A_INTERNAL_ERROR: Internal error.
344 * @GNUTLS_A_NO_RENEGOTIATION: No renegotiation is allowed.
345 * @GNUTLS_A_CERTIFICATE_UNOBTAINABLE: Could not retrieve the
346 * specified certificate.
347 * @GNUTLS_A_UNSUPPORTED_EXTENSION: An unsupported extension was
348 * sent.
349 * @GNUTLS_A_UNRECOGNIZED_NAME: The server name sent was not
350 * recognized.
351 * @GNUTLS_A_UNKNOWN_PSK_IDENTITY: The SRP/PSK username is missing
352 * or not known.
354 * Enumeration of different TLS alerts.
356 typedef enum
358 GNUTLS_A_CLOSE_NOTIFY,
359 GNUTLS_A_UNEXPECTED_MESSAGE = 10,
360 GNUTLS_A_BAD_RECORD_MAC = 20,
361 GNUTLS_A_DECRYPTION_FAILED,
362 GNUTLS_A_RECORD_OVERFLOW,
363 GNUTLS_A_DECOMPRESSION_FAILURE = 30,
364 GNUTLS_A_HANDSHAKE_FAILURE = 40,
365 GNUTLS_A_SSL3_NO_CERTIFICATE = 41,
366 GNUTLS_A_BAD_CERTIFICATE = 42,
367 GNUTLS_A_UNSUPPORTED_CERTIFICATE,
368 GNUTLS_A_CERTIFICATE_REVOKED,
369 GNUTLS_A_CERTIFICATE_EXPIRED,
370 GNUTLS_A_CERTIFICATE_UNKNOWN,
371 GNUTLS_A_ILLEGAL_PARAMETER,
372 GNUTLS_A_UNKNOWN_CA,
373 GNUTLS_A_ACCESS_DENIED,
374 GNUTLS_A_DECODE_ERROR = 50,
375 GNUTLS_A_DECRYPT_ERROR,
376 GNUTLS_A_EXPORT_RESTRICTION = 60,
377 GNUTLS_A_PROTOCOL_VERSION = 70,
378 GNUTLS_A_INSUFFICIENT_SECURITY,
379 GNUTLS_A_INTERNAL_ERROR = 80,
380 GNUTLS_A_USER_CANCELED = 90,
381 GNUTLS_A_NO_RENEGOTIATION = 100,
382 GNUTLS_A_UNSUPPORTED_EXTENSION = 110,
383 GNUTLS_A_CERTIFICATE_UNOBTAINABLE = 111,
384 GNUTLS_A_UNRECOGNIZED_NAME = 112,
385 GNUTLS_A_UNKNOWN_PSK_IDENTITY = 115,
386 } gnutls_alert_description_t;
389 * gnutls_handshake_description_t:
390 * @GNUTLS_HANDSHAKE_HELLO_REQUEST: Hello request.
391 * @GNUTLS_HANDSHAKE_HELLO_VERIFY_REQUEST: DTLS Hello verify request.
392 * @GNUTLS_HANDSHAKE_CLIENT_HELLO: Client hello.
393 * @GNUTLS_HANDSHAKE_SERVER_HELLO: Server hello.
394 * @GNUTLS_HANDSHAKE_NEW_SESSION_TICKET: New session ticket.
395 * @GNUTLS_HANDSHAKE_CERTIFICATE_PKT: Certificate packet.
396 * @GNUTLS_HANDSHAKE_SERVER_KEY_EXCHANGE: Server key exchange.
397 * @GNUTLS_HANDSHAKE_CERTIFICATE_REQUEST: Certificate request.
398 * @GNUTLS_HANDSHAKE_SERVER_HELLO_DONE: Server hello done.
399 * @GNUTLS_HANDSHAKE_CERTIFICATE_VERIFY: Certificate verify.
400 * @GNUTLS_HANDSHAKE_CLIENT_KEY_EXCHANGE: Client key exchange.
401 * @GNUTLS_HANDSHAKE_FINISHED: Finished.
402 * @GNUTLS_HANDSHAKE_SUPPLEMENTAL: Supplemental.
403 * @GNUTLS_HANDSHAKE_CHANGE_CIPHER_SPEC: Change Cipher Spec
404 * @GNUTLS_HANDSHAKE_CLIENT_HELLO_V2: SSLv2 Client Hello.
406 * Enumeration of different TLS handshake packets.
408 typedef enum
410 GNUTLS_HANDSHAKE_HELLO_REQUEST = 0,
411 GNUTLS_HANDSHAKE_CLIENT_HELLO = 1,
412 GNUTLS_HANDSHAKE_SERVER_HELLO = 2,
413 GNUTLS_HANDSHAKE_HELLO_VERIFY_REQUEST = 3,
414 GNUTLS_HANDSHAKE_NEW_SESSION_TICKET = 4,
415 GNUTLS_HANDSHAKE_CERTIFICATE_PKT = 11,
416 GNUTLS_HANDSHAKE_SERVER_KEY_EXCHANGE = 12,
417 GNUTLS_HANDSHAKE_CERTIFICATE_REQUEST = 13,
418 GNUTLS_HANDSHAKE_SERVER_HELLO_DONE = 14,
419 GNUTLS_HANDSHAKE_CERTIFICATE_VERIFY = 15,
420 GNUTLS_HANDSHAKE_CLIENT_KEY_EXCHANGE = 16,
421 GNUTLS_HANDSHAKE_FINISHED = 20,
422 GNUTLS_HANDSHAKE_SUPPLEMENTAL = 23,
423 GNUTLS_HANDSHAKE_CHANGE_CIPHER_SPEC = 254,
424 GNUTLS_HANDSHAKE_CLIENT_HELLO_V2 = 1024,
425 } gnutls_handshake_description_t;
428 * gnutls_certificate_status_t:
429 * @GNUTLS_CERT_INVALID: The certificate is not signed by one of the
430 * known authorities or the signature is invalid.
431 * @GNUTLS_CERT_SIGNATURE_FAILURE: The signature verification failed.
432 * @GNUTLS_CERT_REVOKED: Certificate is revoked by its authority. In X.509 this will be
433 * set only if CRLs are checked.
434 * @GNUTLS_CERT_SIGNER_NOT_FOUND: The certificate's issuer is not known.
435 * This is the case if the issuer is not included in the trusted certificate list.
436 * @GNUTLS_CERT_SIGNER_NOT_CA: The certificate's signer was not a CA. This
437 * may happen if this was a version 1 certificate, which is common with
438 * some CAs, or a version 3 certificate without the basic constrains extension.
439 * @GNUTLS_CERT_INSECURE_ALGORITHM: The certificate was signed using an insecure
440 * algorithm such as MD2 or MD5. These algorithms have been broken and
441 * should not be trusted.
442 * @GNUTLS_CERT_NOT_ACTIVATED: The certificate is not yet activated.
443 * @GNUTLS_CERT_EXPIRED: The certificate has expired.
445 * Enumeration of certificate status codes. Note that the status
446 * bits have different meanings in OpenPGP keys and X.509
447 * certificate verification.
449 typedef enum
451 GNUTLS_CERT_INVALID = 2,
452 GNUTLS_CERT_REVOKED = 32,
453 GNUTLS_CERT_SIGNER_NOT_FOUND = 64,
454 GNUTLS_CERT_SIGNER_NOT_CA = 128,
455 GNUTLS_CERT_INSECURE_ALGORITHM = 256,
456 GNUTLS_CERT_NOT_ACTIVATED = 512,
457 GNUTLS_CERT_EXPIRED = 1024,
458 GNUTLS_CERT_SIGNATURE_FAILURE = 2048
459 } gnutls_certificate_status_t;
462 * gnutls_certificate_request_t:
463 * @GNUTLS_CERT_IGNORE: Ignore certificate.
464 * @GNUTLS_CERT_REQUEST: Request certificate.
465 * @GNUTLS_CERT_REQUIRE: Require certificate.
467 * Enumeration of certificate request types.
469 typedef enum
471 GNUTLS_CERT_IGNORE = 0,
472 GNUTLS_CERT_REQUEST = 1,
473 GNUTLS_CERT_REQUIRE = 2
474 } gnutls_certificate_request_t;
477 * gnutls_openpgp_crt_status_t:
478 * @GNUTLS_OPENPGP_CERT: Send entire certificate.
479 * @GNUTLS_OPENPGP_CERT_FINGERPRINT: Send only certificate fingerprint.
481 * Enumeration of ways to send OpenPGP certificate.
483 typedef enum
485 GNUTLS_OPENPGP_CERT = 0,
486 GNUTLS_OPENPGP_CERT_FINGERPRINT = 1
487 } gnutls_openpgp_crt_status_t;
490 * gnutls_close_request_t:
491 * @GNUTLS_SHUT_RDWR: Disallow further receives/sends.
492 * @GNUTLS_SHUT_WR: Disallow further sends.
494 * Enumeration of how TLS session should be terminated. See gnutls_bye().
496 typedef enum
498 GNUTLS_SHUT_RDWR = 0,
499 GNUTLS_SHUT_WR = 1
500 } gnutls_close_request_t;
503 * gnutls_protocol_t:
504 * @GNUTLS_SSL3: SSL version 3.0.
505 * @GNUTLS_TLS1_0: TLS version 1.0.
506 * @GNUTLS_TLS1: Same as %GNUTLS_TLS1_0.
507 * @GNUTLS_TLS1_1: TLS version 1.1.
508 * @GNUTLS_TLS1_2: TLS version 1.2.
509 * @GNUTLS_DTLS1_0: DTLS version 1.0.
510 * @GNUTLS_DTLS0_9: DTLS version 0.9 (Cisco AnyConnect / OpenSSL 0.9.8e).
511 * @GNUTLS_VERSION_MAX: Maps to the highest supported TLS version.
512 * @GNUTLS_VERSION_UNKNOWN: Unknown SSL/TLS version.
514 * Enumeration of different SSL/TLS protocol versions.
516 typedef enum
518 GNUTLS_SSL3 = 1,
519 GNUTLS_TLS1_0 = 2,
520 GNUTLS_TLS1 = GNUTLS_TLS1_0,
521 GNUTLS_TLS1_1 = 3,
522 GNUTLS_TLS1_2 = 4,
523 GNUTLS_DTLS1_0 = 5,
524 GNUTLS_DTLS0_9 = 6,
525 GNUTLS_VERSION_MAX = GNUTLS_DTLS0_9,
526 GNUTLS_VERSION_UNKNOWN = 0xff
527 } gnutls_protocol_t;
530 * gnutls_certificate_type_t:
531 * @GNUTLS_CRT_UNKNOWN: Unknown certificate type.
532 * @GNUTLS_CRT_X509: X.509 Certificate.
533 * @GNUTLS_CRT_OPENPGP: OpenPGP certificate.
534 * @GNUTLS_CRT_RAW: Raw public key (SubjectPublicKey)
536 * Enumeration of different certificate types.
538 typedef enum
540 GNUTLS_CRT_UNKNOWN = 0,
541 GNUTLS_CRT_X509 = 1,
542 GNUTLS_CRT_OPENPGP = 2,
543 GNUTLS_CRT_RAW = 3
544 } gnutls_certificate_type_t;
547 * gnutls_x509_crt_fmt_t:
548 * @GNUTLS_X509_FMT_DER: X.509 certificate in DER format (binary).
549 * @GNUTLS_X509_FMT_PEM: X.509 certificate in PEM format (text).
551 * Enumeration of different certificate encoding formats.
553 typedef enum
555 GNUTLS_X509_FMT_DER = 0,
556 GNUTLS_X509_FMT_PEM = 1
557 } gnutls_x509_crt_fmt_t;
560 * gnutls_certificate_print_formats_t:
561 * @GNUTLS_CRT_PRINT_FULL: Full information about certificate.
562 * @GNUTLS_CRT_PRINT_COMPACT: Information about certificate name in one line, plus identification of the public key.
563 * @GNUTLS_CRT_PRINT_ONELINE: Information about certificate in one line.
564 * @GNUTLS_CRT_PRINT_UNSIGNED_FULL: All info for an unsigned certificate.
566 * Enumeration of different certificate printing variants.
568 typedef enum gnutls_certificate_print_formats
570 GNUTLS_CRT_PRINT_FULL = 0,
571 GNUTLS_CRT_PRINT_ONELINE = 1,
572 GNUTLS_CRT_PRINT_UNSIGNED_FULL = 2,
573 GNUTLS_CRT_PRINT_COMPACT = 3
574 } gnutls_certificate_print_formats_t;
576 #define GNUTLS_PK_ECC GNUTLS_PK_EC
578 * gnutls_pk_algorithm_t:
579 * @GNUTLS_PK_UNKNOWN: Unknown public-key algorithm.
580 * @GNUTLS_PK_RSA: RSA public-key algorithm.
581 * @GNUTLS_PK_DSA: DSA public-key algorithm.
582 * @GNUTLS_PK_DH: Diffie-Hellman algorithm. Used to generate parameters.
583 * @GNUTLS_PK_EC: Elliptic curve algorithm. Used to generate parameters.
585 * Enumeration of different public-key algorithms.
587 typedef enum
589 GNUTLS_PK_UNKNOWN = 0,
590 GNUTLS_PK_RSA = 1,
591 GNUTLS_PK_DSA = 2,
592 GNUTLS_PK_DH = 3,
593 GNUTLS_PK_EC = 4,
594 } gnutls_pk_algorithm_t;
596 const char *gnutls_pk_algorithm_get_name (gnutls_pk_algorithm_t algorithm);
599 * gnutls_sign_algorithm_t:
600 * @GNUTLS_SIGN_UNKNOWN: Unknown signature algorithm.
601 * @GNUTLS_SIGN_RSA_SHA1: Digital signature algorithm RSA with SHA-1
602 * @GNUTLS_SIGN_RSA_SHA: Same as %GNUTLS_SIGN_RSA_SHA1.
603 * @GNUTLS_SIGN_DSA_SHA1: Digital signature algorithm DSA with SHA-1
604 * @GNUTLS_SIGN_DSA_SHA224: Digital signature algorithm DSA with SHA-224
605 * @GNUTLS_SIGN_DSA_SHA256: Digital signature algorithm DSA with SHA-256
606 * @GNUTLS_SIGN_DSA_SHA: Same as %GNUTLS_SIGN_DSA_SHA1.
607 * @GNUTLS_SIGN_RSA_MD5: Digital signature algorithm RSA with MD5.
608 * @GNUTLS_SIGN_RSA_MD2: Digital signature algorithm RSA with MD2.
609 * @GNUTLS_SIGN_RSA_RMD160: Digital signature algorithm RSA with RMD-160.
610 * @GNUTLS_SIGN_RSA_SHA256: Digital signature algorithm RSA with SHA-256.
611 * @GNUTLS_SIGN_RSA_SHA384: Digital signature algorithm RSA with SHA-384.
612 * @GNUTLS_SIGN_RSA_SHA512: Digital signature algorithm RSA with SHA-512.
613 * @GNUTLS_SIGN_RSA_SHA224: Digital signature algorithm RSA with SHA-224.
614 * @GNUTLS_SIGN_ECDSA_SHA1: ECDSA with SHA1.
615 * @GNUTLS_SIGN_ECDSA_SHA256: Digital signature algorithm ECDSA with SHA-256.
616 * @GNUTLS_SIGN_ECDSA_SHA384: Digital signature algorithm ECDSA with SHA-384.
617 * @GNUTLS_SIGN_ECDSA_SHA512: Digital signature algorithm ECDSA with SHA-512.
618 * @GNUTLS_SIGN_ECDSA_SHA224: Digital signature algorithm ECDSA with SHA-224.
620 * Enumeration of different digital signature algorithms.
622 typedef enum
624 GNUTLS_SIGN_UNKNOWN = 0,
625 GNUTLS_SIGN_RSA_SHA1 = 1,
626 GNUTLS_SIGN_RSA_SHA = GNUTLS_SIGN_RSA_SHA1,
627 GNUTLS_SIGN_DSA_SHA1 = 2,
628 GNUTLS_SIGN_DSA_SHA = GNUTLS_SIGN_DSA_SHA1,
629 GNUTLS_SIGN_RSA_MD5 = 3,
630 GNUTLS_SIGN_RSA_MD2 = 4,
631 GNUTLS_SIGN_RSA_RMD160 = 5,
632 GNUTLS_SIGN_RSA_SHA256 = 6,
633 GNUTLS_SIGN_RSA_SHA384 = 7,
634 GNUTLS_SIGN_RSA_SHA512 = 8,
635 GNUTLS_SIGN_RSA_SHA224 = 9,
636 GNUTLS_SIGN_DSA_SHA224 = 10,
637 GNUTLS_SIGN_DSA_SHA256 = 11,
638 GNUTLS_SIGN_ECDSA_SHA1 = 12,
639 GNUTLS_SIGN_ECDSA_SHA224 = 13,
640 GNUTLS_SIGN_ECDSA_SHA256 = 14,
641 GNUTLS_SIGN_ECDSA_SHA384 = 15,
642 GNUTLS_SIGN_ECDSA_SHA512 = 16,
643 } gnutls_sign_algorithm_t;
646 * gnutls_ecc_curve_t:
647 * @GNUTLS_ECC_CURVE_INVALID: Cannot be known
648 * @GNUTLS_ECC_CURVE_SECP192R1: the SECP192R1 curve
649 * @GNUTLS_ECC_CURVE_SECP224R1: the SECP224R1 curve
650 * @GNUTLS_ECC_CURVE_SECP256R1: the SECP256R1 curve
651 * @GNUTLS_ECC_CURVE_SECP384R1: the SECP384R1 curve
652 * @GNUTLS_ECC_CURVE_SECP521R1: the SECP521R1 curve
654 * Enumeration of ECC curves.
656 typedef enum
658 GNUTLS_ECC_CURVE_INVALID=0,
659 GNUTLS_ECC_CURVE_SECP224R1,
660 GNUTLS_ECC_CURVE_SECP256R1,
661 GNUTLS_ECC_CURVE_SECP384R1,
662 GNUTLS_ECC_CURVE_SECP521R1,
663 GNUTLS_ECC_CURVE_SECP192R1,
664 } gnutls_ecc_curve_t;
666 #define GNUTLS_SEC_PARAM_WEAK GNUTLS_SEC_PARAM_LOW
669 * gnutls_sec_param_t:
670 * @GNUTLS_SEC_PARAM_UNKNOWN: Cannot be known
671 * @GNUTLS_SEC_PARAM_LOW: low security level
672 * @GNUTLS_SEC_PARAM_LEGACY: 96 bits of security
673 * @GNUTLS_SEC_PARAM_NORMAL: 112 bits of security
674 * @GNUTLS_SEC_PARAM_HIGH: 128 bits of security
675 * @GNUTLS_SEC_PARAM_ULTRA: 192 bits of security
677 * Enumeration of security parameters for passive attacks.
679 typedef enum
681 GNUTLS_SEC_PARAM_UNKNOWN,
682 GNUTLS_SEC_PARAM_LOW = 1,
683 GNUTLS_SEC_PARAM_LEGACY = 2,
684 GNUTLS_SEC_PARAM_NORMAL = 3,
685 GNUTLS_SEC_PARAM_HIGH = 4,
686 GNUTLS_SEC_PARAM_ULTRA = 5,
687 } gnutls_sec_param_t;
690 * gnutls_channel_binding_t:
691 * @GNUTLS_CB_TLS_UNIQUE: "tls-unique" (RFC 5929) channel binding
693 * Enumeration of support channel binding types.
695 typedef enum
697 GNUTLS_CB_TLS_UNIQUE
698 } gnutls_channel_binding_t;
700 /* If you want to change this, then also change the define in
701 * gnutls_int.h, and recompile.
703 typedef void *gnutls_transport_ptr_t;
705 struct gnutls_session_int;
706 typedef struct gnutls_session_int *gnutls_session_t;
708 struct gnutls_dh_params_int;
709 typedef struct gnutls_dh_params_int *gnutls_dh_params_t;
711 struct gnutls_ecdh_params_int;
712 typedef struct gnutls_ecdh_params_int *gnutls_ecdh_params_t;
714 /* XXX ugly. */
715 struct gnutls_x509_privkey_int;
716 typedef struct gnutls_x509_privkey_int *gnutls_rsa_params_t;
718 struct gnutls_priority_st;
719 typedef struct gnutls_priority_st *gnutls_priority_t;
721 typedef struct
723 unsigned char *data;
724 unsigned int size;
725 } gnutls_datum_t;
728 typedef struct gnutls_params_st
730 gnutls_params_type_t type;
731 union params
733 gnutls_dh_params_t dh;
734 gnutls_ecdh_params_t ecdh;
735 gnutls_rsa_params_t rsa_export;
736 } params;
737 int deinit;
738 } gnutls_params_st;
740 typedef int gnutls_params_function (gnutls_session_t, gnutls_params_type_t,
741 gnutls_params_st *);
743 /* internal functions */
745 int gnutls_init (gnutls_session_t * session,
746 unsigned int flags);
747 void gnutls_deinit (gnutls_session_t session);
748 #define _gnutls_deinit(x) gnutls_deinit(x)
750 int gnutls_bye (gnutls_session_t session, gnutls_close_request_t how);
752 int gnutls_handshake (gnutls_session_t session);
753 int gnutls_rehandshake (gnutls_session_t session);
755 gnutls_alert_description_t gnutls_alert_get (gnutls_session_t session);
756 int gnutls_alert_send (gnutls_session_t session,
757 gnutls_alert_level_t level,
758 gnutls_alert_description_t desc);
759 int gnutls_alert_send_appropriate (gnutls_session_t session, int err);
760 const char *gnutls_alert_get_name (gnutls_alert_description_t alert);
761 const char * gnutls_alert_get_strname (gnutls_alert_description_t alert);
763 gnutls_sec_param_t gnutls_pk_bits_to_sec_param (gnutls_pk_algorithm_t algo,
764 unsigned int bits);
765 const char *gnutls_sec_param_get_name (gnutls_sec_param_t param);
766 unsigned int gnutls_sec_param_to_pk_bits (gnutls_pk_algorithm_t algo,
767 gnutls_sec_param_t param);
769 /* Elliptic curves */
770 const char * gnutls_ecc_curve_get_name (gnutls_ecc_curve_t curve);
771 int gnutls_ecc_curve_get_size (gnutls_ecc_curve_t curve);
772 gnutls_ecc_curve_t gnutls_ecc_curve_get(gnutls_session_t session);
774 /* get information on the current session */
775 gnutls_cipher_algorithm_t gnutls_cipher_get (gnutls_session_t session);
776 gnutls_kx_algorithm_t gnutls_kx_get (gnutls_session_t session);
777 gnutls_mac_algorithm_t gnutls_mac_get (gnutls_session_t session);
778 gnutls_compression_method_t
779 gnutls_compression_get (gnutls_session_t session);
780 gnutls_certificate_type_t
781 gnutls_certificate_type_get (gnutls_session_t session);
783 int gnutls_sign_algorithm_get_requested (gnutls_session_t session,
784 size_t indx,
785 gnutls_sign_algorithm_t * algo);
787 size_t gnutls_cipher_get_key_size (gnutls_cipher_algorithm_t algorithm);
788 size_t gnutls_mac_get_key_size (gnutls_mac_algorithm_t algorithm);
790 /* the name of the specified algorithms */
791 const char *gnutls_cipher_get_name (gnutls_cipher_algorithm_t algorithm);
792 const char *gnutls_mac_get_name (gnutls_mac_algorithm_t algorithm);
793 const char *gnutls_compression_get_name (gnutls_compression_method_t
794 algorithm);
795 const char *gnutls_kx_get_name (gnutls_kx_algorithm_t algorithm);
796 const char *gnutls_certificate_type_get_name (gnutls_certificate_type_t
797 type);
798 const char *gnutls_pk_get_name (gnutls_pk_algorithm_t algorithm);
799 const char *gnutls_sign_get_name (gnutls_sign_algorithm_t algorithm);
801 gnutls_sign_algorithm_t gnutls_pk_to_sign (gnutls_pk_algorithm_t pk,
802 gnutls_digest_algorithm_t d);
804 #define gnutls_sign_algorithm_get_name gnutls_sign_get_name
806 gnutls_mac_algorithm_t gnutls_mac_get_id (const char *name);
807 gnutls_compression_method_t gnutls_compression_get_id (const char *name);
808 gnutls_cipher_algorithm_t gnutls_cipher_get_id (const char *name);
809 gnutls_kx_algorithm_t gnutls_kx_get_id (const char *name);
810 gnutls_protocol_t gnutls_protocol_get_id (const char *name);
811 gnutls_certificate_type_t gnutls_certificate_type_get_id (const char *name);
812 gnutls_pk_algorithm_t gnutls_pk_get_id (const char *name);
813 gnutls_sign_algorithm_t gnutls_sign_get_id (const char *name);
815 /* list supported algorithms */
816 const gnutls_ecc_curve_t * gnutls_ecc_curve_list (void);
817 const gnutls_cipher_algorithm_t *gnutls_cipher_list (void);
818 const gnutls_mac_algorithm_t *gnutls_mac_list (void);
819 const gnutls_compression_method_t *gnutls_compression_list (void);
820 const gnutls_protocol_t *gnutls_protocol_list (void);
821 const gnutls_certificate_type_t *gnutls_certificate_type_list (void);
822 const gnutls_kx_algorithm_t *gnutls_kx_list (void);
823 const gnutls_pk_algorithm_t *gnutls_pk_list (void);
824 const gnutls_sign_algorithm_t *gnutls_sign_list (void);
825 const char *gnutls_cipher_suite_info (size_t idx,
826 unsigned char *cs_id,
827 gnutls_kx_algorithm_t * kx,
828 gnutls_cipher_algorithm_t * cipher,
829 gnutls_mac_algorithm_t * mac,
830 gnutls_protocol_t * min_version);
832 /* error functions */
833 int gnutls_error_is_fatal (int error);
834 int gnutls_error_to_alert (int err, int *level);
836 void gnutls_perror (int error);
837 const char *gnutls_strerror (int error);
838 const char *gnutls_strerror_name (int error);
840 /* Semi-internal functions.
842 void gnutls_handshake_set_private_extensions (gnutls_session_t session,
843 int allow);
844 gnutls_handshake_description_t
845 gnutls_handshake_get_last_out (gnutls_session_t session);
846 gnutls_handshake_description_t
847 gnutls_handshake_get_last_in (gnutls_session_t session);
849 /* Record layer functions.
851 ssize_t gnutls_record_send (gnutls_session_t session, const void *data,
852 size_t data_size);
853 ssize_t gnutls_record_recv (gnutls_session_t session, void *data,
854 size_t data_size);
855 #define gnutls_read gnutls_record_recv
856 #define gnutls_write gnutls_record_send
857 ssize_t gnutls_record_recv_seq (gnutls_session_t session, void *data, size_t data_size,
858 unsigned char *seq);
860 void gnutls_session_enable_compatibility_mode (gnutls_session_t session);
862 void gnutls_record_disable_padding (gnutls_session_t session);
864 int gnutls_record_get_direction (gnutls_session_t session);
866 size_t gnutls_record_get_max_size (gnutls_session_t session);
867 ssize_t gnutls_record_set_max_size (gnutls_session_t session, size_t size);
869 size_t gnutls_record_check_pending (gnutls_session_t session);
871 int gnutls_prf (gnutls_session_t session,
872 size_t label_size, const char *label,
873 int server_random_first,
874 size_t extra_size, const char *extra,
875 size_t outsize, char *out);
877 int gnutls_prf_raw (gnutls_session_t session,
878 size_t label_size, const char *label,
879 size_t seed_size, const char *seed,
880 size_t outsize, char *out);
883 * gnutls_server_name_type_t:
884 * @GNUTLS_NAME_DNS: Domain Name System name type.
886 * Enumeration of different server name types.
888 typedef enum
890 GNUTLS_NAME_DNS = 1
891 } gnutls_server_name_type_t;
893 int gnutls_server_name_set (gnutls_session_t session,
894 gnutls_server_name_type_t type,
895 const void *name, size_t name_length);
897 int gnutls_server_name_get (gnutls_session_t session,
898 void *data, size_t * data_length,
899 unsigned int *type, unsigned int indx);
901 /* Safe renegotiation */
902 int gnutls_safe_renegotiation_status (gnutls_session_t session);
905 * gnutls_supplemental_data_format_type_t:
906 * @GNUTLS_SUPPLEMENTAL_USER_MAPPING_DATA: Supplemental user mapping data.
908 * Enumeration of different supplemental data types (RFC 4680).
910 typedef enum
912 GNUTLS_SUPPLEMENTAL_USER_MAPPING_DATA = 0
913 } gnutls_supplemental_data_format_type_t;
915 const char
916 *gnutls_supplemental_get_name (gnutls_supplemental_data_format_type_t
917 type);
919 /* SessionTicket, RFC 5077. */
920 int gnutls_session_ticket_key_generate (gnutls_datum_t * key);
921 int gnutls_session_ticket_enable_client (gnutls_session_t session);
922 int gnutls_session_ticket_enable_server (gnutls_session_t session,
923 const gnutls_datum_t * key);
925 int gnutls_key_generate (gnutls_datum_t * key, unsigned int key_size);
927 /* if you just want some defaults, use the following.
929 int gnutls_priority_init (gnutls_priority_t * priority_cache,
930 const char *priorities, const char **err_pos);
931 void gnutls_priority_deinit (gnutls_priority_t priority_cache);
932 int gnutls_priority_get_cipher_suite_index (gnutls_priority_t pcache, unsigned int idx, unsigned int *sidx);
934 int gnutls_priority_set (gnutls_session_t session,
935 gnutls_priority_t priority);
936 int gnutls_priority_set_direct (gnutls_session_t session,
937 const char *priorities,
938 const char **err_pos);
940 int gnutls_priority_certificate_type_list (gnutls_priority_t pcache, const unsigned int** list);
941 int gnutls_priority_sign_list (gnutls_priority_t pcache, const unsigned int** list);
942 int gnutls_priority_protocol_list (gnutls_priority_t pcache, const unsigned int** list);
943 int gnutls_priority_compression_list (gnutls_priority_t pcache, const unsigned int** list);
944 int gnutls_priority_ecc_curve_list (gnutls_priority_t pcache, const unsigned int** list);
946 /* for compatibility
948 int gnutls_set_default_priority (gnutls_session_t session);
950 /* Returns the name of a cipher suite */
951 const char *gnutls_cipher_suite_get_name (gnutls_kx_algorithm_t
952 kx_algorithm,
953 gnutls_cipher_algorithm_t
954 cipher_algorithm,
955 gnutls_mac_algorithm_t
956 mac_algorithm);
958 /* get the currently used protocol version */
959 gnutls_protocol_t gnutls_protocol_get_version (gnutls_session_t session);
961 const char *gnutls_protocol_get_name (gnutls_protocol_t version);
964 /* get/set session
966 int gnutls_session_set_data (gnutls_session_t session,
967 const void *session_data,
968 size_t session_data_size);
969 int gnutls_session_get_data (gnutls_session_t session, void *session_data,
970 size_t * session_data_size);
971 int gnutls_session_get_data2 (gnutls_session_t session,
972 gnutls_datum_t * data);
973 void gnutls_session_get_random (gnutls_session_t session, gnutls_datum_t* client,
974 gnutls_datum_t* server);
976 int gnutls_session_set_premaster (gnutls_session_t session, unsigned int entity,
977 gnutls_protocol_t version,
978 gnutls_kx_algorithm_t kx,
979 gnutls_cipher_algorithm_t cipher,
980 gnutls_mac_algorithm_t mac,
981 gnutls_compression_method_t comp,
982 const gnutls_datum_t* master,
983 const gnutls_datum_t * session_id);
985 /* returns the session ID */
986 #define GNUTLS_MAX_SESSION_ID 32
987 int gnutls_session_get_id (gnutls_session_t session, void *session_id,
988 size_t * session_id_size);
991 int gnutls_session_channel_binding (gnutls_session_t session,
992 gnutls_channel_binding_t cbtype,
993 gnutls_datum_t * cb);
995 /* checks if this session is a resumed one
997 int gnutls_session_is_resumed (gnutls_session_t session);
998 int gnutls_session_resumption_requested (gnutls_session_t session);
1000 typedef int (*gnutls_db_store_func) (void *, gnutls_datum_t key,
1001 gnutls_datum_t data);
1002 typedef int (*gnutls_db_remove_func) (void *, gnutls_datum_t key);
1003 typedef gnutls_datum_t (*gnutls_db_retr_func) (void *, gnutls_datum_t key);
1005 void gnutls_db_set_cache_expiration (gnutls_session_t session, int seconds);
1007 void gnutls_db_remove_session (gnutls_session_t session);
1008 void gnutls_db_set_retrieve_function (gnutls_session_t session,
1009 gnutls_db_retr_func retr_func);
1010 void gnutls_db_set_remove_function (gnutls_session_t session,
1011 gnutls_db_remove_func rem_func);
1012 void gnutls_db_set_store_function (gnutls_session_t session,
1013 gnutls_db_store_func store_func);
1014 void gnutls_db_set_ptr (gnutls_session_t session, void *ptr);
1015 void *gnutls_db_get_ptr (gnutls_session_t session);
1016 int gnutls_db_check_entry (gnutls_session_t session,
1017 gnutls_datum_t session_entry);
1019 typedef int (*gnutls_handshake_post_client_hello_func) (gnutls_session_t);
1020 void
1021 gnutls_handshake_set_post_client_hello_function (gnutls_session_t session,
1022 gnutls_handshake_post_client_hello_func
1023 func);
1025 void gnutls_handshake_set_max_packet_length (gnutls_session_t session,
1026 size_t max);
1028 /* returns libgnutls version (call it with a NULL argument)
1030 const char *gnutls_check_version (const char *req_version);
1032 /* Functions for setting/clearing credentials
1034 void gnutls_credentials_clear (gnutls_session_t session);
1036 /* cred is a structure defined by the kx algorithm
1038 int gnutls_credentials_set (gnutls_session_t session,
1039 gnutls_credentials_type_t type, void *cred);
1040 #define gnutls_cred_set gnutls_credentials_set
1042 /* x.509 types */
1044 struct gnutls_x509_privkey_int;
1045 typedef struct gnutls_x509_privkey_int *gnutls_x509_privkey_t;
1047 struct gnutls_x509_crl_int;
1048 typedef struct gnutls_x509_crl_int *gnutls_x509_crl_t;
1050 struct gnutls_x509_crt_int;
1051 typedef struct gnutls_x509_crt_int *gnutls_x509_crt_t;
1053 struct gnutls_x509_crq_int;
1054 typedef struct gnutls_x509_crq_int *gnutls_x509_crq_t;
1056 struct gnutls_openpgp_keyring_int;
1057 typedef struct gnutls_openpgp_keyring_int *gnutls_openpgp_keyring_t;
1060 /* Credential structures - used in gnutls_credentials_set(); */
1062 struct gnutls_certificate_credentials_st;
1063 typedef struct gnutls_certificate_credentials_st
1064 *gnutls_certificate_credentials_t;
1065 typedef gnutls_certificate_credentials_t
1066 gnutls_certificate_server_credentials;
1067 typedef gnutls_certificate_credentials_t
1068 gnutls_certificate_client_credentials;
1070 typedef struct gnutls_anon_server_credentials_st
1071 *gnutls_anon_server_credentials_t;
1072 typedef struct gnutls_anon_client_credentials_st
1073 *gnutls_anon_client_credentials_t;
1075 void gnutls_anon_free_server_credentials (gnutls_anon_server_credentials_t
1076 sc);
1078 gnutls_anon_allocate_server_credentials (gnutls_anon_server_credentials_t
1079 * sc);
1081 void gnutls_anon_set_server_dh_params (gnutls_anon_server_credentials_t res,
1082 gnutls_dh_params_t dh_params);
1084 void
1085 gnutls_anon_set_server_params_function (gnutls_anon_server_credentials_t
1086 res,
1087 gnutls_params_function * func);
1089 void
1090 gnutls_anon_free_client_credentials (gnutls_anon_client_credentials_t sc);
1092 gnutls_anon_allocate_client_credentials (gnutls_anon_client_credentials_t
1093 * sc);
1095 /* CERTFILE is an x509 certificate in PEM form.
1096 * KEYFILE is a pkcs-1 private key in PEM form (for RSA keys).
1098 void
1099 gnutls_certificate_free_credentials (gnutls_certificate_credentials_t sc);
1101 gnutls_certificate_allocate_credentials (gnutls_certificate_credentials_t
1102 * res);
1105 gnutls_certificate_get_issuer (gnutls_certificate_credentials_t sc,
1106 gnutls_x509_crt_t cert, gnutls_x509_crt_t* issuer, unsigned int flags);
1108 void gnutls_certificate_free_keys (gnutls_certificate_credentials_t sc);
1109 void gnutls_certificate_free_cas (gnutls_certificate_credentials_t sc);
1110 void gnutls_certificate_free_ca_names (gnutls_certificate_credentials_t sc);
1111 void gnutls_certificate_free_crls (gnutls_certificate_credentials_t sc);
1113 void gnutls_certificate_set_dh_params (gnutls_certificate_credentials_t res,
1114 gnutls_dh_params_t dh_params);
1115 void gnutls_certificate_set_verify_flags (gnutls_certificate_credentials_t
1116 res, unsigned int flags);
1117 void gnutls_certificate_set_verify_limits (gnutls_certificate_credentials_t
1118 res, unsigned int max_bits,
1119 unsigned int max_depth);
1122 gnutls_certificate_set_x509_system_trust (gnutls_certificate_credentials_t cred);
1125 gnutls_certificate_set_x509_trust_file (gnutls_certificate_credentials_t
1126 cred, const char *cafile,
1127 gnutls_x509_crt_fmt_t type);
1128 int gnutls_certificate_set_x509_trust_mem (gnutls_certificate_credentials_t
1129 res, const gnutls_datum_t * ca,
1130 gnutls_x509_crt_fmt_t type);
1133 gnutls_certificate_set_x509_crl_file (gnutls_certificate_credentials_t
1134 res, const char *crlfile,
1135 gnutls_x509_crt_fmt_t type);
1136 int gnutls_certificate_set_x509_crl_mem (gnutls_certificate_credentials_t
1137 res, const gnutls_datum_t * CRL,
1138 gnutls_x509_crt_fmt_t type);
1141 gnutls_certificate_set_x509_key_file (gnutls_certificate_credentials_t
1142 res, const char *certfile,
1143 const char *keyfile,
1144 gnutls_x509_crt_fmt_t type);
1145 int gnutls_certificate_set_x509_key_mem (gnutls_certificate_credentials_t
1146 res, const gnutls_datum_t * cert,
1147 const gnutls_datum_t * key,
1148 gnutls_x509_crt_fmt_t type);
1150 void gnutls_certificate_send_x509_rdn_sequence (gnutls_session_t session,
1151 int status);
1153 int gnutls_certificate_set_x509_simple_pkcs12_file (gnutls_certificate_credentials_t res, const char *pkcs12file,
1154 gnutls_x509_crt_fmt_t type, const char *password);
1155 int gnutls_certificate_set_x509_simple_pkcs12_mem (gnutls_certificate_credentials_t res, const gnutls_datum_t * p12blob,
1156 gnutls_x509_crt_fmt_t type, const char *password);
1158 /* New functions to allow setting already parsed X.509 stuff.
1161 int gnutls_certificate_set_x509_key (gnutls_certificate_credentials_t res,
1162 gnutls_x509_crt_t * cert_list,
1163 int cert_list_size,
1164 gnutls_x509_privkey_t key);
1165 int gnutls_certificate_set_x509_trust (gnutls_certificate_credentials_t res,
1166 gnutls_x509_crt_t * ca_list,
1167 int ca_list_size);
1168 int gnutls_certificate_set_x509_crl (gnutls_certificate_credentials_t res,
1169 gnutls_x509_crl_t * crl_list,
1170 int crl_list_size);
1172 /* global state functions
1174 int gnutls_global_init (void);
1175 void gnutls_global_deinit (void);
1178 * gnutls_time_func:
1179 * @t: where to store time.
1181 * Function prototype for time()-like function. Set with
1182 * gnutls_global_set_time_function().
1184 * Returns: Number of seconds since the epoch, or (time_t)-1 on errors.
1186 typedef time_t (*gnutls_time_func) (time_t *t);
1188 typedef int (*mutex_init_func) (void **mutex);
1189 typedef int (*mutex_lock_func) (void **mutex);
1190 typedef int (*mutex_unlock_func) (void **mutex);
1191 typedef int (*mutex_deinit_func) (void **mutex);
1193 void gnutls_global_set_mutex (mutex_init_func init, mutex_deinit_func deinit,
1194 mutex_lock_func lock, mutex_unlock_func unlock);
1196 typedef void *(*gnutls_alloc_function) (size_t);
1197 typedef void *(*gnutls_calloc_function) (size_t, size_t);
1198 typedef int (*gnutls_is_secure_function) (const void *);
1199 typedef void (*gnutls_free_function) (void *);
1200 typedef void *(*gnutls_realloc_function) (void *, size_t);
1202 void
1203 gnutls_global_set_mem_functions (gnutls_alloc_function alloc_func,
1204 gnutls_alloc_function secure_alloc_func,
1205 gnutls_is_secure_function is_secure_func,
1206 gnutls_realloc_function realloc_func,
1207 gnutls_free_function free_func);
1209 void gnutls_global_set_time_function (gnutls_time_func time_func);
1211 /* For use in callbacks */
1212 extern gnutls_alloc_function gnutls_malloc;
1213 extern gnutls_alloc_function gnutls_secure_malloc;
1214 extern gnutls_realloc_function gnutls_realloc;
1215 extern gnutls_calloc_function gnutls_calloc;
1216 extern gnutls_free_function gnutls_free;
1218 extern char *(*gnutls_strdup) (const char *);
1220 typedef void (*gnutls_log_func) (int, const char *);
1221 typedef void (*gnutls_audit_log_func) (gnutls_session_t, const char *);
1222 void gnutls_global_set_log_function (gnutls_log_func log_func);
1223 void gnutls_global_set_audit_log_function (gnutls_audit_log_func log_func);
1224 void gnutls_global_set_log_level (int level);
1226 /* Diffie-Hellman parameter handling.
1228 int gnutls_dh_params_init (gnutls_dh_params_t * dh_params);
1229 void gnutls_dh_params_deinit (gnutls_dh_params_t dh_params);
1230 int gnutls_dh_params_import_raw (gnutls_dh_params_t dh_params,
1231 const gnutls_datum_t * prime,
1232 const gnutls_datum_t * generator);
1233 int gnutls_dh_params_import_pkcs3 (gnutls_dh_params_t params,
1234 const gnutls_datum_t * pkcs3_params,
1235 gnutls_x509_crt_fmt_t format);
1236 int gnutls_dh_params_generate2 (gnutls_dh_params_t params,
1237 unsigned int bits);
1238 int gnutls_dh_params_export_pkcs3 (gnutls_dh_params_t params,
1239 gnutls_x509_crt_fmt_t format,
1240 unsigned char *params_data,
1241 size_t * params_data_size);
1242 int gnutls_dh_params_export_raw (gnutls_dh_params_t params,
1243 gnutls_datum_t * prime,
1244 gnutls_datum_t * generator,
1245 unsigned int *bits);
1246 int gnutls_dh_params_cpy (gnutls_dh_params_t dst, gnutls_dh_params_t src);
1250 /* Session stuff
1252 typedef struct
1254 void *iov_base; /* Starting address */
1255 size_t iov_len; /* Number of bytes to transfer */
1256 } giovec_t;
1258 typedef ssize_t (*gnutls_pull_func) (gnutls_transport_ptr_t, void *,
1259 size_t);
1260 typedef ssize_t (*gnutls_push_func) (gnutls_transport_ptr_t, const void *,
1261 size_t);
1263 typedef int (*gnutls_pull_timeout_func) (gnutls_transport_ptr_t, unsigned int ms);
1265 typedef ssize_t (*gnutls_vec_push_func) (gnutls_transport_ptr_t,
1266 const giovec_t * iov, int iovcnt);
1268 typedef int (*gnutls_errno_func) (gnutls_transport_ptr_t);
1270 void gnutls_transport_set_ptr (gnutls_session_t session,
1271 gnutls_transport_ptr_t ptr);
1272 void gnutls_transport_set_ptr2 (gnutls_session_t session,
1273 gnutls_transport_ptr_t recv_ptr,
1274 gnutls_transport_ptr_t send_ptr);
1276 gnutls_transport_ptr_t gnutls_transport_get_ptr (gnutls_session_t session);
1277 void gnutls_transport_get_ptr2 (gnutls_session_t session,
1278 gnutls_transport_ptr_t * recv_ptr,
1279 gnutls_transport_ptr_t * send_ptr);
1281 void gnutls_transport_set_vec_push_function (gnutls_session_t session,
1282 gnutls_vec_push_func vec_func);
1283 void gnutls_transport_set_push_function (gnutls_session_t session,
1284 gnutls_push_func push_func);
1285 void gnutls_transport_set_pull_function (gnutls_session_t session,
1286 gnutls_pull_func pull_func);
1288 void gnutls_transport_set_pull_timeout_function (gnutls_session_t session,
1289 gnutls_pull_timeout_func func);
1291 void gnutls_transport_set_errno_function (gnutls_session_t session,
1292 gnutls_errno_func errno_func);
1294 void gnutls_transport_set_errno (gnutls_session_t session, int err);
1296 /* session specific
1298 void gnutls_session_set_ptr (gnutls_session_t session, void *ptr);
1299 void *gnutls_session_get_ptr (gnutls_session_t session);
1301 void gnutls_openpgp_send_cert (gnutls_session_t session,
1302 gnutls_openpgp_crt_status_t status);
1304 /* This function returns the hash of the given data.
1306 int gnutls_fingerprint (gnutls_digest_algorithm_t algo,
1307 const gnutls_datum_t * data, void *result,
1308 size_t * result_size);
1311 * gnutls_random_art_t:
1312 * @GNUTLS_RANDOM_ART_OPENSSH: OpenSSH-style random art.
1314 * Enumeration of different random art types.
1316 typedef enum gnutls_random_art
1318 GNUTLS_RANDOM_ART_OPENSSH=1,
1319 } gnutls_random_art_t;
1321 int gnutls_random_art (gnutls_random_art_t type,
1322 const char* key_type, unsigned int key_size,
1323 void * fpr, size_t fpr_size,
1324 gnutls_datum_t* art);
1326 /* SRP
1329 typedef struct gnutls_srp_server_credentials_st
1330 *gnutls_srp_server_credentials_t;
1331 typedef struct gnutls_srp_client_credentials_st
1332 *gnutls_srp_client_credentials_t;
1334 void
1335 gnutls_srp_free_client_credentials (gnutls_srp_client_credentials_t sc);
1337 gnutls_srp_allocate_client_credentials (gnutls_srp_client_credentials_t *
1338 sc);
1339 int gnutls_srp_set_client_credentials (gnutls_srp_client_credentials_t res,
1340 const char *username,
1341 const char *password);
1343 void
1344 gnutls_srp_free_server_credentials (gnutls_srp_server_credentials_t sc);
1346 gnutls_srp_allocate_server_credentials (gnutls_srp_server_credentials_t *
1347 sc);
1348 int gnutls_srp_set_server_credentials_file (gnutls_srp_server_credentials_t
1349 res, const char *password_file,
1350 const char *password_conf_file);
1352 const char *gnutls_srp_server_get_username (gnutls_session_t session);
1354 extern void gnutls_srp_set_prime_bits (gnutls_session_t session,
1355 unsigned int bits);
1357 int gnutls_srp_verifier (const char *username,
1358 const char *password,
1359 const gnutls_datum_t * salt,
1360 const gnutls_datum_t * generator,
1361 const gnutls_datum_t * prime,
1362 gnutls_datum_t * res);
1364 /* The static parameters defined in draft-ietf-tls-srp-05
1365 * Those should be used as input to gnutls_srp_verifier().
1367 extern const gnutls_datum_t gnutls_srp_4096_group_prime;
1368 extern const gnutls_datum_t gnutls_srp_4096_group_generator;
1370 extern const gnutls_datum_t gnutls_srp_3072_group_prime;
1371 extern const gnutls_datum_t gnutls_srp_3072_group_generator;
1373 extern const gnutls_datum_t gnutls_srp_2048_group_prime;
1374 extern const gnutls_datum_t gnutls_srp_2048_group_generator;
1376 extern const gnutls_datum_t gnutls_srp_1536_group_prime;
1377 extern const gnutls_datum_t gnutls_srp_1536_group_generator;
1379 extern const gnutls_datum_t gnutls_srp_1024_group_prime;
1380 extern const gnutls_datum_t gnutls_srp_1024_group_generator;
1382 typedef int gnutls_srp_server_credentials_function (gnutls_session_t,
1383 const char *username,
1384 gnutls_datum_t * salt,
1385 gnutls_datum_t *
1386 verifier,
1387 gnutls_datum_t *
1388 generator,
1389 gnutls_datum_t * prime);
1390 void
1391 gnutls_srp_set_server_credentials_function (
1392 gnutls_srp_server_credentials_t cred,
1393 gnutls_srp_server_credentials_function * func);
1395 typedef int gnutls_srp_client_credentials_function (gnutls_session_t,
1396 char **, char **);
1397 void
1398 gnutls_srp_set_client_credentials_function (
1399 gnutls_srp_client_credentials_t cred,
1400 gnutls_srp_client_credentials_function * func);
1402 int gnutls_srp_base64_encode (const gnutls_datum_t * data, char *result,
1403 size_t * result_size);
1404 int gnutls_srp_base64_encode_alloc (const gnutls_datum_t * data,
1405 gnutls_datum_t * result);
1407 int gnutls_srp_base64_decode (const gnutls_datum_t * b64_data, char *result,
1408 size_t * result_size);
1409 int gnutls_srp_base64_decode_alloc (const gnutls_datum_t * b64_data,
1410 gnutls_datum_t * result);
1412 /* PSK stuff */
1413 typedef struct gnutls_psk_server_credentials_st
1414 *gnutls_psk_server_credentials_t;
1415 typedef struct gnutls_psk_client_credentials_st
1416 *gnutls_psk_client_credentials_t;
1419 * gnutls_psk_key_flags:
1420 * @GNUTLS_PSK_KEY_RAW: PSK-key in raw format.
1421 * @GNUTLS_PSK_KEY_HEX: PSK-key in hex format.
1423 * Enumeration of different PSK key flags.
1425 typedef enum gnutls_psk_key_flags
1427 GNUTLS_PSK_KEY_RAW = 0,
1428 GNUTLS_PSK_KEY_HEX
1429 } gnutls_psk_key_flags;
1431 void
1432 gnutls_psk_free_client_credentials (gnutls_psk_client_credentials_t sc);
1434 gnutls_psk_allocate_client_credentials (gnutls_psk_client_credentials_t *
1435 sc);
1436 int gnutls_psk_set_client_credentials (gnutls_psk_client_credentials_t res,
1437 const char *username,
1438 const gnutls_datum_t * key,
1439 gnutls_psk_key_flags flags);
1441 void
1442 gnutls_psk_free_server_credentials (gnutls_psk_server_credentials_t sc);
1444 gnutls_psk_allocate_server_credentials (gnutls_psk_server_credentials_t *
1445 sc);
1446 int gnutls_psk_set_server_credentials_file (gnutls_psk_server_credentials_t
1447 res, const char *password_file);
1450 gnutls_psk_set_server_credentials_hint (gnutls_psk_server_credentials_t
1451 res, const char *hint);
1453 const char *gnutls_psk_server_get_username (gnutls_session_t session);
1454 const char *gnutls_psk_client_get_hint (gnutls_session_t session);
1456 typedef int gnutls_psk_server_credentials_function (gnutls_session_t,
1457 const char *username,
1458 gnutls_datum_t * key);
1459 void
1460 gnutls_psk_set_server_credentials_function (
1461 gnutls_psk_server_credentials_t cred,
1462 gnutls_psk_server_credentials_function * func);
1464 typedef int gnutls_psk_client_credentials_function (gnutls_session_t,
1465 char **username,
1466 gnutls_datum_t * key);
1467 void
1468 gnutls_psk_set_client_credentials_function (
1469 gnutls_psk_client_credentials_t cred,
1470 gnutls_psk_client_credentials_function * func);
1472 int gnutls_hex_encode (const gnutls_datum_t * data, char *result,
1473 size_t * result_size);
1474 int gnutls_hex_decode (const gnutls_datum_t * hex_data, void *result,
1475 size_t * result_size);
1477 void
1478 gnutls_psk_set_server_dh_params (gnutls_psk_server_credentials_t res,
1479 gnutls_dh_params_t dh_params);
1481 void
1482 gnutls_psk_set_server_params_function (gnutls_psk_server_credentials_t
1483 res,
1484 gnutls_params_function * func);
1487 * gnutls_x509_subject_alt_name_t:
1488 * @GNUTLS_SAN_DNSNAME: DNS-name SAN.
1489 * @GNUTLS_SAN_RFC822NAME: E-mail address SAN.
1490 * @GNUTLS_SAN_URI: URI SAN.
1491 * @GNUTLS_SAN_IPADDRESS: IP address SAN.
1492 * @GNUTLS_SAN_OTHERNAME: OtherName SAN.
1493 * @GNUTLS_SAN_DN: DN SAN.
1494 * @GNUTLS_SAN_OTHERNAME_XMPP: Virtual SAN, used by
1495 * gnutls_x509_crt_get_subject_alt_othername_oid.
1497 * Enumeration of different subject alternative names types.
1499 typedef enum gnutls_x509_subject_alt_name_t
1501 GNUTLS_SAN_DNSNAME = 1,
1502 GNUTLS_SAN_RFC822NAME = 2,
1503 GNUTLS_SAN_URI = 3,
1504 GNUTLS_SAN_IPADDRESS = 4,
1505 GNUTLS_SAN_OTHERNAME = 5,
1506 GNUTLS_SAN_DN = 6,
1507 /* The following are "virtual" subject alternative name types, in
1508 that they are represented by an otherName value and an OID.
1509 Used by gnutls_x509_crt_get_subject_alt_othername_oid. */
1510 GNUTLS_SAN_OTHERNAME_XMPP = 1000
1511 } gnutls_x509_subject_alt_name_t;
1513 struct gnutls_openpgp_crt_int;
1514 typedef struct gnutls_openpgp_crt_int *gnutls_openpgp_crt_t;
1516 struct gnutls_openpgp_privkey_int;
1517 typedef struct gnutls_openpgp_privkey_int *gnutls_openpgp_privkey_t;
1519 struct gnutls_pkcs11_privkey_st;
1520 typedef struct gnutls_pkcs11_privkey_st *gnutls_pkcs11_privkey_t;
1523 * gnutls_privkey_type_t:
1524 * @GNUTLS_PRIVKEY_X509: X.509 private key, #gnutls_x509_privkey_t.
1525 * @GNUTLS_PRIVKEY_OPENPGP: OpenPGP private key, #gnutls_openpgp_privkey_t.
1526 * @GNUTLS_PRIVKEY_PKCS11: PKCS11 private key, #gnutls_pkcs11_privkey_t.
1527 * @GNUTLS_PRIVKEY_EXT: External private key, operating using callbacks.
1529 * Enumeration of different private key types.
1531 typedef enum
1533 GNUTLS_PRIVKEY_X509,
1534 GNUTLS_PRIVKEY_OPENPGP,
1535 GNUTLS_PRIVKEY_PKCS11,
1536 GNUTLS_PRIVKEY_EXT
1537 } gnutls_privkey_type_t;
1539 typedef struct gnutls_retr2_st
1541 gnutls_certificate_type_t cert_type;
1542 gnutls_privkey_type_t key_type;
1544 union
1546 gnutls_x509_crt_t *x509;
1547 gnutls_openpgp_crt_t pgp;
1548 } cert;
1549 unsigned int ncerts; /* one for pgp keys */
1551 union
1553 gnutls_x509_privkey_t x509;
1554 gnutls_openpgp_privkey_t pgp;
1555 gnutls_pkcs11_privkey_t pkcs11;
1556 } key;
1558 unsigned int deinit_all; /* if non zero all keys will be deinited */
1559 } gnutls_retr2_st;
1562 /* Functions that allow auth_info_t structures handling
1565 gnutls_credentials_type_t gnutls_auth_get_type (gnutls_session_t session);
1566 gnutls_credentials_type_t
1567 gnutls_auth_server_get_type (gnutls_session_t session);
1568 gnutls_credentials_type_t
1569 gnutls_auth_client_get_type (gnutls_session_t session);
1571 /* DH */
1573 void gnutls_dh_set_prime_bits (gnutls_session_t session, unsigned int bits);
1574 int gnutls_dh_get_secret_bits (gnutls_session_t session);
1575 int gnutls_dh_get_peers_public_bits (gnutls_session_t session);
1576 int gnutls_dh_get_prime_bits (gnutls_session_t session);
1578 int gnutls_dh_get_group (gnutls_session_t session, gnutls_datum_t * raw_gen,
1579 gnutls_datum_t * raw_prime);
1580 int gnutls_dh_get_pubkey (gnutls_session_t session,
1581 gnutls_datum_t * raw_key);
1583 /* X509PKI */
1586 /* These are set on the credentials structure.
1589 /* use gnutls_certificate_set_retrieve_function2() in abstract.h
1590 * instead. It's much more efficient.
1593 typedef int gnutls_certificate_retrieve_function (gnutls_session_t,
1594 const
1595 gnutls_datum_t *
1596 req_ca_rdn,
1597 int nreqs,
1598 const
1599 gnutls_pk_algorithm_t
1600 * pk_algos,
1602 pk_algos_length,
1603 gnutls_retr2_st *);
1606 void gnutls_certificate_set_retrieve_function (
1607 gnutls_certificate_credentials_t cred,
1608 gnutls_certificate_retrieve_function * func);
1610 typedef int gnutls_certificate_verify_function (gnutls_session_t);
1611 void
1612 gnutls_certificate_set_verify_function (gnutls_certificate_credentials_t
1613 cred,
1614 gnutls_certificate_verify_function
1615 * func);
1617 void
1618 gnutls_certificate_server_set_request (gnutls_session_t session,
1619 gnutls_certificate_request_t req);
1621 /* get data from the session
1623 const gnutls_datum_t *gnutls_certificate_get_peers (gnutls_session_t
1624 session,
1625 unsigned int
1626 *list_size);
1627 const gnutls_datum_t *gnutls_certificate_get_ours (gnutls_session_t
1628 session);
1630 time_t gnutls_certificate_activation_time_peers (gnutls_session_t session);
1631 time_t gnutls_certificate_expiration_time_peers (gnutls_session_t session);
1633 int gnutls_certificate_client_get_request_status (gnutls_session_t session);
1634 int gnutls_certificate_verify_peers2 (gnutls_session_t session,
1635 unsigned int *status);
1637 int gnutls_pem_base64_encode (const char *msg, const gnutls_datum_t * data,
1638 char *result, size_t * result_size);
1639 int gnutls_pem_base64_decode (const char *header,
1640 const gnutls_datum_t * b64_data,
1641 unsigned char *result, size_t * result_size);
1643 int gnutls_pem_base64_encode_alloc (const char *msg,
1644 const gnutls_datum_t * data,
1645 gnutls_datum_t * result);
1646 int gnutls_pem_base64_decode_alloc (const char *header,
1647 const gnutls_datum_t * b64_data,
1648 gnutls_datum_t * result);
1650 /* key_usage will be an OR of the following values:
1653 /* when the key is to be used for signing: */
1654 #define GNUTLS_KEY_DIGITAL_SIGNATURE 128
1655 #define GNUTLS_KEY_NON_REPUDIATION 64
1656 /* when the key is to be used for encryption: */
1657 #define GNUTLS_KEY_KEY_ENCIPHERMENT 32
1658 #define GNUTLS_KEY_DATA_ENCIPHERMENT 16
1659 #define GNUTLS_KEY_KEY_AGREEMENT 8
1660 #define GNUTLS_KEY_KEY_CERT_SIGN 4
1661 #define GNUTLS_KEY_CRL_SIGN 2
1662 #define GNUTLS_KEY_ENCIPHER_ONLY 1
1663 #define GNUTLS_KEY_DECIPHER_ONLY 32768
1665 void
1666 gnutls_certificate_set_params_function (gnutls_certificate_credentials_t
1667 res,
1668 gnutls_params_function * func);
1669 void gnutls_anon_set_params_function (gnutls_anon_server_credentials_t res,
1670 gnutls_params_function * func);
1671 void gnutls_psk_set_params_function (gnutls_psk_server_credentials_t res,
1672 gnutls_params_function * func);
1674 int gnutls_hex2bin (const char *hex_data, size_t hex_size,
1675 void *bin_data, size_t * bin_size);
1677 /* Trust on first use (or ssh like) functions */
1679 /* stores the provided information to a database
1681 typedef int (*gnutls_tdb_store_func) (const char* db_name,
1682 const char* host,
1683 const char* service,
1684 time_t expiration,
1685 const gnutls_datum_t* pubkey);
1687 typedef int (*gnutls_tdb_store_commitment_func) (const char* db_name,
1688 const char* host,
1689 const char* service,
1690 time_t expiration,
1691 gnutls_digest_algorithm_t hash_algo,
1692 const gnutls_datum_t* hash);
1694 /* searches for the provided host/service pair that match the
1695 * provided public key in the database. */
1696 typedef int (*gnutls_tdb_verify_func) (const char* db_name,
1697 const char* host,
1698 const char* service,
1699 const gnutls_datum_t *pubkey);
1702 struct gnutls_tdb_int;
1703 typedef struct gnutls_tdb_int *gnutls_tdb_t;
1705 int gnutls_tdb_init (gnutls_tdb_t *tdb);
1706 void gnutls_tdb_set_store_func (gnutls_tdb_t tdb,
1707 gnutls_tdb_store_func store);
1708 void gnutls_tdb_set_store_commitment_func (gnutls_tdb_t tdb,
1709 gnutls_tdb_store_commitment_func cstore);
1710 void gnutls_tdb_set_verify_func (gnutls_tdb_t tdb,
1711 gnutls_tdb_verify_func verify);
1712 void gnutls_tdb_deinit (gnutls_tdb_t tdb);
1714 int gnutls_verify_stored_pubkey (const char* db_name,
1715 gnutls_tdb_t tdb,
1716 const char* host,
1717 const char* service,
1718 gnutls_certificate_type_t cert_type,
1719 const gnutls_datum_t * cert,
1720 unsigned int flags);
1722 int gnutls_store_commitment (const char* db_name,
1723 gnutls_tdb_t tdb,
1724 const char* host,
1725 const char* service,
1726 gnutls_digest_algorithm_t hash_algo,
1727 const gnutls_datum_t* hash,
1728 time_t expiration,
1729 unsigned int flags);
1731 int gnutls_store_pubkey (const char* db_name,
1732 gnutls_tdb_t tdb,
1733 const char* host,
1734 const char* service,
1735 gnutls_certificate_type_t cert_type,
1736 const gnutls_datum_t * cert,
1737 time_t expiration,
1738 unsigned int flags);
1740 /* Other help functions */
1741 int gnutls_load_file(const char* filename, gnutls_datum_t * data);
1743 /* Gnutls error codes. The mapping to a TLS alert is also shown in
1744 * comments.
1747 #define GNUTLS_E_SUCCESS 0
1748 #define GNUTLS_E_UNKNOWN_COMPRESSION_ALGORITHM -3
1749 #define GNUTLS_E_UNKNOWN_CIPHER_TYPE -6
1750 #define GNUTLS_E_LARGE_PACKET -7
1751 #define GNUTLS_E_UNSUPPORTED_VERSION_PACKET -8 /* GNUTLS_A_PROTOCOL_VERSION */
1752 #define GNUTLS_E_UNEXPECTED_PACKET_LENGTH -9 /* GNUTLS_A_RECORD_OVERFLOW */
1753 #define GNUTLS_E_INVALID_SESSION -10
1754 #define GNUTLS_E_FATAL_ALERT_RECEIVED -12
1755 #define GNUTLS_E_UNEXPECTED_PACKET -15 /* GNUTLS_A_UNEXPECTED_MESSAGE */
1756 #define GNUTLS_E_WARNING_ALERT_RECEIVED -16
1757 #define GNUTLS_E_ERROR_IN_FINISHED_PACKET -18
1758 #define GNUTLS_E_UNEXPECTED_HANDSHAKE_PACKET -19
1759 #define GNUTLS_E_UNKNOWN_CIPHER_SUITE -21 /* GNUTLS_A_HANDSHAKE_FAILURE */
1760 #define GNUTLS_E_UNWANTED_ALGORITHM -22
1761 #define GNUTLS_E_MPI_SCAN_FAILED -23
1762 #define GNUTLS_E_DECRYPTION_FAILED -24 /* GNUTLS_A_DECRYPTION_FAILED, GNUTLS_A_BAD_RECORD_MAC */
1763 #define GNUTLS_E_MEMORY_ERROR -25
1764 #define GNUTLS_E_DECOMPRESSION_FAILED -26 /* GNUTLS_A_DECOMPRESSION_FAILURE */
1765 #define GNUTLS_E_COMPRESSION_FAILED -27
1766 #define GNUTLS_E_AGAIN -28
1767 #define GNUTLS_E_EXPIRED -29
1768 #define GNUTLS_E_DB_ERROR -30
1769 #define GNUTLS_E_SRP_PWD_ERROR -31
1770 #define GNUTLS_E_INSUFFICIENT_CREDENTIALS -32
1771 #define GNUTLS_E_INSUFICIENT_CREDENTIALS GNUTLS_E_INSUFFICIENT_CREDENTIALS /* for backwards compatibility only */
1772 #define GNUTLS_E_INSUFFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS
1773 #define GNUTLS_E_INSUFICIENT_CRED GNUTLS_E_INSUFFICIENT_CREDENTIALS /* for backwards compatibility only */
1775 #define GNUTLS_E_HASH_FAILED -33
1776 #define GNUTLS_E_BASE64_DECODING_ERROR -34
1778 #define GNUTLS_E_MPI_PRINT_FAILED -35
1779 #define GNUTLS_E_REHANDSHAKE -37 /* GNUTLS_A_NO_RENEGOTIATION */
1780 #define GNUTLS_E_GOT_APPLICATION_DATA -38
1781 #define GNUTLS_E_RECORD_LIMIT_REACHED -39
1782 #define GNUTLS_E_ENCRYPTION_FAILED -40
1784 #define GNUTLS_E_PK_ENCRYPTION_FAILED -44
1785 #define GNUTLS_E_PK_DECRYPTION_FAILED -45
1786 #define GNUTLS_E_PK_SIGN_FAILED -46
1787 #define GNUTLS_E_X509_UNSUPPORTED_CRITICAL_EXTENSION -47
1788 #define GNUTLS_E_KEY_USAGE_VIOLATION -48
1789 #define GNUTLS_E_NO_CERTIFICATE_FOUND -49 /* GNUTLS_A_BAD_CERTIFICATE */
1790 #define GNUTLS_E_INVALID_REQUEST -50
1791 #define GNUTLS_E_SHORT_MEMORY_BUFFER -51
1792 #define GNUTLS_E_INTERRUPTED -52
1793 #define GNUTLS_E_PUSH_ERROR -53
1794 #define GNUTLS_E_PULL_ERROR -54
1795 #define GNUTLS_E_RECEIVED_ILLEGAL_PARAMETER -55 /* GNUTLS_A_ILLEGAL_PARAMETER */
1796 #define GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE -56
1797 #define GNUTLS_E_PKCS1_WRONG_PAD -57
1798 #define GNUTLS_E_RECEIVED_ILLEGAL_EXTENSION -58
1799 #define GNUTLS_E_INTERNAL_ERROR -59
1800 #define GNUTLS_E_DH_PRIME_UNACCEPTABLE -63
1801 #define GNUTLS_E_FILE_ERROR -64
1802 #define GNUTLS_E_TOO_MANY_EMPTY_PACKETS -78
1803 #define GNUTLS_E_UNKNOWN_PK_ALGORITHM -80
1804 #define GNUTLS_E_TOO_MANY_HANDSHAKE_PACKETS -81
1806 /* returned if you need to generate temporary RSA
1807 * parameters. These are needed for export cipher suites.
1809 #define GNUTLS_E_NO_TEMPORARY_RSA_PARAMS -84
1811 #define GNUTLS_E_NO_COMPRESSION_ALGORITHMS -86
1812 #define GNUTLS_E_NO_CIPHER_SUITES -87
1814 #define GNUTLS_E_OPENPGP_GETKEY_FAILED -88
1815 #define GNUTLS_E_PK_SIG_VERIFY_FAILED -89
1817 #define GNUTLS_E_ILLEGAL_SRP_USERNAME -90
1818 #define GNUTLS_E_SRP_PWD_PARSING_ERROR -91
1819 #define GNUTLS_E_NO_TEMPORARY_DH_PARAMS -93
1821 /* For certificate and key stuff
1823 #define GNUTLS_E_ASN1_ELEMENT_NOT_FOUND -67
1824 #define GNUTLS_E_ASN1_IDENTIFIER_NOT_FOUND -68
1825 #define GNUTLS_E_ASN1_DER_ERROR -69
1826 #define GNUTLS_E_ASN1_VALUE_NOT_FOUND -70
1827 #define GNUTLS_E_ASN1_GENERIC_ERROR -71
1828 #define GNUTLS_E_ASN1_VALUE_NOT_VALID -72
1829 #define GNUTLS_E_ASN1_TAG_ERROR -73
1830 #define GNUTLS_E_ASN1_TAG_IMPLICIT -74
1831 #define GNUTLS_E_ASN1_TYPE_ANY_ERROR -75
1832 #define GNUTLS_E_ASN1_SYNTAX_ERROR -76
1833 #define GNUTLS_E_ASN1_DER_OVERFLOW -77
1834 #define GNUTLS_E_OPENPGP_UID_REVOKED -79
1835 #define GNUTLS_E_CERTIFICATE_ERROR -43
1836 #define GNUTLS_E_X509_CERTIFICATE_ERROR GNUTLS_E_CERTIFICATE_ERROR
1837 #define GNUTLS_E_CERTIFICATE_KEY_MISMATCH -60
1838 #define GNUTLS_E_UNSUPPORTED_CERTIFICATE_TYPE -61 /* GNUTLS_A_UNSUPPORTED_CERTIFICATE */
1839 #define GNUTLS_E_X509_UNKNOWN_SAN -62
1840 #define GNUTLS_E_OPENPGP_FINGERPRINT_UNSUPPORTED -94
1841 #define GNUTLS_E_X509_UNSUPPORTED_ATTRIBUTE -95
1842 #define GNUTLS_E_UNKNOWN_HASH_ALGORITHM -96
1843 #define GNUTLS_E_UNKNOWN_PKCS_CONTENT_TYPE -97
1844 #define GNUTLS_E_UNKNOWN_PKCS_BAG_TYPE -98
1845 #define GNUTLS_E_INVALID_PASSWORD -99
1846 #define GNUTLS_E_MAC_VERIFY_FAILED -100 /* for PKCS #12 MAC */
1847 #define GNUTLS_E_CONSTRAINT_ERROR -101
1849 #define GNUTLS_E_WARNING_IA_IPHF_RECEIVED -102
1850 #define GNUTLS_E_WARNING_IA_FPHF_RECEIVED -103
1852 #define GNUTLS_E_IA_VERIFY_FAILED -104
1853 #define GNUTLS_E_UNKNOWN_ALGORITHM -105
1854 #define GNUTLS_E_UNSUPPORTED_SIGNATURE_ALGORITHM -106
1855 #define GNUTLS_E_SAFE_RENEGOTIATION_FAILED -107
1856 #define GNUTLS_E_UNSAFE_RENEGOTIATION_DENIED -108
1857 #define GNUTLS_E_UNKNOWN_SRP_USERNAME -109
1858 #define GNUTLS_E_PREMATURE_TERMINATION -110
1860 #define GNUTLS_E_BASE64_ENCODING_ERROR -201
1861 #define GNUTLS_E_INCOMPATIBLE_GCRYPT_LIBRARY -202 /* obsolete */
1862 #define GNUTLS_E_INCOMPATIBLE_CRYPTO_LIBRARY -202
1863 #define GNUTLS_E_INCOMPATIBLE_LIBTASN1_LIBRARY -203
1865 #define GNUTLS_E_OPENPGP_KEYRING_ERROR -204
1866 #define GNUTLS_E_X509_UNSUPPORTED_OID -205
1868 #define GNUTLS_E_RANDOM_FAILED -206
1869 #define GNUTLS_E_BASE64_UNEXPECTED_HEADER_ERROR -207
1871 #define GNUTLS_E_OPENPGP_SUBKEY_ERROR -208
1873 #define GNUTLS_E_CRYPTO_ALREADY_REGISTERED -209
1875 #define GNUTLS_E_HANDSHAKE_TOO_LARGE -210
1877 #define GNUTLS_E_CRYPTODEV_IOCTL_ERROR -211
1878 #define GNUTLS_E_CRYPTODEV_DEVICE_ERROR -212
1880 #define GNUTLS_E_CHANNEL_BINDING_NOT_AVAILABLE -213
1881 #define GNUTLS_E_BAD_COOKIE -214
1882 #define GNUTLS_E_OPENPGP_PREFERRED_KEY_ERROR -215
1883 #define GNUTLS_E_INCOMPAT_DSA_KEY_WITH_TLS_PROTOCOL -216
1885 /* PKCS11 related */
1886 #define GNUTLS_E_PKCS11_ERROR -300
1887 #define GNUTLS_E_PKCS11_LOAD_ERROR -301
1888 #define GNUTLS_E_PARSING_ERROR -302
1889 #define GNUTLS_E_PKCS11_PIN_ERROR -303
1891 #define GNUTLS_E_PKCS11_SLOT_ERROR -305
1892 #define GNUTLS_E_LOCKING_ERROR -306
1893 #define GNUTLS_E_PKCS11_ATTRIBUTE_ERROR -307
1894 #define GNUTLS_E_PKCS11_DEVICE_ERROR -308
1895 #define GNUTLS_E_PKCS11_DATA_ERROR -309
1896 #define GNUTLS_E_PKCS11_UNSUPPORTED_FEATURE_ERROR -310
1897 #define GNUTLS_E_PKCS11_KEY_ERROR -311
1898 #define GNUTLS_E_PKCS11_PIN_EXPIRED -312
1899 #define GNUTLS_E_PKCS11_PIN_LOCKED -313
1900 #define GNUTLS_E_PKCS11_SESSION_ERROR -314
1901 #define GNUTLS_E_PKCS11_SIGNATURE_ERROR -315
1902 #define GNUTLS_E_PKCS11_TOKEN_ERROR -316
1903 #define GNUTLS_E_PKCS11_USER_ERROR -317
1905 #define GNUTLS_E_CRYPTO_INIT_FAILED -318
1906 #define GNUTLS_E_TIMEDOUT -319
1907 #define GNUTLS_E_USER_ERROR -320
1908 #define GNUTLS_E_ECC_NO_SUPPORTED_CURVES -321
1909 #define GNUTLS_E_ECC_UNSUPPORTED_CURVE -322
1910 #define GNUTLS_E_PKCS11_REQUESTED_OBJECT_NOT_AVAILBLE -323
1911 #define GNUTLS_E_CERTIFICATE_LIST_UNSORTED -324
1912 #define GNUTLS_E_ILLEGAL_PARAMETER -325
1913 #define GNUTLS_E_NO_PRIORITIES_WERE_SET -326
1914 #define GNUTLS_E_X509_UNSUPPORTED_EXTENSION -327
1915 #define GNUTLS_E_SESSION_EOF -328
1917 #define GNUTLS_E_UNIMPLEMENTED_FEATURE -1250
1921 #define GNUTLS_E_APPLICATION_ERROR_MAX -65000
1922 #define GNUTLS_E_APPLICATION_ERROR_MIN -65500
1924 #ifdef __cplusplus
1926 #endif
1928 #include <gnutls/compat.h>
1930 #endif /* GNUTLS_H */