Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_mode.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SSL_CTX_set_mode 3"
127 .TH SSL_CTX_set_mode 3 "2012-01-04" "1.0.0f" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 SSL_CTX_set_mode, SSL_set_mode, SSL_CTX_get_mode, SSL_get_mode \- manipulate SSL engine mode
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/ssl.h>
138 \&
139 \& long SSL_CTX_set_mode(SSL_CTX *ctx, long mode);
140 \& long SSL_set_mode(SSL *ssl, long mode);
141 \&
142 \& long SSL_CTX_get_mode(SSL_CTX *ctx);
143 \& long SSL_get_mode(SSL *ssl);
144 .Ve
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\fISSL_CTX_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBctx\fR.
148 Options already set before are not cleared.
149 .PP
150 \&\fISSL_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBssl\fR.
151 Options already set before are not cleared.
152 .PP
153 \&\fISSL_CTX_get_mode()\fR returns the mode set for \fBctx\fR.
154 .PP
155 \&\fISSL_get_mode()\fR returns the mode set for \fBssl\fR.
156 .SH "NOTES"
157 .IX Header "NOTES"
158 The following mode changes are available:
159 .IP "\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0" 4
160 .IX Item "SSL_MODE_ENABLE_PARTIAL_WRITE"
161 Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
162 when just a single record has been written). When not set (the default),
163 \&\fISSL_write()\fR will only report success once the complete chunk was written.
164 Once \fISSL_write()\fR returns with r, r bytes have been successfully written
165 and the next call to \fISSL_write()\fR must only send the n\-r bytes left,
166 imitating the behaviour of \fIwrite()\fR.
167 .IP "\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0" 4
168 .IX Item "SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER"
169 Make it possible to retry \fISSL_write()\fR with changed buffer location
170 (the buffer contents must stay the same). This is not the default to avoid
171 the misconception that non-blocking \fISSL_write()\fR behaves like
172 non-blocking \fIwrite()\fR.
173 .IP "\s-1SSL_MODE_AUTO_RETRY\s0" 4
174 .IX Item "SSL_MODE_AUTO_RETRY"
175 Never bother the application with retries if the transport is blocking.
176 If a renegotiation take place during normal operation, a
177 \&\fISSL_read\fR\|(3) or \fISSL_write\fR\|(3) would return
178 with \-1 and indicate the need to retry with \s-1SSL_ERROR_WANT_READ\s0.
179 In a non-blocking environment applications must be prepared to handle
180 incomplete read/write operations.
181 In a blocking environment, applications are not always prepared to
182 deal with read/write operations returning without success report. The
183 flag \s-1SSL_MODE_AUTO_RETRY\s0 will cause read/write operations to only
184 return after the handshake and successful completion.
185 .IP "\s-1SSL_MODE_RELEASE_BUFFERS\s0" 4
186 .IX Item "SSL_MODE_RELEASE_BUFFERS"
187 When we no longer need a read buffer or a write buffer for a given \s-1SSL\s0,
188 then release the memory we were using to hold it.  Released memory is
189 either appended to a list of unused \s-1RAM\s0 chunks on the \s-1SSL_CTX\s0, or simply
190 freed if the list of unused chunks would become longer than 
191 \&\s-1SSL_CTX\-\s0>freelist_max_len, which defaults to 32.  Using this flag can
192 save around 34k per idle \s-1SSL\s0 connection.
193 This flag has no effect on \s-1SSL\s0 v2 connections, or on \s-1DTLS\s0 connections.
194 .SH "RETURN VALUES"
195 .IX Header "RETURN VALUES"
196 \&\fISSL_CTX_set_mode()\fR and \fISSL_set_mode()\fR return the new mode bitmask
197 after adding \fBmode\fR.
198 .PP
199 \&\fISSL_CTX_get_mode()\fR and \fISSL_get_mode()\fR return the current bitmask.
200 .SH "SEE ALSO"
201 .IX Header "SEE ALSO"
202 \&\fIssl\fR\|(3), \fISSL_read\fR\|(3), \fISSL_write\fR\|(3)
203 .SH "HISTORY"
204 .IX Header "HISTORY"
205 \&\s-1SSL_MODE_AUTO_RETRY\s0 as been added in OpenSSL 0.9.6.