Skip to content

der: add indefinite length #1820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added cms/tests/examples/ber_pkcs7.bin
Binary file not shown.
6 changes: 6 additions & 0 deletions cms/tests/tests_from_pkcs7_crate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -141,3 +141,9 @@ fn cms_decode_signed_der() {
// should match the original
assert_eq!(reencoded_der_signed_data_in_ci, der_signed_data_in_ci)
}

#[test]
fn cms_decode_ber() {
let ber_pkcs7 = include_bytes!("../tests/examples/ber_pkcs7.bin");
let _ci = ContentInfo::from_ber(ber_pkcs7).expect("decoded ber");
}
4 changes: 2 additions & 2 deletions der/src/asn1/any.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ impl<'a> Decode<'a> for AnyRef<'a> {

fn decode<R: Reader<'a>>(reader: &mut R) -> Result<AnyRef<'a>, Error> {
let header = Header::decode(reader)?;
Self::decode_value(reader, header)
Self::decode_nested_value(reader, header)
}
}

Expand Down Expand Up @@ -254,7 +254,7 @@ mod allocating {

fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self, Error> {
let header = Header::decode(reader)?;
Self::decode_value(reader, header)
Self::decode_nested_value(reader, header)
}
}

Expand Down
27 changes: 26 additions & 1 deletion der/src/decode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ where
fn decode<R: Reader<'a>>(reader: &mut R) -> Result<T, <T as DecodeValue<'a>>::Error> {
let header = Header::decode(reader)?;
header.tag.assert_eq(T::TAG)?;
T::decode_value(reader, header)
T::decode_nested_value(reader, header)
}
}

Expand Down Expand Up @@ -119,6 +119,31 @@ pub trait DecodeValue<'a>: Sized {

/// Attempt to decode this message using the provided [`Reader`].
fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self, Self::Error>;

/// Attempt to decode this nested message using the provided [`Reader`].
///
/// When indefinite length occurs, trailing '00 00' bytes are eaten.
fn decode_nested_value<R: Reader<'a>>(
reader: &mut R,
header: Header,
) -> Result<Self, Self::Error> {
if !header.length.is_indefinite() {
// TODO: maybe refactor whole der to read_nested here
Self::decode_value(reader, header)
} else {
let fixed_header = Header {
tag: header.tag,
length: reader.peek_indefinite_length()?,
};
// Now expected length is known
let result = reader.read_nested(fixed_header.length, |reader| {
Self::decode_value(reader, fixed_header)
});

reader.read_end_of_contents()?;
result
}
}
}

