~myers-1/pyopenssl/npn : revision 144

51

Connection objects have the following methods:

52

53

54

<dl><dt><a name='l2h-175'><tt class='method'>accept</tt></a>()

54

<dl><dt><a name='l2h-179'><tt class='method'>accept</tt></a>()

55

<dd>

56

Call the <tt class="method">accept</tt> method of the underlying socket and set up SSL on the

57

returned socket, using the Context object supplied to this Connection object at

61

</dl>

62

63

64

<dl><dt><a name='l2h-176'><tt class='method'>bind</tt></a>(<var>address</var>)

64

<dl><dt><a name='l2h-180'><tt class='method'>bind</tt></a>(<var>address</var>)

65

<dd>

66

Call the <tt class="method">bind</tt> method of the underlying socket.

67

</dl>

68

69

70

<dl><dt><a name='l2h-177'><tt class='method'>close</tt></a>()

70

<dl><dt><a name='l2h-181'><tt class='method'>close</tt></a>()

71

<dd>

72

Call the <tt class="method">close</tt> method of the underlying socket. Note: If you want

73

correct SSL closure, you need to call the <tt class="method">shutdown</tt> method first.

74

</dl>

75

76

77

<dl><dt><a name='l2h-178'><tt class='method'>connect</tt></a>(<var>address</var>)

77

<dl><dt><a name='l2h-182'><tt class='method'>connect</tt></a>(<var>address</var>)

78

<dd>

79

Call the <tt class="method">connect</tt> method of the underlying socket and set up SSL on the

80

socket, using the Context object supplied to this Connection object at

82

</dl>

83

84

85

<dl><dt><a name='l2h-179'><tt class='method'>connect_ex</tt></a>(<var>address</var>)

85

<dl><dt><a name='l2h-183'><tt class='method'>connect_ex</tt></a>(<var>address</var>)

86

<dd>

87

Call the <tt class="method">connect_ex</tt> method of the underlying socket and set up SSL on

88

the socket, using the Context object supplied to this Connection object at

91

</dl>

92

93

94

<dl><dt><a name='l2h-180'><tt class='method'>do_handshake</tt></a>()

94

<dl><dt><a name='l2h-184'><tt class='method'>do_handshake</tt></a>()

95

<dd>

96

Perform 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

99

</dl>

100

101

102

<dl><dt><a name='l2h-181'><tt class='method'>fileno</tt></a>()

102

<dl><dt><a name='l2h-185'><tt class='method'>fileno</tt></a>()

103

<dd>

104

Retrieve the file descriptor number for the underlying socket.

105

</dl>

106

107

108

<dl><dt><a name='l2h-182'><tt class='method'>listen</tt></a>(<var>backlog</var>)

108

<dl><dt><a name='l2h-186'><tt class='method'>listen</tt></a>(<var>backlog</var>)

109

<dd>

110

Call the <tt class="method">listen</tt> method of the underlying socket.

111

</dl>

112

113

114

<dl><dt><a name='l2h-183'><tt class='method'>get_app_data</tt></a>()

114

<dl><dt><a name='l2h-187'><tt class='method'>get_app_data</tt></a>()

115

<dd>

116

Retrieve application data as set by <tt class="method">set_app_data</tt>.

117

</dl>

118

119

120

<dl><dt><a name='l2h-184'><tt class='method'>get_cipher_list</tt></a>()

120

<dl><dt><a name='l2h-188'><tt class='method'>get_cipher_list</tt></a>()

121

<dd>

122

Retrieve the list of ciphers used by the Connection object. WARNING: This API

123

has changed. It used to take an optional parameter and just return a string,

125

</dl>

126

127

128

<dl><dt><a name='l2h-185'><tt class='method'>get_client_ca_list</tt></a>()

128

<dl><dt><a name='l2h-189'><tt class='method'>get_client_ca_list</tt></a>()

129

<dd>

130

Retrieve the list of preferred client certificate issuers sent by the server

131

as <tt class="class">OpenSSL.crypto.X509Name</tt> objects.

146

</dl>

147

148

149

<dl><dt><a name='l2h-186'><tt class='method'>get_context</tt></a>()

149

<dl><dt><a name='l2h-190'><tt class='method'>get_context</tt></a>()

150

<dd>

151

Retrieve the Context object associated with this Connection.

152

</dl>

153

154

155

<dl><dt><a name='l2h-187'><tt class='method'>get_peer_certificate</tt></a>()

155

<dl><dt><a name='l2h-191'><tt class='method'>get_peer_certificate</tt></a>()

156

<dd>

157

Retrieve the other side's certificate (if any)

