Merge pull request #143 from MathiasKoch/enhancement/cancel-safe-read

enhancement(async): Make RecordReaders read fn cancel-safe

Author: lulf

src/asynch.rs

@@ -29,7 +29,7 @@ where
     delegate: Socket,
     opened: bool,
     key_schedule: KeySchedule<CipherSuite>,
-    record_reader: RecordReader<'a, CipherSuite>,
+    record_reader: RecordReader<'a>,
     record_write_buf: WriteBuffer<'a>,
     decrypted: DecryptedBufferInfo,
 }
@@ -365,7 +365,7 @@ where
     state: State,
     delegate: Socket,
     key_schedule: ReadKeySchedule<CipherSuite>,
-    record_reader: RecordReader<'a, CipherSuite>,
+    record_reader: RecordReader<'a>,
     decrypted: DecryptedBufferInfo,
 }
 

src/blocking.rs

@@ -28,7 +28,7 @@ where
     delegate: Socket,
     opened: bool,
     key_schedule: KeySchedule<CipherSuite>,
-    record_reader: RecordReader<'a, CipherSuite>,
+    record_reader: RecordReader<'a>,
     record_write_buf: WriteBuffer<'a>,
     decrypted: DecryptedBufferInfo,
 }
@@ -356,7 +356,7 @@ where
     state: State,
     delegate: Socket,
     key_schedule: ReadKeySchedule<CipherSuite>,
-    record_reader: RecordReader<'a, CipherSuite>,
+    record_reader: RecordReader<'a>,
     decrypted: DecryptedBufferInfo,
 }
 

src/connection.rs

@@ -168,7 +168,7 @@ impl<'a> State {
         self,
         transport: &mut Transport,
         handshake: &mut Handshake<Provider::CipherSuite>,
-        record_reader: &mut RecordReader<'_, Provider::CipherSuite>,
+        record_reader: &mut RecordReader<'_>,
         tx_buf: &mut WriteBuffer<'_>,
         key_schedule: &mut KeySchedule<Provider::CipherSuite>,
         config: &TlsConfig<'a>,
@@ -237,7 +237,7 @@ impl<'a> State {
         self,
         transport: &mut Transport,
         handshake: &mut Handshake<Provider::CipherSuite>,
-        record_reader: &mut RecordReader<'_, Provider::CipherSuite>,
+        record_reader: &mut RecordReader<'_>,
         tx_buf: &mut WriteBuffer,
         key_schedule: &mut KeySchedule<Provider::CipherSuite>,
         config: &TlsConfig<'a>,

src/record.rs

@@ -171,6 +171,8 @@ pub struct RecordHeader {
 }
 
 impl RecordHeader {
+    pub const LEN: usize = 5;
+
     pub fn content_type(&self) -> ContentType {
         // Content type already validated in read
         unwrap!(ContentType::of(self.header[0]))

src/record_reader.rs

@@ -1,5 +1,3 @@
-use core::marker::PhantomData;
-
 use crate::key_schedule::ReadKeySchedule;
 use embedded_io::{Error, Read as BlockingRead};
 use embedded_io_async::Read as AsyncRead;
@@ -10,22 +8,15 @@ use crate::{
     TlsError,
 };
 
-pub struct RecordReader<'a, CipherSuite>
-where
-    CipherSuite: TlsCipherSuite,
-{
+pub struct RecordReader<'a> {
     pub(crate) buf: &'a mut [u8],
     /// The number of decoded bytes in the buffer
     decoded: usize,
     /// The number of read but not yet decoded bytes in the buffer
     pending: usize,
-    cipher_suite: PhantomData<CipherSuite>,
 }
 
-impl<'a, CipherSuite> RecordReader<'a, CipherSuite>
-where
-    CipherSuite: TlsCipherSuite,
-{
+impl<'a> RecordReader<'a> {
     pub fn new(buf: &'a mut [u8]) -> Self {
         if buf.len() < 16640 {
             warn!("Read buffer is smaller than 16640 bytes, which may cause problems!");
@@ -34,33 +25,26 @@ where
             buf,
             decoded: 0,
             pending: 0,
-            cipher_suite: PhantomData,
         }
     }
 
-    pub async fn read<'m>(
+    pub async fn read<'m, CipherSuite: TlsCipherSuite>(
         &'m mut self,
         transport: &mut impl AsyncRead,
         key_schedule: &mut ReadKeySchedule<CipherSuite>,
     ) -> Result<ServerRecord<'m, CipherSuite>, TlsError> {
-        let header = self.advance(transport, 5).await?;
-        let header = RecordHeader::decode(unwrap!(header.try_into().ok()))?;
-
-        let content_length = header.content_length();
-        debug!(
-            "advance: {:?} - content_length = {} bytes",
-            header.content_type(),
-            content_length
-        );
-        let data = self.advance(transport, content_length).await?;
-        ServerRecord::decode(header, data, key_schedule.transcript_hash())
+        self.advance(transport, RecordHeader::LEN).await?;
+        let header = self.record_header()?;
+        self.advance(transport, RecordHeader::LEN + header.content_length())
+            .await?;
+        self.consume(header, key_schedule.transcript_hash())
     }
 
     async fn advance<'m>(
         &'m mut self,
         transport: &mut impl AsyncRead,
         amount: usize,
-    ) -> Result<&'m mut [u8], TlsError> {
+    ) -> Result<(), TlsError> {
         self.ensure_contiguous(amount)?;
 
         while self.pending < amount {
@@ -74,27 +58,25 @@ where
             self.pending += read;
         }
 
-        Ok(self.consume(amount))
+        Ok(())
     }
 
