provared 0.5.0 → 0.7.0

package/page/render.js

@@ -7,7 +7,7 @@
 // is kept inside its own box, so that a record cannot hide, reorder or
 // draw over the words around it.
 
-import { REFUSAL_REASONS, conditionWords, limitWords, neverWords } from '../src/check.js';
+import { DENIAL_SOURCES, REFUSAL_REASONS, conditionWords, isPageAddress, limitWords, neverWords } from '../src/check.js';
 
 // The same holds for characters that cannot be seen (zero-width characters,
 // soft hyphens, line separators, fillers), with which two different labels
@@ -54,6 +54,20 @@ export function readBlocks(text) {
   return { values: lines.filter((line) => /^[0-9a-fA-F]{64}$/.test(line)), bad: lines.filter((line) => !/^[0-9a-fA-F]{64}$/.test(line)) };
 }
 
+/**
+ * Read the box of page addresses, one to a line: the addresses at which the
+ * person expects the permissions to have been signed, each in the one form
+ * the format allows (https://, a website name in lower case, a port only if
+ * it is needed, and nothing more). As with the other boxes, a line that is
+ * not one is never dropped silently.
+ * @param {string} text
+ * @returns {{values: string[], bad: string[]}}
+ */
+export function readOrigins(text) {
+  const lines = String(text).split(/\s+/).filter((line) => line !== '');
+  return { values: lines.filter((line) => isPageAddress(line)), bad: lines.filter((line) => !isPageAddress(line)) };
+}
+
 /**
  * @param {unknown} text
  * @returns {string} the text, safe to place among other words
@@ -82,6 +96,17 @@ export function el(tag, className, text) {
 
 const MONTHS = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
 
+/**
+ * The heading of the card of the top fingerprint. It names the Seal only
+ * where the record holds one: a book, or the pages of a Show, with no seal
+ * has a top fingerprint and no seal.
+ * @param {{summary?: {counts?: {seals?: number}}}} result the checker's answer
+ * @returns {string}
+ */
+export function topFingerprintHeading(result) {
+  return (result?.summary?.counts?.seals ?? 0) > 0 ? 'The top fingerprint (the Seal)' : 'The top fingerprint';
+}
+
 /**
  * A time from a record, in words. The checker has already confirmed its
  * form; anything else is shown as it is.
@@ -149,6 +174,17 @@ function stampRows(list, stamps) {
   }
 }
 
+// The witness statements beside a seal. What a statement says is shown only where it passed its check.
+function witnessRows(list, witnesses) {
+  for (const w of witnesses ?? []) {
+    if (w.state === 'invalid') row(list, 'Witness statement, not used', 'it did not pass its check (see the problems)');
+    else if (w.state === 'unavailable') row(list, 'Witness statement, not checked', 'this browser cannot check both of its signatures');
+    else if (w.counted) row(list, 'Witnessed', `by ${label(w.name)} (a label), a witness you named as trusted (key set ${w.witness}), at ${showTime(w.when)} (the witness's own word)`);
+    else if (w.trusted) row(list, 'Witness statement, not counted', `from a witness you named as trusted (key set ${w.witness}), but it was not counted (see the notes on this card)`);
+    else row(list, 'Witness statement, not counted', `from a witness you did not name as trusted (key set ${w.witness})`);
+  }
+}
+
 function cancellationCard(e) {
   const card = el('div', `card slip${e.problems.length ? ' broken' : ''}`);
   card.append(el('h3', 'kind', `Entry ${e.index}: Cancellation (the person ends a slip)`));
@@ -188,8 +224,39 @@ function acknowledgementCard(e) {
   return card;
 }
 
+// A seal held elsewhere, handed over beside the book.
+function heldSealCard(h, n) {
+  const card = el('div', `card seal${h.problems.length ? ' broken' : ''}`);
+  card.append(el('h3', 'kind', `Handed over beside the book, ${n}: a seal of the book held elsewhere`));
+  if (h.problems.length) {
+    card.append(el('p', 'quiet', 'It did not pass its check, so it was not used. See the problems above.'));
+    return card;
+  }
+  if (h.verified === 'none') {
+    card.append(el('p', 'quiet', 'What this seal says is not shown, because this device could not check its signatures.'));
+  } else {
+    const c = h.content;
+    const list = el('dl');
+    row(list, 'Covers', `the first ${c.size} entries`);
+    row(list, 'Stands at', `entry ${h.place}`);
+    row(list, 'Top fingerprint', c.root, true);
+    row(list, 'Sealed at', `${showTime(c.when)} (the recorder's own word)`);
+    row(list, 'Recorder', `${label(c.by.name)} (a label; it is not checked)`);
+    row(list, 'Recorder\'s key set', h.sealer, true);
+    row(list, 'Recorder\'s signatures', signatureWords(h.signatures));
+    stampRows(list, h.stamps);
+    witnessRows(list, h.witnesses);
+    row(list, 'In the book at that place', h.used ? (h.inBook === null ? 'no' : `yes, at entry ${h.inBook}`) : 'not compared, because it was not used');
+    row(list, 'Fingerprint', h.fingerprint, true);
+    card.append(list);
+  }
+  for (const note of h.notes) flag(card, 'note', note);
+  return card;
+}
+
 // A cancellation the person kept, handed over beside the book.
 function heldCard(h, n) {
+  if (h.kind === 'seal') return heldSealCard(h, n);
   const card = el('div', `card slip${h.problems.length ? ' broken' : ''}`);
   card.append(el('h3', 'kind', `Handed over beside the book, ${n}: the person's own copy of a cancellation`));
   if (h.problems.length) {
@@ -365,6 +432,29 @@ function refusalCard(e) {
   return card;
 }
 
+// A denial: the agent's own side says it did not take an action, and why.
+function denialCard(e) {
+  const card = el('div', `card refusal${e.problems.length ? ' broken' : ''}`);
+  card.append(el('h3', 'kind', `Entry ${e.index}: Denial (the agent's side says it did not take an action)`));
+  if (hidden(e)) {
+    card.append(el('p', 'quiet', hidden(e)));
+    return card;
+  }
+  const c = e.content;
+  const list = el('dl');
+  row(list, 'From', c.pass ? `the helper agent of pass ${c.pass}` : 'the slip\'s own agent');
+  row(list, 'When', `${showTime(c.when)} (the agent's side's own word)`);
+  row(list, 'Not taken', c.action + (c.amount ? `, ${c.amount.value} ${c.amount.unit}` : '') + (c.with ? `, with [${c.with}]` : ''));
+  if (c.details) row(list, 'Documents named', `${c.details.length}, by their fingerprints only`);
+  row(list, 'Who said no', DENIAL_SOURCES[c.source]);
+  if (c.codes) row(list, 'Reasons given', c.codes.join(', '));
+  row(list, 'Agent\'s signatures', signatureWords(e.signatures));
+  row(list, 'Fingerprint', e.fingerprint, true);
+  card.append(list);
+  flag(card, 'onesided', 'This shows what the agent\'s side said. It is not counted against the agent, and it does not show that the action was not taken in some other way.');
+  return card;
+}
+
 function sealCard(e) {
   const card = el('div', `card seal${e.problems.length ? ' broken' : ''}`);
   card.append(el('h3', 'kind', `Entry ${e.index}: Seal (the book, signed by whoever keeps it)`));
@@ -381,6 +471,7 @@ function sealCard(e) {
   row(list, 'Recorder\'s key set', `${e.sealer}. Compare this fingerprint with the one the recorder gave you.`, true);
   row(list, 'Recorder\'s signatures', signatureWords(e.signatures));
   stampRows(list, e.stamps);
+  witnessRows(list, e.witnesses);
   row(list, 'Fingerprint', e.fingerprint, true);
   card.append(list);
   if (e.stamps.length === 0) flag(card, 'onesided', 'There is no outside time-stamp: the time is only the recorder\'s own word.');
@@ -417,15 +508,79 @@ function termsCard(e) {
  * @param {object} [o.options] what the check was told to trust: the green answer needs the passkey the
  *   person trusts and, where the record has a seal, the recorder they expect
  */
