2 * Copyright 1999-2018 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,
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.pem...\n"},
53 {OPT_HELP_STR, 1, '-',
54 " cert.pem... recipient certs for encryption\n"},
56 OPT_SECTION("General"),
57 {"help", OPT_HELP, '-', "Display this summary"},
58 {"in", OPT_IN, '<', "Input file"},
59 {"inform", OPT_INFORM, 'c', "Input format SMIME (default), PEM or DER"},
60 {"out", OPT_OUT, '>', "Output file"},
61 {"outform", OPT_OUTFORM, 'c',
62 "Output format SMIME (default), PEM or DER"},
63 {"inkey", OPT_INKEY, 's',
64 "Input private key (if not signer or recipient)"},
65 {"keyform", OPT_KEYFORM, 'f', "Input private key format (PEM or ENGINE)"},
66 #ifndef OPENSSL_NO_ENGINE
67 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
69 {"stream", OPT_STREAM, '-', "Enable CMS streaming" },
70 {"indef", OPT_INDEF, '-', "Same as -stream" },
71 {"noindef", OPT_NOINDEF, '-', "Disable CMS streaming"},
73 OPT_SECTION("Action"),
74 {"encrypt", OPT_ENCRYPT, '-', "Encrypt message"},
75 {"decrypt", OPT_DECRYPT, '-', "Decrypt encrypted message"},
76 {"sign", OPT_SIGN, '-', "Sign message"},
77 {"resign", OPT_RESIGN, '-', "Resign a signed message"},
78 {"verify", OPT_VERIFY, '-', "Verify signed message"},
80 OPT_SECTION("Signing/Encryption"),
81 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
82 {"md", OPT_MD, 's', "Digest algorithm to use when signing or resigning"},
83 {"", OPT_CIPHER, '-', "Any supported cipher"},
84 {"pk7out", OPT_PK7OUT, '-', "Output PKCS#7 structure"},
85 {"nointern", OPT_NOINTERN, '-',
86 "Don't search certificates in message for signer"},
87 {"nodetach", OPT_NODETACH, '-', "Use opaque signing"},
88 {"noattr", OPT_NOATTR, '-', "Don't include any signed attributes"},
89 {"binary", OPT_BINARY, '-', "Don't translate message to text"},
90 {"signer", OPT_SIGNER, 's', "Signer certificate file"},
91 {"content", OPT_CONTENT, '<',
92 "Supply or override content for detached signature"},
93 {"nocerts", OPT_NOCERTS, '-',
94 "Don't include signers certificate when signing"},
96 OPT_SECTION("Verification/Decryption"),
97 {"nosigs", OPT_NOSIGS, '-', "Don't verify message signature"},
98 {"noverify", OPT_NOVERIFY, '-', "Don't verify signers certificate"},
100 {"certfile", OPT_CERTFILE, '<', "Other certificates file"},
101 {"recip", OPT_RECIP, '<', "Recipient certificate file for decryption"},
103 OPT_SECTION("Email"),
104 {"to", OPT_TO, 's', "To address"},
105 {"from", OPT_FROM, 's', "From address"},
106 {"subject", OPT_SUBJECT, 's', "Subject"},
107 {"text", OPT_TEXT, '-', "Include or delete text MIME headers"},
108 {"nosmimecap", OPT_NOSMIMECAP, '-', "Omit the SMIMECapabilities attribute"},
110 OPT_SECTION("Certificate chain"),
111 {"CApath", OPT_CAPATH, '/', "Trusted certificates directory"},
112 {"CAfile", OPT_CAFILE, '<', "Trusted certificates file"},
113 {"CAstore", OPT_CASTORE, ':', "Trusted certificates store URI"},
114 {"no-CAfile", OPT_NOCAFILE, '-',
115 "Do not load the default certificates file"},
116 {"no-CApath", OPT_NOCAPATH, '-',
117 "Do not load certificates from the default certificates directory"},
118 {"no-CAstore", OPT_NOCASTORE, '-',
119 "Do not load certificates from the default certificates store"},
120 {"nochain", OPT_NOCHAIN, '-',
121 "set PKCS7_NOCHAIN so certificates contained in the message are not used as untrusted CAs" },
122 {"crlfeol", OPT_CRLFEOL, '-', "Use CRLF as EOL termination instead of CR only"},
129 int smime_main(int argc, char **argv)
131 BIO *in = NULL, *out = NULL, *indata = NULL;
132 EVP_PKEY *key = NULL;
134 STACK_OF(OPENSSL_STRING) *sksigners = NULL, *skkeys = NULL;
135 STACK_OF(X509) *encerts = NULL, *other = NULL;
136 X509 *cert = NULL, *recip = NULL, *signer = NULL;
137 X509_STORE *store = NULL;
138 X509_VERIFY_PARAM *vpm = NULL;
139 const EVP_CIPHER *cipher = NULL;
140 const EVP_MD *sign_md = NULL;
141 const char *CAfile = NULL, *CApath = NULL, *CAstore = NULL, *prog = NULL;
142 char *certfile = NULL, *keyfile = NULL, *contfile = NULL;
143 char *infile = NULL, *outfile = NULL, *signerfile = NULL, *recipfile = NULL;
144 char *passinarg = NULL, *passin = NULL, *to = NULL, *from = NULL, *subject = NULL;
146 int noCApath = 0, noCAfile = 0, noCAstore = 0;
147 int flags = PKCS7_DETACHED, operation = 0, ret = 0, indef = 0;
148 int informat = FORMAT_SMIME, outformat = FORMAT_SMIME, keyform =
150 int vpmtouched = 0, rv = 0;
152 const char *mime_eol = "\n";
154 if ((vpm = X509_VERIFY_PARAM_new()) == NULL)
157 prog = opt_init(argc, argv, smime_options);
158 while ((o = opt_next()) != OPT_EOF) {
163 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
166 opt_help(smime_options);
170 if (!opt_format(opt_arg(), OPT_FMT_PDS, &informat))
177 if (!opt_format(opt_arg(), OPT_FMT_PDS, &outformat))
184 operation = SMIME_ENCRYPT;
187 operation = SMIME_DECRYPT;
190 operation = SMIME_SIGN;
193 operation = SMIME_RESIGN;
196 operation = SMIME_VERIFY;
199 operation = SMIME_PK7OUT;
205 flags |= PKCS7_NOINTERN;
208 flags |= PKCS7_NOVERIFY;
211 flags |= PKCS7_NOCHAIN;
214 flags |= PKCS7_NOCERTS;
217 flags |= PKCS7_NOATTR;
220 flags &= ~PKCS7_DETACHED;
223 flags |= PKCS7_NOSMIMECAP;
226 flags |= PKCS7_BINARY;
229 flags |= PKCS7_NOSIGS;
239 flags |= PKCS7_CRLFEOL;
247 e = setup_engine(opt_arg(), 0);
250 passinarg = opt_arg();
262 /* If previous -signer argument add signer to list */
263 if (signerfile != NULL) {
264 if (sksigners == NULL
265 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
267 sk_OPENSSL_STRING_push(sksigners, signerfile);
269 keyfile = signerfile;
271 && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
273 sk_OPENSSL_STRING_push(skkeys, keyfile);
276 signerfile = opt_arg();
279 recipfile = opt_arg();
282 if (!opt_md(opt_arg(), &sign_md))
286 if (!opt_cipher(opt_unknown(), &cipher))
290 /* If previous -inkey argument add signer to list */
291 if (keyfile != NULL) {
292 if (signerfile == NULL) {
294 "%s: Must have -signer before -inkey\n", prog);
297 if (sksigners == NULL
298 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
300 sk_OPENSSL_STRING_push(sksigners, signerfile);
303 && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
305 sk_OPENSSL_STRING_push(skkeys, keyfile);
310 if (!opt_format(opt_arg(), OPT_FMT_ANY, &keyform))
314 certfile = opt_arg();
335 contfile = opt_arg();
338 if (!opt_verify(o, vpm))
344 argc = opt_num_rest();
347 if (!(operation & SMIME_SIGNERS) && (skkeys != NULL || sksigners != NULL)) {
348 BIO_puts(bio_err, "Multiple signers or keys not allowed\n");
352 if (operation & SMIME_SIGNERS) {
353 /* Check to see if any final signer needs to be appended */
354 if (keyfile && !signerfile) {
355 BIO_puts(bio_err, "Illegal -inkey without -signer\n");
358 if (signerfile != NULL) {
359 if (sksigners == NULL
360 && (sksigners = sk_OPENSSL_STRING_new_null()) == NULL)
362 sk_OPENSSL_STRING_push(sksigners, signerfile);
363 if (!skkeys && (skkeys = sk_OPENSSL_STRING_new_null()) == NULL)
366 keyfile = signerfile;
367 sk_OPENSSL_STRING_push(skkeys, keyfile);
369 if (sksigners == NULL) {
370 BIO_printf(bio_err, "No signer certificate specified\n");
375 } else if (operation == SMIME_DECRYPT) {
376 if (recipfile == NULL && keyfile == NULL) {
378 "No recipient certificate or key specified\n");
381 } else if (operation == SMIME_ENCRYPT) {
383 BIO_printf(bio_err, "No recipient(s) certificate(s) specified\n");
386 } else if (!operation) {
390 if (!app_passwd(passinarg, NULL, &passin, NULL)) {
391 BIO_printf(bio_err, "Error getting password\n");
397 if (!(operation & SMIME_SIGNERS))
398 flags &= ~PKCS7_DETACHED;
400 if (!(operation & SMIME_OP)) {
401 if (flags & PKCS7_BINARY)
402 outformat = FORMAT_BINARY;
405 if (!(operation & SMIME_IP)) {
406 if (flags & PKCS7_BINARY)
407 informat = FORMAT_BINARY;
410 if (operation == SMIME_ENCRYPT) {
411 if (cipher == NULL) {
412 #ifndef OPENSSL_NO_DES
413 cipher = EVP_des_ede3_cbc();
415 BIO_printf(bio_err, "No cipher selected\n");
419 encerts = sk_X509_new_null();
422 while (*argv != NULL) {
423 cert = load_cert(*argv, FORMAT_PEM,
424 "recipient certificate file");
427 sk_X509_push(encerts, cert);
433 if (certfile != NULL) {
434 if (!load_certs(certfile, &other, FORMAT_PEM, NULL,
435 "certificate file")) {
436 ERR_print_errors(bio_err);
441 if (recipfile != NULL && (operation == SMIME_DECRYPT)) {
442 if ((recip = load_cert(recipfile, FORMAT_PEM,
443 "recipient certificate file")) == NULL) {
444 ERR_print_errors(bio_err);
449 if (operation == SMIME_DECRYPT) {
452 } else if (operation == SMIME_SIGN) {
454 keyfile = signerfile;
459 if (keyfile != NULL) {
460 key = load_key(keyfile, keyform, 0, passin, e, "signing key file");
465 in = bio_open_default(infile, 'r', informat);
469 if (operation & SMIME_IP) {
470 if (informat == FORMAT_SMIME) {
471 p7 = SMIME_read_PKCS7(in, &indata);
472 } else if (informat == FORMAT_PEM) {
473 p7 = PEM_read_bio_PKCS7(in, NULL, NULL, NULL);
474 } else if (informat == FORMAT_ASN1) {
475 p7 = d2i_PKCS7_bio(in, NULL);
477 BIO_printf(bio_err, "Bad input format for PKCS#7 file\n");
482 BIO_printf(bio_err, "Error reading S/MIME message\n");
485 if (contfile != NULL) {
487 if ((indata = BIO_new_file(contfile, "rb")) == NULL) {
488 BIO_printf(bio_err, "Can't read content file %s\n", contfile);
494 out = bio_open_default(outfile, 'w', outformat);
498 if (operation == SMIME_VERIFY) {
499 if ((store = setup_verify(CAfile, noCAfile, CApath, noCApath,
500 CAstore, noCAstore)) == NULL)
502 X509_STORE_set_verify_cb(store, smime_cb);
504 X509_STORE_set1_param(store, vpm);
509 if (operation == SMIME_ENCRYPT) {
511 flags |= PKCS7_STREAM;
512 p7 = PKCS7_encrypt(encerts, in, cipher, flags);
513 } else if (operation & SMIME_SIGNERS) {
516 * If detached data content we only enable streaming if S/MIME output
519 if (operation == SMIME_SIGN) {
520 if (flags & PKCS7_DETACHED) {
521 if (outformat == FORMAT_SMIME)
522 flags |= PKCS7_STREAM;
524 flags |= PKCS7_STREAM;
526 flags |= PKCS7_PARTIAL;
527 p7 = PKCS7_sign(NULL, NULL, other, in, flags);
530 if (flags & PKCS7_NOCERTS) {
531 for (i = 0; i < sk_X509_num(other); i++) {
532 X509 *x = sk_X509_value(other, i);
533 PKCS7_add_certificate(p7, x);
537 flags |= PKCS7_REUSE_DIGEST;
539 for (i = 0; i < sk_OPENSSL_STRING_num(sksigners); i++) {
540 signerfile = sk_OPENSSL_STRING_value(sksigners, i);
541 keyfile = sk_OPENSSL_STRING_value(skkeys, i);
542 signer = load_cert(signerfile, FORMAT_PEM,
543 "signer certificate");
546 key = load_key(keyfile, keyform, 0, passin, e, "signing key file");
549 if (!PKCS7_sign_add_signer(p7, signer, key, sign_md, flags))
556 /* If not streaming or resigning finalize structure */
557 if ((operation == SMIME_SIGN) && !(flags & PKCS7_STREAM)) {
558 if (!PKCS7_final(p7, in, flags))
564 BIO_printf(bio_err, "Error creating PKCS#7 structure\n");
569 if (operation == SMIME_DECRYPT) {
570 if (!PKCS7_decrypt(p7, key, recip, out, flags)) {
571 BIO_printf(bio_err, "Error decrypting PKCS#7 structure\n");
574 } else if (operation == SMIME_VERIFY) {
575 STACK_OF(X509) *signers;
576 if (PKCS7_verify(p7, other, store, indata, out, flags))
577 BIO_printf(bio_err, "Verification successful\n");
579 BIO_printf(bio_err, "Verification failure\n");
582 signers = PKCS7_get0_signers(p7, other, flags);
583 if (!save_certs(signerfile, signers)) {
584 BIO_printf(bio_err, "Error writing signers to %s\n", signerfile);
588 sk_X509_free(signers);
589 } else if (operation == SMIME_PK7OUT) {
590 PEM_write_bio_PKCS7(out, p7);
593 BIO_printf(out, "To: %s%s", to, mime_eol);
595 BIO_printf(out, "From: %s%s", from, mime_eol);
597 BIO_printf(out, "Subject: %s%s", subject, mime_eol);
598 if (outformat == FORMAT_SMIME) {
599 if (operation == SMIME_RESIGN)
600 rv = SMIME_write_PKCS7(out, p7, indata, flags);
602 rv = SMIME_write_PKCS7(out, p7, in, flags);
603 } else if (outformat == FORMAT_PEM) {
604 rv = PEM_write_bio_PKCS7_stream(out, p7, in, flags);
605 } else if (outformat == FORMAT_ASN1) {
606 rv = i2d_PKCS7_bio_stream(out, p7, in, flags);
608 BIO_printf(bio_err, "Bad output format for PKCS#7 file\n");
612 BIO_printf(bio_err, "Error writing output\n");
620 ERR_print_errors(bio_err);
621 sk_X509_pop_free(encerts, X509_free);
622 sk_X509_pop_free(other, X509_free);
623 X509_VERIFY_PARAM_free(vpm);
624 sk_OPENSSL_STRING_free(sksigners);
625 sk_OPENSSL_STRING_free(skkeys);
626 X509_STORE_free(store);
636 OPENSSL_free(passin);
640 static int save_certs(char *signerfile, STACK_OF(X509) *signers)
645 if (signerfile == NULL)
647 tmp = BIO_new_file(signerfile, "w");
650 for (i = 0; i < sk_X509_num(signers); i++)
651 PEM_write_bio_X509(tmp, sk_X509_value(signers, i));
656 /* Minimal callback just to output policy info (if any) */
658 static int smime_cb(int ok, X509_STORE_CTX *ctx)
662 error = X509_STORE_CTX_get_error(ctx);
664 if ((error != X509_V_ERR_NO_EXPLICIT_POLICY)
665 && ((error != X509_V_OK) || (ok != 2)))