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