1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
use std::fmt;
#[cfg(test)]
use quickcheck::{Arbitrary, Gen};
use crate::Error;
use crate::Fingerprint;
use crate::Result;
/// A short identifier for certificates and keys.
///
/// A `KeyID` identifies a public key. It is used, for example, to
/// reference the issuing key of a signature in its [`Issuer`]
/// subpacket.
///
/// Currently, Sequoia supports *version 4* fingerprints and Key IDs
/// only. *Version 3* fingerprints and Key IDs were deprecated by
/// [RFC 4880] in 2007.
///
/// A *v4* `KeyID` is defined as a fragment (the lower 8 bytes) of the
/// key's fingerprint, which in turn is essentially a SHA-1 hash of
/// the public key packet. As a general rule of thumb, you should
/// prefer the fingerprint as it is possible to create keys with a
/// colliding KeyID using a [birthday attack].
///
/// For more details about how a `KeyID` is generated, see [Section
/// 12.2 of RFC 4880].
///
/// In previous versions of OpenPGP, the Key ID used to be called
/// "long Key ID", as there even was a "short Key ID". At only 4 bytes
/// length, short Key IDs vulnerable to preimage attacks. That is, an
/// attacker can create a key with any given short Key ID in short
/// amount of time.
///
/// See also [`Fingerprint`] and [`KeyHandle`].
///
/// [RFC 4880]: https://tools.ietf.org/html/rfc4880
/// [Section 12.2 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-12.2
/// [birthday attack]: https://nullprogram.com/blog/2019/07/22/
/// [`Issuer`]: crate::packet::signature::subpacket::SubpacketValue::Issuer
/// [`Fingerprint`]: crate::Fingerprint
/// [`KeyHandle`]: crate::KeyHandle
///
/// Note: This enum cannot be exhaustively matched to allow future
/// extensions.
///
/// # Examples
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let id: KeyID = "0123 4567 89AB CDEF".parse()?;
///
/// assert_eq!("0123456789ABCDEF", id.to_hex());
/// # Ok(()) }
/// ```
#[non_exhaustive]
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Hash)]
pub enum KeyID {
/// Lower 8 byte SHA-1 hash.
V4([u8;8]),
/// Used for holding invalid keyids encountered during parsing
/// e.g. wrong number of bytes.
Invalid(Box<[u8]>),
}
assert_send_and_sync!(KeyID);
impl fmt::Display for KeyID {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:X}", self)
}
}
impl fmt::Debug for KeyID {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_tuple("KeyID")
.field(&self.to_string())
.finish()
}
}
impl fmt::UpperHex for KeyID {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
self.write_to_fmt(f, true)
}
}
impl fmt::LowerHex for KeyID {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
self.write_to_fmt(f, false)
}
}
impl std::str::FromStr for KeyID {
type Err = anyhow::Error;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
let bytes = crate::fmt::hex::decode_pretty(s)?;
// A KeyID is exactly 8 bytes long.
if bytes.len() == 8 {
Ok(KeyID::from_bytes(&bytes[..]))
} else {
// Maybe a fingerprint was given. Try to parse it and
// convert it to a KeyID.
Ok(s.parse::<Fingerprint>()?.into())
}
}
}
impl From<KeyID> for Vec<u8> {
fn from(id: KeyID) -> Self {
let mut r = Vec::with_capacity(8);
match id {
KeyID::V4(ref b) => r.extend_from_slice(b),
KeyID::Invalid(ref b) => r.extend_from_slice(b),
}
r
}
}
impl From<u64> for KeyID {
fn from(id: u64) -> Self {
Self::new(id)
}
}
impl From<[u8; 8]> for KeyID {
fn from(id: [u8; 8]) -> Self {
KeyID::from_bytes(&id[..])
}
}
impl From<&Fingerprint> for KeyID {
fn from(fp: &Fingerprint) -> Self {
match fp {
Fingerprint::V4(fp) =>
KeyID::from_bytes(&fp[fp.len() - 8..]),
Fingerprint::V5(fp) =>
KeyID::Invalid(fp.iter().cloned().collect()),
Fingerprint::Invalid(fp) => {
KeyID::Invalid(fp.clone())
}
}
}
}
impl From<Fingerprint> for KeyID {
fn from(fp: Fingerprint) -> Self {
match fp {
Fingerprint::V4(fp) =>
KeyID::from_bytes(&fp[fp.len() - 8..]),
Fingerprint::V5(fp) =>
KeyID::Invalid(fp.into()),
Fingerprint::Invalid(fp) => {
KeyID::Invalid(fp)
}
}
}
}
impl KeyID {
/// Converts a `u64` to a `KeyID`.
///
/// # Examples
///
/// ```rust
/// # extern crate sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let keyid = KeyID::new(0x0123456789ABCDEF);
/// ```
pub fn new(data: u64) -> KeyID {
let bytes = data.to_be_bytes();
Self::from_bytes(&bytes[..])
}
/// Converts the `KeyID` to a `u64` if possible.
///
/// # Examples
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # extern crate sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let keyid = KeyID::new(0x0123456789ABCDEF);
///
/// assert_eq!(keyid.as_u64()?, 0x0123456789ABCDEF);
/// # Ok(()) }
/// ```
pub fn as_u64(&self) -> Result<u64> {
match &self {
KeyID::V4(ref b) =>
Ok(u64::from_be_bytes(*b)),
KeyID::Invalid(_) =>
Err(Error::InvalidArgument("Invalid KeyID".into()).into()),
}
}
/// Creates a `KeyID` from a big endian byte slice.
///
/// # Examples
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # extern crate sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let keyid: KeyID = "0123 4567 89AB CDEF".parse()?;
///
/// let bytes = [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF];
/// assert_eq!(KeyID::from_bytes(&bytes), keyid);
/// # Ok(()) }
/// ```
pub fn from_bytes(raw: &[u8]) -> KeyID {
if raw.len() == 8 {
let mut keyid : [u8; 8] = Default::default();
keyid.copy_from_slice(raw);
KeyID::V4(keyid)
} else {
KeyID::Invalid(raw.to_vec().into_boxed_slice())
}
}
/// Returns a reference to the raw `KeyID` as a byte slice in big
/// endian representation.
///
/// # Examples
///
/// ```rust
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// # fn main() -> sequoia_openpgp::Result<()> {
/// let keyid: KeyID = "0123 4567 89AB CDEF".parse()?;
///
/// assert_eq!(keyid.as_bytes(), [0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF]);
/// # Ok(()) }
/// ```
pub fn as_bytes(&self) -> &[u8] {
match self {
KeyID::V4(ref id) => id,
KeyID::Invalid(ref id) => id,
}
}
/// Creates a wildcard `KeyID`.
///
/// Refer to [Section 5.1 of RFC 4880] for details.
///
/// [Section 5.1 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-5.1
///
/// # Examples
///
/// ```rust
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// assert_eq!(KeyID::wildcard(), KeyID::new(0x0000000000000000));
/// ```
pub fn wildcard() -> Self {
Self::from_bytes(&[0u8; 8][..])
}
/// Returns `true` if this is the wildcard `KeyID`.
///
/// Refer to [Section 5.1 of RFC 4880] for details.
///
/// [Section 5.1 of RFC 4880]: https://tools.ietf.org/html/rfc4880#section-5.1
///
/// # Examples
///
/// ```rust
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// assert!(KeyID::new(0x0000000000000000).is_wildcard());
/// ```
pub fn is_wildcard(&self) -> bool {
self.as_bytes().iter().all(|b| *b == 0)
}
/// Converts this `KeyID` to its canonical hexadecimal
/// representation.
///
/// This representation is always uppercase and without spaces and
/// is suitable for stable key identifiers.
///
/// The output of this function is exactly the same as formatting
/// this object with the `:X` format specifier.
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let keyid: KeyID = "fb3751f1587daef1".parse()?;
///
/// assert_eq!("FB3751F1587DAEF1", keyid.to_hex());
/// assert_eq!(format!("{:X}", keyid), keyid.to_hex());
/// # Ok(()) }
/// ```
pub fn to_hex(&self) -> String {
use std::fmt::Write;
let raw_len = self.as_bytes().len();
let mut output = String::with_capacity(
// Each byte results in two hex characters.
raw_len * 2);
// We write to String that never fails but the Write API
// returns Results.
write!(output, "{:X}", self).unwrap();
output
}
/// Converts this `KeyID` to its hexadecimal representation with
/// spaces.
///
/// This representation is always uppercase and with spaces
/// grouping the hexadecimal digits into groups of four. It is
/// suitable for manual comparison of Key IDs.
///
/// Note: The spaces will hinder other kind of use cases. For
/// example, it is harder to select the whole Key ID for copying,
/// and it has to be quoted when used as a command line argument.
/// Only use this form for displaying a Key ID with the intent of
/// manual comparisons.
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # use sequoia_openpgp as openpgp;
/// let keyid: openpgp::KeyID = "fb3751f1587daef1".parse()?;
///
/// assert_eq!("FB37 51F1 587D AEF1", keyid.to_spaced_hex());
/// # Ok(()) }
/// ```
pub fn to_spaced_hex(&self) -> String {
use std::fmt::Write;
let raw_len = self.as_bytes().len();
let mut output = String::with_capacity(
// Each byte results in two hex characters.
raw_len * 2
+
// Every 2 bytes of output, we insert a space.
raw_len / 2);
// We write to String that never fails but the Write API
// returns Results.
write!(output, "{:#X}", self).unwrap();
output
}
/// Parses the hexadecimal representation of an OpenPGP `KeyID`.
///
/// This function is the reverse of `to_hex`. It also accepts
/// other variants of the `keyID` notation including lower-case
/// letters, spaces and optional leading `0x`.
///
/// ```rust
/// # fn main() -> sequoia_openpgp::Result<()> {
/// # use sequoia_openpgp as openpgp;
/// use openpgp::KeyID;
///
/// let keyid = KeyID::from_hex("0xfb3751f1587daef1")?;
///
/// assert_eq!("FB3751F1587DAEF1", keyid.to_hex());
/// # Ok(()) }
/// ```
pub fn from_hex(s: &str) -> std::result::Result<Self, anyhow::Error> {
std::str::FromStr::from_str(s)
}
/// Common code for the above functions.
fn write_to_fmt(&self, f: &mut fmt::Formatter, upper_case: bool) -> fmt::Result {
use std::fmt::Write;
let a_letter = if upper_case { b'A' } else { b'a' };
let pretty = f.alternate();
let raw = match self {
KeyID::V4(ref fp) => &fp[..],
KeyID::Invalid(ref fp) => &fp[..],
};
// We currently only handle V4 Key IDs, which look like:
//
// AACB 3243 6300 52D9
//
// Since we have no idea how to format an invalid Key ID, just
// format it like a V4 fingerprint and hope for the best.
for (i, b) in raw.iter().enumerate() {
if pretty && i > 0 && i % 2 == 0 {
f.write_char(' ')?;
}
let top = b >> 4;
let bottom = b & 0xFu8;
if top < 10u8 {
f.write_char((b'0' + top) as char)?;
} else {
f.write_char((a_letter + (top - 10u8)) as char)?;
}
if bottom < 10u8 {
f.write_char((b'0' + bottom) as char)?;
} else {
f.write_char((a_letter + (bottom - 10u8)) as char)?;
}
}
Ok(())
}
}
#[cfg(test)]
impl Arbitrary for KeyID {
fn arbitrary(g: &mut Gen) -> Self {
KeyID::new(u64::arbitrary(g))
}
}
#[cfg(test)]
mod test {
use super::*;
quickcheck! {
fn u64_roundtrip(id: u64) -> bool {
KeyID::new(id).as_u64().unwrap() == id
}
}
#[test]
fn from_hex() {
"FB3751F1587DAEF1".parse::<KeyID>().unwrap();
"39D100AB67D5BD8C04010205FB3751F1587DAEF1".parse::<KeyID>()
.unwrap();
"0xFB3751F1587DAEF1".parse::<KeyID>().unwrap();
"0x39D100AB67D5BD8C04010205FB3751F1587DAEF1".parse::<KeyID>()
.unwrap();
"FB37 51F1 587D AEF1".parse::<KeyID>().unwrap();
"39D1 00AB 67D5 BD8C 0401 0205 FB37 51F1 587D AEF1".parse::<KeyID>()
.unwrap();
"GB3751F1587DAEF1".parse::<KeyID>().unwrap_err();
"EFB3751F1587DAEF1".parse::<KeyID>().unwrap_err();
"%FB3751F1587DAEF1".parse::<KeyID>().unwrap_err();
assert_match!(KeyID::Invalid(_) = "587DAEF1".parse().unwrap());
assert_match!(KeyID::Invalid(_) = "0x587DAEF1".parse().unwrap());
}
#[test]
fn hex_formatting() {
let keyid = "FB3751F1587DAEF1".parse::<KeyID>().unwrap();
assert_eq!(format!("{:X}", keyid), "FB3751F1587DAEF1");
assert_eq!(format!("{:x}", keyid), "fb3751f1587daef1");
}
}