summaryrefslogtreecommitdiffstats
path: root/src/libknot/xdp/quic.h
blob: 943a2f371ce9dac426978fd5f33e28533d80e743 (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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*  Copyright (C) 2022 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/*!
 * \file
 *
 * \brief General QUIC functionality.
 *
 * \addtogroup xdp
 * @{
 */

#pragma once

#include "libknot/xdp/quic_conn.h"
#include "libknot/xdp/xdp.h"

struct knot_quic_creds;
struct knot_quic_session;

/*!
 * \brief Gets data needed for session resumption.
 *
 * \param conn   QUIC connection.
 *
 * \return QUIC session context.
 */
struct knot_quic_session *knot_xquic_session_save(knot_xquic_conn_t *conn);

/*!
 * \brief Loads data needed for session resumption.
 *
 * \param conn     QUIC connection.
 * \param session  QUIC session context.
 *
 * \return KNOT_E*
 */
int knot_xquic_session_load(knot_xquic_conn_t *conn, struct knot_quic_session *session);

/*!
 * \brief Init server TLS certificate for DoQ.
 *
 * \param server      Initializing for server-side (client otherwise).
 * \param tls_cert    X509 certificate PEM file path/name.
 * \param tls_key     Key PEM file path/name.
 *
 * \return Initialized creds.
 */
struct knot_quic_creds *knot_xquic_init_creds(bool server, const char *tls_cert,
                                              const char *tls_key);

/*!
 * \brief Init server TLS certificate for DoQ.
 */
void knot_xquic_free_creds(struct knot_quic_creds *creds);

/*!
 * \brief Returns timeout value for the connection.
 */
uint64_t xquic_conn_get_timeout(knot_xquic_conn_t *conn);

/*!
 * \brief Check if connection timed out due to inactivity.
 *
 * \param conn   QUIC connection.
 * \param now    In/out: current monotonic time. Use zero first and reuse for
 *               next calls for optimization.
 *
 * \return True if the connection timed out idle.
 */
bool xquic_conn_timeout(knot_xquic_conn_t *conn, uint64_t *now);

/*!
 * \brief Returns measured connection RTT in usecs.
 */
uint32_t knot_xquic_conn_rtt(knot_xquic_conn_t *conn);

/*!
 * \brief Create new outgoing QUIC connection.
 *
 * \param table       QUIC connections table to be added to.
 * \param dest        Destination IP address.
 * \param via         Source IP address.
 * \param out_conn    Out: new connection.
 *
 * \return KNOT_E*
 */
int knot_xquic_client(knot_xquic_table_t *table, struct sockaddr_in6 *dest,
                      struct sockaddr_in6 *via, knot_xquic_conn_t **out_conn);

/*!
 * \brief Handle incoming QUIC packet.
 *
 * \param table           QUIC connectoins table-
 * \param msg             Incoming XDP packet.
 * \param idle_timeout    Configured idle timeout for connections (in nanoseconds).
 * \param out_conn        Out: QUIC connection that this packet belongs to.
 *
 * \return KNOT_E*
 */
int knot_xquic_handle(knot_xquic_table_t *table, knot_xdp_msg_t *msg,
                      uint64_t idle_timeout, knot_xquic_conn_t **out_conn);

/*!
 * \brief Send outgoing QUIC packet(s) for a connection.
 *
 * \param quic_table         QUIC connection table.
 * \param relay              QUIC connection.
 * \param sock               XDP socket.
 * \param in_msg             Previous incomming packet for this connection.
 * \param handle_ret         Error returned from knot_xquic_handle() for incoming packet.
 * \param max_msgs           Maxmimum packets to be sent.
 * \param ignore_lastbyte    Cut off last byte of QUIC paylod.
 *
 * \return KNOT_E*
 */
int knot_xquic_send(knot_xquic_table_t *quic_table, knot_xquic_conn_t *relay,
                    knot_xdp_socket_t *sock, knot_xdp_msg_t *in_msg,
                    int handle_ret, unsigned max_msgs, bool ignore_lastbyte);

/*! @} */