lib/libssl/man/SSL_CTX_set1_groups.3

   1 .\"     $OpenBSD: SSL_CTX_set1_groups.3,v 1.2 2017/08/19 19:36:39 schwarze Exp $
   2 .\"     OpenSSL SSL_CTX_set1_curves.pod de4d764e Nov 9 14:51:06 2016 +0000
   3 .\"
   4 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
   5 .\" Copyright (c) 2013, 2014, 2016 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: August 19 2017 $
  52 .Dt SSL_CTX_SET1_GROUPS 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_CTX_set1_groups ,
  56 .Nm SSL_CTX_set1_groups_list ,
  57 .Nm SSL_set1_groups ,
  58 .Nm SSL_set1_groups_list ,
  59 .Nm SSL_CTX_set1_curves ,
  60 .Nm SSL_CTX_set1_curves_list ,
  61 .Nm SSL_set1_curves ,
  62 .Nm SSL_set1_curves_list
  63 .Nd choose supported EC groups
  64 .Sh SYNOPSIS
  65 .In openssl/ssl.h
  66 .Ft int
  67 .Fo SSL_CTX_set1_groups
  68 .Fa "SSL_CTX *ctx"
  69 .Fa "const int *glist"
  70 .Fa "size_t glistlen"
  71 .Fc
  72 .Ft int
  73 .Fo SSL_CTX_set1_groups_list
  74 .Fa "SSL_CTX *ctx"
  75 .Fa "const char *list"
  76 .Fc
  77 .Ft int
  78 .Fo SSL_set1_groups
  79 .Fa "SSL *ssl"
  80 .Fa "const int *glist"
  81 .Fa "size_t glistlen"
  82 .Fc
  83 .Ft int
  84 .Fo SSL_set1_groups_list
  85 .Fa "SSL *ssl"
  86 .Fa "const char *list"
  87 .Fc
  88 .Ft int
  89 .Fo SSL_CTX_set1_curves
  90 .Fa "SSL_CTX *ctx"
  91 .Fa "const int *clist"
  92 .Fa "size_t clistlen"
  93 .Fc
  94 .Ft int
  95 .Fo SSL_CTX_set1_curves_list
  96 .Fa "SSL_CTX *ctx"
  97 .Fa "const char *list"
  98 .Fc
  99 .Ft int
 100 .Fo SSL_set1_curves
 101 .Fa "SSL *ssl"
 102 .Fa "const int *clist"
 103 .Fa "size_t clistlen"
 104 .Fc
 105 .Ft int
 106 .Fo SSL_set1_curves_list
 107 .Fa "SSL *ssl"
 108 .Fa "const char *list"
 109 .Fc
 110 .Sh DESCRIPTION
 111 .Fn SSL_CTX_set1_groups
 112 sets the supported groups for
 113 .Fa ctx
 114 to the
 115 .Fa glistlen
 116 groups in the array
 117 .Fa glist .
 118 The array consists of group NIDs in preference order.
 119 For a TLS client, the groups are used directly in the supported groups
 120 extension.
 121 For a TLS server, the groups are used to determine the set of shared
 122 groups.
 123 .Pp
 124 .Fn SSL_CTX_set1_groups_list
 125 sets the supported groups for
 126 .Fa ctx
 127 to the
 128 .Fa list
 129 represented as a colon separated list of group NIDs or names, for example
 130 "P-521:P-384:P-256".
 131 .Pp
 132 .Fn SSL_set1_groups
 133 and
 134 .Fn SSL_set1_groups_list
 135 are similar except that they set supported groups for the SSL structure
 136 .Fa ssl
 137 only.
 138 .Pp
 139 The curve functions are deprecated synonyms for the equivalently
 140 named group functions and are identical in every respect except
 141 that they are implemented as macros.
 142 They exist because prior to TLS1.3, there was only the concept of
 143 supported curves.
 144 In TLS1.3, this was renamed to supported groups and extended to include
 145 Diffie Hellman groups.
 146 .Pp
 147 If an application wishes to make use of several of these functions for
 148 configuration purposes either on a command line or in a file, it should
 149 consider using the SSL_CONF interface instead of manually parsing
 150 options.
 151 .Sh RETURN VALUES
 152 All these functions return 1 for success or 0 for failure.
 153 .Sh SEE ALSO
 154 .Xr ssl 3 ,
 155 .Xr SSL_CTX_add_extra_chain_cert 3 ,
 156 .Xr SSL_CTX_set_cipher_list 3 ,
 157 .Xr SSL_CTX_set_options 3 ,
 158 .Xr SSL_new 3
 159 .Sh HISTORY
 160 The curve functions first appeared in OpenSSL 1.0.2
 161 and the group functions in OpenSSL 1.1.1.
 162 Both have been available since
 163 .Ox 6.1 .