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
#![no_std]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![doc = include_str!("../README.md")]
#![warn(
clippy::mod_module_files,
clippy::unwrap_used,
rust_2018_idioms,
unused_lifetimes
)]
//! ## Usage
//!
//! ```
//! # #[cfg(feature = "std")]
//! # {
//! use tls_codec::{TlsVecU8, Serialize, Deserialize};
//! let mut b = &[1u8, 4, 77, 88, 1, 99] as &[u8];
//!
//! let a = u8::tls_deserialize(&mut b).expect("Unable to tls_deserialize");
//! assert_eq!(1, a);
//! println!("b: {:?}", b);
//! let v = TlsVecU8::<u8>::tls_deserialize(&mut b).expect("Unable to tls_deserialize");
//! assert_eq!(&[77, 88, 1, 99], v.as_slice());
//! # }
//! ```
#[macro_use]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;
use alloc::{string::String, vec::Vec};
use core::fmt::{self, Display};
#[cfg(feature = "std")]
use std::io::{Read, Write};
mod arrays;
mod primitives;
mod quic_vec;
mod tls_vec;
pub use tls_vec::{
SecretTlsVecU16, SecretTlsVecU32, SecretTlsVecU8, TlsByteSliceU16, TlsByteSliceU32,
TlsByteSliceU8, TlsByteVecU16, TlsByteVecU32, TlsByteVecU8, TlsSliceU16, TlsSliceU32,
TlsSliceU8, TlsVecU16, TlsVecU32, TlsVecU8,
};
#[cfg(feature = "std")]
pub use quic_vec::SecretVLBytes;
pub use quic_vec::{VLByteSlice, VLBytes};
#[cfg(feature = "derive")]
pub use tls_codec_derive::{
TlsDeserialize, TlsDeserializeBytes, TlsSerialize, TlsSerializeBytes, TlsSize,
};
/// Errors that are thrown by this crate.
#[derive(Debug, Eq, PartialEq, Clone)]
pub enum Error {
/// An error occurred during encoding.
EncodingError(String),
/// The length of a vector is invalid.
InvalidVectorLength,
/// Error writing everything out.
InvalidWriteLength(String),
/// Invalid input when trying to decode a primitive integer.
InvalidInput,
/// An error occurred during decoding.
DecodingError(String),
/// Reached the end of a byte stream.
EndOfStream,
/// Found unexpected data after deserializing.
TrailingData,
/// An unknown value in an enum.
/// The application might not want to treat this as an error because it is
/// only an unknown value, not an invalid value.
UnknownValue(u64),
/// An internal library error that indicates a bug.
LibraryError,
}
#[cfg(feature = "std")]
impl std::error::Error for Error {}
impl Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_fmt(format_args!("{self:?}"))
}
}
#[cfg(feature = "std")]
impl From<std::io::Error> for Error {
fn from(e: std::io::Error) -> Self {
match e.kind() {
std::io::ErrorKind::UnexpectedEof => Self::EndOfStream,
_ => Self::DecodingError(format!("io error: {e:?}")),
}
}
}
/// The `Size` trait needs to be implemented by any struct that should be
/// efficiently serialized.
/// This allows to collect the length of a serialized structure before allocating
/// memory.
pub trait Size {
fn tls_serialized_len(&self) -> usize;
}
/// The `Serialize` trait provides functions to serialize a struct or enum.
///
/// The trait provides two functions:
/// * `tls_serialize` that takes a buffer to write the serialization to
/// * `tls_serialize_detached` that returns a byte vector
pub trait Serialize: Size {
/// Serialize `self` and write it to the `writer`.
/// The function returns the number of bytes written to `writer`.
#[cfg(feature = "std")]
fn tls_serialize<W: Write>(&self, writer: &mut W) -> Result<usize, Error>;
/// Serialize `self` and return it as a byte vector.
#[cfg(feature = "std")]
fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error> {
let mut buffer = Vec::with_capacity(self.tls_serialized_len());
let written = self.tls_serialize(&mut buffer)?;
debug_assert_eq!(
written,
buffer.len(),
"Expected that {} bytes were written but the output holds {} bytes",
written,
buffer.len()
);
if written != buffer.len() {
Err(Error::EncodingError(format!(
"Expected that {} bytes were written but the output holds {} bytes",
written,
buffer.len()
)))
} else {
Ok(buffer)
}
}
}
/// The `SerializeBytes` trait provides a function to serialize a struct or enum.
///
/// The trait provides one function:
/// * `tls_serialize` that returns a byte vector
pub trait SerializeBytes: Size {
/// Serialize `self` and return it as a byte vector.
fn tls_serialize(&self) -> Result<Vec<u8>, Error>;
}
/// The `Deserialize` trait defines functions to deserialize a byte slice to a
/// struct or enum.
pub trait Deserialize: Size {
/// This function deserializes the `bytes` from the provided a [`std::io::Read`]
/// and returns the populated struct.
///
/// In order to get the amount of bytes read, use [`Size::tls_serialized_len`].
///
/// Returns an error if one occurs during deserialization.
#[cfg(feature = "std")]
fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>
where
Self: Sized;
/// This function deserializes the provided `bytes` and returns the populated
/// struct. All bytes must be consumed.
///
/// Returns an error if not all bytes are read from the input, or if an error
/// occurs during deserialization.
#[cfg(feature = "std")]
fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>
where
Self: Sized,
{
let mut bytes = bytes.as_ref();
let out = Self::tls_deserialize(&mut bytes)?;
if !bytes.is_empty() {
return Err(Error::TrailingData);
}
Ok(out)
}
/// This function deserializes the provided `bytes` and returns the populated
/// struct.
///
/// Returns an error if one occurs during deserialization.
#[cfg(feature = "std")]
fn tls_deserialize_bytes(bytes: impl AsRef<[u8]>) -> Result<Self, Error>
where
Self: Sized,
{
Self::tls_deserialize(&mut bytes.as_ref())
}
}
pub trait DeserializeBytes: Size {
/// This function deserializes the `bytes` from the provided a `&[u8]`
/// and returns the populated struct, as well as the remaining slice.
///
/// In order to get the amount of bytes read, use [`Size::tls_serialized_len`].
///
/// Returns an error if one occurs during deserialization.
fn tls_deserialize(bytes: &[u8]) -> Result<(Self, &[u8]), Error>
where
Self: Sized;
/// This function deserializes the provided `bytes` and returns the populated
/// struct. All bytes must be consumed.
///
/// Returns an error if not all bytes are read from the input, or if an error
/// occurs during deserialization.
fn tls_deserialize_exact(bytes: &[u8]) -> Result<Self, Error>
where
Self: Sized,
{
let (out, remainder) = Self::tls_deserialize(bytes)?;
if !remainder.is_empty() {
return Err(Error::TrailingData);
}
Ok(out)
}
}