[thirdparty/openssl.git] / apps / dgst.c

/*
 * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "apps.h"
#include "progs.h"
#include <openssl/bio.h>
#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/objects.h>
#include <openssl/x509.h>
#include <openssl/pem.h>
#include <openssl/hmac.h>
#include <ctype.h>

DEFINE_STACK_OF_STRING()

#undef BUFSIZE
#define BUFSIZE 1024*8

int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
          EVP_PKEY *key, unsigned char *sigin, int siglen,
          const char *sig_name, const char *md_name,
          const char *file);
static void show_digests(const OBJ_NAME *name, void *bio_);

struct doall_dgst_digests {
    BIO *bio;
    int n;
};

typedef enum OPTION_choice {
    OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_LIST,
    OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
    OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
    OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
    OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
    OPT_DIGEST,
    OPT_R_ENUM, OPT_PROV_ENUM
} OPTION_CHOICE;

const OPTIONS dgst_options[] = {
    {OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},

    OPT_SECTION("General"),
    {"help", OPT_HELP, '-', "Display this summary"},
    {"list", OPT_LIST, '-', "List digests"},
#ifndef OPENSSL_NO_ENGINE
    {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
    {"engine_impl", OPT_ENGINE_IMPL, '-',
     "Also use engine given by -engine for digest operations"},
#endif
    {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},

    OPT_SECTION("Output"),
    {"c", OPT_C, '-', "Print the digest with separating colons"},
    {"r", OPT_R, '-', "Print the digest in coreutils format"},
    {"out", OPT_OUT, '>', "Output to filename rather than stdout"},
    {"keyform", OPT_KEYFORM, 'f', "Key file format (PEM or ENGINE)"},
    {"hex", OPT_HEX, '-', "Print as hex dump"},
    {"binary", OPT_BINARY, '-', "Print in binary form"},
    {"d", OPT_DEBUG, '-', "Print debug info"},
    {"debug", OPT_DEBUG, '-', "Print debug info"},

    OPT_SECTION("Signing"),
    {"sign", OPT_SIGN, 's', "Sign digest using private key"},
    {"verify", OPT_VERIFY, 's', "Verify a signature using public key"},
    {"prverify", OPT_PRVERIFY, 's', "Verify a signature using private key"},
    {"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
    {"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
    {"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
    {"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
    {"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
    {"", OPT_DIGEST, '-', "Any supported digest"},
    {"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
     "Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},

    OPT_R_OPTIONS,
    OPT_PROV_OPTIONS,

    OPT_PARAMETERS(),
    {"file", 0, 0, "Files to digest (optional; default is stdin)"},
    {NULL}
};

int dgst_main(int argc, char **argv)
{
    BIO *in = NULL, *inp, *bmd = NULL, *out = NULL;
    ENGINE *e = NULL, *impl = NULL;
    EVP_PKEY *sigkey = NULL;
    STACK_OF(OPENSSL_STRING) *sigopts = NULL, *macopts = NULL;
    char *hmac_key = NULL;
    char *mac_name = NULL;
    char *passinarg = NULL, *passin = NULL;
    const EVP_MD *md = NULL, *m;
    const char *outfile = NULL, *keyfile = NULL, *prog = NULL;
    const char *sigfile = NULL;
    const char *md_name = NULL;
    OPTION_CHOICE o;
    int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
    int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
    unsigned char *buf = NULL, *sigbuf = NULL;
    int engine_impl = 0;
    struct doall_dgst_digests dec;

    prog = opt_progname(argv[0]);
    buf = app_malloc(BUFSIZE, "I/O buffer");
    md = EVP_get_digestbyname(prog);

    prog = opt_init(argc, argv, dgst_options);
    while ((o = opt_next()) != OPT_EOF) {
        switch (o) {
        case OPT_EOF:
        case OPT_ERR:
 opthelp:
            BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
            goto end;
        case OPT_HELP:
            opt_help(dgst_options);
            ret = 0;
            goto end;
        case OPT_LIST:
            BIO_printf(bio_out, "Supported digests:\n");
            dec.bio = bio_out;
            dec.n = 0;
            OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
                                   show_digests, &dec);
            BIO_printf(bio_out, "\n");
            ret = 0;
            goto end;
        case OPT_C:
            separator = 1;
            break;
        case OPT_R:
            separator = 2;
            break;
        case OPT_R_CASES:
            if (!opt_rand(o))
                goto end;
            break;
        case OPT_OUT:
            outfile = opt_arg();
            break;
        case OPT_SIGN:
            keyfile = opt_arg();
            break;
        case OPT_PASSIN:
            passinarg = opt_arg();
            break;
        case OPT_VERIFY:
            keyfile = opt_arg();
            want_pub = do_verify = 1;
            break;
        case OPT_PRVERIFY:
            keyfile = opt_arg();
            do_verify = 1;
            break;
        case OPT_SIGNATURE:
            sigfile = opt_arg();
            break;
        case OPT_KEYFORM:
            if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
                goto opthelp;
            break;
        case OPT_ENGINE:
            e = setup_engine(opt_arg(), 0);
            break;
        case OPT_ENGINE_IMPL:
            engine_impl = 1;
            break;
        case OPT_HEX:
            out_bin = 0;
            break;
        case OPT_BINARY:
            out_bin = 1;
            break;
        case OPT_DEBUG:
            debug = 1;
            break;
        case OPT_FIPS_FINGERPRINT:
            hmac_key = "etaonrishdlcupfm";
            break;
        case OPT_HMAC:
            hmac_key = opt_arg();
            break;
        case OPT_MAC:
            mac_name = opt_arg();
            break;
        case OPT_SIGOPT:
            if (!sigopts)
                sigopts = sk_OPENSSL_STRING_new_null();
            if (!sigopts || !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
                goto opthelp;
            break;
        case OPT_MACOPT:
            if (!macopts)
                macopts = sk_OPENSSL_STRING_new_null();
            if (!macopts || !sk_OPENSSL_STRING_push(macopts, opt_arg()))
                goto opthelp;
            break;
        case OPT_DIGEST:
            if (!opt_md(opt_unknown(), &m))
                goto opthelp;
            md = m;
            break;
        case OPT_PROV_CASES:
            if (!opt_provider(o))
                goto end;
            break;
        }
    }
    argc = opt_num_rest();
    argv = opt_rest();
    if (keyfile != NULL && argc > 1) {
        BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
        goto end;
    }

    if (do_verify && sigfile == NULL) {
        BIO_printf(bio_err,
                   "No signature to verify: use the -signature option\n");
        goto end;
    }
    if (engine_impl)
        impl = e;

    in = BIO_new(BIO_s_file());
    bmd = BIO_new(BIO_f_md());
    if ((in == NULL) || (bmd == NULL)) {
        ERR_print_errors(bio_err);
        goto end;
    }

    if (debug) {
        BIO_set_callback(in, BIO_debug_callback);
        /* needed for windows 3.1 */
        BIO_set_callback_arg(in, (char *)bio_err);
    }

    if (!app_passwd(passinarg, NULL, &passin, NULL)) {
        BIO_printf(bio_err, "Error getting password\n");
        goto end;
    }

    if (out_bin == -1) {
        if (keyfile != NULL)
            out_bin = 1;
        else
            out_bin = 0;
    }

    out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
    if (out == NULL)
        goto end;

    if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
        BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
        goto end;
    }

    if (keyfile != NULL) {
        int type;

        if (want_pub)
            sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
        else
            sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
        if (sigkey == NULL) {
            /*
             * load_[pub]key() has already printed an appropriate message
             */
            goto end;
        }
        type = EVP_PKEY_id(sigkey);
        if (type == EVP_PKEY_ED25519 || type == EVP_PKEY_ED448) {
            /*
             * We implement PureEdDSA for these which doesn't have a separate
             * digest, and only supports one shot.
             */
            BIO_printf(bio_err, "Key type not supported for this operation\n");
            goto end;
        }
    }

    if (mac_name != NULL) {
        EVP_PKEY_CTX *mac_ctx = NULL;
        int r = 0;
        if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
            goto mac_end;
        if (macopts != NULL) {
            char *macopt;
            for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
                macopt = sk_OPENSSL_STRING_value(macopts, i);
                if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
                    BIO_printf(bio_err,
                               "MAC parameter error \"%s\"\n", macopt);
                    ERR_print_errors(bio_err);
                    goto mac_end;
                }
            }
        }
        if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
            BIO_puts(bio_err, "Error generating key\n");
            ERR_print_errors(bio_err);
            goto mac_end;
        }
        r = 1;
 mac_end:
        EVP_PKEY_CTX_free(mac_ctx);
        if (r == 0)
            goto end;
    }

    if (hmac_key != NULL) {
        sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
                                              (unsigned char *)hmac_key, -1);
        if (sigkey == NULL)
            goto end;
    }

    if (sigkey != NULL) {
        EVP_MD_CTX *mctx = NULL;
        EVP_PKEY_CTX *pctx = NULL;
        int r;
        if (!BIO_get_md_ctx(bmd, &mctx)) {
            BIO_printf(bio_err, "Error getting context\n");
            ERR_print_errors(bio_err);
            goto end;
        }
        if (do_verify)
            r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
        else
            r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
        if (!r) {
            BIO_printf(bio_err, "Error setting context\n");
            ERR_print_errors(bio_err);
            goto end;
        }
        if (sigopts != NULL) {
            char *sigopt;
            for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
                sigopt = sk_OPENSSL_STRING_value(sigopts, i);
                if (pkey_ctrl_string(pctx, sigopt) <= 0) {
                    BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
                    ERR_print_errors(bio_err);
                    goto end;
                }
            }
        }
    }
    /* we use md as a filter, reading from 'in' */
    else {
        EVP_MD_CTX *mctx = NULL;
        if (!BIO_get_md_ctx(bmd, &mctx)) {
            BIO_printf(bio_err, "Error getting context\n");
            ERR_print_errors(bio_err);
            goto end;
        }
        if (md == NULL)
            md = EVP_sha256();
        if (!EVP_DigestInit_ex(mctx, md, impl)) {
            BIO_printf(bio_err, "Error setting digest\n");
            ERR_print_errors(bio_err);
            goto end;
        }
    }

    if (sigfile != NULL && sigkey != NULL) {
        BIO *sigbio = BIO_new_file(sigfile, "rb");
        if (sigbio == NULL) {
            BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
            ERR_print_errors(bio_err);
            goto end;
        }
        siglen = EVP_PKEY_size(sigkey);
        sigbuf = app_malloc(siglen, "signature buffer");
        siglen = BIO_read(sigbio, sigbuf, siglen);
        BIO_free(sigbio);
        if (siglen <= 0) {
            BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
            ERR_print_errors(bio_err);
            goto end;
        }
    }
    inp = BIO_push(bmd, in);

    if (md == NULL) {
        EVP_MD_CTX *tctx;
        BIO_get_md_ctx(bmd, &tctx);
        md = EVP_MD_CTX_md(tctx);
    }
    if (md != NULL)
        md_name = EVP_MD_name(md);

    if (argc == 0) {
        BIO_set_fp(in, stdin, BIO_NOCLOSE);
        ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
                    siglen, NULL, md_name, "stdin");
    } else {
        const char *sig_name = NULL;
        if (!out_bin) {
            if (sigkey != NULL) {
                const EVP_PKEY_ASN1_METHOD *ameth;
                ameth = EVP_PKEY_get0_asn1(sigkey);
                if (ameth)
                    EVP_PKEY_asn1_get0_info(NULL, NULL,
                                            NULL, NULL, &sig_name, ameth);
            }
        }
        ret = 0;
        for (i = 0; i < argc; i++) {
            int r;
            if (BIO_read_filename(in, argv[i]) <= 0) {
                perror(argv[i]);
                ret++;
                continue;
            } else {
                r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
                          siglen, sig_name, md_name, argv[i]);
            }
            if (r)
                ret = r;
            (void)BIO_reset(bmd);
        }
    }
 end:
    OPENSSL_clear_free(buf, BUFSIZE);
    BIO_free(in);
    OPENSSL_free(passin);
    BIO_free_all(out);
    EVP_PKEY_free(sigkey);
    sk_OPENSSL_STRING_free(sigopts);
    sk_OPENSSL_STRING_free(macopts);
    OPENSSL_free(sigbuf);
    BIO_free(bmd);
    release_engine(e);
    return ret;
}

