1GPG-AGENT(1) GNU Privacy Guard 2.2 GPG-AGENT(1)
2
3
4
6 gpg-agent - Secret key management for GnuPG
7
9 gpg-agent [--homedir dir] [--options file] [options]
10 gpg-agent [--homedir dir] [--options file] [options] --server
11 gpg-agent [--homedir dir] [--options file] [options] --daemon [com‐
12 mand_line]
13
14
16 gpg-agent is a daemon to manage secret (private) keys independently
17 from any protocol. It is used as a backend for gpg and gpgsm as well
18 as for a couple of other utilities.
19
20 The agent is automatically started on demand by gpg, gpgsm, gpgconf, or
21 gpg-connect-agent. Thus there is no reason to start it manually. In
22 case you want to use the included Secure Shell Agent you may start the
23 agent using:
24
25
26 gpg-connect-agent /bye
27
28
29 If you want to manually terminate the currently-running agent, you can
30 safely do so with:
31
32 gpgconf --kill gpg-agent
33
34
35 You should always add the following lines to your .bashrc or whatever
36 initialization file is used for all shell invocations:
37
38 GPG_TTY=$(tty)
39 export GPG_TTY
40
41
42 It is important that this environment variable always reflects the out‐
43 put of the tty command. For W32 systems this option is not required.
44
45 Please make sure that a proper pinentry program has been installed un‐
46 der the default filename (which is system dependent) or use the option
47 pinentry-program to specify the full name of that program. It is often
48 useful to install a symbolic link from the actual used pinentry (e.g.
49 ‘/usr/bin/pinentry-gtk’) to the expected one (e.g. ‘/usr/bin/pinen‐
50 try’).
51
52
53
54
56 Commands are not distinguished from options except for the fact that
57 only one command is allowed.
58
59
60 --version
61 Print the program version and licensing information. Note that
62 you cannot abbreviate this command.
63
64
65 --help
66 -h Print a usage message summarizing the most useful command-line
67 options. Note that you cannot abbreviate this command.
68
69
70 --dump-options
71 Print a list of all available options and commands. Note that
72 you cannot abbreviate this command.
73
74
75 --server
76 Run in server mode and wait for commands on the stdin. The de‐
77 fault mode is to create a socket and listen for commands there.
78
79
80 --daemon [command line]
81 Start the gpg-agent as a daemon; that is, detach it from the
82 console and run it in the background.
83
84 As an alternative you may create a new process as a child of
85 gpg-agent: gpg-agent --daemon /bin/sh. This way you get a new
86 shell with the environment setup properly; after you exit from
87 this shell, gpg-agent terminates within a few seconds.
88
89
90 --supervised
91 Run in the foreground, sending logs by default to stderr, and
92 listening on provided file descriptors, which must already be
93 bound to listening sockets. This command is useful when running
94 under systemd or other similar process supervision schemes.
95 This option is not supported on Windows.
96
97 In --supervised mode, different file descriptors can be provided
98 for use as different socket types (e.g. ssh, extra) as long as
99 they are identified in the environment variable LISTEN_FDNAMES
100 (see sd_listen_fds(3) on some Linux distributions for more in‐
101 formation on this convention).
102
104 Options may either be used on the command line or, after stripping off
105 the two leading dashes, in the configuration file.
106
107
108
109
110 --options file
111 Reads configuration from file instead of from the default per-
112 user configuration file. The default configuration file is
113 named ‘gpg-agent.conf’ and expected in the ‘.gnupg’ directory
114 directly below the home directory of the user. This option is
115 ignored if used in an options file.
116
117
118
119 --homedir dir
120 Set the name of the home directory to dir. If this option is not
121 used, the home directory defaults to ‘~/.gnupg’. It is only
122 recognized when given on the command line. It also overrides
123 any home directory stated through the environment variable
124 ‘GNUPGHOME’ or (on Windows systems) by means of the Registry en‐
125 try HKCU\Software\GNU\GnuPG:HomeDir.
126
127 On Windows systems it is possible to install GnuPG as a portable
128 application. In this case only this command line option is con‐
129 sidered, all other ways to set a home directory are ignored.
130
131 To install GnuPG as a portable application under Windows, create
132 an empty file named ‘gpgconf.ctl’ in the same directory as the
133 tool ‘gpgconf.exe’. The root of the installation is then that
134 directory; or, if ‘gpgconf.exe’ has been installed directly be‐
135 low a directory named ‘bin’, its parent directory. You also
136 need to make sure that the following directories exist and are
137 writable: ‘ROOT/home’ for the GnuPG home and
138 ‘ROOT/var/cache/gnupg’ for internal cache files.
139
140
141
142 -v
143
144 --verbose
145 Outputs additional information while running. You can increase
146 the verbosity by giving several verbose commands to gpg-agent,
147 such as ‘-vv’.
148
149
150 -q
151
152 --quiet
153 Try to be as quiet as possible.
154
155
156 --batch
157 Don't invoke a pinentry or do any other thing requiring human
158 interaction.
159
160
161 --faked-system-time epoch
162 This option is only useful for testing; it sets the system time
163 back or forth to epoch which is the number of seconds elapsed
164 since the year 1970.
165
166
167 --debug-level level
168 Select the debug level for investigating problems. level may be
169 a numeric value or a keyword:
170
171
172 none No debugging at all. A value of less than 1 may be used
173 instead of the keyword.
174
175 basic Some basic debug messages. A value between 1 and 2 may
176 be used instead of the keyword.
177
178 advanced
179 More verbose debug messages. A value between 3 and 5 may
180 be used instead of the keyword.
181
182 expert Even more detailed messages. A value between 6 and 8 may
183 be used instead of the keyword.
184
185 guru All of the debug messages you can get. A value greater
186 than 8 may be used instead of the keyword. The creation
187 of hash tracing files is only enabled if the keyword is
188 used.
189
190 How these messages are mapped to the actual debugging flags is not
191 specified and may change with newer releases of this program. They are
192 however carefully selected to best aid in debugging.
193
194
195 --debug flags
196 This option is only useful for debugging and the behavior may
197 change at any time without notice. FLAGS are bit encoded and
198 may be given in usual C-Syntax. The currently defined bits are:
199
200
201 0 (1) X.509 or OpenPGP protocol related data
202
203 1 (2) values of big number integers
204
205 2 (4) low level crypto operations
206
207 5 (32) memory allocation
208
209 6 (64) caching
210
211 7 (128)
212 show memory statistics
213
214 9 (512)
215 write hashed data to files named dbgmd-000*
216
217 10 (1024)
218 trace Assuan protocol
219
220 12 (4096)
221 bypass all certificate validation
222
223
224 --debug-all
225 Same as --debug=0xffffffff
226
227
228 --debug-wait n
229 When running in server mode, wait n seconds before entering the
230 actual processing loop and print the pid. This gives time to
231 attach a debugger.
232
233
234 --debug-quick-random
235 This option inhibits the use of the very secure random quality
236 level (Libgcrypt’s GCRY_VERY_STRONG_RANDOM) and degrades all re‐
237 quest down to standard random quality. It is only used for
238 testing and should not be used for any production quality keys.
239 This option is only effective when given on the command line.
240
241 On GNU/Linux, another way to quickly generate insecure keys is
242 to use rngd to fill the kernel's entropy pool with lower quality
243 random data. rngd is typically provided by the rng-tools pack‐
244 age. It can be run as follows: ‘sudo rngd -f -r /dev/urandom’.
245
246
247 --debug-pinentry
248 This option enables extra debug information pertaining to the
249 Pinentry. As of now it is only useful when used along with
250 --debug 1024.
251
252
253 --no-detach
254 Don't detach the process from the console. This is mainly use‐
255 ful for debugging.
256
257
258 -s
259 --sh
260 -c
261 --csh Format the info output in daemon mode for use with the standard
262 Bourne shell or the C-shell respectively. The default is to
263 guess it based on the environment variable SHELL which is cor‐
264 rect in almost all cases.
265
266
267
268 --grab
269 --no-grab
270 Tell the pinentry to grab the keyboard and mouse. This option
271 should be used on X-Servers to avoid X-sniffing attacks. Any use
272 of the option --grab overrides an used option --no-grab. The
273 default is --no-grab.
274
275
276
277 --log-file file
278 Append all logging output to file. This is very helpful in see‐
279 ing what the agent actually does. Use ‘socket://’ to log to
280 socket. If neither a log file nor a log file descriptor has
281 been set on a Windows platform, the Registry entry HKCU\Soft‐
282 ware\GNU\GnuPG:DefaultLogFile, if set, is used to specify the
283 logging output.
284
285
286
287
288 --no-allow-mark-trusted
289 Do not allow clients to mark keys as trusted, i.e. put them into
290 the ‘trustlist.txt’ file. This makes it harder for users to in‐
291 advertently accept Root-CA keys.
292
293
294
295 --allow-preset-passphrase
296 This option allows the use of gpg-preset-passphrase to seed the
297 internal cache of gpg-agent with passphrases.
298
299
300
301 --no-allow-loopback-pinentry
302
303 --allow-loopback-pinentry
304 Disallow or allow clients to use the loopback pinentry features;
305 see the option pinentry-mode for details. Allow is the default.
306
307 The --force option of the Assuan command DELETE_KEY is also con‐
308 trolled by this option: The option is ignored if a loopback
309 pinentry is disallowed.
310
311
312 --no-allow-external-cache
313 Tell Pinentry not to enable features which use an external cache
314 for passphrases.
315
316 Some desktop environments prefer to unlock all credentials with
317 one master password and may have installed a Pinentry which em‐
318 ploys an additional external cache to implement such a policy.
319 By using this option the Pinentry is advised not to make use of
320 such a cache and instead always ask the user for the requested
321 passphrase.
322
323
324 --allow-emacs-pinentry
325 Tell Pinentry to allow features to divert the passphrase entry
326 to a running Emacs instance. How this is exactly handled de‐
327 pends on the version of the used Pinentry.
328
329
330 --ignore-cache-for-signing
331 This option will let gpg-agent bypass the passphrase cache for
332 all signing operation. Note that there is also a per-session
333 option to control this behavior but this command line option
334 takes precedence.
335
336
337 --default-cache-ttl n
338 Set the time a cache entry is valid to n seconds. The default
339 is 600 seconds. Each time a cache entry is accessed, the en‐
340 try's timer is reset. To set an entry's maximum lifetime, use
341 max-cache-ttl. Note that a cached passphrase may not be evicted
342 immediately from memory if no client requests a cache operation.
343 This is due to an internal housekeeping function which is only
344 run every few seconds.
345
346
347 --default-cache-ttl-ssh n
348 Set the time a cache entry used for SSH keys is valid to n sec‐
349 onds. The default is 1800 seconds. Each time a cache entry is
350 accessed, the entry's timer is reset. To set an entry's maximum
351 lifetime, use max-cache-ttl-ssh.
352
353
354 --max-cache-ttl n
355 Set the maximum time a cache entry is valid to n seconds. After
356 this time a cache entry will be expired even if it has been ac‐
357 cessed recently or has been set using gpg-preset-passphrase.
358 The default is 2 hours (7200 seconds).
359
360
361 --max-cache-ttl-ssh n
362 Set the maximum time a cache entry used for SSH keys is valid to
363 n seconds. After this time a cache entry will be expired even
364 if it has been accessed recently or has been set using gpg-pre‐
365 set-passphrase. The default is 2 hours (7200 seconds).
366
367
368 --enforce-passphrase-constraints
369 Enforce the passphrase constraints by not allowing the user to
370 bypass them using the ``Take it anyway'' button.
371
372
373 --min-passphrase-len n
374 Set the minimal length of a passphrase. When entering a new
375 passphrase shorter than this value a warning will be displayed.
376 Defaults to 8.
377
378
379 --min-passphrase-nonalpha n
380 Set the minimal number of digits or special characters required
381 in a passphrase. When entering a new passphrase with less than
382 this number of digits or special characters a warning will be
383 displayed. Defaults to 1.
384
385
386 --check-passphrase-pattern file
387 Check the passphrase against the pattern given in file. When
388 entering a new passphrase matching one of these pattern a warn‐
389 ing will be displayed. file should be an absolute filename. The
390 default is not to use any pattern file.
391
392 Security note: It is known that checking a passphrase against a
393 list of pattern or even against a complete dictionary is not
394 very effective to enforce good passphrases. Users will soon
395 figure up ways to bypass such a policy. A better policy is to
396 educate users on good security behavior and optionally to run a
397 passphrase cracker regularly on all users passphrases to catch
398 the very simple ones.
399
400
401 --max-passphrase-days n
402 Ask the user to change the passphrase if n days have passed
403 since the last change. With --enforce-passphrase-constraints
404 set the user may not bypass this check.
405
406
407 --enable-passphrase-history
408 This option does nothing yet.
409
410
411 --pinentry-invisible-char char
412 This option asks the Pinentry to use char for displaying hidden
413 characters. char must be one character UTF-8 string. A Pinen‐
414 try may or may not honor this request.
415
416
417 --pinentry-timeout n
418 This option asks the Pinentry to timeout after n seconds with no
419 user input. The default value of 0 does not ask the pinentry to
420 timeout, however a Pinentry may use its own default timeout
421 value in this case. A Pinentry may or may not honor this re‐
422 quest.
423
424
425 --pinentry-program filename
426 Use program filename as the PIN entry. The default is installa‐
427 tion dependent. With the default configuration the name of the
428 default pinentry is ‘pinentry’; if that file does not exist but
429 a ‘pinentry-basic’ exist the latter is used.
430
431 On a Windows platform the default is to use the first existing
432 program from this list: ‘bin\pinentry.exe’,
433 ‘..\Gpg4win\bin\pinentry.exe’, ‘..\Gpg4win\pinentry.exe’,
434 ‘..\GNU\GnuPG\pinentry.exe’, ‘..\GNU\bin\pinentry.exe’,
435 ‘bin\pinentry-basic.exe’ where the file names are relative to
436 the GnuPG installation directory.
437
438
439
440 --pinentry-touch-file filename
441 By default the filename of the socket gpg-agent is listening for
442 requests is passed to Pinentry, so that it can touch that file
443 before exiting (it does this only in curses mode). This option
444 changes the file passed to Pinentry to filename. The special
445 name /dev/null may be used to completely disable this feature.
446 Note that Pinentry will not create that file, it will only
447 change the modification and access time.
448
449
450
451 --scdaemon-program filename
452 Use program filename as the Smartcard daemon. The default is
453 installation dependent and can be shown with the gpgconf com‐
454 mand.
455
456
457 --disable-scdaemon
458 Do not make use of the scdaemon tool. This option has the ef‐
459 fect of disabling the ability to do smartcard operations. Note,
460 that enabling this option at runtime does not kill an already
461 forked scdaemon.
462
463
464 --disable-check-own-socket
465 gpg-agent employs a periodic self-test to detect a stolen
466 socket. This usually means a second instance of gpg-agent has
467 taken over the socket and gpg-agent will then terminate itself.
468 This option may be used to disable this self-test for debugging
469 purposes.
470
471
472 --use-standard-socket
473 --no-use-standard-socket
474 --use-standard-socket-p
475 Since GnuPG 2.1 the standard socket is always used. These op‐
476 tions have no more effect. The command gpg-agent --use-stan‐
477 dard-socket-p will thus always return success.
478
479
480 --display string
481 --ttyname string
482 --ttytype string
483 --lc-ctype string
484 --lc-messages string
485 --xauthority string
486 These options are used with the server mode to pass localization
487 information.
488
489
490 --keep-tty
491 --keep-display
492 Ignore requests to change the current tty or X window system's
493 DISPLAY variable respectively. This is useful to lock the
494 pinentry to pop up at the tty or display you started the agent.
495
496
497 --listen-backlog n
498 Set the size of the queue for pending connections. The default
499 is 64.
500
501
502
503 --extra-socket name
504 The extra socket is created by default, you may use this option
505 to change the name of the socket. To disable the creation of
506 the socket use ``none'' or ``/dev/null'' for name.
507
508 Also listen on native gpg-agent connections on the given socket.
509 The intended use for this extra socket is to setup a Unix domain
510 socket forwarding from a remote machine to this socket on the
511 local machine. A gpg running on the remote machine may then
512 connect to the local gpg-agent and use its private keys. This
513 enables decrypting or signing data on a remote machine without
514 exposing the private keys to the remote machine.
515
516
517 --enable-extended-key-format
518 --disable-extended-key-format
519 Since version 2.2.22 keys are created in the extended private
520 key format by default. Changing the passphrase of a key will
521 also convert the key to that new format. This key format is
522 supported since GnuPG version 2.1.12 and thus there should be no
523 need to disable it. Anyway, the disable option still allows to
524 revert to the old behavior for new keys; be aware that keys are
525 never migrated back to the old format. If the enable option has
526 been used the disable option won't have an effect. The advan‐
527 tage of the extended private key format is that it is text based
528 and can carry additional meta data. In extended key format the
529 OCB mode is used for key protection.
530
531
532
533 --enable-ssh-support
534 --enable-putty-support
535
536 The OpenSSH Agent protocol is always enabled, but gpg-agent will
537 only set the SSH_AUTH_SOCK variable if this flag is given.
538
539 In this mode of operation, the agent does not only implement the
540 gpg-agent protocol, but also the agent protocol used by OpenSSH
541 (through a separate socket). Consequently, it should be possi‐
542 ble to use the gpg-agent as a drop-in replacement for the well
543 known ssh-agent.
544
545 SSH Keys, which are to be used through the agent, need to be
546 added to the gpg-agent initially through the ssh-add utility.
547 When a key is added, ssh-add will ask for the password of the
548 provided key file and send the unprotected key material to the
549 agent; this causes the gpg-agent to ask for a passphrase, which
550 is to be used for encrypting the newly received key and storing
551 it in a gpg-agent specific directory.
552
553 Once a key has been added to the gpg-agent this way, the gpg-
554 agent will be ready to use the key.
555
556 Note: in case the gpg-agent receives a signature request, the
557 user might need to be prompted for a passphrase, which is neces‐
558 sary for decrypting the stored key. Since the ssh-agent proto‐
559 col does not contain a mechanism for telling the agent on which
560 display/terminal it is running, gpg-agent's ssh-support will use
561 the TTY or X display where gpg-agent has been started. To
562 switch this display to the current one, the following command
563 may be used:
564
565 gpg-connect-agent updatestartuptty /bye
566
567 Although all GnuPG components try to start the gpg-agent as needed,
568 this is not possible for the ssh support because ssh does not know
569 about it. Thus if no GnuPG tool which accesses the agent has been run,
570 there is no guarantee that ssh is able to use gpg-agent for authentica‐
571 tion. To fix this you may start gpg-agent if needed using this simple
572 command:
573
574 gpg-connect-agent /bye
575
576 Adding the --verbose shows the progress of starting the agent.
577
578 The --enable-putty-support is only available under Windows and allows
579 the use of gpg-agent with the ssh implementation putty. This is simi‐
580 lar to the regular ssh-agent support but makes use of Windows message
581 queue as required by putty.
582
583
584
585 --ssh-fingerprint-digest
586
587 Select the digest algorithm used to compute ssh fingerprints
588 that are communicated to the user, e.g. in pinentry dialogs.
589 OpenSSH has transitioned from using MD5 to the more secure
590 SHA256.
591
592
593
594 --auto-expand-secmem n
595 Allow Libgcrypt to expand its secure memory area as required.
596 The optional value n is a non-negative integer with a suggested
597 size in bytes of each additionally allocated secure memory area.
598 The value is rounded up to the next 32 KiB; usual C style pre‐
599 fixes are allowed. For an heavy loaded gpg-agent with many con‐
600 current connection this option avoids sign or decrypt errors due
601 to out of secure memory error returns.
602
603
604 --s2k-calibration milliseconds
605 Change the default calibration time to milliseconds. The given
606 value is capped at 60 seconds; a value of 0 resets to the com‐
607 piled-in default. This option is re-read on a SIGHUP (or gpg‐
608 conf --reload gpg-agent) and the S2K count is then re-cali‐
609 brated.
610
611
612 --s2k-count n
613 Specify the iteration count used to protect the passphrase.
614 This option can be used to override the auto-calibration done by
615 default. The auto-calibration computes a count which requires
616 by default 100ms to mangle a given passphrase. See also --s2k-
617 calibration.
618
619 To view the actually used iteration count and the milliseconds
620 required for an S2K operation use:
621
622 gpg-connect-agent 'GETINFO s2k_count' /bye
623 gpg-connect-agent 'GETINFO s2k_time' /bye
624
625 To view the auto-calibrated count use:
626
627 gpg-connect-agent 'GETINFO s2k_count_cal' /bye
628
629
630
632 It is important to set the environment variable GPG_TTY in your login
633 shell, for example in the ‘~/.bashrc’ init script:
634
635 export GPG_TTY=$(tty)
636
637 If you enabled the Ssh Agent Support, you also need to tell ssh about
638 it by adding this to your init script:
639
640 unset SSH_AGENT_PID
641 if [ "${gnupg_SSH_AUTH_SOCK_by:-0}" -ne $$ ]; then
642 export SSH_AUTH_SOCK="$(gpgconf --list-dirs agent-ssh-socket)"
643 fi
644
645
646
647
649 There are a few configuration files needed for the operation of the
650 agent. By default they may all be found in the current home directory
651 (see: [option --homedir]).
652
653
654
655 gpg-agent.conf
656 This is the standard configuration file read by gpg-agent on
657 startup. It may contain any valid long option; the leading
658 two dashes may not be entered and the option may not be abbre‐
659 viated.
660 This file is also read after a SIGHUP however only a few
661 options will actually have an effect. This default name may
662 be
663 changed on the command line (see: [option --options]).
664 You should backup this file.
665
666
667 trustlist.txt
668 This is the list of trusted keys. You should backup this
669 file.
670
671 Comment lines, indicated by a leading hash mark, as well as
672 empty
673 lines are ignored. To mark a key as trusted you need to enter
674 its
675 fingerprint followed by a space and a capital letter S.
676 Colons
677 may optionally be used to separate the bytes of a fingerprint;
678 this
679 enables cutting and pasting the fingerprint from a key listing
680 output. If
681 the line is prefixed with a ! the key is explicitly marked as
682 not trusted.
683
684 Here is an example where two keys are marked as ultimately
685 trusted
686 and one as not trusted:
687
688 .RS 2
689 # CN=Wurzel ZS 3,O=Intevation GmbH,C=DE
690 A6935DD34EF3087973C706FC311AA2CCF733765B S
691
692 # CN=PCA-1-Verwaltung-02/O=PKI-1-Verwaltung/C=DE
693 DC:BD:69:25:48:BD:BB:7E:31:6E:BB:80:D3:00:80:35:D4:F8:A6:CD S
694
695 # CN=Root-CA/O=Schlapphuete/L=Pullach/C=DE
696 !14:56:98:D3:FE:9C:CA:5A:31:6E:BC:81:D3:11:4E:00:90:A3:44:C2 S
697 .fi
698
699 Before entering a key into this file, you need to ensure its
700 authenticity. How to do this depends on your organisation; your
701 administrator might have already entered those keys which are deemed
702 trustworthy enough into this file. Places where to look for the
703 fingerprint of a root certificate are letters received from the CA or
704 the website of the CA (after making 100% sure that this is indeed the
705 website of that CA). You may want to consider disallowing interactive
706 updates of this file by using the [option --no-allow-mark-trusted].
707 It might even be advisable to change the permissions to read-only so
708 that this file can't be changed inadvertently.
709
710 As a special feature a line include-default will include a global
711 list of trusted certificates (e.g. ‘/etc/gnupg/trustlist.txt’).
712 This global list is also used if the local list is not available.
713
714 It is possible to add further flags after the S for use by the
715 caller:
716
717
718
719 relax Relax checking of some root certificate requirements. As of now this
720 flag allows the use of root certificates with a missing basicConstraints
721 attribute (despite that it is a MUST for CA certificates) and disables
722 CRL checking for the root certificate.
723
724
725 cm If validation of a certificate finally issued by a CA with this flag set
726 fails, try again using the chain validation model.
727
728
729
730
731 sshcontrol
732 This file is used when support for the secure shell agent protocol has
733 been enabled (see: [option --enable-ssh-support]). Only keys present in
734 this file are used in the SSH protocol. You should backup this file.
735
736 The ssh-add tool may be used to add new entries to this file;
737 you may also add them manually. Comment lines, indicated by a leading
738 hash mark, as well as empty lines are ignored. An entry starts with
739 optional whitespace, followed by the keygrip of the key given as 40 hex
740 digits, optionally followed by the caching TTL in seconds and another
741 optional field for arbitrary flags. A non-zero TTL overrides the global
742 default as set by --default-cache-ttl-ssh.
743
744 The only flag support is confirm. If this flag is found for a
745 key, each use of the key will pop up a pinentry to confirm the use of
746 that key. The flag is automatically set if a new key was loaded into
747 gpg-agent using the option -c of the ssh-add
748 command.
749
750 The keygrip may be prefixed with a ! to disable an entry.
751
752 The following example lists exactly one key. Note that keys available
753 through a OpenPGP smartcard in the active smartcard reader are
754 implicitly added to this list; i.e. there is no need to list them.
755
756 # Key added on: 2011-07-20 20:38:46
757 # Fingerprint: 5e:8d:c4:ad:e7:af:6e:27:8a:d6:13:e4:79:ad:0b:81
758 34B62F25E277CF13D3C6BCEBFD3F85D08F0A864B 0 confirm
759
760
761 private-keys-v1.d/
762
763 This is the directory where gpg-agent stores the private keys.
764 Each
765 key is stored in a file with the name made up of the keygrip
766 and the
767 suffix ‘key’. You should backup all files in this directory
768 and take great care to keep this backup closed away.
769
770
771
772 Note that on larger installations, it is useful to put predefined files
773 into the directory ‘/etc/skel/.gnupg’ so that newly created users start
774 up with a working configuration. For existing users the a small helper
775 script is provided to create these files (see: [addgnupghome]).
776
777
778
779
780
782 A running gpg-agent may be controlled by signals, i.e. using the kill
783 command to send a signal to the process.
784
785 Here is a list of supported signals:
786
787
788
789 SIGHUP This signal flushes all cached passphrases and if the program
790 has been started with a configuration file, the configuration
791 file is read again. Only certain options are honored: quiet,
792 verbose, debug, debug-all, debug-level, debug-pinentry, no-grab,
793 pinentry-program, pinentry-invisible-char, default-cache-ttl,
794 max-cache-ttl, ignore-cache-for-signing, s2k-count, no-allow-ex‐
795 ternal-cache, allow-emacs-pinentry, no-allow-mark-trusted, dis‐
796 able-scdaemon, and disable-check-own-socket. scdaemon-program
797 is also supported but due to the current implementation, which
798 calls the scdaemon only once, it is not of much use unless you
799 manually kill the scdaemon.
800
801
802
803 SIGTERM
804 Shuts down the process but waits until all current requests are
805 fulfilled. If the process has received 3 of these signals and
806 requests are still pending, a shutdown is forced.
807
808
809 SIGINT Shuts down the process immediately.
810
811
812 SIGUSR1
813 Dump internal information to the log file.
814
815
816 SIGUSR2
817 This signal is used for internal purposes.
818
819
821 gpg(1), gpgsm(1), gpgconf(1), gpg-connect-agent(1), scdaemon(1)
822
823 The full documentation for this tool is maintained as a Texinfo manual.
824 If GnuPG and the info program are properly installed at your site, the
825 command
826
827 info gnupg
828
829 should give you access to the complete manual including a menu struc‐
830 ture and an index.
831
832
833
834GnuPG 2.2.27 2020-12-21 GPG-AGENT(1)