ready to release 0.4.3
[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 "memory.h"
29 #include "options.h"
30 #include "ttyio.h"
31 #include "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     m_free(next_pw);
57     next_pw = NULL;
58     if( s ) {
59         next_pw = m_alloc_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 = m_alloc_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     m_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  */
118 DEK *
119 passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode )
120 {
121     char *pw = NULL;
122     DEK *dek;
123     STRING2KEY help_s2k;
124
125     if( !s2k ) {
126         s2k = &help_s2k;
127         s2k->mode = 0;
128         /* this should be MD5 if cipher is IDEA, but because we do
129          * not have IDEA, we use the default one, the user
130          * can select it from the commandline
131          */
132         s2k->hash_algo = opt.def_digest_algo?opt.def_digest_algo
133                                             :DEFAULT_DIGEST_ALGO;
134     }
135
136     if( keyid && !opt.batch && !next_pw ) {
137         PKT_public_key *pk = m_alloc_clear( sizeof *pk );
138         size_t n;
139         char *p;
140
141         tty_printf(_("\nYou need a passphrase to unlock the secret key for\n"
142                      "user: \"") );
143         p = get_user_id( keyid, &n );
144         tty_print_string( p, n );
145         m_free(p);
146         tty_printf("\"\n");
147
148         if( !get_pubkey( pk, keyid ) ) {
149             const char *s = pubkey_algo_to_string( pk->pubkey_algo );
150             tty_printf( _("(%u-bit %s key, ID %08lX, created %s)\n"),
151                        nbits_from_pk( pk ), s?s:"?", (ulong)keyid[1],
152                        strtimestamp(pk->timestamp) );
153         }
154         tty_printf("\n");
155         free_public_key( pk );
156     }
157     else if( keyid && !next_pw ) {
158         char buf[20];
159         sprintf( buf, "%08lX%08lX", (ulong)keyid[0], (ulong)keyid[1] );
160         write_status_text( STATUS_NEED_PASSPHRASE, buf );
161     }
162
163     if( next_pw ) {
164         pw = next_pw;
165         next_pw = NULL;
166     }
167     else if( fd_passwd ) {
168         pw = m_alloc_secure( strlen(fd_passwd)+1 );
169         strcpy( pw, fd_passwd );
170     }
171     else if( opt.batch )
172         log_fatal("Can't query password in batchmode\n");
173     else {
174         pw = cpr_get_hidden(N_("passphrase.enter"), _("Enter pass phrase: ") );
175         tty_kill_prompt();
176         if( mode == 2 && !cpr_enabled() ) {
177             char *pw2 = cpr_get_hidden(N_("passphrase.repeat"),
178                                        _("Repeat pass phrase: ") );
179             tty_kill_prompt();
180             if( strcmp(pw, pw2) ) {
181                 m_free(pw2);
182                 m_free(pw);
183                 return NULL;
184             }
185             m_free(pw2);
186         }
187     }
188     dek = m_alloc_secure( sizeof *dek );
189     dek->algo = cipher_algo;
190     if( !*pw && mode == 2 )
191         dek->keylen = 0;
192     else
193         hash_passphrase( dek, pw, s2k, mode==2 );
194     m_free(last_pw);
195     last_pw = pw;
196     return dek;
197 }
198
199
200 /****************
201  * Hash a passphrase using the supplied s2k. If create is true, create
202  * a new salt or what else must be filled into the s2k for a new key.
203  * always needs: dek->algo, s2k->mode, s2k->hash_algo.
204  */
205 static void
206 hash_passphrase( DEK *dek, char *pw, STRING2KEY *s2k, int create )
207 {
208     MD_HANDLE md;
209     int pass, i;
210     int used = 0;
211     int pwlen = strlen(pw);
212
213     assert( s2k->hash_algo );
214     dek->keylen = cipher_get_keylen( dek->algo ) / 8;
215     if( !(dek->keylen > 0 && dek->keylen <= DIM(dek->key)) )
216         BUG();
217
218     md = md_open( s2k->hash_algo, 1);
219     for(pass=0; used < dek->keylen ; pass++ ) {
220         if( pass ) {
221             md_reset(md);
222             for(i=0; i < pass; i++ ) /* preset the hash context */
223                 md_putc(md, 0 );
224         }
225
226         if( s2k->mode == 1 || s2k->mode == 3 ) {
227             int len2 = pwlen + 8;
228             ulong count = len2;
229
230             if( create && !pass ) {
231                 randomize_buffer(s2k->salt, 8, 1);
232                 if( s2k->mode == 3 )
233                     s2k->count = 96; /* = 56536 */
234             }
235
236             if( s2k->mode == 3 ) {
237                 count = (16ul + (s2k->count & 15)) << ((s2k->count >> 4) + 6);
238                 if( count < len2 )
239                     count = len2;
240             }
241             /* a little bit complicated because we need a ulong for count */
242             while( count > len2 ) { /* maybe iterated+salted */
243                 md_write( md, s2k->salt, 8 );
244                 md_write( md, pw, pwlen );
245                 count -= len2;
246             }
247             if( count < 8 )
248                 md_write( md, s2k->salt, count );
249             else {
250                 md_write( md, s2k->salt, 8 );
251                 count -= 8;
252                 assert( count >= 0 );
253                 md_write( md, pw, count );
254             }
255         }
256         else
257             md_write( md, pw, pwlen );
258         md_final( md );
259         i = md_digest_length( s2k->hash_algo );
260         if( i > dek->keylen - used )
261             i = dek->keylen - used;
262         memcpy( dek->key+used, md_read(md, s2k->hash_algo), i );
263         used += i;
264     }
265     md_close(md);
266 }
267