GH408 follow-on: update buflen
[openssl.git] / apps / passwd.c
1 /* ====================================================================
2  * Copyright (c) 2000-2015 The OpenSSL Project.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in
13  *    the documentation and/or other materials provided with the
14  *    distribution.
15  *
16  * 3. All advertising materials mentioning features or use of this
17  *    software must display the following acknowledgment:
18  *    "This product includes software developed by the OpenSSL Project
19  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
20  *
21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22  *    endorse or promote products derived from this software without
23  *    prior written permission. For written permission, please contact
24  *    licensing@OpenSSL.org.
25  *
26  * 5. Products derived from this software may not be called "OpenSSL"
27  *    nor may "OpenSSL" appear in their names without prior written
28  *    permission of the OpenSSL Project.
29  *
30  * 6. Redistributions of any form whatsoever must retain the following
31  *    acknowledgment:
32  *    "This product includes software developed by the OpenSSL Project
33  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
34  *
35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46  * OF THE POSSIBILITY OF SUCH DAMAGE.
47  * ====================================================================
48  */
49
50 #if defined OPENSSL_NO_MD5 || defined CHARSET_EBCDIC
51 # define NO_MD5CRYPT_1
52 #endif
53
54 #if !defined(OPENSSL_NO_DES) || !defined(NO_MD5CRYPT_1)
55
56 # include <string.h>
57
58 # include "apps.h"
59
60 # include <openssl/bio.h>
61 # include <openssl/err.h>
62 # include <openssl/evp.h>
63 # include <openssl/rand.h>
64 # ifndef OPENSSL_NO_DES
65 #  include <openssl/des.h>
66 # endif
67 # ifndef NO_MD5CRYPT_1
68 #  include <openssl/md5.h>
69 # endif
70
71 static unsigned const char cov_2char[64] = {
72     /* from crypto/des/fcrypt.c */
73     0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35,
74     0x36, 0x37, 0x38, 0x39, 0x41, 0x42, 0x43, 0x44,
75     0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C,
76     0x4D, 0x4E, 0x4F, 0x50, 0x51, 0x52, 0x53, 0x54,
77     0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x61, 0x62,
78     0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6A,
79     0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70, 0x71, 0x72,
80     0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7A
81 };
82
83 static int do_passwd(int passed_salt, char **salt_p, char **salt_malloc_p,
84                      char *passwd, BIO *out, int quiet, int table,
85                      int reverse, size_t pw_maxlen, int usecrypt, int use1,
86                      int useapr1);
87
88 typedef enum OPTION_choice {
89     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
90     OPT_IN,
91     OPT_NOVERIFY, OPT_QUIET, OPT_TABLE, OPT_REVERSE, OPT_APR1,
92     OPT_1, OPT_CRYPT, OPT_SALT, OPT_STDIN
93 } OPTION_CHOICE;
94
95 OPTIONS passwd_options[] = {
96     {"help", OPT_HELP, '-', "Display this summary"},
97     {"in", OPT_IN, '<', "Pead passwords from file"},
98     {"noverify", OPT_NOVERIFY, '-',
99      "Never verify when reading password from terminal"},
100     {"quiet", OPT_QUIET, '-', "No warnings"},
101     {"table", OPT_TABLE, '-', "Format output as table"},
102     {"reverse", OPT_REVERSE, '-', "Switch table columns"},
103     {"salt", OPT_SALT, 's', "Use provided salt"},
104     {"stdin", OPT_STDIN, '-', "Read passwords from stdin"},
105 # ifndef NO_MD5CRYPT_1
106     {"apr1", OPT_APR1, '-', "MD5-based password algorithm, Apache variant"},
107     {"1", OPT_1, '-', "MD5-based password algorithm"},
108 # endif
109 # ifndef OPENSSL_NO_DES
110     {"crypt", OPT_CRYPT, '-', "Standard Unix password algorithm (default)"},
111 # endif
112     {NULL}
113 };
114
115 int passwd_main(int argc, char **argv)
116 {
117     BIO *in = NULL;
118     char *infile = NULL, *salt = NULL, *passwd = NULL, **passwds = NULL;
119     char *salt_malloc = NULL, *passwd_malloc = NULL, *prog;
120     OPTION_CHOICE o;
121     int in_stdin = 0, in_noverify = 0, pw_source_defined = 0;
122     int passed_salt = 0, quiet = 0, table = 0, reverse = 0;
123     int ret = 1, usecrypt = 0, use1 = 0, useapr1 = 0;
124     size_t passwd_malloc_size = 0, pw_maxlen = 256;
125
126     prog = opt_init(argc, argv, passwd_options);
127     while ((o = opt_next()) != OPT_EOF) {
128         switch (o) {
129         case OPT_EOF:
130         case OPT_ERR:
131  opthelp:
132             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
133             goto end;
134         case OPT_HELP:
135             opt_help(passwd_options);
136             ret = 0;
137             goto end;
138         case OPT_IN:
139             if (pw_source_defined)
140                 goto opthelp;
141             infile = opt_arg();
142             pw_source_defined = 1;
143             break;
144         case OPT_NOVERIFY:
145             in_noverify = 1;
146             break;
147         case OPT_QUIET:
148             quiet = 1;
149             break;
150         case OPT_TABLE:
151             table = 1;
152             break;
153         case OPT_REVERSE:
154             reverse = 1;
155             break;
156         case OPT_1:
157             use1 = 1;
158             break;
159         case OPT_APR1:
160             useapr1 = 1;
161             break;
162         case OPT_CRYPT:
163             usecrypt = 1;
164             break;
165         case OPT_SALT:
166             passed_salt = 1;
167             salt = opt_arg();
168             break;
169         case OPT_STDIN:
170             if (pw_source_defined)
171                 goto opthelp;
172             in_stdin = 1;
173             break;
174         }
175     }
176     argc = opt_num_rest();
177     argv = opt_rest();
178
179     if (*argv) {
180         if (pw_source_defined)
181             goto opthelp;
182         pw_source_defined = 1;
183         passwds = argv;
184     }
185
186     if (!usecrypt && !use1 && !useapr1) {
187         /* use default */
188         usecrypt = 1;
189     }
190     if (usecrypt + use1 + useapr1 > 1) {
191         /* conflict */
192         goto opthelp;
193     }
194
195 # ifdef OPENSSL_NO_DES
196     if (usecrypt)
197         goto opthelp;
198 # endif
199 # ifdef NO_MD5CRYPT_1
200     if (use1 || useapr1)
201         goto opthelp;
202 # endif
203
204     if (!app_load_modules(NULL))
205         goto end;
206
207     if (infile && in_stdin) {
208         BIO_printf(bio_err, "%s: Can't combine -in and -stdin\n", prog);
209         goto end;
210     }
211
212     in = bio_open_default(infile, 'r', FORMAT_TEXT);
213     if (in == NULL)
214         goto end;
215
216     if (usecrypt)
217         pw_maxlen = 8;
218     else if (use1 || useapr1)
219         pw_maxlen = 256;        /* arbitrary limit, should be enough for most
220                                  * passwords */
221
222     if (passwds == NULL) {
223         /* no passwords on the command line */
224
225         passwd_malloc_size = pw_maxlen + 2;
226         /* longer than necessary so that we can warn about truncation */
227         passwd = passwd_malloc =
228             app_malloc(passwd_malloc_size, "password buffer");
229     }
230
231     if ((in == NULL) && (passwds == NULL)) {
232         /* build a null-terminated list */
233         static char *passwds_static[2] = { NULL, NULL };
234
235         passwds = passwds_static;
236         if (in == NULL)
237             if (EVP_read_pw_string
238                 (passwd_malloc, passwd_malloc_size, "Password: ",
239                  !(passed_salt || in_noverify)) != 0)
240                 goto end;
241         passwds[0] = passwd_malloc;
242     }
243
244     if (in == NULL) {
245         assert(passwds != NULL);
246         assert(*passwds != NULL);
247
248         do {                    /* loop over list of passwords */
249             passwd = *passwds++;
250             if (!do_passwd(passed_salt, &salt, &salt_malloc, passwd, bio_out,
251                            quiet, table, reverse, pw_maxlen, usecrypt, use1,
252                            useapr1))
253                 goto end;
254         }
255         while (*passwds != NULL);
256     } else
257         /* in != NULL */
258     {
259         int done;
260
261         assert(passwd != NULL);
262         do {
263             int r = BIO_gets(in, passwd, pw_maxlen + 1);
264             if (r > 0) {
265                 char *c = (strchr(passwd, '\n'));
266                 if (c != NULL)
267                     *c = 0;     /* truncate at newline */
268                 else {
269                     /* ignore rest of line */
270                     char trash[BUFSIZ];
271                     do
272                         r = BIO_gets(in, trash, sizeof trash);
273                     while ((r > 0) && (!strchr(trash, '\n')));
274                 }
275
276                 if (!do_passwd
277                     (passed_salt, &salt, &salt_malloc, passwd, bio_out, quiet,
278                      table, reverse, pw_maxlen, usecrypt, use1, useapr1))
279                     goto end;
280             }
281             done = (r <= 0);
282         }
283         while (!done);
284     }
285     ret = 0;
286
287  end:
288     ERR_print_errors(bio_err);
289     OPENSSL_free(salt_malloc);
290     OPENSSL_free(passwd_malloc);
291     BIO_free(in);
292     return (ret);
293 }
294
295 # ifndef NO_MD5CRYPT_1
296 /*
297  * MD5-based password algorithm (should probably be available as a library
298  * function; then the static buffer would not be acceptable). For magic
299  * string "1", this should be compatible to the MD5-based BSD password
300  * algorithm. For 'magic' string "apr1", this is compatible to the MD5-based
301  * Apache password algorithm. (Apparently, the Apache password algorithm is
302  * identical except that the 'magic' string was changed -- the laziest
303  * application of the NIH principle I've ever encountered.)
304  */
305 static char *md5crypt(const char *passwd, const char *magic, const char *salt)
306 {
307     /* "$apr1$..salt..$.......md5hash..........\0" */
308     static char out_buf[6 + 9 + 24 + 2];
309     unsigned char buf[MD5_DIGEST_LENGTH];
310     char *salt_out;
311     int n;
312     unsigned int i;
313     EVP_MD_CTX md, md2;
314     size_t passwd_len, salt_len;
315
316     passwd_len = strlen(passwd);
317     out_buf[0] = '$';
318     out_buf[1] = 0;
319     assert(strlen(magic) <= 4); /* "1" or "apr1" */
320     strncat(out_buf, magic, 4);
321     strncat(out_buf, "$", 1);
322     strncat(out_buf, salt, 8);
323     assert(strlen(out_buf) <= 6 + 8); /* "$apr1$..salt.." */
324     salt_out = out_buf + 2 + strlen(magic);
325     salt_len = strlen(salt_out);
326     assert(salt_len <= 8);
327
328     EVP_MD_CTX_init(&md);
329     EVP_DigestInit_ex(&md, EVP_md5(), NULL);
330     EVP_DigestUpdate(&md, passwd, passwd_len);
331     EVP_DigestUpdate(&md, "$", 1);
332     EVP_DigestUpdate(&md, magic, strlen(magic));
333     EVP_DigestUpdate(&md, "$", 1);
334     EVP_DigestUpdate(&md, salt_out, salt_len);
335
336     EVP_MD_CTX_init(&md2);
337     EVP_DigestInit_ex(&md2, EVP_md5(), NULL);
338     EVP_DigestUpdate(&md2, passwd, passwd_len);
339     EVP_DigestUpdate(&md2, salt_out, salt_len);
340     EVP_DigestUpdate(&md2, passwd, passwd_len);
341     EVP_DigestFinal_ex(&md2, buf, NULL);
342
343     for (i = passwd_len; i > sizeof buf; i -= sizeof buf)
344         EVP_DigestUpdate(&md, buf, sizeof buf);
345     EVP_DigestUpdate(&md, buf, i);
346
347     n = passwd_len;
348     while (n) {
349         EVP_DigestUpdate(&md, (n & 1) ? "\0" : passwd, 1);
350         n >>= 1;
351     }
352     EVP_DigestFinal_ex(&md, buf, NULL);
353
354     for (i = 0; i < 1000; i++) {
355         EVP_DigestInit_ex(&md2, EVP_md5(), NULL);
356         EVP_DigestUpdate(&md2, (i & 1) ? (unsigned const char *)passwd : buf,
357                          (i & 1) ? passwd_len : sizeof buf);
358         if (i % 3)
359             EVP_DigestUpdate(&md2, salt_out, salt_len);
360         if (i % 7)
361             EVP_DigestUpdate(&md2, passwd, passwd_len);
362         EVP_DigestUpdate(&md2, (i & 1) ? buf : (unsigned const char *)passwd,
363                          (i & 1) ? sizeof buf : passwd_len);
364         EVP_DigestFinal_ex(&md2, buf, NULL);
365     }
366     EVP_MD_CTX_cleanup(&md2);
367
368     {
369         /* transform buf into output string */
370
371         unsigned char buf_perm[sizeof buf];
372         int dest, source;
373         char *output;
374
375         /* silly output permutation */
376         for (dest = 0, source = 0; dest < 14;
377              dest++, source = (source + 6) % 17)
378             buf_perm[dest] = buf[source];
379         buf_perm[14] = buf[5];
380         buf_perm[15] = buf[11];
381 #  ifndef PEDANTIC              /* Unfortunately, this generates a "no
382                                  * effect" warning */
383         assert(16 == sizeof buf_perm);
384 #  endif
385
386         output = salt_out + salt_len;
387         assert(output == out_buf + strlen(out_buf));
388
389         *output++ = '$';
390
391         for (i = 0; i < 15; i += 3) {
392             *output++ = cov_2char[buf_perm[i + 2] & 0x3f];
393             *output++ = cov_2char[((buf_perm[i + 1] & 0xf) << 2) |
394                                   (buf_perm[i + 2] >> 6)];
395             *output++ = cov_2char[((buf_perm[i] & 3) << 4) |
396                                   (buf_perm[i + 1] >> 4)];
397             *output++ = cov_2char[buf_perm[i] >> 2];
398         }
399         assert(i == 15);
400         *output++ = cov_2char[buf_perm[i] & 0x3f];
401         *output++ = cov_2char[buf_perm[i] >> 6];
402         *output = 0;
403         assert(strlen(out_buf) < sizeof(out_buf));
404     }
405     EVP_MD_CTX_cleanup(&md);
406
407     return out_buf;
408 }
409 # endif
410
411 static int do_passwd(int passed_salt, char **salt_p, char **salt_malloc_p,
412                      char *passwd, BIO *out, int quiet, int table,
413                      int reverse, size_t pw_maxlen, int usecrypt, int use1,
414                      int useapr1)
415 {
416     char *hash = NULL;
417
418     assert(salt_p != NULL);
419     assert(salt_malloc_p != NULL);
420
421     /* first make sure we have a salt */
422     if (!passed_salt) {
423 # ifndef OPENSSL_NO_DES
424         if (usecrypt) {
425             if (*salt_malloc_p == NULL) {
426                 *salt_p = *salt_malloc_p = app_malloc(3, "salt buffer");
427             }
428             if (RAND_bytes((unsigned char *)*salt_p, 2) <= 0)
429                 goto end;
430             (*salt_p)[0] = cov_2char[(*salt_p)[0] & 0x3f]; /* 6 bits */
431             (*salt_p)[1] = cov_2char[(*salt_p)[1] & 0x3f]; /* 6 bits */
432             (*salt_p)[2] = 0;
433 #  ifdef CHARSET_EBCDIC
434             ascii2ebcdic(*salt_p, *salt_p, 2); /* des_crypt will convert back
435                                                 * to ASCII */
436 #  endif
437         }
438 # endif                         /* !OPENSSL_NO_DES */
439
440 # ifndef NO_MD5CRYPT_1
441         if (use1 || useapr1) {
442             int i;
443
444             if (*salt_malloc_p == NULL) {
445                 *salt_p = *salt_malloc_p = app_malloc(9, "salt buffer");
446             }
447             if (RAND_bytes((unsigned char *)*salt_p, 8) <= 0)
448                 goto end;
449
450             for (i = 0; i < 8; i++)
451                 (*salt_p)[i] = cov_2char[(*salt_p)[i] & 0x3f]; /* 6 bits */
452             (*salt_p)[8] = 0;
453         }
454 # endif                         /* !NO_MD5CRYPT_1 */
455     }
456
457     assert(*salt_p != NULL);
458
459     /* truncate password if necessary */
460     if ((strlen(passwd) > pw_maxlen)) {
461         if (!quiet)
462             /*
463              * XXX: really we should know how to print a size_t, not cast it
464              */
465             BIO_printf(bio_err,
466                        "Warning: truncating password to %u characters\n",
467                        (unsigned)pw_maxlen);
468         passwd[pw_maxlen] = 0;
469     }
470     assert(strlen(passwd) <= pw_maxlen);
471
472     /* now compute password hash */
473 # ifndef OPENSSL_NO_DES
474     if (usecrypt)
475         hash = DES_crypt(passwd, *salt_p);
476 # endif
477 # ifndef NO_MD5CRYPT_1
478     if (use1 || useapr1)
479         hash = md5crypt(passwd, (use1 ? "1" : "apr1"), *salt_p);
480 # endif
481     assert(hash != NULL);
482
483     if (table && !reverse)
484         BIO_printf(out, "%s\t%s\n", passwd, hash);
485     else if (table && reverse)
486         BIO_printf(out, "%s\t%s\n", hash, passwd);
487     else
488         BIO_printf(out, "%s\n", hash);
489     return 0;
490
491  end:
492     return 1;
493 }
494 #else
495
496 int passwd_main(int argc, char **argv)
497 {
498     BIO_printf(bio_err, "Program not available.\n");
499     return (1);
500 }
501 #endif