#[cfg(feature = "alloc")]
Expand Down
6 changes: 3 additions & 3 deletions der/src/header.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ mod tests {

#[test]
fn peek_max_header() {
const MAX_HEADER: [u8; 11] = hex!("BF8FFFFFFF7F 84FFFFFFFF");
const MAX_HEADER: [u8; 11] = hex!("BF8FFFFFFF7F 84FFFFFFFE");
let reader = SliceReader::new(&MAX_HEADER).expect("slice to be valid length");

let header = Header::peek(&reader).expect("peeked tag");
Expand All @@ -116,14 +116,14 @@ mod tests {
);
assert_eq!(
header.length,
Length::new_usize(0xFFFFFFFF).expect("u32 to fit")
Length::new_usize(0xFFFFFFFE).expect("u32 to fit")
);
assert_eq!(header.encoded_len(), Ok(Length::new(11)));
assert_eq!(reader.position(), Length::ZERO); // Position unchanged
}
#[test]
fn negative_peek_overlength_header() {
const MAX_HEADER: [u8; 12] = hex!("BF8FFFFFFFFF7F 84FFFFFFFF");
const MAX_HEADER: [u8; 12] = hex!("BF8FFFFFFFFF7F 84FFFFFFFE");
let reader = SliceReader::new(&MAX_HEADER).expect("slice to be valid length");
// Should not decode
Header::peek(&reader).expect_err("overlength error");
Expand Down
98 changes: 75 additions & 23 deletions der/src/length.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
//! Length calculations for encoded ASN.1 DER values

use crate::{Decode, DerOrd, Encode, Error, ErrorKind, Reader, Result, SliceWriter, Tag, Writer};
use crate::{
Decode, DerOrd, Encode, EncodingRules, Error, ErrorKind, Reader, Result, SliceWriter, Tag,
Writer,
};
use core::{
cmp::Ordering,
fmt,
ops::{Add, Sub},
};

/// Maximum length as a `u32`.
const MAX_U32: u32 = u32::MAX - 1;

/// Octet identifying an indefinite length as described in X.690 Section
/// 8.1.3.6.1:
///
Expand All @@ -25,8 +31,11 @@ impl Length {
/// Length of `1`
pub const ONE: Self = Self(1);

/// Maximum length (`u32::MAX`).
pub const MAX: Self = Self(u32::MAX);
/// Maximum length (`u32::MAX` - 1).
pub const MAX: Self = Self(MAX_U32);

/// Indefinite length (encoded as `0x80`).
pub const INDEFINITE: Self = Self(u32::MAX);

/// Maximum number of octets in a DER encoding of a [`Length`] using the
/// rules implemented by this crate.
Expand All @@ -44,7 +53,7 @@ impl Length {
/// This function is const-safe and therefore useful for [`Length`] constants.
#[allow(clippy::cast_possible_truncation)]
pub(crate) const fn new_usize(len: usize) -> Result<Self> {
if len > (u32::MAX as usize) {
if len > Self::MAX.0 as usize {
Err(Error::from_kind(ErrorKind::Overflow))
} else {
Ok(Length(len as u32))
Expand All @@ -57,6 +66,12 @@ impl Length {
value == 0
}

/// Is this length indefinite?
pub const fn is_indefinite(self) -> bool {
let value = self.0;
value == u32::MAX
}

/// Get the length of DER Tag-Length-Value (TLV) encoded data if `self`
/// is the length of the inner "value" portion of the message.
pub fn for_tlv(self, tag: Tag) -> Result<Self> {
Expand All @@ -65,11 +80,22 @@ impl Length {

/// Perform saturating addition of two lengths.
pub fn saturating_add(self, rhs: Self) -> Self {
Self(self.0.saturating_add(rhs.0))
if self.is_indefinite() || rhs.is_indefinite() {
return Self::INDEFINITE;
}
let sum = self.0.saturating_add(rhs.0);
if sum < Self::MAX.0 {
Self(sum)
} else {
Self::MAX
}
}

/// Perform saturating subtraction of two lengths.
pub fn saturating_sub(self, rhs: Self) -> Self {
if self.is_indefinite() || rhs.is_indefinite() {
return Self::INDEFINITE;
}
Self(self.0.saturating_sub(rhs.0))
}

Expand All @@ -90,7 +116,7 @@ impl Length {
0x80..=0xFF => Some(0x81),
0x100..=0xFFFF => Some(0x82),
0x10000..=0xFFFFFF => Some(0x83),
0x1000000..=0xFFFFFFFF => Some(0x84),
0x1000000..=MAX_U32 => Some(0x84),
_ => None,
}
}
Expand All @@ -100,10 +126,13 @@ impl Add for Length {
type Output = Result<Self>;

fn add(self, other: Self) -> Result<Self> {
if self.is_indefinite() || other.is_indefinite() {
return Ok(Self::INDEFINITE);
}
self.0
.checked_add(other.0)
.ok_or_else(|| ErrorKind::Overflow.into())
.map(Self)
.and_then(TryInto::try_into)
}
}

Expand All @@ -127,7 +156,7 @@ impl Add<u32> for Length {
type Output = Result<Self>;

fn add(self, other: u32) -> Result<Self> {
self + Length::from(other)
self + Length::try_from(other)?
}
}

Expand Down Expand Up @@ -178,15 +207,21 @@ impl From<u16> for Length {
}
}

impl From<u32> for Length {
fn from(len: u32) -> Length {
Length(len)
impl TryFrom<u32> for Length {
type Error = Error;

fn try_from(len: u32) -> Result<Length> {
if len <= Self::MAX.0 {
Ok(Length(len))
} else {
Err(ErrorKind::Overflow.into())
}
}
}

impl From<Length> for u32 {
fn from(length: Length) -> u32 {
length.0
fn from(len: Length) -> u32 {
if len == Length::INDEFINITE { 0 } else { len.0 }
}
}

Expand All @@ -202,7 +237,11 @@ impl TryFrom<Length> for usize {
type Error = Error;

fn try_from(len: Length) -> Result<usize> {
len.0.try_into().map_err(|_| ErrorKind::Overflow.into())
if len == Length::INDEFINITE {
Ok(0)
} else {
len.0.try_into().map_err(|_| ErrorKind::Overflow.into())
}
}
}

Expand All @@ -214,6 +253,9 @@ impl<'a> Decode<'a> for Length {
// Note: per X.690 Section 8.1.3.6.1 the byte 0x80 encodes indefinite
// lengths, which are not allowed in DER, so disallow that byte.
len if len < INDEFINITE_LENGTH_OCTET => Ok(len.into()),
INDEFINITE_LENGTH_OCTET if reader.encoding_rules() == EncodingRules::Ber => {
Ok(Self::INDEFINITE)
}
INDEFINITE_LENGTH_OCTET => Err(ErrorKind::IndefiniteLength.into()),
// 1-4 byte variable-sized length prefix
tag @ 0x81..=0x84 => {
Expand All @@ -226,7 +268,7 @@ impl<'a> Decode<'a> for Length {
| u32::from(reader.read_byte()?);
}

let length = Length::from(decoded_len);
let length = Length::try_from(decoded_len)?;

// X.690 Section 10.1: DER lengths must be encoded with a minimum
// number of octets
Expand All @@ -251,11 +293,15 @@ impl Encode for Length {
0x80..=0xFF => Ok(Length(2)),
0x100..=0xFFFF => Ok(Length(3)),
0x10000..=0xFFFFFF => Ok(Length(4)),
0x1000000..=0xFFFFFFFF => Ok(Length(5)),
0x1000000..=MAX_U32 => Ok(Length(5)),
u32::MAX => Ok(Length(1)),
}
}

fn encode(&self, writer: &mut impl Writer) -> Result<()> {
if self.is_indefinite() {
return Err(ErrorKind::IndefiniteLength.into());
}
match self.initial_octet() {
Some(tag_byte) => {
writer.write_byte(tag_byte)?;
Expand Down Expand Up @@ -300,7 +346,7 @@ impl fmt::Display for Length {
#[cfg(feature = "arbitrary")]
impl<'a> arbitrary::Arbitrary<'a> for Length {
fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
Ok(Self(u.arbitrary()?))
Ok(Self(u.int_in_range(0..=MAX_U32)?))
}

fn size_hint(depth: usize) -> (usize, Option<usize>) {
Expand Down Expand Up @@ -337,12 +383,16 @@ mod tests {
);

assert_eq!(
Length::from(0x10000u32),
Length::try_from(0x10000u32).unwrap(),
Length::from_der(&[0x83, 0x01, 0x00, 0x00]).unwrap()
);
assert_eq!(
Length::from(0xFFFFFFFFu32),
Length::from_der(&[0x84, 0xFF, 0xFF, 0xFF, 0xFF]).unwrap()
Length::try_from(0xFFFFFFFEu32).unwrap(),
Length::from_der(&[0x84, 0xFF, 0xFF, 0xFF, 0xFE]).unwrap()
);
assert_eq!(
Length::from_der(&[0x84, 0xFF, 0xFF, 0xFF, 0xFF]),
Err(ErrorKind::Overflow.into())
);
}

Expand Down Expand Up @@ -374,13 +424,15 @@ mod tests {

assert_eq!(
&[0x83, 0x01, 0x00, 0x00],
Length::from(0x10000u32)
Length::try_from(0x10000u32)
.unwrap()
.encode_to_slice(&mut buffer)
.unwrap()
);
assert_eq!(
&[0x84, 0xFF, 0xFF, 0xFF, 0xFF],
Length::from(0xFFFFFFFFu32)
&[0x84, 0xFF, 0xFF, 0xFF, 0xFE],
Length::try_from(0xFFFFFFFEu32)
.unwrap()
.encode_to_slice(&mut buffer)
.unwrap()
);
Expand Down
Loading
Loading