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 66FA36F4BD for ; Mon, 30 Aug 2021 10:54:20 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 4853417E8D for ; Mon, 30 Aug 2021 10:53:50 +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 E17C017E70 for ; Mon, 30 Aug 2021 10:53:45 +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 50F1442594 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:38 +0200 Message-Id: <20210830085339.4103-3-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.207 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_PASS -0.001 SPF: sender matches SPF record T_SPF_HELO_TEMPERROR 0.01 SPF: test of HELO record failed (temperror) Subject: [pbs-devel] [PATCH v7 proxmox-backup 2/3] add file inspection 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:20 -0000 Adds possibility to inspect .blob, .fidx and .didx files. For index files a list of the chunks referenced will be printed in addition to some other information. .blob files can be decoded into file or directly into stdout. Without decode the tool just prints the size and encryption mode of the blob file. Options: - file: path to the file - [opt] decode: path to a file or stdout(-), if specidied, the file will be decoded into the specified location [only for blob files, no effect with index files] - [opt] keyfile: path to a keyfile, needed if decode is specified and the data was encrypted Signed-off-by: Hannes Laimer --- src/bin/proxmox_backup_debug/inspect.rs | 132 +++++++++++++++++++++++- 1 file changed, 127 insertions(+), 5 deletions(-) diff --git a/src/bin/proxmox_backup_debug/inspect.rs b/src/bin/proxmox_backup_debug/inspect.rs index 5a0979d2..c06875d0 100644 --- a/src/bin/proxmox_backup_debug/inspect.rs +++ b/src/bin/proxmox_backup_debug/inspect.rs @@ -1,6 +1,9 @@ +use std::collections::HashSet; +use std::fs::File; +use std::io::{Read, Seek, SeekFrom}; use std::path::Path; -use anyhow::{format_err, Error}; +use anyhow::{bail, format_err, Error}; use proxmox::api::cli::{ format_and_print_result, get_output_format, CliCommand, CliCommandMap, CommandLineInterface, }; @@ -10,6 +13,8 @@ use walkdir::WalkDir; use proxmox_backup::backup::{ load_and_decrypt_key, CryptConfig, DataBlob, DynamicIndexReader, FixedIndexReader, IndexFile, + COMPRESSED_BLOB_MAGIC_1_0, DYNAMIC_SIZED_CHUNK_INDEX_1_0, ENCRYPTED_BLOB_MAGIC_1_0, + ENCR_COMPR_BLOB_MAGIC_1_0, FIXED_SIZED_CHUNK_INDEX_1_0, UNCOMPRESSED_BLOB_MAGIC_1_0, }; use pbs_client::tools::key_source::get_encryption_key_password; @@ -203,11 +208,128 @@ fn inspect_chunk( Ok(()) } +#[api( + input: { + properties: { + file: { + description: "Path to the file.", + type: String, + }, + "decode": { + description: "Path to the file to which the file should be decoded, '-' -> decode to stdout.", + type: String, + optional: true, + }, + "keyfile": { + description: "Path to the keyfile with which the file was encrypted.", + type: String, + optional: true, + }, + "output-format": { + schema: OUTPUT_FORMAT, + optional: true, + }, + } + } +)] +/// Inspect a file, for blob file without decode only the size and encryption mode is printed +fn inspect_file( + file: String, + decode: Option, + keyfile: Option, + param: Value, +) -> Result<(), Error> { + let output_format = get_output_format(¶m); + + let mut file = File::open(Path::new(&file))?; + let mut magic = [0; 8]; + file.read_exact(&mut magic)?; + file.seek(SeekFrom::Start(0))?; + let val = match magic { + UNCOMPRESSED_BLOB_MAGIC_1_0 + | COMPRESSED_BLOB_MAGIC_1_0 + | ENCRYPTED_BLOB_MAGIC_1_0 + | ENCR_COMPR_BLOB_MAGIC_1_0 => { + let data_blob = DataBlob::load_from_reader(&mut file)?; + let key_file_path = keyfile.as_ref().map(Path::new); + + let decode_output_path = decode.as_ref().map(Path::new); + + if decode_output_path.is_some() { + decode_blob(decode_output_path, key_file_path, None, &data_blob)?; + } + + let crypt_mode = data_blob.crypt_mode()?; + json!({ + "encryption": crypt_mode, + "size": data_blob.raw_size(), + }) + } + FIXED_SIZED_CHUNK_INDEX_1_0 | DYNAMIC_SIZED_CHUNK_INDEX_1_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!("This is technically not possible")), + }; + + let mut ctime_str = index.index_ctime().to_string(); + if let Ok(s) = proxmox::tools::time::strftime_local("%c", index.index_ctime()) { + ctime_str = s; + } + + let mut chunk_digests = HashSet::new(); + + for pos in 0..index.index_count() { + let digest = index.index_digest(pos).unwrap(); + chunk_digests.insert(proxmox::tools::digest_to_hex(digest)); + } + + json!({ + "size": index.index_size(), + "ctime": ctime_str, + "chunk-digests": chunk_digests + }) + } + _ => bail!(format_err!( + "Only .blob, .fidx and .didx files may be inspected" + )), + }; + + if output_format == "text" { + println!("size: {}", val["size"]); + if let Some(encryption) = val["encryption"].as_str() { + println!("encryption: {}", encryption); + } + if let Some(ctime) = val["ctime"].as_str() { + println!("creation time: {}", ctime); + } + if let Some(chunks) = val["chunk-digests"].as_array() { + println!("chunks:"); + for chunk in chunks { + println!(" {}", chunk); + } + } + } else { + format_and_print_result(&val, &output_format); + } + + Ok(()) +} + pub fn inspect_commands() -> CommandLineInterface { - let cmd_def = CliCommandMap::new().insert( - "chunk", - CliCommand::new(&API_METHOD_INSPECT_CHUNK).arg_param(&["chunk"]), - ); + let cmd_def = CliCommandMap::new() + .insert( + "chunk", + CliCommand::new(&API_METHOD_INSPECT_CHUNK).arg_param(&["chunk"]), + ) + .insert( + "file", + CliCommand::new(&API_METHOD_INSPECT_FILE).arg_param(&["file"]), + ); cmd_def.into() } -- 2.30.2