secure/lib/libcrypto/man/SSL_CTX_set1_sigalgs.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_SET1_SIGALGS 3"
 132 .TH SSL_CTX_SET1_SIGALGS 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& long SSL_CTX_set1_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
 145 \& long SSL_set1_sigalgs(SSL *ssl, const int *slist, long slistlen);
 146 \& long SSL_CTX_set1_sigalgs_list(SSL_CTX *ctx, const char *str);
 147 \& long SSL_set1_sigalgs_list(SSL *ssl, const char *str);
 148 \&
 149 \& long SSL_CTX_set1_client_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
 150 \& long SSL_set1_client_sigalgs(SSL *ssl, const int *slist, long slistlen);
 151 \& long SSL_CTX_set1_client_sigalgs_list(SSL_CTX *ctx, const char *str);
 152 \& long SSL_set1_client_sigalgs_list(SSL *ssl, const char *str);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_CTX_set1_sigalgs()\fR and \fISSL_set1_sigalgs()\fR set the supported signature
 157 algorithms for \fBctx\fR or \fBssl\fR. The array \fBslist\fR of length \fBslistlen\fR
 158 must consist of pairs of NIDs corresponding to digest and public key
 159 algorithms.
 160 .PP
 161 \&\fISSL_CTX_set1_sigalgs_list()\fR and \fISSL_set1_sigalgs_list()\fR set the supported
 162 signature algorithms for \fBctx\fR or \fBssl\fR. The \fBstr\fR parameter
 163 must be a null terminated string consisting of a colon separated list of
 164 elements, where each element is either a combination of a public key
 165 algorithm and a digest separated by \fB+\fR, or a \s-1TLS 1\s0.3\-style named
 166 SignatureScheme such as rsa_pss_pss_sha256.
 167 .PP
 168 \&\fISSL_CTX_set1_client_sigalgs()\fR, \fISSL_set1_client_sigalgs()\fR,
 169 \&\fISSL_CTX_set1_client_sigalgs_list()\fR and \fISSL_set1_client_sigalgs_list()\fR set
 170 signature algorithms related to client authentication, otherwise they are
 171 identical to \fISSL_CTX_set1_sigalgs()\fR, \fISSL_set1_sigalgs()\fR,
 172 \&\fISSL_CTX_set1_sigalgs_list()\fR and \fISSL_set1_sigalgs_list()\fR.
 173 .PP
 174 All these functions are implemented as macros. The signature algorithm
 175 parameter (integer array or string) is not freed: the application should
 176 free it, if necessary.
 177 .SH "NOTES"
 178 .IX Header "NOTES"
 179 If an application wishes to allow the setting of signature algorithms
 180 as one of many user configurable options it should consider using the more
 181 flexible \s-1SSL_CONF API\s0 instead.
 182 .PP
 183 The signature algorithms set by a client are used directly in the supported
 184 signature algorithm in the client hello message.
 185 .PP
 186 The supported signature algorithms set by a server are not sent to the
 187 client but are used to determine the set of shared signature algorithms
 188 and (if server preferences are set with \s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0)
 189 their order.
 190 .PP
 191 The client authentication signature algorithms set by a server are sent
 192 in a certificate request message if client authentication is enabled,
 193 otherwise they are unused.
 194 .PP
 195 Similarly client authentication signature algorithms set by a client are
 196 used to determined the set of client authentication shared signature
 197 algorithms.
 198 .PP
 199 Signature algorithms will neither be advertised nor used if the security level
 200 prohibits them (for example \s-1SHA1\s0 if the security level is 4 or more).
 201 .PP
 202 Currently the NID_md5, NID_sha1, NID_sha224, NID_sha256, NID_sha384 and
 203 NID_sha512 digest NIDs are supported and the public key algorithm NIDs
 204 \&\s-1EVP_PKEY_RSA, EVP_PKEY_RSA_PSS, EVP_PKEY_DSA\s0 and \s-1EVP_PKEY_EC.\s0
 205 .PP
 206 The short or long name values for digests can be used in a string (for
 207 example \*(L"\s-1MD5\*(R", \*(L"SHA1\*(R", \*(L"SHA224\*(R", \*(L"SHA256\*(R", \*(L"SHA384\*(R", \*(L"SHA512\*(R"\s0) and
 208 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
 209 .PP
 210 The \s-1TLS 1.3\s0 signature scheme names (such as \*(L"rsa_pss_pss_sha256\*(R") can also
 211 be used with the \fB_list\fR forms of the \s-1API.\s0
 212 .PP
 213 The use of \s-1MD5\s0 as a digest is strongly discouraged due to security weaknesses.
 214 .SH "EXAMPLES"
 215 .IX Header "EXAMPLES"
 216 Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
 217 using an array:
 218 .PP
 219 .Vb 1
 220 \& const int slist[] = {NID_sha256, EVP_PKEY_EC, NID_sha256, EVP_PKEY_RSA};
 221 \&
 222 \& SSL_CTX_set1_sigalgs(ctx, slist, 4);
 223 .Ve
 224 .PP
 225 Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
 226 using a string:
 227 .PP
 228 .Vb 1
 229 \& SSL_CTX_set1_sigalgs_list(ctx, "ECDSA+SHA256:RSA+SHA256");
 230 .Ve
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 All these functions return 1 for success and 0 for failure.
 234 .SH "SEE ALSO"
 235 .IX Header "SEE ALSO"
 236 \&\fIssl\fR\|(7), \fISSL_get_shared_sigalgs\fR\|(3),
 237 \&\fISSL_CONF_CTX_new\fR\|(3)
 238 .SH "COPYRIGHT"
 239 .IX Header "COPYRIGHT"
 240 Copyright 2015\-2018 The OpenSSL Project Authors. All Rights Reserved.
 241 .PP
 242 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 243 this file except in compliance with the License.  You can obtain a copy
 244 in the file \s-1LICENSE\s0 in the source distribution or at
 245 <https://www.openssl.org/source/license.html>.