Orbit Framework 2.0.0
A high-performance asynchronous C++20 HTTP server framework.
Loading...
Searching...
No Matches
QuicConnection.hpp
Go to the documentation of this file.
1#pragma once
3
4#include <ngtcp2/ngtcp2.h>
5#include <ngtcp2/ngtcp2_crypto.h>
6#if defined(USE_NGTCP2_CRYPTO_OSSL)
7#include <ngtcp2/ngtcp2_crypto_ossl.h>
8#define NGTCP2_CRYPTO_CONFIGURE_SERVER_CONTEXT(ssl_ctx) (0)
9#elif defined(USE_NGTCP2_CRYPTO_QUICTLS)
10#include <ngtcp2/ngtcp2_crypto_quictls.h>
11#define NGTCP2_CRYPTO_CONFIGURE_SERVER_CONTEXT(ssl_ctx) ngtcp2_crypto_quictls_configure_server_context(ssl_ctx)
12#else
13#error "No supported ngtcp2 crypto backend found"
14#endif
15
16#include <openssl/ssl.h>
17#include <vector>
18#include <memory>
19#include <mutex>
20#include <chrono>
21#include <string>
23
24namespace orbit::server {
25
26namespace detail {
27
34bool quic_random_bytes(uint8_t* dest, size_t len);
35
36} // namespace detail
37
38namespace quic::detail {
39
41enum class ErrorAction {
42 Drain,
43 Drop,
44 Close
45};
46
48ErrorAction on_read_error(int ngtcp2_error);
49
52ErrorAction on_expiry_error(int ngtcp2_error);
53
54} // namespace quic::detail
55
58
62class QuicConnection : public std::enable_shared_from_this<QuicConnection> {
63public:
73 QuicConnection(QuicConnectionManager& manager, const ngtcp2_cid& client_dcid, const ngtcp2_cid& client_scid, const ngtcp2_cid& server_scid, const sockaddr_in& remote_addr, SSL_CTX* ssl_ctx);
75
82 void process_packet(const uint8_t* data, size_t datalen, const sockaddr_in& remote_addr);
83
89
91 int64_t ns_until_expiry() const;
92
94 bool is_closed() const { return closed_; }
95
98 std::vector<ngtcp2_cid> take_issued_cids();
99 std::vector<ngtcp2_cid> take_retired_cids();
100
103 std::recursive_mutex& mutex() { return mutex_; }
104
107 void extend_stream_credit(int64_t stream_id, uint64_t consumed);
108
113
118 std::string remote_ip() const;
119
120private:
122 sockaddr_in local_addr_;
123 sockaddr_in remote_addr_;
124 ngtcp2_conn* conn_{nullptr};
125 SSL* ssl_ = nullptr;
126#if defined(USE_NGTCP2_CRYPTO_OSSL)
127 ngtcp2_crypto_ossl_ctx* tls_ctx_ = nullptr;
128#endif
129 ngtcp2_crypto_conn_ref conn_ref_{};
130
131 std::unique_ptr<QuicHttp3Session> h3_session_;
132
133 mutable std::recursive_mutex mutex_;
134 bool closed_ = false;
135 // Closing or draining: no more packets are sent (except one
136 // CONNECTION_CLOSE), and the state is dropped at close_deadline_.
137 bool closing_ = false;
138 std::chrono::steady_clock::time_point close_deadline_{};
139 std::vector<ngtcp2_cid> issued_cids_;
140 std::vector<ngtcp2_cid> retired_cids_;
141
142 void start_closing(int liberr);
145
146 ngtcp2_tstamp get_timestamp() const;
147 bool init_ssl(SSL_CTX* ssl_ctx);
148
149 static int on_handshake_completed(ngtcp2_conn *conn, void *user_data);
150 static void rand_cb(uint8_t *dest, size_t destlen, const ngtcp2_rand_ctx *rand_ctx);
151 static int get_new_connection_id_cb(ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data);
152 static int get_path_challenge_data_cb(ngtcp2_conn *conn, uint8_t *data, void *user_data);
153 static int on_recv_stream_data(ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t offset, const uint8_t *data, size_t datalen, void *user_data, void *stream_user_data);
154 static int on_get_new_connection_id(ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data);
155 static int on_remove_connection_id(ngtcp2_conn *conn, const ngtcp2_cid *cid, void *user_data);
156 static int on_acked_stream_data_offset(ngtcp2_conn *conn, int64_t stream_id, uint64_t offset, uint64_t datalen, void *user_data, void *stream_user_data);
157 static int on_stream_close(ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data);
158 static int on_stream_reset(ngtcp2_conn *conn, int64_t stream_id, uint64_t final_size, uint64_t app_error_code, void *user_data, void *stream_user_data);
159 static int on_stream_stop_sending(ngtcp2_conn *conn, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data);
160 static int on_extend_max_stream_data(ngtcp2_conn *conn, int64_t stream_id, uint64_t max_data, void *user_data, void *stream_user_data);
161 static int on_extend_max_remote_streams_bidi(ngtcp2_conn *conn, uint64_t max_streams, void *user_data);
162};
163
164} // namespace server
Manages QUIC connections.
Definition QuicConnectionManager.hpp:57
Represents a single QUIC connection.
Definition QuicConnection.hpp:62
int64_t ns_until_expiry() const
Nanoseconds until the next timer is due (0 if overdue), or -1 if none.
void extend_stream_credit(int64_t stream_id, uint64_t consumed)
ngtcp2_tstamp get_timestamp() const
sockaddr_in local_addr_
Definition QuicConnection.hpp:122
std::recursive_mutex mutex_
Definition QuicConnection.hpp:133
static int on_stream_stop_sending(ngtcp2_conn *conn, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data)
std::recursive_mutex & mutex()
Definition QuicConnection.hpp:103
static int on_recv_stream_data(ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t offset, const uint8_t *data, size_t datalen, void *user_data, void *stream_user_data)
std::vector< ngtcp2_cid > retired_cids_
Definition QuicConnection.hpp:140
static int on_stream_close(ngtcp2_conn *conn, uint32_t flags, int64_t stream_id, uint64_t app_error_code, void *user_data, void *stream_user_data)
static int on_remove_connection_id(ngtcp2_conn *conn, const ngtcp2_cid *cid, void *user_data)
static int on_get_new_connection_id(ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data)
void process_packet(const uint8_t *data, size_t datalen, const sockaddr_in &remote_addr)
Processes an incoming QUIC packet.
QuicConnectionManager & manager()
Definition QuicConnection.hpp:114
static void rand_cb(uint8_t *dest, size_t destlen, const ngtcp2_rand_ctx *rand_ctx)
QuicConnection(QuicConnectionManager &manager, const ngtcp2_cid &client_dcid, const ngtcp2_cid &client_scid, const ngtcp2_cid &server_scid, const sockaddr_in &remote_addr, SSL_CTX *ssl_ctx)
Constructs a QuicConnection.
ngtcp2_conn * conn_
Definition QuicConnection.hpp:124
static int get_new_connection_id_cb(ngtcp2_conn *conn, ngtcp2_cid *cid, uint8_t *token, size_t cidlen, void *user_data)
std::vector< ngtcp2_cid > issued_cids_
Definition QuicConnection.hpp:139
bool is_closed() const
True once the connection has ended and can be forgotten.
Definition QuicConnection.hpp:94
static int on_acked_stream_data_offset(ngtcp2_conn *conn, int64_t stream_id, uint64_t offset, uint64_t datalen, void *user_data, void *stream_user_data)
QuicConnectionManager & manager_
Definition QuicConnection.hpp:121
ngtcp2_crypto_conn_ref conn_ref_
Definition QuicConnection.hpp:129
std::vector< ngtcp2_cid > take_issued_cids()
void send_pending_data()
Sends any pending data for the connection.
std::vector< ngtcp2_cid > take_retired_cids()
QuicHttp3Session * http3_session()
The HTTP/3 session, once the handshake has completed. Caller holds mutex().
Definition QuicConnection.hpp:116
static int on_handshake_completed(ngtcp2_conn *conn, void *user_data)
sockaddr_in remote_addr_
Definition QuicConnection.hpp:123
std::unique_ptr< QuicHttp3Session > h3_session_
Definition QuicConnection.hpp:131
static int on_stream_reset(ngtcp2_conn *conn, int64_t stream_id, uint64_t final_size, uint64_t app_error_code, void *user_data, void *stream_user_data)
bool closed_
Definition QuicConnection.hpp:134
std::string remote_ip() const
The peer's IP address as text.
static int get_path_challenge_data_cb(ngtcp2_conn *conn, uint8_t *data, void *user_data)
void handle_expiry()
Runs QUIC timers that are due (loss detection, delayed ACKs, idle timeout, the closing period)....
bool closing_
Definition QuicConnection.hpp:137
SSL * ssl_
Definition QuicConnection.hpp:125
std::chrono::steady_clock::time_point close_deadline_
Definition QuicConnection.hpp:138
void apply_error_action(quic::detail::ErrorAction action, int liberr)
static int on_extend_max_remote_streams_bidi(ngtcp2_conn *conn, uint64_t max_streams, void *user_data)
void start_closing(int liberr)
static int on_extend_max_stream_data(ngtcp2_conn *conn, int64_t stream_id, uint64_t max_data, void *user_data, void *stream_user_data)
bool init_ssl(SSL_CTX *ssl_ctx)
Manages an HTTP/3 session over a QUIC connection.
Definition QuicHttp3Session.hpp:90
bool quic_random_bytes(uint8_t *dest, size_t len)
Fills dest with bytes from the OpenSSL CSPRNG. QUIC connection IDs, stateless reset tokens and path c...
ErrorAction on_read_error(int ngtcp2_error)
For a failed ngtcp2_conn_read_pkt (RFC 9000 section 10.2).
ErrorAction
What happens to a connection after an ngtcp2 error.
Definition QuicConnection.hpp:41
@ Drain
The peer closed: send nothing more, keep state for 3 PTOs.
@ Drop
Forget the connection without sending anything.
@ Close
Send CONNECTION_CLOSE, then keep state for 3 PTOs.
ErrorAction on_expiry_error(int ngtcp2_error)
Definition Http2Session.hpp:18