ba98ae87cc21acc5cdd6f67ffa2b837170b07eee
[gnupg.git] / doc / gpgsm.texi
1 @c Copyright (C) 2002 Free Software Foundation, Inc.
2 @c This is part of the GnuPG manual.
3 @c For copying conditions, see the file gnupg.texi.
4
5 @node Invoking GPGSM
6 @chapter Invoking GPGSM
7 @cindex GPGSM command options
8 @cindex command options
9 @cindex options, GPGSM command
10
11 @c man begin DESCRIPTION
12
13 @command{gpgsm} is a tool similar to @command{gpg} to provide digital
14 encryption and signing servicesd on X.509 certificates and the CMS
15 protocol.  It is mainly used as a backend for S/MIME mail processing.
16 @command{gpgsm} includes a full features certificate management and
17 complies with all rules defined for the German Sphinx project.
18
19 @c man end
20
21 @xref{Option Index}, for an index to @command{GPGSM}'s commands and options.
22
23 @menu
24 * GPGSM Commands::        List of all commands.
25 * GPGSM Options::         List of all options.
26 * GPGSM Examples::        Some usage examples.
27
28 Developer information:
29 * Unattended Usage::      Using @command{gpgsm} from other programs.
30 * GPGSM Protocol::        The protocol the server mode uses.
31 @end menu
32
33 @c man begin COMMANDS
34
35 @node GPGSM Commands
36 @section Commands
37
38 Commands are not distinguished from options execpt for the fact that
39 only one one command is allowed.
40
41 @menu
42 * General Commands::        Commands not specific to the functionality.
43 * Operational Commands::    Commands to select the type of operation.
44 * Certificate Management::  How to manage certificates.
45 @end menu
46
47 @node General Commands
48 @subsection Commands not specific to the function
49
50 @table @gnupgtabopt
51 @item --version
52 @opindex version
53 Print the program version and licensing information.  Not that you can
54 abbreviate this command.
55
56 @item --help, -h
57 @opindex help
58 Print a usage message summarizing the most usefule command-line options.
59 Not that you can abbreviate this command.
60
61 @item --dump-options
62 @opindex dump-options
63 Print a list of all available options and commands.  Not that you can
64 abbreviate this command.
65 @end table
66
67
68
69 @node Operational Commands
70 @subsection Commands to select the type of operation
71
72 @table @gnupgtabopt
73 @item --encrypt
74 @opindex encrypt
75 Perform an encryption.
76
77 @item --decrypt
78 @opindex decrypt
79 Perform a decryption; the type of input is automatically detmerined.  It
80 may either be in binary form or PEM encoded; automatic determination of
81 base-64 encoding is not done.
82
83 @item --sign
84 @opindex sign
85 Create a digital signature.  The key used is either the fist one found
86 in the keybox or thise set with the -u option
87
88 @item --verify
89 @opindex verify
90 Check a signature file for validity.  Depending on the arguments a
91 detached signatrue may also be checked.
92  
93 @item --server
94 @opindex server
95 Run in server mode and wait for commands on the @code{stdin}.
96
97 @item --call-dirmngr @var{command} [@var{args}]
98 @opindex call-dirmngr
99 Behave as a Dirmngr client issuing the request @var{command} with the
100 optional list of @var{args}.  The output of the Dirmngr is printed
101 stdout.  Please note that file names given as arguments should have an
102 absulte file name (i.e. commencing with @code{/} because they are
103 passed verbatim to the Dirmngr and the working directory of the
104 Dirmngr might not be the same as the one of this client.  Currently it
105 is not possible to pass data via stdin to the Dirmngr.  @var{command}
106 should not contain spaces.
107
108 This is command is required for certain maintaining tasks of the dirmngr
109 where a dirmngr must be able to call back to @command{gpgsm}.  See the Dirmngr
110 manual for details.
111
112 @item --call-protect-tool @var{arguments}
113 @opindex call-protect-tool
114 Certain maintenance operations are done by an external program call
115 @command{gpg-protect-tool}; this is usually not installed in a directory
116 listed in the PATH variable.  This command provides a simple wrapper to
117 access this tool.  @var{arguments} are passed verbatim to this command;
118 use @samp{--help} to get a list of supported operations. 
119
120
121 @end table
122
123
124 @node Certificate Management
125 @subsection How to manage the certificate and keys
126
127 @table @gnupgtabopt
128 @item --gen-key
129 @opindex gen-key
130 Generate a new key and a certificate request.
131
132 @item --list-keys
133 @itemx -k 
134 @opindex list-keys
135 List all available certificates stored in the local key database.
136 Note that the displayed data might be reformatted for better human
137 readability and illegal characters are replaced by safe substitutes.
138
139 @item --list-secret-keys
140 @itemx -K
141 @opindex list-secret-keys
142 List all available certificates for which a corresponding a secret key
143 is available.
144
145 @item --list-external-keys @var{pattern}
146 @opindex list-keys
147 List certificates matching @var{pattern} using an external server.  This
148 utilizes the @code{dirmngr} service.  
149
150 @item --dump-keys
151 @opindex dump-keys
152 List all available certificates stored in the local key database using a
153 format useful mainly for debugging.
154
155 @item --dump-secret-keys
156 @opindex dump-secret-keys
157 List all available certificates for which a corresponding a secret key
158 is available using a format useful mainly for debugging.
159
160 @item --dump-external-keys @var{pattern}
161 @opindex dump-external-keys
162 List certificates matching @var{pattern} using an external server.
163 This utilizes the @code{dirmngr} service.  It uses a format useful
164 mainly for debugging.
165
166 @item --keydb-clear-some-cert-flags
167 @opindex keydb-clear-some-cert-flags
168 This is a debugging aid to reset certain flags in the key database
169 which are used to cache certain certificate stati.  It is especially
170 useful if a bad CRL or a weird running OCSP reponder did accidently
171 revoke certificate.  There is no security issue with this command
172 because @command{gpgsm} always make sure that the validity of a certificate is
173 checked right before it is used.
174
175 @item --delete-keys @var{pattern}
176 @opindex delete-keys
177 Delete the keys matching @var{pattern}.
178
179 @item --export [@var{pattern}]
180 @opindex export
181 Export all certificates stored in the Keybox or those specified by the
182 optional @var{pattern}.  When using along with the @code{--armor} option
183 a few informational lines are prepended before each block.
184
185 @item --export-secret-key-p12 @var{key-id}
186 @opindex export
187 Export the private key and the certificate identified by @var{key-id}
188 in a PKCS#12 format. When using along with the @code{--armor} option
189 a few informational lines are prepended to the output.  Note, that the
190 PKCS#12 format is higly insecure and this command is only provided if
191 there is no other way to exchange the private key.
192
193 @item --import [@var{files}]
194 @opindex import
195 Import the certificates from the PEM or binary encoded files as well as
196 from signed-only messages.  This command may also be used to import a
197 secret key from a PKCS#12 file.
198
199 @item --learn-card
200 @opindex learn-card
201 Read information about the private keys from the smartcard and import
202 the certificates from there.  This command utilizes the @sc{gpg-agent}
203 and in turn the @sc{scdaemon}.
204
205 @item --passwd @var{user_id}
206 @opindex passwd
207 Change the passphrase of the private key belonging to the certificate
208 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
209 smartcard is not yet supported.
210
211 @end table
212
213
214 @node GPGSM Options
215 @section Option Summary
216
217 @command{GPGSM} comes features a bunch ofoptions to control the exact behaviour
218 and to change the default configuration.
219
220 @menu 
221 * Configuration Options::   How to change the configuration.
222 * Certificate Options::     Certificate related options.
223 * Input and Output::        Input and Output.
224 * CMS Options::             How to change how the CMS is created.
225 * Esoteric Options::        Doing things one usually don't want to do.
226 @end menu
227
228 @c man begin OPTIONS
229
230 @node Configuration Options
231 @subsection How to change the configuration
232
233 These options are used to change the configuraton and are usually found
234 in the option file.
235
236 @table @gnupgtabopt
237
238 @item --options @var{file}
239 @opindex options
240 Reads configuration from @var{file} instead of from the default
241 per-user configuration file.  The default configuration file is named
242 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
243 below the home directory of the user.
244
245 @item --homedir @var{dir}
246 @opindex homedir
247 Set the name of the home directory to @var{dir}. If his option is not
248 used, the home directory defaults to @file{~/.gnupg}.  It is only
249 recognized when given on the command line.  It also overrides any home
250 directory stated through the environment variable @env{GNUPGHOME} or
251 (on W32 systems) by means on the Registry entry
252 @var{HKCU\Software\GNU\GnuPG:HomeDir}.
253
254
255 @item -v
256 @item --verbose
257 @opindex v
258 @opindex verbose
259 Outputs additional information while running.
260 You can increase the verbosity by giving several
261 verbose commands to @command{gpgsm}, such as @samp{-vv}.
262
263 @item --policy-file @var{filename}
264 @opindex policy-file
265 Change the default name of the policy file to @var{filename}.
266
267 @item --agent-program @var{file}
268 @opindex agent-program
269 Specify an agent program to be used for secret key operations.  The
270 default value is the @file{/usr/local/bin/gpg-agent}.  This is only used
271 as a fallback when the envrionment variable @code{GPG_AGENT_INFO} is not
272 set or a running agent can't be connected.
273   
274 @item --dirmngr-program @var{file}
275 @opindex dirmnr-program
276 Specify a dirmngr program to be used for @acronym{CRL} checks.  The
277 default value is @file{/usr/sbin/dirmngr}.  This is only used as a
278 fallback when the environment variable @code{DIRMNGR_INFO} is not set or
279 a running dirmngr can't be connected.
280
281 @item --prefer-system-dirmngr
282 @opindex prefer-system-dirmngr
283 If a system wide @command{dirmngr} is running in daemon mode, first try
284 to connect to this one.  Fallback to a pipe based server if this does
285 not work.
286
287 @item --no-secmem-warning
288 @opindex no-secmem-warning
289 Don't print a warning when the so called "secure memory" can't be used.
290
291 @item --log-file @var{file}
292 @opindex log-file
293 When running in server mode, append all logging output to @var{file}.
294
295 @end table
296
297
298 @node Certificate Options
299 @subsection Certificate related options
300
301 @table @gnupgtabopt
302
303 @item  --enable-policy-checks
304 @itemx --disable-policy-checks
305 @opindex enable-policy-checks
306 @opindex disable-policy-checks
307 By default policy checks are enabled.  These options may be used to
308 change it.
309
310 @item  --enable-crl-checks
311 @itemx --disable-crl-checks
312 @opindex enable-crl-checks
313 @opindex disable-crl-checks
314 By default the @acronym{CRL} checks are enabled and the DirMngr is used
315 to check for revoked certificates.  The disable option is most useful
316 with an off-line network connection to suppress this check.
317
318 @item  --enable-trusted-cert-crl-check
319 @itemx --disable-trusted-cert-crl-check
320 @opindex enable-trusted-cert-crl-check
321 @opindex disable-trusted-cert-crl-check
322 By default the @acronym{CRL} for trusted root certificates are checked
323 like for any other certificates.  This allows a CA to revoke its own
324 certificates voluntary without the need of putting all ever issued
325 certificates into a CRL.  The disable option may be used to switch this
326 extra check off.  Due to the caching done by the Dirmngr, there won't be
327 any noticeable performance gain.  Note, that this also disables possible
328 OCSP checks for trusted root certificates.
329
330 @item --force-crl-refresh
331 @opindex force-crl-refresh
332 Tell the dirmngr to reload the CRL for each request.  For better
333 performance, the dirmngr will actually optimize this by suppressing
334 the loading for short time intervalls (e.g. 30 minutes). This option
335 is useful to make sure that a fresh CRL is available for certificates
336 hold in the keybox.  The suggested way of doing this is by using it
337 along with the option @option{--with-validation} for a ke listing
338 command.  This option should not be used in a configuration file. 
339
340 @item  --enable-ocsp
341 @itemx --disable-ocsp
342 @opindex enable-ocsp
343 @opindex disable-ocsp
344 Be default @acronym{OCSP} checks are disabled.  The enable opton may
345 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
346 are also enabled, CRLs will be used as a fallback if for some reason an
347 OCSP request won't succeed.  Note, that you have to allow OCSP
348 requests in Dirmngr's configuration too (option 
349 @option{--allow-ocsp} and configure dirmngr properly.  If you don't do
350 so you will get the error code @samp{Not supported}.
351
352 @end table
353
354 @node Input and Output
355 @subsection Input and Output
356
357 @table @gnupgtabopt
358 @item --armor
359 @itemx -a
360 @opindex armor
361 @opindex -a
362 Create PEM encoded output.  Default is binary output. 
363
364 @item --base64 
365 @opindex base64
366 Create Base-64 encoded output; i.e. PEM without the header lines.
367
368 @item --assume-armor
369 @opindex assume-armor
370 Assume the input data is PEM encoded.  Default is to autodetect the
371 encoding but this is may fail.
372
373 @item --assume-base64
374 @opindex assume-base64
375 Assume the input data is plain base-64 encoded.
376
377 @item --assume-binary
378 @opindex assume-binary
379 Assume the input data is binary encoded.
380
381 @item --local-user @var{user_id}
382 @item -u @var{user_id}
383 @opindex local-user
384 @opindex -u
385 Set the user(s) to be used for signing.  The default is the first
386 secret key found in the database.
387
388 @item --with-key-data
389 @opindex with-key-data
390 Displays extra information with the @code{--list-keys} commands.  Especially
391 a line tagged @code{grp} is printed which tells you the keygrip of a
392 key.  This string is for example used as the file name of the
393 secret key.
394
395 @item --with-validation
396 @opindex with-validation
397 When doing a key listing, do a full validation check for each key and
398 print the result.  This is usually a slow operation because it
399 requires a CRL lookup and other operations. 
400
401 When used along with --import, a validation of the certificate to
402 import is done and only imported if it succeeds the test.  Note that
403 this does not affect an already available cwertificate in the DB.
404 This option is therefore useful to simply verify a certificate.
405
406
407 @item --with-md5-fingerprint
408 For standard key listings, also print the MD5 fingerprint of the
409 certificate.
410
411 @end table
412
413 @node CMS Options
414 @subsection How to change how the CMS is created.
415
416 @table @gnupgtabopt
417 @item --include-certs @var{n}
418 Using @var{n} of -2 includes all certificate except for the root cert,
419 -1 includes all certs, 0 does not include any certs, 1 includes only
420 the signers cert (this is the default) and all other positive
421 values include up to @var{n} certificates starting with the signer cert.
422   
423 @end table
424
425
426
427 @node Esoteric Options
428 @subsection Doing things one usually don't want to do.
429
430
431 @table @gnupgtabopt
432
433 @item --faked-system-time @var{epoch}
434 @opindex faked-system-time
435 This option is only useful for testing; it sets the system time back or
436 forth to @var{epoch} which is the number of seconds elapsed since the year
437 1970.
438
439 @item --with-ephemeral-keys
440 @opindex with-ephemeral-keys
441 Include ephemeral flagged keys in the output of key listings.
442
443 @item --debug-level @var{level}
444 @opindex debug-level
445 Select the debug level for investigating problems. @var{level} may be
446 one of:
447
448    @table @code
449    @item none
450    no debugging at all.
451    @item basic  
452    some basic debug messages
453    @item advanced
454    more verbose debug messages
455    @item expert
456    even more detailed messages
457    @item guru
458    all of the debug messages you can get
459    @end table
460
461 How these messages are mapped to the actual debugging flags is not
462 specified and may change with newer releaes of this program. They are
463 however carefully selected to best aid in debugging.
464
465 @item --debug @var{flags}
466 @opindex debug
467 This option is only useful for debugging and the behaviour may change
468 at any time without notice; using @code{--debug-levels} is the
469 preferred method to select the debug verbosity.  FLAGS are bit encoded
470 and may be given in usual C-Syntax. The currently defined bits are:
471
472    @table @code
473    @item 0  (1)
474    X.509 or OpenPGP protocol related data
475    @item 1  (2)  
476    values of big number integers 
477    @item 2  (4)
478    low level crypto operations
479    @item 5  (32)
480    memory allocation
481    @item 6  (64)
482    caching
483    @item 7  (128)
484    show memory statistics.
485    @item 9  (512)
486    write hashed data to files named @code{dbgmd-000*}
487    @item 10 (1024)
488    trace Assuan protocol
489    @end table
490
491 Note, that all flags set using this option may get overriden by
492 @code{--debug-level}.
493
494 @item --debug-all
495 @opindex debug-all
496 Same as @code{--debug=0xffffffff}
497
498 @item --debug-allow-core-dump
499 @opindex debug-allow-core-dump
500 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
501 disabling core dumps for security reasons.  However, bugs are pretty
502 durable beasts and to squash them it is sometimes useful to have a core
503 dump.  This option enables core dumps unless the Bad Thing happened
504 before the option parsing.
505
506 @item --debug-no-chain-validation
507 @opindex debug-no-chain-validation
508 This is actually not a debugging option but only useful as such.  It
509 lets @command{gpgsm} bypass all certificate chain validation checks.
510
511 @item --debug-ignore-expiration
512 @opindex debug-ignore-expiration
513 This is actually not a debugging option but only useful as such.  It
514 lets @command{gpgsm} ignore all notAfter dates, this is used by the regresssion
515 tests.
516
517 @item --fixed-passphrase @var{string}
518 @opindex fixed-passphrase
519 Supply the passphrase @var{string} to the gpg-protect-tool.  This
520 option is only useful for the regression tests included with this
521 package and may be revised or removed at any time without notice.
522
523 @end table
524
525 All the long options may also be given in the configuration file after
526 stripping off the two leading dashes.
527
528
529
530 @c 
531 @c  Examples
532 @c
533 @node GPGSM Examples
534 @section Examples
535
536 @c man begin EXAMPLES
537
538 @example
539 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
540 @end example
541
542 @c man end
543
544
545
546 @c ---------------------------------
547 @c    The machine interface
548 @c --------------------------------
549 @node Unattended Usage
550 @section Unattended Usage
551
552 @command{gpgsm} is often used as a backend engine by other software.  To help
553 with this a machine interface has been defined to have an unambiguous
554 way to do this.  This is most likely used with the @code{--server} command
555 but may also be used in the standard operation mode by using the
556 @code{--status-fd} option.
557
558 @menu
559 * Automated signature checking::  Automated signature checking.
560 @end menu
561
562 @node Automated signature checking,,,Unattended Usage
563 @section Automated signature checking
564
565 It is very important to understand the semantics used with signature
566 verification.  Checking a signature is not as simple as it may sound and
567 so the ooperation si a bit complicated.  In mosted cases it is required
568 to look at several status lines.  Here is a table of all cases a signed
569 message may have:
570
571 @table @asis
572 @item The signature is valid
573 This does mean that the signature has been successfully verified, the
574 certificates are all sane.  However there are two subcases with
575 important information:  One of the certificates may have expired or a
576 signature of a message itself as expired.  It is a sound practise to
577 consider such a signature still as valid but additional information
578 should be displayed.  Depending on the subcase @command{gpgsm} will issue
579 these status codes:
580   @table @asis 
581   @item signature valid and nothing did expire
582   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
583   @item signature valid but at least one certificate has expired
584   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
585   @item signature valid but expired
586   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
587   Note, that this case is currently not implemented.
588   @end table
589
590 @item The signature is invalid
591 This means that the signature verification failed (this is an indication
592 of af a transfer error, a programm error or tampering with the message).
593 @command{gpgsm} issues one of these status codes sequences:
594   @table @code
595   @item  @code{BADSIG}
596   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
597   @end table
598
599 @item Error verifying a signature
600 For some reason the signature could not be verified, i.e. it can't be
601 decided whether the signature is valid or invalid.  A common reason for
602 this is a missing certificate.
603
604 @end table
605
606
607 @c 
608 @c  Assuan Protocol
609 @c
610 @node GPGSM Protocol
611 @section The Protocol the Server Mode Uses.
612
613 Description of the protocol used to access @command{GPGSM}.
614 @command{GPGSM} does implement the Assuan protocol and in addition
615 provides a regular command line interface which exhibits a full client
616 to this protocol (but uses internal linking).  To start
617 @command{gpgsm} as a server the command line the option
618 @code{--server} must be used.  Additional options are provided to
619 select the communication method (i.e. the name of the socket).
620
621 We assume that the connection has already been established; see the
622 Assuan manual for details.
623
624 @menu
625 * GPGSM ENCRYPT::         Encrypting a message.
626 * GPGSM DECRYPT::         Decrypting a message.
627 * GPGSM SIGN::            Signing a message.
628 * GPGSM VERIFY::          Verifying a message.
629 * GPGSM GENKEY::          Generating a key.
630 * GPGSM LISTKEYS::        List available keys.
631 * GPGSM EXPORT::          Export certificates.
632 * GPGSM IMPORT::          Import certificates.
633 * GPGSM DELETE::          Delete certificates.
634 @end menu
635
636
637 @node GPGSM ENCRYPT
638 @subsection Encrypting a Message
639
640 Before encrytion can be done the recipient must be set using the
641 command:
642
643 @example
644   RECIPIENT @var{userID}
645 @end example
646
647 Set the recipient for the encryption.  @var{userID} should be the
648 internal representation of the key; the server may accept any other way
649 of specification.  If this is a valid and trusted recipient the server
650 does respond with OK, otherwise the return is an ERR with the reason why
651 the recipient can't be used, the encryption will then not be done for
652 this recipient.  If the policy is not to encrypt at all if not all
653 recipients are valid, the client has to take care of this.  All
654 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
655 successful @code{ENCRYPT} command.
656
657 @example
658   INPUT FD=@var{n} [--armor|--base64|--binary]
659 @end example
660
661 Set the file descriptor for the message to be encrypted to @var{n}.
662 Obviously the pipe must be open at that point, the server establishes
663 its own end.  If the server returns an error the client should consider
664 this session failed.
665
666 The @code{--armor} option may be used to advice the server that the
667 input data is in @acronym{PEM} format, @code{--base64} advices that a
668 raw base-64 encoding is used, @code{--binary} advices of raw binary
669 input (@acronym{BER}).  If none of these options is used, the server
670 tries to figure out the used encoding, but this may not always be
671 correct.
672
673 @example
674   OUTPUT FD=@var{n} [--armor|--base64]
675 @end example
676
677 Set the file descriptor to be used for the output (i.e. the encrypted
678 message). Obviously the pipe must be open at that point, the server
679 establishes its own end.  If the server returns an error he client
680 should consider this session failed.
681
682 The option armor encodes the output in @acronym{PEM} format, the
683 @code{--base64} option applies just a base 64 encoding.  No option
684 creates binary output (@acronym{BER}).
685   
686 The actual encryption is done using the command
687
688 @example
689   ENCRYPT 
690 @end example
691
692 It takes the plaintext from the @code{INPUT} command, writes to the
693 ciphertext to the file descriptor set with the @code{OUTPUT} command,
694 take the recipients from all the recipients set so far.  If this command
695 fails the clients should try to delete all output currently done or
696 otherwise mark it as invalid.  @command{GPGSM} does ensure that there won't be any
697 security problem with leftover data on the output in this case.
698
699 This command should in general not fail, as all necessary checks have
700 been done while setting the recipients.  The input and output pipes are
701 closed.
702
703
704 @node GPGSM DECRYPT
705 @subsection Decrypting a message
706
707 Input and output FDs are set the same way as in encryption, but
708 @code{INPUT} refers to the ciphertext and output to the plaintext. There
709 is no need to set recipients.  @command{GPGSM} automatically strips any
710 @acronym{S/MIME} headers from the input, so it is valid to pass an
711 entire MIME part to the INPUT pipe.
712
713 The encryption is done by using the command
714
715 @example
716   DECRYPT
717 @end example
718
719 It performs the decrypt operation after doing some check on the internal
720 state. (e.g. that all needed data has been set).  Because it utilizes
721 the GPG-Agent for the session key decryption, there is no need to ask
722 the client for a protecting passphrase - GpgAgent takes care of this by
723 requesting this from the user.
724
725
726 @node GPGSM SIGN
727 @subsection Signing a Message
728
729 Signing is usually done with these commands:
730
731 @example
732   INPUT FD=@var{n} [--armor|--base64|--binary]
733 @end example
734
735 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
736
737 @example
738   OUTPUT FD=@var{m} [--armor|--base64]
739 @end example
740
741 Write the output to file descriptor @var{m}.  If a detached signature is
742 requested, only the signature is written.
743
744 @example
745   SIGN [--detached] 
746 @end example
747
748 Sign the data set with the INPUT command and write it to the sink set by
749 OUTPUT.  With @code{--detached}, a detached signature is created
750 (surprise).
751
752 The key used for signining is the default one or the one specified in
753 the configuration file.  To get finer control over the keys, it is
754 possible to use the command
755
756 @example
757   SIGNER @var{userID}
758 @end example
759
760 to the signer's key.  @var{userID} should be the
761 internal representation of the key; the server may accept any other way
762 of specification.  If this is a valid and trusted recipient the server
763 does respond with OK, otherwise the return is an ERR with the reason why
764 the key can't be used, the signature will then not be created using
765 this key.  If the policy is not to sign at all if not all
766 keys are valid, the client has to take care of this.  All
767 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
768 Note that a @code{SIGN} does not reset this list of signers which is in
769 contrats to the @code{RECIPIENT} command.
770
771
772 @node GPGSM VERIFY
773 @subsection Verifying a Message
774
775 To verify a mesage the command:
776
777 @example
778   VERIFY
779 @end example
780
781 is used. It does a verify operation on the message send to the input FD.
782 The result is written out using status lines.  If an output FD was
783 given, the signed text will be written to that.  If the signature is a
784 detached one, the server will inquire about the signed material and the
785 client must provide it.
786
787 @node GPGSM GENKEY
788 @subsection Generating a Key
789
790 This is used to generate a new keypair, store the secret part in the
791 @acronym{PSE} and the public key in the key database.  We will probably
792 add optional commands to allow the client to select whether a hardware
793 token is used to store the key.  Configuration options to @command{GPGSM} can be
794 used to restrict the use of this command.
795
796 @example
797   GENKEY 
798 @end example
799
800 @command{GPGSM} checks whether this command is allowed and then does an
801 INQUIRY to get the key parameters, the client should then send the
802 key parameters in the native format:
803
804 @example
805     S: INQUIRE KEY_PARAM native
806     C: D foo:fgfgfg
807     C: D bar
808     C: END
809 @end example    
810
811 Please note that the server may send Status info lines while reading the
812 data lines from the client.  After this the key generation takes place
813 and the server eventually does send an ERR or OK response.  Status lines
814 may be issued as a progress indicator.
815
816
817 @node GPGSM LISTKEYS
818 @subsection List available keys
819
820 To list the keys in the internal database or using an external key
821 provider, the command:
822
823 @example
824   LISTKEYS  @var{pattern}
825 @end example
826
827 is used.  To allow multiple patterns (which are ORed during the search)
828 quoting is required: Spaces are to be translated into "+" or into "%20";
829 in turn this requires that the usual escape quoting rules are done.
830
831 @example
832   LISTSECRETKEYS @var{pattern}
833 @end example
834
835 Lists only the keys where a secret key is available.
836
837 The list commands  commands are affected by the option
838
839 @example
840   OPTION list-mode=@var{mode}
841 @end example
842
843 where mode may be:
844 @table @code
845 @item 0 
846 Use default (which is usually the same as 1).
847 @item 1
848 List only the internal keys.
849 @item 2
850 List only the external keys.
851 @item 3
852 List internal and external keys.
853 @end table
854
855 Note that options are valid for the entire session.
856     
857
858 @node GPGSM EXPORT
859 @subsection Export certificates
860
861 To export certificate from the internal key database the command:
862
863 @example
864   EXPORT @var{pattern}
865 @end example
866
867 is used.  To allow multiple patterns (which are ORed) quoting is
868 required: Spaces are to be translated into "+" or into "%20"; in turn
869 this requires that the usual escape quoting rules are done.
870
871 The format of the output depends on what was set with the OUTPUT
872 command.  When using @acronym{PEM} encoding a few informational lines
873 are prepended.
874
875
876 @node GPGSM IMPORT
877 @subsection Import certificates
878
879 To import certificates into the internal key database, the command
880
881 @example
882   IMPORT
883 @end example
884
885 is used.  The data is expected on the file descriptor set with the
886 @code{INPUT} command.  Certain checks are performend on the
887 certificate.  Note that the code will also handle PKCS\#12 files and
888 import private keys; a helper program is used for that.
889
890
891 @node GPGSM DELETE
892 @subsection Delete certificates
893
894 To delete certificate the command
895
896 @example
897   DELKEYS @var{pattern}
898 @end example
899
900 is used.  To allow multiple patterns (which are ORed) quoting is
901 required: Spaces are to be translated into "+" or into "%20"; in turn
902 this requires that the usual escape quoting rules are done.
903
904 The certificates must be specified unambiguously otherwise an error is
905 returned.
906