CentOS 7.0 - man page for symcryptrun (centos section 1)
|Linux & Unix Commands - Search Man Pages
SYMCRYPTRUN(1) GNU Privacy Guard SYMCRYPTRUN(1)
symcryptrun - Call a simple symmetric encryption tool
symcryptrun --class class --program program --keyfile keyfile [--decrypt|--encrypt]
Sometimes simple encryption tools are already in use for a long time and there might be a
desire to integrate them into the GnuPG framework. The protocols and encryption methods
might be non-standard or not even properly documented, so that a full-fledged encryption
tool with an interface like gpg is not doable. symcryptrun provides a solution: It oper-
ates by calling the external encryption/decryption module and provides a passphrase for a
key using the standard pinentry based mechanism through gpg-agent.
Note, that symcryptrun is only available if GnuPG has been configured with '--enable-sym-
cryptrun' at build time.
For encryption, the plain text must be provided on STDIN or as the argument inputfile, and
the ciphertext will be output to STDOUT. For decryption vice versa.
CLASS describes the calling conventions of the external tool. Currently it must be given
as 'confucius'. PROGRAM is the full filename of that external tool.
For the class 'confucius' the option --keyfile is required; keyfile is the name of a file
containing the secret key, which may be protected by a passphrase. For detailed calling
conventions, see the source code.
Note, that gpg-agent must be running before starting symcryptrun.
The following additional options may be used:
Output additional information while running.
Try to be as quiet as possible.
Set the name of the home directory to dir. If this option is not used, the home
directory defaults to '~/.gnupg'. It is only recognized when given on the command
line. It also overrides any home directory stated through the environment variable
'GNUPGHOME' or (on W32 systems) by means of the Registry entry HKCU\Soft-
Append all logging output to file. Default is to write logging information to
The possible exit status codes of symcryptrun are:
Some error occured.
No valid passphrase was provided.
The operation was canceled by the user.
gpg(1), gpgsm(1), gpg-agent(1),
The full documentation for this tool is maintained as a Texinfo manual. If GnuPG and the
info program are properly installed at your site, the command
should give you access to the complete manual including a menu structure and an index.
GnuPG 2.0.22 2014-06-10 SYMCRYPTRUN(1)
All times are GMT -4. The time now is 05:30 PM.