1 use anyhow
::{bail, format_err, Error}
;
2 use std
::convert
::TryFrom
;
5 use serde_json
::{json, Value}
;
6 use ::serde
::{Deserialize, Serialize}
;
8 use crate::backup
::{BackupDir, CryptMode, CryptConfig}
;
10 pub const MANIFEST_BLOB_NAME
: &str = "index.json.blob";
11 pub const CLIENT_LOG_BLOB_NAME
: &str = "client.log.blob";
14 use serde
::{self, Deserialize, Serializer, Deserializer}
;
19 ) -> Result
<S
::Ok
, S
::Error
>
23 let s
= proxmox
::tools
::digest_to_hex(csum
);
24 serializer
.serialize_str(&s
)
27 pub fn deserialize
<'de
, D
>(
29 ) -> Result
<[u8; 32], D
::Error
>
33 let s
= String
::deserialize(deserializer
)?
;
34 proxmox
::tools
::hex_to_digest(&s
).map_err(serde
::de
::Error
::custom
)
38 fn crypt_mode_none() -> CryptMode { CryptMode::None }
39 fn empty_value() -> Value { json!({}
) }
41 #[derive(Serialize, Deserialize)]
42 #[serde(rename_all="kebab-case")]
45 #[serde(default="crypt_mode_none")] // to be compatible with < 0.8.0 backups
46 pub crypt_mode
: CryptMode
,
48 #[serde(with = "hex_csum")]
52 #[derive(Serialize, Deserialize)]
53 #[serde(rename_all="kebab-case")]
54 pub struct BackupManifest
{
59 #[serde(default="empty_value")] // to be compatible with < 0.8.0 backups
60 pub unprotected
: Value
,
64 pub enum ArchiveType
{
70 pub fn archive_type
<P
: AsRef
<Path
>>(
72 ) -> Result
<ArchiveType
, Error
> {
74 let archive_name
= archive_name
.as_ref();
75 let archive_type
= match archive_name
.extension().and_then(|ext
| ext
.to_str()) {
76 Some("didx") => ArchiveType
::DynamicIndex
,
77 Some("fidx") => ArchiveType
::FixedIndex
,
78 Some("blob") => ArchiveType
::Blob
,
79 _
=> bail
!("unknown archive type: {:?}", archive_name
),
87 pub fn new(snapshot
: BackupDir
) -> Self {
89 backup_type
: snapshot
.group().backup_type().into(),
90 backup_id
: snapshot
.group().backup_id().into(),
91 backup_time
: snapshot
.backup_time().timestamp(),
93 unprotected
: json
!({}
),
97 pub fn add_file(&mut self, filename
: String
, size
: u64, csum
: [u8; 32], crypt_mode
: CryptMode
) -> Result
<(), Error
> {
98 let _archive_type
= archive_type(&filename
)?
; // check type
99 self.files
.push(FileInfo { filename, size, csum, crypt_mode }
);
103 pub fn files(&self) -> &[FileInfo
] {
107 fn lookup_file_info(&self, name
: &str) -> Result
<&FileInfo
, Error
> {
109 let info
= self.files
.iter().find(|item
| item
.filename
== name
);
112 None
=> bail
!("manifest does not contain file '{}'", name
),
113 Some(info
) => Ok(info
),
117 pub fn verify_file(&self, name
: &str, csum
: &[u8; 32], size
: u64) -> Result
<(), Error
> {
119 let info
= self.lookup_file_info(name
)?
;
121 if size
!= info
.size
{
122 bail
!("wrong size for file '{}' ({} != {})", name
, info
.size
, size
);
125 if csum
!= &info
.csum
{
126 bail
!("wrong checksum for file '{}'", name
);
132 // Generate cannonical json
133 fn to_canonical_json(value
: &Value
) -> Result
<Vec
<u8>, Error
> {
134 let mut data
= Vec
::new();
135 Self::write_canonical_json(value
, &mut data
)?
;
139 fn write_canonical_json(value
: &Value
, output
: &mut Vec
<u8>) -> Result
<(), Error
> {
141 Value
::Null
=> bail
!("got unexpected null value"),
142 Value
::String(_
) | Value
::Number(_
) | Value
::Bool(_
) => {
143 serde_json
::to_writer(output
, &value
)?
;
145 Value
::Array(list
) => {
147 let mut iter
= list
.iter();
148 if let Some(item
) = iter
.next() {
149 Self::write_canonical_json(item
, output
)?
;
152 Self::write_canonical_json(item
, output
)?
;
157 Value
::Object(map
) => {
159 let mut keys
: Vec
<&str> = map
.keys().map(String
::as_str
).collect();
161 let mut iter
= keys
.into_iter();
162 if let Some(key
) = iter
.next() {
163 output
.extend(key
.as_bytes());
165 Self::write_canonical_json(&map
[key
], output
)?
;
168 output
.extend(key
.as_bytes());
170 Self::write_canonical_json(&map
[key
], output
)?
;
179 /// Compute manifest signature
181 /// By generating a HMAC SHA256 over the canonical json
182 /// representation, The 'unpreotected' property is excluded.
183 pub fn signature(&self, crypt_config
: &CryptConfig
) -> Result
<[u8; 32], Error
> {
184 Self::json_signature(&serde_json
::to_value(&self)?
, crypt_config
)
187 fn json_signature(data
: &Value
, crypt_config
: &CryptConfig
) -> Result
<[u8; 32], Error
> {
189 let mut signed_data
= data
.clone();
191 signed_data
.as_object_mut().unwrap().remove("unprotected"); // exclude
192 signed_data
.as_object_mut().unwrap().remove("signature"); // exclude
194 let canonical
= Self::to_canonical_json(&signed_data
)?
;
196 let sig
= crypt_config
.compute_auth_tag(&canonical
);
201 /// Converts the Manifest into json string, and add a signature if there is a crypt_config.
202 pub fn to_string(&self, crypt_config
: Option
<&CryptConfig
>) -> Result
<String
, Error
> {
204 let mut manifest
= serde_json
::to_value(&self)?
;
206 if let Some(crypt_config
) = crypt_config
{
207 let sig
= self.signature(crypt_config
)?
;
208 manifest
["signature"] = proxmox
::tools
::digest_to_hex(&sig
).into();
211 let manifest
= serde_json
::to_string_pretty(&manifest
).unwrap().into();
215 /// Try to read the manifest. This verifies the signature if there is a crypt_config.
216 pub fn from_data(data
: &[u8], crypt_config
: Option
<&CryptConfig
>) -> Result
<BackupManifest
, Error
> {
217 let json
: Value
= serde_json
::from_slice(data
)?
;
218 let signature
= json
["signature"].as_str().map(String
::from
);
220 if let Some(ref crypt_config
) = crypt_config
{
221 if let Some(signature
) = signature
{
222 let expected_signature
= proxmox
::tools
::digest_to_hex(&Self::json_signature(&json
, crypt_config
)?
);
223 if signature
!= expected_signature
{
224 bail
!("wrong signature in manifest");
227 // not signed: warn/fail?
231 let manifest
: BackupManifest
= serde_json
::from_value(json
)?
;
237 impl TryFrom
<super::DataBlob
> for BackupManifest
{
240 fn try_from(blob
: super::DataBlob
) -> Result
<Self, Error
> {
241 let data
= blob
.decode(None
)
242 .map_err(|err
| format_err
!("decode backup manifest blob failed - {}", err
))?
;
243 let json
: Value
= serde_json
::from_slice(&data
[..])
244 .map_err(|err
| format_err
!("unable to parse backup manifest json - {}", err
))?
;
245 let manifest
: BackupManifest
= serde_json
::from_value(json
)?
;
252 fn test_manifest_signature() -> Result
<(), Error
> {
254 use crate::backup
::{KeyDerivationConfig}
;
258 let kdf
= KeyDerivationConfig
::Scrypt
{
265 let testkey
= kdf
.derive_key(pw
)?
;
267 let crypt_config
= CryptConfig
::new(testkey
)?
;
269 let snapshot
: BackupDir
= "host/elsa/2020-06-26T13:56:05Z".parse()?
;
271 let mut manifest
= BackupManifest
::new(snapshot
);
273 manifest
.add_file("test1.img.fidx".into(), 200, [1u8; 32], CryptMode
::Encrypt
)?
;
274 manifest
.add_file("abc.blob".into(), 200, [2u8; 32], CryptMode
::None
)?
;
276 manifest
.unprotected
["note"] = "This is not protected by the signature.".into();
278 let text
= manifest
.to_string(Some(&crypt_config
))?
;
280 let manifest
: Value
= serde_json
::from_str(&text
)?
;
281 let signature
= manifest
["signature"].as_str().unwrap().to_string();
283 assert_eq
!(signature
, "d7b446fb7db081662081d4b40fedd858a1d6307a5aff4ecff7d5bf4fd35679e9");
285 let manifest
: BackupManifest
= serde_json
::from_value(manifest
)?
;
286 let expected_signature
= proxmox
::tools
::digest_to_hex(&manifest
.signature(&crypt_config
)?
);
288 assert_eq
!(signature
, expected_signature
);