2 * Copyright 1999-2020 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
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
10 /* S/MIME utility function */
16 #include <openssl/crypto.h>
17 #include <openssl/pem.h>
18 #include <openssl/err.h>
19 #include <openssl/x509_vfy.h>
20 #include <openssl/x509v3.h>
22 static int save_certs(char *signerfile, STACK_OF(X509) *signers);
23 static int smime_cb(int ok, X509_STORE_CTX *ctx);
27 #define SMIME_SIGNERS 0x40
28 #define SMIME_ENCRYPT (1 | SMIME_OP)
29 #define SMIME_DECRYPT (2 | SMIME_IP)
30 #define SMIME_SIGN (3 | SMIME_OP | SMIME_SIGNERS)
31 #define SMIME_VERIFY (4 | SMIME_IP)
32 #define SMIME_PK7OUT (5 | SMIME_IP | SMIME_OP)
33 #define SMIME_RESIGN (6 | SMIME_IP | SMIME_OP | SMIME_SIGNERS)
35 typedef enum OPTION_choice {
36 OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
37 OPT_ENCRYPT, OPT_DECRYPT, OPT_SIGN, OPT_RESIGN, OPT_VERIFY,
38 OPT_PK7OUT, OPT_TEXT, OPT_NOINTERN, OPT_NOVERIFY, OPT_NOCHAIN,
39 OPT_NOCERTS, OPT_NOATTR, OPT_NODETACH, OPT_NOSMIMECAP,
40 OPT_BINARY, OPT_NOSIGS, OPT_STREAM, OPT_INDEF, OPT_NOINDEF,
41 OPT_CRLFEOL, OPT_ENGINE, OPT_PASSIN,
42 OPT_TO, OPT_FROM, OPT_SUBJECT, OPT_SIGNER, OPT_RECIP, OPT_MD,
43 OPT_CIPHER, OPT_INKEY, OPT_KEYFORM, OPT_CERTFILE, OPT_CAFILE,
44 OPT_CAPATH, OPT_CASTORE, OPT_NOCAFILE, OPT_NOCAPATH, OPT_NOCASTORE,
45 OPT_R_ENUM, OPT_PROV_ENUM, OPT_CONFIG,
47 OPT_IN, OPT_INFORM, OPT_OUT,
48 OPT_OUTFORM, OPT_CONTENT
51 const OPTIONS smime_options[] = {
52 {OPT_HELP_STR, 1, '-', "Usage: %s [options] [cert...]\n"},
54 OPT_SECTION("General"),
55 {"help", OPT_HELP, '-', "Display this summary"},
56 {"in", OPT_IN, '<', "Input file"},
57 {"inform", OPT_INFORM, 'c', "Input format SMIME (default), PEM or DER"},
58 {"out", OPT_OUT, '>', "Output file"},
59 {"outform", OPT_OUTFORM, 'c',
60 "Output format SMIME (default), PEM or DER"},
61 {"inkey", OPT_INKEY, 's',
62 "Input private key (if not signer or recipient)"},
63 {"keyform", OPT_KEYFORM, 'f', "Input private key format (ENGINE, other values ignored)"},
64 #ifndef OPENSSL_NO_ENGINE
65 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
67 {"stream", OPT_STREAM, '-', "Enable CMS streaming" },
68 {"indef", OPT_INDEF, '-', "Same as -stream" },
69 {"noindef", OPT_NOINDEF, '-', "Disable CMS streaming"},
72 OPT_SECTION("Action"),
73 {"encrypt", OPT_ENCRYPT, '-', "Encrypt message"},
74 {"decrypt", OPT_DECRYPT, '-', "Decrypt encrypted message"},
75 {"sign", OPT_SIGN, '-', "Sign message"},
76 {"resign", OPT_RESIGN, '-', "Resign a signed message"},
77 {"verify", OPT_VERIFY, '-', "Verify signed message"},
79 OPT_SECTION("Signing/Encryption"),
80 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
81 {"md", OPT_MD, 's', "Digest algorithm to use when signing or resigning"},
82 {"", OPT_CIPHER, '-', "Any supported cipher"},
83 {"pk7out", OPT_PK7OUT, '-', "Output PKCS#7 structure"},
84 {"nointern", OPT_NOINTERN, '-',
85 "Don't search certificates in message for signer"},
86 {"nodetach", OPT_NODETACH, '-', "Use opaque signing"},
87 {"noattr", OPT_NOATTR, '-', "Don't include any signed attributes"},
88 {"binary", OPT_BINARY, '-', "Don't translate message to text"},
89 {"signer", OPT_SIGNER, 's', "Signer certificate file"},
90 {"content", OPT_CONTENT, '<',
91 "Supply or override content for detached signature"},
92 {"nocerts", OPT_NOCERTS, '-',
93 "Don't include signers certificate when signing"},
95 OPT_SECTION("Verification/Decryption"),
96 {"nosigs", OPT_NOSIGS, '-', "Don't verify message signature"},
97 {"noverify", OPT_NOVERIFY, '-', "Don't verify signers certificate"},
99 {"certfile", OPT_CERTFILE, '<', "Other certificates file"},
100 {"recip", OPT_RECIP, '<', "Recipient certificate file for decryption"},
102 OPT_SECTION("Email"),
103 {"to", OPT_TO, 's', "To address"},
104 {"from", OPT_FROM, 's', "From address"},
105 {"subject", OPT_SUBJECT, 's', "Subject"},
106 {"text", OPT_TEXT, '-', "Include or delete text MIME headers"},
107 {"nosmimecap", OPT_NOSMIMECAP, '-', "Omit the SMIMECapabilities attribute"},
109 OPT_SECTION("Certificate chain"),
110 {"CApath", OPT_CAPATH, '/', "Trusted certificates directory"},
111 {"CAfile", OPT_CAFILE, '<', "Trusted certificates file"},
112 {"CAstore", OPT_CASTORE, ':', "Trusted certificates store URI"},
113 {"no-CAfile", OPT_NOCAFILE, '-',
114 "Do not load the default certificates file"},
115 {"no-CApath", OPT_NOCAPATH, '-',
116 "Do not load certificates from the default certificates directory"},
117 {"no-CAstore", OPT_NOCASTORE, '-',
118 "Do not load certificates from the default certificates store"},
119 {"nochain", OPT_NOCHAIN, '-',
120 "set PKCS7_NOCHAIN so certificates contained in the message are not used as untrusted CAs" },
121 {"crlfeol", OPT_CRLFEOL, '-', "Use CRLF as EOL termination instead of CR only"},
128 {"cert", 0, 0, "Recipient certs, used when encrypting"},
132 int smime_main(int argc, char **argv)
135 BIO *in = NULL, *out = NULL, *indata = NULL;
136 EVP_PKEY *key = NULL;
138 STACK_OF(OPENSSL_STRING) *sksigners = NULL, *skkeys = NULL;
139 STACK_OF(X509) *encerts = NULL, *other = NULL;
140 X509 *cert = NULL, *recip = NULL, *signer = NULL;
141 X509_STORE *store = NULL;
142 X509_VERIFY_PARAM *vpm = NULL;
143 const EVP_CIPHER *cipher = NULL;
144 const EVP_MD *sign_md = NULL;
145 const char *CAfile = NULL, *CApath = NULL, *CAstore = NULL, *prog = NULL;
146 char *certfile = NULL, *keyfile = NULL, *contfile = NULL;
147 char *infile = NULL, *outfile = NULL, *signerfile = NULL, *recipfile = NULL;
148 char *passinarg = NULL, *passin = NULL, *to = NULL, *from = NULL, *subject = NULL;
150 int noCApath = 0, noCAfile = 0, noCAstore = 0;
151 int flags = PKCS7_DETACHED, operation = 0, ret = 0, indef = 0;
152 int informat = FORMAT_SMIME, outformat = FORMAT_SMIME, keyform =
154 int vpmtouched = 0, rv = 0;
156 const char *mime_eol = "\n";
157 OSSL_LIB_CTX *libctx = app_get0_libctx();
158 const char *propq = app_get0_propq();
160 if ((vpm = X509_VERIFY_PARAM_new()) == NULL)
163 prog = opt_init(argc, argv, smime_options);
164 while ((o = opt_next()) != OPT_EOF) {
169 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
172 opt_help(smime_options);
176 if (!opt_format(opt_arg(), OPT_FMT_PDS, &informat))
183 if (!opt_format(opt_arg(), OPT_FMT_PDS, &outformat))
190 operation = SMIME_ENCRYPT;
193 operation = SMIME_DECRYPT;
196 operation = SMIME_SIGN;
199 operation = SMIME_RESIGN;
202 operation = SMIME_VERIFY;
205 operation = SMIME_PK7OUT;
211 flags |= PKCS7_NOINTERN;
214 flags |= PKCS7_NOVERIFY;
217 flags |= PKCS7_NOCHAIN;
220 flags |= PKCS7_NOCERTS;
223 flags |= PKCS7_NOATTR;
226 flags &= ~PKCS7_DETACHED;
229 flags |= PKCS7_NOSMIMECAP;
232 flags |= PKCS7_BINARY;
235 flags |= PKCS7_NOSIGS;
245 flags |= PKCS7_CRLFEOL;
253 if (!opt_provider(o))
257 conf = app_load_config_modules(opt_arg());
262 e = setup_engine(opt_arg(), 0);
265 passinarg = opt_arg();
277 /* If previous -signer argument add signer to list */
278 if (signerfile != NULL) {
279 if (sksigners == NULL
280 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
282 sk_OPENSSL_STRING_push(sksigners, signerfile);
284 keyfile = signerfile;
286 && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
288 sk_OPENSSL_STRING_push(skkeys, keyfile);
291 signerfile = opt_arg();
294 recipfile = opt_arg();
297 if (!opt_md(opt_arg(), &sign_md))
301 if (!opt_cipher(opt_unknown(), &cipher))
305 /* If previous -inkey argument add signer to list */
306 if (keyfile != NULL) {
307 if (signerfile == NULL) {
309 "%s: Must have -signer before -inkey\n", prog);
312 if (sksigners == NULL
313 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
315 sk_OPENSSL_STRING_push(sksigners, signerfile);
318 && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
320 sk_OPENSSL_STRING_push(skkeys, keyfile);
325 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
329 certfile = opt_arg();
350 contfile = opt_arg();
353 if (!opt_verify(o, vpm))
359 argc = opt_num_rest();
362 if (!(operation & SMIME_SIGNERS) && (skkeys != NULL || sksigners != NULL)) {
363 BIO_puts(bio_err, "Multiple signers or keys not allowed\n");
367 if (operation & SMIME_SIGNERS) {
368 /* Check to see if any final signer needs to be appended */
369 if (keyfile && !signerfile) {
370 BIO_puts(bio_err, "Illegal -inkey without -signer\n");
373 if (signerfile != NULL) {
374 if (sksigners == NULL
375 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
377 sk_OPENSSL_STRING_push(sksigners, signerfile);
378 if (!skkeys && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
381 keyfile = signerfile;
382 sk_OPENSSL_STRING_push(skkeys, keyfile);
384 if (sksigners == NULL) {
385 BIO_printf(bio_err, "No signer certificate specified\n");
390 } else if (operation == SMIME_DECRYPT) {
391 if (recipfile == NULL && keyfile == NULL) {
393 "No recipient certificate or key specified\n");
396 } else if (operation == SMIME_ENCRYPT) {
398 BIO_printf(bio_err, "No recipient(s) certificate(s) specified\n");
401 } else if (!operation) {
405 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
406 BIO_printf(bio_err, "Error getting password\n");
412 if (!(operation & SMIME_SIGNERS))
413 flags &= ~PKCS7_DETACHED;
415 if (!(operation & SMIME_OP)) {
416 if (flags & PKCS7_BINARY)
417 outformat = FORMAT_BINARY;
420 if (!(operation & SMIME_IP)) {
421 if (flags & PKCS7_BINARY)
422 informat = FORMAT_BINARY;
425 if (operation == SMIME_ENCRYPT) {
426 if (cipher == NULL) {
427 #ifndef OPENSSL_NO_DES
428 cipher = EVP_des_ede3_cbc();
430 BIO_printf(bio_err, "No cipher selected\n");
434 encerts = sk_X509_new_null();
437 while (*argv != NULL) {
438 cert = load_cert(*argv, FORMAT_UNDEF,
439 "recipient certificate file");
442 sk_X509_push(encerts, cert);
448 if (certfile != NULL) {
449 if (!load_certs(certfile, &other, NULL, "certificates")) {
450 ERR_print_errors(bio_err);
455 if (recipfile != NULL && (operation == SMIME_DECRYPT)) {
456 if ((recip = load_cert(recipfile, FORMAT_UNDEF,
457 "recipient certificate file")) == NULL) {
458 ERR_print_errors(bio_err);
463 if (operation == SMIME_DECRYPT) {
466 } else if (operation == SMIME_SIGN) {
468 keyfile = signerfile;
473 if (keyfile != NULL) {
474 key = load_key(keyfile, keyform, 0, passin, e, "signing key");
479 * TODO: Remove this when CMS has full support for provider-native
482 if (EVP_PKEY_get0(key) == NULL)
487 in = bio_open_default(infile, 'r', informat);
491 if (operation & SMIME_IP) {
494 p7 = PKCS7_new_ex(libctx, propq);
496 BIO_printf(bio_err, "Error allocating PKCS7 object\n");
499 if (informat == FORMAT_SMIME) {
500 p7_in = SMIME_read_PKCS7_ex(in, &indata, &p7);
501 } else if (informat == FORMAT_PEM) {
502 p7_in = PEM_read_bio_PKCS7(in, &p7, NULL, NULL);
503 } else if (informat == FORMAT_ASN1) {
504 p7_in = d2i_PKCS7_bio(in, &p7);
506 BIO_printf(bio_err, "Bad input format for PKCS#7 file\n");
511 BIO_printf(bio_err, "Error reading S/MIME message\n");
514 if (contfile != NULL) {
516 if ((indata = BIO_new_file(contfile, "rb")) == NULL) {
517 BIO_printf(bio_err, "Can't read content file %s\n", contfile);
523 out = bio_open_default(outfile, 'w', outformat);
527 if (operation == SMIME_VERIFY) {
528 if ((store = setup_verify(CAfile, noCAfile, CApath, noCApath,
529 CAstore, noCAstore)) == NULL)
531 X509_STORE_set_verify_cb(store, smime_cb);
533 X509_STORE_set1_param(store, vpm);
538 if (operation == SMIME_ENCRYPT) {
540 flags |= PKCS7_STREAM;
541 p7 = PKCS7_encrypt_ex(encerts, in, cipher, flags, libctx, propq);
542 } else if (operation & SMIME_SIGNERS) {
545 * If detached data content we only enable streaming if S/MIME output
548 if (operation == SMIME_SIGN) {
549 if (flags & PKCS7_DETACHED) {
550 if (outformat == FORMAT_SMIME)
551 flags |= PKCS7_STREAM;
553 flags |= PKCS7_STREAM;
555 flags |= PKCS7_PARTIAL;
556 p7 = PKCS7_sign_ex(NULL, NULL, other, in, flags, libctx, propq);
559 if (flags & PKCS7_NOCERTS) {
560 for (i = 0; i < sk_X509_num(other); i++) {
561 X509 *x = sk_X509_value(other, i);
562 PKCS7_add_certificate(p7, x);
566 flags |= PKCS7_REUSE_DIGEST;
568 for (i = 0; i < sk_OPENSSL_STRING_num(sksigners); i++) {
569 signerfile = sk_OPENSSL_STRING_value(sksigners, i);
570 keyfile = sk_OPENSSL_STRING_value(skkeys, i);
571 signer = load_cert(signerfile, FORMAT_UNDEF,
572 "signer certificate");
575 key = load_key(keyfile, keyform, 0, passin, e, "signing key");
580 * TODO: Remove this when CMS has full support for provider-native
583 if (EVP_PKEY_get0(key) == NULL)
586 if (!PKCS7_sign_add_signer(p7, signer, key, sign_md, flags))
593 /* If not streaming or resigning finalize structure */
594 if ((operation == SMIME_SIGN) && !(flags & PKCS7_STREAM)) {
595 if (!PKCS7_final(p7, in, flags))
601 BIO_printf(bio_err, "Error creating PKCS#7 structure\n");
606 if (operation == SMIME_DECRYPT) {
607 if (!PKCS7_decrypt(p7, key, recip, out, flags)) {
608 BIO_printf(bio_err, "Error decrypting PKCS#7 structure\n");
611 } else if (operation == SMIME_VERIFY) {
612 STACK_OF(X509) *signers;
613 if (PKCS7_verify(p7, other, store, indata, out, flags))
614 BIO_printf(bio_err, "Verification successful\n");
616 BIO_printf(bio_err, "Verification failure\n");
619 signers = PKCS7_get0_signers(p7, other, flags);
620 if (!save_certs(signerfile, signers)) {
621 BIO_printf(bio_err, "Error writing signers to %s\n", signerfile);
625 sk_X509_free(signers);
626 } else if (operation == SMIME_PK7OUT) {
627 PEM_write_bio_PKCS7(out, p7);
630 BIO_printf(out, "To: %s%s", to, mime_eol);
632 BIO_printf(out, "From: %s%s", from, mime_eol);
634 BIO_printf(out, "Subject: %s%s", subject, mime_eol);
635 if (outformat == FORMAT_SMIME) {
636 if (operation == SMIME_RESIGN)
637 rv = SMIME_write_PKCS7(out, p7, indata, flags);
639 rv = SMIME_write_PKCS7(out, p7, in, flags);
640 } else if (outformat == FORMAT_PEM) {
641 rv = PEM_write_bio_PKCS7_stream(out, p7, in, flags);
642 } else if (outformat == FORMAT_ASN1) {
643 rv = i2d_PKCS7_bio_stream(out, p7, in, flags);
645 BIO_printf(bio_err, "Bad output format for PKCS#7 file\n");
649 BIO_printf(bio_err, "Error writing output\n");
657 ERR_print_errors(bio_err);
658 sk_X509_pop_free(encerts, X509_free);
659 sk_X509_pop_free(other, X509_free);
660 X509_VERIFY_PARAM_free(vpm);
661 sk_OPENSSL_STRING_free(sksigners);
662 sk_OPENSSL_STRING_free(skkeys);
663 X509_STORE_free(store);
673 OPENSSL_free(passin);
678 static int save_certs(char *signerfile, STACK_OF(X509) *signers)
683 if (signerfile == NULL)
685 tmp = BIO_new_file(signerfile, "w");
688 for (i = 0; i < sk_X509_num(signers); i++)
689 PEM_write_bio_X509(tmp, sk_X509_value(signers, i));
694 /* Minimal callback just to output policy info (if any) */
696 static int smime_cb(int ok, X509_STORE_CTX *ctx)
700 error = X509_STORE_CTX_get_error(ctx);
702 if ((error != X509_V_ERR_NO_EXPLICIT_POLICY)
703 && ((error != X509_V_OK) || (ok != 2)))