Add support for public extensions in Reports. #754

jhoyla · 2024-12-31T15:38:22Z

Draft 13 adds mandatory support for public extensions in the ReportMetadata, but doesn't define any (Taskprov is (for now) a private extension). This PR adds support for rejecting unknown extensions, which is all of them.

cjpatton

I believe we're missing one feature: we need to resolve repeated extensions across the public and private extension fields.

crates/daphne/src/error/aborts.rs

crates/daphne/src/messages/mod.rs

crates/daphne/src/protocol/report_init.rs

jhoyla · 2025-01-02T13:05:20Z

I believe we're missing one feature: we need to resolve repeated extensions across the public and private extension fields.

So the spec says:

type. (For the purposes of this check, a private report extension can conflict
with a public report extension.) If so, the Aggregator MUST mark the input share
as invalid with error invalid_message.

Which I take to mean a conflict between the public and private extensions is allowed.
If I add support for taskprov as a public extension do I reject it if it appears in both places?

mendess

not even a nit, just a comment. I don't have a preference but instead of Vec::new() you can write vec![]

cjpatton · 2025-01-02T16:40:28Z

I believe we're missing one feature: we need to resolve repeated extensions across the public and private extension fields.

So the spec says:
type. (For the purposes of this check, a private report extension can conflict
with a public report extension.) If so, the Aggregator MUST mark the input share
as invalid with error invalid_message.
Which I take to mean a conflict between the public and private extensions is allowed. If I add support for taskprov as a public extension do I reject it if it appears in both places?

The intent of the text is: "if the same extension appears twice, then the report MUST be rejected - regardless of what fields the extensions appear in." In particular, if the taskprov extension appears in the public and private fields, then reject.

cjpatton

The code looks largely correct, though I have some suggestions for behavior changes. I think the tests need a bit of work. Also, I have some suggestions for making the code a little cleaner/easier to read.

cjpatton · 2025-01-09T23:33:08Z

crates/daphne-server/tests/e2e/e2e.rs

@@ -533,6 +537,150 @@ async fn leader_upload_taskprov_wrong_version(version: DapVersion) {

 async_test_versions!(leader_upload_taskprov_wrong_version);

+#[tokio::test]


I think the test coverage in the daphne::roles module is high enough that we could just as easily move theses tests there. You can call leader::handle_upload_req() on the mock aggregator, just as you already do in a new test in that module.

Any code path that can be tested without the e2e setup ought to be moved to a unit test, since unit tests are easier to run.

cjpatton · 2025-01-09T23:35:30Z

crates/daphne/src/error/aborts.rs

+        task_id: &TaskId,
+        unknown_extensions: &[u16],
+    ) -> Result<Self, DapError> {
+        let detail = serde_json::to_string(&unknown_extensions);


Unnecessary reference

Suggested change

let detail = serde_json::to_string(&unknown_extensions);

let detail = serde_json::to_string(unknown_extensions);

cjpatton · 2025-01-09T23:35:45Z

crates/daphne/src/error/aborts.rs

+                detail: s,
+                task_id: *task_id,
+            }),
+            Err(x) => Err(fatal_error!(err = %x,)),


Suggested change

Err(x) => Err(fatal_error!(err = %x,)),

Err(x) => Err(fatal_error!(err = %x)),

cjpatton · 2025-01-09T23:36:54Z

crates/daphne/src/error/aborts.rs

+        task_id: &TaskId,
+        unknown_extensions: &[u16],
+    ) -> Result<Self, DapError> {
+        let detail = serde_json::to_string(&unknown_extensions);


More Rusty

Suggested change

let detail = serde_json::to_string(&unknown_extensions);

let detail = serde_json::to_string(&unknown_extensions).map_err(|e| fatal_error!(err = e))?;

cjpatton · 2025-01-09T23:41:20Z

crates/daphne/src/protocol/client.rs

+            public_extensions: match version {
+                DapVersion::Draft09 => None,
+                DapVersion::Latest => Some(Vec::new()),
+            },


Since the extensions are replicated between the Leader and Helper, perhaps it makes more sense to include them in the public extensions field rather than in the private extension fields.

If you take this suggestion, let's also rename extensions to public_extensions.

cjpatton · 2025-01-10T00:00:08Z

crates/daphne/src/protocol/mod.rs

+            }
+        );
+    }
+    test_versions! {handle_unknown_public_extensions_in_report}


Note: This creates the test for all versions of DAP, including draft 09.

cjpatton · 2025-01-10T00:04:49Z

crates/daphne/src/roles/leader/mod.rs

