|
| 1 | +use std::str::FromStr; |
| 2 | + |
| 3 | +use uuid::Uuid; |
| 4 | + |
| 5 | +/// An enum carrying an identifier for a binary. This is stores the same information |
| 6 | +/// as a [`debugid::CodeId`], but without projecting it down to a string. |
| 7 | +/// |
| 8 | +/// All types need to be treated rather differently, see their respective documentation. |
| 9 | +#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| 10 | +pub enum CodeId { |
| 11 | + /// The code ID for a Windows PE file. When combined with the binary name, |
| 12 | + /// the code ID lets you obtain binaries from symbol servers. It is not useful |
| 13 | + /// on its own, it has to be paired with the binary name. |
| 14 | + /// |
| 15 | + /// On Windows, a binary's code ID is distinct from its debug ID (= pdb GUID + age). |
| 16 | + /// If you have a binary file, you can get both the code ID and the debug ID |
| 17 | + /// from it. If you only have a PDB file, you usually *cannot* get the code ID of |
| 18 | + /// the corresponding binary from it. |
| 19 | + PeCodeId(PeCodeId), |
| 20 | + |
| 21 | + /// The code ID for a macOS / iOS binary (mach-O). This is just the mach-O UUID. |
| 22 | + /// The mach-O UUID is shared between both the binary file and the debug file (dSYM), |
| 23 | + /// and it can be used on its own to find dSYMs using Spotlight. |
| 24 | + /// |
| 25 | + /// The debug ID and the code ID contain the same information; the debug ID |
| 26 | + /// is literally just the UUID plus a zero at the end. |
| 27 | + MachoUuid(Uuid), |
| 28 | + |
| 29 | + /// The code ID for a Linux ELF file. This is the "ELF build ID" (also called "GNU build ID"). |
| 30 | + /// The build ID is usually 20 bytes, commonly written out as 40 hex chars. |
| 31 | + /// |
| 32 | + /// It can be used to find debug files on the local file system or to download |
| 33 | + /// binaries or debug files from a `debuginfod` symbol server. it does not have to be |
| 34 | + /// paired with the binary name. |
| 35 | + /// |
| 36 | + /// An ELF binary's code ID is more useful than its debug ID: The debug ID is truncated |
| 37 | + /// to 16 bytes (32 hex characters), whereas the code ID is the full ELF build ID. |
| 38 | + ElfBuildId(ElfBuildId), |
| 39 | +} |
| 40 | + |
| 41 | +impl FromStr for CodeId { |
| 42 | + type Err = (); |
| 43 | + |
| 44 | + fn from_str(s: &str) -> Result<Self, Self::Err> { |
| 45 | + if s.len() <= 17 { |
| 46 | + // 8 bytes timestamp + 1 to 8 bytes of image size |
| 47 | + Ok(CodeId::PeCodeId(PeCodeId::from_str(s)?)) |
| 48 | + } else if s.len() == 32 && is_uppercase_hex(s) { |
| 49 | + // mach-O UUID |
| 50 | + Ok(CodeId::MachoUuid(Uuid::from_str(s).map_err(|_| ())?)) |
| 51 | + } else { |
| 52 | + // ELF build ID. These are usually 40 hex characters (= 20 bytes). |
| 53 | + Ok(CodeId::ElfBuildId(ElfBuildId::from_str(s)?)) |
| 54 | + } |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +fn is_uppercase_hex(s: &str) -> bool { |
| 59 | + s.chars() |
| 60 | + .all(|c| c.is_ascii_hexdigit() && (c.is_ascii_digit() || c.is_ascii_uppercase())) |
| 61 | +} |
| 62 | + |
| 63 | +impl std::fmt::Display for CodeId { |
| 64 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 65 | + match self { |
| 66 | + CodeId::PeCodeId(pe) => std::fmt::Display::fmt(pe, f), |
| 67 | + CodeId::MachoUuid(uuid) => f.write_fmt(format_args!("{:X}", uuid.simple())), |
| 68 | + CodeId::ElfBuildId(elf) => std::fmt::Display::fmt(elf, f), |
| 69 | + } |
| 70 | + } |
| 71 | +} |
| 72 | + |
| 73 | +/// The code ID for a Windows PE file. |
| 74 | +/// |
| 75 | +/// When combined with the binary name, the `PeCodeId` lets you obtain binaries from |
| 76 | +/// symbol servers. It is not useful on its own, it has to be paired with the binary name. |
| 77 | +/// |
| 78 | +/// A Windows binary's `PeCodeId` is distinct from its debug ID (= pdb GUID + age). |
| 79 | +/// If you have a binary file, you can get both the `PeCodeId` and the debug ID |
| 80 | +/// from it. If you only have a PDB file, you usually *cannot* get the `PeCodeId` of |
| 81 | +/// the corresponding binary from it. |
| 82 | +#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| 83 | +pub struct PeCodeId { |
| 84 | + pub timestamp: u32, |
| 85 | + pub image_size: u32, |
| 86 | +} |
| 87 | + |
| 88 | +impl FromStr for PeCodeId { |
| 89 | + type Err = (); |
| 90 | + |
| 91 | + fn from_str(s: &str) -> Result<Self, Self::Err> { |
| 92 | + if s.len() < 9 || s.len() > 16 { |
| 93 | + return Err(()); |
| 94 | + } |
| 95 | + let timestamp = u32::from_str_radix(&s[..8], 16).map_err(|_| ())?; |
| 96 | + let image_size = u32::from_str_radix(&s[8..], 16).map_err(|_| ())?; |
| 97 | + Ok(Self { |
| 98 | + timestamp, |
| 99 | + image_size, |
| 100 | + }) |
| 101 | + } |
| 102 | +} |
| 103 | + |
| 104 | +impl std::fmt::Display for PeCodeId { |
| 105 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 106 | + f.write_fmt(format_args!("{:08X}{:x}", self.timestamp, self.image_size)) |
| 107 | + } |
| 108 | +} |
| 109 | + |
| 110 | +/// The build ID for an ELF file (also called "GNU build ID"). |
| 111 | +/// |
| 112 | +/// The build ID can be used to find debug files on the local file system or to download |
| 113 | +/// binaries or debug files from a `debuginfod` symbol server. it does not have to be |
| 114 | +/// paired with the binary name. |
| 115 | +#[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)] |
| 116 | +pub struct ElfBuildId(pub Vec<u8>); |
| 117 | + |
| 118 | +impl ElfBuildId { |
| 119 | + /// Create a new `ElfBuildId` from a slice of bytes (commonly a sha1 hash |
| 120 | + /// generated by the linker, i.e. 20 bytes). |
| 121 | + pub fn from_bytes(bytes: &[u8]) -> Self { |
| 122 | + Self(bytes.to_owned()) |
| 123 | + } |
| 124 | +} |
| 125 | + |
| 126 | +impl FromStr for ElfBuildId { |
| 127 | + type Err = (); |
| 128 | + |
| 129 | + fn from_str(s: &str) -> Result<Self, Self::Err> { |
| 130 | + let byte_count = s.len() / 2; |
| 131 | + let mut bytes = Vec::with_capacity(byte_count); |
| 132 | + for i in 0..byte_count { |
| 133 | + let hex_byte = &s[i * 2..i * 2 + 2]; |
| 134 | + let b = u8::from_str_radix(hex_byte, 16).map_err(|_| ())?; |
| 135 | + bytes.push(b); |
| 136 | + } |
| 137 | + Ok(Self(bytes)) |
| 138 | + } |
| 139 | +} |
| 140 | + |
| 141 | +impl std::fmt::Display for ElfBuildId { |
| 142 | + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { |
| 143 | + for byte in &self.0 { |
| 144 | + f.write_fmt(format_args!("{byte:02x}"))?; |
| 145 | + } |
| 146 | + Ok(()) |
| 147 | + } |
| 148 | +} |
0 commit comments