192 lines
5.0 KiB
HTML
192 lines
5.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of SYMCRYPTRUN</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>SYMCRYPTRUN</H1>
|
|
Section: GNU Privacy Guard 2.2 (1)<BR>Updated: 2019-11-23<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
<B>symcryptrun</B>
|
|
|
|
- Call a simple symmetric encryption tool
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>symcryptrun</B>
|
|
|
|
<B>--class</B>
|
|
|
|
<I>class</I>
|
|
|
|
<B>--program</B>
|
|
|
|
<I>program</I>
|
|
|
|
<B>--keyfile</B>
|
|
|
|
<I>keyfile</I>
|
|
|
|
[<B>--decrypt</B>|<B>--encrypt</B>]
|
|
|
|
[<I>inputfile</I>]
|
|
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
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 <B>gpg</B> is not doable.
|
|
<B>symcryptrun</B> provides a solution: It operates by calling the
|
|
external encryption/decryption module and provides a passphrase for a
|
|
key using the standard <B>pinentry</B> based mechanism through
|
|
<B>gpg-agent</B>.
|
|
<P>
|
|
Note, that <B>symcryptrun</B> is only available if GnuPG has been
|
|
configured with '--enable-symcryptrun' at build time.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
For encryption, the plain text must be provided on STDIN or as the
|
|
argument <I>inputfile</I>, and the ciphertext will be output to STDOUT.
|
|
For decryption vice versa.
|
|
<P>
|
|
<I>CLASS</I> describes the calling conventions of the external tool.
|
|
Currently it must be given as 'confucius'. <I>PROGRAM</I> is
|
|
the full filename of that external tool.
|
|
<P>
|
|
For the class 'confucius' the option <B>--keyfile</B> is
|
|
required; <I>keyfile</I> 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.
|
|
<P>
|
|
<P>
|
|
Note, that <B>gpg-agent</B> must be running before starting
|
|
<B>symcryptrun</B>.
|
|
<P>
|
|
<P>
|
|
The following additional options may be used:
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-v</B>
|
|
|
|
<DD>
|
|
|
|
<B>--verbose</B>
|
|
|
|
Output additional information while running.
|
|
<P>
|
|
<DT id="2"><B>-q</B>
|
|
|
|
<DD>
|
|
<DT id="3"><B>--quiet</B>
|
|
|
|
<DD>
|
|
Try to be as quiet as possible.
|
|
<P>
|
|
<DT id="4"><B>--homedir </B><I>dir</I>
|
|
|
|
<DD>
|
|
Set the name of the home directory to <I>dir</I>. If this option is not
|
|
used, the home directory defaults to '<I>~/.gnupg</I>'. It is only
|
|
recognized when given on the command line. It also overrides any home
|
|
directory stated through the environment variable '<I>GNUPGHOME</I>' or
|
|
(on Windows systems) by means of the Registry entry
|
|
<I>HKCU\Software\GNU\GnuPG:HomeDir</I>.
|
|
<P>
|
|
On Windows systems it is possible to install GnuPG as a portable
|
|
application. In this case only this command line option is
|
|
considered, all other ways to set a home directory are ignored.
|
|
<P>
|
|
To install GnuPG as a portable application under Windows, create an
|
|
empty file named '<I>gpgconf.ctl</I>' in the same directory as the tool
|
|
'<I>gpgconf.exe</I>'. The root of the installation is then that
|
|
directory; or, if '<I>gpgconf.exe</I>' has been installed directly below
|
|
a directory named '<I>bin</I>', its parent directory. You also need to
|
|
make sure that the following directories exist and are writable:
|
|
'<I>ROOT/home</I>' for the GnuPG home and '<I>ROOT/var/cache/gnupg</I>'
|
|
for internal cache files.
|
|
<P>
|
|
<P>
|
|
<DT id="5"><B>--log-file </B><I>file</I>
|
|
|
|
<DD>
|
|
Append all logging output to <I>file</I>. Use '<I>socket://</I>' to log
|
|
to socket. Default is to write logging information to STDERR.
|
|
<P>
|
|
</DL>
|
|
<P>
|
|
|
|
<P>
|
|
<P>
|
|
The possible exit status codes of <B>symcryptrun</B> are:
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="6"><B>0</B>
|
|
|
|
<DD>
|
|
<BR> Success.
|
|
<DT id="7"><B>1</B>
|
|
|
|
<DD>
|
|
<BR> Some error occurred.
|
|
<DT id="8"><B>2</B>
|
|
|
|
<DD>
|
|
<BR> No valid passphrase was provided.
|
|
<DT id="9"><B>3</B>
|
|
|
|
<DD>
|
|
<BR> The operation was canceled by the user.
|
|
<P>
|
|
</DL>
|
|
<P>
|
|
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gpg">gpg</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gpgsm">gpgsm</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?1+gpg-agent">gpg-agent</A></B>(1),
|
|
<P>
|
|
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
|
|
<P>
|
|
<DL COMPACT><DT id="10"><DD>
|
|
<PRE>
|
|
info gnupg
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
should give you access to the complete manual including a menu structure
|
|
and an index.
|
|
<P>
|
|
<P>
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="12"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="13"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="14"><A HREF="#lbAE">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:28 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|