aboutsummaryrefslogtreecommitdiff
path: root/secure/lib/libcrypto/man/man3/EVP_set_default_properties.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/man3/EVP_set_default_properties.3')
-rw-r--r--secure/lib/libcrypto/man/man3/EVP_set_default_properties.3131
1 files changed, 35 insertions, 96 deletions
diff --git a/secure/lib/libcrypto/man/man3/EVP_set_default_properties.3 b/secure/lib/libcrypto/man/man3/EVP_set_default_properties.3
index fd412b94f801..72eb56d45dfe 100644
--- a/secure/lib/libcrypto/man/man3/EVP_set_default_properties.3
+++ b/secure/lib/libcrypto/man/man3/EVP_set_default_properties.3
@@ -1,4 +1,5 @@
-.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -15,29 +16,12 @@
.ft R
.fi
..
-.\" Set up some character translations and predefined strings. \*(-- will
-.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. \*(C+ will
-.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
-.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
-.\" nothing in troff, for use with C<>.
-.tr \(*W-
-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
-. ds -- \(*W-
-. ds PI pi
-. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
-. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
-. ds L" ""
-. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
-. ds -- \|\(em\|
-. ds PI \(*p
-. ds L" ``
-. ds R" ''
. ds C`
. ds C'
'br\}
@@ -68,101 +52,46 @@
. \}
.\}
.rr rF
-.\" Fear. Run. Save yourself. No user-serviceable parts.
-. \" fudge factors for nroff and troff
-.if n \{\
-. ds #H 0
-. ds #V .8m
-. ds #F .3m
-. ds #[ \f1
-. ds #] \fP
-.\}
-.if t \{\
-. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
-. ds #V .6m
-. ds #F 0
-. ds #[ \&
-. ds #] \&
-.\}
-. \" simple accents for nroff and troff
-.if n \{\
-. ds ' \&
-. ds ` \&
-. ds ^ \&
-. ds , \&
-. ds ~ ~
-. ds /
-.\}
-.if t \{\
-. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
-. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
-. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
-. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
-. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
-. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
-.\}
-. \" troff and (daisy-wheel) nroff accents
-.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
-.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
-.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
-.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
-.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
-.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
-.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
-.ds ae a\h'-(\w'a'u*4/10)'e
-.ds Ae A\h'-(\w'A'u*4/10)'E
-. \" corrections for vroff
-.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
-.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
-. \" for low resolution devices (crt and lpr)
-.if \n(.H>23 .if \n(.V>19 \
-\{\
-. ds : e
-. ds 8 ss
-. ds o a
-. ds d- d\h'-1'\(ga
-. ds D- D\h'-1'\(hy
-. ds th \o'bp'
-. ds Th \o'LP'
-. ds ae ae
-. ds Ae AE
-.\}
-.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "EVP_SET_DEFAULT_PROPERTIES 3ossl"
-.TH EVP_SET_DEFAULT_PROPERTIES 3ossl "2023-09-19" "3.0.11" "OpenSSL"
+.TH EVP_SET_DEFAULT_PROPERTIES 3ossl 2025-07-01 3.5.1 OpenSSL
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
-.SH "NAME"
+.SH NAME
EVP_set_default_properties, EVP_default_properties_enable_fips,
-EVP_default_properties_is_fips_enabled
-\&\- Set default properties for future algorithm fetches
-.SH "SYNOPSIS"
+EVP_default_properties_is_fips_enabled, EVP_get1_default_properties
+\&\- manage default properties for future algorithm fetches
+.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/evp.h>
\&
\& int EVP_set_default_properties(OSSL_LIB_CTX *libctx, const char *propq);
+\& char *EVP_get1_default_properties(OSSL_LIB_CTX *libctx);
\& int EVP_default_properties_enable_fips(OSSL_LIB_CTX *libctx, int enable);
\& int EVP_default_properties_is_fips_enabled(OSSL_LIB_CTX *libctx);
.Ve
-.SH "DESCRIPTION"
+.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBEVP_set_default_properties()\fR sets the default properties for all
-future \s-1EVP\s0 algorithm fetches, implicit as well as explicit. See
-\&\*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in \fBcrypto\fR\|(7) for information about implicit and explicit
+future EVP algorithm fetches, implicit as well as explicit. See
+"ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for information about implicit and explicit
fetching.
.PP
EVP_set_default_properties stores the properties given with the string
-\&\fIpropq\fR among the \s-1EVP\s0 data that's been stored in the library context
-given with \fIlibctx\fR (\s-1NULL\s0 signifies the default library context).
+\&\fIpropq\fR among the EVP data that's been stored in the library context
+given with \fIlibctx\fR (NULL signifies the default library context).
.PP
Any previous default property for the specified library context will
be dropped.
.PP
+\&\fBEVP_get1_default_properties()\fR gets the default properties set for all future EVP
+algorithm fetches, implicit as well as explicit, for the specific library
+context.
+.PP
\&\fBEVP_default_properties_enable_fips()\fR sets the 'fips=yes' to be a default property
if \fIenable\fR is non zero, otherwise it clears 'fips' from the default property
query for the given \fIlibctx\fR. It merges the fips default property query with any
@@ -170,11 +99,15 @@ existing query strings that have been set via \fBEVP_set_default_properties()\fR
.PP
\&\fBEVP_default_properties_is_fips_enabled()\fR indicates if 'fips=yes' is a default
property for the given \fIlibctx\fR.
-.SH "NOTES"
+.SH NOTES
.IX Header "NOTES"
\&\fBEVP_set_default_properties()\fR and \fBEVP_default_properties_enable_fips()\fR are not
thread safe. They are intended to be called only during the initialisation
phase of a \fIlibctx\fR.
+.PP
+\&\fBEVP_get1_default_properties()\fR is not thread safe. The application must ensure
+that the context reference is valid and default fetching properties are not
+being modified by a different thread.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBEVP_set_default_properties()\fR and \fBEVP_default_properties_enable_fips()\fR return 1
@@ -183,17 +116,23 @@ failure occurs.
.PP
\&\fBEVP_default_properties_is_fips_enabled()\fR returns 1 if the 'fips=yes' default
property is set for the given \fIlibctx\fR, otherwise it returns 0.
+.PP
+\&\fBEVP_get1_default_properties()\fR returns allocated memory that must be freed by
+\&\fBOPENSSL_free\fR\|(3) on success and NULL on failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBEVP_MD_fetch\fR\|(3)
-.SH "HISTORY"
+.SH HISTORY
.IX Header "HISTORY"
-The functions described here were added in OpenSSL 3.0.
-.SH "COPYRIGHT"
+The functions \fBEVP_set_default_properties()\fR, \fBEVP_default_properties_enable_fips()\fR,
+\&\fBEVP_default_properties_is_fips_enabled()\fR were added in OpenSSL 3.0.
+.PP
+The function \fBEVP_get1_default_properties()\fR was added in OpenSSL 3.5.
+.SH COPYRIGHT
.IX Header "COPYRIGHT"
-Copyright 2019\-2022 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved.
.PP
-Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
+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 \s-1LICENSE\s0 in the source distribution or at
+in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.