1GPG-PRESET-PASSPHRASE(1) GNU Privacy Guard 2.3 GPG-PRESET-PASSPHRASE(1)
2
3
4
6 gpg-preset-passphrase - Put a passphrase into gpg-agent's cache
7
9 gpg-preset-passphrase [options] [command] cache-id
10
11
13 The gpg-preset-passphrase is a utility to seed the internal cache of a
14 running gpg-agent with passphrases. It is mainly useful for unattended
15 machines, where the usual pinentry tool may not be used and the
16 passphrases for the to be used keys are given at machine startup.
17
18 This program works with GnuPG 2 and later. GnuPG 1.x is not supported.
19
20 Passphrases set with this utility don't expire unless the --forget op‐
21 tion is used to explicitly clear them from the cache --- or gpg-agent
22 is either restarted or reloaded (by sending a SIGHUP to it). Note that
23 the maximum cache time as set with --max-cache-ttl is still honored.
24 It is necessary to allow this passphrase presetting by starting gpg-
25 agent with the --allow-preset-passphrase.
26
27
28
29
30 gpg-preset-passphrase is invoked this way:
31
32 gpg-preset-passphrase [options] [command] cacheid
33
34 cacheid is either a 40 character keygrip of hexadecimal characters
35 identifying the key for which the passphrase should be set or cleared.
36 The keygrip is listed along with the key when running the command:
37 gpgsm --with-keygrip --list-secret-keys. Alternatively an arbitrary
38 string may be used to identify a passphrase; it is suggested that such
39 a string is prefixed with the name of the application (e.g foo:12346).
40 Scripts should always use the option --with-colons, which provides the
41 keygrip in a "grp" line (cf. ‘doc/DETAILS’)/
42
43
44 One of the following command options must be given:
45
46
47 --preset
48 Preset a passphrase. This is what you usually will use. gpg-pre‐
49 set-passphrase will then read the passphrase from stdin.
50
51
52 --forget
53 Flush the passphrase for the given cache ID from the cache.
54
55
56 The following additional options may be used:
57
58
59 -v
60 --verbose
61 Output additional information while running.
62
63
64 -P string
65 --passphrase string
66 Instead of reading the passphrase from stdin, use the supplied
67 string as passphrase. Note that this makes the passphrase visi‐
68 ble for other users.
69
71 gpg(1), gpgsm(1), gpg-agent(1), scdaemon(1)
72
73 The full documentation for this tool is maintained as a Texinfo manual.
74 If GnuPG and the info program are properly installed at your site, the
75 command
76
77 info gnupg
78
79 should give you access to the complete manual including a menu struc‐
80 ture and an index.
81
82
83
84
85
86
87
88
89GnuPG 2.3.7 2022-06-27 GPG-PRESET-PASSPHRASE(1)