key_manager.cpp 51 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379
  1. // SPDX-FileCopyrightText: Copyright 2018 yuzu Emulator Project
  2. // SPDX-License-Identifier: GPL-2.0-or-later
  3. #include <algorithm>
  4. #include <array>
  5. #include <bitset>
  6. #include <cctype>
  7. #include <fstream>
  8. #include <locale>
  9. #include <map>
  10. #include <sstream>
  11. #include <tuple>
  12. #include <vector>
  13. #include <mbedtls/bignum.h>
  14. #include <mbedtls/cipher.h>
  15. #include <mbedtls/cmac.h>
  16. #include <mbedtls/sha256.h>
  17. #include "common/fs/file.h"
  18. #include "common/fs/fs.h"
  19. #include "common/fs/path_util.h"
  20. #include "common/hex_util.h"
  21. #include "common/logging/log.h"
  22. #include "common/settings.h"
  23. #include "common/string_util.h"
  24. #include "core/crypto/aes_util.h"
  25. #include "core/crypto/key_manager.h"
  26. #include "core/crypto/partition_data_manager.h"
  27. #include "core/file_sys/content_archive.h"
  28. #include "core/file_sys/nca_metadata.h"
  29. #include "core/file_sys/registered_cache.h"
  30. #include "core/hle/service/filesystem/filesystem.h"
  31. #include "core/loader/loader.h"
  32. namespace Core::Crypto {
  33. namespace {
  34. constexpr u64 CURRENT_CRYPTO_REVISION = 0x5;
  35. using Common::AsArray;
  36. // clang-format off
  37. constexpr std::array eticket_source_hashes{
  38. AsArray("B71DB271DC338DF380AA2C4335EF8873B1AFD408E80B3582D8719FC81C5E511C"), // eticket_rsa_kek_source
  39. AsArray("E8965A187D30E57869F562D04383C996DE487BBA5761363D2D4D32391866A85C"), // eticket_rsa_kekek_source
  40. };
  41. // clang-format on
  42. constexpr std::array<std::pair<std::string_view, KeyIndex<S128KeyType>>, 30> s128_file_id{{
  43. {"eticket_rsa_kek", {S128KeyType::ETicketRSAKek, 0, 0}},
  44. {"eticket_rsa_kek_source",
  45. {S128KeyType::Source, static_cast<u64>(SourceKeyType::ETicketKek), 0}},
  46. {"eticket_rsa_kekek_source",
  47. {S128KeyType::Source, static_cast<u64>(SourceKeyType::ETicketKekek), 0}},
  48. {"rsa_kek_mask_0", {S128KeyType::RSAKek, static_cast<u64>(RSAKekType::Mask0), 0}},
  49. {"rsa_kek_seed_3", {S128KeyType::RSAKek, static_cast<u64>(RSAKekType::Seed3), 0}},
  50. {"rsa_oaep_kek_generation_source",
  51. {S128KeyType::Source, static_cast<u64>(SourceKeyType::RSAOaepKekGeneration), 0}},
  52. {"sd_card_kek_source", {S128KeyType::Source, static_cast<u64>(SourceKeyType::SDKek), 0}},
  53. {"aes_kek_generation_source",
  54. {S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration), 0}},
  55. {"aes_key_generation_source",
  56. {S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration), 0}},
  57. {"package2_key_source", {S128KeyType::Source, static_cast<u64>(SourceKeyType::Package2), 0}},
  58. {"master_key_source", {S128KeyType::Source, static_cast<u64>(SourceKeyType::Master), 0}},
  59. {"header_kek_source", {S128KeyType::Source, static_cast<u64>(SourceKeyType::HeaderKek), 0}},
  60. {"key_area_key_application_source",
  61. {S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyAreaKey),
  62. static_cast<u64>(KeyAreaKeyType::Application)}},
  63. {"key_area_key_ocean_source",
  64. {S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyAreaKey),
  65. static_cast<u64>(KeyAreaKeyType::Ocean)}},
  66. {"key_area_key_system_source",
  67. {S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyAreaKey),
  68. static_cast<u64>(KeyAreaKeyType::System)}},
  69. {"titlekek_source", {S128KeyType::Source, static_cast<u64>(SourceKeyType::Titlekek), 0}},
  70. {"keyblob_mac_key_source",
  71. {S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyblobMAC), 0}},
  72. {"tsec_key", {S128KeyType::TSEC, 0, 0}},
  73. {"secure_boot_key", {S128KeyType::SecureBoot, 0, 0}},
  74. {"sd_seed", {S128KeyType::SDSeed, 0, 0}},
  75. {"bis_key_0_crypt", {S128KeyType::BIS, 0, static_cast<u64>(BISKeyType::Crypto)}},
  76. {"bis_key_0_tweak", {S128KeyType::BIS, 0, static_cast<u64>(BISKeyType::Tweak)}},
  77. {"bis_key_1_crypt", {S128KeyType::BIS, 1, static_cast<u64>(BISKeyType::Crypto)}},
  78. {"bis_key_1_tweak", {S128KeyType::BIS, 1, static_cast<u64>(BISKeyType::Tweak)}},
  79. {"bis_key_2_crypt", {S128KeyType::BIS, 2, static_cast<u64>(BISKeyType::Crypto)}},
  80. {"bis_key_2_tweak", {S128KeyType::BIS, 2, static_cast<u64>(BISKeyType::Tweak)}},
  81. {"bis_key_3_crypt", {S128KeyType::BIS, 3, static_cast<u64>(BISKeyType::Crypto)}},
  82. {"bis_key_3_tweak", {S128KeyType::BIS, 3, static_cast<u64>(BISKeyType::Tweak)}},
  83. {"header_kek", {S128KeyType::HeaderKek, 0, 0}},
  84. {"sd_card_kek", {S128KeyType::SDKek, 0, 0}},
  85. }};
  86. auto Find128ByName(std::string_view name) {
  87. return std::find_if(s128_file_id.begin(), s128_file_id.end(),
  88. [&name](const auto& pair) { return pair.first == name; });
  89. }
  90. constexpr std::array<std::pair<std::string_view, KeyIndex<S256KeyType>>, 6> s256_file_id{{
  91. {"header_key", {S256KeyType::Header, 0, 0}},
  92. {"sd_card_save_key_source", {S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::Save), 0}},
  93. {"sd_card_nca_key_source", {S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::NCA), 0}},
  94. {"header_key_source", {S256KeyType::HeaderSource, 0, 0}},
  95. {"sd_card_save_key", {S256KeyType::SDKey, static_cast<u64>(SDKeyType::Save), 0}},
  96. {"sd_card_nca_key", {S256KeyType::SDKey, static_cast<u64>(SDKeyType::NCA), 0}},
  97. }};
  98. auto Find256ByName(std::string_view name) {
  99. return std::find_if(s256_file_id.begin(), s256_file_id.end(),
  100. [&name](const auto& pair) { return pair.first == name; });
  101. }
  102. using KeyArray = std::array<std::pair<std::pair<S128KeyType, u64>, std::string_view>, 7>;
  103. constexpr KeyArray KEYS_VARIABLE_LENGTH{{
  104. {{S128KeyType::Master, 0}, "master_key_"},
  105. {{S128KeyType::Package1, 0}, "package1_key_"},
  106. {{S128KeyType::Package2, 0}, "package2_key_"},
  107. {{S128KeyType::Titlekek, 0}, "titlekek_"},
  108. {{S128KeyType::Source, static_cast<u64>(SourceKeyType::Keyblob)}, "keyblob_key_source_"},
  109. {{S128KeyType::Keyblob, 0}, "keyblob_key_"},
  110. {{S128KeyType::KeyblobMAC, 0}, "keyblob_mac_key_"},
  111. }};
  112. template <std::size_t Size>
  113. bool IsAllZeroArray(const std::array<u8, Size>& array) {
  114. return std::all_of(array.begin(), array.end(), [](const auto& elem) { return elem == 0; });
  115. }
  116. } // Anonymous namespace
  117. u64 GetSignatureTypeDataSize(SignatureType type) {
  118. switch (type) {
  119. case SignatureType::RSA_4096_SHA1:
  120. case SignatureType::RSA_4096_SHA256:
  121. return 0x200;
  122. case SignatureType::RSA_2048_SHA1:
  123. case SignatureType::RSA_2048_SHA256:
  124. return 0x100;
  125. case SignatureType::ECDSA_SHA1:
  126. case SignatureType::ECDSA_SHA256:
  127. return 0x3C;
  128. }
  129. UNREACHABLE();
  130. }
  131. u64 GetSignatureTypePaddingSize(SignatureType type) {
  132. switch (type) {
  133. case SignatureType::RSA_4096_SHA1:
  134. case SignatureType::RSA_4096_SHA256:
  135. case SignatureType::RSA_2048_SHA1:
  136. case SignatureType::RSA_2048_SHA256:
  137. return 0x3C;
  138. case SignatureType::ECDSA_SHA1:
  139. case SignatureType::ECDSA_SHA256:
  140. return 0x40;
  141. }
  142. UNREACHABLE();
  143. }
  144. bool Ticket::IsValid() const {
  145. return !std::holds_alternative<std::monostate>(data);
  146. }
  147. SignatureType Ticket::GetSignatureType() const {
  148. if (const auto* ticket = std::get_if<RSA4096Ticket>(&data)) {
  149. return ticket->sig_type;
  150. }
  151. if (const auto* ticket = std::get_if<RSA2048Ticket>(&data)) {
  152. return ticket->sig_type;
  153. }
  154. if (const auto* ticket = std::get_if<ECDSATicket>(&data)) {
  155. return ticket->sig_type;
  156. }
  157. throw std::bad_variant_access{};
  158. }
  159. TicketData& Ticket::GetData() {
  160. if (auto* ticket = std::get_if<RSA4096Ticket>(&data)) {
  161. return ticket->data;
  162. }
  163. if (auto* ticket = std::get_if<RSA2048Ticket>(&data)) {
  164. return ticket->data;
  165. }
  166. if (auto* ticket = std::get_if<ECDSATicket>(&data)) {
  167. return ticket->data;
  168. }
  169. throw std::bad_variant_access{};
  170. }
  171. const TicketData& Ticket::GetData() const {
  172. if (const auto* ticket = std::get_if<RSA4096Ticket>(&data)) {
  173. return ticket->data;
  174. }
  175. if (const auto* ticket = std::get_if<RSA2048Ticket>(&data)) {
  176. return ticket->data;
  177. }
  178. if (const auto* ticket = std::get_if<ECDSATicket>(&data)) {
  179. return ticket->data;
  180. }
  181. throw std::bad_variant_access{};
  182. }
  183. u64 Ticket::GetSize() const {
  184. const auto sig_type = GetSignatureType();
  185. return sizeof(SignatureType) + GetSignatureTypeDataSize(sig_type) +
  186. GetSignatureTypePaddingSize(sig_type) + sizeof(TicketData);
  187. }
  188. Ticket Ticket::SynthesizeCommon(Key128 title_key, const std::array<u8, 16>& rights_id) {
  189. RSA2048Ticket out{};
  190. out.sig_type = SignatureType::RSA_2048_SHA256;
  191. out.data.rights_id = rights_id;
  192. out.data.title_key_common = title_key;
  193. return Ticket{out};
  194. }
  195. Ticket Ticket::Read(const FileSys::VirtualFile& file) {
  196. // Attempt to read up to the largest ticket size, and make sure we read at least a signature
  197. // type.
  198. std::array<u8, sizeof(RSA4096Ticket)> raw_data{};
  199. auto read_size = file->Read(raw_data.data(), raw_data.size(), 0);
  200. if (read_size < sizeof(SignatureType)) {
  201. LOG_WARNING(Crypto, "Attempted to read ticket file with invalid size {}.", read_size);
  202. return Ticket{std::monostate()};
  203. }
  204. return Read(std::span{raw_data});
  205. }
  206. Ticket Ticket::Read(std::span<const u8> raw_data) {
  207. // Some tools read only 0x180 bytes of ticket data instead of 0x2C0, so
  208. // just make sure we have at least the bare minimum of data to work with.
  209. SignatureType sig_type;
  210. if (raw_data.size() < sizeof(SignatureType)) {
  211. LOG_WARNING(Crypto, "Attempted to parse ticket buffer with invalid size {}.",
  212. raw_data.size());
  213. return Ticket{std::monostate()};
  214. }
  215. std::memcpy(&sig_type, raw_data.data(), sizeof(sig_type));
  216. switch (sig_type) {
  217. case SignatureType::RSA_4096_SHA1:
  218. case SignatureType::RSA_4096_SHA256: {
  219. RSA4096Ticket ticket{};
  220. std::memcpy(&ticket, raw_data.data(), sizeof(ticket));
  221. return Ticket{ticket};
  222. }
  223. case SignatureType::RSA_2048_SHA1:
  224. case SignatureType::RSA_2048_SHA256: {
  225. RSA2048Ticket ticket{};
  226. std::memcpy(&ticket, raw_data.data(), sizeof(ticket));
  227. return Ticket{ticket};
  228. }
  229. case SignatureType::ECDSA_SHA1:
  230. case SignatureType::ECDSA_SHA256: {
  231. ECDSATicket ticket{};
  232. std::memcpy(&ticket, raw_data.data(), sizeof(ticket));
  233. return Ticket{ticket};
  234. }
  235. default:
  236. LOG_WARNING(Crypto, "Attempted to parse ticket buffer with invalid type {}.", sig_type);
  237. return Ticket{std::monostate()};
  238. }
  239. }
  240. Key128 GenerateKeyEncryptionKey(Key128 source, Key128 master, Key128 kek_seed, Key128 key_seed) {
  241. Key128 out{};
  242. AESCipher<Key128> cipher1(master, Mode::ECB);
  243. cipher1.Transcode(kek_seed.data(), kek_seed.size(), out.data(), Op::Decrypt);
  244. AESCipher<Key128> cipher2(out, Mode::ECB);
  245. cipher2.Transcode(source.data(), source.size(), out.data(), Op::Decrypt);
  246. if (key_seed != Key128{}) {
  247. AESCipher<Key128> cipher3(out, Mode::ECB);
  248. cipher3.Transcode(key_seed.data(), key_seed.size(), out.data(), Op::Decrypt);
  249. }
  250. return out;
  251. }
  252. Key128 DeriveKeyblobKey(const Key128& sbk, const Key128& tsec, Key128 source) {
  253. AESCipher<Key128> sbk_cipher(sbk, Mode::ECB);
  254. AESCipher<Key128> tsec_cipher(tsec, Mode::ECB);
  255. tsec_cipher.Transcode(source.data(), source.size(), source.data(), Op::Decrypt);
  256. sbk_cipher.Transcode(source.data(), source.size(), source.data(), Op::Decrypt);
  257. return source;
  258. }
  259. Key128 DeriveMasterKey(const std::array<u8, 0x90>& keyblob, const Key128& master_source) {
  260. Key128 master_root;
  261. std::memcpy(master_root.data(), keyblob.data(), sizeof(Key128));
  262. AESCipher<Key128> master_cipher(master_root, Mode::ECB);
  263. Key128 master{};
  264. master_cipher.Transcode(master_source.data(), master_source.size(), master.data(), Op::Decrypt);
  265. return master;
  266. }
  267. std::array<u8, 144> DecryptKeyblob(const std::array<u8, 176>& encrypted_keyblob,
  268. const Key128& key) {
  269. std::array<u8, 0x90> keyblob;
  270. AESCipher<Key128> cipher(key, Mode::CTR);
  271. cipher.SetIV(std::vector<u8>(encrypted_keyblob.data() + 0x10, encrypted_keyblob.data() + 0x20));
  272. cipher.Transcode(encrypted_keyblob.data() + 0x20, keyblob.size(), keyblob.data(), Op::Decrypt);
  273. return keyblob;
  274. }
  275. void KeyManager::DeriveGeneralPurposeKeys(std::size_t crypto_revision) {
  276. const auto kek_generation_source =
  277. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration));
  278. const auto key_generation_source =
  279. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration));
  280. if (HasKey(S128KeyType::Master, crypto_revision)) {
  281. for (auto kak_type :
  282. {KeyAreaKeyType::Application, KeyAreaKeyType::Ocean, KeyAreaKeyType::System}) {
  283. if (HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyAreaKey),
  284. static_cast<u64>(kak_type))) {
  285. const auto source =
  286. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyAreaKey),
  287. static_cast<u64>(kak_type));
  288. const auto kek =
  289. GenerateKeyEncryptionKey(source, GetKey(S128KeyType::Master, crypto_revision),
  290. kek_generation_source, key_generation_source);
  291. SetKey(S128KeyType::KeyArea, kek, crypto_revision, static_cast<u64>(kak_type));
  292. }
  293. }
  294. AESCipher<Key128> master_cipher(GetKey(S128KeyType::Master, crypto_revision), Mode::ECB);
  295. for (auto key_type : {SourceKeyType::Titlekek, SourceKeyType::Package2}) {
  296. if (HasKey(S128KeyType::Source, static_cast<u64>(key_type))) {
  297. Key128 key{};
  298. master_cipher.Transcode(
  299. GetKey(S128KeyType::Source, static_cast<u64>(key_type)).data(), key.size(),
  300. key.data(), Op::Decrypt);
  301. SetKey(key_type == SourceKeyType::Titlekek ? S128KeyType::Titlekek
  302. : S128KeyType::Package2,
  303. key, crypto_revision);
  304. }
  305. }
  306. }
  307. }
  308. void KeyManager::DeriveETicketRSAKey() {
  309. if (IsAllZeroArray(eticket_extended_kek) || !HasKey(S128KeyType::ETicketRSAKek)) {
  310. return;
  311. }
  312. const auto eticket_final = GetKey(S128KeyType::ETicketRSAKek);
  313. std::vector<u8> extended_iv(eticket_extended_kek.begin(), eticket_extended_kek.begin() + 0x10);
  314. std::array<u8, 0x230> extended_dec{};
  315. AESCipher<Key128> rsa_1(eticket_final, Mode::CTR);
  316. rsa_1.SetIV(extended_iv);
  317. rsa_1.Transcode(eticket_extended_kek.data() + 0x10, eticket_extended_kek.size() - 0x10,
  318. extended_dec.data(), Op::Decrypt);
  319. std::memcpy(eticket_rsa_keypair.decryption_key.data(), extended_dec.data(),
  320. eticket_rsa_keypair.decryption_key.size());
  321. std::memcpy(eticket_rsa_keypair.modulus.data(), extended_dec.data() + 0x100,
  322. eticket_rsa_keypair.modulus.size());
  323. std::memcpy(eticket_rsa_keypair.exponent.data(), extended_dec.data() + 0x200,
  324. eticket_rsa_keypair.exponent.size());
  325. }
  326. Key128 DeriveKeyblobMACKey(const Key128& keyblob_key, const Key128& mac_source) {
  327. AESCipher<Key128> mac_cipher(keyblob_key, Mode::ECB);
  328. Key128 mac_key{};
  329. mac_cipher.Transcode(mac_source.data(), mac_key.size(), mac_key.data(), Op::Decrypt);
  330. return mac_key;
  331. }
  332. std::optional<Key128> DeriveSDSeed() {
  333. const auto system_save_43_path =
  334. Common::FS::GetYuzuPath(Common::FS::YuzuPath::NANDDir) / "system/save/8000000000000043";
  335. const Common::FS::IOFile save_43{system_save_43_path, Common::FS::FileAccessMode::Read,
  336. Common::FS::FileType::BinaryFile};
  337. if (!save_43.IsOpen()) {
  338. return std::nullopt;
  339. }
  340. const auto sd_private_path =
  341. Common::FS::GetYuzuPath(Common::FS::YuzuPath::SDMCDir) / "Nintendo/Contents/private";
  342. const Common::FS::IOFile sd_private{sd_private_path, Common::FS::FileAccessMode::Read,
  343. Common::FS::FileType::BinaryFile};
  344. if (!sd_private.IsOpen()) {
  345. return std::nullopt;
  346. }
  347. std::array<u8, 0x10> private_seed{};
  348. if (sd_private.Read(private_seed) != private_seed.size()) {
  349. return std::nullopt;
  350. }
  351. std::array<u8, 0x10> buffer{};
  352. s64 offset = 0;
  353. for (; offset + 0x10 < static_cast<s64>(save_43.GetSize()); ++offset) {
  354. if (!save_43.Seek(offset)) {
  355. return std::nullopt;
  356. }
  357. if (save_43.Read(buffer) != buffer.size()) {
  358. return std::nullopt;
  359. }
  360. if (buffer == private_seed) {
  361. break;
  362. }
  363. }
  364. if (!save_43.Seek(offset + 0x10)) {
  365. return std::nullopt;
  366. }
  367. Key128 seed{};
  368. if (save_43.Read(seed) != seed.size()) {
  369. return std::nullopt;
  370. }
  371. return seed;
  372. }
  373. Loader::ResultStatus DeriveSDKeys(std::array<Key256, 2>& sd_keys, KeyManager& keys) {
  374. if (!keys.HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::SDKek))) {
  375. return Loader::ResultStatus::ErrorMissingSDKEKSource;
  376. }
  377. if (!keys.HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration))) {
  378. return Loader::ResultStatus::ErrorMissingAESKEKGenerationSource;
  379. }
  380. if (!keys.HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration))) {
  381. return Loader::ResultStatus::ErrorMissingAESKeyGenerationSource;
  382. }
  383. const auto sd_kek_source =
  384. keys.GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::SDKek));
  385. const auto aes_kek_gen =
  386. keys.GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration));
  387. const auto aes_key_gen =
  388. keys.GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration));
  389. const auto master_00 = keys.GetKey(S128KeyType::Master);
  390. const auto sd_kek =
  391. GenerateKeyEncryptionKey(sd_kek_source, master_00, aes_kek_gen, aes_key_gen);
  392. keys.SetKey(S128KeyType::SDKek, sd_kek);
  393. if (!keys.HasKey(S128KeyType::SDSeed)) {
  394. return Loader::ResultStatus::ErrorMissingSDSeed;
  395. }
  396. const auto sd_seed = keys.GetKey(S128KeyType::SDSeed);
  397. if (!keys.HasKey(S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::Save))) {
  398. return Loader::ResultStatus::ErrorMissingSDSaveKeySource;
  399. }
  400. if (!keys.HasKey(S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::NCA))) {
  401. return Loader::ResultStatus::ErrorMissingSDNCAKeySource;
  402. }
  403. std::array<Key256, 2> sd_key_sources{
  404. keys.GetKey(S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::Save)),
  405. keys.GetKey(S256KeyType::SDKeySource, static_cast<u64>(SDKeyType::NCA)),
  406. };
  407. // Combine sources and seed
  408. for (auto& source : sd_key_sources) {
  409. for (std::size_t i = 0; i < source.size(); ++i) {
  410. source[i] = static_cast<u8>(source[i] ^ sd_seed[i & 0xF]);
  411. }
  412. }
  413. AESCipher<Key128> cipher(sd_kek, Mode::ECB);
  414. // The transform manipulates sd_keys as part of the Transcode, so the return/output is
  415. // unnecessary. This does not alter sd_keys_sources.
  416. std::transform(sd_key_sources.begin(), sd_key_sources.end(), sd_keys.begin(),
  417. sd_key_sources.begin(), [&cipher](const Key256& source, Key256& out) {
  418. cipher.Transcode(source.data(), source.size(), out.data(), Op::Decrypt);
  419. return source; ///< Return unaltered source to satisfy output requirement.
  420. });
  421. keys.SetKey(S256KeyType::SDKey, sd_keys[0], static_cast<u64>(SDKeyType::Save));
  422. keys.SetKey(S256KeyType::SDKey, sd_keys[1], static_cast<u64>(SDKeyType::NCA));
  423. return Loader::ResultStatus::Success;
  424. }
  425. std::vector<Ticket> GetTicketblob(const Common::FS::IOFile& ticket_save) {
  426. if (!ticket_save.IsOpen()) {
  427. return {};
  428. }
  429. std::vector<u8> buffer(ticket_save.GetSize());
  430. if (ticket_save.Read(buffer) != buffer.size()) {
  431. return {};
  432. }
  433. std::vector<Ticket> out;
  434. for (std::size_t offset = 0; offset + 0x4 < buffer.size(); ++offset) {
  435. if (buffer[offset] == 0x4 && buffer[offset + 1] == 0x0 && buffer[offset + 2] == 0x1 &&
  436. buffer[offset + 3] == 0x0) {
  437. // NOTE: Assumes ticket blob will only contain RSA-2048 tickets.
  438. auto ticket = Ticket::Read(std::span{buffer.data() + offset, sizeof(RSA2048Ticket)});
  439. offset += sizeof(RSA2048Ticket);
  440. if (ticket.IsValid()) {
  441. out.push_back(ticket);
  442. }
  443. }
  444. }
  445. return out;
  446. }
  447. template <size_t size>
  448. static std::array<u8, size> operator^(const std::array<u8, size>& lhs,
  449. const std::array<u8, size>& rhs) {
  450. std::array<u8, size> out;
  451. std::transform(lhs.begin(), lhs.end(), rhs.begin(), out.begin(),
  452. [](u8 lhs_elem, u8 rhs_elem) { return u8(lhs_elem ^ rhs_elem); });
  453. return out;
  454. }
  455. template <size_t target_size, size_t in_size>
  456. static std::array<u8, target_size> MGF1(const std::array<u8, in_size>& seed) {
  457. // Avoids truncation overflow within the loop below.
  458. static_assert(target_size <= 0xFF);
  459. std::array<u8, in_size + 4> seed_exp{};
  460. std::memcpy(seed_exp.data(), seed.data(), in_size);
  461. std::vector<u8> out;
  462. size_t i = 0;
  463. while (out.size() < target_size) {
  464. out.resize(out.size() + 0x20);
  465. seed_exp[in_size + 3] = static_cast<u8>(i);
  466. mbedtls_sha256_ret(seed_exp.data(), seed_exp.size(), out.data() + out.size() - 0x20, 0);
  467. ++i;
  468. }
  469. std::array<u8, target_size> target;
  470. std::memcpy(target.data(), out.data(), target_size);
  471. return target;
  472. }
  473. template <size_t size>
  474. static std::optional<u64> FindTicketOffset(const std::array<u8, size>& data) {
  475. u64 offset = 0;
  476. for (size_t i = 0x20; i < data.size() - 0x10; ++i) {
  477. if (data[i] == 0x1) {
  478. offset = i + 1;
  479. break;
  480. } else if (data[i] != 0x0) {
  481. return std::nullopt;
  482. }
  483. }
  484. return offset;
  485. }
  486. std::optional<Key128> KeyManager::ParseTicketTitleKey(const Ticket& ticket) {
  487. if (!ticket.IsValid()) {
  488. LOG_WARNING(Crypto, "Attempted to parse title key of invalid ticket.");
  489. return std::nullopt;
  490. }
  491. if (ticket.GetData().rights_id == Key128{}) {
  492. LOG_WARNING(Crypto, "Attempted to parse title key of ticket with no rights ID.");
  493. return std::nullopt;
  494. }
  495. const auto issuer = ticket.GetData().issuer;
  496. if (IsAllZeroArray(issuer)) {
  497. LOG_WARNING(Crypto, "Attempted to parse title key of ticket with invalid issuer.");
  498. return std::nullopt;
  499. }
  500. if (issuer[0] != 'R' || issuer[1] != 'o' || issuer[2] != 'o' || issuer[3] != 't') {
  501. LOG_WARNING(Crypto, "Parsing ticket with non-standard certificate authority.");
  502. }
  503. if (ticket.GetData().type == TitleKeyType::Common) {
  504. return ticket.GetData().title_key_common;
  505. }
  506. if (eticket_rsa_keypair == RSAKeyPair<2048>{}) {
  507. LOG_WARNING(
  508. Crypto,
  509. "Skipping personalized ticket title key parsing due to missing ETicket RSA key-pair.");
  510. return std::nullopt;
  511. }
  512. mbedtls_mpi D; // RSA Private Exponent
  513. mbedtls_mpi N; // RSA Modulus
  514. mbedtls_mpi S; // Input
  515. mbedtls_mpi M; // Output
  516. mbedtls_mpi_init(&D);
  517. mbedtls_mpi_init(&N);
  518. mbedtls_mpi_init(&S);
  519. mbedtls_mpi_init(&M);
  520. const auto& title_key_block = ticket.GetData().title_key_block;
  521. mbedtls_mpi_read_binary(&D, eticket_rsa_keypair.decryption_key.data(),
  522. eticket_rsa_keypair.decryption_key.size());
  523. mbedtls_mpi_read_binary(&N, eticket_rsa_keypair.modulus.data(),
  524. eticket_rsa_keypair.modulus.size());
  525. mbedtls_mpi_read_binary(&S, title_key_block.data(), title_key_block.size());
  526. mbedtls_mpi_exp_mod(&M, &S, &D, &N, nullptr);
  527. std::array<u8, 0x100> rsa_step;
  528. mbedtls_mpi_write_binary(&M, rsa_step.data(), rsa_step.size());
  529. u8 m_0 = rsa_step[0];
  530. std::array<u8, 0x20> m_1;
  531. std::memcpy(m_1.data(), rsa_step.data() + 0x01, m_1.size());
  532. std::array<u8, 0xDF> m_2;
  533. std::memcpy(m_2.data(), rsa_step.data() + 0x21, m_2.size());
  534. if (m_0 != 0) {
  535. return std::nullopt;
  536. }
  537. m_1 = m_1 ^ MGF1<0x20>(m_2);
  538. m_2 = m_2 ^ MGF1<0xDF>(m_1);
  539. const auto offset = FindTicketOffset(m_2);
  540. if (!offset) {
  541. return std::nullopt;
  542. }
  543. ASSERT(*offset > 0);
  544. Key128 key_temp{};
  545. std::memcpy(key_temp.data(), m_2.data() + *offset, key_temp.size());
  546. return key_temp;
  547. }
  548. KeyManager::KeyManager() {
  549. ReloadKeys();
  550. }
  551. void KeyManager::ReloadKeys() {
  552. // Initialize keys
  553. const auto yuzu_keys_dir = Common::FS::GetYuzuPath(Common::FS::YuzuPath::KeysDir);
  554. if (!Common::FS::CreateDir(yuzu_keys_dir)) {
  555. LOG_ERROR(Core, "Failed to create the keys directory.");
  556. }
  557. if (Settings::values.use_dev_keys) {
  558. dev_mode = true;
  559. LoadFromFile(yuzu_keys_dir / "dev.keys_autogenerated", false);
  560. LoadFromFile(yuzu_keys_dir / "dev.keys", false);
  561. } else {
  562. dev_mode = false;
  563. LoadFromFile(yuzu_keys_dir / "prod.keys_autogenerated", false);
  564. LoadFromFile(yuzu_keys_dir / "prod.keys", false);
  565. }
  566. LoadFromFile(yuzu_keys_dir / "title.keys_autogenerated", true);
  567. LoadFromFile(yuzu_keys_dir / "title.keys", true);
  568. LoadFromFile(yuzu_keys_dir / "console.keys_autogenerated", false);
  569. LoadFromFile(yuzu_keys_dir / "console.keys", false);
  570. }
  571. static bool ValidCryptoRevisionString(std::string_view base, size_t begin, size_t length) {
  572. if (base.size() < begin + length) {
  573. return false;
  574. }
  575. return std::all_of(base.begin() + begin, base.begin() + begin + length,
  576. [](u8 c) { return std::isxdigit(c); });
  577. }
  578. void KeyManager::LoadFromFile(const std::filesystem::path& file_path, bool is_title_keys) {
  579. if (!Common::FS::Exists(file_path)) {
  580. return;
  581. }
  582. std::ifstream file;
  583. Common::FS::OpenFileStream(file, file_path, std::ios_base::in);
  584. if (!file.is_open()) {
  585. return;
  586. }
  587. std::string line;
  588. while (std::getline(file, line)) {
  589. std::vector<std::string> out;
  590. std::stringstream stream(line);
  591. std::string item;
  592. while (std::getline(stream, item, '=')) {
  593. out.push_back(std::move(item));
  594. }
  595. if (out.size() != 2) {
  596. continue;
  597. }
  598. out[0].erase(std::remove(out[0].begin(), out[0].end(), ' '), out[0].end());
  599. out[1].erase(std::remove(out[1].begin(), out[1].end(), ' '), out[1].end());
  600. if (out[0].compare(0, 1, "#") == 0) {
  601. continue;
  602. }
  603. if (is_title_keys) {
  604. auto rights_id_raw = Common::HexStringToArray<16>(out[0]);
  605. u128 rights_id{};
  606. std::memcpy(rights_id.data(), rights_id_raw.data(), rights_id_raw.size());
  607. Key128 key = Common::HexStringToArray<16>(out[1]);
  608. s128_keys[{S128KeyType::Titlekey, rights_id[1], rights_id[0]}] = key;
  609. } else {
  610. out[0] = Common::ToLower(out[0]);
  611. if (const auto iter128 = Find128ByName(out[0]); iter128 != s128_file_id.end()) {
  612. const auto& index = iter128->second;
  613. const Key128 key = Common::HexStringToArray<16>(out[1]);
  614. s128_keys[{index.type, index.field1, index.field2}] = key;
  615. } else if (const auto iter256 = Find256ByName(out[0]); iter256 != s256_file_id.end()) {
  616. const auto& index = iter256->second;
  617. const Key256 key = Common::HexStringToArray<32>(out[1]);
  618. s256_keys[{index.type, index.field1, index.field2}] = key;
  619. } else if (out[0].compare(0, 8, "keyblob_") == 0 &&
  620. out[0].compare(0, 9, "keyblob_k") != 0) {
  621. if (!ValidCryptoRevisionString(out[0], 8, 2)) {
  622. continue;
  623. }
  624. const auto index = std::stoul(out[0].substr(8, 2), nullptr, 16);
  625. keyblobs[index] = Common::HexStringToArray<0x90>(out[1]);
  626. } else if (out[0].compare(0, 18, "encrypted_keyblob_") == 0) {
  627. if (!ValidCryptoRevisionString(out[0], 18, 2)) {
  628. continue;
  629. }
  630. const auto index = std::stoul(out[0].substr(18, 2), nullptr, 16);
  631. encrypted_keyblobs[index] = Common::HexStringToArray<0xB0>(out[1]);
  632. } else if (out[0].compare(0, 20, "eticket_extended_kek") == 0) {
  633. eticket_extended_kek = Common::HexStringToArray<576>(out[1]);
  634. } else if (out[0].compare(0, 19, "eticket_rsa_keypair") == 0) {
  635. const auto key_data = Common::HexStringToArray<528>(out[1]);
  636. std::memcpy(eticket_rsa_keypair.decryption_key.data(), key_data.data(),
  637. eticket_rsa_keypair.decryption_key.size());
  638. std::memcpy(eticket_rsa_keypair.modulus.data(), key_data.data() + 0x100,
  639. eticket_rsa_keypair.modulus.size());
  640. std::memcpy(eticket_rsa_keypair.exponent.data(), key_data.data() + 0x200,
  641. eticket_rsa_keypair.exponent.size());
  642. } else {
  643. for (const auto& kv : KEYS_VARIABLE_LENGTH) {
  644. if (!ValidCryptoRevisionString(out[0], kv.second.size(), 2)) {
  645. continue;
  646. }
  647. if (out[0].compare(0, kv.second.size(), kv.second) == 0) {
  648. const auto index =
  649. std::stoul(out[0].substr(kv.second.size(), 2), nullptr, 16);
  650. const auto sub = kv.first.second;
  651. if (sub == 0) {
  652. s128_keys[{kv.first.first, index, 0}] =
  653. Common::HexStringToArray<16>(out[1]);
  654. } else {
  655. s128_keys[{kv.first.first, kv.first.second, index}] =
  656. Common::HexStringToArray<16>(out[1]);
  657. }
  658. break;
  659. }
  660. }
  661. static constexpr std::array<const char*, 3> kak_names = {
  662. "key_area_key_application_", "key_area_key_ocean_", "key_area_key_system_"};
  663. for (size_t j = 0; j < kak_names.size(); ++j) {
  664. const auto& match = kak_names[j];
  665. if (out[0].compare(0, std::strlen(match), match) == 0) {
  666. const auto index =
  667. std::stoul(out[0].substr(std::strlen(match), 2), nullptr, 16);
  668. s128_keys[{S128KeyType::KeyArea, index, j}] =
  669. Common::HexStringToArray<16>(out[1]);
  670. }
  671. }
  672. }
  673. }
  674. }
  675. }
  676. bool KeyManager::AreKeysLoaded() const {
  677. return !s128_keys.empty() && !s256_keys.empty();
  678. }
  679. bool KeyManager::BaseDeriveNecessary() const {
  680. const auto check_key_existence = [this](auto key_type, u64 index1 = 0, u64 index2 = 0) {
  681. return !HasKey(key_type, index1, index2);
  682. };
  683. if (check_key_existence(S256KeyType::Header)) {
  684. return true;
  685. }
  686. for (size_t i = 0; i < CURRENT_CRYPTO_REVISION; ++i) {
  687. if (check_key_existence(S128KeyType::Master, i) ||
  688. check_key_existence(S128KeyType::KeyArea, i,
  689. static_cast<u64>(KeyAreaKeyType::Application)) ||
  690. check_key_existence(S128KeyType::KeyArea, i, static_cast<u64>(KeyAreaKeyType::Ocean)) ||
  691. check_key_existence(S128KeyType::KeyArea, i,
  692. static_cast<u64>(KeyAreaKeyType::System)) ||
  693. check_key_existence(S128KeyType::Titlekek, i))
  694. return true;
  695. }
  696. return false;
  697. }
  698. bool KeyManager::HasKey(S128KeyType id, u64 field1, u64 field2) const {
  699. return s128_keys.find({id, field1, field2}) != s128_keys.end();
  700. }
  701. bool KeyManager::HasKey(S256KeyType id, u64 field1, u64 field2) const {
  702. return s256_keys.find({id, field1, field2}) != s256_keys.end();
  703. }
  704. Key128 KeyManager::GetKey(S128KeyType id, u64 field1, u64 field2) const {
  705. if (!HasKey(id, field1, field2)) {
  706. return {};
  707. }
  708. return s128_keys.at({id, field1, field2});
  709. }
  710. Key256 KeyManager::GetKey(S256KeyType id, u64 field1, u64 field2) const {
  711. if (!HasKey(id, field1, field2)) {
  712. return {};
  713. }
  714. return s256_keys.at({id, field1, field2});
  715. }
  716. Key256 KeyManager::GetBISKey(u8 partition_id) const {
  717. Key256 out{};
  718. for (const auto& bis_type : {BISKeyType::Crypto, BISKeyType::Tweak}) {
  719. if (HasKey(S128KeyType::BIS, partition_id, static_cast<u64>(bis_type))) {
  720. std::memcpy(
  721. out.data() + sizeof(Key128) * static_cast<u64>(bis_type),
  722. s128_keys.at({S128KeyType::BIS, partition_id, static_cast<u64>(bis_type)}).data(),
  723. sizeof(Key128));
  724. }
  725. }
  726. return out;
  727. }
  728. template <size_t Size>
  729. void KeyManager::WriteKeyToFile(KeyCategory category, std::string_view keyname,
  730. const std::array<u8, Size>& key) {
  731. const auto yuzu_keys_dir = Common::FS::GetYuzuPath(Common::FS::YuzuPath::KeysDir);
  732. std::string filename = "title.keys_autogenerated";
  733. if (category == KeyCategory::Standard) {
  734. filename = dev_mode ? "dev.keys_autogenerated" : "prod.keys_autogenerated";
  735. } else if (category == KeyCategory::Console) {
  736. filename = "console.keys_autogenerated";
  737. }
  738. const auto path = yuzu_keys_dir / filename;
  739. const auto add_info_text = !Common::FS::Exists(path);
  740. Common::FS::IOFile file{path, Common::FS::FileAccessMode::Append,
  741. Common::FS::FileType::TextFile};
  742. if (!file.IsOpen()) {
  743. return;
  744. }
  745. if (add_info_text) {
  746. void(file.WriteString(
  747. "# This file is autogenerated by Yuzu\n"
  748. "# It serves to store keys that were automatically generated from the normal keys\n"
  749. "# If you are experiencing issues involving keys, it may help to delete this file\n"));
  750. }
  751. void(file.WriteString(fmt::format("\n{} = {}", keyname, Common::HexToString(key))));
  752. LoadFromFile(path, category == KeyCategory::Title);
  753. }
  754. void KeyManager::SetKey(S128KeyType id, Key128 key, u64 field1, u64 field2) {
  755. if (s128_keys.find({id, field1, field2}) != s128_keys.end() || key == Key128{}) {
  756. return;
  757. }
  758. if (id == S128KeyType::Titlekey) {
  759. Key128 rights_id;
  760. std::memcpy(rights_id.data(), &field2, sizeof(u64));
  761. std::memcpy(rights_id.data() + sizeof(u64), &field1, sizeof(u64));
  762. WriteKeyToFile(KeyCategory::Title, Common::HexToString(rights_id), key);
  763. }
  764. auto category = KeyCategory::Standard;
  765. if (id == S128KeyType::Keyblob || id == S128KeyType::KeyblobMAC || id == S128KeyType::TSEC ||
  766. id == S128KeyType::SecureBoot || id == S128KeyType::SDSeed || id == S128KeyType::BIS) {
  767. category = KeyCategory::Console;
  768. }
  769. const auto iter2 = std::find_if(
  770. s128_file_id.begin(), s128_file_id.end(), [&id, &field1, &field2](const auto& elem) {
  771. return std::tie(elem.second.type, elem.second.field1, elem.second.field2) ==
  772. std::tie(id, field1, field2);
  773. });
  774. if (iter2 != s128_file_id.end()) {
  775. WriteKeyToFile(category, iter2->first, key);
  776. }
  777. // Variable cases
  778. if (id == S128KeyType::KeyArea) {
  779. static constexpr std::array<const char*, 3> kak_names = {
  780. "key_area_key_application_{:02X}",
  781. "key_area_key_ocean_{:02X}",
  782. "key_area_key_system_{:02X}",
  783. };
  784. WriteKeyToFile(category, fmt::format(fmt::runtime(kak_names.at(field2)), field1), key);
  785. } else if (id == S128KeyType::Master) {
  786. WriteKeyToFile(category, fmt::format("master_key_{:02X}", field1), key);
  787. } else if (id == S128KeyType::Package1) {
  788. WriteKeyToFile(category, fmt::format("package1_key_{:02X}", field1), key);
  789. } else if (id == S128KeyType::Package2) {
  790. WriteKeyToFile(category, fmt::format("package2_key_{:02X}", field1), key);
  791. } else if (id == S128KeyType::Titlekek) {
  792. WriteKeyToFile(category, fmt::format("titlekek_{:02X}", field1), key);
  793. } else if (id == S128KeyType::Keyblob) {
  794. WriteKeyToFile(category, fmt::format("keyblob_key_{:02X}", field1), key);
  795. } else if (id == S128KeyType::KeyblobMAC) {
  796. WriteKeyToFile(category, fmt::format("keyblob_mac_key_{:02X}", field1), key);
  797. } else if (id == S128KeyType::Source && field1 == static_cast<u64>(SourceKeyType::Keyblob)) {
  798. WriteKeyToFile(category, fmt::format("keyblob_key_source_{:02X}", field2), key);
  799. }
  800. s128_keys[{id, field1, field2}] = key;
  801. }
  802. void KeyManager::SetKey(S256KeyType id, Key256 key, u64 field1, u64 field2) {
  803. if (s256_keys.find({id, field1, field2}) != s256_keys.end() || key == Key256{}) {
  804. return;
  805. }
  806. const auto iter = std::find_if(
  807. s256_file_id.begin(), s256_file_id.end(), [&id, &field1, &field2](const auto& elem) {
  808. return std::tie(elem.second.type, elem.second.field1, elem.second.field2) ==
  809. std::tie(id, field1, field2);
  810. });
  811. if (iter != s256_file_id.end()) {
  812. WriteKeyToFile(KeyCategory::Standard, iter->first, key);
  813. }
  814. s256_keys[{id, field1, field2}] = key;
  815. }
  816. bool KeyManager::KeyFileExists(bool title) {
  817. const auto yuzu_keys_dir = Common::FS::GetYuzuPath(Common::FS::YuzuPath::KeysDir);
  818. if (title) {
  819. return Common::FS::Exists(yuzu_keys_dir / "title.keys");
  820. }
  821. if (Settings::values.use_dev_keys) {
  822. return Common::FS::Exists(yuzu_keys_dir / "dev.keys");
  823. }
  824. return Common::FS::Exists(yuzu_keys_dir / "prod.keys");
  825. }
  826. void KeyManager::DeriveSDSeedLazy() {
  827. if (HasKey(S128KeyType::SDSeed)) {
  828. return;
  829. }
  830. const auto res = DeriveSDSeed();
  831. if (res) {
  832. SetKey(S128KeyType::SDSeed, *res);
  833. }
  834. }
  835. static Key128 CalculateCMAC(const u8* source, size_t size, const Key128& key) {
  836. Key128 out{};
  837. mbedtls_cipher_cmac(mbedtls_cipher_info_from_type(MBEDTLS_CIPHER_AES_128_ECB), key.data(),
  838. key.size() * 8, source, size, out.data());
  839. return out;
  840. }
  841. void KeyManager::DeriveBase() {
  842. if (!BaseDeriveNecessary()) {
  843. return;
  844. }
  845. if (!HasKey(S128KeyType::SecureBoot) || !HasKey(S128KeyType::TSEC)) {
  846. return;
  847. }
  848. const auto has_bis = [this](u64 id) {
  849. return HasKey(S128KeyType::BIS, id, static_cast<u64>(BISKeyType::Crypto)) &&
  850. HasKey(S128KeyType::BIS, id, static_cast<u64>(BISKeyType::Tweak));
  851. };
  852. const auto copy_bis = [this](u64 id_from, u64 id_to) {
  853. SetKey(S128KeyType::BIS,
  854. GetKey(S128KeyType::BIS, id_from, static_cast<u64>(BISKeyType::Crypto)), id_to,
  855. static_cast<u64>(BISKeyType::Crypto));
  856. SetKey(S128KeyType::BIS,
  857. GetKey(S128KeyType::BIS, id_from, static_cast<u64>(BISKeyType::Tweak)), id_to,
  858. static_cast<u64>(BISKeyType::Tweak));
  859. };
  860. if (has_bis(2) && !has_bis(3)) {
  861. copy_bis(2, 3);
  862. } else if (has_bis(3) && !has_bis(2)) {
  863. copy_bis(3, 2);
  864. }
  865. std::bitset<32> revisions(0xFFFFFFFF);
  866. for (size_t i = 0; i < revisions.size(); ++i) {
  867. if (!HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::Keyblob), i) ||
  868. encrypted_keyblobs[i] == std::array<u8, 0xB0>{}) {
  869. revisions.reset(i);
  870. }
  871. }
  872. if (!revisions.any()) {
  873. return;
  874. }
  875. const auto sbk = GetKey(S128KeyType::SecureBoot);
  876. const auto tsec = GetKey(S128KeyType::TSEC);
  877. for (size_t i = 0; i < revisions.size(); ++i) {
  878. if (!revisions[i]) {
  879. continue;
  880. }
  881. // Derive keyblob key
  882. const auto key = DeriveKeyblobKey(
  883. sbk, tsec, GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::Keyblob), i));
  884. SetKey(S128KeyType::Keyblob, key, i);
  885. // Derive keyblob MAC key
  886. if (!HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyblobMAC))) {
  887. continue;
  888. }
  889. const auto mac_key = DeriveKeyblobMACKey(
  890. key, GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::KeyblobMAC)));
  891. SetKey(S128KeyType::KeyblobMAC, mac_key, i);
  892. Key128 cmac = CalculateCMAC(encrypted_keyblobs[i].data() + 0x10, 0xA0, mac_key);
  893. if (std::memcmp(cmac.data(), encrypted_keyblobs[i].data(), cmac.size()) != 0) {
  894. continue;
  895. }
  896. // Decrypt keyblob
  897. if (keyblobs[i] == std::array<u8, 0x90>{}) {
  898. keyblobs[i] = DecryptKeyblob(encrypted_keyblobs[i], key);
  899. WriteKeyToFile<0x90>(KeyCategory::Console, fmt::format("keyblob_{:02X}", i),
  900. keyblobs[i]);
  901. }
  902. Key128 package1;
  903. std::memcpy(package1.data(), keyblobs[i].data() + 0x80, sizeof(Key128));
  904. SetKey(S128KeyType::Package1, package1, i);
  905. // Derive master key
  906. if (HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::Master))) {
  907. SetKey(S128KeyType::Master,
  908. DeriveMasterKey(keyblobs[i], GetKey(S128KeyType::Source,
  909. static_cast<u64>(SourceKeyType::Master))),
  910. i);
  911. }
  912. }
  913. revisions.set();
  914. for (size_t i = 0; i < revisions.size(); ++i) {
  915. if (!HasKey(S128KeyType::Master, i)) {
  916. revisions.reset(i);
  917. }
  918. }
  919. if (!revisions.any()) {
  920. return;
  921. }
  922. for (size_t i = 0; i < revisions.size(); ++i) {
  923. if (!revisions[i]) {
  924. continue;
  925. }
  926. // Derive general purpose keys
  927. DeriveGeneralPurposeKeys(i);
  928. }
  929. if (HasKey(S128KeyType::Master, 0) &&
  930. HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration)) &&
  931. HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration)) &&
  932. HasKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::HeaderKek)) &&
  933. HasKey(S256KeyType::HeaderSource)) {
  934. const auto header_kek = GenerateKeyEncryptionKey(
  935. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::HeaderKek)),
  936. GetKey(S128KeyType::Master, 0),
  937. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKekGeneration)),
  938. GetKey(S128KeyType::Source, static_cast<u64>(SourceKeyType::AESKeyGeneration)));
  939. SetKey(S128KeyType::HeaderKek, header_kek);
  940. AESCipher<Key128> header_cipher(header_kek, Mode::ECB);
  941. Key256 out = GetKey(S256KeyType::HeaderSource);
  942. header_cipher.Transcode(out.data(), out.size(), out.data(), Op::Decrypt);
  943. SetKey(S256KeyType::Header, out);
  944. }
  945. }
  946. void KeyManager::DeriveETicket(PartitionDataManager& data,
  947. const FileSys::ContentProvider& provider) {
  948. // ETicket keys
  949. const auto es = provider.GetEntry(0x0100000000000033, FileSys::ContentRecordType::Program);
  950. if (es == nullptr) {
  951. return;
  952. }
  953. const auto exefs = es->GetExeFS();
  954. if (exefs == nullptr) {
  955. return;
  956. }
  957. const auto main = exefs->GetFile("main");
  958. if (main == nullptr) {
  959. return;
  960. }
  961. const auto bytes = main->ReadAllBytes();
  962. const auto eticket_kek = FindKeyFromHex16(bytes, eticket_source_hashes[0]);
  963. const auto eticket_kekek = FindKeyFromHex16(bytes, eticket_source_hashes[1]);
  964. const auto seed3 = data.GetRSAKekSeed3();
  965. const auto mask0 = data.GetRSAKekMask0();
  966. if (eticket_kek != Key128{}) {
  967. SetKey(S128KeyType::Source, eticket_kek, static_cast<size_t>(SourceKeyType::ETicketKek));
  968. }
  969. if (eticket_kekek != Key128{}) {
  970. SetKey(S128KeyType::Source, eticket_kekek,
  971. static_cast<size_t>(SourceKeyType::ETicketKekek));
  972. }
  973. if (seed3 != Key128{}) {
  974. SetKey(S128KeyType::RSAKek, seed3, static_cast<size_t>(RSAKekType::Seed3));
  975. }
  976. if (mask0 != Key128{}) {
  977. SetKey(S128KeyType::RSAKek, mask0, static_cast<size_t>(RSAKekType::Mask0));
  978. }
  979. if (eticket_kek == Key128{} || eticket_kekek == Key128{} || seed3 == Key128{} ||
  980. mask0 == Key128{}) {
  981. return;
  982. }
  983. const Key128 rsa_oaep_kek = seed3 ^ mask0;
  984. if (rsa_oaep_kek == Key128{}) {
  985. return;
  986. }
  987. SetKey(S128KeyType::Source, rsa_oaep_kek,
  988. static_cast<u64>(SourceKeyType::RSAOaepKekGeneration));
  989. Key128 temp_kek{};
  990. Key128 temp_kekek{};
  991. Key128 eticket_final{};
  992. // Derive ETicket RSA Kek
  993. AESCipher<Key128> es_master(GetKey(S128KeyType::Master), Mode::ECB);
  994. es_master.Transcode(rsa_oaep_kek.data(), rsa_oaep_kek.size(), temp_kek.data(), Op::Decrypt);
  995. AESCipher<Key128> es_kekek(temp_kek, Mode::ECB);
  996. es_kekek.Transcode(eticket_kekek.data(), eticket_kekek.size(), temp_kekek.data(), Op::Decrypt);
  997. AESCipher<Key128> es_kek(temp_kekek, Mode::ECB);
  998. es_kek.Transcode(eticket_kek.data(), eticket_kek.size(), eticket_final.data(), Op::Decrypt);
  999. if (eticket_final == Key128{}) {
  1000. return;
  1001. }
  1002. SetKey(S128KeyType::ETicketRSAKek, eticket_final);
  1003. // Titlekeys
  1004. data.DecryptProdInfo(GetBISKey(0));
  1005. eticket_extended_kek = data.GetETicketExtendedKek();
  1006. WriteKeyToFile(KeyCategory::Console, "eticket_extended_kek", eticket_extended_kek);
  1007. DeriveETicketRSAKey();
  1008. PopulateTickets();
  1009. }
  1010. void KeyManager::PopulateTickets() {
  1011. if (ticket_databases_loaded) {
  1012. return;
  1013. }
  1014. ticket_databases_loaded = true;
  1015. std::vector<Ticket> tickets;
  1016. const auto system_save_e1_path =
  1017. Common::FS::GetYuzuPath(Common::FS::YuzuPath::NANDDir) / "system/save/80000000000000e1";
  1018. if (Common::FS::Exists(system_save_e1_path)) {
  1019. const Common::FS::IOFile save_e1{system_save_e1_path, Common::FS::FileAccessMode::Read,
  1020. Common::FS::FileType::BinaryFile};
  1021. const auto blob1 = GetTicketblob(save_e1);
  1022. tickets.insert(tickets.end(), blob1.begin(), blob1.end());
  1023. }
  1024. const auto system_save_e2_path =
  1025. Common::FS::GetYuzuPath(Common::FS::YuzuPath::NANDDir) / "system/save/80000000000000e2";
  1026. if (Common::FS::Exists(system_save_e2_path)) {
  1027. const Common::FS::IOFile save_e2{system_save_e2_path, Common::FS::FileAccessMode::Read,
  1028. Common::FS::FileType::BinaryFile};
  1029. const auto blob2 = GetTicketblob(save_e2);
  1030. tickets.insert(tickets.end(), blob2.begin(), blob2.end());
  1031. }
  1032. for (const auto& ticket : tickets) {
  1033. AddTicket(ticket);
  1034. }
  1035. }
  1036. void KeyManager::SynthesizeTickets() {
  1037. for (const auto& key : s128_keys) {
  1038. if (key.first.type != S128KeyType::Titlekey) {
  1039. continue;
  1040. }
  1041. u128 rights_id{key.first.field1, key.first.field2};
  1042. Key128 rights_id_2;
  1043. std::memcpy(rights_id_2.data(), rights_id.data(), rights_id_2.size());
  1044. const auto ticket = Ticket::SynthesizeCommon(key.second, rights_id_2);
  1045. common_tickets.insert_or_assign(rights_id, ticket);
  1046. }
  1047. }
  1048. void KeyManager::SetKeyWrapped(S128KeyType id, Key128 key, u64 field1, u64 field2) {
  1049. if (key == Key128{}) {
  1050. return;
  1051. }
  1052. SetKey(id, key, field1, field2);
  1053. }
  1054. void KeyManager::SetKeyWrapped(S256KeyType id, Key256 key, u64 field1, u64 field2) {
  1055. if (key == Key256{}) {
  1056. return;
  1057. }
  1058. SetKey(id, key, field1, field2);
  1059. }
  1060. void KeyManager::PopulateFromPartitionData(PartitionDataManager& data) {
  1061. if (!BaseDeriveNecessary()) {
  1062. return;
  1063. }
  1064. if (!data.HasBoot0()) {
  1065. return;
  1066. }
  1067. for (size_t i = 0; i < encrypted_keyblobs.size(); ++i) {
  1068. if (encrypted_keyblobs[i] != std::array<u8, 0xB0>{}) {
  1069. continue;
  1070. }
  1071. encrypted_keyblobs[i] = data.GetEncryptedKeyblob(i);
  1072. WriteKeyToFile<0xB0>(KeyCategory::Console, fmt::format("encrypted_keyblob_{:02X}", i),
  1073. encrypted_keyblobs[i]);
  1074. }
  1075. SetKeyWrapped(S128KeyType::Source, data.GetPackage2KeySource(),
  1076. static_cast<u64>(SourceKeyType::Package2));
  1077. SetKeyWrapped(S128KeyType::Source, data.GetAESKekGenerationSource(),
  1078. static_cast<u64>(SourceKeyType::AESKekGeneration));
  1079. SetKeyWrapped(S128KeyType::Source, data.GetTitlekekSource(),
  1080. static_cast<u64>(SourceKeyType::Titlekek));
  1081. SetKeyWrapped(S128KeyType::Source, data.GetMasterKeySource(),
  1082. static_cast<u64>(SourceKeyType::Master));
  1083. SetKeyWrapped(S128KeyType::Source, data.GetKeyblobMACKeySource(),
  1084. static_cast<u64>(SourceKeyType::KeyblobMAC));
  1085. for (size_t i = 0; i < PartitionDataManager::MAX_KEYBLOB_SOURCE_HASH; ++i) {
  1086. SetKeyWrapped(S128KeyType::Source, data.GetKeyblobKeySource(i),
  1087. static_cast<u64>(SourceKeyType::Keyblob), i);
  1088. }
  1089. if (data.HasFuses()) {
  1090. SetKeyWrapped(S128KeyType::SecureBoot, data.GetSecureBootKey());
  1091. }
  1092. DeriveBase();
  1093. Key128 latest_master{};
  1094. for (s8 i = 0x1F; i >= 0; --i) {
  1095. if (GetKey(S128KeyType::Master, static_cast<u8>(i)) != Key128{}) {
  1096. latest_master = GetKey(S128KeyType::Master, static_cast<u8>(i));
  1097. break;
  1098. }
  1099. }
  1100. const auto masters = data.GetTZMasterKeys(latest_master);
  1101. for (size_t i = 0; i < masters.size(); ++i) {
  1102. if (masters[i] != Key128{} && !HasKey(S128KeyType::Master, i)) {
  1103. SetKey(S128KeyType::Master, masters[i], i);
  1104. }
  1105. }
  1106. DeriveBase();
  1107. if (!data.HasPackage2())
  1108. return;
  1109. std::array<Key128, 0x20> package2_keys{};
  1110. for (size_t i = 0; i < package2_keys.size(); ++i) {
  1111. if (HasKey(S128KeyType::Package2, i)) {
  1112. package2_keys[i] = GetKey(S128KeyType::Package2, i);
  1113. }
  1114. }
  1115. data.DecryptPackage2(package2_keys, Package2Type::NormalMain);
  1116. SetKeyWrapped(S128KeyType::Source, data.GetKeyAreaKeyApplicationSource(),
  1117. static_cast<u64>(SourceKeyType::KeyAreaKey),
  1118. static_cast<u64>(KeyAreaKeyType::Application));
  1119. SetKeyWrapped(S128KeyType::Source, data.GetKeyAreaKeyOceanSource(),
  1120. static_cast<u64>(SourceKeyType::KeyAreaKey),
  1121. static_cast<u64>(KeyAreaKeyType::Ocean));
  1122. SetKeyWrapped(S128KeyType::Source, data.GetKeyAreaKeySystemSource(),
  1123. static_cast<u64>(SourceKeyType::KeyAreaKey),
  1124. static_cast<u64>(KeyAreaKeyType::System));
  1125. SetKeyWrapped(S128KeyType::Source, data.GetSDKekSource(),
  1126. static_cast<u64>(SourceKeyType::SDKek));
  1127. SetKeyWrapped(S256KeyType::SDKeySource, data.GetSDSaveKeySource(),
  1128. static_cast<u64>(SDKeyType::Save));
  1129. SetKeyWrapped(S256KeyType::SDKeySource, data.GetSDNCAKeySource(),
  1130. static_cast<u64>(SDKeyType::NCA));
  1131. SetKeyWrapped(S128KeyType::Source, data.GetHeaderKekSource(),
  1132. static_cast<u64>(SourceKeyType::HeaderKek));
  1133. SetKeyWrapped(S256KeyType::HeaderSource, data.GetHeaderKeySource());
  1134. SetKeyWrapped(S128KeyType::Source, data.GetAESKeyGenerationSource(),
  1135. static_cast<u64>(SourceKeyType::AESKeyGeneration));
  1136. DeriveBase();
  1137. }
  1138. const std::map<u128, Ticket>& KeyManager::GetCommonTickets() const {
  1139. return common_tickets;
  1140. }
  1141. const std::map<u128, Ticket>& KeyManager::GetPersonalizedTickets() const {
  1142. return personal_tickets;
  1143. }
  1144. bool KeyManager::AddTicket(const Ticket& ticket) {
  1145. if (!ticket.IsValid()) {
  1146. LOG_WARNING(Crypto, "Attempted to add invalid ticket.");
  1147. return false;
  1148. }
  1149. const auto& rid = ticket.GetData().rights_id;
  1150. u128 rights_id;
  1151. std::memcpy(rights_id.data(), rid.data(), rid.size());
  1152. if (ticket.GetData().type == Core::Crypto::TitleKeyType::Common) {
  1153. common_tickets[rights_id] = ticket;
  1154. } else {
  1155. personal_tickets[rights_id] = ticket;
  1156. }
  1157. if (HasKey(S128KeyType::Titlekey, rights_id[1], rights_id[0])) {
  1158. LOG_DEBUG(Crypto,
  1159. "Skipping parsing title key from ticket for known rights ID {:016X}{:016X}.",
  1160. rights_id[1], rights_id[0]);
  1161. return true;
  1162. }
  1163. const auto key = ParseTicketTitleKey(ticket);
  1164. if (!key) {
  1165. return false;
  1166. }
  1167. SetKey(S128KeyType::Titlekey, key.value(), rights_id[1], rights_id[0]);
  1168. return true;
  1169. }
  1170. } // namespace Core::Crypto