-//#[macro_use]
-extern crate proxmox_backup;
-
-use failure::*;
-use nix::unistd::{fork, ForkResult, pipe};
-use std::os::unix::io::RawFd;
-use chrono::{Local, Utc, TimeZone};
-use std::path::{Path, PathBuf};
use std::collections::{HashSet, HashMap};
-use std::ffi::OsStr;
-use std::io::{BufReader, Read, Write, Seek, SeekFrom};
-use std::os::unix::fs::OpenOptionsExt;
-
-use proxmox::tools::fs::{file_get_contents, file_get_json, file_set_contents, image_size};
-
-use proxmox_backup::tools;
-use proxmox_backup::cli::*;
-use proxmox_backup::api2::types::*;
-use proxmox_backup::api_schema::*;
-use proxmox_backup::api_schema::router::*;
-use proxmox_backup::client::*;
-use proxmox_backup::backup::*;
-use proxmox_backup::pxar::{ self, catalog::* };
-
-//use proxmox_backup::backup::image_index::*;
-//use proxmox_backup::config::datastore;
-//use proxmox_backup::pxar::encoder::*;
-//use proxmox_backup::backup::datastore::*;
-
-use serde_json::{json, Value};
-//use hyper::Body;
+use std::convert::TryFrom;
+use std::io::{self, Read, Write, Seek, SeekFrom};
+use std::os::unix::io::{FromRawFd, RawFd};
+use std::path::{Path, PathBuf};
+use std::pin::Pin;
use std::sync::{Arc, Mutex};
-use regex::Regex;
-use xdg::BaseDirectories;
+use std::task::Context;
-use lazy_static::lazy_static;
-use futures::*;
+use anyhow::{bail, format_err, Error};
+use futures::future::FutureExt;
+use futures::stream::{StreamExt, TryStreamExt};
+use serde_json::{json, Value};
use tokio::sync::mpsc;
+use tokio_stream::wrappers::ReceiverStream;
+use xdg::BaseDirectories;
-lazy_static! {
- static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf|log)):(.+)$").unwrap();
-
- static ref REPO_URL_SCHEMA: Arc<Schema> = Arc::new(
- StringSchema::new("Repository URL.")
- .format(BACKUP_REPO_URL.clone())
- .max_length(256)
- .into()
- );
-}
+use pathpatterns::{MatchEntry, MatchType, PatternFlag};
+use proxmox::{
+ tools::{
+ time::{strftime_local, epoch_i64},
+ fs::{file_get_contents, file_get_json, replace_file, CreateOptions, image_size},
+ },
+ api::{
+ api,
+ ApiHandler,
+ ApiMethod,
+ RpcEnvironment,
+ schema::*,
+ cli::*,
+ },
+};
+use pxar::accessor::{MaybeReady, ReadAt, ReadAtOperation};
+use proxmox_backup::tools;
+use proxmox_backup::api2::access::user::UserWithTokens;
+use proxmox_backup::api2::types::*;
+use proxmox_backup::api2::version;
+use proxmox_backup::client::*;
+use proxmox_backup::pxar::catalog::*;
+use proxmox_backup::backup::{
+ archive_type,
+ decrypt_key,
+ rsa_encrypt_key_config,
+ verify_chunk_size,
+ ArchiveType,
+ AsyncReadChunk,
+ BackupDir,
+ BackupGroup,
+ BackupManifest,
+ BufferedDynamicReader,
+ CATALOG_NAME,
+ CatalogReader,
+ CatalogWriter,
+ ChunkStream,
+ CryptConfig,
+ CryptMode,
+ DynamicIndexReader,
+ ENCRYPTED_KEY_BLOB_NAME,
+ FixedChunkStream,
+ FixedIndexReader,
+ KeyConfig,
+ IndexFile,
+ MANIFEST_BLOB_NAME,
+ Shell,
+};
+
+mod proxmox_backup_client;
+use proxmox_backup_client::*;
+
+const ENV_VAR_PBS_FINGERPRINT: &str = "PBS_FINGERPRINT";
+const ENV_VAR_PBS_PASSWORD: &str = "PBS_PASSWORD";
+
+
+pub const REPO_URL_SCHEMA: Schema = StringSchema::new("Repository URL.")
+ .format(&BACKUP_REPO_URL)
+ .max_length(256)
+ .schema();
+
+pub const KEYFILE_SCHEMA: Schema = StringSchema::new(
+ "Path to encryption key. All data will be encrypted using this key.")
+ .schema();
+
+pub const KEYFD_SCHEMA: Schema = IntegerSchema::new(
+ "Pass an encryption key via an already opened file descriptor.")
+ .minimum(0)
+ .schema();
+
+const CHUNK_SIZE_SCHEMA: Schema = IntegerSchema::new(
+ "Chunk size in KB. Must be a power of 2.")
+ .minimum(64)
+ .maximum(4096)
+ .default(4096)
+ .schema();
fn get_default_repository() -> Option<String> {
std::env::var("PBS_REPOSITORY").ok()
}
-fn extract_repository_from_value(
+pub fn extract_repository_from_value(
param: &Value,
) -> Result<BackupRepository, Error> {
_ => return,
};
- let mut data = file_get_json(&path, None).unwrap_or(json!({}));
+ let mut data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
let repo = repo.to_string();
let new_data = json!(map);
- let _ = file_set_contents(path, new_data.to_string().as_bytes(), None);
+ let _ = replace_file(path, new_data.to_string().as_bytes(), CreateOptions::new());
}
-fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
+pub fn complete_repository(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
let mut result = vec![];
_ => return result,
};
- let data = file_get_json(&path, None).unwrap_or(json!({}));
+ let data = file_get_json(&path, None).unwrap_or_else(|_| json!({}));
if let Some(map) = data.as_object() {
for (repo, _count) in map {
result
}
-fn compute_file_csum(file: &mut std::fs::File) -> Result<([u8; 32], u64), Error> {
+fn connect(repo: &BackupRepository) -> Result<HttpClient, Error> {
+ connect_do(repo.host(), repo.port(), repo.auth_id())
+ .map_err(|err| format_err!("error building client for repository {} - {}", repo, err))
+}
- file.seek(SeekFrom::Start(0))?;
+fn connect_do(server: &str, port: u16, auth_id: &Authid) -> Result<HttpClient, Error> {
+ let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
- let mut hasher = openssl::sha::Sha256::new();
- let mut buffer = proxmox::tools::vec::undefined(256*1024);
- let mut size: u64 = 0;
+ use std::env::VarError::*;
+ let password = match std::env::var(ENV_VAR_PBS_PASSWORD) {
+ Ok(p) => Some(p),
+ Err(NotUnicode(_)) => bail!(format!("{} contains bad characters", ENV_VAR_PBS_PASSWORD)),
+ Err(NotPresent) => None,
+ };
- loop {
- let count = match file.read(&mut buffer) {
- Ok(count) => count,
- Err(ref err) if err.kind() == std::io::ErrorKind::Interrupted => { continue; }
- Err(err) => return Err(err.into()),
- };
- if count == 0 {
- break;
+ let options = HttpClientOptions::new()
+ .prefix(Some("proxmox-backup".to_string()))
+ .password(password)
+ .interactive(true)
+ .fingerprint(fingerprint)
+ .fingerprint_cache(true)
+ .ticket_cache(true);
+
+ HttpClient::new(server, port, auth_id, options)
+}
+
+async fn view_task_result(
+ client: HttpClient,
+ result: Value,
+ output_format: &str,
+) -> Result<(), Error> {
+ let data = &result["data"];
+ if output_format == "text" {
+ if let Some(upid) = data.as_str() {
+ display_task_log(client, upid, true).await?;
}
- size += count as u64;
- hasher.update(&buffer[..count]);
+ } else {
+ format_and_print_result(&data, &output_format);
+ }
+
+ Ok(())
+}
+
+async fn api_datastore_list_snapshots(
+ client: &HttpClient,
+ store: &str,
+ group: Option<BackupGroup>,
+) -> Result<Value, Error> {
+
+ let path = format!("api2/json/admin/datastore/{}/snapshots", store);
+
+ let mut args = json!({});
+ if let Some(group) = group {
+ args["backup-type"] = group.backup_type().into();
+ args["backup-id"] = group.backup_id().into();
}
- let csum = hasher.finish();
+ let mut result = client.get(&path, Some(args)).await?;
- Ok((csum, size))
+ Ok(result["data"].take())
}
+pub async fn api_datastore_latest_snapshot(
+ client: &HttpClient,
+ store: &str,
+ group: BackupGroup,
+) -> Result<(String, String, i64), Error> {
+
+ let list = api_datastore_list_snapshots(client, store, Some(group.clone())).await?;
+ let mut list: Vec<SnapshotListItem> = serde_json::from_value(list)?;
+
+ if list.is_empty() {
+ bail!("backup group {:?} does not contain any snapshots.", group.group_path());
+ }
+
+ list.sort_unstable_by(|a, b| b.backup_time.cmp(&a.backup_time));
+
+ let backup_time = list[0].backup_time;
+
+ Ok((group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time))
+}
async fn backup_directory<P: AsRef<Path>>(
- client: &BackupClient,
+ client: &BackupWriter,
dir_path: P,
archive_name: &str,
chunk_size: Option<usize>,
- device_set: Option<HashSet<u64>>,
- verbose: bool,
- skip_lost_and_found: bool,
- crypt_config: Option<Arc<CryptConfig>>,
- catalog: Arc<Mutex<CatalogBlobWriter<std::fs::File>>>,
+ catalog: Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
+ pxar_create_options: proxmox_backup::pxar::PxarCreateOptions,
+ upload_options: UploadOptions,
) -> Result<BackupStats, Error> {
- let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), device_set, verbose, skip_lost_and_found, catalog)?;
+ let pxar_stream = PxarBackupStream::open(
+ dir_path.as_ref(),
+ catalog,
+ pxar_create_options,
+ )?;
let mut chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
- let (mut tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
+ let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
- let stream = rx
+ let stream = ReceiverStream::new(rx)
.map_err(Error::from);
// spawn chunker inside a separate task so that it can run parallel
tokio::spawn(async move {
- let _ = tx.send_all(&mut chunk_stream).await;
+ while let Some(v) = chunk_stream.next().await {
+ let _ = tx.send(v).await;
+ }
});
+ if upload_options.fixed_size.is_some() {
+ bail!("cannot backup directory with fixed chunk size!");
+ }
+
let stats = client
- .upload_stream(archive_name, stream, "dynamic", None, crypt_config)
+ .upload_stream(archive_name, stream, upload_options)
.await?;
Ok(stats)
}
async fn backup_image<P: AsRef<Path>>(
- client: &BackupClient,
+ client: &BackupWriter,
image_path: P,
archive_name: &str,
- image_size: u64,
chunk_size: Option<usize>,
- _verbose: bool,
- crypt_config: Option<Arc<CryptConfig>>,
+ upload_options: UploadOptions,
) -> Result<BackupStats, Error> {
let path = image_path.as_ref().to_owned();
let file = tokio::fs::File::open(path).await?;
- let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
+ let stream = tokio_util::codec::FramedRead::new(file, tokio_util::codec::BytesCodec::new())
.map_err(Error::from);
let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
+ if upload_options.fixed_size.is_none() {
+ bail!("cannot backup image with dynamic chunk size!");
+ }
+
let stats = client
- .upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config)
+ .upload_stream(archive_name, stream, upload_options)
.await?;
Ok(stats)
}
-fn strip_server_file_expenstion(name: &str) -> String {
-
- if name.ends_with(".didx") {
- return name[..name.len()-5].to_owned();
- } else if name.ends_with(".fidx") {
- return name[..name.len()-5].to_owned();
- } else if name.ends_with(".blob") {
- return name[..name.len()-5].to_owned();
- } else {
- return name.to_owned(); // should not happen
- }
-}
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// List backup groups.
+async fn list_backup_groups(param: Value) -> Result<Value, Error> {
-fn list_backup_groups(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ let output_format = get_output_format(¶m);
let repo = extract_repository_from_value(¶m)?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(&repo)?;
let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
- let mut result = async_main(async move {
- client.get(&path, None).await
- })?;
+ let mut result = client.get(&path, None).await?;
record_repository(&repo);
- // fixme: implement and use output formatter instead ..
- let list = result["data"].as_array_mut().unwrap();
-
- list.sort_unstable_by(|a, b| {
- let a_id = a["backup-id"].as_str().unwrap();
- let a_backup_type = a["backup-type"].as_str().unwrap();
- let b_id = b["backup-id"].as_str().unwrap();
- let b_backup_type = b["backup-type"].as_str().unwrap();
-
- let type_order = a_backup_type.cmp(b_backup_type);
- if type_order == std::cmp::Ordering::Equal {
- a_id.cmp(b_id)
- } else {
- type_order
- }
- });
-
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
-
- let mut result = vec![];
-
- for item in list {
+ let render_group_path = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ let group = BackupGroup::new(item.backup_type, item.backup_id);
+ Ok(group.group_path().to_str().unwrap().to_owned())
+ };
- let id = item["backup-id"].as_str().unwrap();
- let btype = item["backup-type"].as_str().unwrap();
- let epoch = item["last-backup"].as_i64().unwrap();
- let last_backup = Utc.timestamp(epoch, 0);
- let backup_count = item["backup-count"].as_u64().unwrap();
+ let render_last_backup = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.last_backup)?;
+ Ok(snapshot.relative_path().to_str().unwrap().to_owned())
+ };
- let group = BackupGroup::new(btype, id);
+ let render_files = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: GroupListItem = serde_json::from_value(record.to_owned())?;
+ Ok(tools::format::render_backup_file_list(&item.files))
+ };
- let path = group.group_path().to_str().unwrap().to_owned();
+ let options = default_table_format_options()
+ .sortby("backup-type", false)
+ .sortby("backup-id", false)
+ .column(ColumnConfig::new("backup-id").renderer(render_group_path).header("group"))
+ .column(
+ ColumnConfig::new("last-backup")
+ .renderer(render_last_backup)
+ .header("last snapshot")
+ .right_align(false)
+ )
+ .column(ColumnConfig::new("backup-count"))
+ .column(ColumnConfig::new("files").renderer(render_files));
- let files = item["files"].as_array().unwrap().iter()
- .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
+ let mut data: Value = result["data"].take();
- if output_format == "text" {
- println!(
- "{:20} | {} | {:5} | {}",
- path,
- BackupDir::backup_time_to_string(last_backup),
- backup_count,
- tools::join(&files, ' '),
- );
- } else {
- result.push(json!({
- "backup-type": btype,
- "backup-id": id,
- "last-backup": epoch,
- "backup-count": backup_count,
- "files": files,
- }));
- }
- }
+ let return_type = &proxmox_backup::api2::admin::datastore::API_METHOD_LIST_GROUPS.returns;
- if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
+ format_and_print_result_full(&mut data, return_type, &output_format, &options);
Ok(Value::Null)
}
-fn list_snapshots(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let repo = extract_repository_from_value(¶m)?;
-
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
-
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
-
- let mut args = json!({});
- if let Some(path) = param["group"].as_str() {
- let group = BackupGroup::parse(path)?;
- args["backup-type"] = group.backup_type().into();
- args["backup-id"] = group.backup_id().into();
- }
-
- let result = async_main(async move {
- client.get(&path, Some(args)).await
- })?;
-
- record_repository(&repo);
-
- let list = result["data"].as_array().unwrap();
-
- let mut result = vec![];
-
- for item in list {
-
- let id = item["backup-id"].as_str().unwrap();
- let btype = item["backup-type"].as_str().unwrap();
- let epoch = item["backup-time"].as_i64().unwrap();
-
- let snapshot = BackupDir::new(btype, id, epoch);
-
- let path = snapshot.relative_path().to_str().unwrap().to_owned();
-
- let files = item["files"].as_array().unwrap().iter()
- .map(|v| strip_server_file_expenstion(v.as_str().unwrap())).collect();
-
- if output_format == "text" {
- let size_str = if let Some(size) = item["size"].as_u64() {
- size.to_string()
- } else {
- String::from("-")
- };
- println!("{} | {} | {}", path, size_str, tools::join(&files, ' '));
- } else {
- let mut data = json!({
- "backup-type": btype,
- "backup-id": id,
- "backup-time": epoch,
- "files": files,
- });
- if let Some(size) = item["size"].as_u64() {
- data["size"] = size.into();
- }
- result.push(data);
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ group: {
+ type: String,
+ description: "Backup group.",
+ },
+ "new-owner": {
+ type: Authid,
+ },
}
- }
-
- if output_format != "text" { format_and_print_result(&result.into(), &output_format); }
-
- Ok(Value::Null)
-}
-
-fn forget_snapshots(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ }
+)]
+/// Change owner of a backup group
+async fn change_backup_owner(group: String, mut param: Value) -> Result<(), Error> {
let repo = extract_repository_from_value(¶m)?;
- let path = tools::required_string_param(¶m, "snapshot")?;
- let snapshot = BackupDir::parse(path)?;
+ let mut client = connect(&repo)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ param.as_object_mut().unwrap().remove("repository");
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
+ let group: BackupGroup = group.parse()?;
- let result = async_main(async move {
- client.delete(&path, Some(json!({
- "backup-type": snapshot.group().backup_type(),
- "backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
- }))).await
- })?;
+ param["backup-type"] = group.backup_type().into();
+ param["backup-id"] = group.backup_id().into();
+
+ let path = format!("api2/json/admin/datastore/{}/change-owner", repo.store());
+ client.post(&path, Some(param)).await?;
record_repository(&repo);
- Ok(result)
+ Ok(())
}
-fn api_login(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Try to login. If successful, store ticket.
+async fn api_login(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
- async_main(async move { client.login().await })?;
+ let client = connect(&repo)?;
+ client.login().await?;
record_repository(&repo);
Ok(Value::Null)
}
-fn api_logout(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Logout (delete stored ticket).
+fn api_logout(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- delete_ticket_info(repo.host(), repo.user())?;
+ delete_ticket_info("proxmox-backup", repo.host(), repo.user())?;
Ok(Value::Null)
}
-fn dump_catalog(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let repo = extract_repository_from_value(¶m)?;
-
- let path = tools::required_string_param(¶m, "snapshot")?;
- let snapshot = BackupDir::parse(path)?;
-
- let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
-
- let crypt_config = match keyfile {
- None => None,
- Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
- Some(Arc::new(CryptConfig::new(key)?))
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
}
- };
+ }
+)]
+/// Show client and optional server version
+async fn api_version(param: Value) -> Result<(), Error> {
+
+ let output_format = get_output_format(¶m);
+
+ let mut version_info = json!({
+ "client": {
+ "version": version::PROXMOX_PKG_VERSION,
+ "release": version::PROXMOX_PKG_RELEASE,
+ "repoid": version::PROXMOX_PKG_REPOID,
+ }
+ });
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let repo = extract_repository_from_value(¶m);
+ if let Ok(repo) = repo {
+ let client = connect(&repo)?;
- async_main(async move {
- let client = client.start_backup_reader(
- repo.store(),
- &snapshot.group().backup_type(),
- &snapshot.group().backup_id(),
- snapshot.backup_time(), true).await?;
+ match client.get("api2/json/version", None).await {
+ Ok(mut result) => version_info["server"] = result["data"].take(),
+ Err(e) => eprintln!("could not connect to server - {}", e),
+ }
+ }
+ if output_format == "text" {
+ println!("client version: {}.{}", version::PROXMOX_PKG_VERSION, version::PROXMOX_PKG_RELEASE);
+ if let Some(server) = version_info["server"].as_object() {
+ let server_version = server["version"].as_str().unwrap();
+ let server_release = server["release"].as_str().unwrap();
+ println!("server version: {}.{}", server_version, server_release);
+ }
+ } else {
+ format_and_print_result(&version_info, &output_format);
+ }
- let backup_index_data = download_index_blob(client.clone(), crypt_config.clone()).await?;
- let backup_index: Value = serde_json::from_slice(&backup_index_data[..])?;
+ Ok(())
+}
- let blob_file = std::fs::OpenOptions::new()
- .read(true)
- .write(true)
- .custom_flags(libc::O_TMPFILE)
- .open("/tmp")?;
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ },
+ },
+)]
+/// Start garbage collection for a specific repository.
+async fn start_garbage_collection(param: Value) -> Result<Value, Error> {
- let mut blob_file = client.download(CATALOG_BLOB_NAME, blob_file).await?;
+ let repo = extract_repository_from_value(¶m)?;
- let (csum, size) = compute_file_csum(&mut blob_file)?;
- verify_index_file(&backup_index, CATALOG_BLOB_NAME, &csum, size)?;
+ let output_format = get_output_format(¶m);
- blob_file.seek(SeekFrom::Start(0))?;
+ let mut client = connect(&repo)?;
- let reader = BufReader::new(blob_file);
- let mut catalog_reader = CatalogBlobReader::new(reader, crypt_config)?;
+ let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
- catalog_reader.dump()?;
+ let result = client.post(&path, None).await?;
- record_repository(&repo);
+ record_repository(&repo);
- Ok::<(), Error>(())
- })?;
+ view_task_result(client, result, &output_format).await?;
Ok(Value::Null)
}
-fn list_snapshot_files(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let repo = extract_repository_from_value(¶m)?;
-
- let path = tools::required_string_param(¶m, "snapshot")?;
- let snapshot = BackupDir::parse(path)?;
-
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
+struct CatalogUploadResult {
+ catalog_writer: Arc<Mutex<CatalogWriter<crate::tools::StdChannelWriter>>>,
+ result: tokio::sync::oneshot::Receiver<Result<BackupStats, Error>>,
+}
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+fn spawn_catalog_upload(
+ client: Arc<BackupWriter>,
+ encrypt: bool,
+) -> Result<CatalogUploadResult, Error> {
+ let (catalog_tx, catalog_rx) = std::sync::mpsc::sync_channel(10); // allow to buffer 10 writes
+ let catalog_stream = crate::tools::StdChannelStream(catalog_rx);
+ let catalog_chunk_size = 512*1024;
+ let catalog_chunk_stream = ChunkStream::new(catalog_stream, Some(catalog_chunk_size));
- let path = format!("api2/json/admin/datastore/{}/files", repo.store());
+ let catalog_writer = Arc::new(Mutex::new(CatalogWriter::new(crate::tools::StdChannelWriter::new(catalog_tx))?));
- let mut result = async_main(async move {
- client.get(&path, Some(json!({
- "backup-type": snapshot.group().backup_type(),
- "backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
- }))).await
- })?;
+ let (catalog_result_tx, catalog_result_rx) = tokio::sync::oneshot::channel();
- record_repository(&repo);
+ let upload_options = UploadOptions {
+ encrypt,
+ compress: true,
+ ..UploadOptions::default()
+ };
- let list: Value = result["data"].take();
+ tokio::spawn(async move {
+ let catalog_upload_result = client
+ .upload_stream(CATALOG_NAME, catalog_chunk_stream, upload_options)
+ .await;
- if output_format == "text" {
- for item in list.as_array().unwrap().iter() {
- println!(
- "{} {}",
- strip_server_file_expenstion(item["filename"].as_str().unwrap()),
- item["size"].as_u64().unwrap_or(0),
- );
+ if let Err(ref err) = catalog_upload_result {
+ eprintln!("catalog upload error - {}", err);
+ client.cancel();
}
- } else {
- format_and_print_result(&list, &output_format);
- }
- Ok(Value::Null)
-}
+ let _ = catalog_result_tx.send(catalog_upload_result);
+ });
-fn start_garbage_collection(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ Ok(CatalogUploadResult { catalog_writer, result: catalog_result_rx })
+}
- let repo = extract_repository_from_value(¶m)?;
+fn keyfile_parameters(param: &Value) -> Result<(Option<Vec<u8>>, CryptMode), Error> {
+ let keyfile = match param.get("keyfile") {
+ Some(Value::String(keyfile)) => Some(keyfile),
+ Some(_) => bail!("bad --keyfile parameter type"),
+ None => None,
+ };
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let key_fd = match param.get("keyfd") {
+ Some(Value::Number(key_fd)) => Some(
+ RawFd::try_from(key_fd
+ .as_i64()
+ .ok_or_else(|| format_err!("bad key fd: {:?}", key_fd))?
+ )
+ .map_err(|err| format_err!("bad key fd: {:?}: {}", key_fd, err))?
+ ),
+ Some(_) => bail!("bad --keyfd parameter type"),
+ None => None,
+ };
- let path = format!("api2/json/admin/datastore/{}/gc", repo.store());
+ let crypt_mode: Option<CryptMode> = match param.get("crypt-mode") {
+ Some(mode) => Some(serde_json::from_value(mode.clone())?),
+ None => None,
+ };
- let result = async_main(async move { client.post(&path, None).await })?;
+ let keydata = match (keyfile, key_fd) {
+ (None, None) => None,
+ (Some(_), Some(_)) => bail!("--keyfile and --keyfd are mutually exclusive"),
+ (Some(keyfile), None) => {
+ eprintln!("Using encryption key file: {}", keyfile);
+ Some(file_get_contents(keyfile)?)
+ },
+ (None, Some(fd)) => {
+ let input = unsafe { std::fs::File::from_raw_fd(fd) };
+ let mut data = Vec::new();
+ let _len: usize = { input }.read_to_end(&mut data)
+ .map_err(|err| {
+ format_err!("error reading encryption key from fd {}: {}", fd, err)
+ })?;
+ eprintln!("Using encryption key from file descriptor");
+ Some(data)
+ }
+ };
- record_repository(&repo);
+ Ok(match (keydata, crypt_mode) {
+ // no parameters:
+ (None, None) => match key::read_optional_default_encryption_key()? {
+ Some(key) => {
+ eprintln!("Encrypting with default encryption key!");
+ (Some(key), CryptMode::Encrypt)
+ },
+ None => (None, CryptMode::None),
+ },
+
+ // just --crypt-mode=none
+ (None, Some(CryptMode::None)) => (None, CryptMode::None),
+
+ // just --crypt-mode other than none
+ (None, Some(crypt_mode)) => match key::read_optional_default_encryption_key()? {
+ None => bail!("--crypt-mode without --keyfile and no default key file available"),
+ Some(key) => {
+ eprintln!("Encrypting with default encryption key!");
+ (Some(key), crypt_mode)
+ },
+ }
- Ok(result)
-}
+ // just --keyfile
+ (Some(key), None) => (Some(key), CryptMode::Encrypt),
-fn parse_backupspec(value: &str) -> Result<(&str, &str), Error> {
+ // --keyfile and --crypt-mode=none
+ (Some(_), Some(CryptMode::None)) => {
+ bail!("--keyfile/--keyfd and --crypt-mode=none are mutually exclusive");
+ }
- if let Some(caps) = BACKUPSPEC_REGEX.captures(value) {
- return Ok((caps.get(1).unwrap().as_str(), caps.get(2).unwrap().as_str()));
- }
- bail!("unable to parse directory specification '{}'", value);
+ // --keyfile and --crypt-mode other than none
+ (Some(key), Some(crypt_mode)) => (Some(key), crypt_mode),
+ })
}
-fn create_backup(
+#[api(
+ input: {
+ properties: {
+ backupspec: {
+ type: Array,
+ description: "List of backup source specifications ([<label.ext>:<path>] ...)",
+ items: {
+ schema: BACKUP_SOURCE_SCHEMA,
+ }
+ },
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "include-dev": {
+ description: "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
+ optional: true,
+ items: {
+ type: String,
+ description: "Path to file.",
+ }
+ },
+ "all-file-systems": {
+ type: Boolean,
+ description: "Include all mounted subdirectories.",
+ optional: true,
+ },
+ keyfile: {
+ schema: KEYFILE_SCHEMA,
+ optional: true,
+ },
+ "keyfd": {
+ schema: KEYFD_SCHEMA,
+ optional: true,
+ },
+ "crypt-mode": {
+ type: CryptMode,
+ optional: true,
+ },
+ "skip-lost-and-found": {
+ type: Boolean,
+ description: "Skip lost+found directory.",
+ optional: true,
+ },
+ "backup-type": {
+ schema: BACKUP_TYPE_SCHEMA,
+ optional: true,
+ },
+ "backup-id": {
+ schema: BACKUP_ID_SCHEMA,
+ optional: true,
+ },
+ "backup-time": {
+ schema: BACKUP_TIME_SCHEMA,
+ optional: true,
+ },
+ "chunk-size": {
+ schema: CHUNK_SIZE_SCHEMA,
+ optional: true,
+ },
+ "exclude": {
+ type: Array,
+ description: "List of paths or patterns for matching files to exclude.",
+ optional: true,
+ items: {
+ type: String,
+ description: "Path or match pattern.",
+ }
+ },
+ "entries-max": {
+ type: Integer,
+ description: "Max number of entries to hold in memory.",
+ optional: true,
+ default: proxmox_backup::pxar::ENCODER_MAX_ENTRIES as isize,
+ },
+ "verbose": {
+ type: Boolean,
+ description: "Verbose output.",
+ optional: true,
+ },
+ }
+ }
+)]
+/// Create (host) backup.
+async fn create_backup(
param: Value,
_info: &ApiMethod,
_rpcenv: &mut dyn RpcEnvironment,
verify_chunk_size(size)?;
}
- let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
+ let (keydata, crypt_mode) = keyfile_parameters(¶m)?;
let backup_id = param["backup-id"].as_str().unwrap_or(&proxmox::tools::nodename());
let include_dev = param["include-dev"].as_array();
+ let entries_max = param["entries-max"].as_u64()
+ .unwrap_or(proxmox_backup::pxar::ENCODER_MAX_ENTRIES as u64);
+
+ let empty = Vec::new();
+ let exclude_args = param["exclude"].as_array().unwrap_or(&empty);
+
+ let mut pattern_list = Vec::with_capacity(exclude_args.len());
+ for entry in exclude_args {
+ let entry = entry.as_str().ok_or_else(|| format_err!("Invalid pattern string slice"))?;
+ pattern_list.push(
+ MatchEntry::parse_pattern(entry, PatternFlag::PATH_NAME, MatchType::Exclude)
+ .map_err(|err| format_err!("invalid exclude pattern entry: {}", err))?
+ );
+ }
+
let mut devices = if all_file_systems { None } else { Some(HashSet::new()) };
if let Some(include_dev) = include_dev {
}
let mut upload_list = vec![];
-
- enum BackupType { PXAR, IMAGE, CONFIG, LOGFILE };
+ let mut target_set = HashSet::new();
for backupspec in backupspec_list {
- let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
+ let spec = parse_backup_specification(backupspec.as_str().unwrap())?;
+ let filename = &spec.config_string;
+ let target = &spec.archive_name;
+
+ if target_set.contains(target) {
+ bail!("got target twice: '{}'", target);
+ }
+ target_set.insert(target.to_string());
use std::os::unix::fs::FileTypeExt;
.map_err(|err| format_err!("unable to access '{}' - {}", filename, err))?;
let file_type = metadata.file_type();
- let extension = target.rsplit('.').next()
- .ok_or(format_err!("missing target file extenion '{}'", target))?;
-
- match extension {
- "pxar" => {
+ match spec.spec_type {
+ BackupSpecificationType::PXAR => {
if !file_type.is_dir() {
bail!("got unexpected file type (expected directory)");
}
- upload_list.push((BackupType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
+ upload_list.push((BackupSpecificationType::PXAR, filename.to_owned(), format!("{}.didx", target), 0));
}
- "img" => {
-
+ BackupSpecificationType::IMAGE => {
if !(file_type.is_file() || file_type.is_block_device()) {
bail!("got unexpected file type (expected file or block device)");
}
if size == 0 { bail!("got zero-sized file '{}'", filename); }
- upload_list.push((BackupType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
+ upload_list.push((BackupSpecificationType::IMAGE, filename.to_owned(), format!("{}.fidx", target), size));
}
- "conf" => {
+ BackupSpecificationType::CONFIG => {
if !file_type.is_file() {
bail!("got unexpected file type (expected regular file)");
}
- upload_list.push((BackupType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
+ upload_list.push((BackupSpecificationType::CONFIG, filename.to_owned(), format!("{}.blob", target), metadata.len()));
}
- "log" => {
+ BackupSpecificationType::LOGFILE => {
if !file_type.is_file() {
bail!("got unexpected file type (expected regular file)");
}
- upload_list.push((BackupType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
- }
- _ => {
- bail!("got unknown archive extension '{}'", extension);
+ upload_list.push((BackupSpecificationType::LOGFILE, filename.to_owned(), format!("{}.blob", target), metadata.len()));
}
}
}
- let backup_time = Utc.timestamp(backup_time_opt.unwrap_or(Utc::now().timestamp()), 0);
+ let backup_time = backup_time_opt.unwrap_or_else(epoch_i64);
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(&repo)?;
record_repository(&repo);
- println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time));
+ println!("Starting backup: {}/{}/{}", backup_type, backup_id, BackupDir::backup_time_to_string(backup_time)?);
println!("Client name: {}", proxmox::tools::nodename());
- let start_time = Local::now();
+ let start_time = std::time::Instant::now();
- println!("Starting protocol: {}", start_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
+ println!("Starting backup protocol: {}", strftime_local("%c", epoch_i64())?);
- let (crypt_config, rsa_encrypted_key) = match keyfile {
+ let (crypt_config, rsa_encrypted_key) = match keydata {
None => (None, None),
- Some(path) => {
- let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
+ Some(key) => {
+ let (key, created, fingerprint) = decrypt_key(&key, &key::get_encryption_key_password)?;
+ println!("Encryption key fingerprint: {}", fingerprint);
let crypt_config = CryptConfig::new(key)?;
- let path = master_pubkey_path()?;
- if path.exists() {
- let pem_data = file_get_contents(&path)?;
- let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
- let enc_key = crypt_config.generate_rsa_encoded_key(rsa, created)?;
- (Some(Arc::new(crypt_config)), Some(enc_key))
- } else {
- (Some(Arc::new(crypt_config)), None)
+ match key::find_master_pubkey()? {
+ Some(ref path) if path.exists() => {
+ let pem_data = file_get_contents(path)?;
+ let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
+
+ let mut key_config = KeyConfig::without_password(key)?;
+ key_config.created = created; // keep original value
+
+ let enc_key = rsa_encrypt_key_config(rsa, &key_config)?;
+ println!("Master key '{:?}'", path);
+
+ (Some(Arc::new(crypt_config)), Some(enc_key))
+ }
+ _ => (Some(Arc::new(crypt_config)), None),
}
}
};
- async_main(async move {
- let client = client
- .start_backup(repo.store(), backup_type, &backup_id, backup_time, verbose)
- .await?;
+ let client = BackupWriter::start(
+ client,
+ crypt_config.clone(),
+ repo.store(),
+ backup_type,
+ &backup_id,
+ backup_time,
+ verbose,
+ false
+ ).await?;
+
+ let download_previous_manifest = match client.previous_backup_time().await {
+ Ok(Some(backup_time)) => {
+ println!(
+ "Downloading previous manifest ({})",
+ strftime_local("%c", backup_time)?
+ );
+ true
+ }
+ Ok(None) => {
+ println!("No previous manifest available.");
+ false
+ }
+ Err(_) => {
+ // Fallback for outdated server, TODO remove/bubble up with 2.0
+ true
+ }
+ };
- let mut file_list = vec![];
-
- // fixme: encrypt/sign catalog?
- let catalog_file = std::fs::OpenOptions::new()
- .write(true)
- .read(true)
- .custom_flags(libc::O_TMPFILE)
- .open("/tmp")?;
-
- let catalog = Arc::new(Mutex::new(CatalogBlobWriter::new_compressed(catalog_file)?));
- let mut upload_catalog = false;
-
- for (backup_type, filename, target, size) in upload_list {
- match backup_type {
- BackupType::CONFIG => {
- println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
- let stats = client
- .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
- .await?;
- file_list.push((target, stats));
- }
- BackupType::LOGFILE => { // fixme: remove - not needed anymore ?
- println!("Upload log file '{}' to '{:?}' as {}", filename, repo, target);
- let stats = client
- .upload_blob_from_file(&filename, &target, crypt_config.clone(), true)
- .await?;
- file_list.push((target, stats));
- }
- BackupType::PXAR => {
- upload_catalog = true;
- println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
- catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
- let stats = backup_directory(
- &client,
- &filename,
- &target,
- chunk_size_opt,
- devices.clone(),
- verbose,
- skip_lost_and_found,
- crypt_config.clone(),
- catalog.clone(),
- ).await?;
- file_list.push((target, stats));
- catalog.lock().unwrap().end_directory()?;
- }
- BackupType::IMAGE => {
- println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
- let stats = backup_image(
- &client,
- &filename,
- &target,
- size,
- chunk_size_opt,
- verbose,
- crypt_config.clone(),
- ).await?;
- file_list.push((target, stats));
+ let previous_manifest = if download_previous_manifest {
+ match client.download_previous_manifest().await {
+ Ok(previous_manifest) => {
+ match previous_manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref)) {
+ Ok(()) => Some(Arc::new(previous_manifest)),
+ Err(err) => {
+ println!("Couldn't re-use previous manifest - {}", err);
+ None
+ }
}
}
+ Err(err) => {
+ println!("Couldn't download previous manifest - {}", err);
+ None
+ }
}
+ } else {
+ None
+ };
- // finalize and upload catalog
- if upload_catalog {
- let mutex = Arc::try_unwrap(catalog)
- .map_err(|_| format_err!("unable to get catalog (still used)"))?;
- let mut catalog_file = mutex.into_inner().unwrap().finish()?;
+ let snapshot = BackupDir::new(backup_type, backup_id, backup_time)?;
+ let mut manifest = BackupManifest::new(snapshot);
+
+ let mut catalog = None;
+ let mut catalog_result_rx = None;
+
+ for (backup_type, filename, target, size) in upload_list {
+ match backup_type {
+ BackupSpecificationType::CONFIG => {
+ let upload_options = UploadOptions {
+ compress: true,
+ encrypt: crypt_mode == CryptMode::Encrypt,
+ ..UploadOptions::default()
+ };
+
+ println!("Upload config file '{}' to '{}' as {}", filename, repo, target);
+ let stats = client
+ .upload_blob_from_file(&filename, &target, upload_options)
+ .await?;
+ manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
+ }
+ BackupSpecificationType::LOGFILE => { // fixme: remove - not needed anymore ?
+ let upload_options = UploadOptions {
+ compress: true,
+ encrypt: crypt_mode == CryptMode::Encrypt,
+ ..UploadOptions::default()
+ };
+
+ println!("Upload log file '{}' to '{}' as {}", filename, repo, target);
+ let stats = client
+ .upload_blob_from_file(&filename, &target, upload_options)
+ .await?;
+ manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
+ }
+ BackupSpecificationType::PXAR => {
+ // start catalog upload on first use
+ if catalog.is_none() {
+ let catalog_upload_res = spawn_catalog_upload(client.clone(), crypt_mode == CryptMode::Encrypt)?;
+ catalog = Some(catalog_upload_res.catalog_writer);
+ catalog_result_rx = Some(catalog_upload_res.result);
+ }
+ let catalog = catalog.as_ref().unwrap();
+
+ println!("Upload directory '{}' to '{}' as {}", filename, repo, target);
+ catalog.lock().unwrap().start_directory(std::ffi::CString::new(target.as_str())?.as_c_str())?;
+
+ let pxar_options = proxmox_backup::pxar::PxarCreateOptions {
+ device_set: devices.clone(),
+ patterns: pattern_list.clone(),
+ entries_max: entries_max as usize,
+ skip_lost_and_found,
+ verbose,
+ };
+
+ let upload_options = UploadOptions {
+ previous_manifest: previous_manifest.clone(),
+ compress: true,
+ encrypt: crypt_mode == CryptMode::Encrypt,
+ ..UploadOptions::default()
+ };
+
+ let stats = backup_directory(
+ &client,
+ &filename,
+ &target,
+ chunk_size_opt,
+ catalog.clone(),
+ pxar_options,
+ upload_options,
+ ).await?;
+ manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
+ catalog.lock().unwrap().end_directory()?;
+ }
+ BackupSpecificationType::IMAGE => {
+ println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
+
+ let upload_options = UploadOptions {
+ previous_manifest: previous_manifest.clone(),
+ fixed_size: Some(size),
+ compress: true,
+ encrypt: crypt_mode == CryptMode::Encrypt,
+ };
+
+ let stats = backup_image(
+ &client,
+ &filename,
+ &target,
+ chunk_size_opt,
+ upload_options,
+ ).await?;
+ manifest.add_file(target, stats.size, stats.csum, crypt_mode)?;
+ }
+ }
+ }
- let target = CATALOG_BLOB_NAME;
+ // finalize and upload catalog
+ if let Some(catalog) = catalog {
+ let mutex = Arc::try_unwrap(catalog)
+ .map_err(|_| format_err!("unable to get catalog (still used)"))?;
+ let mut catalog = mutex.into_inner().unwrap();
- catalog_file.seek(SeekFrom::Start(0))?;
+ catalog.finish()?;
- let stats = client.upload_blob(catalog_file, target).await?;
- file_list.push((target.to_owned(), stats));
- }
+ drop(catalog); // close upload stream
- if let Some(rsa_encrypted_key) = rsa_encrypted_key {
- let target = "rsa-encrypted.key";
- println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
- let stats = client
- .upload_blob_from_data(rsa_encrypted_key, target, None, false, false)
- .await?;
- file_list.push((format!("{}.blob", target), stats));
-
- // openssl rsautl -decrypt -inkey master-private.pem -in rsa-encrypted.key -out t
- /*
- let mut buffer2 = vec![0u8; rsa.size() as usize];
- let pem_data = file_get_contents("master-private.pem")?;
- let rsa = openssl::rsa::Rsa::private_key_from_pem(&pem_data)?;
- let len = rsa.private_decrypt(&buffer, &mut buffer2, openssl::rsa::Padding::PKCS1)?;
- println!("TEST {} {:?}", len, buffer2);
- */
+ if let Some(catalog_result_rx) = catalog_result_rx {
+ let stats = catalog_result_rx.await??;
+ manifest.add_file(CATALOG_NAME.to_owned(), stats.size, stats.csum, crypt_mode)?;
}
+ }
- // create index.json
- let file_list = file_list.iter()
- .fold(vec![], |mut acc, (filename, stats)| {
- acc.push(json!({
- "filename": filename,
- "size": stats.size,
- "csum": proxmox::tools::digest_to_hex(&stats.csum),
- }));
- acc
- });
-
- let index = json!({
- "backup-type": backup_type,
- "backup-id": backup_id,
- "backup-time": backup_time.timestamp(),
- "files": file_list,
- });
-
- println!("Upload index.json to '{:?}'", repo);
- let index_data = serde_json::to_string_pretty(&index)?.into();
- client
- .upload_blob_from_data(index_data, "index.json.blob", crypt_config.clone(), true, true)
+ if let Some(rsa_encrypted_key) = rsa_encrypted_key {
+ let target = ENCRYPTED_KEY_BLOB_NAME;
+ println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
+ let options = UploadOptions { compress: false, encrypt: false, ..UploadOptions::default() };
+ let stats = client
+ .upload_blob_from_data(rsa_encrypted_key, target, options)
.await?;
+ manifest.add_file(target.to_string(), stats.size, stats.csum, crypt_mode)?;
- client.finish().await?;
+ }
+ // create manifest (index.json)
+ // manifests are never encrypted, but include a signature
+ let manifest = manifest.to_string(crypt_config.as_ref().map(Arc::as_ref))
+ .map_err(|err| format_err!("unable to format manifest - {}", err))?;
- let end_time = Local::now();
- let elapsed = end_time.signed_duration_since(start_time);
- println!("Duration: {}", elapsed);
- println!("End Time: {}", end_time.to_rfc3339_opts(chrono::SecondsFormat::Secs, false));
+ if verbose { println!("Upload index.json to '{}'", repo) };
+ let options = UploadOptions { compress: true, encrypt: false, ..UploadOptions::default() };
+ client
+ .upload_blob_from_data(manifest.into_bytes(), MANIFEST_BLOB_NAME, options)
+ .await?;
- Ok(Value::Null)
- })
-}
+ client.finish().await?;
+
+ let end_time = std::time::Instant::now();
+ let elapsed = end_time.duration_since(start_time);
+ println!("Duration: {:.2}s", elapsed.as_secs_f64());
+
+ println!("End Time: {}", strftime_local("%c", epoch_i64())?);
+
+ Ok(Value::Null)
+}
fn complete_backup_source(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
result
}
-fn restore(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
- async_main(restore_do(param))
-}
-
-async fn download_index_blob(client: Arc<BackupReader>, crypt_config: Option<Arc<CryptConfig>>) -> Result<Vec<u8>, Error> {
-
- let index_data = client.download(INDEX_BLOB_NAME, Vec::with_capacity(64*1024)).await?;
- let blob = DataBlob::from_raw(index_data)?;
- blob.verify_crc()?;
- blob.decode(crypt_config.as_ref().map(Arc::as_ref))
-}
-
-fn verify_index_file(backup_index: &Value, name: &str, csum: &[u8; 32], size: u64) -> Result<(), Error> {
-
- let files = backup_index["files"]
- .as_array()
- .ok_or_else(|| format_err!("mailformed index - missing 'files' property"))?;
-
- let info = files.iter().find(|v| {
- match v["filename"].as_str() {
- Some(filename) => filename == name,
- None => false,
- }
- });
-
- let info = match info {
- None => bail!("index does not contain file '{}'", name),
- Some(info) => info,
- };
-
- match info["size"].as_u64() {
- None => bail!("index does not contain property 'size' for file '{}'", name),
- Some(expected_size) => {
- if expected_size != size {
- bail!("verify index failed - wrong size for file '{}' ({} != {}", name, expected_size, size);
- }
- }
- };
-
- match info["csum"].as_str() {
- None => bail!("index does not contain property 'csum' for file '{}'", name),
- Some(expected_csum) => {
- let expected_csum = &proxmox::tools::hex_to_digest(expected_csum)?;
- if expected_csum != csum {
- bail!("verify index failed - wrong checksum for file '{}'", name);
- }
- }
- };
-
- Ok(())
-}
-
-fn dump_image<W: Write>(
+async fn dump_image<W: Write>(
client: Arc<BackupReader>,
crypt_config: Option<Arc<CryptConfig>>,
+ crypt_mode: CryptMode,
index: FixedIndexReader,
mut writer: W,
+ verbose: bool,
) -> Result<(), Error> {
let most_used = index.find_most_used_chunks(8);
- let mut chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
+ let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, crypt_mode, most_used);
// Note: we avoid using BufferedFixedReader, because that add an additional buffer/copy
// and thus slows down reading. Instead, directly use RemoteChunkReader
+ let mut per = 0;
+ let mut bytes = 0;
+ let start_time = std::time::Instant::now();
+
for pos in 0..index.index_count() {
let digest = index.index_digest(pos).unwrap();
- let raw_data = chunk_reader.read_chunk(&digest)?;
+ let raw_data = chunk_reader.read_chunk(&digest).await?;
writer.write_all(&raw_data)?;
+ bytes += raw_data.len();
+ if verbose {
+ let next_per = ((pos+1)*100)/index.index_count();
+ if per != next_per {
+ eprintln!("progress {}% (read {} bytes, duration {} sec)",
+ next_per, bytes, start_time.elapsed().as_secs());
+ per = next_per;
+ }
+ }
}
+ let end_time = std::time::Instant::now();
+ let elapsed = end_time.duration_since(start_time);
+ eprintln!("restore image complete (bytes={}, duration={:.2}s, speed={:.2}MB/s)",
+ bytes,
+ elapsed.as_secs_f64(),
+ bytes as f64/(1024.0*1024.0*elapsed.as_secs_f64())
+ );
+
+
Ok(())
}
-async fn restore_do(param: Value) -> Result<Value, Error> {
+fn parse_archive_type(name: &str) -> (String, ArchiveType) {
+ if name.ends_with(".didx") || name.ends_with(".fidx") || name.ends_with(".blob") {
+ (name.into(), archive_type(name).unwrap())
+ } else if name.ends_with(".pxar") {
+ (format!("{}.didx", name), ArchiveType::DynamicIndex)
+ } else if name.ends_with(".img") {
+ (format!("{}.fidx", name), ArchiveType::FixedIndex)
+ } else {
+ (format!("{}.blob", name), ArchiveType::Blob)
+ }
+}
+
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ snapshot: {
+ type: String,
+ description: "Group/Snapshot path.",
+ },
+ "archive-name": {
+ description: "Backup archive name.",
+ type: String,
+ },
+ target: {
+ type: String,
+ description: r###"Target directory path. Use '-' to write to standard output.
+
+We do not extraxt '.pxar' archives when writing to standard output.
+
+"###
+ },
+ "allow-existing-dirs": {
+ type: Boolean,
+ description: "Do not fail if directories already exists.",
+ optional: true,
+ },
+ keyfile: {
+ schema: KEYFILE_SCHEMA,
+ optional: true,
+ },
+ "keyfd": {
+ schema: KEYFD_SCHEMA,
+ optional: true,
+ },
+ "crypt-mode": {
+ type: CryptMode,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Restore backup repository.
+async fn restore(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
let verbose = param["verbose"].as_bool().unwrap_or(false);
let archive_name = tools::required_string_param(¶m, "archive-name")?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(&repo)?;
record_repository(&repo);
let path = tools::required_string_param(¶m, "snapshot")?;
let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
- let group = BackupGroup::parse(path)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.get(&path, Some(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))).await?;
-
- let list = result["data"].as_array().unwrap();
- if list.len() == 0 {
- bail!("backup group '{}' does not contain any snapshots:", path);
- }
-
- let epoch = list[0]["backup-time"].as_i64().unwrap();
- let backup_time = Utc.timestamp(epoch, 0);
- (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
+ let group: BackupGroup = path.parse()?;
+ api_datastore_latest_snapshot(&client, repo.store(), group).await?
} else {
- let snapshot = BackupDir::parse(path)?;
+ let snapshot: BackupDir = path.parse()?;
(snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
};
let target = tools::required_string_param(¶m, "target")?;
let target = if target == "-" { None } else { Some(target) };
- let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
+ let (keydata, _crypt_mode) = keyfile_parameters(¶m)?;
- let crypt_config = match keyfile {
+ let crypt_config = match keydata {
None => None,
- Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
+ Some(key) => {
+ let (key, _, fingerprint) = decrypt_key(&key, &key::get_encryption_key_password)?;
+ eprintln!("Encryption key fingerprint: '{}'", fingerprint);
Some(Arc::new(CryptConfig::new(key)?))
}
};
- let server_archive_name = if archive_name.ends_with(".pxar") {
- format!("{}.didx", archive_name)
- } else if archive_name.ends_with(".img") {
- format!("{}.fidx", archive_name)
- } else {
- format!("{}.blob", archive_name)
- };
+ let client = BackupReader::start(
+ client,
+ crypt_config.clone(),
+ repo.store(),
+ &backup_type,
+ &backup_id,
+ backup_time,
+ true,
+ ).await?;
- let client = client
- .start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true)
- .await?;
+ let (archive_name, archive_type) = parse_archive_type(archive_name);
- let tmpfile = std::fs::OpenOptions::new()
- .write(true)
- .read(true)
- .custom_flags(libc::O_TMPFILE)
- .open("/tmp")?;
+ let (manifest, backup_index_data) = client.download_manifest().await?;
+ if archive_name == ENCRYPTED_KEY_BLOB_NAME && crypt_config.is_none() {
+ eprintln!("Restoring encrypted key blob without original key - skipping manifest fingerprint check!")
+ } else {
+ manifest.check_fingerprint(crypt_config.as_ref().map(Arc::as_ref))?;
+ }
- let backup_index_data = download_index_blob(client.clone(), crypt_config.clone()).await?;
- let backup_index: Value = serde_json::from_slice(&backup_index_data[..])?;
-
- if server_archive_name == INDEX_BLOB_NAME {
+ if archive_name == MANIFEST_BLOB_NAME {
if let Some(target) = target {
- file_set_contents(target, &backup_index_data, None)?;
+ replace_file(target, &backup_index_data, CreateOptions::new())?;
} else {
let stdout = std::io::stdout();
let mut writer = stdout.lock();
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".blob") {
- let mut tmpfile = client.download(&server_archive_name, tmpfile).await?;
+ return Ok(Value::Null);
+ }
- let (csum, size) = compute_file_csum(&mut tmpfile)?;
- verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
+ let file_info = manifest.lookup_file_info(&archive_name)?;
- tmpfile.seek(SeekFrom::Start(0))?;
- let mut reader = DataBlobReader::new(tmpfile, crypt_config)?;
+ if archive_type == ArchiveType::Blob {
+
+ let mut reader = client.download_blob(&manifest, &archive_name).await?;
if let Some(target) = target {
let mut writer = std::fs::OpenOptions::new()
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".didx") {
- let tmpfile = client.download(&server_archive_name, tmpfile).await?;
-
- let index = DynamicIndexReader::new(tmpfile)
- .map_err(|err| format_err!("unable to read dynamic index '{}' - {}", archive_name, err))?;
-
- // Note: do not use values stored in index (not trusted) - instead, computed them again
- let (csum, size) = index.compute_csum();
+ } else if archive_type == ArchiveType::DynamicIndex {
- verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
+ let index = client.download_dynamic_index(&manifest, &archive_name).await?;
let most_used = index.find_most_used_chunks(8);
- let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
+ let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, file_info.chunk_crypt_mode(), most_used);
let mut reader = BufferedDynamicReader::new(index, chunk_reader);
if let Some(target) = target {
-
- let feature_flags = pxar::flags::DEFAULT;
- let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags, |path| {
- if verbose {
- println!("{:?}", path);
- }
- Ok(())
- });
- decoder.set_allow_existing_dirs(allow_existing_dirs);
-
-
- decoder.restore(Path::new(target), &Vec::new())?;
+ proxmox_backup::pxar::extract_archive(
+ pxar::decoder::Decoder::from_std(reader)?,
+ Path::new(target),
+ &[],
+ true,
+ proxmox_backup::pxar::Flags::DEFAULT,
+ allow_existing_dirs,
+ |path| {
+ if verbose {
+ println!("{:?}", path);
+ }
+ },
+ None,
+ )
+ .map_err(|err| format_err!("error extracting archive - {}", err))?;
} else {
let mut writer = std::fs::OpenOptions::new()
.write(true)
std::io::copy(&mut reader, &mut writer)
.map_err(|err| format_err!("unable to pipe data - {}", err))?;
}
- } else if server_archive_name.ends_with(".fidx") {
- let tmpfile = client.download(&server_archive_name, tmpfile).await?;
-
- let index = FixedIndexReader::new(tmpfile)
- .map_err(|err| format_err!("unable to read fixed index '{}' - {}", archive_name, err))?;
+ } else if archive_type == ArchiveType::FixedIndex {
- // Note: do not use values stored in index (not trusted) - instead, computed them again
- let (csum, size) = index.compute_csum();
-
- verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
+ let index = client.download_fixed_index(&manifest, &archive_name).await?;
let mut writer = if let Some(target) = target {
std::fs::OpenOptions::new()
.map_err(|err| format_err!("unable to open /dev/stdout - {}", err))?
};
- dump_image(client.clone(), crypt_config.clone(), index, &mut writer)?;
-
- } else {
- bail!("unknown archive file extension (expected .pxar of .img)");
+ dump_image(client.clone(), crypt_config.clone(), file_info.chunk_crypt_mode(), index, &mut writer, verbose).await?;
}
Ok(Value::Null)
}
-fn upload_log(
+const API_METHOD_PRUNE: ApiMethod = ApiMethod::new(
+ &ApiHandler::Async(&prune),
+ &ObjectSchema::new(
+ "Prune a backup repository.",
+ &proxmox_backup::add_common_prune_prameters!([
+ ("dry-run", true, &BooleanSchema::new(
+ "Just show what prune would do, but do not delete anything.")
+ .schema()),
+ ("group", false, &StringSchema::new("Backup group.").schema()),
+ ], [
+ ("output-format", true, &OUTPUT_FORMAT),
+ (
+ "quiet",
+ true,
+ &BooleanSchema::new("Minimal output - only show removals.")
+ .schema()
+ ),
+ ("repository", true, &REPO_URL_SCHEMA),
+ ])
+ )
+);
+
+fn prune<'a>(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ _rpcenv: &'a mut dyn RpcEnvironment,
+) -> proxmox::api::ApiFuture<'a> {
+ async move {
+ prune_async(param).await
+ }.boxed()
+}
- let logfile = tools::required_string_param(¶m, "logfile")?;
+async fn prune_async(mut param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let snapshot = tools::required_string_param(¶m, "snapshot")?;
- let snapshot = BackupDir::parse(snapshot)?;
+ let mut client = connect(&repo)?;
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
-
- let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
-
- let crypt_config = match keyfile {
- None => None,
- Some(path) => {
- let (key, _created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
- let crypt_config = CryptConfig::new(key)?;
- Some(Arc::new(crypt_config))
- }
- };
-
- let data = file_get_contents(logfile)?;
-
- let blob = DataBlob::encode(&data, crypt_config.as_ref().map(Arc::as_ref), true)?;
+ let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
- let raw_data = blob.into_inner();
+ let group = tools::required_string_param(¶m, "group")?;
+ let group: BackupGroup = group.parse()?;
- let path = format!("api2/json/admin/datastore/{}/upload-backup-log", repo.store());
+ let output_format = get_output_format(¶m);
- let args = json!({
- "backup-type": snapshot.group().backup_type(),
- "backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
- });
+ let quiet = param["quiet"].as_bool().unwrap_or(false);
- let body = hyper::Body::from(raw_data);
+ param.as_object_mut().unwrap().remove("repository");
+ param.as_object_mut().unwrap().remove("group");
+ param.as_object_mut().unwrap().remove("output-format");
+ param.as_object_mut().unwrap().remove("quiet");
- async_main(async move {
- client.upload("application/octet-stream", body, &path, Some(args)).await
- })
-}
+ param["backup-type"] = group.backup_type().into();
+ param["backup-id"] = group.backup_id().into();
-fn prune(
- mut param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+ let mut result = client.post(&path, Some(param)).await?;
- let repo = extract_repository_from_value(¶m)?;
+ record_repository(&repo);
- let mut client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let render_snapshot_path = |_v: &Value, record: &Value| -> Result<String, Error> {
+ let item: PruneListItem = serde_json::from_value(record.to_owned())?;
+ let snapshot = BackupDir::new(item.backup_type, item.backup_id, item.backup_time)?;
+ Ok(snapshot.relative_path().to_str().unwrap().to_owned())
+ };
- let path = format!("api2/json/admin/datastore/{}/prune", repo.store());
+ let render_prune_action = |v: &Value, _record: &Value| -> Result<String, Error> {
+ Ok(match v.as_bool() {
+ Some(true) => "keep",
+ Some(false) => "remove",
+ None => "unknown",
+ }.to_string())
+ };
- let group = tools::required_string_param(¶m, "group")?;
- let group = BackupGroup::parse(group)?;
+ let options = default_table_format_options()
+ .sortby("backup-type", false)
+ .sortby("backup-id", false)
+ .sortby("backup-time", false)
+ .column(ColumnConfig::new("backup-id").renderer(render_snapshot_path).header("snapshot"))
+ .column(ColumnConfig::new("backup-time").renderer(tools::format::render_epoch).header("date"))
+ .column(ColumnConfig::new("keep").renderer(render_prune_action).header("action"))
+ ;
- param.as_object_mut().unwrap().remove("repository");
- param.as_object_mut().unwrap().remove("group");
+ let return_type = &proxmox_backup::api2::admin::datastore::API_METHOD_PRUNE.returns;
- param["backup-type"] = group.backup_type().into();
- param["backup-id"] = group.backup_id().into();
+ let mut data = result["data"].take();
- let _result = async_main(async move { client.post(&path, Some(param)).await })?;
+ if quiet {
+ let list: Vec<Value> = data.as_array().unwrap().iter().filter(|item| {
+ item["keep"].as_bool() == Some(false)
+ }).cloned().collect();
+ data = list.into();
+ }
- record_repository(&repo);
+ format_and_print_result_full(&mut data, return_type, &output_format, &options);
Ok(Value::Null)
}
-fn status(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+#[api(
+ input: {
+ properties: {
+ repository: {
+ schema: REPO_URL_SCHEMA,
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ },
+ returns: {
+ type: StorageStatus,
+ },
+)]
+/// Get repository status.
+async fn status(param: Value) -> Result<Value, Error> {
let repo = extract_repository_from_value(¶m)?;
- let output_format = param["output-format"].as_str().unwrap_or("text").to_owned();
+ let output_format = get_output_format(¶m);
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
+ let client = connect(&repo)?;
let path = format!("api2/json/admin/datastore/{}/status", repo.store());
- let result = async_main(async move { client.get(&path, None).await })?;
- let data = &result["data"];
+ let mut result = client.get(&path, None).await?;
+ let mut data = result["data"].take();
record_repository(&repo);
- if output_format == "text" {
- let total = data["total"].as_u64().unwrap();
- let used = data["used"].as_u64().unwrap();
- let avail = data["avail"].as_u64().unwrap();
+ let render_total_percentage = |v: &Value, record: &Value| -> Result<String, Error> {
+ let v = v.as_u64().unwrap();
+ let total = record["total"].as_u64().unwrap();
let roundup = total/200;
+ let per = ((v+roundup)*100)/total;
+ let info = format!(" ({} %)", per);
+ Ok(format!("{} {:>8}", v, info))
+ };
- println!(
- "total: {} used: {} ({} %) available: {}",
- total,
- used,
- ((used+roundup)*100)/total,
- avail,
- );
- } else {
- format_and_print_result(data, &output_format);
- }
+ let options = default_table_format_options()
+ .noheader(true)
+ .column(ColumnConfig::new("total").renderer(render_total_percentage))
+ .column(ColumnConfig::new("used").renderer(render_total_percentage))
+ .column(ColumnConfig::new("avail").renderer(render_total_percentage));
+
+ let return_type = &API_METHOD_STATUS.returns;
+
+ format_and_print_result_full(&mut data, return_type, &output_format, &options);
Ok(Value::Null)
}
// like get, but simply ignore errors and return Null instead
async fn try_get(repo: &BackupRepository, url: &str) -> Value {
- let client = match HttpClient::new(repo.host(), repo.user(), None) {
+ let fingerprint = std::env::var(ENV_VAR_PBS_FINGERPRINT).ok();
+ let password = std::env::var(ENV_VAR_PBS_PASSWORD).ok();
+
+ let options = HttpClientOptions::new()
+ .prefix(Some("proxmox-backup".to_string()))
+ .password(password)
+ .interactive(false)
+ .fingerprint(fingerprint)
+ .fingerprint_cache(true)
+ .ticket_cache(true);
+
+ let client = match HttpClient::new(repo.host(), repo.port(), repo.auth_id(), options) {
Ok(v) => v,
_ => return Value::Null,
};
}
fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_backup_group_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_backup_group_do(param).await })
}
async fn complete_backup_group_do(param: &HashMap<String, String>) -> Vec<String> {
result
}
-fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_group_or_snapshot_do(arg, param).await })
+pub fn complete_group_or_snapshot(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+ proxmox_backup::tools::runtime::main(async { complete_group_or_snapshot_do(arg, param).await })
}
async fn complete_group_or_snapshot_do(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
}
fn complete_backup_snapshot(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_backup_snapshot_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_backup_snapshot_do(param).await })
}
async fn complete_backup_snapshot_do(param: &HashMap<String, String>) -> Vec<String> {
if let (Some(backup_id), Some(backup_type), Some(backup_time)) =
(item["backup-id"].as_str(), item["backup-type"].as_str(), item["backup-time"].as_i64())
{
- let snapshot = BackupDir::new(backup_type, backup_id, backup_time);
- result.push(snapshot.relative_path().to_str().unwrap().to_owned());
+ if let Ok(snapshot) = BackupDir::new(backup_type, backup_id, backup_time) {
+ result.push(snapshot.relative_path().to_str().unwrap().to_owned());
+ }
}
}
}
}
fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
- async_main(async { complete_server_file_name_do(param).await })
+ proxmox_backup::tools::runtime::main(async { complete_server_file_name_do(param).await })
}
async fn complete_server_file_name_do(param: &HashMap<String, String>) -> Vec<String> {
_ => return result,
};
- let snapshot = match param.get("snapshot") {
+ let snapshot: BackupDir = match param.get("snapshot") {
Some(path) => {
- match BackupDir::parse(path) {
+ match path.parse() {
Ok(v) => v,
_ => return result,
}
let query = tools::json_object_to_query(json!({
"backup-type": snapshot.group().backup_type(),
"backup-id": snapshot.group().backup_id(),
- "backup-time": snapshot.backup_time().timestamp(),
+ "backup-time": snapshot.backup_time(),
})).unwrap();
let path = format!("api2/json/admin/datastore/{}/files?{}", repo.store(), query);
fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
complete_server_file_name(arg, param)
.iter()
- .map(|v| strip_server_file_expenstion(&v))
+ .map(|v| tools::format::strip_server_file_extension(&v))
+ .collect()
+}
+
+pub fn complete_pxar_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+ complete_server_file_name(arg, param)
+ .iter()
+ .filter_map(|name| {
+ if name.ends_with(".pxar.didx") {
+ Some(tools::format::strip_server_file_extension(name))
+ } else {
+ None
+ }
+ })
+ .collect()
+}
+
+pub fn complete_img_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+ complete_server_file_name(arg, param)
+ .iter()
+ .filter_map(|name| {
+ if name.ends_with(".img.fidx") {
+ Some(tools::format::strip_server_file_extension(name))
+ } else {
+ None
+ }
+ })
.collect()
}
let mut size = 64;
loop {
result.push(size.to_string());
- size = size * 2;
+ size *= 2;
if size > 4096 { break; }
}
result
}
-fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
-
- // fixme: implement other input methods
-
- use std::env::VarError::*;
- match std::env::var("PBS_ENCRYPTION_PASSWORD") {
- Ok(p) => return Ok(p.as_bytes().to_vec()),
- Err(NotUnicode(_)) => bail!("PBS_ENCRYPTION_PASSWORD contains bad characters"),
- Err(NotPresent) => {
- // Try another method
- }
- }
-
- // If we're on a TTY, query the user for a password
- if crate::tools::tty::stdin_isatty() {
- return Ok(crate::tools::tty::read_password("Encryption Key Password: ")?);
- }
-
- bail!("no password input mechanism available");
+fn complete_auth_id(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+ proxmox_backup::tools::runtime::main(async { complete_auth_id_do(param).await })
}
-fn key_create(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
+async fn complete_auth_id_do(param: &HashMap<String, String>) -> Vec<String> {
- let path = tools::required_string_param(¶m, "path")?;
- let path = PathBuf::from(path);
+ let mut result = vec![];
- let kdf = param["kdf"].as_str().unwrap_or("scrypt");
+ let repo = match extract_repository_from_map(param) {
+ Some(v) => v,
+ _ => return result,
+ };
- let key = proxmox::sys::linux::random_data(32)?;
+ let data = try_get(&repo, "api2/json/access/users?include_tokens=true").await;
- if kdf == "scrypt" {
- // always read passphrase from tty
- if !crate::tools::tty::stdin_isatty() {
- bail!("unable to read passphrase - no tty");
+ if let Ok(parsed) = serde_json::from_value::<Vec<UserWithTokens>>(data) {
+ for user in parsed {
+ result.push(user.userid.to_string());
+ for token in user.tokens {
+ result.push(token.tokenid.to_string());
+ }
}
+ };
- let password = crate::tools::tty::read_password("Encryption Key Password: ")?;
-
- let key_config = encrypt_key_with_passphrase(&key, &password)?;
-
- store_key_config(&path, false, key_config)?;
-
- Ok(Value::Null)
- } else if kdf == "none" {
- let created = Local.timestamp(Local::now().timestamp(), 0);
-
- store_key_config(&path, false, KeyConfig {
- kdf: None,
- created,
- modified: created,
- data: key,
- })?;
-
- Ok(Value::Null)
- } else {
- unreachable!();
- }
-}
-
-fn master_pubkey_path() -> Result<PathBuf, Error> {
- let base = BaseDirectories::with_prefix("proxmox-backup")?;
-
- // usually $HOME/.config/proxmox-backup/master-public.pem
- let path = base.place_config_file("master-public.pem")?;
-
- Ok(path)
-}
-
-fn key_import_master_pubkey(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let path = tools::required_string_param(¶m, "path")?;
- let path = PathBuf::from(path);
-
- let pem_data = file_get_contents(&path)?;
-
- if let Err(err) = openssl::pkey::PKey::public_key_from_pem(&pem_data) {
- bail!("Unable to decode PEM data - {}", err);
- }
-
- let target_path = master_pubkey_path()?;
-
- file_set_contents(&target_path, &pem_data, None)?;
-
- println!("Imported public master key to {:?}", target_path);
-
- Ok(Value::Null)
+ result
}
-fn key_create_master_key(
- _param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- // we need a TTY to query the new password
- if !crate::tools::tty::stdin_isatty() {
- bail!("unable to create master key - no tty");
- }
-
- let rsa = openssl::rsa::Rsa::generate(4096)?;
- let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
-
- let new_pw = String::from_utf8(crate::tools::tty::read_password("Master Key Password: ")?)?;
- let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
-
- if new_pw != verify_pw {
- bail!("Password verification fail!");
- }
-
- if new_pw.len() < 5 {
- bail!("Password is too short!");
- }
-
- let pub_key: Vec<u8> = pkey.public_key_to_pem()?;
- let filename_pub = "master-public.pem";
- println!("Writing public master key to {}", filename_pub);
- file_set_contents(filename_pub, pub_key.as_slice(), None)?;
-
- let cipher = openssl::symm::Cipher::aes_256_cbc();
- let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, new_pw.as_bytes())?;
-
- let filename_priv = "master-private.pem";
- println!("Writing private master key to {}", filename_priv);
- file_set_contents(filename_priv, priv_key.as_slice(), None)?;
-
- Ok(Value::Null)
+use proxmox_backup::client::RemoteChunkReader;
+/// This is a workaround until we have cleaned up the chunk/reader/... infrastructure for better
+/// async use!
+///
+/// Ideally BufferedDynamicReader gets replaced so the LruCache maps to `BroadcastFuture<Chunk>`,
+/// so that we can properly access it from multiple threads simultaneously while not issuing
+/// duplicate simultaneous reads over http.
+pub struct BufferedDynamicReadAt {
+ inner: Mutex<BufferedDynamicReader<RemoteChunkReader>>,
}
-fn key_change_passphrase(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
- let path = tools::required_string_param(¶m, "path")?;
- let path = PathBuf::from(path);
-
- let kdf = param["kdf"].as_str().unwrap_or("scrypt");
-
- // we need a TTY to query the new password
- if !crate::tools::tty::stdin_isatty() {
- bail!("unable to change passphrase - no tty");
- }
-
- let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
-
- if kdf == "scrypt" {
-
- let new_pw = String::from_utf8(crate::tools::tty::read_password("New Password: ")?)?;
- let verify_pw = String::from_utf8(crate::tools::tty::read_password("Verify Password: ")?)?;
-
- if new_pw != verify_pw {
- bail!("Password verification fail!");
- }
-
- if new_pw.len() < 5 {
- bail!("Password is too short!");
+impl BufferedDynamicReadAt {
+ fn new(inner: BufferedDynamicReader<RemoteChunkReader>) -> Self {
+ Self {
+ inner: Mutex::new(inner),
}
-
- let mut new_key_config = encrypt_key_with_passphrase(&key, new_pw.as_bytes())?;
- new_key_config.created = created; // keep original value
-
- store_key_config(&path, true, new_key_config)?;
-
- Ok(Value::Null)
- } else if kdf == "none" {
- let modified = Local.timestamp(Local::now().timestamp(), 0);
-
- store_key_config(&path, true, KeyConfig {
- kdf: None,
- created, // keep original value
- modified,
- data: key.to_vec(),
- })?;
-
- Ok(Value::Null)
- } else {
- unreachable!();
}
}
-fn key_mgmt_cli() -> CliCommandMap {
-
- let kdf_schema: Arc<Schema> = Arc::new(
- StringSchema::new("Key derivation function. Choose 'none' to store the key unecrypted.")
- .format(Arc::new(ApiStringFormat::Enum(&["scrypt", "none"])))
- .default("scrypt")
- .into()
- );
-
- let key_create_cmd_def = CliCommand::new(
- ApiMethod::new(
- key_create,
- ObjectSchema::new("Create a new encryption key.")
- .required("path", StringSchema::new("File system path."))
- .optional("kdf", kdf_schema.clone())
- ))
- .arg_param(vec!["path"])
- .completion_cb("path", tools::complete_file_name);
-
- let key_change_passphrase_cmd_def = CliCommand::new(
- ApiMethod::new(
- key_change_passphrase,
- ObjectSchema::new("Change the passphrase required to decrypt the key.")
- .required("path", StringSchema::new("File system path."))
- .optional("kdf", kdf_schema.clone())
- ))
- .arg_param(vec!["path"])
- .completion_cb("path", tools::complete_file_name);
-
- let key_create_master_key_cmd_def = CliCommand::new(
- ApiMethod::new(
- key_create_master_key,
- ObjectSchema::new("Create a new 4096 bit RSA master pub/priv key pair.")
- ));
-
- let key_import_master_pubkey_cmd_def = CliCommand::new(
- ApiMethod::new(
- key_import_master_pubkey,
- ObjectSchema::new("Import a new RSA public key and use it as master key. The key is expected to be in '.pem' format.")
- .required("path", StringSchema::new("File system path."))
- ))
- .arg_param(vec!["path"])
- .completion_cb("path", tools::complete_file_name);
-
- let cmd_def = CliCommandMap::new()
- .insert("create".to_owned(), key_create_cmd_def.into())
- .insert("create-master-key".to_owned(), key_create_master_key_cmd_def.into())
- .insert("import-master-pubkey".to_owned(), key_import_master_pubkey_cmd_def.into())
- .insert("change-passphrase".to_owned(), key_change_passphrase_cmd_def.into());
-
- cmd_def
-}
-
-
-fn mount(
- param: Value,
- _info: &ApiMethod,
- _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
- let verbose = param["verbose"].as_bool().unwrap_or(false);
- if verbose {
- // This will stay in foreground with debug output enabled as None is
- // passed for the RawFd.
- return async_main(mount_do(param, None));
+impl ReadAt for BufferedDynamicReadAt {
+ fn start_read_at<'a>(
+ self: Pin<&'a Self>,
+ _cx: &mut Context,
+ buf: &'a mut [u8],
+ offset: u64,
+ ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
+ MaybeReady::Ready(tokio::task::block_in_place(move || {
+ let mut reader = self.inner.lock().unwrap();
+ reader.seek(SeekFrom::Start(offset))?;
+ Ok(reader.read(buf)?)
+ }))
}
- // Process should be deamonized.
- // Make sure to fork before the async runtime is instantiated to avoid troubles.
- let pipe = pipe()?;
- match fork() {
- Ok(ForkResult::Parent { child: _, .. }) => {
- nix::unistd::close(pipe.1).unwrap();
- // Blocks the parent process until we are ready to go in the child
- let _res = nix::unistd::read(pipe.0, &mut [0]).unwrap();
- Ok(Value::Null)
- }
- Ok(ForkResult::Child) => {
- nix::unistd::close(pipe.0).unwrap();
- nix::unistd::setsid().unwrap();
- async_main(mount_do(param, Some(pipe.1)))
- }
- Err(_) => bail!("failed to daemonize process"),
- }
-}
-
-async fn mount_do(param: Value, pipe: Option<RawFd>) -> Result<Value, Error> {
- let repo = extract_repository_from_value(¶m)?;
- let archive_name = tools::required_string_param(¶m, "archive-name")?;
- let target = tools::required_string_param(¶m, "target")?;
- let client = HttpClient::new(repo.host(), repo.user(), None)?;
-
- record_repository(&repo);
-
- let path = tools::required_string_param(¶m, "snapshot")?;
- let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
- let group = BackupGroup::parse(path)?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.get(&path, Some(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))).await?;
-
- let list = result["data"].as_array().unwrap();
- if list.len() == 0 {
- bail!("backup group '{}' does not contain any snapshots:", path);
- }
-
- let epoch = list[0]["backup-time"].as_i64().unwrap();
- let backup_time = Utc.timestamp(epoch, 0);
- (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
- } else {
- let snapshot = BackupDir::parse(path)?;
- (snapshot.group().backup_type().to_owned(), snapshot.group().backup_id().to_owned(), snapshot.backup_time())
- };
-
- let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
- let crypt_config = match keyfile {
- None => None,
- Some(path) => {
- let (key, _) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
- Some(Arc::new(CryptConfig::new(key)?))
- }
- };
-
- let server_archive_name = if archive_name.ends_with(".pxar") {
- format!("{}.didx", archive_name)
- } else {
- bail!("Can only mount pxar archives.");
- };
-
- let client = client
- .start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true)
- .await?;
-
- let tmpfile = std::fs::OpenOptions::new()
- .write(true)
- .read(true)
- .custom_flags(libc::O_TMPFILE)
- .open("/tmp")?;
-
- let backup_index_data = download_index_blob(client.clone(), crypt_config.clone()).await?;
- let backup_index: Value = serde_json::from_slice(&backup_index_data[..])?;
- if server_archive_name.ends_with(".didx") {
- let tmpfile = client.download(&server_archive_name, tmpfile).await?;
- let index = DynamicIndexReader::new(tmpfile)
- .map_err(|err| format_err!("unable to read dynamic index '{}' - {}", archive_name, err))?;
-
- // Note: do not use values stored in index (not trusted) - instead, computed them again
- let (csum, size) = index.compute_csum();
- verify_index_file(&backup_index, &server_archive_name, &csum, size)?;
-
- let most_used = index.find_most_used_chunks(8);
- let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
- let reader = BufferedDynamicReader::new(index, chunk_reader);
- let decoder =
- pxar::Decoder::<Box<dyn pxar::fuse::ReadSeek>, fn(&Path) -> Result<(), Error>>::new(
- Box::new(reader),
- |_| Ok(()),
- )?;
- let options = OsStr::new("ro,default_permissions");
- let mut session = pxar::fuse::Session::from_decoder(decoder, &options, pipe.is_none())
- .map_err(|err| format_err!("pxar mount failed: {}", err))?;
-
- // Mount the session but not call fuse deamonize as this will cause
- // issues with the runtime after the fork
- let deamonize = false;
- session.mount(&Path::new(target), deamonize)?;
-
- if let Some(pipe) = pipe {
- nix::unistd::chdir(Path::new("/")).unwrap();
- // Finish creation of deamon by redirecting filedescriptors.
- let nullfd = nix::fcntl::open(
- "/dev/null",
- nix::fcntl::OFlag::O_RDWR,
- nix::sys::stat::Mode::empty(),
- ).unwrap();
- nix::unistd::dup2(nullfd, 0).unwrap();
- nix::unistd::dup2(nullfd, 1).unwrap();
- nix::unistd::dup2(nullfd, 2).unwrap();
- if nullfd > 2 {
- nix::unistd::close(nullfd).unwrap();
- }
- // Signal the parent process that we are done with the setup and it can
- // terminate.
- nix::unistd::write(pipe, &mut [0u8])?;
- nix::unistd::close(pipe).unwrap();
- }
-
- let multithreaded = true;
- session.run_loop(multithreaded)?;
- } else {
- bail!("unknown archive file extension (expected .pxar)");
+ fn poll_complete<'a>(
+ self: Pin<&'a Self>,
+ _op: ReadAtOperation<'a>,
+ ) -> MaybeReady<io::Result<usize>, ReadAtOperation<'a>> {
+ panic!("LocalDynamicReadAt::start_read_at returned Pending");
}
-
- Ok(Value::Null)
}
fn main() {
- let backup_source_schema: Arc<Schema> = Arc::new(
- StringSchema::new("Backup source specification ([<label>:<path>]).")
- .format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
- .into()
- );
-
- let backup_cmd_def = CliCommand::new(
- ApiMethod::new(
- create_backup,
- ObjectSchema::new("Create (host) backup.")
- .required(
- "backupspec",
- ArraySchema::new(
- "List of backup source specifications ([<label.ext>:<path>] ...)",
- backup_source_schema,
- ).min_length(1)
- )
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional(
- "include-dev",
- ArraySchema::new(
- "Include mountpoints with same st_dev number (see ``man fstat``) as specified files.",
- StringSchema::new("Path to file.").into()
- )
- )
- .optional(
- "keyfile",
- StringSchema::new("Path to encryption key. All data will be encrypted using this key."))
- .optional(
- "verbose",
- BooleanSchema::new("Verbose output.").default(false))
- .optional(
- "skip-lost-and-found",
- BooleanSchema::new("Skip lost+found directory").default(false))
- .optional(
- "backup-type",
- BACKUP_TYPE_SCHEMA.clone()
- )
- .optional(
- "backup-id",
- BACKUP_ID_SCHEMA.clone()
- )
- .optional(
- "backup-time",
- BACKUP_TIME_SCHEMA.clone()
- )
- .optional(
- "chunk-size",
- IntegerSchema::new("Chunk size in KB. Must be a power of 2.")
- .minimum(64)
- .maximum(4096)
- .default(4096)
- )
- ))
- .arg_param(vec!["backupspec"])
+ let backup_cmd_def = CliCommand::new(&API_METHOD_CREATE_BACKUP)
+ .arg_param(&["backupspec"])
.completion_cb("repository", complete_repository)
.completion_cb("backupspec", complete_backup_source)
.completion_cb("keyfile", tools::complete_file_name)
.completion_cb("chunk-size", complete_chunk_size);
- let upload_log_cmd_def = CliCommand::new(
- ApiMethod::new(
- upload_log,
- ObjectSchema::new("Upload backup log file.")
- .required("snapshot", StringSchema::new("Snapshot path."))
- .required("logfile", StringSchema::new("The path to the log file you want to upload."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional(
- "keyfile",
- StringSchema::new("Path to encryption key. All data will be encrypted using this key."))
- ))
- .arg_param(vec!["snapshot", "logfile"])
- .completion_cb("snapshot", complete_backup_snapshot)
- .completion_cb("logfile", tools::complete_file_name)
- .completion_cb("keyfile", tools::complete_file_name)
- .completion_cb("repository", complete_repository);
+ let benchmark_cmd_def = CliCommand::new(&API_METHOD_BENCHMARK)
+ .completion_cb("repository", complete_repository)
+ .completion_cb("keyfile", tools::complete_file_name);
- let list_cmd_def = CliCommand::new(
- ApiMethod::new(
- list_backup_groups,
- ObjectSchema::new("List backup groups.")
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("output-format", OUTPUT_FORMAT.clone())
- ))
+ let list_cmd_def = CliCommand::new(&API_METHOD_LIST_BACKUP_GROUPS)
.completion_cb("repository", complete_repository);
- let snapshots_cmd_def = CliCommand::new(
- ApiMethod::new(
- list_snapshots,
- ObjectSchema::new("List backup snapshots.")
- .optional("group", StringSchema::new("Backup group."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("output-format", OUTPUT_FORMAT.clone())
- ))
- .arg_param(vec!["group"])
- .completion_cb("group", complete_backup_group)
+ let garbage_collect_cmd_def = CliCommand::new(&API_METHOD_START_GARBAGE_COLLECTION)
.completion_cb("repository", complete_repository);
- let forget_cmd_def = CliCommand::new(
- ApiMethod::new(
- forget_snapshots,
- ObjectSchema::new("Forget (remove) backup snapshots.")
- .required("snapshot", StringSchema::new("Snapshot path."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- ))
- .arg_param(vec!["snapshot"])
- .completion_cb("repository", complete_repository)
- .completion_cb("snapshot", complete_backup_snapshot);
-
- let garbage_collect_cmd_def = CliCommand::new(
- ApiMethod::new(
- start_garbage_collection,
- ObjectSchema::new("Start garbage collection for a specific repository.")
- .optional("repository", REPO_URL_SCHEMA.clone())
- ))
- .completion_cb("repository", complete_repository);
-
- let restore_cmd_def = CliCommand::new(
- ApiMethod::new(
- restore,
- ObjectSchema::new("Restore backup repository.")
- .required("snapshot", StringSchema::new("Group/Snapshot path."))
- .required("archive-name", StringSchema::new("Backup archive name."))
- .required("target", StringSchema::new(r###"Target directory path. Use '-' to write to stdandard output.
-
-We do not extraxt '.pxar' archives when writing to stdandard output.
-
-"###
- ))
- .optional(
- "allow-existing-dirs",
- BooleanSchema::new("Do not fail if directories already exists.").default(false))
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("keyfile", StringSchema::new("Path to encryption key."))
- .optional(
- "verbose",
- BooleanSchema::new("Verbose output.").default(false)
- )
- ))
- .arg_param(vec!["snapshot", "archive-name", "target"])
+ let restore_cmd_def = CliCommand::new(&API_METHOD_RESTORE)
+ .arg_param(&["snapshot", "archive-name", "target"])
.completion_cb("repository", complete_repository)
.completion_cb("snapshot", complete_group_or_snapshot)
.completion_cb("archive-name", complete_archive_name)
.completion_cb("target", tools::complete_file_name);
- let files_cmd_def = CliCommand::new(
- ApiMethod::new(
- list_snapshot_files,
- ObjectSchema::new("List snapshot files.")
- .required("snapshot", StringSchema::new("Snapshot path."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("output-format", OUTPUT_FORMAT.clone())
- ))
- .arg_param(vec!["snapshot"])
- .completion_cb("repository", complete_repository)
- .completion_cb("snapshot", complete_backup_snapshot);
-
- let catalog_cmd_def = CliCommand::new(
- ApiMethod::new(
- dump_catalog,
- ObjectSchema::new("Dump catalog.")
- .required("snapshot", StringSchema::new("Snapshot path."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- ))
- .arg_param(vec!["snapshot"])
- .completion_cb("repository", complete_repository)
- .completion_cb("snapshot", complete_backup_snapshot);
-
- let prune_cmd_def = CliCommand::new(
- ApiMethod::new(
- prune,
- proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
- ObjectSchema::new("Prune backup repository.")
- .required("group", StringSchema::new("Backup group."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- )
- ))
- .arg_param(vec!["group"])
+ let prune_cmd_def = CliCommand::new(&API_METHOD_PRUNE)
+ .arg_param(&["group"])
.completion_cb("group", complete_backup_group)
.completion_cb("repository", complete_repository);
- let status_cmd_def = CliCommand::new(
- ApiMethod::new(
- status,
- ObjectSchema::new("Get repository status.")
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("output-format", OUTPUT_FORMAT.clone())
- ))
+ let status_cmd_def = CliCommand::new(&API_METHOD_STATUS)
.completion_cb("repository", complete_repository);
- let login_cmd_def = CliCommand::new(
- ApiMethod::new(
- api_login,
- ObjectSchema::new("Try to login. If successful, store ticket.")
- .optional("repository", REPO_URL_SCHEMA.clone())
- ))
+ let login_cmd_def = CliCommand::new(&API_METHOD_API_LOGIN)
.completion_cb("repository", complete_repository);
- let logout_cmd_def = CliCommand::new(
- ApiMethod::new(
- api_logout,
- ObjectSchema::new("Logout (delete stored ticket).")
- .optional("repository", REPO_URL_SCHEMA.clone())
- ))
+ let logout_cmd_def = CliCommand::new(&API_METHOD_API_LOGOUT)
.completion_cb("repository", complete_repository);
- let mount_cmd_def = CliCommand::new(
- ApiMethod::new(
- mount,
- ObjectSchema::new("Mount pxar archive.")
- .required("snapshot", StringSchema::new("Group/Snapshot path."))
- .required("archive-name", StringSchema::new("Backup archive name."))
- .required("target", StringSchema::new("Target directory path."))
- .optional("repository", REPO_URL_SCHEMA.clone())
- .optional("keyfile", StringSchema::new("Path to encryption key."))
- .optional("verbose", BooleanSchema::new("Verbose output.").default(false))
- ))
- .arg_param(vec!["snapshot", "archive-name", "target"])
- .completion_cb("repository", complete_repository)
- .completion_cb("snapshot", complete_group_or_snapshot)
- .completion_cb("archive-name", complete_archive_name)
- .completion_cb("target", tools::complete_file_name);
+ let version_cmd_def = CliCommand::new(&API_METHOD_API_VERSION)
+ .completion_cb("repository", complete_repository);
- let cmd_def = CliCommandMap::new()
- .insert("backup".to_owned(), backup_cmd_def.into())
- .insert("upload-log".to_owned(), upload_log_cmd_def.into())
- .insert("forget".to_owned(), forget_cmd_def.into())
- .insert("catalog".to_owned(), catalog_cmd_def.into())
- .insert("garbage-collect".to_owned(), garbage_collect_cmd_def.into())
- .insert("list".to_owned(), list_cmd_def.into())
- .insert("login".to_owned(), login_cmd_def.into())
- .insert("logout".to_owned(), logout_cmd_def.into())
- .insert("prune".to_owned(), prune_cmd_def.into())
- .insert("restore".to_owned(), restore_cmd_def.into())
- .insert("snapshots".to_owned(), snapshots_cmd_def.into())
- .insert("files".to_owned(), files_cmd_def.into())
- .insert("status".to_owned(), status_cmd_def.into())
- .insert("key".to_owned(), key_mgmt_cli().into())
- .insert("mount".to_owned(), mount_cmd_def.into());
-
- run_cli_command(cmd_def.into());
-}
+ let change_owner_cmd_def = CliCommand::new(&API_METHOD_CHANGE_BACKUP_OWNER)
+ .arg_param(&["group", "new-owner"])
+ .completion_cb("group", complete_backup_group)
+ .completion_cb("new-owner", complete_auth_id)
+ .completion_cb("repository", complete_repository);
-fn async_main<F: Future>(fut: F) -> <F as Future>::Output {
- let rt = tokio::runtime::Runtime::new().unwrap();
- let ret = rt.block_on(fut);
- rt.shutdown_now();
- ret
+ let cmd_def = CliCommandMap::new()
+ .insert("backup", backup_cmd_def)
+ .insert("garbage-collect", garbage_collect_cmd_def)
+ .insert("list", list_cmd_def)
+ .insert("login", login_cmd_def)
+ .insert("logout", logout_cmd_def)
+ .insert("prune", prune_cmd_def)
+ .insert("restore", restore_cmd_def)
+ .insert("snapshot", snapshot_mgtm_cli())
+ .insert("status", status_cmd_def)
+ .insert("key", key::cli())
+ .insert("mount", mount_cmd_def())
+ .insert("map", map_cmd_def())
+ .insert("unmap", unmap_cmd_def())
+ .insert("catalog", catalog_mgmt_cli())
+ .insert("task", task_mgmt_cli())
+ .insert("version", version_cmd_def)
+ .insert("benchmark", benchmark_cmd_def)
+ .insert("change-owner", change_owner_cmd_def)
+
+ .alias(&["files"], &["snapshot", "files"])
+ .alias(&["forget"], &["snapshot", "forget"])
+ .alias(&["upload-log"], &["snapshot", "upload-log"])
+ .alias(&["snapshots"], &["snapshot", "list"])
+ ;
+
+ let rpcenv = CliEnvironment::new();
+ run_cli_command(cmd_def, rpcenv, Some(|future| {
+ proxmox_backup::tools::runtime::main(future)
+ }));
}
projects / proxmox-backup.git / blobdiff