openkache 0.1.3

Rust client for the OpenKache cache server
Documentation
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
//! Strict TLS-over-TCP binding for one transport-neutral request lane.
//!
//! The binding owns TLS 1.3 setup and opaque frame delimiting only. It never
//! interprets operation payloads, so value parsing remains in the protocol and
//! client API layers.

use std::net::SocketAddr;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};
use std::time::Duration;

use crate::internal_protocol::{
    MAX_REQUEST_FRAME_BYTES, MAX_RESPONSE_FRAME_BYTES, ResponseHeaderBytes, ResponseParts,
};
use futures_util::future::BoxFuture;
use futures_util::lock::Mutex;
use rustls::crypto::SupportedKxGroup;
use tokio::io::{AsyncReadExt, AsyncWriteExt, ReadHalf, WriteHalf};
use tokio::net::TcpStream;
use tokio_rustls::client::TlsStream;

use super::{
    ClientConnection, ClientLane, Deadline, RequestBudget, RequestBudgetPermit,
    enforce_client_profile, response_frame_len, validate_response_frame,
};
use crate::internal_core::config::PQ_GROUP;
use crate::internal_core::request::RequestAttempt;
use crate::internal_core::request_engine::{
    RequestBytes, TransportConnection, TransportError, TransportKind, TransportLane,
};
use crate::internal_core::{Error, Operation, Result};

type ClientTlsStream = TlsStream<TcpStream>;

/// One TLS-over-TCP connection containing its single ordered lane.
pub struct TlsTcpTransport {
    lane: Arc<TlsTcpLane>,
}

/// Compatibility spelling for the TLS-over-TCP transport binding.
pub type TcpTransport = TlsTcpTransport;

/// One TLS-over-TCP request lane.
///
/// TCP supplies one ordered byte stream, so a connection exposes exactly one
/// lane. The TLS stream is split into independently locked halves to permit
/// pipelined writes while a complete response frame is awaited.
pub struct TlsTcpLane {
    send: Arc<Mutex<WriteHalf<ClientTlsStream>>>,
    receive: Arc<Mutex<ReadHalf<ClientTlsStream>>>,
    closed: Arc<AtomicBool>,
    fatal: Arc<AtomicBool>,
}

/// Compatibility spelling for the TLS-over-TCP lane.
pub type TcpLane = TlsTcpLane;

impl TlsTcpTransport {
    /// Establishes the one-lane TLS-over-TCP OpenKache profile.
    ///
    /// The supplied configuration must offer only `openkache/1` and the
    /// mandatory `X25519MLKEM768` group. The handshake is revalidated before
    /// application bytes are exposed, so a caller cannot accidentally use a
    /// plaintext or classical-only fallback.
    pub async fn connect(
        address: SocketAddr,
        server_name: &str,
        tls: rustls::ClientConfig,
        timeout: Duration,
    ) -> crate::internal_core::Result<Self> {
        if tokio::runtime::Handle::try_current().is_err() {
            return Err(crate::internal_core::Error::Connection(
                "an active Tokio runtime is required".into(),
            ));
        }
        let mut tls = tls;
        enforce_client_profile(&mut tls)?;
        let server_name =
            rustls::pki_types::ServerName::try_from(server_name.to_owned()).map_err(|error| {
                crate::internal_core::Error::configuration("server_name", error.to_string())
            })?;
        let socket = tokio::time::timeout(timeout, TcpStream::connect(address))
            .await
            .map_err(|_| crate::internal_core::Error::Timeout {
                operation: crate::internal_core::Operation::ConnectionSetup,
            })?
            .map_err(crate::internal_core::Error::io)?;
        socket
            .set_nodelay(true)
            .map_err(crate::internal_core::Error::io)?;
        let connector = tokio_rustls::TlsConnector::from(Arc::new(tls));
        let stream = tokio::time::timeout(timeout, connector.connect(server_name, socket))
            .await
            .map_err(|_| crate::internal_core::Error::Timeout {
                operation: crate::internal_core::Operation::Handshake,
            })?
            .map_err(crate::internal_core::Error::io)?;
        validate_handshake(&stream)?;
        let (receive, send) = tokio::io::split(stream);
        Ok(Self {
            lane: Arc::new(TlsTcpLane {
                send: Arc::new(Mutex::new(send)),
                receive: Arc::new(Mutex::new(receive)),
                closed: Arc::new(AtomicBool::new(false)),
                fatal: Arc::new(AtomicBool::new(false)),
            }),
        })
    }

    /// Returns the negotiated ALPN protocol.
    pub(crate) fn negotiated_alpn(&self) -> Option<&[u8]> {
        Some(crate::internal_protocol::ALPN)
    }
}

