src/bin/proxmox-backup-client.rs

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