mirrors/rage
1
0
Fork 0
mirror of https://github.com/str4d/rage.git synced 2025-04-04 11:27:43 +03:00
Code Issues Projects Releases Packages Wiki Activity

Add argument support to *fl! macros

Browse source
This commit is contained in:
Jack Grigg 2024-01-06 23:23:26 +00:00
parent 22a7b96440
commit aeb165dbbc
10 changed files with 105 additions and 229 deletions
Download patch file Download diff file Expand all files Collapse all files

32
age/src/cli_common.rs
View file

@ -13,7 +13,7 @@ use std::fs::File;
use std::io::{self, BufReader};
use subtle::ConstantTimeEq;
use crate::{fl, identity::IdentityFile, wfl, Callbacks, Identity};
use crate::{fl, identity::IdentityFile, wfl, wlnfl, Callbacks, Identity};
#[cfg(feature = "armor")]
use crate::armor::ArmoredReader;
@ -55,37 +55,21 @@ impl fmt::Display for ReadError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
ReadError::IdentityEncryptedWithoutPassphrase(filename) => {
write!(
wfl!(
f,
"{}",
i18n_embed_fl::fl!(
crate::i18n::LANGUAGE_LOADER,
"err-read-identity-encrypted-without-passphrase",
filename = filename.as_str()
)
"err-read-identity-encrypted-without-passphrase",
filename = filename.as_str(),
)
}
ReadError::IdentityNotFound(filename) => write!(
ReadError::IdentityNotFound(filename) => wfl!(
f,
"{}",
i18n_embed_fl::fl!(
crate::i18n::LANGUAGE_LOADER,
"err-read-identity-not-found",
filename = filename.as_str()
)
"err-read-identity-not-found",
filename = filename.as_str(),
),
ReadError::Io(e) => write!(f, "{}", e),
#[cfg(feature = "plugin")]
ReadError::MissingPlugin { binary_name } => {
writeln!(
f,
"{}",
i18n_embed_fl::fl!(
crate::i18n::LANGUAGE_LOADER,
"err-missing-plugin",
plugin_name = binary_name.as_str()
)
)?;
wlnfl!(f, "err-missing-plugin", plugin_name = binary_name.as_str())?;
wfl!(f, "rec-missing-plugin")
}
#[cfg(feature = "ssh")]

8
age/src/encrypted.rs
View file

@ -2,11 +2,9 @@
use std::{cell::Cell, io};
use i18n_embed_fl::fl;
use crate::{
decryptor::PassphraseDecryptor, Callbacks, DecryptError, Decryptor, EncryptError, IdentityFile,
IdentityFileEntry,
decryptor::PassphraseDecryptor, fl, Callbacks, DecryptError, Decryptor, EncryptError,
IdentityFile, IdentityFileEntry,
};
/// The state of the encrypted age identity.
@ -46,7 +44,6 @@ impl<R: io::Read> IdentityState<R> {
max_work_factor,
} => {
let passphrase = match callbacks.request_passphrase(&fl!(
crate::i18n::LANGUAGE_LOADER,
"encrypted-passphrase-prompt",
filename = filename.unwrap_or_default()
)) {
@ -169,7 +166,6 @@ impl<R: io::Read, C: Callbacks> Identity<R, C> {
// matched, warn the user.
if requested_passphrase && result.is_none() {
self.callbacks.display_message(&fl!(
crate::i18n::LANGUAGE_LOADER,
"encrypted-warn-no-match",
filename = self.filename.as_deref().unwrap_or_default()
));

57
age/src/error.rs
View file

@ -1,6 +1,5 @@
//! Error type.
use i18n_embed_fl::fl;
use std::fmt;
use std::io;
@ -61,30 +60,22 @@ impl fmt::Display for PluginError {
PluginError::Identity {
binary_name,
message,
} => write!(
} => wfl!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"err-plugin-identity",
plugin_name = binary_name.as_str(),
message = message.as_str()
)
"err-plugin-identity",
plugin_name = binary_name.as_str(),
message = message.as_str(),
),
PluginError::Recipient {
binary_name,
recipient,
message,
} => write!(
} => wfl!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"err-plugin-recipient",
plugin_name = binary_name.as_str(),
recipient = recipient.as_str(),
message = message.as_str()
)
"err-plugin-recipient",
plugin_name = binary_name.as_str(),
recipient = recipient.as_str(),
message = message.as_str(),
),
PluginError::Other {
kind,
@ -153,15 +144,7 @@ impl fmt::Display for EncryptError {
EncryptError::Io(e) => e.fmt(f),
#[cfg(feature = "plugin")]
EncryptError::MissingPlugin { binary_name } => {
writeln!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"err-missing-plugin",
plugin_name = binary_name.as_str()
)
)?;
wlnfl!(f, "err-missing-plugin", plugin_name = binary_name.as_str())?;
wfl!(f, "rec-missing-plugin")
}
#[cfg(feature = "plugin")]
@ -258,14 +241,10 @@ impl fmt::Display for DecryptError {
DecryptError::DecryptionFailed => wfl!(f, "err-decryption-failed"),
DecryptError::ExcessiveWork { required, target } => {
wlnfl!(f, "err-excessive-work")?;
write!(
wfl!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"rec-excessive-work",
duration = (1 << (required - target))
)
"rec-excessive-work",
duration = (1 << (required - target)),
)
}
DecryptError::InvalidHeader => wfl!(f, "err-header-invalid"),
@ -274,15 +253,7 @@ impl fmt::Display for DecryptError {
DecryptError::KeyDecryptionFailed => wfl!(f, "err-key-decryption"),
#[cfg(feature = "plugin")]
DecryptError::MissingPlugin { binary_name } => {
writeln!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"err-missing-plugin",
plugin_name = binary_name.as_str()
)
)?;
wlnfl!(f, "err-missing-plugin", plugin_name = binary_name.as_str())?;
wfl!(f, "rec-missing-plugin")
}
DecryptError::NoMatchingKeys => wfl!(f, "err-no-matching-keys"),

12
age/src/i18n.rs
View file

@ -28,6 +28,10 @@ macro_rules! fl {
($message_id:literal) => {{
i18n_embed_fl::fl!($crate::i18n::LANGUAGE_LOADER, $message_id)
}};
($message_id:literal, $($args:expr),* $(,)?) => {{
i18n_embed_fl::fl!($crate::i18n::LANGUAGE_LOADER, $message_id, $($args), *)
}};
}
/// age-localized version of the write! macro.
@ -37,6 +41,10 @@ macro_rules! wfl {
($f:ident, $message_id:literal) => {
write!($f, "{}", $crate::fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
write!($f, "{}", $crate::fl!($message_id, $($args), *))
};
}
/// age-localized version of the writeln! macro.
@ -46,6 +54,10 @@ macro_rules! wlnfl {
($f:ident, $message_id:literal) => {
writeln!($f, "{}", $crate::fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
writeln!($f, "{}", $crate::fl!($message_id, $($args), *))
};
}
/// Returns the [`Localizer`] to be used for localizing this library.

3
age/src/plugin.rs
View file

@ -8,7 +8,6 @@ use age_core::{
};
use base64::{prelude::BASE64_STANDARD_NO_PAD, Engine};
use bech32::Variant;
use i18n_embed_fl::fl;
use std::borrow::Borrow;
use std::fmt;
@ -22,6 +21,7 @@ use std::time::{Duration, SystemTime};
use crate::{
error::{DecryptError, EncryptError, PluginError},
fl,
util::parse_bech32,
Callbacks,
};
@ -68,7 +68,6 @@ impl SlowPluginGuard {
match SystemTime::now().duration_since(start) {
Ok(end) if end >= TEN_SECONDS => {
callbacks.display_message(&fl!(
crate::i18n::LANGUAGE_LOADER,
"plugin-waiting-on-binary",
binary_name = plugin_binary_name,
));

51
age/src/ssh/identity.rs
View file

@ -4,7 +4,6 @@ use age_core::{
secrecy::{ExposeSecret, Secret},
};
use base64::prelude::BASE64_STANDARD;
use i18n_embed_fl::fl;
use nom::{
branch::alt,
bytes::streaming::{is_not, tag},
@ -27,8 +26,9 @@ use super::{
};
use crate::{
error::DecryptError,
fl,
util::read::{base64_arg, wrapped_str_while_encoded},
Callbacks,
wlnfl, Callbacks,
};
/// An SSH private key for decrypting an age file.
@ -144,53 +144,31 @@ impl UnsupportedKey {
/// Prints details about this unsupported key.
pub fn display(&self, f: &mut fmt::Formatter, filename: Option<&str>) -> fmt::Result {
if let Some(name) = filename {
writeln!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"ssh-unsupported-key",
name = name
)
)?;
wlnfl!(f, "ssh-unsupported-key", name = name)?;
writeln!(f)?;
}
match self {
UnsupportedKey::EncryptedPem => writeln!(
UnsupportedKey::EncryptedPem => wlnfl!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"ssh-insecure-key-format",
change_passphrase = "ssh-keygen -o -p",
gen_new = "ssh-keygen -o"
)
"ssh-insecure-key-format",
change_passphrase = "ssh-keygen -o -p",
gen_new = "ssh-keygen -o",
)?,
UnsupportedKey::EncryptedSsh(cipher) => {
let new_issue = format!(
"https://github.com/str4d/rage/issues/new?title=Support%20OpenSSH%20key%20encryption%20cipher%20{}",
cipher,
);
writeln!(
wlnfl!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"ssh-unsupported-cipher",
cipher = cipher.as_str(),
new_issue = new_issue.as_str()
)
"ssh-unsupported-cipher",
cipher = cipher.as_str(),
new_issue = new_issue.as_str(),
)?;
}
UnsupportedKey::Type(key_type) => writeln!(
f,
"{}",
fl!(
crate::i18n::LANGUAGE_LOADER,
"ssh-unsupported-key-type",
key_type = key_type.as_str(),
)
)?,
UnsupportedKey::Type(key_type) => {
wlnfl!(f, "ssh-unsupported-key-type", key_type = key_type.as_str())?
}
}
Ok(())
}
@ -289,7 +267,6 @@ impl<C: Callbacks> crate::Identity for DecryptableIdentity<C> {
Identity::Unencrypted(key) => key.unwrap_stanza(stanza),
Identity::Encrypted(enc) => {
let passphrase = self.callbacks.request_passphrase(&fl!(
crate::i18n::LANGUAGE_LOADER,
"ssh-passphrase-prompt",
filename = enc.filename.as_deref().unwrap_or_default()
))?;

22
rage/src/bin/rage-keygen/main.rs
View file

@ -23,6 +23,10 @@ macro_rules! fl {
($message_id:literal) => {{
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id)
}};
($message_id:literal, $($args:expr),* $(,)?) => {{
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id, $($args), *)
}};
}
#[derive(Debug, Options)]
@ -62,14 +66,7 @@ fn main() {
match file_io::OutputWriter::new(opts.output, file_io::OutputFormat::Text, 0o600, false) {
Ok(output) => output,
Err(e) => {
error!(
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
"err-failed-to-open-output",
err = e.to_string()
)
);
error!("{}", fl!("err-failed-to-open-output", err = e.to_string()));
return;
}
};
@ -91,13 +88,6 @@ fn main() {
writeln!(output, "# {}: {}", fl!("identity-file-pubkey"), pk)?;
writeln!(output, "{}", sk.to_string().expose_secret())
})() {
error!(
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
"err-failed-to-write-output",
err = e.to_string()
)
);
error!("{}", fl!("err-failed-to-write-output", err = e.to_string()));
}
}

40
rage/src/bin/rage-mount/main.rs
View file

@ -34,7 +34,11 @@ lazy_static! {
macro_rules! fl {
($message_id:literal) => {{
i18n_embed_fl::fl!(LANGUAGE_LOADER, $message_id)
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id)
}};
($message_id:literal, $($args:expr),* $(,)?) => {{
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id, $($args), *)
}};
}
@ -42,12 +46,20 @@ macro_rules! wfl {
($f:ident, $message_id:literal) => {
write!($f, "{}", fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
write!($f, "{}", fl!($message_id, $($args), *))
};
}
macro_rules! wlnfl {
($f:ident, $message_id:literal) => {
writeln!($f, "{}", fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
writeln!($f, "{}", fl!($message_id, $($args), *))
};
}
enum Error {
@ -87,15 +99,7 @@ impl fmt::Debug for Error {
Error::Age(e) => match e {
age::DecryptError::ExcessiveWork { required, .. } => {
writeln!(f, "{}", e)?;
write!(
f,
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
"rec-dec-excessive-work",
wf = required
)
)
wfl!(f, "rec-dec-excessive-work", wf = required)
}
_ => write!(f, "{}", e),
},
@ -108,15 +112,7 @@ impl fmt::Debug for Error {
}
Error::MissingMountpoint => wfl!(f, "err-mnt-missing-mountpoint"),
Error::MissingType => wfl!(f, "err-mnt-missing-types"),
Error::UnknownType(t) => write!(
f,
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
"err-mnt-unknown-type",
fs_type = t.as_str()
)
),
Error::UnknownType(t) => wfl!(f, "err-mnt-unknown-type", fs_type = t.as_str()),
}?;
writeln!(f)?;
writeln!(f, "[ {} ]", fl!("err-ux-A"))?;
@ -253,11 +249,7 @@ fn main() -> Result<(), Error> {
info!(
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
"info-decrypting",
filename = opts.filename.as_str()
)
fl!("info-decrypting", filename = opts.filename.as_str()),
);
let file = File::open(opts.filename)?;

93
rage/src/bin/rage/error.rs
View file

@ -1,4 +1,3 @@
use i18n_embed_fl::fl;
use std::fmt;
use std::io;
@ -6,12 +5,20 @@ macro_rules! wfl {
($f:ident, $message_id:literal) => {
write!($f, "{}", $crate::fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
write!($f, "{}", $crate::fl!($message_id, $($args), *))
};
}
macro_rules! wlnfl {
($f:ident, $message_id:literal) => {
writeln!($f, "{}", $crate::fl!($message_id))
};
($f:ident, $message_id:literal, $($args:expr),* $(,)?) => {
writeln!($f, "{}", $crate::fl!($message_id, $($args), *))
};
}
pub(crate) enum EncryptError {
@ -58,56 +65,28 @@ impl fmt::Display for EncryptError {
EncryptError::Age(e) => write!(f, "{}", e),
EncryptError::BrokenPipe { is_stdout, source } => {
if *is_stdout {
writeln!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-enc-broken-stdout",
err = source.to_string()
)
)?;
wlnfl!(f, "err-enc-broken-stdout", err = source.to_string())?;
wfl!(f, "rec-enc-broken-stdout")
} else {
write!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-enc-broken-file",
err = source.to_string()
)
)
wfl!(f, "err-enc-broken-file", err = source.to_string())
}
}
EncryptError::IdentityEncryptedWithoutPassphrase(filename) => {
write!(
wfl!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-dec-identity-encrypted-without-passphrase",
filename = filename.as_str()
)
"err-dec-identity-encrypted-without-passphrase",
filename = filename.as_str(),
)
}
EncryptError::IdentityNotFound(filename) => write!(
EncryptError::IdentityNotFound(filename) => wfl!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-dec-identity-not-found",
filename = filename.as_str()
)
"err-dec-identity-not-found",
filename = filename.as_str(),
),
EncryptError::InvalidRecipient(recipient) => write!(
EncryptError::InvalidRecipient(recipient) => wfl!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-enc-invalid-recipient",
recipient = recipient.as_str()
)
"err-enc-invalid-recipient",
recipient = recipient.as_str(),
),
EncryptError::Io(e) => write!(f, "{}", e),
EncryptError::MissingRecipients => {
@ -131,15 +110,9 @@ impl fmt::Display for EncryptError {
wfl!(f, "err-enc-plugin-name-flag")
}
#[cfg(feature = "ssh")]
EncryptError::RsaModulusTooLarge => write!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-enc-rsa-modulus-too-large",
max_size = 4096,
)
),
EncryptError::RsaModulusTooLarge => {
wfl!(f, "err-enc-rsa-modulus-too-large", max_size = 4096)
}
#[cfg(feature = "ssh")]
EncryptError::UnsupportedKey(filename, k) => k.display(f, Some(filename.as_str())),
}
@ -198,15 +171,7 @@ impl fmt::Display for DecryptError {
DecryptError::Age(e) => match e {
age::DecryptError::ExcessiveWork { required, .. } => {
writeln!(f, "{}", e)?;
write!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"rec-dec-excessive-work",
wf = required
)
)
wfl!(f, "rec-dec-excessive-work", wf = required)
}
_ => write!(f, "{}", e),
},
@ -276,15 +241,9 @@ impl fmt::Debug for Error {
Error::Encryption(e) => writeln!(f, "{}", e)?,
Error::IdentityFlagAmbiguous => wlnfl!(f, "err-identity-ambiguous")?,
Error::MixedEncryptAndDecrypt => wlnfl!(f, "err-mixed-encrypt-decrypt")?,
Error::SameInputAndOutput(filename) => writeln!(
f,
"{}",
fl!(
crate::LANGUAGE_LOADER,
"err-same-input-and-output",
filename = filename.as_str()
)
)?,
Error::SameInputAndOutput(filename) => {
wlnfl!(f, "err-same-input-and-output", filename = filename.as_str())?
}
}
writeln!(f)?;
writeln!(f, "[ {} ]", crate::fl!("err-ux-A"))?;

16
rage/src/bin/rage/main.rs
View file

@ -35,18 +35,15 @@ macro_rules! fl {
($message_id:literal) => {{
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id)
}};
($message_id:literal, $($args:expr),* $(,)?) => {{
i18n_embed_fl::fl!($crate::LANGUAGE_LOADER, $message_id, $($args), *)
}};
}
macro_rules! warning {
($warning_id:literal) => {{
eprintln!(
"{}",
i18n_embed_fl::fl!(
$crate::LANGUAGE_LOADER,
"warning-msg",
warning = fl!($warning_id)
)
);
eprintln!("{}", fl!("warning-msg", warning = fl!($warning_id)));
}};
}
@ -627,8 +624,7 @@ fn main() -> Result<(), error::Error> {
println!(
"{}",
i18n_embed_fl::fl!(
LANGUAGE_LOADER,
fl!(
"rage-usage",
usage_a = usage_a,
usage_b = usage_b,