* keygen.c (read_parameter_file): New keyword "Handle". This is
[gnupg.git] / g10 / status.c
1 /* status.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004 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 2 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, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <unistd.h>
28 #include <signal.h>
29 #ifdef USE_SHM_COPROCESSING
30 #ifdef USE_CAPABILITIES
31 #include <sys/capability.h>
32 #endif
33 #ifdef HAVE_SYS_IPC_H
34 #include <sys/types.h>
35 #include <sys/ipc.h>
36 #endif
37 #ifdef HAVE_SYS_SHM_H
38 #include <sys/shm.h>
39 #endif
40 #if defined(HAVE_MLOCK)
41 #include <sys/mman.h>
42 #endif
43 #endif
44 #include "util.h"
45 #include "status.h"
46 #include "ttyio.h"
47 #include "options.h"
48 #include "main.h"
49 #include "i18n.h"
50 #include "cipher.h" /* for progress functions */
51
52 #define CONTROL_D ('D' - 'A' + 1)
53
54
55
56 static FILE *statusfp;
57
58 #ifdef USE_SHM_COPROCESSING
59   static int shm_id = -1;
60   static volatile char *shm_area;
61   static size_t shm_size;
62   static int shm_is_locked;
63 #endif /*USE_SHM_COPROCESSING*/
64
65
66 static void
67 progress_cb ( void *ctx, int c )
68 {
69     char buf[50];
70
71     if ( c == '\n' )
72         sprintf ( buf, "%.20s X 100 100", (char*)ctx );
73     else
74         sprintf ( buf, "%.20s %c 0 0", (char*)ctx, c );
75     write_status_text ( STATUS_PROGRESS, buf );
76 }
77
78 static const char *
79 get_status_string ( int no ) 
80 {
81     const char *s;
82
83     switch( no ) {
84       case STATUS_ENTER  : s = "ENTER"; break;
85       case STATUS_LEAVE  : s = "LEAVE"; break;
86       case STATUS_ABORT  : s = "ABORT"; break;
87       case STATUS_NEWSIG : s = "NEWSIG"; break;
88       case STATUS_GOODSIG: s = "GOODSIG"; break;
89       case STATUS_KEYEXPIRED: s = "KEYEXPIRED"; break;
90       case STATUS_KEYREVOKED: s = "KEYREVOKED"; break;
91       case STATUS_BADSIG : s = "BADSIG"; break;
92       case STATUS_ERRSIG : s = "ERRSIG"; break;
93       case STATUS_BADARMOR : s = "BADARMOR"; break;
94       case STATUS_RSA_OR_IDEA : s= "RSA_OR_IDEA"; break;
95       case STATUS_TRUST_UNDEFINED: s = "TRUST_UNDEFINED"; break;
96       case STATUS_TRUST_NEVER    : s = "TRUST_NEVER"; break;
97       case STATUS_TRUST_MARGINAL : s = "TRUST_MARGINAL"; break;
98       case STATUS_TRUST_FULLY    : s = "TRUST_FULLY"; break;
99       case STATUS_TRUST_ULTIMATE : s = "TRUST_ULTIMATE"; break;
100       case STATUS_GET_BOOL       : s = "GET_BOOL"; break;
101       case STATUS_GET_LINE       : s = "GET_LINE"; break;
102       case STATUS_GET_HIDDEN     : s = "GET_HIDDEN"; break;
103       case STATUS_GOT_IT         : s = "GOT_IT"; break;
104       case STATUS_SHM_INFO       : s = "SHM_INFO"; break;
105       case STATUS_SHM_GET        : s = "SHM_GET"; break;
106       case STATUS_SHM_GET_BOOL   : s = "SHM_GET_BOOL"; break;
107       case STATUS_SHM_GET_HIDDEN : s = "SHM_GET_HIDDEN"; break;
108       case STATUS_NEED_PASSPHRASE: s = "NEED_PASSPHRASE"; break;
109       case STATUS_VALIDSIG       : s = "VALIDSIG"; break;
110       case STATUS_SIG_ID         : s = "SIG_ID"; break;
111       case STATUS_ENC_TO         : s = "ENC_TO"; break;
112       case STATUS_NODATA         : s = "NODATA"; break;
113       case STATUS_BAD_PASSPHRASE : s = "BAD_PASSPHRASE"; break;
114       case STATUS_NO_PUBKEY      : s = "NO_PUBKEY"; break;
115       case STATUS_NO_SECKEY      : s = "NO_SECKEY"; break;
116       case STATUS_NEED_PASSPHRASE_SYM: s = "NEED_PASSPHRASE_SYM"; break;
117       case STATUS_DECRYPTION_FAILED: s = "DECRYPTION_FAILED"; break;
118       case STATUS_DECRYPTION_OKAY: s = "DECRYPTION_OKAY"; break;
119       case STATUS_MISSING_PASSPHRASE: s = "MISSING_PASSPHRASE"; break;
120       case STATUS_GOOD_PASSPHRASE : s = "GOOD_PASSPHRASE"; break;
121       case STATUS_GOODMDC        : s = "GOODMDC"; break;
122       case STATUS_BADMDC         : s = "BADMDC"; break;
123       case STATUS_ERRMDC         : s = "ERRMDC"; break;
124       case STATUS_IMPORTED       : s = "IMPORTED"; break;
125       case STATUS_IMPORT_OK      : s = "IMPORT_OK"; break;
126       case STATUS_IMPORT_CHECK   : s = "IMPORT_CHECK"; break;
127       case STATUS_IMPORT_RES     : s = "IMPORT_RES"; break;
128       case STATUS_FILE_START     : s = "FILE_START"; break;
129       case STATUS_FILE_DONE      : s = "FILE_DONE"; break;
130       case STATUS_FILE_ERROR     : s = "FILE_ERROR"; break;
131       case STATUS_BEGIN_DECRYPTION:s = "BEGIN_DECRYPTION"; break;
132       case STATUS_END_DECRYPTION : s = "END_DECRYPTION"; break;
133       case STATUS_BEGIN_ENCRYPTION:s = "BEGIN_ENCRYPTION"; break;
134       case STATUS_END_ENCRYPTION : s = "END_ENCRYPTION"; break;
135       case STATUS_DELETE_PROBLEM : s = "DELETE_PROBLEM"; break;
136       case STATUS_PROGRESS       : s = "PROGRESS"; break;
137       case STATUS_SIG_CREATED    : s = "SIG_CREATED"; break;
138       case STATUS_SESSION_KEY    : s = "SESSION_KEY"; break;
139       case STATUS_NOTATION_NAME  : s = "NOTATION_NAME" ; break;
140       case STATUS_NOTATION_DATA  : s = "NOTATION_DATA" ; break;
141       case STATUS_POLICY_URL     : s = "POLICY_URL" ; break;
142       case STATUS_BEGIN_STREAM   : s = "BEGIN_STREAM"; break;
143       case STATUS_END_STREAM     : s = "END_STREAM"; break;
144       case STATUS_KEY_CREATED    : s = "KEY_CREATED"; break;
145       case STATUS_KEY_NOT_CREATED: s = "KEY_NOT_CREATED"; break;
146       case STATUS_USERID_HINT    : s = "USERID_HINT"; break;
147       case STATUS_UNEXPECTED     : s = "UNEXPECTED"; break;
148       case STATUS_INV_RECP       : s = "INV_RECP"; break;
149       case STATUS_NO_RECP        : s = "NO_RECP"; break;
150       case STATUS_ALREADY_SIGNED : s = "ALREADY_SIGNED"; break;
151       case STATUS_SIGEXPIRED     : s = "SIGEXPIRED deprecated-use-keyexpired-instead"; break;
152       case STATUS_EXPSIG         : s = "EXPSIG"; break;
153       case STATUS_EXPKEYSIG      : s = "EXPKEYSIG"; break;
154       case STATUS_REVKEYSIG      : s = "REVKEYSIG"; break;
155       case STATUS_ATTRIBUTE      : s = "ATTRIBUTE"; break;
156       case STATUS_CARDCTRL       : s = "CARDCTRL"; break;
157       case STATUS_PLAINTEXT      : s = "PLAINTEXT"; break;
158       case STATUS_PLAINTEXT_LENGTH:s = "PLAINTEXT_LENGTH"; break;
159       default: s = "?"; break;
160     }
161     return s;
162 }
163
164
165 /* Return true if the status message NO may currently be issued.  We
166    need this to avoid syncronisation problem while auto retrieving a
167    key.  There it may happen that a status NODATA is issued for a non
168    available key and the user may falsely interpret this has a missing
169    signature. */
170 static int
171 status_currently_allowed (int no)
172 {
173   if (!glo_ctrl.in_auto_key_retrieve)
174     return 1; /* Yes. */
175
176   /* We allow some statis anyway, so that import statistics are
177      correct and to avoid problems if the retriebval subsystem will
178      prompt the user. */
179   switch (no)
180     {
181     case STATUS_GET_BOOL:        
182     case STATUS_GET_LINE:        
183     case STATUS_GET_HIDDEN:      
184     case STATUS_GOT_IT:  
185     case STATUS_IMPORTED:
186     case STATUS_IMPORT_OK:      
187     case STATUS_IMPORT_CHECK:  
188     case STATUS_IMPORT_RES:
189       return 1; /* Yes. */
190     default:
191       break;
192     }
193   return 0; /* No. */
194 }
195
196
197 void
198 set_status_fd ( int fd )
199 {
200     static int last_fd = -1;
201
202     if ( fd != -1 && last_fd == fd )
203         return;
204
205     if ( statusfp && statusfp != stdout && statusfp != stderr )
206         fclose (statusfp);
207     statusfp = NULL;
208     if ( fd == -1 ) 
209         return;
210
211     if( fd == 1 )
212         statusfp = stdout;
213     else if( fd == 2 )
214         statusfp = stderr;
215     else
216         statusfp = fdopen( fd, "w" );
217     if( !statusfp ) {
218         log_fatal("can't open fd %d for status output: %s\n",
219                   fd, strerror(errno));
220     }
221     last_fd = fd;
222     register_primegen_progress ( progress_cb, "primegen" );
223     register_pk_dsa_progress ( progress_cb, "pk_dsa" );
224     register_pk_elg_progress ( progress_cb, "pk_elg" );
225 }
226
227 int
228 is_status_enabled()
229 {
230     return !!statusfp;
231 }
232
233 void
234 write_status ( int no )
235 {
236     write_status_text( no, NULL );
237 }
238
239 void
240 write_status_text ( int no, const char *text)
241 {
242     if( !statusfp || !status_currently_allowed (no) )
243         return;  /* Not enabled or allowed. */
244
245     fputs ( "[GNUPG:] ", statusfp );
246     fputs ( get_status_string (no), statusfp );
247     if( text ) {
248         putc ( ' ', statusfp );
249         for (; *text; text++) {
250             if (*text == '\n')
251                 fputs ( "\\n", statusfp );
252             else if (*text == '\r')
253                 fputs ( "\\r", statusfp );
254             else 
255                 putc ( *(const byte *)text,  statusfp );
256         }
257     }
258     putc ('\n',statusfp);
259     fflush (statusfp);
260 }
261
262
263 /*
264  * Write a status line with a buffer using %XX escapes.  If WRAP is >
265  * 0 wrap the line after this length.  If STRING is not NULL it will
266  * be prepended to the buffer, no escaping is done for string.
267  * A wrap of -1 forces spaces not to be encoded as %20.
268  */
269 void
270 write_status_text_and_buffer ( int no, const char *string,
271                                const char *buffer, size_t len, int wrap )
272 {
273     const char *s, *text;
274     int esc, first;
275     int lower_limit = ' ';
276     size_t n, count, dowrap;
277
278     if( !statusfp || !status_currently_allowed (no) )
279         return;  /* Not enabled or allowed. */
280     
281     if (wrap == -1) {
282         lower_limit--;
283         wrap = 0;
284     }
285
286     text = get_status_string (no);
287     count = dowrap = first = 1;
288     do {
289         if (dowrap) {
290             fprintf (statusfp, "[GNUPG:] %s ", text );
291             count = dowrap = 0;
292             if (first && string) {
293                 fputs (string, statusfp);
294                 count += strlen (string);
295             }
296             first = 0;
297         }
298         for (esc=0, s=buffer, n=len; n && !esc; s++, n-- ) {
299             if ( *s == '%' || *(const byte*)s <= lower_limit 
300                            || *(const byte*)s == 127 ) 
301                 esc = 1;
302             if ( wrap && ++count > wrap ) {
303                 dowrap=1;
304                 break;
305             }
306         }
307         if (esc) {
308             s--; n++;
309         }
310         if (s != buffer) 
311             fwrite (buffer, s-buffer, 1, statusfp );
312         if ( esc ) {
313             fprintf (statusfp, "%%%02X", *(const byte*)s );
314             s++; n--;
315         }
316         buffer = s;
317         len = n;
318         if ( dowrap && len )
319             putc ( '\n', statusfp );
320     } while ( len );
321
322     putc ('\n',statusfp);
323     fflush (statusfp);
324 }
325
326 void
327 write_status_buffer ( int no, const char *buffer, size_t len, int wrap )
328 {
329     write_status_text_and_buffer (no, NULL, buffer, len, wrap);
330 }
331
332
333
334 #ifdef USE_SHM_COPROCESSING
335
336 #ifndef IPC_RMID_DEFERRED_RELEASE
337 static void
338 remove_shmid( void )
339 {
340     if( shm_id != -1 ) {
341         shmctl ( shm_id, IPC_RMID, 0);
342         shm_id = -1;
343     }
344 }
345 #endif
346
347 void
348 init_shm_coprocessing ( ulong requested_shm_size, int lock_mem )
349 {
350     char buf[100];
351     struct shmid_ds shmds;
352
353 #ifndef IPC_RMID_DEFERRED_RELEASE
354     atexit( remove_shmid );
355 #endif
356     requested_shm_size = (requested_shm_size + 4095) & ~4095;
357     if ( requested_shm_size > 2 * 4096 )
358         log_fatal("too much shared memory requested; only 8k are allowed\n");
359     shm_size = 4096 /* one page for us */ + requested_shm_size;
360
361     shm_id = shmget( IPC_PRIVATE, shm_size, IPC_CREAT | 0700 );
362     if ( shm_id == -1 )
363         log_fatal("can't get %uk of shared memory: %s\n",
364                                 (unsigned)shm_size/1024, strerror(errno));
365
366 #if !defined(IPC_HAVE_SHM_LOCK) \
367       && defined(HAVE_MLOCK) && !defined(HAVE_BROKEN_MLOCK)
368     /* part of the old code which uses mlock */
369     shm_area = shmat( shm_id, 0, 0 );
370     if ( shm_area == (char*)-1 )
371         log_fatal("can't attach %uk shared memory: %s\n",
372                                 (unsigned)shm_size/1024, strerror(errno));
373     log_debug("mapped %uk shared memory at %p, id=%d\n",
374                             (unsigned)shm_size/1024, shm_area, shm_id );
375     if( lock_mem ) {
376 #ifdef USE_CAPABILITIES
377         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
378 #endif
379         /* (need the cast for Solaris with Sun's workshop compilers) */
380         if ( mlock ( (char*)shm_area, shm_size) )
381             log_info("locking shared memory %d failed: %s\n",
382                                 shm_id, strerror(errno));
383         else
384             shm_is_locked = 1;
385 #ifdef USE_CAPABILITIES
386         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
387 #endif
388     }
389
390 #ifdef IPC_RMID_DEFERRED_RELEASE
391     if( shmctl( shm_id, IPC_RMID, 0) )
392         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
393                                             shm_id, strerror(errno));
394 #endif
395
396     if( shmctl( shm_id, IPC_STAT, &shmds ) )
397         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
398                                             shm_id, strerror(errno));
399     if( shmds.shm_perm.uid != getuid() ) {
400         shmds.shm_perm.uid = getuid();
401         if( shmctl( shm_id, IPC_SET, &shmds ) )
402             log_fatal("shmctl IPC_SET of %d failed: %s\n",
403                                                 shm_id, strerror(errno));
404     }
405
406 #else /* this is the new code which handles the changes in the SHM
407        * semantics introduced with Linux 2.4.  The changes is that we
408        * now change the permissions and then attach to the memory.
409        */
410
411     if( lock_mem ) {
412 #ifdef USE_CAPABILITIES
413         cap_set_proc( cap_from_text("cap_ipc_lock+ep") );
414 #endif
415 #ifdef IPC_HAVE_SHM_LOCK
416         if ( shmctl (shm_id, SHM_LOCK, 0) )
417             log_info("locking shared memory %d failed: %s\n",
418                                 shm_id, strerror(errno));
419         else
420             shm_is_locked = 1;
421 #else
422         log_info("Locking shared memory %d failed: No way to do it\n", shm_id );
423 #endif
424 #ifdef USE_CAPABILITIES
425         cap_set_proc( cap_from_text("cap_ipc_lock+p") );
426 #endif
427     }
428
429     if( shmctl( shm_id, IPC_STAT, &shmds ) )
430         log_fatal("shmctl IPC_STAT of %d failed: %s\n",
431                                             shm_id, strerror(errno));
432     if( shmds.shm_perm.uid != getuid() ) {
433         shmds.shm_perm.uid = getuid();
434         if( shmctl( shm_id, IPC_SET, &shmds ) )
435             log_fatal("shmctl IPC_SET of %d failed: %s\n",
436                                                 shm_id, strerror(errno));
437     }
438
439     shm_area = shmat( shm_id, 0, 0 );
440     if ( shm_area == (char*)-1 )
441         log_fatal("can't attach %uk shared memory: %s\n",
442                                 (unsigned)shm_size/1024, strerror(errno));
443     log_debug("mapped %uk shared memory at %p, id=%d\n",
444                             (unsigned)shm_size/1024, shm_area, shm_id );
445
446 #ifdef IPC_RMID_DEFERRED_RELEASE
447     if( shmctl( shm_id, IPC_RMID, 0) )
448         log_fatal("shmctl IPC_RMDID of %d failed: %s\n",
449                                             shm_id, strerror(errno));
450 #endif
451
452 #endif
453     /* write info; Protocol version, id, size, locked size */
454     sprintf( buf, "pv=1 pid=%d shmid=%d sz=%u lz=%u", (int)getpid(),
455             shm_id, (unsigned)shm_size, shm_is_locked? (unsigned)shm_size:0 );
456     write_status_text( STATUS_SHM_INFO, buf );
457 }
458
459 /****************
460  * Request a string from client
461  * If bool, returns static string on true (do not free) or NULL for false
462  */
463 static char *
464 do_shm_get( const char *keyword, int hidden, int bool )
465 {
466     size_t n;
467     byte *p;
468     char *string;
469
470     if( !shm_area )
471         BUG();
472
473     shm_area[0] = 0;  /* msb of length of control block */
474     shm_area[1] = 32; /* and lsb */
475     shm_area[2] = 1;  /* indicate that we are waiting on a reply */
476     shm_area[3] = 0;  /* clear data available flag */
477
478     write_status_text( bool? STATUS_SHM_GET_BOOL :
479                        hidden? STATUS_SHM_GET_HIDDEN : STATUS_SHM_GET, keyword );
480
481     do {
482         pause_on_sigusr(1);
483         if( shm_area[0] || shm_area[1] != 32 || shm_area[2] != 1 )
484             log_fatal("client modified shm control block - abort\n");
485     } while( !shm_area[3] );
486     shm_area[2] = 0; /* reset request flag */
487     p = (byte*)shm_area+32;
488     n = p[0] << 8 | p[1];
489     p += 2;
490     if( n+32+2+1 > 4095 )
491         log_fatal("client returns too large data (%u bytes)\n", (unsigned)n );
492
493     if( bool )
494         return p[0]? "" : NULL;
495
496     string = hidden? m_alloc_secure( n+1 ) : m_alloc( n+1 );
497     memcpy(string, p, n );
498     string[n] = 0; /* make sure it is a string */
499     if( hidden ) /* invalidate the memory */
500         memset( p, 0, n );
501
502     return string;
503 }
504
505 #endif /* USE_SHM_COPROCESSING */
506
507 static int
508 myread(int fd, void *buf, size_t count)
509 {
510     int rc;
511     do {
512         rc = read( fd, buf, count );
513     } while ( rc == -1 && errno == EINTR );
514     if ( !rc && count ) {
515         static int eof_emmited=0;
516         if ( eof_emmited < 3 ) {
517             *(char*)buf = CONTROL_D;
518             rc = 1;
519             eof_emmited++;
520         }
521         else { /* Ctrl-D not caught - do something reasonable */
522 #ifdef HAVE_DOSISH_SYSTEM
523             raise (SIGINT);  /* nothing to hangup under DOS */
524 #else
525             raise (SIGHUP); /* no more input data */
526 #endif
527         }
528     }    
529     return rc;
530 }
531
532
533
534 /****************
535  * Request a string from the client over the command-fd
536  * If bool, returns static string on true (do not free) or NULL for false
537  */
538 static char *
539 do_get_from_fd( const char *keyword, int hidden, int bool )
540 {
541     int i, len;
542     char *string;
543
544     if(statusfp!=stdout)
545       fflush(stdout);
546
547     write_status_text( bool? STATUS_GET_BOOL :
548                        hidden? STATUS_GET_HIDDEN : STATUS_GET_LINE, keyword );
549
550     for( string = NULL, i = len = 200; ; i++ ) {
551         if( i >= len-1 ) {
552             char *save = string;
553             len += 100;
554             string = hidden? m_alloc_secure ( len ) : m_alloc ( len );
555             if( save )
556                 memcpy(string, save, i );
557             else
558                 i=0;
559         }
560         /* Hmmm: why not use our read_line function here */
561         if( myread( opt.command_fd, string+i, 1) != 1 || string[i] == '\n'  )
562             break;
563         else if ( string[i] == CONTROL_D ) {
564             /* found ETX - cancel the line and return a sole ETX */
565             string[0] = CONTROL_D;
566             i=1;
567             break;
568         }
569     }
570     string[i] = 0;
571
572     write_status( STATUS_GOT_IT );
573
574     if( bool )   /* Fixme: is this correct??? */
575         return (string[0] == 'Y' || string[0] == 'y') ? "" : NULL;
576
577     return string;
578 }
579
580
581
582 int
583 cpr_enabled()
584 {
585     if( opt.command_fd != -1 )
586         return 1;
587 #ifdef USE_SHM_COPROCESSING
588     if( opt.shm_coprocess )
589         return 1;
590 #endif
591     return 0;
592 }
593
594 char *
595 cpr_get_no_help( const char *keyword, const char *prompt )
596 {
597     char *p;
598
599     if( opt.command_fd != -1 )
600         return do_get_from_fd ( keyword, 0, 0 );
601 #ifdef USE_SHM_COPROCESSING
602     if( opt.shm_coprocess )
603         return do_shm_get( keyword, 0, 0 );
604 #endif
605     for(;;) {
606         p = tty_get( prompt );
607         return p;
608     }
609 }
610
611 char *
612 cpr_get( const char *keyword, const char *prompt )
613 {
614     char *p;
615
616     if( opt.command_fd != -1 )
617         return do_get_from_fd ( keyword, 0, 0 );
618 #ifdef USE_SHM_COPROCESSING
619     if( opt.shm_coprocess )
620         return do_shm_get( keyword, 0, 0 );
621 #endif
622     for(;;) {
623         p = tty_get( prompt );
624         if( *p=='?' && !p[1] && !(keyword && !*keyword)) {
625             m_free(p);
626             display_online_help( keyword );
627         }
628         else
629             return p;
630     }
631 }
632
633
634 char *
635 cpr_get_utf8( const char *keyword, const char *prompt )
636 {
637     char *p;
638     p = cpr_get( keyword, prompt );
639     if( p ) {
640         char *utf8 = native_to_utf8( p );
641         m_free( p );
642         p = utf8;
643     }
644     return p;
645 }
646
647 char *
648 cpr_get_hidden( const char *keyword, const char *prompt )
649 {
650     char *p;
651
652     if( opt.command_fd != -1 )
653         return do_get_from_fd ( keyword, 1, 0 );
654 #ifdef USE_SHM_COPROCESSING
655     if( opt.shm_coprocess )
656         return do_shm_get( keyword, 1, 0 );
657 #endif
658     for(;;) {
659         p = tty_get_hidden( prompt );
660         if( *p == '?' && !p[1] ) {
661             m_free(p);
662             display_online_help( keyword );
663         }
664         else
665             return p;
666     }
667 }
668
669 void
670 cpr_kill_prompt(void)
671 {
672     if( opt.command_fd != -1 )
673         return;
674 #ifdef USE_SHM_COPROCESSING
675     if( opt.shm_coprocess )
676         return;
677 #endif
678     tty_kill_prompt();
679     return;
680 }
681
682 int
683 cpr_get_answer_is_yes( const char *keyword, const char *prompt )
684 {
685     int yes;
686     char *p;
687
688     if( opt.command_fd != -1 )
689         return !!do_get_from_fd ( keyword, 0, 1 );
690 #ifdef USE_SHM_COPROCESSING
691     if( opt.shm_coprocess )
692         return !!do_shm_get( keyword, 0, 1 );
693 #endif
694     for(;;) {
695         p = tty_get( prompt );
696         trim_spaces(p); /* it is okay to do this here */
697         if( *p == '?' && !p[1] ) {
698             m_free(p);
699             display_online_help( keyword );
700         }
701         else {
702             tty_kill_prompt();
703             yes = answer_is_yes(p);
704             m_free(p);
705             return yes;
706         }
707     }
708 }
709
710 int
711 cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt )
712 {
713     int yes;
714     char *p;
715
716     if( opt.command_fd != -1 )
717         return !!do_get_from_fd ( keyword, 0, 1 );
718 #ifdef USE_SHM_COPROCESSING
719     if( opt.shm_coprocess )
720         return !!do_shm_get( keyword, 0, 1 );
721 #endif
722     for(;;) {
723         p = tty_get( prompt );
724         trim_spaces(p); /* it is okay to do this here */
725         if( *p == '?' && !p[1] ) {
726             m_free(p);
727             display_online_help( keyword );
728         }
729         else {
730             tty_kill_prompt();
731             yes = answer_is_yes_no_quit(p);
732             m_free(p);
733             return yes;
734         }
735     }
736 }
737
738
739 int
740 cpr_get_answer_okay_cancel (const char *keyword,
741                             const char *prompt,
742                             int def_answer)
743 {
744   int yes;
745   char *answer = NULL;
746   char *p;
747
748   if( opt.command_fd != -1 )
749     answer = do_get_from_fd ( keyword, 0, 0 );
750 #ifdef USE_SHM_COPROCESSING
751   else if( opt.shm_coprocess )
752     answer = do_shm_get( keyword, 0, 0 );
753 #endif
754
755   if (answer)
756     {
757       yes = answer_is_okay_cancel (answer, def_answer);
758       m_free (answer);
759       return yes;
760     }
761
762   for(;;)
763     {
764       p = tty_get( prompt );
765       trim_spaces(p); /* it is okay to do this here */
766       if (*p == '?' && !p[1])
767         {
768           m_free(p);
769           display_online_help (keyword);
770         }
771       else
772         {
773           tty_kill_prompt();
774           yes = answer_is_okay_cancel (p, def_answer);
775           m_free(p);
776           return yes;
777         }
778     }
779 }
780