Scroll to navigation

SHIGOFUMIRC(5) Návod k igofumi SHIGOFUMIRC(5)

JMÉNO

shigofumirc - Konfigurační soubor igofumi

POPIS

Standardně se nastavení programu shigofumi načítá ze souboru .shigofumirc v domovském adresáři uivatele.

Jedná se o prostý textový soubor s jednoduchou syntaxí: Nastavení je uloeno ve formátu volba = hodnota. Je-li hodnota typu řetězec, musí být vymezena uvozovkami. Pravdivostní hodnotu lze vyjádřit jako "true" nebo nenulové číslo (1) pro souhlas, nebo "false" nebo číslo nula (0) pro zamítnutí. Jednoduché číselné hodnoty se do uvozovek neuzavírají. Komentář začíná znakem mříka (#) a pokračuje a do konce řádku.

Pokud volba přijímá seznam hodnot, syntaxe je tradiční matematický zápis mnoiny: { hodnota1 , hodnota2 }.

PŘEPÍNAČE

Následující volby jsou známy. Ne vechny musí být přítomny. Chybějící volby ponesou výchozí hodnotu.

Volby účtu

base_url

Základ URL serveru ISDS. Při zadávání této hodnoty buďte opatrní: Můe odhalit vae heslo zlým chlápkům s faleným serverem (pokud pečlivě neověříte totonost serveru) a pro rozdílné přihlaovací mechanismy se pouívají rozdílné názvy strojů. Navíc česká vláda provozuje dvě instance serverů: oficiální a testovací.

Např. pro testovací instanci pouijte "https://ws1.czebox.cz/" nebo pro oficiální instanci "https://ws1.mojedatovaschranka.cz/" s platnými závaznými daty při přihlaování bez TLS klientského certifikátu. Jinak při pouití klientského certifikátu nahraďte doménu ws1 doménou ws1c. Nebo při autentizaci jednorázovým heslem nahraďte doménou www. T. j. pro testovací instanci s přihlaováním certifikátem "https://ws1c.czebox.cz/" nebo pro oficiální instanci s přihlaováním jednorázovým heslem "https://www.mojedatovaschranka.cz/".

Nezapomeňte na schéma protokolu na začátku a na lomítko na konci. Výchozí hodnota je lokátor oficiální instance přísluný pro vybraný způsob přihlaování získaný z knihovny libisds.

certificate_format

Formát klientského certifikátu, který se pouije pro přihláení uivatele k ISDS. Existují tři různé hodnoty: PEM pro soubor kódovaný do Base64, DER pro binární soubor a ENG pro certifikát uloený v ifrovacím modulu. Výchozí hodnota je prázdný řetězec.

certificate_path

Soubor, ve kterém se nachází klientský certifikát určený pro přihlaování uivatele k systému ISDS, je-li volba certificate_format nastavena na PEM nebo DER. Je-li certificate_format ENG, jedná se o identifikátor certifikátu uvnitř ifrovacího modulu. Knihovna NSS pouívá tuto volbu jako název certifikátu. Výchozí hodnota je prázdný řetězec značící, e uivatel se nebude přihlaovat certifikátem.

key_engine

ifrovací modul obsahující soukromý klíč klienta a/nebo certifikát, který se pouije pro přihláení uivatele k systému ISDS. Hodnota určuje zařízení (např. čipovou kartu) známé pouité kryptografické knihovně, kde je uloen klíč a/nebo certifikát. Přesný význam závisí na kryptografické knihovně. Tato volba má smysl jen, pokud key_format nebo certificate_format je ENG. Výchozí hodnota je prázdný řetězec.

key_format

Formát klientského klíče pouívaného pro přihlaování uivatele k ISDS. Existují tři různé hodnoty: PEM pro soubor kódovaný do Base64, DER pro binární soubor a ENG pro klíč uloený v ifrovacím modulu. Výchozí hodnota je prázdný řetězec.

key_path

Soubor, ve kterém se nachází klientský klíč určený pro přihlaování uivatele k systému ISDS, je-li volba key_format nastavena na PEM nebo DER. Je-li key_format ENG, jedná se o identifikátor klíče uvnitř ifrovacího modulu. Knihovna NSS pouívá tuto volbu jako název certifikátu. Výchozí hodnota je prázdný řetězec. To můe znamenat, e klíč je uloen spolu s certifikátem.

key_password

Heslo chránící soukromý klíč určený k přihlaování uivatele pomocí asymetrické kryptografie. Výchozí hodnota je prázdný řetězec. Pouitá kryptografická knihovna můe vznést svůj vlastní dotaz na heslo nebo si vyádat kód jiným způsobem (např. zadat PIN na klávesnici čtečky čipových karet).

otp_method

Způsob přihlaování jednorázovým heslem. Výchozí hodnota je nedefinovaný řetězec, co znamená, e se autentizace jednorázovým heslem (OTP) nepouije. Je-li tato volba definována, pro přihláení se pouije OTP. Rozliují se dva způsoby: HOTP pro jednorázové heslo odvozené haovacím autentizačním algoritmem (HMAC) a TOTP pro jednorázové heslo závislé na času.

otp_code

Jednorázové heslo pouité při autentizaci pomocí OTP.

Je-li pouita metoda HMAC, toto heslo bude vypočteno v zařízení nebo programu, který by měl být ve výlučném drení uivatele.

Je-li pouita časová metoda, bude heslo vytvořeno serverem ISDS a doručeno uivateli postranním kanálem. (V současnosti je tímto kanálem SMS. Protoe doručování je zvláť zpoplatněno, je tvorba časového hesla chráněna rovně běným heslem. Uivatel nejprve odele běné heslo bez jednorázového hesla, potom server doručí jednorázové heslo ve zprávě SMS, a nakonec se uivatel znovu pokusí přihlásit zadáním běného i jednorázového hesla.)

Výchozí hodnota je prázdný řetězec a uivatel bude poádán o zadání jednorázového hesla, a bude třeba. Protoe jednorázové heslo se neustále mění, uloení jeho hodnoty do konfiguračního souboru postrádá smysl. Avak v dávkovém reimu můete zkusit jeho hodnotu přepsat před kadým sputěním shigofumi.

password

Heslo přiřazené danému uivatelskému jménu. Uivatel jej musí dret v tajnosti. Toto heslo se pouije při HTTP autentizaci a je předáno síťové knihovně na nií úrovni. Ujistěte se, e tento konfigurační soubor a vá odkládací oddíl (síťová knihovna můe být spolu s heslem odswapována při nedostatku fyzické paměti) se nedostane do nesprávných rukou. Nejdříve je zaifrujte. Výchozí hodnota je prázdný řetězec.

username

Přihlaovací jméno uivatele do ISDS. Identifikuje uivatele v rámci ISDS. Jedna osoba můe mít více identit. Výchozí hodnota je prázdný řetězec.

Volby TLS

ca_directory

Cesta k adresáři s certifikáty důvěryhodných autorit uloených v jednotlivých souborech (soubory obvykle musí mít zvlátní názvy). Výchozí hodnota je poskytnuta kryptografickou knihovnou z nií úrovně. Přesný význam této volby závisí na výkladu pouité kryptografické knihovny.

ca_file

Cesta k souboru s certifikáty důvěryhodných autorit (zřetězený seznam certifikátů ve formátu PEM. Výchozí hodnota je poskytnuta kryptografickou knihovnou z nií úrovně. Přesný význam této volby závisí na výkladu pouité kryptografické knihovny.

crl_file

Cesta k souboru se seznamy odvolaných certifikátů (obvykle zřetězený seznam CRL ve formátu PEM). Výchozí hodnota je poskytnuta kryptografickou knihovnou z nií úrovně. Přesný význam této volby závisí na výkladu pouité kryptografické knihovny.

verify_server

Pravdivostní přepínač rozhodující, zda se má ověřovat totonost serveru. Pouije-li se HTTPS spojení k serveru, totonost serveru můe být ověřena ve fázi vyjednávání TLS pomocí ověření platnosti certifikátu serveru proti certifikátu důvěryhodné certifikační autority a seznamu odvolaných certifikátů. Výchozí hodnota je zapnuto. Důrazně se doporučuje nechat tuto volbu zapnutou.

Síťové volby

timeout

Nezáporná celočíselná hodnota časového limitu sítě v milisekundách. Pomocí 0 vypnete časové omezení síťových operací. Výchozí hodnota je 10 000 ms.

Volby protokolování

log_facilities

Seznam řetězcových hodnot určující obor knihovny libisds, který se bude zaznamenávat. Platné hodnoty jsou: none (nic), http, soap, isds, file (soubor), sec (zabezpečení), xml, all (ve). Výchozí hodnota je {"none"}.

log_file

Řetězcová hodnota vybírající soubor, do kterého se bude připisovat protokol ISDS. Protokol zachycuje vnitřní ladicí záznam libisds. Nepokrývá hláení samotného shigofumi. Tato vlastnost je určena k ladění niích knihoven a protokolů jako ISDS, SOAP nebo HTTP(S) knihovny cURL. Není-li definována, shigofumi bude vypisovat protokol na standardní chybový výstup.

log_level

Celočíselná hodnota z intervalu <0;100> nastavující úroveň ladění libisds. 0 je ádné protokolování, 10 jsou kritické zprávy, 20 chyby, 30 upozornění, 40 informativní hláky, 50 ladicí zprávy, 100 zprávy vech úrovní závanosti. Výchozí hodnota protokolování je 20.

Ostatní volby

clean_temporary_files

Pravdivostní přepínač řídící, zda-li budou pomocné soubory při ukončení shigofumi odstraněny. Toto se vztahuje na soubory vytvořené příkazem opendoc, protoe vnějí nástroj můe přistupovat k souboru i po skončení shigofumi. Výchozí hodnota je zapnuto.

confirm_send

Pravdivostní přepínač řídící, zda-li třeba vyadovat potvrzení před odesláním sestavené zprávy. Výchozí hodnota je pravda.

mark_message_read

Pravdivostní přepínač řídící, zda-li právě staená příchozí zpráva má být automaticky označena za přečtenou. Je-li pravda, změní stav zprávy na serveru na přečtenou. V opačném případě ponechá stav zprávy nezměněný. Výchozí hodnota je nepravda.

Stav můete později změnit na přečteno ručně pomocí příkazu read.

Mějte na paměti, e webový portál ISDS označuje zprávy za přečtené automaticky. Vezměte na vědomí, e neexistuje způsob, jak vrátit stav zprávy zpět na nepřečteno.

normalize_mime_type

Pravdivostní přepínač řídící, zda-li typ MIME dokumentů získaných ze zprávy by měl být převeden na normalizovanou hodnotu. Výchozí hodnota je pravda.

ISDS nekontroluje typ dokumentu MIME, který mu předává klient. Nanetěstí oficiální klient odesílá neplatné hodnoty (obvykle příponu souboru). Tato volba umoňuje igofumi opravit typ za běhu. Pamatujte, e původní hodnota uloená v ISDS nebo ve zprávě uloené do místního souboru zůstane nezměněna.

open_command

Seznam řetězcových hodnot určující vnějí nástroj, který bude sputěn při otevírání dokumentu.

První hodnota je příkaz, dalí hodnoty jsou argumenty příkazu v daném pořadí. Pokud příkaz není absolutní název souboru, bude dohledán podle proměnné prostředí PATH. Pokud hodnota bude obsahovat podřetězec %f, bude nahrazen názvem otevíraného souboru. Pokud hodnota bude obsahovat podřetězec %t, bude nahrazen za typ MIME otevíraného dokumentu. Znak procenta lze vyjádřit posloupností %%.

Výchozí hodnota je {"xdg-open", "%f"}.

overwrite_files

Pravdivostní přepínač řídící, zda-li nově vytvářené soubory mají přepsat soubory existující. Je-li pravda, existující soubory budou potichu přepsány. Jinak bude vrácena chyba. Výchozí hodnota je pravda.

Toto se nevztahuje na soubor protokolu. Jeho nový obsah je vdy připsán na konec.

POZNÁMKA KE KRYPTOGRAFICKÝM KNIHOVNÁM

igofumi pouívá libisds, která pouívá knihovnu cURL, která můe v současnosti pouívat tři různé kryptografické knihovny: OpenSSL, GnuTLS a NSS. Kadá knihovna má jinou mnoinu schopností a rozdílnou konfiguraci. Proto přesný význam některých voleb igofumi můe být mírně posunut (např. název certifikátu a klíče klienta). Některé volby nebudou pochopeny vůbec (např. GnuTLS nepodporuje adresář certifikátů).

Současnou kryptografickou knihovnu lze určit z výstupu příkazu shigofumi -V.

SOUBORY

~/.shigofumirc

Výchozí umístění konfiguračního souboru.

PŘÍKLAD

base_url = "https://ws1.czebox.cz/"
# Tyto přihlaovací údaje nejsou platné
username = 1s79vd
password = XY123456
verify_server = true
ca_file = /etc/ssl/certs/ca-certificates.crt
ca_directory = /etc/ssl/certs
crl_file = /etc/ssl/crl
log_facilities = {"http", "soap"}

VIZTE TÉ

shigofumi(1)

AUTOR

Petr Písař

Napsal igofumi a libisds.
28. února 2021 igofumi