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