static void show_digests(const OBJ_NAME *name, void *arg)
{
    struct doall_dgst_digests *dec = (struct doall_dgst_digests *)arg;
    const EVP_MD *md = NULL;

    /* Filter out signed digests (a.k.a signature algorithms) */
    if (strstr(name->name, "rsa") != NULL || strstr(name->name, "RSA") != NULL)
        return;

    if (!islower((unsigned char)*name->name))
        return;

    /* Filter out message digests that we cannot use */
    md = EVP_get_digestbyname(name->name);
    if (md == NULL)
        return;

    BIO_printf(dec->bio, "-%-25s", name->name);
    if (++dec->n == 3) {
        BIO_printf(dec->bio, "\n");
        dec->n = 0;
    } else {
        BIO_printf(dec->bio, " ");
    }
}

/*
 * The newline_escape_filename function performs newline escaping for any
 * filename that contains a newline.  This function also takes a pointer
 * to backslash. The backslash pointer is a flag to indicating whether a newline
 * is present in the filename.  If a newline is present, the backslash flag is
 * set and the output format will contain a backslash at the beginning of the
 * digest output. This output format is to replicate the output format found
 * in the '*sum' checksum programs. This aims to preserve backward
 * compatibility.
 */
static const char *newline_escape_filename(const char *file, int * backslash)
{
    size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
    char *file_cpy = NULL;

    for (i = 0; i < length; i++)
        if (file[i] == '\n')
            newline_count++;

    mem_len = length + newline_count + 1;
    file_cpy = app_malloc(mem_len, file);
    i = 0;

    while(e < length) {
        const char c = file[e];
        if (c == '\n') {
            file_cpy[i++] = '\\';
            file_cpy[i++] = 'n';
            *backslash = 1;
        } else {
            file_cpy[i++] = c;
        }
        e++;
    }
    file_cpy[i] = '\0';
    return (const char*)file_cpy;
}