impl TlsTcpLane {
    /// Reads one response while reserving the payload budget before allocation.
    ///
    /// The low-level [`TransportLane`] API intentionally returns one complete
    /// frame for callers that own their own resource policy. The request
    /// engine uses this variant so a declared response body cannot be read
    /// into an unbudgeted frame before the shared aggregate byte permit is
    /// acquired.
    async fn read_response_with_budget(
        &self,
        maximum: usize,
        budget: &RequestBudget,
        timeout: Duration,
    ) -> Result<(ResponseParts, RequestBudgetPermit)> {
        if self.fatal.load(Ordering::Acquire) {
            return Err(Error::Connection("TLS-over-TCP lane has failed".into()));
        }
        let maximum = maximum.min(MAX_RESPONSE_FRAME_BYTES);
        if maximum == 0 {
            return Err(Error::configuration(
                "response maximum",
                "must be greater than zero",
            ));
        }
        let mut receive = self.receive.lock().await;
        let mut header = ResponseHeaderBytes::new();
        let frame_len = loop {
            let mut byte = [0_u8; 1];
            if let Err(error) = receive.read_exact(&mut byte).await {
                close_after_transport_error(&self.send, &self.closed, &self.fatal);
                return Err(Error::Connection(error.to_string()));
            }
            header.push(byte[0]).map_err(|error| {
                close_after_protocol_error(&self.send, &self.closed, &self.fatal);
                Error::protocol(error)
            })?;
            match response_frame_len(header.as_slice(), maximum) {
                Ok(Some(length)) => break length,
                Ok(None) => continue,
                Err(error) => {
                    close_after_protocol_error(&self.send, &self.closed, &self.fatal);
                    return Err(Error::Connection(error));
                }
            }
        };
        let header_len = header.len();
        if header_len > frame_len {
            close_after_protocol_error(&self.send, &self.closed, &self.fatal);
            return Err(Error::Connection(
                "response header exceeds complete frame".into(),
            ));
        }
        let payload_len = frame_len - header_len;
        let permit = match budget.acquire(payload_len, timeout).await {
            Ok(permit) => permit,
            Err(error) => {
                // The body is still unread, so this ordered TCP lane cannot
                // be returned to the pool after an admission failure.
                self.close();
                return Err(error);
            }
        };
        let mut payload = Vec::new();
        if payload.try_reserve_exact(payload_len).is_err() {
            drop(permit);
            close_after_protocol_error(&self.send, &self.closed, &self.fatal);
            return Err(Error::Connection("response allocation failed".into()));
        }
        payload.resize(payload_len, 0);
        if payload_len > 0
            && let Err(error) = receive.read_exact(&mut payload).await
        {
            drop(permit);
            close_after_transport_error(&self.send, &self.closed, &self.fatal);
            return Err(Error::Connection(error.to_string()));
        }
        let response = ResponseParts::decode(header, payload).map_err(|error| {
            close_after_protocol_error(&self.send, &self.closed, &self.fatal);
            Error::protocol(error)
        })?;
        Ok((response, permit))
    }
}

impl TransportConnection for TlsTcpTransport {
    fn kind(&self) -> TransportKind {
        TransportKind::TlsTcp
    }

    fn lanes(&self) -> Vec<Arc<dyn TransportLane>> {
        vec![Arc::clone(&self.lane) as Arc<dyn TransportLane>]
    }

    fn close(&self) {
        self.lane.close();
    }
}

