Merge branch 'vendor/NCURSES'
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_cipher_list.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "SSL_CTX_set_cipher_list 3"
135 .TH SSL_CTX_set_cipher_list 3 "2009-11-06" "0.9.8l" "OpenSSL"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 SSL_CTX_set_cipher_list, SSL_set_cipher_list \- choose list of available SSL_CIPHERs
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/ssl.h>
146 \&
147 \& int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
148 \& int SSL_set_cipher_list(SSL *ssl, const char *str);
149 .Ve
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 \&\fISSL_CTX_set_cipher_list()\fR sets the list of available ciphers for \fBctx\fR
153 using the control string \fBstr\fR. The format of the string is described
154 in \fIciphers\fR\|(1). The list of ciphers is inherited by all
155 \&\fBssl\fR objects created from \fBctx\fR.
156 .PP
157 \&\fISSL_set_cipher_list()\fR sets the list of ciphers only for \fBssl\fR.
158 .SH "NOTES"
159 .IX Header "NOTES"
160 The control string \fBstr\fR should be universally usable and not depend
161 on details of the library configuration (ciphers compiled in). Thus no
162 syntax checking takes place. Items that are not recognized, because the
163 corresponding ciphers are not compiled in or because they are mistyped,
164 are simply ignored. Failure is only flagged if no ciphers could be collected
165 at all.
166 .PP
167 It should be noted, that inclusion of a cipher to be used into the list is
168 a necessary condition. On the client side, the inclusion into the list is
169 also sufficient. On the server side, additional restrictions apply. All ciphers
170 have additional requirements. \s-1ADH\s0 ciphers don't need a certificate, but
171 DH-parameters must have been set. All other ciphers need a corresponding
172 certificate and key.
173 .PP
174 A \s-1RSA\s0 cipher can only be chosen, when a \s-1RSA\s0 certificate is available.
175 \&\s-1RSA\s0 export ciphers with a keylength of 512 bits for the \s-1RSA\s0 key require
176 a temporary 512 bit \s-1RSA\s0 key, as typically the supplied key has a length
177 of 1024 bit (see
178 \&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3)).
179 \&\s-1RSA\s0 ciphers using \s-1EDH\s0 need a certificate and key and additional DH-parameters
180 (see \fISSL_CTX_set_tmp_dh_callback\fR\|(3)).
181 .PP
182 A \s-1DSA\s0 cipher can only be chosen, when a \s-1DSA\s0 certificate is available.
183 \&\s-1DSA\s0 ciphers always use \s-1DH\s0 key exchange and therefore need DH-parameters
184 (see \fISSL_CTX_set_tmp_dh_callback\fR\|(3)).
185 .PP
186 When these conditions are not met for any cipher in the list (e.g. a
187 client only supports export \s-1RSA\s0 ciphers with a asymmetric key length
188 of 512 bits and the server is not configured to use temporary \s-1RSA\s0
189 keys), the \*(L"no shared cipher\*(R" (\s-1SSL_R_NO_SHARED_CIPHER\s0) error is generated
190 and the handshake will fail.
191 .SH "RETURN VALUES"
192 .IX Header "RETURN VALUES"
193 \&\fISSL_CTX_set_cipher_list()\fR and \fISSL_set_cipher_list()\fR return 1 if any cipher
194 could be selected and 0 on complete failure.
195 .SH "SEE ALSO"
196 .IX Header "SEE ALSO"
197 \&\fIssl\fR\|(3), \fISSL_get_ciphers\fR\|(3),
198 \&\fISSL_CTX_use_certificate\fR\|(3),
199 \&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3),
200 \&\fISSL_CTX_set_tmp_dh_callback\fR\|(3),
201 \&\fIciphers\fR\|(1)