1SYMCRYPTRUN(1)                 GNU Privacy Guard                SYMCRYPTRUN(1)
2
3
4

NAME

6       symcryptrun - Call a simple symmetric encryption tool
7

SYNOPSIS

9       symcryptrun   --class   class   --program   program  --keyfile  keyfile
10       [--decrypt|--encrypt] [inputfile]
11
12

DESCRIPTION

14       Sometimes simple encryption tools are already in use for  a  long  time
15       and there might be a desire to integrate them into the GnuPG framework.
16       The protocols and encryption methods might be non-standard or not  even
17       properly  documented,  so  that  a full-fledged encryption tool with an
18       interface like gpg is not doable.  symcryptrun provides a solution:  It
19       operates  by calling the external encryption/decryption module and pro‐
20       vides a passphrase for a key using the standard pinentry  based  mecha‐
21       nism through gpg-agent.
22
23       Note,  that  symcryptrun is only available if GnuPG has been configured
24       with '--enable-symcryptrun' at build time.
25
26
27
28       For encryption, the plain text must be provided  on  STDIN  or  as  the
29       argument  inputfile,  and the ciphertext will be output to STDOUT.  For
30       decryption vice versa.
31
32       CLASS describes the calling conventions of  the  external  tool.   Cur‐
33       rently  it  must be given as 'confucius'.  PROGRAM is the full filename
34       of that external tool.
35
36       For the class 'confucius' the option --keyfile is required; keyfile  is
37       the name of a file containing the secret key, which may be protected by
38       a passphrase.  For detailed calling conventions, see the source code.
39
40
41       Note, that gpg-agent must be running before starting symcryptrun.
42
43
44       The following additional options may be used:
45
46
47       -v
48
49       --verbose
50              Output additional information while running.
51
52
53       -q
54
55       --quiet
56              Try to be as quiet as possible.
57
58
59       --homedir dir
60              Set the name of the home directory to dir. If this option is not
61              used,  the  home  directory  defaults to ‘~/.gnupg’.  It is only
62              recognized when given on the command line.   It  also  overrides
63              any  home  directory  stated  through  the  environment variable
64              ‘GNUPGHOME’ or (on W32 systems) by means of the  Registry  entry
65              HKCU\Software\GNU\GnuPG:HomeDir.
66
67
68
69
70       --log-file file
71              Append  all logging output to file.  Default is to write logging
72              information to STDERR.
73
74
75
76              The possible exit status codes of symcryptrun are:
77
78
79       0
80                      Success.
81
82       1
83                      Some error occured.
84
85       2
86                      No valid passphrase was provided.
87
88       3
89                      The operation was canceled by the user.
90
91
92

SEE ALSO

94       gpg(1), gpgsm(1), gpg-agent(1),
95
96       The full documentation for this tool is maintained as a Texinfo manual.
97       If  GnuPG and the info program are properly installed at your site, the
98       command
99
100         info gnupg
101
102       should give you access to the complete manual including a  menu  struc‐
103       ture and an index.
104
105
106
107
108
109
110GnuPG 2.0.22                      2018-07-13                    SYMCRYPTRUN(1)
Impressum