doc: Add --binary option for the OUTPUT command of an uiserver.
[gpgme.git] / doc / uiserver.texi
1 @c uiserver.texi                    -*- mode: texinfo; coding: latin-1; -*-
2 @c Specification of the UI server protocol.
3 @c To be included by gpgme.texi
4
5 @node UI Server Protocol
6 @appendix The GnuPG UI Server Protocol
7 @cindex UI server
8 @cindex user interface server
9
10
11 This section specifies the protocol used between clients and a User
12 Interface Server (UI server).  This protocol helps to build a system
13 where all cryptographic operations are done by a server and the server
14 is responsible for all dialogs.  Although @acronym{GPGME} has no direct
15 support for this protocol it is believed that servers will utilize the
16 @acronym{GPGME} library; thus having the specification included in this
17 manual is an appropriate choice.  This protocol should be referenced as
18 `The GnuPG UI Server Protocol'.
19
20 @noindent
21 A server needs to implement these commands:@footnote{In all examples we
22 assume that the connection has already been established; see the Assuan
23 manual for details.}
24
25 @menu
26 * UI Server Encrypt::                Encrypt a message.
27 * UI Server Sign::                   Sign a message.
28 * UI Server Decrypt::                Decrypt a message.
29 * UI Server Verify::                 Verify a message.
30 * UI Server Set Input Files::        Specifying the input files to operate on.
31 * UI Server Sign/Encrypt Files::     Encrypting and signing files.
32 * UI Server Verify/Decrypt Files::   Decrypting and verifying files.
33 * UI Server Import/Export Keys::     Managing certificates.
34 * UI Server Checksum Files::         Create and verify checksums for files.
35 * Miscellaneous UI Server Commands::   Commands not related to a specific operation.
36 @end menu
37
38
39
40 @node UI Server Encrypt
41 @section UI Server: Encrypt a Message
42
43 Before encryption can be done the recipients must be set using the
44 command:
45
46 @deffn Command RECIPIENT @var{string}
47
48 Set the recipient for the encryption.  @var{string} is an RFC-2822
49 recipient name ("mailbox" as per section 3.4).  This command may or may
50 not check the recipient for validity right away; if it does not all
51 recipients are expected to be checked at the time of the @code{ENCRYPT}
52 command.  All @code{RECIPIENT} commands are cumulative until a
53 successful @code{ENCRYPT} command or until a @code{RESET} command.
54 Linefeeds are obviously not allowed in @var{string} and should be folded
55 into spaces (which are equivalent).
56 @end deffn
57
58 @noindent
59 To tell the server the source and destination of the data, the next two
60 commands are to be used:
61
62 @deffn Command INPUT FD=@var{n}
63 Set the file descriptor for the message to be encrypted to @var{n}.  The
64 message send to the server is binary encoded.
65
66 GpgOL is a Windows only program, thus @var{n} is not a libc file
67 descriptor but a regular system handle.  Given that the Assuan
68 connection works over a socket, it is not possible to use regular
69 inheritance to make the file descriptor available to the server.
70 Thus @code{DuplicateHandle} needs to be used to duplicate a handle
71 to the server process.  This is the reason that the server needs to
72 implement the @code{GETINFO pid} command.  Sending this command a second
73 time replaces the file descriptor set by the last one.
74 @c If @var{n} is not given, this commands uses the
75 @c %last file descriptor passed to the application.
76 @c %@xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the
77 @c %Libassuan manual}, on how to do descriptor passing.
78 @end deffn
79
80 @deffn Command OUTPUT FD=@var{n} [--binary]
81 Set the file descriptor to be used for the output (i.e. the encrypted
82 message) to @var{n}.  If the option @code{--binary} is given the
83 output shall be in binary format; if not given, the output for OpenPGP
84 needs to be ASCII armored and for CMS Base-64 encoded.  For details on
85 the file descriptor, see the @code{INPUT} command.
86 @end deffn
87
88 @noindent
89 The setting of the recipients, the data source and destination may
90 happen in any order, even intermixed.  If this has been done the actual
91 encryption operation is called using:
92
93 @deffn Command ENCRYPT -@w{}-protocol=@var{name}
94
95 This command reads the plaintext from the file descriptor set by the
96 @code{INPUT} command, encrypts it and writes the ciphertext to the file
97 descriptor set by the @code{OUTPUT} command.  The server may (and
98 should) overlap reading and writing.  The recipients used for the
99 encryption are all the recipients set so far.  If any recipient is not
100 usable the server should take appropriate measures to notify the user
101 about the problem and may cancel the operation by returning an error
102 code.  The used file descriptors are void after this command; the
103 recipient list is only cleared if the server returns success.
104
105 @noindent
106 Because GpgOL uses a streaming mode of operation the server is not
107 allowed to auto select the protocol and must obey to the mandatory
108 @var{protocol} parameter:
109
110 @table @code
111 @item OpenPGP
112 Use the OpenPGP protocol (RFC-2440).
113 @item CMS
114 Use the CMS (PKCS#7) protocol (RFC-3852).
115 @end table
116
117 @end deffn
118
119 To support automagically selection of the protocol depending on the
120 selected keys, the server MAY implement the command:
121
122 @deffn Command PREP_ENCRYPT [-@w{}-protocol=@var{name}] [-@w{}-expect-sign]
123
124 This commands considers all recipients set so far and decides whether it
125 is able to take input and start the actual encryption.  This is kind of
126 a dry-run @command{ENCRYPT} without requiring or using the input and
127 output file descriptors.  The server shall cache the result of any user
128 selection to avoid asking this again when the actual @command{ENCRYPT}
129 command is send.  The @option{--protocol} option is optional; if it is
130 not given, the server should allow the user to select the protocol to be
131 used based on the recipients given or by any other means.
132
133 If @option{--expect-sign} is given the server should expect that the
134 message will also be signed and use this hint to present a unified
135 recipient and signer selection dialog if possible and desired.  A
136 selected signer should then be cached for the expected SIGN command
137 (which is expected in the same session but possible on another
138 connection).
139
140 If this command is given again before a successful @command{ENCRYPT}
141 command, the second one takes effect.
142
143 Before sending the OK response the server shall tell the client the
144 protocol to be used (either the one given by the argument or the one
145 selected by the user) by means of a status line:
146 @end deffn
147
148 @deffn {Status line} PROTOCOL @var{name}
149 Advise the client to use the protocol @var{name} for the
150 @command{ENCRYPT} command.  The valid protocol names are listed under
151 the description of the @command{ENCRYPT} command.  The server shall emit
152 exactly one PROTOCOL status line.
153 @end deffn
154
155 @noindent
156 Here is an example of a complete encryption sequence; client lines are
157 indicated by a @sc{c:}, server responses by @sc{c:}:
158
159 @smallexample
160 @group
161   @clnt RESET
162   @srvr OK
163   @clnt RECIPIENT foo@@example.net
164   @srvr OK
165   @clnt RECIPIENT bar@@example.com
166   @srvr OK
167   @clnt PREP_ENCRYPT
168   @srvr S PROTOCOL OpenPGP
169   @srvr OK
170   @clnt INPUT FD=17
171   @srvr OK
172   @clnt OUTPUT FD=18
173   @srvr OK
174   @clnt ENCRYPT
175   @srvr OK
176 @end group
177 @end smallexample
178
179
180
181 @node UI Server Sign
182 @section UI Server: Sign a Message
183
184 The server needs to implement opaque signing as well as detached
185 signing.  Due to the nature of OpenPGP messages it is always required to
186 send the entire message to the server; sending just the hash is not
187 possible.  The following two commands are required to set the input and
188 output file descriptors:
189
190 @deffn Command INPUT FD=@var{n}
191 Set the file descriptor for the message to be signed to @var{n}.  The
192 message send to the server is binary encoded.  For details on the file
193 descriptor, see the description of @code{INPUT} in the @code{ENCRYPT}
194 section.
195 @end deffn
196
197 @deffn Command OUTPUT FD=@var{n} [--binary]
198 Set the file descriptor to be used for the output.  The output is
199 either the complete signed message or in case of a detached signature
200 just that detached signature.  If the option @code{--binary} is given
201 the output shall be in binary format; if not given, the output for
202 OpenPGP needs to be ASCII armored and for CMS Base-64 encoded.  For
203 details on the file descriptor, see the @code{INPUT} command.
204 @end deffn
205
206 @noindent
207 To allow the server the selection of a non-default signing key the
208 client may optionally use the @code{SENDER} command, see @ref{command
209 SENDER}.
210
211 @noindent
212 The signing operation is then initiated by:
213
214 @deffn Command SIGN -@w{}-protocol=@var{name} [-@w{}-detached]
215 Sign the data set with the @code{INPUT} command and write it to the sink
216 set by OUTPUT.  @var{name} is the signing protocol used for the
217 message. For a description of the allowed protocols see the
218 @code{ENCRYPT} command.  With option @code{--detached} given, a detached
219 signature is created; this is actually the usual way the command is
220 used.
221 @end deffn
222
223 @noindent
224 The client expects the server to send at least this status information
225 before the final OK response:
226
227 @deffn {Status line} MICALG @var{string}
228 The @var{string} represents the hash algorithm used to create the
229 signature. It is used with MOSS style signature messages and defined by
230 PGP/MIME (RFC-3156) and S/MIME (RFC-3851).  The GPGME library has a
231 supporting function @code{gpgme_hash_algo_name} to return the algorithm
232 name as a string.  This string needs to be lowercased and for OpenPGP
233 prefixed with "@code{pgp-}".
234 @end deffn
235
236
237
238 @node UI Server Decrypt
239 @section UI Server: Decrypt a Message
240
241 Decryption may include the verification of OpenPGP messages.  This is
242 due to the often used combined signing/encryption modus of OpenPGP.  The
243 client may pass an option to the server to inhibit the signature
244 verification.  The following two commands are required to set the input
245 and output file descriptors:
246
247 @deffn Command INPUT FD=@var{n}
248 Set the file descriptor for the message to be decrypted to @var{n}.  The
249 message send to the server is either binary encoded or --- in the case
250 of OpenPGP --- ASCII armored.  For details on the file descriptor, see
251 the description of @code{INPUT} in the @code{ENCRYPT} section.
252 @end deffn
253
254 @deffn Command OUTPUT FD=@var{n}
255 Set the file descriptor to be used for the output. The output is binary
256 encoded. For details on the file descriptor, see the description of
257 @code{INPUT} in the @code{ENCRYPT} section.
258 @end deffn
259
260 @noindent
261 The decryption is started with the command:
262
263 @deffn Command DECRYPT -@w{}-protocol=@var{name} [-@w{}-no-verify]
264 @var{name} is the encryption protocol used for the message. For a
265 description of the allowed protocols see the @code{ENCRYPT} command.
266 This argument is mandatory.  If the option @option{--no-verify} is given,
267 the server should not try to verify a signature, in case the input data
268 is an OpenPGP combined message.
269 @end deffn
270
271
272 @node UI Server Verify
273 @section UI Server: Verify a Message
274
275 The server needs to support the verification of opaque signatures as
276 well as detached signatures.  The kind of input sources controls what
277 kind message is to be verified.
278
279 @deffn Command MESSAGE FD=@var{n}
280 This command is used with detached signatures to set the file descriptor
281 for the signed data to @var{n}. The data is binary encoded (used
282 verbatim).  For details on the file descriptor, see the description of
283 @code{INPUT} in the @code{ENCRYPT} section.
284 @end deffn
285
286 @deffn Command INPUT FD=@var{n}
287 Set the file descriptor for the opaque message or the signature part of
288 a detached signature to @var{n}.  The message send to the server is
289 either binary encoded or -- in the case of OpenPGP -- ASCII armored.
290 For details on the file descriptor, see the description of @code{INPUT}
291 in the @code{ENCRYPT} section.
292 @end deffn
293
294 @deffn Command OUTPUT FD=@var{n}
295 Set the file descriptor to be used for the output. The output is binary
296 encoded and only used for opaque signatures.  For details on the file
297 descriptor, see the description of @code{INPUT} in the @code{ENCRYPT}
298 section.
299 @end deffn
300
301 @noindent
302 The verification is then started using:
303
304 @deffn Command VERIFY -@w{}-protocol=@var{name} [-@w{}-silent]
305 @var{name} is the signing protocol used for the message. For a
306 description of the allowed protocols see the @code{ENCRYPT} command.
307 This argument is mandatory.  Depending on the combination of
308 @code{MESSAGE} @code{INPUT} and @code{OUTPUT} commands, the server needs
309 to select the appropriate verification mode:
310
311 @table @asis
312 @item MESSAGE and INPUT
313 This indicates a detached signature.  Output data is not applicable.
314 @item INPUT
315 This indicates an opaque signature.  As no output command has been given,
316 the server is only required to check the signature.
317 @item INPUT and OUTPUT
318 This indicates an opaque signature.  The server shall write the signed
319 data to the file descriptor set by the output command.  This data shall
320 even be written if the signatures can't be verified.
321 @end table
322 @end deffn
323
324 With @option{--silent} the server shall not display any dialog; this is
325 for example used by the client to get the content of opaque signed
326 messages. The client expects the server to send at least this status
327 information before the final OK response:
328
329 @deffn {Status line} SIGSTATUS @var{flag} @var{displaystring}
330 Returns the status for the signature and a short string explaining the
331 status.  Valid values for @var{flag} are:
332
333 @table @code
334 @item none
335 The message has a signature but it could not not be verified due to a
336 missing key.
337 @item green
338 The signature is fully valid.
339 @item yellow
340 The signature is valid but additional information was shown regarding the
341 validity of the key.
342 @item red
343 The signature is not valid.
344 @end table
345
346 @var{displaystring} is a percent-and-plus-encoded string with a short
347 human readable description of the status.  For example
348
349 @smallexample
350 S SIGSTATUS green Good+signature+from+Keith+Moon+<keith@@example.net>
351 @end smallexample
352
353 Note that this string needs to fit into an Assuan line and should be
354 short enough to be displayed as short one-liner on the clients window.
355 As usual the encoding of this string is UTF-8 and it should be send in
356 its translated form.
357
358 The server shall send one status line for every signature found on the
359 message.
360
361
362 @end deffn
363
364
365 @node UI Server Set Input Files
366 @section UI Server: Specifying the input files to operate on.
367
368 All file related UI server commands operate on a number of input files
369 or directories, specified by one or more @code{FILE} commands:
370
371 @deffn Command FILE @var{name} [--continued]
372 Add the file or directory @var{name} to the list of pathnames to be
373 processed by the server.  The parameter @var{name} must be an absolute
374 path name (including the drive letter) and is percent espaced (in
375 particular, the characters %, = and white space characters are always
376 escaped).  The option @code{--continued} is present for all but the
377 last @code{FILE} command.
378 @end deffn
379
380
381 @node UI Server Sign/Encrypt Files
382 @section UI Server: Encrypting and signing files.
383
384 First, the input files need to be specified by one or more
385 @code{FILE} commands.  Afterwards, the actual operation is requested:
386
387 @deffn Command ENCRYPT_FILES --nohup
388 @deffnx Command SIGN_FILES --nohup
389 @deffnx Command ENCRYPT_SIGN_FILES --nohup
390 Request that the files specified by @code{FILE} are encrypted and/or
391 signed.  The command selects the default action.  The UI server may
392 allow the user to change this default afterwards interactively, and
393 even abort the operation or complete it only on some of the selected
394 files and directories.
395
396 What it means to encrypt or sign a file or directory is specific to
397 the preferences of the user, the functionality the UI server provides,
398 and the selected protocol.  Typically, for each input file a new file
399 is created under the original filename plus a protocol specific
400 extension (like @code{.gpg} or @code{.sig}), which contain the
401 encrypted/signed file or a detached signature.  For directories, the
402 server may offer multiple options to the user (for example ignore or
403 process recursively).
404
405 The @code{ENCRYPT_SIGN_FILES} command requests a combined sign and
406 encrypt operation.  It may not be available for all protocols (for
407 example, it is available for OpenPGP but not for CMS).
408
409 The option @code{--nohup} is mandatory.  It is currently unspecified
410 what should happen if @code{--nohup} is not present.  Because
411 @code{--nohup} is present, the server always returns @code{OK}
412 promptly, and completes the operation asynchronously.
413 @end deffn
414
415
416 @node UI Server Verify/Decrypt Files
417 @section UI Server: Decrypting and verifying files.
418
419 First, the input files need to be specified by one or more
420 @code{FILE} commands.  Afterwards, the actual operation is requested:
421
422 @deffn Command DECRYPT_FILES --nohup
423 @deffnx Command VERIFY_FILES --nohup
424 @deffnx Command DECRYPT_VERIFY_FILES --nohup
425 Request that the files specified by @code{FILE} are decrypted and/or
426 verified.  The command selects the default action.  The UI server may
427 allow the user to change this default afterwards interactively, and
428 even abort the operation or complete it only on some of the selected
429 files and directories.
430
431 What it means to decrypt or verify a file or directory is specific to
432 the preferences of the user, the functionality the UI server provides,
433 and the selected protocol.  Typically, for decryption, a new file is
434 created for each input file under the original filename minus a
435 protocol specific extension (like @code{.gpg}) which contains the
436 original plaintext.  For verification a status is displayed for each
437 signed input file, indicating if it is signed, and if yes, if the
438 signature is valid.  For files that are signed and encrypted, the
439 @code{VERIFY} command transiently decrypts the file to verify the
440 enclosed signature.  For directories, the server may offer multiple
441 options to the user (for example ignore or process recursively).
442
443 The option @code{--nohup} is mandatory.  It is currently unspecified
444 what should happen if @code{--nohup} is not present.  Because
445 @code{--nohup} is present, the server always returns @code{OK}
446 promptly, and completes the operation asynchronously.
447 @end deffn
448
449
450 @node UI Server Import/Export Keys
451 @section UI Server: Managing certificates.
452
453 First, the input files need to be specified by one or more
454 @code{FILE} commands.  Afterwards, the actual operation is requested:
455
456 @deffn Command IMPORT_FILES --nohup
457 Request that the certificates contained in the files specified by
458 @code{FILE} are imported into the local certificate databases.
459
460 For directories, the server may offer multiple options to the user
461 (for example ignore or process recursively).
462
463 The option @code{--nohup} is mandatory.  It is currently unspecified
464 what should happen if @code{--nohup} is not present.  Because
465 @code{--nohup} is present, the server always returns @code{OK}
466 promptly, and completes the operation asynchronously.
467 @end deffn
468
469 FIXME: It may be nice to support an @code{EXPORT} command as well,
470 which is enabled by the context menu of the background of a directory.
471
472
473 @node UI Server Checksum Files
474 @section UI Server: Create and verify checksums for files.
475
476 First, the input files need to be specified by one or more
477 @code{FILE} commands.  Afterwards, the actual operation is requested:
478
479 @deffn Command CHECKSUM_CREATE_FILES --nohup
480 Request that checksums are created for the files specifed by
481 @code{FILE}.  The choice of checksum algorithm and the destination
482 storage and format for the created checksums depend on the preferences
483 of the user and the functionality provided by the UI server.  For
484 directories, the server may offer multiple options to the user (for
485 example ignore or process recursively).
486
487 The option @code{--nohup} is mandatory.  It is currently unspecified
488 what should happen if @code{--nohup} is not present.  Because
489 @code{--nohup} is present, the server always returns @code{OK}
490 promptly, and completes the operation asynchronously.
491 @end deffn
492
493
494 @deffn Command CHECKSUM_VERIFY_FILES --nohup
495 Request that checksums are created for the files specifed by
496 @code{FILE} and verified against previously created and stored
497 checksums.  The choice of checksum algorithm and the source storage
498 and format for previously created checksums depend on the preferences
499 of the user and the functionality provided by the UI server.  For
500 directories, the server may offer multiple options to the user (for
501 example ignore or process recursively).
502
503 If the source storage of previously created checksums is available to
504 the user through the Windows shell, this command may also accept such
505 checksum files as @code{FILE} arguments.  In this case, the UI server
506 should instead verify the checksum of the referenced files as if they
507 were given as INPUT files.
508
509 The option @code{--nohup} is mandatory.  It is currently unspecified
510 what should happen if @code{--nohup} is not present.  Because
511 @code{--nohup} is present, the server always returns @code{OK}
512 promptly, and completes the operation asynchronously.
513 @end deffn
514
515
516
517
518 @c
519 @c M I S C E L L A N E O U S  C O M M A N D S
520 @c
521 @node Miscellaneous UI Server Commands
522 @section Miscellaneous UI Server Commands
523
524 The server needs to implement the following commands which are not
525 related to a specific command:
526
527 @deffn Command GETINFO @var{what}
528 This is a multi purpose command, commonly used to return a variety of
529 information.  The required subcommands as described by the @var{what}
530 parameter are:
531
532 @table @code
533 @item pid
534 Return the process id of the server in decimal notation using an Assuan
535 data line.
536 @end table
537 @end deffn
538
539
540 @noindent
541 To allow the server to pop up the windows in the correct relation to the
542 client, the client is advised to tell the server by sending the option:
543
544 @deffn {Command option} window-id @var{number}
545 The @var{number} represents the native window ID of the clients current
546 window.  On Windows systems this is a windows handle (@code{HWND}) and
547 on X11 systems it is the @code{X Window ID}.  The number needs to be
548 given as a hexadecimal value so that it is easier to convey pointer
549 values (e.g. @code{HWND}).
550 @end deffn
551
552
553 @noindent
554 A client may want to fire up the certificate manager of the server.  To
555 do this it uses the Assuan command:
556
557 @deffn Command START_KEYMANAGER
558 The server shall pop up the main window of the key manager (aka
559 certificate manager).  The client expects that the key manager is brought
560 into the foregound and that this command immediatley returns (does not
561 wait until the key manager has been fully brought up).
562 @end deffn
563
564 @noindent
565 A client may want to fire up the configuration dialog of the server.  To
566 do this it uses the Assuan command:
567
568 @deffn Command START_CONFDIALOG
569 The server shall pop up its configuration dialog.  The client expects
570 that this dialog is brought into the foregound and that this command
571 immediatley returns (i.e. it does not wait until the dialog has been
572 fully brought up).
573 @end deffn
574
575 @anchor{command SENDER}
576 @noindent
577 When doing an operation on a mail, it is useful to let the server know
578 the address of the sender:
579
580 @deffn Command SENDER [-@w{}-info] [-@w{}-protocol=@var{name}] @var{email}
581 @var{email} is the plain ASCII encoded address ("addr-spec" as per
582 RFC-2822) enclosed in angle brackets.  The address set with this command
583 is valid until a successful completion of the operation or until a
584 @code{RESET} command.  A second command overrides the effect of the
585 first one; if @var{email} is not given and @option{--info} is not used,
586 the server shall use the default signing key.
587
588 If option @option{--info} is not given, the server shall also suggest a
589 protocol to use for signing.  The client may use this suggested protocol
590 on its own discretion.  The same status line as with PREP_ENCRYPT is
591 used for this.
592
593 The option @option{--protocol} may be used to give the server a hint on
594 which signing protocol should be preferred.
595 @end deffn
596
597 @noindent
598 To allow the UI-server to visually identify a running operation or to
599 associate operations the server MAY support the command:
600
601 @deffn Command SESSION @var{number} [@var{string}]
602 The @var{number} is an arbitrary value, a server may use to associate
603 simultaneous running sessions.  It is a 32 bit unsigned integer with
604 @code{0} as a special value indicating that no session association shall
605 be done.
606
607 If @var{string} is given, the server may use this as the title of a
608 window or, in the case of an email operation, to extract the sender's
609 address. The string may contain spaces; thus no plus-escaping is used.
610
611 This command may be used at any time and overrides the effect of the
612 last command.  A @code{RESET} undoes the effect of this command.
613
614 @end deffn