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