int do_fp(BIO *out, unsigned char *buf, BIO *bp, int sep, int binout,
          EVP_PKEY *key, unsigned char *sigin, int siglen,
          const char *sig_name, const char *md_name,
          const char *file)
{
    size_t len = BUFSIZE;
    int i, backslash = 0, ret = 1;
    unsigned char *sigbuf = NULL;

    while (BIO_pending(bp) || !BIO_eof(bp)) {
        i = BIO_read(bp, (char *)buf, BUFSIZE);
        if (i < 0) {
            BIO_printf(bio_err, "Read Error in %s\n", file);
            ERR_print_errors(bio_err);
            goto end;
        }
        if (i == 0)
            break;
    }
    if (sigin != NULL) {
        EVP_MD_CTX *ctx;
        BIO_get_md_ctx(bp, &ctx);
        i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
        if (i > 0) {
            BIO_printf(out, "Verified OK\n");
        } else if (i == 0) {
            BIO_printf(out, "Verification Failure\n");
            goto end;
        } else {
            BIO_printf(bio_err, "Error Verifying Data\n");
            ERR_print_errors(bio_err);
            goto end;
        }
        ret = 0;
        goto end;
    }
    if (key != NULL) {
        EVP_MD_CTX *ctx;
        size_t tmplen;

        BIO_get_md_ctx(bp, &ctx);
        if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
            BIO_printf(bio_err, "Error Signing Data\n");
            ERR_print_errors(bio_err);
            goto end;
        }
        if (tmplen > BUFSIZE) {
            len = tmplen;
            sigbuf = app_malloc(len, "Signature buffer");
            buf = sigbuf;
        }
        if (!EVP_DigestSignFinal(ctx, buf, &len)) {
            BIO_printf(bio_err, "Error Signing Data\n");
            ERR_print_errors(bio_err);
            goto end;
        }
    } else {
        len = BIO_gets(bp, (char *)buf, BUFSIZE);
        if ((int)len < 0) {
            ERR_print_errors(bio_err);
            goto end;
        }
    }

    if (binout) {
        BIO_write(out, buf, len);
    } else if (sep == 2) {
        file = newline_escape_filename(file, &backslash);

        if (backslash == 1)
            BIO_puts(out, "\\");

        for (i = 0; i < (int)len; i++)
            BIO_printf(out, "%02x", buf[i]);

        BIO_printf(out, " *%s\n", file);
        OPENSSL_free((char *)file);
    } else {
        if (sig_name != NULL) {
            BIO_puts(out, sig_name);
            if (md_name != NULL)
                BIO_printf(out, "-%s", md_name);
            BIO_printf(out, "(%s)= ", file);
        } else if (md_name != NULL) {
            BIO_printf(out, "%s(%s)= ", md_name, file);
        } else {
            BIO_printf(out, "(%s)= ", file);
        }
        for (i = 0; i < (int)len; i++) {
            if (sep && (i != 0))
                BIO_printf(out, ":");
            BIO_printf(out, "%02x", buf[i]);
        }
        BIO_printf(out, "\n");
    }

    ret = 0;
 end:
    if (sigbuf != NULL)
        OPENSSL_clear_free(sigbuf, len);

    return ret;
}
Commit	Line	Data
846e33c7	1	/*
33388b44	2	* Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6	3	*
dffa7520	4	* Licensed under the Apache License 2.0 (the "License"). You may not use
846e33c7 RS	5	* this file except in compliance with the License. You can obtain a copy
	6	* in the file LICENSE in the source distribution or at
	7	* https://www.openssl.org/source/license.html
d02b48c6 RE	8	*/
	9
	10	#include <stdio.h>
	11	#include <string.h>
	12	#include <stdlib.h>
	13	#include "apps.h"
