Clarify formulation (proposed by Bodo Moeller).
[openssl.git] / apps / passwd.c
1 /* apps/passwd.c */
2
3 #if defined OPENSSL_NO_MD5 || defined CHARSET_EBCDIC
4 # define NO_MD5CRYPT_1
5 #endif
6
7 #if !defined(OPENSSL_NO_DES) || !defined(NO_MD5CRYPT_1)
8
9 #include <assert.h>
10 #include <string.h>
11
12 #include "apps.h"
13
14 #include <openssl/bio.h>
15 #include <openssl/err.h>
16 #include <openssl/evp.h>
17 #include <openssl/rand.h>
18 #ifndef OPENSSL_NO_DES
19 # include <openssl/des.h>
20 #endif
21 #ifndef NO_MD5CRYPT_1
22 # include <openssl/evp.h>
23 # include <openssl/md5.h>
24 #endif
25
26
27 #undef PROG
28 #define PROG passwd_main
29
30
31 static unsigned const char cov_2char[64]={
32         /* from crypto/des/fcrypt.c */
33         0x2E,0x2F,0x30,0x31,0x32,0x33,0x34,0x35,
34         0x36,0x37,0x38,0x39,0x41,0x42,0x43,0x44,
35         0x45,0x46,0x47,0x48,0x49,0x4A,0x4B,0x4C,
36         0x4D,0x4E,0x4F,0x50,0x51,0x52,0x53,0x54,
37         0x55,0x56,0x57,0x58,0x59,0x5A,0x61,0x62,
38         0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6A,
39         0x6B,0x6C,0x6D,0x6E,0x6F,0x70,0x71,0x72,
40         0x73,0x74,0x75,0x76,0x77,0x78,0x79,0x7A
41 };
42
43 static int do_passwd(int passed_salt, char **salt_p, char **salt_malloc_p,
44         char *passwd, BIO *out, int quiet, int table, int reverse,
45         size_t pw_maxlen, int usecrypt, int use1, int useapr1);
46
47 /* -crypt        - standard Unix password algorithm (default)
48  * -1            - MD5-based password algorithm
49  * -apr1         - MD5-based password algorithm, Apache variant
50  * -salt string  - salt
51  * -in file      - read passwords from file
52  * -stdin        - read passwords from stdin
53  * -noverify     - never verify when reading password from terminal
54  * -quiet        - no warnings
55  * -table        - format output as table
56  * -reverse      - switch table columns
57  */
58
59 int MAIN(int, char **);
60
61 int MAIN(int argc, char **argv)
62         {
63         int ret = 1;
64         char *infile = NULL;
65         int in_stdin = 0;
66         int in_noverify = 0;
67         char *salt = NULL, *passwd = NULL, **passwds = NULL;
68         char *salt_malloc = NULL, *passwd_malloc = NULL;
69         size_t passwd_malloc_size = 0;
70         int pw_source_defined = 0;
71         BIO *in = NULL, *out = NULL;
72         int i, badopt, opt_done;
73         int passed_salt = 0, quiet = 0, table = 0, reverse = 0;
74         int usecrypt = 0, use1 = 0, useapr1 = 0;
75         size_t pw_maxlen = 0;
76
77         apps_startup();
78
79         if (bio_err == NULL)
80                 if ((bio_err=BIO_new(BIO_s_file())) != NULL)
81                         BIO_set_fp(bio_err,stderr,BIO_NOCLOSE|BIO_FP_TEXT);
82
83         if (!load_config(bio_err, NULL))
84                 goto err;
85         out = BIO_new(BIO_s_file());
86         if (out == NULL)
87                 goto err;
88         BIO_set_fp(out, stdout, BIO_NOCLOSE | BIO_FP_TEXT);
89 #ifdef OPENSSL_SYS_VMS
90         {
91         BIO *tmpbio = BIO_new(BIO_f_linebuffer());
92         out = BIO_push(tmpbio, out);
93         }
94 #endif
95
96         badopt = 0, opt_done = 0;
97         i = 0;
98         while (!badopt && !opt_done && argv[++i] != NULL)
99                 {
100                 if (strcmp(argv[i], "-crypt") == 0)
101                         usecrypt = 1;
102                 else if (strcmp(argv[i], "-1") == 0)
103                         use1 = 1;
104                 else if (strcmp(argv[i], "-apr1") == 0)
105                         useapr1 = 1;
106                 else if (strcmp(argv[i], "-salt") == 0)
107                         {
108                         if ((argv[i+1] != NULL) && (salt == NULL))
109                                 {
110                                 passed_salt = 1;
111                                 salt = argv[++i];
112                                 }
113                         else
114                                 badopt = 1;
115                         }
116                 else if (strcmp(argv[i], "-in") == 0)
117                         {
118                         if ((argv[i+1] != NULL) && !pw_source_defined)
119                                 {
120                                 pw_source_defined = 1;
121                                 infile = argv[++i];
122                                 }
123                         else
124                                 badopt = 1;
125                         }
126                 else if (strcmp(argv[i], "-stdin") == 0)
127                         {
128                         if (!pw_source_defined)
129                                 {
130                                 pw_source_defined = 1;
131                                 in_stdin = 1;
132                                 }
133                         else
134                                 badopt = 1;
135                         }
136                 else if (strcmp(argv[i], "-noverify") == 0)
137                         in_noverify = 1;
138                 else if (strcmp(argv[i], "-quiet") == 0)
139                         quiet = 1;
140                 else if (strcmp(argv[i], "-table") == 0)
141                         table = 1;
142                 else if (strcmp(argv[i], "-reverse") == 0)
143                         reverse = 1;
144                 else if (argv[i][0] == '-')
145                         badopt = 1;
146                 else if (!pw_source_defined)
147                         /* non-option arguments, use as passwords */
148                         {
149                         pw_source_defined = 1;
150                         passwds = &argv[i];
151                         opt_done = 1;
152                         }
153                 else
154                         badopt = 1;
155                 }
156
157         if (!usecrypt && !use1 && !useapr1) /* use default */
158                 usecrypt = 1;
159         if (usecrypt + use1 + useapr1 > 1) /* conflict */
160                 badopt = 1;
161
162         /* reject unsupported algorithms */
163 #ifdef OPENSSL_NO_DES
164         if (usecrypt) badopt = 1;
165 #endif
166 #ifdef NO_MD5CRYPT_1
167         if (use1 || useapr1) badopt = 1;
168 #endif
169
170         if (badopt) 
171                 {
172                 BIO_printf(bio_err, "Usage: passwd [options] [passwords]\n");
173                 BIO_printf(bio_err, "where options are\n");
174 #ifndef OPENSSL_NO_DES
175                 BIO_printf(bio_err, "-crypt             standard Unix password algorithm (default)\n");
176 #endif
177 #ifndef NO_MD5CRYPT_1
178                 BIO_printf(bio_err, "-1                 MD5-based password algorithm\n");
179                 BIO_printf(bio_err, "-apr1              MD5-based password algorithm, Apache variant\n");
180 #endif
181                 BIO_printf(bio_err, "-salt string       use provided salt\n");
182                 BIO_printf(bio_err, "-in file           read passwords from file\n");
183                 BIO_printf(bio_err, "-stdin             read passwords from stdin\n");
184                 BIO_printf(bio_err, "-noverify          never verify when reading password from terminal\n");
185                 BIO_printf(bio_err, "-quiet             no warnings\n");
186                 BIO_printf(bio_err, "-table             format output as table\n");
187                 BIO_printf(bio_err, "-reverse           switch table columns\n");
188                 
189                 goto err;
190                 }
191
192         if ((infile != NULL) || in_stdin)
193                 {
194                 in = BIO_new(BIO_s_file());
195                 if (in == NULL)
196                         goto err;
197                 if (infile != NULL)
198                         {
199                         assert(in_stdin == 0);
200                         if (BIO_read_filename(in, infile) <= 0)
201                                 goto err;
202                         }
203                 else
204                         {
205                         assert(in_stdin);
206                         BIO_set_fp(in, stdin, BIO_NOCLOSE);
207                         }
208                 }
209         
210         if (usecrypt)
211                 pw_maxlen = 8;
212         else if (use1 || useapr1)
213                 pw_maxlen = 256; /* arbitrary limit, should be enough for most passwords */
214
215         if (passwds == NULL)
216                 {
217                 /* no passwords on the command line */
218
219                 passwd_malloc_size = pw_maxlen + 2;
220                 /* longer than necessary so that we can warn about truncation */
221                 passwd = passwd_malloc = OPENSSL_malloc(passwd_malloc_size);
222                 if (passwd_malloc == NULL)
223                         goto err;
224                 }
225
226         if ((in == NULL) && (passwds == NULL))
227                 {
228                 /* build a null-terminated list */
229                 static char *passwds_static[2] = {NULL, NULL};
230                 
231                 passwds = passwds_static;
232                 if (in == NULL)
233                         if (EVP_read_pw_string(passwd_malloc, passwd_malloc_size, "Password: ", !(passed_salt || in_noverify)) != 0)
234                                 goto err;
235                 passwds[0] = passwd_malloc;
236                 }
237
238         if (in == NULL)
239                 {
240                 assert(passwds != NULL);
241                 assert(*passwds != NULL);
242                 
243                 do /* loop over list of passwords */
244                         {
245                         passwd = *passwds++;
246                         if (!do_passwd(passed_salt, &salt, &salt_malloc, passwd, out,
247                                 quiet, table, reverse, pw_maxlen, usecrypt, use1, useapr1))
248                                 goto err;
249                         }
250                 while (*passwds != NULL);
251                 }
252         else
253                 /* in != NULL */
254                 {
255                 int done;
256
257                 assert (passwd != NULL);
258                 do
259                         {
260                         int r = BIO_gets(in, passwd, pw_maxlen + 1);
261                         if (r > 0)
262                                 {
263                                 char *c = (strchr(passwd, '\n')) ;
264                                 if (c != NULL)
265                                         *c = 0; /* truncate at newline */
266                                 else
267                                         {
268                                         /* ignore rest of line */
269                                         char trash[BUFSIZ];
270                                         do
271                                                 r = BIO_gets(in, trash, sizeof trash);
272                                         while ((r > 0) && (!strchr(trash, '\n')));
273                                         }
274                                 
275                                 if (!do_passwd(passed_salt, &salt, &salt_malloc, passwd, out,
276                                         quiet, table, reverse, pw_maxlen, usecrypt, use1, useapr1))
277                                         goto err;
278                                 }
279                         done = (r <= 0);
280                         }
281                 while (!done);
282                 }
283         ret = 0;
284
285 err:
286         ERR_print_errors(bio_err);
287         if (salt_malloc)
288                 OPENSSL_free(salt_malloc);
289         if (passwd_malloc)
290                 OPENSSL_free(passwd_malloc);
291         if (in)
292                 BIO_free(in);
293         if (out)
294                 BIO_free_all(out);
295         apps_shutdown();
296         EXIT(ret);
297         }
298
299
300 #ifndef NO_MD5CRYPT_1
301 /* MD5-based password algorithm (should probably be available as a library
302  * function; then the static buffer would not be acceptable).
303  * For magic string "1", this should be compatible to the MD5-based BSD
304  * password algorithm.
305  * For 'magic' string "apr1", this is compatible to the MD5-based Apache
306  * password algorithm.
307  * (Apparently, the Apache password algorithm is identical except that the
308  * 'magic' string was changed -- the laziest application of the NIH principle
309  * I've ever encountered.)
310  */
311 static char *md5crypt(const char *passwd, const char *magic, const char *salt)
312         {
313         static char out_buf[6 + 9 + 24 + 2]; /* "$apr1$..salt..$.......md5hash..........\0" */
314         unsigned char buf[MD5_DIGEST_LENGTH];
315         char *salt_out;
316         int n, i;
317         EVP_MD_CTX md,md2;
318         size_t passwd_len, salt_len;
319
320         passwd_len = strlen(passwd);
321         out_buf[0] = '$';
322         out_buf[1] = 0;
323         assert(strlen(magic) <= 4); /* "1" or "apr1" */
324         strncat(out_buf, magic, 4);
325         strncat(out_buf, "$", 1);
326         strncat(out_buf, salt, 8);
327         assert(strlen(out_buf) <= 6 + 8); /* "$apr1$..salt.." */
328         salt_out = out_buf + 2 + strlen(magic);
329         salt_len = strlen(salt_out);
330         assert(salt_len <= 8);
331         
332         EVP_MD_CTX_init(&md);
333         EVP_DigestInit_ex(&md,EVP_md5(), NULL);
334         EVP_DigestUpdate(&md, passwd, passwd_len);
335         EVP_DigestUpdate(&md, "$", 1);
336         EVP_DigestUpdate(&md, magic, strlen(magic));
337         EVP_DigestUpdate(&md, "$", 1);
338         EVP_DigestUpdate(&md, salt_out, salt_len);
339         
340         EVP_MD_CTX_init(&md2);
341         EVP_DigestInit_ex(&md2,EVP_md5(), NULL);
342         EVP_DigestUpdate(&md2, passwd, passwd_len);
343         EVP_DigestUpdate(&md2, salt_out, salt_len);
344         EVP_DigestUpdate(&md2, passwd, passwd_len);
345         EVP_DigestFinal_ex(&md2, buf, NULL);
346
347         for (i = passwd_len; i > sizeof buf; i -= sizeof buf)
348                 EVP_DigestUpdate(&md, buf, sizeof buf);
349         EVP_DigestUpdate(&md, buf, i);
350         
351         n = passwd_len;
352         while (n)
353                 {
354                 EVP_DigestUpdate(&md, (n & 1) ? "\0" : passwd, 1);
355                 n >>= 1;
356                 }
357         EVP_DigestFinal_ex(&md, buf, NULL);
358
359         for (i = 0; i < 1000; i++)
360                 {
361                 EVP_DigestInit_ex(&md2,EVP_md5(), NULL);
362                 EVP_DigestUpdate(&md2, (i & 1) ? (unsigned char *) passwd : buf,
363                                        (i & 1) ? passwd_len : sizeof buf);
364                 if (i % 3)
365                         EVP_DigestUpdate(&md2, salt_out, salt_len);
366                 if (i % 7)
367                         EVP_DigestUpdate(&md2, passwd, passwd_len);
368                 EVP_DigestUpdate(&md2, (i & 1) ? buf : (unsigned char *) passwd,
369                                        (i & 1) ? sizeof buf : passwd_len);
370                 EVP_DigestFinal_ex(&md2, buf, NULL);
371                 }
372         EVP_MD_CTX_cleanup(&md2);
373         
374          {
375                 /* transform buf into output string */
376         
377                 unsigned char buf_perm[sizeof buf];
378                 int dest, source;
379                 char *output;
380
381                 /* silly output permutation */
382                 for (dest = 0, source = 0; dest < 14; dest++, source = (source + 6) % 17)
383                         buf_perm[dest] = buf[source];
384                 buf_perm[14] = buf[5];
385                 buf_perm[15] = buf[11];
386 #ifndef PEDANTIC /* Unfortunately, this generates a "no effect" warning */
387                 assert(16 == sizeof buf_perm);
388 #endif
389                 
390                 output = salt_out + salt_len;
391                 assert(output == out_buf + strlen(out_buf));
392                 
393                 *output++ = '$';
394
395                 for (i = 0; i < 15; i += 3)
396                         {
397                         *output++ = cov_2char[buf_perm[i+2] & 0x3f];
398                         *output++ = cov_2char[((buf_perm[i+1] & 0xf) << 2) |
399                                                   (buf_perm[i+2] >> 6)];
400                         *output++ = cov_2char[((buf_perm[i] & 3) << 4) |
401                                                   (buf_perm[i+1] >> 4)];
402                         *output++ = cov_2char[buf_perm[i] >> 2];
403                         }
404                 assert(i == 15);
405                 *output++ = cov_2char[buf_perm[i] & 0x3f];
406                 *output++ = cov_2char[buf_perm[i] >> 6];
407                 *output = 0;
408                 assert(strlen(out_buf) < sizeof(out_buf));
409          }
410         EVP_MD_CTX_cleanup(&md);
411
412         return out_buf;
413         }
414 #endif
415
416
417 static int do_passwd(int passed_salt, char **salt_p, char **salt_malloc_p,
418         char *passwd, BIO *out, int quiet, int table, int reverse,
419         size_t pw_maxlen, int usecrypt, int use1, int useapr1)
420         {
421         char *hash = NULL;
422
423         assert(salt_p != NULL);
424         assert(salt_malloc_p != NULL);
425
426         /* first make sure we have a salt */
427         if (!passed_salt)
428                 {
429 #ifndef OPENSSL_NO_DES
430                 if (usecrypt)
431                         {
432                         if (*salt_malloc_p == NULL)
433                                 {
434                                 *salt_p = *salt_malloc_p = OPENSSL_malloc(3);
435                                 if (*salt_malloc_p == NULL)
436                                         goto err;
437                                 }
438                         if (RAND_pseudo_bytes((unsigned char *)*salt_p, 2) < 0)
439                                 goto err;
440                         (*salt_p)[0] = cov_2char[(*salt_p)[0] & 0x3f]; /* 6 bits */
441                         (*salt_p)[1] = cov_2char[(*salt_p)[1] & 0x3f]; /* 6 bits */
442                         (*salt_p)[2] = 0;
443 #ifdef CHARSET_EBCDIC
444                         ascii2ebcdic(*salt_p, *salt_p, 2); /* des_crypt will convert
445                                                             * back to ASCII */
446 #endif
447                         }
448 #endif /* !OPENSSL_NO_DES */
449
450 #ifndef NO_MD5CRYPT_1
451                 if (use1 || useapr1)
452                         {
453                         int i;
454                         
455                         if (*salt_malloc_p == NULL)
456                                 {
457                                 *salt_p = *salt_malloc_p = OPENSSL_malloc(9);
458                                 if (*salt_malloc_p == NULL)
459                                         goto err;
460                                 }
461                         if (RAND_pseudo_bytes((unsigned char *)*salt_p, 8) < 0)
462                                 goto err;
463                         
464                         for (i = 0; i < 8; i++)
465                                 (*salt_p)[i] = cov_2char[(*salt_p)[i] & 0x3f]; /* 6 bits */
466                         (*salt_p)[8] = 0;
467                         }
468 #endif /* !NO_MD5CRYPT_1 */
469                 }
470         
471         assert(*salt_p != NULL);
472         
473         /* truncate password if necessary */
474         if ((strlen(passwd) > pw_maxlen))
475                 {
476                 if (!quiet)
477                         BIO_printf(bio_err, "Warning: truncating password to %u characters\n", pw_maxlen);
478                 passwd[pw_maxlen] = 0;
479                 }
480         assert(strlen(passwd) <= pw_maxlen);
481         
482         /* now compute password hash */
483 #ifndef OPENSSL_NO_DES
484         if (usecrypt)
485                 hash = DES_crypt(passwd, *salt_p);
486 #endif
487 #ifndef NO_MD5CRYPT_1
488         if (use1 || useapr1)
489                 hash = md5crypt(passwd, (use1 ? "1" : "apr1"), *salt_p);
490 #endif
491         assert(hash != NULL);
492
493         if (table && !reverse)
494                 BIO_printf(out, "%s\t%s\n", passwd, hash);
495         else if (table && reverse)
496                 BIO_printf(out, "%s\t%s\n", hash, passwd);
497         else
498                 BIO_printf(out, "%s\n", hash);
499         return 1;
500         
501 err:
502         return 0;
503         }
504 #else
505
506 int MAIN(int argc, char **argv)
507         {
508         fputs("Program not available.\n", stderr)
509         EXIT(1);
510         }
511 #endif