1SYMCRYPTRUN(1) GNU Privacy Guard 2.2 SYMCRYPTRUN(1)
2
3
4
6 symcryptrun - Call a simple symmetric encryption tool
7
9 symcryptrun --class class --program program --keyfile keyfile
10 [--decrypt|--encrypt] [inputfile]
11
12
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 --verbose
49 Output additional information while running.
50
51
52 -q
53
54 --quiet
55 Try to be as quiet as possible.
56
57
58 --homedir dir
59 Set the name of the home directory to dir. If this option is not
60 used, the home directory defaults to ‘~/.gnupg’. It is only
61 recognized when given on the command line. It also overrides
62 any home directory stated through the environment variable
63 ‘GNUPGHOME’ or (on Windows systems) by means of the Registry
64 entry HKCU\Software\GNU\GnuPG:HomeDir.
65
66 On Windows systems it is possible to install GnuPG as a portable
67 application. In this case only this command line option is con‐
68 sidered, all other ways to set a home directory are ignored.
69
70 To install GnuPG as a portable application under Windows, create
71 an empty file named ‘gpgconf.ctl’ in the same directory as the
72 tool ‘gpgconf.exe’. The root of the installation is then that
73 directory; or, if ‘gpgconf.exe’ has been installed directly
74 below a directory named ‘bin’, its parent directory. You also
75 need to make sure that the following directories exist and are
76 writable: ‘ROOT/home’ for the GnuPG home and
77 ‘ROOT/var/cache/gnupg’ for internal cache files.
78
79
80
81 --log-file file
82 Append all logging output to file. Use ‘socket://’ to log to
83 socket. Default is to write logging information to STDERR.
84
85
86 The possible exit status codes of symcryptrun are:
87
88
89 0
90 Success.
91
92 1
93 Some error occurred.
94
95 2
96 No valid passphrase was provided.
97
98 3
99 The operation was canceled by the user.
100
101
103 gpg(1), gpgsm(1), gpg-agent(1),
104
105 The full documentation for this tool is maintained as a Texinfo manual.
106 If GnuPG and the info program are properly installed at your site, the
107 command
108
109 info gnupg
110
111 should give you access to the complete manual including a menu struc‐
112 ture and an index.
113
114
115
116
117
118
119GnuPG 2.2.18 2019-11-23 SYMCRYPTRUN(1)