src/bin/proxmox-backup-client.rs

   1 //#[macro_use]
   2 extern crate proxmox_backup;
   3
   4 use failure::*;
   5 //use std::os::unix::io::AsRawFd;
   6 use chrono::{Local, Utc, TimeZone};
   7 use std::path::{Path, PathBuf};
   8 use std::collections::{HashSet, HashMap};
   9 use std::io::Write;
  10
  11 use proxmox_backup::tools;
  12 use proxmox_backup::cli::*;
  13 use proxmox_backup::api2::types::*;
  14 use proxmox_backup::api_schema::*;
  15 use proxmox_backup::api_schema::router::*;
  16 use proxmox_backup::client::*;
  17 use proxmox_backup::backup::*;
  18 use proxmox_backup::pxar;
  19
  20 //use proxmox_backup::backup::image_index::*;
  21 //use proxmox_backup::config::datastore;
  22 //use proxmox_backup::pxar::encoder::*;
  23 //use proxmox_backup::backup::datastore::*;
  24
  25 use serde_json::{json, Value};
  26 //use hyper::Body;
  27 use std::sync::Arc;
  28 use regex::Regex;
  29 use xdg::BaseDirectories;
  30
  31 use lazy_static::lazy_static;
  32 use futures::*;
  33 use tokio::sync::mpsc;
  34
  35 lazy_static! {
  36     static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$").unwrap();
  37
  38     static ref REPO_URL_SCHEMA: Arc<Schema> = Arc::new(
  39         StringSchema::new("Repository URL.")
  40             .format(BACKUP_REPO_URL.clone())
  41             .max_length(256)
  42             .into()
  43     );
  44 }
  45
  46
  47 fn get_default_repository() -> Option<String> {
  48     std::env::var("PBS_REPOSITORY").ok()
  49 }
  50
  51 fn extract_repository_from_value(
  52     param: &Value,
  53 ) -> Result<BackupRepository, Error> {
  54
  55     let repo_url = param["repository"]
  56         .as_str()
  57         .map(String::from)
  58         .or_else(get_default_repository)
  59         .ok_or_else(|| format_err!("unable to get (default) repository"))?;
  60
  61     let repo: BackupRepository = repo_url.parse()?;
  62
  63     Ok(repo)
  64 }
  65
  66 fn extract_repository_from_map(
  67     param: &HashMap<String, String>,
  68 ) -> Option<BackupRepository> {
  69
  70     param.get("repository")
  71         .map(String::from)
  72         .or_else(get_default_repository)
  73         .and_then(|repo_url| repo_url.parse::<BackupRepository>().ok())
  74 }
  75
  76 fn record_repository(repo: &BackupRepository) {
  77
  78     let base = match BaseDirectories::with_prefix("proxmox-backup") {
  79         Ok(v) => v,
  80         _ => return,
  81     };
  82
  83     // usually $HOME/.cache/proxmox-backup/repo-list
  84     let path = match base.place_cache_file("repo-list") {
  85         Ok(v) => v,
  86         _ => return,
  87     };
  88
  89     let mut data = tools::file_get_json(&path, None).unwrap_or(json!({}));
  90
  91     let repo = repo.to_string();
  92
  93     data[&repo] = json!{ data[&repo].as_i64().unwrap_or(0) + 1 };
  94
  95     let mut map = serde_json::map::Map::new();
  96
  97     loop {
  98         let mut max_used = 0;
  99         let mut max_repo = None;
 100         for (repo, count) in data.as_object().unwrap() {
 101             if map.contains_key(repo) { continue; }
 102             if let Some(count) = count.as_i64() {
 103                 if count > max_used {
 104                     max_used = count;
 105                     max_repo = Some(repo);
 106                 }
 107             }
 108         }
 109         if let Some(repo) = max_repo {
 110             map.insert(repo.to_owned(), json!(max_used));
 111         } else {
 112             break;
 113         }
 114         if map.len() > 10 { // store max. 10 repos
 115             break;
 116         }
 117     }
 118
 119     let new_data = json!(map);
 120
 121     let _ = tools::file_set_contents(path, new_data.to_string().as_bytes(), None);
 122 }
 123
 124 fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
 125
 126     let mut result = vec![];
 127
 128     let base = match BaseDirectories::with_prefix("proxmox-backup") {
 129         Ok(v) => v,
 130         _ => return result,
 131     };
 132
 133     // usually $HOME/.cache/proxmox-backup/repo-list
 134     let path = match base.place_cache_file("repo-list") {
 135         Ok(v) => v,
 136         _ => return result,
 137     };
 138
 139     let data = tools::file_get_json(&path, None).unwrap_or(json!({}));
 140
 141     if let Some(map) = data.as_object() {
 142         for (repo, _count) in map {
 143             result.push(repo.to_owned());
 144         }
 145     }
 146
 147     result
 148 }
 149
 150 fn backup_directory<P: AsRef<Path>>(
 151     client: &BackupClient,
 152     dir_path: P,
 153     archive_name: &str,
 154     chunk_size: Option<usize>,
 155     device_set: Option<HashSet<u64>>,
 156     verbose: bool,
 157     skip_lost_and_found: bool,
 158     crypt_config: Option<Arc<CryptConfig>>,
 159 ) -> Result<BackupStats, Error> {
 160
 161     let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), device_set, verbose, skip_lost_and_found)?;
 162     let chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
 163
 164     let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
 165
 166     let stream = rx
 167         .map_err(Error::from)
 168         .and_then(|x| x); // flatten
 169
 170     // spawn chunker inside a separate task so that it can run parallel
 171     tokio::spawn(
 172         tx.send_all(chunk_stream.then(|r| Ok(r)))
 173             .map_err(|_| {}).map(|_| ())
 174     );
 175
 176     let stats = client.upload_stream(archive_name, stream, "dynamic", None, crypt_config).wait()?;
 177
 178     Ok(stats)
 179 }
 180
 181 fn backup_image<P: AsRef<Path>>(
 182     client: &BackupClient,
 183     image_path: P,
 184     archive_name: &str,
 185     image_size: u64,
 186     chunk_size: Option<usize>,
 187     _verbose: bool,
 188     crypt_config: Option<Arc<CryptConfig>>,
 189 ) -> Result<BackupStats, Error> {
 190
 191     let path = image_path.as_ref().to_owned();
 192
 193     let file = tokio::fs::File::open(path).wait()?;
 194
 195     let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
 196         .map_err(Error::from);
 197
 198     let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
 199
 200     let stats = client.upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config).wait()?;
 201
 202     Ok(stats)
 203 }
 204
 205 fn strip_server_file_expenstion(name: &str) -> String {
 206
 207     if name.ends_with(".didx") {
 208         return name[..name.len()-5].to_owned();
 209     } else if name.ends_with(".fidx") {
 210         return name[..name.len()-5].to_owned();
 211     } else if name.ends_with(".blob") {
 212         return name[..name.len()-5].to_owned();
 213     } else {
 214         return name.to_owned(); // should not happen
 215     }
 216 }
 217
 218 fn list_backup_groups(
 219     param: Value,
 220     _info: &ApiMethod,
 221     _rpcenv: &mut dyn RpcEnvironment,
 222 ) -> Result<Value, Error> {
 223
 224     let repo = extract_repository_from_value(&param)?;
 225
 226     let client = HttpClient::new(repo.host(), repo.user())?;
 227
 228     let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
 229
 230     let mut result = client.get(&path, None).wait()?;
 231
 232     record_repository(&repo);
 233
 234     // fixme: implement and use output formatter instead ..
 235     let list = result["data"].as_array_mut().unwrap();
 236
 237     list.sort_unstable_by(|a, b| {
 238         let a_id = a["backup-id"].as_str().unwrap();
 239         let a_backup_type = a["backup-type"].as_str().unwrap();
 240         let b_id = b["backup-id"].as_str().unwrap();
 241         let b_backup_type = b["backup-type"].as_str().unwrap();
 242
 243         let type_order = a_backup_type.cmp(b_backup_type);
 244         if type_order == std::cmp::Ordering::Equal {
 245             a_id.cmp(b_id)
 246         } else {
 247             type_order
 248         }
 249     });
 250
 251     let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
 252
 253     let mut result = vec![];
 254
 255     for item in list {
 256
 257         let id = item["backup-id"].as_str().unwrap();
 258         let btype = item["backup-type"].as_str().unwrap();
 259         let epoch = item["last-backup"].as_i64().unwrap();
 260         let last_backup = Utc.timestamp(epoch, 0);
 261         let backup_count = item["backup-count"].as_u64().unwrap();
 262
 263         let group = BackupGroup::new(btype, id);
 264
 265         let path = group.group_path().to_str().unwrap().to_owned();
 266
 267         let files = item["files"].as_array().unwrap().iter()
 268             .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
 269
 270         if output_format == "text" {
 271             println!(
 272                 "{:20} | {} | {:5} | {}",
 273                 path,
 274                 BackupDir::backup_time_to_string(last_backup),
 275                 backup_count,
 276                 tools::join(&files, ' '),
 277             );
 278         } else {
 279             result.push(json!({
 280                 "backup-type": btype,
 281                 "backup-id": id,
 282                 "last-backup": epoch,
 283                 "backup-count": backup_count,
 284                 "files": files,
 285             }));
 286         }
 287     }
 288
 289     if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
 290
 291     Ok(Value::Null)
 292 }
 293
 294 fn list_snapshots(
 295     param: Value,
 296     _info: &ApiMethod,
 297     _rpcenv: &mut dyn RpcEnvironment,
 298 ) -> Result<Value, Error> {
 299
 300     let repo = extract_repository_from_value(&param)?;
 301
 302     let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
 303
 304     let client = HttpClient::new(repo.host(), repo.user())?;
 305
 306     let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
 307
 308     let mut args = json!({});
 309     if let Some(path) = param["group"].as_str() {
 310         let group = BackupGroup::parse(path)?;
 311         args["backup-type"] = group.backup_type().into();
 312         args["backup-id"] = group.backup_id().into();
 313     }
 314
 315     let result = client.get(&path, Some(args)).wait()?;
 316
 317     record_repository(&repo);
 318
 319     let list = result["data"].as_array().unwrap();
 320
 321     let mut result = vec![];
 322
 323     for item in list {
 324
 325         let id = item["backup-id"].as_str().unwrap();
 326         let btype = item["backup-type"].as_str().unwrap();
 327         let epoch = item["backup-time"].as_i64().unwrap();
 328
 329         let snapshot = BackupDir::new(btype, id, epoch);
 330
 331         let path = snapshot.relative_path().to_str().unwrap().to_owned();
 332
 333         let files = item["files"].as_array().unwrap().iter()
 334             .map(|v|  strip_server_file_expenstion(v.as_str().unwrap())).collect();
 335
 336         if output_format == "text" {
 337             println!("{} | {}", path, tools::join(&files, ' '));
 338         } else {
 339             result.push(json!({
 340                 "backup-type": btype,
 341                 "backup-id": id,
 342                 "backup-time": epoch,
 343                 "files": files,
 344             }));
 345         }
 346     }
 347
 348     if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
 349
 350     Ok(Value::Null)
 351 }
 352
 353 fn forget_snapshots(
 354     param: Value,
 355     _info: &ApiMethod,
 356     _rpcenv: &mut dyn RpcEnvironment,
 357 ) -> Result<Value, Error> {
 358
 359     let repo = extract_repository_from_value(&param)?;
 360
 361     let path = tools::required_string_param(&param, "snapshot")?;
 362     let snapshot = BackupDir::parse(path)?;
 363
 364     let mut client = HttpClient::new(repo.host(), repo.user())?;
 365
 366     let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
 367
 368     let result = client.delete(&path, Some(json!({
 369         "backup-type": snapshot.group().backup_type(),
 370         "backup-id": snapshot.group().backup_id(),
 371         "backup-time": snapshot.backup_time().timestamp(),
 372     }))).wait()?;
 373
 374     record_repository(&repo);
 375
 376     Ok(result)
 377 }
 378
 379 fn list_snapshot_files(
 380     param: Value,
 381     _info: &ApiMethod,
 382     _rpcenv: &mut dyn RpcEnvironment,
 383 ) -> Result<Value, Error> {
 384
 385     let repo = extract_repository_from_value(&param)?;
 386
 387     let path = tools::required_string_param(&param, "snapshot")?;
 388     let snapshot = BackupDir::parse(path)?;
 389
 390     let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
 391
 392     let client = HttpClient::new(repo.host(), repo.user())?;
 393
 394     let path = format!("api2/json/admin/datastore/{}/files", repo.store());
 395
 396     let result = client.get(&path, Some(json!({
 397         "backup-type": snapshot.group().backup_type(),
 398         "backup-id": snapshot.group().backup_id(),
 399         "backup-time": snapshot.backup_time().timestamp(),
 400     }))).wait()?;
 401
 402     record_repository(&repo);
 403
 404     let list: Vec<String> = result["data"].as_array().unwrap().iter()
 405         .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
 406
 407     if output_format == "text" {
 408         for file in list {
 409             println!("{}", file);
 410         }
 411     } else {
 412         format_and_print_result(&list.into(), &output_format);
 413     }
 414
 415     Ok(Value::Null)
 416 }
 417
 418 fn start_garbage_collection(
 419     param: Value,
 420     _info: &ApiMethod,
 421     _rpcenv: &mut dyn RpcEnvironment,
 422 ) -> Result<Value, Error> {
 423
 424     let repo = extract_repository_from_value(&param)?;
 425
 426     let mut client = HttpClient::new(repo.host(), repo.user())?;
 427
 428     let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
 429
 430     let result = client.post(&path, None).wait()?;
 431
 432     record_repository(&repo);
 433
 434     Ok(result)
 435 }
 436
 437 fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
 438
 439     if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
 440         return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
 441     }
 442     bail!("unable to parse directory specification '{}'", value);
 443 }
 444
 445 fn create_backup(
 446     param: Value,
 447     _info: &ApiMethod,
 448     _rpcenv: &mut dyn RpcEnvironment,
 449 ) -> Result<Value, Error> {
 450
 451     let repo = extract_repository_from_value(&param)?;
 452
 453     let backupspec_list = tools::required_array_param(&param, "backupspec")?;
 454
 455     let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
 456
 457     let skip_lost_and_found = param["skip-lost-and-found"].as_bool().unwrap_or(false);
 458
 459     let verbose = param["verbose"].as_bool().unwrap_or(false);
 460
 461     let backup_time_opt = param["backup-time"].as_i64();
 462
 463     let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize);
 464
 465     if let Some(size) = chunk_size_opt {
 466         verify_chunk_size(size)?;
 467     }
 468
 469     let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
 470
 471     let backup_id = param["backup-id"].as_str().unwrap_or(&tools::nodename());
 472
 473     let backup_type = param["backup-type"].as_str().unwrap_or("host");
 474
 475     let include_dev = param["include-dev"].as_array();
 476
 477     let mut devices = if all_file_systems { None } else { Some(HashSet::new()) };
 478
 479     if let Some(include_dev) = include_dev {
 480         if all_file_systems {
 481             bail!("option 'all-file-systems' conflicts with option 'include-dev'");
 482         }
 483
 484         let mut set = HashSet::new();
 485         for path in include_dev {
 486             let path = path.as_str().unwrap();
 487             let stat = nix::sys::stat::stat(path)
 488                 .map_err(|err| format_err!("fstat {:?} failed - {}", path, err))?;
 489             set.insert(stat.st_dev);
 490         }
 491         devices = Some(set);
 492     }
 493
 494     let mut upload_list = vec![];
 495
 496     enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE };
 497
 498     for backupspec in backupspec_list {
 499         let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
 500
 501         use std::os::unix::fs::FileTypeExt;
 502
 503         let metadata = match std::fs::metadata(filename) {
 504             Ok(m) => m,
 505             Err(err) => bail!("unable to access '{}' - {}", filename, err),
 506         };
 507         let file_type = metadata.file_type();
 508
 509         let extension = Path::new(target).extension().map(|s| s.to_str().unwrap()).unwrap();
 510
 511         match extension {
 512             "pxar" => {
 513                 if !file_type.is_dir() {
 514                     bail!("got unexpected file type (expected directory)");
 515                 }
 516                 upload_list.push((BackupType::PXAR, filename.to_owned(), target.to_owned(), 0));
 517             }
 518             "img" => {
 519
 520                 if !(file_type.is_file() || file_type.is_block_device()) {
 521                     bail!("got unexpected file type (expected file or block device)");
 522                 }
 523
 524                 let size = tools::image_size(&PathBuf::from(filename))?;
 525
 526                 if size == 0 { bail!("got zero-sized file '{}'", filename); }
 527
 528                 upload_list.push((BackupType::IMAGE, filename.to_owned(), target.to_owned(), size));
 529             }
 530             "conf" => {
 531                 if !file_type.is_file() {
 532                     bail!("got unexpected file type (expected regular file)");
 533                 }
 534                 upload_list.push((BackupType::CONFIG, filename.to_owned(), target.to_owned(), metadata.len()));
 535             }
 536             "log" => {
 537                 if !file_type.is_file() {
 538                     bail!("got unexpected file type (expected regular file)");
 539                 }
 540                 upload_list.push((BackupType::LOGFILE, filename.to_owned(), target.to_owned(), metadata.len()));
 541             }
 542             _ => {
 543                 bail!("got unknown archive extension '{}'", extension);
 544             }
 545         }
 546     }
 547
 548     let backup_time = Utc.timestamp(backup_time_opt.unwrap_or(Utc::now().timestamp()), 0);
 549
 550     let client = HttpClient::new(repo.host(), repo.user())?;
 551     record_repository(&repo);
 552
 553     println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
 554
 555     println!("Client name: {}", tools::nodename());
 556
 557     let start_time = Local::now();
 558
 559     println!("Starting protocol: {}", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
 560
 561     let (crypt_config, rsa_encrypted_key) = match keyfile {
 562         None => (None, None),
 563         Some(path) => {
 564             let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
 565
 566             let crypt_config = CryptConfig::new(key)?;
 567
 568             let path = master_pubkey_path()?;
 569             if path.exists() {
 570                 let pem_data = proxmox_backup::tools::file_get_contents(&path)?;
 571                 let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
 572                 let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
 573                 (Some(Arc::new(crypt_config)), Some(enc_key))
 574             } else {
 575                 (Some(Arc::new(crypt_config)), None)
 576             }
 577         }
 578     };
 579
 580     let client = client.start_backup(repo.store(), backup_type, &backup_id, backup_time, verbose).wait()?;
 581
 582     let mut file_list = vec![];
 583
 584     for (backup_type, filename, target, size) in upload_list {
 585         match backup_type {
 586             BackupType::CONFIG => {
 587                 println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
 588                 let stats = client.upload_blob_from_file(&filename, &target, crypt_config.clone(), true).wait()?;
 589                 file_list.push((target, stats));
 590             }
 591             BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
 592                 println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target);
 593                 let stats = client.upload_blob_from_file(&filename, &target, crypt_config.clone(), true).wait()?;
 594                 file_list.push((target, stats));
 595             }
 596             BackupType::PXAR => {
 597                 println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
 598                 let stats = backup_directory(
 599                     &client,
 600                     &filename,
 601                     &target,
 602                     chunk_size_opt,
 603                     devices.clone(),
 604                     verbose,
 605                     skip_lost_and_found,
 606                     crypt_config.clone(),
 607                 )?;
 608                 file_list.push((target, stats));
 609             }
 610             BackupType::IMAGE => {
 611                 println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
 612                 let stats = backup_image(
 613                     &client,
 614                     &filename,
 615                     &target,
 616                     size,
 617                     chunk_size_opt,
 618                     verbose,
 619                     crypt_config.clone(),
 620                 )?;
 621                 file_list.push((target, stats));
 622             }
 623         }
 624     }
 625
 626     if let Some(rsa_encrypted_key) = rsa_encrypted_key {
 627         let target = "rsa-encrypted.key";
 628         println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
 629         let stats = client.upload_blob_from_data(rsa_encrypted_key, target, None, false).wait()?;
 630         file_list.push((target.to_owned(), stats));
 631
 632         // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
 633         /*
 634         let mut buffer2 = vec![0u8; rsa.size() as usize];
 635         let pem_data = proxmox_backup::tools::file_get_contents("master-private.pem")?;
 636         let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
 637         let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
 638         println!("TEST {} {:?}", len, buffer2);
 639          */
 640     }
 641
 642     // create index.json
 643     let file_list = file_list.iter()
 644         .fold(json!({}), |mut acc, (filename, stats)| {
 645             acc[filename] = json!({
 646                 "size": stats.size,
 647             });
 648             acc
 649         });
 650
 651     let index = json!({
 652         "backup-type": backup_type,
 653         "backup-id": backup_id,
 654         "backup-time": backup_time.timestamp(),
 655         "files": file_list,
 656     });
 657
 658     println!("Upload index.json to '{:?}'", repo);
 659     let index_data = serde_json::to_string_pretty(&index)?.into();
 660     client.upload_blob_from_data(index_data, "index.json", crypt_config.clone(), true).wait()?;
 661
 662     client.finish().wait()?;
 663
 664     let end_time = Local::now();
 665     let elapsed = end_time.signed_duration_since(start_time);
 666     println!("Duration: {}", elapsed);
 667
 668     println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
 669
 670     Ok(Value::Null)
 671 }
 672
 673 fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
 674
 675     let mut result = vec![];
 676
 677     let data: Vec<&str> = arg.splitn(2, ':').collect();
 678
 679     if data.len() != 2 {
 680         result.push(String::from("root.pxar:/"));
 681         result.push(String::from("etc.pxar:/etc"));
 682         return result;
 683     }
 684
 685     let files = tools::complete_file_name(data[1], param);
 686
 687     for file in files {
 688         result.push(format!("{}:{}", data[0], file));
 689     }
 690
 691     result
 692 }
 693
 694 fn restore(
 695     param: Value,
 696     _info: &ApiMethod,
 697     _rpcenv: &mut dyn RpcEnvironment,
 698 ) -> Result<Value, Error> {
 699
 700     let repo = extract_repository_from_value(&param)?;
 701
 702     let verbose = param["verbose"].as_bool().unwrap_or(false);
 703
 704     let allow_existing_dirs = param["allow-existing-dirs"].as_bool().unwrap_or(false);
 705
 706     let archive_name = tools::required_string_param(&param, "archive-name")?;
 707
 708     let client = HttpClient::new(repo.host(), repo.user())?;
 709
 710     record_repository(&repo);
 711
 712     let path = tools::required_string_param(&param, "snapshot")?;
 713
 714     let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
 715         let group = BackupGroup::parse(path)?;
 716
 717         let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
 718         let result = client.get(&path, Some(json!({
 719             "backup-type": group.backup_type(),
 720             "backup-id": group.backup_id(),
 721         }))).wait()?;
 722
 723         let list = result["data"].as_array().unwrap();
 724         if list.len() == 0 {
 725             bail!("backup group '{}' does not contain any snapshots:", path);
 726         }
 727
 728         let epoch = list[0]["backup-time"].as_i64().unwrap();
 729         let backup_time = Utc.timestamp(epoch, 0);
 730         (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
 731     } else {
 732         let snapshot = BackupDir::parse(path)?;
 733         (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
 734     };
 735
 736     let target = tools::required_string_param(&param, "target")?;
 737     let target = if target == "-" { None } else { Some(target) };
 738
 739     let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
 740
 741     let crypt_config = match keyfile {
 742         None => None,
 743         Some(path) => {
 744             let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
 745             Some(Arc::new(CryptConfig::new(key)?))
 746         }
 747     };
 748
 749     let server_archive_name = if archive_name.ends_with(".pxar") {
 750         format!("{}.didx", archive_name)
 751     } else if archive_name.ends_with(".img") {
 752         format!("{}.fidx", archive_name)
 753     } else {
 754         format!("{}.blob", archive_name)
 755     };
 756
 757     let client = client.start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true).wait()?;
 758
 759     use std::os::unix::fs::OpenOptionsExt;
 760
 761     let tmpfile = std::fs::OpenOptions::new()
 762         .write(true)
 763         .read(true)
 764         .custom_flags(libc::O_TMPFILE)
 765         .open("/tmp")?;
 766
 767     if server_archive_name.ends_with(".blob") {
 768
 769         let writer = Vec::with_capacity(1024*1024);
 770         let blob_data = client.download(&server_archive_name, writer).wait()?;
 771         let blob = DataBlob::from_raw(blob_data)?;
 772         blob.verify_crc()?;
 773
 774         let raw_data = match crypt_config {
 775             Some(ref crypt_config) => blob.decode(Some(crypt_config))?,
 776             None => blob.decode(None)?,
 777         };
 778
 779         if let Some(target) = target {
 780             crate::tools::file_set_contents(target, &raw_data, None)?;
 781         } else {
 782             let stdout = std::io::stdout();
 783             let mut writer = stdout.lock();
 784             writer.write_all(&raw_data)
 785                 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
 786         }
 787
 788     } else if server_archive_name.ends_with(".didx") {
 789         let tmpfile = client.download(&server_archive_name, tmpfile).wait()?;
 790
 791         let index = DynamicIndexReader::new(tmpfile)
 792             .map_err(|err| format_err!("unable to read dynamic index '{}' - {}", archive_name, err))?;
 793
 794         let most_used = index.find_most_used_chunks(8);
 795
 796         let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
 797
 798         let mut reader = BufferedDynamicReader::new(index, chunk_reader);
 799
 800         if let Some(target) = target {
 801
 802             let feature_flags = pxar::CA_FORMAT_DEFAULT;
 803             let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags, |path| {
 804                 if verbose {
 805                     println!("{:?}", path);
 806                 }
 807                 Ok(())
 808             });
 809             decoder.set_allow_existing_dirs(allow_existing_dirs);
 810
 811
 812             decoder.restore(Path::new(target), &Vec::new())?;
 813         } else {
 814             let stdout = std::io::stdout();
 815             let mut writer = stdout.lock();
 816
 817             std::io::copy(&mut reader, &mut writer)
 818                 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
 819         }
 820     } else if server_archive_name.ends_with(".fidx") {
 821         let tmpfile = client.download(&server_archive_name, tmpfile).wait()?;
 822
 823         let index = FixedIndexReader::new(tmpfile)
 824             .map_err(|err| format_err!("unable to read fixed index '{}' - {}", archive_name, err))?;
 825
 826         let most_used = index.find_most_used_chunks(8);
 827
 828         let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
 829
 830         let mut reader = BufferedFixedReader::new(index, chunk_reader);
 831
 832         if let Some(target) = target {
 833             let mut writer = std::fs::OpenOptions::new()
 834                 .write(true)
 835                 .create(true)
 836                 .create_new(true)
 837                 .open(target)
 838                 .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?;
 839
 840             std::io::copy(&mut reader, &mut writer)
 841                 .map_err(|err| format_err!("unable to store data - {}", err))?;
 842         } else {
 843             let stdout = std::io::stdout();
 844             let mut writer = stdout.lock();
 845
 846             std::io::copy(&mut reader, &mut writer)
 847                 .map_err(|err| format_err!("unable to pipe data - {}", err))?;
 848         }
 849     } else {
 850         bail!("unknown archive file extension (expected .pxar of .img)");
 851     }
 852
 853     Ok(Value::Null)
 854 }
 855
 856 fn upload_log(
 857     param: Value,
 858     _info: &ApiMethod,
 859     _rpcenv: &mut dyn RpcEnvironment,
 860 ) -> Result<Value, Error> {
 861
 862     let logfile = tools::required_string_param(&param, "logfile")?;
 863     let repo = extract_repository_from_value(&param)?;
 864
 865     let snapshot = tools::required_string_param(&param, "snapshot")?;
 866     let snapshot = BackupDir::parse(snapshot)?;
 867
 868     let mut client = HttpClient::new(repo.host(), repo.user())?;
 869
 870     let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
 871
 872     let crypt_config = match keyfile {
 873         None => None,
 874         Some(path) => {
 875             let (key, _created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
 876             let crypt_config = CryptConfig::new(key)?;
 877             Some(crypt_config)
 878         }
 879     };
 880
 881     let data = crate::tools::file_get_contents(logfile)?;
 882
 883     let blob = if let Some(ref crypt_config) = crypt_config {
 884         DataBlob::encode(&data, Some(crypt_config), true)?
 885     } else {
 886         DataBlob::encode(&data, None, true)?
 887     };
 888
 889     let raw_data = blob.into_inner();
 890
 891     let path = format!("api2/json/admin/datastore/{}/upload-backup-log", repo.store());
 892
 893     let args = json!({
 894         "backup-type": snapshot.group().backup_type(),
 895         "backup-id":  snapshot.group().backup_id(),
 896         "backup-time": snapshot.backup_time().timestamp(),
 897     });
 898
 899     let body = hyper::Body::from(raw_data);
 900
 901     let result = client.upload("application/octet-stream", body, &path, Some(args)).wait()?;
 902
 903     Ok(result)
 904 }
 905
 906 fn prune(
 907     mut param: Value,
 908     _info: &ApiMethod,
 909     _rpcenv: &mut dyn RpcEnvironment,
 910 ) -> Result<Value, Error> {
 911
 912     let repo = extract_repository_from_value(&param)?;
 913
 914     let mut client = HttpClient::new(repo.host(), repo.user())?;
 915
 916     let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
 917
 918     let group = tools::required_string_param(&param, "group")?;
 919     let group = BackupGroup::parse(group)?;
 920
 921     param.as_object_mut().unwrap().remove("repository");
 922     param.as_object_mut().unwrap().remove("group");
 923
 924     param["backup-type"] = group.backup_type().into();
 925     param["backup-id"] = group.backup_id().into();
 926
 927     let _result = client.post(&path, Some(param)).wait()?;
 928
 929     record_repository(&repo);
 930
 931     Ok(Value::Null)
 932 }
 933
 934 fn status(
 935     param: Value,
 936     _info: &ApiMethod,
 937     _rpcenv: &mut dyn RpcEnvironment,
 938 ) -> Result<Value, Error> {
 939
 940     let repo = extract_repository_from_value(&param)?;
 941
 942     let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
 943
 944     let client = HttpClient::new(repo.host(), repo.user())?;
 945
 946     let path = format!("api2/json/admin/datastore/{}/status", repo.store());
 947
 948     let result = client.get(&path, None).wait()?;
 949     let data = &result["data"];
 950
 951     record_repository(&repo);
 952
 953     if output_format == "text" {
 954         let total = data["total"].as_u64().unwrap();
 955         let used = data["used"].as_u64().unwrap();
 956         let avail = data["avail"].as_u64().unwrap();
 957         let roundup = total/200;
 958
 959         println!(
 960             "total: {} used: {} ({} %) available: {}",
 961             total,
 962             used,
 963             ((used+roundup)*100)/total,
 964             avail,
 965         );
 966     } else {
 967         format_and_print_result(data, &output_format);
 968     }
 969
 970     Ok(Value::Null)
 971 }
 972
 973 // like get, but simply ignore errors and return Null instead
 974 fn try_get(repo: &BackupRepository, url: &str) -> Value {
 975
 976     let client = match HttpClient::new(repo.host(), repo.user()) {
 977         Ok(v) => v,
 978         _ => return Value::Null,
 979     };
 980
 981     let mut resp = match client.get(url, None).wait() {
 982         Ok(v) => v,
 983         _ => return Value::Null,
 984     };
 985
 986     if let Some(map) = resp.as_object_mut() {
 987         if let Some(data) = map.remove("data") {
 988             return data;
 989         }
 990     }
 991     Value::Null
 992 }
 993
 994 fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
 995
 996     let mut result = vec![];
 997
 998     let repo = match extract_repository_from_map(param) {
 999         Some(v) => v,
1000         _ => return result,
1001     };
1002
1003     let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
1004
1005     let data = try_get(&repo, &path);
1006
1007     if let Some(list) = data.as_array() {
1008         for item in list {
1009             if let (Some(backup_id), Some(backup_type)) =
1010                 (item["backup-id"].as_str(), item["backup-type"].as_str())
1011             {
1012                 result.push(format!("{}/{}", backup_type, backup_id));
1013             }
1014         }
1015     }
1016
1017     result
1018 }
1019
1020 fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1021
1022     let mut result = vec![];
1023
1024      let repo = match extract_repository_from_map(param) {
1025         Some(v) => v,
1026         _ => return result,
1027     };
1028
1029     if arg.matches('/').count() < 2 {
1030         let groups = complete_backup_group(arg, param);
1031         for group in groups {
1032             result.push(group.to_string());
1033             result.push(format!("{}/", group));
1034         }
1035         return result;
1036     }
1037
1038     let mut parts = arg.split('/');
1039     let query = tools::json_object_to_query(json!({
1040         "backup-type": parts.next().unwrap(),
1041         "backup-id": parts.next().unwrap(),
1042     })).unwrap();
1043
1044     let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), query);
1045
1046     let data = try_get(&repo, &path);
1047
1048     if let Some(list) = data.as_array() {
1049         for item in list {
1050             if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
1051                 (item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64())
1052             {
1053                 let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
1054                 result.push(snapshot.relative_path().to_str().unwrap().to_owned());
1055             }
1056         }
1057     }
1058
1059     result
1060 }
1061
1062 fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1063
1064     let mut result = vec![];
1065
1066     let repo = match extract_repository_from_map(param) {
1067         Some(v) => v,
1068         _ => return result,
1069     };
1070
1071     let snapshot = match param.get("snapshot") {
1072         Some(path) => {
1073             match BackupDir::parse(path) {
1074                 Ok(v) => v,
1075                 _ => return result,
1076             }
1077         }
1078         _ => return result,
1079     };
1080
1081     let query = tools::json_object_to_query(json!({
1082         "backup-type": snapshot.group().backup_type(),
1083         "backup-id": snapshot.group().backup_id(),
1084         "backup-time": snapshot.backup_time().timestamp(),
1085     })).unwrap();
1086
1087     let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query);
1088
1089     let data = try_get(&repo, &path);
1090
1091     if let Some(list) = data.as_array() {
1092         for item in list {
1093             if let Some(filename) = item.as_str() {
1094                 result.push(filename.to_owned());
1095             }
1096         }
1097     }
1098
1099     result
1100 }
1101
1102 fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
1103
1104     complete_server_file_name(arg, param)
1105         .iter().map(|v| strip_server_file_expenstion(&v)).collect()
1106 }
1107
1108 fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
1109
1110     let mut result = vec![];
1111
1112     let mut size = 64;
1113     loop {
1114         result.push(size.to_string());
1115         size = size * 2;
1116         if size > 4096 { break; }
1117     }
1118
1119     result
1120 }
1121
1122 fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
1123
1124     // fixme: implement other input methods
1125
1126     use std::env::VarError::*;
1127     match std::env::var("PBS_ENCRYPTION_PASSWORD") {
1128         Ok(p) => return Ok(p.as_bytes().to_vec()),
1129         Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters"),
1130         Err(NotPresent) => {
1131             // Try another method
1132         }
1133     }
1134
1135     // If we're on a TTY, query the user for a password
1136     if crate::tools::tty::stdin_isatty() {
1137         return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?);
1138     }
1139
1140     bail!("no password input mechanism available");
1141 }
1142
1143 fn key_create(
1144     param: Value,
1145     _info: &ApiMethod,
1146     _rpcenv: &mut dyn RpcEnvironment,
1147 ) -> Result<Value, Error> {
1148
1149     let path = tools::required_string_param(&param, "path")?;
1150     let path = PathBuf::from(path);
1151
1152     let kdf = param["kdf"].as_str().unwrap_or("scrypt");
1153
1154     let key = proxmox::sys::linux::random_data(32)?;
1155
1156     if kdf == "scrypt" {
1157         // always read passphrase from tty
1158         if !crate::tools::tty::stdin_isatty() {
1159             bail!("unable to read passphrase - no tty");
1160         }
1161
1162         let password = crate::tools::tty::read_password("Encryption Key Password: ")?;
1163
1164         let key_config = encrypt_key_with_passphrase(&key, &password)?;
1165
1166         store_key_config(&path, false, key_config)?;
1167
1168         Ok(Value::Null)
1169     } else if kdf == "none" {
1170         let created =  Local.timestamp(Local::now().timestamp(), 0);
1171
1172         store_key_config(&path, false, KeyConfig {
1173             kdf: None,
1174             created,
1175             modified: created,
1176             data: key,
1177         })?;
1178
1179         Ok(Value::Null)
1180     } else {
1181         unreachable!();
1182     }
1183 }
1184
1185 fn master_pubkey_path() -> Result<PathBuf, Error> {
1186     let base = BaseDirectories::with_prefix("proxmox-backup")?;
1187
1188     // usually $HOME/.config/proxmox-backup/master-public.pem
1189     let path = base.place_config_file("master-public.pem")?;
1190
1191     Ok(path)
1192 }
1193
1194 fn key_import_master_pubkey(
1195     param: Value,
1196     _info: &ApiMethod,
1197     _rpcenv: &mut dyn RpcEnvironment,
1198 ) -> Result<Value, Error> {
1199
1200     let path = tools::required_string_param(&param, "path")?;
1201     let path = PathBuf::from(path);
1202
1203     let pem_data = proxmox_backup::tools::file_get_contents(&path)?;
1204
1205     if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
1206         bail!("Unable to decode PEM data - {}", err);
1207     }
1208
1209     let target_path = master_pubkey_path()?;
1210
1211     proxmox_backup::tools::file_set_contents(&target_path, &pem_data, None)?;
1212
1213     println!("Imported public master key to {:?}", target_path);
1214
1215     Ok(Value::Null)
1216 }
1217
1218 fn key_create_master_key(
1219     _param: Value,
1220     _info: &ApiMethod,
1221     _rpcenv: &mut dyn RpcEnvironment,
1222 ) -> Result<Value, Error> {
1223
1224     // we need a TTY to query the new password
1225     if !crate::tools::tty::stdin_isatty() {
1226         bail!("unable to create master key - no tty");
1227     }
1228
1229     let rsa = openssl::rsa::Rsa::generate(4096)?;
1230     let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
1231
1232     let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?;
1233     let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
1234
1235     if new_pw != verify_pw {
1236         bail!("Password verification fail!");
1237     }
1238
1239     if new_pw.len() < 5 {
1240         bail!("Password is too short!");
1241     }
1242
1243     let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
1244     let filename_pub = "master-public.pem";
1245     println!("Writing public master key to {}", filename_pub);
1246     proxmox_backup::tools::file_set_contents(filename_pub, pub_key.as_slice(), None)?;
1247
1248     let cipher = openssl::symm::Cipher::aes_256_cbc();
1249     let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
1250
1251     let filename_priv = "master-private.pem";
1252     println!("Writing private master key to {}", filename_priv);
1253     proxmox_backup::tools::file_set_contents(filename_priv, priv_key.as_slice(), None)?;
1254
1255     Ok(Value::Null)
1256 }
1257
1258 fn key_change_passphrase(
1259     param: Value,
1260     _info: &ApiMethod,
1261     _rpcenv: &mut dyn RpcEnvironment,
1262 ) -> Result<Value, Error> {
1263
1264     let path = tools::required_string_param(&param, "path")?;
1265     let path = PathBuf::from(path);
1266
1267     let kdf = param["kdf"].as_str().unwrap_or("scrypt");
1268
1269     // we need a TTY to query the new password
1270     if !crate::tools::tty::stdin_isatty() {
1271         bail!("unable to change passphrase - no tty");
1272     }
1273
1274     let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
1275
1276     if kdf == "scrypt" {
1277
1278         let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?;
1279         let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
1280
1281         if new_pw != verify_pw {
1282             bail!("Password verification fail!");
1283         }
1284
1285         if new_pw.len() < 5 {
1286             bail!("Password is too short!");
1287         }
1288
1289         let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
1290         new_key_config.created = created; // keep original value
1291
1292         store_key_config(&path, true, new_key_config)?;
1293
1294         Ok(Value::Null)
1295     } else if kdf == "none" {
1296         let modified =  Local.timestamp(Local::now().timestamp(), 0);
1297
1298         store_key_config(&path, true, KeyConfig {
1299             kdf: None,
1300             created, // keep original value
1301             modified,
1302             data: key.to_vec(),
1303         })?;
1304
1305         Ok(Value::Null)
1306     } else {
1307         unreachable!();
1308     }
1309 }
1310
1311 fn key_mgmt_cli() -> CliCommandMap {
1312
1313     let kdf_schema: Arc<Schema> = Arc::new(
1314         StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.")
1315             .format(Arc::new(ApiStringFormat::Enum(&["scrypt", "none"])))
1316             .default("scrypt")
1317             .into()
1318     );
1319
1320     let key_create_cmd_def = CliCommand::new(
1321         ApiMethod::new(
1322             key_create,
1323             ObjectSchema::new("Create a new encryption key.")
1324                 .required("path", StringSchema::new("File system path."))
1325                 .optional("kdf", kdf_schema.clone())
1326         ))
1327         .arg_param(vec!["path"])
1328         .completion_cb("path", tools::complete_file_name);
1329
1330     let key_change_passphrase_cmd_def = CliCommand::new(
1331         ApiMethod::new(
1332             key_change_passphrase,
1333             ObjectSchema::new("Change the passphrase required to decrypt the key.")
1334                 .required("path", StringSchema::new("File system path."))
1335                 .optional("kdf", kdf_schema.clone())
1336          ))
1337         .arg_param(vec!["path"])
1338         .completion_cb("path", tools::complete_file_name);
1339
1340     let key_create_master_key_cmd_def = CliCommand::new(
1341         ApiMethod::new(
1342             key_create_master_key,
1343             ObjectSchema::new("Create a new 4096 bit RSA master pub/priv key pair.")
1344         ));
1345
1346     let key_import_master_pubkey_cmd_def = CliCommand::new(
1347         ApiMethod::new(
1348             key_import_master_pubkey,
1349             ObjectSchema::new("Import a new RSA public key and use it as master key. The key is expected to be in '.pem' format.")
1350                 .required("path", StringSchema::new("File system path."))
1351         ))
1352         .arg_param(vec!["path"])
1353         .completion_cb("path", tools::complete_file_name);
1354
1355     let cmd_def = CliCommandMap::new()
1356         .insert("create".to_owned(), key_create_cmd_def.into())
1357         .insert("create-master-key".to_owned(), key_create_master_key_cmd_def.into())
1358         .insert("import-master-pubkey".to_owned(), key_import_master_pubkey_cmd_def.into())
1359         .insert("change-passphrase".to_owned(), key_change_passphrase_cmd_def.into());
1360
1361     cmd_def
1362 }
1363
1364 fn main() {
1365
1366     let backup_source_schema: Arc<Schema> = Arc::new(
1367         StringSchema::new("Backup source specification ([<label>:<path>]).")
1368             .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
1369             .into()
1370     );
1371
1372     let backup_cmd_def = CliCommand::new(
1373         ApiMethod::new(
1374             create_backup,
1375             ObjectSchema::new("Create (host) backup.")
1376                 .required(
1377                     "backupspec",
1378                     ArraySchema::new(
1379                         "List of backup source specifications ([<label.ext>:<path>] ...)",
1380                         backup_source_schema,
1381                     ).min_length(1)
1382                 )
1383                 .optional("repository", REPO_URL_SCHEMA.clone())
1384                 .optional(
1385                     "include-dev",
1386                     ArraySchema::new(
1387                         "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
1388                         StringSchema::new("Path to file.").into()
1389                     )
1390                 )
1391                 .optional(
1392                     "keyfile",
1393                     StringSchema::new("Path to encryption key. All data will be encrypted using this key."))
1394                 .optional(
1395                     "verbose",
1396                     BooleanSchema::new("Verbose output.").default(false))
1397                 .optional(
1398                     "skip-lost-and-found",
1399                     BooleanSchema::new("Skip lost+found directory").default(false))
1400                 .optional(
1401                     "backup-type",
1402                     BACKUP_TYPE_SCHEMA.clone()
1403                 )
1404                 .optional(
1405                     "backup-id",
1406                     BACKUP_ID_SCHEMA.clone()
1407                 )
1408                 .optional(
1409                     "backup-time",
1410                     BACKUP_TIME_SCHEMA.clone()
1411                 )
1412                 .optional(
1413                     "chunk-size",
1414                     IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
1415                         .minimum(64)
1416                         .maximum(4096)
1417                         .default(4096)
1418                 )
1419         ))
1420         .arg_param(vec!["backupspec"])
1421         .completion_cb("repository", complete_repository)
1422         .completion_cb("backupspec", complete_backup_source)
1423         .completion_cb("keyfile", tools::complete_file_name)
1424         .completion_cb("chunk-size", complete_chunk_size);
1425
1426     let upload_log_cmd_def = CliCommand::new(
1427         ApiMethod::new(
1428             upload_log,
1429             ObjectSchema::new("Upload backup log file.")
1430                 .required("snapshot", StringSchema::new("Snapshot path."))
1431                 .required("logfile", StringSchema::new("The path to the log file you want to upload."))
1432                 .optional("repository", REPO_URL_SCHEMA.clone())
1433                 .optional(
1434                     "keyfile",
1435                     StringSchema::new("Path to encryption key. All data will be encrypted using this key."))
1436         ))
1437         .arg_param(vec!["snapshot", "logfile"])
1438         .completion_cb("snapshot", complete_group_or_snapshot)
1439         .completion_cb("logfile", tools::complete_file_name)
1440         .completion_cb("keyfile", tools::complete_file_name)
1441         .completion_cb("repository", complete_repository);
1442
1443     let list_cmd_def = CliCommand::new(
1444         ApiMethod::new(
1445             list_backup_groups,
1446             ObjectSchema::new("List backup groups.")
1447                 .optional("repository", REPO_URL_SCHEMA.clone())
1448                 .optional("output-format", OUTPUT_FORMAT.clone())
1449         ))
1450         .completion_cb("repository", complete_repository);
1451
1452     let snapshots_cmd_def = CliCommand::new(
1453         ApiMethod::new(
1454             list_snapshots,
1455             ObjectSchema::new("List backup snapshots.")
1456                 .optional("group", StringSchema::new("Backup group."))
1457                 .optional("repository", REPO_URL_SCHEMA.clone())
1458                 .optional("output-format", OUTPUT_FORMAT.clone())
1459         ))
1460         .arg_param(vec!["group"])
1461         .completion_cb("group", complete_backup_group)
1462         .completion_cb("repository", complete_repository);
1463
1464     let forget_cmd_def = CliCommand::new(
1465         ApiMethod::new(
1466             forget_snapshots,
1467             ObjectSchema::new("Forget (remove) backup snapshots.")
1468                 .required("snapshot", StringSchema::new("Snapshot path."))
1469                 .optional("repository", REPO_URL_SCHEMA.clone())
1470         ))
1471         .arg_param(vec!["snapshot"])
1472         .completion_cb("repository", complete_repository)
1473         .completion_cb("snapshot", complete_group_or_snapshot);
1474
1475     let garbage_collect_cmd_def = CliCommand::new(
1476         ApiMethod::new(
1477             start_garbage_collection,
1478             ObjectSchema::new("Start garbage collection for a specific repository.")
1479                 .optional("repository", REPO_URL_SCHEMA.clone())
1480         ))
1481         .completion_cb("repository", complete_repository);
1482
1483     let restore_cmd_def = CliCommand::new(
1484         ApiMethod::new(
1485             restore,
1486             ObjectSchema::new("Restore backup repository.")
1487                 .required("snapshot", StringSchema::new("Group/Snapshot path."))
1488                 .required("archive-name", StringSchema::new("Backup archive name."))
1489                 .required("target", StringSchema::new(r###"Target directory path. Use '-' to write to stdandard output.
1490
1491 We do not extraxt '.pxar' archives when writing to stdandard output.
1492
1493 "###
1494                 ))
1495                 .optional(
1496                     "allow-existing-dirs",
1497                     BooleanSchema::new("Do not fail if directories already exists.").default(false))
1498                 .optional("repository", REPO_URL_SCHEMA.clone())
1499                 .optional("keyfile", StringSchema::new("Path to encryption key."))
1500                 .optional(
1501                     "verbose",
1502                     BooleanSchema::new("Verbose output.").default(false)
1503                 )
1504         ))
1505         .arg_param(vec!["snapshot", "archive-name", "target"])
1506         .completion_cb("repository", complete_repository)
1507         .completion_cb("snapshot", complete_group_or_snapshot)
1508         .completion_cb("archive-name", complete_archive_name)
1509         .completion_cb("target", tools::complete_file_name);
1510
1511     let files_cmd_def = CliCommand::new(
1512         ApiMethod::new(
1513             list_snapshot_files,
1514             ObjectSchema::new("List snapshot files.")
1515                 .required("snapshot", StringSchema::new("Snapshot path."))
1516                 .optional("repository", REPO_URL_SCHEMA.clone())
1517                 .optional("output-format", OUTPUT_FORMAT.clone())
1518         ))
1519         .arg_param(vec!["snapshot"])
1520         .completion_cb("repository", complete_repository)
1521         .completion_cb("snapshot", complete_group_or_snapshot);
1522
1523     let prune_cmd_def = CliCommand::new(
1524         ApiMethod::new(
1525             prune,
1526             proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
1527                 ObjectSchema::new("Prune backup repository.")
1528                     .required("group", StringSchema::new("Backup group."))
1529                     .optional("repository", REPO_URL_SCHEMA.clone())
1530             )
1531         ))
1532         .arg_param(vec!["group"])
1533         .completion_cb("group", complete_backup_group)
1534         .completion_cb("repository", complete_repository);
1535
1536     let status_cmd_def = CliCommand::new(
1537         ApiMethod::new(
1538             status,
1539             ObjectSchema::new("Get repository status.")
1540                 .optional("repository", REPO_URL_SCHEMA.clone())
1541                 .optional("output-format", OUTPUT_FORMAT.clone())
1542         ))
1543         .completion_cb("repository", complete_repository);
1544
1545     let cmd_def = CliCommandMap::new()
1546         .insert("backup".to_owned(), backup_cmd_def.into())
1547         .insert("upload-log".to_owned(), upload_log_cmd_def.into())
1548         .insert("forget".to_owned(), forget_cmd_def.into())
1549         .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
1550         .insert("list".to_owned(), list_cmd_def.into())
1551         .insert("prune".to_owned(), prune_cmd_def.into())
1552         .insert("restore".to_owned(), restore_cmd_def.into())
1553         .insert("snapshots".to_owned(), snapshots_cmd_def.into())
1554         .insert("files".to_owned(), files_cmd_def.into())
1555         .insert("status".to_owned(), status_cmd_def.into())
1556         .insert("key".to_owned(), key_mgmt_cli().into());
1557
1558     hyper::rt::run(futures::future::lazy(move || {
1559         run_cli_command(cmd_def.into());
1560         Ok(())
1561     }));
1562
1563 }