automake updates, removed one debug output
[gnupg.git] / g10 / passphrase.c
1 /* passphrase.c -  Get a passphrase
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 <stddef.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <unistd.h>
28 #include <assert.h>
29 #if !defined(HAVE_DOSISH_SYSTEM) && !defined(__riscos__)
30 #include <sys/socket.h>
31 #include <sys/un.h>
32 #endif
33 #if defined (_WIN32) || defined (__CYGWIN32__)
34 # include <windows.h>
35 #endif
36 #include <errno.h>
37 #ifdef HAVE_LOCALE_H
38 #include <locale.h>
39 #endif
40 #ifdef HAVE_LANGINFO_CODESET
41 #include <langinfo.h>
42 #endif
43
44 #include "util.h"
45 #include "memory.h"
46 #include "options.h"
47 #include "ttyio.h"
48 #include "cipher.h"
49 #include "keydb.h"
50 #include "main.h"
51 #include "i18n.h"
52 #include "status.h"
53
54
55 enum gpga_protocol_codes {
56     /* Request codes */
57     GPGA_PROT_GET_VERSION     = 1,
58     GPGA_PROT_GET_PASSPHRASE  = 2,
59     GPGA_PROT_CLEAR_PASSPHRASE= 3,
60     GPGA_PROT_SHUTDOWN        = 4,
61     GPGA_PROT_FLUSH           = 5,
62
63     /* Reply codes */
64     GPGA_PROT_REPLY_BASE     = 0x10000,
65     GPGA_PROT_OKAY           = 0x10001,
66     GPGA_PROT_GOT_PASSPHRASE = 0x10002,
67
68     /* Error codes */
69     GPGA_PROT_ERROR_BASE     = 0x20000,
70     GPGA_PROT_PROTOCOL_ERROR = 0x20001,
71     GPGA_PROT_INVALID_REQUEST= 0x20002,
72     GPGA_PROT_CANCELED       = 0x20003,    
73     GPGA_PROT_NO_PASSPHRASE  = 0x20004,    
74     GPGA_PROT_BAD_PASSPHRASE = 0x20005,
75     GPGA_PROT_INVALID_DATA   = 0x20006,
76     GPGA_PROT_NOT_IMPLEMENTED= 0x20007,
77     GPGA_PROT_UI_PROBLEM     = 0x20008
78 };
79
80
81 #define buftou32( p )  ((*(byte*)(p) << 24) | (*((byte*)(p)+1)<< 16) | \
82                        (*((byte*)(p)+2) << 8) | (*((byte*)(p)+3)))
83 #define u32tobuf( p, a ) do {                                   \
84                             ((byte*)p)[0] = (byte)((a) >> 24);  \
85                             ((byte*)p)[1] = (byte)((a) >> 16);  \
86                             ((byte*)p)[2] = (byte)((a) >>  8);  \
87                             ((byte*)p)[3] = (byte)((a)      );  \
88                         } while(0)
89
90 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
91 #define hexdigitp(a) (digitp (a)                     \
92                       || (*(a) >= 'A' && *(a) <= 'F')  \
93                       || (*(a) >= 'a' && *(a) <= 'f'))
94 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
95                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
96 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
97
98
99
100 static char *fd_passwd = NULL;
101 static char *next_pw = NULL;
102 static char *last_pw = NULL;
103
104 #if defined (_WIN32)
105 static int read_fd = 0;
106 static int write_fd = 0;
107 #endif
108
109 static void hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create );
110
111 int
112 have_static_passphrase()
113 {
114     if ( opt.use_agent )
115         return 0;
116     return !!fd_passwd;
117 }
118
119 /****************
120  * Set the passphrase to be used for the next query and only for the next
121  * one.
122  */
123 void
124 set_next_passphrase( const char *s )
125 {
126     m_free(next_pw);
127     next_pw = NULL;
128     if( s ) {
129         next_pw = m_alloc_secure( strlen(s)+1 );
130         strcpy(next_pw, s );
131     }
132 }
133
134 /****************
135  * Get the last passphrase used in passphrase_to_dek.
136  * Note: This removes the passphrase from this modules and
137  * the caller must free the result.  May return NULL:
138  */
139 char *
140 get_last_passphrase()
141 {
142     char *p = last_pw;
143     last_pw = NULL;
144     return p;
145 }
146
147
148 void
149 read_passphrase_from_fd( int fd )
150 {
151   int i, len;
152   char *pw;
153   
154   if ( opt.use_agent ) 
155     { /* Not used but we have to do a dummy read, so that it won't end
156          up at the begin of the message if the quite usual trick to
157          prepend the passphtrase to the message is used. */
158       char buf[1];
159
160       while (!(read (fd, buf, 1) != 1 || *buf == '\n' ))
161         ;
162       *buf = 0;
163       return; 
164     }
165
166   if (!opt.batch )
167         tty_printf("Reading passphrase from file descriptor %d ...", fd );
168   for (pw = NULL, i = len = 100; ; i++ ) 
169     {
170       if (i >= len-1 ) 
171         {
172           char *pw2 = pw;
173           len += 100;
174           pw = m_alloc_secure( len );
175           if( pw2 )
176             {
177               memcpy(pw, pw2, i );
178               m_free (pw2);
179             }
180           else
181             i=0;
182         }
183       if (read( fd, pw+i, 1) != 1 || pw[i] == '\n' )
184         break;
185     }
186   pw[i] = 0;
187   if (!opt.batch)
188     tty_printf("\b\b\b   \n" );
189
190   m_free( fd_passwd );
191   fd_passwd = pw;
192 }
193
194 static int
195 writen (int fd, const void *buf, size_t nbytes)
196 {
197 #if defined (_WIN32)
198   DWORD nwritten, nleft = nbytes;
199     
200   while (nleft > 0)
201     {
202       if (!WriteFile ((HANDLE)write_fd, buf, nleft, &nwritten, NULL))
203         {
204           log_error ("write failed: %s\n", w32_strerror (0));
205           return -1;
206         }
207       /*log_info ("** WriteFile fd=%d nytes=%d nwritten=%d\n",
208         write_fd, nbytes, (int)nwritten);*/
209       Sleep (100);
210         
211       nleft -= nwritten;
212       buf = (const BYTE *)buf + nwritten;
213     }
214 #elif defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
215   /* not implemented */
216 #else
217   size_t nleft = nbytes;
218   int nwritten;
219
220   while (nleft > 0)
221     {
222       nwritten = write (fd, buf, nleft);
223       if (nwritten < 0)
224         {
225           if (errno == EINTR)
226             nwritten = 0;
227           else
228             {
229               log_error ("write() failed: %s\n", strerror (errno));
230               return -1;
231             }
232         }
233       nleft -= nwritten;
234       buf = (const char*)buf + nwritten;
235     }
236 #endif
237     
238   return 0;
239 }
240
241
242 static int
243 readn (int fd, void *buf, size_t buflen, size_t *ret_nread)
244 {
245 #if defined (_WIN32)
246   DWORD nread, nleft = buflen;
247     
248   while (nleft > 0)
249     {
250       if (!ReadFile ((HANDLE)read_fd, buf, nleft, &nread, NULL))
251         {
252           log_error ("read() error: %s\n", w32_strerror (0));
253           return -1;
254         }
255       if (!nread || GetLastError() == ERROR_BROKEN_PIPE)
256         break;
257       /*log_info ("** ReadFile fd=%d buflen=%d nread=%d\n",
258         read_fd, buflen, (int)nread);*/
259       Sleep (100);
260         
261       nleft -= nread;
262       buf = (BYTE *)buf + nread;
263     }           
264   if (ret_nread)
265     *ret_nread = buflen - nleft;
266
267 #elif defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
268   /* not implemented */
269 #else
270   size_t nleft = buflen;
271   int nread;
272   char *p;
273   
274   p = buf;
275   while( nleft > 0 )
276     {
277       nread = read ( fd, buf, nleft );
278       if( nread < 0 ) 
279         {
280           if (errno == EINTR)
281             nread = 0;
282           else 
283             {
284               log_error ( "read() error: %s\n", strerror (errno) );
285               return -1;
286             }
287         }
288       else if (!nread)
289         break; /* EOF */
290       nleft -= nread;
291       buf = (char*)buf + nread;
292     }
293   if (ret_nread)
294     *ret_nread = buflen - nleft;
295 #endif
296     
297   return 0;
298 }
299
300 /* read an entire line */
301 static int
302 readline (int fd, char *buf, size_t buflen)
303 {
304   size_t nleft = buflen;
305   char *p;
306   int nread = 0;
307
308   while (nleft > 0)
309     {
310       int n = read (fd, buf, nleft);
311       if (n < 0)
312         {
313           if (errno == EINTR)
314             continue;
315           return -1; /* read error */
316         }
317       else if (!n)
318         {
319           return -1; /* incomplete line */
320         }
321       p = buf;
322       nleft -= n;
323       buf += n;
324       nread += n;
325       
326       for (; n && *p != '\n'; n--, p++)
327         ;
328       if (n)
329         {
330           break; /* at least one full line available - that's enough.
331                     This function is just a temporary hack until we use
332                     the assuna lib in gpg.  So it is okay to forget
333                     about pending bytes */
334         }
335     }
336
337   return nread; 
338 }
339
340
341
342 #if !defined (__riscos__)
343
344 #if !defined (_WIN32)
345 /* For the new Assuan protocol we may have to send options */
346 static int
347 agent_send_option (int fd, const char *name, const char *value)
348 {
349   char buf[200];
350   int nread;
351   char *line;
352   int i; 
353   
354   line = m_alloc (7 + strlen (name) + 1 + strlen (value) + 2);
355   strcpy (stpcpy (stpcpy (stpcpy (
356                      stpcpy (line, "OPTION "), name), "="), value), "\n");
357   i = writen (fd, line, strlen (line));
358   m_free (line);
359   if (i)
360     return -1;
361   
362   /* get response */
363   nread = readline (fd, buf, DIM(buf)-1);
364   if (nread < 3)
365     return -1;
366   
367   if (buf[0] == 'O' && buf[1] == 'K' && (buf[2] == ' ' || buf[2] == '\n')) 
368     return 0; /* okay */
369
370   return -1;
371 }
372
373 static int 
374 agent_send_all_options (int fd)
375 {
376   char *dft_display = NULL;
377   const char *dft_ttyname = NULL;
378   char *dft_ttytype = NULL;
379   char *old_lc = NULL;
380   char *dft_lc = NULL;
381   int rc = 0;
382
383   dft_display = getenv ("DISPLAY");
384   if (opt.display || dft_display)
385     {
386       if (agent_send_option (fd, "display",
387                              opt.display ? opt.display : dft_display))
388         return -1;
389     }
390
391   if (!opt.ttyname)
392     {
393       const char *tmp;
394
395       dft_ttyname = getenv ("GPG_TTY");
396       if ((!dft_ttyname || !*dft_ttyname) && (tmp=ttyname (0)))
397         dft_ttyname = tmp;
398       if ((!dft_ttyname || !*dft_ttyname) && (tmp=tty_get_ttyname ()))
399         dft_ttyname = tmp;
400     }
401   if (opt.ttyname || dft_ttyname)
402     {
403       if (agent_send_option (fd, "ttyname",
404                              opt.ttyname ? opt.ttyname : dft_ttyname))
405         return -1;
406     }
407
408   dft_ttytype = getenv ("TERM");
409   if (opt.ttytype || (dft_ttyname && dft_ttytype))
410     {
411       if (agent_send_option (fd, "ttytype",
412                              opt.ttyname ? opt.ttytype : dft_ttytype))
413         return -1;
414     }
415
416 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
417   old_lc = setlocale (LC_CTYPE, NULL);
418   if (old_lc)
419     old_lc = m_strdup (old_lc);
420   dft_lc = setlocale (LC_CTYPE, "");
421 #endif
422   if (opt.lc_ctype || (dft_ttyname && dft_lc))
423     {
424       rc = agent_send_option (fd, "lc-ctype",
425                               opt.lc_ctype ? opt.lc_ctype : dft_lc);
426     }
427 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
428   if (old_lc)
429     {
430       setlocale (LC_CTYPE, old_lc);
431       m_free (old_lc);
432     }
433 #endif
434   if (rc)
435     return rc;
436
437 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
438   old_lc = setlocale (LC_MESSAGES, NULL);
439   if (old_lc)
440     old_lc = m_strdup (old_lc);
441   dft_lc = setlocale (LC_MESSAGES, "");
442 #endif
443   if (opt.lc_messages || (dft_ttyname && dft_lc))
444     {
445       rc = agent_send_option (fd, "lc-messages",
446                               opt.lc_messages ? opt.lc_messages : dft_lc);
447     }
448 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
449   if (old_lc)
450     {
451       setlocale (LC_MESSAGES, old_lc);
452       m_free (old_lc);
453     }
454 #endif
455   return rc;
456 }
457 #endif /*!_WIN32*/
458
459
460 /*
461  * Open a connection to the agent and send the magic string
462  * Returns: -1 on error or an filedescriptor for urther processing
463  */
464
465 static int
466 agent_open (int *ret_prot)
467 {
468 #if defined (_WIN32)
469     int fd;
470     char *infostr, *p;
471     HANDLE h;
472     char pidstr[128];
473
474     *ret_prot = 0;
475     if ( !(infostr = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
476                                               "agentPID")) 
477          || *infostr == '0') {
478         log_error( _("gpg-agent is not available in this session\n"));
479         return -1;
480     }
481     free(infostr);
482     
483     sprintf(pidstr, "%u", (unsigned int)GetCurrentProcessId());
484     if (write_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
485                                   "agentCID", pidstr)) {
486         log_error( _("can't set client pid for the agent\n") );
487         return -1;
488     }
489     h = OpenEvent(EVENT_ALL_ACCESS, FALSE, "gpg_agent");
490     SetEvent(h);
491     Sleep(50); /* some time for the server */ 
492     if ( !(p = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
493                                         "agentReadFD")) ) {
494         log_error( _("can't get server read FD for the agent\n") );
495         return -1;
496     }
497     read_fd = atol(p);
498     free(p);    
499     if ( !(p = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
500                                         "agentWriteFD")) ) {
501         log_error ( _("can't get server write FD for the agent\n") );
502         return -1;
503     }
504     write_fd = atol(p);
505     free(p);
506     fd = 0;
507
508     if ( writen ( fd, "GPGA\0\0\0\x01", 8 ) ) {
509         fd = -1;
510     }
511 #else /* Posix */
512
513     int fd;
514     char *infostr, *p;
515     struct sockaddr_un client_addr;
516     size_t len;
517     int prot;
518
519     if (opt.gpg_agent_info)
520       infostr = m_strdup (opt.gpg_agent_info);
521     else
522       {
523         infostr = getenv ( "GPG_AGENT_INFO" );
524         if ( !infostr ) {
525           log_error (_("gpg-agent is not available in this session\n"));
526           opt.use_agent = 0;
527           return -1;
528         }
529         infostr = m_strdup ( infostr );
530       }
531
532     if ( !(p = strchr ( infostr, ':')) || p == infostr
533          || (p-infostr)+1 >= sizeof client_addr.sun_path ) {
534         log_error( _("malformed GPG_AGENT_INFO environment variable\n"));
535         m_free (infostr );
536         opt.use_agent = 0;
537         return -1;
538     }
539     *p++ = 0;
540     /* See whether this is the new gpg-agent using the Assuna protocl.
541        This agent identifies itself by have an info string with a
542        version number in the 3rd field. */
543     while (*p && *p != ':')
544       p++;
545     prot = *p? atoi (p+1) : 0;
546     if ( prot < 0 || prot > 1) {
547         log_error (_("gpg-agent protocol version %d is not supported\n"),prot);
548         m_free (infostr );
549         opt.use_agent = 0;
550         return -1;
551     }
552     *ret_prot = prot;
553        
554     if( (fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1 ) {
555         log_error ("can't create socket: %s\n", strerror(errno) );
556         m_free (infostr );
557         opt.use_agent = 0;
558         return -1;
559     }
560     
561     memset( &client_addr, 0, sizeof client_addr );
562     client_addr.sun_family = AF_UNIX;
563     strcpy( client_addr.sun_path, infostr );
564     len = offsetof (struct sockaddr_un, sun_path)
565         + strlen(client_addr.sun_path) + 1;
566     
567     if( connect( fd, (struct sockaddr*)&client_addr, len ) == -1 ) {
568         log_error ( _("can't connect to `%s': %s\n"), 
569                     infostr, strerror (errno) );
570         m_free (infostr );
571         close (fd );
572         opt.use_agent = 0;
573         return -1;
574     }
575     m_free (infostr);
576
577     if (!prot) {
578         if ( writen ( fd, "GPGA\0\0\0\x01", 8 ) ) {
579           close (fd);
580           fd = -1;
581         }
582     }
583     else { /* assuan based gpg-agent */
584       char line[200];
585       int nread;
586
587       nread = readline (fd, line, DIM(line));
588       if (nread < 3 || !(line[0] == 'O' && line[1] == 'K'
589                          && (line[2] == '\n' || line[2] == ' ')) ) {
590         log_error ( _("communication problem with gpg-agent\n"));
591         close (fd );
592         opt.use_agent = 0;
593         return -1;
594       }
595
596       if (agent_send_all_options (fd)) {
597         log_error (_("problem with the agent - disabling agent use\n"));
598         close (fd);
599         opt.use_agent = 0;
600         return -1;
601       }
602         
603     }
604 #endif
605
606     return fd;
607 }
608
609
610 static void
611 agent_close ( int fd )
612 {
613 #if defined (_WIN32)
614     HANDLE h = OpenEvent(EVENT_ALL_ACCESS, FALSE, "gpg_agent");
615     ResetEvent(h);
616 #else
617     close (fd);
618 #endif
619 }
620 #endif /* !__riscos__ */
621
622
623
624 /*
625  * Ask the GPG Agent for the passphrase.
626  * Mode 0:  Allow cached passphrase
627  *      1:  No cached passphrase FIXME: Not really implemented
628  *      2:  Ditto, but change the text to "repeat entry"
629  *
630  * Note that TRYAGAIN_TEXT must not be translated.  If canceled is not
631  * NULL, the function does set it to 1 if the user canceled the
632  * operation.
633  */
634 static char *
635 agent_get_passphrase ( u32 *keyid, int mode, const char *tryagain_text,
636                        const char *custom_description,
637                        const char *custom_prompt, int *canceled)
638 {
639 #if defined(__riscos__)
640   return NULL;
641 #else
642   size_t n;
643   char *atext = NULL;
644   char buf[50];
645   int fd = -1;
646   int nread;
647   u32 reply;
648   char *pw = NULL;
649   PKT_public_key *pk = m_alloc_clear( sizeof *pk );
650   byte fpr[MAX_FINGERPRINT_LEN];
651   int have_fpr = 0;
652   int prot;
653   char *orig_codeset = NULL;
654
655   if (canceled)
656     *canceled = 0;
657
658 #if MAX_FINGERPRINT_LEN < 20
659 #error agent needs a 20 byte fingerprint
660 #endif
661
662   memset (fpr, 0, MAX_FINGERPRINT_LEN );
663   if( keyid && get_pubkey( pk, keyid ) )
664     {
665       free_public_key( pk );      
666       pk = NULL; /* oops: no key for some reason */
667     }
668   
669 #ifdef ENABLE_NLS
670   /* The Assuan agent protol requires us to transmit utf-8 strings */
671   orig_codeset = bind_textdomain_codeset (PACKAGE, NULL);
672 #ifdef HAVE_LANGINFO_CODESET
673   if (!orig_codeset)
674     orig_codeset = nl_langinfo (CODESET);
675 #endif
676   if (orig_codeset)
677     { /* We only switch when we are able to restore the codeset later. */
678       orig_codeset = m_strdup (orig_codeset);
679       if (!bind_textdomain_codeset (PACKAGE, "utf-8"))
680         orig_codeset = NULL; 
681     }
682 #endif
683
684   if ( (fd = agent_open (&prot)) == -1 ) 
685     goto failure;
686
687   if (custom_description)
688     atext = native_to_utf8 (custom_description);
689   else if ( !mode && pk && keyid )
690     { 
691       char *uid;
692       size_t uidlen;
693       const char *algo_name = pubkey_algo_to_string ( pk->pubkey_algo );
694       const char *timestr;
695       char *maink;
696       
697       if ( !algo_name )
698         algo_name = "?";
699
700 #define KEYIDSTRING _(" (main key ID %s)")
701
702       maink = m_alloc ( strlen (KEYIDSTRING) + keystrlen() + 20 );
703       if( keyid[2] && keyid[3] && keyid[0] != keyid[2] 
704           && keyid[1] != keyid[3] )
705         sprintf( maink, KEYIDSTRING, keystr(&keyid[2]) );
706       else
707         *maink = 0;
708       
709       uid = get_user_id ( keyid, &uidlen ); 
710       timestr = strtimestamp (pk->timestamp);
711
712 #undef KEYIDSTRING
713
714 #define PROMPTSTRING _("You need a passphrase to unlock the secret" \
715                        " key for user:\n" \
716                        "\"%.*s\"\n" \
717                        "%u-bit %s key, ID %s, created %s%s\n" )
718
719       atext = m_alloc ( 100 + strlen (PROMPTSTRING)  
720                         + uidlen + 15 + strlen(algo_name) + keystrlen()
721                         + strlen (timestr) + strlen (maink) );
722       sprintf (atext, PROMPTSTRING,
723                (int)uidlen, uid,
724                nbits_from_pk (pk), algo_name, keystr(&keyid[0]), timestr,
725                maink  );
726       m_free (uid);
727       m_free (maink);
728
729 #undef PROMPTSTRING
730
731       { 
732         size_t dummy;
733         fingerprint_from_pk( pk, fpr, &dummy );
734         have_fpr = 1;
735       }
736       
737     }
738   else if (mode == 2 ) 
739     atext = m_strdup ( _("Repeat passphrase\n") );
740   else
741     atext = m_strdup ( _("Enter passphrase\n") );
742                 
743   if (!prot)
744     { /* old style protocol */
745       n = 4 + 20 + strlen (atext);
746       u32tobuf (buf, n );
747       u32tobuf (buf+4, GPGA_PROT_GET_PASSPHRASE );
748       memcpy (buf+8, fpr, 20 );
749       if ( writen ( fd, buf, 28 ) || writen ( fd, atext, strlen (atext) ) ) 
750         goto failure;
751       m_free (atext); atext = NULL;
752       
753       /* get response */
754       if ( readn ( fd, buf, 12, &nread ) ) 
755         goto failure;
756       
757       if ( nread < 8 ) 
758         {
759           log_error ( "response from agent too short\n" );
760           goto failure;
761         }
762       n = buftou32 ( buf );
763       reply = buftou32 ( buf + 4 );
764       if ( reply == GPGA_PROT_GOT_PASSPHRASE ) 
765         {
766           size_t pwlen;
767           size_t nn;
768           
769           if ( nread < 12 || n < 8 ) 
770             {
771               log_error ( "response from agent too short\n" );
772               goto failure;
773             }
774           pwlen = buftou32 ( buf + 8 );
775           nread -= 12;
776           n -= 8;
777           if ( pwlen > n || n > 1000 ) 
778             {
779               log_error (_("passphrase too long\n"));
780               /* or protocol error */
781               goto failure;
782             }
783           /* we read the whole block in one chunk to give no hints
784            * on how long the passhrase actually is - this wastes some bytes
785            * but because we already have this padding we should not loosen
786            * this by issuing 2 read calls */
787           pw = m_alloc_secure ( n+1 );
788           if ( readn ( fd, pw, n, &nn ) )
789             goto failure;
790           if ( n != nn ) 
791             {
792               log_error (_("invalid response from agent\n"));
793               goto failure;           
794             }
795           pw[pwlen] = 0; /* make a C String */
796           agent_close (fd);
797           free_public_key( pk );
798 #ifdef ENABLE_NLS
799           if (orig_codeset)
800             bind_textdomain_codeset (PACKAGE, orig_codeset);
801 #endif
802           m_free (orig_codeset);
803           return pw;
804         }
805       else if ( reply == GPGA_PROT_CANCELED ) 
806         {
807           log_info ( _("cancelled by user\n") );
808           if (canceled)
809             *canceled = 1;
810         }
811       else 
812         log_error ( _("problem with the agent: agent returns 0x%lx\n"),
813                     (ulong)reply );
814     }
815   else
816     { /* The new Assuan protocol */
817       char *line, *p;
818       const unsigned char *s;
819       int i; 
820
821       if (!tryagain_text)
822         tryagain_text = "X";
823       else
824         tryagain_text = _(tryagain_text);
825
826       /* We allocate 2 time the needed space for atext so that there
827          is enough space for escaping */
828       line = m_alloc (15 + 46 
829                       + 3*strlen (tryagain_text)
830                       + 3*strlen (atext)
831                       + 3*strlen (custom_prompt? custom_prompt:"")
832                       + 2);
833       strcpy (line, "GET_PASSPHRASE ");
834       p = line+15;
835       if (!mode && have_fpr)
836         {
837           for (i=0; i < 20; i++, p +=2 )
838             sprintf (p, "%02X", fpr[i]);
839         }
840       else
841         *p++ = 'X'; /* no caching */
842       *p++ = ' ';
843       for (i=0, s=tryagain_text; *s; s++)
844         {
845           if (*s < ' ' || *s == '+')
846             {
847               sprintf (p, "%%%02X", *s);
848               p += 3;
849             }
850           else if (*s == ' ')
851             *p++ = '+';
852           else
853             *p++ = *s;
854         }
855       *p++ = ' ';
856
857       /* The prompt.  */
858       if (custom_prompt)
859         {
860           char *tmp = native_to_utf8 (custom_prompt);
861           for (i=0, s=tmp; *s; s++)
862             {
863               if (*s < ' ' || *s == '+')
864                 {
865                   sprintf (p, "%%%02X", *s);
866                   p += 3;
867                 }
868               else if (*s == ' ')
869                 *p++ = '+';
870               else
871                 *p++ = *s;
872             }
873           xfree (tmp);
874         }
875       else
876         *p++ = 'X'; /* Use the standard prompt */
877
878       *p++ = ' ';
879       /* copy description */
880       for (i=0, s= atext; *s; s++)
881         {
882           if (*s < ' ' || *s == '+')
883             {
884               sprintf (p, "%%%02X", *s);
885               p += 3;
886             }
887           else if (*s == ' ')
888             *p++ = '+';
889           else
890             *p++ = *s;
891         }
892       *p++ = '\n';
893       i = writen (fd, line, p - line);
894       m_free (line);
895       if (i)
896         goto failure;
897       m_free (atext); atext = NULL;
898       
899       /* get response */
900       pw = m_alloc_secure (500);
901       nread = readline (fd, pw, 499);
902       if (nread < 3)
903         goto failure;
904       
905       if (pw[0] == 'O' && pw[1] == 'K' && pw[2] == ' ') 
906         { /* we got a passphrase - convert it back from hex */
907           size_t pwlen = 0;
908
909           for (i=3; i < nread && hexdigitp (pw+i); i+=2)
910             pw[pwlen++] = xtoi_2 (pw+i);
911           pw[pwlen] = 0; /* make a C String */
912           agent_close (fd);
913           free_public_key( pk );
914 #ifdef ENABLE_NLS
915           if (orig_codeset)
916             bind_textdomain_codeset (PACKAGE, orig_codeset);
917 #endif
918           m_free (orig_codeset);
919           return pw;
920         }
921       else if (nread > 4 && !memcmp (pw, "ERR ", 4)
922                && (0xffff & strtoul (&pw[4], NULL, 0)) == 99)
923         {
924           /* 99 is GPG_ERR_CANCELED.  FIXME: Check tail and overflow,
925              and use gpg-error.  */
926           log_info (_("cancelled by user\n") );
927           if (canceled)
928             *canceled = 1;
929         }
930       else 
931         {
932           log_error (_("problem with the agent - disabling agent use\n"));
933           opt.use_agent = 0;
934         }
935     }
936       
937         
938  failure:
939 #ifdef ENABLE_NLS
940   if (orig_codeset)
941     bind_textdomain_codeset (PACKAGE, orig_codeset);
942 #endif
943   m_free (atext);
944   if ( fd != -1 )
945     agent_close (fd);
946   m_free (pw );
947   free_public_key( pk );
948   
949   return NULL;
950 #endif /* Posix or W32 */
951 }
952
953 /*
954  * Clear the cached passphrase
955  */
956 void
957 passphrase_clear_cache ( u32 *keyid, int algo )
958 {
959 #if defined(__riscos__)
960   return ;
961 #else
962   size_t n;
963   char buf[200];
964   int fd = -1;
965   size_t nread;
966   u32 reply;
967   PKT_public_key *pk;
968   byte fpr[MAX_FINGERPRINT_LEN];
969   int prot;
970   
971 #if MAX_FINGERPRINT_LEN < 20
972 #error agent needs a 20 byte fingerprint
973 #endif
974     
975   if (!opt.use_agent)
976     return;
977   
978   pk = m_alloc_clear ( sizeof *pk );
979   memset (fpr, 0, MAX_FINGERPRINT_LEN );
980   if( !keyid || get_pubkey( pk, keyid ) )
981     {
982       log_debug ("oops, no key in passphrase_clear_cache\n");
983       goto failure; /* oops: no key for some reason */
984     }
985   
986   {
987     size_t dummy;
988     fingerprint_from_pk( pk, fpr, &dummy );
989   }
990     
991   if ( (fd = agent_open (&prot)) == -1 ) 
992     goto failure;
993
994   if (!prot)
995     {
996       n = 4 + 20;
997       u32tobuf (buf, n );
998       u32tobuf (buf+4, GPGA_PROT_CLEAR_PASSPHRASE );
999       memcpy (buf+8, fpr, 20 );
1000       if ( writen ( fd, buf, 28 ) )  
1001         goto failure;
1002       
1003       /* get response */
1004       if ( readn ( fd, buf, 8, &nread ) ) 
1005         goto failure;
1006       
1007       if ( nread < 8 ) {
1008         log_error ( "response from agent too short\n" );
1009         goto failure;
1010       }
1011       
1012       reply = buftou32 ( buf + 4 );
1013       if ( reply != GPGA_PROT_OKAY && reply != GPGA_PROT_NO_PASSPHRASE )
1014         {
1015           log_error ( _("problem with the agent: agent returns 0x%lx\n"),
1016                       (ulong)reply );
1017         }
1018     }
1019   else 
1020     { /* The assuan protocol */
1021       char *line, *p;
1022       int i; 
1023
1024       line = m_alloc (17 + 40 + 2);
1025       strcpy (line, "CLEAR_PASSPHRASE ");
1026       p = line+17;
1027       for (i=0; i < 20; i++, p +=2 )
1028         sprintf (p, "%02X", fpr[i]);
1029       *p++ = '\n';
1030       i = writen (fd, line, p - line);
1031       m_free (line);
1032       if (i)
1033         goto failure;
1034       
1035       /* get response */
1036       nread = readline (fd, buf, DIM(buf)-1);
1037       if (nread < 3)
1038         goto failure;
1039       
1040       if (buf[0] == 'O' && buf[1] == 'K' && (buf[2] == ' ' || buf[2] == '\n')) 
1041         ;
1042       else 
1043         {
1044           log_error (_("problem with the agent - disabling agent use\n"));
1045           opt.use_agent = 0;
1046         }
1047     }
1048         
1049  failure:
1050   if (fd != -1)
1051     agent_close (fd);
1052   free_public_key( pk );
1053 #endif /* Posix or W32 */
1054 }
1055
1056
1057
1058
1059 /****************
1060  * Ask for a passphrase and return that string.
1061  */
1062 char *
1063 ask_passphrase (const char *description,
1064                 const char *tryagain_text,
1065                 const char *promptid,
1066                 const char *prompt, int *canceled)
1067 {
1068   char *pw = NULL;
1069   
1070   if (canceled)
1071     *canceled = 0;
1072
1073   if (!opt.batch && description)
1074     tty_printf ("\n%s\n",description);
1075                
1076  agent_died:
1077   if ( opt.use_agent ) 
1078     {
1079       pw = agent_get_passphrase (NULL, 0,
1080                                  tryagain_text, description, prompt,
1081                                  canceled );
1082       if (!pw)
1083         {
1084           if (!opt.use_agent)
1085             goto agent_died;
1086           pw = NULL;
1087         }
1088     }
1089   else if (fd_passwd) 
1090     {
1091       pw = m_alloc_secure (strlen(fd_passwd)+1);
1092       strcpy (pw, fd_passwd);
1093     }
1094   else if (opt.batch)
1095     {
1096       log_error(_("can't query passphrase in batch mode\n"));
1097       pw = NULL;
1098     }
1099   else {
1100     if (tryagain_text)
1101       tty_printf(_("%s.\n"), tryagain_text);
1102     pw = cpr_get_hidden(promptid? promptid : "passphrase.ask",
1103                         prompt?prompt : _("Enter passphrase: ") );
1104     tty_kill_prompt();
1105   }
1106
1107   if (!pw || !*pw)
1108     write_status( STATUS_MISSING_PASSPHRASE );
1109
1110   return pw;
1111 }
1112
1113
1114 /* Return a new DEK object Using the string-to-key sepcifier S2K.  Use
1115  * KEYID and PUBKEY_ALGO to prompt the user.
1116
1117    MODE 0:  Allow cached passphrase
1118         1:  Ignore cached passphrase 
1119         2:  Ditto, but change the text to "repeat entry"
1120 */
1121 DEK *
1122 passphrase_to_dek( u32 *keyid, int pubkey_algo,
1123                    int cipher_algo, STRING2KEY *s2k, int mode,
1124                    const char *tryagain_text, int *canceled)
1125 {
1126     char *pw = NULL;
1127     DEK *dek;
1128     STRING2KEY help_s2k;
1129
1130     if (canceled)
1131       *canceled = 0;
1132
1133     if( !s2k ) {
1134         /* This is used for the old rfc1991 mode 
1135          * Note: This must match the code in encode.c with opt.rfc1991 set */
1136         s2k = &help_s2k;
1137         s2k->mode = 0;
1138         s2k->hash_algo = S2K_DIGEST_ALGO;
1139     }
1140
1141     /* If we do not have a passphrase available in NEXT_PW and status
1142        information are request, we print them now. */
1143     if( !next_pw && is_status_enabled() ) {
1144         char buf[50];
1145  
1146         if( keyid ) {
1147             u32 used_kid[2];
1148             char *us;
1149
1150             if( keyid[2] && keyid[3] ) {
1151                 used_kid[0] = keyid[2];
1152                 used_kid[1] = keyid[3];
1153             }
1154             else {
1155                 used_kid[0] = keyid[0];
1156                 used_kid[1] = keyid[1];
1157             }
1158
1159             us = get_long_user_id_string( keyid );
1160             write_status_text( STATUS_USERID_HINT, us );
1161             m_free(us);
1162
1163             sprintf( buf, "%08lX%08lX %08lX%08lX %d 0",
1164                      (ulong)keyid[0], (ulong)keyid[1],
1165                      (ulong)used_kid[0], (ulong)used_kid[1],
1166                      pubkey_algo );
1167                      
1168             write_status_text( STATUS_NEED_PASSPHRASE, buf );
1169         }
1170         else {
1171             sprintf( buf, "%d %d %d", cipher_algo, s2k->mode, s2k->hash_algo );
1172             write_status_text( STATUS_NEED_PASSPHRASE_SYM, buf );
1173         }
1174     }
1175
1176     /* If we do have a keyID, we do not have a passphrase available in
1177        NEXT_PW, we are not running in batch mode and we do not want to
1178        ignore the passphrase cache (mode!=1), print a prompt with
1179        information on that key. */
1180     if( keyid && !opt.batch && !next_pw && mode!=1 ) {
1181         PKT_public_key *pk = m_alloc_clear( sizeof *pk );
1182         char *p;
1183
1184         p=get_user_id_native(keyid);
1185         tty_printf("\n");
1186         tty_printf(_("You need a passphrase to unlock the secret key for\n"
1187                      "user: \"%s\"\n"),p);
1188         m_free(p);
1189
1190         if( !get_pubkey( pk, keyid ) ) {
1191             const char *s = pubkey_algo_to_string( pk->pubkey_algo );
1192             tty_printf( _("%u-bit %s key, ID %s, created %s"),
1193                        nbits_from_pk( pk ), s?s:"?", keystr(keyid),
1194                        strtimestamp(pk->timestamp) );
1195             if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
1196                                      && keyid[1] != keyid[3] )
1197               {
1198                 if(keystrlen()>10)
1199                   {
1200                     tty_printf("\n");
1201                     tty_printf(_("         (subkey on main key ID %s)"),
1202                                keystr(&keyid[2]) );
1203                   }
1204                 else
1205                   tty_printf( _(" (main key ID %s)"), keystr(&keyid[2]) );
1206               }
1207             tty_printf("\n");
1208         }
1209
1210         tty_printf("\n");
1211         free_public_key( pk );
1212     }
1213
1214  agent_died:
1215     if( next_pw ) {
1216         /* Simply return the passphrase we already have in NEXT_PW. */
1217         pw = next_pw;
1218         next_pw = NULL;
1219     }
1220     else if ( opt.use_agent ) {
1221       /* Divert to the gpg-agent. */
1222         pw = agent_get_passphrase ( keyid, mode == 2? 1: 0,
1223                                     tryagain_text, NULL, NULL, canceled );
1224         if (!pw)
1225           {
1226             if (!opt.use_agent)
1227               goto agent_died;
1228             pw = m_strdup ("");
1229           }
1230         if( *pw && mode == 2 ) {
1231           char *pw2 = agent_get_passphrase ( keyid, 2, NULL, NULL,
1232                                                NULL, canceled );
1233             if (!pw2)
1234               {
1235                 if (!opt.use_agent)
1236                   {
1237                     m_free (pw);
1238                     pw = NULL;
1239                     goto agent_died;
1240                   }
1241                 pw2 = m_strdup ("");
1242               }
1243             if( strcmp(pw, pw2) ) {
1244                 m_free(pw2);
1245                 m_free(pw);
1246                 return NULL;
1247             }
1248             m_free(pw2);
1249         }
1250     }
1251     else if( fd_passwd ) {
1252         /* Return the passphrase we have store in FD_PASSWD. */
1253         pw = m_alloc_secure( strlen(fd_passwd)+1 );
1254         strcpy( pw, fd_passwd );
1255     }
1256     else if( opt.batch )
1257       {
1258         log_error(_("can't query passphrase in batch mode\n"));
1259         pw = m_strdup( "" ); /* return an empty passphrase */
1260       }
1261     else {
1262         /* Read the passphrase from the tty or the command-fd. */
1263         pw = cpr_get_hidden("passphrase.enter", _("Enter passphrase: ") );
1264         tty_kill_prompt();
1265         if( mode == 2 && !cpr_enabled() ) {
1266             char *pw2 = cpr_get_hidden("passphrase.repeat",
1267                                        _("Repeat passphrase: ") );
1268             tty_kill_prompt();
1269             if( strcmp(pw, pw2) ) {
1270                 m_free(pw2);
1271                 m_free(pw);
1272                 return NULL;
1273             }
1274             m_free(pw2);
1275         }
1276     }
1277
1278     if( !pw || !*pw )
1279         write_status( STATUS_MISSING_PASSPHRASE );
1280
1281     /* Hash the passphrase and store it in a newly allocated DEK
1282        object.  Keep a copy of the passphrase in LAST_PW for use by
1283        get_last_passphrase(). */
1284     dek = m_alloc_secure_clear ( sizeof *dek );
1285     dek->algo = cipher_algo;
1286     if( !*pw && mode == 2 )
1287         dek->keylen = 0;
1288     else
1289         hash_passphrase( dek, pw, s2k, mode==2 );
1290     m_free(last_pw);
1291     last_pw = pw;
1292     return dek;
1293 }
1294
1295
1296 /****************
1297  * Hash a passphrase using the supplied s2k. If create is true, create
1298  * a new salt or what else must be filled into the s2k for a new key.
1299  * always needs: dek->algo, s2k->mode, s2k->hash_algo.
1300  */
1301 static void
1302 hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
1303 {
1304     MD_HANDLE md;
1305     int pass, i;
1306     int used = 0;
1307     int pwlen = strlen(pw);
1308
1309     assert( s2k->hash_algo );
1310     dek->keylen = cipher_get_keylen( dek->algo ) / 8;
1311     if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
1312         BUG();
1313
1314     md = md_open( s2k->hash_algo, 1);
1315     for(pass=0; used < dek->keylen ; pass++ ) {
1316         if( pass ) {
1317             md_reset(md);
1318             for(i=0; i < pass; i++ ) /* preset the hash context */
1319                 md_putc(md, 0 );
1320         }
1321
1322         if( s2k->mode == 1 || s2k->mode == 3 ) {
1323             int len2 = pwlen + 8;
1324             ulong count = len2;
1325
1326             if( create && !pass ) {
1327                 randomize_buffer(s2k->salt, 8, 1);
1328                 if( s2k->mode == 3 )
1329                     s2k->count = 96; /* 65536 iterations */
1330             }
1331
1332             if( s2k->mode == 3 ) {
1333                 count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
1334                 if( count < len2 )
1335                     count = len2;
1336             }
1337             /* a little bit complicated because we need a ulong for count */
1338             while( count > len2 ) { /* maybe iterated+salted */
1339                 md_write( md, s2k->salt, 8 );
1340                 md_write( md, pw, pwlen );
1341                 count -= len2;
1342             }
1343             if( count < 8 )
1344                 md_write( md, s2k->salt, count );
1345             else {
1346                 md_write( md, s2k->salt, 8 );
1347                 count -= 8;
1348                 md_write( md, pw, count );
1349             }
1350         }
1351         else
1352             md_write( md, pw, pwlen );
1353         md_final( md );
1354         i = md_digest_length( s2k->hash_algo );
1355         if( i > dek->keylen - used )
1356             i = dek->keylen - used;
1357         memcpy( dek->key+used, md_read(md, s2k->hash_algo), i );
1358         used += i;
1359     }
1360     md_close(md);
1361 }
1362