]> git.proxmox.com Git - proxmox-backup.git/blobdiff - src/api2/admin/datastore.rs
garbage_collect: call fail_on_abort to abort GV when requested.
[proxmox-backup.git] / src / api2 / admin / datastore.rs
index 6819530799138baab8781980970acb4456633abf..3fe919859ceccb45def2aa77c904bdc8e8227c72 100644 (file)
@@ -2,14 +2,15 @@ use std::collections::{HashSet, HashMap};
 use std::convert::TryFrom;
 
 use chrono::{TimeZone, Local};
-use failure::*;
+use anyhow::{bail, Error};
 use futures::*;
 use hyper::http::request::Parts;
 use hyper::{header, Body, Response, StatusCode};
 use serde_json::{json, Value};
 
-use proxmox::api::api;
-use proxmox::api::{ApiResponseFuture, ApiHandler, ApiMethod, Router, RpcEnvironment, RpcEnvironmentType};
+use proxmox::api::{
+    api, ApiResponseFuture, ApiHandler, ApiMethod, Router,
+    RpcEnvironment, RpcEnvironmentType, Permission, UserInformation};
 use proxmox::api::router::SubdirMap;
 use proxmox::api::schema::*;
 use proxmox::tools::fs::{file_get_contents, replace_file, CreateOptions};
@@ -19,8 +20,25 @@ use proxmox::{http_err, identity, list_subdirs_api_method, sortable};
 use crate::api2::types::*;
 use crate::backup::*;
 use crate::config::datastore;
+use crate::config::cached_user_info::CachedUserInfo;
+
 use crate::server::WorkerTask;
 use crate::tools;
+use crate::config::acl::{
+    PRIV_DATASTORE_AUDIT,
+    PRIV_DATASTORE_MODIFY,
+    PRIV_DATASTORE_READ,
+    PRIV_DATASTORE_PRUNE,
+    PRIV_DATASTORE_BACKUP,
+};
+
+fn check_backup_owner(store: &DataStore, group: &BackupGroup, userid: &str) -> Result<(), Error> {
+    let owner = store.get_owner(group)?;
+    if &owner != userid {
+        bail!("backup owner check failed ({} != {})", userid, owner);
+    }
+    Ok(())
+}
 
 fn read_backup_index(store: &DataStore, backup_dir: &BackupDir) -> Result<Vec<BackupContent>, Error> {
 
@@ -78,12 +96,23 @@ fn group_backups(backup_list: Vec<BackupInfo>) -> HashMap<String, Vec<BackupInfo
             type: GroupListItem,
         }
     },
