kankys/doxa

0 Fork 0

mirror of https://codeberg.org/Kankys/doxa.git synced 2026-11-11 06:44:36 +01:00

Files

T

kankys 5eacbb0182 new-doxa-monorepo

2026-08-07 09:48:59 +02:00

6.2 KiB

Raw Permalink Blame History

🦅 UŽIVATELSKÝ MANUÁL (DOXA-SECRET)

DOXA-SECRET je minimalistický, lokální nástroj příkazové řádky pro šifrování a dešifrování textu. Je navržen s ohledem na bezpečnost a soukromí, a umožňuje převádět textové zprávy do tajných šifer definovaných v JSON souborech. Každý znak má přiřazen unikátní 5znakový kód. Aplikace je napsána v jazyce Go a nabízí moderní terminálové uživatelské rozhraní (TUI) postavené na knihovně Bubble Tea a Lip Gloss.

1. INSTALACE A SPUŠTĚNÍ

Požadavky

Před instalací se ujistěte, že máte v systému nainstalované Go (doporučená verze 1.20 nebo vyšší).

Postup instalace (Linux / macOS / FreeBSD)

Naklonujte repozitář:

git clone https://codeberg.org/Kankys/doxa-secret.git
cd doxa-secret

Spusťte instalační skript:
```
chmod +x install.sh
./install.sh
```
Skript zkontroluje instalaci Go, stáhne závislosti, zkompiluje binárku, nainstaluje spustitelný soubor doxa-secret do ~/.local/bin/ a vytvoří konfigurační složku ~/.doxa-secret/.
Přidání do PATH (pokud je to nutné): Pokud terminál příkaz doxa-secret nerozpozná, přidejte následující řádek do svého profilu (např. ~/.bashrc nebo ~/.zshrc):
```
export PATH=$PATH:$HOME/.local/bin
```
Poté restartujte terminál nebo načtěte profil příkazem source ~/.bashrc.

Úklid po instalaci

Jakmile je instalace dokončena, můžete složku projektu bezpečně smazat:

rm -rf doxa-secret

2. STRUKTURA ŠIFER A JSON ABECEDY

Všechny šifry jsou uloženy jako .json soubory v konfiguračním adresáři ~/.doxa-secret/. Při prvním spuštění aplikace se automaticky vygeneruje výchozí šifra default.json.

Ukázka struktury JSON

Každá šifra přiřazuje základním znakům latinky (bez diakritiky, která je při šifrování automaticky odstraněna a převedena na základní latinku z důvodu předcházení problémům s kódováním na různých platformách, včetně mezer, čárek, teček, číslic) unikátní, náhodně generovaný 5znakový kód:

{
  "version": "1.0",
  "mappings": {
    " ": "k9#pA",
    ",": "L5z2M",
    ".": "q7R1o",
    "a": "H3nK9",
    "b": "8vX1m"
  }
}

3. UŽIVATELSKÉ ROZHRANÍ A STAVY

Aplikace podporuje několik interaktivních stavů v rámci terminálového rozhraní:

Umožňuje vybrat ze tří hlavních možností:

Napsat zprávu: Napíšete zprávu v běžném textu a uložíte její šifrovanou verzi do souboru .txt do složky ~/doxa-secret/export/.
Dešifrovat zprávu: Načtete šifrovaný text z .txt souboru (umístěného ve složce ~/doxa-secret/import/) a zobrazíte jej v čitelné podobě.
Správa šifer: Vytváření, přepínání, import a export šifrovacích klíčů.

B. Psaní zprávy

Obsahuje pole pro zadání textu a pole pro název souboru. Přepínání mezi poli se provádí pomocí klávesy [Tab]. Stisknutím [Ctrl+S] zprávu zašifrujete a uložíte do ~/doxa-secret/export/<název_souboru>.

C. Dešifrování zprávy

Požádá vás o zadání názvu šifrovaného souboru .txt (který bude načten ze složky ~/doxa-secret/import/) nebo absolutní cesty k souboru. Aplikace jej načte, dešifruje pomocí aktuálně aktivní šifry a zobrazí v posuvném prohlížeči.

4. PŘEHLED KLÁVESOVÝCH ZKRATEK

Klávesa	Kontext	Akce
`ctrl+c`	Globální	Vynucené ukončení programu
`l`	Hlavní menu	Přepnout jazyk (Čeština / Angličtina)
`1`	Hlavní menu	Otevřít obrazovku pro psaní zprávy
`2`	Hlavní menu	Otevřít obrazovku pro dešifrování zprávy
`3`	Hlavní menu	Otevřít správu šifer
`q` / `esc`	Hlavní menu	Ukončit program
`tab`	Psaní zprávy	Přepnout mezi tělem zprávy a názvem souboru
`ctrl+s`	Psaní zprávy	Uložit a zašifrovat zprávu do souboru
`esc`	Formuláře	Zrušit akci a vrátit se do předchozího menu
`↑` / `↓` / `k` / `j`	Seznam šifer	Pohyb v seznamu šifer
`enter`	Seznam šifer	Aktivovat vybranou šifru
`c`	Seznam šifer	Vytvořit novou vlastní šifru
`i`	Seznam šifer	Importovat soubor šifry
`e`	Seznam šifer	Exportovat aktivní šifru
`d`	Seznam šifer	Smazat vybranou šifru

5. DISTRIBUCE ŠIFER (IMPORT A EXPORT)

Chcete-li sdílet šifrované zprávy s jinou osobou, musí mít druhá strana v aplikaci aktivovanou přesně stejnou šifru.

Export šifry

Ve Správě šifer vyberte šifru, kterou chcete exportovat a aktivujte ji.
Stiskněte klávesu e pro export.
Zadejte cílovou cestu (např. /cesta/k/moje_sifra.json).
Tento soubor pošlete druhé straně.

Import šifry

Ve Správě šifer stiskněte klávesu i pro import.
Zadejte cestu k obdrženému souboru JSON.
Šifra bude zvalidována, zkopírována do konfigurační složky a automaticky nastavena jako aktivní.

6. ODINSTALACE

Pro kompletní odstranění aplikace a jejích konfigurací zadejte:

rm ~/.local/bin/doxa-secret
rm -rf ~/.doxa-secret

Upozornění: Smazání adresáře ~/.doxa-secret trvale vymaže všechny vaše šifrovací klíče.

6.2 KiB Raw Permalink Blame History