Skip to content
This repository has been archived by the owner on Jul 21, 2023. It is now read-only.

Commit

Permalink
protocol: make encryption_key_id optional
Browse files Browse the repository at this point in the history 
Ingestion servers will not all be populating the encryption_key_id field
in PrioDataSharePacket, so we need to make that an optional field in the
Avro message.
  • Loading branch information
@tgeoghegan
tgeoghegan committed Oct 23, 2020
1 parent 51e5704 commit ae6baa8
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
5 changes: 4 additions & 1 deletion avro-schema/ingestion-data-share-packet.avsc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@
},
{
"name": "encryption_key_id",
"type": "string",
"type": [
"null",
"string"
],
"doc": "Encryption key identifier (e.g., to support key rotations)"
},
{
Expand Down
6 changes: 3 additions & 3 deletions facilitator/src/batch.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,23 +303,23 @@ mod tests {
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![0u8, 1u8, 2u8, 3u8],
encryption_key_id: "fake-key-1".to_owned(),
encryption_key_id: Some("fake-key-1".to_owned()),
r_pit: 1,
version_configuration: Some("config-1".to_owned()),
device_nonce: None,
},
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![4u8, 5u8, 6u8, 7u8],
encryption_key_id: "fake-key-2".to_owned(),
encryption_key_id: None,
r_pit: 2,
version_configuration: None,
device_nonce: Some(vec![8u8, 9u8, 10u8, 11u8]),
},
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![8u8, 9u8, 10u8, 11u8],
encryption_key_id: "fake-key-3".to_owned(),
encryption_key_id: Some("fake-key-3".to_owned()),
r_pit: 3,
version_configuration: None,
device_nonce: None,
Expand Down
38 changes: 23 additions & 15 deletions facilitator/src/idl.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ impl Header for IngestionHeader {
pub struct IngestionDataSharePacket {
pub uuid: Uuid,
pub encrypted_payload: Vec<u8>,
pub encryption_key_id: String,
pub encryption_key_id: Option<String>,
pub r_pit: i64,
pub version_configuration: Option<String>,
pub device_nonce: Option<Vec<u8>>,
Expand Down Expand Up @@ -409,7 +409,16 @@ impl Packet for IngestionDataSharePacket {
match (tuple.0.as_str(), tuple.1) {
("uuid", Value::Uuid(v)) => uuid = Some(v),
("encrypted_payload", Value::Bytes(v)) => encrypted_payload = Some(v),
("encryption_key_id", Value::String(v)) => encryption_key_id = Some(v),
("encryption_key_id", Value::Union(boxed)) => match *boxed {
Value::String(v) => encryption_key_id = Some(v),
Value::Null => encryption_key_id = None,
v => {
return Err(Error::MalformedDataPacketError(format!(
"unexpected boxed value {:?} in encryption_key_id",
v
)))
}
},
("r_pit", Value::Long(v)) => r_pit = Some(v),
("version_configuration", Value::Union(boxed)) => match *boxed {
Value::String(v) => version_configuration = Some(v),
Expand Down Expand Up @@ -440,11 +449,7 @@ impl Packet for IngestionDataSharePacket {
}
}

if uuid.is_none()
|| encrypted_payload.is_none()
|| encryption_key_id.is_none()
|| r_pit.is_none()
{
if uuid.is_none() || encrypted_payload.is_none() || r_pit.is_none() {
return Err(Error::MalformedDataPacketError(
"missing fields in record".to_owned(),
));
Expand All @@ -453,7 +458,7 @@ impl Packet for IngestionDataSharePacket {
Ok(IngestionDataSharePacket {
uuid: uuid.unwrap(),
encrypted_payload: encrypted_payload.unwrap(),
encryption_key_id: encryption_key_id.unwrap(),
encryption_key_id,
r_pit: r_pit.unwrap(),
version_configuration,
device_nonce,
Expand All @@ -476,10 +481,13 @@ impl Packet for IngestionDataSharePacket {
"encrypted_payload",
Value::Bytes(self.encrypted_payload.clone()),
);
record.put(
"encryption_key_id",
Value::String(self.encryption_key_id.clone()),
);
match &self.encryption_key_id {
Some(v) => record.put(
"encryption_key_id",
Value::Union(Box::new(Value::String(v.to_owned()))),
),
None => record.put("encryption_key_id", Value::Union(Box::new(Value::Null))),
}
record.put("r_pit", Value::Long(self.r_pit));
match &self.version_configuration {
Some(v) => record.put(
Expand Down Expand Up @@ -1102,23 +1110,23 @@ mod tests {
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![0u8, 1u8, 2u8, 3u8],
encryption_key_id: "fake-key-1".to_owned(),
encryption_key_id: Some("fake-key-1".to_owned()),
r_pit: 1,
version_configuration: Some("config-1".to_owned()),
device_nonce: None,
},
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![4u8, 5u8, 6u8, 7u8],
encryption_key_id: "fake-key-2".to_owned(),
encryption_key_id: None,
r_pit: 2,
version_configuration: None,
device_nonce: Some(vec![8u8, 9u8, 10u8, 11u8]),
},
IngestionDataSharePacket {
uuid: Uuid::new_v4(),
encrypted_payload: vec![8u8, 9u8, 10u8, 11u8],
encryption_key_id: "fake-key-3".to_owned(),
encryption_key_id: Some("fake-key-3".to_owned()),
r_pit: 3,
version_configuration: None,
device_nonce: None,
Expand Down
4 changes: 2 additions & 2 deletions facilitator/src/sample.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ pub fn generate_ingestion_sample(
let pha_packet = IngestionDataSharePacket {
uuid: packet_uuid,
encrypted_payload: pha_share,
encryption_key_id: "pha-fake-key-1".to_owned(),
encryption_key_id: Some("pha-fake-key-1".to_owned()),
r_pit: u32::from(r_pit) as i64,
version_configuration: Some("config-1".to_owned()),
device_nonce: None,
Expand All @@ -102,7 +102,7 @@ pub fn generate_ingestion_sample(
let facilitator_packet = IngestionDataSharePacket {
uuid: packet_uuid,
encrypted_payload: facilitator_share,
encryption_key_id: "facilitator-fake-key-1".to_owned(),
encryption_key_id: None,
r_pit: u32::from(r_pit) as i64,
version_configuration: Some("config-1".to_owned()),
device_nonce: None,
Expand Down

0 comments on commit ae6baa8

Please sign in to comment.