dab2cd68	14	#include "progs.h"
ec577822 BM	15	#include <openssl/bio.h>
	16	#include <openssl/err.h>
	17	#include <openssl/evp.h>
	18	#include <openssl/objects.h>
	19	#include <openssl/x509.h>
	20	#include <openssl/pem.h>
52cfa397	21	#include <openssl/hmac.h>
f62d67b6	22	#include <ctype.h>
d02b48c6	23
852c2ed2 RS	24	DEFINE_STACK_OF_STRING()
852c2ed2 RS	25
d02b48c6	26	#undef BUFSIZE
0f113f3e	27	#define BUFSIZE 1024*8
d02b48c6	28
d15711ef	29	int do_fp(BIO out, unsigned char buf, BIO *bp, int sep, int binout,
0f113f3e MC	30	EVP_PKEY key, unsigned char sigin, int siglen,
0f113f3e MC	31	const char sig_name, const char md_name,
a773b52a	32	const char *file);
f62d67b6	33	static void show_digests(const OBJ_NAME name, void bio_);
	34
	35	struct doall_dgst_digests {
	36	BIO *bio;
	37	int n;
	38	};
667ac4ec	39
7e1b7485	40	typedef enum OPTION_choice {
f62d67b6	41	OPT_ERR = -1, OPT_EOF = 0, OPT_HELP, OPT_LIST,
3ee1eac2	42	OPT_C, OPT_R, OPT_OUT, OPT_SIGN, OPT_PASSIN, OPT_VERIFY,
7e1b7485 RS	43	OPT_PRVERIFY, OPT_SIGNATURE, OPT_KEYFORM, OPT_ENGINE, OPT_ENGINE_IMPL,
7e1b7485 RS	44	OPT_HEX, OPT_BINARY, OPT_DEBUG, OPT_FIPS_FINGERPRINT,
700b4a4a	45	OPT_HMAC, OPT_MAC, OPT_SIGOPT, OPT_MACOPT,
3ee1eac2	46	OPT_DIGEST,
6bd4e3f2	47	OPT_R_ENUM, OPT_PROV_ENUM
7e1b7485 RS	48	} OPTION_CHOICE;
7e1b7485 RS	49
44c83ebd	50	const OPTIONS dgst_options[] = {
7e1b7485	51	{OPT_HELP_STR, 1, '-', "Usage: %s [options] [file...]\n"},
92de469f	52
5388f986	53	OPT_SECTION("General"),
7e1b7485	54	{"help", OPT_HELP, '-', "Display this summary"},
f62d67b6	55	{"list", OPT_LIST, '-', "List digests"},
5388f986 RS	56	#ifndef OPENSSL_NO_ENGINE
	57	{"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
	58	{"engine_impl", OPT_ENGINE_IMPL, '-',
	59	"Also use engine given by -engine for digest operations"},
	60	#endif
	61	{"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
	62
	63	OPT_SECTION("Output"),
7e1b7485 RS	64	{"c", OPT_C, '-', "Print the digest with separating colons"},
7e1b7485 RS	65	{"r", OPT_R, '-', "Print the digest in coreutils format"},
7e1b7485	66	{"out", OPT_OUT, '>', "Output to filename rather than stdout"},
7e1b7485	67	{"keyform", OPT_KEYFORM, 'f', "Key file format (PEM or ENGINE)"},
7e1b7485 RS	68	{"hex", OPT_HEX, '-', "Print as hex dump"},
	69	{"binary", OPT_BINARY, '-', "Print in binary form"},
	70	{"d", OPT_DEBUG, '-', "Print debug info"},
a173a7ee	71	{"debug", OPT_DEBUG, '-', "Print debug info"},
5388f986 RS	72
	73	OPT_SECTION("Signing"),
	74	{"sign", OPT_SIGN, 's', "Sign digest using private key"},
	75	{"verify", OPT_VERIFY, 's', "Verify a signature using public key"},
	76	{"prverify", OPT_PRVERIFY, 's', "Verify a signature using private key"},
	77	{"sigopt", OPT_SIGOPT, 's', "Signature parameter in n:v form"},
	78	{"signature", OPT_SIGNATURE, '<', "File with signature to verify"},
7e1b7485	79	{"hmac", OPT_HMAC, 's', "Create hashed MAC with key"},
0d4fb843	80	{"mac", OPT_MAC, 's', "Create MAC (not necessarily HMAC)"},
d175e8a6	81	{"macopt", OPT_MACOPT, 's', "MAC algorithm parameters in n:v form or key"},
9c3bcfa0	82	{"", OPT_DIGEST, '-', "Any supported digest"},
5388f986 RS	83	{"fips-fingerprint", OPT_FIPS_FINGERPRINT, '-',
	84	"Compute HMAC with the key used in OpenSSL-FIPS fingerprint"},
	85
3ee1eac2	86	OPT_R_OPTIONS,
6bd4e3f2	87	OPT_PROV_OPTIONS,
92de469f RS	88
	89	OPT_PARAMETERS(),
	90	{"file", 0, 0, "Files to digest (optional; default is stdin)"},
7e1b7485 RS	91	{NULL}
	92	};
	93
	94	int dgst_main(int argc, char **argv)
0f113f3e	95	{
7e1b7485	96	BIO in = NULL, inp, bmd = NULL, out = NULL;
0f113f3e	97	ENGINE e = NULL, impl = NULL;
7e1b7485 RS	98	EVP_PKEY *sigkey = NULL;
	99	STACK_OF(OPENSSL_STRING) sigopts = NULL, macopts = NULL;
	100	char *hmac_key = NULL;
	101	char *mac_name = NULL;
	102	char passinarg = NULL, passin = NULL;
0f113f3e	103	const EVP_MD md = NULL, m;
7e1b7485	104	const char outfile = NULL, keyfile = NULL, *prog = NULL;
3ee1eac2	105	const char *sigfile = NULL;
7ed4b97b	106	const char *md_name = NULL;
7e1b7485 RS	107	OPTION_CHOICE o;
7e1b7485 RS	108	int separator = 0, debug = 0, keyform = FORMAT_PEM, siglen = 0;
700b4a4a	109	int i, ret = 1, out_bin = -1, want_pub = 0, do_verify = 0;
7e1b7485	110	unsigned char buf = NULL, sigbuf = NULL;
0f113f3e	111	int engine_impl = 0;
f62d67b6	112	struct doall_dgst_digests dec;
0f113f3e	113
7e1b7485	114	prog = opt_progname(argv[0]);
68dc6824	115	buf = app_malloc(BUFSIZE, "I/O buffer");
7e1b7485 RS	116	md = EVP_get_digestbyname(prog);
	117
	118	prog = opt_init(argc, argv, dgst_options);
	119	while ((o = opt_next()) != OPT_EOF) {
	120	switch (o) {
	121	case OPT_EOF:
	122	case OPT_ERR:
	123	opthelp:
	124	BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
	125	goto end;
	126	case OPT_HELP:
	127	opt_help(dgst_options);
	128	ret = 0;
	129	goto end;
f62d67b6	130	case OPT_LIST:
	131	BIO_printf(bio_out, "Supported digests:\n");
	132	dec.bio = bio_out;
	133	dec.n = 0;
	134	OBJ_NAME_do_all_sorted(OBJ_NAME_TYPE_MD_METH,
	135	show_digests, &dec);
	136	BIO_printf(bio_out, "\n");
	137	ret = 0;
	138	goto end;
7e1b7485	139	case OPT_C:
0f113f3e	140	separator = 1;
7e1b7485 RS	141	break;
7e1b7485 RS	142	case OPT_R:
0f113f3e	143	separator = 2;
7e1b7485	144	break;
3ee1eac2 RS	145	case OPT_R_CASES:
	146	if (!opt_rand(o))
	147	goto end;
7e1b7485 RS	148	break;
	149	case OPT_OUT:
	150	outfile = opt_arg();
	151	break;
	152	case OPT_SIGN:
	153	keyfile = opt_arg();
	154	break;
	155	case OPT_PASSIN:
	156	passinarg = opt_arg();
	157	break;
	158	case OPT_VERIFY:
	159	keyfile = opt_arg();
	160	want_pub = do_verify = 1;
	161	break;
	162	case OPT_PRVERIFY:
	163	keyfile = opt_arg();
0f113f3e	164	do_verify = 1;
7e1b7485 RS	165	break;
	166	case OPT_SIGNATURE:
	167	sigfile = opt_arg();
	168	break;
	169	case OPT_KEYFORM:
	170	if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
	171	goto opthelp;
	172	break;
7e1b7485	173	case OPT_ENGINE:
333b070e	174	e = setup_engine(opt_arg(), 0);
7e1b7485 RS	175	break;
7e1b7485 RS	176	case OPT_ENGINE_IMPL:
0f113f3e	177	engine_impl = 1;
7e1b7485	178	break;
7e1b7485	179	case OPT_HEX:
0f113f3e	180	out_bin = 0;
7e1b7485 RS	181	break;
7e1b7485 RS	182	case OPT_BINARY:
0f113f3e	183	out_bin = 1;
7e1b7485 RS	184	break;
7e1b7485 RS	185	case OPT_DEBUG:
0f113f3e	186	debug = 1;
7e1b7485 RS	187	break;
7e1b7485 RS	188	case OPT_FIPS_FINGERPRINT:
0f113f3e	189	hmac_key = "etaonrishdlcupfm";
7e1b7485	190	break;
7e1b7485 RS	191	case OPT_HMAC:
	192	hmac_key = opt_arg();
	193	break;
	194	case OPT_MAC:
	195	mac_name = opt_arg();
	196	break;
	197	case OPT_SIGOPT:
0f113f3e MC	198	if (!sigopts)
0f113f3e MC	199	sigopts = sk_OPENSSL_STRING_new_null();
7e1b7485 RS	200	if (!sigopts \|\| !sk_OPENSSL_STRING_push(sigopts, opt_arg()))
	201	goto opthelp;
	202	break;
	203	case OPT_MACOPT:
0f113f3e MC	204	if (!macopts)
0f113f3e MC	205	macopts = sk_OPENSSL_STRING_new_null();
7e1b7485 RS	206	if (!macopts \|\| !sk_OPENSSL_STRING_push(macopts, opt_arg()))
	207	goto opthelp;
	208	break;
	209	case OPT_DIGEST:
	210	if (!opt_md(opt_unknown(), &m))
	211	goto opthelp;
0f113f3e	212	md = m;
0f113f3e	213	break;
6bd4e3f2 P	214	case OPT_PROV_CASES:
	215	if (!opt_provider(o))
	216	goto end;
	217	break;
7e1b7485	218	}
0f113f3e	219	}
7e1b7485 RS	220	argc = opt_num_rest();
7e1b7485 RS	221	argv = opt_rest();
13a46183 RS	222	if (keyfile != NULL && argc > 1) {
	223	BIO_printf(bio_err, "%s: Can only sign or verify one file.\n", prog);
	224	goto end;
	225	}
0f113f3e	226
2234212c	227	if (do_verify && sigfile == NULL) {
0f113f3e MC	228	BIO_printf(bio_err,
	229	"No signature to verify: use the -signature option\n");
	230	goto end;
	231	}
0f113f3e MC	232	if (engine_impl)
0f113f3e MC	233	impl = e;
bb845ee0	234
0f113f3e MC	235	in = BIO_new(BIO_s_file());
0f113f3e MC	236	bmd = BIO_new(BIO_f_md());
be1477ad MC	237	if ((in == NULL) \|\| (bmd == NULL)) {
	238	ERR_print_errors(bio_err);
	239	goto end;
	240	}
	241
0f113f3e MC	242	if (debug) {
	243	BIO_set_callback(in, BIO_debug_callback);
	244	/* needed for windows 3.1 */
	245	BIO_set_callback_arg(in, (char *)bio_err);
	246	}
	247
7e1b7485	248	if (!app_passwd(passinarg, NULL, &passin, NULL)) {
0f113f3e MC	249	BIO_printf(bio_err, "Error getting password\n");
	250	goto end;
	251	}
	252
0f113f3e	253	if (out_bin == -1) {
2234212c	254	if (keyfile != NULL)
0f113f3e MC	255	out_bin = 1;
	256	else
	257	out_bin = 0;
	258	}
	259
bdd58d98	260	out = bio_open_default(outfile, 'w', out_bin ? FORMAT_BINARY : FORMAT_TEXT);
7e1b7485	261	if (out == NULL)
0f113f3e	262	goto end;
7e1b7485	263
2234212c	264	if ((!(mac_name == NULL) + !(keyfile == NULL) + !(hmac_key == NULL)) > 1) {
0f113f3e MC	265	BIO_printf(bio_err, "MAC and Signing key cannot both be specified\n");
	266	goto end;
	267	}
	268
2234212c	269	if (keyfile != NULL) {
e65c959f MC	270	int type;
e65c959f MC	271
0f113f3e	272	if (want_pub)
7e1b7485	273	sigkey = load_pubkey(keyfile, keyform, 0, NULL, e, "key file");
0f113f3e	274	else
7e1b7485	275	sigkey = load_key(keyfile, keyform, 0, passin, e, "key file");
2234212c	276	if (sigkey == NULL) {
0f113f3e MC	277	/*
	278	* load_[pub]key() has already printed an appropriate message
	279	*/
	280	goto end;
	281	}
e65c959f MC	282	type = EVP_PKEY_id(sigkey);
	283	if (type == EVP_PKEY_ED25519 \|\| type == EVP_PKEY_ED448) {
	284	/*
	285	* We implement PureEdDSA for these which doesn't have a separate
	286	* digest, and only supports one shot.
	287	*/
	288	BIO_printf(bio_err, "Key type not supported for this operation\n");
	289	goto end;
	290	}
0f113f3e MC	291	}
0f113f3e MC	292
2234212c	293	if (mac_name != NULL) {
0f113f3e MC	294	EVP_PKEY_CTX *mac_ctx = NULL;
0f113f3e MC	295	int r = 0;
7e1b7485	296	if (!init_gen_str(&mac_ctx, mac_name, impl, 0))
0f113f3e	297	goto mac_end;
2234212c	298	if (macopts != NULL) {
0f113f3e MC	299	char *macopt;
	300	for (i = 0; i < sk_OPENSSL_STRING_num(macopts); i++) {
	301	macopt = sk_OPENSSL_STRING_value(macopts, i);
	302	if (pkey_ctrl_string(mac_ctx, macopt) <= 0) {
	303	BIO_printf(bio_err,
	304	"MAC parameter error \"%s\"\n", macopt);
	305	ERR_print_errors(bio_err);
	306	goto mac_end;
	307	}
	308	}
	309	}
	310	if (EVP_PKEY_keygen(mac_ctx, &sigkey) <= 0) {
	311	BIO_puts(bio_err, "Error generating key\n");
	312	ERR_print_errors(bio_err);
	313	goto mac_end;
	314	}
	315	r = 1;
	316	mac_end:
c5ba2d99	317	EVP_PKEY_CTX_free(mac_ctx);
0f113f3e MC	318	if (r == 0)
	319	goto end;
	320	}
	321
2234212c	322	if (hmac_key != NULL) {
f929439f MC	323	sigkey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, impl,
f929439f MC	324	(unsigned char *)hmac_key, -1);
2234212c	325	if (sigkey == NULL)
0f113f3e MC	326	goto end;
	327	}
	328
2234212c	329	if (sigkey != NULL) {
0f113f3e MC	330	EVP_MD_CTX *mctx = NULL;
	331	EVP_PKEY_CTX *pctx = NULL;
	332	int r;
	333	if (!BIO_get_md_ctx(bmd, &mctx)) {
	334	BIO_printf(bio_err, "Error getting context\n");
	335	ERR_print_errors(bio_err);
	336	goto end;
	337	}
	338	if (do_verify)
	339	r = EVP_DigestVerifyInit(mctx, &pctx, md, impl, sigkey);
	340	else
	341	r = EVP_DigestSignInit(mctx, &pctx, md, impl, sigkey);
	342	if (!r) {
	343	BIO_printf(bio_err, "Error setting context\n");
	344	ERR_print_errors(bio_err);
	345	goto end;
	346	}
2234212c	347	if (sigopts != NULL) {
0f113f3e MC	348	char *sigopt;
	349	for (i = 0; i < sk_OPENSSL_STRING_num(sigopts); i++) {
	350	sigopt = sk_OPENSSL_STRING_value(sigopts, i);
	351	if (pkey_ctrl_string(pctx, sigopt) <= 0) {
	352	BIO_printf(bio_err, "parameter error \"%s\"\n", sigopt);
	353	ERR_print_errors(bio_err);
	354	goto end;
	355	}
	356	}
	357	}
	358	}
	359	/* we use md as a filter, reading from 'in' */
	360	else {
	361	EVP_MD_CTX *mctx = NULL;
	362	if (!BIO_get_md_ctx(bmd, &mctx)) {
	363	BIO_printf(bio_err, "Error getting context\n");
	364	ERR_print_errors(bio_err);
	365	goto end;
	366	}
	367	if (md == NULL)
f8547f62	368	md = EVP_sha256();
0f113f3e	369	if (!EVP_DigestInit_ex(mctx, md, impl)) {
7e1b7485	370	BIO_printf(bio_err, "Error setting digest\n");
0f113f3e MC	371	ERR_print_errors(bio_err);
	372	goto end;
	373	}
	374	}
	375
2234212c	376	if (sigfile != NULL && sigkey != NULL) {
7e1b7485	377	BIO *sigbio = BIO_new_file(sigfile, "rb");
2234212c	378	if (sigbio == NULL) {
0f113f3e MC	379	BIO_printf(bio_err, "Error opening signature file %s\n", sigfile);
	380	ERR_print_errors(bio_err);
	381	goto end;
	382	}
7e1b7485	383	siglen = EVP_PKEY_size(sigkey);
68dc6824	384	sigbuf = app_malloc(siglen, "signature buffer");
0f113f3e MC	385	siglen = BIO_read(sigbio, sigbuf, siglen);
	386	BIO_free(sigbio);
	387	if (siglen <= 0) {
	388	BIO_printf(bio_err, "Error reading signature file %s\n", sigfile);
	389	ERR_print_errors(bio_err);
	390	goto end;
	391	}
	392	}
	393	inp = BIO_push(bmd, in);
	394
	395	if (md == NULL) {
	396	EVP_MD_CTX *tctx;
	397	BIO_get_md_ctx(bmd, &tctx);
	398	md = EVP_MD_CTX_md(tctx);
	399	}
7ed4b97b RL	400	if (md != NULL)
7ed4b97b RL	401	md_name = EVP_MD_name(md);
0f113f3e MC	402
	403	if (argc == 0) {
	404	BIO_set_fp(in, stdin, BIO_NOCLOSE);
7e1b7485	405	ret = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
7ed4b97b	406	siglen, NULL, md_name, "stdin");
0f113f3e	407	} else {
7ed4b97b	408	const char *sig_name = NULL;
0f113f3e	409	if (!out_bin) {
2234212c	410	if (sigkey != NULL) {
0f113f3e MC	411	const EVP_PKEY_ASN1_METHOD *ameth;
	412	ameth = EVP_PKEY_get0_asn1(sigkey);
	413	if (ameth)
	414	EVP_PKEY_asn1_get0_info(NULL, NULL,
	415	NULL, NULL, &sig_name, ameth);
	416	}
0f113f3e	417	}
7e1b7485	418	ret = 0;
0f113f3e MC	419	for (i = 0; i < argc; i++) {
	420	int r;
	421	if (BIO_read_filename(in, argv[i]) <= 0) {
	422	perror(argv[i]);
7e1b7485	423	ret++;
0f113f3e	424	continue;
2234212c	425	} else {
0f113f3e	426	r = do_fp(out, buf, inp, separator, out_bin, sigkey, sigbuf,
a773b52a	427	siglen, sig_name, md_name, argv[i]);
2234212c	428	}
0f113f3e	429	if (r)
7e1b7485	430	ret = r;
0f113f3e MC	431	(void)BIO_reset(bmd);
	432	}
	433	}
	434	end:
4b45c6e5	435	OPENSSL_clear_free(buf, BUFSIZE);
ca3a82c3	436	BIO_free(in);
25aaa98a	437	OPENSSL_free(passin);
0f113f3e MC	438	BIO_free_all(out);
0f113f3e MC	439	EVP_PKEY_free(sigkey);
25aaa98a RS	440	sk_OPENSSL_STRING_free(sigopts);
25aaa98a RS	441	sk_OPENSSL_STRING_free(macopts);
b548a1f1	442	OPENSSL_free(sigbuf);
ca3a82c3	443	BIO_free(bmd);
dd1abd44	444	release_engine(e);
26a7d938	445	return ret;
0f113f3e	446	}
d02b48c6	447
f62d67b6	448	static void show_digests(const OBJ_NAME name, void arg)
	449	{
	450	struct doall_dgst_digests dec = (struct doall_dgst_digests )arg;
	451	const EVP_MD *md = NULL;
	452
	453	/* Filter out signed digests (a.k.a signature algorithms) */
	454	if (strstr(name->name, "rsa") != NULL \|\| strstr(name->name, "RSA") != NULL)
	455	return;
	456
	457	if (!islower((unsigned char)*name->name))
	458	return;
	459
	460	/* Filter out message digests that we cannot use */
	461	md = EVP_get_digestbyname(name->name);
	462	if (md == NULL)
	463	return;
	464
	465	BIO_printf(dec->bio, "-%-25s", name->name);
	466	if (++dec->n == 3) {
	467	BIO_printf(dec->bio, "\n");
	468	dec->n = 0;
	469	} else {
	470	BIO_printf(dec->bio, " ");
	471	}
	472	}
	473
