Skip to content

[Decrypt script] In case decryption fails for a record, ignore and continue to decrypt #1270

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

Open
richajaindce wants to merge 9 commits into
base: main
Choose a base branch
from
Open

[Decrypt script] In case decryption fails for a record, ignore and continue to decrypt #1270

Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
794c9ae
In case decryption fails, do not error out
richajaindce Sep 10, 2024
9baca44
In case of an error it, log the error in the file and continue to pro…
richajaindce Sep 13, 2024
bd65cb5
Fixing test
richajaindce Sep 13, 2024
40b2760
move error printing into iterator trait
eriktaubeneck Sep 16, 2024
95af9ff
Merge pull request #36 from eriktaubeneck/decrypt
richajaindce Sep 17, 2024
ce50fbf
fix clippy error
eriktaubeneck Sep 17, 2024
f952513
Merge pull request #37 from eriktaubeneck/decrypt2
richajaindce Sep 17, 2024
fa2c862
Merge branch 'main' into decrypt
richajaindce Oct 28, 2024
2f0e0c1
Adding deryption failure logging
richajaindce Oct 28, 2024
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
137 changes: 82 additions & 55 deletions ipa-core/src/cli/crypto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ use crate::{
U128Conversions,
},
hpke::{KeyRegistry, PrivateKeyOnly},
report::{EncryptedOprfReport, EventType, OprfReport, DEFAULT_KEY_ID},
report::{EncryptedOprfReport, EventType, InvalidReportError, OprfReport, DEFAULT_KEY_ID},
secret_sharing::IntoShares,
test_fixture::{ipa::TestRawDataRecord, Reconstruct},
};
Expand Down Expand Up @@ -146,16 +146,15 @@ impl DecryptedReports {
}

impl Iterator for DecryptedReports {
type Item = OprfReport<BA8, BA3, BA20>;
type Item = Result<OprfReport<BA8, BA3, BA20>, InvalidReportError>;

fn next(&mut self) -> Option<Self::Item> {
let mut line = String::new();
if self.reader.read_line(&mut line).unwrap() > 0 {
let encrypted_report_bytes = hex::decode(line.trim()).unwrap();
let enc_report =
EncryptedOprfReport::from_bytes(encrypted_report_bytes.as_slice()).unwrap();
let dec_report: OprfReport<BA8, BA3, BA20> =
enc_report.decrypt(&self.key_registry).unwrap();
let dec_report = enc_report.decrypt(&self.key_registry);
Some(dec_report)
} else {
None
Expand All @@ -181,60 +180,88 @@ pub async fn decrypt_and_reconstruct(args: DecryptArgs) -> Result<(), BoxError>
.create_new(true)
.open(args.output_file)?,
);

for (dec_report1, (dec_report2, dec_report3)) in
decrypted_reports1.zip(decrypted_reports2.zip(decrypted_reports3))
let mut first_error = Ok(());
Copy link
Member

@eriktaubeneck eriktaubeneck Sep 13, 2024

Choose a reason for hiding this comment

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

what is this for?

for (idx, (dec_report1, (dec_report2, dec_report3))) in decrypted_reports1
.zip(decrypted_reports2.zip(decrypted_reports3))
.enumerate()
{
let timestamp = [
dec_report1.timestamp,
dec_report2.timestamp,
dec_report3.timestamp,
]
.reconstruct()
.as_u128();

let match_key = [
dec_report1.match_key,
dec_report2.match_key,
dec_report3.match_key,
]
.reconstruct()
.as_u128();

// these aren't reconstucted, so we explictly make sure
// they are consistent across all three files, then set
// it to the first one (without loss of generality)
assert_eq!(dec_report1.event_type, dec_report2.event_type);
assert_eq!(dec_report2.event_type, dec_report3.event_type);
let is_trigger_report = dec_report1.event_type == EventType::Trigger;

let breakdown_key = [
dec_report1.breakdown_key,
dec_report2.breakdown_key,
dec_report3.breakdown_key,
]
.reconstruct()
.as_u128();

let trigger_value = [
dec_report1.trigger_value,
dec_report2.trigger_value,
dec_report3.trigger_value,
]
.reconstruct()
.as_u128();

writeln!(
writer,
"{},{},{},{},{}",
timestamp,
match_key,
u8::from(is_trigger_report),
breakdown_key,
trigger_value,
)?;
match (dec_report1, dec_report2, dec_report3) {
Copy link
Member

@eriktaubeneck eriktaubeneck Sep 13, 2024

Choose a reason for hiding this comment

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

it may make sense to check each for errors explicitly up top, so that we make sure we log all 3. we'll want to make sure that all 3 are not decryptable. the suggestion is just a sketch, don't merge it directly.

Suggested change
match (dec_report1, dec_report2, dec_report3) {
if dec_report1.is_err() { # log here }
if dec_report2.is_err() { # log here }
if dec_report3.is_err() { # log here }
match (dec_report1, dec_report2, dec_report3) {
(Ok(dec_report1), Ok(dec_report2), Ok(dec_report3)) => { ... }
_ => { ... }
}

(Ok(dec_report1), Ok(dec_report2), Ok(dec_report3)) => {
let timestamp = [
dec_report1.timestamp,
dec_report2.timestamp,
dec_report3.timestamp,
]
.reconstruct()
.as_u128();

let match_key = [
dec_report1.match_key,
dec_report2.match_key,
dec_report3.match_key,
]
.reconstruct()
.as_u128();

// these aren't reconstucted, so we explictly make sure
// they are consistent across all three files, then set
// it to the first one (without loss of generality)
assert_eq!(dec_report1.event_type, dec_report2.event_type);
assert_eq!(dec_report2.event_type, dec_report3.event_type);
let is_trigger_report = dec_report1.event_type == EventType::Trigger;

let breakdown_key = [
dec_report1.breakdown_key,
dec_report2.breakdown_key,
dec_report3.breakdown_key,
]
.reconstruct()
.as_u128();

let trigger_value = [
dec_report1.trigger_value,
dec_report2.trigger_value,
dec_report3.trigger_value,
]
.reconstruct()
.as_u128();

writeln!(
writer,
"{},{},{},{},{}",
timestamp,
match_key,
u8::from(is_trigger_report),
breakdown_key,
trigger_value,
)?;
}
// error handling in case decryption failed
(Err(e1), _, _) => {
Copy link
Member

@eriktaubeneck eriktaubeneck Sep 13, 2024

Choose a reason for hiding this comment

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

this will end up only matching one of the errors, but it's probably useful to log all 3 if they fail, right?

writeln!(writer, "Decryption failed Record: {idx} Reason:{e1}",)?;
Copy link
Member

@eriktaubeneck eriktaubeneck Sep 13, 2024

Choose a reason for hiding this comment

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

do we actually want to write these to the file?

eprintln!("Decryption failed Record: {idx} Reason:{e1}");
if first_error.is_ok() {
first_error = Err(e1);
}
}
(Ok(_), Err(e2), _) => {
writeln!(writer, "Decryption failed Record: {idx} Reason:{e2}",)?;
eprintln!("Decryption failed Record: {idx} Reason:{e2}");
if first_error.is_ok() {
first_error = Err(e2);
}
}
(Ok(_), Ok(_), Err(e3)) => {
writeln!(writer, "Decryption failed Record: {idx} Reason:{e3}",)?;
eprintln!("Decryption failed Record: {idx} Reason:{e3}");
if first_error.is_ok() {
first_error = Err(e3);
}
}
}
}

first_error.unwrap();
Ok(())
}

Expand Down