Enum apple_codesign::SignatureReader
source · pub enum SignatureReader {
Dmg(PathBuf, Box<DmgReader>),
MachO(PathBuf, Vec<u8>),
Bundle(Box<DirectoryBundle>),
FlatPackage(PathBuf),
}
Expand description
Entity for reading Apple code signature data.
Variants§
Dmg(PathBuf, Box<DmgReader>)
MachO(PathBuf, Vec<u8>)
Bundle(Box<DirectoryBundle>)
FlatPackage(PathBuf)
Implementations§
source§impl SignatureReader
impl SignatureReader
sourcepub fn from_path(path: impl AsRef<Path>) -> Result<Self, AppleCodesignError>
pub fn from_path(path: impl AsRef<Path>) -> Result<Self, AppleCodesignError>
Construct a signature reader from a path.
Examples found in repository?
src/cli.rs (line 1032)
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
fn command_diff_signatures(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path0 = args
.get_one::<String>("path0")
.ok_or(AppleCodesignError::CliBadArgument)?;
let path1 = args
.get_one::<String>("path1")
.ok_or(AppleCodesignError::CliBadArgument)?;
let reader = SignatureReader::from_path(path0)?;
let a_entities = reader.entities()?;
let reader = SignatureReader::from_path(path1)?;
let b_entities = reader.entities()?;
let a = serde_yaml::to_string(&a_entities)?;
let b = serde_yaml::to_string(&b_entities)?;
let Changeset { diffs, .. } = Changeset::new(&a, &b, "\n");
for item in diffs {
match item {
Difference::Same(ref x) => {
for line in x.lines() {
println!(" {line}");
}
}
Difference::Add(ref x) => {
for line in x.lines() {
println!("+{line}");
}
}
Difference::Rem(ref x) => {
for line in x.lines() {
println!("-{line}");
}
}
}
}
Ok(())
}
const ENCODE_APP_STORE_CONNECT_API_KEY_ABOUT: &str = "\
Encode an App Store Connect API Key to JSON.
App Store Connect API Keys
(https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api)
are defined by 3 components:
* The Issuer ID (likely a UUID)
* A Key ID (an alphanumeric value like `DEADBEEF42`)
* A PEM encoded ECDSA private key (typically a file beginning with
`-----BEGIN PRIVATE KEY-----`).
This command is used to encode all API Key components into a single JSON
object so you only have to refer to a single entity when performing
operations (like notarization) using these API Keys.
The API Key components are specified as positional arguments.
By default, the JSON encoded unified representation is printed to stdout.
You can write to a file instead by passing `--output-path <path>`.
# Security Considerations
The App Store Connect API Key contains a private key and its value should be
treated as sensitive: if an unwanted party obtains your private key, they
effectively have access to your App Store Connect account.
When this command writes JSON files, an attempt is made to limit access
to the file. However, file access restrictions may not be as secure as you
want. Security conscious individuals should audit the permissions of the
file and adjust accordingly.
";
fn command_encode_app_store_connect_api_key(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let issuer_id = args
.get_one::<String>("issuer_id")
.expect("arg should have been required");
let key_id = args
.get_one::<String>("key_id")
.expect("arg should have been required");
let private_key_path = args
.get_one::<PathBuf>("private_key_path")
.expect("arg should have been required");
let unified = UnifiedApiKey::from_ecdsa_pem_path(issuer_id, key_id, private_key_path)?;
if let Some(output_path) = args.get_one::<PathBuf>("output_path") {
eprintln!("writing unified key JSON to {}", output_path.display());
unified.write_json_file(output_path)?;
eprintln!(
"consider auditing the file's access permissions to ensure its content remains secure"
);
} else {
println!("{}", unified.to_json_string()?);
}
Ok(())
}
fn print_signed_data(
prefix: &str,
signed_data: &SignedData,
external_content: Option<Vec<u8>>,
) -> Result<(), AppleCodesignError> {
println!(
"{}signed content (embedded): {:?}",
prefix,
signed_data.signed_content().map(hex::encode)
);
println!(
"{}signed content (external): {:?}... ({} bytes)",
prefix,
external_content.as_ref().map(|x| hex::encode(&x[0..40])),
external_content.as_ref().map(|x| x.len()).unwrap_or(0),
);
let content = if let Some(v) = signed_data.signed_content() {
Some(v)
} else {
external_content.as_ref().map(|v| v.as_ref())
};
if let Some(content) = content {
println!(
"{}signed content SHA-1: {}",
prefix,
hex::encode(DigestType::Sha1.digest_data(content)?)
);
println!(
"{}signed content SHA-256: {}",
prefix,
hex::encode(DigestType::Sha256.digest_data(content)?)
);
println!(
"{}signed content SHA-384: {}",
prefix,
hex::encode(DigestType::Sha384.digest_data(content)?)
);
println!(
"{}signed content SHA-512: {}",
prefix,
hex::encode(DigestType::Sha512.digest_data(content)?)
);
}
println!(
"{}certificate count: {}",
prefix,
signed_data.certificates().count()
);
for (i, cert) in signed_data.certificates().enumerate() {
println!(
"{}certificate #{}: subject CN={}; self signed={}",
prefix,
i,
cert.subject_common_name()
.unwrap_or_else(|| "<unknown>".to_string()),
cert.subject_is_issuer()
);
}
println!("{}signer count: {}", prefix, signed_data.signers().count());
for (i, signer) in signed_data.signers().enumerate() {
println!(
"{}signer #{}: digest algorithm: {:?}",
prefix,
i,
signer.digest_algorithm()
);
println!(
"{}signer #{}: signature algorithm: {:?}",
prefix,
i,
signer.signature_algorithm()
);
if let Some(sa) = signer.signed_attributes() {
println!(
"{}signer #{}: content type: {}",
prefix,
i,
sa.content_type()
);
println!(
"{}signer #{}: message digest: {}",
prefix,
i,
hex::encode(sa.message_digest())
);
println!(
"{}signer #{}: signing time: {:?}",
prefix,
i,
sa.signing_time()
);
}
let digested_data = signer.signed_content_with_signed_data(signed_data);
println!(
"{}signer #{}: signature content SHA-1: {}",
prefix,
i,
hex::encode(DigestType::Sha1.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-256: {}",
prefix,
i,
hex::encode(DigestType::Sha256.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-384: {}",
prefix,
i,
hex::encode(DigestType::Sha384.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-512: {}",
prefix,
i,
hex::encode(DigestType::Sha512.digest_data(&digested_data)?)
);
if signed_data.signed_content().is_some() {
println!(
"{}signer #{}: digest valid: {}",
prefix,
i,
signer
.verify_message_digest_with_signed_data(signed_data)
.is_ok()
);
}
println!(
"{}signer #{}: signature valid: {}",
prefix,
i,
signer
.verify_signature_with_signed_data(signed_data)
.is_ok()
);
println!(
"{}signer #{}: time-stamp token present: {}",
prefix,
i,
signer.time_stamp_token_signed_data()?.is_some()
);
if let Some(tsp_signed_data) = signer.time_stamp_token_signed_data()? {
let prefix = format!("{prefix}signer #{i}: time-stamp token: ");
print_signed_data(&prefix, &tsp_signed_data, None)?;
}
}
Ok(())
}
fn command_extract(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("path")
.ok_or(AppleCodesignError::CliBadArgument)?;
let format = args
.get_one::<String>("data")
.ok_or(AppleCodesignError::CliBadArgument)?;
let index = args.get_one::<String>("universal_index").unwrap();
let index = usize::from_str(index).map_err(|_| AppleCodesignError::CliBadArgument)?;
let data = std::fs::read(path)?;
let mach = MachFile::parse(&data)?;
let macho = mach.nth_macho(index)?;
match format.as_str() {
"blobs" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
for blob in embedded.blobs {
let parsed = blob.into_parsed_blob()?;
println!("{parsed:#?}");
}
}
"cms-info" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
let signed_data = SignedData::parse_ber(cms)?;
let cd_data = if let Ok(Some(blob)) = embedded.code_directory() {
Some(blob.to_blob_bytes()?)
} else {
None
};
print_signed_data("", &signed_data, cd_data)?;
} else {
eprintln!("no CMS data");
}
}
"cms-pem" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
print!(
"{}",
pem::encode(&pem::Pem {
tag: "PKCS7".to_string(),
contents: cms.to_vec(),
})
);
} else {
eprintln!("no CMS data");
}
}
"cms-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
std::io::stdout().write_all(cms)?;
} else {
eprintln!("no CMS data");
}
}
"cms" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(signed_data) = embedded.signed_data()? {
println!("{signed_data:#?}");
} else {
eprintln!("no CMS data");
}
}
"code-directory-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(blob) = embedded.find_slot(CodeSigningSlot::CodeDirectory) {
std::io::stdout().write_all(blob.data)?;
} else {
eprintln!("no code directory");
}
}
"code-directory-serialized-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Ok(Some(cd)) = embedded.code_directory() {
std::io::stdout().write_all(&cd.to_blob_bytes()?)?;
} else {
eprintln!("no code directory");
}
}
"code-directory-serialized" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Ok(Some(cd)) = embedded.code_directory() {
let serialized = cd.to_blob_bytes()?;
println!("{:#?}", CodeDirectoryBlob::from_blob_bytes(&serialized)?);
}
}
"code-directory" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cd) = embedded.code_directory()? {
println!("{cd:#?}");
} else {
eprintln!("no code directory");
}
}
"linkedit-info" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
println!("__LINKEDIT segment index: {}", sig.linkedit_segment_index);
println!(
"__LINKEDIT segment start offset: {}",
sig.linkedit_segment_start_offset
);
println!(
"__LINKEDIT segment end offset: {}",
sig.linkedit_segment_end_offset
);
println!(
"__LINKEDIT segment size: {}",
sig.linkedit_segment_data.len()
);
println!(
"__LINKEDIT signature global start offset: {}",
sig.linkedit_signature_start_offset
);
println!(
"__LINKEDIT signature global end offset: {}",
sig.linkedit_signature_end_offset
);
println!(
"__LINKEDIT signature local segment start offset: {}",
sig.signature_start_offset
);
println!(
"__LINKEDIT signature local segment end offset: {}",
sig.signature_end_offset
);
println!("__LINKEDIT signature size: {}", sig.signature_data.len());
}
"linkedit-segment-raw" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
std::io::stdout().write_all(sig.linkedit_segment_data)?;
}
"macho-load-commands" => {
println!("load command count: {}", macho.macho.load_commands.len());
for command in &macho.macho.load_commands {
println!(
"{}; offsets=0x{:x}-0x{:x} ({}-{}); size={}",
goblin::mach::load_command::cmd_to_str(command.command.cmd()),
command.offset,
command.offset + command.command.cmdsize(),
command.offset,
command.offset + command.command.cmdsize(),
command.command.cmdsize(),
);
}
}
"macho-segments" => {
println!("segments count: {}", macho.macho.segments.len());
for (segment_index, segment) in macho.macho.segments.iter().enumerate() {
let sections = segment.sections()?;
println!(
"segment #{}; {}; offsets=0x{:x}-0x{:x}; vm/file size {}/{}; section count {}",
segment_index,
segment.name()?,
segment.fileoff,
segment.fileoff as usize + segment.data.len(),
segment.vmsize,
segment.filesize,
sections.len()
);
for (section_index, (section, _)) in sections.into_iter().enumerate() {
println!(
"segment #{}; section #{}: {}; segment offsets=0x{:x}-0x{:x} size {}",
segment_index,
section_index,
section.name()?,
section.offset,
section.offset as u64 + section.size,
section.size
);
}
}
}
"macho-target" => {
if let Some(target) = macho.find_targeting()? {
println!("Platform: {}", target.platform);
println!("Minimum OS: {}", target.minimum_os_version);
println!("SDK: {}", target.sdk_version);
} else {
println!("Unable to resolve Mach-O targeting from load commands");
}
}
"requirements-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(blob) = embedded.find_slot(CodeSigningSlot::RequirementSet) {
std::io::stdout().write_all(blob.data)?;
} else {
eprintln!("no requirements");
}
}
"requirements-rust" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
for (typ, req) in &reqs.requirements {
for expr in req.parse_expressions()?.iter() {
println!("{typ} => {expr:#?}");
}
}
} else {
eprintln!("no requirements");
}
}
"requirements-serialized-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
std::io::stdout().write_all(&reqs.to_blob_bytes()?)?;
} else {
eprintln!("no requirements");
}
}
"requirements-serialized" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
let serialized = reqs.to_blob_bytes()?;
println!("{:#?}", RequirementSetBlob::from_blob_bytes(&serialized)?);
} else {
eprintln!("no requirements");
}
}
"requirements" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
for (typ, req) in &reqs.requirements {
for expr in req.parse_expressions()?.iter() {
println!("{typ} => {expr}");
}
}
} else {
eprintln!("no requirements");
}
}
"signature-raw" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
std::io::stdout().write_all(sig.signature_data)?;
}
"superblob" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
println!("file start offset: {}", sig.linkedit_signature_start_offset);
println!("file end offset: {}", sig.linkedit_signature_end_offset);
println!("__LINKEDIT start offset: {}", sig.signature_start_offset);
println!("__LINKEDIT end offset: {}", sig.signature_end_offset);
println!("length: {}", embedded.length);
println!("blob count: {}", embedded.count);
println!("blobs:");
for blob in embedded.blobs {
println!("- index: {}", blob.index);
println!(
" offsets: 0x{:x}-0x{:x} ({}-{})",
blob.offset,
blob.offset + blob.length - 1,
blob.offset,
blob.offset + blob.length - 1
);
println!(" length: {}", blob.length);
println!(" slot: {:?}", blob.slot);
println!(" magic: {:?} (0x{:x})", blob.magic, u32::from(blob.magic));
println!(
" sha1: {}",
hex::encode(blob.digest_with(DigestType::Sha1)?)
);
println!(
" sha256: {}",
hex::encode(blob.digest_with(DigestType::Sha256)?)
);
println!(
" sha256-truncated: {}",
hex::encode(blob.digest_with(DigestType::Sha256Truncated)?)
);
println!(
" sha384: {}",
hex::encode(blob.digest_with(DigestType::Sha384)?),
);
println!(
" sha512: {}",
hex::encode(blob.digest_with(DigestType::Sha512)?),
);
println!(
" sha1-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha1)?)
);
println!(
" sha256-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha256)?)
);
println!(
" sha256-truncated-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha256Truncated)?)
);
println!(
" sha384-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha384)?)
);
println!(
" sha512-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha512)?)
);
}
}
_ => panic!("unhandled format: {format}"),
}
Ok(())
}
fn command_generate_certificate_signing_request(
args: &ArgMatches,
) -> Result<(), AppleCodesignError> {
let csr_pem_path = args.get_one::<String>("csr_pem_path").map(PathBuf::from);
let (private_keys, _) = collect_certificates_from_args(args, true)?;
let private_key = if private_keys.is_empty() {
error!("no private keys found; a private key is required to sign a certificate signing request");
return Err(AppleCodesignError::CliBadArgument);
} else if private_keys.len() > 1 {
error!(
"at most 1 private key can be present (found {}); aborting",
private_keys.len()
);
return Err(AppleCodesignError::CliBadArgument);
} else {
private_keys.into_iter().next().expect("checked size above")
};
let key_algorithm = private_key.key_algorithm().ok_or_else(|| {
error!("unable to determine key algorithm of private key (please report this issue)");
AppleCodesignError::CliBadArgument
})?;
let mut builder = X509CertificateBuilder::new(key_algorithm);
builder
.subject()
.append_common_name_utf8_string("Apple Code Signing CSR")
.map_err(|e| AppleCodesignError::CertificateBuildError(format!("{e:?}")))?;
warn!("generating CSR; you may be prompted to enter credentials to unlock the signing key");
let pem = builder
.create_certificate_signing_request(private_key.as_key_info_signer())?
.encode_pem()?;
if let Some(dest_path) = csr_pem_path {
if let Some(parent) = dest_path.parent() {
std::fs::create_dir_all(parent)?;
}
warn!("writing PEM encoded CSR to {}", dest_path.display());
std::fs::write(&dest_path, pem.as_bytes())?;
}
print!("{pem}");
Ok(())
}
fn command_generate_self_signed_certificate(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let algorithm = match args
.get_one::<String>("algorithm")
.ok_or(AppleCodesignError::CliBadArgument)?
.as_str()
{
"ecdsa" => KeyAlgorithm::Ecdsa(EcdsaCurve::Secp256r1),
"ed25519" => KeyAlgorithm::Ed25519,
value => panic!(
"algorithm values should have been validated by arg parser: {value}"
),
};
let profile = args
.get_one::<String>("profile")
.ok_or(AppleCodesignError::CliBadArgument)?;
let profile = CertificateProfile::from_str(profile)?;
let team_id = args
.get_one::<String>("team_id")
.ok_or(AppleCodesignError::CliBadArgument)?;
let person_name = args
.get_one::<String>("person_name")
.ok_or(AppleCodesignError::CliBadArgument)?;
let country_name = args
.get_one::<String>("country_name")
.ok_or(AppleCodesignError::CliBadArgument)?;
let validity_days = args.get_one::<String>("validity_days").unwrap();
let validity_days =
i64::from_str(validity_days).map_err(|_| AppleCodesignError::CliBadArgument)?;
let pem_filename = args.get_one::<String>("pem_filename");
let validity_duration = chrono::Duration::days(validity_days);
let (cert, _, raw) = create_self_signed_code_signing_certificate(
algorithm,
profile,
team_id,
person_name,
country_name,
validity_duration,
)?;
let cert_pem = cert.encode_pem();
let key_pem = pem::encode(&pem::Pem {
tag: "PRIVATE KEY".to_string(),
contents: raw.as_ref().to_vec(),
});
let mut wrote_file = false;
if let Some(pem_filename) = pem_filename {
let cert_path = PathBuf::from(format!("{pem_filename}.crt"));
let key_path = PathBuf::from(format!("{pem_filename}.key"));
if let Some(parent) = cert_path.parent() {
std::fs::create_dir_all(parent)?;
}
println!("writing public certificate to {}", cert_path.display());
std::fs::write(&cert_path, cert_pem.as_bytes())?;
println!("writing private signing key to {}", key_path.display());
std::fs::write(&key_path, key_pem.as_bytes())?;
wrote_file = true;
}
if !wrote_file {
print!("{cert_pem}");
print!("{key_pem}");
}
Ok(())
}
#[cfg(target_os = "macos")]
fn command_keychain_export_certificate_chain(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let user_id = args.get_one::<String>("user_id").unwrap();
let domain = args
.get_one::<String>("domain")
.expect("clap should have added default value");
let domain = KeychainDomain::try_from(domain.as_str())
.expect("clap should have validated domain values");
let password = if let Some(path) = args.get_one::<String>("password_file") {
let data = std::fs::read_to_string(path)?;
Some(
data.lines()
.next()
.expect("should get a single line")
.to_string(),
)
} else if let Some(password) = args.get_one::<String>("password") {
Some(password.to_string())
} else {
None
};
let certs = macos_keychain_find_certificate_chain(domain, password.as_deref(), user_id)?;
for (i, cert) in certs.iter().enumerate() {
if args.get_flag("no_print_self") && i == 0 {
continue;
}
print!("{}", cert.encode_pem());
}
Ok(())
}
#[cfg(not(target_os = "macos"))]
fn command_keychain_export_certificate_chain(_args: &ArgMatches) -> Result<(), AppleCodesignError> {
Err(AppleCodesignError::CliGeneralError(
"macOS Keychain export only supported on macOS".to_string(),
))
}
#[cfg(target_os = "macos")]
fn command_keychain_print_certificates(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let domain = args
.get_one::<String>("domain")
.expect("clap should have added default value");
let domain = KeychainDomain::try_from(domain.as_str())
.expect("clap should have validated domain values");
let certs = keychain_find_code_signing_certificates(domain, None)?;
for (i, cert) in certs.into_iter().enumerate() {
println!("# Certificate {}", i);
println!();
print_certificate_info(&cert)?;
println!();
}
Ok(())
}
#[cfg(not(target_os = "macos"))]
fn command_keychain_print_certificates(_args: &ArgMatches) -> Result<(), AppleCodesignError> {
Err(AppleCodesignError::CliGeneralError(
"macOS Keychain integration supported on macOS".to_string(),
))
}
const NOTARIZE_ABOUT: &str = "\
Submit a notarization request to Apple.
This command is used to submit an asset to Apple for notarization. Given
a path to an asset with a code signature, this command will connect to Apple's
Notary API and upload the asset. It will then optionally wait on the submission
to finish processing (which typically takes a few dozen seconds). If the
asset validates Apple's requirements, Apple will issue a *notarization ticket*
as proof that they approved of it. This ticket is then added to the asset in a
process called *stapling*, which this command can do automatically if the
`--staple` argument is passed.
# App Store Connect API Key
In order to communicate with Apple's servers, you need an App Store Connect
API Key. This requires an Apple Developer account. You can generate an
API Key at https://appstoreconnect.apple.com/access/api.
The recommended mechanism to define the API Key is via `--api-key-path`,
which takes the path to a file containing JSON produced by the
`encode-app-store-connect-api-key` command. See that command's help for
more details.
If you don't wish to use `--api-key-path`, you can define the key components
via the `--api-issuer` and `--api-key` arguments. You will need a file named
`AuthKey_<ID>.p8` in one of the following locations: `$(pwd)/private_keys/`,
`~/private_keys/`, '~/.private_keys/`, and `~/.appstoreconnect/private_keys/`
(searched in that order). The name of the file is derived from the value of
`--api-key`.
In all cases, App Store Connect API Keys can be managed at
https://appstoreconnect.apple.com/access/api.
# Modes of Operation
By default, the `notarize` command will initiate an upload to Apple and exit
once the upload is complete.
Once an upload is performed, Apple will asynchronously process the uploaded
content. This can take seconds to minutes.
To poll Apple's servers and wait on the server-side processing to finish,
specify `--wait`. This will query the state of the processing every few seconds
until it is finished, the max wait time is reached, or an error occurs.
To automatically staple an asset after server-side processing has finished,
specify `--staple`. This implies `--wait`.
";
/// Obtain a notarization client from arguments.
fn notarizer_from_args(args: &ArgMatches) -> Result<Notarizer, AppleCodesignError> {
let api_key_path = args.get_one::<PathBuf>("api_key_path");
let api_issuer = args.get_one::<String>("api_issuer");
let api_key = args.get_one::<String>("api_key");
if let Some(api_key_path) = api_key_path {
Notarizer::from_api_key(api_key_path)
} else if let (Some(issuer), Some(key)) = (api_issuer, api_key) {
Notarizer::from_api_key_id(issuer, key)
} else {
Err(AppleCodesignError::NotarizeNoAuthCredentials)
}
}
fn notarizer_wait_duration(args: &ArgMatches) -> Result<std::time::Duration, AppleCodesignError> {
let max_wait_seconds = args
.get_one::<String>("max_wait_seconds")
.expect("argument should have default value");
let max_wait_seconds =
u64::from_str(max_wait_seconds).map_err(|_| AppleCodesignError::CliBadArgument)?;
Ok(std::time::Duration::from_secs(max_wait_seconds))
}
fn command_notary_log(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let notarizer = notarizer_from_args(args)?;
let submission_id = args
.get_one::<String>("submission_id")
.expect("submission_id is required");
let log = notarizer.fetch_notarization_log(submission_id)?;
for line in serde_json::to_string_pretty(&log)?.lines() {
println!("{line}");
}
Ok(())
}
fn command_notary_submit(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = PathBuf::from(
args.get_one::<String>("path")
.expect("clap should have validated arguments"),
);
let staple = args.get_flag("staple");
let wait = args.get_flag("wait") || staple;
let wait_limit = if wait {
Some(notarizer_wait_duration(args)?)
} else {
None
};
let notarizer = notarizer_from_args(args)?;
let upload = notarizer.notarize_path(&path, wait_limit)?;
if staple {
match upload {
crate::notarization::NotarizationUpload::UploadId(_) => {
panic!(
"NotarizationUpload::UploadId should not be returned if we waited successfully"
);
}
crate::notarization::NotarizationUpload::NotaryResponse(_) => {
let stapler = crate::stapling::Stapler::new()?;
stapler.staple_path(&path)?;
}
}
}
Ok(())
}
fn command_notary_wait(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let wait_duration = notarizer_wait_duration(args)?;
let notarizer = notarizer_from_args(args)?;
let submission_id = args
.get_one::<String>("submission_id")
.expect("submission_id is required");
notarizer.wait_on_notarization_and_fetch_log(submission_id, wait_duration)?;
Ok(())
}
fn command_parse_code_signing_requirement(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("input_path")
.expect("clap should have validated argument");
let data = std::fs::read(path)?;
let requirements = CodeRequirements::parse_blob(&data)?.0;
for requirement in requirements.iter() {
match args
.get_one::<String>("format")
.expect("clap should have validated argument")
.as_str()
{
"csrl" => {
println!("{requirement}");
}
"expression-tree" => {
println!("{requirement:#?}");
}
format => panic!("unhandled format: {format}"),
}
}
Ok(())
}
fn command_print_signature_info(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("path")
.expect("clap should have validated argument");
let reader = SignatureReader::from_path(path)?;
let entities = reader.entities()?;
serde_yaml::to_writer(std::io::stdout(), &entities)?;
Ok(())
}
sourcepub fn entities(&self) -> Result<Vec<FileEntity>, AppleCodesignError>
pub fn entities(&self) -> Result<Vec<FileEntity>, AppleCodesignError>
Obtain entities that are possibly relevant to code signing.
Examples found in repository?
src/cli.rs (line 1034)
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
fn command_diff_signatures(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path0 = args
.get_one::<String>("path0")
.ok_or(AppleCodesignError::CliBadArgument)?;
let path1 = args
.get_one::<String>("path1")
.ok_or(AppleCodesignError::CliBadArgument)?;
let reader = SignatureReader::from_path(path0)?;
let a_entities = reader.entities()?;
let reader = SignatureReader::from_path(path1)?;
let b_entities = reader.entities()?;
let a = serde_yaml::to_string(&a_entities)?;
let b = serde_yaml::to_string(&b_entities)?;
let Changeset { diffs, .. } = Changeset::new(&a, &b, "\n");
for item in diffs {
match item {
Difference::Same(ref x) => {
for line in x.lines() {
println!(" {line}");
}
}
Difference::Add(ref x) => {
for line in x.lines() {
println!("+{line}");
}
}
Difference::Rem(ref x) => {
for line in x.lines() {
println!("-{line}");
}
}
}
}
Ok(())
}
const ENCODE_APP_STORE_CONNECT_API_KEY_ABOUT: &str = "\
Encode an App Store Connect API Key to JSON.
App Store Connect API Keys
(https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api)
are defined by 3 components:
* The Issuer ID (likely a UUID)
* A Key ID (an alphanumeric value like `DEADBEEF42`)
* A PEM encoded ECDSA private key (typically a file beginning with
`-----BEGIN PRIVATE KEY-----`).
This command is used to encode all API Key components into a single JSON
object so you only have to refer to a single entity when performing
operations (like notarization) using these API Keys.
The API Key components are specified as positional arguments.
By default, the JSON encoded unified representation is printed to stdout.
You can write to a file instead by passing `--output-path <path>`.
# Security Considerations
The App Store Connect API Key contains a private key and its value should be
treated as sensitive: if an unwanted party obtains your private key, they
effectively have access to your App Store Connect account.
When this command writes JSON files, an attempt is made to limit access
to the file. However, file access restrictions may not be as secure as you
want. Security conscious individuals should audit the permissions of the
file and adjust accordingly.
";
fn command_encode_app_store_connect_api_key(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let issuer_id = args
.get_one::<String>("issuer_id")
.expect("arg should have been required");
let key_id = args
.get_one::<String>("key_id")
.expect("arg should have been required");
let private_key_path = args
.get_one::<PathBuf>("private_key_path")
.expect("arg should have been required");
let unified = UnifiedApiKey::from_ecdsa_pem_path(issuer_id, key_id, private_key_path)?;
if let Some(output_path) = args.get_one::<PathBuf>("output_path") {
eprintln!("writing unified key JSON to {}", output_path.display());
unified.write_json_file(output_path)?;
eprintln!(
"consider auditing the file's access permissions to ensure its content remains secure"
);
} else {
println!("{}", unified.to_json_string()?);
}
Ok(())
}
fn print_signed_data(
prefix: &str,
signed_data: &SignedData,
external_content: Option<Vec<u8>>,
) -> Result<(), AppleCodesignError> {
println!(
"{}signed content (embedded): {:?}",
prefix,
signed_data.signed_content().map(hex::encode)
);
println!(
"{}signed content (external): {:?}... ({} bytes)",
prefix,
external_content.as_ref().map(|x| hex::encode(&x[0..40])),
external_content.as_ref().map(|x| x.len()).unwrap_or(0),
);
let content = if let Some(v) = signed_data.signed_content() {
Some(v)
} else {
external_content.as_ref().map(|v| v.as_ref())
};
if let Some(content) = content {
println!(
"{}signed content SHA-1: {}",
prefix,
hex::encode(DigestType::Sha1.digest_data(content)?)
);
println!(
"{}signed content SHA-256: {}",
prefix,
hex::encode(DigestType::Sha256.digest_data(content)?)
);
println!(
"{}signed content SHA-384: {}",
prefix,
hex::encode(DigestType::Sha384.digest_data(content)?)
);
println!(
"{}signed content SHA-512: {}",
prefix,
hex::encode(DigestType::Sha512.digest_data(content)?)
);
}
println!(
"{}certificate count: {}",
prefix,
signed_data.certificates().count()
);
for (i, cert) in signed_data.certificates().enumerate() {
println!(
"{}certificate #{}: subject CN={}; self signed={}",
prefix,
i,
cert.subject_common_name()
.unwrap_or_else(|| "<unknown>".to_string()),
cert.subject_is_issuer()
);
}
println!("{}signer count: {}", prefix, signed_data.signers().count());
for (i, signer) in signed_data.signers().enumerate() {
println!(
"{}signer #{}: digest algorithm: {:?}",
prefix,
i,
signer.digest_algorithm()
);
println!(
"{}signer #{}: signature algorithm: {:?}",
prefix,
i,
signer.signature_algorithm()
);
if let Some(sa) = signer.signed_attributes() {
println!(
"{}signer #{}: content type: {}",
prefix,
i,
sa.content_type()
);
println!(
"{}signer #{}: message digest: {}",
prefix,
i,
hex::encode(sa.message_digest())
);
println!(
"{}signer #{}: signing time: {:?}",
prefix,
i,
sa.signing_time()
);
}
let digested_data = signer.signed_content_with_signed_data(signed_data);
println!(
"{}signer #{}: signature content SHA-1: {}",
prefix,
i,
hex::encode(DigestType::Sha1.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-256: {}",
prefix,
i,
hex::encode(DigestType::Sha256.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-384: {}",
prefix,
i,
hex::encode(DigestType::Sha384.digest_data(&digested_data)?)
);
println!(
"{}signer #{}: signature content SHA-512: {}",
prefix,
i,
hex::encode(DigestType::Sha512.digest_data(&digested_data)?)
);
if signed_data.signed_content().is_some() {
println!(
"{}signer #{}: digest valid: {}",
prefix,
i,
signer
.verify_message_digest_with_signed_data(signed_data)
.is_ok()
);
}
println!(
"{}signer #{}: signature valid: {}",
prefix,
i,
signer
.verify_signature_with_signed_data(signed_data)
.is_ok()
);
println!(
"{}signer #{}: time-stamp token present: {}",
prefix,
i,
signer.time_stamp_token_signed_data()?.is_some()
);
if let Some(tsp_signed_data) = signer.time_stamp_token_signed_data()? {
let prefix = format!("{prefix}signer #{i}: time-stamp token: ");
print_signed_data(&prefix, &tsp_signed_data, None)?;
}
}
Ok(())
}
fn command_extract(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("path")
.ok_or(AppleCodesignError::CliBadArgument)?;
let format = args
.get_one::<String>("data")
.ok_or(AppleCodesignError::CliBadArgument)?;
let index = args.get_one::<String>("universal_index").unwrap();
let index = usize::from_str(index).map_err(|_| AppleCodesignError::CliBadArgument)?;
let data = std::fs::read(path)?;
let mach = MachFile::parse(&data)?;
let macho = mach.nth_macho(index)?;
match format.as_str() {
"blobs" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
for blob in embedded.blobs {
let parsed = blob.into_parsed_blob()?;
println!("{parsed:#?}");
}
}
"cms-info" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
let signed_data = SignedData::parse_ber(cms)?;
let cd_data = if let Ok(Some(blob)) = embedded.code_directory() {
Some(blob.to_blob_bytes()?)
} else {
None
};
print_signed_data("", &signed_data, cd_data)?;
} else {
eprintln!("no CMS data");
}
}
"cms-pem" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
print!(
"{}",
pem::encode(&pem::Pem {
tag: "PKCS7".to_string(),
contents: cms.to_vec(),
})
);
} else {
eprintln!("no CMS data");
}
}
"cms-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cms) = embedded.signature_data()? {
std::io::stdout().write_all(cms)?;
} else {
eprintln!("no CMS data");
}
}
"cms" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(signed_data) = embedded.signed_data()? {
println!("{signed_data:#?}");
} else {
eprintln!("no CMS data");
}
}
"code-directory-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(blob) = embedded.find_slot(CodeSigningSlot::CodeDirectory) {
std::io::stdout().write_all(blob.data)?;
} else {
eprintln!("no code directory");
}
}
"code-directory-serialized-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Ok(Some(cd)) = embedded.code_directory() {
std::io::stdout().write_all(&cd.to_blob_bytes()?)?;
} else {
eprintln!("no code directory");
}
}
"code-directory-serialized" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Ok(Some(cd)) = embedded.code_directory() {
let serialized = cd.to_blob_bytes()?;
println!("{:#?}", CodeDirectoryBlob::from_blob_bytes(&serialized)?);
}
}
"code-directory" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(cd) = embedded.code_directory()? {
println!("{cd:#?}");
} else {
eprintln!("no code directory");
}
}
"linkedit-info" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
println!("__LINKEDIT segment index: {}", sig.linkedit_segment_index);
println!(
"__LINKEDIT segment start offset: {}",
sig.linkedit_segment_start_offset
);
println!(
"__LINKEDIT segment end offset: {}",
sig.linkedit_segment_end_offset
);
println!(
"__LINKEDIT segment size: {}",
sig.linkedit_segment_data.len()
);
println!(
"__LINKEDIT signature global start offset: {}",
sig.linkedit_signature_start_offset
);
println!(
"__LINKEDIT signature global end offset: {}",
sig.linkedit_signature_end_offset
);
println!(
"__LINKEDIT signature local segment start offset: {}",
sig.signature_start_offset
);
println!(
"__LINKEDIT signature local segment end offset: {}",
sig.signature_end_offset
);
println!("__LINKEDIT signature size: {}", sig.signature_data.len());
}
"linkedit-segment-raw" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
std::io::stdout().write_all(sig.linkedit_segment_data)?;
}
"macho-load-commands" => {
println!("load command count: {}", macho.macho.load_commands.len());
for command in &macho.macho.load_commands {
println!(
"{}; offsets=0x{:x}-0x{:x} ({}-{}); size={}",
goblin::mach::load_command::cmd_to_str(command.command.cmd()),
command.offset,
command.offset + command.command.cmdsize(),
command.offset,
command.offset + command.command.cmdsize(),
command.command.cmdsize(),
);
}
}
"macho-segments" => {
println!("segments count: {}", macho.macho.segments.len());
for (segment_index, segment) in macho.macho.segments.iter().enumerate() {
let sections = segment.sections()?;
println!(
"segment #{}; {}; offsets=0x{:x}-0x{:x}; vm/file size {}/{}; section count {}",
segment_index,
segment.name()?,
segment.fileoff,
segment.fileoff as usize + segment.data.len(),
segment.vmsize,
segment.filesize,
sections.len()
);
for (section_index, (section, _)) in sections.into_iter().enumerate() {
println!(
"segment #{}; section #{}: {}; segment offsets=0x{:x}-0x{:x} size {}",
segment_index,
section_index,
section.name()?,
section.offset,
section.offset as u64 + section.size,
section.size
);
}
}
}
"macho-target" => {
if let Some(target) = macho.find_targeting()? {
println!("Platform: {}", target.platform);
println!("Minimum OS: {}", target.minimum_os_version);
println!("SDK: {}", target.sdk_version);
} else {
println!("Unable to resolve Mach-O targeting from load commands");
}
}
"requirements-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(blob) = embedded.find_slot(CodeSigningSlot::RequirementSet) {
std::io::stdout().write_all(blob.data)?;
} else {
eprintln!("no requirements");
}
}
"requirements-rust" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
for (typ, req) in &reqs.requirements {
for expr in req.parse_expressions()?.iter() {
println!("{typ} => {expr:#?}");
}
}
} else {
eprintln!("no requirements");
}
}
"requirements-serialized-raw" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
std::io::stdout().write_all(&reqs.to_blob_bytes()?)?;
} else {
eprintln!("no requirements");
}
}
"requirements-serialized" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
let serialized = reqs.to_blob_bytes()?;
println!("{:#?}", RequirementSetBlob::from_blob_bytes(&serialized)?);
} else {
eprintln!("no requirements");
}
}
"requirements" => {
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
if let Some(reqs) = embedded.code_requirements()? {
for (typ, req) in &reqs.requirements {
for expr in req.parse_expressions()?.iter() {
println!("{typ} => {expr}");
}
}
} else {
eprintln!("no requirements");
}
}
"signature-raw" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
std::io::stdout().write_all(sig.signature_data)?;
}
"superblob" => {
let sig = macho
.find_signature_data()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
let embedded = macho
.code_signature()?
.ok_or(AppleCodesignError::BinaryNoCodeSignature)?;
println!("file start offset: {}", sig.linkedit_signature_start_offset);
println!("file end offset: {}", sig.linkedit_signature_end_offset);
println!("__LINKEDIT start offset: {}", sig.signature_start_offset);
println!("__LINKEDIT end offset: {}", sig.signature_end_offset);
println!("length: {}", embedded.length);
println!("blob count: {}", embedded.count);
println!("blobs:");
for blob in embedded.blobs {
println!("- index: {}", blob.index);
println!(
" offsets: 0x{:x}-0x{:x} ({}-{})",
blob.offset,
blob.offset + blob.length - 1,
blob.offset,
blob.offset + blob.length - 1
);
println!(" length: {}", blob.length);
println!(" slot: {:?}", blob.slot);
println!(" magic: {:?} (0x{:x})", blob.magic, u32::from(blob.magic));
println!(
" sha1: {}",
hex::encode(blob.digest_with(DigestType::Sha1)?)
);
println!(
" sha256: {}",
hex::encode(blob.digest_with(DigestType::Sha256)?)
);
println!(
" sha256-truncated: {}",
hex::encode(blob.digest_with(DigestType::Sha256Truncated)?)
);
println!(
" sha384: {}",
hex::encode(blob.digest_with(DigestType::Sha384)?),
);
println!(
" sha512: {}",
hex::encode(blob.digest_with(DigestType::Sha512)?),
);
println!(
" sha1-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha1)?)
);
println!(
" sha256-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha256)?)
);
println!(
" sha256-truncated-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha256Truncated)?)
);
println!(
" sha384-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha384)?)
);
println!(
" sha512-base64: {}",
base64::encode(blob.digest_with(DigestType::Sha512)?)
);
}
}
_ => panic!("unhandled format: {format}"),
}
Ok(())
}
fn command_generate_certificate_signing_request(
args: &ArgMatches,
) -> Result<(), AppleCodesignError> {
let csr_pem_path = args.get_one::<String>("csr_pem_path").map(PathBuf::from);
let (private_keys, _) = collect_certificates_from_args(args, true)?;
let private_key = if private_keys.is_empty() {
error!("no private keys found; a private key is required to sign a certificate signing request");
return Err(AppleCodesignError::CliBadArgument);
} else if private_keys.len() > 1 {
error!(
"at most 1 private key can be present (found {}); aborting",
private_keys.len()
);
return Err(AppleCodesignError::CliBadArgument);
} else {
private_keys.into_iter().next().expect("checked size above")
};
let key_algorithm = private_key.key_algorithm().ok_or_else(|| {
error!("unable to determine key algorithm of private key (please report this issue)");
AppleCodesignError::CliBadArgument
})?;
let mut builder = X509CertificateBuilder::new(key_algorithm);
builder
.subject()
.append_common_name_utf8_string("Apple Code Signing CSR")
.map_err(|e| AppleCodesignError::CertificateBuildError(format!("{e:?}")))?;
warn!("generating CSR; you may be prompted to enter credentials to unlock the signing key");
let pem = builder
.create_certificate_signing_request(private_key.as_key_info_signer())?
.encode_pem()?;
if let Some(dest_path) = csr_pem_path {
if let Some(parent) = dest_path.parent() {
std::fs::create_dir_all(parent)?;
}
warn!("writing PEM encoded CSR to {}", dest_path.display());
std::fs::write(&dest_path, pem.as_bytes())?;
}
print!("{pem}");
Ok(())
}
fn command_generate_self_signed_certificate(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let algorithm = match args
.get_one::<String>("algorithm")
.ok_or(AppleCodesignError::CliBadArgument)?
.as_str()
{
"ecdsa" => KeyAlgorithm::Ecdsa(EcdsaCurve::Secp256r1),
"ed25519" => KeyAlgorithm::Ed25519,
value => panic!(
"algorithm values should have been validated by arg parser: {value}"
),
};
let profile = args
.get_one::<String>("profile")
.ok_or(AppleCodesignError::CliBadArgument)?;
let profile = CertificateProfile::from_str(profile)?;
let team_id = args
.get_one::<String>("team_id")
.ok_or(AppleCodesignError::CliBadArgument)?;
let person_name = args
.get_one::<String>("person_name")
.ok_or(AppleCodesignError::CliBadArgument)?;
let country_name = args
.get_one::<String>("country_name")
.ok_or(AppleCodesignError::CliBadArgument)?;
let validity_days = args.get_one::<String>("validity_days").unwrap();
let validity_days =
i64::from_str(validity_days).map_err(|_| AppleCodesignError::CliBadArgument)?;
let pem_filename = args.get_one::<String>("pem_filename");
let validity_duration = chrono::Duration::days(validity_days);
let (cert, _, raw) = create_self_signed_code_signing_certificate(
algorithm,
profile,
team_id,
person_name,
country_name,
validity_duration,
)?;
let cert_pem = cert.encode_pem();
let key_pem = pem::encode(&pem::Pem {
tag: "PRIVATE KEY".to_string(),
contents: raw.as_ref().to_vec(),
});
let mut wrote_file = false;
if let Some(pem_filename) = pem_filename {
let cert_path = PathBuf::from(format!("{pem_filename}.crt"));
let key_path = PathBuf::from(format!("{pem_filename}.key"));
if let Some(parent) = cert_path.parent() {
std::fs::create_dir_all(parent)?;
}
println!("writing public certificate to {}", cert_path.display());
std::fs::write(&cert_path, cert_pem.as_bytes())?;
println!("writing private signing key to {}", key_path.display());
std::fs::write(&key_path, key_pem.as_bytes())?;
wrote_file = true;
}
if !wrote_file {
print!("{cert_pem}");
print!("{key_pem}");
}
Ok(())
}
#[cfg(target_os = "macos")]
fn command_keychain_export_certificate_chain(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let user_id = args.get_one::<String>("user_id").unwrap();
let domain = args
.get_one::<String>("domain")
.expect("clap should have added default value");
let domain = KeychainDomain::try_from(domain.as_str())
.expect("clap should have validated domain values");
let password = if let Some(path) = args.get_one::<String>("password_file") {
let data = std::fs::read_to_string(path)?;
Some(
data.lines()
.next()
.expect("should get a single line")
.to_string(),
)
} else if let Some(password) = args.get_one::<String>("password") {
Some(password.to_string())
} else {
None
};
let certs = macos_keychain_find_certificate_chain(domain, password.as_deref(), user_id)?;
for (i, cert) in certs.iter().enumerate() {
if args.get_flag("no_print_self") && i == 0 {
continue;
}
print!("{}", cert.encode_pem());
}
Ok(())
}
#[cfg(not(target_os = "macos"))]
fn command_keychain_export_certificate_chain(_args: &ArgMatches) -> Result<(), AppleCodesignError> {
Err(AppleCodesignError::CliGeneralError(
"macOS Keychain export only supported on macOS".to_string(),
))
}
#[cfg(target_os = "macos")]
fn command_keychain_print_certificates(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let domain = args
.get_one::<String>("domain")
.expect("clap should have added default value");
let domain = KeychainDomain::try_from(domain.as_str())
.expect("clap should have validated domain values");
let certs = keychain_find_code_signing_certificates(domain, None)?;
for (i, cert) in certs.into_iter().enumerate() {
println!("# Certificate {}", i);
println!();
print_certificate_info(&cert)?;
println!();
}
Ok(())
}
#[cfg(not(target_os = "macos"))]
fn command_keychain_print_certificates(_args: &ArgMatches) -> Result<(), AppleCodesignError> {
Err(AppleCodesignError::CliGeneralError(
"macOS Keychain integration supported on macOS".to_string(),
))
}
const NOTARIZE_ABOUT: &str = "\
Submit a notarization request to Apple.
This command is used to submit an asset to Apple for notarization. Given
a path to an asset with a code signature, this command will connect to Apple's
Notary API and upload the asset. It will then optionally wait on the submission
to finish processing (which typically takes a few dozen seconds). If the
asset validates Apple's requirements, Apple will issue a *notarization ticket*
as proof that they approved of it. This ticket is then added to the asset in a
process called *stapling*, which this command can do automatically if the
`--staple` argument is passed.
# App Store Connect API Key
In order to communicate with Apple's servers, you need an App Store Connect
API Key. This requires an Apple Developer account. You can generate an
API Key at https://appstoreconnect.apple.com/access/api.
The recommended mechanism to define the API Key is via `--api-key-path`,
which takes the path to a file containing JSON produced by the
`encode-app-store-connect-api-key` command. See that command's help for
more details.
If you don't wish to use `--api-key-path`, you can define the key components
via the `--api-issuer` and `--api-key` arguments. You will need a file named
`AuthKey_<ID>.p8` in one of the following locations: `$(pwd)/private_keys/`,
`~/private_keys/`, '~/.private_keys/`, and `~/.appstoreconnect/private_keys/`
(searched in that order). The name of the file is derived from the value of
`--api-key`.
In all cases, App Store Connect API Keys can be managed at
https://appstoreconnect.apple.com/access/api.
# Modes of Operation
By default, the `notarize` command will initiate an upload to Apple and exit
once the upload is complete.
Once an upload is performed, Apple will asynchronously process the uploaded
content. This can take seconds to minutes.
To poll Apple's servers and wait on the server-side processing to finish,
specify `--wait`. This will query the state of the processing every few seconds
until it is finished, the max wait time is reached, or an error occurs.
To automatically staple an asset after server-side processing has finished,
specify `--staple`. This implies `--wait`.
";
/// Obtain a notarization client from arguments.
fn notarizer_from_args(args: &ArgMatches) -> Result<Notarizer, AppleCodesignError> {
let api_key_path = args.get_one::<PathBuf>("api_key_path");
let api_issuer = args.get_one::<String>("api_issuer");
let api_key = args.get_one::<String>("api_key");
if let Some(api_key_path) = api_key_path {
Notarizer::from_api_key(api_key_path)
} else if let (Some(issuer), Some(key)) = (api_issuer, api_key) {
Notarizer::from_api_key_id(issuer, key)
} else {
Err(AppleCodesignError::NotarizeNoAuthCredentials)
}
}
fn notarizer_wait_duration(args: &ArgMatches) -> Result<std::time::Duration, AppleCodesignError> {
let max_wait_seconds = args
.get_one::<String>("max_wait_seconds")
.expect("argument should have default value");
let max_wait_seconds =
u64::from_str(max_wait_seconds).map_err(|_| AppleCodesignError::CliBadArgument)?;
Ok(std::time::Duration::from_secs(max_wait_seconds))
}
fn command_notary_log(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let notarizer = notarizer_from_args(args)?;
let submission_id = args
.get_one::<String>("submission_id")
.expect("submission_id is required");
let log = notarizer.fetch_notarization_log(submission_id)?;
for line in serde_json::to_string_pretty(&log)?.lines() {
println!("{line}");
}
Ok(())
}
fn command_notary_submit(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = PathBuf::from(
args.get_one::<String>("path")
.expect("clap should have validated arguments"),
);
let staple = args.get_flag("staple");
let wait = args.get_flag("wait") || staple;
let wait_limit = if wait {
Some(notarizer_wait_duration(args)?)
} else {
None
};
let notarizer = notarizer_from_args(args)?;
let upload = notarizer.notarize_path(&path, wait_limit)?;
if staple {
match upload {
crate::notarization::NotarizationUpload::UploadId(_) => {
panic!(
"NotarizationUpload::UploadId should not be returned if we waited successfully"
);
}
crate::notarization::NotarizationUpload::NotaryResponse(_) => {
let stapler = crate::stapling::Stapler::new()?;
stapler.staple_path(&path)?;
}
}
}
Ok(())
}
fn command_notary_wait(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let wait_duration = notarizer_wait_duration(args)?;
let notarizer = notarizer_from_args(args)?;
let submission_id = args
.get_one::<String>("submission_id")
.expect("submission_id is required");
notarizer.wait_on_notarization_and_fetch_log(submission_id, wait_duration)?;
Ok(())
}
fn command_parse_code_signing_requirement(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("input_path")
.expect("clap should have validated argument");
let data = std::fs::read(path)?;
let requirements = CodeRequirements::parse_blob(&data)?.0;
for requirement in requirements.iter() {
match args
.get_one::<String>("format")
.expect("clap should have validated argument")
.as_str()
{
"csrl" => {
println!("{requirement}");
}
"expression-tree" => {
println!("{requirement:#?}");
}
format => panic!("unhandled format: {format}"),
}
}
Ok(())
}
fn command_print_signature_info(args: &ArgMatches) -> Result<(), AppleCodesignError> {
let path = args
.get_one::<String>("path")
.expect("clap should have validated argument");
let reader = SignatureReader::from_path(path)?;
let entities = reader.entities()?;
serde_yaml::to_writer(std::io::stdout(), &entities)?;
Ok(())
}
Auto Trait Implementations§
impl RefUnwindSafe for SignatureReader
impl Send for SignatureReader
impl Sync for SignatureReader
impl Unpin for SignatureReader
impl UnwindSafe for SignatureReader
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
Borrows
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Mutable access to the
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.