+    access: {
+        permission: &Permission::Privilege(
+            &["datastore", "{store}"],
+            PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
+            true),
+    },
 )]
 /// List backup groups.
 fn list_groups(
     store: String,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Vec<GroupListItem>, Error> {
 
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+    let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
     let datastore = DataStore::lookup_datastore(&store)?;
 
     let backup_list = BackupInfo::list_backups(&datastore.base_path())?;
@@ -97,8 +126,15 @@ fn list_groups(
         BackupInfo::sort_list(&mut list, false);
 
         let info = &list[0];
+
         let group = info.backup_dir.group();
 
+        let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
+        if !list_all {
+            let owner = datastore.get_owner(group)?;
+            if owner != username { continue; }
+        }
+
         let result_item = GroupListItem {
             backup_type: group.backup_type().to_string(),
             backup_id: group.backup_id().to_string(),
@@ -136,6 +172,12 @@ fn list_groups(
             type: BackupContent,
         }
     },
+    access: {
+        permission: &Permission::Privilege(
+            &["datastore", "{store}"],
+            PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
+            true),
+    },
 )]
 /// List snapshot files.
 pub fn list_snapshot_files(
@@ -144,12 +186,20 @@ pub fn list_snapshot_files(
     backup_id: String,
     backup_time: i64,
     _info: &ApiMethod,
-    _rpcenv: &mut dyn RpcEnvironment,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Vec<BackupContent>, Error> {
 
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+    let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
     let datastore = DataStore::lookup_datastore(&store)?;
+
     let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
 
+    let allowed = (user_privs & (PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_READ)) != 0;
+    if !allowed { check_backup_owner(&datastore, snapshot.group(), &username)?; }
+
     let mut files = read_backup_index(&datastore, &snapshot)?;
 
     let info = BackupInfo::new(&datastore.base_path(), snapshot)?;
@@ -184,6 +234,12 @@ pub fn list_snapshot_files(
             },
         },
     },
+    access: {
+        permission: &Permission::Privilege(
+            &["datastore", "{store}"],
+            PRIV_DATASTORE_MODIFY| PRIV_DATASTORE_PRUNE,
+            true),
+    },
 )]
 /// Delete backup snapshot.
 fn delete_snapshot(
@@ -192,13 +248,20 @@ fn delete_snapshot(
     backup_id: String,
     backup_time: i64,
     _info: &ApiMethod,
-    _rpcenv: &mut dyn RpcEnvironment,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Value, Error> {
 
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+    let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
     let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
 
     let datastore = DataStore::lookup_datastore(&store)?;
 
+    let allowed = (user_privs & PRIV_DATASTORE_MODIFY) != 0;
+    if !allowed { check_backup_owner(&datastore, snapshot.group(), &username)?; }
+
     datastore.remove_backup_dir(&snapshot)?;
 
     Ok(Value::Null)
@@ -227,19 +290,28 @@ fn delete_snapshot(
             type: SnapshotListItem,
         }
     },
+    access: {
+        permission: &Permission::Privilege(
+            &["datastore", "{store}"],
+            PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP,
+            true),
+    },
 )]
 /// List backup snapshots.
 pub fn list_snapshots (
-    param: Value,
+    store: String,
+    backup_type: Option<String>,
+    backup_id: Option<String>,
+    _param: Value,
     _info: &ApiMethod,
-    _rpcenv: &mut dyn RpcEnvironment,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Vec<SnapshotListItem>, Error> {
 
-    let store = tools::required_string_param(&param, "store")?;
-    let backup_type = param["backup-type"].as_str();
-    let backup_id = param["backup-id"].as_str();
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+    let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
 
-    let datastore = DataStore::lookup_datastore(store)?;
+    let datastore = DataStore::lookup_datastore(&store)?;
 
     let base_path = datastore.base_path();
 
@@ -249,13 +321,19 @@ pub fn list_snapshots (
 
     for info in backup_list {
         let group = info.backup_dir.group();
-        if let Some(backup_type) = backup_type {
+        if let Some(ref backup_type) = backup_type {
             if backup_type != group.backup_type() { continue; }
         }
-        if let Some(backup_id) = backup_id {
+        if let Some(ref backup_id) = backup_id {
             if backup_id != group.backup_id() { continue; }
         }
 
+        let list_all = (user_privs & PRIV_DATASTORE_AUDIT) != 0;
+        if !list_all {
+            let owner = datastore.get_owner(group)?;
+            if owner != username { continue; }
+        }
+
         let mut result_item = SnapshotListItem {
             backup_type: group.backup_type().to_string(),
             backup_id: group.backup_id().to_string(),
@@ -291,6 +369,9 @@ pub fn list_snapshots (
     returns: {
         type: StorageStatus,
     },
+    access: {
+        permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT | PRIV_DATASTORE_BACKUP, true),
+    },
 )]
 /// Get datastore status.
 pub fn status(
@@ -374,6 +455,11 @@ macro_rules! add_common_prune_prameters {
     }
 }
 
+pub const API_RETURN_SCHEMA_PRUNE: Schema = ArraySchema::new(
+    "Returns the list of snapshots and a flag indicating if there are kept or removed.",
+    PruneListItem::API_SCHEMA
+).schema();
+
 const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
     &ApiHandler::Sync(&prune),
     &ObjectSchema::new(
@@ -388,25 +474,36 @@ const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
         ],[
             ("store", false, &DATASTORE_SCHEMA),
         ])
-    )
+    ))
+    .returns(&API_RETURN_SCHEMA_PRUNE)
+    .access(None, &Permission::Privilege(
+    &["datastore", "{store}"],
+    PRIV_DATASTORE_MODIFY | PRIV_DATASTORE_PRUNE,
+    true)
 );
 
 fn prune(
     param: Value,
     _info: &ApiMethod,
-    _rpcenv: &mut dyn RpcEnvironment,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Value, Error> {
 
-    let store = param["store"].as_str().unwrap();
-
+    let store = tools::required_string_param(&param, "store")?;
     let backup_type = tools::required_string_param(&param, "backup-type")?;
     let backup_id = tools::required_string_param(&param, "backup-id")?;
 
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+    let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
     let dry_run = param["dry-run"].as_bool().unwrap_or(false);
 
     let group = BackupGroup::new(backup_type, backup_id);
 
-    let datastore = DataStore::lookup_datastore(store)?;
+    let datastore = DataStore::lookup_datastore(&store)?;
+
+    let allowed = (user_privs & PRIV_DATASTORE_MODIFY) != 0;
+    if !allowed { check_backup_owner(&datastore, &group, &username)?; }
 
     let prune_options = PruneOptions {
         keep_last: param["keep-last"].as_u64(),
@@ -512,6 +609,9 @@ fn prune(
     returns: {
         schema: UPID_SCHEMA,
     },
+    access: {
+        permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_MODIFY, false),
+    },
 )]
 /// Start garbage collection.
 fn start_garbage_collection(
@@ -530,7 +630,7 @@ fn start_garbage_collection(
         "garbage_collection", Some(store.clone()), "root@pam", to_stdout, move |worker|
         {
             worker.log(format!("starting garbage collection on store {}", store));
-            datastore.garbage_collection(worker)
+            datastore.garbage_collection(&worker)
         })?;
 
     Ok(json!(upid_str))
@@ -546,7 +646,10 @@ fn start_garbage_collection(
     },
     returns: {
         type: GarbageCollectionStatus,
-    }
+    },
+    access: {
+        permission: &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_AUDIT, false),
+    },
 )]
 /// Garbage collection status.
 pub fn garbage_collection_status(
@@ -562,16 +665,54 @@ pub fn garbage_collection_status(
     Ok(status)
 }
 
-
+#[api(
+    returns: {
+        description: "List the accessible datastores.",
+        type: Array,
+        items: {
+            description: "Datastore name and description.",
+            properties: {
+                store: {
+                    schema: DATASTORE_SCHEMA,
+                },
+                comment: {
+                    optional: true,
+                    schema: SINGLE_LINE_COMMENT_SCHEMA,
+                },
+            },
+        },
+    },
+    access: {
+        permission: &Permission::Anybody,
+    },
+)]
+/// Datastore list
 fn get_datastore_list(
     _param: Value,
     _info: &ApiMethod,
-    _rpcenv: &mut dyn RpcEnvironment,
+    rpcenv: &mut dyn RpcEnvironment,
 ) -> Result<Value, Error> {
 
     let (config, _digest) = datastore::config()?;
 
-    Ok(config.convert_to_array("store", None, &[]))
+    let username = rpcenv.get_user().unwrap();
+    let user_info = CachedUserInfo::new()?;
+
+    let mut list = Vec::new();
+
+    for (store, (_, data)) in &config.sections {
+        let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+        let allowed = (user_privs & (PRIV_DATASTORE_AUDIT| PRIV_DATASTORE_BACKUP)) != 0;
+        if allowed {
+            let mut entry = json!({ "store": store });
+            if let Some(comment) = data["comment"].as_str() {
+                entry["comment"] = comment.into();
+            }
+            list.push(entry);
+        }
+    }
+
+    Ok(list.into())
 }
 
 #[sortable]
