/* * Copyright (c) Atmosphère-NX * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU General Public License, * version 2, as published by the Free Software Foundation. * * This program is distributed in the hope it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include "hactool_options.hpp" namespace ams::fssrv::impl { const char *GetWorkingDirectoryPath(); } namespace ams::hactool { namespace { bool CreateFilePath(const char **out, const char *argument) { /* Allocate buffer for path. */ const auto dst_size = std::strlen(argument) + fs::EntryNameLengthMax + 1; char *dst = static_cast(std::malloc(dst_size)); ON_SCOPE_EXIT { std::free(dst); }; if (dst == nullptr) { printf("Error: failed to allocate memory to hold path (%s)\n", argument); return false; } /* Print to path. */ if (fs::IsPathAbsolute(argument)) { util::SNPrintf(dst, dst_size, "%s", argument); } else { util::SNPrintf(dst, dst_size, "%s%s", fssrv::impl::GetWorkingDirectoryPath(), argument); } /* Normalize path. */ char *normalized = static_cast(std::malloc(dst_size)); if (normalized == nullptr) { printf("Error: failed to allocate memory to hold path (%s)\n", argument); return false; } /* Check that the path is valid. */ fs::PathFlags flags; flags.AllowWindowsPath(); if (const auto res = fs::PathFormatter::Normalize(normalized, dst_size, dst, std::strlen(dst) + 1, flags); R_FAILED(res)) { printf("Error: failed to normalize path (%s): 2%03d-%04d\n", dst, res.GetModule(), res.GetDescription()); return false; } /* Set output. */ *out = normalized; return true; } bool ParseIntegerArgument(int *out, const char *argument) { char *parse_end = nullptr; const auto val = std::strtol(argument, std::addressof(parse_end), 0); if (parse_end != nullptr && parse_end != argument) { *out = val; return true; } else { return false; } } using OptionHandlerFunction = util::IFunction; struct OptionHandler { char short_name; bool takes_arg; const char *name; const char *desc; u8 handler_storage[0x20]; const OptionHandlerFunction &handler; OptionHandler(const char *n, const char *d, char sn, bool ta, auto f) : short_name(sn), takes_arg(ta), name(n), desc(d), handler(*reinterpret_cast(handler_storage)) { using FunctionType = decltype(OptionHandlerFunction::Make(f)); static_assert(sizeof(this->handler_storage) >= sizeof(FunctionType)); std::construct_at(reinterpret_cast(this->handler_storage), OptionHandlerFunction::Make(f)); } }; template concept NotCharacterOverloadHelper = !std::convertible_to; OptionHandler MakeOptionHandler(const char *s, const char *d, char sn, auto f) { if constexpr (requires { f(std::declval(), std::declval()); }) { if constexpr (std::convertible_to(), std::declval())), bool>) { return OptionHandler(s, d, sn, true, f); } else { return OptionHandler(s, d, sn, true, [&] (Options &options, const char *arg) -> bool { f(options, arg); return true; }); } } else { if constexpr (std::convertible_to())), bool>) { return OptionHandler(s, d, sn, false, [&] (Options &options, const char *) -> bool { return f(options); }); } else { return OptionHandler(s, d, sn, false, [&] (Options &options, const char *) -> bool { f(options); return true; }); } } } OptionHandler MakeOptionHandler(const char *s, const char *d, NotCharacterOverloadHelper auto f) { return MakeOptionHandler(s, d, 0, f); } const OptionHandler OptionHandlers[] = { MakeOptionHandler("intype", "Specify input file type [nca, xci, pfs or pfs0 or nsp, appfs, romfs, npdm]", 't', [] (Options &options, const char *arg) { if (std::strcmp(arg, "npdm") == 0) { options.file_type = FileType::Npdm; } else if (std::strcmp(arg, "nca") == 0) { options.file_type = FileType::Nca; } else if (std::strcmp(arg, "xci") == 0) { options.file_type = FileType::Xci; } else if (std::strcmp(arg, "appfs") == 0) { options.file_type = FileType::AppFs; } else if (std::strcmp(arg, "romfs") == 0) { options.file_type = FileType::Romfs; } else if (std::strcmp(arg, "pfs") == 0 || std::strcmp(arg, "pfs0") == 0 || std::strcmp(arg, "nsp") == 0) { options.file_type = FileType::Pfs; } else { return false; } return true; }), MakeOptionHandler("raw", "Keep raw data, don't unpack.", 'r', [] (Options &options) { options.raw = true; }), MakeOptionHandler("verify", "Verify hashes and signatures.", 'y', [] (Options &options) { options.verify = true; }), MakeOptionHandler("dev", "Decrypt with development keys instead of retail.", 'd', [] (Options &options) { options.dev = true; }), MakeOptionHandler("enablehash", "Enable hash enforcement.", 'h', [] (Options &options) { options.enable_hash = true; }), MakeOptionHandler("disablekeywarns", "Disable warning output when loading external keys.", [] (Options &options) { options.disable_key_warns = true; }), MakeOptionHandler("keyset", "Load keys from an external file.", 'k', [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.key_file_path), arg); }), MakeOptionHandler("titlekeys", "Load title keys from an external file.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.titlekey_path), arg); }), MakeOptionHandler("consolekeys","Load console-specific keys from an external file.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.consolekey_path), arg); }), MakeOptionHandler("outdir", "Specify output directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.default_out_dir_path), arg); }), MakeOptionHandler("outfile", "Specify output file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.default_out_file_path), arg); }), MakeOptionHandler("basenca", "Specify a base nca to use when processing.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.base_nca_path), arg); }), MakeOptionHandler("basexci", "Specify a base xci to use when processing.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.base_xci_path), arg); }), MakeOptionHandler("basepfs", "Specify a base pfs to use when processing.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.base_pfs_path), arg); }), MakeOptionHandler("basensp", "Specify a base nsp to use when processing. Synonym for basepfs.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.base_pfs_path), arg); }), MakeOptionHandler("baseappfs", "Specify a base appfs to use when processing.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.base_appfs_path), arg); }), MakeOptionHandler("appindex", "[appfs] Specify a preferred application index.", [] (Options &options, const char *arg) { return ParseIntegerArgument(std::addressof(options.preferred_app_index), arg); }), MakeOptionHandler("programindex", "[appfs] Specify a preferred program index.", [] (Options &options, const char *arg) { return ParseIntegerArgument(std::addressof(options.preferred_program_index), arg); }), MakeOptionHandler("appversion", "[appfs] Specify a preferred application version.", [] (Options &options, const char *arg) { return ParseIntegerArgument(std::addressof(options.preferred_version), arg); }), MakeOptionHandler("header", "[nca] Specify header file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.header_out_path), arg); }), MakeOptionHandler("plaintext", "[nca] Specify plaintext output path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.plaintext_out_path), arg); }), MakeOptionHandler("exefs", "[nca] Specify exefs file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.exefs_out_file_path), arg); }), MakeOptionHandler("romfs", "[nca] Specify romfs file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.romfs_out_file_path), arg); }), MakeOptionHandler("exefsdir", "[nca] Specify exefs directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.exefs_out_dir_path), arg); }), MakeOptionHandler("romfsdir", "[nca] Specify romfs file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.romfs_out_dir_path), arg); }), MakeOptionHandler("listromfs", "[nca/romfs] List files in romfs.", [] (Options &options) { options.list_romfs = true; }), MakeOptionHandler("section0", "[nca] Specify Section 0 file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_file_paths[0]), arg); }), MakeOptionHandler("section1", "[nca] Specify Section 1 file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_file_paths[1]), arg); }), MakeOptionHandler("section2", "[nca] Specify Section 2 file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_file_paths[2]), arg); }), MakeOptionHandler("section3", "[nca] Specify Section 3 file path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_file_paths[3]), arg); }), MakeOptionHandler("section0dir", "[nca] Specify Section 0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_dir_paths[0]), arg); }), MakeOptionHandler("section1dir", "[nca] Specify Section 1 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_dir_paths[1]), arg); }), MakeOptionHandler("section2dir", "[nca] Specify Section 2 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_dir_paths[2]), arg); }), MakeOptionHandler("section3dir", "[nca] Specify Section 3 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.section_out_dir_paths[3]), arg); }), MakeOptionHandler("onlyupdated", "[nca] Ignore non-updated files in update partitions.", [] (Options &options) { options.only_updated = true; }), MakeOptionHandler("updatedsince", "[nca] Ignore files updated prior to a specific update generation.", [] (Options &options, const char *arg) { return ParseIntegerArgument(std::addressof(options.updated_generation), arg); }), MakeOptionHandler("json", "[nca/exefs/npdm/kip] Specify file path for saving JSON representation of program permissions.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.json_out_file_path), arg); }), MakeOptionHandler("rootdir", "[xci] Specify xci root hfs0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.root_partition_out_dir), arg); }), MakeOptionHandler("securedir", "[xci] Specify xci secure hfs0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.secure_partition_out_dir), arg); }), MakeOptionHandler("normaldir", "[xci] Specify xci normal hfs0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.normal_partition_out_dir), arg); }), MakeOptionHandler("updatedir", "[xci] Specify xci update hfs0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.update_partition_out_dir), arg); }), MakeOptionHandler("logodir", "[xci] Specify xci logo hfs0 directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.logo_partition_out_dir), arg); }), MakeOptionHandler("listupdate", "[xci] List update details.", [] (Options &options) { options.list_update = true; }), MakeOptionHandler("pfsdir", "[pfs] Specify pfs directory path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.nsp_out_dir_path), arg); }), MakeOptionHandler("nspdir", "[pfs] Specify nsp directory path. Synonym for pfsdir.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.nsp_out_dir_path), arg); }), MakeOptionHandler("ciphertext", "[unused] Specify ciphertext output path.", [] (Options &options, const char *arg) { return CreateFilePath(std::addressof(options.ciphertext_out_path), arg); }), }; } void PrintUsage() { printf("hac2l (c) SciresM/Atmosphere-NX\n"); printf("Built: %s %s\n", __TIME__, __DATE__); printf("\n"); printf("Usage: hac2l [options...] path\n"); printf("Options:\n"); for (const auto &o : OptionHandlers) { printf(" "); size_t len = 2; if (o.short_name) { printf("-%c, ", o.short_name); len += 4; } if (o.takes_arg) { printf("--%s=* ", o.name); len += 5 + std::strlen(o.name); } else { printf("--%s ", o.name); len += 3 + std::strlen(o.name); } { char pad[0x20] = {}; memset(pad, ' ', 0x18 - len); printf("%s", pad); } printf("%s\n", o.desc); } } const char *GetKeysFilePath(const char *fn) { /* Declare path buffers. */ fs::Path path; /* Try to find an environment variable. */ char *home = getenv("HOME"); if (home == nullptr) { home = getenv("USERPROFILE"); } if (home != nullptr) { if (!fs::IsPathAbsolute(home)) { printf("Warning: home path (%s) is not absolute, ignoring.\n", home); return nullptr; } if (const auto res = path.Initialize(home); R_FAILED(res)) { printf("Warning: Failed to initialize home path (%s): 2%03d-%04d\n", home, res.GetModule(), res.GetDescription()); return nullptr; } /* Normalize the path. */ fs::PathFlags flags; flags.AllowWindowsPath(); if (const auto res = path.Normalize(flags); R_FAILED(res)) { printf("Warning: Failed to normalize home path (%s): 2%03d-%04d\n", home, res.GetModule(), res.GetDescription()); return nullptr; } /* Append .switch. */ if (const auto res = path.AppendChild(".switch"); R_FAILED(res)) { printf("Warning: failed to append .switch to path (%s): 2%03d-%04d\n", path.GetString(), res.GetModule(), res.GetDescription()); return nullptr; } /* Append fn. */ if (const auto res = path.AppendChild(fn); R_FAILED(res)) { printf("Warning: failed to append %s to path (%s): 2%03d-%04d\n", fn, path.GetString(), res.GetModule(), res.GetDescription()); return nullptr; } } /* If the path isn't empty, check if the file exists. */ if (!path.IsEmpty()) { bool has_file = false; if (const auto res = fs::HasFile(std::addressof(has_file), path.GetString()); R_FAILED(res)) { printf("Warning: failed to check if path exists (%s): 2%03d-%04d\n", path.GetString(), res.GetModule(), res.GetDescription()); } else if (has_file) { return ::strdup(path.GetString()); } } /* We couldn't use {home}/.switch/{fn}. Try using xdg home. */ char *xdg = getenv("XDG_CONFIG_HOME"); if (xdg != nullptr) { if (!fs::IsPathAbsolute(xdg)) { printf("Warning: xdg path (%s) is not absolute, ignoring.\n", xdg); return nullptr; } if (const auto res = path.Initialize(xdg); R_FAILED(res)) { printf("Warning: Failed to initialize xdg path (%s): 2%03d-%04d\n", xdg, res.GetModule(), res.GetDescription()); return nullptr; } /* Normalize the path. */ fs::PathFlags flags; flags.AllowWindowsPath(); if (const auto res = path.Normalize(flags); R_FAILED(res)) { printf("Warning: Failed to normalize xdg path (%s): 2%03d-%04d\n", xdg, res.GetModule(), res.GetDescription()); return nullptr; } } else if (!path.IsEmpty()) { /* Path is already initialized with /.switch/, try /.config/switch/. */ R_ABORT_UNLESS(path.RemoveChild()); R_ABORT_UNLESS(path.RemoveChild()); /* Append .config. */ if (const auto res = path.AppendChild(".config"); R_FAILED(res)) { printf("Warning: failed to append .config to path (%s): 2%03d-%04d\n", path.GetString(), res.GetModule(), res.GetDescription()); return nullptr; } } /* If the path isn't empty, format the remaining path segments and check if the file exists. */ if (!path.IsEmpty()) { /* Append switch. */ if (const auto res = path.AppendChild("switch"); R_FAILED(res)) { printf("Warning: failed to append switch to path (%s): 2%03d-%04d\n", path.GetString(), res.GetModule(), res.GetDescription()); return nullptr; } /* Append fn. */ if (const auto res = path.AppendChild(fn); R_FAILED(res)) { printf("Warning: failed to append %s to path (%s): 2%03d-%04d\n", fn, path.GetString(), res.GetModule(), res.GetDescription()); return nullptr; } bool has_file = false; if (const auto res = fs::HasFile(std::addressof(has_file), path.GetString()); R_FAILED(res)) { printf("Warning: failed to check if path exists (%s): 2%03d-%04d\n", path.GetString(), res.GetModule(), res.GetDescription()); } else if (has_file) { return ::strdup(path.GetString()); } } /* We couldn't find a path. */ return nullptr; } Options ParseOptionsFromCommandLine() { /* Create default options. */ Options options{}; /* Get argc/argv. */ const auto argc = os::GetHostArgc(); const auto argv = os::GetHostArgv(); /* Parse all arguments. */ for (auto i = 1; i < argc; ++i) { /* Get the current argument length. */ const auto *arg = argv[i]; const auto arg_len = std::strlen(arg); bool success = false; if (arg[0] == '-' && arg[1] != '-') { for (const auto &o : OptionHandlers) { if (arg[1] != o.short_name) { continue; } if (o.takes_arg) { if (arg_len > 2) { success = o.handler(options, arg + 2); } else { ++i; success = i < argc && o.handler(options, argv[i]); } } else { success = o.handler(options, nullptr); } break; } } else if (arg[0] == '-' && arg[1] == '-') { for (const auto &o : OptionHandlers) { const auto o_len = std::strlen(o.name); if (arg_len < o_len + 2 || std::memcmp(arg + 2, o.name, o_len) != 0 || (arg[2 + o_len] != 0 && arg[2 + o_len] != '=')) { continue; } if (o.takes_arg) { if (arg[2 + o_len] == '=') { success = o.handler(options, arg + 2 + o_len + 1); } else { ++i; success = i < argc && o.handler(options, argv[i]); } } else { success = o.handler(options, nullptr); } break; } } else if (options.in_file_path == nullptr) { success = CreateFilePath(std::addressof(options.in_file_path), arg); } if (!success) { fprintf(stderr, "[Warning]: An error occurred while parsing option (%s)\n", arg); return options; } } /* Try to ensure key files are valid. */ if (options.key_file_path == nullptr) { options.key_file_path = GetKeysFilePath(options.dev ? "dev.keys" : "prod.keys"); } if (options.titlekey_path == nullptr) { options.titlekey_path = GetKeysFilePath("title.keys"); } if (options.consolekey_path == nullptr) { options.consolekey_path = GetKeysFilePath("console.keys"); } /* If we have an input file, we're valid. */ options.valid = options.in_file_path != nullptr; return options; } }