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