Skip to content

Native iCloud apps for Windows and Linux, built in Rust. Notes, Reminders, Calendar, Contacts, Drive and Photos, offline and in sync with your iPhone.

Some note bodies are zlib, not gzip

Yashwanth Kamireddi258385d66124
diff --git a/crates/quince-icloud/src/ckdocument.rs b/crates/quince-icloud/src/ckdocument.rs
index 058e325..7a23c4d 100644
--- a/crates/quince-icloud/src/ckdocument.rs
+++ b/crates/quince-icloud/src/ckdocument.rs
@@ -101,18 +101,42 @@ fn field_at<'a>(bytes: &'a [u8], path: &[u64]) -> Option<&'a [u8]> {
None
}
-/// Ungzip a CloudKit document payload, refusing anything implausibly large.
+/// Decompress a CloudKit document payload.
+///
+/// Apple uses more than one wrapper. Most payloads are gzip, but some are raw zlib and some
+/// are not compressed at all — a note body arriving as zlib decoded to nothing for as long as
+/// only gzip was handled, which looked like an empty note rather than a decoder gap.
fn inflate(compressed: &[u8]) -> Option<Vec<u8>> {
- // Not gzip: some payloads are stored plainly.
- if compressed.len() < 3 || compressed[0] != 0x1f || compressed[1] != 0x8b {
+ if compressed.len() < 2 {
return Some(compressed.to_vec());
}
- let mut out = Vec::new();
- flate2::read::GzDecoder::new(compressed)
- .take(MAX_DECOMPRESSED)
- .read_to_end(&mut out)
- .ok()?;
- Some(out)
+
+ let read_all = |mut reader: Box<dyn Read>| -> Option<Vec<u8>> {
+ let mut out = Vec::new();
+ reader.read_to_end(&mut out).ok()?;
+ Some(out)
+ };
+
+ // gzip
+ if compressed[0] == 0x1f && compressed[1] == 0x8b {
+ return read_all(Box::new(
+ flate2::read::GzDecoder::new(compressed).take(MAX_DECOMPRESSED),
+ ));
+ }
+
+ // zlib: low nibble of the first byte is the method (8 = deflate), and the two-byte
+ // header is a multiple of 31.
+ let header = u16::from(compressed[0]) << 8 | u16::from(compressed[1]);
+ if compressed[0] & 0x0f == 8 && header % 31 == 0 {
+ if let Some(out) = read_all(Box::new(
+ flate2::read::ZlibDecoder::new(compressed).take(MAX_DECOMPRESSED),
+ )) {
+ return Some(out);
+ }
+ }
+
+ // Not compressed: titles and folder names arrive as bare bytes.
+ Some(compressed.to_vec())
}
/// The readable text of a CloudKit document field, or `None` if there is none to find.
@@ -275,6 +299,43 @@ mod tests {
}
}
+ fn zlib(bytes: &[u8]) -> Vec<u8> {
+ let mut encoder =
+ flate2::write::ZlibEncoder::new(Vec::new(), flate2::Compression::default());
+ encoder.write_all(bytes).unwrap();
+ encoder.finish().unwrap()
+ }
+
+ /// Apple compresses some payloads with zlib rather than gzip. Handling only gzip made
+ /// those notes render as empty, which reads as data loss rather than a decoder gap.
+ #[test]
+ fn reads_a_zlib_document_as_well_as_gzip() {
+ let text = "🔴 UNIT 2: STATIC & DYNAMIC SOFTWARE TESTING";
+ assert_eq!(
+ text_from_bytes(&zlib(&document(text))).as_deref(),
+ Some(text)
+ );
+ assert_eq!(
+ text_from_bytes(&gzipped(&document(text))).as_deref(),
+ Some(text)
+ );
+ }
+
+ #[test]
+ fn reads_zlib_wrapped_bare_text() {
+ assert_eq!(
+ text_from_bytes(&zlib(b"Recently Deleted")).as_deref(),
+ Some("Recently Deleted")
+ );
+ }
+
+ /// Bytes that merely start with 0x78 must not be mistaken for zlib.
+ #[test]
+ fn a_leading_0x78_that_is_not_zlib_still_reads_as_text() {
+ // 'x' is 0x78, and "xy" fails the header checksum, so it must fall through to text.
+ assert_eq!(text_from_bytes(b"xy note").as_deref(), Some("xy note"));
+ }
+
#[test]
fn reads_an_uncompressed_document_too() {
assert_eq!(
diff --git a/probe/src/main.rs b/probe/src/main.rs
index 8af69f7..e73b4bf 100644
--- a/probe/src/main.rs
+++ b/probe/src/main.rs
@@ -665,12 +665,17 @@ async fn main() -> Result<()> {
if kind == "Note" {
println!(" text={:?}", decode("TextDataEncrypted"));
}
- // The title does not decode at the reminders path, so emit the raw
- // payload once and let the structure be read directly.
- if let Some(raw) =
- quince_icloud::cloudkit::field::string(r, "TitleEncrypted")
+ // Emit any body that will not decode, so its shape can be read
+ // directly rather than guessed at.
+ if kind == "Note"
+ && quince_icloud::cloudkit::field::document_text(r, "TextDataEncrypted")
+ .is_none()
{
- println!(" TITLE_B64 {raw}");
+ if let Some(raw) =
+ quince_icloud::cloudkit::field::string(r, "TextDataEncrypted")
+ {
+ println!(" BODY_B64 {raw}");
+ }
}
}