Dokumentace

Kaloko

Stáhnout
Markdown s obrázky (.zip)Složka pro Docusaurus (.zip)Složka pro VitePress (.zip)Složka pro MkDocs (.zip)HTML pro offline čtení (.zip)PDFNovinky jako JSON
Stránky

Skrýt osobní údaje ve snímcích

Když procházíte kopii produkce nebo čtete produkční stránky, dostanou se do prohlížeče skutečná jména a e‑maily. Kaloko je umí skrýt ve všem, co krok uloží: ve screenshotu, v zachyceném HTML, v osnově stránky pro evaluátory, v průběhu kroku, ve videu i v zachycených e‑mailech. Kontroly přitom běží nad skutečnou stránkou, takže kritérium „rekapitulace ukazuje jméno z formuláře“ dál dostane správný verdikt.

Zamaskovat, co znáte

Prvky s osobními údaji vyjmenujte v capture.mask, u scénáře nebo u jednoho kroku:

capture:
  mask: [".customer-name", "[data-qa=email]", ".payer"]

Masky scénáře a kroku se sčítají. Na screenshotu dostane každý prvek tmavý pruhovaný obdélník. V HTML se jeho text změní na [skryto] doplněné na stejnou délku ([hidden] v anglických bězích), takže rozložení kopie se nerozpadne. Zakryjí se i formulářová pole (také skrytá), odkazy mailto: a tel: a atributy title, alt a data-*. Atributy, které nikdo nevidí, třeba data-*, se změní jen v uloženém HTML: samotná stránka si ničeho nevšimne.

Nechat je najít Kaloko

pii: redact ve scénáři zapne vyhledávání ve všech krocích. Najde e‑mailové adresy, telefonní čísla (s +420 a 00420, a české 603 123 456 vedle slova jako Telefon, Mobil nebo Kontakt), rodná čísla (s kontrolním součtem; starý devítimístný tvar a čísla bez lomítka jen vedle popisku jako RČ), IBAN a čísla účtů, data narození u popisku, adresy s PSČ a jména v oslovení („Dobrý den, Jano,“). Částky jako 250 000 000 Kč a čísla objednávek nechá být. Formulářová pole pozná podle typu, autocomplete a názvu. Počítají se i údaje v adresách URL, také zakódované (jan%40firma.cz). Pro jeden krok udělá totéž capture: { mask: auto }.

Vyhledávání čte i text v otevřeném shadow DOM a v rámech ze stejného originu. Uzavřené shadow rooty, rámy z jiného originu a text vykreslený do obrázků nebo canvasu přečíst neumí: takové prvky zamaskujte selektorem.

Údaje, které jako osobní jen vypadají, třeba vaši zákaznickou linku, zapište do pii.allow v kaloko.config.yml. Hvězdička * znamená jakýkoli text:

pii:
  allow: ["info@acme.cz", "*@support.acme.cz", "+420 800 100 200"]

Smyšlené údaje místo obdélníků

pii: pseudonymize nahradí osobní údaje vymyšlenými: eva.svobodova42@example.com, +420 000 731 205, Petr Novák. Stejný údaj má stejnou náhradu v celém běhu i v dalších bězích scénáře, takže se screenshoty dají porovnat pixel po pixelu a schválení zůstane platit. Dva různé údaje nikdy nedostanou stejnou náhradu. Obrazovky zůstanou pro klienta čitelné a pořád z nich poznáte, že se jméno z formuláře propsalo do rekapitulace i do potvrzovacího e‑mailu. Smyšlená telefonní čísla mají za předvolbou 000 a smyšlená rodná čísla měsíc 00, aby je nikdo nepovažoval za skutečná.

Náhradu vybírá otisk (hash) údaje, scénáře a projektu. Zůstane v něm z údaje tak málo, že se z náhrady zpátky odvodit nedá. Pokud chcete do výpočtu přidat vlastní tajemství, nastavte KALOKO_PII_SALT (všude stejné, jinak se náhrady na vašem počítači a v CI budou lišit).

Údaje zamaskované v jednom kroku se nahradí i v dalších, také když další krok běží v novém procesu kaloko: běh si je drží v souboru .pii-known.json ve své složce, který zůstává na vašem počítači. Krátké údaje se dál nepřenášejí, takže zamaskované 2024 nebo Praha se jinde v běhu nezmění na zástupný text.

E‑maily

Příjemci zachyceného e‑mailu (Komu a Kopie) se skryjí vždy, když krok něco maskuje. Oslovení a údaje plátce zamaskujte selektorem u e‑mailového kroku (capture: { mask: [".greeting", ".payer"] }), nebo nechte zapnuté vyhledávání. E‑mail jen s textovou částí pokryje vyhledávání a údaje, které se v běhu zamaskovaly dřív.

Vyžadovat to u prostředí

environments:
  production:
    base_url: https://shop.acme.cz
    pii: required

S pii: required vytvoří kaloko start běh jen tehdy, když scénář říká pii: redact nebo pseudonymize, nebo když běh spustíte s --pii redact. pii: redact nebo pii: pseudonymize přímo u prostředí zapne skrývání pro každý běh v něm.

Kontrola před sdílením

kaloko share projde, co se chystá nahrát. V běhu, který skrývá osobní údaje (pii u běhu, scénáře nebo prostředí, nebo mask: auto), nahrávání zastaví nezamaskovaný e‑mail, telefon, rodné číslo nebo IBAN a Kaloko vypíše krok a prvek:

Not shared: the run holds 1 unmasked personal data value(s):
  summary (cs, desktop)  <p.contact>  email ja….cz

Údaj zamaskujte a krok zachyťte znovu, nebo ho přidejte do pii.allow, pokud osobní není. kaloko share --allow-pii nahraje běh i tak. Běh, který osobní údaje neskrývá, se nahraje a stejný seznam vypíše jako upozornění.

Kontakty samotného webu se nepočítají: e‑maily na doméně prostředí, e‑maily a telefony v patičce stránky a kontakty Organization nebo ContactPoint v JSON-LD. Nepočítají se ani ukázkové adresy jako you@company.com, text v placeholderech a čísla v kresbách SVG. Pokud chcete kontakty webu kontrolovat jako cokoli jiného, nastavte pii: { site_contacts: false } v kaloko.config.yml. Screenshoty a videa se nečtou: ty chrání maska.

Na plachtě

Běh, který skrývá osobní údaje, to říká vedle názvu prostředí („Osobní údaje skryty“). V detailu kroku jsou zamaskovaná místa orámovaná fialově a poznámka vysvětlí, že tmavý pruhovaný obdélník je záměr, ne chyba aplikace.

Na této stránceNa této stránce