+    ) {
+        (Some(extensions), DapVersion::Latest) => {
+            let mut unknown_extensions = Vec::<u16>::new();
+            if crate::protocol::no_duplicates(extensions.iter()).is_err() {


And use crate::protocol;. Also, we should rename no_duplicates to something more distinctive.

Suggested change

if crate::protocol::no_duplicates(extensions.iter()).is_err() {

if protocol::no_duplicates(extensions.iter()).is_err() {

cjpatton · 2025-01-10T00:05:22Z

crates/daphne/src/roles/leader/mod.rs

@@ -223,6 +223,47 @@ pub async fn handle_upload_req<A: DapLeader>(
        .into());
    }



Add a comment here telling the reader what's going on.

cjpatton · 2025-01-10T00:10:44Z

crates/daphne/src/roles/leader/mod.rs

+        (Some(_), DapVersion::Draft09) => {
+            return Err(DapError::Abort(DapAbort::version_mismatch(
+                DapVersion::Draft09,
+                DapVersion::Latest,
+            )))
+        }
+        (None, DapVersion::Latest) => {
+            return Err(DapError::Abort(DapAbort::version_mismatch(
+                DapVersion::Latest,
+                DapVersion::Draft09,
+            )))
+        }


I'm not sure either of these arms could ever be reached, assuming the code that sets public_extensions is correct. If I were you, I would use the public_extension.is_some() to deduce which version was negotiated. Tnen we could replace this big ugly match with:

if let Some(public_extensions) = &report.report_metadata.public_extensions { ... // check for duplicates, unorecgonized values, and so on }

cjpatton · 2025-01-10T00:14:38Z

crates/daphne-server/tests/e2e/e2e.rs

@@ -1348,6 +1496,116 @@ async fn leader_selected() {
    .unwrap();
 }

+#[tokio::test]
+async fn leader_collect_taskprov_repeated_abort() {


What does this new test do?

jhoyla requested review from armfazh, bhalleycf, cjpatton, fisherdarling, cbranch, lbaquerofierro, mendess and RageKnify as code owners December 31, 2024 15:38

cjpatton reviewed Jan 1, 2025

View reviewed changes

mendess reviewed Jan 2, 2025

View reviewed changes

jhoyla force-pushed the jhoyla/public-extensions branch 3 times, most recently from 692eb78 to eda9b3c Compare January 8, 2025 11:37

Add support for public extensions in Reports.

5078b99

jhoyla force-pushed the jhoyla/public-extensions branch from eda9b3c to 5078b99 Compare January 8, 2025 12:41

jhoyla requested review from mendess and cjpatton January 8, 2025 12:49

mendess approved these changes Jan 8, 2025

View reviewed changes

cjpatton requested changes Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for public extensions in Reports. #754

Add support for public extensions in Reports. #754

jhoyla commented Dec 31, 2024 •

edited

Loading

cjpatton left a comment

jhoyla commented Jan 2, 2025 •

edited

Loading

mendess left a comment

cjpatton commented Jan 2, 2025

cjpatton left a comment

cjpatton Jan 9, 2025

cjpatton Jan 9, 2025

cjpatton Jan 9, 2025

cjpatton Jan 9, 2025

cjpatton Jan 9, 2025

cjpatton Jan 10, 2025

cjpatton Jan 10, 2025

cjpatton Jan 10, 2025

cjpatton Jan 10, 2025

cjpatton Jan 10, 2025

		@@ -533,6 +537,150 @@ async fn leader_upload_taskprov_wrong_version(version: DapVersion) {

		async_test_versions!(leader_upload_taskprov_wrong_version);

		#[tokio::test]

	let detail = serde_json::to_string(&unknown_extensions);
	let detail = serde_json::to_string(unknown_extensions);

	Err(x) => Err(fatal_error!(err = %x,)),
	Err(x) => Err(fatal_error!(err = %x)),

	if crate::protocol::no_duplicates(extensions.iter()).is_err() {
	if protocol::no_duplicates(extensions.iter()).is_err() {

		@@ -223,6 +223,47 @@ pub async fn handle_upload_req<A: DapLeader>(
		.into());
		}

Add support for public extensions in Reports. #754

Are you sure you want to change the base?

Add support for public extensions in Reports. #754

Conversation

jhoyla commented Dec 31, 2024 • edited Loading

cjpatton left a comment

Choose a reason for hiding this comment

jhoyla commented Jan 2, 2025 • edited Loading

mendess left a comment

Choose a reason for hiding this comment

cjpatton commented Jan 2, 2025

cjpatton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhoyla commented Dec 31, 2024 •

edited

Loading

jhoyla commented Jan 2, 2025 •

edited

Loading