diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-02-15 14:57:32 +0100 |
---|---|---|
committer | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-02-17 07:43:58 +0100 |
commit | 31b28ad96aa841ae39d4009ebb15d90f2a2afdab (patch) | |
tree | 1c35d270dec05defdb07028911a67dbba82fe65c /doc | |
parent | 235595c402bd7815f07f1f3f3babe9fcc247a206 (diff) | |
download | openssl-31b28ad96aa841ae39d4009ebb15d90f2a2afdab.zip openssl-31b28ad96aa841ae39d4009ebb15d90f2a2afdab.tar.gz openssl-31b28ad96aa841ae39d4009ebb15d90f2a2afdab.tar.bz2 |
chunk 7 of CMP contribution to OpenSSL
add CMP message validation and related tests; while doing so:
* add ERR_add_error_mem_bio() to crypto/err/err_prn.c
* move ossl_cmp_add_error_txt() as ERR_add_error_txt() to crypto/err/err_prn.c
* add X509_STORE_CTX_print_verify_cb() to crypto/x509/t_x509.c,
adding internally x509_print_ex_brief(), print_certs(), and print_store_certs()
* move {ossl_cmp_,}X509_STORE_get1_certs() to crypto/x509/x509_lu.c
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Bernd Edlinger <bernd.edlinger@hotmail.de>
(Merged from https://github.com/openssl/openssl/pull/10620)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/internal/man3/ossl_cmp_print_log.pod | 19 | ||||
-rw-r--r-- | doc/man3/ERR_put_error.pod | 31 | ||||
-rw-r--r-- | doc/man3/OSSL_CMP_validate_msg.pod | 86 | ||||
-rw-r--r-- | doc/man3/X509_STORE_CTX_set_verify_cb.pod | 14 | ||||
-rw-r--r-- | doc/man3/X509_STORE_get0_param.pod | 12 |
5 files changed, 142 insertions, 20 deletions
diff --git a/doc/internal/man3/ossl_cmp_print_log.pod b/doc/internal/man3/ossl_cmp_print_log.pod index a45897a..47d4dd8 100644 --- a/doc/internal/man3/ossl_cmp_print_log.pod +++ b/doc/internal/man3/ossl_cmp_print_log.pod @@ -14,7 +14,6 @@ ossl_cmp_log2, ossl_cmp_log3, ossl_cmp_log4, ossl_cmp_log_parse_metadata, -ossl_cmp_add_error_txt, ossl_cmp_add_error_data, ossl_cmp_add_error_line - logging and error reporting support for CMP @@ -40,7 +39,6 @@ ossl_cmp_add_error_line OSSL_CMP_severity *level, char **func, char **file, int *line); - void ossl_cmp_add_error_txt(const char *separator, const char *txt); #define ossl_cmp_add_error_data(txt) #define ossl_cmp_add_error_line(txt) @@ -72,17 +70,11 @@ the variable pointed to by I<file> with the filename string or NULL, and the variable pointed to by I<line> with the line number or -1. Any string returned via I<*func> and I<*file> must be freeed by the caller. -ossl_cmp_add_error_txt() appends text to the extra data field of the last -error message in the OpenSSL error queue, after adding the optional separator -unless data has been empty so far. The text can be of arbitrary length, -which is not possible when using L<ERR_add_error_data(3)> in conjunction with -L<ERR_print_errors_cb(3)>. - ossl_cmp_add_error_data() is a macro calling -ossl_cmp_add_error_txt() with the separator being ":". +L<ERR_add_error_txt(3)> with the separator being ":". ossl_cmp_add_error_line() is a macro calling -ossl_cmp_add_error_txt() with the separator being "\n". +L<ERR_add_error_txt(3)> with the separator being "\n". =head1 RETURN VALUES @@ -90,13 +82,16 @@ ossl_cmp_log_parse_metadata() returns the pointer to the actual message text after the OSSL_CMP_LOG_PREFIX and level and ':' if found in the buffer, else the beginning of the buffer. -ossl_cmp_add_error_txt() -ossl_cmp_add_error_data(), and +ossl_cmp_add_error_data() and ossl_cmp_add_error_line() do not return anything. All other functions return 1 on success, 0 on error. +=head1 SEE ALSO + +L<ERR_add_error_txt(3)> + =head1 HISTORY The OpenSSL CMP support was added in OpenSSL 3.0. diff --git a/doc/man3/ERR_put_error.pod b/doc/man3/ERR_put_error.pod index e3c19bf..85538f7 100644 --- a/doc/man3/ERR_put_error.pod +++ b/doc/man3/ERR_put_error.pod @@ -3,7 +3,8 @@ =head1 NAME ERR_raise, ERR_raise_data, -ERR_put_error, ERR_add_error_data, ERR_add_error_vdata +ERR_put_error, ERR_add_error_data, ERR_add_error_vdata, +ERR_add_error_txt, ERR_add_error_mem_bio - record an error =head1 SYNOPSIS @@ -15,6 +16,8 @@ ERR_put_error, ERR_add_error_data, ERR_add_error_vdata void ERR_add_error_data(int num, ...); void ERR_add_error_vdata(int num, va_list arg); + void ERR_add_error_txt(const char *sep, const char *txt); + void ERR_add_error_mem_bio(const char *sep, BIO *bio); Deprecated since OpenSSL 3.0: @@ -38,9 +41,23 @@ B<func> of library B<lib>, in line number B<line> of B<file>. This function is usually called by a macro. ERR_add_error_data() associates the concatenation of its B<num> string -arguments with the error code added last. +arguments as additional data with the error code added last. ERR_add_error_vdata() is similar except the argument is a B<va_list>. Multiple calls to these functions append to the current top of the error queue. +The total length of the string data per error is limited to 4096 characters. + +ERR_add_error_txt() appends the given text string as additional data to the +last error queue entry, after inserting the optional separator string if it is +not NULL and the top error entry does not yet have additional data. +In case the separator is at the end of the text it is not appended to the data. +The B<sep> argument may be for instance "\n" to insert a line break when needed. +If the associated data would become more than 4096 characters long +(which is the limit given above) +it is split over sufficiently many new copies of the last error queue entry. + +ERR_add_error_mem_bio() is the same as ERR_add_error_txt() except that +the text string is taken from the given memory BIO. +It appends '\0' to the BIO contents if not already NUL-terminated. L<ERR_load_strings(3)> can be used to register error strings so that the application can a generate human-readable @@ -76,8 +93,10 @@ the ASN1err() macro. =head1 RETURN VALUES -ERR_raise(), ERR_put_error(), ERR_add_error_data() and -ERR_add_error_vdata() return no values. +ERR_raise(), ERR_put_error(), +ERR_add_error_data(), ERR_add_error_vdata() +ERR_add_error_txt(), and ERR_add_error_mem_bio() +return no values. =head1 NOTES @@ -87,6 +106,10 @@ ERR_raise() and ERR_put_error() are implemented as macros. L<ERR_load_strings(3)> +=head1 HISTORY + +B<ERR_add_error_txt> and B<ERR_add_error_mem_bio> were added in OpenSSL 3.0. + =head1 COPYRIGHT Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved. diff --git a/doc/man3/OSSL_CMP_validate_msg.pod b/doc/man3/OSSL_CMP_validate_msg.pod new file mode 100644 index 0000000..acb17fa --- /dev/null +++ b/doc/man3/OSSL_CMP_validate_msg.pod @@ -0,0 +1,86 @@ +=pod + +=head1 NAME + +OSSL_CMP_validate_msg, +OSSL_CMP_validate_cert_path +- functions for verifying CMP message protection + +=head1 SYNOPSIS + + #include <openssl/cmp.h> + int OSSL_CMP_validate_msg(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg); + int OSSL_CMP_validate_cert_path(const OSSL_CMP_CTX *ctx, + X509_STORE *trusted_store, X509 *cert); + +=head1 DESCRIPTION + +This is the API for validating the protection of CMP messages, +which includes validating CMP message sender certificates and their paths +while optionally checking the revocation status of the certificates(s). + +OSSL_CMP_validate_msg() validates the protection of the given C<msg> +using either password-based mac (PBM) or a signature algorithm. + +In case of signature algorithm, the certificate to use for the signature check +is preferably the one provided by a call to L<OSSL_CMP_CTX_set1_srvCert(3)>. +If no such sender cert has been pinned then candidate sender certificates are +taken from the list of certificates received in the C<msg> extraCerts, then any +certificates provided before via L<OSSL_CMP_CTX_set1_untrusted_certs(3)>, and +then all trusted certificates provided via L<OSSL_CMP_CTX_set0_trustedStore(3)>, +where a candidate is acceptable only if has not expired, its subject DN matches +the C<msg> sender DN (as far as present), and its subject key identifier +is present and matches the senderKID (as far as the latter present). +Each acceptable cert is tried in the given order to see if the message +signature check succeeds and the cert and its path can be verified +using any trust store set via L<OSSL_CMP_CTX_set0_trustedStore(3)>. + +If the option OSSL_CMP_OPT_PERMIT_TA_IN_EXTRACERTS_FOR_IR was set by calling +L<OSSL_CMP_CTX_set_option(3)>, for an Initialization Response (IP) message +any self-issued certificate from the C<msg> extraCerts field may also be used +as trust anchor for the path verification of an acceptable cert if it can be +used also to validate the issued certificate returned in the IP message. This is +according to TS 33.310 [Network Domain Security (NDS); Authentication Framework +(AF)] document specified by the The 3rd Generation Partnership Project (3GPP). + +Any cert that has been found as described above is cached and tried first when +validating the signatures of subsequent messages in the same transaction. + +After successful validation of PBM-based protection of a certificate response +the certificates in the caPubs field (if any) are added to the trusted +certificates provided via L<OSSL_CMP_CTX_set0_trustedStore(3)>, such that +they are available for validating subsequent messages in the same context. +Those could apply to any Polling Response (pollRep), error, or PKI Confirmation +(PKIConf) messages following in the same or future transactions. + +OSSL_CMP_validate_cert_path() attempts to validate the given certificate and its +path using the given store of trusted certs (possibly including CRLs and a cert +verification callback) and non-trusted intermediate certs from the B<ctx>. + +=head1 NOTES + +CMP is defined in RFC 4210 (and CRMF in RFC 4211). + +=head1 RETURN VALUES + +OSSL_CMP_validate_msg() and OSSL_CMP_validate_cert_path() +return 1 on success, 0 on error or validation failed. + +=head1 SEE ALSO + +L<OSSL_CMP_CTX_new(3)>, L<OSSL_CMP_exec_IR_ses(3)> + +=head1 HISTORY + +The OpenSSL CMP support was added in OpenSSL 3.0. + +=head1 COPYRIGHT + +Copyright 2007-2019 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 +L<https://www.openssl.org/source/license.html>. + +=cut diff --git a/doc/man3/X509_STORE_CTX_set_verify_cb.pod b/doc/man3/X509_STORE_CTX_set_verify_cb.pod index 64ccefa..c53b14d 100644 --- a/doc/man3/X509_STORE_CTX_set_verify_cb.pod +++ b/doc/man3/X509_STORE_CTX_set_verify_cb.pod @@ -14,14 +14,16 @@ X509_STORE_CTX_get_check_issued, X509_STORE_CTX_get_get_issuer, X509_STORE_CTX_get_verify_cb, X509_STORE_CTX_set_verify_cb, -X509_STORE_CTX_verify_cb -- get and set verification callback +X509_STORE_CTX_verify_cb, +X509_STORE_CTX_print_verify_cb +- get and set X509_STORE_CTX components such as verification callback =head1 SYNOPSIS #include <openssl/x509_vfy.h> typedef int (*X509_STORE_CTX_verify_cb)(int, X509_STORE_CTX *); + int X509_STORE_CTX_print_verify_cb(int ok, X509_STORE_CTX *ctx); X509_STORE_CTX_verify_cb X509_STORE_CTX_get_verify_cb(X509_STORE_CTX *ctx); @@ -63,6 +65,12 @@ structure and receive additional information about the error, for example by calling X509_STORE_CTX_get_current_cert(). Additional application data can be passed to the callback via the B<ex_data> mechanism. +X509_STORE_CTX_print_verify_cb() is a verification callback function that, +when a certificate verification has failed, adds an entry to the error queue +with code B<X509_R_CERTIFICATE_VERIFICATION_FAILED> and with diagnostic details, +including the most relevant fields of the target certificate that failed to +verify and, if appropriate, of the available untrusted and trusted certificates. + X509_STORE_CTX_get_verify_cb() returns the value of the current callback for the specific B<ctx>. @@ -200,6 +208,8 @@ X509_STORE_CTX_get_cert_crl(), X509_STORE_CTX_get_check_policy(), X509_STORE_CTX_get_lookup_certs(), X509_STORE_CTX_get_lookup_crls() and X509_STORE_CTX_get_cleanup() functions were added in OpenSSL 1.1.0. +X509_STORE_CTX_print_verify_cb() was added in OpenSSL 3.0. + =head1 COPYRIGHT Copyright 2009-2016 The OpenSSL Project Authors. All Rights Reserved. diff --git a/doc/man3/X509_STORE_get0_param.pod b/doc/man3/X509_STORE_get0_param.pod index 27fe786..6db760e 100644 --- a/doc/man3/X509_STORE_get0_param.pod +++ b/doc/man3/X509_STORE_get0_param.pod @@ -3,7 +3,8 @@ =head1 NAME X509_STORE_get0_param, X509_STORE_set1_param, -X509_STORE_get0_objects - X509_STORE setter and getter functions +X509_STORE_get0_objects, X509_STORE_get1_all_certs +- X509_STORE setter and getter functions =head1 SYNOPSIS @@ -12,6 +13,7 @@ X509_STORE_get0_objects - X509_STORE setter and getter functions X509_VERIFY_PARAM *X509_STORE_get0_param(X509_STORE *ctx); int X509_STORE_set1_param(X509_STORE *ctx, X509_VERIFY_PARAM *pm); STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(X509_STORE *ctx); + STACK_OF(X509) *X509_STORE_get1_all_certs(X509_STORE *st); =head1 DESCRIPTION @@ -22,10 +24,12 @@ X509_STORE_get0_param() retrieves an internal pointer to the verification parameters for B<ctx>. The returned pointer must not be freed by the calling application -X509_STORE_get0_objects() retrieve an internal pointer to the store's +X509_STORE_get0_objects() retrieves an internal pointer to the store's X509 object cache. The cache contains B<X509> and B<X509_CRL> objects. The returned pointer must not be freed by the calling application. +X509_STORE_get1_all_certs() returns a list of all certificates in the store. +The caller is responsible for freeing the returned list. =head1 RETURN VALUES @@ -36,6 +40,9 @@ X509_STORE_set1_param() returns 1 for success and 0 for failure. X509_STORE_get0_objects() returns a pointer to a stack of B<X509_OBJECT>. +X509_STORE_get1_all_certs() returns a pointer to a stack of the retrieved +certificates on success, else NULL. + =head1 SEE ALSO L<X509_STORE_new(3)> @@ -44,6 +51,7 @@ L<X509_STORE_new(3)> B<X509_STORE_get0_param> and B<X509_STORE_get0_objects> were added in OpenSSL 1.1.0. +B<X509_STORE_get1_certs> was added in OpenSSL 3.0. =head1 COPYRIGHT |