Skip to content

der: add owned Any and OctetString types#640

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.

Sign up for GitHub

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

Merged
tarcieri merged 1 commit into from
May 5, 2022
Merged

der: add owned Any and OctetString types #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion der/src/asn1.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down
74 changes: 73 additions & 1 deletion der/src/asn1/any.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
value: ByteSlice::EMPTY,
};

/// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
/// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
AnyRef::from_der(bytes)
}
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
/// Tag representing the type of the encoded value.
tag: Tag,

/// Inner value encoded as bytes.
value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
/// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
let value = bytes.into();

// Ensure the tag and value are a valid `AnyRef`.
AnyRef::new(tag, &value)?;
Ok(Self { tag, value })
}
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
fn can_decode(_: Tag) -> bool {
true
}
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
let header = Header::decode(reader)?;
let value = reader.read_vec(header.length)?;
Self::new(header.tag, value)
}
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
fn value_len(&self) -> Result<Length> {
self.value.len().try_into()
}

fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
writer.write(&self.value)
}
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
fn from(any: &'a Any) -> AnyRef<'a> {
// Ensured to parse successfully in constructor
AnyRef::new(any.tag, &any.value).expect("invalid ANY")
}
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
fn tag(&self) -> Tag {
self.tag
}
}
228 changes: 139 additions & 89 deletions der/src/asn1/bit_string.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
/// Number of unused bits in the final octet.
unused_bits: u8,

/// Length of this `BIT STRING` in bits.
bit_length: usize,

/// Bitstring represented as a slice of bytes.
inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
/// Maximum number of unused bits allowed.
pub const MAX_UNUSED_BITS: u8 = 7;

/// Create a new ASN.1 `BIT STRING` from a byte slice.
///
/// Accepts an optional number of "unused bits" (0-7) which are omitted
/// from the final octet. This number is 0 if the value is octet-aligned.
pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
let inner = bytes.into();

// Ensure parameters parse successfully as a `BitStringRef`.
let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

Ok(BitString {
unused_bits,
bit_length,
inner,
})
}

/// Create a new ASN.1 `BIT STRING` from the given bytes.
///
/// The "unused bits" are set to 0.
pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
Self::new(0, bytes)
}

/// Get the number of unused bits in the octet serialization of this
/// `BIT STRING`.
pub fn unused_bits(&self) -> u8 {
self.unused_bits
}

/// Is the number of unused bits a value other than 0?
pub fn has_unused_bits(&self) -> bool {
self.unused_bits != 0
}

/// Get the length of this `BIT STRING` in bits.
pub fn bit_len(&self) -> usize {
self.bit_length
}

/// Is the inner byte slice empty?
pub fn is_empty(&self) -> bool {
self.inner.is_empty()
}

/// Borrow the inner byte slice.
///
/// Returns `None` if the number of unused bits is *not* equal to zero,
/// i.e. if the `BIT STRING` is not octet aligned.
///
/// Use [`BitString::raw_bytes`] to obtain access to the raw value
/// regardless of the presence of unused bits.
pub fn as_bytes(&self) -> Option<&[u8]> {
if self.has_unused_bits() {
None
} else {
Some(self.raw_bytes())
}
}

/// Borrow the raw bytes of this `BIT STRING`.
pub fn raw_bytes(&self) -> &[u8] {
self.inner.as_slice()
}

/// Iterator over the bits of this `BIT STRING`.
pub fn bits(&self) -> BitStringIter<'_> {
BitStringRef::from(self).bits()
}
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
let inner_len = (header.length - Length::ONE)?;
let unused_bits = reader.read_byte()?;
let inner = reader.read_vec(inner_len)?;
Self::new(unused_bits, inner)
}
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
fn value_len(&self) -> Result<Length> {
Length::ONE + Length::try_from(self.inner.len())?
}

fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
writer.write_byte(self.unused_bits)?;
writer.write(&self.inner)
}
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
// Ensured to parse successfully in constructor
BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
}
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
fn value_cmp(&self, other: &Self) -> Result<Ordering> {
match self.unused_bits.cmp(&other.unused_bits) {
Ordering::Equal => self.inner.der_cmp(&other.inner),
ordering => Ok(ordering),
}
}
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
/// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
}
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
/// Number of unused bits in the final octet.
unused_bits: u8,

/// Length of this `BIT STRING` in bits.
bit_length: usize,

/// Bitstring represented as a slice of bytes.
inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
/// Get the number of unused bits in the octet serialization of this
/// `BIT STRING`.
pub fn unused_bits(&self) -> u8 {
self.unused_bits
}

/// Borrow the raw bytes of this `BIT STRING`.
pub fn raw_bytes(&self) -> &[u8] {
self.inner.as_slice()
}
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
let unused_bits = reader.read_byte()?;
let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
return Err(Self::TAG.value_error());
}

