1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:47:41 2003
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
140 .IX Title "SSL_CTX_set_mode 3"
141 .TH SSL_CTX_set_mode 3 "0.9.7a" "2003-02-19" "OpenSSL"
144 SSL_CTX_set_mode, SSL_set_mode, SSL_CTX_get_mode, SSL_get_mode \- manipulate \s-1SSL\s0 engine mode
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/ssl.h>
151 \& long SSL_CTX_set_mode(SSL_CTX *ctx, long mode);
152 \& long SSL_set_mode(SSL *ssl, long mode);
155 \& long SSL_CTX_get_mode(SSL_CTX *ctx);
156 \& long SSL_get_mode(SSL *ssl);
159 .IX Header "DESCRIPTION"
160 \&\fISSL_CTX_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBctx\fR.
161 Options already set before are not cleared.
163 \&\fISSL_set_mode()\fR adds the mode set via bitmask in \fBmode\fR to \fBssl\fR.
164 Options already set before are not cleared.
166 \&\fISSL_CTX_get_mode()\fR returns the mode set for \fBctx\fR.
168 \&\fISSL_get_mode()\fR returns the mode set for \fBssl\fR.
171 The following mode changes are available:
172 .Ip "\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0" 4
173 .IX Item "SSL_MODE_ENABLE_PARTIAL_WRITE"
174 Allow SSL_write(..., n) to return r with 0 < r < n (i.e. report success
175 when just a single record has been written). When not set (the default),
176 \&\fISSL_write()\fR will only report success once the complete chunk was written.
177 Once \fISSL_write()\fR returns with r, r bytes have been successfully written
178 and the next call to \fISSL_write()\fR must only send the n-r bytes left,
179 imitating the behaviour of \fIwrite()\fR.
180 .Ip "\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0" 4
181 .IX Item "SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER"
182 Make it possible to retry \fISSL_write()\fR with changed buffer location
183 (the buffer contents must stay the same). This is not the default to avoid
184 the misconception that non-blocking \fISSL_write()\fR behaves like
185 non-blocking \fIwrite()\fR.
186 .Ip "\s-1SSL_MODE_AUTO_RETRY\s0" 4
187 .IX Item "SSL_MODE_AUTO_RETRY"
188 Never bother the application with retries if the transport is blocking.
189 If a renegotiation take place during normal operation, a
190 SSL_read(3) or SSL_write(3) would return
191 with \-1 and indicate the need to retry with \s-1SSL_ERROR_WANT_READ\s0.
192 In a non-blocking environment applications must be prepared to handle
193 incomplete read/write operations.
194 In a blocking environment, applications are not always prepared to
195 deal with read/write operations returning without success report. The
196 flag \s-1SSL_MODE_AUTO_RETRY\s0 will cause read/write operations to only
197 return after the handshake and successful completion.
199 .IX Header "RETURN VALUES"
200 \&\fISSL_CTX_set_mode()\fR and \fISSL_set_mode()\fR return the new mode bitmask
201 after adding \fBmode\fR.
203 \&\fISSL_CTX_get_mode()\fR and \fISSL_get_mode()\fR return the current bitmask.
205 .IX Header "SEE ALSO"
206 ssl(3), SSL_read(3), SSL_write(3)
209 \&\s-1SSL_MODE_AUTO_RETRY\s0 as been added in OpenSSL 0.9.6.