shigofumi - Man Page

ISDS client

Synopsis

shigofumi [-c FILE]

shigofumi [-c FILE] -e COMMANDS

shigofumi -V

Description

Shigofumi is an ISDS client based on libisds library. The client can access ISDS, processes local message and delivery details, and submit file to authorized conversion.

Shigofumi is command line oriented program. Once you start it, use help to get list of embedded commands. Use help COMMAND to get details about selected COMMAND. Be ware that command listing changes contextually. User can use casual readline shortcuts for line editing (like tab completing).

While transmitting data over Internet, a progress-bar is updated. User can cancel current network operation by emitting SIGINT signal (Ctrl+C usually).

Options

-c FILE

Use configuration FILE instead of default one.

-e COMMANDS

Run shigofumi in batch mode: execute each command and terminate then.

Commands are delimited by new line (\n or \r). If any command fails, other commands will not be processed and shigofumi will quit immediately with non-zero exit code. If all commands succeed, shigofumi will return zero code.

Example 1. Authorized Conversion from Shell

$ shigofumi -e 'convert /etc/passwd'

The command submits /etc/passwd file to authorized conversion. Although it's syntactically correct, it will fail because plain text files are not allowed to be converted. Check always return code in your scripts.

-V

Show program version and linked libraries details and exit.

Shigofumi Command Language

The language is straightforward. Each command is one case sensitive word followed by (empty) sequence of arguments. Command and arguments are separated by one or more white spaces. If you need to embed white space into argument, use backslash (\) to escape it. If you need to write backslash, escape it with backslash again. Also quotation is supported with double quotes ("). White space and pipe symbol loose their delimiting properties until next double quotes. Backslash is still meta-character inside quoted string and it can be used to embed double quotes into quoted string.

The argument list can be terminated prematurely with pipe character (|). In that case, the rest of the line will be considered as shell command and output of preceding shigofumi command will be passed to standard input of the shell command.

If argument type is file name, you can use tilde symbol (~) as abbreviation for user's home directory. Home directory is derived from HOME environment variable.

Command names, file names and message identifiers can be completed by pressing completion key (depends on readline configuration, Tab usually). They are expanded only after commands expecting argument of appropriate type.

Set of available commands changes with context. E.g. If a message is loaded, commands for message operation like save to file will become available. Also meaning of the same command can change. E.g. show command will print list of incoming messages if such list is loaded; if a message is loaded, it will print the message. List of currently available commands can be obtained by help command.

Syntax help for a command is printed after calling command with invalid option or by help command with interested command as first argument. Command option -h is reserved as invalid option and shows always command usage.

ISDS

ISDS (Informační systém datových schránek / Data Box Information System) is defined by Czech ISDS Act (300/2008 Coll.)^[1] and implied documents. Current implementation details are described in Provozní řád that can be downloaded from Dokumenty ke stažení section of ISDS Information Portal^[2].

The system is designed to deliver messages between public authorities (government, courts etc.) and other entities (corporations, persons, other government or municipality offices) in reliable and traceable way.

Shigofumi implements following ISDS operations: Log in by name and password, Log in by name and password and one-time pasword, Log in by name and/or password and/or X.509 certificate, Listing incoming and outgoing message, Accepting commercial message, Retrieving incoming and outgoing message, Explicit marking a message as read, Verifying message hash, Getting message hash stored in ISDS, Verifying message authenticity, Retrieving delivery details, Getting message sender name, Sending a message to one or more recipients, Searching a box by any criteria, Searching a box by full-text, Getting a box status, Changing user password, Getting user password expiration time, Getting details about user's box, Listing box users, Getting archive with list of all boxes, Re-signing message or delivery datails, Getting details about credit for sending commercial messages.

In addition, Shigofumi can save a message and delivery details into local file and load it later again. Program can save each document into local file.

Authorized Conversion

Czech government offers a document conversion from digital to analogue form and vice versa preserving legal impacts. This is done at Czech POINT meeting place (in government, municipality or post office usually). Visit Czech POINT web site^[3] for more details.

Shigofumi allows to submit a digital document (local file or document delivered by an ISDS message) for authorized conversion into Czech POINT deposit. If deposit accepts the document, it will return a document identifier that user is required to tell to an officer in a office where he wants to obtain analogue version of his document.

Please note the deposit keeps submitted document for limited period only. Old documents (30 days currently) are removed automatically. Note also PDF documents with valid digital signature can be converted only.