table of contents
SHIGOFUMIRC(5) | Manual for Shigofumi | SHIGOFUMIRC(5) |
NAME¶
shigofumirc - Configuration file for Shigofumi
DESCRIPTION¶
Configuration for shigofumi is loaded from .shigofumirc in user's home directory by default.
The file is plain text file with simple syntax: Setting is stored in option = value format. If value is a type of string, it must be delimited by quotation marks. Boolean values can be expressed as "true" or non-zero integer (1) for affirmation, or "false" or zero integer (0) for negation. Simple numeric values are unquoted. Commentary starts with hash sign (#) and continues to the end of the line.
If an option accepts list of values, the syntax is traditional mathematical set notation: { value1 , value2 }.
OPTIONS¶
Following options are recognized. Not all of them must present. Missing options fall to default value back.
Account Options¶
base_url
E.g. use "https://ws1.czebox.cz/" for testing instance of ISDS or "https://ws1.mojedatovaschranka.cz/" for official instance with valid and legal data when logging in without TLS client certificate. Otherwise, with client certificate in use, replace the ws1 domain with ws1c domain. Or, with OTP authentication, replace with www domain. I.e. "https://ws1c.czebox.cz/" for testing instance with certificate authentication or "https://www.mojedatovaschranka.cz/" for official instance with OTP authentication.
Do not forget on leading protocol schema and trailing slash. Default value is official instance locator suitable for selected authentication method provided by libisds library.
certificate_format
certificate_path
key_engine
key_format
key_path
key_password
otp_method
otp_code
If HMAC-based method is used, this code will be computed in a device or a piece of software which should be in exclusive possession of its user.
If Time-based method is used, the code will be generated by ISDS server and delivered to the user by a side channel. (The channel is an SMS currently. Because the delivery is specialy charged, the time code generation is protected by plain password too. User sends standard password without OTP code first, then server delivers code by the SMS message and finally user will retry log-in with both password and both OTP code.)
Default value is empty string and user will be asked interactively for the OTP code when needed. Because of dynamic nature of this code, setting the value in a configuration file is pointless. However you could rewrite this value for each shigofumi run in batch mode.
password
username
TLS Options¶
ca_directory
ca_file
crl_file
verify_server
Network Options¶
timeout
Log Options¶
log_facilities
log_file
log_level
Other Options¶
clean_temporary_files
confirm_send
mark_message_read
You can change the state to read state by read command manually latter.
Be ware ISDS web portal marks messages as read automatically. Note, there is no way to unmark a message to unread state back.
normalize_mime_type
ISDS does not check document MIME type a client supplies. Unfortunately, official client sends invalid values (file name extension usually). This option allows Shigofumi to fix the type on-the-fly. Be ware the original value stored in ISDS or locally saved message keeps untouched.
open_command
First value is command, other values are command arguments in order. If command is not absolute file name, it's located according PATH environment variable. If value contains %f substring, it will be expanded to name of file to open. If value contains %t substring, it will be expanded to MIME type of document to open. Use %% sequence to escape per-cent character.
Default value is {"xdg-open", "%f"}.
overwrite_files
This does not apply to log file. Its new content is appended always.
NOTICE ON CRYPTOGRAPHIC LIBRARY¶
Shigofumi uses libisds that utilizes cURL library that can use three different cryptographic libraries at this time: OpenSSL, GnuTLS and NSS. Each library has different set of features and different configuration. Thus exact meaning of some Shigofumi configuration options can be slightly shifted (e.g. the name of client certificate and key). Some options cannot be understood at all (e.g. GnuTLS does not support directory of certificates).
Current cryptographic library can be determined from shigofumi -V output.
FILES¶
~/.shigofumirc
EXAMPLE¶
base_url = "https://ws1.czebox.cz/" # These credentials are invalid 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"}
SEE ALSO¶
AUTHOR¶
Petr Písař
08/18/2015 | Shigofumi |