]> git.proxmox.com Git - proxmox-backup.git/blame - src/bin/proxmox-backup-client.rs
tape: remove MediaLabelInfo, use MediaId instead
[proxmox-backup.git] / src / bin / proxmox-backup-client.rs
CommitLineData
2eeaacb9 1use std::collections::{HashSet, HashMap};
0351f23b
WB
2use std::convert::TryFrom;
3use std::io::{self, Read, Write, Seek, SeekFrom};
4use std::os::unix::io::{FromRawFd, RawFd};
c443f58b
WB
5use std::path::{Path, PathBuf};
6use std::pin::Pin;
7use std::sync::{Arc, Mutex};
a6f87283 8use std::task::Context;
c443f58b
WB
9
10use anyhow::{bail, format_err, Error};
c443f58b 11use futures::future::FutureExt;
c443f58b 12use futures::stream::{StreamExt, TryStreamExt};
c443f58b 13use serde_json::{json, Value};
c443f58b
WB
14use tokio::sync::mpsc;
15use xdg::BaseDirectories;
2761d6a4 16
c443f58b 17use pathpatterns::{MatchEntry, MatchType, PatternFlag};
6a7be83e
DM
18use proxmox::{
19 tools::{
20 time::{strftime_local, epoch_i64},
21 fs::{file_get_contents, file_get_json, replace_file, CreateOptions, image_size},
22 },
23 api::{
24 api,
25 ApiHandler,
26 ApiMethod,
27 RpcEnvironment,
28 schema::*,
29 cli::*,
30 },
31};
a6f87283 32use pxar::accessor::{MaybeReady, ReadAt, ReadAtOperation};
ff5d3707 33
fe0e04c6 34use proxmox_backup::tools;
0224c3c2 35use proxmox_backup::api2::access::user::UserWithTokens;
bbf9e7e9 36use proxmox_backup::api2::types::*;
e39974af 37use proxmox_backup::api2::version;
151c6ce2 38use proxmox_backup::client::*;
c443f58b 39use proxmox_backup::pxar::catalog::*;
4d16badf
WB
40use proxmox_backup::backup::{
41 archive_type,
0351f23b 42 decrypt_key,
4d16badf
WB
43 verify_chunk_size,
44 ArchiveType,
8e6e18b7 45 AsyncReadChunk,
4d16badf
WB
46 BackupDir,
47 BackupGroup,
48 BackupManifest,
49 BufferedDynamicReader,
f28d9088 50 CATALOG_NAME,
4d16badf
WB
51 CatalogReader,
52 CatalogWriter,
4d16badf
WB
53 ChunkStream,
54 CryptConfig,
f28d9088 55 CryptMode,
4d16badf
WB
56 DynamicIndexReader,
57 FixedChunkStream,
58 FixedIndexReader,
59 IndexFile,
4d16badf 60 MANIFEST_BLOB_NAME,
4d16badf
WB
61 Shell,
62};
ae0be2dd 63
caea8d61
DM
64mod proxmox_backup_client;
65use proxmox_backup_client::*;
66
a05c0c6f 67const ENV_VAR_PBS_FINGERPRINT: &str = "PBS_FINGERPRINT";
d1c65727 68const ENV_VAR_PBS_PASSWORD: &str = "PBS_PASSWORD";
a05c0c6f 69
33d64b81 70
caea8d61 71pub const REPO_URL_SCHEMA: Schema = StringSchema::new("Repository URL.")
255f378a
DM
72 .format(&BACKUP_REPO_URL)
73 .max_length(256)
74 .schema();
d0a03d40 75
caea8d61 76pub const KEYFILE_SCHEMA: Schema = StringSchema::new(
a47a02ae
DM
77 "Path to encryption key. All data will be encrypted using this key.")
78 .schema();
79
0351f23b
WB
80pub const KEYFD_SCHEMA: Schema = IntegerSchema::new(
81 "Pass an encryption key via an already opened file descriptor.")
82 .minimum(0)
83 .schema();
84
a47a02ae
DM
85const CHUNK_SIZE_SCHEMA: Schema = IntegerSchema::new(
86 "Chunk size in KB. Must be a power of 2.")
87 .minimum(64)
88 .maximum(4096)
89 .default(4096)
90 .schema();
91
2665cef7
DM
92fn get_default_repository() -> Option<String> {
93 std::env::var("PBS_REPOSITORY").ok()
94}
95
caea8d61 96pub fn extract_repository_from_value(
2665cef7
DM
97 param: &Value,
98) -> Result<BackupRepository, Error> {
99
100 let repo_url = param["repository"]
101 .as_str()
102 .map(String::from)
103 .or_else(get_default_repository)
104 .ok_or_else(|| format_err!("unable to get (default) repository"))?;
105
106 let repo: BackupRepository = repo_url.parse()?;
107
108 Ok(repo)
109}
110
111fn extract_repository_from_map(
112 param: &HashMap<String, String>,
113) -> Option<BackupRepository> {
114
115 param.get("repository")
116 .map(String::from)
117 .or_else(get_default_repository)
118 .and_then(|repo_url| repo_url.parse::<BackupRepository>().ok())
119}
120
d0a03d40
DM
121fn record_repository(repo: &BackupRepository) {
122
123 let base = match BaseDirectories::with_prefix("proxmox-backup") {
124 Ok(v) => v,
125 _ => return,
126 };
127
128 // usually $HOME/.cache/proxmox-backup/repo-list
129 let path = match base.place_cache_file("repo-list") {
130 Ok(v) => v,
131 _ => return,
132 };
133
11377a47 134 let mut data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
d0a03d40
DM
135
136 let repo = repo.to_string();
137
138 data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 };
139
140 let mut map = serde_json::map::Map::new();
141
142 loop {
143 let mut max_used = 0;
144 let mut max_repo = None;
145 for (repo, count) in data.as_object().unwrap() {
146 if map.contains_key(repo) { continue; }
147 if let Some(count) = count.as_i64() {
148 if count > max_used {
149 max_used = count;
150 max_repo = Some(repo);
151 }
152 }
153 }
154 if let Some(repo) = max_repo {
155 map.insert(repo.to_owned(), json!(max_used));
156 } else {
157 break;
158 }
159 if map.len() > 10 { // store max. 10 repos
160 break;
161 }
162 }
163
164 let new_data = json!(map);
165
feaa1ad3 166 let _ = replace_file(path, new_data.to_string().as_bytes(), CreateOptions::new());
d0a03d40
DM
167}
168
43abba4b 169pub fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
d0a03d40
DM
170
171 let mut result = vec![];
172
173 let base = match BaseDirectories::with_prefix("proxmox-backup") {
174 Ok(v) => v,
175 _ => return result,
176 };
177
178 // usually $HOME/.cache/proxmox-backup/repo-list
179 let path = match base.place_cache_file("repo-list") {
180 Ok(v) => v,
181 _ => return result,
182 };
183
11377a47 184 let data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
d0a03d40
DM
185
186 if let Some(map) = data.as_object() {
49811347 187 for (repo, _count) in map {
d0a03d40
DM
188 result.push(repo.to_owned());
189 }
190 }
191
192 result
193}
194
f3fde36b
WB
195fn connect(repo: &BackupRepository) -> Result<HttpClient, Error> {
196 connect_do(repo.host(), repo.port(), repo.auth_id())
197 .map_err(|err| format_err!("error building client for repository {} - {}", repo, err))
198}
d59dbeca 199
f3fde36b 200fn connect_do(server: &str, port: u16, auth_id: &Authid) -> Result<HttpClient, Error> {
a05c0c6f
DM
201 let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
202
d1c65727
DM
203 use std::env::VarError::*;
204 let password = match std::env::var(ENV_VAR_PBS_PASSWORD) {
205 Ok(p) => Some(p),
206 Err(NotUnicode(_)) => bail!(format!("{} contains bad characters", ENV_VAR_PBS_PASSWORD)),
207 Err(NotPresent) => None,
208 };
209
d59dbeca 210 let options = HttpClientOptions::new()
5030b7ce 211 .prefix(Some("proxmox-backup".to_string()))
d1c65727 212 .password(password)
d59dbeca 213 .interactive(true)
a05c0c6f 214 .fingerprint(fingerprint)
5a74756c 215 .fingerprint_cache(true)
d59dbeca
DM
216 .ticket_cache(true);
217
34aa8e13 218 HttpClient::new(server, port, auth_id, options)
d59dbeca
DM
219}
220
d105176f
DM
221async fn view_task_result(
222 client: HttpClient,
223 result: Value,
224 output_format: &str,
225) -> Result<(), Error> {
226 let data = &result["data"];
227 if output_format == "text" {
228 if let Some(upid) = data.as_str() {
229 display_task_log(client, upid, true).await?;
230 }
231 } else {
232 format_and_print_result(&data, &output_format);
233 }
234
235 Ok(())
236}
237
42af4b8f
DM
238async fn api_datastore_list_snapshots(
239 client: &HttpClient,
240 store: &str,
241 group: Option<BackupGroup>,
f24fc116 242) -> Result<Value, Error> {
42af4b8f
DM
243
244 let path = format!("api2/json/admin/datastore/{}/snapshots", store);
245
246 let mut args = json!({});
247 if let Some(group) = group {
248 args["backup-type"] = group.backup_type().into();
249 args["backup-id"] = group.backup_id().into();
250 }
251
252 let mut result = client.get(&path, Some(args)).await?;
253
f24fc116 254 Ok(result["data"].take())
42af4b8f
DM
255}
256
43abba4b 257pub async fn api_datastore_latest_snapshot(
27c9affb
DM
258 client: &HttpClient,
259 store: &str,
260 group: BackupGroup,
6a7be83e 261) -> Result<(String, String, i64), Error> {
27c9affb 262
f24fc116
DM
263 let list = api_datastore_list_snapshots(client, store, Some(group.clone())).await?;
264 let mut list: Vec<SnapshotListItem> = serde_json::from_value(list)?;
27c9affb
DM
265
266 if list.is_empty() {
267 bail!("backup group {:?} does not contain any snapshots.", group.group_path());
268 }
269
270 list.sort_unstable_by(|a, b| b.backup_time.cmp(&a.backup_time));
271
6a7be83e 272 let backup_time = list[0].backup_time;
27c9affb
DM
273
274 Ok((group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time))
275}
276
e9722f8b 277async fn backup_directory<P: AsRef<Path>>(
cf9271e2 278 client: &BackupWriter,
b957aa81 279 previous_manifest: Option<Arc<BackupManifest>>,
17d6979a 280 dir_path: P,
247cdbce 281 archive_name: &str,
36898ffc 282 chunk_size: Option<usize>,
2eeaacb9 283 device_set: Option<HashSet<u64>>,
219ef0e6 284 verbose: bool,
5b72c9b4 285 skip_lost_and_found: bool,
f1d99e3f 286 catalog: Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
c443f58b 287 exclude_pattern: Vec<MatchEntry>,
6fc053ed 288 entries_max: usize,
3638341a
DM
289 compress: bool,
290 encrypt: bool,
2c3891d1 291) -> Result<BackupStats, Error> {
33d64b81 292
6fc053ed
CE
293 let pxar_stream = PxarBackupStream::open(
294 dir_path.as_ref(),
295 device_set,
296 verbose,
297 skip_lost_and_found,
298 catalog,
189996cf 299 exclude_pattern,
6fc053ed
CE
300 entries_max,
301 )?;
e9722f8b 302 let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
ff3d3100 303
e9722f8b 304 let (mut tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
5e7a09be 305
c4ff3dce 306 let stream = rx
e9722f8b 307 .map_err(Error::from);
17d6979a 308
c4ff3dce 309 // spawn chunker inside a separate task so that it can run parallel
e9722f8b 310 tokio::spawn(async move {
db0cb9ce
WB
311 while let Some(v) = chunk_stream.next().await {
312 let _ = tx.send(v).await;
313 }
e9722f8b 314 });
17d6979a 315
e9722f8b 316 let stats = client
3638341a 317 .upload_stream(previous_manifest, archive_name, stream, "dynamic", None, compress, encrypt)
e9722f8b 318 .await?;
bcd879cf 319
2c3891d1 320 Ok(stats)
bcd879cf
DM
321}
322
e9722f8b 323async fn backup_image<P: AsRef<Path>>(
cf9271e2 324 client: &BackupWriter,
b957aa81 325 previous_manifest: Option<Arc<BackupManifest>>,
6af905c1
DM
326 image_path: P,
327 archive_name: &str,
328 image_size: u64,
36898ffc 329 chunk_size: Option<usize>,
3638341a
DM
330 compress: bool,
331 encrypt: bool,
1c0472e8 332 _verbose: bool,
2c3891d1 333) -> Result<BackupStats, Error> {
6af905c1 334
6af905c1
DM
335 let path = image_path.as_ref().to_owned();
336
e9722f8b 337 let file = tokio::fs::File::open(path).await?;
6af905c1 338
db0cb9ce 339 let stream = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
6af905c1
DM
340 .map_err(Error::from);
341
36898ffc 342 let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
6af905c1 343
e9722f8b 344 let stats = client
3638341a 345 .upload_stream(previous_manifest, archive_name, stream, "fixed", Some(image_size), compress, encrypt)
e9722f8b 346 .await?;
6af905c1 347
2c3891d1 348 Ok(stats)
6af905c1
DM
349}
350
a47a02ae
DM
351#[api(
352 input: {
353 properties: {
354 repository: {
355 schema: REPO_URL_SCHEMA,
356 optional: true,
357 },
358 "output-format": {
359 schema: OUTPUT_FORMAT,
360 optional: true,
361 },
362 }
363 }
364)]
365/// List backup groups.
366async fn list_backup_groups(param: Value) -> Result<Value, Error> {
812c6f87 367
c81b2b7c
DM
368 let output_format = get_output_format(&param);
369
2665cef7 370 let repo = extract_repository_from_value(&param)?;
812c6f87 371
f3fde36b 372 let client = connect(&repo)?;
812c6f87 373
d0a03d40 374 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
812c6f87 375
8a8a4703 376 let mut result = client.get(&path, None).await?;
812c6f87 377
d0a03d40
DM
378 record_repository(&repo);
379
c81b2b7c
DM
380 let render_group_path = |_v: &Value, record: &Value| -> Result<String, Error> {
381 let item: GroupListItem = serde_json::from_value(record.to_owned())?;
382 let group = BackupGroup::new(item.backup_type, item.backup_id);
383 Ok(group.group_path().to_str().unwrap().to_owned())
384 };
812c6f87 385
18deda40
DM
386 let render_last_backup = |_v: &Value, record: &Value| -> Result<String, Error> {
387 let item: GroupListItem = serde_json::from_value(record.to_owned())?;
e0e5b442 388 let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.last_backup)?;
18deda40 389 Ok(snapshot.relative_path().to_str().unwrap().to_owned())
c81b2b7c 390 };
812c6f87 391
c81b2b7c
DM
392 let render_files = |_v: &Value, record: &Value| -> Result<String, Error> {
393 let item: GroupListItem = serde_json::from_value(record.to_owned())?;
4939255f 394 Ok(tools::format::render_backup_file_list(&item.files))
c81b2b7c 395 };
812c6f87 396
c81b2b7c
DM
397 let options = default_table_format_options()
398 .sortby("backup-type", false)
399 .sortby("backup-id", false)
400 .column(ColumnConfig::new("backup-id").renderer(render_group_path).header("group"))
18deda40
DM
401 .column(
402 ColumnConfig::new("last-backup")
403 .renderer(render_last_backup)
404 .header("last snapshot")
405 .right_align(false)
406 )
c81b2b7c
DM
407 .column(ColumnConfig::new("backup-count"))
408 .column(ColumnConfig::new("files").renderer(render_files));
ad20d198 409
c81b2b7c 410 let mut data: Value = result["data"].take();
ad20d198 411
c81b2b7c 412 let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_LIST_GROUPS;
812c6f87 413
c81b2b7c 414 format_and_print_result_full(&mut data, info, &output_format, &options);
34a816cc 415
812c6f87
DM
416 Ok(Value::Null)
417}
418
344add38
DW
419#[api(
420 input: {
421 properties: {
422 repository: {
423 schema: REPO_URL_SCHEMA,
424 optional: true,
425 },
426 group: {
427 type: String,
428 description: "Backup group.",
429 },
430 "new-owner": {
e6dc35ac 431 type: Authid,
344add38
DW
432 },
433 }
434 }
435)]
436/// Change owner of a backup group
437async fn change_backup_owner(group: String, mut param: Value) -> Result<(), Error> {
438
439 let repo = extract_repository_from_value(&param)?;
440
f3fde36b 441 let mut client = connect(&repo)?;
344add38
DW
442
443 param.as_object_mut().unwrap().remove("repository");
444
445 let group: BackupGroup = group.parse()?;
446
447 param["backup-type"] = group.backup_type().into();
448 param["backup-id"] = group.backup_id().into();
449
450 let path = format!("api2/json/admin/datastore/{}/change-owner", repo.store());
451 client.post(&path, Some(param)).await?;
452
453 record_repository(&repo);
454
455 Ok(())
456}
457
a47a02ae
DM
458#[api(
459 input: {
460 properties: {
461 repository: {
462 schema: REPO_URL_SCHEMA,
463 optional: true,
464 },
465 }
466 }
467)]
468/// Try to login. If successful, store ticket.
469async fn api_login(param: Value) -> Result<Value, Error> {
e240d8be
DM
470
471 let repo = extract_repository_from_value(&param)?;
472
f3fde36b 473 let client = connect(&repo)?;
8a8a4703 474 client.login().await?;
e240d8be
DM
475
476 record_repository(&repo);
477
478 Ok(Value::Null)
479}
480
a47a02ae
DM
481#[api(
482 input: {
483 properties: {
484 repository: {
485 schema: REPO_URL_SCHEMA,
486 optional: true,
487 },
488 }
489 }
490)]
491/// Logout (delete stored ticket).
492fn api_logout(param: Value) -> Result<Value, Error> {
e240d8be
DM
493
494 let repo = extract_repository_from_value(&param)?;
495
5030b7ce 496 delete_ticket_info("proxmox-backup", repo.host(), repo.user())?;
e240d8be
DM
497
498 Ok(Value::Null)
499}
500
e39974af
TL
501#[api(
502 input: {
503 properties: {
504 repository: {
505 schema: REPO_URL_SCHEMA,
506 optional: true,
507 },
508 "output-format": {
509 schema: OUTPUT_FORMAT,
510 optional: true,
511 },
512 }
513 }
514)]
515/// Show client and optional server version
516async fn api_version(param: Value) -> Result<(), Error> {
517
518 let output_format = get_output_format(&param);
519
520 let mut version_info = json!({
521 "client": {
522 "version": version::PROXMOX_PKG_VERSION,
523 "release": version::PROXMOX_PKG_RELEASE,
524 "repoid": version::PROXMOX_PKG_REPOID,
525 }
526 });
527
528 let repo = extract_repository_from_value(&param);
529 if let Ok(repo) = repo {
f3fde36b 530 let client = connect(&repo)?;
e39974af
TL
531
532 match client.get("api2/json/version", None).await {
533 Ok(mut result) => version_info["server"] = result["data"].take(),
534 Err(e) => eprintln!("could not connect to server - {}", e),
535 }
536 }
537 if output_format == "text" {
538 println!("client version: {}.{}", version::PROXMOX_PKG_VERSION, version::PROXMOX_PKG_RELEASE);
539 if let Some(server) = version_info["server"].as_object() {
540 let server_version = server["version"].as_str().unwrap();
541 let server_release = server["release"].as_str().unwrap();
542 println!("server version: {}.{}", server_version, server_release);
543 }
544 } else {
545 format_and_print_result(&version_info, &output_format);
546 }
547
548 Ok(())
549}
550
a47a02ae 551#[api(
94913f35 552 input: {
a47a02ae
DM
553 properties: {
554 repository: {
555 schema: REPO_URL_SCHEMA,
556 optional: true,
557 },
94913f35
DM
558 "output-format": {
559 schema: OUTPUT_FORMAT,
560 optional: true,
561 },
562 },
563 },
a47a02ae
DM
564)]
565/// Start garbage collection for a specific repository.
566async fn start_garbage_collection(param: Value) -> Result<Value, Error> {
8cc0d6af 567
2665cef7 568 let repo = extract_repository_from_value(&param)?;
c2043614
DM
569
570 let output_format = get_output_format(&param);
8cc0d6af 571
f3fde36b 572 let mut client = connect(&repo)?;
8cc0d6af 573
d0a03d40 574 let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
8cc0d6af 575
8a8a4703 576 let result = client.post(&path, None).await?;
8cc0d6af 577
8a8a4703 578 record_repository(&repo);
d0a03d40 579
8a8a4703 580 view_task_result(client, result, &output_format).await?;
e5f7def4 581
e5f7def4 582 Ok(Value::Null)
8cc0d6af 583}
33d64b81 584
bf6e3217 585fn spawn_catalog_upload(
3bad3e6e 586 client: Arc<BackupWriter>,
3638341a 587 encrypt: bool,
bf6e3217
DM
588) -> Result<
589 (
f1d99e3f 590 Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
bf6e3217
DM
591 tokio::sync::oneshot::Receiver<Result<BackupStats, Error>>
592 ), Error>
593{
f1d99e3f
DM
594 let (catalog_tx, catalog_rx) = std::sync::mpsc::sync_channel(10); // allow to buffer 10 writes
595 let catalog_stream = crate::tools::StdChannelStream(catalog_rx);
bf6e3217
DM
596 let catalog_chunk_size = 512*1024;
597 let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size));
598
f1d99e3f 599 let catalog = Arc::new(Mutex::new(CatalogWriter::new(crate::tools::StdChannelWriter::new(catalog_tx))?));
bf6e3217
DM
600
601 let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel();
602
603 tokio::spawn(async move {
604 let catalog_upload_result = client
3638341a 605 .upload_stream(None, CATALOG_NAME, catalog_chunk_stream, "dynamic", None, true, encrypt)
bf6e3217
DM
606 .await;
607
608 if let Err(ref err) = catalog_upload_result {
609 eprintln!("catalog upload error - {}", err);
610 client.cancel();
611 }
612
613 let _ = catalog_result_tx.send(catalog_upload_result);
614 });
615
616 Ok((catalog, catalog_result_rx))
617}
618
0351f23b 619fn keyfile_parameters(param: &Value) -> Result<(Option<Vec<u8>>, CryptMode), Error> {
f28d9088
WB
620 let keyfile = match param.get("keyfile") {
621 Some(Value::String(keyfile)) => Some(keyfile),
622 Some(_) => bail!("bad --keyfile parameter type"),
623 None => None,
624 };
625
0351f23b
WB
626 let key_fd = match param.get("keyfd") {
627 Some(Value::Number(key_fd)) => Some(
628 RawFd::try_from(key_fd
629 .as_i64()
630 .ok_or_else(|| format_err!("bad key fd: {:?}", key_fd))?
631 )
632 .map_err(|err| format_err!("bad key fd: {:?}: {}", key_fd, err))?
633 ),
634 Some(_) => bail!("bad --keyfd parameter type"),
635 None => None,
636 };
637
f28d9088
WB
638 let crypt_mode: Option<CryptMode> = match param.get("crypt-mode") {
639 Some(mode) => Some(serde_json::from_value(mode.clone())?),
640 None => None,
641 };
642
0351f23b
WB
643 let keydata = match (keyfile, key_fd) {
644 (None, None) => None,
645 (Some(_), Some(_)) => bail!("--keyfile and --keyfd are mutually exclusive"),
beb07279 646 (Some(keyfile), None) => {
490560e0 647 eprintln!("Using encryption key file: {}", keyfile);
beb07279
SI
648 Some(file_get_contents(keyfile)?)
649 },
0351f23b
WB
650 (None, Some(fd)) => {
651 let input = unsafe { std::fs::File::from_raw_fd(fd) };
652 let mut data = Vec::new();
653 let _len: usize = { input }.read_to_end(&mut data)
654 .map_err(|err| {
655 format_err!("error reading encryption key from fd {}: {}", fd, err)
656 })?;
490560e0 657 eprintln!("Using encryption key from file descriptor");
0351f23b
WB
658 Some(data)
659 }
660 };
661
662 Ok(match (keydata, crypt_mode) {
96ee8577 663 // no parameters:
0351f23b 664 (None, None) => match key::read_optional_default_encryption_key()? {
8c6854c8 665 Some(key) => {
490560e0 666 eprintln!("Encrypting with default encryption key!");
8c6854c8
SI
667 (Some(key), CryptMode::Encrypt)
668 },
05389a01
WB
669 None => (None, CryptMode::None),
670 },
96ee8577 671
f28d9088
WB
672 // just --crypt-mode=none
673 (None, Some(CryptMode::None)) => (None, CryptMode::None),
96ee8577 674
f28d9088 675 // just --crypt-mode other than none
0351f23b 676 (None, Some(crypt_mode)) => match key::read_optional_default_encryption_key()? {
f28d9088 677 None => bail!("--crypt-mode without --keyfile and no default key file available"),
beb07279 678 Some(key) => {
490560e0 679 eprintln!("Encrypting with default encryption key!");
beb07279
SI
680 (Some(key), crypt_mode)
681 },
96ee8577
WB
682 }
683
684 // just --keyfile
0351f23b 685 (Some(key), None) => (Some(key), CryptMode::Encrypt),
96ee8577 686
f28d9088
WB
687 // --keyfile and --crypt-mode=none
688 (Some(_), Some(CryptMode::None)) => {
0351f23b 689 bail!("--keyfile/--keyfd and --crypt-mode=none are mutually exclusive");
96ee8577
WB
690 }
691
f28d9088 692 // --keyfile and --crypt-mode other than none
0351f23b 693 (Some(key), Some(crypt_mode)) => (Some(key), crypt_mode),
96ee8577
WB
694 })
695}
696
a47a02ae
DM
697#[api(
698 input: {
699 properties: {
700 backupspec: {
701 type: Array,
702 description: "List of backup source specifications ([<label.ext>:<path>] ...)",
703 items: {
704 schema: BACKUP_SOURCE_SCHEMA,
705 }
706 },
707 repository: {
708 schema: REPO_URL_SCHEMA,
709 optional: true,
710 },
711 "include-dev": {
712 description: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
713 optional: true,
714 items: {
715 type: String,
716 description: "Path to file.",
717 }
718 },
58fcbf5a
FE
719 "all-file-systems": {
720 type: Boolean,
721 description: "Include all mounted subdirectories.",
722 optional: true,
723 },
a47a02ae
DM
724 keyfile: {
725 schema: KEYFILE_SCHEMA,
726 optional: true,
727 },
0351f23b
WB
728 "keyfd": {
729 schema: KEYFD_SCHEMA,
730 optional: true,
731 },
24be37e3
WB
732 "crypt-mode": {
733 type: CryptMode,
96ee8577
WB
734 optional: true,
735 },
a47a02ae
DM
736 "skip-lost-and-found": {
737 type: Boolean,
738 description: "Skip lost+found directory.",
739 optional: true,
740 },
741 "backup-type": {
742 schema: BACKUP_TYPE_SCHEMA,
743 optional: true,
744 },
745 "backup-id": {
746 schema: BACKUP_ID_SCHEMA,
747 optional: true,
748 },
749 "backup-time": {
750 schema: BACKUP_TIME_SCHEMA,
751 optional: true,
752 },
753 "chunk-size": {
754 schema: CHUNK_SIZE_SCHEMA,
755 optional: true,
756 },
189996cf
CE
757 "exclude": {
758 type: Array,
759 description: "List of paths or patterns for matching files to exclude.",
760 optional: true,
761 items: {
762 type: String,
763 description: "Path or match pattern.",
764 }
765 },
6fc053ed
CE
766 "entries-max": {
767 type: Integer,
768 description: "Max number of entries to hold in memory.",
769 optional: true,
c443f58b 770 default: proxmox_backup::pxar::ENCODER_MAX_ENTRIES as isize,
6fc053ed 771 },
e02c3d46
DM
772 "verbose": {
773 type: Boolean,
774 description: "Verbose output.",
775 optional: true,
776 },
a47a02ae
DM
777 }
778 }
779)]
780/// Create (host) backup.
781async fn create_backup(
6049b71f
DM
782 param: Value,
783 _info: &ApiMethod,
dd5495d6 784 _rpcenv: &mut dyn RpcEnvironment,
6049b71f 785) -> Result<Value, Error> {
ff5d3707 786
2665cef7 787 let repo = extract_repository_from_value(&param)?;
ae0be2dd
DM
788
789 let backupspec_list = tools::required_array_param(&param, "backupspec")?;
a914a774 790
eed6db39
DM
791 let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
792
5b72c9b4
DM
793 let skip_lost_and_found = param["skip-lost-and-found"].as_bool().unwrap_or(false);
794
219ef0e6
DM
795 let verbose = param["verbose"].as_bool().unwrap_or(false);
796
ca5d0b61
DM
797 let backup_time_opt = param["backup-time"].as_i64();
798
36898ffc 799 let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize);
2d9d143a 800
247cdbce
DM
801 if let Some(size) = chunk_size_opt {
802 verify_chunk_size(size)?;
2d9d143a
DM
803 }
804
0351f23b 805 let (keydata, crypt_mode) = keyfile_parameters(&param)?;
6d0983db 806
f69adc81 807 let backup_id = param["backup-id"].as_str().unwrap_or(&proxmox::tools::nodename());
fba30411 808
bbf9e7e9 809 let backup_type = param["backup-type"].as_str().unwrap_or("host");
ca5d0b61 810
2eeaacb9
DM
811 let include_dev = param["include-dev"].as_array();
812
c443f58b
WB
813 let entries_max = param["entries-max"].as_u64()
814 .unwrap_or(proxmox_backup::pxar::ENCODER_MAX_ENTRIES as u64);
6fc053ed 815
189996cf 816 let empty = Vec::new();
c443f58b
WB
817 let exclude_args = param["exclude"].as_array().unwrap_or(&empty);
818
239e49f9 819 let mut pattern_list = Vec::with_capacity(exclude_args.len());
c443f58b
WB
820 for entry in exclude_args {
821 let entry = entry.as_str().ok_or_else(|| format_err!("Invalid pattern string slice"))?;
239e49f9 822 pattern_list.push(
c443f58b
WB
823 MatchEntry::parse_pattern(entry, PatternFlag::PATH_NAME, MatchType::Exclude)
824 .map_err(|err| format_err!("invalid exclude pattern entry: {}", err))?
825 );
189996cf
CE
826 }
827
2eeaacb9
DM
828 let mut devices = if all_file_systems { None } else { Some(HashSet::new()) };
829
830 if let Some(include_dev) = include_dev {
831 if all_file_systems {
832 bail!("option 'all-file-systems' conflicts with option 'include-dev'");
833 }
834
835 let mut set = HashSet::new();
836 for path in include_dev {
837 let path = path.as_str().unwrap();
838 let stat = nix::sys::stat::stat(path)
839 .map_err(|err| format_err!("fstat {:?} failed - {}", path, err))?;
840 set.insert(stat.st_dev);
841 }
842 devices = Some(set);
843 }
844
ae0be2dd 845 let mut upload_list = vec![];
f2b4b4b9 846 let mut target_set = HashSet::new();
a914a774 847
ae0be2dd 848 for backupspec in backupspec_list {
7cc3473a
DM
849 let spec = parse_backup_specification(backupspec.as_str().unwrap())?;
850 let filename = &spec.config_string;
851 let target = &spec.archive_name;
bcd879cf 852
f2b4b4b9
SI
853 if target_set.contains(target) {
854 bail!("got target twice: '{}'", target);
855 }
856 target_set.insert(target.to_string());
857
eb1804c5
DM
858 use std::os::unix::fs::FileTypeExt;
859
3fa71727
CE
860 let metadata = std::fs::metadata(filename)
861 .map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?;
eb1804c5 862 let file_type = metadata.file_type();
23bb8780 863
7cc3473a
DM
864 match spec.spec_type {
865 BackupSpecificationType::PXAR => {
ec8a9bb9
DM
866 if !file_type.is_dir() {
867 bail!("got unexpected file type (expected directory)");
868 }
7cc3473a 869 upload_list.push((BackupSpecificationType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
ec8a9bb9 870 }
7cc3473a 871 BackupSpecificationType::IMAGE => {
ec8a9bb9
DM
872 if !(file_type.is_file() || file_type.is_block_device()) {
873 bail!("got unexpected file type (expected file or block device)");
874 }
eb1804c5 875
e18a6c9e 876 let size = image_size(&PathBuf::from(filename))?;
23bb8780 877
ec8a9bb9 878 if size == 0 { bail!("got zero-sized file '{}'", filename); }
ae0be2dd 879
7cc3473a 880 upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
ec8a9bb9 881 }
7cc3473a 882 BackupSpecificationType::CONFIG => {
ec8a9bb9
DM
883 if !file_type.is_file() {
884 bail!("got unexpected file type (expected regular file)");
885 }
7cc3473a 886 upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
ec8a9bb9 887 }
7cc3473a 888 BackupSpecificationType::LOGFILE => {
79679c2d
DM
889 if !file_type.is_file() {
890 bail!("got unexpected file type (expected regular file)");
891 }
7cc3473a 892 upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
ec8a9bb9 893 }
ae0be2dd
DM
894 }
895 }
896
6a7be83e 897 let backup_time = backup_time_opt.unwrap_or_else(|| epoch_i64());
ae0be2dd 898
f3fde36b 899 let client = connect(&repo)?;
d0a03d40
DM
900 record_repository(&repo);
901
6a7be83e 902 println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time)?);
ca5d0b61 903
f69adc81 904 println!("Client name: {}", proxmox::tools::nodename());
ca5d0b61 905
6a7be83e 906 let start_time = std::time::Instant::now();
ca5d0b61 907
6a7be83e 908 println!("Starting backup protocol: {}", strftime_local("%c", epoch_i64())?);
51144821 909
0351f23b 910 let (crypt_config, rsa_encrypted_key) = match keydata {
bb823140 911 None => (None, None),
0351f23b 912 Some(key) => {
6f2626ae
FG
913 let (key, created, fingerprint) = decrypt_key(&key, &key::get_encryption_key_password)?;
914 println!("Encryption key fingerprint: {}", fingerprint);
bb823140
DM
915
916 let crypt_config = CryptConfig::new(key)?;
917
05389a01
WB
918 match key::find_master_pubkey()? {
919 Some(ref path) if path.exists() => {
920 let pem_data = file_get_contents(path)?;
921 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
922 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
6f2626ae
FG
923 println!("Master key '{:?}'", path);
924
05389a01
WB
925 (Some(Arc::new(crypt_config)), Some(enc_key))
926 }
927 _ => (Some(Arc::new(crypt_config)), None),
bb823140 928 }
6d0983db
DM
929 }
930 };
f98ac774 931
8a8a4703
DM
932 let client = BackupWriter::start(
933 client,
b957aa81 934 crypt_config.clone(),
8a8a4703
DM
935 repo.store(),
936 backup_type,
937 &backup_id,
938 backup_time,
939 verbose,
61d7b501 940 false
8a8a4703
DM
941 ).await?;
942
8b7f8d3f
FG
943 let download_previous_manifest = match client.previous_backup_time().await {
944 Ok(Some(backup_time)) => {
945 println!(
946 "Downloading previous manifest ({})",
947 strftime_local("%c", backup_time)?
948 );
949 true
950 }
951 Ok(None) => {
952 println!("No previous manifest available.");
953 false
954 }
955 Err(_) => {
956 // Fallback for outdated server, TODO remove/bubble up with 2.0
957 true
958 }
959 };
960
961 let previous_manifest = if download_previous_manifest {
962 match client.download_previous_manifest().await {
963 Ok(previous_manifest) => {
964 match previous_manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref)) {
965 Ok(()) => Some(Arc::new(previous_manifest)),
966 Err(err) => {
967 println!("Couldn't re-use previous manifest - {}", err);
968 None
969 }
970 }
23f9503a 971 }
8b7f8d3f
FG
972 Err(err) => {
973 println!("Couldn't download previous manifest - {}", err);
974 None
975 }
976 }
977 } else {
978 None
b957aa81
DM
979 };
980
6a7be83e 981 let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?;
8a8a4703
DM
982 let mut manifest = BackupManifest::new(snapshot);
983
5d85847f
DC
984 let mut catalog = None;
985 let mut catalog_result_tx = None;
8a8a4703
DM
986
987 for (backup_type, filename, target, size) in upload_list {
988 match backup_type {
7cc3473a 989 BackupSpecificationType::CONFIG => {
5b32820e 990 println!("Upload config file '{}' to '{}' as {}", filename, repo, target);
8a8a4703 991 let stats = client
3638341a 992 .upload_blob_from_file(&filename, &target, true, crypt_mode == CryptMode::Encrypt)
8a8a4703 993 .await?;
f28d9088 994 manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
8a8a4703 995 }
7cc3473a 996 BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
5b32820e 997 println!("Upload log file '{}' to '{}' as {}", filename, repo, target);
8a8a4703 998 let stats = client
3638341a 999 .upload_blob_from_file(&filename, &target, true, crypt_mode == CryptMode::Encrypt)
8a8a4703 1000 .await?;
f28d9088 1001 manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
8a8a4703 1002 }
7cc3473a 1003 BackupSpecificationType::PXAR => {
5d85847f
DC
1004 // start catalog upload on first use
1005 if catalog.is_none() {
3638341a 1006 let (cat, res) = spawn_catalog_upload(client.clone(), crypt_mode == CryptMode::Encrypt)?;
5d85847f
DC
1007 catalog = Some(cat);
1008 catalog_result_tx = Some(res);
1009 }
1010 let catalog = catalog.as_ref().unwrap();
1011
5b32820e 1012 println!("Upload directory '{}' to '{}' as {}", filename, repo, target);
8a8a4703
DM
1013 catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
1014 let stats = backup_directory(
1015 &client,
b957aa81 1016 previous_manifest.clone(),
8a8a4703
DM
1017 &filename,
1018 &target,
1019 chunk_size_opt,
1020 devices.clone(),
1021 verbose,
1022 skip_lost_and_found,
8a8a4703 1023 catalog.clone(),
239e49f9 1024 pattern_list.clone(),
6fc053ed 1025 entries_max as usize,
3638341a
DM
1026 true,
1027 crypt_mode == CryptMode::Encrypt,
8a8a4703 1028 ).await?;
f28d9088 1029 manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
8a8a4703
DM
1030 catalog.lock().unwrap().end_directory()?;
1031 }
7cc3473a 1032 BackupSpecificationType::IMAGE => {
8a8a4703
DM
1033 println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
1034 let stats = backup_image(
1035 &client,
b957aa81
DM
1036 previous_manifest.clone(),
1037 &filename,
8a8a4703
DM
1038 &target,
1039 size,
1040 chunk_size_opt,
3638341a
DM
1041 true,
1042 crypt_mode == CryptMode::Encrypt,
8a8a4703 1043 verbose,
8a8a4703 1044 ).await?;
f28d9088 1045 manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
6af905c1
DM
1046 }
1047 }
8a8a4703 1048 }
4818c8b6 1049
8a8a4703 1050 // finalize and upload catalog
5d85847f 1051 if let Some(catalog) = catalog {
8a8a4703
DM
1052 let mutex = Arc::try_unwrap(catalog)
1053 .map_err(|_| format_err!("unable to get catalog (still used)"))?;
1054 let mut catalog = mutex.into_inner().unwrap();
bf6e3217 1055
8a8a4703 1056 catalog.finish()?;
2761d6a4 1057
8a8a4703 1058 drop(catalog); // close upload stream
2761d6a4 1059
5d85847f
DC
1060 if let Some(catalog_result_rx) = catalog_result_tx {
1061 let stats = catalog_result_rx.await??;
f28d9088 1062 manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum, crypt_mode)?;
5d85847f 1063 }
8a8a4703 1064 }
2761d6a4 1065
8a8a4703 1066 if let Some(rsa_encrypted_key) = rsa_encrypted_key {
5f76ac37 1067 let target = "rsa-encrypted.key.blob";
8a8a4703
DM
1068 println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
1069 let stats = client
3638341a 1070 .upload_blob_from_data(rsa_encrypted_key, target, false, false)
8a8a4703 1071 .await?;
5f76ac37 1072 manifest.add_file(target.to_string(), stats.size, stats.csum, crypt_mode)?;
8a8a4703
DM
1073
1074 // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
1075 /*
1076 let mut buffer2 = vec![0u8; rsa.size() as usize];
1077 let pem_data = file_get_contents("master-private.pem")?;
1078 let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
1079 let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
1080 println!("TEST {} {:?}", len, buffer2);
1081 */
1082 }
8a8a4703 1083 // create manifest (index.json)
3638341a 1084 // manifests are never encrypted, but include a signature
dfa517ad 1085 let manifest = manifest.to_string(crypt_config.as_ref().map(Arc::as_ref))
b53f6379 1086 .map_err(|err| format_err!("unable to format manifest - {}", err))?;
3638341a 1087
b53f6379 1088
9688f6de 1089 if verbose { println!("Upload index.json to '{}'", repo) };
8a8a4703 1090 client
b53f6379 1091 .upload_blob_from_data(manifest.into_bytes(), MANIFEST_BLOB_NAME, true, false)
8a8a4703 1092 .await?;
2c3891d1 1093
8a8a4703 1094 client.finish().await?;
c4ff3dce 1095
6a7be83e
DM
1096 let end_time = std::time::Instant::now();
1097 let elapsed = end_time.duration_since(start_time);
1098 println!("Duration: {:.2}s", elapsed.as_secs_f64());
3ec3ec3f 1099
6a7be83e 1100 println!("End Time: {}", strftime_local("%c", epoch_i64())?);
3d5c11e5 1101
8a8a4703 1102 Ok(Value::Null)
f98ea63d
DM
1103}
1104
d0a03d40 1105fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
f98ea63d
DM
1106
1107 let mut result = vec![];
1108
1109 let data: Vec<&str> = arg.splitn(2, ':').collect();
1110
bff11030 1111 if data.len() != 2 {
8968258b
DM
1112 result.push(String::from("root.pxar:/"));
1113 result.push(String::from("etc.pxar:/etc"));
bff11030
DM
1114 return result;
1115 }
f98ea63d 1116
496a6784 1117 let files = tools::complete_file_name(data[1], param);
f98ea63d
DM
1118
1119 for file in files {
1120 result.push(format!("{}:{}", data[0], file));
1121 }
1122
1123 result
ff5d3707 1124}
1125
8e6e18b7 1126async fn dump_image<W: Write>(
88892ea8
DM
1127 client: Arc<BackupReader>,
1128 crypt_config: Option<Arc<CryptConfig>>,
14f6c9cb 1129 crypt_mode: CryptMode,
88892ea8
DM
1130 index: FixedIndexReader,
1131 mut writer: W,
fd04ca7a 1132 verbose: bool,
88892ea8
DM
1133) -> Result<(), Error> {
1134
1135 let most_used = index.find_most_used_chunks(8);
1136
14f6c9cb 1137 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, crypt_mode, most_used);
88892ea8
DM
1138
1139 // Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
1140 // and thus slows down reading. Instead, directly use RemoteChunkReader
fd04ca7a
DM
1141 let mut per = 0;
1142 let mut bytes = 0;
1143 let start_time = std::time::Instant::now();
1144
88892ea8
DM
1145 for pos in 0..index.index_count() {
1146 let digest = index.index_digest(pos).unwrap();
8e6e18b7 1147 let raw_data = chunk_reader.read_chunk(&digest).await?;
88892ea8 1148 writer.write_all(&raw_data)?;
fd04ca7a
DM
1149 bytes += raw_data.len();
1150 if verbose {
1151 let next_per = ((pos+1)*100)/index.index_count();
1152 if per != next_per {
1153 eprintln!("progress {}% (read {} bytes, duration {} sec)",
1154 next_per, bytes, start_time.elapsed().as_secs());
1155 per = next_per;
1156 }
1157 }
88892ea8
DM
1158 }
1159
fd04ca7a
DM
1160 let end_time = std::time::Instant::now();
1161 let elapsed = end_time.duration_since(start_time);
1162 eprintln!("restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)",
1163 bytes,
1164 elapsed.as_secs_f64(),
1165 bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
1166 );
1167
1168
88892ea8
DM
1169 Ok(())
1170}
1171
dc155e9b 1172fn parse_archive_type(name: &str) -> (String, ArchiveType) {
2d32fe2c
TL
1173 if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
1174 (name.into(), archive_type(name).unwrap())
1175 } else if name.ends_with(".pxar") {
dc155e9b
TL
1176 (format!("{}.didx", name), ArchiveType::DynamicIndex)
1177 } else if name.ends_with(".img") {
1178 (format!("{}.fidx", name), ArchiveType::FixedIndex)
1179 } else {
1180 (format!("{}.blob", name), ArchiveType::Blob)
1181 }
1182}
1183
a47a02ae
DM
1184#[api(
1185 input: {
1186 properties: {
1187 repository: {
1188 schema: REPO_URL_SCHEMA,
1189 optional: true,
1190 },
1191 snapshot: {
1192 type: String,
1193 description: "Group/Snapshot path.",
1194 },
1195 "archive-name": {
1196 description: "Backup archive name.",
1197 type: String,
1198 },
1199 target: {
1200 type: String,
90c815bf 1201 description: r###"Target directory path. Use '-' to write to standard output.
8a8a4703 1202
5eee6d89 1203We do not extraxt '.pxar' archives when writing to standard output.
8a8a4703 1204
a47a02ae
DM
1205"###
1206 },
1207 "allow-existing-dirs": {
1208 type: Boolean,
1209 description: "Do not fail if directories already exists.",
1210 optional: true,
1211 },
1212 keyfile: {
1213 schema: KEYFILE_SCHEMA,
1214 optional: true,
1215 },
0351f23b
WB
1216 "keyfd": {
1217 schema: KEYFD_SCHEMA,
1218 optional: true,
1219 },
24be37e3
WB
1220 "crypt-mode": {
1221 type: CryptMode,
96ee8577
WB
1222 optional: true,
1223 },
a47a02ae
DM
1224 }
1225 }
1226)]
1227/// Restore backup repository.
1228async fn restore(param: Value) -> Result<Value, Error> {
2665cef7 1229 let repo = extract_repository_from_value(&param)?;
9f912493 1230
86eda3eb
DM
1231 let verbose = param["verbose"].as_bool().unwrap_or(false);
1232
46d5aa0a
DM
1233 let allow_existing_dirs = param["allow-existing-dirs"].as_bool().unwrap_or(false);
1234
d5c34d98
DM
1235 let archive_name = tools::required_string_param(&param, "archive-name")?;
1236
f3fde36b 1237 let client = connect(&repo)?;
d0a03d40 1238
d0a03d40 1239 record_repository(&repo);
d5c34d98 1240
9f912493 1241 let path = tools::required_string_param(&param, "snapshot")?;
9f912493 1242
86eda3eb 1243 let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
d6d3b353 1244 let group: BackupGroup = path.parse()?;
27c9affb 1245 api_datastore_latest_snapshot(&client, repo.store(), group).await?
d5c34d98 1246 } else {
a67f7d0a 1247 let snapshot: BackupDir = path.parse()?;
86eda3eb
DM
1248 (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
1249 };
9f912493 1250
d5c34d98 1251 let target = tools::required_string_param(&param, "target")?;
bf125261 1252 let target = if target == "-" { None } else { Some(target) };
2ae7d196 1253
0351f23b 1254 let (keydata, _crypt_mode) = keyfile_parameters(&param)?;
2ae7d196 1255
0351f23b 1256 let crypt_config = match keydata {
86eda3eb 1257 None => None,
0351f23b 1258 Some(key) => {
6f2626ae 1259 let (key, _, fingerprint) = decrypt_key(&key, &key::get_encryption_key_password)?;
490560e0 1260 eprintln!("Encryption key fingerprint: '{}'", fingerprint);
86eda3eb
DM
1261 Some(Arc::new(CryptConfig::new(key)?))
1262 }
1263 };
d5c34d98 1264
296c50ba
DM
1265 let client = BackupReader::start(
1266 client,
1267 crypt_config.clone(),
1268 repo.store(),
1269 &backup_type,
1270 &backup_id,
1271 backup_time,
1272 true,
1273 ).await?;
86eda3eb 1274
2107a5ae 1275 let (manifest, backup_index_data) = client.download_manifest().await?;
23f9503a 1276 manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref))?;
02fcf372 1277
dc155e9b
TL
1278 let (archive_name, archive_type) = parse_archive_type(archive_name);
1279
1280 if archive_name == MANIFEST_BLOB_NAME {
02fcf372 1281 if let Some(target) = target {
2107a5ae 1282 replace_file(target, &backup_index_data, CreateOptions::new())?;
02fcf372
DM
1283 } else {
1284 let stdout = std::io::stdout();
1285 let mut writer = stdout.lock();
2107a5ae 1286 writer.write_all(&backup_index_data)
02fcf372
DM
1287 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1288 }
1289
14f6c9cb
FG
1290 return Ok(Value::Null);
1291 }
1292
1293 let file_info = manifest.lookup_file_info(&archive_name)?;
1294
1295 if archive_type == ArchiveType::Blob {
d2267b11 1296
dc155e9b 1297 let mut reader = client.download_blob(&manifest, &archive_name).await?;
f8100e96 1298
bf125261 1299 if let Some(target) = target {
0d986280
DM
1300 let mut writer = std::fs::OpenOptions::new()
1301 .write(true)
1302 .create(true)
1303 .create_new(true)
1304 .open(target)
1305 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?;
1306 std::io::copy(&mut reader, &mut writer)?;
bf125261
DM
1307 } else {
1308 let stdout = std::io::stdout();
1309 let mut writer = stdout.lock();
0d986280 1310 std::io::copy(&mut reader, &mut writer)
bf125261
DM
1311 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1312 }
f8100e96 1313
dc155e9b 1314 } else if archive_type == ArchiveType::DynamicIndex {
86eda3eb 1315
dc155e9b 1316 let index = client.download_dynamic_index(&manifest, &archive_name).await?;
df65bd3d 1317
f4bf7dfc
DM
1318 let most_used = index.find_most_used_chunks(8);
1319
14f6c9cb 1320 let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, file_info.chunk_crypt_mode(), most_used);
f4bf7dfc 1321
afb4cd28 1322 let mut reader = BufferedDynamicReader::new(index, chunk_reader);
86eda3eb 1323
bf125261 1324 if let Some(target) = target {
c443f58b
WB
1325 proxmox_backup::pxar::extract_archive(
1326 pxar::decoder::Decoder::from_std(reader)?,
1327 Path::new(target),
1328 &[],
d44185c4 1329 true,
5444fa94 1330 proxmox_backup::pxar::Flags::DEFAULT,
c443f58b
WB
1331 allow_existing_dirs,
1332 |path| {
1333 if verbose {
1334 println!("{:?}", path);
1335 }
1336 },
d9b8e2c7 1337 None,
c443f58b
WB
1338 )
1339 .map_err(|err| format_err!("error extracting archive - {}", err))?;
bf125261 1340 } else {
88892ea8
DM
1341 let mut writer = std::fs::OpenOptions::new()
1342 .write(true)
1343 .open("/dev/stdout")
1344 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?;
afb4cd28 1345
bf125261
DM
1346 std::io::copy(&mut reader, &mut writer)
1347 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
1348 }
dc155e9b 1349 } else if archive_type == ArchiveType::FixedIndex {
afb4cd28 1350
dc155e9b 1351 let index = client.download_fixed_index(&manifest, &archive_name).await?;
df65bd3d 1352
88892ea8
DM
1353 let mut writer = if let Some(target) = target {
1354 std::fs::OpenOptions::new()
bf125261
DM
1355 .write(true)
1356 .create(true)
1357 .create_new(true)
1358 .open(target)
88892ea8 1359 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?
bf125261 1360 } else {
88892ea8
DM
1361 std::fs::OpenOptions::new()
1362 .write(true)
1363 .open("/dev/stdout")
1364 .map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?
1365 };
afb4cd28 1366
14f6c9cb 1367 dump_image(client.clone(), crypt_config.clone(), file_info.chunk_crypt_mode(), index, &mut writer, verbose).await?;
3031e44c 1368 }
fef44d4f
DM
1369
1370 Ok(Value::Null)
45db6f89
DM
1371}
1372
032d3ad8
DM
1373const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
1374 &ApiHandler::Async(&prune),
1375 &ObjectSchema::new(
1376 "Prune a backup repository.",
1377 &proxmox_backup::add_common_prune_prameters!([
1378 ("dry-run", true, &BooleanSchema::new(
1379 "Just show what prune would do, but do not delete anything.")
1380 .schema()),
1381 ("group", false, &StringSchema::new("Backup group.").schema()),
1382 ], [
1383 ("output-format", true, &OUTPUT_FORMAT),
c48aa39f
DM
1384 (
1385 "quiet",
1386 true,
1387 &BooleanSchema::new("Minimal output - only show removals.")
1388 .schema()
1389 ),
032d3ad8
DM
1390 ("repository", true, &REPO_URL_SCHEMA),
1391 ])
1392 )
1393);
1394
1395fn prune<'a>(
1396 param: Value,
1397 _info: &ApiMethod,
1398 _rpcenv: &'a mut dyn RpcEnvironment,
1399) -> proxmox::api::ApiFuture<'a> {
1400 async move {
1401 prune_async(param).await
1402 }.boxed()
1403}
83b7db02 1404
032d3ad8 1405async fn prune_async(mut param: Value) -> Result<Value, Error> {
2665cef7 1406 let repo = extract_repository_from_value(&param)?;
83b7db02 1407
f3fde36b 1408 let mut client = connect(&repo)?;
83b7db02 1409
d0a03d40 1410 let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
83b7db02 1411
9fdc3ef4 1412 let group = tools::required_string_param(&param, "group")?;
d6d3b353 1413 let group: BackupGroup = group.parse()?;
c2043614
DM
1414
1415 let output_format = get_output_format(&param);
9fdc3ef4 1416
c48aa39f
DM
1417 let quiet = param["quiet"].as_bool().unwrap_or(false);
1418
ea7a7ef2
DM
1419 param.as_object_mut().unwrap().remove("repository");
1420 param.as_object_mut().unwrap().remove("group");
163e9bbe 1421 param.as_object_mut().unwrap().remove("output-format");
c48aa39f 1422 param.as_object_mut().unwrap().remove("quiet");
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())?;
e0e5b442 1433 let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time)?;
db1e061d
DM
1434 Ok(snapshot.relative_path().to_str().unwrap().to_owned())
1435 };
1436
c48aa39f
DM
1437 let render_prune_action = |v: &Value, _record: &Value| -> Result<String, Error> {
1438 Ok(match v.as_bool() {
1439 Some(true) => "keep",
1440 Some(false) => "remove",
1441 None => "unknown",
1442 }.to_string())
1443 };
1444
db1e061d
DM
1445 let options = default_table_format_options()
1446 .sortby("backup-type", false)
1447 .sortby("backup-id", false)
1448 .sortby("backup-time", false)
1449 .column(ColumnConfig::new("backup-id").renderer(render_snapshot_path).header("snapshot"))
74f7240b 1450 .column(ColumnConfig::new("backup-time").renderer(tools::format::render_epoch).header("date"))
c48aa39f 1451 .column(ColumnConfig::new("keep").renderer(render_prune_action).header("action"))
db1e061d
DM
1452 ;
1453
1454 let info = &proxmox_backup::api2::admin::datastore::API_RETURN_SCHEMA_PRUNE;
1455
1456 let mut data = result["data"].take();
1457
c48aa39f
DM
1458 if quiet {
1459 let list: Vec<Value> = data.as_array().unwrap().iter().filter(|item| {
1460 item["keep"].as_bool() == Some(false)
1461 }).map(|v| v.clone()).collect();
1462 data = list.into();
1463 }
1464
db1e061d 1465 format_and_print_result_full(&mut data, info, &output_format, &options);
d0a03d40 1466
43a406fd 1467 Ok(Value::Null)
83b7db02
DM
1468}
1469
a47a02ae
DM
1470#[api(
1471 input: {
1472 properties: {
1473 repository: {
1474 schema: REPO_URL_SCHEMA,
1475 optional: true,
1476 },
1477 "output-format": {
1478 schema: OUTPUT_FORMAT,
1479 optional: true,
1480 },
1481 }
f9beae9c
TL
1482 },
1483 returns: {
1484 type: StorageStatus,
1485 },
a47a02ae
DM
1486)]
1487/// Get repository status.
1488async fn status(param: Value) -> Result<Value, Error> {
34a816cc
DM
1489
1490 let repo = extract_repository_from_value(&param)?;
1491
c2043614 1492 let output_format = get_output_format(&param);
34a816cc 1493
f3fde36b 1494 let client = connect(&repo)?;
34a816cc
DM
1495
1496 let path = format!("api2/json/admin/datastore/{}/status", repo.store());
1497
1dc117bb 1498 let mut result = client.get(&path, None).await?;
14e08625 1499 let mut data = result["data"].take();
34a816cc
DM
1500
1501 record_repository(&repo);
1502
390c5bdd
DM
1503 let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
1504 let v = v.as_u64().unwrap();
1505 let total = record["total"].as_u64().unwrap();
1506 let roundup = total/200;
1507 let per = ((v+roundup)*100)/total;
e23f5863
DM
1508 let info = format!(" ({} %)", per);
1509 Ok(format!("{} {:>8}", v, info))
390c5bdd 1510 };
1dc117bb 1511
c2043614 1512 let options = default_table_format_options()
be2425ff 1513 .noheader(true)
e23f5863 1514 .column(ColumnConfig::new("total").renderer(render_total_percentage))
390c5bdd
DM
1515 .column(ColumnConfig::new("used").renderer(render_total_percentage))
1516 .column(ColumnConfig::new("avail").renderer(render_total_percentage));
34a816cc 1517
f9beae9c 1518 let schema = &API_RETURN_SCHEMA_STATUS;
390c5bdd
DM
1519
1520 format_and_print_result_full(&mut data, schema, &output_format, &options);
34a816cc
DM
1521
1522 Ok(Value::Null)
1523}
1524
5a2df000 1525// like get, but simply ignore errors and return Null instead
e9722f8b 1526async fn try_get(repo: &BackupRepository, url: &str) -> Value {
024f11bb 1527
a05c0c6f 1528 let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
d1c65727 1529 let password = std::env::var(ENV_VAR_PBS_PASSWORD).ok();
a05c0c6f 1530
d59dbeca 1531 let options = HttpClientOptions::new()
5030b7ce 1532 .prefix(Some("proxmox-backup".to_string()))
d1c65727 1533 .password(password)
d59dbeca 1534 .interactive(false)
a05c0c6f 1535 .fingerprint(fingerprint)
5a74756c 1536 .fingerprint_cache(true)
d59dbeca
DM
1537 .ticket_cache(true);
1538
34aa8e13 1539 let client = match HttpClient::new(repo.host(), repo.port(), repo.auth_id(), options) {
45cdce06
DM
1540 Ok(v) => v,
1541 _ => return Value::Null,
1542 };
b2388518 1543
e9722f8b 1544 let mut resp = match client.get(url, None).await {
b2388518
DM
1545 Ok(v) => v,
1546 _ => return Value::Null,
1547 };
1548
1549 if let Some(map) = resp.as_object_mut() {
1550 if let Some(data) = map.remove("data") {
1551 return data;
1552 }
1553 }
1554 Value::Null
1555}
1556
b2388518 1557fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
3f06d6fb 1558 proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
e9722f8b
WB
1559}
1560
1561async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
024f11bb 1562
b2388518
DM
1563 let mut result = vec![];
1564
2665cef7 1565 let repo = match extract_repository_from_map(param) {
b2388518 1566 Some(v) => v,
024f11bb
DM
1567 _ => return result,
1568 };
1569
b2388518
DM
1570 let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
1571
e9722f8b 1572 let data = try_get(&repo, &path).await;
b2388518
DM
1573
1574 if let Some(list) = data.as_array() {
024f11bb 1575 for item in list {
98f0b972
DM
1576 if let (Some(backup_id), Some(backup_type)) =
1577 (item["backup-id"].as_str(), item["backup-type"].as_str())
1578 {
1579 result.push(format!("{}/{}", backup_type, backup_id));
024f11bb
DM
1580 }
1581 }
1582 }
1583
1584 result
1585}
1586
43abba4b 1587pub fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
3f06d6fb 1588 proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
e9722f8b
WB
1589}
1590
1591async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
b2388518 1592
b2388518 1593 if arg.matches('/').count() < 2 {
e9722f8b 1594 let groups = complete_backup_group_do(param).await;
543a260f 1595 let mut result = vec![];
b2388518
DM
1596 for group in groups {
1597 result.push(group.to_string());
1598 result.push(format!("{}/", group));
1599 }
1600 return result;
1601 }
1602
e9722f8b 1603 complete_backup_snapshot_do(param).await
543a260f 1604}
b2388518 1605
3fb53e07 1606fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
3f06d6fb 1607 proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
e9722f8b
WB
1608}
1609
1610async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
543a260f
DM
1611
1612 let mut result = vec![];
1613
1614 let repo = match extract_repository_from_map(param) {
1615 Some(v) => v,
1616 _ => return result,
1617 };
1618
1619 let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
b2388518 1620
e9722f8b 1621 let data = try_get(&repo, &path).await;
b2388518
DM
1622
1623 if let Some(list) = data.as_array() {
1624 for item in list {
1625 if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1626 (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64())
1627 {
e0e5b442
FG
1628 if let Ok(snapshot) = BackupDir::new(backup_type, backup_id, backup_time) {
1629 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1630 }
b2388518
DM
1631 }
1632 }
1633 }
1634
1635 result
1636}
1637
45db6f89 1638fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
3f06d6fb 1639 proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
e9722f8b
WB
1640}
1641
1642async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
08dc340a
DM
1643
1644 let mut result = vec![];
1645
2665cef7 1646 let repo = match extract_repository_from_map(param) {
08dc340a
DM
1647 Some(v) => v,
1648 _ => return result,
1649 };
1650
a67f7d0a 1651 let snapshot: BackupDir = match param.get("snapshot") {
08dc340a 1652 Some(path) => {
a67f7d0a 1653 match path.parse() {
08dc340a
DM
1654 Ok(v) => v,
1655 _ => return result,
1656 }
1657 }
1658 _ => return result,
1659 };
1660
1661 let query = tools::json_object_to_query(json!({
1662 "backup-type": snapshot.group().backup_type(),
1663 "backup-id": snapshot.group().backup_id(),
6a7be83e 1664 "backup-time": snapshot.backup_time(),
08dc340a
DM
1665 })).unwrap();
1666
1667 let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query);
1668
e9722f8b 1669 let data = try_get(&repo, &path).await;
08dc340a
DM
1670
1671 if let Some(list) = data.as_array() {
1672 for item in list {
c4f025eb 1673 if let Some(filename) = item["filename"].as_str() {
08dc340a
DM
1674 result.push(filename.to_owned());
1675 }
1676 }
1677 }
1678
45db6f89
DM
1679 result
1680}
1681
1682fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
52c171e4 1683 complete_server_file_name(arg, param)
e9722f8b 1684 .iter()
708fab30 1685 .map(|v| tools::format::strip_server_file_extension(&v))
e9722f8b 1686 .collect()
08dc340a
DM
1687}
1688
43abba4b 1689pub fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
0ec9e1b0
DM
1690 complete_server_file_name(arg, param)
1691 .iter()
2995aedf
DM
1692 .filter_map(|name| {
1693 if name.ends_with(".pxar.didx") {
708fab30 1694 Some(tools::format::strip_server_file_extension(name))
2995aedf
DM
1695 } else {
1696 None
1697 }
1698 })
1699 .collect()
1700}
1701
1702pub fn complete_img_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1703 complete_server_file_name(arg, param)
1704 .iter()
1705 .filter_map(|name| {
1706 if name.ends_with(".img.fidx") {
708fab30 1707 Some(tools::format::strip_server_file_extension(name))
0ec9e1b0
DM
1708 } else {
1709 None
1710 }
1711 })
1712 .collect()
1713}
1714
49811347
DM
1715fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1716
1717 let mut result = vec![];
1718
1719 let mut size = 64;
1720 loop {
1721 result.push(size.to_string());
11377a47 1722 size *= 2;
49811347
DM
1723 if size > 4096 { break; }
1724 }
1725
1726 result
1727}
1728
0224c3c2
FG
1729fn complete_auth_id(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1730 proxmox_backup::tools::runtime::main(async { complete_auth_id_do(param).await })
1731}
1732
1733async fn complete_auth_id_do(param: &HashMap<String, String>) -> Vec<String> {
1734
1735 let mut result = vec![];
1736
1737 let repo = match extract_repository_from_map(param) {
1738 Some(v) => v,
1739 _ => return result,
1740 };
1741
1742 let data = try_get(&repo, "api2/json/access/users?include_tokens=true").await;
1743
1744 if let Ok(parsed) = serde_json::from_value::<Vec<UserWithTokens>>(data) {
1745 for user in parsed {
1746 result.push(user.userid.to_string());
1747 for token in user.tokens {
1748 result.push(token.tokenid.to_string());
1749 }
1750 }
1751 };
1752
1753 result
1754}
1755
c443f58b
WB
1756use proxmox_backup::client::RemoteChunkReader;
1757/// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
1758/// async use!
1759///
1760/// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
1761/// so that we can properly access it from multiple threads simultaneously while not issuing
1762/// duplicate simultaneous reads over http.
43abba4b 1763pub struct BufferedDynamicReadAt {
c443f58b
WB
1764 inner: Mutex<BufferedDynamicReader<RemoteChunkReader>>,
1765}
1766
1767impl BufferedDynamicReadAt {
1768 fn new(inner: BufferedDynamicReader<RemoteChunkReader>) -> Self {
1769 Self {
1770 inner: Mutex::new(inner),
1771 }
1772 }
1773}
1774
a6f87283
WB
1775impl ReadAt for BufferedDynamicReadAt {
1776 fn start_read_at<'a>(
1777 self: Pin<&'a Self>,
c443f58b 1778 _cx: &mut Context,
a6f87283 1779 buf: &'a mut [u8],
c443f58b 1780 offset: u64,
a6f87283 1781 ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
a6f87283 1782 MaybeReady::Ready(tokio::task::block_in_place(move || {
c443f58b
WB
1783 let mut reader = self.inner.lock().unwrap();
1784 reader.seek(SeekFrom::Start(offset))?;
a6f87283
WB
1785 Ok(reader.read(buf)?)
1786 }))
1787 }
1788
1789 fn poll_complete<'a>(
1790 self: Pin<&'a Self>,
1791 _op: ReadAtOperation<'a>,
1792 ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
1793 panic!("LocalDynamicReadAt::start_read_at returned Pending");
c443f58b
WB
1794 }
1795}
1796
f2401311 1797fn main() {
33d64b81 1798
255f378a 1799 let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
49fddd98 1800 .arg_param(&["backupspec"])
d0a03d40 1801 .completion_cb("repository", complete_repository)
49811347 1802 .completion_cb("backupspec", complete_backup_source)
6d0983db 1803 .completion_cb("keyfile", tools::complete_file_name)
49811347 1804 .completion_cb("chunk-size", complete_chunk_size);
f8838fe9 1805
caea8d61
DM
1806 let benchmark_cmd_def = CliCommand::new(&API_METHOD_BENCHMARK)
1807 .completion_cb("repository", complete_repository)
1808 .completion_cb("keyfile", tools::complete_file_name);
1809
255f378a 1810 let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
d0a03d40 1811 .completion_cb("repository", complete_repository);
41c039e1 1812
255f378a 1813 let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
d0a03d40 1814 .completion_cb("repository", complete_repository);
8cc0d6af 1815
255f378a 1816 let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
49fddd98 1817 .arg_param(&["snapshot", "archive-name", "target"])
b2388518 1818 .completion_cb("repository", complete_repository)
08dc340a
DM
1819 .completion_cb("snapshot", complete_group_or_snapshot)
1820 .completion_cb("archive-name", complete_archive_name)
1821 .completion_cb("target", tools::complete_file_name);
9f912493 1822
255f378a 1823 let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
49fddd98 1824 .arg_param(&["group"])
9fdc3ef4 1825 .completion_cb("group", complete_backup_group)
d0a03d40 1826 .completion_cb("repository", complete_repository);
9f912493 1827
255f378a 1828 let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
34a816cc
DM
1829 .completion_cb("repository", complete_repository);
1830
255f378a 1831 let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
e240d8be
DM
1832 .completion_cb("repository", complete_repository);
1833
255f378a 1834 let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
e240d8be 1835 .completion_cb("repository", complete_repository);
32efac1c 1836
e39974af
TL
1837 let version_cmd_def = CliCommand::new(&API_METHOD_API_VERSION)
1838 .completion_cb("repository", complete_repository);
1839
344add38
DW
1840 let change_owner_cmd_def = CliCommand::new(&API_METHOD_CHANGE_BACKUP_OWNER)
1841 .arg_param(&["group", "new-owner"])
1842 .completion_cb("group", complete_backup_group)
0224c3c2 1843 .completion_cb("new-owner", complete_auth_id)
344add38
DW
1844 .completion_cb("repository", complete_repository);
1845
41c039e1 1846 let cmd_def = CliCommandMap::new()
48ef3c33 1847 .insert("backup", backup_cmd_def)
48ef3c33
DM
1848 .insert("garbage-collect", garbage_collect_cmd_def)
1849 .insert("list", list_cmd_def)
1850 .insert("login", login_cmd_def)
1851 .insert("logout", logout_cmd_def)
1852 .insert("prune", prune_cmd_def)
1853 .insert("restore", restore_cmd_def)
a65e3e4b 1854 .insert("snapshot", snapshot_mgtm_cli())
48ef3c33 1855 .insert("status", status_cmd_def)
9696f519 1856 .insert("key", key::cli())
43abba4b 1857 .insert("mount", mount_cmd_def())
45f9b32e
SR
1858 .insert("map", map_cmd_def())
1859 .insert("unmap", unmap_cmd_def())
5830c205 1860 .insert("catalog", catalog_mgmt_cli())
caea8d61 1861 .insert("task", task_mgmt_cli())
e39974af 1862 .insert("version", version_cmd_def)
344add38 1863 .insert("benchmark", benchmark_cmd_def)
731eeef2
DM
1864 .insert("change-owner", change_owner_cmd_def)
1865
61205f00 1866 .alias(&["files"], &["snapshot", "files"])
edebd523 1867 .alias(&["forget"], &["snapshot", "forget"])
0c9209b0 1868 .alias(&["upload-log"], &["snapshot", "upload-log"])
731eeef2
DM
1869 .alias(&["snapshots"], &["snapshot", "list"])
1870 ;
48ef3c33 1871
7b22acd0
DM
1872 let rpcenv = CliEnvironment::new();
1873 run_cli_command(cmd_def, rpcenv, Some(|future| {
d08bc483
DM
1874 proxmox_backup::tools::runtime::main(future)
1875 }));
ff5d3707 1876}