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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
//! This module includes all that is needed for the (de)serialization of Mullvad version metadata.
//! This includes ensuring authenticity and integrity of version metadata, and rejecting expired
//! metadata. There are also tools for producing new versions.
//!
//! Fundamentally, a version object is a JSON object with a `signed` key and a `signature` key.
//! `signature` contains a public key and an ed25519 signature of `signed` in canonical JSON form.
//! `signed` also contains an `expires` field, which is a timestamp indicating when the object
//! expires.
//!
//! For the deserializer to succeed in deserializing a file, it must verify that the canonicalized
//! form of `signed` is in fact signed by key/signature in `signature`. It also reads the `expires`
//! and rejects the file if it has expired.
use std::fmt::Display;
use serde::{Deserialize, Serialize};
use crate::version::{FULLY_ROLLED_OUT, Rollout};
pub mod deserializer;
pub mod key;
#[cfg(feature = "sign")]
pub mod serializer;
/// JSON response including signature and signed content
/// This type does not implement [serde::Deserialize] to prevent accidental deserialization without
/// signature verification.
#[derive(Debug, Serialize)]
#[cfg_attr(test, derive(PartialEq))]
pub struct SignedResponse {
/// Signatures of the canonicalized JSON of `signed`
pub signatures: Vec<ResponseSignature>,
/// Content signed by `signature`
pub signed: Response,
}
impl SignedResponse {
pub fn get_releases(self) -> Vec<Release> {
self.signed.releases
}
}
/// Helper type that leaves the signed data untouched
/// Note that deserializing doesn't verify anything
#[derive(Deserialize, Serialize)]
#[cfg_attr(test, derive(Debug, PartialEq))]
struct PartialSignedResponse {
/// Signatures of the canonicalized JSON of `signed`
pub signatures: Vec<ResponseSignature>,
/// Content signed by `signature`
pub signed: serde_json::Value,
}
/// Signed JSON response, not including the signature
#[derive(Default, Debug, Deserialize, Serialize, Clone)]
#[serde(deny_unknown_fields)]
#[cfg_attr(test, derive(PartialEq))]
pub struct Response {
/// Version counter
pub metadata_version: usize,
/// When the signature expires
pub metadata_expiry: chrono::DateTime<chrono::Utc>,
/// Available app releases
pub releases: Vec<Release>,
}
/// App release
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct Release {
/// Mullvad app version
pub version: mullvad_version::Version,
/// Changelog entries
pub changelog: String,
/// Installer details for different architectures
pub installers: Vec<Installer>,
/// Fraction of users that should receive the new version
#[serde(default = "complete_rollout")]
#[serde(skip_serializing_if = "is_complete_rollout")]
pub rollout: Rollout,
}
impl PartialEq for Release {
fn eq(&self, other: &Self) -> bool {
self.version.eq(&other.version)
}
}
impl PartialOrd for Release {
fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
self.version.partial_cmp(&other.version)
}
}
/// A full rollout includes all users
fn complete_rollout() -> Rollout {
FULLY_ROLLED_OUT
}
fn is_complete_rollout(b: impl std::borrow::Borrow<Rollout>) -> bool {
// TODO: do we actually need this? if so, should we bake it into Rollout::eq?
//(b.borrow() - complete_rollout()).abs() < f32::EPSILON
b.borrow() == &FULLY_ROLLED_OUT
}
/// App installer
#[derive(Debug, Deserialize, Serialize, Clone)]
#[cfg_attr(test, derive(PartialEq))]
pub struct Installer {
/// Installer architecture
pub architecture: Architecture,
/// Mirrors that host the artifact
pub urls: Vec<String>,
/// Size of the installer, in bytes
pub size: usize,
/// Hash of the installer, hexadecimal string
pub sha256: String,
}
/// Installer architecture
#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "lowercase")]
#[cfg_attr(feature = "strum", derive(strum::EnumIter))]
pub enum Architecture {
/// x86-64 architecture
X86,
/// ARM64 architecture
Arm64,
}
impl Display for Architecture {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Architecture::X86 => f.write_str("x86"),
Architecture::Arm64 => f.write_str("arm64"),
}
}
}
/// JSON response signature
#[derive(Debug, Deserialize, Serialize)]
#[cfg_attr(test, derive(PartialEq))]
#[serde(tag = "keytype")]
#[serde(rename_all = "lowercase")]
pub enum ResponseSignature {
Ed25519 {
keyid: key::VerifyingKey,
sig: key::Signature,
},
#[serde(untagged)]
Other { keyid: String, sig: String },
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_default_rollout_serialize() {
// rollout should not be serialized if equal to default value
let serialized = serde_json::to_value(Release {
version: "2024.1".parse().unwrap(),
changelog: "".to_owned(),
installers: vec![],
rollout: complete_rollout(),
})
.unwrap();
assert_eq!(
serialized,
serde_json::json!({
"version": "2024.1",
"changelog": "",
"installers": [],
})
);
// rollout *should* be serialized if not equal to default value
let rollout = Rollout::try_from(0.99).unwrap();
let serialized = serde_json::to_value(Release {
version: "2024.1".parse().unwrap(),
changelog: "".to_owned(),
installers: vec![],
rollout,
})
.unwrap();
assert_eq!(
serialized,
serde_json::json!({
"version": "2024.1",
"changelog": "",
"installers": [],
"rollout": rollout,
})
);
}
}
|
