Add support for context specific fields with default values#246

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 7 commits into from
Nov 19, 2021
Merged

Add support for context specific fields with default values #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a57c0a9
support context specific fields with default values
carl-wallace Nov 18, 2021
29b386e
remove defer support
carl-wallace Nov 18, 2021
d61dc70
rustfmt
carl-wallace Nov 19, 2021
c2f848b
refactor optional and default variable checks to is_optional check. u…
carl-wallace Nov 19, 2021
1f039b5
refactor else block per clippy. rustfmt.
carl-wallace Nov 19, 2021
e2867bf
remove spurious return
carl-wallace Nov 19, 2021
fe65b1f
make indentation in test case consistent
carl-wallace Nov 19, 2021
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
22 changes: 19 additions & 3 deletions der/derive/src/attributes.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
/// is_optional return true when either an optional or default ASN.1 attribute is associated
/// with a field. Default signifies optionality due to omission of default values in DER encodings.
fn is_optional(&self) -> bool {
self.optional || self.default.is_some()
}

/// Parse attributes from a struct field or enum variant.
pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
let mut asn1_type = None;
let mut context_specific = None;

let mut default = None;
let mut extensible = None;
let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

let context_specific = match self.tag_mode {
TagMode::Explicit => {
if self.extensible || self.optional {
if self.extensible || self.is_optional() {
quote! {
::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
}
};

if self.optional {
quote!(#context_specific.map(|cs| cs.value))
if self.is_optional() {
if let Some(default) = &self.default {
quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
} else {
quote!(#context_specific.map(|cs| cs.value))
}
} else {
// TODO(tarcieri): better error handling?
quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
})?.value
}
}
} else if let Some(default) = &self.default {
let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
|| quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
)
} else {
self.asn1_type
.map(|ty| ty.decoder())
Expand Down
3 changes: 2 additions & 1 deletion der/derive/src/sequence.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
let #ident = #decoder.try_into()?;
}
}
} else if let Some(default) = &self.attrs.default {
} else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
let default = &self.attrs.default;
quote! {
let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
}
Expand Down
148 changes: 148 additions & 0 deletions der/tests/derive.rs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
};
use hex_literal::hex;

pub fn default_false_example() -> bool {
false
}

// Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
//
// ```text
// IssuingDistributionPoint ::= SEQUENCE {
// distributionPoint [0] DistributionPointName OPTIONAL,
// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
// onlySomeReasons [3] ReasonFlags OPTIONAL,
// indirectCRL [4] BOOLEAN DEFAULT FALSE,
// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
// -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
// -- and onlyContainsAttributeCerts may be set to TRUE.
// ```
//
// [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
#[derive(Sequence)]
pub struct IssuingDistributionPointExample {
// Omit distributionPoint and only_some_reasons because corresponding structs are not
// available here and are not germane to the example
// distributionPoint [0] DistributionPointName OPTIONAL,
//#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
//pub distribution_point: Option<DistributionPointName<'a>>,
/// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
#[asn1(
context_specific = "1",
default = "default_false_example",
tag_mode = "IMPLICIT"
)]
pub only_contains_user_certs: bool,

/// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
#[asn1(
context_specific = "2",
default = "default_false_example",
tag_mode = "IMPLICIT"
)]
pub only_contains_cacerts: bool,

// onlySomeReasons [3] ReasonFlags OPTIONAL,
//#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
//pub only_some_reasons: Option<ReasonFlags<'a>>,
Comment on lines +251 to +253

@tarcieritarcieriNov 19, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?

@carl-wallacecarl-wallaceNov 19, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.

@tarcieritarcieriNov 19, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?

/// indirectCRL [4] BOOLEAN DEFAULT FALSE,
#[asn1(
context_specific = "4",
default = "default_false_example",
tag_mode = "IMPLICIT"
)]
pub indirect_crl: bool,

/// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
#[asn1(
context_specific = "5",
default = "default_false_example",
tag_mode = "IMPLICIT"
)]
pub only_contains_attribute_certs: bool,
}

