secure/lib/libcrypto/man/man3/SSL_CTX_set1_sigalgs.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "SSL_CTX_SET1_SIGALGS 3"
 136 .TH SSL_CTX_SET1_SIGALGS 3 "2022-05-03" "1.1.1o" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 SSL_CTX_set1_sigalgs, SSL_set1_sigalgs, SSL_CTX_set1_sigalgs_list, SSL_set1_sigalgs_list, SSL_CTX_set1_client_sigalgs, SSL_set1_client_sigalgs, SSL_CTX_set1_client_sigalgs_list, SSL_set1_client_sigalgs_list \- set supported signature algorithms
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& long SSL_CTX_set1_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
 149 \& long SSL_set1_sigalgs(SSL *ssl, const int *slist, long slistlen);
 150 \& long SSL_CTX_set1_sigalgs_list(SSL_CTX *ctx, const char *str);
 151 \& long SSL_set1_sigalgs_list(SSL *ssl, const char *str);
 152 \&
 153 \& long SSL_CTX_set1_client_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
 154 \& long SSL_set1_client_sigalgs(SSL *ssl, const int *slist, long slistlen);
 155 \& long SSL_CTX_set1_client_sigalgs_list(SSL_CTX *ctx, const char *str);
 156 \& long SSL_set1_client_sigalgs_list(SSL *ssl, const char *str);
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 \&\fBSSL_CTX_set1_sigalgs()\fR and \fBSSL_set1_sigalgs()\fR set the supported signature
 161 algorithms for \fBctx\fR or \fBssl\fR. The array \fBslist\fR of length \fBslistlen\fR
 162 must consist of pairs of NIDs corresponding to digest and public key
 163 algorithms.
 164 .PP
 165 \&\fBSSL_CTX_set1_sigalgs_list()\fR and \fBSSL_set1_sigalgs_list()\fR set the supported
 166 signature algorithms for \fBctx\fR or \fBssl\fR. The \fBstr\fR parameter
 167 must be a null terminated string consisting of a colon separated list of
 168 elements, where each element is either a combination of a public key
 169 algorithm and a digest separated by \fB+\fR, or a \s-1TLS 1\s0.3\-style named
 170 SignatureScheme such as rsa_pss_pss_sha256.
 171 .PP
 172 \&\fBSSL_CTX_set1_client_sigalgs()\fR, \fBSSL_set1_client_sigalgs()\fR,
 173 \&\fBSSL_CTX_set1_client_sigalgs_list()\fR and \fBSSL_set1_client_sigalgs_list()\fR set
 174 signature algorithms related to client authentication, otherwise they are
 175 identical to \fBSSL_CTX_set1_sigalgs()\fR, \fBSSL_set1_sigalgs()\fR,
 176 \&\fBSSL_CTX_set1_sigalgs_list()\fR and \fBSSL_set1_sigalgs_list()\fR.
 177 .PP
 178 All these functions are implemented as macros. The signature algorithm
 179 parameter (integer array or string) is not freed: the application should
 180 free it, if necessary.
 181 .SH "NOTES"
 182 .IX Header "NOTES"
 183 If an application wishes to allow the setting of signature algorithms
 184 as one of many user configurable options it should consider using the more
 185 flexible \s-1SSL_CONF API\s0 instead.
 186 .PP
 187 The signature algorithms set by a client are used directly in the supported
 188 signature algorithm in the client hello message.
 189 .PP
 190 The supported signature algorithms set by a server are not sent to the
 191 client but are used to determine the set of shared signature algorithms
 192 and (if server preferences are set with \s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0)
 193 their order.
 194 .PP
 195 The client authentication signature algorithms set by a server are sent
 196 in a certificate request message if client authentication is enabled,
 197 otherwise they are unused.
 198 .PP
 199 Similarly client authentication signature algorithms set by a client are
 200 used to determined the set of client authentication shared signature
 201 algorithms.
 202 .PP
 203 Signature algorithms will neither be advertised nor used if the security level
 204 prohibits them (for example \s-1SHA1\s0 if the security level is 4 or more).
 205 .PP
 206 Currently the NID_md5, NID_sha1, NID_sha224, NID_sha256, NID_sha384 and
 207 NID_sha512 digest NIDs are supported and the public key algorithm NIDs
 208 \&\s-1EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_DSA\s0 and \s-1EVP_PKEY_EC.\s0
 209 .PP
 210 The short or long name values for digests can be used in a string (for
 211 example \*(L"\s-1MD5\*(R", \*(L"SHA1\*(R", \*(L"SHA224\*(R", \*(L"SHA256\*(R", \*(L"SHA384\*(R", \*(L"SHA512\*(R"\s0) and
 212 the public key algorithm strings \*(L"\s-1RSA\*(R",\s0 \*(L"RSA-PSS\*(R", \*(L"\s-1DSA\*(R"\s0 or \*(L"\s-1ECDSA\*(R".\s0
 213 .PP
 214 The \s-1TLS 1.3\s0 signature scheme names (such as \*(L"rsa_pss_pss_sha256\*(R") can also
 215 be used with the \fB_list\fR forms of the \s-1API.\s0
 216 .PP
 217 The use of \s-1MD5\s0 as a digest is strongly discouraged due to security weaknesses.
 218 .SH "RETURN VALUES"
 219 .IX Header "RETURN VALUES"
 220 All these functions return 1 for success and 0 for failure.
 221 .SH "EXAMPLES"
 222 .IX Header "EXAMPLES"
 223 Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
 224 using an array:
 225 .PP
 226 .Vb 1
 227 \& const int slist[] = {NID_sha256, EVP_PKEY_EC, NID_sha256, EVP_PKEY_RSA};
 228 \&
 229 \& SSL_CTX_set1_sigalgs(ctx, slist, 4);
 230 .Ve
 231 .PP
 232 Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
 233 using a string:
 234 .PP
 235 .Vb 1
 236 \& SSL_CTX_set1_sigalgs_list(ctx, "ECDSA+SHA256:RSA+SHA256");
 237 .Ve
 238 .SH "SEE ALSO"
 239 .IX Header "SEE ALSO"
 240 \&\fBssl\fR\|(7), \fBSSL_get_shared_sigalgs\fR\|(3),
 241 \&\fBSSL_CONF_CTX_new\fR\|(3)
 242 .SH "COPYRIGHT"
 243 .IX Header "COPYRIGHT"
 244 Copyright 2015\-2019 The OpenSSL Project Authors. All Rights Reserved.
 245 .PP
 246 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 247 this file except in compliance with the License.  You can obtain a copy
 248 in the file \s-1LICENSE\s0 in the source distribution or at
 249 <https://www.openssl.org/source/license.html>.