f3448f54 P	474	/*
	475	* The newline_escape_filename function performs newline escaping for any
	476	* filename that contains a newline. This function also takes a pointer
	477	* to backslash. The backslash pointer is a flag to indicating whether a newline
	478	* is present in the filename. If a newline is present, the backslash flag is
	479	* set and the output format will contain a backslash at the beginning of the
	480	* digest output. This output format is to replicate the output format found
	481	* in the '*sum' checksum programs. This aims to preserve backward
	482	* compatibility.
	483	*/
	484	static const char newline_escape_filename(const char file, int * backslash)
	485	{
	486	size_t i, e = 0, length = strlen(file), newline_count = 0, mem_len = 0;
	487	char *file_cpy = NULL;
	488
	489	for (i = 0; i < length; i++)
	490	if (file[i] == '\n')
	491	newline_count++;
	492
	493	mem_len = length + newline_count + 1;
	494	file_cpy = app_malloc(mem_len, file);
	495	i = 0;
	496
	497	while(e < length) {
	498	const char c = file[e];
	499	if (c == '\n') {
	500	file_cpy[i++] = '\\';
	501	file_cpy[i++] = 'n';
	502	*backslash = 1;
	503	} else {
	504	file_cpy[i++] = c;
	505	}
	506	e++;
	507	}
	508	file_cpy[i] = '\0';
	509	return (const char*)file_cpy;
	510	}
	511
	512