let bit_length = inner_len
.checked_mul(8)
.and_then(|n| n.checked_sub(usize::from(unused_bits)))
.ok_or(ErrorKind::Overflow)?;

let mut inner = vec![0u8; inner_len];
let actual_len = reader.read_into(&mut inner)?.len();

if inner_len == actual_len {
Ok(Self {
unused_bits,
bit_length,
inner,
})
} else {
Err(Self::TAG.length_error())
}
}
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
fn value_len(&self) -> Result<Length> {
Length::ONE + Length::try_from(self.inner.len())?
}

fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
writer.write_byte(self.unused_bits)?;
writer.write(&self.inner)
}
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
fn value_cmp(&self, other: &Self) -> Result<Ordering> {
match self.unused_bits.cmp(&other.unused_bits) {
Ordering::Equal => self.inner.der_cmp(&other.inner),
ordering => Ok(ordering),
}
}
}

#[cfg(test)]
mod tests {
use super::{BitStringRef, Result, Tag};
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
der: add owned `Any` and `OctetString` types by tarcieri · Pull Request #640 · RustCrypto/formats · GitHub
Skip to content
der: add owned Any and OctetString types#640

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.

 Sign up for GitHub

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

 Merged

tarcieri
merged 1 commit into

from

May 5, 2022
 Merged


der: add owned Any and OctetString types
#640
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


2 changes: 1 addition & 1 deletion
der/src/asn1.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,7 +43,7 @@ pub use self::{

#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
pub use self::{bit_string::BitString, set_of::SetOfVec};
pub use self::{any::Any, bit_string::BitString, octet_string::OctetString, set_of::SetOfVec};

#[cfg(feature = "oid")]
#[cfg_attr(docsrs, doc(cfg(feature = "oid")))]
Expand Down

74 changes: 73 additions & 1 deletion
der/src/asn1/any.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,9 @@ use crate::{
};
use core::cmp::Ordering;

#[cfg(feature = "alloc")]
use alloc::vec::Vec;

#[cfg(feature = "oid")]
use crate::asn1::ObjectIdentifier;

Expand DownExpand Up@@ -36,7 +39,7 @@ impl<'a> AnyRef<'a> {
 value: ByteSlice::EMPTY,
 };

 /// Create a new [`AnyRef`] from the provided [`Tag`] and byte slice.
 /// Create a new [`AnyRef`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: &'a [u8]) -> Result<Self> {
 let value = ByteSlice::new(bytes).map_err(|_| ErrorKind::Length { tag })?;
 Ok(Self { tag, value })
Expand DownExpand Up@@ -200,3 +203,72 @@ impl<'a> TryFrom<&'a [u8]> for AnyRef<'a> {
 AnyRef::from_der(bytes)
 }
}

/// ASN.1 `ANY`: represents any explicitly tagged ASN.1 value.
///
/// This type provides the same functionality as [`AnyRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct Any {
 /// Tag representing the type of the encoded value.
 tag: Tag,

 /// Inner value encoded as bytes.
 value: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl Any {
 /// Create a new [`Any`] from the provided [`Tag`] and DER bytes.
 pub fn new(tag: Tag, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let value = bytes.into();

 // Ensure the tag and value are a valid `AnyRef`.
 AnyRef::new(tag, &value)?;
 Ok(Self { tag, value })
 }
}

#[cfg(feature = "alloc")]
impl Choice<'_> for Any {
 fn can_decode(_: Tag) -> bool {
 true
 }
}

