36274e60178eed736c598df6ed71840dd8b1398e
[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 @c man begin DESCRIPTION
12
13 The @sc{scdaeon} is a daemon to manage smartcards.  It is usually
14 invoked by gpg-agent and in general not used directly.
15
16 @c man end
17
18 @xref{Option Index}, for an index to GPG-AGENTS's commands and options.
19
20 @menu
21 * Scdaemon Commands::      List of all commands.
22 * Scdaemon Options::       List of all options.
23 * Scdaemon Examples::      Some usage examples.
24 * Scdaemon Protocol::      The protocol the daemon uses.
25 @end menu
26
27 @c man begin COMMANDS
28
29 @node Scdaemon Commands
30 @section Commands
31
32 Commands are not distinguished from options execpt for the fact that
33 only one one command is allowed.
34
35 @table @gnupgtabopt
36 @item --version
37 @opindex version
38 Print the program version and licensing information.  Not that you can
39 abbreviate this command.
40
41 @item --help, -h
42 @opindex help
43 Print a usage message summarizing the most usefule command-line options.
44 Not that you can abbreviate this command.
45
46 @item --dump-options
47 @opindex dump-options
48 Print a list of all available options and commands.  Not that you can
49 abbreviate this command.
50
51 @item --server
52 @opindex server
53 Run in server mode and wait for commands on the @code{stdin}.  This is
54 default mode is to create a socket and listen for commands there.
55
56 @item --daemon
57 @opindex daemon
58 Run the program in the background.  This option is required to prevent
59 it from being accidently running in the background.
60
61 @item --print-atr
62 @opindex print-atr
63 This is mainly a debugging command, used to print the ATR
64 (Answer-To-Reset) of a card and exit immediately. 
65
66 @end table
67
68
69 @c man begin OPTIONS
70
71 @node Scdaemon Options
72 @section Option Summary
73
74 @table @gnupgtabopt
75
76 @item --options @var{file}
77 @opindex options
78 Reads configuration from @var{file} instead of from the default
79 per-user configuration file.
80
81 @item -v
82 @item --verbose
83 @opindex v
84 @opindex verbose
85 Outputs additional information while running.
86 You can increase the verbosity by giving several
87 verbose commands to @sc{gpgsm}, such as @samp{-vv}.
88
89 @item --debug @var{flags}
90 @opindex debug
91 This option is only useful for debugging and the behaviour may change at
92 any time without notice.  FLAGS are bit encoded and may be given in
93 usual C-Syntax. The currently defined bits are:
94    @table @code
95    @item 0  (1)
96    X.509 or OpenPGP protocol related data
97    @item 1  (2)  
98    values of big number integers 
99    @item 2  (4)
100    low level crypto operations
101    @item 5  (32)
102    memory allocation
103    @item 6  (64)
104    caching
105    @item 7  (128)
106    show memory statistics.
107    @item 9  (512)
108    write hashed data to files named @code{dbgmd-000*}
109    @item 10 (1024)
110    trace Assuan protocol
111    @item 12 (4096)
112    bypass all certificate validation
113    @end table
114
115 @item --debug-all
116 @opindex debug-all
117 Same as @code{--debug=0xffffffff}
118
119 @item --debug-wait @var{n}
120 @opindex debug-wait
121 When running in server mode, wait @var{n} seconds before entering the
122 actual processing loop and print the pid.  This gives time to attach a
123 debugger.
124
125 @item --debug-sc @var{n}
126 @opindex debug-sc
127 Set the debug level of the OpenSC library to @var{n}.
128
129 @item --no-detach
130 @opindex no-detach
131 Don't detach the process from the console.  This is manly usefule for
132 debugging.
133
134 @item --log-file @var{file}
135 @opindex log-file
136 Append all logging output to @var{file}.  This is very helpful in
137 seeing what the agent actually does.
138
139 @item --reader-port @var{number}
140 When the program has been build without OpenSC support, this option must
141 be used to specify the port of the card terminal.  A value of 0 refers
142 to the first serial device; add 32768 to access USB devices.  The
143 default is 32768 (first USB device).
144
145 @item --ctapi-driver @var{library}
146 Use @var{library} to access the smartcard reader.  The current default
147 is @code{libtowitoko.so}.
148
149 @end table
150
151 All the long options may also be given in the configuration file after
152 stripping off the two leading dashes.
153
154
155 @c 
156 @c  Examples
157 @c
158 @node Scdaemon Examples
159 @section Examples
160
161 @c man begin EXAMPLES
162
163 @example
164 $ scdaemon --server -v
165 @end example
166
167 @c man end
168
169 @c 
170 @c  Assuan Protocol
171 @c
172 @node Scdaemon Protocol
173 @section Scdaemon's Assuan Protocol
174
175 The SC-Daemon should be started by the system to provide access to
176 external tokens.  Using Smartcards on a multi-user system does not
177 make much sense expcet for system services, but in this case no
178 regular user accounts are hosted on the machine.
179
180 A client connects to the SC-Daemon by connecting to the socket named
181 @file{/var/run/scdaemon/socket}, configuration information is read from
182 @var{/etc/scdaemon.conf}
183
184 Each connection acts as one session, SC-Daemon takes care of
185 syncronizing access to a token between sessions.
186
187 @menu
188 * Scdaemon SERIALNO::     Return the serial number.
189 * Scdaemon LEARN::        Read all useful information from the card.
190 * Scdaemon READCERT::     Return a certificate.
191 * Scdaemon READKEY::      Return a public key.
192 * Scdaemon PKSIGN::       Signing data with a Smartcard.
193 * Scdaemon PKDECRYPT::    Decrypting data with a Smartcard.
194 @end menu
195
196 @node Scdaemon SERIALNO 
197 @subsection Return the serial number
198
199 This command should be used to check for the presence of a card.  It is
200 special in that it can be used to reset the card.  Most other commands
201 will return an error when a card change has been detected and the use of
202 this function is therefore required.
203
204 Background: We want to keep the client clear of handling card changes
205 between operations; i.e. the client can assume that all operations are
206 done on the same card unless he call this function.
207
208 @example
209   SERIALNO
210 @end example
211
212 Return the serial number of the card using a status reponse like:
213
214 @example
215   S SERIALNO D27600000000000000000000 0
216 @end example
217
218 The trailing 0 should be ignored for now, it is reserved for a future
219 extension.  The serial number is the hex encoded value identified by 
220 the @code{0x5A} tag in the GDO file (FIX=0x2F02).
221
222
223
224 @node Scdaemon LEARN
225 @subsection Read all useful information from the card
226
227 @example
228   LEARN [--force]
229 @end example
230
231 Learn all useful information of the currently inserted card.  When
232 used without the force options, the command might do an INQUIRE
233 like this:
234
235 @example
236       INQUIRE KNOWNCARDP <hexstring_with_serialNumber> <timestamp>
237 @end example
238
239 The client should just send an @code{END} if the processing should go on
240 or a @code{CANCEL} to force the function to terminate with a cancel
241 error message.  The response of this command is a list of status lines
242 formatted as this:
243
244 @example
245      S KEYPAIRINFO @var{hexstring_with_keygrip} @var{hexstring_with_id}
246 @end example
247
248 If there is no certificate yet stored on the card a single "X" is
249 returned in @var{hexstring_with_keygrip}.
250
251 @node Scdaemon READCERT
252 @subsection Return a certificate
253
254 @example
255  READCERT @var{hexified_certid}
256 @end example
257
258 This function is used to read a certificate identified by
259 @var{hexified_certid} from the card.
260
261
262 @node Scdaemon READKEY
263 @subsection Return a public key
264
265 @example
266 READKEY @var{hexified_certid}
267 @end example
268
269 Return the public key for the given cert or key ID as an standard
270 S-Expression. 
271
272
273
274 @node Scdaemon PKSIGN
275 @subsection Signing data with a Smartcard
276
277 To sign some data the caller should use the command
278
279 @example
280  SETDATA @var{hexstring}
281 @end example
282
283 to tell scdaemon about the data to be signed.  The data must be given in
284 hex notation.  The actual signing is done using the command
285
286 @example
287   PKSIGN @var{keyid}
288 @end example
289
290 where @var{keyid} is the hexified ID of the key to be used.  The key id
291 may have been retrieved using the command @code{LEARN}.
292
293
294 @node Scdaemon PKDECRYPT
295 @subsection Decrypting data with a Smartcard
296
297 To decrypt some data the caller should use the command
298
299 @example
300  SETDATA @var{hexstring}
301 @end example
302
303 to tell scdaemon about the data to be decrypted.  The data must be given in
304 hex notation.  The actual decryption is then done using the command
305
306 @example
307   PKDECRYPT @var{keyid}
308 @end example
309
310 where @var{keyid} is the hexified ID of the key to be used.
311