gpg,sm: Implement keybox compression run and release lock in gpgsm
[gnupg.git] / g10 / cpr.c
1 /* status.c - Status message and command-fd interface
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004, 2005, 2006, 2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <unistd.h>
27 #ifdef HAVE_SIGNAL_H
28 # include <signal.h>
29 #endif
30
31 #include "gpg.h"
32 #include "../common/util.h"
33 #include "../common/status.h"
34 #include "../common/ttyio.h"
35 #include "options.h"
36 #include "main.h"
37 #include "../common/i18n.h"
38
39 #define CONTROL_D ('D' - 'A' + 1)
40
41
42 /* The stream to output the status information.  Output is disabled if
43    this is NULL.  */
44 static estream_t statusfp;
45
46
47 static void
48 progress_cb (void *ctx, const char *what, int printchar,
49              int current, int total)
50 {
51   char buf[50];
52
53   (void)ctx;
54
55   if ( printchar == '\n' && !strcmp (what, "primegen") )
56     snprintf (buf, sizeof buf, "%.20s X 100 100", what );
57   else
58     snprintf (buf, sizeof buf, "%.20s %c %d %d",
59               what, printchar=='\n'?'X':printchar, current, total );
60   write_status_text (STATUS_PROGRESS, buf);
61 }
62
63
64 /* Return true if the status message NO may currently be issued.  We
65    need this to avoid synchronization problem while auto retrieving a
66    key.  There it may happen that a status NODATA is issued for a non
67    available key and the user may falsely interpret this has a missing
68    signature. */
69 static int
70 status_currently_allowed (int no)
71 {
72   if (!glo_ctrl.in_auto_key_retrieve)
73     return 1; /* Yes. */
74
75   /* We allow some statis anyway, so that import statistics are
76      correct and to avoid problems if the retrieval subsystem will
77      prompt the user. */
78   switch (no)
79     {
80     case STATUS_GET_BOOL:
81     case STATUS_GET_LINE:
82     case STATUS_GET_HIDDEN:
83     case STATUS_GOT_IT:
84     case STATUS_IMPORTED:
85     case STATUS_IMPORT_OK:
86     case STATUS_IMPORT_CHECK:
87     case STATUS_IMPORT_RES:
88       return 1; /* Yes. */
89     default:
90       break;
91     }
92   return 0; /* No. */
93 }
94
95
96 void
97 set_status_fd (int fd)
98 {
99   static int last_fd = -1;
100
101   if (fd != -1 && last_fd == fd)
102     return;
103
104   if (statusfp && statusfp != es_stdout && statusfp != es_stderr )
105     es_fclose (statusfp);
106   statusfp = NULL;
107   if (fd == -1)
108     return;
109
110   if (! gnupg_fd_valid (fd))
111     log_fatal ("status-fd is invalid: %s\n", strerror (errno));
112
113   if (fd == 1)
114     statusfp = es_stdout;
115   else if (fd == 2)
116     statusfp = es_stderr;
117   else
118     statusfp = es_fdopen (fd, "w");
119   if (!statusfp)
120     {
121       log_fatal ("can't open fd %d for status output: %s\n",
122                  fd, strerror (errno));
123     }
124   last_fd = fd;
125
126   gcry_set_progress_handler (progress_cb, NULL);
127 }
128
129
130 int
131 is_status_enabled ()
132 {
133   return !!statusfp;
134 }
135
136
137 void
138 write_status ( int no )
139 {
140     write_status_text( no, NULL );
141 }
142
143
144 /* Write a status line with code NO followed by the string TEXT and
145  * directly followed by the remaining strings up to a NULL.  Embedded
146  * CR and LFs in the strings (but not in TEXT) are C-style escaped.*/
147 void
148 write_status_strings (int no, const char *text, ...)
149 {
150   va_list arg_ptr;
151   const char *s;
152
153   if (!statusfp || !status_currently_allowed (no) )
154     return;  /* Not enabled or allowed. */
155
156   es_fputs ("[GNUPG:] ", statusfp);
157   es_fputs (get_status_string (no), statusfp);
158   if ( text )
159     {
160       es_putc ( ' ', statusfp);
161       va_start (arg_ptr, text);
162       s = text;
163       do
164         {
165           for (; *s; s++)
166             {
167               if (*s == '\n')
168                 es_fputs ("\\n", statusfp);
169               else if (*s == '\r')
170                 es_fputs ("\\r", statusfp);
171               else
172                 es_fputc (*(const byte *)s, statusfp);
173             }
174         }
175       while ((s = va_arg (arg_ptr, const char*)));
176       va_end (arg_ptr);
177     }
178   es_putc ('\n', statusfp);
179   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
180     g10_exit (0);
181 }
182
183
184 void
185 write_status_text (int no, const char *text)
186 {
187   write_status_strings (no, text, NULL);
188 }
189
190
191 /* Write a status line with code NO followed by the output of the
192  * printf style FORMAT.  Embedded CR and LFs are C-style escaped.  */
193 void
194 write_status_printf (int no, const char *format, ...)
195 {
196   va_list arg_ptr;
197   char *buf;
198
199   if (!statusfp || !status_currently_allowed (no) )
200     return;  /* Not enabled or allowed. */
201
202   es_fputs ("[GNUPG:] ", statusfp);
203   es_fputs (get_status_string (no), statusfp);
204   if (format)
205     {
206       es_putc ( ' ', statusfp);
207       va_start (arg_ptr, format);
208       buf = gpgrt_vbsprintf (format, arg_ptr);
209       if (!buf)
210         log_error ("error printing status line: %s\n",
211                    gpg_strerror (gpg_err_code_from_syserror ()));
212       else
213         {
214           if (strpbrk (buf, "\r\n"))
215             {
216               const byte *s;
217               for (s=buf; *s; s++)
218                 {
219                   if (*s == '\n')
220                     es_fputs ("\\n", statusfp);
221                   else if (*s == '\r')
222                     es_fputs ("\\r", statusfp);
223                   else
224                     es_fputc (*s, statusfp);
225                 }
226             }
227           else
228             es_fputs (buf, statusfp);
229           gpgrt_free (buf);
230         }
231
232       va_end (arg_ptr);
233     }
234   es_putc ('\n', statusfp);
235   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
236     g10_exit (0);
237 }
238
239
240 /* Write an ERROR status line using a full gpg-error error value.  */
241 void
242 write_status_error (const char *where, gpg_error_t err)
243 {
244   if (!statusfp || !status_currently_allowed (STATUS_ERROR))
245     return;  /* Not enabled or allowed. */
246
247   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
248               get_status_string (STATUS_ERROR), where, err);
249   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
250     g10_exit (0);
251 }
252
253
254 /* Same as above but outputs the error code only.  */
255 void
256 write_status_errcode (const char *where, int errcode)
257 {
258   if (!statusfp || !status_currently_allowed (STATUS_ERROR))
259     return;  /* Not enabled or allowed. */
260
261   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
262               get_status_string (STATUS_ERROR), where, gpg_err_code (errcode));
263   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
264     g10_exit (0);
265 }
266
267
268 /* Write a FAILURE status line.  */
269 void
270 write_status_failure (const char *where, gpg_error_t err)
271 {
272   static int any_failure_printed;
273
274   if (!statusfp || !status_currently_allowed (STATUS_FAILURE))
275     return;  /* Not enabled or allowed. */
276   if (any_failure_printed)
277     return;
278   any_failure_printed = 1;
279   es_fprintf (statusfp, "[GNUPG:] %s %s %u\n",
280               get_status_string (STATUS_FAILURE), where, err);
281   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
282     g10_exit (0);
283 }
284
285
286 /*
287  * Write a status line with a buffer using %XX escapes.  If WRAP is >
288  * 0 wrap the line after this length.  If STRING is not NULL it will
289  * be prepended to the buffer, no escaping is done for string.
290  * A wrap of -1 forces spaces not to be encoded as %20.
291  */
292 void
293 write_status_text_and_buffer (int no, const char *string,
294                               const char *buffer, size_t len, int wrap)
295 {
296   const char *s, *text;
297   int esc, first;
298   int lower_limit = ' ';
299   size_t n, count, dowrap;
300
301   if (!statusfp || !status_currently_allowed (no))
302     return;  /* Not enabled or allowed. */
303
304   if (wrap == -1)
305     {
306       lower_limit--;
307       wrap = 0;
308     }
309
310   text = get_status_string (no);
311   count = dowrap = first = 1;
312   do
313     {
314       if (dowrap)
315         {
316           es_fprintf (statusfp, "[GNUPG:] %s ", text);
317           count = dowrap = 0;
318           if (first && string)
319             {
320               es_fputs (string, statusfp);
321               count += strlen (string);
322               /* Make sure that there is a space after the string.  */
323               if (*string && string[strlen (string)-1] != ' ')
324                 {
325                   es_putc (' ', statusfp);
326                   count++;
327                 }
328             }
329           first = 0;
330         }
331       for (esc=0, s=buffer, n=len; n && !esc; s++, n--)
332         {
333           if (*s == '%' || *(const byte*)s <= lower_limit
334               || *(const byte*)s == 127 )
335             esc = 1;
336           if (wrap && ++count > wrap)
337             {
338               dowrap=1;
339               break;
340             }
341         }
342       if (esc)
343         {
344           s--; n++;
345         }
346       if (s != buffer)
347         es_fwrite (buffer, s-buffer, 1, statusfp);
348       if ( esc )
349         {
350           es_fprintf (statusfp, "%%%02X", *(const byte*)s );
351           s++; n--;
352         }
353       buffer = s;
354       len = n;
355       if (dowrap && len)
356         es_putc ('\n', statusfp);
357     }
358   while (len);
359
360   es_putc ('\n',statusfp);
361   if (es_fflush (statusfp) && opt.exit_on_status_write_error)
362     g10_exit (0);
363 }
364
365
366 void
367 write_status_buffer (int no, const char *buffer, size_t len, int wrap)
368 {
369   write_status_text_and_buffer (no, NULL, buffer, len, wrap);
370 }
371
372
373 /* Print the BEGIN_SIGNING status message.  If MD is not NULL it is
374    used to retrieve the hash algorithms used for the message. */
375 void
376 write_status_begin_signing (gcry_md_hd_t md)
377 {
378   if (md)
379     {
380       char buf[100];
381       size_t buflen;
382       int i, ga;
383
384       buflen = 0;
385       for (i=1; i <= 110; i++)
386         {
387           ga = map_md_openpgp_to_gcry (i);
388           if (ga && gcry_md_is_enabled (md, ga) && buflen+10 < DIM(buf))
389             {
390               snprintf (buf+buflen, DIM(buf) - buflen,
391                         "%sH%d", buflen? " ":"",i);
392               buflen += strlen (buf+buflen);
393             }
394         }
395       write_status_text (STATUS_BEGIN_SIGNING, buf);
396     }
397   else
398     write_status ( STATUS_BEGIN_SIGNING );
399 }
400
401
402 static int
403 myread(int fd, void *buf, size_t count)
404 {
405   int rc;
406   do
407     {
408       rc = read( fd, buf, count );
409     }
410   while (rc == -1 && errno == EINTR);
411
412   if (!rc && count)
413     {
414       static int eof_emmited=0;
415       if ( eof_emmited < 3 )
416         {
417           *(char*)buf = CONTROL_D;
418           rc = 1;
419           eof_emmited++;
420         }
421       else /* Ctrl-D not caught - do something reasonable */
422         {
423 #ifdef HAVE_DOSISH_SYSTEM
424 #ifndef HAVE_W32CE_SYSTEM
425           raise (SIGINT); /* Nothing to hangup under DOS.  */
426 #endif
427 #else
428           raise (SIGHUP); /* No more input data.  */
429 #endif
430         }
431     }
432   return rc;
433 }
434
435
436
437 /* Request a string from the client over the command-fd.  If GETBOOL
438    is set the function returns a static string (do not free) if the
439    entered value was true or NULL if the entered value was false.  */
440 static char *
441 do_get_from_fd ( const char *keyword, int hidden, int getbool )
442 {
443   int i, len;
444   char *string;
445
446   if (statusfp != es_stdout)
447     es_fflush (es_stdout);
448
449   write_status_text (getbool? STATUS_GET_BOOL :
450                      hidden? STATUS_GET_HIDDEN : STATUS_GET_LINE, keyword);
451
452   for (string = NULL, i = len = 200; ; i++ )
453     {
454       if (i >= len-1 )
455         {
456           /* On the first iteration allocate a new buffer.  If that
457            * buffer is too short at further iterations do a poor man's
458            * realloc.  */
459           char *save = string;
460           len += 100;
461           string = hidden? xmalloc_secure ( len ) : xmalloc ( len );
462           if (save)
463             {
464               memcpy (string, save, i);
465               xfree (save);
466             }
467           else
468             i = 0;
469         }
470       /* Fixme: why not use our read_line function here? */
471       if ( myread( opt.command_fd, string+i, 1) != 1 || string[i] == '\n'  )
472         break;
473       else if ( string[i] == CONTROL_D )
474         {
475           /* Found ETX - Cancel the line and return a sole ETX.  */
476           string[0] = CONTROL_D;
477           i = 1;
478           break;
479         }
480     }
481   string[i] = 0;
482
483   write_status (STATUS_GOT_IT);
484
485   if (getbool)   /* Fixme: is this correct??? */
486     return (string[0] == 'Y' || string[0] == 'y') ? "" : NULL;
487
488   return string;
489 }
490
491
492
493 int
494 cpr_enabled()
495 {
496     if( opt.command_fd != -1 )
497         return 1;
498     return 0;
499 }
500
501 char *
502 cpr_get_no_help( const char *keyword, const char *prompt )
503 {
504     char *p;
505
506     if( opt.command_fd != -1 )
507         return do_get_from_fd ( keyword, 0, 0 );
508     for(;;) {
509         p = tty_get( prompt );
510         return p;
511     }
512 }
513
514 char *
515 cpr_get( const char *keyword, const char *prompt )
516 {
517     char *p;
518
519     if( opt.command_fd != -1 )
520         return do_get_from_fd ( keyword, 0, 0 );
521     for(;;) {
522         p = tty_get( prompt );
523         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
524             xfree(p);
525             display_online_help( keyword );
526         }
527         else
528             return p;
529     }
530 }
531
532
533 char *
534 cpr_get_utf8( const char *keyword, const char *prompt )
535 {
536     char *p;
537     p = cpr_get( keyword, prompt );
538     if( p ) {
539         char *utf8 = native_to_utf8( p );
540         xfree( p );
541         p = utf8;
542     }
543     return p;
544 }
545
546 char *
547 cpr_get_hidden( const char *keyword, const char *prompt )
548 {
549     char *p;
550
551     if( opt.command_fd != -1 )
552         return do_get_from_fd ( keyword, 1, 0 );
553     for(;;) {
554         p = tty_get_hidden( prompt );
555         if( *p == '?' && !p[1] ) {
556             xfree(p);
557             display_online_help( keyword );
558         }
559         else
560             return p;
561     }
562 }
563
564 void
565 cpr_kill_prompt(void)
566 {
567     if( opt.command_fd != -1 )
568         return;
569     tty_kill_prompt();
570     return;
571 }
572
573 int
574 cpr_get_answer_is_yes_def (const char *keyword, const char *prompt, int def_yes)
575 {
576     int yes;
577     char *p;
578
579     if( opt.command_fd != -1 )
580         return !!do_get_from_fd ( keyword, 0, 1 );
581     for(;;) {
582         p = tty_get( prompt );
583         trim_spaces(p); /* it is okay to do this here */
584         if( *p == '?' && !p[1] ) {
585             xfree(p);
586             display_online_help( keyword );
587         }
588         else {
589             tty_kill_prompt();
590             yes = answer_is_yes_no_default (p, def_yes);
591             xfree(p);
592             return yes;
593         }
594     }
595 }
596
597 int
598 cpr_get_answer_is_yes (const char *keyword, const char *prompt)
599 {
600   return cpr_get_answer_is_yes_def (keyword, prompt, 0);
601 }
602
603 int
604 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
605 {
606     int yes;
607     char *p;
608
609     if( opt.command_fd != -1 )
610         return !!do_get_from_fd ( keyword, 0, 1 );
611     for(;;) {
612         p = tty_get( prompt );
613         trim_spaces(p); /* it is okay to do this here */
614         if( *p == '?' && !p[1] ) {
615             xfree(p);
616             display_online_help( keyword );
617         }
618         else {
619             tty_kill_prompt();
620             yes = answer_is_yes_no_quit(p);
621             xfree(p);
622             return yes;
623         }
624     }
625 }
626
627
628 int
629 cpr_get_answer_okay_cancel (const char *keyword,
630                             const char *prompt,
631                             int def_answer)
632 {
633   int yes;
634   char *answer = NULL;
635   char *p;
636
637   if( opt.command_fd != -1 )
638     answer = do_get_from_fd ( keyword, 0, 0 );
639
640   if (answer)
641     {
642       yes = answer_is_okay_cancel (answer, def_answer);
643       xfree (answer);
644       return yes;
645     }
646
647   for(;;)
648     {
649       p = tty_get( prompt );
650       trim_spaces(p); /* it is okay to do this here */
651       if (*p == '?' && !p[1])
652         {
653           xfree(p);
654           display_online_help (keyword);
655         }
656       else
657         {
658           tty_kill_prompt();
659           yes = answer_is_okay_cancel (p, def_answer);
660           xfree(p);
661           return yes;
662         }
663     }
664 }