158

</dl>

159

160

161

<dl><dt><a name='l2h-188'><tt class='method'>getpeername</tt></a>()

161

<dl><dt><a name='l2h-192'><tt class='method'>getpeername</tt></a>()

162

<dd>

163

Call the <tt class="method">getpeername</tt> method of the underlying socket.

164

</dl>

165

166

167

<dl><dt><a name='l2h-189'><tt class='method'>getsockname</tt></a>()

167

<dl><dt><a name='l2h-193'><tt class='method'>getsockname</tt></a>()

168

<dd>

169

Call the <tt class="method">getsockname</tt> method of the underlying socket.

170

</dl>

171

172

173

<dl><dt><a name='l2h-190'><tt class='method'>getsockopt</tt></a>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>)

173

<dl><dt><a name='l2h-194'><tt class='method'>getsockopt</tt></a>(<var>level, optname</var><big>[</big><var>, buflen</var><big>]</big>)

174

<dd>

175

Call the <tt class="method">getsockopt</tt> method of the underlying socket.

176

</dl>

177

178

179

<dl><dt><a name='l2h-191'><tt class='method'>pending</tt></a>()

179

<dl><dt><a name='l2h-195'><tt class='method'>pending</tt></a>()

180

<dd>

181

Retrieve the number of bytes that can be safely read from the SSL buffer

182

(not the underlying transport buffer).

183

</dl>

184

185

186

<dl><dt><a name='l2h-192'><tt class='method'>recv</tt></a>(<var>bufsize</var>)

186

<dl><dt><a name='l2h-196'><tt class='method'>recv</tt></a>(<var>bufsize</var>)

187

<dd>

188

Receive data from the Connection. The return value is a string representing the

189

data received. The maximum amount of data to be received at once, is specified

191

</dl>

192

193

194

<dl><dt><a name='l2h-193'><tt class='method'>bio_write</tt></a>(<var>bytes</var>)

194

<dl><dt><a name='l2h-197'><tt class='method'>bio_write</tt></a>(<var>bytes</var>)

195

<dd>

196

If the Connection was created with a memory BIO, this method can be used to add

197

bytes to the read end of that memory BIO. The Connection can then read the

199

</dl>

200

201

202

<dl><dt><a name='l2h-194'><tt class='method'>renegotiate</tt></a>()

202

<dl><dt><a name='l2h-198'><tt class='method'>renegotiate</tt></a>()

203

<dd>

204

Renegotiate the SSL session. Call this if you wish to change cipher suites or

205

anything like that.

206

</dl>

207

208

209

<dl><dt><a name='l2h-195'><tt class='method'>send</tt></a>(<var>string</var>)

209

<dl><dt><a name='l2h-199'><tt class='method'>send</tt></a>(<var>string</var>)

210

<dd>

211

Send the <var>string</var> data to the Connection.

212

</dl>

213

214

215

<dl><dt><a name='l2h-196'><tt class='method'>bio_read</tt></a>(<var>bufsize</var>)

215

<dl><dt><a name='l2h-200'><tt class='method'>bio_read</tt></a>(<var>bufsize</var>)

216

<dd>

217

If the Connection was created with a memory BIO, this method can be used to

218

read bytes from the write end of that memory BIO. Many Connection methods will

221

</dl>

222

223

224

<dl><dt><a name='l2h-197'><tt class='method'>sendall</tt></a>(<var>string</var>)

224

<dl><dt><a name='l2h-201'><tt class='method'>sendall</tt></a>(<var>string</var>)

225

<dd>

226

Send all of the <var>string</var> data to the Connection. This calls <tt class="method">send</tt>

227

repeatedly until all data is sent. If an error occurs, it's impossible to tell

229

</dl>

230

231

232

<dl><dt><a name='l2h-198'><tt class='method'>set_accept_state</tt></a>()

232

<dl><dt><a name='l2h-202'><tt class='method'>set_accept_state</tt></a>()

233

<dd>

234

Set the connection to work in server mode. The handshake will be handled

235

automatically by read/write.

236

</dl>

237

238

239

<dl><dt><a name='l2h-199'><tt class='method'>set_app_data</tt></a>(<var>data</var>)

239

<dl><dt><a name='l2h-203'><tt class='method'>set_app_data</tt></a>(<var>data</var>)

240

<dd>

241

Associate <var>data</var> with this Connection object. <var>data</var> can be retrieved

242

later using the <tt class="method">get_app_data</tt> method.

243

</dl>

244

245

246

<dl><dt><a name='l2h-200'><tt class='method'>set_connect_state</tt></a>()

246

