pkpass 1.1.0

Rust library for generate Apple Wallet Passes for iOS, WatchOS, MacOS.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

use serde::{ser::SerializeMap, Serialize};
use sha1::Digest;
use sha1::Sha1;

/// Represents manifest.json file, contains SHA-256 of all .pkpass files.
///
/// Only serialization supported!
///
/// <https://developer.apple.com/documentation/walletorders/building_a_distributable_order_package>
pub struct Manifest {
    /// All manifest files with SHA-256
    items: Vec<Item>,
}

impl Default for Manifest {
    fn default() -> Self {
        Self::new()
    }
}

impl Manifest {
    /// Create empty manifest
    #[must_use]
    pub fn new() -> Self {
        Self { items: Vec::new() }
    }

    /// Add items & calculate SHA-1
    pub fn add_item(&mut self, path: &str, data: &[u8]) {
        let checksum = Sha1::digest(data);
        let item = Item {
            path: path.to_string(),
            checksum: format!("{checksum:#x}"),
        };
        self.items.push(item);
    }

    /// Add multiple items & calculate SHA-1
    pub fn add_items(&mut self, items: &[(&str, &[u8])]) {
        for (path, data) in items {
            self.add_item(path, data);
        }
    }

    /// Build JSON output for manifest (manifest.json)
    /// # Errors
    /// Returns a `serde_json` error if building the json fails
    pub fn make_json(&self) -> Result<String, serde_json::Error> {
        serde_json::to_string(&self)
    }

    /// Remove all items from Manifest
    pub fn clear(&mut self) {
        self.items.clear();
    }
}

/// Manifest item
struct Item {
    /// Path of zip file
    path: String,

    /// SHA-256 hash
    checksum: String,
}

impl Serialize for Manifest {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        let mut map = serializer.serialize_map(Some(self.items.len()))?;
        for item in &self.items {
            map.serialize_entry(&item.path, &item.checksum)?;
        }
        map.end()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn make_manifest() {
        let example_data = "hello world".as_bytes();
        let path = "pass.json";

        let mut manifest = Manifest::new();
        manifest.add_item(path, example_data);

        let json = manifest.make_json().unwrap();
        let json_expected = r#"{"pass.json":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"}"#;

        assert_eq!(json_expected, json);
    }

    #[test]
    fn make_manifest_multiple_items() {
        let items = vec![
            ("pass.json", "hello world".as_bytes()),
            ("logo.png", "PNG DATA 1".as_bytes()),
            ("background.png", "PNG DATA 2".as_bytes()),
        ];

        let mut manifest = Manifest::new();
        manifest.add_items(&items);

        let json = manifest.make_json().unwrap();
        let json_expected = r#"{"pass.json":"2aae6c35c94fcfb415dbe95f408b9ce91ee846ed","logo.png":"e2507820ce1bd6d09669504e6a5536f7a3ccc94b","background.png":"05cc11980f5826d11c5c1292a4cd04ad11ddbf45"}"#;

        assert_eq!(json_expected, json);
    }
}