|
| 1 | +//! The "tag" recipient type, native to age. |
| 2 | +
|
| 3 | +use std::collections::HashSet; |
| 4 | +use std::fmt; |
| 5 | + |
| 6 | +use age_core::{ |
| 7 | + format::{FileKey, Stanza}, |
| 8 | + primitives::hpke_seal, |
| 9 | + secrecy::ExposeSecret, |
| 10 | +}; |
| 11 | +use base64::{prelude::BASE64_STANDARD_NO_PAD, Engine}; |
| 12 | +use bech32::{ToBase32, Variant}; |
| 13 | +use hpke::{Deserializable, Serializable}; |
| 14 | +use p256::{ |
| 15 | + elliptic_curve::sec1::{FromEncodedPoint, ToEncodedPoint}, |
| 16 | + EncodedPoint, PublicKey, |
| 17 | +}; |
| 18 | +use rand::rngs::OsRng; |
| 19 | + |
| 20 | +use crate::{util::parse_bech32, EncryptError}; |
| 21 | + |
| 22 | +const RECIPIENT_PREFIX: &str = "age1tag"; |
| 23 | + |
| 24 | +const P256TAG_RECIPIENT_TAG: &str = "p256tag"; |
| 25 | +const P256TAG_SALT: &str = "age-encryption.org/p256tag"; |
| 26 | + |
| 27 | +type Kem = hpke::kem::DhP256HkdfSha256; |
| 28 | + |
| 29 | +/// The non-hybrid tagged age recipient type, designed for hardware keys where decryption |
| 30 | +/// potentially requires user presence. |
| 31 | +/// |
| 32 | +/// With knowledge of the recipient, it is possible to check if a stanza was addressed to |
| 33 | +/// a specific recipient before attempting decryption. This offers less privacy than the |
| 34 | +/// untagged recipient types. |
| 35 | +#[derive(Clone, PartialEq, Eq)] |
| 36 | +pub struct Recipient { |
| 37 | + /// Compressed encoding of the recipient public key. |
| 38 | + compressed: EncodedPoint, |
| 39 | + /// Cached in-memory representation, for HPKE. |
| 40 | + pk_recip: <Kem as hpke::Kem>::PublicKey, |
| 41 | +} |
| 42 | + |
| 43 | +impl std::str::FromStr for Recipient { |
| 44 | + type Err = &'static str; |
| 45 | + |
| 46 | + /// Parses a recipient key from a string. |
| 47 | + fn from_str(s: &str) -> Result<Self, Self::Err> { |
| 48 | + let (hrp, bytes) = parse_bech32(s).ok_or("invalid Bech32 encoding")?; |
| 49 | + |
| 50 | + if hrp != RECIPIENT_PREFIX { |
| 51 | + return Err("incorrect HRP"); |
| 52 | + } |
| 53 | + |
| 54 | + let encoded = EncodedPoint::from_bytes(bytes).map_err(|_| "invalid SEC-1 encoding")?; |
| 55 | + if !encoded.is_compressed() { |
| 56 | + return Err("not a compressed SEC-1 encoding"); |
| 57 | + } |
| 58 | + |
| 59 | + let point = PublicKey::from_encoded_point(&encoded) |
| 60 | + .into_option() |
| 61 | + .ok_or("invalid P-256 point")?; |
| 62 | + |
| 63 | + let pk_recip = |
| 64 | + <Kem as hpke::Kem>::PublicKey::from_bytes(point.to_encoded_point(false).as_bytes()) |
| 65 | + .expect("valid"); |
| 66 | + |
| 67 | + Ok(Self { |
| 68 | + compressed: encoded, |
| 69 | + pk_recip, |
| 70 | + }) |
| 71 | + } |
| 72 | +} |
| 73 | + |
| 74 | +impl fmt::Display for Recipient { |
| 75 | + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { |
| 76 | + write!( |
| 77 | + f, |
| 78 | + "{}", |
| 79 | + bech32::encode( |
| 80 | + RECIPIENT_PREFIX, |
| 81 | + self.compressed.as_bytes().to_base32(), |
| 82 | + Variant::Bech32 |
| 83 | + ) |
| 84 | + .expect("HRP is valid") |
| 85 | + ) |
| 86 | + } |
| 87 | +} |
| 88 | + |
| 89 | +impl fmt::Debug for Recipient { |
| 90 | + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { |
| 91 | + write!(f, "{}", self) |
| 92 | + } |
| 93 | +} |
| 94 | + |
| 95 | +impl crate::Recipient for Recipient { |
| 96 | + fn wrap_file_key( |
| 97 | + &self, |
| 98 | + file_key: &FileKey, |
| 99 | + ) -> Result<(Vec<Stanza>, HashSet<String>), EncryptError> { |
| 100 | + let (enc, ct) = hpke_seal::<Kem, _>( |
| 101 | + &self.pk_recip, |
| 102 | + P256TAG_SALT.as_bytes(), |
| 103 | + file_key.expose_secret(), |
| 104 | + &mut OsRng, |
| 105 | + ); |
| 106 | + |
| 107 | + let ikm = enc |
| 108 | + .to_bytes() |
| 109 | + .into_iter() |
| 110 | + .chain(super::static_tag(self.compressed.as_bytes())) |
| 111 | + .collect::<Vec<u8>>(); |
| 112 | + let tag = super::stanza_tag(&ikm, P256TAG_SALT); |
| 113 | + |
| 114 | + let encoded_tag = BASE64_STANDARD_NO_PAD.encode(tag); |
| 115 | + let encoded_enc = BASE64_STANDARD_NO_PAD.encode(enc.to_bytes()); |
| 116 | + |
| 117 | + Ok(( |
| 118 | + vec![Stanza { |
| 119 | + tag: P256TAG_RECIPIENT_TAG.to_owned(), |
| 120 | + args: vec![encoded_tag, encoded_enc], |
| 121 | + body: ct, |
| 122 | + }], |
| 123 | + HashSet::new(), |
| 124 | + )) |
| 125 | + } |
| 126 | +} |
| 127 | + |
| 128 | +#[cfg(test)] |
| 129 | +pub(crate) mod tests { |
| 130 | + use super::Recipient; |
| 131 | + |
| 132 | + pub(crate) const TEST_RECIPIENT: &str = |
| 133 | + "age1tag1qt8lw0ual6avlwmwatk888yqnmdamm7xfd0wak53ut6elz5c4swx2yqdj4e"; |
| 134 | + |
| 135 | + #[test] |
| 136 | + fn recipient_encoding() { |
| 137 | + let recipient: Recipient = TEST_RECIPIENT.parse().unwrap(); |
| 138 | + assert_eq!(recipient.to_string(), TEST_RECIPIENT); |
| 139 | + } |
| 140 | +} |
0 commit comments