See ChangeLog: Mon Jan 24 22:24:38 CET 2000 Werner Koch
[gnupg.git] / g10 / passphrase.c
1 /* passphrase.c -  Get a passphrase
2  *      Copyright (C) 1998 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 <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <unistd.h>
26 #include <assert.h>
27 #include "util.h"
28 #include <gcrypt.h>
29 #include "options.h"
30 #include "ttyio.h"
31 #include "dummy-cipher.h"
32 #include "keydb.h"
33 #include "main.h"
34 #include "i18n.h"
35 #include "status.h"
36
37 static char *fd_passwd = NULL;
38 static char *next_pw = NULL;
39 static char *last_pw = NULL;
40
41 static void hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create );
42
43 int
44 have_static_passphrase()
45 {
46     return !!fd_passwd;
47 }
48
49 /****************
50  * Set the passphrase to be used for the next query and only for the next
51  * one.
52  */
53 void
54 set_next_passphrase( const char *s )
55 {
56     gcry_free(next_pw);
57     next_pw = NULL;
58     if( s ) {
59         next_pw = gcry_xmalloc_secure( strlen(s)+1 );
60         strcpy(next_pw, s );
61     }
62 }
63
64 /****************
65  * Get the last passphrase used in passphrase_to_dek.
66  * Note: This removes the passphrase from this modules and
67  * the caller must free the result.  May return NULL:
68  */
69 char *
70 get_last_passphrase()
71 {
72     char *p = last_pw;
73     last_pw = NULL;
74     return p;
75 }
76
77
78 void
79 read_passphrase_from_fd( int fd )
80 {
81     int i, len;
82     char *pw;
83
84     if( !opt.batch )
85         tty_printf("Reading passphrase from file descriptor %d ...", fd );
86     for( pw = NULL, i = len = 100; ; i++ ) {
87         if( i >= len-1 ) {
88             char *pw2 = pw;
89             len += 100;
90             pw = gcry_xmalloc_secure( len );
91             if( pw2 )
92                 memcpy(pw, pw2, i );
93             else
94                 i=0;
95         }
96         if( read( fd, pw+i, 1) != 1 || pw[i] == '\n' )
97             break;
98     }
99     pw[i] = 0;
100     if( !opt.batch )
101         tty_printf("\b\b\b   \n" );
102
103     gcry_free( fd_passwd );
104     fd_passwd = pw;
105 }
106
107
108 /****************
109  * Get a passphrase for the secret key with KEYID, display TEXT
110  * if the user needs to enter the passphrase.
111  * mode 0 = standard, 2 = create new passphrase
112  * Returns: a DEK with a session key; caller must free
113  *          or NULL if the passphrase was not correctly repeated.
114  *          (only for mode 2)
115  *          a dek->keylen of 0 means: no passphrase entered.
116  *          (only for mode 2)
117  * pubkey_algo is only informational.
118  */
119 DEK *
120 passphrase_to_dek( u32 *keyid, int pubkey_algo,
121                    int cipher_algo, STRING2KEY *s2k, int mode )
122 {
123     char *pw = NULL;
124     DEK *dek;
125     STRING2KEY help_s2k;
126
127     if( !s2k ) {
128         s2k = &help_s2k;
129         s2k->mode = 0;
130         /* this should be MD5 if cipher is IDEA, but because we do
131          * not have IDEA, we use the default one, the user
132          * can select it from the commandline
133          */
134         s2k->hash_algo = opt.def_digest_algo?opt.def_digest_algo
135                                             :DEFAULT_DIGEST_ALGO;
136     }
137
138     if( !next_pw && is_status_enabled() ) {
139         char buf[50];
140         if( keyid ) {
141             sprintf( buf, "%08lX%08lX", (ulong)keyid[0], (ulong)keyid[1] );
142             if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
143                                      && keyid[1] != keyid[3] )
144                 sprintf( buf+strlen(buf), " %08lX%08lX %d 0",
145                            (ulong)keyid[2], (ulong)keyid[3], pubkey_algo );
146             write_status_text( STATUS_NEED_PASSPHRASE, buf );
147         }
148         else {
149             sprintf( buf, "%d %d %d", cipher_algo, s2k->mode, s2k->hash_algo );
150             write_status_text( STATUS_NEED_PASSPHRASE_SYM, buf );
151         }
152     }
153
154     if( keyid && !opt.batch && !next_pw ) {
155         PKT_public_key *pk = gcry_xcalloc( 1, sizeof *pk );
156         size_t n;
157         char *p;
158
159         tty_printf(_("\nYou need a passphrase to unlock the secret key for\n"
160                      "user: \"") );
161         p = get_user_id( keyid, &n );
162         tty_print_utf8_string( p, n );
163         gcry_free(p);
164         tty_printf("\"\n");
165
166         if( !get_pubkey( pk, keyid ) ) {
167             tty_printf( _("%u-bit %s key, ID %08lX, created %s"),
168                        nbits_from_pk( pk ),
169                        gcry_pk_algo_name( pk->pubkey_algo ), (ulong)keyid[1],
170                        strtimestamp(pk->timestamp) );
171             if( keyid[2] && keyid[3] && keyid[0] != keyid[2]
172                                      && keyid[1] != keyid[3] )
173                 tty_printf( _(" (main key ID %08lX)"), (ulong)keyid[3] );
174             tty_printf("\n");
175         }
176
177         tty_printf("\n");
178         free_public_key( pk );
179     }
180
181     if( next_pw ) {
182         pw = next_pw;
183         next_pw = NULL;
184     }
185     else if( fd_passwd ) {
186         pw = gcry_xmalloc_secure( strlen(fd_passwd)+1 );
187         strcpy( pw, fd_passwd );
188     }
189     else if( opt.batch ) {
190         log_error(_("can't query password in batchmode\n"));
191         pw = gcry_xstrdup( "" ); /* return an empty passphrase */
192     }
193     else {
194         pw = cpr_get_hidden("passphrase.enter", _("Enter passphrase: ") );
195         tty_kill_prompt();
196         if( mode == 2 && !cpr_enabled() ) {
197             char *pw2 = cpr_get_hidden("passphrase.repeat",
198                                        _("Repeat passphrase: ") );
199             tty_kill_prompt();
200             if( strcmp(pw, pw2) ) {
201                 gcry_free(pw2);
202                 gcry_free(pw);
203                 return NULL;
204             }
205             gcry_free(pw2);
206         }
207     }
208
209     if( !pw || !*pw )
210         write_status( STATUS_MISSING_PASSPHRASE );
211
212     dek = gcry_xmalloc_secure( sizeof *dek );
213     dek->algo = cipher_algo;
214     if( !*pw && mode == 2 )
215         dek->keylen = 0;
216     else
217         hash_passphrase( dek, pw, s2k, mode==2 );
218     gcry_free(last_pw);
219     last_pw = pw;
220     return dek;
221 }
222
223
224 /****************
225  * Hash a passphrase using the supplied s2k. If create is true, create
226  * a new salt or what else must be filled into the s2k for a new key.
227  * always needs: dek->algo, s2k->mode, s2k->hash_algo.
228  */
229 static void
230 hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
231 {
232     GCRY_MD_HD md;
233     int pass, i;
234     int used = 0;
235     int pwlen = strlen(pw);
236
237     assert( s2k->hash_algo );
238     dek->keylen = gcry_cipher_get_algo_keylen( dek->algo );
239     if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
240         BUG();
241
242     if( !(md = gcry_md_open( s2k->hash_algo, GCRY_MD_FLAG_SECURE )) )
243         BUG();
244
245     for(pass=0; used < dek->keylen ; pass++ ) {
246         if( pass ) {
247             gcry_md_reset(md);
248             for(i=0; i < pass; i++ ) /* preset the hash context */
249                 gcry_md_putc(md, 0 );
250         }
251
252         if( s2k->mode == 1 || s2k->mode == 3 ) {
253             int len2 = pwlen + 8;
254             ulong count = len2;
255
256             if( create && !pass ) {
257                 gcry_randomize(s2k->salt, 8, GCRY_STRONG_RANDOM );
258                 if( s2k->mode == 3 )
259                     s2k->count = 96; /* 65536 iterations */
260             }
261
262             if( s2k->mode == 3 ) {
263                 count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
264                 if( count < len2 )
265                     count = len2;
266             }
267             /* a little bit complicated because we need a ulong for count */
268             while( count > len2 ) { /* maybe iterated+salted */
269                 gcry_md_write( md, s2k->salt, 8 );
270                 gcry_md_write( md, pw, pwlen );
271                 count -= len2;
272             }
273             if( count < 8 )
274                 gcry_md_write( md, s2k->salt, count );
275             else {
276                 gcry_md_write( md, s2k->salt, 8 );
277                 count -= 8;
278                 assert( count >= 0 );
279                 gcry_md_write( md, pw, count );
280             }
281         }
282         else
283             gcry_md_write( md, pw, pwlen );
284         gcry_md_final( md );
285         i = gcry_md_get_algo_dlen( s2k->hash_algo );
286         if( i > dek->keylen - used )
287             i = dek->keylen - used;
288         memcpy( dek->key+used, gcry_md_read(md, s2k->hash_algo), i );
289         used += i;
290     }
291     gcry_md_close(md);
292 }
293