feat(x509): implement RFC 4514 string serialization for x509 names#464

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
Mar 10, 2022
Merged

feat(x509): implement RFC 4514 string serialization for x509 names #464

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
169 changes: 167 additions & 2 deletions x509/src/attr.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
type Error = der::Error;
type Error = Error;

fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
pub oid: AttributeType,
pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
None,
Some,
Hex(u8),
}

struct Parser {
state: Escape,
bytes: Vec<u8>,
}

impl Parser {
pub fn new() -> Self {
Self {
state: Escape::None,
bytes: Vec::new(),
}
}

fn push(&mut self, c: u8) {
self.state = Escape::None;
self.bytes.push(c);
}

pub fn add(&mut self, c: u8) -> Result<(), Error> {
match (self.state, c) {
(Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
(Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
(Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

(Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
(Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
(Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

(Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
(Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

(Escape::None, b'\\') => self.state = Escape::Some,
(Escape::None, ..) => self.push(c),

_ => return Err(ErrorKind::Failed.into()),
}

Ok(())
}

pub fn as_bytes(&self) -> &[u8] {
&self.bytes
}
}

impl AttributeTypeAndValue<'_> {
/// Parses the hex value in the `OID=#HEX` format.
fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
// Ensure an even number of hex bytes.
let mut iter = match val.len() % 2 {
0 => [].iter().cloned().chain(val.bytes()),
1 => [0u8].iter().cloned().chain(val.bytes()),
_ => unreachable!(),
};

// Decode der bytes from hex.
let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
let mut byte = 0u8;

for (half, shift) in [(h, 4), (l, 0)] {
match half {
b'0'..=b'9' => byte |= (half - b'0') << shift,
b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
_ => return Err(ErrorKind::Failed.into()),
}
}

bytes.push(byte);
}

// Serialize.
let value = Any::from_der(&bytes)?;
let atv = AttributeTypeAndValue { oid, value };
atv.to_vec()
}

/// Parses the string value in the `NAME=STRING` format.
fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
// Undo escaping.
let mut parser = Parser::new();
for c in val.bytes() {
parser.add(c)?;
}

// Serialize.
let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
let atv = AttributeTypeAndValue { oid, value };
atv.to_vec()
}

/// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
///
/// This function follows the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
let (key, val) = s.split_at(idx);
let val = &val[1..];

// Either decode or lookup the OID for the given key.
let oid = match DB.by_name(key) {
Some(oid) => *oid,
None => ObjectIdentifier::new(key)?,
};

// If the value is hex-encoded DER...
match val.strip_prefix('#') {
Some(val) => Self::encode_hex(oid, val),
None => Self::encode_str(oid, val),
}
}
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let val = match self.value.tag() {
Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
_ => None,
};

if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
write!(f, "{}=", key.to_ascii_uppercase())?;

let mut iter = val.char_indices().peekable();
while let Some((i, c)) = iter.next() {
match c {
'#' if i == 0 => write!(f, "\\#")?,
' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
'"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
'\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
_ => f.write_char(c)?,
}
}
} else {
let value = self.value.to_vec().or(Err(fmt::Error))?;

write!(f, "{}=#", self.oid)?;
for c in value {
write!(f, "{:02x}", c)?;
}
}

Ok(())
}
}
111 changes: 108 additions & 3 deletions x509/src/name.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
(0..s.len())
.filter(move |i| s.as_bytes()[*i] == b)
.filter(|i| {
let x = i
.checked_sub(2)
.map(|i| s.as_bytes()[i])
.unwrap_or_default();

let y = i
.checked_sub(1)
.map(|i| s.as_bytes()[i])
.unwrap_or_default();

y != b'\\' || x == b'\\'
})
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
let mut prev = 0;
find(s, b).chain([s.len()].into_iter()).map(move |i| {
let x = &s[prev..i];
prev = i + 1;
x
})
}

impl RdnSequence<'_> {
/// Converts an RDNSequence string into an encoded RDNSequence
///
/// This function follows the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
let ders = split(s, b',')
.map(RelativeDistinguishedName::encode_from_string)
.collect::<Result<Vec<_>, der::Error>>()?;

