From cf2025c60b59c99c9f55d58a4a7d83491c95d6d8 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Mon, 23 Mar 2020 23:29:03 +1300 Subject: [PATCH] Consistently refer to "age files" --- age/src/cli_common/file_io.rs | 2 +- age/src/error.rs | 8 ++++---- age/src/format.rs | 2 +- age/src/format/ssh_rsa.rs | 2 +- age/src/keys.rs | 4 ++-- age/src/lib.rs | 2 +- age/src/primitives/stream.rs | 10 +++++----- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/age/src/cli_common/file_io.rs b/age/src/cli_common/file_io.rs index fff6057..65a3033 100644 --- a/age/src/cli_common/file_io.rs +++ b/age/src/cli_common/file_io.rs @@ -11,7 +11,7 @@ use crate::util::LINE_ENDING; const SHORT_OUTPUT_LENGTH: usize = 20 * 80; const TRUNCATED_TTY_MSG: &[u8] = - b"[truncated; use a pipe, a redirect, or -o/--output to see full message]"; + b"[truncated; use a pipe, a redirect, or -o/--output to decrypt the entire file]"; #[derive(Debug)] struct DenyBinaryOutputError; diff --git a/age/src/error.rs b/age/src/error.rs index b7bf035..5ad8691 100644 --- a/age/src/error.rs +++ b/age/src/error.rs @@ -6,9 +6,9 @@ use std::io; /// The various errors that can be returned during the decryption process. #[derive(Debug)] pub enum Error { - /// The message failed to decrypt. + /// The age file failed to decrypt. DecryptionFailed, - /// The message used an excessive work factor for passphrase encryption. + /// The age file used an excessive work factor for passphrase encryption. ExcessiveWork { /// The work factor required to decrypt. required: u8, @@ -17,13 +17,13 @@ pub enum Error { }, /// The age header was invalid. InvalidHeader, - /// The MAC in the message header was invalid. + /// The MAC in the age header was invalid. InvalidMac, /// An I/O error occurred during decryption. Io(io::Error), /// Failed to decrypt an encrypted key. KeyDecryptionFailed, - /// None of the provided keys could be used to decrypt the message. + /// None of the provided keys could be used to decrypt the age file. NoMatchingKeys, /// An unknown age format, probably from a newer version. UnknownFormat, diff --git a/age/src/format.rs b/age/src/format.rs index 837f8e4..71b3839 100644 --- a/age/src/format.rs +++ b/age/src/format.rs @@ -1,4 +1,4 @@ -//! The age message format. +//! The age file format. use rand::{ distributions::{Distribution, Uniform}, diff --git a/age/src/format/ssh_rsa.rs b/age/src/format/ssh_rsa.rs index 1e8d299..10640e4 100644 --- a/age/src/format/ssh_rsa.rs +++ b/age/src/format/ssh_rsa.rs @@ -49,7 +49,7 @@ impl RecipientLine { &mut h, Some(SSH_RSA_OAEP_LABEL.to_owned()), ) - .expect("pubkey is valid and message is not too long"); + .expect("pubkey is valid and file key is not too long"); RecipientLine { tag: ssh_tag(&ssh_key), diff --git a/age/src/keys.rs b/age/src/keys.rs index 6c133b7..1a06ee8 100644 --- a/age/src/keys.rs +++ b/age/src/keys.rs @@ -49,7 +49,7 @@ impl FileKey { } } -/// A secret key for decrypting an age message. +/// A secret key for decrypting an age file. pub enum SecretKey { /// An X25519 secret key. X25519(StaticSecret), @@ -330,7 +330,7 @@ impl Identity { } } -/// A key that can be used to encrypt an age message to a recipient. +/// A key that can be used to encrypt a file to a recipient. #[derive(Clone, Debug)] pub enum RecipientKey { /// An X25519 recipient key. diff --git a/age/src/lib.rs b/age/src/lib.rs index d771288..d2d3d0e 100644 --- a/age/src/lib.rs +++ b/age/src/lib.rs @@ -1,4 +1,4 @@ -//! *Library for encrypting and decryping age messages* +//! *Library for encrypting and decryping age files* //! //! age is a simple, secure, and modern encryption tool with small explicit keys, no //! config options, and UNIX-style composability. diff --git a/age/src/primitives/stream.rs b/age/src/primitives/stream.rs index 93491c4..4efac1a 100644 --- a/age/src/primitives/stream.rs +++ b/age/src/primitives/stream.rs @@ -128,7 +128,7 @@ impl Stream { } } -/// Writes an encrypted age message. +/// Writes an encrypted age file. pub struct StreamWriter { stream: Stream, inner: ArmoredWriter, @@ -197,7 +197,7 @@ enum StartPos { Explicit(u64), } -/// Provides access to a decrypted age message. +/// Provides access to a decrypted age file. pub struct StreamReader { stream: Stream, inner: ArmoredReader, @@ -254,14 +254,14 @@ impl Read for StreamReader { // Stream has ended before seeing the last chunk. return Err(io::Error::new( io::ErrorKind::UnexpectedEof, - "message is truncated", + "age file is truncated", )); } else { return Ok(0); } } - // This check works for all cases except when the message is an integer + // This check works for all cases except when the age file is an integer // multiple of the chunk size. In that case, we try decrypting twice on a // decryption failure. let last = end < ENCRYPTED_CHUNK_SIZE; @@ -507,7 +507,7 @@ mod tests { } #[test] - fn stream_fails_to_decrypt_truncated_message() { + fn stream_fails_to_decrypt_truncated_file() { let key = [7; 32]; let data = vec![42; 2 * CHUNK_SIZE];