From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 39D006F4BF for ; Mon, 30 Aug 2021 10:54:21 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 18DEF17E8F for ; Mon, 30 Aug 2021 10:53:51 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 07E9B17E71 for ; Mon, 30 Aug 2021 10:53:46 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 659584419E for ; Mon, 30 Aug 2021 10:53:45 +0200 (CEST) From: Hannes Laimer To: pbs-devel@lists.proxmox.com Date: Mon, 30 Aug 2021 10:53:39 +0200 Message-Id: <20210830085339.4103-4-h.laimer@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210830085339.4103-1-h.laimer@proxmox.com> References: <20210830085339.4103-1-h.laimer@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.201 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH v7 proxmox-backup 3/3] add index recovery to pb-debug X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 30 Aug 2021 08:54:21 -0000 Adds possibility to recover data from an index file. Options: - chunks: path to the directory where the chunks are saved - file: the index file that should be recovered(must be either .fidx or didx) - [opt] keyfile: path to a keyfile, if the data was encrypted, a keyfile is needed - [opt] skip-crc: boolean, if true, read chunks wont be verified with their crc-sum, increases the restore speed by a lot Signed-off-by: Hannes Laimer --- src/bin/proxmox-backup-debug.rs | 6 +- src/bin/proxmox_backup_debug/mod.rs | 2 + src/bin/proxmox_backup_debug/recover.rs | 119 ++++++++++++++++++++++++ 3 files changed, 125 insertions(+), 2 deletions(-) create mode 100644 src/bin/proxmox_backup_debug/recover.rs diff --git a/src/bin/proxmox-backup-debug.rs b/src/bin/proxmox-backup-debug.rs index 897fa221..b3360c93 100644 --- a/src/bin/proxmox-backup-debug.rs +++ b/src/bin/proxmox-backup-debug.rs @@ -1,12 +1,14 @@ use proxmox::api::cli::*; mod proxmox_backup_debug; -use proxmox_backup_debug::inspect_commands; +use proxmox_backup_debug::{inspect_commands, recover_commands}; fn main() { proxmox_backup::tools::setup_safe_path_env(); - let cmd_def = CliCommandMap::new().insert("inspect", inspect_commands()); + let cmd_def = CliCommandMap::new() + .insert("inspect", inspect_commands()) + .insert("recover", recover_commands()); let rpcenv = CliEnvironment::new(); run_cli_command(cmd_def, rpcenv, Some(|future| pbs_runtime::main(future))); diff --git a/src/bin/proxmox_backup_debug/mod.rs b/src/bin/proxmox_backup_debug/mod.rs index 644583db..62df7754 100644 --- a/src/bin/proxmox_backup_debug/mod.rs +++ b/src/bin/proxmox_backup_debug/mod.rs @@ -1,2 +1,4 @@ mod inspect; pub use inspect::*; +mod recover; +pub use recover::*; diff --git a/src/bin/proxmox_backup_debug/recover.rs b/src/bin/proxmox_backup_debug/recover.rs new file mode 100644 index 00000000..706223b1 --- /dev/null +++ b/src/bin/proxmox_backup_debug/recover.rs @@ -0,0 +1,119 @@ +use std::fs::File; +use std::io::{Read, Seek, SeekFrom, Write}; +use std::path::Path; + +use anyhow::{bail, format_err, Error}; + +use proxmox::api::api; +use proxmox::api::cli::{CliCommand, CliCommandMap, CommandLineInterface}; +use proxmox_backup::backup::{DYNAMIC_SIZED_CHUNK_INDEX_1_0, FIXED_SIZED_CHUNK_INDEX_1_0}; +use serde_json::Value; + +use proxmox_backup::backup::{ + load_and_decrypt_key, CryptConfig, DataBlob, DynamicIndexReader, FixedIndexReader, IndexFile, +}; + +use pbs_client::tools::key_source::get_encryption_key_password; + +use proxmox::tools::digest_to_hex; + +#[api( + input: { + properties: { + file: { + description: "Path to the index file, either .fidx or .didx.", + type: String, + }, + chunks: { + description: "Path to the directorty that contains the chunks, usually /.chunks.", + type: String, + }, + "keyfile": { + description: "Path to a keyfile, if the data was encrypted, a keyfile is needed for decryption.", + type: String, + optional: true, + }, + "skip-crc": { + description: "Skip the crc verification, increases the restore speed by lot.", + type: Boolean, + optional: true, + default: false, + } + } + } +)] +/// Restore the data from an index file, given the directory of where chunks +/// are saved, the index file and a keyfile, if needed for decryption. +fn recover_index( + file: String, + chunks: String, + keyfile: Option, + skip_crc: bool, + _param: Value, +) -> Result<(), Error> { + let file_path = Path::new(&file); + let chunks_path = Path::new(&chunks); + + let key_file_path = keyfile.as_ref().map(Path::new); + + let mut file = File::open(Path::new(&file))?; + let mut magic = [0; 8]; + file.read_exact(&mut magic)?; + file.seek(SeekFrom::Start(0))?; + let index: Box = match magic { + FIXED_SIZED_CHUNK_INDEX_1_0 => Box::new(FixedIndexReader::new(file)?) as Box, + DYNAMIC_SIZED_CHUNK_INDEX_1_0 => { + Box::new(DynamicIndexReader::new(file)?) as Box + } + _ => bail!(format_err!( + "index file must either be a .fidx or a .didx file" + )), + }; + + let crypt_conf_opt = if let Some(key_file_path) = key_file_path { + let (key, _created, _fingerprint) = + load_and_decrypt_key(&key_file_path, &get_encryption_key_password)?; + Some(CryptConfig::new(key)?) + } else { + None + }; + + let output_filename = file_path.file_stem().unwrap().to_str().unwrap(); + let output_path = Path::new(output_filename); + let mut output_file = File::create(output_path) + .map_err(|e| format_err!("could not create output file - {}", e))?; + + let mut data = Vec::with_capacity(4 * 1024 * 1024); + for pos in 0..index.index_count() { + let chunk_digest = index.index_digest(pos).unwrap(); + let digest_str = digest_to_hex(chunk_digest); + let digest_prefix = &digest_str[0..4]; + let chunk_path = chunks_path.join(digest_prefix).join(digest_str); + let mut chunk_file = std::fs::File::open(&chunk_path) + .map_err(|e| format_err!("could not open chunk file - {}", e))?; + + data.clear(); + chunk_file.read_to_end(&mut data)?; + let chunk_blob = DataBlob::from_raw(data.clone())?; + + if !skip_crc { + chunk_blob.verify_crc()?; + } + + output_file.write_all( + chunk_blob + .decode(crypt_conf_opt.as_ref(), Some(chunk_digest))? + .as_slice(), + )?; + } + + Ok(()) +} + +pub fn recover_commands() -> CommandLineInterface { + let cmd_def = CliCommandMap::new().insert( + "index", + CliCommand::new(&API_METHOD_RECOVER_INDEX).arg_param(&["file", "chunks"]), + ); + cmd_def.into() +} -- 2.30.2