let mut out = Vec::new();
for der in ders.iter() {
out.push(RelativeDistinguishedName::from_der(der)?);
}

RdnSequence(out).to_vec()
}
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
for (i, atv) in self.0.iter().enumerate() {
match i {
0 => write!(f, "{}", atv)?,
_ => write!(f, ",{}", atv)?,
}
}

Ok(())
}
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
/// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
///
/// This function follows the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
let ders = split(s, b'+')
.map(AttributeTypeAndValue::encode_from_string)
.collect::<Result<Vec<_>, der::Error>>()?;

let atvs = ders
.iter()
.map(|der| AttributeTypeAndValue::from_der(der))
.collect::<Result<Vec<_>, der::Error>>()?;

RelativeDistinguishedName(atvs.try_into()?).to_vec()
}
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
for (i, atv) in self.0.iter().enumerate() {
match i {
0 => write!(f, "{}", atv)?,
_ => write!(f, "+{}", atv)?,
}
}

Ok(())
}
}
8 changes: 4 additions & 4 deletions x509/tests/certificate.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
);

let mut counter = 0;
let i = cert.tbs_certificate.issuer.iter();
let i = cert.tbs_certificate.issuer.0.iter();
for rdn in i {
let i1 = rdn.iter();
let i1 = rdn.0.iter();
for atav in i1 {
if 0 == counter {
assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
);

counter = 0;
let i = cert.tbs_certificate.subject.iter();
let i = cert.tbs_certificate.subject.0.iter();
for rdn in i {
let i1 = rdn.iter();
let i1 = rdn.0.iter();
for atav in i1 {
// Yes, this cert features RDNs encoded in reverse order
if 0 == counter {
Expand Down
8 changes: 4 additions & 4 deletions x509/tests/certreq.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
assert_eq!(cr.info.version, Version::V1);

// Check all the RDNs.
assert_eq!(cr.info.subject.len(), NAMES.len());
for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
let kind = name.get(0).unwrap();
assert_eq!(cr.info.subject.0.len(), NAMES.len());
for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
let kind = name.0.get(0).unwrap();
let value = match kind.value.tag() {
Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
_ => panic!("unexpected tag"),
};

assert_eq!(kind.oid, oid.parse().unwrap());
assert_eq!(name.len(), 1);
assert_eq!(name.0.len(), 1);
assert_eq!(value, *val);
}

Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

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

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

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

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

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

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading

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

Skip to content
feat(x509): implement RFC 4514 string serialization for x509 names#464

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

Mar 10, 2022
 Merged


feat(x509): implement RFC 4514 string serialization for x509 names
#464
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


169 changes: 167 additions & 2 deletions
x509/src/attr.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;
use core::fmt::{self, Write};

use const_oid::db::DB;
use der::asn1::{Any, ObjectIdentifier, SetOfVec};
use der::{Decodable, Sequence, ValueOrd};
use der::{Decodable, Encodable, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd};

/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
///
Expand DownExpand Up@@ -51,7 +55,7 @@ pub struct Attribute<'a> {
}

impl<'a> TryFrom<&'a [u8]> for Attribute<'a> {
 type Error = der::Error;
 type Error = Error;

 fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
 Self::from_der(bytes)
Expand DownExpand Up@@ -83,3 +87,164 @@ pub struct AttributeTypeAndValue<'a> {
 pub oid: AttributeType,
 pub value: Any<'a>,
}

#[derive(Copy, Clone)]
enum Escape {
 None,
 Some,
 Hex(u8),
}

struct Parser {
 state: Escape,
 bytes: Vec<u8>,
}

impl Parser {
 pub fn new() -> Self {
 Self {
 state: Escape::None,
 bytes: Vec::new(),
 }
 }

 fn push(&mut self, c: u8) {
 self.state = Escape::None;
 self.bytes.push(c);
 }

 pub fn add(&mut self, c: u8) -> Result<(), Error> {
 match (self.state, c) {
 (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
 (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
 (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),

 (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
 (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
 (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),

 (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
 (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),

 (Escape::None, b'\\') => self.state = Escape::Some,
 (Escape::None, ..) => self.push(c),

 _ => return Err(ErrorKind::Failed.into()),
 }

 Ok(())
 }

 pub fn as_bytes(&self) -> &[u8] {
 &self.bytes
 }
}

impl AttributeTypeAndValue<'_> {
 /// Parses the hex value in the `OID=#HEX` format.
 fn encode_hex(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Ensure an even number of hex bytes.
 let mut iter = match val.len() % 2 {
 0 => [].iter().cloned().chain(val.bytes()),
 1 => [0u8].iter().cloned().chain(val.bytes()),
 _ => unreachable!(),
 };

 // Decode der bytes from hex.
 let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
 while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
 let mut byte = 0u8;

 for (half, shift) in [(h, 4), (l, 0)] {
 match half {
 b'0'..=b'9' => byte |= (half - b'0') << shift,
 b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
 b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
 _ => return Err(ErrorKind::Failed.into()),
 }
 }

 bytes.push(byte);
 }

 // Serialize.
 let value = Any::from_der(&bytes)?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Parses the string value in the `NAME=STRING` format.
 fn encode_str(oid: ObjectIdentifier, val: &str) -> Result<Vec<u8>, Error> {
 // Undo escaping.
 let mut parser = Parser::new();
 for c in val.bytes() {
 parser.add(c)?;
 }

 // Serialize.
 let value = Any::new(Tag::Utf8String, parser.as_bytes())?;
 let atv = AttributeTypeAndValue { oid, value };
 atv.to_vec()
 }

 /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
 let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
 let (key, val) = s.split_at(idx);
 let val = &val[1..];

 // Either decode or lookup the OID for the given key.
 let oid = match DB.by_name(key) {
 Some(oid) => *oid,
 None => ObjectIdentifier::new(key)?,
 };

 // If the value is hex-encoded DER...
 match val.strip_prefix('#') {
 Some(val) => Self::encode_hex(oid, val),
 None => Self::encode_str(oid, val),
 }
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl fmt::Display for AttributeTypeAndValue<'_> {
 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 let val = match self.value.tag() {
 Tag::PrintableString => self.value.printable_string().ok().map(|s| s.as_str()),
 Tag::Utf8String => self.value.utf8_string().ok().map(|s| s.as_str()),
 Tag::Ia5String => self.value.ia5_string().ok().map(|s| s.as_str()),
 _ => None,
 };

 if let (Some(key), Some(val)) = (DB.by_oid(&self.oid), val) {
 write!(f, "{}=", key.to_ascii_uppercase())?;

 let mut iter = val.char_indices().peekable();
 while let Some((i, c)) = iter.next() {
 match c {
 '#' if i == 0 => write!(f, "\\#")?,
 ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
 '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
 '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
 _ => f.write_char(c)?,
 }
 }
 } else {
 let value = self.value.to_vec().or(Err(fmt::Error))?;

 write!(f, "{}=#", self.oid)?;
 for c in value {
 write!(f, "{:02x}", c)?;
 }
 }

 Ok(())
 }
}

111 changes: 108 additions & 3 deletions
x509/src/name.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
//! Name-related definitions as defined in X.501 (and updated by RFC 5280).

use alloc::vec::Vec;

use crate::attr::AttributeTypeAndValue;

use der::asn1::SetOfVec;
use der::{asn1::SetOfVec, Decodable, Encodable, Newtype};

/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
///
Expand All@@ -20,7 +22,73 @@ pub type Name<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RdnSequence<'a> = alloc::vec::Vec<RelativeDistinguishedName<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RdnSequence<'a>(pub Vec<RelativeDistinguishedName<'a>>);

/// Find the indices of all non-escaped separators.
fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
 (0..s.len())
 .filter(move |i| s.as_bytes()[*i] == b)
 .filter(|i| {
 let x = i
 .checked_sub(2)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 let y = i
 .checked_sub(1)
 .map(|i| s.as_bytes()[i])
 .unwrap_or_default();

 y != b'\\' || x == b'\\'
 })
}

/// Split a string at all non-escaped separators.
fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
 let mut prev = 0;
 find(s, b).chain([s.len()].into_iter()).map(move |i| {
 let x = &s[prev..i];
 prev = i + 1;
 x
 })
}

impl RdnSequence<'_> {
 /// Converts an RDNSequence string into an encoded RDNSequence
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b',')
 .map(RelativeDistinguishedName::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let mut out = Vec::new();
 for der in ders.iter() {
 out.push(RelativeDistinguishedName::from_der(der)?);
 }

 RdnSequence(out).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RdnSequence<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, ",{}", atv)?,
 }
 }

 Ok(())
 }
}