-    pub fn read_blocking<'m>(
+    pub fn read_blocking<'m, CipherSuite: TlsCipherSuite>(
         &'m mut self,
         transport: &mut impl BlockingRead,
         key_schedule: &mut ReadKeySchedule<CipherSuite>,
     ) -> Result<ServerRecord<'m, CipherSuite>, TlsError> {
-        let header = self.advance_blocking(transport, 5)?;
-        let header = RecordHeader::decode(unwrap!(header.try_into().ok()))?;
-
-        let content_length = header.content_length();
-        let data = self.advance_blocking(transport, content_length)?;
-        ServerRecord::decode(header, data, key_schedule.transcript_hash())
+        self.advance_blocking(transport, RecordHeader::LEN)?;
+        let header = self.record_header()?;
+        self.advance_blocking(transport, RecordHeader::LEN + header.content_length())?;
+        self.consume(header, key_schedule.transcript_hash())
     }
 
     fn advance_blocking<'m>(
         &'m mut self,
         transport: &mut impl BlockingRead,
         amount: usize,
-    ) -> Result<&'m mut [u8], TlsError> {
+    ) -> Result<(), TlsError> {
         self.ensure_contiguous(amount)?;
 
         while self.pending < amount {
@@ -107,14 +89,30 @@ where
             self.pending += read;
         }
 
-        Ok(self.consume(amount))
+        Ok(())
     }
 
-    fn consume(&mut self, amount: usize) -> &mut [u8] {
-        let slice = &mut self.buf[self.decoded..self.decoded + amount];
-        self.decoded += amount;
-        self.pending -= amount;
-        slice
+    fn record_header(&self) -> Result<RecordHeader, TlsError> {
+        RecordHeader::decode(unwrap!(self.buf
+            [self.decoded..self.decoded + RecordHeader::LEN]
+            .try_into()
+            .ok()))
+    }
+
+    fn consume<'m, CipherSuite: TlsCipherSuite>(
+        &'m mut self,
+        header: RecordHeader,
+        digest: &mut CipherSuite::Hash,
+    ) -> Result<ServerRecord<'m, CipherSuite>, TlsError> {
+        let content_len = header.content_length();
+
+        let slice = &mut self.buf
+            [self.decoded + RecordHeader::LEN..self.decoded + RecordHeader::LEN + content_len];
+
+        self.decoded += RecordHeader::LEN + content_len;
+        self.pending -= RecordHeader::LEN + content_len;
+
+        ServerRecord::decode(header, slice, digest)
     }
 
     fn ensure_contiguous(&mut self, len: usize) -> Result<(), TlsError> {
@@ -207,7 +205,7 @@ mod tests {
         );
 
         let mut buf = [0; 32];
-        let mut reader = RecordReader::<Aes128GcmSha256>::new(&mut buf);
+        let mut reader = RecordReader::new(&mut buf);
         let mut key_schedule = KeySchedule::<Aes128GcmSha256>::new();
 
         {
@@ -265,8 +263,8 @@ mod tests {
         ]
         .as_slice();
 
-        let mut buf = [0; 5]; // This buffer is so small that it cannot contain both the header and data
-        let mut reader = RecordReader::<Aes128GcmSha256>::new(&mut buf);
+        let mut buf = [0; 9]; // This buffer is so small that it cannot contain both the header and data
+        let mut reader = RecordReader::new(&mut buf);
         let mut key_schedule = KeySchedule::<Aes128GcmSha256>::new();
 
         {
@@ -279,8 +277,8 @@ mod tests {
                 panic!("Wrong server record");
             }
 
-            assert_eq!(4, reader.decoded); // The buffer is rotated after decoding the header
-            assert_eq!(1, reader.pending);
+            assert_eq!(9, reader.decoded); // The buffer is rotated after decoding the header
+            assert_eq!(0, reader.pending);
         }
 
         {
@@ -293,7 +291,7 @@ mod tests {
                 panic!("Wrong server record");
             }
 
-            assert_eq!(2, reader.decoded);
+            assert_eq!(7, reader.decoded);
             assert_eq!(0, reader.pending);
         }
     }
@@ -318,7 +316,7 @@ mod tests {
         .as_slice();
 
         let mut buf = [0; 32];
-        let mut reader = RecordReader::<Aes128GcmSha256>::new(&mut buf);
+        let mut reader = RecordReader::new(&mut buf);
         let mut key_schedule = KeySchedule::<Aes128GcmSha256>::new();
 
         {