]>
Commit | Line | Data |
---|---|---|
ff5d3707 | 1 | use failure::*; |
70235f72 CE |
2 | use nix::unistd::{fork, ForkResult, pipe}; |
3 | use std::os::unix::io::RawFd; | |
fa5d6977 | 4 | use chrono::{Local, Utc, TimeZone}; |
e9c9409a | 5 | use std::path::{Path, PathBuf}; |
2eeaacb9 | 6 | use std::collections::{HashSet, HashMap}; |
70235f72 | 7 | use std::ffi::OsStr; |
bb19af73 | 8 | use std::io::{Write, Seek, SeekFrom}; |
2761d6a4 DM |
9 | use std::os::unix::fs::OpenOptionsExt; |
10 | ||
552c2259 | 11 | use proxmox::{sortable, identity}; |
e18a6c9e | 12 | use proxmox::tools::fs::{file_get_contents, file_get_json, file_set_contents, image_size}; |
3d482025 WB |
13 | use proxmox::api::{ApiHandler, ApiMethod, RpcEnvironment}; |
14 | use proxmox::api::schema::*; | |
7eea56ca | 15 | use proxmox::api::cli::*; |
5830c205 | 16 | use proxmox::api::api; |
ff5d3707 | 17 | |
fe0e04c6 | 18 | use proxmox_backup::tools; |
bbf9e7e9 | 19 | use proxmox_backup::api2::types::*; |
151c6ce2 | 20 | use proxmox_backup::client::*; |
247cdbce | 21 | use proxmox_backup::backup::*; |
7926a3a1 | 22 | use proxmox_backup::pxar::{ self, catalog::* }; |
86eda3eb | 23 | |
fe0e04c6 DM |
24 | //use proxmox_backup::backup::image_index::*; |
25 | //use proxmox_backup::config::datastore; | |
8968258b | 26 | //use proxmox_backup::pxar::encoder::*; |
728797d0 | 27 | //use proxmox_backup::backup::datastore::*; |
23bb8780 | 28 | |
f5f13ebc | 29 | use serde_json::{json, Value}; |
1c0472e8 | 30 | //use hyper::Body; |
2761d6a4 | 31 | use std::sync::{Arc, Mutex}; |
255f378a | 32 | //use regex::Regex; |
d0a03d40 | 33 | use xdg::BaseDirectories; |
ae0be2dd | 34 | |
5a2df000 | 35 | use futures::*; |
c4ff3dce | 36 | use tokio::sync::mpsc; |
ae0be2dd | 37 | |
3d482025 | 38 | proxmox::api::const_regex! { |
255f378a | 39 | BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$"; |
ae0be2dd | 40 | } |
33d64b81 | 41 | |
255f378a DM |
42 | const REPO_URL_SCHEMA: Schema = StringSchema::new("Repository URL.") |
43 | .format(&BACKUP_REPO_URL) | |
44 | .max_length(256) | |
45 | .schema(); | |
d0a03d40 | 46 | |
2665cef7 DM |
47 | fn get_default_repository() -> Option<String> { |
48 | std::env::var("PBS_REPOSITORY").ok() | |
49 | } | |
50 | ||
51 | fn extract_repository_from_value( | |
52 | param: &Value, | |
53 | ) -> Result<BackupRepository, Error> { | |
54 | ||
55 | let repo_url = param["repository"] | |
56 | .as_str() | |
57 | .map(String::from) | |
58 | .or_else(get_default_repository) | |
59 | .ok_or_else(|| format_err!("unable to get (default) repository"))?; | |
60 | ||
61 | let repo: BackupRepository = repo_url.parse()?; | |
62 | ||
63 | Ok(repo) | |
64 | } | |
65 | ||
66 | fn extract_repository_from_map( | |
67 | param: &HashMap<String, String>, | |
68 | ) -> Option<BackupRepository> { | |
69 | ||
70 | param.get("repository") | |
71 | .map(String::from) | |
72 | .or_else(get_default_repository) | |
73 | .and_then(|repo_url| repo_url.parse::<BackupRepository>().ok()) | |
74 | } | |
75 | ||
d0a03d40 DM |
76 | fn record_repository(repo: &BackupRepository) { |
77 | ||
78 | let base = match BaseDirectories::with_prefix("proxmox-backup") { | |
79 | Ok(v) => v, | |
80 | _ => return, | |
81 | }; | |
82 | ||
83 | // usually $HOME/.cache/proxmox-backup/repo-list | |
84 | let path = match base.place_cache_file("repo-list") { | |
85 | Ok(v) => v, | |
86 | _ => return, | |
87 | }; | |
88 | ||
11377a47 | 89 | let mut data = file_get_json(&path, None).unwrap_or_else(|_| json!({})); |
d0a03d40 DM |
90 | |
91 | let repo = repo.to_string(); | |
92 | ||
93 | data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 }; | |
94 | ||
95 | let mut map = serde_json::map::Map::new(); | |
96 | ||
97 | loop { | |
98 | let mut max_used = 0; | |
99 | let mut max_repo = None; | |
100 | for (repo, count) in data.as_object().unwrap() { | |
101 | if map.contains_key(repo) { continue; } | |
102 | if let Some(count) = count.as_i64() { | |
103 | if count > max_used { | |
104 | max_used = count; | |
105 | max_repo = Some(repo); | |
106 | } | |
107 | } | |
108 | } | |
109 | if let Some(repo) = max_repo { | |
110 | map.insert(repo.to_owned(), json!(max_used)); | |
111 | } else { | |
112 | break; | |
113 | } | |
114 | if map.len() > 10 { // store max. 10 repos | |
115 | break; | |
116 | } | |
117 | } | |
118 | ||
119 | let new_data = json!(map); | |
120 | ||
e18a6c9e | 121 | let _ = file_set_contents(path, new_data.to_string().as_bytes(), None); |
d0a03d40 DM |
122 | } |
123 | ||
49811347 | 124 | fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> { |
d0a03d40 DM |
125 | |
126 | let mut result = vec![]; | |
127 | ||
128 | let base = match BaseDirectories::with_prefix("proxmox-backup") { | |
129 | Ok(v) => v, | |
130 | _ => return result, | |
131 | }; | |
132 | ||
133 | // usually $HOME/.cache/proxmox-backup/repo-list | |
134 | let path = match base.place_cache_file("repo-list") { | |
135 | Ok(v) => v, | |
136 | _ => return result, | |
137 | }; | |
138 | ||
11377a47 | 139 | let data = file_get_json(&path, None).unwrap_or_else(|_| json!({})); |
d0a03d40 DM |
140 | |
141 | if let Some(map) = data.as_object() { | |
49811347 | 142 | for (repo, _count) in map { |
d0a03d40 DM |
143 | result.push(repo.to_owned()); |
144 | } | |
145 | } | |
146 | ||
147 | result | |
148 | } | |
149 | ||
d105176f DM |
150 | async fn view_task_result( |
151 | client: HttpClient, | |
152 | result: Value, | |
153 | output_format: &str, | |
154 | ) -> Result<(), Error> { | |
155 | let data = &result["data"]; | |
156 | if output_format == "text" { | |
157 | if let Some(upid) = data.as_str() { | |
158 | display_task_log(client, upid, true).await?; | |
159 | } | |
160 | } else { | |
161 | format_and_print_result(&data, &output_format); | |
162 | } | |
163 | ||
164 | Ok(()) | |
165 | } | |
166 | ||
e9722f8b | 167 | async fn backup_directory<P: AsRef<Path>>( |
cf9271e2 | 168 | client: &BackupWriter, |
17d6979a | 169 | dir_path: P, |
247cdbce | 170 | archive_name: &str, |
36898ffc | 171 | chunk_size: Option<usize>, |
2eeaacb9 | 172 | device_set: Option<HashSet<u64>>, |
219ef0e6 | 173 | verbose: bool, |
5b72c9b4 | 174 | skip_lost_and_found: bool, |
f98ac774 | 175 | crypt_config: Option<Arc<CryptConfig>>, |
bf6e3217 | 176 | catalog: Arc<Mutex<CatalogWriter<SenderWriter>>>, |
2c3891d1 | 177 | ) -> Result<BackupStats, Error> { |
33d64b81 | 178 | |
2761d6a4 | 179 | let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), device_set, verbose, skip_lost_and_found, catalog)?; |
e9722f8b | 180 | let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size); |
ff3d3100 | 181 | |
e9722f8b | 182 | let (mut tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks |
5e7a09be | 183 | |
c4ff3dce | 184 | let stream = rx |
e9722f8b | 185 | .map_err(Error::from); |
17d6979a | 186 | |
c4ff3dce | 187 | // spawn chunker inside a separate task so that it can run parallel |
e9722f8b WB |
188 | tokio::spawn(async move { |
189 | let _ = tx.send_all(&mut chunk_stream).await; | |
190 | }); | |
17d6979a | 191 | |
e9722f8b WB |
192 | let stats = client |
193 | .upload_stream(archive_name, stream, "dynamic", None, crypt_config) | |
194 | .await?; | |
bcd879cf | 195 | |
2c3891d1 | 196 | Ok(stats) |
bcd879cf DM |
197 | } |
198 | ||
e9722f8b | 199 | async fn backup_image<P: AsRef<Path>>( |
cf9271e2 | 200 | client: &BackupWriter, |
6af905c1 DM |
201 | image_path: P, |
202 | archive_name: &str, | |
203 | image_size: u64, | |
36898ffc | 204 | chunk_size: Option<usize>, |
1c0472e8 | 205 | _verbose: bool, |
f98ac774 | 206 | crypt_config: Option<Arc<CryptConfig>>, |
2c3891d1 | 207 | ) -> Result<BackupStats, Error> { |
6af905c1 | 208 | |
6af905c1 DM |
209 | let path = image_path.as_ref().to_owned(); |
210 | ||
e9722f8b | 211 | let file = tokio::fs::File::open(path).await?; |
6af905c1 DM |
212 | |
213 | let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new()) | |
214 | .map_err(Error::from); | |
215 | ||
36898ffc | 216 | let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024)); |
6af905c1 | 217 | |
e9722f8b WB |
218 | let stats = client |
219 | .upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config) | |
220 | .await?; | |
6af905c1 | 221 | |
2c3891d1 | 222 | Ok(stats) |
6af905c1 DM |
223 | } |
224 | ||
52c171e4 DM |
225 | fn strip_server_file_expenstion(name: &str) -> String { |
226 | ||
11377a47 DM |
227 | if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") { |
228 | name[..name.len()-5].to_owned() | |
52c171e4 | 229 | } else { |
11377a47 | 230 | name.to_owned() // should not happen |
8e39232a | 231 | } |
8e39232a DM |
232 | } |
233 | ||
812c6f87 DM |
234 | fn list_backup_groups( |
235 | param: Value, | |
236 | _info: &ApiMethod, | |
dd5495d6 | 237 | _rpcenv: &mut dyn RpcEnvironment, |
812c6f87 DM |
238 | ) -> Result<Value, Error> { |
239 | ||
2665cef7 | 240 | let repo = extract_repository_from_value(¶m)?; |
812c6f87 | 241 | |
cc2ce4a9 | 242 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
812c6f87 | 243 | |
d0a03d40 | 244 | let path = format!("api2/json/admin/datastore/{}/groups", repo.store()); |
812c6f87 | 245 | |
e9722f8b WB |
246 | let mut result = async_main(async move { |
247 | client.get(&path, None).await | |
248 | })?; | |
812c6f87 | 249 | |
d0a03d40 DM |
250 | record_repository(&repo); |
251 | ||
812c6f87 | 252 | // fixme: implement and use output formatter instead .. |
80822b95 DM |
253 | let list = result["data"].as_array_mut().unwrap(); |
254 | ||
255 | list.sort_unstable_by(|a, b| { | |
256 | let a_id = a["backup-id"].as_str().unwrap(); | |
257 | let a_backup_type = a["backup-type"].as_str().unwrap(); | |
258 | let b_id = b["backup-id"].as_str().unwrap(); | |
259 | let b_backup_type = b["backup-type"].as_str().unwrap(); | |
260 | ||
261 | let type_order = a_backup_type.cmp(b_backup_type); | |
262 | if type_order == std::cmp::Ordering::Equal { | |
263 | a_id.cmp(b_id) | |
264 | } else { | |
265 | type_order | |
266 | } | |
267 | }); | |
812c6f87 | 268 | |
34a816cc DM |
269 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); |
270 | ||
271 | let mut result = vec![]; | |
272 | ||
812c6f87 DM |
273 | for item in list { |
274 | ||
ad20d198 DM |
275 | let id = item["backup-id"].as_str().unwrap(); |
276 | let btype = item["backup-type"].as_str().unwrap(); | |
277 | let epoch = item["last-backup"].as_i64().unwrap(); | |
fa5d6977 | 278 | let last_backup = Utc.timestamp(epoch, 0); |
ad20d198 | 279 | let backup_count = item["backup-count"].as_u64().unwrap(); |
812c6f87 | 280 | |
1e9a94e5 | 281 | let group = BackupGroup::new(btype, id); |
812c6f87 DM |
282 | |
283 | let path = group.group_path().to_str().unwrap().to_owned(); | |
ad20d198 | 284 | |
52c171e4 DM |
285 | let files = item["files"].as_array().unwrap().iter() |
286 | .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect(); | |
ad20d198 | 287 | |
34a816cc | 288 | if output_format == "text" { |
fa5d6977 DM |
289 | println!( |
290 | "{:20} | {} | {:5} | {}", | |
291 | path, | |
292 | BackupDir::backup_time_to_string(last_backup), | |
293 | backup_count, | |
294 | tools::join(&files, ' '), | |
295 | ); | |
34a816cc DM |
296 | } else { |
297 | result.push(json!({ | |
298 | "backup-type": btype, | |
299 | "backup-id": id, | |
300 | "last-backup": epoch, | |
301 | "backup-count": backup_count, | |
302 | "files": files, | |
303 | })); | |
304 | } | |
812c6f87 DM |
305 | } |
306 | ||
9aa3f682 | 307 | if output_format != "text" { format_and_print_result(&result.into(), &output_format); } |
34a816cc | 308 | |
812c6f87 DM |
309 | Ok(Value::Null) |
310 | } | |
311 | ||
184f17af DM |
312 | fn list_snapshots( |
313 | param: Value, | |
314 | _info: &ApiMethod, | |
dd5495d6 | 315 | _rpcenv: &mut dyn RpcEnvironment, |
184f17af DM |
316 | ) -> Result<Value, Error> { |
317 | ||
2665cef7 | 318 | let repo = extract_repository_from_value(¶m)?; |
184f17af | 319 | |
34a816cc DM |
320 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); |
321 | ||
cc2ce4a9 | 322 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
184f17af | 323 | |
9e391bb7 | 324 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); |
184f17af | 325 | |
15c847f1 DM |
326 | let mut args = json!({}); |
327 | if let Some(path) = param["group"].as_str() { | |
328 | let group = BackupGroup::parse(path)?; | |
329 | args["backup-type"] = group.backup_type().into(); | |
330 | args["backup-id"] = group.backup_id().into(); | |
331 | } | |
332 | ||
e9722f8b WB |
333 | let result = async_main(async move { |
334 | client.get(&path, Some(args)).await | |
335 | })?; | |
184f17af | 336 | |
d0a03d40 DM |
337 | record_repository(&repo); |
338 | ||
184f17af DM |
339 | let list = result["data"].as_array().unwrap(); |
340 | ||
34a816cc DM |
341 | let mut result = vec![]; |
342 | ||
184f17af DM |
343 | for item in list { |
344 | ||
345 | let id = item["backup-id"].as_str().unwrap(); | |
346 | let btype = item["backup-type"].as_str().unwrap(); | |
347 | let epoch = item["backup-time"].as_i64().unwrap(); | |
184f17af | 348 | |
391d3107 | 349 | let snapshot = BackupDir::new(btype, id, epoch); |
184f17af DM |
350 | |
351 | let path = snapshot.relative_path().to_str().unwrap().to_owned(); | |
352 | ||
52c171e4 DM |
353 | let files = item["files"].as_array().unwrap().iter() |
354 | .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect(); | |
184f17af | 355 | |
34a816cc | 356 | if output_format == "text" { |
a17a0e7a DM |
357 | let size_str = if let Some(size) = item["size"].as_u64() { |
358 | size.to_string() | |
359 | } else { | |
360 | String::from("-") | |
361 | }; | |
362 | println!("{} | {} | {}", path, size_str, tools::join(&files, ' ')); | |
34a816cc | 363 | } else { |
a17a0e7a | 364 | let mut data = json!({ |
34a816cc DM |
365 | "backup-type": btype, |
366 | "backup-id": id, | |
367 | "backup-time": epoch, | |
368 | "files": files, | |
a17a0e7a DM |
369 | }); |
370 | if let Some(size) = item["size"].as_u64() { | |
371 | data["size"] = size.into(); | |
372 | } | |
373 | result.push(data); | |
34a816cc | 374 | } |
184f17af DM |
375 | } |
376 | ||
f6ede796 | 377 | if output_format != "text" { format_and_print_result(&result.into(), &output_format); } |
34a816cc | 378 | |
184f17af DM |
379 | Ok(Value::Null) |
380 | } | |
381 | ||
6f62c924 DM |
382 | fn forget_snapshots( |
383 | param: Value, | |
384 | _info: &ApiMethod, | |
dd5495d6 | 385 | _rpcenv: &mut dyn RpcEnvironment, |
6f62c924 DM |
386 | ) -> Result<Value, Error> { |
387 | ||
2665cef7 | 388 | let repo = extract_repository_from_value(¶m)?; |
6f62c924 DM |
389 | |
390 | let path = tools::required_string_param(¶m, "snapshot")?; | |
391 | let snapshot = BackupDir::parse(path)?; | |
392 | ||
cc2ce4a9 | 393 | let mut client = HttpClient::new(repo.host(), repo.user(), None)?; |
6f62c924 | 394 | |
9e391bb7 | 395 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); |
6f62c924 | 396 | |
e9722f8b WB |
397 | let result = async_main(async move { |
398 | client.delete(&path, Some(json!({ | |
399 | "backup-type": snapshot.group().backup_type(), | |
400 | "backup-id": snapshot.group().backup_id(), | |
401 | "backup-time": snapshot.backup_time().timestamp(), | |
402 | }))).await | |
403 | })?; | |
6f62c924 | 404 | |
d0a03d40 DM |
405 | record_repository(&repo); |
406 | ||
6f62c924 DM |
407 | Ok(result) |
408 | } | |
409 | ||
e240d8be DM |
410 | fn api_login( |
411 | param: Value, | |
412 | _info: &ApiMethod, | |
413 | _rpcenv: &mut dyn RpcEnvironment, | |
414 | ) -> Result<Value, Error> { | |
415 | ||
416 | let repo = extract_repository_from_value(¶m)?; | |
417 | ||
cc2ce4a9 | 418 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
e9722f8b | 419 | async_main(async move { client.login().await })?; |
e240d8be DM |
420 | |
421 | record_repository(&repo); | |
422 | ||
423 | Ok(Value::Null) | |
424 | } | |
425 | ||
426 | fn api_logout( | |
427 | param: Value, | |
428 | _info: &ApiMethod, | |
429 | _rpcenv: &mut dyn RpcEnvironment, | |
430 | ) -> Result<Value, Error> { | |
431 | ||
432 | let repo = extract_repository_from_value(¶m)?; | |
433 | ||
434 | delete_ticket_info(repo.host(), repo.user())?; | |
435 | ||
436 | Ok(Value::Null) | |
437 | } | |
438 | ||
9049a8cf DM |
439 | fn dump_catalog( |
440 | param: Value, | |
441 | _info: &ApiMethod, | |
442 | _rpcenv: &mut dyn RpcEnvironment, | |
443 | ) -> Result<Value, Error> { | |
444 | ||
445 | let repo = extract_repository_from_value(¶m)?; | |
446 | ||
447 | let path = tools::required_string_param(¶m, "snapshot")?; | |
448 | let snapshot = BackupDir::parse(path)?; | |
449 | ||
11377a47 | 450 | let keyfile = param["keyfile"].as_str().map(PathBuf::from); |
9049a8cf DM |
451 | |
452 | let crypt_config = match keyfile { | |
453 | None => None, | |
454 | Some(path) => { | |
a8f10f84 | 455 | let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
9025312a | 456 | Some(Arc::new(CryptConfig::new(key)?)) |
9049a8cf DM |
457 | } |
458 | }; | |
459 | ||
cc2ce4a9 | 460 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
9049a8cf | 461 | |
e9722f8b | 462 | async_main(async move { |
9e490a74 DM |
463 | let client = BackupReader::start( |
464 | client, | |
296c50ba | 465 | crypt_config.clone(), |
e9722f8b WB |
466 | repo.store(), |
467 | &snapshot.group().backup_type(), | |
468 | &snapshot.group().backup_id(), | |
9e490a74 DM |
469 | snapshot.backup_time(), |
470 | true, | |
471 | ).await?; | |
9049a8cf | 472 | |
f06b820a | 473 | let manifest = client.download_manifest().await?; |
d2267b11 | 474 | |
c3d84a22 | 475 | let index = client.download_dynamic_index(&manifest, CATALOG_NAME).await?; |
bf6e3217 DM |
476 | |
477 | let most_used = index.find_most_used_chunks(8); | |
478 | ||
479 | let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used); | |
480 | ||
481 | let mut reader = BufferedDynamicReader::new(index, chunk_reader); | |
482 | ||
483 | let mut catalogfile = std::fs::OpenOptions::new() | |
e9722f8b | 484 | .write(true) |
bf6e3217 | 485 | .read(true) |
e9722f8b WB |
486 | .custom_flags(libc::O_TMPFILE) |
487 | .open("/tmp")?; | |
9049a8cf | 488 | |
bf6e3217 DM |
489 | std::io::copy(&mut reader, &mut catalogfile) |
490 | .map_err(|err| format_err!("unable to download catalog - {}", err))?; | |
d2267b11 | 491 | |
bf6e3217 | 492 | catalogfile.seek(SeekFrom::Start(0))?; |
a84ef4c2 | 493 | |
bf6e3217 | 494 | let mut catalog_reader = CatalogReader::new(catalogfile); |
9049a8cf | 495 | |
e9722f8b | 496 | catalog_reader.dump()?; |
9049a8cf | 497 | |
e9722f8b WB |
498 | record_repository(&repo); |
499 | ||
500 | Ok::<(), Error>(()) | |
501 | })?; | |
9049a8cf DM |
502 | |
503 | Ok(Value::Null) | |
504 | } | |
505 | ||
52c171e4 DM |
506 | fn list_snapshot_files( |
507 | param: Value, | |
508 | _info: &ApiMethod, | |
509 | _rpcenv: &mut dyn RpcEnvironment, | |
510 | ) -> Result<Value, Error> { | |
511 | ||
512 | let repo = extract_repository_from_value(¶m)?; | |
513 | ||
514 | let path = tools::required_string_param(¶m, "snapshot")?; | |
515 | let snapshot = BackupDir::parse(path)?; | |
516 | ||
517 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); | |
518 | ||
cc2ce4a9 | 519 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
52c171e4 DM |
520 | |
521 | let path = format!("api2/json/admin/datastore/{}/files", repo.store()); | |
522 | ||
e9722f8b WB |
523 | let mut result = async_main(async move { |
524 | client.get(&path, Some(json!({ | |
525 | "backup-type": snapshot.group().backup_type(), | |
526 | "backup-id": snapshot.group().backup_id(), | |
527 | "backup-time": snapshot.backup_time().timestamp(), | |
528 | }))).await | |
529 | })?; | |
52c171e4 DM |
530 | |
531 | record_repository(&repo); | |
532 | ||
8c70e3eb | 533 | let list: Value = result["data"].take(); |
52c171e4 DM |
534 | |
535 | if output_format == "text" { | |
8c70e3eb DM |
536 | for item in list.as_array().unwrap().iter() { |
537 | println!( | |
538 | "{} {}", | |
539 | strip_server_file_expenstion(item["filename"].as_str().unwrap()), | |
540 | item["size"].as_u64().unwrap_or(0), | |
541 | ); | |
52c171e4 DM |
542 | } |
543 | } else { | |
8c70e3eb | 544 | format_and_print_result(&list, &output_format); |
52c171e4 DM |
545 | } |
546 | ||
547 | Ok(Value::Null) | |
548 | } | |
549 | ||
8cc0d6af DM |
550 | fn start_garbage_collection( |
551 | param: Value, | |
552 | _info: &ApiMethod, | |
dd5495d6 | 553 | _rpcenv: &mut dyn RpcEnvironment, |
8cc0d6af DM |
554 | ) -> Result<Value, Error> { |
555 | ||
2665cef7 | 556 | let repo = extract_repository_from_value(¶m)?; |
e5f7def4 | 557 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); |
8cc0d6af | 558 | |
cc2ce4a9 | 559 | let mut client = HttpClient::new(repo.host(), repo.user(), None)?; |
8cc0d6af | 560 | |
d0a03d40 | 561 | let path = format!("api2/json/admin/datastore/{}/gc", repo.store()); |
8cc0d6af | 562 | |
e5f7def4 DM |
563 | async_main(async { |
564 | let result = client.post(&path, None).await?; | |
8cc0d6af | 565 | |
e5f7def4 | 566 | record_repository(&repo); |
d0a03d40 | 567 | |
d105176f | 568 | view_task_result(client, result, &output_format).await |
e5f7def4 DM |
569 | })?; |
570 | ||
e5f7def4 | 571 | Ok(Value::Null) |
8cc0d6af | 572 | } |
33d64b81 | 573 | |
ae0be2dd DM |
574 | fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> { |
575 | ||
255f378a | 576 | if let Some(caps) = (BACKUPSPEC_REGEX.regex_obj)().captures(value) { |
ae0be2dd DM |
577 | return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str())); |
578 | } | |
579 | bail!("unable to parse directory specification '{}'", value); | |
580 | } | |
581 | ||
bf6e3217 DM |
582 | fn spawn_catalog_upload( |
583 | client: Arc<BackupWriter>, | |
584 | crypt_config: Option<Arc<CryptConfig>>, | |
585 | ) -> Result< | |
586 | ( | |
587 | Arc<Mutex<CatalogWriter<SenderWriter>>>, | |
588 | tokio::sync::oneshot::Receiver<Result<BackupStats, Error>> | |
589 | ), Error> | |
590 | { | |
591 | let (catalog_tx, catalog_rx) = mpsc::channel(10); // allow to buffer 10 writes | |
592 | let catalog_stream = catalog_rx.map_err(Error::from); | |
593 | let catalog_chunk_size = 512*1024; | |
594 | let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size)); | |
595 | ||
596 | let catalog = Arc::new(Mutex::new(CatalogWriter::new(SenderWriter::new(catalog_tx))?)); | |
597 | ||
598 | let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel(); | |
599 | ||
600 | tokio::spawn(async move { | |
601 | let catalog_upload_result = client | |
602 | .upload_stream(CATALOG_NAME, catalog_chunk_stream, "dynamic", None, crypt_config) | |
603 | .await; | |
604 | ||
605 | if let Err(ref err) = catalog_upload_result { | |
606 | eprintln!("catalog upload error - {}", err); | |
607 | client.cancel(); | |
608 | } | |
609 | ||
610 | let _ = catalog_result_tx.send(catalog_upload_result); | |
611 | }); | |
612 | ||
613 | Ok((catalog, catalog_result_rx)) | |
614 | } | |
615 | ||
6049b71f DM |
616 | fn create_backup( |
617 | param: Value, | |
618 | _info: &ApiMethod, | |
dd5495d6 | 619 | _rpcenv: &mut dyn RpcEnvironment, |
6049b71f | 620 | ) -> Result<Value, Error> { |
ff5d3707 | 621 | |
2665cef7 | 622 | let repo = extract_repository_from_value(¶m)?; |
ae0be2dd DM |
623 | |
624 | let backupspec_list = tools::required_array_param(¶m, "backupspec")?; | |
a914a774 | 625 | |
eed6db39 DM |
626 | let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false); |
627 | ||
5b72c9b4 DM |
628 | let skip_lost_and_found = param["skip-lost-and-found"].as_bool().unwrap_or(false); |
629 | ||
219ef0e6 DM |
630 | let verbose = param["verbose"].as_bool().unwrap_or(false); |
631 | ||
ca5d0b61 DM |
632 | let backup_time_opt = param["backup-time"].as_i64(); |
633 | ||
36898ffc | 634 | let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize); |
2d9d143a | 635 | |
247cdbce DM |
636 | if let Some(size) = chunk_size_opt { |
637 | verify_chunk_size(size)?; | |
2d9d143a DM |
638 | } |
639 | ||
11377a47 | 640 | let keyfile = param["keyfile"].as_str().map(PathBuf::from); |
6d0983db | 641 | |
f69adc81 | 642 | let backup_id = param["backup-id"].as_str().unwrap_or(&proxmox::tools::nodename()); |
fba30411 | 643 | |
bbf9e7e9 | 644 | let backup_type = param["backup-type"].as_str().unwrap_or("host"); |
ca5d0b61 | 645 | |
2eeaacb9 DM |
646 | let include_dev = param["include-dev"].as_array(); |
647 | ||
648 | let mut devices = if all_file_systems { None } else { Some(HashSet::new()) }; | |
649 | ||
650 | if let Some(include_dev) = include_dev { | |
651 | if all_file_systems { | |
652 | bail!("option 'all-file-systems' conflicts with option 'include-dev'"); | |
653 | } | |
654 | ||
655 | let mut set = HashSet::new(); | |
656 | for path in include_dev { | |
657 | let path = path.as_str().unwrap(); | |
658 | let stat = nix::sys::stat::stat(path) | |
659 | .map_err(|err| format_err!("fstat {:?} failed - {}", path, err))?; | |
660 | set.insert(stat.st_dev); | |
661 | } | |
662 | devices = Some(set); | |
663 | } | |
664 | ||
ae0be2dd | 665 | let mut upload_list = vec![]; |
a914a774 | 666 | |
79679c2d | 667 | enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE }; |
6af905c1 | 668 | |
bf6e3217 DM |
669 | let mut upload_catalog = false; |
670 | ||
ae0be2dd DM |
671 | for backupspec in backupspec_list { |
672 | let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?; | |
bcd879cf | 673 | |
eb1804c5 DM |
674 | use std::os::unix::fs::FileTypeExt; |
675 | ||
3fa71727 CE |
676 | let metadata = std::fs::metadata(filename) |
677 | .map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?; | |
eb1804c5 | 678 | let file_type = metadata.file_type(); |
23bb8780 | 679 | |
4af0ee05 | 680 | let extension = target.rsplit('.').next() |
11377a47 | 681 | .ok_or_else(|| format_err!("missing target file extenion '{}'", target))?; |
bcd879cf | 682 | |
ec8a9bb9 DM |
683 | match extension { |
684 | "pxar" => { | |
685 | if !file_type.is_dir() { | |
686 | bail!("got unexpected file type (expected directory)"); | |
687 | } | |
4af0ee05 | 688 | upload_list.push((BackupType::PXAR, filename.to_owned(), format!("{}.didx", target), 0)); |
bf6e3217 | 689 | upload_catalog = true; |
ec8a9bb9 DM |
690 | } |
691 | "img" => { | |
eb1804c5 | 692 | |
ec8a9bb9 DM |
693 | if !(file_type.is_file() || file_type.is_block_device()) { |
694 | bail!("got unexpected file type (expected file or block device)"); | |
695 | } | |
eb1804c5 | 696 | |
e18a6c9e | 697 | let size = image_size(&PathBuf::from(filename))?; |
23bb8780 | 698 | |
ec8a9bb9 | 699 | if size == 0 { bail!("got zero-sized file '{}'", filename); } |
ae0be2dd | 700 | |
4af0ee05 | 701 | upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size)); |
ec8a9bb9 DM |
702 | } |
703 | "conf" => { | |
704 | if !file_type.is_file() { | |
705 | bail!("got unexpected file type (expected regular file)"); | |
706 | } | |
4af0ee05 | 707 | upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len())); |
ec8a9bb9 | 708 | } |
79679c2d DM |
709 | "log" => { |
710 | if !file_type.is_file() { | |
711 | bail!("got unexpected file type (expected regular file)"); | |
712 | } | |
4af0ee05 | 713 | upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len())); |
79679c2d | 714 | } |
ec8a9bb9 DM |
715 | _ => { |
716 | bail!("got unknown archive extension '{}'", extension); | |
717 | } | |
ae0be2dd DM |
718 | } |
719 | } | |
720 | ||
11377a47 | 721 | let backup_time = Utc.timestamp(backup_time_opt.unwrap_or_else(|| Utc::now().timestamp()), 0); |
ae0be2dd | 722 | |
cc2ce4a9 | 723 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
d0a03d40 DM |
724 | record_repository(&repo); |
725 | ||
ca5d0b61 DM |
726 | println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time)); |
727 | ||
f69adc81 | 728 | println!("Client name: {}", proxmox::tools::nodename()); |
ca5d0b61 DM |
729 | |
730 | let start_time = Local::now(); | |
731 | ||
7a6cfbd9 | 732 | println!("Starting protocol: {}", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false)); |
51144821 | 733 | |
bb823140 DM |
734 | let (crypt_config, rsa_encrypted_key) = match keyfile { |
735 | None => (None, None), | |
6d0983db | 736 | Some(path) => { |
a8f10f84 | 737 | let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
bb823140 DM |
738 | |
739 | let crypt_config = CryptConfig::new(key)?; | |
740 | ||
741 | let path = master_pubkey_path()?; | |
742 | if path.exists() { | |
e18a6c9e | 743 | let pem_data = file_get_contents(&path)?; |
bb823140 DM |
744 | let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?; |
745 | let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?; | |
746 | (Some(Arc::new(crypt_config)), Some(enc_key)) | |
747 | } else { | |
748 | (Some(Arc::new(crypt_config)), None) | |
749 | } | |
6d0983db DM |
750 | } |
751 | }; | |
f98ac774 | 752 | |
e9722f8b | 753 | async_main(async move { |
cf9271e2 DM |
754 | let client = BackupWriter::start( |
755 | client, | |
756 | repo.store(), | |
757 | backup_type, | |
758 | &backup_id, | |
759 | backup_time, | |
760 | verbose, | |
761 | ).await?; | |
e9722f8b | 762 | |
59e9ba01 DM |
763 | let snapshot = BackupDir::new(backup_type, backup_id, backup_time.timestamp()); |
764 | let mut manifest = BackupManifest::new(snapshot); | |
e9722f8b | 765 | |
bf6e3217 | 766 | let (catalog, catalog_result_rx) = spawn_catalog_upload(client.clone(), crypt_config.clone())?; |
e9722f8b WB |
767 | |
768 | for (backup_type, filename, target, size) in upload_list { | |
769 | match backup_type { | |
770 | BackupType::CONFIG => { | |
771 | println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target); | |
772 | let stats = client | |
773 | .upload_blob_from_file(&filename, &target, crypt_config.clone(), true) | |
774 | .await?; | |
59e9ba01 | 775 | manifest.add_file(target, stats.size, stats.csum); |
e9722f8b WB |
776 | } |
777 | BackupType::LOGFILE => { // fixme: remove - not needed anymore ? | |
778 | println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target); | |
779 | let stats = client | |
780 | .upload_blob_from_file(&filename, &target, crypt_config.clone(), true) | |
781 | .await?; | |
59e9ba01 | 782 | manifest.add_file(target, stats.size, stats.csum); |
e9722f8b WB |
783 | } |
784 | BackupType::PXAR => { | |
e9722f8b WB |
785 | println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target); |
786 | catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?; | |
787 | let stats = backup_directory( | |
788 | &client, | |
789 | &filename, | |
790 | &target, | |
791 | chunk_size_opt, | |
792 | devices.clone(), | |
793 | verbose, | |
794 | skip_lost_and_found, | |
795 | crypt_config.clone(), | |
796 | catalog.clone(), | |
797 | ).await?; | |
59e9ba01 | 798 | manifest.add_file(target, stats.size, stats.csum); |
e9722f8b WB |
799 | catalog.lock().unwrap().end_directory()?; |
800 | } | |
801 | BackupType::IMAGE => { | |
802 | println!("Upload image '{}' to '{:?}' as {}", filename, repo, target); | |
803 | let stats = backup_image( | |
804 | &client, | |
805 | &filename, | |
806 | &target, | |
807 | size, | |
808 | chunk_size_opt, | |
809 | verbose, | |
810 | crypt_config.clone(), | |
811 | ).await?; | |
59e9ba01 | 812 | manifest.add_file(target, stats.size, stats.csum); |
e9722f8b | 813 | } |
6af905c1 DM |
814 | } |
815 | } | |
4818c8b6 | 816 | |
e9722f8b WB |
817 | // finalize and upload catalog |
818 | if upload_catalog { | |
819 | let mutex = Arc::try_unwrap(catalog) | |
820 | .map_err(|_| format_err!("unable to get catalog (still used)"))?; | |
bf6e3217 DM |
821 | let mut catalog = mutex.into_inner().unwrap(); |
822 | ||
823 | catalog.finish()?; | |
2761d6a4 | 824 | |
bf6e3217 | 825 | drop(catalog); // close upload stream |
2761d6a4 | 826 | |
bf6e3217 | 827 | let stats = catalog_result_rx.await??; |
9d135fe6 | 828 | |
bf6e3217 | 829 | manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum); |
e9722f8b | 830 | } |
2761d6a4 | 831 | |
e9722f8b WB |
832 | if let Some(rsa_encrypted_key) = rsa_encrypted_key { |
833 | let target = "rsa-encrypted.key"; | |
834 | println!("Upload RSA encoded key to '{:?}' as {}", repo, target); | |
835 | let stats = client | |
836 | .upload_blob_from_data(rsa_encrypted_key, target, None, false, false) | |
837 | .await?; | |
59e9ba01 | 838 | manifest.add_file(format!("{}.blob", target), stats.size, stats.csum); |
e9722f8b WB |
839 | |
840 | // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t | |
841 | /* | |
842 | let mut buffer2 = vec![0u8; rsa.size() as usize]; | |
843 | let pem_data = file_get_contents("master-private.pem")?; | |
844 | let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?; | |
845 | let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?; | |
846 | println!("TEST {} {:?}", len, buffer2); | |
847 | */ | |
848 | } | |
9f46c7de | 849 | |
59e9ba01 DM |
850 | // create manifest (index.json) |
851 | let manifest = manifest.into_json(); | |
2c3891d1 | 852 | |
e9722f8b | 853 | println!("Upload index.json to '{:?}'", repo); |
59e9ba01 | 854 | let manifest = serde_json::to_string_pretty(&manifest)?.into(); |
e9722f8b | 855 | client |
59e9ba01 | 856 | .upload_blob_from_data(manifest, MANIFEST_BLOB_NAME, crypt_config.clone(), true, true) |
e9722f8b | 857 | .await?; |
2c3891d1 | 858 | |
e9722f8b | 859 | client.finish().await?; |
c4ff3dce | 860 | |
e9722f8b WB |
861 | let end_time = Local::now(); |
862 | let elapsed = end_time.signed_duration_since(start_time); | |
863 | println!("Duration: {}", elapsed); | |
3ec3ec3f | 864 | |
e9722f8b | 865 | println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false)); |
3d5c11e5 | 866 | |
e9722f8b WB |
867 | Ok(Value::Null) |
868 | }) | |
f98ea63d DM |
869 | } |
870 | ||
d0a03d40 | 871 | fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
f98ea63d DM |
872 | |
873 | let mut result = vec![]; | |
874 | ||
875 | let data: Vec<&str> = arg.splitn(2, ':').collect(); | |
876 | ||
bff11030 | 877 | if data.len() != 2 { |
8968258b DM |
878 | result.push(String::from("root.pxar:/")); |
879 | result.push(String::from("etc.pxar:/etc")); | |
bff11030 DM |
880 | return result; |
881 | } | |
f98ea63d | 882 | |
496a6784 | 883 | let files = tools::complete_file_name(data[1], param); |
f98ea63d DM |
884 | |
885 | for file in files { | |
886 | result.push(format!("{}:{}", data[0], file)); | |
887 | } | |
888 | ||
889 | result | |
ff5d3707 | 890 | } |
891 | ||
9f912493 DM |
892 | fn restore( |
893 | param: Value, | |
894 | _info: &ApiMethod, | |
dd5495d6 | 895 | _rpcenv: &mut dyn RpcEnvironment, |
9f912493 | 896 | ) -> Result<Value, Error> { |
e9722f8b WB |
897 | async_main(restore_do(param)) |
898 | } | |
9f912493 | 899 | |
88892ea8 DM |
900 | fn dump_image<W: Write>( |
901 | client: Arc<BackupReader>, | |
902 | crypt_config: Option<Arc<CryptConfig>>, | |
903 | index: FixedIndexReader, | |
904 | mut writer: W, | |
fd04ca7a | 905 | verbose: bool, |
88892ea8 DM |
906 | ) -> Result<(), Error> { |
907 | ||
908 | let most_used = index.find_most_used_chunks(8); | |
909 | ||
910 | let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used); | |
911 | ||
912 | // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy | |
913 | // and thus slows down reading. Instead, directly use RemoteChunkReader | |
fd04ca7a DM |
914 | let mut per = 0; |
915 | let mut bytes = 0; | |
916 | let start_time = std::time::Instant::now(); | |
917 | ||
88892ea8 DM |
918 | for pos in 0..index.index_count() { |
919 | let digest = index.index_digest(pos).unwrap(); | |
920 | let raw_data = chunk_reader.read_chunk(&digest)?; | |
921 | writer.write_all(&raw_data)?; | |
fd04ca7a DM |
922 | bytes += raw_data.len(); |
923 | if verbose { | |
924 | let next_per = ((pos+1)*100)/index.index_count(); | |
925 | if per != next_per { | |
926 | eprintln!("progress {}% (read {} bytes, duration {} sec)", | |
927 | next_per, bytes, start_time.elapsed().as_secs()); | |
928 | per = next_per; | |
929 | } | |
930 | } | |
88892ea8 DM |
931 | } |
932 | ||
fd04ca7a DM |
933 | let end_time = std::time::Instant::now(); |
934 | let elapsed = end_time.duration_since(start_time); | |
935 | eprintln!("restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)", | |
936 | bytes, | |
937 | elapsed.as_secs_f64(), | |
938 | bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64()) | |
939 | ); | |
940 | ||
941 | ||
88892ea8 DM |
942 | Ok(()) |
943 | } | |
944 | ||
e9722f8b | 945 | async fn restore_do(param: Value) -> Result<Value, Error> { |
2665cef7 | 946 | let repo = extract_repository_from_value(¶m)?; |
9f912493 | 947 | |
86eda3eb DM |
948 | let verbose = param["verbose"].as_bool().unwrap_or(false); |
949 | ||
46d5aa0a DM |
950 | let allow_existing_dirs = param["allow-existing-dirs"].as_bool().unwrap_or(false); |
951 | ||
d5c34d98 DM |
952 | let archive_name = tools::required_string_param(¶m, "archive-name")?; |
953 | ||
cc2ce4a9 | 954 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
d0a03d40 | 955 | |
d0a03d40 | 956 | record_repository(&repo); |
d5c34d98 | 957 | |
9f912493 | 958 | let path = tools::required_string_param(¶m, "snapshot")?; |
9f912493 | 959 | |
86eda3eb | 960 | let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 { |
d5c34d98 | 961 | let group = BackupGroup::parse(path)?; |
9f912493 | 962 | |
9e391bb7 DM |
963 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); |
964 | let result = client.get(&path, Some(json!({ | |
d5c34d98 DM |
965 | "backup-type": group.backup_type(), |
966 | "backup-id": group.backup_id(), | |
e9722f8b | 967 | }))).await?; |
9f912493 | 968 | |
d5c34d98 | 969 | let list = result["data"].as_array().unwrap(); |
11377a47 | 970 | if list.is_empty() { |
d5c34d98 DM |
971 | bail!("backup group '{}' does not contain any snapshots:", path); |
972 | } | |
9f912493 | 973 | |
86eda3eb | 974 | let epoch = list[0]["backup-time"].as_i64().unwrap(); |
fa5d6977 | 975 | let backup_time = Utc.timestamp(epoch, 0); |
86eda3eb | 976 | (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time) |
d5c34d98 DM |
977 | } else { |
978 | let snapshot = BackupDir::parse(path)?; | |
86eda3eb DM |
979 | (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time()) |
980 | }; | |
9f912493 | 981 | |
d5c34d98 | 982 | let target = tools::required_string_param(¶m, "target")?; |
bf125261 | 983 | let target = if target == "-" { None } else { Some(target) }; |
2ae7d196 | 984 | |
11377a47 | 985 | let keyfile = param["keyfile"].as_str().map(PathBuf::from); |
2ae7d196 | 986 | |
86eda3eb DM |
987 | let crypt_config = match keyfile { |
988 | None => None, | |
989 | Some(path) => { | |
a8f10f84 | 990 | let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
86eda3eb DM |
991 | Some(Arc::new(CryptConfig::new(key)?)) |
992 | } | |
993 | }; | |
d5c34d98 | 994 | |
afb4cd28 DM |
995 | let server_archive_name = if archive_name.ends_with(".pxar") { |
996 | format!("{}.didx", archive_name) | |
997 | } else if archive_name.ends_with(".img") { | |
998 | format!("{}.fidx", archive_name) | |
999 | } else { | |
f8100e96 | 1000 | format!("{}.blob", archive_name) |
afb4cd28 | 1001 | }; |
9f912493 | 1002 | |
296c50ba DM |
1003 | let client = BackupReader::start( |
1004 | client, | |
1005 | crypt_config.clone(), | |
1006 | repo.store(), | |
1007 | &backup_type, | |
1008 | &backup_id, | |
1009 | backup_time, | |
1010 | true, | |
1011 | ).await?; | |
86eda3eb | 1012 | |
f06b820a | 1013 | let manifest = client.download_manifest().await?; |
02fcf372 | 1014 | |
ad6e5a6f | 1015 | if server_archive_name == MANIFEST_BLOB_NAME { |
f06b820a | 1016 | let backup_index_data = manifest.into_json().to_string(); |
02fcf372 | 1017 | if let Some(target) = target { |
296c50ba | 1018 | file_set_contents(target, backup_index_data.as_bytes(), None)?; |
02fcf372 DM |
1019 | } else { |
1020 | let stdout = std::io::stdout(); | |
1021 | let mut writer = stdout.lock(); | |
296c50ba | 1022 | writer.write_all(backup_index_data.as_bytes()) |
02fcf372 DM |
1023 | .map_err(|err| format_err!("unable to pipe data - {}", err))?; |
1024 | } | |
1025 | ||
1026 | } else if server_archive_name.ends_with(".blob") { | |
d2267b11 | 1027 | |
bb19af73 | 1028 | let mut reader = client.download_blob(&manifest, &server_archive_name).await?; |
f8100e96 | 1029 | |
bf125261 | 1030 | if let Some(target) = target { |
0d986280 DM |
1031 | let mut writer = std::fs::OpenOptions::new() |
1032 | .write(true) | |
1033 | .create(true) | |
1034 | .create_new(true) | |
1035 | .open(target) | |
1036 | .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?; | |
1037 | std::io::copy(&mut reader, &mut writer)?; | |
bf125261 DM |
1038 | } else { |
1039 | let stdout = std::io::stdout(); | |
1040 | let mut writer = stdout.lock(); | |
0d986280 | 1041 | std::io::copy(&mut reader, &mut writer) |
bf125261 DM |
1042 | .map_err(|err| format_err!("unable to pipe data - {}", err))?; |
1043 | } | |
f8100e96 DM |
1044 | |
1045 | } else if server_archive_name.ends_with(".didx") { | |
86eda3eb | 1046 | |
c3d84a22 | 1047 | let index = client.download_dynamic_index(&manifest, &server_archive_name).await?; |
df65bd3d | 1048 | |
f4bf7dfc DM |
1049 | let most_used = index.find_most_used_chunks(8); |
1050 | ||
1051 | let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used); | |
1052 | ||
afb4cd28 | 1053 | let mut reader = BufferedDynamicReader::new(index, chunk_reader); |
86eda3eb | 1054 | |
bf125261 | 1055 | if let Some(target) = target { |
86eda3eb | 1056 | |
47651f95 | 1057 | let feature_flags = pxar::flags::DEFAULT; |
f701d033 DM |
1058 | let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags); |
1059 | decoder.set_callback(move |path| { | |
bf125261 | 1060 | if verbose { |
fd04ca7a | 1061 | eprintln!("{:?}", path); |
bf125261 DM |
1062 | } |
1063 | Ok(()) | |
1064 | }); | |
6a879109 CE |
1065 | decoder.set_allow_existing_dirs(allow_existing_dirs); |
1066 | ||
fa7e957c | 1067 | decoder.restore(Path::new(target), &Vec::new())?; |
bf125261 | 1068 | } else { |
88892ea8 DM |
1069 | let mut writer = std::fs::OpenOptions::new() |
1070 | .write(true) | |
1071 | .open("/dev/stdout") | |
1072 | .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?; | |
afb4cd28 | 1073 | |
bf125261 DM |
1074 | std::io::copy(&mut reader, &mut writer) |
1075 | .map_err(|err| format_err!("unable to pipe data - {}", err))?; | |
1076 | } | |
afb4cd28 | 1077 | } else if server_archive_name.ends_with(".fidx") { |
afb4cd28 | 1078 | |
72050500 | 1079 | let index = client.download_fixed_index(&manifest, &server_archive_name).await?; |
df65bd3d | 1080 | |
88892ea8 DM |
1081 | let mut writer = if let Some(target) = target { |
1082 | std::fs::OpenOptions::new() | |
bf125261 DM |
1083 | .write(true) |
1084 | .create(true) | |
1085 | .create_new(true) | |
1086 | .open(target) | |
88892ea8 | 1087 | .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))? |
bf125261 | 1088 | } else { |
88892ea8 DM |
1089 | std::fs::OpenOptions::new() |
1090 | .write(true) | |
1091 | .open("/dev/stdout") | |
1092 | .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))? | |
1093 | }; | |
afb4cd28 | 1094 | |
fd04ca7a | 1095 | dump_image(client.clone(), crypt_config.clone(), index, &mut writer, verbose)?; |
88892ea8 DM |
1096 | |
1097 | } else { | |
f8100e96 | 1098 | bail!("unknown archive file extension (expected .pxar of .img)"); |
3031e44c | 1099 | } |
fef44d4f DM |
1100 | |
1101 | Ok(Value::Null) | |
45db6f89 DM |
1102 | } |
1103 | ||
ec34f7eb DM |
1104 | fn upload_log( |
1105 | param: Value, | |
1106 | _info: &ApiMethod, | |
1107 | _rpcenv: &mut dyn RpcEnvironment, | |
1108 | ) -> Result<Value, Error> { | |
1109 | ||
1110 | let logfile = tools::required_string_param(¶m, "logfile")?; | |
1111 | let repo = extract_repository_from_value(¶m)?; | |
1112 | ||
1113 | let snapshot = tools::required_string_param(¶m, "snapshot")?; | |
1114 | let snapshot = BackupDir::parse(snapshot)?; | |
1115 | ||
cc2ce4a9 | 1116 | let mut client = HttpClient::new(repo.host(), repo.user(), None)?; |
ec34f7eb | 1117 | |
11377a47 | 1118 | let keyfile = param["keyfile"].as_str().map(PathBuf::from); |
ec34f7eb DM |
1119 | |
1120 | let crypt_config = match keyfile { | |
1121 | None => None, | |
1122 | Some(path) => { | |
a8f10f84 | 1123 | let (key, _created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
ec34f7eb | 1124 | let crypt_config = CryptConfig::new(key)?; |
9025312a | 1125 | Some(Arc::new(crypt_config)) |
ec34f7eb DM |
1126 | } |
1127 | }; | |
1128 | ||
e18a6c9e | 1129 | let data = file_get_contents(logfile)?; |
ec34f7eb | 1130 | |
7123ff7d | 1131 | let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?; |
ec34f7eb DM |
1132 | |
1133 | let raw_data = blob.into_inner(); | |
1134 | ||
1135 | let path = format!("api2/json/admin/datastore/{}/upload-backup-log", repo.store()); | |
1136 | ||
1137 | let args = json!({ | |
1138 | "backup-type": snapshot.group().backup_type(), | |
1139 | "backup-id": snapshot.group().backup_id(), | |
1140 | "backup-time": snapshot.backup_time().timestamp(), | |
1141 | }); | |
1142 | ||
1143 | let body = hyper::Body::from(raw_data); | |
1144 | ||
e9722f8b WB |
1145 | async_main(async move { |
1146 | client.upload("application/octet-stream", body, &path, Some(args)).await | |
1147 | }) | |
ec34f7eb DM |
1148 | } |
1149 | ||
83b7db02 | 1150 | fn prune( |
ea7a7ef2 | 1151 | mut param: Value, |
83b7db02 | 1152 | _info: &ApiMethod, |
dd5495d6 | 1153 | _rpcenv: &mut dyn RpcEnvironment, |
83b7db02 DM |
1154 | ) -> Result<Value, Error> { |
1155 | ||
2665cef7 | 1156 | let repo = extract_repository_from_value(¶m)?; |
83b7db02 | 1157 | |
cc2ce4a9 | 1158 | let mut client = HttpClient::new(repo.host(), repo.user(), None)?; |
83b7db02 | 1159 | |
d0a03d40 | 1160 | let path = format!("api2/json/admin/datastore/{}/prune", repo.store()); |
83b7db02 | 1161 | |
9fdc3ef4 DM |
1162 | let group = tools::required_string_param(¶m, "group")?; |
1163 | let group = BackupGroup::parse(group)?; | |
163e9bbe | 1164 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); |
9fdc3ef4 | 1165 | |
ea7a7ef2 DM |
1166 | param.as_object_mut().unwrap().remove("repository"); |
1167 | param.as_object_mut().unwrap().remove("group"); | |
163e9bbe | 1168 | param.as_object_mut().unwrap().remove("output-format"); |
ea7a7ef2 DM |
1169 | |
1170 | param["backup-type"] = group.backup_type().into(); | |
1171 | param["backup-id"] = group.backup_id().into(); | |
83b7db02 | 1172 | |
5a0b484b DM |
1173 | async_main(async { |
1174 | let result = client.post(&path, Some(param)).await?; | |
74fa81b8 | 1175 | |
5a0b484b | 1176 | record_repository(&repo); |
3b03abfe | 1177 | |
d105176f DM |
1178 | view_task_result(client, result, &output_format).await |
1179 | })?; | |
d0a03d40 | 1180 | |
43a406fd | 1181 | Ok(Value::Null) |
83b7db02 DM |
1182 | } |
1183 | ||
34a816cc DM |
1184 | fn status( |
1185 | param: Value, | |
1186 | _info: &ApiMethod, | |
1187 | _rpcenv: &mut dyn RpcEnvironment, | |
1188 | ) -> Result<Value, Error> { | |
1189 | ||
1190 | let repo = extract_repository_from_value(¶m)?; | |
1191 | ||
1192 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); | |
1193 | ||
cc2ce4a9 | 1194 | let client = HttpClient::new(repo.host(), repo.user(), None)?; |
34a816cc DM |
1195 | |
1196 | let path = format!("api2/json/admin/datastore/{}/status", repo.store()); | |
1197 | ||
e9722f8b | 1198 | let result = async_main(async move { client.get(&path, None).await })?; |
34a816cc DM |
1199 | let data = &result["data"]; |
1200 | ||
1201 | record_repository(&repo); | |
1202 | ||
1203 | if output_format == "text" { | |
1204 | let total = data["total"].as_u64().unwrap(); | |
1205 | let used = data["used"].as_u64().unwrap(); | |
1206 | let avail = data["avail"].as_u64().unwrap(); | |
1207 | let roundup = total/200; | |
1208 | ||
1209 | println!( | |
1210 | "total: {} used: {} ({} %) available: {}", | |
1211 | total, | |
1212 | used, | |
1213 | ((used+roundup)*100)/total, | |
1214 | avail, | |
1215 | ); | |
1216 | } else { | |
f6ede796 | 1217 | format_and_print_result(data, &output_format); |
34a816cc DM |
1218 | } |
1219 | ||
1220 | Ok(Value::Null) | |
1221 | } | |
1222 | ||
5a2df000 | 1223 | // like get, but simply ignore errors and return Null instead |
e9722f8b | 1224 | async fn try_get(repo: &BackupRepository, url: &str) -> Value { |
024f11bb | 1225 | |
cc2ce4a9 | 1226 | let client = match HttpClient::new(repo.host(), repo.user(), None) { |
45cdce06 DM |
1227 | Ok(v) => v, |
1228 | _ => return Value::Null, | |
1229 | }; | |
b2388518 | 1230 | |
e9722f8b | 1231 | let mut resp = match client.get(url, None).await { |
b2388518 DM |
1232 | Ok(v) => v, |
1233 | _ => return Value::Null, | |
1234 | }; | |
1235 | ||
1236 | if let Some(map) = resp.as_object_mut() { | |
1237 | if let Some(data) = map.remove("data") { | |
1238 | return data; | |
1239 | } | |
1240 | } | |
1241 | Value::Null | |
1242 | } | |
1243 | ||
b2388518 | 1244 | fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
e9722f8b WB |
1245 | async_main(async { complete_backup_group_do(param).await }) |
1246 | } | |
1247 | ||
1248 | async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> { | |
024f11bb | 1249 | |
b2388518 DM |
1250 | let mut result = vec![]; |
1251 | ||
2665cef7 | 1252 | let repo = match extract_repository_from_map(param) { |
b2388518 | 1253 | Some(v) => v, |
024f11bb DM |
1254 | _ => return result, |
1255 | }; | |
1256 | ||
b2388518 DM |
1257 | let path = format!("api2/json/admin/datastore/{}/groups", repo.store()); |
1258 | ||
e9722f8b | 1259 | let data = try_get(&repo, &path).await; |
b2388518 DM |
1260 | |
1261 | if let Some(list) = data.as_array() { | |
024f11bb | 1262 | for item in list { |
98f0b972 DM |
1263 | if let (Some(backup_id), Some(backup_type)) = |
1264 | (item["backup-id"].as_str(), item["backup-type"].as_str()) | |
1265 | { | |
1266 | result.push(format!("{}/{}", backup_type, backup_id)); | |
024f11bb DM |
1267 | } |
1268 | } | |
1269 | } | |
1270 | ||
1271 | result | |
1272 | } | |
1273 | ||
b2388518 | 1274 | fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
e9722f8b WB |
1275 | async_main(async { complete_group_or_snapshot_do(arg, param).await }) |
1276 | } | |
1277 | ||
1278 | async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
b2388518 | 1279 | |
b2388518 | 1280 | if arg.matches('/').count() < 2 { |
e9722f8b | 1281 | let groups = complete_backup_group_do(param).await; |
543a260f | 1282 | let mut result = vec![]; |
b2388518 DM |
1283 | for group in groups { |
1284 | result.push(group.to_string()); | |
1285 | result.push(format!("{}/", group)); | |
1286 | } | |
1287 | return result; | |
1288 | } | |
1289 | ||
e9722f8b | 1290 | complete_backup_snapshot_do(param).await |
543a260f | 1291 | } |
b2388518 | 1292 | |
3fb53e07 | 1293 | fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
e9722f8b WB |
1294 | async_main(async { complete_backup_snapshot_do(param).await }) |
1295 | } | |
1296 | ||
1297 | async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> { | |
543a260f DM |
1298 | |
1299 | let mut result = vec![]; | |
1300 | ||
1301 | let repo = match extract_repository_from_map(param) { | |
1302 | Some(v) => v, | |
1303 | _ => return result, | |
1304 | }; | |
1305 | ||
1306 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
b2388518 | 1307 | |
e9722f8b | 1308 | let data = try_get(&repo, &path).await; |
b2388518 DM |
1309 | |
1310 | if let Some(list) = data.as_array() { | |
1311 | for item in list { | |
1312 | if let (Some(backup_id), Some(backup_type), Some(backup_time)) = | |
1313 | (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64()) | |
1314 | { | |
1315 | let snapshot = BackupDir::new(backup_type, backup_id, backup_time); | |
1316 | result.push(snapshot.relative_path().to_str().unwrap().to_owned()); | |
1317 | } | |
1318 | } | |
1319 | } | |
1320 | ||
1321 | result | |
1322 | } | |
1323 | ||
45db6f89 | 1324 | fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
e9722f8b WB |
1325 | async_main(async { complete_server_file_name_do(param).await }) |
1326 | } | |
1327 | ||
1328 | async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> { | |
08dc340a DM |
1329 | |
1330 | let mut result = vec![]; | |
1331 | ||
2665cef7 | 1332 | let repo = match extract_repository_from_map(param) { |
08dc340a DM |
1333 | Some(v) => v, |
1334 | _ => return result, | |
1335 | }; | |
1336 | ||
1337 | let snapshot = match param.get("snapshot") { | |
1338 | Some(path) => { | |
1339 | match BackupDir::parse(path) { | |
1340 | Ok(v) => v, | |
1341 | _ => return result, | |
1342 | } | |
1343 | } | |
1344 | _ => return result, | |
1345 | }; | |
1346 | ||
1347 | let query = tools::json_object_to_query(json!({ | |
1348 | "backup-type": snapshot.group().backup_type(), | |
1349 | "backup-id": snapshot.group().backup_id(), | |
1350 | "backup-time": snapshot.backup_time().timestamp(), | |
1351 | })).unwrap(); | |
1352 | ||
1353 | let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query); | |
1354 | ||
e9722f8b | 1355 | let data = try_get(&repo, &path).await; |
08dc340a DM |
1356 | |
1357 | if let Some(list) = data.as_array() { | |
1358 | for item in list { | |
c4f025eb | 1359 | if let Some(filename) = item["filename"].as_str() { |
08dc340a DM |
1360 | result.push(filename.to_owned()); |
1361 | } | |
1362 | } | |
1363 | } | |
1364 | ||
45db6f89 DM |
1365 | result |
1366 | } | |
1367 | ||
1368 | fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> { | |
52c171e4 | 1369 | complete_server_file_name(arg, param) |
e9722f8b WB |
1370 | .iter() |
1371 | .map(|v| strip_server_file_expenstion(&v)) | |
1372 | .collect() | |
08dc340a DM |
1373 | } |
1374 | ||
0ec9e1b0 DM |
1375 | fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> { |
1376 | complete_server_file_name(arg, param) | |
1377 | .iter() | |
1378 | .filter_map(|v| { | |
1379 | let name = strip_server_file_expenstion(&v); | |
1380 | if name.ends_with(".pxar") { | |
1381 | Some(name) | |
1382 | } else { | |
1383 | None | |
1384 | } | |
1385 | }) | |
1386 | .collect() | |
1387 | } | |
1388 | ||
49811347 DM |
1389 | fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> { |
1390 | ||
1391 | let mut result = vec![]; | |
1392 | ||
1393 | let mut size = 64; | |
1394 | loop { | |
1395 | result.push(size.to_string()); | |
11377a47 | 1396 | size *= 2; |
49811347 DM |
1397 | if size > 4096 { break; } |
1398 | } | |
1399 | ||
1400 | result | |
1401 | } | |
1402 | ||
826f309b | 1403 | fn get_encryption_key_password() -> Result<Vec<u8>, Error> { |
ff5d3707 | 1404 | |
f2401311 DM |
1405 | // fixme: implement other input methods |
1406 | ||
1407 | use std::env::VarError::*; | |
1408 | match std::env::var("PBS_ENCRYPTION_PASSWORD") { | |
826f309b | 1409 | Ok(p) => return Ok(p.as_bytes().to_vec()), |
f2401311 DM |
1410 | Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters"), |
1411 | Err(NotPresent) => { | |
1412 | // Try another method | |
1413 | } | |
1414 | } | |
1415 | ||
1416 | // If we're on a TTY, query the user for a password | |
1417 | if crate::tools::tty::stdin_isatty() { | |
826f309b | 1418 | return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?); |
f2401311 DM |
1419 | } |
1420 | ||
1421 | bail!("no password input mechanism available"); | |
1422 | } | |
1423 | ||
ac716234 DM |
1424 | fn key_create( |
1425 | param: Value, | |
1426 | _info: &ApiMethod, | |
1427 | _rpcenv: &mut dyn RpcEnvironment, | |
1428 | ) -> Result<Value, Error> { | |
1429 | ||
9b06db45 DM |
1430 | let path = tools::required_string_param(¶m, "path")?; |
1431 | let path = PathBuf::from(path); | |
ac716234 | 1432 | |
181f097a | 1433 | let kdf = param["kdf"].as_str().unwrap_or("scrypt"); |
ac716234 DM |
1434 | |
1435 | let key = proxmox::sys::linux::random_data(32)?; | |
1436 | ||
181f097a DM |
1437 | if kdf == "scrypt" { |
1438 | // always read passphrase from tty | |
1439 | if !crate::tools::tty::stdin_isatty() { | |
1440 | bail!("unable to read passphrase - no tty"); | |
1441 | } | |
ac716234 | 1442 | |
181f097a DM |
1443 | let password = crate::tools::tty::read_password("Encryption Key Password: ")?; |
1444 | ||
ab44acff | 1445 | let key_config = encrypt_key_with_passphrase(&key, &password)?; |
37c5a175 | 1446 | |
ab44acff | 1447 | store_key_config(&path, false, key_config)?; |
181f097a DM |
1448 | |
1449 | Ok(Value::Null) | |
1450 | } else if kdf == "none" { | |
1451 | let created = Local.timestamp(Local::now().timestamp(), 0); | |
1452 | ||
1453 | store_key_config(&path, false, KeyConfig { | |
1454 | kdf: None, | |
1455 | created, | |
ab44acff | 1456 | modified: created, |
181f097a DM |
1457 | data: key, |
1458 | })?; | |
1459 | ||
1460 | Ok(Value::Null) | |
1461 | } else { | |
1462 | unreachable!(); | |
1463 | } | |
ac716234 DM |
1464 | } |
1465 | ||
9f46c7de DM |
1466 | fn master_pubkey_path() -> Result<PathBuf, Error> { |
1467 | let base = BaseDirectories::with_prefix("proxmox-backup")?; | |
1468 | ||
1469 | // usually $HOME/.config/proxmox-backup/master-public.pem | |
1470 | let path = base.place_config_file("master-public.pem")?; | |
1471 | ||
1472 | Ok(path) | |
1473 | } | |
1474 | ||
3ea8bfc9 DM |
1475 | fn key_import_master_pubkey( |
1476 | param: Value, | |
1477 | _info: &ApiMethod, | |
1478 | _rpcenv: &mut dyn RpcEnvironment, | |
1479 | ) -> Result<Value, Error> { | |
1480 | ||
1481 | let path = tools::required_string_param(¶m, "path")?; | |
1482 | let path = PathBuf::from(path); | |
1483 | ||
e18a6c9e | 1484 | let pem_data = file_get_contents(&path)?; |
3ea8bfc9 DM |
1485 | |
1486 | if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) { | |
1487 | bail!("Unable to decode PEM data - {}", err); | |
1488 | } | |
1489 | ||
9f46c7de | 1490 | let target_path = master_pubkey_path()?; |
3ea8bfc9 | 1491 | |
e18a6c9e | 1492 | file_set_contents(&target_path, &pem_data, None)?; |
3ea8bfc9 DM |
1493 | |
1494 | println!("Imported public master key to {:?}", target_path); | |
1495 | ||
1496 | Ok(Value::Null) | |
1497 | } | |
1498 | ||
37c5a175 DM |
1499 | fn key_create_master_key( |
1500 | _param: Value, | |
1501 | _info: &ApiMethod, | |
1502 | _rpcenv: &mut dyn RpcEnvironment, | |
1503 | ) -> Result<Value, Error> { | |
1504 | ||
1505 | // we need a TTY to query the new password | |
1506 | if !crate::tools::tty::stdin_isatty() { | |
1507 | bail!("unable to create master key - no tty"); | |
1508 | } | |
1509 | ||
1510 | let rsa = openssl::rsa::Rsa::generate(4096)?; | |
1511 | let pkey = openssl::pkey::PKey::from_rsa(rsa)?; | |
1512 | ||
1513 | let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?; | |
1514 | let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?; | |
1515 | ||
1516 | if new_pw != verify_pw { | |
1517 | bail!("Password verification fail!"); | |
1518 | } | |
1519 | ||
1520 | if new_pw.len() < 5 { | |
1521 | bail!("Password is too short!"); | |
1522 | } | |
1523 | ||
1524 | let pub_key: Vec<u8> = pkey.public_key_to_pem()?; | |
1525 | let filename_pub = "master-public.pem"; | |
1526 | println!("Writing public master key to {}", filename_pub); | |
e18a6c9e | 1527 | file_set_contents(filename_pub, pub_key.as_slice(), None)?; |
37c5a175 DM |
1528 | |
1529 | let cipher = openssl::symm::Cipher::aes_256_cbc(); | |
1530 | let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?; | |
1531 | ||
1532 | let filename_priv = "master-private.pem"; | |
1533 | println!("Writing private master key to {}", filename_priv); | |
e18a6c9e | 1534 | file_set_contents(filename_priv, priv_key.as_slice(), None)?; |
37c5a175 DM |
1535 | |
1536 | Ok(Value::Null) | |
1537 | } | |
ac716234 DM |
1538 | |
1539 | fn key_change_passphrase( | |
1540 | param: Value, | |
1541 | _info: &ApiMethod, | |
1542 | _rpcenv: &mut dyn RpcEnvironment, | |
1543 | ) -> Result<Value, Error> { | |
1544 | ||
9b06db45 DM |
1545 | let path = tools::required_string_param(¶m, "path")?; |
1546 | let path = PathBuf::from(path); | |
ac716234 | 1547 | |
181f097a DM |
1548 | let kdf = param["kdf"].as_str().unwrap_or("scrypt"); |
1549 | ||
ac716234 DM |
1550 | // we need a TTY to query the new password |
1551 | if !crate::tools::tty::stdin_isatty() { | |
1552 | bail!("unable to change passphrase - no tty"); | |
1553 | } | |
1554 | ||
a8f10f84 | 1555 | let (key, created) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
ac716234 | 1556 | |
181f097a | 1557 | if kdf == "scrypt" { |
ac716234 | 1558 | |
181f097a DM |
1559 | let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?; |
1560 | let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?; | |
ac716234 | 1561 | |
181f097a DM |
1562 | if new_pw != verify_pw { |
1563 | bail!("Password verification fail!"); | |
1564 | } | |
1565 | ||
1566 | if new_pw.len() < 5 { | |
1567 | bail!("Password is too short!"); | |
1568 | } | |
ac716234 | 1569 | |
ab44acff DM |
1570 | let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?; |
1571 | new_key_config.created = created; // keep original value | |
1572 | ||
1573 | store_key_config(&path, true, new_key_config)?; | |
ac716234 | 1574 | |
181f097a DM |
1575 | Ok(Value::Null) |
1576 | } else if kdf == "none" { | |
ab44acff | 1577 | let modified = Local.timestamp(Local::now().timestamp(), 0); |
181f097a DM |
1578 | |
1579 | store_key_config(&path, true, KeyConfig { | |
1580 | kdf: None, | |
ab44acff DM |
1581 | created, // keep original value |
1582 | modified, | |
6d0983db | 1583 | data: key.to_vec(), |
181f097a DM |
1584 | })?; |
1585 | ||
1586 | Ok(Value::Null) | |
1587 | } else { | |
1588 | unreachable!(); | |
1589 | } | |
f2401311 DM |
1590 | } |
1591 | ||
1592 | fn key_mgmt_cli() -> CliCommandMap { | |
1593 | ||
255f378a | 1594 | const KDF_SCHEMA: Schema = |
181f097a | 1595 | StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.") |
255f378a DM |
1596 | .format(&ApiStringFormat::Enum(&["scrypt", "none"])) |
1597 | .default("scrypt") | |
1598 | .schema(); | |
1599 | ||
552c2259 | 1600 | #[sortable] |
255f378a DM |
1601 | const API_METHOD_KEY_CREATE: ApiMethod = ApiMethod::new( |
1602 | &ApiHandler::Sync(&key_create), | |
1603 | &ObjectSchema::new( | |
1604 | "Create a new encryption key.", | |
552c2259 | 1605 | &sorted!([ |
255f378a DM |
1606 | ("path", false, &StringSchema::new("File system path.").schema()), |
1607 | ("kdf", true, &KDF_SCHEMA), | |
552c2259 | 1608 | ]), |
255f378a | 1609 | ) |
181f097a | 1610 | ); |
7074a0b3 | 1611 | |
255f378a | 1612 | let key_create_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE) |
49fddd98 | 1613 | .arg_param(&["path"]) |
9b06db45 | 1614 | .completion_cb("path", tools::complete_file_name); |
f2401311 | 1615 | |
552c2259 | 1616 | #[sortable] |
255f378a DM |
1617 | const API_METHOD_KEY_CHANGE_PASSPHRASE: ApiMethod = ApiMethod::new( |
1618 | &ApiHandler::Sync(&key_change_passphrase), | |
1619 | &ObjectSchema::new( | |
1620 | "Change the passphrase required to decrypt the key.", | |
552c2259 | 1621 | &sorted!([ |
255f378a DM |
1622 | ("path", false, &StringSchema::new("File system path.").schema()), |
1623 | ("kdf", true, &KDF_SCHEMA), | |
552c2259 | 1624 | ]), |
255f378a DM |
1625 | ) |
1626 | ); | |
7074a0b3 | 1627 | |
255f378a | 1628 | let key_change_passphrase_cmd_def = CliCommand::new(&API_METHOD_KEY_CHANGE_PASSPHRASE) |
49fddd98 | 1629 | .arg_param(&["path"]) |
9b06db45 | 1630 | .completion_cb("path", tools::complete_file_name); |
ac716234 | 1631 | |
255f378a DM |
1632 | const API_METHOD_KEY_CREATE_MASTER_KEY: ApiMethod = ApiMethod::new( |
1633 | &ApiHandler::Sync(&key_create_master_key), | |
1634 | &ObjectSchema::new("Create a new 4096 bit RSA master pub/priv key pair.", &[]) | |
1635 | ); | |
7074a0b3 | 1636 | |
255f378a DM |
1637 | let key_create_master_key_cmd_def = CliCommand::new(&API_METHOD_KEY_CREATE_MASTER_KEY); |
1638 | ||
552c2259 | 1639 | #[sortable] |
255f378a DM |
1640 | const API_METHOD_KEY_IMPORT_MASTER_PUBKEY: ApiMethod = ApiMethod::new( |
1641 | &ApiHandler::Sync(&key_import_master_pubkey), | |
1642 | &ObjectSchema::new( | |
1643 | "Import a new RSA public key and use it as master key. The key is expected to be in '.pem' format.", | |
552c2259 | 1644 | &sorted!([ ("path", false, &StringSchema::new("File system path.").schema()) ]), |
255f378a DM |
1645 | ) |
1646 | ); | |
7074a0b3 | 1647 | |
255f378a | 1648 | let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_KEY_IMPORT_MASTER_PUBKEY) |
49fddd98 | 1649 | .arg_param(&["path"]) |
3ea8bfc9 DM |
1650 | .completion_cb("path", tools::complete_file_name); |
1651 | ||
11377a47 | 1652 | CliCommandMap::new() |
48ef3c33 DM |
1653 | .insert("create", key_create_cmd_def) |
1654 | .insert("create-master-key", key_create_master_key_cmd_def) | |
1655 | .insert("import-master-pubkey", key_import_master_pubkey_cmd_def) | |
1656 | .insert("change-passphrase", key_change_passphrase_cmd_def) | |
f2401311 DM |
1657 | } |
1658 | ||
70235f72 CE |
1659 | fn mount( |
1660 | param: Value, | |
1661 | _info: &ApiMethod, | |
1662 | _rpcenv: &mut dyn RpcEnvironment, | |
1663 | ) -> Result<Value, Error> { | |
1664 | let verbose = param["verbose"].as_bool().unwrap_or(false); | |
1665 | if verbose { | |
1666 | // This will stay in foreground with debug output enabled as None is | |
1667 | // passed for the RawFd. | |
1668 | return async_main(mount_do(param, None)); | |
1669 | } | |
1670 | ||
1671 | // Process should be deamonized. | |
1672 | // Make sure to fork before the async runtime is instantiated to avoid troubles. | |
1673 | let pipe = pipe()?; | |
1674 | match fork() { | |
11377a47 | 1675 | Ok(ForkResult::Parent { .. }) => { |
70235f72 CE |
1676 | nix::unistd::close(pipe.1).unwrap(); |
1677 | // Blocks the parent process until we are ready to go in the child | |
1678 | let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap(); | |
1679 | Ok(Value::Null) | |
1680 | } | |
1681 | Ok(ForkResult::Child) => { | |
1682 | nix::unistd::close(pipe.0).unwrap(); | |
1683 | nix::unistd::setsid().unwrap(); | |
1684 | async_main(mount_do(param, Some(pipe.1))) | |
1685 | } | |
1686 | Err(_) => bail!("failed to daemonize process"), | |
1687 | } | |
1688 | } | |
1689 | ||
1690 | async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> { | |
1691 | let repo = extract_repository_from_value(¶m)?; | |
1692 | let archive_name = tools::required_string_param(¶m, "archive-name")?; | |
1693 | let target = tools::required_string_param(¶m, "target")?; | |
1694 | let client = HttpClient::new(repo.host(), repo.user(), None)?; | |
1695 | ||
1696 | record_repository(&repo); | |
1697 | ||
1698 | let path = tools::required_string_param(¶m, "snapshot")?; | |
1699 | let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 { | |
1700 | let group = BackupGroup::parse(path)?; | |
1701 | ||
1702 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
1703 | let result = client.get(&path, Some(json!({ | |
1704 | "backup-type": group.backup_type(), | |
1705 | "backup-id": group.backup_id(), | |
1706 | }))).await?; | |
1707 | ||
1708 | let list = result["data"].as_array().unwrap(); | |
11377a47 | 1709 | if list.is_empty() { |
70235f72 CE |
1710 | bail!("backup group '{}' does not contain any snapshots:", path); |
1711 | } | |
1712 | ||
1713 | let epoch = list[0]["backup-time"].as_i64().unwrap(); | |
1714 | let backup_time = Utc.timestamp(epoch, 0); | |
1715 | (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time) | |
1716 | } else { | |
1717 | let snapshot = BackupDir::parse(path)?; | |
1718 | (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time()) | |
1719 | }; | |
1720 | ||
11377a47 | 1721 | let keyfile = param["keyfile"].as_str().map(PathBuf::from); |
70235f72 CE |
1722 | let crypt_config = match keyfile { |
1723 | None => None, | |
1724 | Some(path) => { | |
a8f10f84 | 1725 | let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; |
70235f72 CE |
1726 | Some(Arc::new(CryptConfig::new(key)?)) |
1727 | } | |
1728 | }; | |
1729 | ||
1730 | let server_archive_name = if archive_name.ends_with(".pxar") { | |
1731 | format!("{}.didx", archive_name) | |
1732 | } else { | |
1733 | bail!("Can only mount pxar archives."); | |
1734 | }; | |
1735 | ||
296c50ba DM |
1736 | let client = BackupReader::start( |
1737 | client, | |
1738 | crypt_config.clone(), | |
1739 | repo.store(), | |
1740 | &backup_type, | |
1741 | &backup_id, | |
1742 | backup_time, | |
1743 | true, | |
1744 | ).await?; | |
70235f72 | 1745 | |
f06b820a | 1746 | let manifest = client.download_manifest().await?; |
296c50ba | 1747 | |
70235f72 | 1748 | if server_archive_name.ends_with(".didx") { |
c3d84a22 | 1749 | let index = client.download_dynamic_index(&manifest, &server_archive_name).await?; |
70235f72 CE |
1750 | let most_used = index.find_most_used_chunks(8); |
1751 | let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used); | |
1752 | let reader = BufferedDynamicReader::new(index, chunk_reader); | |
f701d033 | 1753 | let decoder = pxar::Decoder::new(reader)?; |
70235f72 | 1754 | let options = OsStr::new("ro,default_permissions"); |
2a111910 | 1755 | let mut session = pxar::fuse::Session::new(decoder, &options, pipe.is_none()) |
70235f72 CE |
1756 | .map_err(|err| format_err!("pxar mount failed: {}", err))?; |
1757 | ||
1758 | // Mount the session but not call fuse deamonize as this will cause | |
1759 | // issues with the runtime after the fork | |
1760 | let deamonize = false; | |
1761 | session.mount(&Path::new(target), deamonize)?; | |
1762 | ||
1763 | if let Some(pipe) = pipe { | |
1764 | nix::unistd::chdir(Path::new("/")).unwrap(); | |
1765 | // Finish creation of deamon by redirecting filedescriptors. | |
1766 | let nullfd = nix::fcntl::open( | |
1767 | "/dev/null", | |
1768 | nix::fcntl::OFlag::O_RDWR, | |
1769 | nix::sys::stat::Mode::empty(), | |
1770 | ).unwrap(); | |
1771 | nix::unistd::dup2(nullfd, 0).unwrap(); | |
1772 | nix::unistd::dup2(nullfd, 1).unwrap(); | |
1773 | nix::unistd::dup2(nullfd, 2).unwrap(); | |
1774 | if nullfd > 2 { | |
1775 | nix::unistd::close(nullfd).unwrap(); | |
1776 | } | |
1777 | // Signal the parent process that we are done with the setup and it can | |
1778 | // terminate. | |
11377a47 | 1779 | nix::unistd::write(pipe, &[0u8])?; |
70235f72 CE |
1780 | nix::unistd::close(pipe).unwrap(); |
1781 | } | |
1782 | ||
1783 | let multithreaded = true; | |
1784 | session.run_loop(multithreaded)?; | |
1785 | } else { | |
1786 | bail!("unknown archive file extension (expected .pxar)"); | |
1787 | } | |
1788 | ||
1789 | Ok(Value::Null) | |
1790 | } | |
1791 | ||
1c6ad6ef | 1792 | fn catalog_shell( |
3cf73c4e CE |
1793 | param: Value, |
1794 | _info: &ApiMethod, | |
1795 | _rpcenv: &mut dyn RpcEnvironment, | |
1796 | ) -> Result<Value, Error> { | |
1c6ad6ef | 1797 | async_main(catalog_shell_async(param)) |
3cf73c4e CE |
1798 | } |
1799 | ||
1c6ad6ef | 1800 | async fn catalog_shell_async(param: Value) -> Result<Value, Error> { |
3cf73c4e CE |
1801 | let repo = extract_repository_from_value(¶m)?; |
1802 | let client = HttpClient::new(repo.host(), repo.user(), None)?; | |
1803 | let path = tools::required_string_param(¶m, "snapshot")?; | |
1804 | let archive_name = tools::required_string_param(¶m, "archive-name")?; | |
1805 | ||
1806 | let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 { | |
1807 | let group = BackupGroup::parse(path)?; | |
1808 | ||
1809 | let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store()); | |
1810 | let result = client.get(&path, Some(json!({ | |
1811 | "backup-type": group.backup_type(), | |
1812 | "backup-id": group.backup_id(), | |
1813 | }))).await?; | |
1814 | ||
1815 | let list = result["data"].as_array().unwrap(); | |
314bb358 | 1816 | if list.is_empty() { |
3cf73c4e CE |
1817 | bail!("backup group '{}' does not contain any snapshots:", path); |
1818 | } | |
1819 | ||
1820 | let epoch = list[0]["backup-time"].as_i64().unwrap(); | |
1821 | let backup_time = Utc.timestamp(epoch, 0); | |
1822 | (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time) | |
1823 | } else { | |
1824 | let snapshot = BackupDir::parse(path)?; | |
1825 | (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time()) | |
1826 | }; | |
1827 | ||
1828 | let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p)); | |
1829 | let crypt_config = match keyfile { | |
1830 | None => None, | |
1831 | Some(path) => { | |
1832 | let (key, _) = load_and_decrtypt_key(&path, &get_encryption_key_password)?; | |
1833 | Some(Arc::new(CryptConfig::new(key)?)) | |
1834 | } | |
1835 | }; | |
1836 | ||
1837 | let server_archive_name = if archive_name.ends_with(".pxar") { | |
1838 | format!("{}.didx", archive_name) | |
1839 | } else { | |
1840 | bail!("Can only mount pxar archives."); | |
1841 | }; | |
1842 | ||
1843 | let client = BackupReader::start( | |
1844 | client, | |
1845 | crypt_config.clone(), | |
1846 | repo.store(), | |
1847 | &backup_type, | |
1848 | &backup_id, | |
1849 | backup_time, | |
1850 | true, | |
1851 | ).await?; | |
1852 | ||
1853 | let tmpfile = std::fs::OpenOptions::new() | |
1854 | .write(true) | |
1855 | .read(true) | |
1856 | .custom_flags(libc::O_TMPFILE) | |
1857 | .open("/tmp")?; | |
1858 | ||
1859 | let manifest = client.download_manifest().await?; | |
1860 | ||
1861 | let index = client.download_dynamic_index(&manifest, &server_archive_name).await?; | |
1862 | let most_used = index.find_most_used_chunks(8); | |
1863 | let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config.clone(), most_used); | |
1864 | let reader = BufferedDynamicReader::new(index, chunk_reader); | |
f701d033 DM |
1865 | let mut decoder = pxar::Decoder::new(reader)?; |
1866 | decoder.set_callback(|path| { | |
1867 | println!("{:?}", path); | |
1868 | Ok(()) | |
1869 | }); | |
3cf73c4e CE |
1870 | |
1871 | let tmpfile = client.download(CATALOG_NAME, tmpfile).await?; | |
1872 | let index = DynamicIndexReader::new(tmpfile) | |
1873 | .map_err(|err| format_err!("unable to read catalog index - {}", err))?; | |
1874 | ||
1875 | // Note: do not use values stored in index (not trusted) - instead, computed them again | |
1876 | let (csum, size) = index.compute_csum(); | |
1877 | manifest.verify_file(CATALOG_NAME, &csum, size)?; | |
1878 | ||
1879 | let most_used = index.find_most_used_chunks(8); | |
1880 | let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used); | |
1881 | let mut reader = BufferedDynamicReader::new(index, chunk_reader); | |
1882 | let mut catalogfile = std::fs::OpenOptions::new() | |
1883 | .write(true) | |
1884 | .read(true) | |
1885 | .custom_flags(libc::O_TMPFILE) | |
1886 | .open("/tmp")?; | |
1887 | ||
1888 | std::io::copy(&mut reader, &mut catalogfile) | |
1889 | .map_err(|err| format_err!("unable to download catalog - {}", err))?; | |
1890 | ||
1891 | catalogfile.seek(SeekFrom::Start(0))?; | |
1892 | let catalog_reader = CatalogReader::new(catalogfile); | |
1893 | let state = Shell::new( | |
1894 | catalog_reader, | |
1895 | &server_archive_name, | |
1896 | decoder, | |
1897 | )?; | |
1898 | ||
1899 | println!("Starting interactive shell"); | |
1900 | state.shell()?; | |
1901 | ||
1902 | record_repository(&repo); | |
1903 | ||
1904 | Ok(Value::Null) | |
1905 | } | |
1906 | ||
1c6ad6ef DM |
1907 | fn catalog_mgmt_cli() -> CliCommandMap { |
1908 | ||
1909 | #[sortable] | |
1910 | const API_METHOD_SHELL: ApiMethod = ApiMethod::new( | |
1911 | &ApiHandler::Sync(&catalog_shell), | |
1912 | &ObjectSchema::new( | |
1913 | "Shell to interactively inspect and restore snapshots.", | |
1914 | &sorted!([ | |
1915 | ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()), | |
1916 | ("archive-name", false, &StringSchema::new("Backup archive name.").schema()), | |
1917 | ("repository", true, &REPO_URL_SCHEMA), | |
1918 | ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()), | |
1919 | ]), | |
1920 | ) | |
1921 | ); | |
1922 | ||
1923 | let catalog_shell_cmd_def = CliCommand::new(&API_METHOD_SHELL) | |
1924 | .arg_param(&["snapshot", "archive-name"]) | |
1925 | .completion_cb("repository", complete_repository) | |
0ec9e1b0 | 1926 | .completion_cb("archive-name", complete_pxar_archive_name) |
1c6ad6ef DM |
1927 | .completion_cb("snapshot", complete_group_or_snapshot); |
1928 | ||
1929 | #[sortable] | |
1930 | const API_METHOD_DUMP_CATALOG: ApiMethod = ApiMethod::new( | |
1931 | &ApiHandler::Sync(&dump_catalog), | |
1932 | &ObjectSchema::new( | |
1933 | "Dump catalog.", | |
1934 | &sorted!([ | |
1935 | ("snapshot", false, &StringSchema::new("Snapshot path.").schema()), | |
1936 | ("repository", true, &REPO_URL_SCHEMA), | |
1937 | ]), | |
1938 | ) | |
1939 | ); | |
1940 | ||
1941 | let catalog_dump_cmd_def = CliCommand::new(&API_METHOD_DUMP_CATALOG) | |
1942 | .arg_param(&["snapshot"]) | |
1943 | .completion_cb("repository", complete_repository) | |
1944 | .completion_cb("snapshot", complete_backup_snapshot); | |
1945 | ||
1946 | CliCommandMap::new() | |
48ef3c33 DM |
1947 | .insert("dump", catalog_dump_cmd_def) |
1948 | .insert("shell", catalog_shell_cmd_def) | |
1c6ad6ef DM |
1949 | } |
1950 | ||
5830c205 DM |
1951 | #[api( |
1952 | input: { | |
1953 | properties: { | |
1954 | repository: { | |
1955 | schema: REPO_URL_SCHEMA, | |
1956 | optional: true, | |
1957 | }, | |
1958 | limit: { | |
1959 | description: "The maximal number of tasks to list.", | |
1960 | type: Integer, | |
1961 | optional: true, | |
1962 | minimum: 1, | |
1963 | maximum: 1000, | |
1964 | default: 50, | |
1965 | }, | |
1966 | "output-format": { | |
1967 | schema: OUTPUT_FORMAT, | |
1968 | optional: true, | |
1969 | }, | |
1970 | } | |
1971 | } | |
1972 | )] | |
1973 | /// List running server tasks for this repo user | |
1974 | fn task_list(param: Value) -> Result<Value, Error> { | |
1975 | ||
1976 | async_main(async { | |
1977 | let output_format = param["output-format"].as_str().unwrap_or("text").to_owned(); | |
1978 | let repo = extract_repository_from_value(¶m)?; | |
1979 | let client = HttpClient::new(repo.host(), repo.user(), None)?; | |
1980 | ||
1981 | let limit = param["limit"].as_u64().unwrap_or(50) as usize; | |
1982 | ||
1983 | let args = json!({ "start": 0, "limit": limit, "userfilter": repo.user()}); | |
1984 | let result = client.get("api2/json/nodes/localhost/tasks", Some(args)).await?; | |
1985 | ||
1986 | let data = &result["data"]; | |
1987 | ||
1988 | if output_format == "text" { | |
1989 | for item in data.as_array().unwrap() { | |
1990 | println!( | |
1991 | "{} {}", | |
1992 | item["upid"].as_str().unwrap(), | |
1993 | item["status"].as_str().unwrap_or("running"), | |
1994 | ); | |
1995 | } | |
1996 | } else { | |
1997 | format_and_print_result(data, &output_format); | |
1998 | } | |
1999 | ||
2000 | Ok::<_, Error>(()) | |
2001 | })?; | |
2002 | ||
2003 | Ok(Value::Null) | |
2004 | } | |
2005 | ||
2006 | #[api( | |
2007 | input: { | |
2008 | properties: { | |
2009 | repository: { | |
2010 | schema: REPO_URL_SCHEMA, | |
2011 | optional: true, | |
2012 | }, | |
2013 | upid: { | |
2014 | schema: UPID_SCHEMA, | |
2015 | }, | |
2016 | } | |
2017 | } | |
2018 | )] | |
2019 | /// Display the task log. | |
2020 | fn task_log(param: Value) -> Result<Value, Error> { | |
2021 | ||
2022 | async_main(async { | |
2023 | let repo = extract_repository_from_value(¶m)?; | |
2024 | let upid = tools::required_string_param(¶m, "upid")?; | |
2025 | ||
2026 | let client = HttpClient::new(repo.host(), repo.user(), None)?; | |
2027 | ||
2028 | display_task_log(client, upid, true).await?; | |
2029 | ||
2030 | Ok::<_, Error>(()) | |
2031 | })?; | |
2032 | ||
2033 | Ok(Value::Null) | |
2034 | } | |
2035 | ||
2036 | fn task_mgmt_cli() -> CliCommandMap { | |
2037 | ||
2038 | let task_list_cmd_def = CliCommand::new(&API_METHOD_TASK_LIST) | |
2039 | .completion_cb("repository", complete_repository); | |
2040 | ||
2041 | let task_log_cmd_def = CliCommand::new(&API_METHOD_TASK_LOG) | |
2042 | .arg_param(&["upid"]); | |
2043 | ||
2044 | CliCommandMap::new() | |
2045 | .insert("log", task_log_cmd_def) | |
2046 | .insert("list", task_list_cmd_def) | |
2047 | ||
2048 | } | |
1c6ad6ef | 2049 | |
f2401311 | 2050 | fn main() { |
33d64b81 | 2051 | |
255f378a DM |
2052 | const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new("Backup source specification ([<label>:<path>]).") |
2053 | .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)) | |
2054 | .schema(); | |
25f1650b | 2055 | |
552c2259 | 2056 | #[sortable] |
255f378a DM |
2057 | const API_METHOD_CREATE_BACKUP: ApiMethod = ApiMethod::new( |
2058 | &ApiHandler::Sync(&create_backup), | |
2059 | &ObjectSchema::new( | |
2060 | "Create (host) backup.", | |
552c2259 | 2061 | &sorted!([ |
255f378a | 2062 | ( |
ae0be2dd | 2063 | "backupspec", |
255f378a DM |
2064 | false, |
2065 | &ArraySchema::new( | |
74cdb521 | 2066 | "List of backup source specifications ([<label.ext>:<path>] ...)", |
255f378a DM |
2067 | &BACKUP_SOURCE_SCHEMA, |
2068 | ).min_length(1).schema() | |
2069 | ), | |
2070 | ( | |
2071 | "repository", | |
2072 | true, | |
2073 | &REPO_URL_SCHEMA | |
2074 | ), | |
2075 | ( | |
2eeaacb9 | 2076 | "include-dev", |
255f378a DM |
2077 | true, |
2078 | &ArraySchema::new( | |
2eeaacb9 | 2079 | "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.", |
255f378a DM |
2080 | &StringSchema::new("Path to file.").schema() |
2081 | ).schema() | |
2082 | ), | |
2083 | ( | |
6d0983db | 2084 | "keyfile", |
255f378a DM |
2085 | true, |
2086 | &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema() | |
2087 | ), | |
2088 | ( | |
219ef0e6 | 2089 | "verbose", |
255f378a DM |
2090 | true, |
2091 | &BooleanSchema::new("Verbose output.") | |
2092 | .default(false) | |
2093 | .schema() | |
2094 | ), | |
2095 | ( | |
5b72c9b4 | 2096 | "skip-lost-and-found", |
255f378a DM |
2097 | true, |
2098 | &BooleanSchema::new("Skip lost+found directory") | |
2099 | .default(false) | |
2100 | .schema() | |
2101 | ), | |
2102 | ( | |
bbf9e7e9 | 2103 | "backup-type", |
255f378a DM |
2104 | true, |
2105 | &BACKUP_TYPE_SCHEMA, | |
2106 | ), | |
2107 | ( | |
bbf9e7e9 | 2108 | "backup-id", |
255f378a DM |
2109 | true, |
2110 | &BACKUP_ID_SCHEMA | |
2111 | ), | |
2112 | ( | |
ca5d0b61 | 2113 | "backup-time", |
255f378a DM |
2114 | true, |
2115 | &BACKUP_TIME_SCHEMA | |
2116 | ), | |
2117 | ( | |
2d9d143a | 2118 | "chunk-size", |
255f378a DM |
2119 | true, |
2120 | &IntegerSchema::new("Chunk size in KB. Must be a power of 2.") | |
2d9d143a DM |
2121 | .minimum(64) |
2122 | .maximum(4096) | |
2123 | .default(4096) | |
255f378a DM |
2124 | .schema() |
2125 | ), | |
552c2259 | 2126 | ]), |
255f378a DM |
2127 | ) |
2128 | ); | |
7074a0b3 | 2129 | |
255f378a | 2130 | let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP) |
49fddd98 | 2131 | .arg_param(&["backupspec"]) |
d0a03d40 | 2132 | .completion_cb("repository", complete_repository) |
49811347 | 2133 | .completion_cb("backupspec", complete_backup_source) |
6d0983db | 2134 | .completion_cb("keyfile", tools::complete_file_name) |
49811347 | 2135 | .completion_cb("chunk-size", complete_chunk_size); |
f8838fe9 | 2136 | |
552c2259 | 2137 | #[sortable] |
255f378a DM |
2138 | const API_METHOD_UPLOAD_LOG: ApiMethod = ApiMethod::new( |
2139 | &ApiHandler::Sync(&upload_log), | |
2140 | &ObjectSchema::new( | |
2141 | "Upload backup log file.", | |
552c2259 | 2142 | &sorted!([ |
255f378a DM |
2143 | ( |
2144 | "snapshot", | |
2145 | false, | |
2146 | &StringSchema::new("Snapshot path.").schema() | |
2147 | ), | |
2148 | ( | |
2149 | "logfile", | |
2150 | false, | |
2151 | &StringSchema::new("The path to the log file you want to upload.").schema() | |
2152 | ), | |
2153 | ( | |
2154 | "repository", | |
2155 | true, | |
2156 | &REPO_URL_SCHEMA | |
2157 | ), | |
2158 | ( | |
ec34f7eb | 2159 | "keyfile", |
255f378a DM |
2160 | true, |
2161 | &StringSchema::new("Path to encryption key. All data will be encrypted using this key.").schema() | |
2162 | ), | |
552c2259 | 2163 | ]), |
255f378a DM |
2164 | ) |
2165 | ); | |
7074a0b3 | 2166 | |
255f378a | 2167 | let upload_log_cmd_def = CliCommand::new(&API_METHOD_UPLOAD_LOG) |
49fddd98 | 2168 | .arg_param(&["snapshot", "logfile"]) |
543a260f | 2169 | .completion_cb("snapshot", complete_backup_snapshot) |
ec34f7eb DM |
2170 | .completion_cb("logfile", tools::complete_file_name) |
2171 | .completion_cb("keyfile", tools::complete_file_name) | |
2172 | .completion_cb("repository", complete_repository); | |
2173 | ||
552c2259 | 2174 | #[sortable] |
255f378a DM |
2175 | const API_METHOD_LIST_BACKUP_GROUPS: ApiMethod = ApiMethod::new( |
2176 | &ApiHandler::Sync(&list_backup_groups), | |
2177 | &ObjectSchema::new( | |
2178 | "List backup groups.", | |
552c2259 | 2179 | &sorted!([ |
255f378a DM |
2180 | ("repository", true, &REPO_URL_SCHEMA), |
2181 | ("output-format", true, &OUTPUT_FORMAT), | |
552c2259 | 2182 | ]), |
255f378a DM |
2183 | ) |
2184 | ); | |
7074a0b3 | 2185 | |
255f378a | 2186 | let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS) |
d0a03d40 | 2187 | .completion_cb("repository", complete_repository); |
41c039e1 | 2188 | |
552c2259 | 2189 | #[sortable] |
255f378a DM |
2190 | const API_METHOD_LIST_SNAPSHOTS: ApiMethod = ApiMethod::new( |
2191 | &ApiHandler::Sync(&list_snapshots), | |
2192 | &ObjectSchema::new( | |
2193 | "List backup snapshots.", | |
552c2259 | 2194 | &sorted!([ |
255f378a DM |
2195 | ("group", true, &StringSchema::new("Backup group.").schema()), |
2196 | ("repository", true, &REPO_URL_SCHEMA), | |
2197 | ("output-format", true, &OUTPUT_FORMAT), | |
552c2259 | 2198 | ]), |
255f378a DM |
2199 | ) |
2200 | ); | |
7074a0b3 | 2201 | |
255f378a | 2202 | let snapshots_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOTS) |
49fddd98 | 2203 | .arg_param(&["group"]) |
024f11bb | 2204 | .completion_cb("group", complete_backup_group) |
d0a03d40 | 2205 | .completion_cb("repository", complete_repository); |
184f17af | 2206 | |
552c2259 | 2207 | #[sortable] |
255f378a DM |
2208 | const API_METHOD_FORGET_SNAPSHOTS: ApiMethod = ApiMethod::new( |
2209 | &ApiHandler::Sync(&forget_snapshots), | |
2210 | &ObjectSchema::new( | |
2211 | "Forget (remove) backup snapshots.", | |
552c2259 | 2212 | &sorted!([ |
255f378a DM |
2213 | ("snapshot", false, &StringSchema::new("Snapshot path.").schema()), |
2214 | ("repository", true, &REPO_URL_SCHEMA), | |
552c2259 | 2215 | ]), |
255f378a DM |
2216 | ) |
2217 | ); | |
7074a0b3 | 2218 | |
255f378a | 2219 | let forget_cmd_def = CliCommand::new(&API_METHOD_FORGET_SNAPSHOTS) |
49fddd98 | 2220 | .arg_param(&["snapshot"]) |
b2388518 | 2221 | .completion_cb("repository", complete_repository) |
543a260f | 2222 | .completion_cb("snapshot", complete_backup_snapshot); |
6f62c924 | 2223 | |
552c2259 | 2224 | #[sortable] |
255f378a DM |
2225 | const API_METHOD_START_GARBAGE_COLLECTION: ApiMethod = ApiMethod::new( |
2226 | &ApiHandler::Sync(&start_garbage_collection), | |
2227 | &ObjectSchema::new( | |
2228 | "Start garbage collection for a specific repository.", | |
552c2259 | 2229 | &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]), |
255f378a DM |
2230 | ) |
2231 | ); | |
7074a0b3 | 2232 | |
255f378a | 2233 | let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION) |
d0a03d40 | 2234 | .completion_cb("repository", complete_repository); |
8cc0d6af | 2235 | |
552c2259 | 2236 | #[sortable] |
255f378a DM |
2237 | const API_METHOD_RESTORE: ApiMethod = ApiMethod::new( |
2238 | &ApiHandler::Sync(&restore), | |
2239 | &ObjectSchema::new( | |
2240 | "Restore backup repository.", | |
552c2259 | 2241 | &sorted!([ |
255f378a DM |
2242 | ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()), |
2243 | ("archive-name", false, &StringSchema::new("Backup archive name.").schema()), | |
2244 | ( | |
2245 | "target", | |
2246 | false, | |
2247 | &StringSchema::new( | |
2248 | r###"Target directory path. Use '-' to write to stdandard output. | |
bf125261 DM |
2249 | |
2250 | We do not extraxt '.pxar' archives when writing to stdandard output. | |
2251 | ||
2252 | "### | |
255f378a DM |
2253 | ).schema() |
2254 | ), | |
2255 | ( | |
46d5aa0a | 2256 | "allow-existing-dirs", |
255f378a DM |
2257 | true, |
2258 | &BooleanSchema::new("Do not fail if directories already exists.") | |
2259 | .default(false) | |
2260 | .schema() | |
2261 | ), | |
2262 | ("repository", true, &REPO_URL_SCHEMA), | |
2263 | ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()), | |
2264 | ( | |
86eda3eb | 2265 | "verbose", |
7074a0b3 | 2266 | true, |
255f378a DM |
2267 | &BooleanSchema::new("Verbose output.") |
2268 | .default(false) | |
2269 | .schema() | |
2270 | ), | |
552c2259 | 2271 | ]), |
255f378a DM |
2272 | ) |
2273 | ); | |
7074a0b3 | 2274 | |
255f378a | 2275 | let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE) |
49fddd98 | 2276 | .arg_param(&["snapshot", "archive-name", "target"]) |
b2388518 | 2277 | .completion_cb("repository", complete_repository) |
08dc340a DM |
2278 | .completion_cb("snapshot", complete_group_or_snapshot) |
2279 | .completion_cb("archive-name", complete_archive_name) | |
2280 | .completion_cb("target", tools::complete_file_name); | |
9f912493 | 2281 | |
552c2259 | 2282 | #[sortable] |
255f378a DM |
2283 | const API_METHOD_LIST_SNAPSHOT_FILES: ApiMethod = ApiMethod::new( |
2284 | &ApiHandler::Sync(&list_snapshot_files), | |
2285 | &ObjectSchema::new( | |
2286 | "List snapshot files.", | |
552c2259 | 2287 | &sorted!([ |
255f378a DM |
2288 | ("snapshot", false, &StringSchema::new("Snapshot path.").schema()), |
2289 | ("repository", true, &REPO_URL_SCHEMA), | |
2290 | ("output-format", true, &OUTPUT_FORMAT), | |
552c2259 | 2291 | ]), |
255f378a DM |
2292 | ) |
2293 | ); | |
7074a0b3 | 2294 | |
255f378a | 2295 | let files_cmd_def = CliCommand::new(&API_METHOD_LIST_SNAPSHOT_FILES) |
49fddd98 | 2296 | .arg_param(&["snapshot"]) |
52c171e4 | 2297 | .completion_cb("repository", complete_repository) |
543a260f | 2298 | .completion_cb("snapshot", complete_backup_snapshot); |
52c171e4 | 2299 | |
255f378a DM |
2300 | const API_METHOD_PRUNE: ApiMethod = ApiMethod::new( |
2301 | &ApiHandler::Sync(&prune), | |
2302 | &ObjectSchema::new( | |
2303 | "Prune backup repository.", | |
552c2259 | 2304 | &proxmox_backup::add_common_prune_prameters!([ |
74fa81b8 DM |
2305 | ("dry-run", true, &BooleanSchema::new( |
2306 | "Just show what prune would do, but do not delete anything.") | |
2307 | .schema()), | |
255f378a | 2308 | ("group", false, &StringSchema::new("Backup group.").schema()), |
552c2259 | 2309 | ], [ |
163e9bbe | 2310 | ("output-format", true, &OUTPUT_FORMAT), |
255f378a | 2311 | ("repository", true, &REPO_URL_SCHEMA), |
552c2259 | 2312 | ]) |
255f378a DM |
2313 | ) |
2314 | ); | |
7074a0b3 | 2315 | |
255f378a | 2316 | let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE) |
49fddd98 | 2317 | .arg_param(&["group"]) |
9fdc3ef4 | 2318 | .completion_cb("group", complete_backup_group) |
d0a03d40 | 2319 | .completion_cb("repository", complete_repository); |
9f912493 | 2320 | |
552c2259 | 2321 | #[sortable] |
255f378a DM |
2322 | const API_METHOD_STATUS: ApiMethod = ApiMethod::new( |
2323 | &ApiHandler::Sync(&status), | |
2324 | &ObjectSchema::new( | |
2325 | "Get repository status.", | |
552c2259 | 2326 | &sorted!([ |
255f378a DM |
2327 | ("repository", true, &REPO_URL_SCHEMA), |
2328 | ("output-format", true, &OUTPUT_FORMAT), | |
552c2259 | 2329 | ]), |
255f378a DM |
2330 | ) |
2331 | ); | |
7074a0b3 | 2332 | |
255f378a | 2333 | let status_cmd_def = CliCommand::new(&API_METHOD_STATUS) |
34a816cc DM |
2334 | .completion_cb("repository", complete_repository); |
2335 | ||
552c2259 | 2336 | #[sortable] |
255f378a DM |
2337 | const API_METHOD_API_LOGIN: ApiMethod = ApiMethod::new( |
2338 | &ApiHandler::Sync(&api_login), | |
2339 | &ObjectSchema::new( | |
2340 | "Try to login. If successful, store ticket.", | |
552c2259 | 2341 | &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]), |
255f378a DM |
2342 | ) |
2343 | ); | |
7074a0b3 | 2344 | |
255f378a | 2345 | let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN) |
e240d8be DM |
2346 | .completion_cb("repository", complete_repository); |
2347 | ||
552c2259 | 2348 | #[sortable] |
255f378a DM |
2349 | const API_METHOD_API_LOGOUT: ApiMethod = ApiMethod::new( |
2350 | &ApiHandler::Sync(&api_logout), | |
2351 | &ObjectSchema::new( | |
2352 | "Logout (delete stored ticket).", | |
552c2259 | 2353 | &sorted!([ ("repository", true, &REPO_URL_SCHEMA) ]), |
255f378a DM |
2354 | ) |
2355 | ); | |
7074a0b3 | 2356 | |
255f378a | 2357 | let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT) |
e240d8be | 2358 | .completion_cb("repository", complete_repository); |
32efac1c | 2359 | |
552c2259 | 2360 | #[sortable] |
255f378a DM |
2361 | const API_METHOD_MOUNT: ApiMethod = ApiMethod::new( |
2362 | &ApiHandler::Sync(&mount), | |
2363 | &ObjectSchema::new( | |
2364 | "Mount pxar archive.", | |
552c2259 | 2365 | &sorted!([ |
255f378a DM |
2366 | ("snapshot", false, &StringSchema::new("Group/Snapshot path.").schema()), |
2367 | ("archive-name", false, &StringSchema::new("Backup archive name.").schema()), | |
2368 | ("target", false, &StringSchema::new("Target directory path.").schema()), | |
2369 | ("repository", true, &REPO_URL_SCHEMA), | |
2370 | ("keyfile", true, &StringSchema::new("Path to encryption key.").schema()), | |
2371 | ("verbose", true, &BooleanSchema::new("Verbose output.").default(false).schema()), | |
552c2259 | 2372 | ]), |
255f378a DM |
2373 | ) |
2374 | ); | |
7074a0b3 | 2375 | |
255f378a | 2376 | let mount_cmd_def = CliCommand::new(&API_METHOD_MOUNT) |
49fddd98 | 2377 | .arg_param(&["snapshot", "archive-name", "target"]) |
70235f72 CE |
2378 | .completion_cb("repository", complete_repository) |
2379 | .completion_cb("snapshot", complete_group_or_snapshot) | |
0ec9e1b0 | 2380 | .completion_cb("archive-name", complete_pxar_archive_name) |
70235f72 | 2381 | .completion_cb("target", tools::complete_file_name); |
e240d8be | 2382 | |
3cf73c4e | 2383 | |
41c039e1 | 2384 | let cmd_def = CliCommandMap::new() |
48ef3c33 DM |
2385 | .insert("backup", backup_cmd_def) |
2386 | .insert("upload-log", upload_log_cmd_def) | |
2387 | .insert("forget", forget_cmd_def) | |
2388 | .insert("garbage-collect", garbage_collect_cmd_def) | |
2389 | .insert("list", list_cmd_def) | |
2390 | .insert("login", login_cmd_def) | |
2391 | .insert("logout", logout_cmd_def) | |
2392 | .insert("prune", prune_cmd_def) | |
2393 | .insert("restore", restore_cmd_def) | |
2394 | .insert("snapshots", snapshots_cmd_def) | |
2395 | .insert("files", files_cmd_def) | |
2396 | .insert("status", status_cmd_def) | |
2397 | .insert("key", key_mgmt_cli()) | |
2398 | .insert("mount", mount_cmd_def) | |
5830c205 DM |
2399 | .insert("catalog", catalog_mgmt_cli()) |
2400 | .insert("task", task_mgmt_cli()); | |
48ef3c33 DM |
2401 | |
2402 | run_cli_command(cmd_def); | |
e9722f8b | 2403 | } |
496a6784 | 2404 | |
e9722f8b WB |
2405 | fn async_main<F: Future>(fut: F) -> <F as Future>::Output { |
2406 | let rt = tokio::runtime::Runtime::new().unwrap(); | |
2407 | let ret = rt.block_on(fut); | |
2408 | rt.shutdown_now(); | |
2409 | ret | |
ff5d3707 | 2410 | } |