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