secure/lib/libcrypto/man/SSL_CTX_set1_curves.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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_CURVES 3"
 136 .TH SSL_CTX_SET1_CURVES 3 "2019-09-10" "1.1.1d" "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_groups, SSL_CTX_set1_groups_list, SSL_set1_groups, SSL_set1_groups_list, SSL_get1_groups, SSL_get_shared_group, SSL_CTX_set1_curves, SSL_CTX_set1_curves_list, SSL_set1_curves, SSL_set1_curves_list, SSL_get1_curves, SSL_get_shared_curve \&\- EC supported curve functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_CTX_set1_groups(SSL_CTX *ctx, int *glist, int glistlen);
 149 \& int SSL_CTX_set1_groups_list(SSL_CTX *ctx, char *list);
 150 \&
 151 \& int SSL_set1_groups(SSL *ssl, int *glist, int glistlen);
 152 \& int SSL_set1_groups_list(SSL *ssl, char *list);
 153 \&
 154 \& int SSL_get1_groups(SSL *ssl, int *groups);
 155 \& int SSL_get_shared_group(SSL *s, int n);
 156 \&
 157 \& int SSL_CTX_set1_curves(SSL_CTX *ctx, int *clist, int clistlen);
 158 \& int SSL_CTX_set1_curves_list(SSL_CTX *ctx, char *list);
 159 \&
 160 \& int SSL_set1_curves(SSL *ssl, int *clist, int clistlen);
 161 \& int SSL_set1_curves_list(SSL *ssl, char *list);
 162 \&
 163 \& int SSL_get1_curves(SSL *ssl, int *curves);
 164 \& int SSL_get_shared_curve(SSL *s, int n);
 165 .Ve
 166 .SH "DESCRIPTION"
 167 .IX Header "DESCRIPTION"
 168 For all of the functions below that set the supported groups there must be at
 169 least one group in the list.
 170 .PP
 171 \&\fBSSL_CTX_set1_groups()\fR sets the supported groups for \fBctx\fR to \fBglistlen\fR
 172 groups in the array \fBglist\fR. The array consist of all NIDs of groups in
 173 preference order. For a \s-1TLS\s0 client the groups are used directly in the
 174 supported groups extension. For a \s-1TLS\s0 server the groups are used to
 175 determine the set of shared groups.
 176 .PP
 177 \&\fBSSL_CTX_set1_groups_list()\fR sets the supported groups for \fBctx\fR to
 178 string \fBlist\fR. The string is a colon separated list of group NIDs or
 179 names, for example \*(L"P\-521:P\-384:P\-256\*(R".
 180 .PP
 181 \&\fBSSL_set1_groups()\fR and \fBSSL_set1_groups_list()\fR are similar except they set
 182 supported groups for the \s-1SSL\s0 structure \fBssl\fR.
 183 .PP
 184 \&\fBSSL_get1_groups()\fR returns the set of supported groups sent by a client
 185 in the supported groups extension. It returns the total number of
 186 supported groups. The \fBgroups\fR parameter can be \fB\s-1NULL\s0\fR to simply
 187 return the number of groups for memory allocation purposes. The
 188 \&\fBgroups\fR array is in the form of a set of group NIDs in preference
 189 order. It can return zero if the client did not send a supported groups
 190 extension.
 191 .PP
 192 \&\fBSSL_get_shared_group()\fR returns shared group \fBn\fR for a server-side
 193 \&\s-1SSL\s0 \fBssl\fR. If \fBn\fR is \-1 then the total number of shared groups is
 194 returned, which may be zero. Other than for diagnostic purposes,
 195 most applications will only be interested in the first shared group
 196 so \fBn\fR is normally set to zero. If the value \fBn\fR is out of range,
 197 NID_undef is returned.
 198 .PP
 199 All these functions are implemented as macros.
 200 .PP
 201 The curve functions are synonyms for the equivalently named group functions and
 202 are identical in every respect. They exist because, prior to \s-1TLS1.3,\s0 there was
 203 only the concept of supported curves. In \s-1TLS1.3\s0 this was renamed to supported
 204 groups, and extended to include Diffie Hellman groups. The group functions
 205 should be used in preference.
 206 .SH "NOTES"
 207 .IX Header "NOTES"
 208 If an application wishes to make use of several of these functions for
 209 configuration purposes either on a command line or in a file it should
 210 consider using the \s-1SSL_CONF\s0 interface instead of manually parsing options.
 211 .SH "RETURN VALUES"
 212 .IX Header "RETURN VALUES"
 213 \&\fBSSL_CTX_set1_groups()\fR, \fBSSL_CTX_set1_groups_list()\fR, \fBSSL_set1_groups()\fR and
 214 \&\fBSSL_set1_groups_list()\fR, return 1 for success and 0 for failure.
 215 .PP
 216 \&\fBSSL_get1_groups()\fR returns the number of groups, which may be zero.
 217 .PP
 218 \&\fBSSL_get_shared_group()\fR returns the \s-1NID\s0 of shared group \fBn\fR or NID_undef if there
 219 is no shared group \fBn\fR; or the total number of shared groups if \fBn\fR
 220 is \-1.
 221 .PP
 222 When called on a client \fBssl\fR, \fBSSL_get_shared_group()\fR has no meaning and
 223 returns \-1.
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fBSSL_CTX_add_extra_chain_cert\fR\|(3)
 227 .SH "HISTORY"
 228 .IX Header "HISTORY"
 229 The curve functions were added in OpenSSL 1.0.2. The equivalent group
 230 functions were added in OpenSSL 1.1.1.
 231 .SH "COPYRIGHT"
 232 .IX Header "COPYRIGHT"
 233 Copyright 2013\-2018 The OpenSSL Project Authors. All Rights Reserved.
 234 .PP
 235 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 236 this file except in compliance with the License.  You can obtain a copy
 237 in the file \s-1LICENSE\s0 in the source distribution or at
 238 <https://www.openssl.org/source/license.html>.