impl TransportLane for TlsTcpLane {
    fn write_request(
        &self,
        request: RequestBytes,
    ) -> BoxFuture<'static, std::result::Result<(), TransportError>> {
        let send = Arc::clone(&self.send);
        let closed = Arc::clone(&self.closed);
        let fatal = Arc::clone(&self.fatal);
        Box::pin(async move {
            if closed.load(Ordering::Acquire) {
                return Err(TransportError::before_send("TLS-over-TCP lane is closed"));
            }
            if request.is_empty() {
                return Err(TransportError::before_send(
                    "request frame must not be empty",
                ));
            }
            if request.len() > MAX_REQUEST_FRAME_BYTES {
                return Err(TransportError::before_send(format!(
                    "request frame exceeds {MAX_REQUEST_FRAME_BYTES} bytes"
                )));
            }
            let mut send = send.lock().await;
            let mut transmitted = false;
            for segment in request.segments() {
                let mut offset = 0;
                while offset < segment.len() {
                    match send.write(&segment[offset..]).await {
                        Ok(written) if written > 0 => {
                            transmitted = true;
                            offset += written;
                        }
                        Ok(_) => {
                            closed.store(true, Ordering::Release);
                            fatal.store(true, Ordering::Release);
                            let _ = send.shutdown().await;
                            return Err(if transmitted {
                                TransportError::after_send("TLS write made no progress")
                            } else {
                                TransportError::before_send("TLS write made no progress")
                            });
                        }
                        Err(error) => {
                            closed.store(true, Ordering::Release);
                            fatal.store(true, Ordering::Release);
                            let _ = send.shutdown().await;
                            return Err(if transmitted {
                                TransportError::after_send(error.to_string())
                            } else {
                                TransportError::before_send(error.to_string())
                            });
                        }
                    }
                }
            }
            if let Err(error) = send.flush().await {
                closed.store(true, Ordering::Release);
                fatal.store(true, Ordering::Release);
                let _ = send.shutdown().await;
                return Err(TransportError::after_send(error.to_string()));
            }
            if closed.load(Ordering::Acquire) {
                let _ = send.shutdown().await;
                return Err(TransportError::after_send("TLS-over-TCP lane is closing"));
            }
            Ok(())
        })
    }

    fn read_response(
        &self,
        maximum: usize,
    ) -> BoxFuture<'static, std::result::Result<Vec<u8>, TransportError>> {
        let receive = Arc::clone(&self.receive);
        let send = Arc::clone(&self.send);
        let closed = Arc::clone(&self.closed);
        let fatal = Arc::clone(&self.fatal);
        Box::pin(async move {
            if fatal.load(Ordering::Acquire) {
                return Err(TransportError::after_send("TLS-over-TCP lane has failed"));
            }
            let maximum = maximum.min(MAX_RESPONSE_FRAME_BYTES);
            if maximum == 0 {
                return Err(TransportError::before_send(
                    "response maximum must be greater than zero",
                ));
            }
            let mut receive = receive.lock().await;
            let mut header = Vec::with_capacity(32);
            let frame_len = loop {
                let mut byte = [0_u8; 1];
                if let Err(error) = receive.read_exact(&mut byte).await {
                    close_after_transport_error(&send, &closed, &fatal);
                    return Err(TransportError::after_send(error.to_string()));
                }
                header.push(byte[0]);
                match response_frame_len(&header, maximum) {
                    Ok(Some(length)) => break length,
                    Ok(None) => continue,
                    Err(error) => {
                        close_after_protocol_error(&send, &closed, &fatal);
                        return Err(TransportError::after_send(error));
                    }
                }
            };
            let header_len = header.len();
            if header_len > frame_len {
                close_after_protocol_error(&send, &closed, &fatal);
                return Err(TransportError::after_send(
                    "response header exceeds complete frame",
                ));
            }
            let mut frame = header;
            frame
                .try_reserve_exact(frame_len.saturating_sub(header_len))
                .map_err(|_| {
                    close_after_protocol_error(&send, &closed, &fatal);
                    TransportError::after_send("response allocation failed")
                })?;
            frame.resize(frame_len, 0);
            if header_len < frame_len {
                if let Err(error) = receive.read_exact(&mut frame[header_len..]).await {
                    close_after_transport_error(&send, &closed, &fatal);
                    return Err(TransportError::after_send(error.to_string()));
                }
            }
            if let Err(error) = validate_response_frame(&frame, frame_len) {
                close_after_protocol_error(&send, &closed, &fatal);
                return Err(TransportError::after_send(error));
            }
            Ok(frame)
        })
    }

    fn close(&self) {
        if self.closed.swap(true, Ordering::AcqRel) {
            return;
        }
        // A TLS close-notify cleanly half-closes the request direction while
        // retaining the receive half so already admitted responses can drain.
        shutdown_send(&self.send);
    }
}

fn close_after_protocol_error(
    send: &Arc<Mutex<WriteHalf<ClientTlsStream>>>,
    closed: &Arc<AtomicBool>,
    fatal: &Arc<AtomicBool>,
) {
    fatal.store(true, Ordering::Release);
    if closed.swap(true, Ordering::AcqRel) {
        return;
    }
    shutdown_send(send);
}

fn close_after_transport_error(
    send: &Arc<Mutex<WriteHalf<ClientTlsStream>>>,
    closed: &Arc<AtomicBool>,
    fatal: &Arc<AtomicBool>,
) {
    close_after_protocol_error(send, closed, fatal);
}

fn shutdown_send(send: &Arc<Mutex<WriteHalf<ClientTlsStream>>>) {
    let send = Arc::clone(send);
    if let Ok(handle) = tokio::runtime::Handle::try_current() {
        handle.spawn(async move {
            let mut send = send.lock().await;
            let _ = send.shutdown().await;
        });
    }
}

