Merged most of David Shaw's changes in 1.3 since 2003-06-03.
[gnupg.git] / g10 / passphrase.c
1 /* passphrase.c -  Get a passphrase
2  * Copyright (C) 1998,1999,2000,2001,2002,2003 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stddef.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27 #include <assert.h>
28 #if !defined(HAVE_DOSISH_SYSTEM) && !defined(__riscos__)
29 #include <sys/socket.h>
30 #include <sys/un.h>
31 #endif
32 #if defined (_WIN32) || defined (__CYGWIN32__)
33 # include <windows.h>
34 #endif
35 #include <errno.h>
36 #ifdef HAVE_LOCALE_H
37 #include <locale.h>
38 #endif
39 #ifdef HAVE_LANGINFO_CODESET
40 #include <langinfo.h>
41 #endif
42
43 #include "gpg.h"
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     xfree (next_pw);
127     next_pw = NULL;
128     if( s ) {
129         next_pw = gcry_xmalloc_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 = gcry_xmalloc_secure ( len );
175           if( pw2 )
176             memcpy(pw, pw2, i );
177           else
178             i=0;
179         }
180       if (read( fd, pw+i, 1) != 1 || pw[i] == '\n' )
181         break;
182     }
183   pw[i] = 0;
184   if (!opt.batch)
185     tty_printf("\b\b\b   \n" );
186
187   xfree ( fd_passwd );
188   fd_passwd = pw;
189 }
190
191 static int
192 writen ( int fd, const void *buf, size_t nbytes )
193 {
194 #if defined (_WIN32)
195     DWORD nwritten, nleft = nbytes;
196     
197     while (nleft > 0) {
198         if ( !WriteFile( (HANDLE)write_fd, buf, nleft, &nwritten, NULL) ) {
199                 log_error("write failed: ec=%d\n", (int)GetLastError());
200                 return -1;
201         }
202         /*log_info("** WriteFile fd=%d nytes=%d nwritten=%d\n",
203                  write_fd, nbytes, (int)nwritten);*/
204         Sleep(100);
205         
206         nleft -= nwritten;
207         buf = (const BYTE *)buf + nwritten;
208     }
209 #elif defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
210     /* not implemented */
211 #else
212     size_t nleft = nbytes;
213     int nwritten;
214
215     while( nleft > 0 ) {
216         nwritten = write( fd, buf, nleft );
217         if( nwritten < 0 ) {
218             if ( errno == EINTR )
219                 nwritten = 0;
220             else {
221                 log_error ( "write() failed: %s\n", strerror (errno) );
222                 return -1;
223             }
224         }
225         nleft -= nwritten;
226         buf = (const char*)buf + nwritten;
227     }
228 #endif
229     
230     return 0;
231 }
232
233
234 static int
235 readn ( int fd, void *buf, size_t buflen, size_t *ret_nread )
236 {
237 #if defined (_WIN32)
238     DWORD nread, nleft = buflen;
239     
240     while (nleft > 0) {
241         if ( !ReadFile( (HANDLE)read_fd, buf, nleft, &nread, NULL) ) {
242             log_error("read() error: ec=%d\n", (int)GetLastError());
243             return -1;
244         }
245         if (!nread || GetLastError() == ERROR_BROKEN_PIPE)
246             break;
247         /*log_info("** ReadFile fd=%d buflen=%d nread=%d\n",
248           read_fd, buflen, (int)nread);*/
249         Sleep(100);
250         
251         nleft -= nread;
252         buf = (BYTE *)buf + nread;
253     }           
254     if (ret_nread)
255         *ret_nread = buflen - nleft;
256
257 #elif defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
258     /* not implemented */
259 #else
260     size_t nleft = buflen;
261     int nread;
262     char *p;
263
264     p = buf;
265     while( nleft > 0 ) {
266         nread = read ( fd, buf, nleft );
267         if( nread < 0 ) {
268             if (nread == EINTR)
269                 nread = 0;
270             else {
271                 log_error ( "read() error: %s\n", strerror (errno) );
272                 return -1;
273             }
274         }
275         else if( !nread )
276             break; /* EOF */
277         nleft -= nread;
278         buf = (char*)buf + nread;
279     }
280     if( ret_nread )
281         *ret_nread = buflen - nleft;
282 #endif
283     
284     return 0;
285 }
286
287 /* read an entire line */
288 static int
289 readline (int fd, char *buf, size_t buflen)
290 {
291   size_t nleft = buflen;
292   char *p;
293   int nread = 0;
294
295   while (nleft > 0)
296     {
297       int n = read (fd, buf, nleft);
298       if (n < 0)
299         {
300           if (errno == EINTR)
301             continue;
302           return -1; /* read error */
303         }
304       else if (!n)
305         {
306           return -1; /* incomplete line */
307         }
308       p = buf;
309       nleft -= n;
310       buf += n;
311       nread += n;
312       
313       for (; n && *p != '\n'; n--, p++)
314         ;
315       if (n)
316         {
317           break; /* at least one full line available - that's enough.
318                     This function is just a temporary hack until we use
319                     the assuna lib in gpg.  So it is okay to forget
320                     about pending bytes */
321         }
322     }
323
324   return nread; 
325 }
326
327
328
329 #if !defined (__riscos__)
330
331 #if !defined (_WIN32)
332 /* For the new Assuan protocol we may have to send options */
333 static int
334 agent_send_option (int fd, const char *name, const char *value)
335 {
336   char buf[200];
337   int nread;
338   char *line;
339   int i; 
340   
341   line = xmalloc (7 + strlen (name) + 1 + strlen (value) + 2);
342   strcpy (stpcpy (stpcpy (stpcpy (
343                      stpcpy (line, "OPTION "), name), "="), value), "\n");
344   i = writen (fd, line, strlen (line));
345   xfree (line);
346   if (i)
347     return -1;
348   
349   /* get response */
350   nread = readline (fd, buf, DIM(buf)-1);
351   if (nread < 3)
352     return -1;
353   
354   if (buf[0] == 'O' && buf[1] == 'K' && (buf[2] == ' ' || buf[2] == '\n')) 
355     return 0; /* okay */
356
357   return -1;
358 }
359
360 static int 
361 agent_send_all_options (int fd)
362 {
363   char *dft_display = NULL;
364   const char *dft_ttyname = NULL;
365   char *dft_ttytype = NULL;
366   char *old_lc = NULL;
367   char *dft_lc = NULL;
368   int rc = 0;
369
370   dft_display = getenv ("DISPLAY");
371   if (opt.display || dft_display)
372     {
373       if (agent_send_option (fd, "display",
374                              opt.display ? opt.display : dft_display))
375         return -1;
376     }
377
378   if (!opt.ttyname)
379     {
380       dft_ttyname = getenv ("GPG_TTY");
381       if ((!dft_ttyname || !*dft_ttyname) && tty_get_ttyname ())
382         dft_ttyname = tty_get_ttyname ();
383     }
384   if (opt.ttyname || dft_ttyname)
385     {
386       if (agent_send_option (fd, "ttyname",
387                              opt.ttyname ? opt.ttyname : dft_ttyname))
388         return -1;
389     }
390
391   dft_ttytype = getenv ("TERM");
392   if (opt.ttytype || (dft_ttyname && dft_ttytype))
393     {
394       if (agent_send_option (fd, "ttytype",
395                              opt.ttyname ? opt.ttytype : dft_ttytype))
396         return -1;
397     }
398
399 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
400   old_lc = setlocale (LC_CTYPE, NULL);
401   if (old_lc)
402     old_lc = xstrdup (old_lc);
403   dft_lc = setlocale (LC_CTYPE, "");
404 #endif
405   if (opt.lc_ctype || (dft_ttyname && dft_lc))
406     {
407       rc = agent_send_option (fd, "lc-ctype",
408                               opt.lc_ctype ? opt.lc_ctype : dft_lc);
409     }
410 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
411   if (old_lc)
412     {
413       setlocale (LC_CTYPE, old_lc);
414       xfree (old_lc);
415     }
416 #endif
417   if (rc)
418     return rc;
419
420 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
421   old_lc = setlocale (LC_MESSAGES, NULL);
422   if (old_lc)
423     old_lc = xstrdup (old_lc);
424   dft_lc = setlocale (LC_MESSAGES, "");
425 #endif
426   if (opt.lc_messages || (dft_ttyname && dft_lc))
427     {
428       rc = agent_send_option (fd, "lc-messages",
429                               opt.lc_messages ? opt.lc_messages : dft_lc);
430     }
431 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
432   if (old_lc)
433     {
434       setlocale (LC_MESSAGES, old_lc);
435       xfree (old_lc);
436     }
437 #endif
438   return rc;
439 }
440 #endif /*!_WIN32*/
441
442
443 /*
444  * Open a connection to the agent and send the magic string
445  * Returns: -1 on error or an filedescriptor for urther processing
446  */
447
448 static int
449 agent_open (int *ret_prot)
450 {
451 #if defined (_WIN32)
452     int fd;
453     char *infostr, *p;
454     HANDLE h;
455     char pidstr[128];
456
457     *ret_prot = 0;
458     if ( !(infostr = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
459                                               "agentPID")) 
460          || *infostr == '0') {
461         log_error( _("gpg-agent is not available in this session\n"));
462         return -1;
463     }
464     free(infostr);
465     
466     sprintf(pidstr, "%u", (unsigned int)GetCurrentProcessId());
467     if (write_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
468                                   "agentCID", pidstr)) {
469         log_error( _("can't set client pid for the agent\n") );
470         return -1;
471     }
472     h = OpenEvent(EVENT_ALL_ACCESS, FALSE, "gpg_agent");
473     SetEvent(h);
474     Sleep(50); /* some time for the server */ 
475     if ( !(p = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
476                                         "agentReadFD")) ) {
477         log_error( _("can't get server read FD for the agent\n") );
478         return -1;
479     }
480     read_fd = atol(p);
481     free(p);    
482     if ( !(p = read_w32_registry_string(NULL, "Software\\GNU\\GnuPG",
483                                         "agentWriteFD")) ) {
484         log_error ( _("can't get server write FD for the agent\n") );
485         return -1;
486     }
487     write_fd = atol(p);
488     free(p);
489     fd = 0;
490
491     if ( writen ( fd, "GPGA\0\0\0\x01", 8 ) ) {
492         fd = -1;
493     }
494 #else /* Posix */
495
496     int fd;
497     char *infostr, *p;
498     struct sockaddr_un client_addr;
499     size_t len;
500     int prot;
501
502     if (opt.gpg_agent_info)
503       infostr = xstrdup (opt.gpg_agent_info);
504     else
505       {
506         infostr = getenv ( "GPG_AGENT_INFO" );
507         if ( !infostr ) {
508           log_error (_("gpg-agent is not available in this session\n"));
509           opt.use_agent = 0;
510           return -1;
511         }
512         infostr = xstrdup ( infostr );
513       }
514
515     if ( !(p = strchr ( infostr, ':')) || p == infostr
516          || (p-infostr)+1 >= sizeof client_addr.sun_path ) {
517         log_error( _("malformed GPG_AGENT_INFO environment variable\n"));
518         xfree (infostr );
519         opt.use_agent = 0;
520         return -1;
521     }
522     *p++ = 0;
523     /* See whether this is the new gpg-agent using the Assuna protocl.
524        This agent identifies itself by have an info string with a
525        version number in the 3rd field. */
526     while (*p && *p != ':')
527       p++;
528     prot = *p? atoi (p+1) : 0;
529     if ( prot < 0 || prot > 1) {
530         log_error (_("gpg-agent protocol version %d is not supported\n"),prot);
531         xfree (infostr );
532         opt.use_agent = 0;
533         return -1;
534     }
535     *ret_prot = prot;
536        
537     if( (fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1 ) {
538         log_error ("can't create socket: %s\n", strerror(errno) );
539         xfree (infostr );
540         opt.use_agent = 0;
541         return -1;
542     }
543     
544     memset( &client_addr, 0, sizeof client_addr );
545     client_addr.sun_family = AF_UNIX;
546     strcpy( client_addr.sun_path, infostr );
547     len = offsetof (struct sockaddr_un, sun_path)
548         + strlen(client_addr.sun_path) + 1;
549     
550     if( connect( fd, (struct sockaddr*)&client_addr, len ) == -1 ) {
551         log_error ( _("can't connect to `%s': %s\n"), 
552                     infostr, strerror (errno) );
553         xfree (infostr );
554         close (fd );
555         opt.use_agent = 0;
556         return -1;
557     }
558     xfree (infostr);
559
560     if (!prot) {
561         if ( writen ( fd, "GPGA\0\0\0\x01", 8 ) ) {
562           close (fd);
563           fd = -1;
564         }
565     }
566     else { /* assuan based gpg-agent */
567       char line[200];
568       int nread;
569
570       nread = readline (fd, line, DIM(line));
571       if (nread < 3 || !(line[0] == 'O' && line[1] == 'K'
572                          && (line[2] == '\n' || line[2] == ' ')) ) {
573         log_error ( _("communication problem with gpg-agent\n"));
574         close (fd );
575         opt.use_agent = 0;
576         return -1;
577       }
578
579       if (agent_send_all_options (fd)) {
580         log_error (_("problem with the agent - disabling agent use\n"));
581         close (fd);
582         opt.use_agent = 0;
583         return -1;
584       }
585         
586     }
587 #endif
588
589     return fd;
590 }
591
592
593 static void
594 agent_close ( int fd )
595 {
596 #if defined (_WIN32)
597     HANDLE h = OpenEvent(EVENT_ALL_ACCESS, FALSE, "gpg_agent");
598     ResetEvent(h);
599 #else
600     close (fd);
601 #endif
602 }
603 #endif /* !__riscos__ */
604
605
606
607 /*
608  * Ask the GPG Agent for the passphrase.
609  * Mode 0:  Allow cached passphrase
610  *      1:  No cached passphrase FIXME: Not really implemented
611  *      2:  Ditto, but change the text to "repeat entry"
612  *
613  * Note that TRYAGAIN_TEXT must not be translated.  If canceled is not
614  * NULL, the function does set it to 1 if the user canceled the
615  * operation.
616  */
617 static char *
618 agent_get_passphrase ( u32 *keyid, int mode, const char *tryagain_text,
619                        int *canceled)
620 {
621 #if defined(__riscos__)
622   return NULL;
623 #else
624   size_t n;
625   char *atext = NULL;
626   char buf[50];
627   int fd = -1;
628   int nread;
629   u32 reply;
630   char *pw = NULL;
631   PKT_public_key *pk = xcalloc (1, sizeof *pk );
632   byte fpr[MAX_FINGERPRINT_LEN];
633   int have_fpr = 0;
634   int prot;
635   char *orig_codeset = NULL;
636
637   if (canceled)
638     *canceled = 0;
639
640 #if MAX_FINGERPRINT_LEN < 20
641 #error agent needs a 20 byte fingerprint
642 #endif
643
644   memset (fpr, 0, MAX_FINGERPRINT_LEN );
645   if( keyid && get_pubkey( pk, keyid ) )
646     {
647       free_public_key( pk );      
648       pk = NULL; /* oops: no key for some reason */
649     }
650   
651 #ifdef ENABLE_NLS
652   /* The Assuan agent protol requires us to trasnmit utf-8 strings */
653   orig_codeset = bind_textdomain_codeset (PACKAGE, NULL);
654 #ifdef HAVE_LANGINFO_CODESET
655   if (!orig_codeset)
656     orig_codeset = nl_langinfo (CODESET);
657 #endif
658   if (orig_codeset)
659     { /* We only switch when we are able to restore the codeset later. */
660       orig_codeset = xstrdup (orig_codeset);
661       if (!bind_textdomain_codeset (PACKAGE, "utf-8"))
662         orig_codeset = NULL; 
663     }
664 #endif
665
666   if ( (fd = agent_open (&prot)) == -1 ) 
667     goto failure;
668
669   if ( !mode && pk && keyid )
670     { 
671       char *uid;
672       size_t uidlen;
673       const char *algo_name = gcry_pk_algo_name ( pk->pubkey_algo );
674       const char *timestr;
675       char *maink;
676       const char *fmtstr;
677       
678       if ( !algo_name )
679         algo_name = "?";
680       
681       fmtstr = _(" (main key ID %08lX)");
682       maink = xmalloc ( strlen (fmtstr) + 20 );
683       if( keyid[2] && keyid[3] && keyid[0] != keyid[2] 
684           && keyid[1] != keyid[3] )
685         sprintf( maink, fmtstr, (ulong)keyid[3] );
686       else
687         *maink = 0;
688       
689       uid = get_user_id ( keyid, &uidlen ); 
690       timestr = strtimestamp (pk->timestamp);
691       fmtstr = _("You need a passphrase to unlock the"
692                  " secret key for user:\n"
693                  "\"%.*s\"\n"
694                  "%u-bit %s key, ID %08lX, created %s%s\n" );
695       atext = xmalloc ( 100 + strlen (fmtstr)  
696                         + uidlen + 15 + strlen(algo_name) + 8
697                         + strlen (timestr) + strlen (maink) );
698       sprintf (atext, fmtstr,
699                uidlen, uid,
700                nbits_from_pk (pk), algo_name, (ulong)keyid[1], timestr,
701                maink  );
702       xfree (uid);
703       xfree (maink);
704       
705       { 
706         size_t dummy;
707         fingerprint_from_pk( pk, fpr, &dummy );
708         have_fpr = 1;
709       }
710       
711     }
712   else if (mode == 2 ) 
713     atext = xstrdup ( _("Repeat passphrase\n") );
714   else
715     atext = xstrdup ( _("Enter passphrase\n") );
716                 
717   if (!prot)
718     { /* old style protocol */
719       n = 4 + 20 + strlen (atext);
720       u32tobuf (buf, n );
721       u32tobuf (buf+4, GPGA_PROT_GET_PASSPHRASE );
722       memcpy (buf+8, fpr, 20 );
723       if ( writen ( fd, buf, 28 ) || writen ( fd, atext, strlen (atext) ) ) 
724         goto failure;
725       xfree (atext); atext = NULL;
726       
727       /* get response */
728       if ( readn ( fd, buf, 12, &nread ) ) 
729         goto failure;
730       
731       if ( nread < 8 ) 
732         {
733           log_error ( "response from agent too short\n" );
734           goto failure;
735         }
736       n = buftou32 ( buf );
737       reply = buftou32 ( buf + 4 );
738       if ( reply == GPGA_PROT_GOT_PASSPHRASE ) 
739         {
740           size_t pwlen;
741           size_t nn;
742           
743           if ( nread < 12 || n < 8 ) 
744             {
745               log_error ( "response from agent too short\n" );
746               goto failure;
747             }
748           pwlen = buftou32 ( buf + 8 );
749           nread -= 12;
750           n -= 8;
751           if ( pwlen > n || n > 1000 ) 
752             {
753               log_error (_("passphrase too long\n"));
754               /* or protocol error */
755               goto failure;
756             }
757           /* we read the whole block in one chunk to give no hints
758            * on how long the passhrase actually is - this wastes some bytes
759            * but because we already have this padding we should not loosen
760            * this by issuing 2 read calls */
761           pw = xmalloc_secure ( n+1 );
762           if ( readn ( fd, pw, n, &nn ) )
763             goto failure;
764           if ( n != nn ) 
765             {
766               log_error (_("invalid response from agent\n"));
767               goto failure;           
768             }
769           pw[pwlen] = 0; /* make a C String */
770           agent_close (fd);
771           free_public_key( pk );
772 #ifdef ENABLE_NLS
773           if (orig_codeset)
774             bind_textdomain_codeset (PACKAGE, orig_codeset);
775 #endif
776           xfree (orig_codeset);
777           return pw;
778         }
779       else if ( reply == GPGA_PROT_CANCELED ) 
780         {
781           log_info ( _("cancelled by user\n") );
782           if (canceled)
783             *canceled = 1;
784         }
785       else 
786         log_error ( _("problem with the agent: agent returns 0x%lx\n"),
787                     (ulong)reply );
788     }
789   else
790     { /* The new Assuan protocol */
791       char *line, *p;
792       const unsigned char *s;
793       int i; 
794
795       if (!tryagain_text)
796         tryagain_text = "X";
797       else
798         tryagain_text = _(tryagain_text);
799
800       /* We allocate 2 time the needed space for atext so that there
801          is enough space for escaping */
802       line = xmalloc (15 + 46 
803                       +  3*strlen (tryagain_text) + 3*strlen (atext) + 2);
804       strcpy (line, "GET_PASSPHRASE ");
805       p = line+15;
806       if (!mode && have_fpr)
807         {
808           for (i=0; i < 20; i++, p +=2 )
809             sprintf (p, "%02X", fpr[i]);
810         }
811       else
812         *p++ = 'X'; /* no caching */
813       *p++ = ' ';
814       for (i=0, s=tryagain_text; *s; s++)
815         {
816           if (*s < ' ' || *s == '+')
817             {
818               sprintf (p, "%%%02X", *s);
819               p += 3;
820             }
821           else if (*s == ' ')
822             *p++ = '+';
823           else
824             *p++ = *s;
825         }
826       *p++ = ' ';
827       *p++ = 'X'; /* Use the standard prompt */
828       *p++ = ' ';
829       /* copy description */
830       for (i=0, s= atext; *s; s++)
831         {
832           if (*s < ' ' || *s == '+')
833             {
834               sprintf (p, "%%%02X", *s);
835               p += 3;
836             }
837           else if (*s == ' ')
838             *p++ = '+';
839           else
840             *p++ = *s;
841         }
842       *p++ = '\n';
843       i = writen (fd, line, p - line);
844       xfree (line);
845       if (i)
846         goto failure;
847       xfree (atext); atext = NULL;
848       
849       /* get response */
850       pw = xmalloc_secure (500);
851       nread = readline (fd, pw, 499);
852       if (nread < 3)
853         goto failure;
854       
855       if (pw[0] == 'O' && pw[1] == 'K' && pw[2] == ' ') 
856         { /* we got a passphrase - convert it back from hex */
857           size_t pwlen = 0;
858
859           for (i=3; i < nread && hexdigitp (pw+i); i+=2)
860             pw[pwlen++] = xtoi_2 (pw+i);
861           pw[pwlen] = 0; /* make a C String */
862           agent_close (fd);
863           free_public_key( pk );
864 #ifdef ENABLE_NLS
865           if (orig_codeset)
866             bind_textdomain_codeset (PACKAGE, orig_codeset);
867 #endif
868           xfree (orig_codeset);
869           return pw;
870         }
871       else if (nread > 7 && !memcmp (pw, "ERR 111", 7)
872                && (pw[7] == ' ' || pw[7] == '\n') ) 
873         {
874           log_info (_("cancelled by user\n") );
875           if (canceled)
876             *canceled = 1;
877         }
878       else 
879         {
880           log_error (_("problem with the agent - disabling agent use\n"));
881           opt.use_agent = 0;
882         }
883     }
884       
885         
886  failure:
887 #ifdef ENABLE_NLS
888   if (orig_codeset)
889     bind_textdomain_codeset (PACKAGE, orig_codeset);
890 #endif
891   xfree (atext);
892   if ( fd != -1 )
893     agent_close (fd);
894   xfree (pw );
895   free_public_key( pk );
896   
897   return NULL;
898 #endif /* Posix or W32 */
899 }
900
901 /*
902  * Clear the cached passphrase
903  */
904 void
905 passphrase_clear_cache ( u32 *keyid, int algo )
906 {
907 #if defined(__riscos__)
908   return ;
909 #else
910   size_t n;
911   char buf[200];
912   int fd = -1;
913   size_t nread;
914   u32 reply;
915   PKT_public_key *pk;
916   byte fpr[MAX_FINGERPRINT_LEN];
917   int prot;
918   
919 #if MAX_FINGERPRINT_LEN < 20
920 #error agent needs a 20 byte fingerprint
921 #endif
922     
923   if (!opt.use_agent)
924     return;
925   
926   pk = xcalloc (1, sizeof *pk );
927   memset (fpr, 0, MAX_FINGERPRINT_LEN );
928   if( !keyid || get_pubkey( pk, keyid ) )
929     {
930       log_debug ("oops, no key in passphrase_clear_cache\n");
931       goto failure; /* oops: no key for some reason */
932     }
933   
934   {
935     size_t dummy;
936     fingerprint_from_pk( pk, fpr, &dummy );
937   }
938     
939   if ( (fd = agent_open (&prot)) == -1 ) 
940     goto failure;
941
942   if (!prot)
943     {
944       n = 4 + 20;
945       u32tobuf (buf, n );
946       u32tobuf (buf+4, GPGA_PROT_CLEAR_PASSPHRASE );
947       memcpy (buf+8, fpr, 20 );
948       if ( writen ( fd, buf, 28 ) )  
949         goto failure;
950       
951       /* get response */
952       if ( readn ( fd, buf, 8, &nread ) ) 
953         goto failure;
954       
955       if ( nread < 8 ) {
956         log_error ( "response from agent too short\n" );
957         goto failure;
958       }
959       
960       reply = buftou32 ( buf + 4 );
961       if ( reply != GPGA_PROT_OKAY && reply != GPGA_PROT_NO_PASSPHRASE )
962         {
963           log_error ( _("problem with the agent: agent returns 0x%lx\n"),
964                       (ulong)reply );
965         }
966     }
967   else 
968     { /* The assuan protocol */
969       char *line, *p;
970       int i; 
971
972       line = xmalloc (17 + 40 + 2);
973       strcpy (line, "CLEAR_PASSPHRASE ");
974       p = line+17;
975       for (i=0; i < 20; i++, p +=2 )
976         sprintf (p, "%02X", fpr[i]);
977       *p++ = '\n';
978       i = writen (fd, line, p - line);
979       xfree (line);
980       if (i)
981         goto failure;
982       
983       /* get response */
984       nread = readline (fd, buf, DIM(buf)-1);
985       if (nread < 3)
986         goto failure;
987       
988       if (buf[0] == 'O' && buf[1] == 'K' && (buf[2] == ' ' || buf[2] == '\n')) 
989         ;
990       else 
991         {
992           log_error (_("problem with the agent - disabling agent use\n"));
993           opt.use_agent = 0;
994         }
995     }
996         
997  failure:
998   if (fd != -1)
999     agent_close (fd);
1000   free_public_key( pk );
1001 #endif /* Posix or W32 */
1002 }
1003
1004
1005
1006
1007 /****************
1008  * Get a passphrase for the secret key with KEYID, display TEXT
1009  * if the user needs to enter the passphrase.
1010  * mode 0 = standard, 1 = same but don't show key info,
1011  *      2 = create new passphrase
1012  * Returns: a DEK with a session key; caller must free
1013  *          or NULL if the passphrase was not correctly repeated.
1014  *          (only for mode 2)
1015  *          a dek->keylen of 0 means: no passphrase entered.
1016  *          (only for mode 2)
1017  *
1018  * pubkey_algo is only informational.  Note that TRYAGAIN_TEXT must
1019  * not be translated as this is done within this function (required to
1020  * switch to utf-8 when the agent is in use).  If CANCELED is not
1021  * NULL, it is set to 1 if the user choosed to cancel the operation,
1022  * otherwise it will be set to 0.
1023  */
1024 DEK *
1025 passphrase_to_dek( u32 *keyid, int pubkey_algo,
1026                    int cipher_algo, STRING2KEY *s2k, int mode,
1027                    const char *tryagain_text, int *canceled)
1028 {
1029     char *pw = NULL;
1030     DEK *dek;
1031     STRING2KEY help_s2k;
1032
1033     if (canceled)
1034       *canceled = 0;
1035
1036     if( !s2k ) {
1037         /* This is used for the old rfc1991 mode 
1038          * Note: This must match the code in encode.c with opt.rfc1991 set */
1039         s2k = &help_s2k;
1040         s2k->mode = 0;
1041         s2k->hash_algo = opt.s2k_digest_algo;
1042     }
1043
1044     if( !next_pw && is_status_enabled() ) {
1045         char buf[50];
1046
1047         if( keyid ) {
1048             u32 used_kid[2];
1049             char *us;
1050
1051             if( keyid[2] && keyid[3] ) {
1052                 used_kid[0] = keyid[2];
1053                 used_kid[1] = keyid[3];
1054             }
1055             else {
1056                 used_kid[0] = keyid[0];
1057                 used_kid[1] = keyid[1];
1058             }
1059
1060             us = get_long_user_id_string( keyid );
1061             write_status_text( STATUS_USERID_HINT, us );
1062             xfree (us);
1063
1064             sprintf( buf, "%08lX%08lX %08lX%08lX %d 0",
1065                      (ulong)keyid[0], (ulong)keyid[1],
1066                      (ulong)used_kid[0], (ulong)used_kid[1],
1067                      pubkey_algo );
1068                      
1069             write_status_text( STATUS_NEED_PASSPHRASE, buf );
1070         }
1071         else {
1072             sprintf( buf, "%d %d %d", cipher_algo, s2k->mode, s2k->hash_algo );
1073             write_status_text( STATUS_NEED_PASSPHRASE_SYM, buf );
1074         }
1075     }
1076
1077     if( keyid && !opt.batch && !next_pw && mode!=1 ) {
1078         PKT_public_key *pk = xcalloc (1, sizeof *pk );
1079         size_t n;
1080         char *p;
1081
1082         tty_printf(_("\nYou need a passphrase to unlock the secret key for\n"
1083                      "user: \"") );
1084         p = get_user_id( keyid, &n );
1085         tty_print_utf8_string( p, n );
1086         xfree (p);
1087         tty_printf("\"\n");
1088
1089         if( !get_pubkey( pk, keyid ) ) {
1090             const char *s = gcry_pk_algo_name ( pk->pubkey_algo );
1091             tty_printf( _("%u-bit %s key, ID %08lX, created %s"),
1092                        nbits_from_pk( pk ), s?s:"?", (ulong)keyid[1],
1093                        strtimestamp(pk->timestamp) );
1094             if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
1095                                      && keyid[1] != keyid[3] )
1096                 tty_printf( _(" (main key ID %08lX)"), (ulong)keyid[3] );
1097             tty_printf("\n");
1098         }
1099
1100         tty_printf("\n");
1101         free_public_key( pk );
1102     }
1103
1104  agent_died:
1105     if( next_pw ) {
1106         pw = next_pw;
1107         next_pw = NULL;
1108     }
1109     else if ( opt.use_agent ) {
1110         pw = agent_get_passphrase ( keyid, mode == 2? 1: 0,
1111                                     tryagain_text, canceled );
1112         if (!pw)
1113           {
1114             if (!opt.use_agent)
1115               goto agent_died;
1116             pw = xstrdup ("");
1117           }
1118         if( *pw && mode == 2 ) {
1119             char *pw2 = agent_get_passphrase ( keyid, 2, NULL, canceled );
1120             if (!pw2)
1121               {
1122                 if (!opt.use_agent)
1123                   {
1124                     xfree (pw);
1125                     pw = NULL;
1126                     goto agent_died;
1127                   }
1128                 pw2 = xstrdup ("");
1129               }
1130             if( strcmp(pw, pw2) ) {
1131                 xfree (pw2);
1132                 xfree (pw);
1133                 return NULL;
1134             }
1135             xfree (pw2);
1136         }
1137     }
1138     else if( fd_passwd ) {
1139         pw = xmalloc_secure ( strlen(fd_passwd)+1 );
1140         strcpy( pw, fd_passwd );
1141     }
1142     else if( opt.batch ) {
1143         log_error(_("can't query password in batchmode\n"));
1144         pw = xstrdup ( "" ); /* return an empty passphrase */
1145     }
1146     else {
1147         pw = cpr_get_hidden("passphrase.enter", _("Enter passphrase: ") );
1148         tty_kill_prompt();
1149         if( mode == 2 && !cpr_enabled() ) {
1150             char *pw2 = cpr_get_hidden("passphrase.repeat",
1151                                        _("Repeat passphrase: ") );
1152             tty_kill_prompt();
1153             if( strcmp(pw, pw2) ) {
1154                 xfree (pw2);
1155                 xfree (pw);
1156                 return NULL;
1157             }
1158             xfree (pw2);
1159         }
1160     }
1161
1162     if( !pw || !*pw )
1163         write_status( STATUS_MISSING_PASSPHRASE );
1164
1165     dek = xcalloc_secure (1, sizeof *dek );
1166     dek->algo = cipher_algo;
1167     if( !*pw && mode == 2 )
1168         dek->keylen = 0;
1169     else
1170         hash_passphrase( dek, pw, s2k, mode==2 );
1171     xfree (last_pw);
1172     last_pw = pw;
1173     return dek;
1174 }
1175
1176
1177 /****************
1178  * Hash a passphrase using the supplied s2k. If create is true, create
1179  * a new salt or what else must be filled into the s2k for a new key.
1180  * always needs: dek->algo, s2k->mode, s2k->hash_algo.
1181  */
1182 static void
1183 hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
1184 {
1185     MD_HANDLE md;
1186     int pass, i;
1187     int used = 0;
1188     int pwlen = strlen(pw);
1189
1190     assert( s2k->hash_algo );
1191     dek->keylen = gcry_cipher_get_algo_keylen (dek->algo);
1192     if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
1193         BUG();
1194
1195     gcry_md_open (&md, s2k->hash_algo, 1);
1196     for(pass=0; used < dek->keylen ; pass++ ) {
1197         if( pass ) {
1198             gcry_md_reset(md);
1199             for(i=0; i < pass; i++ ) /* preset the hash context */
1200                 gcry_md_putc (md, 0 );
1201         }
1202
1203         if( s2k->mode == 1 || s2k->mode == 3 ) {
1204             int len2 = pwlen + 8;
1205             ulong count = len2;
1206
1207             if( create && !pass ) {
1208                 gcry_randomize(s2k->salt, 8, GCRY_STRONG_RANDOM );
1209                 if( s2k->mode == 3 )
1210                     s2k->count = 96; /* 65536 iterations */
1211             }
1212
1213             if( s2k->mode == 3 ) {
1214                 count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
1215                 if( count < len2 )
1216                     count = len2;
1217             }
1218             /* a little bit complicated because we need a ulong for count */
1219             while( count > len2 ) { /* maybe iterated+salted */
1220                 gcry_md_write( md, s2k->salt, 8 );
1221                 gcry_md_write( md, pw, pwlen );
1222                 count -= len2;
1223             }
1224             if( count < 8 )
1225                 gcry_md_write( md, s2k->salt, count );
1226             else {
1227                 gcry_md_write( md, s2k->salt, 8 );
1228                 count -= 8;
1229                 gcry_md_write( md, pw, count );
1230             }
1231         }
1232         else
1233             gcry_md_write( md, pw, pwlen );
1234         gcry_md_final ( md );
1235         i = gcry_md_get_algo_dlen (s2k->hash_algo);
1236         if( i > dek->keylen - used )
1237             i = dek->keylen - used;
1238         memcpy( dek->key+used, gcry_md_read (md, s2k->hash_algo), i );
1239         used += i;
1240     }
1241     gcry_md_close (md);
1242 }
1243