/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
///
Expand DownExpand Up@@ -55,4 +123,41 @@ pub type DistinguishedName<'a> = RdnSequence<'a>;
/// ```
///
/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
pub type RelativeDistinguishedName<'a> = SetOfVec<AttributeTypeAndValue<'a>>;
#[derive(Clone, Debug, Default, PartialEq, Eq, Newtype)]
pub struct RelativeDistinguishedName<'a>(pub SetOfVec<AttributeTypeAndValue<'a>>);

impl RelativeDistinguishedName<'_> {
 /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
 ///
 /// This function follows the rules in [RFC 4514].
 ///
 /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
 pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
 let ders = split(s, b'+')
 .map(AttributeTypeAndValue::encode_from_string)
 .collect::<Result<Vec<_>, der::Error>>()?;

 let atvs = ders
 .iter()
 .map(|der| AttributeTypeAndValue::from_der(der))
 .collect::<Result<Vec<_>, der::Error>>()?;

 RelativeDistinguishedName(atvs.try_into()?).to_vec()
 }
}

/// Serializes the structure according to the rules in [RFC 4514].
///
/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
impl core::fmt::Display for RelativeDistinguishedName<'_> {
 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 for (i, atv) in self.0.iter().enumerate() {
 match i {
 0 => write!(f, "{}", atv)?,
 _ => write!(f, "+{}", atv)?,
 }
 }

 Ok(())
 }
}

