summaryrefslogtreecommitdiffstats
path: root/src/contrib/libngtcp2/ngtcp2/ngtcp2_crypto_gnutls.h
blob: 5d4b9d962b77992fd84e3eedaf609b71deb02967 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*
 * ngtcp2
 *
 * Copyright (c) 2020 ngtcp2 contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef NGTCP2_CRYPTO_GNUTLS_H
#define NGTCP2_CRYPTO_GNUTLS_H

#include <ngtcp2/ngtcp2.h>

#include <gnutls/gnutls.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @function
 *
 * `ngtcp2_crypto_gnutls_from_gnutls_record_encryption_level`
 * translates |gtls_level| to :type:`ngtcp2_encryption_level`.  This
 * function is only available for GnuTLS backend.
 */
NGTCP2_EXTERN ngtcp2_encryption_level
ngtcp2_crypto_gnutls_from_gnutls_record_encryption_level(
    gnutls_record_encryption_level_t gtls_level);

/**
 * @function
 *
 * `ngtcp2_crypto_gnutls_from_ngtcp2_encryption_level` translates
 * |encryption_level| to gnutls_record_encryption_level_t.  This
 * function is only available for GnuTLS backend.
 */
NGTCP2_EXTERN gnutls_record_encryption_level_t
ngtcp2_crypto_gnutls_from_ngtcp2_encryption_level(
    ngtcp2_encryption_level encryption_level);

/**
 * @function
 *
 * `ngtcp2_crypto_gnutls_configure_server_session` configures
 * |session| for server side QUIC connection.  It performs the
 * following modifications:
 *
 * - Set gnutls_handshake_set_secret_function.
 * - Set gnutls_handshake_set_read_function.
 * - Set gnutls_alert_set_read_function.
 * - Register a TLS extension handler for QUIC Transport Parameters.
 *
 * Application must set a pointer to :type:`ngtcp2_crypto_conn_ref` to
 * gnutls_session_t object by calling gnutls_session_set_ptr, and
 * :type:`ngtcp2_crypto_conn_ref` object must have
 * :member:`ngtcp2_crypto_conn_ref.get_conn` field assigned to get
 * :type:`ngtcp2_conn`.
 *
 * It returns 0 if it succeeds, or -1.
 */
NGTCP2_EXTERN int
ngtcp2_crypto_gnutls_configure_server_session(gnutls_session_t session);

/**
 * @function
 *
 * `ngtcp2_crypto_gnutls_configure_client_session` configures
 * |session| for client side QUIC connection.  It performs the
 * following modifications:
 *
 * - Set gnutls_handshake_set_secret_function.
 * - Set gnutls_handshake_set_read_function.
 * - Set gnutls_alert_set_read_function.
 * - Register a TLS extension handler for QUIC Transport Parameters.
 *
 * Application must set a pointer to :type:`ngtcp2_crypto_conn_ref` to
 * gnutls_session_t object by calling gnutls_session_set_ptr, and
 * :type:`ngtcp2_crypto_conn_ref` object must have
 * :member:`ngtcp2_crypto_conn_ref.get_conn` field assigned to get
 * :type:`ngtcp2_conn`.
 *
 * It returns 0 if it succeeds, or -1.
 */
NGTCP2_EXTERN int
ngtcp2_crypto_gnutls_configure_client_session(gnutls_session_t session);

#ifdef __cplusplus
}
#endif

#endif /* NGTCP2_CRYPTO_GNUTLS_H */