Make DSA_METHOD opaque
[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, pw_source_defined = 0;
122 #ifndef OPENSSL_NO_UI
123     int in_noverify = 0;
124 #endif
125     int passed_salt = 0, quiet = 0, table = 0, reverse = 0;
126     int ret = 1, usecrypt = 0, use1 = 0, useapr1 = 0;
127     size_t passwd_malloc_size = 0, pw_maxlen = 256;
128
129     prog = opt_init(argc, argv, passwd_options);
130     while ((o = opt_next()) != OPT_EOF) {
131         switch (o) {
132         case OPT_EOF:
133         case OPT_ERR:
134  opthelp:
135             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
136             goto end;
137         case OPT_HELP:
138             opt_help(passwd_options);
139             ret = 0;
140             goto end;
141         case OPT_IN:
142             if (pw_source_defined)
143                 goto opthelp;
144             infile = opt_arg();
145             pw_source_defined = 1;
146             break;
147         case OPT_NOVERIFY:
148 #ifndef OPENSSL_NO_UI
149             in_noverify = 1;
150 #endif
151             break;
152         case OPT_QUIET:
153             quiet = 1;
154             break;
155         case OPT_TABLE:
156             table = 1;
157             break;
158         case OPT_REVERSE:
159             reverse = 1;
160             break;
161         case OPT_1:
162             use1 = 1;
163             break;
164         case OPT_APR1:
165             useapr1 = 1;
166             break;
167         case OPT_CRYPT:
168             usecrypt = 1;
169             break;
170         case OPT_SALT:
171             passed_salt = 1;
172             salt = opt_arg();
173             break;
174         case OPT_STDIN:
175             if (pw_source_defined)
176                 goto opthelp;
177             in_stdin = 1;
178             break;
179         }
180     }
181     argc = opt_num_rest();
182     argv = opt_rest();
183
184     if (*argv) {
185         if (pw_source_defined)
186             goto opthelp;
187         pw_source_defined = 1;
188         passwds = argv;
189     }
190
191     if (!usecrypt && !use1 && !useapr1) {
192         /* use default */
193         usecrypt = 1;
194     }
195     if (usecrypt + use1 + useapr1 > 1) {
196         /* conflict */
197         goto opthelp;
198     }
199
200 # ifdef OPENSSL_NO_DES
201     if (usecrypt)
202         goto opthelp;
203 # endif
204 # ifdef NO_MD5CRYPT_1
205     if (use1 || useapr1)
206         goto opthelp;
207 # endif
208
209     if (infile != NULL && in_stdin) {
210         BIO_printf(bio_err, "%s: Can't combine -in and -stdin\n", prog);
211         goto end;
212     }
213
214     if (infile != NULL || in_stdin) {
215         /*
216          * If in_stdin is true, we know that infile is NULL, and that
217          * bio_open_default() will give us back an alias for stdin.
218          */
219         in = bio_open_default(infile, 'r', FORMAT_TEXT);
220         if (in == NULL)
221             goto end;
222     }
223
224     if (usecrypt)
225         pw_maxlen = 8;
226     else if (use1 || useapr1)
227         pw_maxlen = 256;        /* arbitrary limit, should be enough for most
228                                  * passwords */
229
230     if (passwds == NULL) {
231         /* no passwords on the command line */
232
233         passwd_malloc_size = pw_maxlen + 2;
234         /* longer than necessary so that we can warn about truncation */
235         passwd = passwd_malloc =
236             app_malloc(passwd_malloc_size, "password buffer");
237     }
238
239     if ((in == NULL) && (passwds == NULL)) {
240         if (1) {
241 #ifndef OPENSSL_NO_UI
242             /* build a null-terminated list */
243             static char *passwds_static[2] = { NULL, NULL };
244
245             passwds = passwds_static;
246             if (in == NULL)
247                 if (EVP_read_pw_string
248                     (passwd_malloc, passwd_malloc_size, "Password: ",
249                      !(passed_salt || in_noverify)) != 0)
250                     goto end;
251             passwds[0] = passwd_malloc;
252         } else {
253 #endif
254             BIO_printf(bio_err, "password required\n");
255             goto end;
256         }
257     }
258
259
260     if (in == NULL) {
261         assert(passwds != NULL);
262         assert(*passwds != NULL);
263
264         do {                    /* loop over list of passwords */
265             passwd = *passwds++;
266             if (!do_passwd(passed_salt, &salt, &salt_malloc, passwd, bio_out,
267                            quiet, table, reverse, pw_maxlen, usecrypt, use1,
268                            useapr1))
269                 goto end;
270         }
271         while (*passwds != NULL);
272     } else
273         /* in != NULL */
274     {
275         int done;
276
277         assert(passwd != NULL);
278         do {
279             int r = BIO_gets(in, passwd, pw_maxlen + 1);
280             if (r > 0) {
281                 char *c = (strchr(passwd, '\n'));
282                 if (c != NULL)
283                     *c = 0;     /* truncate at newline */
284                 else {
285                     /* ignore rest of line */
286                     char trash[BUFSIZ];
287                     do
288                         r = BIO_gets(in, trash, sizeof trash);
289                     while ((r > 0) && (!strchr(trash, '\n')));
290                 }
291
292                 if (!do_passwd
293                     (passed_salt, &salt, &salt_malloc, passwd, bio_out, quiet,
294                      table, reverse, pw_maxlen, usecrypt, use1, useapr1))
295                     goto end;
296             }
297             done = (r <= 0);
298         }
299         while (!done);
300     }
301     ret = 0;
302
303  end:
304     ERR_print_errors(bio_err);
305     OPENSSL_free(salt_malloc);
306     OPENSSL_free(passwd_malloc);
307     BIO_free(in);
308     return (ret);
309 }
310
311 # ifndef NO_MD5CRYPT_1
312 /*
313  * MD5-based password algorithm (should probably be available as a library
314  * function; then the static buffer would not be acceptable). For magic
315  * string "1", this should be compatible to the MD5-based BSD password
316  * algorithm. For 'magic' string "apr1", this is compatible to the MD5-based
317  * Apache password algorithm. (Apparently, the Apache password algorithm is
318  * identical except that the 'magic' string was changed -- the laziest
319  * application of the NIH principle I've ever encountered.)
320  */
321 static char *md5crypt(const char *passwd, const char *magic, const char *salt)
322 {
323     /* "$apr1$..salt..$.......md5hash..........\0" */
324     static char out_buf[6 + 9 + 24 + 2];
325     unsigned char buf[MD5_DIGEST_LENGTH];
326     char *salt_out;
327     int n;
328     unsigned int i;
329     EVP_MD_CTX *md, *md2;
330     size_t passwd_len, salt_len;
331
332     passwd_len = strlen(passwd);
333     out_buf[0] = '$';
334     out_buf[1] = 0;
335     assert(strlen(magic) <= 4); /* "1" or "apr1" */
336     OPENSSL_strlcat(out_buf, magic, sizeof out_buf);
337     OPENSSL_strlcat(out_buf, "$", sizeof out_buf);
338     OPENSSL_strlcat(out_buf, salt, sizeof out_buf);
339     assert(strlen(out_buf) <= 6 + 8); /* "$apr1$..salt.." */
340     salt_out = out_buf + 2 + strlen(magic);
341     salt_len = strlen(salt_out);
342     assert(salt_len <= 8);
343
344     md = EVP_MD_CTX_new();
345     if (md == NULL)
346         return NULL;
347     EVP_DigestInit_ex(md, EVP_md5(), NULL);
348     EVP_DigestUpdate(md, passwd, passwd_len);
349     EVP_DigestUpdate(md, "$", 1);
350     EVP_DigestUpdate(md, magic, strlen(magic));
351     EVP_DigestUpdate(md, "$", 1);
352     EVP_DigestUpdate(md, salt_out, salt_len);
353
354     md2 = EVP_MD_CTX_new();
355     if (md2 == NULL)
356         return NULL;
357     EVP_DigestInit_ex(md2, EVP_md5(), NULL);
358     EVP_DigestUpdate(md2, passwd, passwd_len);
359     EVP_DigestUpdate(md2, salt_out, salt_len);
360     EVP_DigestUpdate(md2, passwd, passwd_len);
361     EVP_DigestFinal_ex(md2, buf, NULL);
362
363     for (i = passwd_len; i > sizeof buf; i -= sizeof buf)
364         EVP_DigestUpdate(md, buf, sizeof buf);
365     EVP_DigestUpdate(md, buf, i);
366
367     n = passwd_len;
368     while (n) {
369         EVP_DigestUpdate(md, (n & 1) ? "\0" : passwd, 1);
370         n >>= 1;
371     }
372     EVP_DigestFinal_ex(md, buf, NULL);
373
374     for (i = 0; i < 1000; i++) {
375         EVP_DigestInit_ex(md2, EVP_md5(), NULL);
376         EVP_DigestUpdate(md2, (i & 1) ? (unsigned const char *)passwd : buf,
377                          (i & 1) ? passwd_len : sizeof buf);
378         if (i % 3)
379             EVP_DigestUpdate(md2, salt_out, salt_len);
380         if (i % 7)
381             EVP_DigestUpdate(md2, passwd, passwd_len);
382         EVP_DigestUpdate(md2, (i & 1) ? buf : (unsigned const char *)passwd,
383                          (i & 1) ? sizeof buf : passwd_len);
384         EVP_DigestFinal_ex(md2, buf, NULL);
385     }
386     EVP_MD_CTX_free(md2);
387     EVP_MD_CTX_free(md);
388
389     {
390         /* transform buf into output string */
391
392         unsigned char buf_perm[sizeof buf];
393         int dest, source;
394         char *output;
395
396         /* silly output permutation */
397         for (dest = 0, source = 0; dest < 14;
398              dest++, source = (source + 6) % 17)
399             buf_perm[dest] = buf[source];
400         buf_perm[14] = buf[5];
401         buf_perm[15] = buf[11];
402 #  ifndef PEDANTIC              /* Unfortunately, this generates a "no
403                                  * effect" warning */
404         assert(16 == sizeof buf_perm);
405 #  endif
406
407         output = salt_out + salt_len;
408         assert(output == out_buf + strlen(out_buf));
409
410         *output++ = '$';
411
412         for (i = 0; i < 15; i += 3) {
413             *output++ = cov_2char[buf_perm[i + 2] & 0x3f];
414             *output++ = cov_2char[((buf_perm[i + 1] & 0xf) << 2) |
415                                   (buf_perm[i + 2] >> 6)];
416             *output++ = cov_2char[((buf_perm[i] & 3) << 4) |
417                                   (buf_perm[i + 1] >> 4)];
418             *output++ = cov_2char[buf_perm[i] >> 2];
419         }
420         assert(i == 15);
421         *output++ = cov_2char[buf_perm[i] & 0x3f];
422         *output++ = cov_2char[buf_perm[i] >> 6];
423         *output = 0;
424         assert(strlen(out_buf) < sizeof(out_buf));
425     }
426
427     return out_buf;
428 }
429 # endif
430
431 static int do_passwd(int passed_salt, char **salt_p, char **salt_malloc_p,
432                      char *passwd, BIO *out, int quiet, int table,
433                      int reverse, size_t pw_maxlen, int usecrypt, int use1,
434                      int useapr1)
435 {
436     char *hash = NULL;
437
438     assert(salt_p != NULL);
439     assert(salt_malloc_p != NULL);
440
441     /* first make sure we have a salt */
442     if (!passed_salt) {
443 # ifndef OPENSSL_NO_DES
444         if (usecrypt) {
445             if (*salt_malloc_p == NULL) {
446                 *salt_p = *salt_malloc_p = app_malloc(3, "salt buffer");
447             }
448             if (RAND_bytes((unsigned char *)*salt_p, 2) <= 0)
449                 goto end;
450             (*salt_p)[0] = cov_2char[(*salt_p)[0] & 0x3f]; /* 6 bits */
451             (*salt_p)[1] = cov_2char[(*salt_p)[1] & 0x3f]; /* 6 bits */
452             (*salt_p)[2] = 0;
453 #  ifdef CHARSET_EBCDIC
454             ascii2ebcdic(*salt_p, *salt_p, 2); /* des_crypt will convert back
455                                                 * to ASCII */
456 #  endif
457         }
458 # endif                         /* !OPENSSL_NO_DES */
459
460 # ifndef NO_MD5CRYPT_1
461         if (use1 || useapr1) {
462             int i;
463
464             if (*salt_malloc_p == NULL) {
465                 *salt_p = *salt_malloc_p = app_malloc(9, "salt buffer");
466             }
467             if (RAND_bytes((unsigned char *)*salt_p, 8) <= 0)
468                 goto end;
469
470             for (i = 0; i < 8; i++)
471                 (*salt_p)[i] = cov_2char[(*salt_p)[i] & 0x3f]; /* 6 bits */
472             (*salt_p)[8] = 0;
473         }
474 # endif                         /* !NO_MD5CRYPT_1 */
475     }
476
477     assert(*salt_p != NULL);
478
479     /* truncate password if necessary */
480     if ((strlen(passwd) > pw_maxlen)) {
481         if (!quiet)
482             /*
483              * XXX: really we should know how to print a size_t, not cast it
484              */
485             BIO_printf(bio_err,
486                        "Warning: truncating password to %u characters\n",
487                        (unsigned)pw_maxlen);
488         passwd[pw_maxlen] = 0;
489     }
490     assert(strlen(passwd) <= pw_maxlen);
491
492     /* now compute password hash */
493 # ifndef OPENSSL_NO_DES
494     if (usecrypt)
495         hash = DES_crypt(passwd, *salt_p);
496 # endif
497 # ifndef NO_MD5CRYPT_1
498     if (use1 || useapr1)
499         hash = md5crypt(passwd, (use1 ? "1" : "apr1"), *salt_p);
500 # endif
501     assert(hash != NULL);
502
503     if (table && !reverse)
504         BIO_printf(out, "%s\t%s\n", passwd, hash);
505     else if (table && reverse)
506         BIO_printf(out, "%s\t%s\n", hash, passwd);
507     else
508         BIO_printf(out, "%s\n", hash);
509     return 0;
510
511  end:
512     return 1;
513 }
514 #else
515
516 int passwd_main(int argc, char **argv)
517 {
518     BIO_printf(bio_err, "Program not available.\n");
519     return (1);
520 }
521 #endif