Some changes to suport g13.
[gnupg.git] / g10 / server.c
1 /* server.c - server mode for gpg
2  * Copyright (C) 2006, 2008  Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <errno.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <stdarg.h>
26 #include <ctype.h>
27 #include <unistd.h>
28
29
30 #include "gpg.h"
31 #include <assuan.h>
32 #include "util.h"
33 #include "i18n.h"
34 #include "options.h"
35 #include "../common/sysutils.h"
36 #include "status.h"
37
38
39 #define set_error(e,t) assuan_set_error (ctx, gpg_error (e), (t))
40
41
42 /* Data used to associate an Assuan context with local server data.  */
43 struct server_local_s 
44 {
45   /* Our current Assuan context. */
46   assuan_context_t assuan_ctx;  
47   /* File descriptor as set by the MESSAGE command. */
48   gnupg_fd_t message_fd;               
49
50   /* List of prepared recipients.  */
51   pk_list_t recplist;
52
53 };
54
55
56 \f
57 /* Helper to close the message fd if it is open. */
58 static void 
59 close_message_fd (ctrl_t ctrl)
60 {
61   if (ctrl->server_local->message_fd != GNUPG_INVALID_FD)
62     {
63       assuan_sock_close (ctrl->server_local->message_fd);
64       ctrl->server_local->message_fd = GNUPG_INVALID_FD;
65     } 
66 }
67
68
69 /* Skip over options.  Blanks after the options are also removed.  */
70 static char *
71 skip_options (const char *line)
72 {
73   while (spacep (line))
74     line++;
75   while ( *line == '-' && line[1] == '-' )
76     {
77       while (*line && !spacep (line))
78         line++;
79       while (spacep (line))
80         line++;
81     }
82   return (char*)line;
83 }
84
85
86 /* Check whether the option NAME appears in LINE.  */
87 static int
88 has_option (const char *line, const char *name)
89 {
90   const char *s;
91   int n = strlen (name);
92   
93   s = strstr (line, name);
94   if (s && s >= skip_options (line))
95     return 0;
96   return (s && (s == line || spacep (s-1)) && (!s[n] || spacep (s+n)));
97 }
98
99
100
101
102 \f
103 /* Called by libassuan for Assuan options.  See the Assuan manual for
104    details. */
105 static gpg_error_t
106 option_handler (assuan_context_t ctx, const char *key, const char *value)
107 {
108 /*   ctrl_t ctrl = assuan_get_pointer (ctx); */
109
110   (void)ctx;
111   (void)value;
112
113   /* Fixme: Implement the tty and locale args. */
114   if (!strcmp (key, "display"))
115     {
116     }
117   else if (!strcmp (key, "ttyname"))
118     {
119     }
120   else if (!strcmp (key, "ttytype"))
121     {
122     }
123   else if (!strcmp (key, "lc-ctype"))
124     {
125     }
126   else if (!strcmp (key, "lc-messages"))
127     {
128     }
129   else if (!strcmp (key, "xauthority"))
130     {
131     }
132   else if (!strcmp (key, "pinentry_user_data"))
133     {
134     }
135   else if (!strcmp (key, "list-mode"))
136     {
137       /* This is for now a dummy option. */
138     }
139   else
140     return gpg_error (GPG_ERR_UNKNOWN_OPTION);
141
142   return 0;
143 }
144
145
146 /* Called by libassuan for RESET commands. */
147 static void
148 reset_notify (assuan_context_t ctx)
149 {
150   ctrl_t ctrl = assuan_get_pointer (ctx);
151
152   release_pk_list (ctrl->server_local->recplist);
153   ctrl->server_local->recplist = NULL;
154
155   close_message_fd (ctrl);
156   assuan_close_input_fd (ctx);
157   assuan_close_output_fd (ctx);
158 }
159
160
161 /* Called by libassuan for INPUT commands. */
162 static void
163 input_notify (assuan_context_t ctx, const char *line)
164 {
165 /*   ctrl_t ctrl = assuan_get_pointer (ctx); */
166
167   (void)ctx;
168
169   if (strstr (line, "--armor"))
170     ; /* FIXME */
171   else if (strstr (line, "--base64"))
172     ; /* FIXME */
173   else if (strstr (line, "--binary"))
174     ;
175   else
176     {
177       /* FIXME (autodetect encoding) */
178     }
179 }
180
181
182 /* Called by libassuan for OUTPUT commands. */
183 static void
184 output_notify (assuan_context_t ctx, const char *line)
185 {
186 /*   ctrl_t ctrl = assuan_get_pointer (ctx); */
187   
188   (void)ctx;
189
190   if (strstr (line, "--armor"))
191     ; /* FIXME */
192   else if (strstr (line, "--base64"))
193     {
194       /* FIXME */
195     }
196 }
197
198
199
200 \f
201 /*  RECIPIENT [--hidden] <userID>
202
203    Set the recipient for the encryption.  <userID> should be the
204    internal representation of the key; the server may accept any other
205    way of specification.  If this is a valid and trusted recipient the
206    server does respond with OK, otherwise the return is an ERR with
207    the reason why the recipient can't be used, the encryption will
208    then not be done for this recipient.  If the policy is not to
209    encrypt at all if not all recipients are valid, the client has to
210    take care of this.  All RECIPIENT commands are cumulative until a
211    RESET or an successful ENCRYPT command.  */
212 static gpg_error_t
213 cmd_recipient (assuan_context_t ctx, char *line)
214 {
215   ctrl_t ctrl = assuan_get_pointer (ctx);
216   gpg_error_t err;
217   int hidden;
218
219   hidden = has_option (line,"--hidden");
220   line = skip_options (line);
221
222   /* FIXME: Expand groups
223   if (opt.grouplist)
224     remusr = expand_group (rcpts);
225   else
226     remusr = rcpts;
227   */
228
229   err = find_and_check_key (line, PUBKEY_USAGE_ENC, hidden, 
230                             &ctrl->server_local->recplist);
231   
232   if (err)
233     log_error ("command '%s' failed: %s\n", "RECIPIENT", gpg_strerror (err));
234   return err;
235 }
236
237
238 \f
239 /*  SIGNER <userID>
240
241    Set the signer's keys for the signature creation.  <userID> should
242    be the internal representation of the key; the server may accept
243    any other way of specification.  If this is a valid and usable
244    signing key the server does respond with OK, otherwise it returns
245    an ERR with the reason why the key can't be used, the signing will
246    then not be done for this key.  If the policy is not to sign at all
247    if not all signer keys are valid, the client has to take care of
248    this.  All SIGNER commands are cumulative until a RESET but they
249    are *not* reset by an SIGN command becuase it can be expected that
250    set of signers are used for more than one sign operation.
251
252    Note that this command returns an INV_RECP status which is a bit
253    strange, but they are very similar.  */
254 static gpg_error_t
255 cmd_signer (assuan_context_t ctx, char *line)
256 {
257   (void)ctx;
258   (void)line;
259   return gpg_error (GPG_ERR_NOT_SUPPORTED);
260 }
261
262
263 \f
264 /*  ENCRYPT 
265
266    Do the actual encryption process.  Takes the plaintext from the
267    INPUT command, writes the ciphertext to the file descriptor set
268    with the OUTPUT command, take the recipients from all the
269    recipients set so far with RECIPIENTS.
270
271    If this command fails the clients should try to delete all output
272    currently done or otherwise mark it as invalid.  GPG does ensure
273    that there won't be any security problem with leftover data on the
274    output in this case.
275
276    In most cases this command won't fail because most necessary checks
277    have been done while setting the recipients.  However some checks
278    can only be done right here and thus error may occur anyway (for
279    example, no recipients at all).
280
281    The input, output and message pipes are closed after this
282    command.  */
283 static gpg_error_t
284 cmd_encrypt (assuan_context_t ctx, char *line)
285 {
286   ctrl_t ctrl = assuan_get_pointer (ctx);
287   gpg_error_t err;
288   int inp_fd, out_fd;
289
290   (void)line; /* LINE is not used.  */
291
292   if ( !ctrl->server_local->recplist ) 
293     {
294       write_status_text (STATUS_NO_RECP, "0");
295       err = gpg_error (GPG_ERR_NO_USER_ID);
296       goto leave;
297     }
298
299   inp_fd = translate_sys2libc_fd (assuan_get_input_fd (ctx), 0);
300   if (inp_fd == -1)
301     {
302       err = set_error (GPG_ERR_ASS_NO_INPUT, NULL);
303       goto leave;
304     }
305   out_fd = translate_sys2libc_fd (assuan_get_output_fd (ctx), 1);
306   if (out_fd == -1)
307     {
308       err = set_error (GPG_ERR_ASS_NO_OUTPUT, NULL);
309       goto leave;
310     }
311
312   /* Fixme: Check that we are using real files and not pipes if in
313      PGP-2 mode.  Do all the other checks we do in gpg.c for aEncr.
314      Maybe we should drop the PGP2 compatibility. */
315
316   
317   /* FIXME: GPGSM does this here: Add all encrypt-to marked recipients
318      from the default list. */
319
320   /* fixme: err = ctrl->audit? 0 : start_audit_session (ctrl);*/
321     
322   err = encrypt_crypt (inp_fd, NULL, NULL, 0,
323                        ctrl->server_local->recplist,
324                        out_fd);
325
326  leave:
327   /* Release the recipient list on success.  */
328   if (!err)
329     {
330       release_pk_list (ctrl->server_local->recplist);
331       ctrl->server_local->recplist = NULL;
332     }
333
334   /* Close and reset the fds. */
335   close_message_fd (ctrl);
336   assuan_close_input_fd (ctx);
337   assuan_close_output_fd (ctx);
338
339   if (err)
340     log_error ("command '%s' failed: %s\n", "ENCRYPT", gpg_strerror (err));
341   return err;
342 }
343
344
345 \f
346 /*  DECRYPT
347
348    This performs the decrypt operation after doing some checks on the
349    internal state (e.g. that only needed data has been set).   */
350 static gpg_error_t
351 cmd_decrypt (assuan_context_t ctx, char *line)
352 {
353   (void)ctx;
354   (void)line;
355   return gpg_error (GPG_ERR_NOT_SUPPORTED);
356 }
357
358
359 \f
360 /*  VERIFY
361
362    This does a verify operation on the message send to the input-FD.
363    The result is written out using status lines.  If an output FD was
364    given, the signed text will be written to that.
365   
366    If the signature is a detached one, the server will inquire about
367    the signed material and the client must provide it.
368  */
369 static gpg_error_t
370 cmd_verify (assuan_context_t ctx, char *line)
371 {
372   int rc;
373   ctrl_t ctrl = assuan_get_pointer (ctx);
374   gnupg_fd_t fd = assuan_get_input_fd (ctx);
375   gnupg_fd_t out_fd = assuan_get_output_fd (ctx);
376   FILE *out_fp = NULL;
377
378   /* FIXME: Revamp this code it is nearly to 3 years old and was only
379      intended as a quick test.  */
380   
381   (void)line;
382
383   if (fd == GNUPG_INVALID_FD)
384     return gpg_error (GPG_ERR_ASS_NO_INPUT);
385
386   if (out_fd != GNUPG_INVALID_FD)
387     {
388       out_fp = fdopen ( dup (FD2INT (out_fd)), "w");
389       if (!out_fp)
390         return set_error (GPG_ERR_ASS_GENERAL, "fdopen() failed");
391     }
392
393   log_debug ("WARNING: The server mode is WORK "
394              "iN PROGRESS and not ready for use\n");
395
396   /* Need to dup it because it might get closed and libassuan won't
397      know about it then. */
398   rc = gpg_verify (ctrl,
399                    dup ( FD2INT (fd)), 
400                    dup ( FD2INT (ctrl->server_local->message_fd)),
401                    out_fp);
402
403   if (out_fp)
404     fclose (out_fp);
405   close_message_fd (ctrl);
406   assuan_close_input_fd (ctx);
407   assuan_close_output_fd (ctx);
408
409   return rc;
410 }
411
412
413 \f
414 /*  SIGN [--detached]
415
416    Sign the data set with the INPUT command and write it to the sink
417    set by OUTPUT.  With "--detached" specified, a detached signature
418    is created.  */
419 static gpg_error_t
420 cmd_sign (assuan_context_t ctx, char *line)
421 {
422   (void)ctx;
423   (void)line;
424   return gpg_error (GPG_ERR_NOT_SUPPORTED);
425 }
426
427
428 \f
429 /*  IMPORT
430
431   Import keys as read from the input-fd, return status message for
432   each imported one.  The import checks the validity of the key.  */
433 static gpg_error_t
434 cmd_import (assuan_context_t ctx, char *line)
435 {
436   (void)ctx;
437   (void)line;
438   return gpg_error (GPG_ERR_NOT_SUPPORTED);
439 }
440
441
442 \f
443 /*  EXPORT [--data [--armor|--base64]] [--] pattern
444
445    Similar to the --export command line command, this command exports
446    public keys matching PATTERN.  The output is send to the output fd
447    unless the --data option has been used in which case the output
448    gets send inline using regular data lines.  The options "--armor"
449    and "--base" ospecify an output format if "--data" has been used.
450    Recall that in general the output format is set with the OUTPUT
451    command.
452  */
453 static gpg_error_t
454 cmd_export (assuan_context_t ctx, char *line)
455 {
456   (void)ctx;
457   (void)line;
458   return gpg_error (GPG_ERR_NOT_SUPPORTED);
459 }
460
461
462 \f
463 /*  DELKEYS
464
465     Fixme
466 */
467 static gpg_error_t
468 cmd_delkeys (assuan_context_t ctx, char *line)
469 {
470   (void)ctx;
471   (void)line;
472   return gpg_error (GPG_ERR_NOT_SUPPORTED);
473 }
474
475
476 \f
477 /*  MESSAGE FD[=<n>]
478
479    Set the file descriptor to read a message which is used with
480    detached signatures.  */
481 static gpg_error_t
482 cmd_message (assuan_context_t ctx, char *line)
483 {
484   int rc;
485   gnupg_fd_t fd;
486   ctrl_t ctrl = assuan_get_pointer (ctx);
487
488   rc = assuan_command_parse_fd (ctx, line, &fd);
489   if (rc)
490     return rc;
491   if (fd == GNUPG_INVALID_FD)
492     return gpg_error (GPG_ERR_ASS_NO_INPUT);
493   ctrl->server_local->message_fd = fd;
494   return 0;
495 }
496
497
498 \f
499 /* LISTKEYS [<patterns>]
500    LISTSECRETKEYS [<patterns>]
501
502    fixme
503 */
504 static gpg_error_t
505 do_listkeys (assuan_context_t ctx, char *line, int mode)
506 {
507   (void)ctx;
508   (void)line;
509   (void)mode;
510
511   return gpg_error (GPG_ERR_NOT_SUPPORTED);
512 }
513
514
515 static gpg_error_t
516 cmd_listkeys (assuan_context_t ctx, char *line)
517 {
518   return do_listkeys (ctx, line, 3);
519 }
520
521
522 static gpg_error_t
523 cmd_listsecretkeys (assuan_context_t ctx, char *line)
524 {
525   return do_listkeys (ctx, line, 2);
526 }
527
528
529 \f
530 /* GENKEY
531
532    Read the parameters in native format from the input fd and create a
533    new OpenPGP key.
534  */
535 static gpg_error_t
536 cmd_genkey (assuan_context_t ctx, char *line)
537 {
538   (void)ctx;
539   (void)line;
540   return gpg_error (GPG_ERR_NOT_SUPPORTED);
541 }
542
543
544 /* GETINFO <what>
545
546    Multipurpose function to return a variety of information.
547    Supported values for WHAT are:
548
549      version     - Return the version of the program.
550      pid         - Return the process id of the server.
551
552  */
553 static gpg_error_t
554 cmd_getinfo (assuan_context_t ctx, char *line)
555 {
556   int rc;
557
558   if (!strcmp (line, "version"))
559     {
560       const char *s = VERSION;
561       rc = assuan_send_data (ctx, s, strlen (s));
562     }
563   else if (!strcmp (line, "pid"))
564     {
565       char numbuf[50];
566
567       snprintf (numbuf, sizeof numbuf, "%lu", (unsigned long)getpid ());
568       rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
569     }
570   else
571     rc = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for WHAT");
572   return rc;
573 }
574
575
576 \f
577 /* Helper to register our commands with libassuan. */
578 static int
579 register_commands (assuan_context_t ctx)
580 {
581   static struct 
582   {
583     const char *name;
584     gpg_error_t (*handler)(assuan_context_t, char *line);
585   } table[] = {
586     { "RECIPIENT",     cmd_recipient },
587     { "SIGNER",        cmd_signer    },
588     { "ENCRYPT",       cmd_encrypt   },
589     { "DECRYPT",       cmd_decrypt   },
590     { "VERIFY",        cmd_verify    },
591     { "SIGN",          cmd_sign      },
592     { "IMPORT",        cmd_import    },
593     { "EXPORT",        cmd_export    },
594     { "INPUT",         NULL          }, 
595     { "OUTPUT",        NULL          }, 
596     { "MESSAGE",       cmd_message   },
597     { "LISTKEYS",      cmd_listkeys  },
598     { "LISTSECRETKEYS",cmd_listsecretkeys },
599     { "GENKEY",        cmd_genkey    },
600     { "DELKEYS",       cmd_delkeys   },
601     { "GETINFO",       cmd_getinfo   },
602     { NULL }
603   };
604   int i, rc;
605
606   for (i=0; table[i].name; i++)
607     {
608       rc = assuan_register_command (ctx, table[i].name, table[i].handler);
609       if (rc)
610         return rc;
611     } 
612   return 0;
613 }
614
615
616
617 \f
618 /* Startup the server.  CTRL must have been allocated by the caller
619    and set to the default values. */
620 int
621 gpg_server (ctrl_t ctrl)
622 {
623   int rc;
624   int filedes[2];
625   assuan_context_t ctx = NULL;
626   static const char hello[] = ("GNU Privacy Guard's OpenPGP server "
627                                VERSION " ready");
628
629   /* We use a pipe based server so that we can work from scripts.
630      assuan_init_pipe_server will automagically detect when we are
631      called with a socketpair and ignore FILEDES in this case.  */
632   filedes[0] = 0;
633   filedes[1] = 1;
634   rc = assuan_new (&ctx);
635   if (rc)
636     {
637       log_error ("failed to allocate the assuan context: %s\n",
638                  gpg_strerror (rc));
639       goto leave;
640     }
641   
642   rc = assuan_init_pipe_server (ctx, filedes);
643   if (rc)
644     {
645       log_error ("failed to initialize the server: %s\n", gpg_strerror (rc));
646       goto leave;
647     }
648
649   rc = register_commands (ctx);
650   if (rc)
651     {
652       log_error ("failed to the register commands with Assuan: %s\n",
653                  gpg_strerror(rc));
654       goto leave;
655     }
656
657   assuan_set_pointer (ctx, ctrl);
658   if (opt.verbose || opt.debug)
659     {
660       char *tmp = NULL;
661       const char *s1 = getenv ("GPG_AGENT_INFO");
662
663       tmp = xtryasprintf ("Home: %s\n"
664                           "Config: %s\n"
665                           "AgentInfo: %s\n"
666                           "%s",
667                           opt.homedir,
668                           "fixme: need config filename",
669                           s1?s1:"[not set]",
670                           hello);
671       if (tmp)
672         {
673           assuan_set_hello_line (ctx, tmp);
674           xfree (tmp);
675         }
676     }
677   else
678     assuan_set_hello_line (ctx, hello);
679   assuan_register_reset_notify (ctx, reset_notify);
680   assuan_register_input_notify (ctx, input_notify);
681   assuan_register_output_notify (ctx, output_notify);
682   assuan_register_option_handler (ctx, option_handler);
683
684   ctrl->server_local = xtrycalloc (1, sizeof *ctrl->server_local);
685   if (!ctrl->server_local)
686     {
687       rc = gpg_error_from_syserror ();
688       goto leave;
689     }
690   ctrl->server_local->assuan_ctx = ctx;
691   ctrl->server_local->message_fd = GNUPG_INVALID_FD;
692
693   if (DBG_ASSUAN)
694     assuan_set_log_stream (ctx, log_get_stream ());
695
696   for (;;)
697     {
698       rc = assuan_accept (ctx);
699       if (rc == -1)
700         {
701           rc = 0;
702           break;
703         }
704       else if (rc)
705         {
706           log_info ("Assuan accept problem: %s\n", gpg_strerror (rc));
707           break;
708         }
709       
710       rc = assuan_process (ctx);
711       if (rc)
712         {
713           log_info ("Assuan processing failed: %s\n", gpg_strerror (rc));
714           continue;
715         }
716     }
717
718  leave:
719   if (ctrl->server_local)
720     {
721       release_pk_list (ctrl->server_local->recplist);
722
723       xfree (ctrl->server_local);
724       ctrl->server_local = NULL;
725     }
726   assuan_release (ctx);
727   return rc;
728 }
729