[openssl] master update
Matt Caswell
matt at openssl.org
Thu Jan 27 15:44:34 UTC 2022
The branch master has been updated
via 7b75b973fbd9087714daa19e07bb92b2101eba28 (commit)
via 8447f2e3912c810a02ed1c8641db27ff70ded5ba (commit)
via 4aa82850267defd772ddf74a88d515ef4fb566b8 (commit)
from 2ce0a3d19005271e7e3c351b562d9da93e2d4c80 (commit)
- Log -----------------------------------------------------------------
commit 7b75b973fbd9087714daa19e07bb92b2101eba28
Author: Matt Caswell <matt at openssl.org>
Date: Thu Jan 13 15:16:39 2022 +0000
Document purpose and trust setting functions
In particular:
X509_STORE_CTX_set_purpose()
X509_STORE_CTX_set_trust();
X509_STORE_CTX_purpose_inherit();
Reviewed-by: Ben Kaduk <kaduk at mit.edu>
(Merged from https://github.com/openssl/openssl/pull/17382)
commit 8447f2e3912c810a02ed1c8641db27ff70ded5ba
Author: Matt Caswell <matt at openssl.org>
Date: Thu Dec 30 16:38:28 2021 +0000
Add a test for X509_STORE_CTX_set_purpose()
This function was previously incorrectly failing if it is called with
X509_PURPOSE_ANY. Add a test to catch this.
Reviewed-by: Ben Kaduk <kaduk at mit.edu>
(Merged from https://github.com/openssl/openssl/pull/17382)
commit 4aa82850267defd772ddf74a88d515ef4fb566b8
Author: Matt Caswell <matt at openssl.org>
Date: Thu Dec 30 16:37:06 2021 +0000
Ensure X509_STORE_CTX_purpose_inherit handles a 0 default purpose
The function X509_STORE_CTX_purpose_inherit() can be called with a 0
default purpose. If the main purpose was set to X509_PURPOSE_ANY this
would case the function to incorrectly return an error response.
Fixes #17367
Reviewed-by: Ben Kaduk <kaduk at mit.edu>
(Merged from https://github.com/openssl/openssl/pull/17382)
-----------------------------------------------------------------------
Summary of changes:
crypto/x509/x509_vfy.c | 11 ++--
doc/man3/X509_STORE_CTX_new.pod | 69 +++++++++++++++++++-
test/recipes/70-test_verify_extra.t | 8 +--
test/verify_extra_test.c | 121 ++++++++++++++++++++++++++++++++----
util/missingcrypto.txt | 3 -
5 files changed, 185 insertions(+), 27 deletions(-)
diff --git a/crypto/x509/x509_vfy.c b/crypto/x509/x509_vfy.c
index 8a7f1ba8e8..817901e6cb 100644
--- a/crypto/x509/x509_vfy.c
+++ b/crypto/x509/x509_vfy.c
@@ -2230,6 +2230,12 @@ int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
/* If purpose not set use default */
if (purpose == 0)
purpose = def_purpose;
+ /*
+ * If purpose is set but we don't have a default then set the default to
+ * the current purpose
+ */
+ else if (def_purpose == 0)
+ def_purpose = purpose;
/* If we have a purpose then check it is valid */
if (purpose != 0) {
X509_PURPOSE *ptmp;
@@ -2242,11 +2248,6 @@ int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
ptmp = X509_PURPOSE_get0(idx);
if (ptmp->trust == X509_TRUST_DEFAULT) {
idx = X509_PURPOSE_get_by_id(def_purpose);
- /*
- * XXX: In the two callers above def_purpose is always 0, which is
- * not a known value, so idx will always be -1. How is the
- * X509_TRUST_DEFAULT case actually supposed to be handled?
- */
if (idx == -1) {
ERR_raise(ERR_LIB_X509, X509_R_UNKNOWN_PURPOSE_ID);
return 0;
diff --git a/doc/man3/X509_STORE_CTX_new.pod b/doc/man3/X509_STORE_CTX_new.pod
index 56a36bfecd..3bf964e802 100644
--- a/doc/man3/X509_STORE_CTX_new.pod
+++ b/doc/man3/X509_STORE_CTX_new.pod
@@ -11,7 +11,10 @@ X509_STORE_CTX_get_num_untrusted,
X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain,
X509_STORE_CTX_set_default,
X509_STORE_CTX_set_verify,
-X509_STORE_CTX_verify_fn
+X509_STORE_CTX_verify_fn,
+X509_STORE_CTX_set_purpose,
+X509_STORE_CTX_set_trust,
+X509_STORE_CTX_purpose_inherit
- X509_STORE_CTX initialisation
=head1 SYNOPSIS
@@ -45,6 +48,11 @@ X509_STORE_CTX_verify_fn
typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
+ int X509_STORE_CTX_set_purpose(X509_STORE_CTX *ctx, int purpose);
+ int X509_STORE_CTX_set_trust(X509_STORE_CTX *ctx, int trust);
+ int X509_STORE_CTX_purpose_inherit(X509_STORE_CTX *ctx, int def_purpose,
+ int purpose, int trust);
+
=head1 DESCRIPTION
These functions initialise an B<X509_STORE_CTX> structure for subsequent use
@@ -155,6 +163,65 @@ following signature:
This function should receive the current X509_STORE_CTX as a parameter and
return 1 on success or 0 on failure.
+X509 certificates may contain information about what purposes keys contained
+within them can be used for. For example "TLS WWW Server Authentication" or
+"Email Protection". This "key usage" information is held internally to the
+certificate itself. In addition the trust store containing trusted certificates
+can declare what purposes we trust different certificates for. This "trust"
+information is not held within the certificate itself but is "meta" information
+held alongside it. This "meta" information is associated with the certificate
+after it is issued and could be determined by a system administrator. For
+example a certificate might declare that it is suitable for use for both
+"TLS WWW Server Authentication" and "TLS Client Authentication", but a system
+administrator might only trust it for the former. An X.509 certificate extension
+exists that can record extended key usage information to supplement the purpose
+information described above. This extended mechanism is arbitrarily extensible
+and not well suited for a generic library API; applications that need to
+validate extended key usage information in certifiates will need to define a
+custom "purpose" (see below) or supply a nondefault verification callback
+(L<X509_STORE_set_verify_cb_func(3)>).
+
+X509_STORE_CTX_set_purpose() sets the purpose for the target certificate being
+verified in the I<ctx>. Built-in available values for the I<purpose> argument
+are B<X509_PURPOSE_SSL_CLIENT>, B<X509_PURPOSE_SSL_SERVER>,
+B<X509_PURPOSE_NS_SSL_SERVER>, B<X509_PURPOSE_SMIME_SIGN>,
+B<X509_PURPOSE_SMIME_ENCRYPT>, B<X509_PURPOSE_CRL_SIGN>, B<X509_PURPOSE_ANY>,
+B<X509_PURPOSE_OCSP_HELPER> and B<X509_PURPOSE_TIMESTAMP_SIGN>. It is also
+possible to create a custom purpose value. Setting a purpose will ensure that
+the key usage declared within certificates in the chain being verified is
+consistent with that purpose as well as, potentially, other checks. Every
+purpose also has an associated default trust value which will also be set at the
+same time. During verification this trust setting will be verified to check it
+is consistent with the trust set by the system administrator for certificates in
+the chain.
+
+X509_STORE_CTX_set_trust() sets the trust value for the target certificate
+being verified in the I<ctx>. Built-in available values for the I<trust>
+argument are B<X509_TRUST_COMPAT>, B<X509_TRUST_SSL_CLIENT>,
+B<X509_TRUST_SSL_SERVER>, B<X509_TRUST_EMAIL>, B<X509_TRUST_OBJECT_SIGN>,
+B<X509_TRUST_OCSP_SIGN>, B<X509_TRUST_OCSP_REQUEST> and B<X509_TRUST_TSA>. It is
+also possible to create a custom trust value. Since X509_STORE_CTX_set_purpose()
+also sets the trust value it is normally sufficient to only call that function.
+If both are called then X509_STORE_CTX_set_trust() should be called after
+X509_STORE_CTX_set_purpose() since the trust setting of the last call will be
+used.
+
+It should not normally be necessary for end user applications to call
+X509_STORE_CTX_purpose_inherit() directly. Typically applications should call
+X509_STORE_CTX_set_purpose() or X509_STORE_CTX_set_trust() instead. Using this
+function it is possible to set the purpose and trust values for the I<ctx> at
+the same time. The I<def_purpose> and I<purpose> arguments can have the same
+purpose values as described for X509_STORE_CTX_set_purpose() above. The I<trust>
+argument can have the same trust values as described in
+X509_STORE_CTX_set_trust() above. Any of the I<def_purpose>, I<purpose> or
+I<trust> values may also have the value 0 to indicate that the supplied
+parameter should be ignored. After calling this function the purpose to be used
+for verification is set from the I<purpose> argument, and the trust is set from
+the I<trust> argument. If I<trust> is 0 then the trust value will be set from
+the default trust value for I<purpose>. If the default trust value for the
+purpose is I<X509_TRUST_DEFAULT> and I<trust> is 0 then the default trust value
+associated with the I<def_purpose> value is used for the trust setting instead.
+
=head1 NOTES
The certificates and CRLs in a store are used internally and should B<not>
diff --git a/test/recipes/70-test_verify_extra.t b/test/recipes/70-test_verify_extra.t
index b4bd013f36..27bd8a58f3 100644
--- a/test/recipes/70-test_verify_extra.t
+++ b/test/recipes/70-test_verify_extra.t
@@ -7,15 +7,11 @@
# https://www.openssl.org/source/license.html
-use OpenSSL::Test qw/:DEFAULT srctop_file/;
+use OpenSSL::Test qw/:DEFAULT srctop_dir/;
setup("test_verify_extra");
plan tests => 1;
ok(run(test(["verify_extra_test",
- srctop_file("test", "certs", "rootCA.pem"),
- srctop_file("test", "certs", "roots.pem"),
- srctop_file("test", "certs", "untrusted.pem"),
- srctop_file("test", "certs", "bad.pem"),
- srctop_file("test", "certs", "sm2-csr.pem")])));
+ srctop_dir("test", "certs")])));
diff --git a/test/verify_extra_test.c b/test/verify_extra_test.c
index d03dc0c71d..4ccf8f0a7f 100644
--- a/test/verify_extra_test.c
+++ b/test/verify_extra_test.c
@@ -12,15 +12,20 @@
#include <openssl/crypto.h>
#include <openssl/bio.h>
#include <openssl/x509.h>
+#include <openssl/x509v3.h>
#include <openssl/pem.h>
#include <openssl/err.h>
#include "testutil.h"
-static const char *root_f;
-static const char *roots_f;
-static const char *untrusted_f;
-static const char *bad_f;
-static const char *req_f;
+static const char *certs_dir;
+static char *root_f = NULL;
+static char *roots_f = NULL;
+static char *untrusted_f = NULL;
+static char *bad_f = NULL;
+static char *req_f = NULL;
+static char *sroot_cert = NULL;
+static char *ca_cert = NULL;
+static char *ee_cert = NULL;
#define load_cert_from_file(file) load_cert_pem(file, NULL)
@@ -99,8 +104,6 @@ static int test_alt_chains_cert_forgery(void)
return ret;
}
-OPT_TEST_DECLARE_USAGE("roots.pem untrusted.pem bad.pem\n")
-
static int test_distinguishing_id(void)
{
X509 *x = NULL;
@@ -219,6 +222,76 @@ static int test_store_ctx(void)
return test_self_signed(bad_f, 0, 0);
}
+static int do_test_purpose(int purpose, int expected)
+{
+ X509 *eecert = load_cert_from_file(ee_cert); /* may result in NULL */
+ X509 *untrcert = load_cert_from_file(ca_cert);
+ X509 *trcert = load_cert_from_file(sroot_cert);
+ STACK_OF(X509) *trusted = sk_X509_new_null();
+ STACK_OF(X509) *untrusted = sk_X509_new_null();
+ X509_STORE_CTX *ctx = X509_STORE_CTX_new();
+ int testresult = 0;
+
+ if (!TEST_ptr(eecert)
+ || !TEST_ptr(untrcert)
+ || !TEST_ptr(trcert)
+ || !TEST_ptr(trusted)
+ || !TEST_ptr(untrusted)
+ || !TEST_ptr(ctx))
+ goto err;
+
+
+ if (!TEST_true(sk_X509_push(trusted, trcert)))
+ goto err;
+ trcert = NULL;
+ if (!TEST_true(sk_X509_push(untrusted, untrcert)))
+ goto err;
+ untrcert = NULL;
+
+ if (!TEST_true(X509_STORE_CTX_init(ctx, NULL, eecert, untrusted)))
+ goto err;
+
+ if (!TEST_true(X509_STORE_CTX_set_purpose(ctx, purpose)))
+ goto err;
+
+ /*
+ * X509_STORE_CTX_set0_trusted_stack() is bady named. Despite the set0 name
+ * we are still responsible for freeing trusted after we have finished with
+ * it.
+ */
+ X509_STORE_CTX_set0_trusted_stack(ctx, trusted);
+
+ if (!TEST_int_eq(X509_verify_cert(ctx), expected))
+ goto err;
+
+ testresult = 1;
+ err:
+ OSSL_STACK_OF_X509_free(trusted);
+ OSSL_STACK_OF_X509_free(untrusted);
+ X509_STORE_CTX_free(ctx);
+ X509_free(eecert);
+ X509_free(untrcert);
+ X509_free(trcert);
+ return testresult;
+}
+
+static int test_purpose_ssl_client(void)
+{
+ return do_test_purpose(X509_PURPOSE_SSL_CLIENT, 0);
+}
+
+static int test_purpose_ssl_server(void)
+{
+ return do_test_purpose(X509_PURPOSE_SSL_SERVER, 1);
+}
+
+static int test_purpose_any(void)
+{
+ return do_test_purpose(X509_PURPOSE_ANY, 1);
+}
+
+OPT_TEST_DECLARE_USAGE("certs-dir\n")
+
int setup_tests(void)
{
if (!test_skip_common_options()) {
@@ -226,13 +299,19 @@ int setup_tests(void)
return 0;
}
- if (!TEST_ptr(root_f = test_get_argument(0))
- || !TEST_ptr(roots_f = test_get_argument(1))
- || !TEST_ptr(untrusted_f = test_get_argument(2))
- || !TEST_ptr(bad_f = test_get_argument(3))
- || !TEST_ptr(req_f = test_get_argument(4)))
+ if (!TEST_ptr(certs_dir = test_get_argument(0)))
return 0;
+ if (!TEST_ptr(root_f = test_mk_file_path(certs_dir, "rootCA.pem"))
+ || !TEST_ptr(roots_f = test_mk_file_path(certs_dir, "roots.pem"))
+ || !TEST_ptr(untrusted_f = test_mk_file_path(certs_dir, "untrusted.pem"))
+ || !TEST_ptr(bad_f = test_mk_file_path(certs_dir, "bad.pem"))
+ || !TEST_ptr(req_f = test_mk_file_path(certs_dir, "sm2-csr.pem"))
+ || !TEST_ptr(sroot_cert = test_mk_file_path(certs_dir, "sroot-cert.pem"))
+ || !TEST_ptr(ca_cert = test_mk_file_path(certs_dir, "ca-cert.pem"))
+ || !TEST_ptr(ee_cert = test_mk_file_path(certs_dir, "ee-cert.pem")))
+ goto err;
+
ADD_TEST(test_alt_chains_cert_forgery);
ADD_TEST(test_store_ctx);
ADD_TEST(test_distinguishing_id);
@@ -240,5 +319,23 @@ int setup_tests(void)
ADD_TEST(test_self_signed_good);
ADD_TEST(test_self_signed_bad);
ADD_TEST(test_self_signed_error);
+ ADD_TEST(test_purpose_ssl_client);
+ ADD_TEST(test_purpose_ssl_server);
+ ADD_TEST(test_purpose_any);
return 1;
+ err:
+ cleanup_tests();
+ return 0;
+}
+
+void cleanup_tests(void)
+{
+ OPENSSL_free(root_f);
+ OPENSSL_free(roots_f);
+ OPENSSL_free(untrusted_f);
+ OPENSSL_free(bad_f);
+ OPENSSL_free(req_f);
+ OPENSSL_free(sroot_cert);
+ OPENSSL_free(ca_cert);
+ OPENSSL_free(ee_cert);
}
diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt
index f883219f6c..b61bdeb880 100644
--- a/util/missingcrypto.txt
+++ b/util/missingcrypto.txt
@@ -1277,13 +1277,10 @@ X509_STORE_CTX_get1_crls(3)
X509_STORE_CTX_get_by_subject(3)
X509_STORE_CTX_get_explicit_policy(3)
X509_STORE_CTX_get_obj_by_subject(3)
-X509_STORE_CTX_purpose_inherit(3)
X509_STORE_CTX_set0_dane(3)
X509_STORE_CTX_set_depth(3)
X509_STORE_CTX_set_flags(3)
-X509_STORE_CTX_set_purpose(3)
X509_STORE_CTX_set_time(3)
-X509_STORE_CTX_set_trust(3)
X509_STORE_get_verify(3)
X509_TRUST_add(3)
X509_TRUST_cleanup(3)
More information about the openssl-commits
mailing list