src/api2/admin/datastore.rs

   1 //! Datastore Management
   2
   3 use std::collections::HashSet;
   4 use std::ffi::OsStr;
   5 use std::os::unix::ffi::OsStrExt;
   6 use std::path::PathBuf;
   7
   8 use anyhow::{bail, format_err, Error};
   9 use futures::*;
  10 use hyper::http::request::Parts;
  11 use hyper::{header, Body, Response, StatusCode};
  12 use serde_json::{json, Value};
  13 use tokio_stream::wrappers::ReceiverStream;
  14
  15 use proxmox::api::{
  16     api, ApiResponseFuture, ApiHandler, ApiMethod, Router,
  17     RpcEnvironment, RpcEnvironmentType, Permission
  18 };
  19 use proxmox::api::router::SubdirMap;
  20 use proxmox::api::schema::*;
  21 use proxmox::tools::fs::{
  22     file_read_firstline, file_read_optional_string, replace_file, CreateOptions,
  23 };
  24 use proxmox::{http_err, identity, list_subdirs_api_method, sortable};
  25
  26 use pxar::accessor::aio::Accessor;
  27 use pxar::EntryKind;
  28
  29 use pbs_api_types::{ Authid, BackupContent, Counts, CryptMode,
  30     DataStoreListItem, GarbageCollectionStatus, GroupListItem,
  31     SnapshotListItem, SnapshotVerifyState, PruneOptions,
  32     DataStoreStatus, RRDMode, RRDTimeFrameResolution,
  33     BACKUP_ARCHIVE_NAME_SCHEMA, BACKUP_ID_SCHEMA, BACKUP_TIME_SCHEMA,
  34     BACKUP_TYPE_SCHEMA, DATASTORE_SCHEMA,
  35     IGNORE_VERIFIED_BACKUPS_SCHEMA, UPID_SCHEMA,
  36     VERIFICATION_OUTDATED_AFTER_SCHEMA, PRIV_DATASTORE_AUDIT,
  37     PRIV_DATASTORE_MODIFY, PRIV_DATASTORE_READ, PRIV_DATASTORE_PRUNE,
  38     PRIV_DATASTORE_BACKUP, PRIV_DATASTORE_VERIFY,
  39
  40 };
  41 use pbs_client::pxar::create_zip;
  42 use pbs_datastore::{BackupDir, BackupGroup, StoreProgress, CATALOG_NAME};
  43 use pbs_datastore::backup_info::BackupInfo;
  44 use pbs_datastore::cached_chunk_reader::CachedChunkReader;
  45 use pbs_datastore::catalog::{ArchiveEntry, CatalogReader};
  46 use pbs_datastore::data_blob::DataBlob;
  47 use pbs_datastore::data_blob_reader::DataBlobReader;
  48 use pbs_datastore::dynamic_index::{BufferedDynamicReader, DynamicIndexReader, LocalDynamicReadAt};
  49 use pbs_datastore::fixed_index::{FixedIndexReader};
  50 use pbs_datastore::index::IndexFile;
  51 use pbs_datastore::manifest::{BackupManifest, CLIENT_LOG_BLOB_NAME, MANIFEST_BLOB_NAME};
  52 use pbs_datastore::prune::compute_prune_info;
  53 use pbs_tools::blocking::WrappedReaderStream;
  54 use pbs_tools::stream::{AsyncReaderStream, AsyncChannelWriter};
  55 use pbs_tools::json::{required_integer_param, required_string_param};
  56 use pbs_config::CachedUserInfo;
  57 use proxmox_rest_server::formatter;
  58
  59 use crate::api2::node::rrd::create_value_from_rrd;
  60 use crate::backup::{
  61     check_backup_owner, verify_all_backups, verify_backup_group, verify_backup_dir, verify_filter,
  62     DataStore, LocalChunkReader,
  63 };
  64
  65 use crate::server::{jobstate::Job, WorkerTask};
  66
  67
  68 const GROUP_NOTES_FILE_NAME: &str = "notes";
  69
  70 fn get_group_note_path(store: &DataStore, group: &BackupGroup) -> PathBuf {
  71     let mut note_path = store.base_path();
  72     note_path.push(group.group_path());
  73     note_path.push(GROUP_NOTES_FILE_NAME);
  74     note_path
  75 }
  76
  77 fn check_priv_or_backup_owner(
  78     store: &DataStore,
  79     group: &BackupGroup,
  80     auth_id: &Authid,
  81     required_privs: u64,
  82 ) -> Result<(), Error> {
  83     let user_info = CachedUserInfo::new()?;
  84     let privs = user_info.lookup_privs(&auth_id, &["datastore", store.name()]);
  85
  86     if privs & required_privs == 0 {
  87         let owner = store.get_owner(group)?;
  88         check_backup_owner(&owner, auth_id)?;
  89     }
  90     Ok(())
  91 }
  92
  93 fn read_backup_index(
  94     store: &DataStore,
  95     backup_dir: &BackupDir,
  96 ) -> Result<(BackupManifest, Vec<BackupContent>), Error> {
  97
  98     let (manifest, index_size) = store.load_manifest(backup_dir)?;
  99
 100     let mut result = Vec::new();
 101     for item in manifest.files() {
 102         result.push(BackupContent {
 103             filename: item.filename.clone(),
 104             crypt_mode: Some(item.crypt_mode),
 105             size: Some(item.size),
 106         });
 107     }
 108
 109     result.push(BackupContent {
 110         filename: MANIFEST_BLOB_NAME.to_string(),
 111         crypt_mode: match manifest.signature {
 112             Some(_) => Some(CryptMode::SignOnly),
 113             None => Some(CryptMode::None),
 114         },
 115         size: Some(index_size),
 116     });
 117
 118     Ok((manifest, result))
 119 }
 120
 121 fn get_all_snapshot_files(
 122     store: &DataStore,
 123     info: &BackupInfo,
 124 ) -> Result<(BackupManifest, Vec<BackupContent>), Error> {
 125
 126     let (manifest, mut files) = read_backup_index(&store, &info.backup_dir)?;
 127
 128     let file_set = files.iter().fold(HashSet::new(), |mut acc, item| {
 129         acc.insert(item.filename.clone());
 130         acc
 131     });
 132
 133     for file in &info.files {
 134         if file_set.contains(file) { continue; }
 135         files.push(BackupContent {
 136             filename: file.to_string(),
 137             size: None,
 138             crypt_mode: None,
 139         });
 140     }
 141
 142     Ok((manifest, files))
 143 }
 144
 145 #[api(
 146     input: {
 147         properties: {
 148             store: {
 149                 schema: DATASTORE_SCHEMA,
 150             },
 151         },
 152     },
 153     returns: pbs_api_types::ADMIN_DATASTORE_LIST_GROUPS_RETURN_TYPE,
 154     access: {
 155         permission: &Permission::Privilege(
 156             &["datastore", "{store}"],
 157             PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
 158             true),
 159     },
 160 )]
 161 /// List backup groups.
 162 pub fn list_groups(
 163     store: String,
 164     rpcenv: &mut dyn RpcEnvironment,
 165 ) -> Result<Vec<GroupListItem>, Error> {
 166
 167     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 168     let user_info = CachedUserInfo::new()?;
 169     let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]);
 170
 171     let datastore = DataStore::lookup_datastore(&store)?;
 172     let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
 173
 174     let backup_groups = BackupInfo::list_backup_groups(&datastore.base_path())?;
 175
 176     let group_info = backup_groups
 177         .into_iter()
 178         .fold(Vec::new(), |mut group_info, group| {
 179             let owner = match datastore.get_owner(&group) {
 180                 Ok(auth_id) => auth_id,
 181                 Err(err) => {
 182                     eprintln!("Failed to get owner of group '{}/{}' - {}",
 183                              &store,
 184                              group,
 185                              err);
 186                     return group_info;
 187                 },
 188             };
 189             if !list_all && check_backup_owner(&owner, &auth_id).is_err() {
 190                 return group_info;
 191             }
 192
 193             let snapshots = match group.list_backups(&datastore.base_path()) {
 194                 Ok(snapshots) => snapshots,
 195                 Err(_) => {
 196                     return group_info;
 197                 },
 198             };
 199
 200             let backup_count: u64 = snapshots.len() as u64;
 201             if backup_count == 0 {
 202                 return group_info;
 203             }
 204
 205             let last_backup = snapshots
 206                 .iter()
 207                 .fold(&snapshots[0], |last, curr| {
 208                     if curr.is_finished()
 209                         && curr.backup_dir.backup_time() > last.backup_dir.backup_time() {
 210                         curr
 211                     } else {
 212                         last
 213                     }
 214                 })
 215                 .to_owned();
 216
 217             let note_path = get_group_note_path(&datastore, &group);
 218             let comment = file_read_firstline(&note_path).ok();
 219
 220             group_info.push(GroupListItem {
 221                 backup_type: group.backup_type().to_string(),
 222                 backup_id: group.backup_id().to_string(),
 223                 last_backup: last_backup.backup_dir.backup_time(),
 224                 owner: Some(owner),
 225                 backup_count,
 226                 files: last_backup.files,
 227                 comment,
 228             });
 229
 230             group_info
 231         });
 232
 233     Ok(group_info)
 234 }
 235
 236 #[api(
 237     input: {
 238         properties: {
 239             store: {
 240                 schema: DATASTORE_SCHEMA,
 241             },
 242             "backup-type": {
 243                 schema: BACKUP_TYPE_SCHEMA,
 244             },
 245             "backup-id": {
 246                 schema: BACKUP_ID_SCHEMA,
 247             },
 248         },
 249     },
 250     access: {
 251         permission: &Permission::Privilege(
 252             &["datastore", "{store}"],
 253             PRIV_DATASTORE_MODIFY| PRIV_DATASTORE_PRUNE,
 254             true),
 255     },
 256 )]
 257 /// Delete backup group including all snapshots.
 258 pub fn delete_group(
 259     store: String,
 260     backup_type: String,
 261     backup_id: String,
 262     _info: &ApiMethod,
 263     rpcenv: &mut dyn RpcEnvironment,
 264 ) -> Result<Value, Error> {
 265
 266     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 267
 268     let group = BackupGroup::new(backup_type, backup_id);
 269     let datastore = DataStore::lookup_datastore(&store)?;
 270
 271     check_priv_or_backup_owner(&datastore, &group, &auth_id, PRIV_DATASTORE_MODIFY)?;
 272
 273     datastore.remove_backup_group(&group)?;
 274
 275     Ok(Value::Null)
 276 }
 277
 278 #[api(
 279     input: {
 280         properties: {
 281             store: {
 282                 schema: DATASTORE_SCHEMA,
 283             },
 284             "backup-type": {
 285                 schema: BACKUP_TYPE_SCHEMA,
 286             },
 287             "backup-id": {
 288                 schema: BACKUP_ID_SCHEMA,
 289             },
 290             "backup-time": {
 291                 schema: BACKUP_TIME_SCHEMA,
 292             },
 293         },
 294     },
 295     returns: pbs_api_types::ADMIN_DATASTORE_LIST_SNAPSHOT_FILES_RETURN_TYPE,
 296     access: {
 297         permission: &Permission::Privilege(
 298             &["datastore", "{store}"],
 299             PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
 300             true),
 301     },
 302 )]
 303 /// List snapshot files.
 304 pub fn list_snapshot_files(
 305     store: String,
 306     backup_type: String,
 307     backup_id: String,
 308     backup_time: i64,
 309     _info: &ApiMethod,
 310     rpcenv: &mut dyn RpcEnvironment,
 311 ) -> Result<Vec<BackupContent>, Error> {
 312
 313     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 314     let datastore = DataStore::lookup_datastore(&store)?;
 315
 316     let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?;
 317
 318     check_priv_or_backup_owner(&datastore, snapshot.group(), &auth_id, PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ)?;
 319
 320     let info = BackupInfo::new(&datastore.base_path(), snapshot)?;
 321
 322     let (_manifest, files) = get_all_snapshot_files(&datastore, &info)?;
 323
 324     Ok(files)
 325 }
 326
 327 #[api(
 328     input: {
 329         properties: {
 330             store: {
 331                 schema: DATASTORE_SCHEMA,
 332             },
 333             "backup-type": {
 334                 schema: BACKUP_TYPE_SCHEMA,
 335             },
 336             "backup-id": {
 337                 schema: BACKUP_ID_SCHEMA,
 338             },
 339             "backup-time": {
 340                 schema: BACKUP_TIME_SCHEMA,
 341             },
 342         },
 343     },
 344     access: {
 345         permission: &Permission::Privilege(
 346             &["datastore", "{store}"],
 347             PRIV_DATASTORE_MODIFY| PRIV_DATASTORE_PRUNE,
 348             true),
 349     },
 350 )]
 351 /// Delete backup snapshot.
 352 pub fn delete_snapshot(
 353     store: String,
 354     backup_type: String,
 355     backup_id: String,
 356     backup_time: i64,
 357     _info: &ApiMethod,
 358     rpcenv: &mut dyn RpcEnvironment,
 359 ) -> Result<Value, Error> {
 360
 361     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 362
 363     let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?;
 364     let datastore = DataStore::lookup_datastore(&store)?;
 365
 366     check_priv_or_backup_owner(&datastore, snapshot.group(), &auth_id, PRIV_DATASTORE_MODIFY)?;
 367
 368     datastore.remove_backup_dir(&snapshot, false)?;
 369
 370     Ok(Value::Null)
 371 }
 372
 373 #[api(
 374     input: {
 375         properties: {
 376             store: {
 377                 schema: DATASTORE_SCHEMA,
 378             },
 379             "backup-type": {
 380                 optional: true,
 381                 schema: BACKUP_TYPE_SCHEMA,
 382             },
 383             "backup-id": {
 384                 optional: true,
 385                 schema: BACKUP_ID_SCHEMA,
 386             },
 387         },
 388     },
 389     returns: pbs_api_types::ADMIN_DATASTORE_LIST_SNAPSHOTS_RETURN_TYPE,
 390     access: {
 391         permission: &Permission::Privilege(
 392             &["datastore", "{store}"],
 393             PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
 394             true),
 395     },
 396 )]
 397 /// List backup snapshots.
 398 pub fn list_snapshots (
 399     store: String,
 400     backup_type: Option<String>,
 401     backup_id: Option<String>,
 402     _param: Value,
 403     _info: &ApiMethod,
 404     rpcenv: &mut dyn RpcEnvironment,
 405 ) -> Result<Vec<SnapshotListItem>, Error> {
 406
 407     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 408     let user_info = CachedUserInfo::new()?;
 409     let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]);
 410
 411     let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
 412
 413     let datastore = DataStore::lookup_datastore(&store)?;
 414
 415     let base_path = datastore.base_path();
 416
 417     let groups = match (backup_type, backup_id) {
 418         (Some(backup_type), Some(backup_id)) => {
 419             let mut groups = Vec::with_capacity(1);
 420             groups.push(BackupGroup::new(backup_type, backup_id));
 421             groups
 422         },
 423         (Some(backup_type), None) => {
 424             BackupInfo::list_backup_groups(&base_path)?
 425                 .into_iter()
 426                 .filter(|group| group.backup_type() == backup_type)
 427                 .collect()
 428         },
 429         (None, Some(backup_id)) => {
 430             BackupInfo::list_backup_groups(&base_path)?
 431                 .into_iter()
 432                 .filter(|group| group.backup_id() == backup_id)
 433                 .collect()
 434         },
 435         _ => BackupInfo::list_backup_groups(&base_path)?,
 436     };
 437
 438     let info_to_snapshot_list_item = |group: &BackupGroup, owner, info: BackupInfo| {
 439         let backup_type = group.backup_type().to_string();
 440         let backup_id = group.backup_id().to_string();
 441         let backup_time = info.backup_dir.backup_time();
 442
 443         match get_all_snapshot_files(&datastore, &info) {
 444             Ok((manifest, files)) => {
 445                 // extract the first line from notes
 446                 let comment: Option<String> = manifest.unprotected["notes"]
 447                     .as_str()
 448                     .and_then(|notes| notes.lines().next())
 449                     .map(String::from);
 450
 451                 let fingerprint = match manifest.fingerprint() {
 452                     Ok(fp) => fp,
 453                     Err(err) => {
 454                         eprintln!("error parsing fingerprint: '{}'", err);
 455                         None
 456                     },
 457                 };
 458
 459                 let verification = manifest.unprotected["verify_state"].clone();
 460                 let verification: Option<SnapshotVerifyState> = match serde_json::from_value(verification) {
 461                     Ok(verify) => verify,
 462                     Err(err) => {
 463                         eprintln!("error parsing verification state : '{}'", err);
 464                         None
 465                     }
 466                 };
 467
 468                 let size = Some(files.iter().map(|x| x.size.unwrap_or(0)).sum());
 469
 470                 SnapshotListItem {
 471                     backup_type,
 472                     backup_id,
 473                     backup_time,
 474                     comment,
 475                     verification,
 476                     fingerprint,
 477                     files,
 478                     size,
 479                     owner,
 480                 }
 481             },
 482             Err(err) => {
 483                 eprintln!("error during snapshot file listing: '{}'", err);
 484                 let files = info
 485                         .files
 486                         .into_iter()
 487                         .map(|filename| BackupContent {
 488                             filename,
 489                             size: None,
 490                             crypt_mode: None,
 491                         })
 492                         .collect();
 493
 494                 SnapshotListItem {
 495                     backup_type,
 496                     backup_id,
 497                     backup_time,
 498                     comment: None,
 499                     verification: None,
 500                     fingerprint: None,
 501                     files,
 502                     size: None,
 503                     owner,
 504                 }
 505             },
 506         }
 507     };
 508
 509     groups
 510         .iter()
 511         .try_fold(Vec::new(), |mut snapshots, group| {
 512             let owner = match datastore.get_owner(group) {
 513                 Ok(auth_id) => auth_id,
 514                 Err(err) => {
 515                     eprintln!("Failed to get owner of group '{}/{}' - {}",
 516                               &store,
 517                               group,
 518                               err);
 519                     return Ok(snapshots);
 520                 },
 521             };
 522
 523             if !list_all && check_backup_owner(&owner, &auth_id).is_err() {
 524                 return Ok(snapshots);
 525             }
 526
 527             let group_backups = group.list_backups(&datastore.base_path())?;
 528
 529             snapshots.extend(
 530                 group_backups
 531                     .into_iter()
 532                     .map(|info| info_to_snapshot_list_item(&group, Some(owner.clone()), info))
 533             );
 534
 535             Ok(snapshots)
 536         })
 537 }
 538
 539 fn get_snapshots_count(store: &DataStore, filter_owner: Option<&Authid>) -> Result<Counts, Error> {
 540     let base_path = store.base_path();
 541     let groups = BackupInfo::list_backup_groups(&base_path)?;
 542
 543     groups.iter()
 544         .filter(|group| {
 545             let owner = match store.get_owner(&group) {
 546                 Ok(owner) => owner,
 547                 Err(err) => {
 548                     eprintln!("Failed to get owner of group '{}/{}' - {}",
 549                               store.name(),
 550                               group,
 551                               err);
 552                     return false;
 553                 },
 554             };
 555
 556             match filter_owner {
 557                 Some(filter) => check_backup_owner(&owner, filter).is_ok(),
 558                 None => true,
 559             }
 560         })
 561         .try_fold(Counts::default(), |mut counts, group| {
 562             let snapshot_count = group.list_backups(&base_path)?.len() as u64;
 563
 564             let type_count = match group.backup_type() {
 565                 "ct" => counts.ct.get_or_insert(Default::default()),
 566                 "vm" => counts.vm.get_or_insert(Default::default()),
 567                 "host" => counts.host.get_or_insert(Default::default()),
 568                 _ => counts.other.get_or_insert(Default::default()),
 569             };
 570
 571             type_count.groups += 1;
 572             type_count.snapshots += snapshot_count;
 573
 574             Ok(counts)
 575         })
 576 }
 577
 578 #[api(
 579     input: {
 580         properties: {
 581             store: {
 582                 schema: DATASTORE_SCHEMA,
 583             },
 584             verbose: {
 585                 type: bool,
 586                 default: false,
 587                 optional: true,
 588                 description: "Include additional information like snapshot counts and GC status.",
 589             },
 590         },
 591
 592     },
 593     returns: {
 594         type: DataStoreStatus,
 595     },
 596     access: {
 597         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
 598     },
 599 )]
 600 /// Get datastore status.
 601 pub fn status(
 602     store: String,
 603     verbose: bool,
 604     _info: &ApiMethod,
 605     rpcenv: &mut dyn RpcEnvironment,
 606 ) -> Result<DataStoreStatus, Error> {
 607     let datastore = DataStore::lookup_datastore(&store)?;
 608     let storage = crate::tools::disks::disk_usage(&datastore.base_path())?;
 609     let (counts, gc_status) = if verbose {
 610         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 611         let user_info = CachedUserInfo::new()?;
 612
 613         let store_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]);
 614         let filter_owner = if store_privs & PRIV_DATASTORE_AUDIT != 0 {
 615             None
 616         } else {
 617             Some(&auth_id)
 618         };
 619
 620         let counts = Some(get_snapshots_count(&datastore, filter_owner)?);
 621         let gc_status = Some(datastore.last_gc_status());
 622
 623         (counts, gc_status)
 624     } else {
 625         (None, None)
 626     };
 627
 628     Ok(DataStoreStatus {
 629         total: storage.total,
 630         used: storage.used,
 631         avail: storage.avail,
 632         gc_status,
 633         counts,
 634     })
 635 }
 636
 637 #[api(
 638     input: {
 639         properties: {
 640             store: {
 641                 schema: DATASTORE_SCHEMA,
 642             },
 643             "backup-type": {
 644                 schema: BACKUP_TYPE_SCHEMA,
 645                 optional: true,
 646             },
 647             "backup-id": {
 648                 schema: BACKUP_ID_SCHEMA,
 649                 optional: true,
 650             },
 651             "ignore-verified": {
 652                 schema: IGNORE_VERIFIED_BACKUPS_SCHEMA,
 653                 optional: true,
 654             },
 655             "outdated-after": {
 656                 schema: VERIFICATION_OUTDATED_AFTER_SCHEMA,
 657                 optional: true,
 658             },
 659             "backup-time": {
 660                 schema: BACKUP_TIME_SCHEMA,
 661                 optional: true,
 662             },
 663         },
 664     },
 665     returns: {
 666         schema: UPID_SCHEMA,
 667     },
 668     access: {
 669         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_VERIFY | PRIV_DATASTORE_BACKUP, true),
 670     },
 671 )]
 672 /// Verify backups.
 673 ///
 674 /// This function can verify a single backup snapshot, all backup from a backup group,
 675 /// or all backups in the datastore.
 676 pub fn verify(
 677     store: String,
 678     backup_type: Option<String>,
 679     backup_id: Option<String>,
 680     backup_time: Option<i64>,
 681     ignore_verified: Option<bool>,
 682     outdated_after: Option<i64>,
 683     rpcenv: &mut dyn RpcEnvironment,
 684 ) -> Result<Value, Error> {
 685     let datastore = DataStore::lookup_datastore(&store)?;
 686     let ignore_verified = ignore_verified.unwrap_or(true);
 687
 688     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 689     let worker_id;
 690
 691     let mut backup_dir = None;
 692     let mut backup_group = None;
 693     let mut worker_type = "verify";
 694
 695     match (backup_type, backup_id, backup_time) {
 696         (Some(backup_type), Some(backup_id), Some(backup_time)) => {
 697             worker_id = format!("{}:{}/{}/{:08X}", store, backup_type, backup_id, backup_time);
 698             let dir = BackupDir::new(backup_type, backup_id, backup_time)?;
 699
 700             check_priv_or_backup_owner(&datastore, dir.group(), &auth_id, PRIV_DATASTORE_VERIFY)?;
 701
 702             backup_dir = Some(dir);
 703             worker_type = "verify_snapshot";
 704         }
 705         (Some(backup_type), Some(backup_id), None) => {
 706             worker_id = format!("{}:{}/{}", store, backup_type, backup_id);
 707             let group = BackupGroup::new(backup_type, backup_id);
 708
 709             check_priv_or_backup_owner(&datastore, &group, &auth_id, PRIV_DATASTORE_VERIFY)?;
 710
 711             backup_group = Some(group);
 712             worker_type = "verify_group";
 713         }
 714         (None, None, None) => {
 715             worker_id = store.clone();
 716         }
 717         _ => bail!("parameters do not specify a backup group or snapshot"),
 718     }
 719
 720     let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI;
 721
 722     let upid_str = WorkerTask::new_thread(
 723         worker_type,
 724         Some(worker_id),
 725         auth_id.clone(),
 726         to_stdout,
 727         move |worker| {
 728             let verify_worker = crate::backup::VerifyWorker::new(worker.clone(), datastore);
 729             let failed_dirs = if let Some(backup_dir) = backup_dir {
 730                 let mut res = Vec::new();
 731                 if !verify_backup_dir(
 732                     &verify_worker,
 733                     &backup_dir,
 734                     worker.upid().clone(),
 735                     Some(&move |manifest| {
 736                         verify_filter(ignore_verified, outdated_after, manifest)
 737                     }),
 738                 )? {
 739                     res.push(backup_dir.to_string());
 740                 }
 741                 res
 742             } else if let Some(backup_group) = backup_group {
 743                 let failed_dirs = verify_backup_group(
 744                     &verify_worker,
 745                     &backup_group,
 746                     &mut StoreProgress::new(1),
 747                     worker.upid(),
 748                     Some(&move |manifest| {
 749                         verify_filter(ignore_verified, outdated_after, manifest)
 750                     }),
 751                 )?;
 752                 failed_dirs
 753             } else {
 754                 let privs = CachedUserInfo::new()?
 755                     .lookup_privs(&auth_id, &["datastore", &store]);
 756
 757                 let owner = if privs & PRIV_DATASTORE_VERIFY == 0 {
 758                     Some(auth_id)
 759                 } else {
 760                     None
 761                 };
 762
 763                 verify_all_backups(
 764                     &verify_worker,
 765                     worker.upid(),
 766                     owner,
 767                     Some(&move |manifest| {
 768                         verify_filter(ignore_verified, outdated_after, manifest)
 769                     }),
 770                 )?
 771             };
 772             if !failed_dirs.is_empty() {
 773                 worker.log("Failed to verify the following snapshots/groups:");
 774                 for dir in failed_dirs {
 775                     worker.log(format!("\t{}", dir));
 776                 }
 777                 bail!("verification failed - please check the log for details");
 778             }
 779             Ok(())
 780         },
 781     )?;
 782
 783     Ok(json!(upid_str))
 784 }
 785
 786 #[api(
 787     input: {
 788         properties: {
 789             "backup-id": {
 790                 schema: BACKUP_ID_SCHEMA,
 791             },
 792             "backup-type": {
 793                 schema: BACKUP_TYPE_SCHEMA,
 794             },
 795             "dry-run": {
 796                 optional: true,
 797                 type: bool,
 798                 default: false,
 799                 description: "Just show what prune would do, but do not delete anything.",
 800             },
 801             "prune-options": {
 802                 type: PruneOptions,
 803                 flatten: true,
 804             },
 805             store: {
 806                 schema: DATASTORE_SCHEMA,
 807             },
 808         },
 809     },
 810     returns: pbs_api_types::ADMIN_DATASTORE_PRUNE_RETURN_TYPE,
 811     access: {
 812         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_PRUNE, true),
 813     },
 814 )]
 815 /// Prune a group on the datastore
 816 pub fn prune(
 817     backup_id: String,
 818     backup_type: String,
 819     dry_run: bool,
 820     prune_options: PruneOptions,
 821     store: String,
 822     _param: Value,
 823     rpcenv: &mut dyn RpcEnvironment,
 824 ) -> Result<Value, Error> {
 825
 826     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 827
 828     let group = BackupGroup::new(&backup_type, &backup_id);
 829
 830     let datastore = DataStore::lookup_datastore(&store)?;
 831
 832     check_priv_or_backup_owner(&datastore, &group, &auth_id, PRIV_DATASTORE_MODIFY)?;
 833
 834     let worker_id = format!("{}:{}/{}", store, &backup_type, &backup_id);
 835
 836     let mut prune_result = Vec::new();
 837
 838     let list = group.list_backups(&datastore.base_path())?;
 839
 840     let mut prune_info = compute_prune_info(list, &prune_options)?;
 841
 842     prune_info.reverse(); // delete older snapshots first
 843
 844     let keep_all = !pbs_datastore::prune::keeps_something(&prune_options);
 845
 846     if dry_run {
 847         for (info, mut keep) in prune_info {
 848             if keep_all { keep = true; }
 849
 850             let backup_time = info.backup_dir.backup_time();
 851             let group = info.backup_dir.group();
 852
 853             prune_result.push(json!({
 854                 "backup-type": group.backup_type(),
 855                 "backup-id": group.backup_id(),
 856                 "backup-time": backup_time,
 857                 "keep": keep,
 858             }));
 859         }
 860         return Ok(json!(prune_result));
 861     }
 862
 863
 864     // We use a WorkerTask just to have a task log, but run synchrounously
 865     let worker = WorkerTask::new("prune", Some(worker_id), auth_id, true)?;
 866
 867     if keep_all {
 868         worker.log("No prune selection - keeping all files.");
 869     } else {
 870         worker.log(format!("retention options: {}", pbs_datastore::prune::cli_options_string(&prune_options)));
 871         worker.log(format!("Starting prune on store \"{}\" group \"{}/{}\"",
 872                             store, backup_type, backup_id));
 873     }
 874
 875     for (info, mut keep) in prune_info {
 876         if keep_all { keep = true; }
 877
 878         let backup_time = info.backup_dir.backup_time();
 879         let timestamp = info.backup_dir.backup_time_string();
 880         let group = info.backup_dir.group();
 881
 882
 883         let msg = format!(
 884             "{}/{}/{} {}",
 885             group.backup_type(),
 886             group.backup_id(),
 887             timestamp,
 888             if keep { "keep" } else { "remove" },
 889         );
 890
 891         worker.log(msg);
 892
 893         prune_result.push(json!({
 894             "backup-type": group.backup_type(),
 895             "backup-id": group.backup_id(),
 896             "backup-time": backup_time,
 897             "keep": keep,
 898         }));
 899
 900         if !(dry_run || keep) {
 901             if let Err(err) = datastore.remove_backup_dir(&info.backup_dir, false) {
 902                 worker.warn(
 903                     format!(
 904                         "failed to remove dir {:?}: {}",
 905                         info.backup_dir.relative_path(), err
 906                     )
 907                 );
 908             }
 909         }
 910     }
 911
 912     worker.log_result(&Ok(()));
 913
 914     Ok(json!(prune_result))
 915 }
 916
 917 #[api(
 918     input: {
 919         properties: {
 920             "dry-run": {
 921                 optional: true,
 922                 type: bool,
 923                 default: false,
 924                 description: "Just show what prune would do, but do not delete anything.",
 925             },
 926             "prune-options": {
 927                 type: PruneOptions,
 928                 flatten: true,
 929             },
 930             store: {
 931                 schema: DATASTORE_SCHEMA,
 932             },
 933         },
 934     },
 935     returns: {
 936         schema: UPID_SCHEMA,
 937     },
 938     access: {
 939         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_PRUNE, true),
 940     },
 941 )]
 942 /// Prune the datastore
 943 pub fn prune_datastore(
 944     dry_run: bool,
 945     prune_options: PruneOptions,
 946     store: String,
 947     _param: Value,
 948     rpcenv: &mut dyn RpcEnvironment,
 949 ) -> Result<String, Error> {
 950
 951     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 952
 953     let datastore = DataStore::lookup_datastore(&store)?;
 954
 955     let upid_str = WorkerTask::new_thread(
 956         "prune",
 957         Some(store.clone()),
 958         auth_id.clone(),
 959         false,
 960         move |worker| crate::server::prune_datastore(
 961             worker.clone(),
 962             auth_id,
 963             prune_options,
 964             &store,
 965             datastore,
 966             dry_run
 967         ),
 968     )?;
 969
 970     Ok(upid_str)
 971 }
 972
 973 #[api(
 974     input: {
 975         properties: {
 976             store: {
 977                 schema: DATASTORE_SCHEMA,
 978             },
 979         },
 980     },
 981     returns: {
 982         schema: UPID_SCHEMA,
 983     },
 984     access: {
 985         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY, false),
 986     },
 987 )]
 988 /// Start garbage collection.
 989 pub fn start_garbage_collection(
 990     store: String,
 991     _info: &ApiMethod,
 992     rpcenv: &mut dyn RpcEnvironment,
 993 ) -> Result<Value, Error> {
 994
 995     let datastore = DataStore::lookup_datastore(&store)?;
 996     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
 997
 998     let job =  Job::new("garbage_collection", &store)
 999         .map_err(|_| format_err!("garbage collection already running"))?;
1000
1001     let to_stdout = rpcenv.env_type() == RpcEnvironmentType::CLI;
1002
1003     let upid_str = crate::server::do_garbage_collection_job(job, datastore, &auth_id, None, to_stdout)
1004         .map_err(|err| format_err!("unable to start garbage collection job on datastore {} - {}", store, err))?;
1005
1006     Ok(json!(upid_str))
1007 }
1008
1009 #[api(
1010     input: {
1011         properties: {
1012             store: {
1013                 schema: DATASTORE_SCHEMA,
1014             },
1015         },
1016     },
1017     returns: {
1018         type: GarbageCollectionStatus,
1019     },
1020     access: {
1021         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT, false),
1022     },
1023 )]
1024 /// Garbage collection status.
1025 pub fn garbage_collection_status(
1026     store: String,
1027     _info: &ApiMethod,
1028     _rpcenv: &mut dyn RpcEnvironment,
1029 ) -> Result<GarbageCollectionStatus, Error> {
1030
1031     let datastore = DataStore::lookup_datastore(&store)?;
1032
1033     let status = datastore.last_gc_status();
1034
1035     Ok(status)
1036 }
1037
1038 #[api(
1039     returns: {
1040         description: "List the accessible datastores.",
1041         type: Array,
1042         items: { type: DataStoreListItem },
1043     },
1044     access: {
1045         permission: &Permission::Anybody,
1046     },
1047 )]
1048 /// Datastore list
1049 pub fn get_datastore_list(
1050     _param: Value,
1051     _info: &ApiMethod,
1052     rpcenv: &mut dyn RpcEnvironment,
1053 ) -> Result<Vec<DataStoreListItem>, Error> {
1054
1055     let (config, _digest) = pbs_config::datastore::config()?;
1056
1057     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1058     let user_info = CachedUserInfo::new()?;
1059
1060     let mut list = Vec::new();
1061
1062     for (store, (_, data)) in &config.sections {
1063         let user_privs = user_info.lookup_privs(&auth_id, &["datastore", &store]);
1064         let allowed = (user_privs & (PRIV_DATASTORE_AUDIT| PRIV_DATASTORE_BACKUP)) != 0;
1065         if allowed {
1066             list.push(
1067                 DataStoreListItem {
1068                     store: store.clone(),
1069                     comment: data["comment"].as_str().map(String::from),
1070                 }
1071             );
1072         }
1073     }
1074
1075     Ok(list)
1076 }
1077
1078 #[sortable]
1079 pub const API_METHOD_DOWNLOAD_FILE: ApiMethod = ApiMethod::new(
1080     &ApiHandler::AsyncHttp(&download_file),
1081     &ObjectSchema::new(
1082         "Download single raw file from backup snapshot.",
1083         &sorted!([
1084             ("store", false, &DATASTORE_SCHEMA),
1085             ("backup-type", false, &BACKUP_TYPE_SCHEMA),
1086             ("backup-id", false,  &BACKUP_ID_SCHEMA),
1087             ("backup-time", false, &BACKUP_TIME_SCHEMA),
1088             ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA),
1089         ]),
1090     )
1091 ).access(None, &Permission::Privilege(
1092     &["datastore", "{store}"],
1093     PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
1094     true)
1095 );
1096
1097 pub fn download_file(
1098     _parts: Parts,
1099     _req_body: Body,
1100     param: Value,
1101     _info: &ApiMethod,
1102     rpcenv: Box<dyn RpcEnvironment>,
1103 ) -> ApiResponseFuture {
1104
1105     async move {
1106         let store = required_string_param(&param, "store")?;
1107         let datastore = DataStore::lookup_datastore(store)?;
1108
1109         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1110
1111         let file_name = required_string_param(&param, "file-name")?.to_owned();
1112
1113         let backup_type = required_string_param(&param, "backup-type")?;
1114         let backup_id = required_string_param(&param, "backup-id")?;
1115         let backup_time = required_integer_param(&param, "backup-time")?;
1116
1117         let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1118
1119         check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?;
1120
1121         println!("Download {} from {} ({}/{})", file_name, store, backup_dir, file_name);
1122
1123         let mut path = datastore.base_path();
1124         path.push(backup_dir.relative_path());
1125         path.push(&file_name);
1126
1127         let file = tokio::fs::File::open(&path)
1128             .await
1129             .map_err(|err| http_err!(BAD_REQUEST, "File open failed: {}", err))?;
1130
1131         let payload = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
1132             .map_ok(|bytes| bytes.freeze())
1133             .map_err(move |err| {
1134                 eprintln!("error during streaming of '{:?}' - {}", &path, err);
1135                 err
1136             });
1137         let body = Body::wrap_stream(payload);
1138
1139         // fixme: set other headers ?
1140         Ok(Response::builder()
1141            .status(StatusCode::OK)
1142            .header(header::CONTENT_TYPE, "application/octet-stream")
1143            .body(body)
1144            .unwrap())
1145     }.boxed()
1146 }
1147
1148 #[sortable]
1149 pub const API_METHOD_DOWNLOAD_FILE_DECODED: ApiMethod = ApiMethod::new(
1150     &ApiHandler::AsyncHttp(&download_file_decoded),
1151     &ObjectSchema::new(
1152         "Download single decoded file from backup snapshot. Only works if it's not encrypted.",
1153         &sorted!([
1154             ("store", false, &DATASTORE_SCHEMA),
1155             ("backup-type", false, &BACKUP_TYPE_SCHEMA),
1156             ("backup-id", false,  &BACKUP_ID_SCHEMA),
1157             ("backup-time", false, &BACKUP_TIME_SCHEMA),
1158             ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA),
1159         ]),
1160     )
1161 ).access(None, &Permission::Privilege(
1162     &["datastore", "{store}"],
1163     PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
1164     true)
1165 );
1166
1167 pub fn download_file_decoded(
1168     _parts: Parts,
1169     _req_body: Body,
1170     param: Value,
1171     _info: &ApiMethod,
1172     rpcenv: Box<dyn RpcEnvironment>,
1173 ) -> ApiResponseFuture {
1174
1175     async move {
1176         let store = required_string_param(&param, "store")?;
1177         let datastore = DataStore::lookup_datastore(store)?;
1178
1179         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1180
1181         let file_name = required_string_param(&param, "file-name")?.to_owned();
1182
1183         let backup_type = required_string_param(&param, "backup-type")?;
1184         let backup_id = required_string_param(&param, "backup-id")?;
1185         let backup_time = required_integer_param(&param, "backup-time")?;
1186
1187         let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1188
1189         check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?;
1190
1191         let (manifest, files) = read_backup_index(&datastore, &backup_dir)?;
1192         for file in files {
1193             if file.filename == file_name && file.crypt_mode == Some(CryptMode::Encrypt) {
1194                 bail!("cannot decode '{}' - is encrypted", file_name);
1195             }
1196         }
1197
1198         println!("Download {} from {} ({}/{})", file_name, store, backup_dir, file_name);
1199
1200         let mut path = datastore.base_path();
1201         path.push(backup_dir.relative_path());
1202         path.push(&file_name);
1203
1204         let extension = file_name.rsplitn(2, '.').next().unwrap();
1205
1206         let body = match extension {
1207             "didx" => {
1208                 let index = DynamicIndexReader::open(&path)
1209                     .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?;
1210                 let (csum, size) = index.compute_csum();
1211                 manifest.verify_file(&file_name, &csum, size)?;
1212
1213                 let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None);
1214                 let reader = CachedChunkReader::new(chunk_reader, index, 1).seekable();
1215                 Body::wrap_stream(AsyncReaderStream::new(reader)
1216                     .map_err(move |err| {
1217                         eprintln!("error during streaming of '{:?}' - {}", path, err);
1218                         err
1219                     }))
1220             },
1221             "fidx" => {
1222                 let index = FixedIndexReader::open(&path)
1223                     .map_err(|err| format_err!("unable to read fixed index '{:?}' - {}", &path, err))?;
1224
1225                 let (csum, size) = index.compute_csum();
1226                 manifest.verify_file(&file_name, &csum, size)?;
1227
1228                 let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None);
1229                 let reader = CachedChunkReader::new(chunk_reader, index, 1).seekable();
1230                 Body::wrap_stream(AsyncReaderStream::with_buffer_size(reader, 4*1024*1024)
1231                     .map_err(move |err| {
1232                         eprintln!("error during streaming of '{:?}' - {}", path, err);
1233                         err
1234                     }))
1235             },
1236             "blob" => {
1237                 let file = std::fs::File::open(&path)
1238                     .map_err(|err| http_err!(BAD_REQUEST, "File open failed: {}", err))?;
1239
1240                 // FIXME: load full blob to verify index checksum?
1241
1242                 Body::wrap_stream(
1243                     WrappedReaderStream::new(DataBlobReader::new(file, None)?)
1244                         .map_err(move |err| {
1245                             eprintln!("error during streaming of '{:?}' - {}", path, err);
1246                             err
1247                         })
1248                 )
1249             },
1250             extension => {
1251                 bail!("cannot download '{}' files", extension);
1252             },
1253         };
1254
1255         // fixme: set other headers ?
1256         Ok(Response::builder()
1257            .status(StatusCode::OK)
1258            .header(header::CONTENT_TYPE, "application/octet-stream")
1259            .body(body)
1260            .unwrap())
1261     }.boxed()
1262 }
1263
1264 #[sortable]
1265 pub const API_METHOD_UPLOAD_BACKUP_LOG: ApiMethod = ApiMethod::new(
1266     &ApiHandler::AsyncHttp(&upload_backup_log),
1267     &ObjectSchema::new(
1268         "Upload the client backup log file into a backup snapshot ('client.log.blob').",
1269         &sorted!([
1270             ("store", false, &DATASTORE_SCHEMA),
1271             ("backup-type", false, &BACKUP_TYPE_SCHEMA),
1272             ("backup-id", false, &BACKUP_ID_SCHEMA),
1273             ("backup-time", false, &BACKUP_TIME_SCHEMA),
1274         ]),
1275     )
1276 ).access(
1277     Some("Only the backup creator/owner is allowed to do this."),
1278     &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_BACKUP, false)
1279 );
1280
1281 pub fn upload_backup_log(
1282     _parts: Parts,
1283     req_body: Body,
1284     param: Value,
1285     _info: &ApiMethod,
1286     rpcenv: Box<dyn RpcEnvironment>,
1287 ) -> ApiResponseFuture {
1288
1289     async move {
1290         let store = required_string_param(&param, "store")?;
1291         let datastore = DataStore::lookup_datastore(store)?;
1292
1293         let file_name =  CLIENT_LOG_BLOB_NAME;
1294
1295         let backup_type = required_string_param(&param, "backup-type")?;
1296         let backup_id = required_string_param(&param, "backup-id")?;
1297         let backup_time = required_integer_param(&param, "backup-time")?;
1298
1299         let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1300
1301         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1302         let owner = datastore.get_owner(backup_dir.group())?;
1303         check_backup_owner(&owner, &auth_id)?;
1304
1305         let mut path = datastore.base_path();
1306         path.push(backup_dir.relative_path());
1307         path.push(&file_name);
1308
1309         if path.exists() {
1310             bail!("backup already contains a log.");
1311         }
1312
1313         println!("Upload backup log to {}/{}/{}/{}/{}", store,
1314                  backup_type, backup_id, backup_dir.backup_time_string(), file_name);
1315
1316         let data = req_body
1317             .map_err(Error::from)
1318             .try_fold(Vec::new(), |mut acc, chunk| {
1319                 acc.extend_from_slice(&*chunk);
1320                 future::ok::<_, Error>(acc)
1321             })
1322             .await?;
1323
1324         // always verify blob/CRC at server side
1325         let blob = DataBlob::load_from_reader(&mut &data[..])?;
1326
1327         replace_file(&path, blob.raw_data(), CreateOptions::new())?;
1328
1329         // fixme: use correct formatter
1330         Ok(formatter::json_response(Ok(Value::Null)))
1331     }.boxed()
1332 }
1333
1334 #[api(
1335     input: {
1336         properties: {
1337             store: {
1338                 schema: DATASTORE_SCHEMA,
1339             },
1340             "backup-type": {
1341                 schema: BACKUP_TYPE_SCHEMA,
1342             },
1343             "backup-id": {
1344                 schema: BACKUP_ID_SCHEMA,
1345             },
1346             "backup-time": {
1347                 schema: BACKUP_TIME_SCHEMA,
1348             },
1349             "filepath": {
1350                 description: "Base64 encoded path.",
1351                 type: String,
1352             }
1353         },
1354     },
1355     access: {
1356         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP, true),
1357     },
1358 )]
1359 /// Get the entries of the given path of the catalog
1360 pub fn catalog(
1361     store: String,
1362     backup_type: String,
1363     backup_id: String,
1364     backup_time: i64,
1365     filepath: String,
1366     rpcenv: &mut dyn RpcEnvironment,
1367 ) -> Result<Vec<ArchiveEntry>, Error> {
1368     let datastore = DataStore::lookup_datastore(&store)?;
1369
1370     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1371
1372     let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1373
1374     check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?;
1375
1376     let file_name = CATALOG_NAME;
1377
1378     let (manifest, files) = read_backup_index(&datastore, &backup_dir)?;
1379     for file in files {
1380         if file.filename == file_name && file.crypt_mode == Some(CryptMode::Encrypt) {
1381             bail!("cannot decode '{}' - is encrypted", file_name);
1382         }
1383     }
1384
1385     let mut path = datastore.base_path();
1386     path.push(backup_dir.relative_path());
1387     path.push(file_name);
1388
1389     let index = DynamicIndexReader::open(&path)
1390         .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?;
1391
1392     let (csum, size) = index.compute_csum();
1393     manifest.verify_file(&file_name, &csum, size)?;
1394
1395     let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None);
1396     let reader = BufferedDynamicReader::new(index, chunk_reader);
1397
1398     let mut catalog_reader = CatalogReader::new(reader);
1399
1400     let path = if filepath != "root" && filepath != "/" {
1401         base64::decode(filepath)?
1402     } else {
1403         vec![b'/']
1404     };
1405
1406     catalog_reader.list_dir_contents(&path)
1407 }
1408
1409 #[sortable]
1410 pub const API_METHOD_PXAR_FILE_DOWNLOAD: ApiMethod = ApiMethod::new(
1411     &ApiHandler::AsyncHttp(&pxar_file_download),
1412     &ObjectSchema::new(
1413         "Download single file from pxar file of a backup snapshot. Only works if it's not encrypted.",
1414         &sorted!([
1415             ("store", false, &DATASTORE_SCHEMA),
1416             ("backup-type", false, &BACKUP_TYPE_SCHEMA),
1417             ("backup-id", false,  &BACKUP_ID_SCHEMA),
1418             ("backup-time", false, &BACKUP_TIME_SCHEMA),
1419             ("filepath", false, &StringSchema::new("Base64 encoded path").schema()),
1420         ]),
1421     )
1422 ).access(None, &Permission::Privilege(
1423     &["datastore", "{store}"],
1424     PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
1425     true)
1426 );
1427
1428 pub fn pxar_file_download(
1429     _parts: Parts,
1430     _req_body: Body,
1431     param: Value,
1432     _info: &ApiMethod,
1433     rpcenv: Box<dyn RpcEnvironment>,
1434 ) -> ApiResponseFuture {
1435
1436     async move {
1437         let store = required_string_param(&param, "store")?;
1438         let datastore = DataStore::lookup_datastore(&store)?;
1439
1440         let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1441
1442         let filepath = required_string_param(&param, "filepath")?.to_owned();
1443
1444         let backup_type = required_string_param(&param, "backup-type")?;
1445         let backup_id = required_string_param(&param, "backup-id")?;
1446         let backup_time = required_integer_param(&param, "backup-time")?;
1447
1448         let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1449
1450         check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_READ)?;
1451
1452         let mut components = base64::decode(&filepath)?;
1453         if !components.is_empty() && components[0] == b'/' {
1454             components.remove(0);
1455         }
1456
1457         let mut split = components.splitn(2, |c| *c == b'/');
1458         let pxar_name = std::str::from_utf8(split.next().unwrap())?;
1459         let file_path = split.next().unwrap_or(b"/");
1460         let (manifest, files) = read_backup_index(&datastore, &backup_dir)?;
1461         for file in files {
1462             if file.filename == pxar_name && file.crypt_mode == Some(CryptMode::Encrypt) {
1463                 bail!("cannot decode '{}' - is encrypted", pxar_name);
1464             }
1465         }
1466
1467         let mut path = datastore.base_path();
1468         path.push(backup_dir.relative_path());
1469         path.push(pxar_name);
1470
1471         let index = DynamicIndexReader::open(&path)
1472             .map_err(|err| format_err!("unable to read dynamic index '{:?}' - {}", &path, err))?;
1473
1474         let (csum, size) = index.compute_csum();
1475         manifest.verify_file(&pxar_name, &csum, size)?;
1476
1477         let chunk_reader = LocalChunkReader::new(datastore, None, CryptMode::None);
1478         let reader = BufferedDynamicReader::new(index, chunk_reader);
1479         let archive_size = reader.archive_size();
1480         let reader = LocalDynamicReadAt::new(reader);
1481
1482         let decoder = Accessor::new(reader, archive_size).await?;
1483         let root = decoder.open_root().await?;
1484         let path = OsStr::from_bytes(file_path).to_os_string();
1485         let file = root
1486             .lookup(&path).await?
1487             .ok_or_else(|| format_err!("error opening '{:?}'", path))?;
1488
1489         let body = match file.kind() {
1490             EntryKind::File { .. } => Body::wrap_stream(
1491                 AsyncReaderStream::new(file.contents().await?).map_err(move |err| {
1492                     eprintln!("error during streaming of file '{:?}' - {}", filepath, err);
1493                     err
1494                 }),
1495             ),
1496             EntryKind::Hardlink(_) => Body::wrap_stream(
1497                 AsyncReaderStream::new(decoder.follow_hardlink(&file).await?.contents().await?)
1498                     .map_err(move |err| {
1499                         eprintln!(
1500                             "error during streaming of hardlink '{:?}' - {}",
1501                             path, err
1502                         );
1503                         err
1504                     }),
1505             ),
1506             EntryKind::Directory => {
1507                 let (sender, receiver) = tokio::sync::mpsc::channel(100);
1508                 let channelwriter = AsyncChannelWriter::new(sender, 1024 * 1024);
1509                 proxmox_rest_server::spawn_internal_task(
1510                     create_zip(channelwriter, decoder, path.clone(), false)
1511                 );
1512                 Body::wrap_stream(ReceiverStream::new(receiver).map_err(move |err| {
1513                     eprintln!("error during streaming of zip '{:?}' - {}", path, err);
1514                     err
1515                 }))
1516             }
1517             other => bail!("cannot download file of type {:?}", other),
1518         };
1519
1520         // fixme: set other headers ?
1521         Ok(Response::builder()
1522            .status(StatusCode::OK)
1523            .header(header::CONTENT_TYPE, "application/octet-stream")
1524            .body(body)
1525            .unwrap())
1526     }.boxed()
1527 }
1528
1529 #[api(
1530     input: {
1531         properties: {
1532             store: {
1533                 schema: DATASTORE_SCHEMA,
1534             },
1535             timeframe: {
1536                 type: RRDTimeFrameResolution,
1537             },
1538             cf: {
1539                 type: RRDMode,
1540             },
1541         },
1542     },
1543     access: {
1544         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
1545     },
1546 )]
1547 /// Read datastore stats
1548 pub fn get_rrd_stats(
1549     store: String,
1550     timeframe: RRDTimeFrameResolution,
1551     cf: RRDMode,
1552     _param: Value,
1553 ) -> Result<Value, Error> {
1554
1555     create_value_from_rrd(
1556         &format!("datastore/{}", store),
1557         &[
1558             "total", "used",
1559             "read_ios", "read_bytes",
1560             "write_ios", "write_bytes",
1561             "io_ticks",
1562         ],
1563         timeframe,
1564         cf,
1565     )
1566 }
1567
1568 #[api(
1569     input: {
1570         properties: {
1571             store: {
1572                 schema: DATASTORE_SCHEMA,
1573             },
1574             "backup-type": {
1575                 schema: BACKUP_TYPE_SCHEMA,
1576             },
1577             "backup-id": {
1578                 schema: BACKUP_ID_SCHEMA,
1579             },
1580         },
1581     },
1582     access: {
1583         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
1584     },
1585 )]
1586 /// Get "notes" for a backup group
1587 pub fn get_group_notes(
1588     store: String,
1589     backup_type: String,
1590     backup_id: String,
1591     rpcenv: &mut dyn RpcEnvironment,
1592 ) -> Result<String, Error> {
1593     let datastore = DataStore::lookup_datastore(&store)?;
1594
1595     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1596     let backup_group = BackupGroup::new(backup_type, backup_id);
1597
1598     check_priv_or_backup_owner(&datastore, &backup_group, &auth_id, PRIV_DATASTORE_AUDIT)?;
1599
1600     let note_path = get_group_note_path(&datastore, &backup_group);
1601     Ok(file_read_optional_string(note_path)?.unwrap_or_else(|| "".to_owned()))
1602 }
1603
1604 #[api(
1605     input: {
1606         properties: {
1607             store: {
1608                 schema: DATASTORE_SCHEMA,
1609             },
1610             "backup-type": {
1611                 schema: BACKUP_TYPE_SCHEMA,
1612             },
1613             "backup-id": {
1614                 schema: BACKUP_ID_SCHEMA,
1615             },
1616             notes: {
1617                 description: "A multiline text.",
1618             },
1619         },
1620     },
1621     access: {
1622         permission: &Permission::Privilege(&["datastore", "{store}"],
1623                                            PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_BACKUP,
1624                                            true),
1625     },
1626 )]
1627 /// Set "notes" for a backup group
1628 pub fn set_group_notes(
1629     store: String,
1630     backup_type: String,
1631     backup_id: String,
1632     notes: String,
1633     rpcenv: &mut dyn RpcEnvironment,
1634 ) -> Result<(), Error> {
1635     let datastore = DataStore::lookup_datastore(&store)?;
1636
1637     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1638     let backup_group = BackupGroup::new(backup_type, backup_id);
1639
1640     check_priv_or_backup_owner(&datastore, &backup_group, &auth_id, PRIV_DATASTORE_MODIFY)?;
1641
1642     let note_path = get_group_note_path(&datastore, &backup_group);
1643     replace_file(note_path, notes.as_bytes(), CreateOptions::new())?;
1644
1645     Ok(())
1646 }
1647
1648 #[api(
1649     input: {
1650         properties: {
1651             store: {
1652                 schema: DATASTORE_SCHEMA,
1653             },
1654             "backup-type": {
1655                 schema: BACKUP_TYPE_SCHEMA,
1656             },
1657             "backup-id": {
1658                 schema: BACKUP_ID_SCHEMA,
1659             },
1660             "backup-time": {
1661                 schema: BACKUP_TIME_SCHEMA,
1662             },
1663         },
1664     },
1665     access: {
1666         permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
1667     },
1668 )]
1669 /// Get "notes" for a specific backup
1670 pub fn get_notes(
1671     store: String,
1672     backup_type: String,
1673     backup_id: String,
1674     backup_time: i64,
1675     rpcenv: &mut dyn RpcEnvironment,
1676 ) -> Result<String, Error> {
1677     let datastore = DataStore::lookup_datastore(&store)?;
1678
1679     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1680     let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1681
1682     check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_AUDIT)?;
1683
1684     let (manifest, _) = datastore.load_manifest(&backup_dir)?;
1685
1686     let notes = manifest.unprotected["notes"]
1687         .as_str()
1688         .unwrap_or("");
1689
1690     Ok(String::from(notes))
1691 }
1692
1693 #[api(
1694     input: {
1695         properties: {
1696             store: {
1697                 schema: DATASTORE_SCHEMA,
1698             },
1699             "backup-type": {
1700                 schema: BACKUP_TYPE_SCHEMA,
1701             },
1702             "backup-id": {
1703                 schema: BACKUP_ID_SCHEMA,
1704             },
1705             "backup-time": {
1706                 schema: BACKUP_TIME_SCHEMA,
1707             },
1708             notes: {
1709                 description: "A multiline text.",
1710             },
1711         },
1712     },
1713     access: {
1714         permission: &Permission::Privilege(&["datastore", "{store}"],
1715                                            PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_BACKUP,
1716                                            true),
1717     },
1718 )]
1719 /// Set "notes" for a specific backup
1720 pub fn set_notes(
1721     store: String,
1722     backup_type: String,
1723     backup_id: String,
1724     backup_time: i64,
1725     notes: String,
1726     rpcenv: &mut dyn RpcEnvironment,
1727 ) -> Result<(), Error> {
1728     let datastore = DataStore::lookup_datastore(&store)?;
1729
1730     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1731     let backup_dir = BackupDir::new(backup_type, backup_id, backup_time)?;
1732
1733     check_priv_or_backup_owner(&datastore, backup_dir.group(), &auth_id, PRIV_DATASTORE_MODIFY)?;
1734
1735     datastore.update_manifest(&backup_dir,|manifest| {
1736         manifest.unprotected["notes"] = notes.into();
1737     }).map_err(|err| format_err!("unable to update manifest blob - {}", err))?;
1738
1739     Ok(())
1740 }
1741
1742 #[api(
1743     input: {
1744         properties: {
1745             store: {
1746                 schema: DATASTORE_SCHEMA,
1747             },
1748             "backup-type": {
1749                 schema: BACKUP_TYPE_SCHEMA,
1750             },
1751             "backup-id": {
1752                 schema: BACKUP_ID_SCHEMA,
1753             },
1754             "new-owner": {
1755                 type: Authid,
1756             },
1757         },
1758     },
1759     access: {
1760         permission: &Permission::Anybody,
1761         description: "Datastore.Modify on whole datastore, or changing ownership between user and a user's token for owned backups with Datastore.Backup"
1762     },
1763 )]
1764 /// Change owner of a backup group
1765 pub fn set_backup_owner(
1766     store: String,
1767     backup_type: String,
1768     backup_id: String,
1769     new_owner: Authid,
1770     rpcenv: &mut dyn RpcEnvironment,
1771 ) -> Result<(), Error> {
1772
1773     let datastore = DataStore::lookup_datastore(&store)?;
1774
1775     let backup_group = BackupGroup::new(backup_type, backup_id);
1776
1777     let auth_id: Authid = rpcenv.get_auth_id().unwrap().parse()?;
1778
1779     let user_info = CachedUserInfo::new()?;
1780
1781     let privs = user_info.lookup_privs(&auth_id, &["datastore", &store]);
1782
1783     let allowed = if (privs & PRIV_DATASTORE_MODIFY) != 0 {
1784         // High-privilege user/token
1785         true
1786     } else if (privs & PRIV_DATASTORE_BACKUP) != 0 {
1787         let owner = datastore.get_owner(&backup_group)?;
1788
1789         match (owner.is_token(), new_owner.is_token()) {
1790             (true, true) => {
1791                 // API token to API token, owned by same user
1792                 let owner = owner.user();
1793                 let new_owner = new_owner.user();
1794                 owner == new_owner && Authid::from(owner.clone()) == auth_id
1795             },
1796             (true, false) => {
1797                 // API token to API token owner
1798                 Authid::from(owner.user().clone()) == auth_id
1799                     && new_owner == auth_id
1800             },
1801             (false, true) => {
1802                 // API token owner to API token
1803                 owner == auth_id
1804                     && Authid::from(new_owner.user().clone()) == auth_id
1805             },
1806             (false, false) => {
1807                 // User to User, not allowed for unprivileged users
1808                 false
1809             },
1810         }
1811     } else {
1812         false
1813     };
1814
1815     if !allowed {
1816         return Err(http_err!(UNAUTHORIZED,
1817                   "{} does not have permission to change owner of backup group '{}' to {}",
1818                   auth_id,
1819                   backup_group,
1820                   new_owner,
1821         ));
1822     }
1823
1824     if !user_info.is_active_auth_id(&new_owner) {
1825         bail!("{} '{}' is inactive or non-existent",
1826               if new_owner.is_token() {
1827                   "API token".to_string()
1828               } else {
1829                   "user".to_string()
1830               },
1831               new_owner);
1832     }
1833
1834     datastore.set_owner(&backup_group, &new_owner, true)?;
1835
1836     Ok(())
1837 }
1838
1839 #[sortable]
1840 const DATASTORE_INFO_SUBDIRS: SubdirMap = &[
1841     (
1842         "catalog",
1843         &Router::new()
1844             .get(&API_METHOD_CATALOG)
1845     ),
1846     (
1847         "change-owner",
1848         &Router::new()
1849             .post(&API_METHOD_SET_BACKUP_OWNER)
1850     ),
1851     (
1852         "download",
1853         &Router::new()
1854             .download(&API_METHOD_DOWNLOAD_FILE)
1855     ),
1856     (
1857         "download-decoded",
1858         &Router::new()
1859             .download(&API_METHOD_DOWNLOAD_FILE_DECODED)
1860     ),
1861     (
1862         "files",
1863         &Router::new()
1864             .get(&API_METHOD_LIST_SNAPSHOT_FILES)
1865     ),
1866     (
1867         "gc",
1868         &Router::new()
1869             .get(&API_METHOD_GARBAGE_COLLECTION_STATUS)
1870             .post(&API_METHOD_START_GARBAGE_COLLECTION)
1871     ),
1872     (
1873         "group-notes",
1874         &Router::new()
1875             .get(&API_METHOD_GET_GROUP_NOTES)
1876             .put(&API_METHOD_SET_GROUP_NOTES)
1877     ),
1878     (
1879         "groups",
1880         &Router::new()
1881             .get(&API_METHOD_LIST_GROUPS)
1882             .delete(&API_METHOD_DELETE_GROUP)
1883     ),
1884     (
1885         "notes",
1886         &Router::new()
1887             .get(&API_METHOD_GET_NOTES)
1888             .put(&API_METHOD_SET_NOTES)
1889     ),
1890     (
1891         "prune",
1892         &Router::new()
1893             .post(&API_METHOD_PRUNE)
1894     ),
1895     (
1896         "prune-datastore",
1897         &Router::new()
1898             .post(&API_METHOD_PRUNE_DATASTORE)
1899     ),
1900     (
1901         "pxar-file-download",
1902         &Router::new()
1903             .download(&API_METHOD_PXAR_FILE_DOWNLOAD)
1904     ),
1905     (
1906         "rrd",
1907         &Router::new()
1908             .get(&API_METHOD_GET_RRD_STATS)
1909     ),
1910     (
1911         "snapshots",
1912         &Router::new()
1913             .get(&API_METHOD_LIST_SNAPSHOTS)
1914             .delete(&API_METHOD_DELETE_SNAPSHOT)
1915     ),
1916     (
1917         "status",
1918         &Router::new()
1919             .get(&API_METHOD_STATUS)
1920     ),
1921     (
1922         "upload-backup-log",
1923         &Router::new()
1924             .upload(&API_METHOD_UPLOAD_BACKUP_LOG)
1925     ),
1926     (
1927         "verify",
1928         &Router::new()
1929             .post(&API_METHOD_VERIFY)
1930     ),
1931 ];
1932
1933 const DATASTORE_INFO_ROUTER: Router = Router::new()
1934     .get(&list_subdirs_api_method!(DATASTORE_INFO_SUBDIRS))
1935     .subdirs(DATASTORE_INFO_SUBDIRS);
1936
1937
1938 pub const ROUTER: Router = Router::new()
1939     .get(&API_METHOD_GET_DATASTORE_LIST)
1940     .match_all("store", &DATASTORE_INFO_ROUTER);