// Extension as defined in [RFC 5280 Section 4.1.2.9].
//
// The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
//
// ```text
// Extension ::= SEQUENCE {
// extnID OBJECT IDENTIFIER,
// critical BOOLEAN DEFAULT FALSE,
// extnValue OCTET STRING
// -- contains the DER encoding of an ASN.1 value
// -- corresponding to the extension type identified
// -- by extnID
// }
// ```
//
// [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
pub struct ExtensionExample<'a> {
/// extnID OBJECT IDENTIFIER,
pub extn_id: ObjectIdentifier,

/// critical BOOLEAN DEFAULT FALSE,
#[asn1(default = "default_false_example")]
pub critical: bool,

/// extnValue OCTET STRING
#[asn1(type = "OCTET STRING")]
pub extn_value: &'a [u8],
}

/// X.509 `AlgorithmIdentifier`
#[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
const ALGORITHM_IDENTIFIER_DER: &[u8] =
&hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

#[test]
fn idp_test() {
let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
assert_eq!(idp.only_contains_user_certs, true);
assert_eq!(idp.only_contains_cacerts, false);
assert_eq!(idp.indirect_crl, false);
assert_eq!(idp.only_contains_attribute_certs, false);

let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
assert_eq!(idp.only_contains_user_certs, false);
assert_eq!(idp.only_contains_cacerts, true);
assert_eq!(idp.indirect_crl, false);
assert_eq!(idp.only_contains_attribute_certs, false);

let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
assert_eq!(idp.only_contains_user_certs, false);
assert_eq!(idp.only_contains_cacerts, false);
assert_eq!(idp.indirect_crl, true);
assert_eq!(idp.only_contains_attribute_certs, false);

let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
assert_eq!(idp.only_contains_user_certs, false);
assert_eq!(idp.only_contains_cacerts, false);
assert_eq!(idp.indirect_crl, false);
assert_eq!(idp.only_contains_attribute_certs, true);
}

// demonstrates default field that is not context specific
#[test]
fn extension_test() {
let ext1 = ExtensionExample::from_der(&hex!(
"
300F // 0 15: SEQUENCE {
0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
0101FF // 7 1: BOOLEAN TRUE
0405 // 10 5: OCTET STRING, encapsulates {
3003 // 12 3: SEQUENCE {
0101FF // 14 1: BOOLEAN TRUE
"
))
.unwrap();
assert_eq!(ext1.critical, true);

let ext2 = ExtensionExample::from_der(&hex!(
"
301F // 0 31: SEQUENCE {
0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
0418 // 7 24: OCTET STRING, encapsulates {
3016 // 9 22: SEQUENCE {
8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
"
))
.unwrap();
assert_eq!(ext2.critical, false);
}

