Prepare fixed MSI 1.1 major upgrade with honest timeout and noop outcomes

This commit is contained in:
2026-11-14 11:18:21 +01:00
parent eb38b4b209
commit c393b6bdd2
4 changed files with 708 additions and 49 deletions
+97 -6
View File
@@ -1,7 +1,6 @@
//! Unexported Windows MSI fixture contract. No legacy Linux codec is changed.
//! This version supports first installation or independently proven exact noop;
//! an upgrade requires a separate reviewed recipe with explicit predecessor
//! products/UpgradeCode semantics. No implicit REINSTALL flags are inferred.
//! Fixed1.0 first installation/noop and separate1.0→1.1 major-upgrade/noop
//! recipes only. No implicit REINSTALL, repair, downgrade or fresh1.1 mode.
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use uuid::Uuid;
@@ -11,6 +10,17 @@ pub const MSI_PRODUCT_CODE: &str = "{3F070B4B-9C08-4D65-BD41-13D81B884AEC}";
pub const MSI_UPGRADE_CODE: &str = "{C9BF1FB8-E31D-4BD7-BA0D-AB46539BBBAA}";
pub const MSI_VERSION: &str = "1.0.0";
pub const MSI_PAYLOAD: &str = r"C:\Program Files\RustDiscoveryFixtures\msi-payload.txt";
pub const MSI_UPGRADE_RECIPE_ID: &str = "rmm-windows-msi-fixture-upgrade-1.1";
pub const MSI_UPGRADE_PRODUCT_CODE: &str = "{D42BD387-079B-4BBF-A134-0DA7B7A97011}";
pub const MSI_UPGRADE_VERSION: &str = "1.1.0";
pub const MSI_PAYLOAD_BYTES: u64 = 33;
pub const MSI_PAYLOAD_10_SHA256: &str =
"0c90c4fc7233017cc88c0e925095d6662ac57abdb303c7527ef59d02b454fca0";
pub const MSI_PAYLOAD_11_SHA256: &str =
"ba0c83deff9eed014009bcd45369b2a356ae909ebf0c1434dc836b0e6d759c49";
pub const MSI_OLD_PRODUCTS: &str = "RMM_OLD_PRODUCTS";
pub const MSI_ALL_PRODUCTS: &str = "RMM_ALL_PRODUCTS";
pub const MSI_UPGRADE_CONDITION: &str = "Installed OR (RMM_OLD_PRODUCTS = \"{3F070B4B-9C08-4D65-BD41-13D81B884AEC}\" AND RMM_ALL_PRODUCTS = \"{3F070B4B-9C08-4D65-BD41-13D81B884AEC}\")";
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Architecture {
@@ -56,6 +66,11 @@ pub struct WindowsMsiRecipe {
pub artifact: MsiArtifact,
pub postcondition: MsiPostcondition,
pub no_reboot: bool,
// Appended opt-in metadata: old1.0 recipes retain exactly their old bytes.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub package_code: Option<String>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub predecessor: Option<MsiPostcondition>,
}
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
@@ -70,10 +85,16 @@ pub fn digest(value: &str) -> bool {
.bytes()
.all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b))
}
pub fn valid_package_code(value: &str) -> bool {
Uuid::parse_str(value).is_ok_and(|id| {
!id.is_nil()
&& value == format!("{{{}}}", id.to_string().to_uppercase())
&& ![MSI_PRODUCT_CODE, MSI_UPGRADE_PRODUCT_CODE, MSI_UPGRADE_CODE].contains(&value)
})
}
impl WindowsMsiRecipe {
pub fn validate(&self) -> bool {
self.schema_version == 1
&& self.recipe_id == MSI_RECIPE_ID
&& self.recipe_version == "1"
&& self.platform == "windows"
&& self.upgrade_code == MSI_UPGRADE_CODE
@@ -81,11 +102,32 @@ impl WindowsMsiRecipe {
&& !self.artifact.artifact_id.is_nil()
&& digest(&self.artifact.sha256)
&& (1..=262144).contains(&self.artifact.bytes)
&& self.postcondition.product_code == MSI_PRODUCT_CODE
&& self.postcondition.product_version == MSI_VERSION
&& self.postcondition.payload_path == MSI_PAYLOAD
&& digest(&self.postcondition.payload_sha256)
&& (1..=65536).contains(&self.postcondition.payload_bytes)
&& match self.recipe_id.as_str() {
MSI_RECIPE_ID => {
self.postcondition.product_code == MSI_PRODUCT_CODE
&& self.postcondition.product_version == MSI_VERSION
&& self.package_code.is_none()
&& self.predecessor.is_none()
}
MSI_UPGRADE_RECIPE_ID => {
self.postcondition.product_code == MSI_UPGRADE_PRODUCT_CODE
&& self.postcondition.product_version == MSI_UPGRADE_VERSION
&& self.postcondition.payload_sha256 == MSI_PAYLOAD_11_SHA256
&& self.postcondition.payload_bytes == MSI_PAYLOAD_BYTES
&& self.package_code.as_deref().is_some_and(valid_package_code)
&& self.predecessor.as_ref().is_some_and(|old| {
old.product_code == MSI_PRODUCT_CODE
&& old.product_version == MSI_VERSION
&& old.payload_path == MSI_PAYLOAD
&& old.payload_sha256 == MSI_PAYLOAD_10_SHA256
&& old.payload_bytes == MSI_PAYLOAD_BYTES
})
}
_ => false,
}
}
pub fn sha256(&self) -> Result<String, serde_json::Error> {
Ok(format!("{:x}", Sha256::digest(serde_json::to_vec(self)?)))
@@ -127,6 +169,55 @@ mod tests {
payload_bytes: 20,
},
no_reboot: true,
package_code: None,
predecessor: None,
}
}
#[test]
fn major_upgrade_requires_explicit_exact_predecessor_new_package_and_same_family() {
let old = recipe();
let old_bytes = serde_json::to_vec(&old).unwrap();
assert!(
!String::from_utf8(old_bytes.clone())
.unwrap()
.contains("predecessor")
);
assert_eq!(
serde_json::to_vec(&serde_json::from_slice::<WindowsMsiRecipe>(&old_bytes).unwrap())
.unwrap(),
old_bytes
);
let mut r = old.clone();
r.recipe_id = MSI_UPGRADE_RECIPE_ID.into();
r.package_code = Some("{8475C4D1-6EE2-4C3A-B41D-D834A20F4135}".into());
r.postcondition.product_code = MSI_UPGRADE_PRODUCT_CODE.into();
r.postcondition.product_version = MSI_UPGRADE_VERSION.into();
r.postcondition.payload_sha256 = MSI_PAYLOAD_11_SHA256.into();
r.postcondition.payload_bytes = MSI_PAYLOAD_BYTES;
r.predecessor = Some(MsiPostcondition {
product_code: MSI_PRODUCT_CODE.into(),
product_version: MSI_VERSION.into(),
payload_path: MSI_PAYLOAD.into(),
payload_sha256: MSI_PAYLOAD_10_SHA256.into(),
payload_bytes: MSI_PAYLOAD_BYTES,
});
assert!(r.validate());
assert_ne!(r.sha256().unwrap(), old.sha256().unwrap());
for case in 0..8 {
let mut bad = r.clone();
match case {
0 => bad.predecessor = None,
1 => bad.package_code = None,
2 => bad.package_code = Some(MSI_PRODUCT_CODE.into()),
3 => bad.upgrade_code = Uuid::new_v4().to_string(),
4 => {
bad.predecessor.as_mut().unwrap().product_code = MSI_UPGRADE_PRODUCT_CODE.into()
}
5 => bad.predecessor.as_mut().unwrap().payload_sha256 = "aa".repeat(32),
6 => bad.postcondition.product_version = "1.2.0".into(),
_ => bad.postcondition.payload_sha256 = MSI_PAYLOAD_10_SHA256.into(),
};
assert!(!bad.validate());
}
}
#[test]