+use std::convert::TryFrom;
use std::path::PathBuf;
-use std::io::Write;
-use std::process::{Stdio, Command};
use anyhow::{bail, format_err, Error};
-use serde::{Deserialize, Serialize};
use serde_json::Value;
use proxmox::api::api;
use proxmox::api::cli::{
- ColumnConfig,
- CliCommand,
- CliCommandMap,
- format_and_print_result_full,
- get_output_format,
+ format_and_print_result_full, get_output_format, CliCommand, CliCommandMap, ColumnConfig,
OUTPUT_FORMAT,
};
use proxmox::api::router::ReturnType;
use proxmox::tools::fs::{file_get_contents, replace_file, CreateOptions};
use proxmox_backup::{
- api2::types::{
- PASSWORD_HINT_SCHEMA,
- KeyInfo,
- Kdf,
- },
- backup::{
- rsa_decrypt_key_config,
- KeyConfig,
- },
+ api2::types::{Kdf, KeyInfo, RsaPubKeyInfo, PASSWORD_HINT_SCHEMA},
+ backup::{rsa_decrypt_key_config, KeyConfig},
tools,
+ tools::paperkey::{generate_paper_key, PaperkeyFormat},
};
-#[api()]
-#[derive(Debug, Serialize, Deserialize)]
-#[serde(rename_all = "lowercase")]
-/// Paperkey output format
-pub enum PaperkeyFormat {
- /// Format as Utf8 text. Includes QR codes as ascii-art.
- Text,
- /// Format as Html. Includes QR codes as png images.
- Html,
-}
+use crate::KeyWithSource;
pub const DEFAULT_ENCRYPTION_KEY_FILE_NAME: &str = "encryption-key.json";
-pub const MASTER_PUBKEY_FILE_NAME: &str = "master-public.pem";
+pub const DEFAULT_MASTER_PUBKEY_FILE_NAME: &str = "master-public.pem";
-pub fn find_master_pubkey() -> Result<Option<PathBuf>, Error> {
- super::find_xdg_file(MASTER_PUBKEY_FILE_NAME, "main public key file")
+pub fn find_default_master_pubkey() -> Result<Option<PathBuf>, Error> {
+ super::find_xdg_file(
+ DEFAULT_MASTER_PUBKEY_FILE_NAME,
+ "default master public key file",
+ )
}
-pub fn place_master_pubkey() -> Result<PathBuf, Error> {
- super::place_xdg_file(MASTER_PUBKEY_FILE_NAME, "main public key file")
+pub fn place_default_master_pubkey() -> Result<PathBuf, Error> {
+ super::place_xdg_file(
+ DEFAULT_MASTER_PUBKEY_FILE_NAME,
+ "default master public key file",
+ )
}
pub fn find_default_encryption_key() -> Result<Option<PathBuf>, Error> {
- super::find_xdg_file(DEFAULT_ENCRYPTION_KEY_FILE_NAME, "default encryption key file")
+ super::find_xdg_file(
+ DEFAULT_ENCRYPTION_KEY_FILE_NAME,
+ "default encryption key file",
+ )
}
pub fn place_default_encryption_key() -> Result<PathBuf, Error> {
- super::place_xdg_file(DEFAULT_ENCRYPTION_KEY_FILE_NAME, "default encryption key file")
+ super::place_xdg_file(
+ DEFAULT_ENCRYPTION_KEY_FILE_NAME,
+ "default encryption key file",
+ )
}
-pub fn read_optional_default_encryption_key() -> Result<Option<Vec<u8>>, Error> {
+#[cfg(not(test))]
+pub(crate) fn read_optional_default_encryption_key() -> Result<Option<KeyWithSource>, Error> {
find_default_encryption_key()?
- .map(file_get_contents)
+ .map(|path| file_get_contents(path).map(KeyWithSource::from_default))
+ .transpose()
+}
+
+#[cfg(not(test))]
+pub(crate) fn read_optional_default_master_pubkey() -> Result<Option<KeyWithSource>, Error> {
+ find_default_master_pubkey()?
+ .map(|path| file_get_contents(path).map(KeyWithSource::from_default))
.transpose()
}
+#[cfg(test)]
+static mut TEST_DEFAULT_ENCRYPTION_KEY: Result<Option<Vec<u8>>, Error> = Ok(None);
+
+#[cfg(test)]
+pub(crate) fn read_optional_default_encryption_key() -> Result<Option<KeyWithSource>, Error> {
+ // not safe when multiple concurrent test cases end up here!
+ unsafe {
+ match &TEST_DEFAULT_ENCRYPTION_KEY {
+ Ok(Some(key)) => Ok(Some(KeyWithSource::from_default(key.clone()))),
+ Ok(None) => Ok(None),
+ Err(_) => bail!("test error"),
+ }
+ }
+}
+
+#[cfg(test)]
+// not safe when multiple concurrent test cases end up here!
+pub(crate) unsafe fn set_test_encryption_key(value: Result<Option<Vec<u8>>, Error>) {
+ TEST_DEFAULT_ENCRYPTION_KEY = value;
+}
+
+#[cfg(test)]
+static mut TEST_DEFAULT_MASTER_PUBKEY: Result<Option<Vec<u8>>, Error> = Ok(None);
+
+#[cfg(test)]
+pub(crate) fn read_optional_default_master_pubkey() -> Result<Option<KeyWithSource>, Error> {
+ // not safe when multiple concurrent test cases end up here!
+ unsafe {
+ match &TEST_DEFAULT_MASTER_PUBKEY {
+ Ok(Some(key)) => Ok(Some(KeyWithSource::from_default(key.clone()))),
+ Ok(None) => Ok(None),
+ Err(_) => bail!("test error"),
+ }
+ }
+}
+
+#[cfg(test)]
+// not safe when multiple concurrent test cases end up here!
+pub(crate) unsafe fn set_test_default_master_pubkey(value: Result<Option<Vec<u8>>, Error>) {
+ TEST_DEFAULT_MASTER_PUBKEY = value;
+}
+
pub fn get_encryption_key_password() -> Result<Vec<u8>, Error> {
// fixme: implement other input methods
},
)]
/// Create a new encryption key.
-fn create(
- kdf: Option<Kdf>,
- path: Option<String>,
- hint: Option<String>
-) -> Result<(), Error> {
+fn create(kdf: Option<Kdf>, path: Option<String>, hint: Option<String>) -> Result<(), Error> {
let path = match path {
Some(path) => PathBuf::from(path),
None => {
let master_key = file_get_contents(&master_keyfile)?;
let password = tty::read_password("Master Key Password: ")?;
- let master_key =
- openssl::pkey::PKey::private_key_from_pem_passphrase(&master_key, &password)
+ let master_key = openssl::pkey::PKey::private_key_from_pem_passphrase(&master_key, &password)
.map_err(|err| format_err!("failed to read PEM-formatted private key - {}", err))?
.rsa()
.map_err(|err| format_err!("not a valid private RSA key - {}", err))?;
key_config.created = created; // keep original value
key_config.store(path, true)?;
-
}
Kdf::Scrypt | Kdf::PBKDF2 => {
let password = tty::read_and_verify_password("New Password: ")?;
let path = match path {
Some(path) => PathBuf::from(path),
None => {
- let path = find_default_encryption_key()?
- .ok_or_else(|| {
- format_err!("no encryption file provided and no default file found")
- })?;
+ let path = find_default_encryption_key()?.ok_or_else(|| {
+ format_err!("no encryption file provided and no default file found")
+ })?;
println!("updating default key at: {:?}", path);
path
}
}
let mut key_config = KeyConfig::without_password(key)?;
- key_config.created = created; // keep original value
+ key_config.created = created; // keep original value
key_config.store(&path, true)?;
}
},
)]
/// Print the encryption key's metadata.
-fn show_key(
- path: Option<String>,
- param: Value,
-) -> Result<(), Error> {
+fn show_key(path: Option<String>, param: Value) -> Result<(), Error> {
let path = match path {
Some(path) => PathBuf::from(path),
- None => {
- let path = find_default_encryption_key()?
- .ok_or_else(|| {
- format_err!("no encryption file provided and no default file found")
- })?;
- path
- }
+ None => find_default_encryption_key()?
+ .ok_or_else(|| format_err!("no encryption file provided and no default file found"))?,
};
-
let config: KeyConfig = serde_json::from_slice(&file_get_contents(path.clone())?)?;
let output_format = get_output_format(¶m);
)]
/// Import an RSA public key used to put an encrypted version of the symmetric backup encryption
/// key onto the backup server along with each backup.
+///
+/// The imported key will be used as default master key for future invocations by the same local
+/// user.
fn import_master_pubkey(path: String) -> Result<(), Error> {
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);
- }
+ match openssl::pkey::PKey::public_key_from_pem(&pem_data) {
+ Ok(key) => {
+ let info = RsaPubKeyInfo::try_from(key.rsa()?)?;
+ println!("Found following key at {:?}", path);
+ println!("Modulus: {}", info.modulus);
+ println!("Exponent: {}", info.exponent);
+ println!("Length: {}", info.length);
+ }
+ Err(err) => bail!("Unable to decode PEM data - {}", err),
+ };
- let target_path = place_master_pubkey()?;
+ let target_path = place_default_master_pubkey()?;
replace_file(&target_path, &pem_data, CreateOptions::new())?;
bail!("unable to create master key - no tty");
}
- let rsa = openssl::rsa::Rsa::generate(4096)?;
+ let bits = 4096;
+ println!("Generating {}-bit RSA key..", bits);
+ let rsa = openssl::rsa::Rsa::generate(bits)?;
+ let public =
+ openssl::rsa::Rsa::from_public_components(rsa.n().to_owned()?, rsa.e().to_owned()?)?;
+ let info = RsaPubKeyInfo::try_from(public)?;
+ println!("Modulus: {}", info.modulus);
+ println!("Exponent: {}", info.exponent);
+ println!();
+
let pkey = openssl::pkey::PKey::from_rsa(rsa)?;
let password = String::from_utf8(tty::read_and_verify_password("Master Key Password: ")?)?;
replace_file(filename_pub, pub_key.as_slice(), CreateOptions::new())?;
let cipher = openssl::symm::Cipher::aes_256_cbc();
- let priv_key: Vec<u8> = pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
+ let priv_key: Vec<u8> =
+ pkey.private_key_to_pem_pkcs8_passphrase(cipher, password.as_bytes())?;
let filename_priv = "master-private.pem";
println!("Writing private master key to {}", filename_priv);
Ok(())
}
+#[api(
+ input: {
+ properties: {
+ path: {
+ description: "Path to the PEM formatted RSA public key. Default location will be used if not specified.",
+ optional: true,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ },
+ },
+)]
+/// List information about master key
+fn show_master_pubkey(path: Option<String>, param: Value) -> Result<(), Error> {
+ let path = match path {
+ Some(path) => PathBuf::from(path),
+ None => find_default_master_pubkey()?
+ .ok_or_else(|| format_err!("No path specified and no default master key available."))?,
+ };
+
+ let path = path.canonicalize()?;
+
+ let output_format = get_output_format(¶m);
+
+ let pem_data = file_get_contents(path.clone())?;
+ let rsa = openssl::rsa::Rsa::public_key_from_pem(&pem_data)?;
+
+ let mut info = RsaPubKeyInfo::try_from(rsa)?;
+ info.path = Some(path.display().to_string());
+
+ let options = proxmox::api::cli::default_table_format_options()
+ .column(ColumnConfig::new("path"))
+ .column(ColumnConfig::new("modulus"))
+ .column(ColumnConfig::new("exponent"))
+ .column(ColumnConfig::new("length"));
+
+ let return_type = ReturnType::new(false, &RsaPubKeyInfo::API_SCHEMA);
+
+ format_and_print_result_full(
+ &mut serde_json::to_value(info)?,
+ &return_type,
+ &output_format,
+ &options,
+ );
+
+ Ok(())
+}
+
#[api(
input: {
properties: {
optional: true,
},
subject: {
- description: "Include the specified subject as titel text.",
+ description: "Include the specified subject as title text.",
optional: true,
},
"output-format": {
) -> Result<(), Error> {
let path = match path {
Some(path) => PathBuf::from(path),
- None => {
- let path = find_default_encryption_key()?
- .ok_or_else(|| {
- format_err!("no encryption file provided and no default file found")
- })?;
- path
- }
+ None => find_default_encryption_key()?
+ .ok_or_else(|| format_err!("no encryption file provided and no default file found"))?,
};
let data = file_get_contents(&path)?;
let data = String::from_utf8(data)?;
- let (data, is_private_key) = if data.starts_with("-----BEGIN ENCRYPTED PRIVATE KEY-----\n") {
- let lines: Vec<String> = data
- .lines()
- .map(|s| s.trim_end())
- .filter(|s| !s.is_empty())
- .map(String::from)
- .collect();
-
- if !lines[lines.len()-1].starts_with("-----END ENCRYPTED PRIVATE KEY-----") {
- bail!("unexpected key format");
- }
-
- if lines.len() < 20 {
- bail!("unexpected key format");
- }
-
- (lines, true)
- } else {
- match serde_json::from_str::<KeyConfig>(&data) {
- Ok(key_config) => {
- let lines = serde_json::to_string_pretty(&key_config)?
- .lines()
- .map(String::from)
- .collect();
-
- (lines, false)
- },
- Err(err) => {
- eprintln!("Couldn't parse '{:?}' as KeyConfig - {}", path, err);
- bail!("Neither a PEM-formatted private key, nor a PBS key file.");
- },
- }
- };
-
- let format = output_format.unwrap_or(PaperkeyFormat::Html);
-
- match format {
- PaperkeyFormat::Html => paperkey_html(&data, subject, is_private_key),
- PaperkeyFormat::Text => paperkey_text(&data, subject, is_private_key),
- }
+ generate_paper_key(std::io::stdout(), &data, subject, output_format)
}
pub fn cli() -> CliCommandMap {
let key_import_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_IMPORT_MASTER_PUBKEY)
.arg_param(&["path"])
.completion_cb("path", tools::complete_file_name);
+ let key_show_master_pubkey_cmd_def = CliCommand::new(&API_METHOD_SHOW_MASTER_PUBKEY)
+ .arg_param(&["path"])
+ .completion_cb("path", tools::complete_file_name);
let key_show_cmd_def = CliCommand::new(&API_METHOD_SHOW_KEY)
.arg_param(&["path"])
.insert("import-master-pubkey", key_import_master_pubkey_cmd_def)
.insert("change-passphrase", key_change_passphrase_cmd_def)
.insert("show", key_show_cmd_def)
+ .insert("show-master-pubkey", key_show_master_pubkey_cmd_def)
.insert("paperkey", paper_key_cmd_def)
}
-
-fn paperkey_html(lines: &[String], subject: Option<String>, is_private: bool) -> Result<(), Error> {
-
- let img_size_pt = 500;
-
- println!("<!DOCTYPE html>");
- println!("<html lang=\"en\">");
- println!("<head>");
- println!("<meta charset=\"utf-8\">");
- println!("<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">");
- println!("<title>Proxmox Backup Paperkey</title>");
- println!("<style type=\"text/css\">");
-
- println!(" p {{");
- println!(" font-size: 12pt;");
- println!(" font-family: monospace;");
- println!(" white-space: pre-wrap;");
- println!(" line-break: anywhere;");
- println!(" }}");
-
- println!("</style>");
-
- println!("</head>");
-
- println!("<body>");
-
- if let Some(subject) = subject {
- println!("<p>Subject: {}</p>", subject);
- }
-
- if is_private {
- const BLOCK_SIZE: usize = 20;
- let blocks = (lines.len() + BLOCK_SIZE -1)/BLOCK_SIZE;
-
- for i in 0..blocks {
- let start = i*BLOCK_SIZE;
- let mut end = start + BLOCK_SIZE;
- if end > lines.len() {
- end = lines.len();
- }
- let data = &lines[start..end];
-
- println!("<div style=\"page-break-inside: avoid;page-break-after: always\">");
- println!("<p>");
-
- for l in start..end {
- println!("{:02}: {}", l, lines[l]);
- }
-
- println!("</p>");
-
- let qr_code = generate_qr_code("svg", data)?;
- let qr_code = base64::encode_config(&qr_code, base64::STANDARD_NO_PAD);
-
- println!("<center>");
- println!("<img");
- println!("width=\"{}pt\" height=\"{}pt\"", img_size_pt, img_size_pt);
- println!("src=\"data:image/svg+xml;base64,{}\"/>", qr_code);
- println!("</center>");
- println!("</div>");
- }
-
- println!("</body>");
- println!("</html>");
- return Ok(());
- }
-
- println!("<div style=\"page-break-inside: avoid\">");
-
- println!("<p>");
-
- println!("-----BEGIN PROXMOX BACKUP KEY-----");
-
- for line in lines {
- println!("{}", line);
- }
-
- println!("-----END PROXMOX BACKUP KEY-----");
-
- println!("</p>");
-
- let qr_code = generate_qr_code("svg", lines)?;
- let qr_code = base64::encode_config(&qr_code, base64::STANDARD_NO_PAD);
-
- println!("<center>");
- println!("<img");
- println!("width=\"{}pt\" height=\"{}pt\"", img_size_pt, img_size_pt);
- println!("src=\"data:image/svg+xml;base64,{}\"/>", qr_code);
- println!("</center>");
-
- println!("</div>");
-
- println!("</body>");
- println!("</html>");
-
- Ok(())
-}
-
-fn paperkey_text(lines: &[String], subject: Option<String>, is_private: bool) -> Result<(), Error> {
-
- if let Some(subject) = subject {
- println!("Subject: {}\n", subject);
- }
-
- if is_private {
- const BLOCK_SIZE: usize = 5;
- let blocks = (lines.len() + BLOCK_SIZE -1)/BLOCK_SIZE;
-
- for i in 0..blocks {
- let start = i*BLOCK_SIZE;
- let mut end = start + BLOCK_SIZE;
- if end > lines.len() {
- end = lines.len();
- }
- let data = &lines[start..end];
-
- for l in start..end {
- println!("{:-2}: {}", l, lines[l]);
- }
- let qr_code = generate_qr_code("utf8i", data)?;
- let qr_code = String::from_utf8(qr_code)
- .map_err(|_| format_err!("Failed to read qr code (got non-utf8 data)"))?;
- println!("{}", qr_code);
- println!("{}", char::from(12u8)); // page break
-
- }
- return Ok(());
- }
-
- println!("-----BEGIN PROXMOX BACKUP KEY-----");
- for line in lines {
- println!("{}", line);
- }
- println!("-----END PROXMOX BACKUP KEY-----");
-
- let qr_code = generate_qr_code("utf8i", &lines)?;
- let qr_code = String::from_utf8(qr_code)
- .map_err(|_| format_err!("Failed to read qr code (got non-utf8 data)"))?;
-
- println!("{}", qr_code);
-
- Ok(())
-}
-
-fn generate_qr_code(output_type: &str, lines: &[String]) -> Result<Vec<u8>, Error> {
- let mut child = Command::new("qrencode")
- .args(&["-t", output_type, "-m0", "-s1", "-lm", "--output", "-"])
- .stdin(Stdio::piped())
- .stdout(Stdio::piped())
- .spawn()?;
-
- {
- let stdin = child.stdin.as_mut()
- .ok_or_else(|| format_err!("Failed to open stdin"))?;
- let data = lines.join("\n");
- stdin.write_all(data.as_bytes())
- .map_err(|_| format_err!("Failed to write to stdin"))?;
- }
-
- let output = child.wait_with_output()
- .map_err(|_| format_err!("Failed to read stdout"))?;
-
- let output = crate::tools::command_output(output, None)?;
-
- Ok(output)
-}
projects / proxmox-backup.git / blobdiff