+// A copy of a cancellation, a seal, or a file of disclosures, is small.
+const MAX_HANDED_BYTES = 1000000;
+const MAX_COPIES = 16;
+const MAX_SEALS = 64;
+
+async function jsonFrom(file, what) {
+  if (file.size > MAX_HANDED_BYTES) throw new Error(`The file of ${what}, ${shown(file.name)}, is too large. Nothing was checked.`);
+  try {
+    return JSON.parse(await file.text());
+  } catch {
+    throw new Error(`The file of ${what}, ${shown(file.name)}, is not JSON. Nothing was checked. Choose another file, or clear these files.`);
+  }
+}
+
+/**
+ * What the person was handed with the record: their own copies of
+ * cancellations (up to 16), seals held elsewhere (up to 64), and one file of
+ * disclosures for covered fields. A file that cannot be read stops the
+ * check: it is never set aside silently.
+ * @param {{cancellations?: File[], seals?: File[], disclosures?: File|null}} files the files chosen, as the
+ *   browser gives them (anything with "name", "size" and "text()")
+ * @returns {Promise<{options: object, said: string[]}>} the options to check with, and what to say was handed over
+ */
+export async function readHanded({ cancellations = [], seals = [], disclosures = null } = {}) {
+  const options = {};
+  const said = [];
+  if (cancellations.length > MAX_COPIES) throw new Error('At most 16 copies of cancellations can be handed over at once. Nothing was checked.');
+  if (cancellations.length) {
+    options.cancellations = [];
+    for (const file of cancellations) options.cancellations.push(await jsonFrom(file, 'a cancellation'));
+    said.push(cancellations.length === 1 ? 'one copy of a cancellation' : `${cancellations.length} copies of cancellations`);
+  }
+  if (seals.length > MAX_SEALS) throw new Error('At most 64 seals held elsewhere can be handed over at once. Nothing was checked.');
+  if (seals.length) {
+    options.seals = [];
+    for (const file of seals) options.seals.push(await jsonFrom(file, 'a seal'));
+    said.push(seals.length === 1 ? 'one seal held elsewhere' : `${seals.length} seals held elsewhere`);
+  }
+  if (disclosures) {
+    options.disclosures = await jsonFrom(disclosures, 'disclosures');
+    said.push('disclosures for covered fields');
+  }
+  return { options, said };
+}
+
+/**
+ * What the check rests on: whether the person named the passkey they trust
+ * and, where the record has a seal or seals held elsewhere were handed
+ * over, the recorder they expect; and whether those seals went unused
+ * because no recorder was named. Without the keys the person named, a
+ * record agrees only with the keys inside it, and anyone could have made
+ * those.
+ * @param {object} result what checkBook or checkShow returned
+ * @param {object} [options] what the check was told
+ */
+export function trustOf(result, options = {}) {
+  const s = result.summary;
+  const issuerNamed = Array.isArray(options.issuerKeys) && options.issuerKeys.length > 0;
+  const sealerNamed = Array.isArray(options.sealKeys) && options.sealKeys.length > 0;
+  const sealsHanded = Array.isArray(options.seals) && options.seals.length > 0;
+  const named = issuerNamed && ((s.counts.seals === 0 && !sealsHanded) || sealerNamed);
+  // A seal handed over that was not compared with the book (it gives another book number, or could not be used) gives no pass.
+  // (Where no recorder was named, the seals handed over were not compared at all, and heldUnused says so.)
+  const heldCompared = !sealsHanded || !sealerNamed || (result.held ?? []).filter((h) => h.kind === 'seal').every((h) => h.used);
+  return { issuerNamed, named, sure: s.intact && named && heldCompared, heldUnused: sealsHanded && !sealerNamed };
+}
+
 export function renderResult(target, result, { isShow = false, checkedBy = 'Checked in this browser.', options = {} } = {}) {
   target.replaceChildren();
   const s = result.summary;
   const missing = s.methodsMissing.join(' or ');
-  // Without the keys the person named, a record agrees only with the keys
-  // inside it, and anyone could have made those.
-  const issuerNamed = Array.isArray(options.issuerKeys) && options.issuerKeys.length > 0;
-  const named = issuerNamed && (s.counts.seals === 0 || (Array.isArray(options.sealKeys) && options.sealKeys.length > 0));
-  const sure = s.intact && named;
+  const { issuerNamed, named, sure, heldUnused } = trustOf(result, options);
+  const heldCompared = heldUnused || (result.held ?? []).filter((h) => h.kind === 'seal').every((h) => h.used);
 
   target.append(el('h2', '', 'The answer'));
   const answers = el('ul', 'answers');
@@ -433,14 +588,23 @@ export function renderResult(target, result, { isShow = false, checkedBy = 'Chec
     answer(answers, 'no', 'The record is NOT intact.', 'See the problems marked below. A record that is not intact is not evidence.');
   } else if (sure) {
     answer(answers, 'yes', 'The record is intact.', `Every signature fits its key, every label is right and nothing has been changed. ${checkedBy}`);
+  } else if (s.intact && named && !heldCompared) {
+    answer(
+      answers,
+      'partly',
+      'Not every seal you handed over was compared with this book.',
+      'A seal held elsewhere that you handed over gives another book number than this book, or could not be used, so it was not compared with the book. See the note beside it. This is not a pass.',
+    );
   } else if (s.intact) {
     answer(
       answers,
       'partly',
       'Intact only as far as its own keys show.',
-      issuerNamed
-        ? 'The record has a seal, and you named no recorder you expect, so anyone could have sealed it. Put the fingerprint of the recorder you expect in its box. This is not a pass.'
-        : 'You named no passkey you trust, so anyone could have made a record like this. Put the thumbprint of the passkey you trust in its box. This is not a pass.',
+      !issuerNamed
+        ? 'You named no passkey you trust, so anyone could have made a record like this. Put the thumbprint of the passkey you trust in its box. This is not a pass.'
+        : s.counts.seals === 0
+          ? 'You were handed seals held elsewhere, and you named no recorder you expect, so those seals were not compared with the book. Put the fingerprint of the recorder you expect in its box. This is not a pass.'
+          : 'The record has a seal, and you named no recorder you expect, so anyone could have sealed it. Put the fingerprint of the recorder you expect in its box. This is not a pass.',
     );
   } else {
     answer(
@@ -477,11 +641,16 @@ export function renderResult(target, result, { isShow = false, checkedBy = 'Chec
 
   const held = result.held ?? [];
   if (held.length) target.append(el('h2', '', 'Handed over beside the book'));
+  if (heldUnused) {
+    const card = el('div', 'card show');
+    flag(card, 'note', 'The seals held elsewhere that you handed over were not compared with the book, because you named no recorder you expect. Put the fingerprint of the recorder you expect in its box.');
+    target.append(card);
+  }
   held.forEach((h, i) => target.append(heldCard(h, i + 1)));
 
   if (result.root) {
     const seal = el('div', 'card seal');
-    seal.append(el('h3', 'kind', 'The top fingerprint (the Seal)'));
+    seal.append(el('h3', 'kind', topFingerprintHeading(result)));
     const list = el('dl');
     row(list, 'Top fingerprint', result.root, true);
     row(list, 'Entries in the book', String(result.size));
@@ -497,6 +666,9 @@ export function renderResult(target, result, { isShow = false, checkedBy = 'Chec
           : 'It stands for the whole book. No outside time-stamp from a service you trust covers it: compare it, and the number of entries, with a copy you already trust.',
       ),
     );
+    if (s.witnessed) {
+      seal.append(el('p', 'quiet', `A witness you named as trusted signed for the seal at entry ${s.witnessed.seal}, which covers the first ${s.witnessed.entries} entries (${s.witnessed.seals.length} of ${s.counts.seals} seals witnessed). Being witnessed excuses nothing.${isShow ? ' These are single pages: they cannot show that a limit over the whole book was kept, so being witnessed says nothing here about totals.' : ''}`));
+    }
     target.append(seal);
   }
 
@@ -510,6 +682,7 @@ export function renderResult(target, result, { isShow = false, checkedBy = 'Chec
     else if (e.kind === 'seal') card = sealCard(e);
     else if (e.kind === 'cancellation') card = cancellationCard(e);
     else if (e.kind === 'acknowledgement') card = acknowledgementCard(e);
+    else if (e.kind === 'denial') card = denialCard(e);
     else if (e.kind === 'pass') card = passCard(e);
     else if (e.kind === 'vouching') card = vouchingCard(e);
     else if (e.kind === 'withdrawal') card = withdrawalCard(e);