#include #include #include #include "pki.h" #include "aes.h" #include "extkeys.h" /** * Reads a line from file f and parses out the key and value from it. * The format of a line must match /^ *[A-Za-z0-9_] *[,=] *.+$/. * If a line ends in \r, the final \r is stripped. * The input file is assumed to have been opened with the 'b' flag. * The input file is assumed to contain only ASCII. * * A line cannot exceed 512 bytes in length. * Lines that are excessively long will be silently truncated. * * On success, *key and *value will be set to point to the key and value in * the input line, respectively. * *key and *value may also be NULL in case of empty lines. * On failure, *key and *value will be set to NULL. * End of file is considered failure. * * Because *key and *value will point to a static buffer, their contents must be * copied before calling this function again. * For the same reason, this function is not thread-safe. * * The key will be converted to lowercase. * An empty key is considered a parse error, but an empty value is returned as * success. * * This function assumes that the file can be trusted not to contain any NUL in * the contents. * * Whitespace (' ', ASCII 0x20, as well as '\t', ASCII 0x09) at the beginning of * the line, at the end of the line as well as around = (or ,) will be ignored. * * @param f the file to read * @param key pointer to change to point to the key * @param value pointer to change to point to the value * @return 0 on success, * 1 on end of file, * -1 on parse error (line too long, line malformed) * -2 on I/O error */ static int get_kv(FILE *f, char **key, char **value) { #define SKIP_SPACE(p) do {\ for (; *p == ' ' || *p == '\t'; ++p)\ ;\ } while(0); static char line[1024]; char *k, *v, *p, *end; *key = *value = NULL; errno = 0; if (fgets(line, (int)sizeof(line), f) == NULL) { if (feof(f)) return 1; else return -2; } if (errno != 0) return -2; if (*line == '\n' || *line == '\r' || *line == '\0') return 0; /* Not finding \r or \n is not a problem. * The line might just be exactly 512 characters long, we have no way to * tell. * Additionally, it's possible that the last line of a file is not actually * a line (i.e., does not end in '\n'); we do want to handle those. */ if ((p = strchr(line, '\r')) != NULL || (p = strchr(line, '\n')) != NULL) { end = p; *p = '\0'; } else { end = line + strlen(line) + 1; } p = line; SKIP_SPACE(p); k = p; /* Validate key and convert to lower case. */ for (; *p != ' ' && *p != ',' && *p != '\t' && *p != '='; ++p) { if (*p == '\0') return -1; if (*p >= 'A' && *p <= 'Z') { *p = 'a' + (*p - 'A'); continue; } if (*p != '_' && (*p < '0' || *p > '9') && (*p < 'a' || *p > 'z')) { return -1; } } /* Bail if the final ++p put us at the end of string */ if (*p == '\0') return -1; /* We should be at the end of key now and either whitespace or [,=] * follows. */ if (*p == '=' || *p == ',') { *p++ = '\0'; } else { *p++ = '\0'; SKIP_SPACE(p); if (*p != '=' && *p != ',') return -1; *p++ = '\0'; } /* Empty key is an error. */ if (*k == '\0') return -1; SKIP_SPACE(p); v = p; /* Skip trailing whitespace */ for (p = end - 1; *p == '\t' || *p == ' '; --p) ; *(p + 1) = '\0'; *key = k; *value = v; return 0; #undef SKIP_SPACE } static int ishex(char c) { if ('a' <= c && c <= 'f') return 1; if ('A' <= c && c <= 'F') return 1; if ('0' <= c && c <= '9') return 1; return 0; } static char hextoi(char c) { if ('a' <= c && c <= 'f') return c - 'a' + 0xA; if ('A' <= c && c <= 'F') return c - 'A' + 0xA; if ('0' <= c && c <= '9') return c - '0'; return 0; } void parse_hex_key(unsigned char *key, const char *hex, unsigned int len) { if (strlen(hex) != 2 * len) { fprintf(stderr, "Key (%s) must be %"PRIu32" hex digits!\n", hex, 2 * len); exit(EXIT_FAILURE); } for (unsigned int i = 0; i < 2 * len; i++) { if (!ishex(hex[i])) { fprintf(stderr, "Key (%s) must be %"PRIu32" hex digits!\n", hex, 2 * len); exit(EXIT_FAILURE); } } memset(key, 0, len); for (unsigned int i = 0; i < 2 * len; i++) { char val = hextoi(hex[i]); if ((i & 1) == 0) { val <<= 4; } key[i >> 1] |= val; } } void extkeys_parse_titlekeys(hactool_settings_t *settings, FILE *f) { char *key, *value; int ret; while ((ret = get_kv(f, &key, &value)) != 1 && ret != -2) { if (ret == 0) { if (key == NULL || value == NULL) { continue; } unsigned char rights_id[0x10]; unsigned char titlekey[0x10]; bool should_ignore_key = false; if (strlen(key) != 0x20) { should_ignore_key = true; } else { for (unsigned int i = 0; i < 0x20; i++) { if (!ishex(key[i])) { should_ignore_key = true; } } } if (should_ignore_key) { if (!settings->skip_key_warnings) { fprintf(stderr, "[WARN]: Invalid title.keys content: \"%s\", (value \"%s\")\n", key, value); } } else { parse_hex_key(rights_id, key, sizeof(rights_id)); parse_hex_key(titlekey, value, sizeof(titlekey)); settings_add_titlekey(settings, rights_id, titlekey); } } } } void extkeys_initialize_settings(hactool_settings_t *settings, FILE *f) { char *key, *value; int ret; nca_keyset_t *keyset = &settings->keyset; while ((ret = get_kv(f, &key, &value)) != 1 && ret != -2) { if (ret == 0) { if (key == NULL || value == NULL) { continue; } int matched_key = 0; if (strcmp(key, "aes_kek_generation_source") == 0) { parse_hex_key(keyset->aes_kek_generation_source, value, sizeof(keyset->aes_kek_generation_source)); matched_key = 1; } else if (strcmp(key, "aes_key_generation_source") == 0) { parse_hex_key(keyset->aes_key_generation_source, value, sizeof(keyset->aes_key_generation_source)); matched_key = 1; } else if (strcmp(key, "key_area_key_application_source") == 0) { parse_hex_key(keyset->key_area_key_application_source, value, sizeof(keyset->key_area_key_application_source)); matched_key = 1; } else if (strcmp(key, "key_area_key_ocean_source") == 0) { parse_hex_key(keyset->key_area_key_ocean_source, value, sizeof(keyset->key_area_key_ocean_source)); matched_key = 1; } else if (strcmp(key, "key_area_key_system_source") == 0) { parse_hex_key(keyset->key_area_key_system_source, value, sizeof(keyset->key_area_key_system_source)); matched_key = 1; } else if (strcmp(key, "titlekek_source") == 0) { parse_hex_key(keyset->titlekek_source, value, sizeof(keyset->titlekek_source)); matched_key = 1; } else if (strcmp(key, "header_kek_source") == 0) { parse_hex_key(keyset->header_kek_source, value, sizeof(keyset->header_kek_source)); matched_key = 1; } else if (strcmp(key, "header_key_source") == 0) { parse_hex_key(keyset->header_key_source, value, sizeof(keyset->header_key_source)); matched_key = 1; } else if (strcmp(key, "header_key") == 0) { parse_hex_key(keyset->header_key, value, sizeof(keyset->header_key)); matched_key = 1; } else if (strcmp(key, "package2_key_source") == 0) { parse_hex_key(keyset->package2_key_source, value, sizeof(keyset->package2_key_source)); matched_key = 1; } else if (strcmp(key, "per_console_key_source") == 0) { parse_hex_key(keyset->per_console_key_source, value, sizeof(keyset->per_console_key_source)); matched_key = 1; } else if (strcmp(key, "xci_header_key") == 0) { parse_hex_key(keyset->xci_header_key, value, sizeof(keyset->xci_header_key)); matched_key = 1; } else if (strcmp(key, "sd_card_kek_source") == 0) { parse_hex_key(keyset->sd_card_kek_source, value, sizeof(keyset->sd_card_kek_source)); matched_key = 1; } else if (strcmp(key, "sd_card_nca_key_source") == 0) { parse_hex_key(keyset->sd_card_key_sources[1], value, sizeof(keyset->sd_card_key_sources[1])); matched_key = 1; } else if (strcmp(key, "sd_card_save_key_source") == 0) { parse_hex_key(keyset->sd_card_key_sources[0], value, sizeof(keyset->sd_card_key_sources[0])); matched_key = 1; } else if (strcmp(key, "save_mac_kek_source") == 0) { parse_hex_key(keyset->save_mac_kek_source, value, sizeof(keyset->save_mac_kek_source)); matched_key = 1; } else if (strcmp(key, "save_mac_key_source") == 0) { parse_hex_key(keyset->save_mac_key_source, value, sizeof(keyset->save_mac_key_source)); matched_key = 1; } else if (strcmp(key, "master_key_source") == 0) { parse_hex_key(keyset->master_key_source, value, sizeof(keyset->master_key_source)); matched_key = 1; } else if (strcmp(key, "keyblob_mac_key_source") == 0) { parse_hex_key(keyset->keyblob_mac_key_source, value, sizeof(keyset->keyblob_mac_key_source)); matched_key = 1; } else if (strcmp(key, "secure_boot_key") == 0) { parse_hex_key(keyset->secure_boot_key, value, sizeof(keyset->secure_boot_key)); matched_key = 1; } else if (strcmp(key, "tsec_key") == 0) { parse_hex_key(keyset->tsec_key, value, sizeof(keyset->tsec_key)); matched_key = 1; } else if (strcmp(key, "mariko_kek") == 0) { parse_hex_key(keyset->mariko_kek, value, sizeof(keyset->mariko_kek)); matched_key = 1; } else if (strcmp(key, "mariko_bek") == 0) { parse_hex_key(keyset->mariko_bek, value, sizeof(keyset->mariko_bek)); matched_key = 1; } else if (strcmp(key, "tsec_root_kek") == 0) { parse_hex_key(keyset->tsec_root_kek, value, sizeof(keyset->tsec_root_kek)); matched_key = 1; } else if (strcmp(key, "package1_mac_kek") == 0) { parse_hex_key(keyset->package1_mac_kek, value, sizeof(keyset->package1_mac_kek)); matched_key = 1; } else if (strcmp(key, "package1_kek") == 0) { parse_hex_key(keyset->package1_kek, value, sizeof(keyset->package1_kek)); matched_key = 1; } else if (strcmp(key, "beta_nca0_exponent") == 0) { unsigned char exponent[0x100] = {0}; parse_hex_key(exponent, value, sizeof(exponent)); pki_set_beta_nca0_exponent(exponent); matched_key = 1; } else if (strcmp(key, "xci_t1_titlekey_kek_00") == 0) { matched_key = 1; } else { char test_name[0x100] = {0}; for (unsigned int i = 0; i < 0x6 && !matched_key; i++) { snprintf(test_name, sizeof(test_name), "keyblob_key_source_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->keyblob_key_sources[i], value, sizeof(keyset->keyblob_key_sources[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "keyblob_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->keyblob_keys[i], value, sizeof(keyset->keyblob_keys[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "keyblob_mac_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->keyblob_mac_keys[i], value, sizeof(keyset->keyblob_mac_keys[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "encrypted_keyblob_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->encrypted_keyblobs[i], value, sizeof(keyset->encrypted_keyblobs[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "mariko_master_kek_source_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->mariko_master_kek_sources[i], value, sizeof(keyset->mariko_master_kek_sources[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "keyblob_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->keyblobs[i], value, sizeof(keyset->keyblobs[i])); matched_key = 1; break; } } for (unsigned int i = 0x6; i < 0x20 && !matched_key; i++) { snprintf(test_name, sizeof(test_name), "tsec_auth_signature_%02"PRIx32, i - 6); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->tsec_auth_signatures[i - 6], value, sizeof(keyset->tsec_auth_signatures[i - 6])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "tsec_root_key_%02"PRIx32, i - 6); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->tsec_root_keys[i - 6], value, sizeof(keyset->tsec_root_keys[i - 6])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "master_kek_source_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->master_kek_sources[i], value, sizeof(keyset->master_kek_sources[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "mariko_master_kek_source_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->mariko_master_kek_sources[i], value, sizeof(keyset->mariko_master_kek_sources[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "package1_mac_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->package1_mac_keys[i], value, sizeof(keyset->package1_mac_keys[i])); matched_key = 1; break; } } for (unsigned int i = 0; i < 0xC && !matched_key; i++) { snprintf(test_name, sizeof(test_name), "mariko_aes_class_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->mariko_aes_class_keys[i], value, sizeof(keyset->mariko_aes_class_keys[i])); matched_key = 1; break; } } for (unsigned int i = 0; i < 0x20 && !matched_key; i++) { snprintf(test_name, sizeof(test_name), "master_kek_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->master_keks[i], value, sizeof(keyset->master_keks[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "master_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->master_keys[i], value, sizeof(keyset->master_keys[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "package1_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->package1_keys[i], value, sizeof(keyset->package1_keys[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "package2_key_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->package2_keys[i], value, sizeof(keyset->package2_keys[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "titlekek_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->titlekeks[i], value, sizeof(keyset->titlekeks[i])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "key_area_key_application_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->key_area_keys[i][0], value, sizeof(keyset->key_area_keys[i][0])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "key_area_key_ocean_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->key_area_keys[i][1], value, sizeof(keyset->key_area_keys[i][1])); matched_key = 1; break; } snprintf(test_name, sizeof(test_name), "key_area_key_system_%02"PRIx32, i); if (strcmp(key, test_name) == 0) { parse_hex_key(keyset->key_area_keys[i][2], value, sizeof(keyset->key_area_keys[i][2])); matched_key = 1; break; } } } if (!matched_key && !settings->skip_key_warnings) { fprintf(stderr, "[WARN]: Failed to match key \"%s\", (value \"%s\")\n", key, value); } } } } int settings_has_titlekey(hactool_settings_t *settings, const unsigned char *rights_id) { return settings_get_titlekey(settings, rights_id) != NULL; } void settings_add_titlekey(hactool_settings_t *settings, const unsigned char *rights_id, const unsigned char *titlekey) { if (settings_has_titlekey(settings, rights_id)) { fprintf(stderr, "Error: Rights ID "); for (unsigned int i = 0; i < 0x10; i++) { fprintf(stderr, "%02X", rights_id[i]); } fprintf(stderr, " already has a corresponding titlekey!\n"); exit(EXIT_FAILURE); } /* Ensure enough space for keys. */ if (settings->known_titlekeys.count == 0) { settings->known_titlekeys.titlekeys = malloc(1 * sizeof(titlekey_entry_t)); } else if ((settings->known_titlekeys.count & (settings->known_titlekeys.count + 1)) == 0) { settings->known_titlekeys.titlekeys = realloc(settings->known_titlekeys.titlekeys, 2 * (settings->known_titlekeys.count + 1) * sizeof(titlekey_entry_t)); } if (settings->known_titlekeys.titlekeys == NULL) { fprintf(stderr, "Failed to allocate titlekey list!\n"); exit(EXIT_FAILURE); } titlekey_entry_t *new_key = &settings->known_titlekeys.titlekeys[settings->known_titlekeys.count++]; memcpy(new_key->rights_id, rights_id, 0x10); memcpy(new_key->titlekey, titlekey, 0x10); } titlekey_entry_t *settings_get_titlekey(hactool_settings_t *settings, const unsigned char *rights_id) { for (unsigned int i = 0; i < settings->known_titlekeys.count; i++) { if (memcmp(settings->known_titlekeys.titlekeys[i].rights_id, rights_id, 0x10) == 0) { return &settings->known_titlekeys.titlekeys[i]; } } return NULL; }