249 lines
9.2 KiB
Groff
Executable File
249 lines
9.2 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.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'
|
|
.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" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" 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 "SSL_CTX_SET1_CURVES 3"
|
|
.TH SSL_CTX_SET1_CURVES 3 "2020-03-02" "3.0.0-dev" "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"
|
|
SSL_CTX_set1_groups, SSL_CTX_set1_groups_list, SSL_set1_groups,
|
|
SSL_set1_groups_list, SSL_get1_groups, SSL_get_shared_group,
|
|
SSL_get_negotiated_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
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& int SSL_CTX_set1_groups(SSL_CTX *ctx, int *glist, int glistlen);
|
|
\& int SSL_CTX_set1_groups_list(SSL_CTX *ctx, char *list);
|
|
\&
|
|
\& int SSL_set1_groups(SSL *ssl, int *glist, int glistlen);
|
|
\& int SSL_set1_groups_list(SSL *ssl, char *list);
|
|
\&
|
|
\& int SSL_get1_groups(SSL *ssl, int *groups);
|
|
\& int SSL_get_shared_group(SSL *s, int n);
|
|
\& int SSL_get_negotiated_group(SSL *s);
|
|
\&
|
|
\& int SSL_CTX_set1_curves(SSL_CTX *ctx, int *clist, int clistlen);
|
|
\& int SSL_CTX_set1_curves_list(SSL_CTX *ctx, char *list);
|
|
\&
|
|
\& int SSL_set1_curves(SSL *ssl, int *clist, int clistlen);
|
|
\& int SSL_set1_curves_list(SSL *ssl, char *list);
|
|
\&
|
|
\& int SSL_get1_curves(SSL *ssl, int *curves);
|
|
\& int SSL_get_shared_curve(SSL *s, int n);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
For all of the functions below that set the supported groups there must be at
|
|
least one group in the list.
|
|
.PP
|
|
\&\fISSL_CTX_set1_groups()\fR sets the supported groups for \fBctx\fR to \fBglistlen\fR
|
|
groups in the array \fBglist\fR. The array consist of all NIDs of groups in
|
|
preference order. For a \s-1TLS\s0 client the groups are used directly in the
|
|
supported groups extension. For a \s-1TLS\s0 server the groups are used to
|
|
determine the set of shared groups. Currently supported groups for
|
|
\&\fBTLSv1.3\fR are \fBNID_X9_62_prime256v1\fR, \fBNID_secp384r1\fR, \fBNID_secp521r1\fR,
|
|
\&\fB\s-1NID_X25519\s0\fR, \fB\s-1NID_X448\s0\fR, \fBNID_ffdhe2048\fR, \fBNID_ffdhe3072\fR,
|
|
\&\fBNID_ffdhe4096\fR, \fBNID_ffdhe6144\fR and \fBNID_ffdhe8192\fR.
|
|
.PP
|
|
\&\fISSL_CTX_set1_groups_list()\fR sets the supported groups for \fBctx\fR to
|
|
string \fBlist\fR. The string is a colon separated list of group NIDs or
|
|
names, for example \*(L"P\-521:P\-384:P\-256:X25519:ffdhe2048\*(R". Currently supported
|
|
groups for \fBTLSv1.3\fR are \fBP\-256\fR, \fBP\-384\fR, \fBP\-521\fR, \fBX25519\fR, \fBX448\fR,
|
|
\&\fBffdhe2048\fR, \fBffdhe3072\fR, \fBffdhe4096\fR, \fBffdhe6144\fR, \fBffdhe8192\fR.
|
|
.PP
|
|
\&\fISSL_set1_groups()\fR and \fISSL_set1_groups_list()\fR are similar except they set
|
|
supported groups for the \s-1SSL\s0 structure \fBssl\fR.
|
|
.PP
|
|
\&\fISSL_get1_groups()\fR returns the set of supported groups sent by a client
|
|
in the supported groups extension. It returns the total number of
|
|
supported groups. The \fBgroups\fR parameter can be \fB\s-1NULL\s0\fR to simply
|
|
return the number of groups for memory allocation purposes. The
|
|
\&\fBgroups\fR array is in the form of a set of group NIDs in preference
|
|
order. It can return zero if the client did not send a supported groups
|
|
extension.
|
|
.PP
|
|
\&\fISSL_get_shared_group()\fR returns shared group \fBn\fR for a server-side
|
|
\&\s-1SSL\s0 \fBssl\fR. If \fBn\fR is \-1 then the total number of shared groups is
|
|
returned, which may be zero. Other than for diagnostic purposes,
|
|
most applications will only be interested in the first shared group
|
|
so \fBn\fR is normally set to zero. If the value \fBn\fR is out of range,
|
|
NID_undef is returned.
|
|
.PP
|
|
\&\fISSL_get_negotiated_group()\fR returns the negotiated group on a TLSv1.3 connection
|
|
for key exchange. This can be called by either client or server.
|
|
.PP
|
|
All these functions are implemented as macros.
|
|
.PP
|
|
The curve functions are synonyms for the equivalently named group functions and
|
|
are identical in every respect. They exist because, prior to \s-1TLS1\s0.3, there was
|
|
only the concept of supported curves. In \s-1TLS1\s0.3 this was renamed to supported
|
|
groups, and extended to include Diffie Hellman groups. The group functions
|
|
should be used in preference.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
If an application wishes to make use of several of these functions for
|
|
configuration purposes either on a command line or in a file it should
|
|
consider using the \s-1SSL_CONF\s0 interface instead of manually parsing options.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fISSL_CTX_set1_groups()\fR, \fISSL_CTX_set1_groups_list()\fR, \fISSL_set1_groups()\fR and
|
|
\&\fISSL_set1_groups_list()\fR, return 1 for success and 0 for failure.
|
|
.PP
|
|
\&\fISSL_get1_groups()\fR returns the number of groups, which may be zero.
|
|
.PP
|
|
\&\fISSL_get_shared_group()\fR returns the \s-1NID\s0 of shared group \fBn\fR or NID_undef if there
|
|
is no shared group \fBn\fR; or the total number of shared groups if \fBn\fR
|
|
is \-1.
|
|
.PP
|
|
When called on a client \fBssl\fR, \fISSL_get_shared_group()\fR has no meaning and
|
|
returns \-1.
|
|
.PP
|
|
\&\fISSL_get_negotiated_group()\fR returns the \s-1NID\s0 of the negotiated group on a
|
|
TLSv1.3 connection for key exchange. Or it returns NID_undef if no negotiated
|
|
group.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7),
|
|
\&\fISSL_CTX_add_extra_chain_cert\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The curve functions were added in OpenSSL 1.0.2. The equivalent group
|
|
functions were added in OpenSSL 1.1.1. The \fISSL_get_negotiated_group()\fR function
|
|
was added in OpenSSL 3.0.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2013\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). 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
|
|
<https://www.openssl.org/source/license.html>.
|