8 changes: 4 additions & 4 deletions
x509/tests/certificate.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,9 +218,9 @@ fn decode_cert() {
 );

 let mut counter = 0;
 let i = cert.tbs_certificate.issuer.iter();
 let i = cert.tbs_certificate.issuer.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 if 0 == counter {
 assert_eq!(atav.oid.to_string(), "2.5.4.6");
Expand DownExpand Up@@ -263,9 +263,9 @@ fn decode_cert() {
 );

 counter = 0;
 let i = cert.tbs_certificate.subject.iter();
 let i = cert.tbs_certificate.subject.0.iter();
 for rdn in i {
 let i1 = rdn.iter();
 let i1 = rdn.0.iter();
 for atav in i1 {
 // Yes, this cert features RDNs encoded in reverse order
 if 0 == counter {
Expand Down

8 changes: 4 additions & 4 deletions
x509/tests/certreq.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,17 +34,17 @@ fn decode_rsa_2048_der() {
 assert_eq!(cr.info.version, Version::V1);

 // Check all the RDNs.
 assert_eq!(cr.info.subject.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.iter().zip(NAMES) {
 let kind = name.get(0).unwrap();
 assert_eq!(cr.info.subject.0.len(), NAMES.len());
 for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
 let kind = name.0.get(0).unwrap();
 let value = match kind.value.tag() {
 Tag::Utf8String => kind.value.utf8_string().unwrap().as_str(),
 Tag::PrintableString => kind.value.printable_string().unwrap().as_str(),
 _ => panic!("unexpected tag"),
 };

 assert_eq!(kind.oid, oid.parse().unwrap());
 assert_eq!(name.len(), 1);
 assert_eq!(name.0.len(), 1);
 assert_eq!(value, *val);
 }

Expand Down
Loading