Files
vardkey/static/health-check.js
T

599 lines
19 KiB
JavaScript

"use strict";
const form = document.querySelector("#health-check-form");
const keySelect = document.querySelector("#key-select");
const keyCheck = document.querySelector("#key-check");
const softwareGrid = document.querySelector("#software-section .field-grid");
const walletSoftwareSelect = document.querySelector("#wallet-software");
const softwareVersionInput = document.querySelector("#software-version");
const softwareHelp = document.querySelector("#software-help");
const toolChecks = document.querySelector("#tool-checks");
const securityChecks = document.querySelector("#security-checks");
const nextCheckPreview = document.querySelector("#next-check-preview");
const reviewPanel = document.querySelector("#review-panel");
const reviewSummary = document.querySelector("#review-summary");
const saveButton = document.querySelector("#save-check");
const saveStatus = document.querySelector("#save-status");
const CLOUD_KEY_NUMBER = 3;
const KEY_PRODUCTS = { 1: "SeedSigner", 2: "Blockstream Jade", 3: "Nunchuk" };
const WALLET_SOFTWARE = ["Sparrow Wallet", "Nunchuk"];
const SECURITY_STATUSES = ["SECURE", "PATCHED", "VULNERABLE", "COMPROMISED"];
// A status that still needs follow-up is never hidden (section 20).
const UNRESOLVED_STATUSES = ["VULNERABLE", "COMPROMISED"];
const DEFAULT_SECURITY_STATUS = "SECURE";
const generalStatuses = [
["IKKJE_VURDERT", "Not assessed"],
["OK", "OK"],
["PROBLEM", "Problem"],
];
const verificationStatuses = [
["OK", "OK"],
["PROBLEM", "Problem"],
];
const booleanOptions = [["", "Not assessed"], ["1", "Yes"], ["0", "No"]];
let keyProfiles = [];
let previousValues = { keys: [], security: {} };
let carriedSecurity = [];
function emptyState(text) {
const message = document.createElement("p");
message.className = "empty-state";
message.textContent = text;
return message;
}
function makeField(labelText, name, control) {
const label = document.createElement("label");
label.className = "field";
const labelSpan = document.createElement("span");
labelSpan.textContent = labelText;
control.name = name;
label.append(labelSpan, control);
return label;
}
function makeSelect(options, name, placeholder = "") {
const select = document.createElement("select");
select.name = name;
if (placeholder) {
const option = document.createElement("option");
option.value = "";
option.textContent = placeholder;
select.append(option);
}
for (const [value, label] of options) {
const option = document.createElement("option");
option.value = value;
option.textContent = label;
select.append(option);
}
return select;
}
function makeTextInput(name, maxLength = 200, placeholder = "") {
const input = document.createElement("input");
input.type = "text";
input.name = name;
input.maxLength = maxLength;
input.autocomplete = "off";
if (placeholder) {
input.placeholder = placeholder;
}
return input;
}
function makeTextarea(name, maxLength = 2000) {
const textarea = document.createElement("textarea");
textarea.name = name;
textarea.rows = 3;
textarea.maxLength = maxLength;
return textarea;
}
function makeCard(title, subtitle) {
const card = document.createElement("fieldset");
card.className = "check-card";
const legend = document.createElement("legend");
legend.textContent = title;
card.append(legend);
const description = document.createElement("p");
description.className = "field-help";
description.textContent = subtitle;
card.append(description);
return card;
}
function productSlug(product) {
return product.toLowerCase().replaceAll(" ", "_");
}
function selectedKey() {
const keyId = Number(keySelect.value);
return keyProfiles.find((key) => key.id === keyId) || null;
}
function previousForKey(keyId) {
return (previousValues.keys || []).find((entry) => entry.key_id === keyId) || null;
}
function previousSecurity(provider) {
return (previousValues.security || {})[provider] || null;
}
function keyProductFor(key) {
return KEY_PRODUCTS[key.key_number];
}
function expectedProducts(key) {
const software = walletSoftwareSelect.value;
if (!key || !WALLET_SOFTWARE.includes(software)) {
return [];
}
return [...new Set([keyProductFor(key), software])];
}
function expectedProviders(key) {
if (!key) {
return [];
}
if (key.key_number === CLOUD_KEY_NUMBER) {
return ["Nunchuk"];
}
return [keyProductFor(key), "Sparrow Wallet", "Nunchuk"];
}
function renderKeySelect() {
for (const key of keyProfiles) {
const option = document.createElement("option");
option.value = String(key.id);
option.textContent = `Key ${key.key_number}: ${key.name}`;
keySelect.append(option);
}
}
function renderKeyCheck() {
const key = selectedKey();
keyCheck.replaceChildren();
if (!key) {
keyCheck.append(emptyState("Select a key to record its checks."));
return;
}
const previous = previousForKey(key.id);
const card = makeCard(
`Key ${key.key_number}: ${key.name}`,
key.type === "cloud"
? "Cloud key — report the result of your manual check."
: "Hardware key — record the result of your manual check.",
);
const available = makeSelect(booleanOptions, "available");
card.append(makeField("Availability", "available", available));
const details = document.createElement("div");
details.className = "form-stack";
if (key.type === "hardware") {
details.append(makeField("Hardware works", "hardware_works", makeSelect(booleanOptions, "hardware_works")));
details.append(makeField(
"Firmware version",
"firmware_version",
makeTextInput("firmware_version", 100, previous ? previous.firmware_version : ""),
));
details.append(makeField(
"Seed backup intact and matching the device",
"seed_backup_verified",
makeSelect(verificationStatuses, "seed_backup_verified", "Select a status"),
));
}
details.append(makeField(
"Address path verified",
"address_path_verified",
makeSelect(verificationStatuses, "address_path_verified", "Select a status"),
));
details.append(makeField(
"Address path",
"address_path",
makeTextInput("address_path", 200, previous ? previous.address_path : ""),
));
card.append(details);
card.append(makeField("Key notes", "key_comments", makeTextarea("key_comments")));
keyCheck.append(card);
available.addEventListener("change", () => {
details.hidden = available.value === "0";
syncRequiredFields();
});
syncRequiredFields();
}
function syncRequiredFields() {
const key = selectedKey();
const availability = form.querySelector('[name="available"]');
const required = Boolean(key) && availability !== null && availability.value === "1";
for (const name of ["seed_backup_verified", "address_path_verified"]) {
const select = form.querySelector(`[name="${name}"]`);
if (select) {
select.required = required;
}
}
}
function lockSoftwareFields() {
const key = selectedKey();
const isCloud = Boolean(key) && key.key_number === CLOUD_KEY_NUMBER;
const sparrow = walletSoftwareSelect.querySelector('option[value="Sparrow Wallet"]');
sparrow.disabled = isCloud;
softwareGrid.hidden = isCloud;
if (isCloud) {
walletSoftwareSelect.value = "Nunchuk";
softwareHelp.textContent = "Compatibility is derived from availability for the cloud key: available gives OK, not available gives not assessed.";
} else {
softwareHelp.textContent = "Record the version of the software you selected for this key.";
}
updateSoftwareVersionPlaceholder();
}
function updateSoftwareVersionPlaceholder() {
const key = selectedKey();
const previous = key ? previousForKey(key.id) : null;
const reusable = Boolean(key)
&& key.key_number !== CLOUD_KEY_NUMBER
&& previous
&& previous.wallet_software === walletSoftwareSelect.value
&& previous.software_version;
softwareVersionInput.placeholder = reusable ? previous.software_version : "";
}
function renderToolChecks() {
toolChecks.replaceChildren();
const products = expectedProducts(selectedKey());
if (!products.length) {
toolChecks.append(emptyState("Select a key and software to see the products to check."));
return;
}
for (const product of products) {
const slug = productSlug(product);
const card = makeCard(product, "Record the support status for this submission.");
card.append(makeField("BIP327 status", `tool_${slug}_bip327_status`, makeSelect(generalStatuses, `tool_${slug}_bip327_status`)));
card.append(makeField("SLIP39 status", `tool_${slug}_slip39_status`, makeSelect(generalStatuses, `tool_${slug}_slip39_status`)));
toolChecks.append(card);
}
}
function renderSecurityChecks() {
const key = selectedKey();
securityChecks.replaceChildren();
carriedSecurity = [];
if (!key) {
securityChecks.append(emptyState("Select a key to see the providers to check."));
return;
}
const software = walletSoftwareSelect.value;
const keyProduct = keyProductFor(key);
const options = SECURITY_STATUSES.map((status) => [status, status]);
for (const provider of expectedProviders(key)) {
const slug = productSlug(provider);
const last = previousSecurity(provider);
const relevant = provider === keyProduct || provider === software;
if (!relevant && !UNRESOLVED_STATUSES.includes(last)) {
// Hidden, and carried forward so nothing is lost (section 20).
carriedSecurity.push({ provider, status: last || DEFAULT_SECURITY_STATUS });
continue;
}
const card = makeCard(provider, "Enter the result of external research; do not include credentials or secrets.");
const status = makeSelect(options, `security_${slug}_status`, "Select a status");
status.required = true;
if (!relevant && last) {
// A known problem stays visible, so it is never dropped silently.
status.value = last;
}
card.append(makeField("Security status", `security_${slug}_status`, status));
card.append(makeField("Comment", `security_${slug}_comments`, makeTextarea(`security_${slug}_comments`, 1000)));
securityChecks.append(card);
}
for (const entry of carriedSecurity) {
const input = document.createElement("input");
input.type = "hidden";
input.name = `security_${productSlug(entry.provider)}_status`;
input.value = entry.status;
securityChecks.append(input);
}
}
function formatLocalDate(date) {
const year = date.getFullYear();
const month = String(date.getMonth() + 1).padStart(2, "0");
const day = String(date.getDate()).padStart(2, "0");
return `${year}-${month}-${day}`;
}
function nextCheckDate(value) {
if (!value) {
return "";
}
const [year, month, day] = value.split("-").map(Number);
const date = new Date(year, month - 1, day);
date.setFullYear(date.getFullYear() + 1);
if (date.getMonth() !== month - 1) {
// 29 February has no equivalent in a non-leap year, so clamp to 28 February.
date.setDate(0);
}
return formatLocalDate(date);
}
function updateDuePreview() {
const due = nextCheckDate(document.querySelector("#checked-at").value);
nextCheckPreview.textContent = due
? `Next check due: ${due} (one calendar year after the check date).`
: "Next check due is calculated automatically as one calendar year after the check date.";
}
function setCheckDate() {
const checkedAt = document.querySelector("#checked-at");
checkedAt.value = formatLocalDate(new Date());
updateDuePreview();
checkedAt.addEventListener("change", updateDuePreview);
}
function resetReview() {
reviewPanel.hidden = true;
saveStatus.textContent = "";
saveButton.disabled = true;
}
function appendSummaryList(parent, title, items) {
const heading = document.createElement("h3");
heading.textContent = title;
const list = document.createElement("ul");
for (const item of items) {
const entry = document.createElement("li");
entry.textContent = item;
list.append(entry);
}
parent.append(heading, list);
}
function derivedSummary(key, available) {
if (!key || key.key_number !== CLOUD_KEY_NUMBER || available === null) {
return [];
}
if (available === 1) {
return [
"Cloud health check: OK",
"Provider operational: Yes",
"Compatibility status: OK",
];
}
return [
"Cloud health check: PROBLEM",
"Provider operational: No",
"Compatibility status: not assessed",
];
}
function buildReview() {
const data = new FormData(form);
const missing = [];
const problems = [];
for (const select of form.querySelectorAll("select")) {
if (select.closest("[hidden]")) {
continue;
}
const fieldLabel = select.closest(".field")?.querySelector("span");
const label = fieldLabel?.textContent || select.name;
const value = data.get(select.name);
if (value === "" || value === "IKKJE_VURDERT") {
missing.push(label);
} else if (value === "PROBLEM" || value === "0" || value === "VULNERABLE" || value === "COMPROMISED") {
problems.push(`${label}: ${value}`);
}
}
const key = selectedKey();
const available = key ? flagValue(data, "available") : null;
const fragment = document.createDocumentFragment();
appendSummaryList(fragment, "Needs assessment", missing.length ? missing : ["None"]);
appendSummaryList(fragment, "Results requiring follow-up", problems.length ? problems : ["None"]);
const derived = derivedSummary(key, available);
if (derived.length) {
appendSummaryList(fragment, "Derived from availability", derived);
}
if (carriedSecurity.length) {
appendSummaryList(
fragment,
"Carried forward from the last saved check",
carriedSecurity.map((entry) => `${entry.provider}: ${entry.status}`),
);
}
const checkedAt = data.get("checked_at");
const dates = document.createElement("p");
const keyLabel = key ? `Key ${key.key_number}: ${key.name}` : "No key selected";
dates.textContent = `${keyLabel} · Check date: ${checkedAt} · Next check due: ${nextCheckDate(checkedAt)}`;
fragment.append(dates);
reviewSummary.replaceChildren(fragment);
reviewPanel.hidden = false;
saveStatus.textContent = "";
saveButton.disabled = false;
reviewPanel.scrollIntoView({ behavior: "smooth", block: "start" });
}
function flagValue(data, name) {
const value = data.get(name);
return value === "1" || value === "0" ? Number(value) : null;
}
function textValue(data, name) {
const value = data.get(name);
return typeof value === "string" ? value.trim() : "";
}
function statusValue(data, name) {
const value = data.get(name);
return typeof value === "string" && value !== "" ? value : null;
}
function derivedValues(key, available) {
// The cloud key records these from availability alone (section 20).
if (!key || key.key_number !== CLOUD_KEY_NUMBER) {
return {};
}
if (available === 1) {
return {
cloud_health_status: "OK",
cloud_provider_operational: 1,
software_compatibility_status: "OK",
};
}
if (available === 0) {
return {
cloud_health_status: "PROBLEM",
cloud_provider_operational: 0,
software_compatibility_status: "IKKJE_VURDERT",
};
}
return {
cloud_health_status: null,
cloud_provider_operational: null,
software_compatibility_status: "IKKJE_VURDERT",
};
}
function collectKeyCheck(data, key, derived) {
const available = flagValue(data, "available");
const isCloud = key.type === "cloud";
const entry = {
key_id: key.id,
available: available,
hardware_works: null,
firmware_version: "",
seed_backup_verified: null,
cloud_health_status: isCloud ? derived.cloud_health_status : null,
cloud_provider_operational: isCloud ? derived.cloud_provider_operational : null,
address_path_verified: null,
address_path: "",
comments: textValue(data, "key_comments"),
};
if (available === 0) {
return entry;
}
if (!isCloud) {
entry.hardware_works = flagValue(data, "hardware_works");
entry.firmware_version = textValue(data, "firmware_version");
entry.seed_backup_verified = statusValue(data, "seed_backup_verified");
}
entry.address_path_verified = statusValue(data, "address_path_verified");
entry.address_path = textValue(data, "address_path");
return entry;
}
function collectPayload() {
const data = new FormData(form);
const key = selectedKey();
const derived = derivedValues(key, key ? flagValue(data, "available") : null);
return {
checked_at: textValue(data, "checked_at"),
wallet_software: data.get("wallet_software"),
software_version: textValue(data, "software_version"),
software_compatibility_status: derived.software_compatibility_status || data.get("software_compatibility_status"),
software_comments: textValue(data, "software_comments"),
contact_info_verified: flagValue(data, "contact_info_verified"),
comments: textValue(data, "comments"),
key_check: collectKeyCheck(data, key, derived),
tool_checks: expectedProducts(key).map((product) => {
const slug = productSlug(product);
return {
product,
bip327_status: data.get(`tool_${slug}_bip327_status`),
slip39_status: data.get(`tool_${slug}_slip39_status`),
};
}),
ai_security_checks: expectedProviders(key).map((provider) => {
const slug = productSlug(provider);
return {
provider,
status: statusValue(data, `security_${slug}_status`),
comments: textValue(data, `security_${slug}_comments`),
};
}),
};
}
async function saveHealthCheck() {
saveButton.disabled = true;
saveStatus.textContent = "Saving…";
try {
const response = await fetch("/api/health-checks", {
method: "POST",
headers: { "Content-Type": "application/json", Accept: "application/json" },
body: JSON.stringify(collectPayload()),
});
if (!response.ok) {
const detail = await response.json().catch(() => ({}));
throw new Error(detail.error || "The health check could not be saved.");
}
const saved = await response.json();
saveStatus.textContent = "Health check saved.";
window.location.assign(`/history?id=${encodeURIComponent(saved.id)}`);
} catch (error) {
saveStatus.textContent = error.message;
saveButton.disabled = false;
}
}
async function loadFormData() {
try {
const [keysResponse, previousResponse] = await Promise.all([
fetch("/api/keys", { headers: { Accept: "application/json" } }),
fetch("/api/previous-values", { headers: { Accept: "application/json" } }),
]);
if (!keysResponse.ok) {
throw new Error("Key profiles are unavailable.");
}
keyProfiles = await keysResponse.json();
if (previousResponse.ok) {
const values = await previousResponse.json();
previousValues = {
keys: values.keys || [],
security: values.security || {},
};
}
renderKeySelect();
} catch {
keySelect.disabled = true;
keyCheck.replaceChildren(emptyState(
"Key profiles could not be loaded. Return to the dashboard or contact the service administrator.",
));
}
}
setCheckDate();
renderKeyCheck();
lockSoftwareFields();
renderToolChecks();
renderSecurityChecks();
saveButton.addEventListener("click", saveHealthCheck);
keySelect.addEventListener("change", () => {
lockSoftwareFields();
renderKeyCheck();
renderToolChecks();
renderSecurityChecks();
});
walletSoftwareSelect.addEventListener("change", () => {
updateSoftwareVersionPlaceholder();
renderToolChecks();
renderSecurityChecks();
});
form.addEventListener("input", resetReview);
form.addEventListener("submit", (event) => {
event.preventDefault();
if (!form.reportValidity()) {
return;
}
buildReview();
});
loadFormData();