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 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
//! # Untrustended - Untrusted Extended.
//!
//! Untrustended is a compilation of primitives for parsing values from
//! untrusted input. It's building on top of
//! [untrusted](https://crates.io/crates/untrusted)'s
//! [`Reader::read_byte()`](https://briansmith.org/rustdoc/untrusted/struct.Reader.html#method.read_byte)
//! and [`Reader::read_bytes()`](https://briansmith.org/rustdoc/untrusted/struct.Reader.html#method.read_bytes).
//!
//! Please, consult [untrusted](https://crates.io/crates/untrusted)'s
//! documentation about how to use that crate before attempting to use this one.
//!
//! To use the new methods provided by this crate:
//!
//! ```rust,no_run
//! use untrustended::ReaderExt;
//! ```
//!
//! then construct a `Reader` as usual and enjoy.
//!
//! Example:
//!
//! ```rust
//! use untrusted::{Input, Reader};
//! use untrustended::{ReaderExt, Error};
//!
//! fn read_stuff(input: &mut Reader<'_>) -> Result<(u8, u16, u32), Error> {
//! let one_byte = input.read_u8()?;
//! let big_endian_u16 = input.read_u16be()?;
//! let little_endian_u32 = input.read_u32le()?;
//! Ok((one_byte, big_endian_u16, little_endian_u32))
//! }
//!
//! fn main() {
//! let buf = vec![0, 1, 2, 3, 4, 5, 6];
//! let input = Input::from(&buf);
//!
//! input.read_all(Error::UnknownError, read_stuff).expect("read_all to succeed");
//! }
//! ```
#![cfg_attr(not(feature = "use_std"), no_std)]
use untrusted::{EndOfInput, Input, Reader};
pub use crate::error::Error;
#[cfg(feature = "use_std")]
use std::net::{Ipv4Addr, Ipv6Addr};
/// A trait extending [untrusted](https://crates.io/crates/untrusted)'s
/// [`Reader`](https://briansmith.org/rustdoc/untrusted/struct.Reader.html).
pub trait ReaderExt<'a> {
/// Read one byte.
fn read_byte(&mut self) -> Result<u8, EndOfInput>;
/// Skips num_bytes of the input, returning the skipped input as an Input.
///
/// Returns Ok(i) where i is an Input if there are at least num_bytes of
/// input remaining, and Err(EndOfInput) otherwise.
fn read_bytes(&mut self, num_bytes: usize) -> Result<Input<'a>, EndOfInput>;
/// Read as many bytes as needed to instantiate a type in Big Endian byte
/// order.
fn read_be<T: FromReader>(&mut self) -> Result<T, Error>;
/// Read as many bytes as needed to instantiate a type in Little Endian byte
/// order.
fn read_le<T: FromReader>(&mut self) -> Result<T, Error>;
/// Reads 8 bit unsigned integer.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader is at the end of the input.
#[inline]
fn read_u8(&mut self) -> Result<u8, Error> {
self.read_byte().map_err(From::from)
}
/// Reads 16 bit unsigned integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u16be(&mut self) -> Result<u16, Error> {
self.read_be().map_err(From::from)
}
/// Reads 24 bit unsigned integer in big endian.
///
/// This method reads three bytes, but returns `u32` because Rust doesn't
/// have 24 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u24be(&mut self) -> Result<u32, Error> {
let b1 = u32::from(self.read_u16be()?);
let b2 = u32::from(self.read_u8()?);
Ok((b1 << 8) + b2)
}
/// Reads 32 bit unsigned integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u32be(&mut self) -> Result<u32, Error> {
self.read_be().map_err(From::from)
}
/// Reads 48 bit unsigned integer in big endian.
///
/// This method reads six bytes, but returns `u64` because Rust doesn't have
/// 48 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u48be(&mut self) -> Result<u64, Error> {
let b1 = u64::from(self.read_u24be()?);
let b2 = u64::from(self.read_u24be()?);
Ok((b1 << 24) + b2)
}
/// Reads 64 bit unsigned integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u64be(&mut self) -> Result<u64, Error> {
self.read_be().map_err(From::from)
}
/// Reads 128 bit unsigned integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u128be(&mut self) -> Result<u128, Error> {
self.read_be().map_err(From::from)
}
/// Reads 16 bit unsigned integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u16le(&mut self) -> Result<u16, Error> {
self.read_le().map_err(From::from)
}
/// Reads 24 bit unsigned integer in little endian.
///
/// This method reads three bytes, but returns `u32` because Rust doesn't
/// have 24 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u24le(&mut self) -> Result<u32, Error> {
let b2 = u32::from(self.read_u8()?);
let b1 = u32::from(self.read_u16le()?);
Ok((b1 << 8) + b2)
}
/// Reads 32 bit unsigned integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u32le(&mut self) -> Result<u32, Error> {
self.read_le().map_err(From::from)
}
/// Reads 48 bit unsigned integer in little endian.
///
/// This method reads six bytes, but returns `u64` because Rust doesn't have
/// 48 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u48le(&mut self) -> Result<u64, Error> {
let b2 = u64::from(self.read_u24le()?);
let b1 = u64::from(self.read_u24le()?);
Ok((b1 << 24) + b2)
}
/// Reads 64 bit unsigned integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u64le(&mut self) -> Result<u64, Error> {
self.read_le().map_err(From::from)
}
/// Reads 128 bit unsigned integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_u128le(&mut self) -> Result<u128, Error> {
self.read_le().map_err(From::from)
}
/// Reads 8 bit signed integer.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader is at the end of the input.
#[inline]
fn read_i8(&mut self) -> Result<i8, Error> {
Ok(self.read_u8()? as i8)
}
/// Reads 16 bit signed integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i16be(&mut self) -> Result<i16, Error> {
self.read_be().map_err(From::from)
}
/// Reads 24 bit signed integer in big endian.
///
/// This method reads three bytes, but returns `i32` because Rust doesn't
/// have 24 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i24be(&mut self) -> Result<i32, Error> {
let b1 = i32::from(self.read_i16be()?);
let b2 = i32::from(self.read_u8()?);
Ok((b1 << 8) + b2)
}
/// Reads 32 bit signed integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i32be(&mut self) -> Result<i32, Error> {
self.read_be().map_err(From::from)
}
/// Reads 48 bit signed integer in big endian.
///
/// This method reads six bytes, but returns `i64` because Rust doesn't have
/// 48 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i48be(&mut self) -> Result<i64, Error> {
let b1 = i64::from(self.read_i24be()?);
let b2 = i64::from(self.read_u24be()?);
Ok((b1 << 24) + b2)
}
/// Reads 64 bit signed integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i64be(&mut self) -> Result<i64, Error> {
self.read_be().map_err(From::from)
}
/// Reads 128 bit signed integer in big endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i128be(&mut self) -> Result<i128, Error> {
self.read_be().map_err(From::from)
}
/// Reads 16 bit signed integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i16le(&mut self) -> Result<i16, Error> {
self.read_le().map_err(From::from)
}
/// Reads 24 bit signed integer in little endian.
///
/// This method reads three bytes, but returns `i32` because Rust doesn't
/// have 24 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i24le(&mut self) -> Result<i32, Error> {
let b2 = i32::from(self.read_u8()?);
let b1 = i32::from(self.read_i16le()?);
Ok((b1 << 8) + b2)
}
/// Reads 32 bit signed integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i32le(&mut self) -> Result<i32, Error> {
self.read_le().map_err(From::from)
}
/// Reads 48 bit signed integer in little endian.
///
/// This method reads six bytes, but returns `i64` because Rust doesn't have
/// 48 bit integer type.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i48le(&mut self) -> Result<i64, Error> {
let b2 = i64::from(self.read_u24le()?);
let b1 = i64::from(self.read_i24le()?);
Ok((b1 << 24) + b2)
}
/// Reads 64 bit signed integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i64le(&mut self) -> Result<i64, Error> {
self.read_le().map_err(From::from)
}
/// Reads 128 bit signed integer in little endian.
///
/// Returns Ok(v) where v is the value read, or Err(Error::EndOfInput) if
/// the Reader encountered an end of the input while reading.
#[inline]
fn read_i128le(&mut self) -> Result<i128, Error> {
self.read_le().map_err(From::from)
}
/// Reads given amount of bytes.
///
/// Access the given amount of bytes as a slice so it can be processed by
/// functions that are not written using the untrusted's Input/Reader
/// framework.
///
/// Returns Ok(v) where v is a `&[u8]` of bytes read, or
/// Err(Error::EndOfInput) if the Reader encountered an end of the input
/// while reading.
#[inline]
fn read_bytes_less_safe(&mut self, num_bytes: usize) -> Result<&'a [u8], Error> {
Ok(self.read_bytes(num_bytes).map(|v| v.as_slice_less_safe())?)
}
/// Reads bytes as UTF-8 String.
///
/// Length required is the amount of bytes to read, not the amount of UTF-8
/// characters.
///
/// Read bytes are validated to be valid UTF-8 by
/// [`str::from_utf8`](https://doc.rust-lang.org/std/str/fn.from_utf8.html)
/// method.
///
/// Returns Ok(v) where v is a `&str` of bytes read, or
/// Err(Error::EndOfInput) if the Reader encountered an end of the input
/// while reading, or Err(Error::ParseError) if UTF-8 parsing failed.
#[inline]
#[cfg(feature = "use_std")]
fn read_utf8(&mut self, num_bytes: usize) -> Result<&'a str, Error> {
let buf = self.read_bytes_less_safe(num_bytes)?;
std::str::from_utf8(buf).map_err(From::from)
}
/// Reads bytes as UTF-16 String.
///
/// Length is the amount of bytes to read, not the amount of UTF-16
/// characters. Length should be even number and Err(Error::ParseError) is
/// returned if it's odd.
///
/// Read bytes are validated to be valid UTF-16 by
/// [`String::from_utf16`](https://doc.rust-lang.org/std/string/struct.String.html#method.from_utf16)
/// method.
///
/// Returns Ok(v) where v is a `String` of bytes read, or
/// Err(Error::EndOfInput) if the Reader encountered an end of the input
/// while reading, or Err(Error::ParseError) if UTF-8 parsing failed.
#[inline]
#[cfg(feature = "use_std")]
fn read_utf16(&mut self, num_bytes: usize) -> Result<String, Error> {
if (num_bytes % 2) != 0 {
return Err(Error::ParseError);
}
let len16 = num_bytes / 2;
let mut buf: Vec<u16> = Vec::with_capacity(len16);
for _ in 0..len16 {
let b = self.read_u16be()?;
buf.push(b);
}
String::from_utf16(&buf).map_err(From::from)
}
/// Reads IPv4 address in big endian format.
///
/// Returns Ok(v) where v is a `Ipv4Addr`, or Err(Error::EndOfInput) if the
/// Reader encountered an end of the input while reading, or
/// Err(Error::ParseError) if parsing of address failed.
#[inline]
#[cfg(feature = "use_std")]
fn read_ipv4addr(&mut self) -> Result<Ipv4Addr, Error> {
self.read_u32be().map(Ipv4Addr::from)
}
/// Reads IPv6 address in big endian format.
///
/// Returns Ok(v) where v is a `Ipv6Addr`, or Err(Error::EndOfInput) if the
/// Reader encountered an end of the input while reading, or
/// Err(Error::ParseError) if parsing of address failed.
#[inline]
#[cfg(feature = "use_std")]
fn read_ipv6addr(&mut self) -> Result<Ipv6Addr, Error> {
self.read_u128be().map(Ipv6Addr::from)
}
}
impl<'a> ReaderExt<'a> for Reader<'a> {
#[inline]
fn read_byte(&mut self) -> Result<u8, EndOfInput> {
self.read_byte()
}
#[inline]
fn read_bytes(&mut self, num_bytes: usize) -> Result<Input<'a>, EndOfInput> {
self.read_bytes(num_bytes)
}
#[inline]
fn read_be<T: FromReader>(&mut self) -> Result<T, Error> {
FromReader::read_be(self)
}
#[inline]
fn read_le<T: FromReader>(&mut self) -> Result<T, Error> {
FromReader::read_le(self)
}
}
/// A trait to abstract the idea of creating a new instance of a type from
/// reading bytes out from `Reader`.
pub trait FromReader: Sized {
/// Read as many bytes as needed to instantiate a type in Big Endian byte
/// order.
fn read_be(_: &mut Reader<'_>) -> Result<Self, Error>;
/// Read as many bytes as needed to instantiate a type in Little Endian byte
/// order.
fn read_le(_: &mut Reader<'_>) -> Result<Self, Error>;
}
macro_rules! read_unsigned {
($type:ty) => {
#[inline]
fn read_be(reader: &mut Reader<'_>) -> Result<Self, Error> {
const LEN: usize = core::mem::size_of::<$type>();
let mut arr = [0u8; LEN];
let slice = reader.read_bytes(LEN)?.as_slice_less_safe();
arr.copy_from_slice(slice);
Ok(<$type>::from_be_bytes(arr))
}
#[inline]
fn read_le(reader: &mut Reader<'_>) -> Result<Self, Error> {
const LEN: usize = core::mem::size_of::<$type>();
let mut arr = [0u8; LEN];
let slice = reader.read_bytes(LEN)?.as_slice_less_safe();
arr.copy_from_slice(slice);
Ok(<$type>::from_le_bytes(arr))
}
};
}
macro_rules! read_signed {
($type:ty) => {
#[inline]
fn read_be(reader: &mut Reader<'_>) -> Result<Self, Error> {
let r = reader.read_be::<$type>()?;
Ok(r as Self)
}
#[inline]
fn read_le(reader: &mut Reader<'_>) -> Result<Self, Error> {
let r = reader.read_le::<$type>()?;
Ok(r as Self)
}
};
}
impl FromReader for u8 {
#[inline]
fn read_be(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_byte().map_err(From::from)
}
#[inline]
fn read_le(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_byte().map_err(From::from)
}
}
impl FromReader for u16 {
read_unsigned!(u16);
}
impl FromReader for u32 {
read_unsigned!(u32);
}
impl FromReader for u64 {
read_unsigned!(u64);
}
impl FromReader for u128 {
read_unsigned!(u128);
}
impl FromReader for i8 {
read_signed!(u8);
}
impl FromReader for i16 {
read_signed!(u16);
}
impl FromReader for i32 {
read_signed!(u32);
}
impl FromReader for i64 {
read_signed!(u64);
}
impl FromReader for i128 {
read_signed!(u128);
}
#[cfg(feature = "use_std")]
impl FromReader for Ipv4Addr {
fn read_be(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_u32be().map(Ipv4Addr::from)
}
fn read_le(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_u32le().map(Ipv4Addr::from)
}
}
#[cfg(feature = "use_std")]
impl FromReader for Ipv6Addr {
fn read_be(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_u128be().map(Ipv6Addr::from)
}
fn read_le(reader: &mut Reader<'_>) -> Result<Self, Error> {
reader.read_u128le().map(Ipv6Addr::from)
}
}
mod error {
#[cfg(feature = "use_std")]
use std::fmt;
#[cfg(feature = "use_std")]
use std::str::Utf8Error;
#[cfg(feature = "use_std")]
use std::string::FromUtf16Error;
use untrusted::EndOfInput;
/// Possible errors raised by `ReaderExt`.
#[derive(Debug, PartialEq)]
pub enum Error {
/// The error type used to indicate the end of the input was reached
/// before the operation could be completed.
EndOfInput,
/// The error type used to indicate when parsing failed while trying
/// to convert bytes into a more specific type.
ParseError,
/// Unknown error occured.
UnknownError,
}
#[cfg(feature = "use_std")]
impl std::error::Error for Error {}
#[cfg(feature = "use_std")]
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Error::EndOfInput => f.write_str("end of input was reached unexpectedly"),
Error::ParseError => f.write_str("failed to parse data into a more specific type"),
Error::UnknownError => f.write_str("reading failed with an unknown error"),
}
}
}
impl From<EndOfInput> for Error {
fn from(_: EndOfInput) -> Self {
Error::EndOfInput
}
}
#[cfg(feature = "use_std")]
impl From<Utf8Error> for Error {
fn from(_: Utf8Error) -> Self {
Error::ParseError
}
}
#[cfg(feature = "use_std")]
impl From<FromUtf16Error> for Error {
fn from(_: FromUtf16Error) -> Self {
Error::ParseError
}
}
}