13b1c0e44a37421e3d505a9c87bc1656d739796a
[openssl.git] / doc / man3 / SSL_CTX_set1_curves.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set1_groups, SSL_CTX_set1_groups_list, SSL_set1_groups,
6 SSL_set1_groups_list, SSL_get1_groups, SSL_get_shared_group,
7 SSL_get_negotiated_group, SSL_CTX_set1_curves, SSL_CTX_set1_curves_list,
8 SSL_set1_curves, SSL_set1_curves_list, SSL_get1_curves, SSL_get_shared_curve
9 - EC supported curve functions
10
11 =head1 SYNOPSIS
12
13  #include <openssl/ssl.h>
14
15  int SSL_CTX_set1_groups(SSL_CTX *ctx, int *glist, int glistlen);
16  int SSL_CTX_set1_groups_list(SSL_CTX *ctx, char *list);
17
18  int SSL_set1_groups(SSL *ssl, int *glist, int glistlen);
19  int SSL_set1_groups_list(SSL *ssl, char *list);
20
21  int SSL_get1_groups(SSL *ssl, int *groups);
22  int SSL_get_shared_group(SSL *s, int n);
23  int SSL_get_negotiated_group(SSL *s);
24
25  int SSL_CTX_set1_curves(SSL_CTX *ctx, int *clist, int clistlen);
26  int SSL_CTX_set1_curves_list(SSL_CTX *ctx, char *list);
27
28  int SSL_set1_curves(SSL *ssl, int *clist, int clistlen);
29  int SSL_set1_curves_list(SSL *ssl, char *list);
30
31  int SSL_get1_curves(SSL *ssl, int *curves);
32  int SSL_get_shared_curve(SSL *s, int n);
33
34 =head1 DESCRIPTION
35
36 For all of the functions below that set the supported groups there must be at
37 least one group in the list.
38
39 SSL_CTX_set1_groups() sets the supported groups for B<ctx> to B<glistlen>
40 groups in the array B<glist>. The array consist of all NIDs of groups in
41 preference order. For a TLS client the groups are used directly in the
42 supported groups extension. For a TLS server the groups are used to
43 determine the set of shared groups. Currently supported groups for
44 B<TLSv1.3> are B<NID_X9_62_prime256v1>, B<NID_secp384r1>, B<NID_secp521r1>,
45 B<NID_X25519>, B<NID_X448>, B<NID_ffdhe2048>, B<NID_ffdhe3072>,
46 B<NID_ffdhe4096>, B<NID_ffdhe6144> and B<NID_ffdhe8192>.
47
48 SSL_CTX_set1_groups_list() sets the supported groups for B<ctx> to
49 string B<list>. The string is a colon separated list of group NIDs or
50 names, for example "P-521:P-384:P-256:X25519:ffdhe2048". Currently supported
51 groups for B<TLSv1.3> are B<P-256>, B<P-384>, B<P-521>, B<X25519>, B<X448>,
52 B<ffdhe2048>, B<ffdhe3072>, B<ffdhe4096>, B<ffdhe6144>, B<ffdhe8192>.
53
54 SSL_set1_groups() and SSL_set1_groups_list() are similar except they set
55 supported groups for the SSL structure B<ssl>.
56
57 SSL_get1_groups() returns the set of supported groups sent by a client
58 in the supported groups extension. It returns the total number of
59 supported groups. The B<groups> parameter can be B<NULL> to simply
60 return the number of groups for memory allocation purposes. The
61 B<groups> array is in the form of a set of group NIDs in preference
62 order. It can return zero if the client did not send a supported groups
63 extension.
64
65 SSL_get_shared_group() returns shared group B<n> for a server-side
66 SSL B<ssl>. If B<n> is -1 then the total number of shared groups is
67 returned, which may be zero. Other than for diagnostic purposes,
68 most applications will only be interested in the first shared group
69 so B<n> is normally set to zero. If the value B<n> is out of range,
70 NID_undef is returned.
71
72 SSL_get_negotiated_group() returns the negotiated group on a TLSv1.3 connection
73 for key exchange. This can be called by either client or server.
74
75 All these functions are implemented as macros.
76
77 The curve functions are synonyms for the equivalently named group functions and
78 are identical in every respect. They exist because, prior to TLS1.3, there was
79 only the concept of supported curves. In TLS1.3 this was renamed to supported
80 groups, and extended to include Diffie Hellman groups. The group functions
81 should be used in preference.
82
83 =head1 NOTES
84
85 If an application wishes to make use of several of these functions for
86 configuration purposes either on a command line or in a file it should
87 consider using the SSL_CONF interface instead of manually parsing options.
88
89 =head1 RETURN VALUES
90
91 SSL_CTX_set1_groups(), SSL_CTX_set1_groups_list(), SSL_set1_groups() and
92 SSL_set1_groups_list(), return 1 for success and 0 for failure.
93
94 SSL_get1_groups() returns the number of groups, which may be zero.
95
96 SSL_get_shared_group() returns the NID of shared group B<n> or NID_undef if there
97 is no shared group B<n>; or the total number of shared groups if B<n>
98 is -1.
99
100 When called on a client B<ssl>, SSL_get_shared_group() has no meaning and
101 returns -1.
102
103 SSL_get_negotiated_group() returns the NID of the negotiated group on a
104 TLSv1.3 connection for key exchange. Or it returns NID_undef if no negotiated
105 group.
106
107 =head1 SEE ALSO
108
109 L<SSL_CTX_add_extra_chain_cert(3)>
110
111 =head1 HISTORY
112
113 The curve functions were added in OpenSSL 1.0.2. The equivalent group
114 functions were added in OpenSSL 1.1.1. The SSL_get_negotiated_group() function
115 was added in OpenSSL 3.0.0.
116
117 =head1 COPYRIGHT
118
119 Copyright 2013-2018 The OpenSSL Project Authors. All Rights Reserved.
120
121 Licensed under the Apache License 2.0 (the "License").  You may not use
122 this file except in compliance with the License.  You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 L<https://www.openssl.org/source/license.html>.
125
126 =cut