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