* README: Mentioned --enable-selinux-support.
[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         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 = m_alloc (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   m_free (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 = m_strdup (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       m_free (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 = m_strdup (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       m_free (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 = m_strdup (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 = m_strdup ( 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         m_free (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         m_free (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         m_free (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         m_free (infostr );
554         close (fd );
555         opt.use_agent = 0;
556         return -1;
557     }
558     m_free (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 = m_alloc_clear( 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 = m_strdup (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 = pubkey_algo_to_string ( pk->pubkey_algo );
674       const char *timestr;
675       char *maink;
676       
677       if ( !algo_name )
678         algo_name = "?";
679
680 #define KEYIDSTRING _(" (main key ID %s)")
681
682       maink = m_alloc ( strlen (KEYIDSTRING) + keystrlen() + 20 );
683       if( keyid[2] && keyid[3] && keyid[0] != keyid[2] 
684           && keyid[1] != keyid[3] )
685         sprintf( maink, KEYIDSTRING, keystr(&keyid[2]) );
686       else
687         *maink = 0;
688       
689       uid = get_user_id ( keyid, &uidlen ); 
690       timestr = strtimestamp (pk->timestamp);
691
692 #undef KEYIDSTRING
693
694 #define PROMPTSTRING _("You need a passphrase to unlock the secret" \
695                        " key for user:\n" \
696                        "\"%.*s\"\n" \
697                        "%u-bit %s key, ID %s, created %s%s\n" )
698
699       atext = m_alloc ( 100 + strlen (PROMPTSTRING)  
700                         + uidlen + 15 + strlen(algo_name) + keystrlen()
701                         + strlen (timestr) + strlen (maink) );
702       sprintf (atext, PROMPTSTRING,
703                uidlen, uid,
704                nbits_from_pk (pk), algo_name, keystr(&keyid[0]), timestr,
705                maink  );
706       m_free (uid);
707       m_free (maink);
708
709 #undef PROMPTSTRING
710
711       { 
712         size_t dummy;
713         fingerprint_from_pk( pk, fpr, &dummy );
714         have_fpr = 1;
715       }
716       
717     }
718   else if (mode == 2 ) 
719     atext = m_strdup ( _("Repeat passphrase\n") );
720   else
721     atext = m_strdup ( _("Enter passphrase\n") );
722                 
723   if (!prot)
724     { /* old style protocol */
725       n = 4 + 20 + strlen (atext);
726       u32tobuf (buf, n );
727       u32tobuf (buf+4, GPGA_PROT_GET_PASSPHRASE );
728       memcpy (buf+8, fpr, 20 );
729       if ( writen ( fd, buf, 28 ) || writen ( fd, atext, strlen (atext) ) ) 
730         goto failure;
731       m_free (atext); atext = NULL;
732       
733       /* get response */
734       if ( readn ( fd, buf, 12, &nread ) ) 
735         goto failure;
736       
737       if ( nread < 8 ) 
738         {
739           log_error ( "response from agent too short\n" );
740           goto failure;
741         }
742       n = buftou32 ( buf );
743       reply = buftou32 ( buf + 4 );
744       if ( reply == GPGA_PROT_GOT_PASSPHRASE ) 
745         {
746           size_t pwlen;
747           size_t nn;
748           
749           if ( nread < 12 || n < 8 ) 
750             {
751               log_error ( "response from agent too short\n" );
752               goto failure;
753             }
754           pwlen = buftou32 ( buf + 8 );
755           nread -= 12;
756           n -= 8;
757           if ( pwlen > n || n > 1000 ) 
758             {
759               log_error (_("passphrase too long\n"));
760               /* or protocol error */
761               goto failure;
762             }
763           /* we read the whole block in one chunk to give no hints
764            * on how long the passhrase actually is - this wastes some bytes
765            * but because we already have this padding we should not loosen
766            * this by issuing 2 read calls */
767           pw = m_alloc_secure ( n+1 );
768           if ( readn ( fd, pw, n, &nn ) )
769             goto failure;
770           if ( n != nn ) 
771             {
772               log_error (_("invalid response from agent\n"));
773               goto failure;           
774             }
775           pw[pwlen] = 0; /* make a C String */
776           agent_close (fd);
777           free_public_key( pk );
778 #ifdef ENABLE_NLS
779           if (orig_codeset)
780             bind_textdomain_codeset (PACKAGE, orig_codeset);
781 #endif
782           m_free (orig_codeset);
783           return pw;
784         }
785       else if ( reply == GPGA_PROT_CANCELED ) 
786         {
787           log_info ( _("cancelled by user\n") );
788           if (canceled)
789             *canceled = 1;
790         }
791       else 
792         log_error ( _("problem with the agent: agent returns 0x%lx\n"),
793                     (ulong)reply );
794     }
795   else
796     { /* The new Assuan protocol */
797       char *line, *p;
798       const unsigned char *s;
799       int i; 
800
801       if (!tryagain_text)
802         tryagain_text = "X";
803       else
804         tryagain_text = _(tryagain_text);
805
806       /* We allocate 2 time the needed space for atext so that there
807          is nenough space for escaping */
808       line = m_alloc (15 + 46 
809                       +  3*strlen (tryagain_text) + 3*strlen (atext) + 2);
810       strcpy (line, "GET_PASSPHRASE ");
811       p = line+15;
812       if (!mode && have_fpr)
813         {
814           for (i=0; i < 20; i++, p +=2 )
815             sprintf (p, "%02X", fpr[i]);
816         }
817       else
818         *p++ = 'X'; /* no caching */
819       *p++ = ' ';
820       for (i=0, s=tryagain_text; *s; s++)
821         {
822           if (*s < ' ' || *s == '+')
823             {
824               sprintf (p, "%%%02X", *s);
825               p += 3;
826             }
827           else if (*s == ' ')
828             *p++ = '+';
829           else
830             *p++ = *s;
831         }
832       *p++ = ' ';
833       *p++ = 'X'; /* Use the standard prompt */
834       *p++ = ' ';
835       /* copy description */
836       for (i=0, s= atext; *s; s++)
837         {
838           if (*s < ' ' || *s == '+')
839             {
840               sprintf (p, "%%%02X", *s);
841               p += 3;
842             }
843           else if (*s == ' ')
844             *p++ = '+';
845           else
846             *p++ = *s;
847         }
848       *p++ = '\n';
849       i = writen (fd, line, p - line);
850       m_free (line);
851       if (i)
852         goto failure;
853       m_free (atext); atext = NULL;
854       
855       /* get response */
856       pw = m_alloc_secure (500);
857       nread = readline (fd, pw, 499);
858       if (nread < 3)
859         goto failure;
860       
861       if (pw[0] == 'O' && pw[1] == 'K' && pw[2] == ' ') 
862         { /* we got a passphrase - convert it back from hex */
863           size_t pwlen = 0;
864
865           for (i=3; i < nread && hexdigitp (pw+i); i+=2)
866             pw[pwlen++] = xtoi_2 (pw+i);
867           pw[pwlen] = 0; /* make a C String */
868           agent_close (fd);
869           free_public_key( pk );
870 #ifdef ENABLE_NLS
871           if (orig_codeset)
872             bind_textdomain_codeset (PACKAGE, orig_codeset);
873 #endif
874           m_free (orig_codeset);
875           return pw;
876         }
877       else if (nread > 4 && !memcmp (pw, "ERR ", 4)
878                && (0xffff & strtoul (&pw[4], NULL, 0)) == 99)
879         {
880           /* 99 is GPG_ERR_CANCELED.  FIXME: Check tail and overflow,
881              and use gpg-error.  */
882           log_info (_("cancelled by user\n") );
883           if (canceled)
884             *canceled = 1;
885         }
886       else 
887         {
888           log_error (_("problem with the agent - disabling agent use\n"));
889           opt.use_agent = 0;
890         }
891     }
892       
893         
894  failure:
895 #ifdef ENABLE_NLS
896   if (orig_codeset)
897     bind_textdomain_codeset (PACKAGE, orig_codeset);
898 #endif
899   m_free (atext);
900   if ( fd != -1 )
901     agent_close (fd);
902   m_free (pw );
903   free_public_key( pk );
904   
905   return NULL;
906 #endif /* Posix or W32 */
907 }
908
909 /*
910  * Clear the cached passphrase
911  */
912 void
913 passphrase_clear_cache ( u32 *keyid, int algo )
914 {
915 #if defined(__riscos__)
916   return ;
917 #else
918   size_t n;
919   char buf[200];
920   int fd = -1;
921   size_t nread;
922   u32 reply;
923   PKT_public_key *pk;
924   byte fpr[MAX_FINGERPRINT_LEN];
925   int prot;
926   
927 #if MAX_FINGERPRINT_LEN < 20
928 #error agent needs a 20 byte fingerprint
929 #endif
930     
931   if (!opt.use_agent)
932     return;
933   
934   pk = m_alloc_clear ( sizeof *pk );
935   memset (fpr, 0, MAX_FINGERPRINT_LEN );
936   if( !keyid || get_pubkey( pk, keyid ) )
937     {
938       log_debug ("oops, no key in passphrase_clear_cache\n");
939       goto failure; /* oops: no key for some reason */
940     }
941   
942   {
943     size_t dummy;
944     fingerprint_from_pk( pk, fpr, &dummy );
945   }
946     
947   if ( (fd = agent_open (&prot)) == -1 ) 
948     goto failure;
949
950   if (!prot)
951     {
952       n = 4 + 20;
953       u32tobuf (buf, n );
954       u32tobuf (buf+4, GPGA_PROT_CLEAR_PASSPHRASE );
955       memcpy (buf+8, fpr, 20 );
956       if ( writen ( fd, buf, 28 ) )  
957         goto failure;
958       
959       /* get response */
960       if ( readn ( fd, buf, 8, &nread ) ) 
961         goto failure;
962       
963       if ( nread < 8 ) {
964         log_error ( "response from agent too short\n" );
965         goto failure;
966       }
967       
968       reply = buftou32 ( buf + 4 );
969       if ( reply != GPGA_PROT_OKAY && reply != GPGA_PROT_NO_PASSPHRASE )
970         {
971           log_error ( _("problem with the agent: agent returns 0x%lx\n"),
972                       (ulong)reply );
973         }
974     }
975   else 
976     { /* The assuan protocol */
977       char *line, *p;
978       int i; 
979
980       line = m_alloc (17 + 40 + 2);
981       strcpy (line, "CLEAR_PASSPHRASE ");
982       p = line+17;
983       for (i=0; i < 20; i++, p +=2 )
984         sprintf (p, "%02X", fpr[i]);
985       *p++ = '\n';
986       i = writen (fd, line, p - line);
987       m_free (line);
988       if (i)
989         goto failure;
990       
991       /* get response */
992       nread = readline (fd, buf, DIM(buf)-1);
993       if (nread < 3)
994         goto failure;
995       
996       if (buf[0] == 'O' && buf[1] == 'K' && (buf[2] == ' ' || buf[2] == '\n')) 
997         ;
998       else 
999         {
1000           log_error (_("problem with the agent - disabling agent use\n"));
1001           opt.use_agent = 0;
1002         }
1003     }
1004         
1005  failure:
1006   if (fd != -1)
1007     agent_close (fd);
1008   free_public_key( pk );
1009 #endif /* Posix or W32 */
1010 }
1011
1012
1013
1014
1015 /****************
1016  * Ask for a passphrase and return that string.
1017  */
1018 char *
1019 ask_passphrase (const char *description,
1020                 const char *promptid,
1021                 const char *prompt, int *canceled)
1022 {
1023   char *pw = NULL;
1024   
1025   if (canceled)
1026     *canceled = 0;
1027
1028   if (!opt.batch && description)
1029     tty_printf ("\n%s\n",description);
1030                
1031  agent_died:
1032   if ( opt.use_agent ) 
1033     {
1034       pw = agent_get_passphrase (NULL, 0,  description, canceled );
1035       if (!pw)
1036         {
1037           if (!opt.use_agent)
1038             goto agent_died;
1039           pw = NULL;
1040         }
1041     }
1042   else if (fd_passwd) 
1043     {
1044       pw = m_alloc_secure (strlen(fd_passwd)+1);
1045       strcpy (pw, fd_passwd);
1046     }
1047   else if (opt.batch)
1048     {
1049       log_error(_("can't query password in batchmode\n"));
1050       pw = NULL;
1051     }
1052   else {
1053     pw = cpr_get_hidden(promptid? promptid : "passphrase.ask",
1054                         prompt?prompt : _("Enter passphrase: ") );
1055     tty_kill_prompt();
1056   }
1057
1058   if (!pw || !*pw)
1059     write_status( STATUS_MISSING_PASSPHRASE );
1060
1061   return pw;
1062 }
1063
1064
1065 /* Return a new DEK object Using the string-to-key sepcifier S2K.  Use
1066  * KEYID and PUBKEY_ALGO to prompt the user.
1067
1068    MODE 0:  Allow cached passphrase
1069         1:  Ignore cached passphrase 
1070         2:  Ditto, but change the text to "repeat entry"
1071 */
1072 DEK *
1073 passphrase_to_dek( u32 *keyid, int pubkey_algo,
1074                    int cipher_algo, STRING2KEY *s2k, int mode,
1075                    const char *tryagain_text, int *canceled)
1076 {
1077     char *pw = NULL;
1078     DEK *dek;
1079     STRING2KEY help_s2k;
1080
1081     if (canceled)
1082       *canceled = 0;
1083
1084     if( !s2k ) {
1085         /* This is used for the old rfc1991 mode 
1086          * Note: This must match the code in encode.c with opt.rfc1991 set */
1087         s2k = &help_s2k;
1088         s2k->mode = 0;
1089         s2k->hash_algo = S2K_DIGEST_ALGO;
1090     }
1091
1092     /* If we do not have a passphrase available in NEXT_PW and status
1093        information are request, we print them now. */
1094     if( !next_pw && is_status_enabled() ) {
1095         char buf[50];
1096  
1097         if( keyid ) {
1098             u32 used_kid[2];
1099             char *us;
1100
1101             if( keyid[2] && keyid[3] ) {
1102                 used_kid[0] = keyid[2];
1103                 used_kid[1] = keyid[3];
1104             }
1105             else {
1106                 used_kid[0] = keyid[0];
1107                 used_kid[1] = keyid[1];
1108             }
1109
1110             us = get_long_user_id_string( keyid );
1111             write_status_text( STATUS_USERID_HINT, us );
1112             m_free(us);
1113
1114             sprintf( buf, "%08lX%08lX %08lX%08lX %d 0",
1115                      (ulong)keyid[0], (ulong)keyid[1],
1116                      (ulong)used_kid[0], (ulong)used_kid[1],
1117                      pubkey_algo );
1118                      
1119             write_status_text( STATUS_NEED_PASSPHRASE, buf );
1120         }
1121         else {
1122             sprintf( buf, "%d %d %d", cipher_algo, s2k->mode, s2k->hash_algo );
1123             write_status_text( STATUS_NEED_PASSPHRASE_SYM, buf );
1124         }
1125     }
1126
1127     /* If we do have a keyID, we do not have a passphrase available in
1128        NEXT_PW, we are not running in batch mode and we do not want to
1129        ignore the passphrase cache (mode!=1), print a prompt with
1130        information on that key. */
1131     if( keyid && !opt.batch && !next_pw && mode!=1 ) {
1132         PKT_public_key *pk = m_alloc_clear( sizeof *pk );
1133         char *p;
1134
1135         p=get_user_id_native(keyid);
1136         tty_printf("\n");
1137         tty_printf(_("You need a passphrase to unlock the secret key for\n"
1138                      "user: \"%s\"\n"),p);
1139         m_free(p);
1140
1141         if( !get_pubkey( pk, keyid ) ) {
1142             const char *s = pubkey_algo_to_string( pk->pubkey_algo );
1143             tty_printf( _("%u-bit %s key, ID %s, created %s"),
1144                        nbits_from_pk( pk ), s?s:"?", keystr(keyid),
1145                        strtimestamp(pk->timestamp) );
1146             if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
1147                                      && keyid[1] != keyid[3] )
1148               {
1149                 if(keystrlen()>10)
1150                   {
1151                     tty_printf("\n");
1152                     tty_printf(_("         (subkey on main key ID %s)"),
1153                                keystr(&keyid[2]) );
1154                   }
1155                 else
1156                   tty_printf( _(" (main key ID %s)"), keystr(&keyid[2]) );
1157               }
1158             tty_printf("\n");
1159         }
1160
1161         tty_printf("\n");
1162         free_public_key( pk );
1163     }
1164
1165  agent_died:
1166     if( next_pw ) {
1167         /* Simply return the passpharse we already have in NEXT_PW. */
1168         pw = next_pw;
1169         next_pw = NULL;
1170     }
1171     else if ( opt.use_agent ) {
1172       /* Divert to teh gpg-agent. */
1173         pw = agent_get_passphrase ( keyid, mode == 2? 1: 0,
1174                                     tryagain_text, canceled );
1175         if (!pw)
1176           {
1177             if (!opt.use_agent)
1178               goto agent_died;
1179             pw = m_strdup ("");
1180           }
1181         if( *pw && mode == 2 ) {
1182             char *pw2 = agent_get_passphrase ( keyid, 2, NULL, canceled );
1183             if (!pw2)
1184               {
1185                 if (!opt.use_agent)
1186                   {
1187                     m_free (pw);
1188                     pw = NULL;
1189                     goto agent_died;
1190                   }
1191                 pw2 = m_strdup ("");
1192               }
1193             if( strcmp(pw, pw2) ) {
1194                 m_free(pw2);
1195                 m_free(pw);
1196                 return NULL;
1197             }
1198             m_free(pw2);
1199         }
1200     }
1201     else if( fd_passwd ) {
1202         /* Return the passphrase we have store in FD_PASSWD. */
1203         pw = m_alloc_secure( strlen(fd_passwd)+1 );
1204         strcpy( pw, fd_passwd );
1205     }
1206     else if( opt.batch ) {
1207         log_error(_("can't query password in batchmode\n"));
1208         pw = m_strdup( "" ); /* return an empty passphrase */
1209     }
1210     else {
1211         /* Read the passphrase from the tty or the command-fd. */
1212         pw = cpr_get_hidden("passphrase.enter", _("Enter passphrase: ") );
1213         tty_kill_prompt();
1214         if( mode == 2 && !cpr_enabled() ) {
1215             char *pw2 = cpr_get_hidden("passphrase.repeat",
1216                                        _("Repeat passphrase: ") );
1217             tty_kill_prompt();
1218             if( strcmp(pw, pw2) ) {
1219                 m_free(pw2);
1220                 m_free(pw);
1221                 return NULL;
1222             }
1223             m_free(pw2);
1224         }
1225     }
1226
1227     if( !pw || !*pw )
1228         write_status( STATUS_MISSING_PASSPHRASE );
1229
1230     /* Hash the passphrase and store it in a newly allocated DEK
1231        object.  Keep a copy of the passphrase in LAST_PW for use by
1232        get_last_passphrase(). */
1233     dek = m_alloc_secure_clear ( sizeof *dek );
1234     dek->algo = cipher_algo;
1235     if( !*pw && mode == 2 )
1236         dek->keylen = 0;
1237     else
1238         hash_passphrase( dek, pw, s2k, mode==2 );
1239     m_free(last_pw);
1240     last_pw = pw;
1241     return dek;
1242 }
1243
1244
1245 /****************
1246  * Hash a passphrase using the supplied s2k. If create is true, create
1247  * a new salt or what else must be filled into the s2k for a new key.
1248  * always needs: dek->algo, s2k->mode, s2k->hash_algo.
1249  */
1250 static void
1251 hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
1252 {
1253     MD_HANDLE md;
1254     int pass, i;
1255     int used = 0;
1256     int pwlen = strlen(pw);
1257
1258     assert( s2k->hash_algo );
1259     dek->keylen = cipher_get_keylen( dek->algo ) / 8;
1260     if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
1261         BUG();
1262
1263     md = md_open( s2k->hash_algo, 1);
1264     for(pass=0; used < dek->keylen ; pass++ ) {
1265         if( pass ) {
1266             md_reset(md);
1267             for(i=0; i < pass; i++ ) /* preset the hash context */
1268                 md_putc(md, 0 );
1269         }
1270
1271         if( s2k->mode == 1 || s2k->mode == 3 ) {
1272             int len2 = pwlen + 8;
1273             ulong count = len2;
1274
1275             if( create && !pass ) {
1276                 randomize_buffer(s2k->salt, 8, 1);
1277                 if( s2k->mode == 3 )
1278                     s2k->count = 96; /* 65536 iterations */
1279             }
1280
1281             if( s2k->mode == 3 ) {
1282                 count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
1283                 if( count < len2 )
1284                     count = len2;
1285             }
1286             /* a little bit complicated because we need a ulong for count */
1287             while( count > len2 ) { /* maybe iterated+salted */
1288                 md_write( md, s2k->salt, 8 );
1289                 md_write( md, pw, pwlen );
1290                 count -= len2;
1291             }
1292             if( count < 8 )
1293                 md_write( md, s2k->salt, count );
1294             else {
1295                 md_write( md, s2k->salt, 8 );
1296                 count -= 8;
1297                 md_write( md, pw, count );
1298             }
1299         }
1300         else
1301             md_write( md, pw, pwlen );
1302         md_final( md );
1303         i = md_digest_length( s2k->hash_algo );
1304         if( i > dek->keylen - used )
1305             i = dek->keylen - used;
1306         memcpy( dek->key+used, md_read(md, s2k->hash_algo), i );
1307         used += i;
1308     }
1309     md_close(md);
1310 }
1311