fn validate_handshake(stream: &ClientTlsStream) -> crate::internal_core::Result<()> {
    let (_, connection) = stream.get_ref();
    if connection.protocol_version() != Some(rustls::ProtocolVersion::TLSv1_3) {
        return Err(crate::internal_core::Error::Connection(
            "server did not negotiate TLS 1.3".into(),
        ));
    }
    if connection.alpn_protocol() != Some(crate::internal_protocol::ALPN) {
        return Err(crate::internal_core::Error::Connection(
            "server did not negotiate openkache/1".into(),
        ));
    }
    if connection
        .negotiated_key_exchange_group()
        .map(SupportedKxGroup::name)
        != Some(PQ_GROUP)
    {
        return Err(crate::internal_core::Error::Connection(
            "server did not negotiate X25519MLKEM768".into(),
        ));
    }
    Ok(())
}

/// Internal request-engine connection wrapper for the one-lane TCP profile.
///
/// The public [`TransportConnection`] surface permits pipelined writes, while
/// the legacy high-level request API expects one request/response exchange per
/// acquired lane.  A single async gate preserves that API's correlation
/// invariant without inventing a second TCP lane.
pub(crate) struct Connection {
    inner: TlsTcpTransport,
    gate: Mutex<()>,
    budget: RequestBudget,
}

pub(crate) struct Lane<'a> {
    connection: &'a Connection,
    _gate: futures_util::lock::MutexGuard<'a, ()>,
    response_permit: Option<RequestBudgetPermit>,
}

impl ClientConnection for Connection {
    type Lane<'a> = Lane<'a>;

    async fn connect(
        address: SocketAddr,
        server_name: &str,
        tls: rustls::ClientConfig,
        timeout: Duration,
        _max_stream_lanes: usize,
        budget: RequestBudget,
    ) -> Result<Self> {
        Ok(Self {
            inner: TlsTcpTransport::connect(address, server_name, tls, timeout).await?,
            gate: Mutex::new(()),
            budget,
        })
    }

    async fn acquire_lane(&self, deadline: Deadline) -> Result<Self::Lane<'_>> {
        let remaining = deadline.remaining(Operation::StreamAcquisition)?;
        let gate = tokio::time::timeout(remaining, self.gate.lock())
            .await
            .map_err(|_| Error::Timeout {
                operation: Operation::StreamAcquisition,
            })?;
        Ok(Lane {
            connection: self,
            _gate: gate,
            response_permit: None,
        })
    }

    fn negotiated_alpn(&self) -> Option<&[u8]> {
        self.inner.negotiated_alpn()
    }

    async fn timeout<F: std::future::Future>(
        duration: Duration,
        future: F,
    ) -> Result<Option<F::Output>> {
        if tokio::runtime::Handle::try_current().is_err() {
            return Err(Error::Connection(
                "an active Tokio runtime is required".into(),
            ));
        }
        Ok(tokio::time::timeout(duration, future).await.ok())
    }

    fn close(&self) {
        self.inner.close();
    }
}

impl ClientLane for Lane<'_> {
    async fn write_request(&mut self, request: RequestAttempt, timeout: Duration) -> Result<()> {
        let frame = match request {
            RequestAttempt::Once(frame) => frame,
            RequestAttempt::Replay(frame) => frame.clone_owned().map_err(Error::protocol)?,
        };
        let request = RequestBytes::new(frame);
        let _permit = self.connection.budget.try_reserve(request.len())?;
        match tokio::time::timeout(timeout, self.connection.inner.lane.write_request(request)).await
        {
            Ok(result) => result.map_err(|error| Error::Connection(error.to_string())),
            Err(_) => {
                self.connection.inner.close();
                Err(Error::Timeout {
                    operation: Operation::RequestWrite,
                })
            }
        }
    }

    async fn read_response(
        &mut self,
        maximum: usize,
        deadline: Deadline,
    ) -> Result<crate::internal_protocol::ResponseParts> {
        let remaining = deadline.remaining(Operation::ResponseBodyRead)?;
        let (decoded, permit) = match tokio::time::timeout(
            remaining,
            self.connection.inner.lane.read_response_with_budget(
                maximum,
                &self.connection.budget,
                remaining,
            ),
        )
        .await
        {
            Ok(result) => result?,
            Err(_) => {
                self.connection.inner.close();
                return Err(Error::Timeout {
                    operation: Operation::ResponseBodyRead,
                });
            }
        };
        self.response_permit = Some(permit);
        Ok(decoded)
    }

    fn take_response_permit(&mut self) -> Option<RequestBudgetPermit> {
        self.response_permit.take()
    }

    fn release(self) {}
}