Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1 | /* |
| 2 | * connection.c |
| 3 | * |
| 4 | * Copyright (C) AB Strakt 2001, All rights reserved |
Jean-Paul Calderone | 8b63d45 | 2008-03-21 18:31:12 -0400 | [diff] [blame] | 5 | * Copyright (C) Jean-Paul Calderone 2008, All rights reserved |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 6 | * |
| 7 | * SSL Connection objects and methods. |
| 8 | * See the file RATIONALE for a short explanation of why this module was written. |
| 9 | * |
| 10 | * Reviewed 2001-07-23 |
| 11 | */ |
| 12 | #include <Python.h> |
Jean-Paul Calderone | 12ea9a0 | 2008-02-22 12:24:39 -0500 | [diff] [blame] | 13 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 14 | #ifndef MS_WINDOWS |
| 15 | # include <sys/socket.h> |
| 16 | # include <netinet/in.h> |
| 17 | # if !(defined(__BEOS__) || defined(__CYGWIN__)) |
| 18 | # include <netinet/tcp.h> |
| 19 | # endif |
| 20 | #else |
| 21 | # include <winsock.h> |
Jean-Paul Calderone | 12ea9a0 | 2008-02-22 12:24:39 -0500 | [diff] [blame] | 22 | # include <wincrypt.h> |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 23 | #endif |
| 24 | |
Jean-Paul Calderone | 12ea9a0 | 2008-02-22 12:24:39 -0500 | [diff] [blame] | 25 | #define SSL_MODULE |
Jean-Paul Calderone | 3ad85d4 | 2009-04-30 20:24:35 -0400 | [diff] [blame] | 26 | #include <openssl/bio.h> |
Jean-Paul Calderone | 12ea9a0 | 2008-02-22 12:24:39 -0500 | [diff] [blame] | 27 | #include <openssl/err.h> |
Jean-Paul Calderone | 12ea9a0 | 2008-02-22 12:24:39 -0500 | [diff] [blame] | 28 | #include "ssl.h" |
| 29 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 30 | /** |
| 31 | * If we are on UNIX, fine, just use PyErr_SetFromErrno. If we are on Windows, |
| 32 | * apply some black winsock voodoo. This is basically just copied from Python's |
| 33 | * socketmodule.c |
| 34 | * |
| 35 | * Arguments: None |
| 36 | * Returns: None |
| 37 | */ |
| 38 | static void |
| 39 | syscall_from_errno(void) |
| 40 | { |
| 41 | #ifdef MS_WINDOWS |
| 42 | int errnum = WSAGetLastError(); |
| 43 | if (errnum) |
| 44 | { |
| 45 | static struct { int num; const char *msg; } *msgp, msgs[] = { |
| 46 | { WSAEINTR, "Interrupted system call" }, |
| 47 | { WSAEBADF, "Bad file descriptor" }, |
| 48 | { WSAEACCES, "Permission denied" }, |
| 49 | { WSAEFAULT, "Bad address" }, |
| 50 | { WSAEINVAL, "Invalid argument" }, |
| 51 | { WSAEMFILE, "Too many open files" }, |
| 52 | { WSAEWOULDBLOCK, "The socket operation could not complete " |
| 53 | "without blocking" }, |
| 54 | { WSAEINPROGRESS, "Operation now in progress" }, |
| 55 | { WSAEALREADY, "Operation already in progress" }, |
| 56 | { WSAENOTSOCK, "Socket operation on non-socket" }, |
| 57 | { WSAEDESTADDRREQ, "Destination address required" }, |
| 58 | { WSAEMSGSIZE, "Message too long" }, |
| 59 | { WSAEPROTOTYPE, "Protocol wrong type for socket" }, |
| 60 | { WSAENOPROTOOPT, "Protocol not available" }, |
| 61 | { WSAEPROTONOSUPPORT, "Protocol not supported" }, |
| 62 | { WSAESOCKTNOSUPPORT, "Socket type not supported" }, |
| 63 | { WSAEOPNOTSUPP, "Operation not supported" }, |
| 64 | { WSAEPFNOSUPPORT, "Protocol family not supported" }, |
| 65 | { WSAEAFNOSUPPORT, "Address family not supported" }, |
| 66 | { WSAEADDRINUSE, "Address already in use" }, |
| 67 | { WSAEADDRNOTAVAIL, "Can't assign requested address" }, |
| 68 | { WSAENETDOWN, "Network is down" }, |
| 69 | { WSAENETUNREACH, "Network is unreachable" }, |
| 70 | { WSAENETRESET, "Network dropped connection on reset" }, |
| 71 | { WSAECONNABORTED, "Software caused connection abort" }, |
| 72 | { WSAECONNRESET, "Connection reset by peer" }, |
| 73 | { WSAENOBUFS, "No buffer space available" }, |
| 74 | { WSAEISCONN, "Socket is already connected" }, |
| 75 | { WSAENOTCONN, "Socket is not connected" }, |
| 76 | { WSAESHUTDOWN, "Can't send after socket shutdown" }, |
| 77 | { WSAETOOMANYREFS, "Too many references: can't splice" }, |
| 78 | { WSAETIMEDOUT, "Operation timed out" }, |
| 79 | { WSAECONNREFUSED, "Connection refused" }, |
| 80 | { WSAELOOP, "Too many levels of symbolic links" }, |
| 81 | { WSAENAMETOOLONG, "File name too long" }, |
| 82 | { WSAEHOSTDOWN, "Host is down" }, |
| 83 | { WSAEHOSTUNREACH, "No route to host" }, |
| 84 | { WSAENOTEMPTY, "Directory not empty" }, |
| 85 | { WSAEPROCLIM, "Too many processes" }, |
| 86 | { WSAEUSERS, "Too many users" }, |
| 87 | { WSAEDQUOT, "Disc quota exceeded" }, |
| 88 | { WSAESTALE, "Stale NFS file handle" }, |
| 89 | { WSAEREMOTE, "Too many levels of remote in path" }, |
| 90 | { WSASYSNOTREADY, "Network subsystem is unvailable" }, |
| 91 | { WSAVERNOTSUPPORTED, "WinSock version is not supported" }, |
| 92 | { WSANOTINITIALISED, "Successful WSAStartup() not yet performed" }, |
| 93 | { WSAEDISCON, "Graceful shutdown in progress" }, |
| 94 | /* Resolver errors */ |
| 95 | { WSAHOST_NOT_FOUND, "No such host is known" }, |
| 96 | { WSATRY_AGAIN, "Host not found, or server failed" }, |
| 97 | { WSANO_RECOVERY, "Unexpected server error encountered" }, |
| 98 | { WSANO_DATA, "Valid name without requested data" }, |
| 99 | { WSANO_ADDRESS, "No address, look for MX record" }, |
| 100 | { 0, NULL } |
| 101 | }; |
| 102 | PyObject *v; |
| 103 | const char *msg = "winsock error"; |
| 104 | |
| 105 | for (msgp = msgs; msgp->msg; msgp++) |
| 106 | { |
| 107 | if (errnum == msgp->num) |
| 108 | { |
| 109 | msg = msgp->msg; |
| 110 | break; |
| 111 | } |
| 112 | } |
| 113 | |
| 114 | v = Py_BuildValue("(is)", errnum, msg); |
| 115 | if (v != NULL) |
| 116 | { |
| 117 | PyErr_SetObject(ssl_SysCallError, v); |
| 118 | Py_DECREF(v); |
| 119 | } |
| 120 | return; |
| 121 | } |
| 122 | #else |
| 123 | PyErr_SetFromErrno(ssl_SysCallError); |
| 124 | #endif |
| 125 | } |
| 126 | |
| 127 | /* |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 128 | * Handle errors raised by BIO functions. |
| 129 | * |
| 130 | * Arguments: bio - The BIO object |
| 131 | * ret - The return value of the BIO_ function. |
| 132 | * Returns: None, the calling function should return NULL; |
| 133 | */ |
| 134 | static void |
| 135 | handle_bio_errors(BIO* bio, int ret) |
| 136 | { |
| 137 | if (BIO_should_retry(bio)) { |
| 138 | if (BIO_should_read(bio)) { |
| 139 | PyErr_SetNone(ssl_WantReadError); |
| 140 | } else if (BIO_should_write(bio)) { |
| 141 | PyErr_SetNone(ssl_WantWriteError); |
| 142 | } else if (BIO_should_io_special(bio)) { |
| 143 | /* |
| 144 | * It's somewhat unclear what this means. From the OpenSSL source, |
| 145 | * it seems like it should not be triggered by the memory BIO, so |
| 146 | * for the time being, this case shouldn't come up. The SSL BIO |
| 147 | * (which I think should be named the socket BIO) may trigger this |
| 148 | * case if its socket is not yet connected or it is busy doing |
| 149 | * something related to x509. |
| 150 | */ |
| 151 | PyErr_SetString(PyExc_ValueError, "BIO_should_io_special"); |
| 152 | } else { |
| 153 | /* |
| 154 | * I hope this is dead code. The BIO documentation suggests that |
| 155 | * one of the above three checks should always be true. |
| 156 | */ |
| 157 | PyErr_SetString(PyExc_ValueError, "unknown bio failure"); |
| 158 | } |
| 159 | } else { |
| 160 | /* |
| 161 | * If we aren't to retry, it's really an error, so fall back to the |
| 162 | * normal error reporting code. However, the BIO interface does not |
| 163 | * specify a uniform error reporting mechanism. We can only hope that |
| 164 | * the code which triggered the error also kindly pushed something onto |
| 165 | * the error stack. |
| 166 | */ |
| 167 | exception_from_error_queue(); |
| 168 | } |
| 169 | } |
| 170 | |
| 171 | /* |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 172 | * Handle errors raised by SSL I/O functions. NOTE: Not SSL_shutdown ;) |
| 173 | * |
| 174 | * Arguments: ssl - The SSL object |
| 175 | * err - The return code from SSL_get_error |
| 176 | * ret - The return code from the SSL I/O function |
| 177 | * Returns: None, the calling function should return NULL |
| 178 | */ |
| 179 | static void |
| 180 | handle_ssl_errors(SSL *ssl, int err, int ret) |
| 181 | { |
| 182 | switch (err) |
| 183 | { |
| 184 | /* |
| 185 | * Strange as it may seem, ZeroReturn is not an error per se. It means |
| 186 | * that the SSL Connection has been closed correctly (note, not the |
| 187 | * transport layer!), i.e. closure alerts have been exchanged. This is |
| 188 | * an exception since |
| 189 | * + There's an SSL "error" code for it |
| 190 | * + You have to deal with it in any case, close the transport layer |
| 191 | * etc |
| 192 | */ |
| 193 | case SSL_ERROR_ZERO_RETURN: |
| 194 | PyErr_SetNone(ssl_ZeroReturnError); |
| 195 | break; |
| 196 | |
| 197 | /* |
| 198 | * The WantXYZ exceptions don't mean that there's an error, just that |
| 199 | * nothing could be read/written just now, maybe because the transport |
| 200 | * layer would block on the operation, or that there's not enough data |
| 201 | * available to fill an entire SSL record. |
| 202 | */ |
| 203 | case SSL_ERROR_WANT_READ: |
| 204 | PyErr_SetNone(ssl_WantReadError); |
| 205 | break; |
| 206 | |
| 207 | case SSL_ERROR_WANT_WRITE: |
| 208 | PyErr_SetNone(ssl_WantWriteError); |
| 209 | break; |
| 210 | |
| 211 | case SSL_ERROR_WANT_X509_LOOKUP: |
| 212 | PyErr_SetNone(ssl_WantX509LookupError); |
| 213 | break; |
| 214 | |
| 215 | case SSL_ERROR_SYSCALL: |
| 216 | if (ERR_peek_error() == 0) |
| 217 | { |
| 218 | if (ret < 0) |
| 219 | { |
| 220 | syscall_from_errno(); |
| 221 | } |
| 222 | else |
| 223 | { |
| 224 | PyObject *v; |
| 225 | |
| 226 | v = Py_BuildValue("(is)", -1, "Unexpected EOF"); |
| 227 | if (v != NULL) |
| 228 | { |
| 229 | PyErr_SetObject(ssl_SysCallError, v); |
| 230 | Py_DECREF(v); |
| 231 | } |
| 232 | } |
| 233 | break; |
| 234 | } |
| 235 | |
| 236 | /* NOTE: Fall-through here, we don't want to duplicate code, right? */ |
| 237 | |
| 238 | case SSL_ERROR_SSL: |
| 239 | ; |
| 240 | default: |
| 241 | exception_from_error_queue(); |
| 242 | break; |
| 243 | } |
| 244 | } |
| 245 | |
| 246 | /* |
| 247 | * Here be member methods of the Connection "class" |
| 248 | */ |
| 249 | |
| 250 | static char ssl_Connection_get_context_doc[] = "\n\ |
| 251 | Get session context\n\ |
| 252 | \n\ |
| 253 | Arguments: self - The Connection object\n\ |
| 254 | args - The Python argument tuple, should be empty\n\ |
| 255 | Returns: A Context object\n\ |
| 256 | "; |
| 257 | static PyObject * |
| 258 | ssl_Connection_get_context(ssl_ConnectionObj *self, PyObject *args) |
| 259 | { |
| 260 | if (!PyArg_ParseTuple(args, ":get_context")) |
| 261 | return NULL; |
| 262 | |
| 263 | Py_INCREF(self->context); |
| 264 | return (PyObject *)self->context; |
| 265 | } |
| 266 | |
| 267 | static char ssl_Connection_pending_doc[] = "\n\ |
| 268 | Get the number of bytes that can be safely read from the connection\n\ |
| 269 | \n\ |
| 270 | Arguments: self - The Connection object\n\ |
| 271 | args - The Python argument tuple, should be empty\n\ |
| 272 | Returns: \n\ |
| 273 | "; |
| 274 | static PyObject * |
| 275 | ssl_Connection_pending(ssl_ConnectionObj *self, PyObject *args) |
| 276 | { |
| 277 | int ret; |
| 278 | |
| 279 | if (!PyArg_ParseTuple(args, ":pending")) |
| 280 | return NULL; |
| 281 | |
| 282 | ret = SSL_pending(self->ssl); |
| 283 | return PyInt_FromLong((long)ret); |
| 284 | } |
| 285 | |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 286 | static char ssl_Connection_bio_write_doc[] = "\n\ |
| 287 | When using non-socket connections this function sends\n\ |
| 288 | \"dirty\" data that would have traveled in on the network.\n\ |
| 289 | \n\ |
| 290 | Arguments: self - The Connection object\n\ |
| 291 | args - The Python argument tuple, should be:\n\ |
| 292 | buf - The string to bio_write\n\ |
| 293 | Returns: The number of bytes written\n\ |
| 294 | "; |
| 295 | static PyObject * |
| 296 | ssl_Connection_bio_write(ssl_ConnectionObj *self, PyObject *args) |
| 297 | { |
| 298 | char *buf; |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 299 | int len, ret; |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 300 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 301 | if (self->into_ssl == NULL) |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 302 | { |
| 303 | PyErr_SetString(PyExc_TypeError, "Connection sock was not None"); |
| 304 | return NULL; |
| 305 | } |
| 306 | |
Jean-Paul Calderone | fc4ed0f | 2009-04-27 11:51:27 -0400 | [diff] [blame] | 307 | if (!PyArg_ParseTuple(args, "s#|i:bio_write", &buf, &len)) |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 308 | return NULL; |
| 309 | |
| 310 | ret = BIO_write(self->into_ssl, buf, len); |
| 311 | |
| 312 | if (PyErr_Occurred()) |
| 313 | { |
| 314 | flush_error_queue(); |
| 315 | return NULL; |
| 316 | } |
| 317 | |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 318 | if (ret <= 0) { |
| 319 | /* |
| 320 | * There was a problem with the BIO_write of some sort. |
| 321 | */ |
Jean-Paul Calderone | 3ad85d4 | 2009-04-30 20:24:35 -0400 | [diff] [blame] | 322 | handle_bio_errors(self->into_ssl, ret); |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 323 | return NULL; |
| 324 | } |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 325 | |
| 326 | return PyInt_FromLong((long)ret); |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 327 | } |
| 328 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 329 | static char ssl_Connection_send_doc[] = "\n\ |
| 330 | Send data on the connection. NOTE: If you get one of the WantRead,\n\ |
| 331 | WantWrite or WantX509Lookup exceptions on this, you have to call the\n\ |
| 332 | method again with the SAME buffer.\n\ |
| 333 | \n\ |
| 334 | Arguments: self - The Connection object\n\ |
| 335 | args - The Python argument tuple, should be:\n\ |
| 336 | buf - The string to send\n\ |
| 337 | flags - (optional) Included for compatability with the socket\n\ |
| 338 | API, the value is ignored\n\ |
| 339 | Returns: The number of bytes written\n\ |
| 340 | "; |
| 341 | static PyObject * |
| 342 | ssl_Connection_send(ssl_ConnectionObj *self, PyObject *args) |
| 343 | { |
| 344 | char *buf; |
| 345 | int len, ret, err, flags; |
| 346 | |
| 347 | if (!PyArg_ParseTuple(args, "s#|i:send", &buf, &len, &flags)) |
| 348 | return NULL; |
| 349 | |
| 350 | MY_BEGIN_ALLOW_THREADS(self->tstate) |
| 351 | ret = SSL_write(self->ssl, buf, len); |
| 352 | MY_END_ALLOW_THREADS(self->tstate) |
| 353 | |
| 354 | if (PyErr_Occurred()) |
| 355 | { |
| 356 | flush_error_queue(); |
| 357 | return NULL; |
| 358 | } |
| 359 | |
| 360 | err = SSL_get_error(self->ssl, ret); |
| 361 | if (err == SSL_ERROR_NONE) |
| 362 | { |
| 363 | return PyInt_FromLong((long)ret); |
| 364 | } |
| 365 | else |
| 366 | { |
| 367 | handle_ssl_errors(self->ssl, err, ret); |
| 368 | return NULL; |
| 369 | } |
| 370 | } |
| 371 | |
| 372 | static char ssl_Connection_sendall_doc[] = "\n\ |
| 373 | Send \"all\" data on the connection. This calls send() repeatedly until\n\ |
| 374 | all data is sent. If an error occurs, it's impossible to tell how much data\n\ |
| 375 | has been sent.\n\ |
| 376 | \n\ |
| 377 | Arguments: self - The Connection object\n\ |
| 378 | args - The Python argument tuple, should be:\n\ |
| 379 | buf - The string to send\n\ |
| 380 | flags - (optional) Included for compatability with the socket\n\ |
| 381 | API, the value is ignored\n\ |
| 382 | Returns: The number of bytes written\n\ |
| 383 | "; |
| 384 | static PyObject * |
| 385 | ssl_Connection_sendall(ssl_ConnectionObj *self, PyObject *args) |
| 386 | { |
| 387 | char *buf; |
| 388 | int len, ret, err, flags; |
| 389 | PyObject *pyret = Py_None; |
| 390 | |
| 391 | if (!PyArg_ParseTuple(args, "s#|i:sendall", &buf, &len, &flags)) |
| 392 | return NULL; |
| 393 | |
| 394 | do { |
| 395 | MY_BEGIN_ALLOW_THREADS(self->tstate) |
| 396 | ret = SSL_write(self->ssl, buf, len); |
| 397 | MY_END_ALLOW_THREADS(self->tstate) |
| 398 | if (PyErr_Occurred()) |
| 399 | { |
| 400 | flush_error_queue(); |
| 401 | pyret = NULL; |
| 402 | break; |
| 403 | } |
| 404 | err = SSL_get_error(self->ssl, ret); |
| 405 | if (err == SSL_ERROR_NONE) |
| 406 | { |
| 407 | buf += ret; |
| 408 | len -= ret; |
| 409 | } |
| 410 | else if (err == SSL_ERROR_SSL || err == SSL_ERROR_SYSCALL || |
| 411 | err == SSL_ERROR_ZERO_RETURN) |
| 412 | { |
| 413 | handle_ssl_errors(self->ssl, err, ret); |
| 414 | pyret = NULL; |
| 415 | break; |
| 416 | } |
| 417 | } while (len > 0); |
| 418 | |
| 419 | Py_XINCREF(pyret); |
| 420 | return pyret; |
| 421 | } |
| 422 | |
| 423 | static char ssl_Connection_recv_doc[] = "\n\ |
| 424 | Receive data on the connection. NOTE: If you get one of the WantRead,\n\ |
| 425 | WantWrite or WantX509Lookup exceptions on this, you have to call the\n\ |
| 426 | method again with the SAME buffer.\n\ |
| 427 | \n\ |
| 428 | Arguments: self - The Connection object\n\ |
| 429 | args - The Python argument tuple, should be:\n\ |
| 430 | bufsiz - The maximum number of bytes to read\n\ |
| 431 | flags - (optional) Included for compatability with the socket\n\ |
| 432 | API, the value is ignored\n\ |
| 433 | Returns: The number of bytes read\n\ |
| 434 | "; |
| 435 | static PyObject * |
| 436 | ssl_Connection_recv(ssl_ConnectionObj *self, PyObject *args) |
| 437 | { |
| 438 | int bufsiz, ret, err, flags; |
| 439 | PyObject *buf; |
| 440 | |
| 441 | if (!PyArg_ParseTuple(args, "i|i:recv", &bufsiz, &flags)) |
| 442 | return NULL; |
| 443 | |
| 444 | buf = PyString_FromStringAndSize(NULL, bufsiz); |
| 445 | if (buf == NULL) |
| 446 | return NULL; |
| 447 | |
| 448 | MY_BEGIN_ALLOW_THREADS(self->tstate) |
| 449 | ret = SSL_read(self->ssl, PyString_AsString(buf), bufsiz); |
| 450 | MY_END_ALLOW_THREADS(self->tstate) |
| 451 | |
| 452 | if (PyErr_Occurred()) |
| 453 | { |
| 454 | Py_DECREF(buf); |
| 455 | flush_error_queue(); |
| 456 | return NULL; |
| 457 | } |
| 458 | |
| 459 | err = SSL_get_error(self->ssl, ret); |
| 460 | if (err == SSL_ERROR_NONE) |
| 461 | { |
| 462 | if (ret != bufsiz && _PyString_Resize(&buf, ret) < 0) |
| 463 | return NULL; |
| 464 | return buf; |
| 465 | } |
| 466 | else |
| 467 | { |
| 468 | handle_ssl_errors(self->ssl, err, ret); |
| 469 | Py_DECREF(buf); |
| 470 | return NULL; |
| 471 | } |
| 472 | } |
| 473 | |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 474 | static char ssl_Connection_bio_read_doc[] = "\n\ |
| 475 | When using non-socket connections this function reads\n\ |
| 476 | the \"dirty\" data that would have traveled away on the network.\n\ |
| 477 | \n\ |
| 478 | Arguments: self - The Connection object\n\ |
| 479 | args - The Python argument tuple, should be:\n\ |
| 480 | bufsiz - The maximum number of bytes to read\n\ |
| 481 | Returns: The string read.\n\ |
| 482 | "; |
| 483 | static PyObject * |
| 484 | ssl_Connection_bio_read(ssl_ConnectionObj *self, PyObject *args) |
| 485 | { |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 486 | int bufsiz, ret; |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 487 | PyObject *buf; |
| 488 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 489 | if (self->from_ssl == NULL) |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 490 | { |
| 491 | PyErr_SetString(PyExc_TypeError, "Connection sock was not None"); |
| 492 | return NULL; |
| 493 | } |
| 494 | |
| 495 | if (!PyArg_ParseTuple(args, "i:bio_read", &bufsiz)) |
| 496 | return NULL; |
| 497 | |
| 498 | buf = PyString_FromStringAndSize(NULL, bufsiz); |
| 499 | if (buf == NULL) |
| 500 | return NULL; |
| 501 | |
| 502 | ret = BIO_read(self->from_ssl, PyString_AsString(buf), bufsiz); |
| 503 | |
| 504 | if (PyErr_Occurred()) |
| 505 | { |
| 506 | Py_DECREF(buf); |
| 507 | flush_error_queue(); |
| 508 | return NULL; |
| 509 | } |
| 510 | |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 511 | if (ret <= 0) { |
| 512 | /* |
| 513 | * There was a problem with the BIO_read of some sort. |
| 514 | */ |
| 515 | handle_bio_errors(self->from_ssl, ret); |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 516 | Py_DECREF(buf); |
| 517 | return NULL; |
| 518 | } |
Jean-Paul Calderone | aff0fc4 | 2009-04-27 17:13:34 -0400 | [diff] [blame] | 519 | |
| 520 | /* |
| 521 | * Shrink the string to match the number of bytes we actually read. |
| 522 | */ |
| 523 | if (ret != bufsiz && _PyString_Resize(&buf, ret) < 0) |
| 524 | { |
| 525 | Py_DECREF(buf); |
| 526 | return NULL; |
| 527 | } |
| 528 | return buf; |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 529 | } |
| 530 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 531 | static char ssl_Connection_renegotiate_doc[] = "\n\ |
| 532 | Renegotiate the session\n\ |
| 533 | \n\ |
| 534 | Arguments: self - The Connection object\n\ |
| 535 | args - The Python argument tuple, should be empty\n\ |
| 536 | Returns: True if the renegotiation can be started, false otherwise\n\ |
| 537 | "; |
| 538 | static PyObject * |
| 539 | ssl_Connection_renegotiate(ssl_ConnectionObj *self, PyObject *args) |
| 540 | { |
| 541 | int ret; |
| 542 | |
| 543 | if (!PyArg_ParseTuple(args, ":renegotiate")) |
| 544 | return NULL; |
| 545 | |
| 546 | MY_BEGIN_ALLOW_THREADS(self->tstate); |
| 547 | ret = SSL_renegotiate(self->ssl); |
| 548 | MY_END_ALLOW_THREADS(self->tstate); |
| 549 | |
| 550 | if (PyErr_Occurred()) |
| 551 | { |
| 552 | flush_error_queue(); |
| 553 | return NULL; |
| 554 | } |
| 555 | |
| 556 | return PyInt_FromLong((long)ret); |
| 557 | } |
| 558 | |
| 559 | static char ssl_Connection_do_handshake_doc[] = "\n\ |
| 560 | Perform an SSL handshake (usually called after renegotiate() or one of\n\ |
| 561 | set_*_state()). This can raise the same exceptions as send and recv.\n\ |
| 562 | \n\ |
| 563 | Arguments: self - The Connection object\n\ |
| 564 | args - The Python argument tuple, should be empty\n\ |
| 565 | Returns: None.\n\ |
| 566 | "; |
| 567 | static PyObject * |
| 568 | ssl_Connection_do_handshake(ssl_ConnectionObj *self, PyObject *args) |
| 569 | { |
| 570 | int ret, err; |
| 571 | |
| 572 | if (!PyArg_ParseTuple(args, ":do_handshake")) |
| 573 | return NULL; |
| 574 | |
| 575 | MY_BEGIN_ALLOW_THREADS(self->tstate); |
| 576 | ret = SSL_do_handshake(self->ssl); |
| 577 | MY_END_ALLOW_THREADS(self->tstate); |
| 578 | |
| 579 | if (PyErr_Occurred()) |
| 580 | { |
| 581 | flush_error_queue(); |
| 582 | return NULL; |
| 583 | } |
| 584 | |
| 585 | err = SSL_get_error(self->ssl, ret); |
| 586 | if (err == SSL_ERROR_NONE) |
| 587 | { |
| 588 | Py_INCREF(Py_None); |
| 589 | return Py_None; |
| 590 | } |
| 591 | else |
| 592 | { |
| 593 | handle_ssl_errors(self->ssl, err, ret); |
| 594 | return NULL; |
| 595 | } |
| 596 | } |
| 597 | |
| 598 | #if defined(OPENSSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x00907000L |
| 599 | static char ssl_Connection_renegotiate_pending_doc[] = "\n\ |
| 600 | Check if there's a renegotiation in progress, it will return false once\n\ |
| 601 | a renegotiation is finished.\n\ |
| 602 | \n\ |
| 603 | Arguments: self - The Connection object\n\ |
| 604 | args - The Python argument tuple, should be empty\n\ |
| 605 | Returns: Whether there's a renegotiation in progress\n\ |
| 606 | "; |
| 607 | static PyObject * |
| 608 | ssl_Connection_renegotiate_pending(ssl_ConnectionObj *self, PyObject *args) |
| 609 | { |
| 610 | if (!PyArg_ParseTuple(args, ":renegotiate_pending")) |
| 611 | return NULL; |
| 612 | |
| 613 | return PyInt_FromLong((long)SSL_renegotiate_pending(self->ssl)); |
| 614 | } |
| 615 | #endif |
| 616 | |
| 617 | static char ssl_Connection_total_renegotiations_doc[] = "\n\ |
| 618 | Find out the total number of renegotiations.\n\ |
| 619 | \n\ |
| 620 | Arguments: self - The Connection object\n\ |
| 621 | args - The Python argument tuple, should be empty\n\ |
| 622 | Returns: The number of renegotiations.\n\ |
| 623 | "; |
| 624 | static PyObject * |
| 625 | ssl_Connection_total_renegotiations(ssl_ConnectionObj *self, PyObject *args) |
| 626 | { |
| 627 | if (!PyArg_ParseTuple(args, ":total_renegotiations")) |
| 628 | return NULL; |
| 629 | |
| 630 | return PyInt_FromLong(SSL_total_renegotiations(self->ssl)); |
| 631 | } |
| 632 | |
| 633 | static char ssl_Connection_set_accept_state_doc[] = "\n\ |
| 634 | Set the connection to work in server mode. The handshake will be handled\n\ |
| 635 | automatically by read/write.\n\ |
| 636 | \n\ |
| 637 | Arguments: self - The Connection object\n\ |
| 638 | args - The Python argument tuple, should be empty\n\ |
| 639 | Returns: None\n\ |
| 640 | "; |
| 641 | static PyObject * |
| 642 | ssl_Connection_set_accept_state(ssl_ConnectionObj *self, PyObject *args) |
| 643 | { |
| 644 | if (!PyArg_ParseTuple(args, ":set_accept_state")) |
| 645 | return NULL; |
| 646 | |
| 647 | SSL_set_accept_state(self->ssl); |
| 648 | |
| 649 | Py_INCREF(Py_None); |
| 650 | return Py_None; |
| 651 | } |
| 652 | |
| 653 | static char ssl_Connection_set_connect_state_doc[] = "\n\ |
| 654 | Set the connection to work in client mode. The handshake will be handled\n\ |
| 655 | automatically by read/write.\n\ |
| 656 | \n\ |
| 657 | Arguments: self - The Connection object\n\ |
| 658 | args - The Python argument tuple, should be empty\n\ |
| 659 | Returns: None\n\ |
| 660 | "; |
| 661 | static PyObject * |
| 662 | ssl_Connection_set_connect_state(ssl_ConnectionObj *self, PyObject *args) |
| 663 | { |
| 664 | if (!PyArg_ParseTuple(args, ":set_connect_state")) |
| 665 | return NULL; |
| 666 | |
| 667 | SSL_set_connect_state(self->ssl); |
| 668 | |
| 669 | Py_INCREF(Py_None); |
| 670 | return Py_None; |
| 671 | } |
| 672 | |
| 673 | static char ssl_Connection_connect_doc[] = "\n\ |
| 674 | Connect to remote host and set up client-side SSL\n\ |
| 675 | \n\ |
| 676 | Arguments: self - The Connection object\n\ |
| 677 | args - The Python argument tuple, should be:\n\ |
| 678 | addr - A remote address\n\ |
| 679 | Returns: What the socket's connect method returns\n\ |
| 680 | "; |
| 681 | static PyObject * |
| 682 | ssl_Connection_connect(ssl_ConnectionObj *self, PyObject *args) |
| 683 | { |
| 684 | PyObject *meth, *ret; |
| 685 | |
| 686 | if ((meth = PyObject_GetAttrString(self->socket, "connect")) == NULL) |
| 687 | return NULL; |
| 688 | |
| 689 | SSL_set_connect_state(self->ssl); |
| 690 | |
| 691 | ret = PyEval_CallObject(meth, args); |
| 692 | Py_DECREF(meth); |
| 693 | if (ret == NULL) |
| 694 | return NULL; |
| 695 | |
| 696 | return ret; |
| 697 | } |
| 698 | |
| 699 | static char ssl_Connection_connect_ex_doc[] = "\n\ |
| 700 | Connect to remote host and set up client-side SSL. Note that if the socket's\n\ |
| 701 | connect_ex method doesn't return 0, SSL won't be initialized.\n\ |
| 702 | \n\ |
| 703 | Arguments: self - The Connection object\n\ |
| 704 | args - The Python argument tuple, should be:\n\ |
| 705 | addr - A remove address\n\ |
| 706 | Returns: What the socket's connect_ex method returns\n\ |
| 707 | "; |
| 708 | static PyObject * |
| 709 | ssl_Connection_connect_ex(ssl_ConnectionObj *self, PyObject *args) |
| 710 | { |
| 711 | PyObject *meth, *ret; |
| 712 | |
| 713 | if ((meth = PyObject_GetAttrString(self->socket, "connect_ex")) == NULL) |
| 714 | return NULL; |
| 715 | |
| 716 | SSL_set_connect_state(self->ssl); |
| 717 | |
| 718 | ret = PyEval_CallObject(meth, args); |
| 719 | Py_DECREF(meth); |
| 720 | if (ret == NULL) |
| 721 | return NULL; |
| 722 | if (PyInt_Check(ret) && PyInt_AsLong(ret) != 0) |
| 723 | return ret; |
| 724 | |
| 725 | return ret; |
| 726 | } |
| 727 | |
| 728 | static char ssl_Connection_accept_doc[] = "\n\ |
| 729 | Accept incoming connection and set up SSL on it\n\ |
| 730 | \n\ |
| 731 | Arguments: self - The Connection object\n\ |
| 732 | args - The Python argument tuple, should be empty\n\ |
| 733 | Returns: A (conn,addr) pair where conn is a Connection and addr is an\n\ |
| 734 | address\n\ |
| 735 | "; |
| 736 | static PyObject * |
| 737 | ssl_Connection_accept(ssl_ConnectionObj *self, PyObject *args) |
| 738 | { |
| 739 | PyObject *tuple, *socket, *address, *meth; |
| 740 | ssl_ConnectionObj *conn; |
| 741 | |
| 742 | if ((meth = PyObject_GetAttrString(self->socket, "accept")) == NULL) |
| 743 | return NULL; |
| 744 | tuple = PyEval_CallObject(meth, args); |
| 745 | Py_DECREF(meth); |
| 746 | if (tuple == NULL) |
| 747 | return NULL; |
| 748 | |
| 749 | socket = PyTuple_GetItem(tuple, 0); |
| 750 | Py_INCREF(socket); |
| 751 | address = PyTuple_GetItem(tuple, 1); |
| 752 | Py_INCREF(address); |
| 753 | Py_DECREF(tuple); |
| 754 | |
| 755 | conn = ssl_Connection_New(self->context, socket); |
| 756 | Py_DECREF(socket); |
| 757 | if (conn == NULL) |
| 758 | { |
| 759 | Py_DECREF(address); |
| 760 | return NULL; |
| 761 | } |
| 762 | |
| 763 | SSL_set_accept_state(conn->ssl); |
| 764 | |
| 765 | tuple = Py_BuildValue("(OO)", conn, address); |
| 766 | |
| 767 | Py_DECREF(conn); |
| 768 | Py_DECREF(address); |
| 769 | |
| 770 | return tuple; |
| 771 | } |
| 772 | |
Jean-Paul Calderone | 3ad85d4 | 2009-04-30 20:24:35 -0400 | [diff] [blame] | 773 | static char ssl_Connection_bio_shutdown_doc[] = "\n\ |
| 774 | When using non-socket connections this function signals end of\n\ |
| 775 | data on the input for this connection.\n\ |
| 776 | \n\ |
| 777 | Arguments: self - The Connection object\n\ |
| 778 | args - The Python argument tuple, should be empty.\n\ |
| 779 | Returns: Nothing\n\ |
| 780 | "; |
| 781 | |
| 782 | static PyObject * |
| 783 | ssl_Connection_bio_shutdown(ssl_ConnectionObj *self, PyObject *args) |
| 784 | { |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 785 | if (self->from_ssl == NULL) |
| 786 | { |
| 787 | PyErr_SetString(PyExc_TypeError, "Connection sock was not None"); |
| 788 | return NULL; |
| 789 | } |
| 790 | |
Jean-Paul Calderone | 3ad85d4 | 2009-04-30 20:24:35 -0400 | [diff] [blame] | 791 | BIO_set_mem_eof_return(self->into_ssl, 0); |
| 792 | Py_INCREF(Py_None); |
| 793 | return Py_None; |
| 794 | } |
| 795 | |
| 796 | |
| 797 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 798 | static char ssl_Connection_shutdown_doc[] = "\n\ |
| 799 | Send closure alert\n\ |
| 800 | \n\ |
| 801 | Arguments: self - The Connection object\n\ |
| 802 | args - The Python argument tuple, should be empty\n\ |
| 803 | Returns: True if the shutdown completed successfully (i.e. both sides\n\ |
| 804 | have sent closure alerts), false otherwise (i.e. you have to\n\ |
| 805 | wait for a ZeroReturnError on a recv() method call\n\ |
| 806 | "; |
| 807 | static PyObject * |
| 808 | ssl_Connection_shutdown(ssl_ConnectionObj *self, PyObject *args) |
| 809 | { |
| 810 | int ret; |
| 811 | |
| 812 | if (!PyArg_ParseTuple(args, ":shutdown")) |
| 813 | return NULL; |
| 814 | |
| 815 | MY_BEGIN_ALLOW_THREADS(self->tstate) |
| 816 | ret = SSL_shutdown(self->ssl); |
| 817 | MY_END_ALLOW_THREADS(self->tstate) |
| 818 | |
| 819 | if (PyErr_Occurred()) |
| 820 | { |
| 821 | flush_error_queue(); |
| 822 | return NULL; |
| 823 | } |
| 824 | |
| 825 | if (ret < 0) |
| 826 | { |
| 827 | exception_from_error_queue(); |
| 828 | return NULL; |
| 829 | } |
| 830 | else if (ret > 0) |
| 831 | { |
| 832 | Py_INCREF(Py_True); |
| 833 | return Py_True; |
| 834 | } |
| 835 | else |
| 836 | { |
| 837 | Py_INCREF(Py_False); |
| 838 | return Py_False; |
| 839 | } |
| 840 | } |
| 841 | |
| 842 | static char ssl_Connection_get_cipher_list_doc[] = "\n\ |
| 843 | Get the session cipher list\n\ |
| 844 | WARNING: API change! This used to take an optional argument, and return a\n\ |
| 845 | string.\n\ |
| 846 | \n\ |
| 847 | Arguments: self - The Connection object\n\ |
| 848 | args - The Python argument tuple, should be empty\n\ |
| 849 | Returns: A list of cipher strings\n\ |
| 850 | "; |
| 851 | static PyObject * |
| 852 | ssl_Connection_get_cipher_list(ssl_ConnectionObj *self, PyObject *args) |
| 853 | { |
| 854 | int idx = 0; |
| 855 | const char *ret; |
| 856 | PyObject *lst, *item; |
| 857 | |
| 858 | if (!PyArg_ParseTuple(args, ":get_cipher_list")) |
| 859 | return NULL; |
| 860 | |
| 861 | lst = PyList_New(0); |
| 862 | while ((ret = SSL_get_cipher_list(self->ssl, idx)) != NULL) |
| 863 | { |
| 864 | item = PyString_FromString(ret); |
| 865 | PyList_Append(lst, item); |
| 866 | Py_DECREF(item); |
| 867 | idx++; |
| 868 | } |
| 869 | return lst; |
| 870 | } |
| 871 | |
| 872 | static char ssl_Connection_makefile_doc[] = "\n\ |
| 873 | The makefile() method is not implemented, since there is no dup semantics\n\ |
| 874 | for SSL connections\n\ |
| 875 | XXX: Return self instead?\n\ |
| 876 | \n\ |
| 877 | Arguments: self - The Connection object\n\ |
| 878 | args - The Python argument tuple, should be empty\n\ |
| 879 | Returns: NULL\n\ |
| 880 | "; |
| 881 | static PyObject * |
| 882 | ssl_Connection_makefile(ssl_ConnectionObj *self, PyObject *args) |
| 883 | { |
| 884 | PyErr_SetString(PyExc_NotImplementedError, "Cannot make file object of SSL.Connection"); |
| 885 | return NULL; |
| 886 | } |
| 887 | |
| 888 | static char ssl_Connection_get_app_data_doc[] = "\n\ |
| 889 | Get application data\n\ |
| 890 | \n\ |
| 891 | Arguments: self - The Connection object\n\ |
| 892 | args - The Python argument tuple, should be empty\n\ |
| 893 | Returns: The application data\n\ |
| 894 | "; |
| 895 | static PyObject * |
| 896 | ssl_Connection_get_app_data(ssl_ConnectionObj *self, PyObject *args) |
| 897 | { |
| 898 | if (!PyArg_ParseTuple(args, ":get_app_data")) |
| 899 | return NULL; |
| 900 | |
| 901 | Py_INCREF(self->app_data); |
| 902 | return self->app_data; |
| 903 | } |
| 904 | |
| 905 | static char ssl_Connection_set_app_data_doc[] = "\n\ |
| 906 | Set application data\n\ |
| 907 | \n\ |
| 908 | Arguments: self - The Connection object\n\ |
| 909 | args - The Python argument tuple, should be\n\ |
| 910 | data - The application data\n\ |
| 911 | Returns: None\n\ |
| 912 | "; |
| 913 | static PyObject * |
| 914 | ssl_Connection_set_app_data(ssl_ConnectionObj *self, PyObject *args) |
| 915 | { |
| 916 | PyObject *data; |
| 917 | |
| 918 | if (!PyArg_ParseTuple(args, "O:set_app_data", &data)) |
| 919 | return NULL; |
| 920 | |
| 921 | Py_DECREF(self->app_data); |
| 922 | Py_INCREF(data); |
| 923 | self->app_data = data; |
| 924 | |
| 925 | Py_INCREF(Py_None); |
| 926 | return Py_None; |
| 927 | } |
| 928 | |
Jean-Paul Calderone | 72b8f0f | 2008-02-21 23:57:40 -0500 | [diff] [blame] | 929 | static char ssl_Connection_get_shutdown_doc[] = "\n\ |
| 930 | Get shutdown state\n\ |
| 931 | \n\ |
| 932 | Arguments: self - The Connection object\n\ |
| 933 | args - The Python argument tuple, should be empty\n\ |
| 934 | Returns: The shutdown state, a bitmask of SENT_SHUTDOWN, RECEIVED_SHUTDOWN.\n\ |
| 935 | "; |
| 936 | static PyObject * |
| 937 | ssl_Connection_get_shutdown(ssl_ConnectionObj *self, PyObject *args) |
| 938 | { |
| 939 | if (!PyArg_ParseTuple(args, ":get_shutdown")) |
| 940 | return NULL; |
| 941 | |
| 942 | return PyInt_FromLong((long)SSL_get_shutdown(self->ssl)); |
| 943 | } |
| 944 | |
| 945 | static char ssl_Connection_set_shutdown_doc[] = "\n\ |
| 946 | Set shutdown state\n\ |
| 947 | \n\ |
| 948 | Arguments: self - The Connection object\n\ |
| 949 | args - The Python argument tuple, should be\n\ |
| 950 | shutdown state - bitmask of SENT_SHUTDOWN, RECEIVED_SHUTDOWN.\n\ |
| 951 | Returns: None\n\ |
| 952 | "; |
| 953 | static PyObject * |
| 954 | ssl_Connection_set_shutdown(ssl_ConnectionObj *self, PyObject *args) |
| 955 | { |
| 956 | int shutdown; |
| 957 | |
| 958 | if (!PyArg_ParseTuple(args, "i:set_shutdown", &shutdown)) |
| 959 | return NULL; |
| 960 | |
| 961 | SSL_set_shutdown(self->ssl, shutdown); |
| 962 | Py_INCREF(Py_None); |
| 963 | return Py_None; |
| 964 | } |
| 965 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 966 | static char ssl_Connection_state_string_doc[] = "\n\ |
| 967 | Get a verbose state description\n\ |
| 968 | \n\ |
| 969 | Arguments: self - The Connection object\n\ |
| 970 | args - The Python argument tuple, should be empty\n\ |
| 971 | Returns: A string representing the state\n\ |
| 972 | "; |
| 973 | static PyObject * |
| 974 | ssl_Connection_state_string(ssl_ConnectionObj *self, PyObject *args) |
| 975 | { |
| 976 | if (!PyArg_ParseTuple(args, ":state_string")) |
| 977 | return NULL; |
| 978 | |
| 979 | return PyString_FromString(SSL_state_string_long(self->ssl)); |
| 980 | } |
| 981 | |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 982 | static char ssl_Connection_client_random_doc[] = "\n\ |
| 983 | Get a copy of the client hello nonce.\n\ |
| 984 | \n\ |
| 985 | Arguments: self - The Connection object\n\ |
| 986 | args - The Python argument tuple, should be empty\n\ |
| 987 | Returns: A string representing the state\n\ |
| 988 | "; |
| 989 | static PyObject * |
| 990 | ssl_Connection_client_random(ssl_ConnectionObj *self, PyObject *args) |
| 991 | { |
| 992 | if (!PyArg_ParseTuple(args, ":client_random")) |
| 993 | return NULL; |
| 994 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 995 | if (self->ssl->session == NULL) { |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 996 | Py_INCREF(Py_None); |
| 997 | return Py_None; |
| 998 | } |
| 999 | return PyString_FromStringAndSize( (const char *) self->ssl->s3->client_random, SSL3_RANDOM_SIZE); |
| 1000 | } |
| 1001 | |
| 1002 | static char ssl_Connection_server_random_doc[] = "\n\ |
| 1003 | Get a copy of the server hello nonce.\n\ |
| 1004 | \n\ |
| 1005 | Arguments: self - The Connection object\n\ |
| 1006 | args - The Python argument tuple, should be empty\n\ |
| 1007 | Returns: A string representing the state\n\ |
| 1008 | "; |
| 1009 | static PyObject * |
| 1010 | ssl_Connection_server_random(ssl_ConnectionObj *self, PyObject *args) |
| 1011 | { |
| 1012 | if (!PyArg_ParseTuple(args, ":server_random")) |
| 1013 | return NULL; |
| 1014 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 1015 | if (self->ssl->session == NULL) { |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1016 | Py_INCREF(Py_None); |
| 1017 | return Py_None; |
| 1018 | } |
| 1019 | return PyString_FromStringAndSize( (const char *) self->ssl->s3->server_random, SSL3_RANDOM_SIZE); |
| 1020 | } |
| 1021 | |
| 1022 | static char ssl_Connection_master_key_doc[] = "\n\ |
| 1023 | Get a copy of the master key.\n\ |
| 1024 | \n\ |
| 1025 | Arguments: self - The Connection object\n\ |
| 1026 | args - The Python argument tuple, should be empty\n\ |
| 1027 | Returns: A string representing the state\n\ |
| 1028 | "; |
| 1029 | static PyObject * |
| 1030 | ssl_Connection_master_key(ssl_ConnectionObj *self, PyObject *args) |
| 1031 | { |
| 1032 | if (!PyArg_ParseTuple(args, ":master_key")) |
| 1033 | return NULL; |
| 1034 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 1035 | if (self->ssl->session == NULL) { |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1036 | Py_INCREF(Py_None); |
| 1037 | return Py_None; |
| 1038 | } |
| 1039 | return PyString_FromStringAndSize( (const char *) self->ssl->session->master_key, self->ssl->session->master_key_length); |
| 1040 | } |
| 1041 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1042 | static char ssl_Connection_sock_shutdown_doc[] = "\n\ |
| 1043 | See shutdown(2)\n\ |
| 1044 | \n\ |
| 1045 | Arguments: self - The Connection object\n\ |
| 1046 | args - The Python argument tuple, should be whatever the\n\ |
| 1047 | socket's shutdown() method expects\n\ |
| 1048 | Returns: What the socket's shutdown() method returns\n\ |
| 1049 | "; |
| 1050 | static PyObject * |
| 1051 | ssl_Connection_sock_shutdown(ssl_ConnectionObj *self, PyObject *args) |
| 1052 | { |
| 1053 | PyObject *meth, *ret; |
| 1054 | |
| 1055 | if ((meth = PyObject_GetAttrString(self->socket, "shutdown")) == NULL) |
| 1056 | return NULL; |
| 1057 | ret = PyEval_CallObject(meth, args); |
| 1058 | Py_DECREF(meth); |
| 1059 | return ret; |
| 1060 | } |
| 1061 | |
| 1062 | static char ssl_Connection_get_peer_certificate_doc[] = "\n\ |
| 1063 | Retrieve the other side's certificate (if any)\n\ |
| 1064 | \n\ |
| 1065 | Arguments: self - The Connection object\n\ |
| 1066 | args - The Python argument tuple, should be empty\n\ |
| 1067 | Returns: The peer's certificate\n\ |
| 1068 | "; |
| 1069 | static PyObject * |
| 1070 | ssl_Connection_get_peer_certificate(ssl_ConnectionObj *self, PyObject *args) |
| 1071 | { |
| 1072 | X509 *cert; |
| 1073 | |
| 1074 | if (!PyArg_ParseTuple(args, ":get_peer_certificate")) |
| 1075 | return NULL; |
| 1076 | |
| 1077 | cert = SSL_get_peer_certificate(self->ssl); |
| 1078 | if (cert != NULL) |
| 1079 | { |
| 1080 | return (PyObject *)crypto_X509_New(cert, 1); |
| 1081 | } |
| 1082 | else |
| 1083 | { |
| 1084 | Py_INCREF(Py_None); |
| 1085 | return Py_None; |
| 1086 | } |
| 1087 | } |
| 1088 | |
| 1089 | static char ssl_Connection_want_read_doc[] = "\n\ |
| 1090 | Checks if more data has to be read from the transport layer to complete an\n\ |
| 1091 | operation.\n\ |
| 1092 | \n\ |
| 1093 | Arguments: self - The Connection object\n\ |
| 1094 | args - The Python argument tuple, should be empty\n\ |
| 1095 | Returns: True iff more data has to be read\n\ |
| 1096 | "; |
| 1097 | static PyObject * |
| 1098 | ssl_Connection_want_read(ssl_ConnectionObj *self, PyObject *args) |
| 1099 | { |
| 1100 | if (!PyArg_ParseTuple(args, ":want_read")) |
| 1101 | return NULL; |
| 1102 | |
| 1103 | return PyInt_FromLong((long)SSL_want_read(self->ssl)); |
| 1104 | } |
| 1105 | |
| 1106 | static char ssl_Connection_want_write_doc[] = "\n\ |
| 1107 | Checks if there is data to write to the transport layer to complete an\n\ |
| 1108 | operation.\n\ |
| 1109 | \n\ |
| 1110 | Arguments: self - The Connection object\n\ |
| 1111 | args - The Python argument tuple, should be empty\n\ |
| 1112 | Returns: True iff there is data to write\n\ |
| 1113 | "; |
| 1114 | static PyObject * |
| 1115 | ssl_Connection_want_write(ssl_ConnectionObj *self, PyObject *args) |
| 1116 | { |
| 1117 | if (!PyArg_ParseTuple(args, ":want_write")) |
| 1118 | return NULL; |
| 1119 | |
| 1120 | return PyInt_FromLong((long)SSL_want_write(self->ssl)); |
| 1121 | } |
| 1122 | |
| 1123 | /* |
| 1124 | * Member methods in the Connection object |
| 1125 | * ADD_METHOD(name) expands to a correct PyMethodDef declaration |
| 1126 | * { 'name', (PyCFunction)ssl_Connection_name, METH_VARARGS } |
| 1127 | * for convenience |
| 1128 | * ADD_ALIAS(name,real) creates an "alias" of the ssl_Connection_real |
| 1129 | * function with the name 'name' |
| 1130 | */ |
| 1131 | #define ADD_METHOD(name) \ |
| 1132 | { #name, (PyCFunction)ssl_Connection_##name, METH_VARARGS, ssl_Connection_##name##_doc } |
| 1133 | #define ADD_ALIAS(name,real) \ |
| 1134 | { #name, (PyCFunction)ssl_Connection_##real, METH_VARARGS, ssl_Connection_##real##_doc } |
| 1135 | static PyMethodDef ssl_Connection_methods[] = |
| 1136 | { |
| 1137 | ADD_METHOD(get_context), |
| 1138 | ADD_METHOD(pending), |
| 1139 | ADD_METHOD(send), |
| 1140 | ADD_ALIAS (write, send), |
| 1141 | ADD_METHOD(sendall), |
| 1142 | ADD_METHOD(recv), |
| 1143 | ADD_ALIAS (read, recv), |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1144 | ADD_METHOD(bio_read), |
| 1145 | ADD_METHOD(bio_write), |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1146 | ADD_METHOD(renegotiate), |
| 1147 | ADD_METHOD(do_handshake), |
| 1148 | #if defined(OPENSSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x00907000L |
| 1149 | ADD_METHOD(renegotiate_pending), |
| 1150 | #endif |
| 1151 | ADD_METHOD(total_renegotiations), |
| 1152 | ADD_METHOD(connect), |
| 1153 | ADD_METHOD(connect_ex), |
| 1154 | ADD_METHOD(accept), |
Jean-Paul Calderone | 3ad85d4 | 2009-04-30 20:24:35 -0400 | [diff] [blame] | 1155 | ADD_METHOD(bio_shutdown), |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1156 | ADD_METHOD(shutdown), |
| 1157 | ADD_METHOD(get_cipher_list), |
| 1158 | ADD_METHOD(makefile), |
| 1159 | ADD_METHOD(get_app_data), |
| 1160 | ADD_METHOD(set_app_data), |
Jean-Paul Calderone | 72b8f0f | 2008-02-21 23:57:40 -0500 | [diff] [blame] | 1161 | ADD_METHOD(get_shutdown), |
| 1162 | ADD_METHOD(set_shutdown), |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1163 | ADD_METHOD(state_string), |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1164 | ADD_METHOD(server_random), |
| 1165 | ADD_METHOD(client_random), |
| 1166 | ADD_METHOD(master_key), |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1167 | ADD_METHOD(sock_shutdown), |
| 1168 | ADD_METHOD(get_peer_certificate), |
| 1169 | ADD_METHOD(want_read), |
| 1170 | ADD_METHOD(want_write), |
| 1171 | ADD_METHOD(set_accept_state), |
| 1172 | ADD_METHOD(set_connect_state), |
| 1173 | { NULL, NULL } |
| 1174 | }; |
| 1175 | #undef ADD_ALIAS |
| 1176 | #undef ADD_METHOD |
| 1177 | |
| 1178 | |
| 1179 | /* |
| 1180 | * Constructor for Connection objects |
| 1181 | * |
| 1182 | * Arguments: ctx - An SSL Context to use for this connection |
| 1183 | * sock - The socket to use for transport layer |
| 1184 | * Returns: The newly created Connection object |
| 1185 | */ |
| 1186 | ssl_ConnectionObj * |
| 1187 | ssl_Connection_New(ssl_ContextObj *ctx, PyObject *sock) |
| 1188 | { |
| 1189 | ssl_ConnectionObj *self; |
| 1190 | int fd; |
| 1191 | |
| 1192 | self = PyObject_GC_New(ssl_ConnectionObj, &ssl_Connection_Type); |
| 1193 | if (self == NULL) |
| 1194 | return NULL; |
| 1195 | |
| 1196 | Py_INCREF(ctx); |
| 1197 | self->context = ctx; |
| 1198 | |
| 1199 | Py_INCREF(sock); |
| 1200 | self->socket = sock; |
| 1201 | |
| 1202 | self->ssl = NULL; |
Jean-Paul Calderone | fc4ed0f | 2009-04-27 11:51:27 -0400 | [diff] [blame] | 1203 | self->from_ssl = NULL; |
| 1204 | self->into_ssl = NULL; |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1205 | |
| 1206 | Py_INCREF(Py_None); |
| 1207 | self->app_data = Py_None; |
| 1208 | |
| 1209 | self->tstate = NULL; |
| 1210 | |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1211 | self->ssl = SSL_new(self->context->ctx); |
| 1212 | SSL_set_app_data(self->ssl, self); |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1213 | |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 1214 | if (self->socket == Py_None) |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1215 | { |
| 1216 | /* If it's not a socket or file, treat it like a memory buffer, |
| 1217 | * so crazy people can do things like EAP-TLS. */ |
| 1218 | self->into_ssl = BIO_new(BIO_s_mem()); |
| 1219 | self->from_ssl = BIO_new(BIO_s_mem()); |
Jean-Paul Calderone | 07acf3f | 2009-05-05 13:23:28 -0400 | [diff] [blame^] | 1220 | if (self->into_ssl == NULL || self->from_ssl == NULL) |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1221 | goto error; |
| 1222 | SSL_set_bio(self->ssl, self->into_ssl, self->from_ssl); |
| 1223 | } |
| 1224 | else |
| 1225 | { |
| 1226 | fd = PyObject_AsFileDescriptor(self->socket); |
| 1227 | if (fd < 0) |
| 1228 | { |
| 1229 | Py_DECREF(self); |
| 1230 | return NULL; |
| 1231 | } |
| 1232 | else |
| 1233 | { |
| 1234 | SSL_set_fd(self->ssl, (SOCKET_T)fd); |
| 1235 | } |
| 1236 | } |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1237 | |
| 1238 | PyObject_GC_Track(self); |
| 1239 | |
| 1240 | return self; |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1241 | |
| 1242 | error: |
| 1243 | BIO_free(self->into_ssl); /* NULL safe */ |
| 1244 | BIO_free(self->from_ssl); /* NULL safe */ |
| 1245 | Py_DECREF(self); |
| 1246 | return NULL; |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1247 | } |
| 1248 | |
| 1249 | /* |
| 1250 | * Find attribute |
| 1251 | * |
| 1252 | * Arguments: self - The Connection object |
| 1253 | * name - The attribute name |
| 1254 | * Returns: A Python object for the attribute, or NULL if something went |
| 1255 | * wrong |
| 1256 | */ |
| 1257 | static PyObject * |
| 1258 | ssl_Connection_getattr(ssl_ConnectionObj *self, char *name) |
| 1259 | { |
| 1260 | PyObject *meth; |
| 1261 | |
| 1262 | meth = Py_FindMethod(ssl_Connection_methods, (PyObject *)self, name); |
| 1263 | |
| 1264 | if (PyErr_Occurred() && PyErr_ExceptionMatches(PyExc_AttributeError)) |
| 1265 | { |
| 1266 | PyErr_Clear(); |
| 1267 | /* Try looking it up in the "socket" instead. */ |
| 1268 | meth = PyObject_GetAttrString(self->socket, name); |
| 1269 | } |
| 1270 | |
| 1271 | return meth; |
| 1272 | } |
| 1273 | |
| 1274 | /* |
| 1275 | * Call the visitproc on all contained objects. |
| 1276 | * |
| 1277 | * Arguments: self - The Connection object |
| 1278 | * visit - Function to call |
| 1279 | * arg - Extra argument to visit |
| 1280 | * Returns: 0 if all goes well, otherwise the return code from the first |
| 1281 | * call that gave non-zero result. |
| 1282 | */ |
| 1283 | static int |
| 1284 | ssl_Connection_traverse(ssl_ConnectionObj *self, visitproc visit, void *arg) |
| 1285 | { |
| 1286 | int ret = 0; |
| 1287 | |
| 1288 | if (ret == 0 && self->context != NULL) |
| 1289 | ret = visit((PyObject *)self->context, arg); |
| 1290 | if (ret == 0 && self->socket != NULL) |
| 1291 | ret = visit(self->socket, arg); |
| 1292 | if (ret == 0 && self->app_data != NULL) |
| 1293 | ret = visit(self->app_data, arg); |
| 1294 | return ret; |
| 1295 | } |
| 1296 | |
| 1297 | /* |
| 1298 | * Decref all contained objects and zero the pointers. |
| 1299 | * |
| 1300 | * Arguments: self - The Connection object |
| 1301 | * Returns: Always 0. |
| 1302 | */ |
| 1303 | static int |
| 1304 | ssl_Connection_clear(ssl_ConnectionObj *self) |
| 1305 | { |
| 1306 | Py_XDECREF(self->context); |
| 1307 | self->context = NULL; |
| 1308 | Py_XDECREF(self->socket); |
| 1309 | self->socket = NULL; |
| 1310 | Py_XDECREF(self->app_data); |
| 1311 | self->app_data = NULL; |
Rick Dean | b71c0d2 | 2009-04-01 14:09:23 -0500 | [diff] [blame] | 1312 | self->into_ssl = NULL; /* was cleaned up by SSL_free() */ |
| 1313 | self->from_ssl = NULL; /* was cleaned up by SSL_free() */ |
Jean-Paul Calderone | 897bc25 | 2008-02-18 20:50:23 -0500 | [diff] [blame] | 1314 | return 0; |
| 1315 | } |
| 1316 | |
| 1317 | /* |
| 1318 | * Deallocate the memory used by the Connection object |
| 1319 | * |
| 1320 | * Arguments: self - The Connection object |
| 1321 | * Returns: None |
| 1322 | */ |
| 1323 | static void |
| 1324 | ssl_Connection_dealloc(ssl_ConnectionObj *self) |
| 1325 | { |
| 1326 | PyObject_GC_UnTrack(self); |
| 1327 | if (self->ssl != NULL) |
| 1328 | SSL_free(self->ssl); |
| 1329 | ssl_Connection_clear(self); |
| 1330 | PyObject_GC_Del(self); |
| 1331 | } |
| 1332 | |
| 1333 | PyTypeObject ssl_Connection_Type = { |
| 1334 | PyObject_HEAD_INIT(NULL) |
| 1335 | 0, |
| 1336 | "Connection", |
| 1337 | sizeof(ssl_ConnectionObj), |
| 1338 | 0, |
| 1339 | (destructor)ssl_Connection_dealloc, |
| 1340 | NULL, /* print */ |
| 1341 | (getattrfunc)ssl_Connection_getattr, |
| 1342 | NULL, /* setattr */ |
| 1343 | NULL, /* compare */ |
| 1344 | NULL, /* repr */ |
| 1345 | NULL, /* as_number */ |
| 1346 | NULL, /* as_sequence */ |
| 1347 | NULL, /* as_mapping */ |
| 1348 | NULL, /* hash */ |
| 1349 | NULL, /* call */ |
| 1350 | NULL, /* str */ |
| 1351 | NULL, /* getattro */ |
| 1352 | NULL, /* setattro */ |
| 1353 | NULL, /* as_buffer */ |
| 1354 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, |
| 1355 | NULL, /* doc */ |
| 1356 | (traverseproc)ssl_Connection_traverse, |
| 1357 | (inquiry)ssl_Connection_clear, |
| 1358 | }; |
| 1359 | |
| 1360 | |
| 1361 | /* |
| 1362 | * Initiailze the Connection part of the SSL sub module |
| 1363 | * |
| 1364 | * Arguments: dict - Dictionary of the OpenSSL.SSL module |
| 1365 | * Returns: 1 for success, 0 otherwise |
| 1366 | */ |
| 1367 | int |
| 1368 | init_ssl_connection(PyObject *dict) |
| 1369 | { |
| 1370 | ssl_Connection_Type.ob_type = &PyType_Type; |
| 1371 | Py_INCREF(&ssl_Connection_Type); |
| 1372 | if (PyDict_SetItemString(dict, "ConnectionType", (PyObject *)&ssl_Connection_Type) != 0) |
| 1373 | return 0; |
| 1374 | |
| 1375 | return 1; |
| 1376 | } |
| 1377 | |