serdect: return the deserialized buffer during deserialization (#1515)

Fixes #1322
RustCrypto · Sep 10, 2024 · 816286f · 816286f
1 parent 320ee91
commit 816286f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/serdect/src/array.rs b/serdect/src/array.rs
@@ -57,7 +57,7 @@ impl LengthCheck for ExactLength {
 /// Deserialize from hex when using human-readable formats or binary if the
 /// format is binary. Fails if the `buffer` isn't the exact same size as the
 /// resulting array.
-pub fn deserialize_hex_or_bin<'de, D>(buffer: &mut [u8], deserializer: D) -> Result<(), D::Error>
+pub fn deserialize_hex_or_bin<'de, D>(buffer: &mut [u8], deserializer: D) -> Result<&[u8], D::Error>
 where
     D: Deserializer<'de>,
 {

diff --git a/serdect/src/common.rs b/serdect/src/common.rs
@@ -2,7 +2,7 @@ use core::fmt;
 use core::marker::PhantomData;
 
 use serde::{
-    de::{Error, Visitor},
+    de::{Error, Unexpected, Visitor},
     Serializer,
 };
 
@@ -74,7 +74,7 @@ pub(crate) trait LengthCheck {
 pub(crate) struct StrIntoBufVisitor<'b, T: LengthCheck>(pub &'b mut [u8], pub PhantomData<T>);
 
 impl<'de, 'b, T: LengthCheck> Visitor<'de> for StrIntoBufVisitor<'b, T> {
-    type Value = ();
+    type Value = &'b [u8];
 
     fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
         T::expecting(formatter, "a string", self.0.len() * 2)
@@ -84,13 +84,15 @@ impl<'de, 'b, T: LengthCheck> Visitor<'de> for StrIntoBufVisitor<'b, T> {
     where
         E: Error,
     {
-        if !T::length_check(self.0.len() * 2, v.len()) {
-            return Err(Error::invalid_length(v.len(), &self));
-        }
-        // TODO: Map `base16ct::Error::InvalidLength` to `Error::invalid_length`.
-        base16ct::mixed::decode(v, self.0)
-            .map(|_| ())
-            .map_err(E::custom)
+        base16ct::mixed::decode(v, self.0).map_err(|err| match err {
+            base16ct::Error::InvalidLength => {
+                Error::invalid_length(v.len(), &"an even number of hex digits")
+            }
+            base16ct::Error::InvalidEncoding => Error::invalid_value(
+                Unexpected::Other("<potentially secret hex string>"),
+                &"a sequence of hex digits (0-9,a-f,A-F)",
+            ),
+        })
     }
 }
 
@@ -116,7 +118,7 @@ impl<'de> Visitor<'de> for StrIntoVecVisitor {
 pub(crate) struct SliceVisitor<'b, T: LengthCheck>(pub &'b mut [u8], pub PhantomData<T>);
 
 impl<'de, 'b, T: LengthCheck> Visitor<'de> for SliceVisitor<'b, T> {
-    type Value = ();
+    type Value = &'b [u8];
 
     fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
         T::expecting(formatter, "an array", self.0.len())
@@ -131,7 +133,7 @@ impl<'de, 'b, T: LengthCheck> Visitor<'de> for SliceVisitor<'b, T> {
         if T::length_check(self.0.len(), v.len()) {
             let buffer = &mut self.0[..v.len()];
             buffer.copy_from_slice(v);
-            return Ok(());
+            return Ok(buffer);
         }
 
         Err(E::invalid_length(v.len(), &self))
@@ -147,7 +149,7 @@ impl<'de, 'b, T: LengthCheck> Visitor<'de> for SliceVisitor<'b, T> {
         if T::length_check(self.0.len(), v.len()) {
             let buffer = &mut self.0[..v.len()];
             buffer.swap_with_slice(&mut v);
-            return Ok(());
+            return Ok(buffer);
         }
 
         Err(E::invalid_length(v.len(), &self))

diff --git a/serdect/src/slice.rs b/serdect/src/slice.rs
@@ -61,7 +61,7 @@ impl LengthCheck for UpperBound {
 /// Deserialize from hex when using human-readable formats or binary if the
 /// format is binary. Fails if the `buffer` is smaller then the resulting
 /// slice.
-pub fn deserialize_hex_or_bin<'de, D>(buffer: &mut [u8], deserializer: D) -> Result<(), D::Error>
+pub fn deserialize_hex_or_bin<'de, D>(buffer: &mut [u8], deserializer: D) -> Result<&[u8], D::Error>
 where
     D: Deserializer<'de>,
 {