d15711ef	513	int do_fp(BIO out, unsigned char buf, BIO *bp, int sep, int binout,
0f113f3e MC	514	EVP_PKEY key, unsigned char sigin, int siglen,
0f113f3e MC	515	const char sig_name, const char md_name,
a773b52a	516	const char *file)
0f113f3e	517	{
7c2d95d4 PK	518	size_t len = BUFSIZE;
	519	int i, backslash = 0, ret = 1;
	520	unsigned char *sigbuf = NULL;
0f113f3e	521
8ed7bbb4	522	while (BIO_pending(bp) \|\| !BIO_eof(bp)) {
0f113f3e MC	523	i = BIO_read(bp, (char *)buf, BUFSIZE);
	524	if (i < 0) {
	525	BIO_printf(bio_err, "Read Error in %s\n", file);
	526	ERR_print_errors(bio_err);
7c2d95d4	527	goto end;
0f113f3e MC	528	}
	529	if (i == 0)
	530	break;
	531	}
2234212c	532	if (sigin != NULL) {
0f113f3e MC	533	EVP_MD_CTX *ctx;
	534	BIO_get_md_ctx(bp, &ctx);
	535	i = EVP_DigestVerifyFinal(ctx, sigin, (unsigned int)siglen);
2234212c	536	if (i > 0) {
0f113f3e	537	BIO_printf(out, "Verified OK\n");
2234212c	538	} else if (i == 0) {
0f113f3e	539	BIO_printf(out, "Verification Failure\n");
7c2d95d4	540	goto end;
0f113f3e MC	541	} else {
	542	BIO_printf(bio_err, "Error Verifying Data\n");
	543	ERR_print_errors(bio_err);
7c2d95d4	544	goto end;
0f113f3e	545	}
7c2d95d4 PK	546	ret = 0;
7c2d95d4 PK	547	goto end;
0f113f3e	548	}
2234212c	549	if (key != NULL) {
0f113f3e	550	EVP_MD_CTX *ctx;
0a054d2a RL	551	size_t tmplen;
0a054d2a RL	552
0f113f3e	553	BIO_get_md_ctx(bp, &ctx);
0a054d2a RL	554	if (!EVP_DigestSignFinal(ctx, NULL, &tmplen)) {
	555	BIO_printf(bio_err, "Error Signing Data\n");
	556	ERR_print_errors(bio_err);
	557	goto end;
	558	}
	559	if (tmplen > BUFSIZE) {
	560	len = tmplen;
7c2d95d4 PK	561	sigbuf = app_malloc(len, "Signature buffer");
	562	buf = sigbuf;
	563	}
0f113f3e MC	564	if (!EVP_DigestSignFinal(ctx, buf, &len)) {
	565	BIO_printf(bio_err, "Error Signing Data\n");
	566	ERR_print_errors(bio_err);
7c2d95d4	567	goto end;
0f113f3e MC	568	}
	569	} else {
	570	len = BIO_gets(bp, (char *)buf, BUFSIZE);
	571	if ((int)len < 0) {
	572	ERR_print_errors(bio_err);
7c2d95d4	573	goto end;
0f113f3e MC	574	}
	575	}
	576
2234212c	577	if (binout) {
0f113f3e	578	BIO_write(out, buf, len);
2234212c	579	} else if (sep == 2) {
f3448f54 P	580	file = newline_escape_filename(file, &backslash);
	581
	582	if (backslash == 1)
	583	BIO_puts(out, "\\");
	584
0f113f3e MC	585	for (i = 0; i < (int)len; i++)
0f113f3e MC	586	BIO_printf(out, "%02x", buf[i]);
f3448f54	587
0f113f3e	588	BIO_printf(out, " *%s\n", file);
f3448f54	589	OPENSSL_free((char *)file);
0f113f3e	590	} else {
2234212c	591	if (sig_name != NULL) {
0f113f3e	592	BIO_puts(out, sig_name);
2234212c	593	if (md_name != NULL)
0f113f3e MC	594	BIO_printf(out, "-%s", md_name);
0f113f3e MC	595	BIO_printf(out, "(%s)= ", file);
2234212c	596	} else if (md_name != NULL) {
0f113f3e	597	BIO_printf(out, "%s(%s)= ", md_name, file);
2234212c	598	} else {
0f113f3e	599	BIO_printf(out, "(%s)= ", file);
2234212c	600	}
0f113f3e MC	601	for (i = 0; i < (int)len; i++) {
	602	if (sep && (i != 0))
	603	BIO_printf(out, ":");
	604	BIO_printf(out, "%02x", buf[i]);
	605	}
	606	BIO_printf(out, "\n");
	607	}
7c2d95d4 PK	608
	609	ret = 0;
	610	end:
	611	if (sigbuf != NULL)
	612	OPENSSL_clear_free(sigbuf, len);
	613
	614	return ret;
0f113f3e	615	}