+//#[macro_use]
extern crate proxmox_backup;
use failure::*;
//use std::os::unix::io::AsRawFd;
-use chrono::{DateTime, Local, TimeZone};
+use chrono::{Local, TimeZone};
use std::path::{Path, PathBuf};
use std::collections::HashMap;
+use std::io::Write;
use proxmox_backup::tools;
use proxmox_backup::cli::*;
use proxmox_backup::api_schema::router::*;
use proxmox_backup::client::*;
use proxmox_backup::backup::*;
+use proxmox_backup::pxar;
+
//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 hyper::Body;
use std::sync::Arc;
use regex::Regex;
use xdg::BaseDirectories;
use lazy_static::lazy_static;
use futures::*;
+use tokio::sync::mpsc;
lazy_static! {
- static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|raw)):(.+)$").unwrap();
+ static ref BACKUPSPEC_REGEX: Regex = Regex::new(r"^([a-zA-Z0-9_-]+\.(?:pxar|img|conf)):(.+)$").unwrap();
+
+ static ref REPO_URL_SCHEMA: Arc<Schema> = Arc::new(
+ StringSchema::new("Repository URL.")
+ .format(BACKUP_REPO_URL.clone())
+ .max_length(256)
+ .into()
+ );
+}
+
+
+fn get_default_repository() -> Option<String> {
+ std::env::var("PBS_REPOSITORY").ok()
+}
+
+fn extract_repository_from_value(
+ param: &Value,
+) -> Result<BackupRepository, Error> {
+
+ let repo_url = param["repository"]
+ .as_str()
+ .map(String::from)
+ .or_else(get_default_repository)
+ .ok_or_else(|| format_err!("unable to get (default) repository"))?;
+
+ let repo: BackupRepository = repo_url.parse()?;
+
+ Ok(repo)
}
+fn extract_repository_from_map(
+ param: &HashMap<String, String>,
+) -> Option<BackupRepository> {
+
+ param.get("repository")
+ .map(String::from)
+ .or_else(get_default_repository)
+ .and_then(|repo_url| repo_url.parse::<BackupRepository>().ok())
+}
fn record_repository(repo: &BackupRepository) {
}
fn backup_directory<P: AsRef<Path>>(
- client: &mut HttpClient,
- repo: &BackupRepository,
+ client: &BackupClient,
dir_path: P,
archive_name: &str,
- backup_id: &str,
- backup_time: DateTime<Local>,
- chunk_size: Option<u64>,
+ chunk_size: Option<usize>,
all_file_systems: bool,
verbose: bool,
+ crypt_config: Option<Arc<CryptConfig>>,
) -> Result<(), Error> {
- let mut param = json!({
- "archive-name": archive_name,
- "backup-type": "host",
- "backup-id": backup_id,
- "backup-time": backup_time.timestamp(),
- });
-
- if let Some(size) = chunk_size {
- param["chunk-size"] = size.into();
- }
-
- let query = tools::json_object_to_query(param)?;
+ let pxar_stream = PxarBackupStream::open(dir_path.as_ref(), all_file_systems, verbose)?;
+ let chunk_stream = ChunkStream::new(pxar_stream, chunk_size);
- let path = format!("api2/json/admin/datastore/{}/pxar?{}", repo.store(), query);
+ let (tx, rx) = mpsc::channel(10); // allow to buffer 10 chunks
- let stream = PxarBackupStream::open(dir_path.as_ref(), all_file_systems, verbose)?;
+ let stream = rx
+ .map_err(Error::from)
+ .and_then(|x| x); // flatten
- let body = Body::wrap_stream(stream);
+ // spawn chunker inside a separate task so that it can run parallel
+ tokio::spawn(
+ tx.send_all(chunk_stream.then(|r| Ok(r)))
+ .map_err(|_| {}).map(|_| ())
+ );
- client.upload("application/x-proxmox-backup-pxar", body, &path).wait()?;
+ client.upload_stream(archive_name, stream, "dynamic", None, crypt_config).wait()?;
Ok(())
}
-/****
-fn backup_image(datastore: &DataStore, file: &std::fs::File, size: usize, target: &str, chunk_size: usize) -> Result<(), Error> {
+fn backup_image<P: AsRef<Path>>(
+ client: &BackupClient,
+ image_path: P,
+ archive_name: &str,
+ image_size: u64,
+ chunk_size: Option<usize>,
+ _verbose: bool,
+ crypt_config: Option<Arc<CryptConfig>>,
+) -> Result<(), Error> {
- let mut target = PathBuf::from(target);
+ let path = image_path.as_ref().to_owned();
- if let Some(ext) = target.extension() {
- if ext != "fidx" {
- bail!("got wrong file extension - expected '.fidx'");
- }
- } else {
- target.set_extension("fidx");
- }
+ let file = tokio::fs::File::open(path).wait()?;
- let mut index = datastore.create_image_writer(&target, size, chunk_size)?;
+ let stream = tokio::codec::FramedRead::new(file, tokio::codec::BytesCodec::new())
+ .map_err(Error::from);
- tools::file_chunker(file, chunk_size, |pos, chunk| {
- index.add_chunk(pos, chunk)?;
- Ok(true)
- })?;
+ let stream = FixedChunkStream::new(stream, chunk_size.unwrap_or(4*1024*1024));
- index.close()?; // commit changes
+ client.upload_stream(archive_name, stream, "fixed", Some(image_size), crypt_config).wait()?;
Ok(())
}
-*/
-fn strip_chunked_file_expenstions(list: Vec<String>) -> Vec<String> {
+fn strip_server_file_expenstions(list: Vec<String>) -> Vec<String> {
let mut result = vec![];
result.push(file[..file.len()-5].to_owned());
} else if file.ends_with(".fidx") {
result.push(file[..file.len()-5].to_owned());
+ } else if file.ends_with(".blob") {
+ result.push(file[..file.len()-5].to_owned());
} else {
result.push(file); // should not happen
}
fn list_backups(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let mut client = HttpClient::new(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/backups", repo.store());
- let result = client.get(&path)?;
+ let result = client.get(&path, None)?;
record_repository(&repo);
let backup_dir = BackupDir::new(btype, id, epoch);
let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
- let files = strip_chunked_file_expenstions(files);
+ let files = strip_server_file_expenstions(files);
for filename in files {
let path = backup_dir.relative_path().to_str().unwrap().to_owned();
fn list_backup_groups(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let client = HttpClient::new(repo.host(), repo.user())?;
let path = format!("api2/json/admin/datastore/{}/groups", repo.store());
- let mut result = client.get(&path).wait()?;
+ let mut result = client.get(&path, None).wait()?;
record_repository(&repo);
let path = group.group_path().to_str().unwrap().to_owned();
let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
- let files = strip_chunked_file_expenstions(files);
+ let files = strip_server_file_expenstions(files);
println!("{:20} | {} | {:5} | {}", path, last_backup.format("%c"),
backup_count, tools::join(&files, ' '));
fn list_snapshots(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let path = tools::required_string_param(¶m, "group")?;
let group = BackupGroup::parse(path)?;
- let query = tools::json_object_to_query(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- }))?;
-
let client = HttpClient::new(repo.host(), repo.user())?;
- let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), query);
+ let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- // fixme: params
- let result = client.get(&path).wait()?;
+ let result = client.get(&path, Some(json!({
+ "backup-type": group.backup_type(),
+ "backup-id": group.backup_id(),
+ }))).wait()?;
record_repository(&repo);
let path = snapshot.relative_path().to_str().unwrap().to_owned();
let files = item["files"].as_array().unwrap().iter().map(|v| v.as_str().unwrap().to_owned()).collect();
- let files = strip_chunked_file_expenstions(files);
+ let files = strip_server_file_expenstions(files);
println!("{} | {} | {}", path, snapshot.backup_time().format("%c"), tools::join(&files, ' '));
}
fn forget_snapshots(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let path = tools::required_string_param(¶m, "snapshot")?;
let snapshot = BackupDir::parse(path)?;
- 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(),
- }))?;
-
let mut client = HttpClient::new(repo.host(), repo.user())?;
- let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), query);
+ let path = format!("api2/json/admin/datastore/{}/snapshots", repo.store());
- let result = client.delete(&path).wait()?;
+ let result = client.delete(&path, Some(json!({
+ "backup-type": snapshot.group().backup_type(),
+ "backup-id": snapshot.group().backup_id(),
+ "backup-time": snapshot.backup_time().timestamp(),
+ }))).wait()?;
record_repository(&repo);
fn start_garbage_collection(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let mut client = HttpClient::new(repo.host(), repo.user())?;
fn create_backup(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
+ let repo = extract_repository_from_value(¶m)?;
let backupspec_list = tools::required_array_param(¶m, "backupspec")?;
- let repo: BackupRepository = repo_url.parse()?;
-
let all_file_systems = param["all-file-systems"].as_bool().unwrap_or(false);
let verbose = param["verbose"].as_bool().unwrap_or(false);
- let chunk_size_opt = param["chunk-size"].as_u64().map(|v| v*1024);
+ let chunk_size_opt = param["chunk-size"].as_u64().map(|v| (v*1024) as usize);
if let Some(size) = chunk_size_opt {
verify_chunk_size(size)?;
}
+ let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
+
let backup_id = param["host-id"].as_str().unwrap_or(&tools::nodename());
let mut upload_list = vec![];
+ enum BackupType { PXAR, IMAGE, CONFIG };
+
for backupspec in backupspec_list {
let (target, filename) = parse_backupspec(backupspec.as_str().unwrap())?;
- let stat = match nix::sys::stat::stat(filename) {
- Ok(s) => s,
+ use std::os::unix::fs::FileTypeExt;
+
+ let metadata = match std::fs::metadata(filename) {
+ Ok(m) => m,
Err(err) => bail!("unable to access '{}' - {}", filename, err),
};
+ let file_type = metadata.file_type();
- if (stat.st_mode & libc::S_IFDIR) != 0 {
-
- upload_list.push((filename.to_owned(), target.to_owned()));
+ let extension = Path::new(target).extension().map(|s| s.to_str().unwrap()).unwrap();
- } else if (stat.st_mode & (libc::S_IFREG|libc::S_IFBLK)) != 0 {
- if stat.st_size <= 0 { bail!("got strange file size '{}'", stat.st_size); }
- let _size = stat.st_size as usize;
+ match extension {
+ "pxar" => {
+ if !file_type.is_dir() {
+ bail!("got unexpected file type (expected directory)");
+ }
+ upload_list.push((BackupType::PXAR, filename.to_owned(), target.to_owned(), 0));
+ }
+ "img" => {
- panic!("implement me");
+ if !(file_type.is_file() || file_type.is_block_device()) {
+ bail!("got unexpected file type (expected file or block device)");
+ }
- //backup_image(&datastore, &file, size, &target, chunk_size)?;
+ let size = tools::image_size(&PathBuf::from(filename))?;
- // let idx = datastore.open_image_reader(target)?;
- // idx.print_info();
+ if size == 0 { bail!("got zero-sized file '{}'", filename); }
- } else {
- bail!("unsupported file type (expected a directory, file or block device)");
+ upload_list.push((BackupType::IMAGE, filename.to_owned(), target.to_owned(), size));
+ }
+ "conf" => {
+ if !file_type.is_file() {
+ bail!("got unexpected file type (expected regular file)");
+ }
+ upload_list.push((BackupType::CONFIG, filename.to_owned(), target.to_owned(), metadata.len()));
+ }
+ _ => {
+ bail!("got unknown archive extension '{}'", extension);
+ }
}
}
let backup_time = Local.timestamp(Local::now().timestamp(), 0);
- let mut client = HttpClient::new(repo.host(), repo.user())?;
-
+ let client = HttpClient::new(repo.host(), repo.user())?;
record_repository(&repo);
println!("Starting backup");
println!("Client name: {}", tools::nodename());
println!("Start Time: {}", backup_time.to_rfc3339());
- for (filename, target) in upload_list {
- println!("Upload '{}' to '{:?}' as {}", filename, repo, target);
- backup_directory(&mut client, &repo, &filename, &target, backup_id, backup_time,
- chunk_size_opt, all_file_systems, verbose)?;
+ let (crypt_config, rsa_encrypted_key) = match keyfile {
+ None => (None, None),
+ Some(path) => {
+ let (key, created) = load_and_decrtypt_key(&path, get_encryption_key_password)?;
+
+ let crypt_config = CryptConfig::new(key)?;
+
+ let path = master_pubkey_path()?;
+ if path.exists() {
+ let pem_data = proxmox_backup::tools::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)
+ }
+ }
+ };
+
+ let client = client.start_backup(repo.store(), "host", &backup_id, verbose).wait()?;
+
+ for (backup_type, filename, target, size) in upload_list {
+ match backup_type {
+ BackupType::CONFIG => {
+ println!("Upload config file '{}' to '{:?}' as {}", filename, repo, target);
+ client.upload_blob_from_file(&filename, &target, crypt_config.clone(), true).wait()?;
+ }
+ BackupType::PXAR => {
+ println!("Upload directory '{}' to '{:?}' as {}", filename, repo, target);
+ backup_directory(
+ &client,
+ &filename,
+ &target,
+ chunk_size_opt,
+ all_file_systems,
+ verbose,
+ crypt_config.clone(),
+ )?;
+ }
+ BackupType::IMAGE => {
+ println!("Upload image '{}' to '{:?}' as {}", filename, repo, target);
+ backup_image(
+ &client,
+ &filename,
+ &target,
+ size,
+ chunk_size_opt,
+ verbose,
+ crypt_config.clone(),
+ )?;
+ }
+ }
+ }
+
+ if let Some(rsa_encrypted_key) = rsa_encrypted_key {
+ let target = "rsa-encrypted.key";
+ println!("Upload RSA encoded key to '{:?}' as {}", repo, target);
+ client.upload_blob_from_data(rsa_encrypted_key, target, None, false).wait()?;
+
+ // 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 = proxmox_backup::tools::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);
+ */
}
+ client.finish().wait()?;
+
let end_time = Local.timestamp(Local::now().timestamp(), 0);
let elapsed = end_time.signed_duration_since(backup_time);
println!("Duration: {}", elapsed);
fn restore(
param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ 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 mut client = HttpClient::new(repo.host(), repo.user())?;
+ let client = HttpClient::new(repo.host(), repo.user())?;
record_repository(&repo);
let path = tools::required_string_param(¶m, "snapshot")?;
- let query;
-
- if path.matches('/').count() == 1 {
+ let (backup_type, backup_id, backup_time) = if path.matches('/').count() == 1 {
let group = BackupGroup::parse(path)?;
- let subquery = tools::json_object_to_query(json!({
+ 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(),
- }))?;
-
- let path = format!("api2/json/admin/datastore/{}/snapshots?{}", repo.store(), subquery);
- let result = client.get(&path).wait()?;
+ }))).wait()?;
let list = result["data"].as_array().unwrap();
if list.len() == 0 {
bail!("backup group '{}' does not contain any snapshots:", path);
}
- query = tools::json_object_to_query(json!({
- "backup-type": group.backup_type(),
- "backup-id": group.backup_id(),
- "backup-time": list[0]["backup-time"].as_i64().unwrap(),
- "archive-name": archive_name,
- }))?;
+ let epoch = list[0]["backup-time"].as_i64().unwrap();
+ let backup_time = Local.timestamp(epoch, 0);
+ (group.backup_type().to_owned(), group.backup_id().to_owned(), backup_time)
} else {
let snapshot = BackupDir::parse(path)?;
-
- 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(),
- "archive-name": archive_name,
- }))?;
- }
+ (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) };
- if archive_name.ends_with(".pxar") {
- let path = format!("api2/json/admin/datastore/{}/pxar?{}", repo.store(), query);
+ let keyfile = param["keyfile"].as_str().map(|p| PathBuf::from(p));
- println!("DOWNLOAD FILE {} to {}", path, target);
+ 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 target = PathBuf::from(target);
- let writer = PxarDecodeWriter::new(&target, true)?;
- client.download(&path, Box::new(writer)).wait()?;
+ 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 {
- bail!("unknown file extensions - unable to download '{}'", archive_name);
+ format!("{}.blob", archive_name)
+ };
+
+ let client = client.start_backup_reader(repo.store(), &backup_type, &backup_id, backup_time, true).wait()?;
+
+ use std::os::unix::fs::OpenOptionsExt;
+
+ let tmpfile = std::fs::OpenOptions::new()
+ .write(true)
+ .read(true)
+ .custom_flags(libc::O_TMPFILE)
+ .open("/tmp")?;
+
+ if server_archive_name.ends_with(".blob") {
+
+ let writer = Vec::with_capacity(1024*1024);
+ let blob_data = client.download(&server_archive_name, writer).wait()?;
+ let blob = DataBlob::from_raw(blob_data)?;
+ blob.verify_crc()?;
+
+ let raw_data = match crypt_config {
+ Some(ref crypt_config) => blob.decode(Some(crypt_config))?,
+ None => blob.decode(None)?,
+ };
+
+ if let Some(target) = target {
+ crate::tools::file_set_contents(target, &raw_data, None)?;
+ } else {
+ let stdout = std::io::stdout();
+ let mut writer = stdout.lock();
+ writer.write_all(&raw_data)
+ .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).wait()?;
+
+ let index = DynamicIndexReader::new(tmpfile)
+ .map_err(|err| format_err!("unable to read dynamic index '{}' - {}", archive_name, err))?;
+
+ let most_used = index.find_most_used_chunks(8);
+
+ let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
+
+ let mut reader = BufferedDynamicReader::new(index, chunk_reader);
+
+ if let Some(target) = target {
+
+ let feature_flags = pxar::CA_FORMAT_DEFAULT;
+ let mut decoder = pxar::SequentialDecoder::new(&mut reader, feature_flags, |path| {
+ if verbose {
+ println!("{:?}", path);
+ }
+ Ok(())
+ });
+
+ decoder.restore(Path::new(target))?;
+ } else {
+ let stdout = std::io::stdout();
+ let mut writer = stdout.lock();
+
+ 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).wait()?;
+
+ let index = FixedIndexReader::new(tmpfile)
+ .map_err(|err| format_err!("unable to read fixed index '{}' - {}", archive_name, err))?;
+
+ let most_used = index.find_most_used_chunks(8);
+
+ let chunk_reader = RemoteChunkReader::new(client.clone(), crypt_config, most_used);
+
+ let mut reader = BufferedFixedReader::new(index, chunk_reader);
+
+ if let Some(target) = target {
+ let mut writer = std::fs::OpenOptions::new()
+ .write(true)
+ .create(true)
+ .create_new(true)
+ .open(target)
+ .map_err(|err| format_err!("unable to create target file {:?} - {}", target, err))?;
+
+ std::io::copy(&mut reader, &mut writer)
+ .map_err(|err| format_err!("unable to store data - {}", err))?;
+ } else {
+ let stdout = std::io::stdout();
+ let mut writer = stdout.lock();
+
+ std::io::copy(&mut reader, &mut writer)
+ .map_err(|err| format_err!("unable to pipe data - {}", err))?;
+ }
+ } else {
+ bail!("unknown archive file extension (expected .pxar of .img)");
}
Ok(Value::Null)
fn prune(
mut param: Value,
_info: &ApiMethod,
- _rpcenv: &mut RpcEnvironment,
+ _rpcenv: &mut dyn RpcEnvironment,
) -> Result<Value, Error> {
- let repo_url = tools::required_string_param(¶m, "repository")?;
- let repo: BackupRepository = repo_url.parse()?;
+ let repo = extract_repository_from_value(¶m)?;
let mut client = HttpClient::new(repo.host(), repo.user())?;
_ => return Value::Null,
};
- let mut resp = match client.get(url).wait() {
+ let mut resp = match client.get(url, None).wait() {
Ok(v) => v,
_ => return Value::Null,
};
Value::Null
}
-fn extract_repo(param: &HashMap<String, String>) -> Option<BackupRepository> {
-
- let repo_url = match param.get("repository") {
- Some(v) => v,
- _ => return None,
- };
-
- let repo: BackupRepository = match repo_url.parse() {
- Ok(v) => v,
- _ => return None,
- };
-
- Some(repo)
-}
-
fn complete_backup_group(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
let mut result = vec![];
- let repo = match extract_repo(param) {
+ let repo = match extract_repository_from_map(param) {
Some(v) => v,
_ => return result,
};
let mut result = vec![];
- let repo = match extract_repo(param) {
+ let repo = match extract_repository_from_map(param) {
Some(v) => v,
_ => return result,
};
result
}
-fn complete_archive_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+fn complete_server_file_name(_arg: &str, param: &HashMap<String, String>) -> Vec<String> {
let mut result = vec![];
- let repo = match extract_repo(param) {
+ let repo = match extract_repository_from_map(param) {
Some(v) => v,
_ => return result,
};
}
}
- strip_chunked_file_expenstions(result)
+ result
+}
+
+fn complete_archive_name(arg: &str, param: &HashMap<String, String>) -> Vec<String> {
+
+ let result = complete_server_file_name(arg, param);
+
+ strip_server_file_expenstions(result)
}
fn complete_chunk_size(_arg: &str, _param: &HashMap<String, String>) -> Vec<String> {
result
}
-fn main() {
+fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
- let repo_url_schema: Arc<Schema> = Arc::new(
- StringSchema::new("Repository URL.")
- .format(BACKUP_REPO_URL.clone())
- .max_length(256)
+ // 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 key_create(
+ 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");
+
+ let key = proxmox::sys::linux::random_data(32)?;
+
+ if kdf == "scrypt" {
+ // always read passphrase from tty
+ if !crate::tools::tty::stdin_isatty() {
+ bail!("unable to read passphrase - no tty");
+ }
+
+ 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 = proxmox_backup::tools::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()?;
+
+ proxmox_backup::tools::file_set_contents(&target_path, &pem_data, None)?;
+
+ println!("Imported public master key to {:?}", target_path);
+
+ Ok(Value::Null)
+}
+
+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);
+ proxmox_backup::tools::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);
+ proxmox_backup::tools::file_set_contents(filename_priv, priv_key.as_slice(), None)?;
+
+ Ok(Value::Null)
+}
+
+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!");
+ }
+
+ 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 main() {
+
let backup_source_schema: Arc<Schema> = Arc::new(
StringSchema::new("Backup source specification ([<label>:<path>]).")
.format(Arc::new(ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)))
ApiMethod::new(
create_backup,
ObjectSchema::new("Create (host) backup.")
- .required("repository", repo_url_schema.clone())
.required(
"backupspec",
ArraySchema::new(
backup_source_schema,
).min_length(1)
)
+ .optional("repository", REPO_URL_SCHEMA.clone())
+ .optional(
+ "keyfile",
+ StringSchema::new("Path to encryption key. All data will be encrypted using this key."))
.optional(
"verbose",
BooleanSchema::new("Verbose output.").default(false))
.default(4096)
)
))
- .arg_param(vec!["repository", "backupspec"])
+ .arg_param(vec!["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 list_cmd_def = CliCommand::new(
ApiMethod::new(
list_backup_groups,
ObjectSchema::new("List backup groups.")
- .required("repository", repo_url_schema.clone())
+ .optional("repository", REPO_URL_SCHEMA.clone())
))
- .arg_param(vec!["repository"])
.completion_cb("repository", complete_repository);
let snapshots_cmd_def = CliCommand::new(
ApiMethod::new(
list_snapshots,
ObjectSchema::new("List backup snapshots.")
- .required("repository", repo_url_schema.clone())
.required("group", StringSchema::new("Backup group."))
+ .optional("repository", REPO_URL_SCHEMA.clone())
))
- .arg_param(vec!["repository", "group"])
+ .arg_param(vec!["group"])
.completion_cb("group", complete_backup_group)
.completion_cb("repository", complete_repository);
ApiMethod::new(
forget_snapshots,
ObjectSchema::new("Forget (remove) backup snapshots.")
- .required("repository", repo_url_schema.clone())
.required("snapshot", StringSchema::new("Snapshot path."))
+ .optional("repository", REPO_URL_SCHEMA.clone())
))
- .arg_param(vec!["repository", "snapshot"])
+ .arg_param(vec!["snapshot"])
.completion_cb("repository", complete_repository)
.completion_cb("snapshot", complete_group_or_snapshot);
ApiMethod::new(
start_garbage_collection,
ObjectSchema::new("Start garbage collection for a specific repository.")
- .required("repository", repo_url_schema.clone())
+ .optional("repository", REPO_URL_SCHEMA.clone())
))
- .arg_param(vec!["repository"])
.completion_cb("repository", complete_repository);
let restore_cmd_def = CliCommand::new(
ApiMethod::new(
restore,
ObjectSchema::new("Restore backup repository.")
- .required("repository", repo_url_schema.clone())
.required("snapshot", StringSchema::new("Group/Snapshot path."))
.required("archive-name", StringSchema::new("Backup archive name."))
- .required("target", StringSchema::new("Target directory path."))
+ .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("repository", REPO_URL_SCHEMA.clone())
+ .optional("keyfile", StringSchema::new("Path to encryption key."))
+ .optional(
+ "verbose",
+ BooleanSchema::new("Verbose output.").default(false)
+ )
))
- .arg_param(vec!["repository", "snapshot", "archive-name", "target"])
+ .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)
prune,
proxmox_backup::api2::admin::datastore::add_common_prune_prameters(
ObjectSchema::new("Prune backup repository.")
- .required("repository", repo_url_schema.clone())
+ .optional("repository", REPO_URL_SCHEMA.clone())
)
))
- .arg_param(vec!["repository"])
.completion_cb("repository", complete_repository);
let cmd_def = CliCommandMap::new()
.insert("list".to_owned(), list_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("snapshots".to_owned(), snapshots_cmd_def.into())
+ .insert("key".to_owned(), key_mgmt_cli().into());
hyper::rt::run(futures::future::lazy(move || {
run_cli_command(cmd_def.into());
projects / proxmox-backup.git / blobdiff