| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "EVP_SET_DEFAULT_PROPERTIES 3SSL" |
| 58 |
.TH EVP_SET_DEFAULT_PROPERTIES 3SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
EVP_set_default_properties, EVP_default_properties_enable_fips, |
| 65 |
EVP_default_properties_is_fips_enabled, EVP_get1_default_properties |
| 66 |
\&\- manage default properties for future algorithm fetches |
| 67 |
.SH SYNOPSIS |
| 68 |
.IX Header "SYNOPSIS" |
| 69 |
.Vb 1 |
| 70 |
\& #include <openssl/evp.h> |
| 71 |
\& |
| 72 |
\& int EVP_set_default_properties(OSSL_LIB_CTX *libctx, const char *propq); |
| 73 |
\& char *EVP_get1_default_properties(OSSL_LIB_CTX *libctx); |
| 74 |
\& int EVP_default_properties_enable_fips(OSSL_LIB_CTX *libctx, int enable); |
| 75 |
\& int EVP_default_properties_is_fips_enabled(OSSL_LIB_CTX *libctx); |
| 76 |
.Ve |
| 77 |
.SH DESCRIPTION |
| 78 |
.IX Header "DESCRIPTION" |
| 79 |
\&\fBEVP_set_default_properties()\fR sets the default properties for all |
| 80 |
future EVP algorithm fetches, implicit as well as explicit. See |
| 81 |
"ALGORITHM FETCHING" in \fBcrypto\fR\|(7) for information about implicit and explicit |
| 82 |
fetching. |
| 83 |
.PP |
| 84 |
EVP_set_default_properties stores the properties given with the string |
| 85 |
\&\fIpropq\fR among the EVP data that's been stored in the library context |
| 86 |
given with \fIlibctx\fR (NULL signifies the default library context). |
| 87 |
.PP |
| 88 |
Any previous default property for the specified library context will |
| 89 |
be dropped. |
| 90 |
.PP |
| 91 |
\&\fBEVP_get1_default_properties()\fR gets the default properties set for all future EVP |
| 92 |
algorithm fetches, implicit as well as explicit, for the specific library |
| 93 |
context. |
| 94 |
.PP |
| 95 |
\&\fBEVP_default_properties_enable_fips()\fR sets the 'fips=yes' to be a default property |
| 96 |
if \fIenable\fR is non zero, otherwise it clears 'fips' from the default property |
| 97 |
query for the given \fIlibctx\fR. It merges the fips default property query with any |
| 98 |
existing query strings that have been set via \fBEVP_set_default_properties()\fR. |
| 99 |
.PP |
| 100 |
\&\fBEVP_default_properties_is_fips_enabled()\fR indicates if 'fips=yes' is a default |
| 101 |
property for the given \fIlibctx\fR. |
| 102 |
.SH NOTES |
| 103 |
.IX Header "NOTES" |
| 104 |
\&\fBEVP_set_default_properties()\fR and \fBEVP_default_properties_enable_fips()\fR are not |
| 105 |
thread safe. They are intended to be called only during the initialisation |
| 106 |
phase of a \fIlibctx\fR. |
| 107 |
.PP |
| 108 |
\&\fBEVP_get1_default_properties()\fR is not thread safe. The application must ensure |
| 109 |
that the context reference is valid and default fetching properties are not |
| 110 |
being modified by a different thread. |
| 111 |
.SH "RETURN VALUES" |
| 112 |
.IX Header "RETURN VALUES" |
| 113 |
\&\fBEVP_set_default_properties()\fR and \fBEVP_default_properties_enable_fips()\fR return 1 |
| 114 |
on success, or 0 on failure. An error is placed on the error stack if a |
| 115 |
failure occurs. |
| 116 |
.PP |
| 117 |
\&\fBEVP_default_properties_is_fips_enabled()\fR returns 1 if the 'fips=yes' default |
| 118 |
property is set for the given \fIlibctx\fR, otherwise it returns 0. |
| 119 |
.PP |
| 120 |
\&\fBEVP_get1_default_properties()\fR returns allocated memory that must be freed by |
| 121 |
\&\fBOPENSSL_free\fR\|(3) on success and NULL on failure. |
| 122 |
.SH "SEE ALSO" |
| 123 |
.IX Header "SEE ALSO" |
| 124 |
\&\fBEVP_MD_fetch\fR\|(3) |
| 125 |
.SH HISTORY |
| 126 |
.IX Header "HISTORY" |
| 127 |
The functions \fBEVP_set_default_properties()\fR, \fBEVP_default_properties_enable_fips()\fR, |
| 128 |
\&\fBEVP_default_properties_is_fips_enabled()\fR were added in OpenSSL 3.0. |
| 129 |
.PP |
| 130 |
The function \fBEVP_get1_default_properties()\fR was added in OpenSSL 3.5. |
| 131 |
.SH COPYRIGHT |
| 132 |
.IX Header "COPYRIGHT" |
| 133 |
Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved. |
| 134 |
.PP |
| 135 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 136 |
this file except in compliance with the License. You can obtain a copy |
| 137 |
in the file LICENSE in the source distribution or at |
| 138 |
<https://www.openssl.org/source/license.html>. |