diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2021-07-22 17:11:15 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2021-07-22 17:11:15 +0000 |
commit | 1125e81c6fdf83d530534ab9e76ab59a2e9c446f (patch) | |
tree | bb2a2a375a4ae8e655f64be52a49d58ee64923c2 /lib | |
parent | 4de38fb7709443431ca96b66a271c8e21e4c3d9c (diff) |
Split the functions operating on the X509_VERIFY_PARAM object out
of X509_STORE_CTX_new(3) because i'm about to document five additional
functions of this kind and the page X509_STORE_CTX_new(3) is growing
unwieldy.
No text change yet, except that i added an introductory sentence
to the beginning of the DESCRIPTION of the new page.
Diffstat (limited to 'lib')
-rw-r--r-- | lib/libcrypto/man/Makefile | 3 | ||||
-rw-r--r-- | lib/libcrypto/man/X509_STORE_CTX_new.3 | 77 | ||||
-rw-r--r-- | lib/libcrypto/man/X509_STORE_CTX_set_flags.3 | 166 |
3 files changed, 172 insertions, 74 deletions
diff --git a/lib/libcrypto/man/Makefile b/lib/libcrypto/man/Makefile index c7375752bb6..fd8655d5b6f 100644 --- a/lib/libcrypto/man/Makefile +++ b/lib/libcrypto/man/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.183 2021/07/20 17:31:32 schwarze Exp $ +# $OpenBSD: Makefile,v 1.184 2021/07/22 17:11:14 schwarze Exp $ .include <bsd.own.mk> @@ -298,6 +298,7 @@ MAN= \ X509_STORE_CTX_get_error.3 \ X509_STORE_CTX_get_ex_new_index.3 \ X509_STORE_CTX_new.3 \ + X509_STORE_CTX_set_flags.3 \ X509_STORE_CTX_set_verify_cb.3 \ X509_STORE_load_locations.3 \ X509_STORE_new.3 \ diff --git a/lib/libcrypto/man/X509_STORE_CTX_new.3 b/lib/libcrypto/man/X509_STORE_CTX_new.3 index 17faeb3f135..d29bcf10fc3 100644 --- a/lib/libcrypto/man/X509_STORE_CTX_new.3 +++ b/lib/libcrypto/man/X509_STORE_CTX_new.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: X509_STORE_CTX_new.3,v 1.21 2021/07/22 14:30:38 schwarze Exp $ +.\" $OpenBSD: X509_STORE_CTX_new.3,v 1.22 2021/07/22 17:11:14 schwarze Exp $ .\" full merge up to: OpenSSL aae41f8c Jun 25 09:47:15 2015 +0100 .\" selective merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 .\" @@ -84,11 +84,7 @@ .Nm X509_STORE_CTX_set_chain , .Nm X509_STORE_CTX_set0_untrusted , .Nm X509_STORE_CTX_get0_untrusted , -.Nm X509_STORE_CTX_set0_crls , -.Nm X509_STORE_CTX_set_flags , -.Nm X509_STORE_CTX_get0_param , -.Nm X509_STORE_CTX_set0_param , -.Nm X509_STORE_CTX_set_default +.Nm X509_STORE_CTX_set0_crls .Nd X509_STORE_CTX initialisation .Sh SYNOPSIS .In openssl/x509_vfy.h @@ -151,25 +147,6 @@ .Fa "X509_STORE_CTX *ctx" .Fa "STACK_OF(X509_CRL) *sk" .Fc -.Ft void -.Fo X509_STORE_CTX_set_flags -.Fa "X509_STORE_CTX *ctx" -.Fa "unsigned long flags" -.Fc -.Ft X509_VERIFY_PARAM * -.Fo X509_STORE_CTX_get0_param -.Fa "X509_STORE_CTX *ctx" -.Fc -.Ft void -.Fo X509_STORE_CTX_set0_param -.Fa "X509_STORE_CTX *ctx" -.Fa "X509_VERIFY_PARAM *param" -.Fc -.Ft int -.Fo X509_STORE_CTX_set_default -.Fa "X509_STORE_CTX *ctx" -.Fa "const char *name" -.Fc .Sh DESCRIPTION These functions initialise an .Vt X509_STORE_CTX @@ -306,33 +283,6 @@ structure. This might be used where additional "useful" CRLs are supplied as part of a protocol, for example in a PKCS#7 structure. .Pp -.Fn X509_STORE_CTX_set_flags -sets the internal verification parameter flags to -.Fa flags . -See -.Xr X509_VERIFY_PARAM_set_flags 3 -for a description of the verification flags. -.Pp -.Fn X509_STORE_CTX_get0_param -retrieves an internal pointer to the verification parameters associated -with -.Fa ctx . -.Pp -.Fn X509_STORE_CTX_set0_param -sets the internal verification parameter pointer to -.Fa param . -After this call -.Fa param -should not be used. -.Pp -.Fn X509_STORE_CTX_set_default -looks up and sets the default verification method to -.Fa name . -This uses the function -.Xr X509_VERIFY_PARAM_lookup 3 -to find an appropriate set of parameters from -.Fa name . -.Pp The certificates and CRLs in a store are used internally and should .Sy not be freed up until after the associated @@ -383,20 +333,11 @@ returns the internal pointer to the set of additional, untrusted certificates or .Dv NULL if no set of additional certificates was provided. -.Pp -.Fn X509_STORE_CTX_get0_param -returns a pointer to an -.Vt X509_VERIFY_PARAM -structure or -.Dv NULL -if an error occurred. -.Pp -.Fn X509_STORE_CTX_set_default -returns 1 for success or 0 if an error occurred. .Sh SEE ALSO .Xr X509_CRL_new 3 , .Xr X509_STORE_CTX_get_error 3 , .Xr X509_STORE_CTX_get_ex_new_index 3 , +.Xr X509_STORE_CTX_set_flags 3 , .Xr X509_STORE_new 3 , .Xr X509_STORE_set1_param 3 , .Xr X509_verify_cert 3 , @@ -417,19 +358,9 @@ first appeared in OpenSSL 0.9.5 and have been available since .Ox 2.7 . .Pp .Fn X509_STORE_CTX_trusted_stack -and -.Fn X509_STORE_CTX_set_flags -first appeared in OpenSSL 0.9.6 and have been available since +first appeared in OpenSSL 0.9.6 and has been available since .Ox 2.9 . .Pp -.Fn X509_STORE_CTX_set0_crls , -.Fn X509_STORE_CTX_get0_param , -.Fn X509_STORE_CTX_set0_param , -and -.Fn X509_STORE_CTX_set_default -first appeared in OpenSSL 0.9.8 and have been available since -.Ox 4.5 . -.Pp .Fn X509_STORE_CTX_get0_store first appeared in OpenSSL 1.0.2. .Fn X509_STORE_CTX_set0_trusted_stack , diff --git a/lib/libcrypto/man/X509_STORE_CTX_set_flags.3 b/lib/libcrypto/man/X509_STORE_CTX_set_flags.3 new file mode 100644 index 00000000000..f15ec5f16fe --- /dev/null +++ b/lib/libcrypto/man/X509_STORE_CTX_set_flags.3 @@ -0,0 +1,166 @@ +.\" $OpenBSD: X509_STORE_CTX_set_flags.3,v 1.1 2021/07/22 17:11:14 schwarze Exp $ +.\" full merge up to: OpenSSL aae41f8c Jun 25 09:47:15 2015 +0100 +.\" selective merge up to: OpenSSL 24a535ea Sep 22 13:14:20 2020 +0100 +.\" +.\" This file is a derived work. +.\" The changes are covered by the following Copyright and license: +.\" +.\" Copyright (c) 2019 Claudio Jeker <claudio@openbsd.org> +.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>. +.\" Copyright (c) 2009 The OpenSSL Project. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in +.\" the documentation and/or other materials provided with the +.\" distribution. +.\" +.\" 3. All advertising materials mentioning features or use of this +.\" software must display the following acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" +.\" +.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to +.\" endorse or promote products derived from this software without +.\" prior written permission. For written permission, please contact +.\" openssl-core@openssl.org. +.\" +.\" 5. Products derived from this software may not be called "OpenSSL" +.\" nor may "OpenSSL" appear in their names without prior written +.\" permission of the OpenSSL Project. +.\" +.\" 6. Redistributions of any form whatsoever must retain the following +.\" acknowledgment: +.\" "This product includes software developed by the OpenSSL Project +.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY +.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR +.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +.\" OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd $Mdocdate: July 22 2021 $ +.Dt X509_STORE_CTX_SET_FLAGS 3 +.Os +.Sh NAME +.Nm X509_STORE_CTX_set_flags , +.Nm X509_STORE_CTX_get0_param , +.Nm X509_STORE_CTX_set0_param , +.Nm X509_STORE_CTX_set_default +.Nd X509_STORE_CTX parameter initialisation +.Sh SYNOPSIS +.In openssl/x509_vfy.h +.Ft void +.Fo X509_STORE_CTX_set_flags +.Fa "X509_STORE_CTX *ctx" +.Fa "unsigned long flags" +.Fc +.Ft X509_VERIFY_PARAM * +.Fo X509_STORE_CTX_get0_param +.Fa "X509_STORE_CTX *ctx" +.Fc +.Ft void +.Fo X509_STORE_CTX_set0_param +.Fa "X509_STORE_CTX *ctx" +.Fa "X509_VERIFY_PARAM *param" +.Fc +.Ft int +.Fo X509_STORE_CTX_set_default +.Fa "X509_STORE_CTX *ctx" +.Fa "const char *name" +.Fc +.Sh DESCRIPTION +These functions operate on the +.Vt X509_VERIFY_PARAM +object used by +.Fa ctx . +Usually, +.Xr X509_STORE_CTX_init 3 +is called on +.Fa ctx +before these functions, and +.Xr X509_verify_cert 3 +afterwards. +.Pp +.Fn X509_STORE_CTX_set_flags +sets the internal verification parameter flags to +.Fa flags . +See +.Xr X509_VERIFY_PARAM_set_flags 3 +for a description of the verification flags. +.Pp +.Fn X509_STORE_CTX_get0_param +retrieves an internal pointer to the verification parameters associated +with +.Fa ctx . +.Pp +.Fn X509_STORE_CTX_set0_param +sets the internal verification parameter pointer to +.Fa param . +After this call +.Fa param +should not be used. +.Pp +.Fn X509_STORE_CTX_set_default +looks up and sets the default verification method to +.Fa name . +This uses the function +.Xr X509_VERIFY_PARAM_lookup 3 +to find an appropriate set of parameters from +.Fa name . +.Sh RETURN VALUES +.Fn X509_STORE_CTX_get0_param +returns a pointer to an +.Vt X509_VERIFY_PARAM +structure or +.Dv NULL +if an error occurred. +.Pp +.Fn X509_STORE_CTX_set_default +returns 1 for success or 0 if an error occurred. +.Sh SEE ALSO +.Xr X509_STORE_CTX_get_error 3 , +.Xr X509_STORE_CTX_new 3 , +.Xr X509_STORE_new 3 , +.Xr X509_STORE_set1_param 3 , +.Xr X509_verify_cert 3 , +.Xr X509_VERIFY_PARAM_set_flags 3 +.Sh HISTORY +.Fn X509_STORE_CTX_set_flags +first appeared in OpenSSL 0.9.6 and has been available since +.Ox 2.9 . +.Pp +.Fn X509_STORE_CTX_get0_param , +.Fn X509_STORE_CTX_set0_param , +and +.Fn X509_STORE_CTX_set_default +first appeared in OpenSSL 0.9.8 and have been available since +.Ox 4.5 . |