#[test]
fn decode() {
let algorithm_identifier =
Expand Down
, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down

, '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
Add support for context specific fields with default values#246

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 7 commits into

from

Nov 19, 2021
 Merged


Add support for context specific fields with default values
#246
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
a57c0a9

support context specific fields with default values


carl-wallace Nov 18, 2021
29b386e

remove defer support


carl-wallace Nov 18, 2021
d61dc70

rustfmt


carl-wallace Nov 19, 2021
c2f848b

refactor optional and default variable checks to is_optional check. u…


carl-wallace Nov 19, 2021
1f039b5

refactor else block per clippy. rustfmt.


carl-wallace Nov 19, 2021
e2867bf

remove spurious return


carl-wallace Nov 19, 2021
fe65b1f

make indentation in test case consistent


carl-wallace Nov 19, 2021

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


22 changes: 19 additions & 3 deletions
der/derive/src/attributes.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -81,10 +81,17 @@ pub(crate) struct FieldAttrs {
}

impl FieldAttrs {
 /// is_optional return true when either an optional or default ASN.1 attribute is associated
 /// with a field. Default signifies optionality due to omission of default values in DER encodings.
 fn is_optional(&self) -> bool {
 self.optional || self.default.is_some()
 }

 /// Parse attributes from a struct field or enum variant.
 pub fn parse(attrs: &[Attribute], type_attrs: &TypeAttrs) -> Self {
 let mut asn1_type = None;
 let mut context_specific = None;

 let mut default = None;
 let mut extensible = None;
 let mut optional = None;
Expand DownExpand Up@@ -184,7 +191,7 @@ impl FieldAttrs {

 let context_specific = match self.tag_mode {
 TagMode::Explicit => {
 if self.extensible || self.optional {
 if self.extensible || self.is_optional() {
 quote! {
 ::der::asn1::ContextSpecific::<#type_params>::decode_explicit(
 decoder,
Expand All@@ -210,8 +217,12 @@ impl FieldAttrs {
 }
 };

 if self.optional {
 quote!(#context_specific.map(|cs| cs.value))
 if self.is_optional() {
 if let Some(default) = &self.default {
 quote!(#context_specific.map(|cs| cs.value).unwrap_or_else(#default))
 } else {
 quote!(#context_specific.map(|cs| cs.value))
 }
 } else {
 // TODO(tarcieri): better error handling?
 quote! {
Expand All@@ -223,6 +234,11 @@ impl FieldAttrs {
 })?.value
 }
 }
 } else if let Some(default) = &self.default {
 let type_params = self.asn1_type.map(|ty| ty.type_path()).unwrap_or_default();
 self.asn1_type.map(|ty| ty.decoder()).unwrap_or_else(
 || quote!(decoder.decode::<Option<#type_params>>()?.unwrap_or_else(#default)),
 )
 } else {
 self.asn1_type
 .map(|ty| ty.decoder())
Expand Down

3 changes: 2 additions & 1 deletion
der/derive/src/sequence.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,8 @@ impl SequenceField {
 let #ident = #decoder.try_into()?;
 }
 }
 } else if let Some(default) = &self.attrs.default {
 } else if self.attrs.context_specific.is_none() && self.attrs.default.is_some() {
 let default = &self.attrs.default;
 quote! {
 let #ident = decoder.decode::<Option<#ty>>()?.unwrap_or_else(#default);
 }
Expand Down

148 changes: 148 additions & 0 deletions
der/tests/derive.rs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -206,6 +206,98 @@ mod sequence {
 };
 use hex_literal::hex;

 pub fn default_false_example() -> bool {
 false
 }

 // Issuing distribution point extension as defined in [RFC 5280 Section 5.2.5] and as identified by the [`PKIX_PE_SUBJECTINFOACCESS`](constant.PKIX_PE_SUBJECTINFOACCESS.html) OID.
 //
 // ```text
 // IssuingDistributionPoint ::= SEQUENCE {
 // distributionPoint [0] DistributionPointName OPTIONAL,
 // onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 // onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 // indirectCRL [4] BOOLEAN DEFAULT FALSE,
 // onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE }
 // -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
 // -- and onlyContainsAttributeCerts may be set to TRUE.
 // ```
 //
 // [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
 #[derive(Sequence)]
 pub struct IssuingDistributionPointExample {
 // Omit distributionPoint and only_some_reasons because corresponding structs are not
 // available here and are not germane to the example
 // distributionPoint [0] DistributionPointName OPTIONAL,
 //#[asn1(context_specific="0", optional="true", tag_mode="IMPLICIT")]
 //pub distribution_point: Option<DistributionPointName<'a>>,
 /// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "1",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_user_certs: bool,

 /// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "2",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_cacerts: bool,

 // onlySomeReasons [3] ReasonFlags OPTIONAL,
 //#[asn1(context_specific="3", optional="true", tag_mode="IMPLICIT")]
 //pub only_some_reasons: Option<ReasonFlags<'a>>,

Comment on lines

+251
 to 
+253

@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason why this is commented out?
@carl-wallacecarl-wallaceNov 19, 2021

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The types for the commented out fields are not in the main x509 repo yet. Replicating those here seemed heavier than the value they would add to the example. The structure without the comments will land as x509 bits are pushed.
@tarcieritarcieriNov 19, 2021

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aah, ok. Maybe a TODO then?
 /// indirectCRL [4] BOOLEAN DEFAULT FALSE,
 #[asn1(
 context_specific = "4",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub indirect_crl: bool,

 /// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
 #[asn1(
 context_specific = "5",
 default = "default_false_example",
 tag_mode = "IMPLICIT"
 )]
 pub only_contains_attribute_certs: bool,
 }

 // Extension as defined in [RFC 5280 Section 4.1.2.9].
 //
 // The ASN.1 definition for Extension objects is below. The extnValue type may be further parsed using a decoder corresponding to the extnID value.
 //
 // ```text
 // Extension ::= SEQUENCE {
 // extnID OBJECT IDENTIFIER,
 // critical BOOLEAN DEFAULT FALSE,
 // extnValue OCTET STRING
 // -- contains the DER encoding of an ASN.1 value
 // -- corresponding to the extension type identified
 // -- by extnID
 // }
 // ```
 //
 // [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
 #[derive(Clone, Debug, Eq, PartialEq, Sequence)]
 pub struct ExtensionExample<'a> {
 /// extnID OBJECT IDENTIFIER,
 pub extn_id: ObjectIdentifier,

 /// critical BOOLEAN DEFAULT FALSE,
 #[asn1(default = "default_false_example")]
 pub critical: bool,

 /// extnValue OCTET STRING
 #[asn1(type = "OCTET STRING")]
 pub extn_value: &'a [u8],
 }

 /// X.509 `AlgorithmIdentifier`
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
 pub struct AlgorithmIdentifier<'a> {
Expand DownExpand Up@@ -261,6 +353,62 @@ mod sequence {
 const ALGORITHM_IDENTIFIER_DER: &[u8] =
 &hex!("30 13 06 07 2a 86 48 ce 3d 02 01 06 08 2a 86 48 ce 3d 03 01 07");

 #[test]
 fn idp_test() {
 let idp = IssuingDistributionPointExample::from_der(&hex!("30038101FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, true);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038201FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, true);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038401FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, true);
 assert_eq!(idp.only_contains_attribute_certs, false);

 let idp = IssuingDistributionPointExample::from_der(&hex!("30038501FF")).unwrap();
 assert_eq!(idp.only_contains_user_certs, false);
 assert_eq!(idp.only_contains_cacerts, false);
 assert_eq!(idp.indirect_crl, false);
 assert_eq!(idp.only_contains_attribute_certs, true);
 }

 // demonstrates default field that is not context specific
 #[test]
 fn extension_test() {
 let ext1 = ExtensionExample::from_der(&hex!(
 "
 300F // 0 15: SEQUENCE {
 0603551D13 // 2 3: OBJECT IDENTIFIER basicConstraints (2 5 29 19)
 0101FF // 7 1: BOOLEAN TRUE
 0405 // 10 5: OCTET STRING, encapsulates {
 3003 // 12 3: SEQUENCE {
 0101FF // 14 1: BOOLEAN TRUE
 "
 ))
 .unwrap();
 assert_eq!(ext1.critical, true);

 let ext2 = ExtensionExample::from_der(&hex!(
 "
 301F // 0 31: SEQUENCE {
 0603551D23 // 2 3: OBJECT IDENTIFIER authorityKeyIdentifier (2 5 29 35)
 0418 // 7 24: OCTET STRING, encapsulates {
 3016 // 9 22: SEQUENCE {
 8014E47D5FD15C9586082C05AEBE75B665A7D95DA866 // 11 20: [0] E4 7D 5F D1 5C 95 86 08 2C 05 AE BE 75 B6 65 A7 D9 5D A8 66
 "
 ))
 .unwrap();
 assert_eq!(ext2.critical, false);
 }

 #[test]
 fn decode() {
 let algorithm_identifier =
Expand Down