Skip to content

crypto: improve SenderData stored with room key bundle data #4988

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.

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
merged 3 commits into from
May 7, 2025

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Apr 29, 2025

If we already have cross-signing details for the owner of the device at the point we receive the to-device message, we should store that rather than just the device info.

To enable this, we have a couple of preparatory commits which factor out some code from SenderDataFinder so that we can reuse the same logic when we receive the key bundle data.

Suggest review commit-by-commit

Part of element-hq/element-meta#2685

@richvdh richvdh requested review from a team as code owners April 29, 2025 11:07
@richvdh richvdh requested review from poljar and removed request for a team April 29, 2025 11:07
@richvdh richvdh force-pushed the rav/history_sharing/better_sender_data branch from a6b0f8b to 4319703 Compare April 29, 2025 11:13
Copy link

codecov bot commented Apr 29, 2025

Codecov Report

Attention: Patch coverage is 92.59259% with 2 lines in your changes missing coverage. Please review.

Project coverage is 85.90%. Comparing base (ff32840) to head (f349a66).
Report is 39 commits behind head on main.

Files with missing lines Patch % Lines
...x-sdk-crypto/src/olm/group_sessions/sender_data.rs 90.47% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4988      +/-   ##
==========================================
+ Coverage   85.89%   85.90%   +0.01%     
==========================================
  Files         325      325              
  Lines       35731    35733       +2     
==========================================
+ Hits        30690    30697       +7     
+ Misses       5041     5036       -5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@richvdh richvdh force-pushed the rav/history_sharing/better_sender_data branch from 4319703 to 99fab18 Compare April 29, 2025 11:36
Copy link
Contributor

@poljar poljar left a comment

Choose a reason for hiding this comment

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

Left a couple nits about the panics here.

Comment on lines +955 to +957
// We already checked that `sender_device_keys` matches the actual sender of the
// message when we decrypted the message, which included doing
// `DeviceData::try_from` on it, so it can't fail.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can't we instead treat that the same way as we treat the None case up above?

And let a test ensure that we always handle this properly?

Copy link
Member Author

Choose a reason for hiding this comment

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

You mean, ignore the to-device message, rather than panic?

I suppose so, though generally I take the view that "unreachable" code should cause a crash so that you get an early warning that your previous assumptions no longer hold.

Copy link
Contributor

Choose a reason for hiding this comment

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

Well ok, I guess it's marginally easier to see where the assumption changed if we panic here instead in a test.

Copy link
Member Author

Choose a reason for hiding this comment

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

As for a test: what did you have in mind? receive_room_key_bundle_data is private so can't easily be called directly from a test, as are its callers. And, for obvious reasons, we can't test this by injecting a to-device message with a mis-signed sender_device_keys.

Copy link
Contributor

Choose a reason for hiding this comment

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

I just assumed that testing the happy path here would be enough to ensure that the assumption didn't change.

Copy link
Member Author

Choose a reason for hiding this comment

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

If you don't have strong opinions on this one, I'd like to leave it as-is. I think otherwise we end up with more unreachable (and untestable) code.

richvdh added 2 commits May 7, 2025 22:16
create a new method `SenderData::from_device` which does the last few steps of
`SenderDataFinder`: turns out we want it elsewhere. Add some tests to test that
functionality in isolation.
If we already have cross-signing details for the owner of the device at the
point we receive the to-device message, we should store that rather than just
the device info.
@richvdh richvdh force-pushed the rav/history_sharing/better_sender_data branch from 8e76266 to f349a66 Compare May 7, 2025 21:17
@richvdh richvdh enabled auto-merge May 7, 2025 21:17
@richvdh richvdh merged commit 55d475d into main May 7, 2025
41 of 42 checks passed
@richvdh richvdh deleted the rav/history_sharing/better_sender_data branch May 7, 2025 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants