Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / pyopenssl / bb960a6f6ccda15ae4c0936fe164490e3d79979a / . / doc / html / openssl-connection.html
blob: c4f7d8893c8a89bbcaeeff81f9fe0aaa8ad13d29 [file] [log] [blame]
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<title>3.3.2 Connection objects </title>
5<META NAME="description" CONTENT="3.3.2 Connection objects ">
6<META NAME="keywords" CONTENT="pyOpenSSL">
7<META NAME="resource-type" CONTENT="document">
8<META NAME="distribution" CONTENT="global">
9<link rel="STYLESHEET" href="pyOpenSSL.css">
10<LINK REL="previous" href="openssl-context.html">
11<LINK REL="up" href="openssl-ssl.html">
12<LINK REL="next" href="internals.html">
13</head>
14<body>
15<DIV CLASS="navigation">
16<table align="center" width="100%" cellpadding="0" cellspacing="2">
17<tr>
18<td><A href="openssl-context.html"><img src="previous.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]19 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]20 alt="Previous Page" width="32"></A></td>
21<td><A href="openssl-ssl.html"><img src="up.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]22 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]23 alt="Up One Level" width="32"></A></td>
24<td><A href="internals.html"><img src="next.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]25 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]26 alt="Next Page" width="32"></A></td>
27<td align="center" width="100%">Python OpenSSL Manual</td>
28<td><A href="contents.html"><img src="contents.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]29 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]30 alt="Contents" width="32"></A></td>
31<td><img src="blank.gif"
32 border="0" height="32"
33 alt="" width="32"></td>
34<td><img src="blank.gif"
35 border="0" height="32"
36 alt="" width="32"></td>
37</tr></table>
38<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A>
39<b class="navlabel">Up:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A>
40<b class="navlabel">Next:</b> <a class="sectref" href="internals.html">4 Internals</A>
41<br><hr>
42</DIV>
43<!--End of Navigation Panel-->
44
45<H3><A NAME="SECTION000432000000000000000">&nbsp;</A>
46<BR>
473.3.2 Connection objects
48</H3>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]49
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]50<P>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]51Connection objects have the following methods:
52
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]53<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]54<dl><dt><b><a name='l2h-188'><tt class='method'>accept</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]55<dd>
56Call the <tt class="method">accept</tt> method of the underlying socket and set up SSL on the
57returned socket, using the Context object supplied to this Connection object at
58creation. Returns a pair <code>(<var>conn</var>, <var>address</var>)</code>. where <var>conn</var>
59is the new Connection object created, and <var>address</var> is as returned by the
60socket's <tt class="method">accept</tt>.
61</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]62
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]63<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]64<dl><dt><b><a name='l2h-189'><tt class='method'>bind</tt></a></b>(<var>address</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]65<dd>
66Call the <tt class="method">bind</tt> method of the underlying socket.
67</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]68
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]69<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]70<dl><dt><b><a name='l2h-190'><tt class='method'>close</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]71<dd>
72Call the <tt class="method">close</tt> method of the underlying socket. Note: If you want
73correct SSL closure, you need to call the <tt class="method">shutdown</tt> method first.
74</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]75
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]76<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]77<dl><dt><b><a name='l2h-191'><tt class='method'>connect</tt></a></b>(<var>address</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]78<dd>
79Call the <tt class="method">connect</tt> method of the underlying socket and set up SSL on the
80socket, using the Context object supplied to this Connection object at
81creation.
82</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]83
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]84<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]85<dl><dt><b><a name='l2h-192'><tt class='method'>connect_ex</tt></a></b>(<var>address</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]86<dd>
87Call the <tt class="method">connect_ex</tt> method of the underlying socket and set up SSL on
88the socket, using the Context object supplied to this Connection object at
89creation. Note that if the <tt class="method">connect_ex</tt> method of the socket doesn't
90return 0, SSL won't be initialized.
91</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]92
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]93<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]94<dl><dt><b><a name='l2h-193'><tt class='method'>do_handshake</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]95<dd>
96Perform an SSL handshake (usually called after <tt class="method">renegotiate</tt> or one of
97<tt class="method">set_accept_state</tt> or <tt class="method">set_accept_state</tt>). This can raise the
98same exceptions as <tt class="method">send</tt> and <tt class="method">recv</tt>.
99</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]100
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]101<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]102<dl><dt><b><a name='l2h-194'><tt class='method'>fileno</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]103<dd>
104Retrieve the file descriptor number for the underlying socket.
105</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]106
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]107<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]108<dl><dt><b><a name='l2h-195'><tt class='method'>listen</tt></a></b>(<var>backlog</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]109<dd>
110Call the <tt class="method">listen</tt> method of the underlying socket.
111</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]112
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]113<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]114<dl><dt><b><a name='l2h-196'><tt class='method'>get_app_data</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]115<dd>
116Retrieve application data as set by <tt class="method">set_app_data</tt>.
117</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]118
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]119<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]120<dl><dt><b><a name='l2h-197'><tt class='method'>get_cipher_list</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]121<dd>
122Retrieve the list of ciphers used by the Connection object. WARNING: This API
123has changed. It used to take an optional parameter and just return a string,
124but not it returns the entire list in one go.
125</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]126
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]127<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]128<dl><dt><b><a name='l2h-198'><tt class='method'>get_client_ca_list</tt></a></b>()
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]129<dd>
130Retrieve the list of preferred client certificate issuers sent by the server
131as <tt class="class">OpenSSL.crypto.X509Name</tt> objects.
132
133<P>
134If this is a client <tt class="class">Connection</tt>, the list will be empty until the
135connection with the server is established.
136
137<P>
138If this is a server <tt class="class">Connection</tt>, return the list of certificate
139authorities that will be sent or has been sent to the client, as controlled
140by this <tt class="class">Connection</tt>'s <tt class="class">Context</tt>.
141
142<P>
143
144<span class='versionnote'>New in version 0.10.</span>
145
146</dl>
147
148<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]149<dl><dt><b><a name='l2h-199'><tt class='method'>get_context</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]150<dd>
151Retrieve the Context object associated with this Connection.
152</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]153
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]154<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]155<dl><dt><b><a name='l2h-200'><tt class='method'>set_context</tt></a></b>(<var>context</var>)
156<dd>
157Specify a replacement Context object for this Connection.
158</dl>
159
160<P>
161<dl><dt><b><a name='l2h-201'><tt class='method'>get_peer_certificate</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]162<dd>
163Retrieve the other side's certificate (if any)
164</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]165
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]166<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]167<dl><dt><b><a name='l2h-202'><tt class='method'>get_peer_cert_chain</tt></a></b>()
168<dd>
169Retrieve the tuple of the other side's certificate chain (if any)
170</dl>
171
172<P>
173<dl><dt><b><a name='l2h-203'><tt class='method'>getpeername</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]174<dd>
175Call the <tt class="method">getpeername</tt> method of the underlying socket.
176</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]177
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]178<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]179<dl><dt><b><a name='l2h-204'><tt class='method'>getsockname</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]180<dd>
181Call the <tt class="method">getsockname</tt> method of the underlying socket.
182</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]183
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]184<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]185<dl><dt><b><a name='l2h-205'><tt class='method'>getsockopt</tt></a></b>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]186<dd>
187Call the <tt class="method">getsockopt</tt> method of the underlying socket.
188</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]189
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]190<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]191<dl><dt><b><a name='l2h-206'><tt class='method'>pending</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]192<dd>
Jean-Paul Calderoneb6f57be2008-03-06 21:22:16 -0500[diff] [blame]193Retrieve the number of bytes that can be safely read from the SSL buffer
194(<i>not</i> the underlying transport buffer).
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]195</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]196
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]197<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]198<dl><dt><b><a name='l2h-207'><tt class='method'>recv</tt></a></b>(<var>bufsize</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]199<dd>
200Receive data from the Connection. The return value is a string representing the
201data received. The maximum amount of data to be received at once, is specified
202by <var>bufsize</var>.
203</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]204
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]205<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]206<dl><dt><b><a name='l2h-208'><tt class='method'>bio_write</tt></a></b>(<var>bytes</var>)
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]207<dd>
208If the Connection was created with a memory BIO, this method can be used to add
209bytes to the read end of that memory BIO. The Connection can then read the
210bytes (for example, in response to a call to <tt class="method">recv</tt>).
211</dl>
212
213<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]214<dl><dt><b><a name='l2h-209'><tt class='method'>renegotiate</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]215<dd>
216Renegotiate the SSL session. Call this if you wish to change cipher suites or
217anything like that.
218</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]219
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]220<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]221<dl><dt><b><a name='l2h-210'><tt class='method'>send</tt></a></b>(<var>string</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]222<dd>
223Send the <var>string</var> data to the Connection.
224</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]225
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]226<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]227<dl><dt><b><a name='l2h-211'><tt class='method'>bio_read</tt></a></b>(<var>bufsize</var>)
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]228<dd>
229If the Connection was created with a memory BIO, this method can be used to
230read bytes from the write end of that memory BIO. Many Connection methods will
231add bytes which must be read in this manner or the buffer will eventually fill
232up and the Connection will be able to take no further actions.
233</dl>
234
235<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]236<dl><dt><b><a name='l2h-212'><tt class='method'>sendall</tt></a></b>(<var>string</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]237<dd>
238Send all of the <var>string</var> data to the Connection. This calls <tt class="method">send</tt>
239repeatedly until all data is sent. If an error occurs, it's impossible to tell
240how much data has been sent.
241</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]242
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]243<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]244<dl><dt><b><a name='l2h-213'><tt class='method'>set_accept_state</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]245<dd>
246Set the connection to work in server mode. The handshake will be handled
247automatically by read/write.
248</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]249
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]250<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]251<dl><dt><b><a name='l2h-214'><tt class='method'>set_app_data</tt></a></b>(<var>data</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]252<dd>
253Associate <var>data</var> with this Connection object. <var>data</var> can be retrieved
254later using the <tt class="method">get_app_data</tt> method.
255</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]256
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]257<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]258<dl><dt><b><a name='l2h-215'><tt class='method'>set_connect_state</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]259<dd>
260Set the connection to work in client mode. The handshake will be handled
261automatically by read/write.
262</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]263
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]264<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]265<dl><dt><b><a name='l2h-216'><tt class='method'>setblocking</tt></a></b>(<var>flag</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]266<dd>
267Call the <tt class="method">setblocking</tt> method of the underlying socket.
268</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]269
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]270<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]271<dl><dt><b><a name='l2h-217'><tt class='method'>setsockopt</tt></a></b>(<var>level, optname, value</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]272<dd>
273Call the <tt class="method">setsockopt</tt> method of the underlying socket.
274</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]275
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]276<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]277<dl><dt><b><a name='l2h-218'><tt class='method'>shutdown</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]278<dd>
279Send the shutdown message to the Connection. Returns true if the shutdown
280message exchange is completed and false otherwise (in which case you call
281<tt class="method">recv()</tt> or <tt class="method">send()</tt> when the connection becomes
282readable/writeable.
283</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]284
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]285<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]286<dl><dt><b><a name='l2h-219'><tt class='method'>get_shutdown</tt></a></b>()
Jean-Paul Calderone72b8f0f2008-02-21 23:57:40 -0500[diff] [blame]287<dd>
288Get the shutdown state of the Connection. Returns a bitvector of either or
289both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>.
290</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]291
Jean-Paul Calderone72b8f0f2008-02-21 23:57:40 -0500[diff] [blame]292<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]293<dl><dt><b><a name='l2h-220'><tt class='method'>set_shutdown</tt></a></b>(<var>state</var>)
Jean-Paul Calderone72b8f0f2008-02-21 23:57:40 -0500[diff] [blame]294<dd>
295Set the shutdown state of the Connection. <var>state</var> is a bitvector of
296either or both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>.
297</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]298
Jean-Paul Calderone72b8f0f2008-02-21 23:57:40 -0500[diff] [blame]299<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]300<dl><dt><b><a name='l2h-221'><tt class='method'>sock_shutdown</tt></a></b>(<var>how</var>)
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]301<dd>
302Call the <tt class="method">shutdown</tt> method of the underlying socket.
303</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]304
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]305<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]306<dl><dt><b><a name='l2h-222'><tt class='method'>bio_shutdown</tt></a></b>()
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]307<dd>
308If the Connection was created with a memory BIO, this method can be used to
309indicate that ``end of file'' has been reached on the read end of that memory
310BIO.
311</dl>
312
313<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]314<dl><dt><b><a name='l2h-223'><tt class='method'>state_string</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]315<dd>
316Retrieve a verbose string detailing the state of the Connection.
317</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]318
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]319<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]320<dl><dt><b><a name='l2h-224'><tt class='method'>client_random</tt></a></b>()
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]321<dd>
322Retrieve the random value used with the client hello message.
323</dl>
324
325<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]326<dl><dt><b><a name='l2h-225'><tt class='method'>server_random</tt></a></b>()
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]327<dd>
328Retrieve the random value used with the server hello message.
329</dl>
330
331<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]332<dl><dt><b><a name='l2h-226'><tt class='method'>master_key</tt></a></b>()
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]333<dd>
334Retrieve the value of the master key for this session.
335</dl>
336
337<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]338<dl><dt><b><a name='l2h-227'><tt class='method'>want_read</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]339<dd>
340Checks if more data has to be read from the transport layer to complete an
341operation.
342</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]343
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]344<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]345<dl><dt><b><a name='l2h-228'><tt class='method'>want_write</tt></a></b>()
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]346<dd>
347Checks if there is data to write to the transport layer to complete an
348operation.
349</dl>
Jean-Paul Calderone2aa2b332008-03-06 21:43:14 -0500[diff] [blame]350
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]351<P>
Jean-Paul Calderone7fd9c562011-08-14 18:19:17 -0400[diff] [blame]352<dl><dt><b><a name='l2h-229'><tt class='method'>set_tlsext_host_name</tt></a></b>(<var>name</var>)
353<dd>
354Specify the byte string to send as the server name in the client hello message.
355
356<span class='versionnote'>New in version 0.13.</span>
357
358</dl>
359
360<P>
361<dl><dt><b><a name='l2h-230'><tt class='method'>get_servername</tt></a></b>()
362<dd>
363Get the value of the server name received in the client hello message.
364
365<span class='versionnote'>New in version 0.13.</span>
366
367</dl>
368
369<P>
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]370
371<DIV CLASS="navigation">
372<p><hr>
373<table align="center" width="100%" cellpadding="0" cellspacing="2">
374<tr>
375<td><A href="openssl-context.html"><img src="previous.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]376 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]377 alt="Previous Page" width="32"></A></td>
378<td><A href="openssl-ssl.html"><img src="up.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]379 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]380 alt="Up One Level" width="32"></A></td>
381<td><A href="internals.html"><img src="next.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]382 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]383 alt="Next Page" width="32"></A></td>
384<td align="center" width="100%">Python OpenSSL Manual</td>
385<td><A href="contents.html"><img src="contents.gif"
Jean-Paul Calderone215d51b2009-11-13 09:19:21 -0500[diff] [blame]386 border="0" height="32"
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]387 alt="Contents" width="32"></A></td>
388<td><img src="blank.gif"
389 border="0" height="32"
390 alt="" width="32"></td>
391<td><img src="blank.gif"
392 border="0" height="32"
393 alt="" width="32"></td>
394</tr></table>
395<b class="navlabel">Previous:</b> <a class="sectref" href="openssl-context.html">3.3.1 Context objects</A>
396<b class="navlabel">Up:</b> <a class="sectref" href="openssl-ssl.html">3.3 SSL </A>
397<b class="navlabel">Next:</b> <a class="sectref" href="internals.html">4 Internals</A>
398<hr>
Jean-Paul Calderoneb557e982011-09-02 11:35:12 -0400[diff] [blame]399<span class="release-info">Release 0.13.</span>
Jean-Paul Calderone897bc252008-02-18 20:50:23 -0500[diff] [blame]400</DIV>
401<!--End of Navigation Panel-->
402
403</BODY>
404</HTML>