99716db7911951654d4d716abc12599339af5116
[gnupg.git] / doc / scdaemon.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 SCDAEMON
6 @chapter Invoking the SCDAEMON
7 @cindex SCDAEMON command options
8 @cindex command options
9 @cindex options, SCDAEMON command
10
11 @manpage scdaemon.1
12 @ifset manverb
13 .B scdaemon
14 \- Smartcard daemon for the GnuPG system
15 @end ifset
16
17 @mansect synopsis
18 @ifset manverb
19 .B  scdaemon
20 .RB [ \-\-homedir
21 .IR dir ]
22 .RB [ \-\-options
23 .IR file ]
24 .RI [ options ]  
25 .B  \-\-server 
26 .br
27 .B  scdaemon
28 .RB [ \-\-homedir
29 .IR dir ]
30 .RB [ \-\-options
31 .IR file ]
32 .RI [ options ]  
33 .B  \-\-daemon 
34 .RI [ command_line ]
35 @end ifset
36
37
38 @mansect description
39 The @command{scdaemon} is a daemon to manage smartcards.  It is usually
40 invoked by @command{gpg-agent} and in general not used directly.
41
42 @manpause
43 @xref{Option Index}, for an index to @command{scdaemon}'s commands and
44 options.
45 @mancont
46
47 @menu
48 * Scdaemon Commands::      List of all commands.
49 * Scdaemon Options::       List of all options.
50 * Card applications::      Description of card applications.
51 * Scdaemon Configuration:: Configuration files.
52 * Scdaemon Examples::      Some usage examples.
53 * Scdaemon Protocol::      The protocol the daemon uses.
54 @end menu
55
56 @mansect commands
57
58 @node Scdaemon Commands
59 @section Commands
60
61 Commands are not distinguished from options except for the fact that
62 only one command is allowed.
63
64 @table @gnupgtabopt
65 @item --version
66 @opindex version
67 Print the program version and licensing information.  Not that you can
68 abbreviate this command.
69
70 @item --help, -h
71 @opindex help
72 Print a usage message summarizing the most usefule command-line options.
73 Not that you can abbreviate this command.
74
75 @item --dump-options
76 @opindex dump-options
77 Print a list of all available options and commands.  Not that you can
78 abbreviate this command.
79
80 @item --server
81 @opindex server
82 Run in server mode and wait for commands on the @code{stdin}.  This is
83 default mode is to create a socket and listen for commands there.
84
85 @item --multi-server
86 @opindex multi-server
87 Run in server mode and wait for commands on the @code{stdin} as well as
88 on an additional Unix Domain socket.  The server command @code{GETINFO}
89 may be used to get the name of that extra socket.
90
91 @item --daemon
92 @opindex daemon
93 Run the program in the background.  This option is required to prevent
94 it from being accidently running in the background.
95
96 @end table
97
98
99 @mansect options
100
101 @node Scdaemon Options
102 @section Option Summary
103
104 @table @gnupgtabopt
105
106 @item --options @var{file}
107 @opindex options
108 Reads configuration from @var{file} instead of from the default
109 per-user configuration file.  The default configuration file is named
110 @file{scdaemon.conf} and expected in the @file{.gnupg} directory directly
111 below the home directory of the user.
112
113 @include opt-homedir.texi
114
115
116 @item -v
117 @item --verbose
118 @opindex v
119 @opindex verbose
120 Outputs additional information while running.
121 You can increase the verbosity by giving several
122 verbose commands to @command{gpgsm}, such as @samp{-vv}.
123
124 @item --debug-level @var{level}
125 @opindex debug-level
126 Select the debug level for investigating problems. @var{level} may be
127 one of:
128
129 @table @code
130 @item none
131 no debugging at all.
132 @item basic  
133 some basic debug messages
134 @item advanced
135 more verbose debug messages
136 @item expert
137 even more detailed messages
138 @item guru
139 all of the debug messages you can get
140 @end table
141
142 How these messages are mapped to the actual debugging flags is not
143 specified and may change with newer releases of this program. They are
144 however carefully selected to best aid in debugging.
145
146 @quotation Note
147 All debugging options are subject to change and thus should not be used
148 by any application program.  As the name says, they are only used as
149 helpers to debug problems.
150 @end quotation
151
152
153 @item --debug @var{flags}
154 @opindex debug
155 This option is only useful for debugging and the behaviour may change at
156 any time without notice.  FLAGS are bit encoded and may be given in
157 usual C-Syntax. The currently defined bits are:
158
159 @table @code
160 @item 0  (1)
161 command I/O
162 @item 1  (2)  
163 values of big number integers 
164 @item 2  (4)
165 low level crypto operations
166 @item 5  (32)
167 memory allocation
168 @item 6  (64)
169 caching
170 @item 7  (128)
171 show memory statistics.
172 @item 9  (512)
173 write hashed data to files named @code{dbgmd-000*}
174 @item 10 (1024)
175 trace Assuan protocol
176 @item 11 (2048)
177 trace APDU I/O to the card.  This may reveal sensitive data.
178 @end table
179
180 @item --debug-all
181 @opindex debug-all
182 Same as @code{--debug=0xffffffff}
183
184 @item --debug-wait @var{n}
185 @opindex debug-wait
186 When running in server mode, wait @var{n} seconds before entering the
187 actual processing loop and print the pid.  This gives time to attach a
188 debugger.
189
190 @item --debug-ccid-driver
191 @opindex debug-wait
192 Enable debug output from the included CCID driver for smartcards.
193 Using this option twice will also enable some tracing of the T=1
194 protocol.  Note that this option may reveal sensitive data.
195
196 @item --debug-disable-ticker
197 @opindex debug-disable-ticker
198 This option disables all ticker functions like checking for card
199 insertions.
200
201 @item --debug-allow-core-dump
202 @opindex debug-allow-core-dump
203 For security reasons we won't create a core dump when the process
204 aborts.  For debugging purposes it is sometimes better to allow core
205 dump.  This options enables it and also changes the working directory to
206 @file{/tmp} when running in @option{--server} mode.
207
208
209 @item --no-detach
210 @opindex no-detach
211 Don't detach the process from the console.  This is mainly useful for
212 debugging.
213
214 @item --log-file @var{file}
215 @opindex log-file
216 Append all logging output to @var{file}.  This is very helpful in
217 seeing what the agent actually does.
218
219
220 @item --pcsc-driver @var{library}
221 @opindex pcsc-driver
222 Use @var{library} to access the smartcard reader.  The current default
223 is @file{libpcsclite.so}.  Instead of using this option you might also
224 want to install a symbolic link to the default file name
225 (e.g. from @file{libpcsclite.so.1}).
226
227 @item --ctapi-driver @var{library}
228 @opindex ctapi-driver
229 Use @var{library} to access the smartcard reader.  The current default
230 is @file{libtowitoko.so}.  Note that the use of this interface is
231 deprecated; it may be removed in future releases.
232
233 @item --disable-ccid 
234 @opindex disable-ccid
235 Disable the integrated support for CCID compliant readers.  This
236 allows to fall back to one of the other drivers even if the internal
237 CCID driver can handle the reader.  Note, that CCID support is only
238 available if libusb was available at build time.
239
240 @item --reader-port @var{number_or_string}
241 @opindex reader-port
242 This option may be used to specify the port of the card terminal.  A
243 value of 0 refers to the first serial device; add 32768 to access USB
244 devices.  The default is 32768 (first USB device).  PC/SC or CCID
245 readers might need a string here; run the program in verbose mode to get
246 a list of available readers.  The default is then the first reader
247 found.
248
249 To get a list of available CCID readers you may use this command:
250 @smallexample
251 echo scd getinfo reader_list | gpg-connect-agent --decode | awk '/^D/ @{print $2@}'
252 @end smallexample
253
254
255 @item --card-timeout @var{n}
256 @opindex card-timeout
257 If @var{n} is not 0 and no client is actively using the card, the card
258 will be powered down after @var{n} seconds.  Powering down the card
259 avoids a potential risk of damaging a card when used with certain
260 cheap readers.  This also allows non Scdaemon aware applications to
261 access the card.  The disadvantage of using a card timeout is that
262 accessing the card takes longer and that the user needs to enter the
263 PIN again after the next power up.
264
265 Note that with the current version of Scdaemon the card is powered
266 down immediatley at the next timer tick for any value of @var{n} other
267 than 0.
268
269
270 @item --disable-keypad
271 @opindex disable-keypad
272 Even if a card reader features a keypad, do not try to use it.
273
274
275 @item --deny-admin
276 @opindex deny-admin
277 @opindex allow-admin
278 This option disables the use of admin class commands for card
279 applications where this is supported.  Currently we support it for the
280 OpenPGP card. This commands is useful to inhibit accidental access to
281 admin class command which could ultimately lock the card through wrong
282 PIN numbers.  Note that GnuPG versions older than 2.0.11 featured an
283 @option{--allow-admin} command which was required to use such admin
284 commands.  This option has no more effect today because the default is
285 now to allow admin commands.
286
287 @item --disable-application @var{name}
288 @opindex disable-application
289 This option disables the use of the card application named
290 @var{name}.  This is mainly useful for debugging or if a application
291 with lower priority should be used by default.
292
293 @end table
294
295 All the long options may also be given in the configuration file after
296 stripping off the two leading dashes.
297
298
299 @mansect card applications
300 @node Card applications
301 @section Description of card applications
302
303 @command{scdaemon} supports the card applications as described below.
304
305 @menu
306 * OpenPGP Card::          The OpenPGP card application
307 * NKS Card::              The Telesec NetKey card application
308 * DINSIG Card::           The DINSIG card application
309 * PKCS#15 Card::          The PKCS#15 card application
310 * Geldkarte Card::        The Geldkarte application
311 @end menu
312
313 @node OpenPGP Card
314 @subsection The OpenPGP card application ``openpgp''
315
316 This application is currently only used by @command{gpg} but may in
317 future also be useful with @command{gpgsm}.  Version 1 and version 2 of
318 the card is supported. 
319
320 The specifications for these cards are available at
321 @uref{http://g10code.com/docs/openpgp-card-1.0.pdf} and
322 @uref{http://g10code.com/docs/openpgp-card-2.0.pdf}.
323
324 @node NKS Card
325 @subsection The Telesec NetKey card ``nks''
326
327 This is the main application of the Telesec cards as available in
328 Germany.  It is a superset of the German DINSIG card.  The card is
329 used by @command{gpgsm}.
330
331 @node DINSIG Card
332 @subsection The DINSIG card application ``dinsig''
333
334 This is an application as described in the German draft standard
335 @emph{DIN V 66291-1}.  It is intended to be used by cards supporting
336 the German signature law and its bylaws (SigG and SigV).
337
338 @node PKCS#15 Card
339 @subsection The PKCS#15 card application ``p15''
340
341 This is common fraqmework for smart card applications.  It is used by
342 @command{gpgsm}.
343
344 @node Geldkarte Card
345 @subsection The Geldkarte card application ``geldkarte''
346
347 This is a simple application to display information of a German
348 Geldkarte.  The Geldkarte is a small amount debit card application which
349 comes with almost all German banking cards.
350
351
352 @c *******************************************
353 @c ***************            ****************
354 @c ***************   FILES    ****************
355 @c ***************            ****************
356 @c *******************************************
357 @mansect files
358 @node Scdaemon Configuration
359 @section Configuration files
360
361 There are a few configuration files to control certain aspects of
362 @command{scdaemons}'s operation. Unless noted, they are expected in the
363 current home directory (@pxref{option --homedir}).
364
365 @table @file
366
367 @item scdaemon.conf
368 @cindex scdaemon.conf
369 This is the standard configuration file read by @command{scdaemon} on
370 startup.  It may contain any valid long option; the leading two dashes
371 may not be entered and the option may not be abbreviated.  This default
372 name may be changed on the command line (@pxref{option --options}).
373
374 @item scd-event
375 @cindex scd-event
376 If this file is present and executable, it will be called on veyer card
377 reader's status changed. An example of this script is provided with the
378 distribution
379
380 @item reader_@var{n}.status
381 This file is created by @command{sdaemon} to let other applications now
382 about reader status changes.  Its use is now deprecated in favor of
383 @file{scd-event}.
384
385 @end table
386
387
388 @c 
389 @c  Examples
390 @c
391 @mansect examples
392 @node Scdaemon Examples
393 @section Examples
394
395 @c man begin EXAMPLES
396
397 @example
398 $ scdaemon --server -v
399 @end example
400
401 @c man end
402
403 @c 
404 @c  Assuan Protocol
405 @c
406 @manpause
407 @node Scdaemon Protocol
408 @section Scdaemon's Assuan Protocol
409
410 The SC-Daemon should be started by the system to provide access to
411 external tokens.  Using Smartcards on a multi-user system does not
412 make much sense expcet for system services, but in this case no
413 regular user accounts are hosted on the machine.
414
415 A client connects to the SC-Daemon by connecting to the socket named
416 @file{/var/run/scdaemon/socket}, configuration information is read from
417 @var{/etc/scdaemon.conf}
418
419 Each connection acts as one session, SC-Daemon takes care of
420 syncronizing access to a token between sessions.
421
422 @menu
423 * Scdaemon SERIALNO::     Return the serial number.
424 * Scdaemon LEARN::        Read all useful information from the card.
425 * Scdaemon READCERT::     Return a certificate.
426 * Scdaemon READKEY::      Return a public key.
427 * Scdaemon PKSIGN::       Signing data with a Smartcard.
428 * Scdaemon PKDECRYPT::    Decrypting data with a Smartcard.
429 * Scdaemon GETATTR::      Read an attribute's value.
430 * Scdaemon SETATTR::      Update an attribute's value.
431 * Scdaemon WRITEKEY::     Write a key to a card.
432 * Scdaemon GENKEY::       Generate a new key on-card.
433 * Scdaemon RANDOM::       Return random bytes generate on-card.
434 * Scdaemon PASSWD::       Change PINs.
435 * Scdaemon CHECKPIN::     Perform a VERIFY operation.
436 * Scdaemon RESTART::      Restart connection
437 * Scdaemon APDU::         Send a verbatim APDU to the card
438 @end menu
439
440 @node Scdaemon SERIALNO 
441 @subsection Return the serial number
442
443 This command should be used to check for the presence of a card.  It is
444 special in that it can be used to reset the card.  Most other commands
445 will return an error when a card change has been detected and the use of
446 this function is therefore required.
447
448 Background: We want to keep the client clear of handling card changes
449 between operations; i.e. the client can assume that all operations are
450 done on the same card unless he call this function.
451
452 @example
453   SERIALNO
454 @end example
455
456 Return the serial number of the card using a status reponse like:
457
458 @example
459   S SERIALNO D27600000000000000000000 0
460 @end example
461
462 The trailing 0 should be ignored for now, it is reserved for a future
463 extension.  The serial number is the hex encoded value identified by 
464 the @code{0x5A} tag in the GDO file (FIX=0x2F02).
465
466
467
468 @node Scdaemon LEARN
469 @subsection Read all useful information from the card
470
471 @example
472   LEARN [--force]
473 @end example
474
475 Learn all useful information of the currently inserted card.  When
476 used without the force options, the command might do an INQUIRE
477 like this:
478
479 @example
480       INQUIRE KNOWNCARDP <hexstring_with_serialNumber> <timestamp>
481 @end example
482
483 The client should just send an @code{END} if the processing should go on
484 or a @code{CANCEL} to force the function to terminate with a cancel
485 error message.  The response of this command is a list of status lines
486 formatted as this:
487
488 @example
489      S KEYPAIRINFO @var{hexstring_with_keygrip} @var{hexstring_with_id}
490 @end example
491
492 If there is no certificate yet stored on the card a single "X" is
493 returned in @var{hexstring_with_keygrip}.
494
495 @node Scdaemon READCERT
496 @subsection Return a certificate
497
498 @example
499  READCERT @var{hexified_certid}|@var{keyid}
500 @end example
501
502 This function is used to read a certificate identified by
503 @var{hexified_certid} from the card.  With OpenPGP cards the keyid
504 @code{OpenPGP.3} may be used to rad the certticate of version 2 cards.
505
506
507 @node Scdaemon READKEY
508 @subsection Return a public key
509
510 @example
511 READKEY @var{hexified_certid}
512 @end example
513
514 Return the public key for the given cert or key ID as an standard
515 S-Expression. 
516
517
518
519 @node Scdaemon PKSIGN
520 @subsection Signing data with a Smartcard
521
522 To sign some data the caller should use the command
523
524 @example
525  SETDATA @var{hexstring}
526 @end example
527
528 to tell @command{scdaemon} about the data to be signed.  The data must be given in
529 hex notation.  The actual signing is done using the command
530
531 @example
532   PKSIGN @var{keyid}
533 @end example
534
535 where @var{keyid} is the hexified ID of the key to be used.  The key id
536 may have been retrieved using the command @code{LEARN}.  If another
537 hash algorithm than SHA-1 is used, that algorithm may be given like:
538
539 @example
540   PKSIGN --hash=@var{algoname} @var{keyid}
541 @end example
542
543 With @var{algoname} are one of @code{sha1}, @code{rmd160} or @code{md5}.
544
545
546 @node Scdaemon PKDECRYPT
547 @subsection Decrypting data with a Smartcard
548
549 To decrypt some data the caller should use the command
550
551 @example
552  SETDATA @var{hexstring}
553 @end example
554
555 to tell @command{scdaemon} about the data to be decrypted.  The data
556 must be given in hex notation.  The actual decryption is then done
557 using the command
558
559 @example
560   PKDECRYPT @var{keyid}
561 @end example
562
563 where @var{keyid} is the hexified ID of the key to be used.
564
565
566 @node Scdaemon GETATTR
567 @subsection Read an attribute's value.
568
569 TO BE WRITTEN.
570
571 @node Scdaemon SETATTR
572 @subsection Update an attribute's value.
573
574 TO BE WRITTEN.
575
576 @node Scdaemon WRITEKEY
577 @subsection Write a key to a card.
578
579 @example
580   WRITEKEY [--force] @var{keyid}
581 @end example
582
583 This command is used to store a secret key on a a smartcard.  The
584 allowed keyids depend on the currently selected smartcard
585 application. The actual keydata is requested using the inquiry
586 @code{KEYDATA} and need to be provided without any protection.  With
587 @option{--force} set an existing key under this @var{keyid} will get
588 overwritten.  The key data is expected to be the usual canonical encoded
589 S-expression.
590
591 A PIN will be requested in most saes.  This however depends on the
592 actual card application.
593
594
595 @node Scdaemon GENKEY
596 @subsection Generate a new key on-card.
597
598 TO BE WRITTEN.
599
600 @node Scdaemon RANDOM
601 @subsection Return random bytes generate on-card.
602
603 TO BE WRITTEN.
604
605
606 @node Scdaemon PASSWD
607 @subsection Change PINs.
608
609 @example
610    PASSWD [--reset] [--nullpin] @var{chvno}
611 @end example
612   
613 Change the PIN or reset the retry counter of the card holder
614 verification vector number @var{chvno}.  The option @option{--nullpin}
615 is used to initialize the PIN of TCOS cards (6 byte NullPIN only).
616
617
618 @node Scdaemon CHECKPIN
619 @subsection Perform a VERIFY operation.
620
621 @example
622   CHECKPIN @var{idstr}
623 @end example
624
625 Perform a VERIFY operation without doing anything else.  This may be
626 used to initialize a the PIN cache earlier to long lasting
627 operations.  Its use is highly application dependent:
628
629 @table @strong
630 @item OpenPGP
631
632 Perform a simple verify operation for CHV1 and CHV2, so that further
633 operations won't ask for CHV2 and it is possible to do a cheap check on
634 the PIN: If there is something wrong with the PIN entry system, only the
635 regular CHV will get blocked and not the dangerous CHV3.  @var{idstr} is
636 the usual card's serial number in hex notation; an optional fingerprint
637 part will get ignored.
638
639 There is however a special mode if @var{idstr} is suffixed with the
640 literal string @code{[CHV3]}: In this case the Admin PIN is checked if
641 and only if the retry counter is still at 3.
642
643 @end table
644
645
646
647 @node Scdaemon RESTART
648 @subsection Perform a RESTART operation.
649
650 @example
651   RESTART
652 @end example
653
654 Restart the current connection; this is a kind of warm reset.  It
655 deletes the context used by this connection but does not actually
656 reset the card. 
657
658 This is used by gpg-agent to reuse a primary pipe connection and
659 may be used by clients to backup from a conflict in the serial
660 command; i.e. to select another application. 
661
662
663
664
665 @node Scdaemon APDU
666 @subsection Send a verbatim APDU to the card.
667
668 @example
669   APDU [--atr] [--more] [@var{hexstring}]
670 @end example
671
672
673 Send an APDU to the current reader.  This command bypasses the high
674 level functions and sends the data directly to the card.
675 @var{hexstring} is expected to be a proper APDU.  If @var{hexstring} is
676 not given no commands are send to the card; However the command will
677 implicitly check whether the card is ready for use.
678
679 Using the option @code{--atr} returns the ATR of the card as a status
680 message before any data like this:
681 @example
682      S CARD-ATR 3BFA1300FF813180450031C173C00100009000B1
683 @end example
684
685 Using the option @code{--more} handles the card status word MORE_DATA
686 (61xx) and concatenate all reponses to one block.
687
688
689
690 @mansect see also
691 @ifset isman
692 @command{gpg-agent}(1),
693 @command{gpgsm}(1), 
694 @command{gpg2}(1)
695 @end ifset
696 @include see-also-note.texi
697