@@ -587,6 +728,10 @@ pub const API_METHOD_DOWNLOAD_FILE: ApiMethod = ApiMethod::new(
             ("file-name", false, &BACKUP_ARCHIVE_NAME_SCHEMA),
         ]),
     )
+).access(None, &Permission::Privilege(
+    &["datastore", "{store}"],
+    PRIV_DATASTORE_READ | PRIV_DATASTORE_BACKUP,
+    true)
 );
 
 fn download_file(
@@ -594,25 +739,31 @@ fn download_file(
     _req_body: Body,
     param: Value,
     _info: &ApiMethod,
-    _rpcenv: Box<dyn RpcEnvironment>,
+    rpcenv: Box<dyn RpcEnvironment>,
 ) -> ApiResponseFuture {
 
     async move {
         let store = tools::required_string_param(&param, "store")?;
-
         let datastore = DataStore::lookup_datastore(store)?;
 
+        let username = rpcenv.get_user().unwrap();
+        let user_info = CachedUserInfo::new()?;
+        let user_privs = user_info.lookup_privs(&username, &["datastore", &store]);
+
         let file_name = tools::required_string_param(&param, "file-name")?.to_owned();
 
         let backup_type = tools::required_string_param(&param, "backup-type")?;
         let backup_id = tools::required_string_param(&param, "backup-id")?;
         let backup_time = tools::required_integer_param(&param, "backup-time")?;
 
+        let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
+
+        let allowed = (user_privs & PRIV_DATASTORE_READ) != 0;
+        if !allowed { check_backup_owner(&datastore, backup_dir.group(), &username)?; }
+
         println!("Download {} from {} ({}/{}/{}/{})", file_name, store,
                  backup_type, backup_id, Local.timestamp(backup_time, 0), file_name);
 
-        let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
-
         let mut path = datastore.base_path();
         path.push(backup_dir.relative_path());
         path.push(&file_name);
@@ -638,7 +789,7 @@ fn download_file(
 pub const API_METHOD_UPLOAD_BACKUP_LOG: ApiMethod = ApiMethod::new(
     &ApiHandler::AsyncHttp(&upload_backup_log),
     &ObjectSchema::new(
-        "Download single raw file from backup snapshot.",
+        "Upload the client backup log file into a backup snapshot ('client.log.blob').",
         &sorted!([
             ("store", false, &DATASTORE_SCHEMA),
             ("backup-type", false, &BACKUP_TYPE_SCHEMA),
@@ -646,6 +797,9 @@ pub const API_METHOD_UPLOAD_BACKUP_LOG: ApiMethod = ApiMethod::new(
             ("backup-time", false, &BACKUP_TIME_SCHEMA),
         ]),
     )
+).access(
+    Some("Only the backup creator/owner is allowed to do this."),
+    &Permission::Privilege(&["datastore", "{store}"], PRIV_DATASTORE_BACKUP, false)
 );
 
 fn upload_backup_log(
@@ -653,12 +807,11 @@ fn upload_backup_log(
     req_body: Body,
     param: Value,
     _info: &ApiMethod,
-    _rpcenv: Box<dyn RpcEnvironment>,
+    rpcenv: Box<dyn RpcEnvironment>,
 ) -> ApiResponseFuture {
 
     async move {
         let store = tools::required_string_param(&param, "store")?;
-
         let datastore = DataStore::lookup_datastore(store)?;
 
         let file_name = "client.log.blob";
@@ -669,6 +822,9 @@ fn upload_backup_log(
 
         let backup_dir = BackupDir::new(backup_type, backup_id, backup_time);
 
+        let username = rpcenv.get_user().unwrap();
+        check_backup_owner(&datastore, backup_dir.group(), &username)?;
+
         let mut path = datastore.base_path();
         path.push(backup_dir.relative_path());
         path.push(&file_name);
@@ -751,10 +907,5 @@ const DATASTORE_INFO_ROUTER: Router = Router::new()
 
 
 pub const ROUTER: Router = Router::new()
-    .get(
-        &ApiMethod::new(
-            &ApiHandler::Sync(&get_datastore_list),
-            &ObjectSchema::new("Directory index.", &[])
-        )
-    )
+    .get(&API_METHOD_GET_DATASTORE_LIST)
     .match_all("store", &DATASTORE_INFO_ROUTER);