<dl><dt><a name='l2h-204'><tt class='method'>set_connect_state</tt></a>()

247

<dd>

248

Set the connection to work in client mode. The handshake will be handled

249

automatically by read/write.

250

</dl>

251

252

253

<dl><dt><a name='l2h-201'><tt class='method'>setblocking</tt></a>(<var>flag</var>)

253

<dl><dt><a name='l2h-205'><tt class='method'>setblocking</tt></a>(<var>flag</var>)

254

<dd>

255

Call the <tt class="method">setblocking</tt> method of the underlying socket.

256

</dl>

257

258

259

<dl><dt><a name='l2h-202'><tt class='method'>setsockopt</tt></a>(<var>level, optname, value</var>)

259

<dl><dt><a name='l2h-206'><tt class='method'>setsockopt</tt></a>(<var>level, optname, value</var>)

260

<dd>

261

Call the <tt class="method">setsockopt</tt> method of the underlying socket.

262

</dl>

263

264

265

<dl><dt><a name='l2h-203'><tt class='method'>shutdown</tt></a>()

265

<dl><dt><a name='l2h-207'><tt class='method'>shutdown</tt></a>()

266

<dd>

267

Send the shutdown message to the Connection. Returns true if the shutdown

268

message exchange is completed and false otherwise (in which case you call

271

</dl>

272

273

274

<dl><dt><a name='l2h-204'><tt class='method'>get_shutdown</tt></a>()

274

<dl><dt><a name='l2h-208'><tt class='method'>get_shutdown</tt></a>()

275

<dd>

276

Get the shutdown state of the Connection. Returns a bitvector of either or

277

both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>.

278

</dl>

279

280

281

<dl><dt><a name='l2h-205'><tt class='method'>set_shutdown</tt></a>(<var>state</var>)

281

<dl><dt><a name='l2h-209'><tt class='method'>set_shutdown</tt></a>(<var>state</var>)

282

<dd>

283

Set the shutdown state of the Connection. <var>state</var> is a bitvector of

284

either or both of <var>SENT_SHUTDOWN</var> and <var>RECEIVED_SHUTDOWN</var>.

285

</dl>

286

287

288

<dl><dt><a name='l2h-206'><tt class='method'>sock_shutdown</tt></a>(<var>how</var>)

288

<dl><dt><a name='l2h-210'><tt class='method'>sock_shutdown</tt></a>(<var>how</var>)

289

<dd>

290

Call the <tt class="method">shutdown</tt> method of the underlying socket.

291

</dl>

292

293

294

<dl><dt><a name='l2h-207'><tt class='method'>bio_shutdown</tt></a>()

294

<dl><dt><a name='l2h-211'><tt class='method'>bio_shutdown</tt></a>()

295

<dd>

296

If the Connection was created with a memory BIO, this method can be used to

297

indicate that ``end of file'' has been reached on the read end of that memory

299

</dl>

300

301

302

<dl><dt><a name='l2h-208'><tt class='method'>state_string</tt></a>()

302

<dl><dt><a name='l2h-212'><tt class='method'>state_string</tt></a>()

303

<dd>

304

Retrieve a verbose string detailing the state of the Connection.

305

</dl>

306

307

308

<dl><dt><a name='l2h-209'><tt class='method'>client_random</tt></a>()

308

<dl><dt><a name='l2h-213'><tt class='method'>client_random</tt></a>()

309

<dd>

310

Retrieve the random value used with the client hello message.

311

</dl>

312

313

314

<dl><dt><a name='l2h-210'><tt class='method'>server_random</tt></a>()

314

<dl><dt><a name='l2h-214'><tt class='method'>server_random</tt></a>()

315

<dd>

316

Retrieve the random value used with the server hello message.

317

</dl>

318

319

320

<dl><dt><a name='l2h-211'><tt class='method'>master_key</tt></a>()

320

<dl><dt><a name='l2h-215'><tt class='method'>master_key</tt></a>()

321

<dd>

322

Retrieve the value of the master key for this session.

323

</dl>

324

325

326

<dl><dt><a name='l2h-212'><tt class='method'>want_read</tt></a>()

326

<dl><dt><a name='l2h-216'><tt class='method'>want_read</tt></a>()

327

<dd>

328

Checks if more data has to be read from the transport layer to complete an

329

operation.

330

</dl>

331

332

333

<dl><dt><a name='l2h-213'><tt class='method'>want_write</tt></a>()

333

<dl><dt><a name='l2h-217'><tt class='method'>want_write</tt></a>()

334

<dd>

335

Checks if there is data to write to the transport layer to complete an

336

operation.