Skip to content

feat(rust/signed-doc): Add 'NotSpecified' variant to Content Encoding validation rule #529

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
saibatizoku merged 1 commit into from
Sep 2, 2025
Merged

feat(rust/signed-doc): Add 'NotSpecified' variant to Content Encoding validation rule #529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion rust/catalyst-signed-doc-macro/src/rules/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub(crate) fn catalyst_signed_documents_rules_impl() -> anyhow::Result<TokenStre
content_type: crate::validator::rules::ContentTypeRule {
exp: ContentType::Json,
},
content_encoding: crate::validator::rules::ContentEncodingRule {
content_encoding: crate::validator::rules::ContentEncodingRule::Specified {
exp: ContentEncoding::Brotli,
optional: false,
},
Expand Down
6 changes: 3 additions & 3 deletions rust/signed_doc/src/validator/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ fn proposal_rule() -> Rules {
content_type: ContentTypeRule {
exp: ContentType::Json,
},
content_encoding: ContentEncodingRule {
content_encoding: ContentEncodingRule::Specified {
exp: ContentEncoding::Brotli,
optional: false,
},
Expand Down Expand Up @@ -82,7 +82,7 @@ fn proposal_comment_rule() -> Rules {
content_type: ContentTypeRule {
exp: ContentType::Json,
},
content_encoding: ContentEncodingRule {
content_encoding: ContentEncodingRule::Specified {
exp: ContentEncoding::Brotli,
optional: false,
},
Expand Down Expand Up @@ -138,7 +138,7 @@ fn proposal_submission_action_rule() -> Rules {
content_type: ContentTypeRule {
exp: ContentType::Json,
},
content_encoding: ContentEncodingRule {
content_encoding: ContentEncodingRule::Specified {
exp: ContentEncoding::Brotli,
optional: false,
},
Expand Down
115 changes: 79 additions & 36 deletions rust/signed_doc/src/validator/rules/content_encoding.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@

use crate::{metadata::ContentEncoding, CatalystSignedDocument};

/// `content-encoding` field validation rule
/// `content-encoding` field validation rule.
#[derive(Debug)]
pub(crate) struct ContentEncodingRule {
/// expected `content-encoding` field
pub(crate) exp: ContentEncoding,
/// optional flag for the `content-encoding` field
pub(crate) optional: bool,
pub(crate) enum ContentEncodingRule {
/// Content Encoding field is optionally present in the document.
Specified {
/// expected `content-encoding` field.
exp: ContentEncoding,
/// optional flag for the `content-encoding` field.
optional: bool,
},
/// Content Encoding field must not be present in the document.
#[allow(dead_code)]
NotSpecified,
}

impl ContentEncodingRule {
Expand All @@ -18,33 +24,50 @@ impl ContentEncodingRule {
&self,
doc: &CatalystSignedDocument,
) -> anyhow::Result<bool> {
if let Some(content_encoding) = doc.doc_content_encoding() {
if content_encoding != self.exp {
doc.report().invalid_value(
"content-encoding",
content_encoding.to_string().as_str(),
self.exp.to_string().as_str(),
"Invalid Document content-encoding value",
);
return Ok(false);
}
if content_encoding.decode(doc.encoded_content()).is_err() {
doc.report().invalid_value(
"payload",
&hex::encode(doc.encoded_content()),
&format!(
"Document content (payload) must decodable by the set content encoding type: {content_encoding}"
),
"Invalid Document content value",
);
return Ok(false);
}
} else if !self.optional {
doc.report().missing_field(
"content-encoding",
"Document must have a content-encoding field",
);
return Ok(false);
let context = "Content Encoding Rule check";
match self {
Self::NotSpecified => {
if let Some(content_encoding) = doc.doc_content_encoding() {
doc.report().unknown_field(
"content-encoding",
&content_encoding.to_string(),
&format!(
"{context}, document does not expect to have a content-encoding field"
),
);
return Ok(false);
}
},
Self::Specified { exp, optional } => {
if let Some(content_encoding) = doc.doc_content_encoding() {
if content_encoding != *exp {
doc.report().invalid_value(
"content-encoding",
content_encoding.to_string().as_str(),
exp.to_string().as_str(),
"Invalid Document content-encoding value",
);
return Ok(false);
}
if content_encoding.decode(doc.encoded_content()).is_err() {
doc.report().invalid_value(
"payload",
&hex::encode(doc.encoded_content()),
&format!(
"Document content (payload) must decodable by the set content encoding type: {content_encoding}"
),
"Invalid Document content value",
);
return Ok(false);
}
} else if !optional {
doc.report().missing_field(
"content-encoding",
"Document must have a content-encoding field",
);
return Ok(false);
}
},
}
Ok(true)
}
Expand All @@ -56,10 +79,10 @@ mod tests {
use crate::{builder::tests::Builder, metadata::SupportedField};

#[tokio::test]
async fn content_encoding_rule_test() {
async fn content_encoding_is_specified_rule_test() {
let content_encoding = ContentEncoding::Brotli;

let mut rule = ContentEncodingRule {
let rule = ContentEncodingRule::Specified {
exp: content_encoding,
optional: true,
};
Expand All @@ -79,7 +102,27 @@ mod tests {
let doc = Builder::new().build();
assert!(rule.check(&doc).await.unwrap());

rule.optional = false;
let rule = ContentEncodingRule::Specified {
exp: content_encoding,
optional: false,
};
assert!(!rule.check(&doc).await.unwrap());
}

#[tokio::test]
async fn content_encoding_is_not_specified_rule_test() {
let content_encoding = ContentEncoding::Brotli;

let rule = ContentEncodingRule::NotSpecified;

// With Brotli content encoding
let doc = Builder::new()
.with_metadata_field(SupportedField::ContentEncoding(content_encoding))
.build();
assert!(!rule.check(&doc).await.unwrap());

// No content encoding
let doc = Builder::new().build();
assert!(rule.check(&doc).await.unwrap());
}
}
Loading