#[cfg(feature = "alloc")]
impl<'a> Decode<'a> for Any {
 fn decode<R: Reader<'a>>(reader: &mut R) -> Result<Self> {
 let header = Header::decode(reader)?;
 let value = reader.read_vec(header.length)?;
 Self::new(header.tag, value)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for Any {
 fn value_len(&self) -> Result<Length> {
 self.value.len().try_into()
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write(&self.value)
 }
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a Any> for AnyRef<'a> {
 fn from(any: &'a Any) -> AnyRef<'a> {
 // Ensured to parse successfully in constructor
 AnyRef::new(any.tag, &any.value).expect("invalid ANY")
 }
}

#[cfg(feature = "alloc")]
impl Tagged for Any {
 fn tag(&self) -> Tag {
 self.tag
 }
}

228 changes: 139 additions & 89 deletions
der/src/asn1/bit_string.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -198,6 +198,145 @@ impl<'a> FixedTag for BitStringRef<'a> {
 const TAG: Tag = Tag::BitString;
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitStringRef`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Maximum number of unused bits allowed.
 pub const MAX_UNUSED_BITS: u8 = 7;

 /// Create a new ASN.1 `BIT STRING` from a byte slice.
 ///
 /// Accepts an optional number of "unused bits" (0-7) which are omitted
 /// from the final octet. This number is 0 if the value is octet-aligned.
 pub fn new(unused_bits: u8, bytes: impl Into<Vec<u8>>) -> Result<Self> {
 let inner = bytes.into();

 // Ensure parameters parse successfully as a `BitStringRef`.
 let bit_length = BitStringRef::new(unused_bits, &inner)?.bit_length;

 Ok(BitString {
 unused_bits,
 bit_length,
 inner,
 })
 }

 /// Create a new ASN.1 `BIT STRING` from the given bytes.
 ///
 /// The "unused bits" are set to 0.
 pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
 Self::new(0, bytes)
 }

 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Is the number of unused bits a value other than 0?
 pub fn has_unused_bits(&self) -> bool {
 self.unused_bits != 0
 }

 /// Get the length of this `BIT STRING` in bits.
 pub fn bit_len(&self) -> usize {
 self.bit_length
 }

 /// Is the inner byte slice empty?
 pub fn is_empty(&self) -> bool {
 self.inner.is_empty()
 }

 /// Borrow the inner byte slice.
 ///
 /// Returns `None` if the number of unused bits is *not* equal to zero,
 /// i.e. if the `BIT STRING` is not octet aligned.
 ///
 /// Use [`BitString::raw_bytes`] to obtain access to the raw value
 /// regardless of the presence of unused bits.
 pub fn as_bytes(&self) -> Option<&[u8]> {
 if self.has_unused_bits() {
 None
 } else {
 Some(self.raw_bytes())
 }
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }

 /// Iterator over the bits of this `BIT STRING`.
 pub fn bits(&self) -> BitStringIter<'_> {
 BitStringRef::from(self).bits()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let inner_len = (header.length - Length::ONE)?;
 let unused_bits = reader.read_byte()?;
 let inner = reader.read_vec(inner_len)?;
 Self::new(unused_bits, inner)
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl<'a> From<&'a BitString> for BitStringRef<'a> {
 fn from(bit_string: &'a BitString) -> BitStringRef<'a> {
 // Ensured to parse successfully in constructor
 BitStringRef::new(bit_string.unused_bits, &bit_string.inner).expect("invalid BIT STRING")
 }
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

/// Iterator over the bits of a [`BitString`].
pub struct BitStringIter<'a> {
 /// [`BitString`] being iterated over.
Expand DownExpand Up@@ -302,95 +441,6 @@ where
 }
}

/// Owned form of ASN.1 `BIT STRING` type.
///
/// This type provides the same functionality as [`BitString`] but owns the
/// backing data.
#[cfg(feature = "alloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
pub struct BitString {
 /// Number of unused bits in the final octet.
 unused_bits: u8,

 /// Length of this `BIT STRING` in bits.
 bit_length: usize,

 /// Bitstring represented as a slice of bytes.
 inner: Vec<u8>,
}

#[cfg(feature = "alloc")]
impl BitString {
 /// Get the number of unused bits in the octet serialization of this
 /// `BIT STRING`.
 pub fn unused_bits(&self) -> u8 {
 self.unused_bits
 }

 /// Borrow the raw bytes of this `BIT STRING`.
 pub fn raw_bytes(&self) -> &[u8] {
 self.inner.as_slice()
 }
}

#[cfg(feature = "alloc")]
impl<'a> DecodeValue<'a> for BitString {
 fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
 let unused_bits = reader.read_byte()?;
 let inner_len: usize = (header.length - Length::ONE)?.try_into()?;

 if (unused_bits > BitStringRef::MAX_UNUSED_BITS) || (unused_bits != 0 && inner_len == 0) {
 return Err(Self::TAG.value_error());
 }

 let bit_length = inner_len
 .checked_mul(8)
 .and_then(|n| n.checked_sub(usize::from(unused_bits)))
 .ok_or(ErrorKind::Overflow)?;

 let mut inner = vec![0u8; inner_len];
 let actual_len = reader.read_into(&mut inner)?.len();

 if inner_len == actual_len {
 Ok(Self {
 unused_bits,
 bit_length,
 inner,
 })
 } else {
 Err(Self::TAG.length_error())
 }
 }
}

#[cfg(feature = "alloc")]
impl EncodeValue for BitString {
 fn value_len(&self) -> Result<Length> {
 Length::ONE + Length::try_from(self.inner.len())?
 }

 fn encode_value(&self, writer: &mut dyn Writer) -> Result<()> {
 writer.write_byte(self.unused_bits)?;
 writer.write(&self.inner)
 }
}

#[cfg(feature = "alloc")]
impl FixedTag for BitString {
 const TAG: Tag = Tag::BitString;
}

#[cfg(feature = "alloc")]
impl ValueOrd for BitString {
 fn value_cmp(&self, other: &Self) -> Result<Ordering> {
 match self.unused_bits.cmp(&other.unused_bits) {
 Ordering::Equal => self.inner.der_cmp(&other.inner),
 ordering => Ok(ordering),
 }
 }
}

#[cfg(test)]
mod tests {
 use super::{BitStringRef, Result, Tag};
Expand Down
Loading