blob: 4c0da6f5cb24d3201fc1b2455f724f709d25e4d0 [file] [log] [blame]
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001/* SSL socket module
2
3 SSL support based on patches by Brian E Gallew and Laszlo Kovacs.
4
5 This module is imported by socket.py. It should *not* be used
6 directly.
7
8*/
9
10#include "Python.h"
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +000011enum py_ssl_error {
12 /* these mirror ssl.h */
13 PY_SSL_ERROR_NONE,
14 PY_SSL_ERROR_SSL,
15 PY_SSL_ERROR_WANT_READ,
16 PY_SSL_ERROR_WANT_WRITE,
17 PY_SSL_ERROR_WANT_X509_LOOKUP,
18 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
19 PY_SSL_ERROR_ZERO_RETURN,
20 PY_SSL_ERROR_WANT_CONNECT,
21 /* start of non ssl.h errorcodes */
22 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
23 PY_SSL_ERROR_INVALID_ERROR_CODE
24};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000025
26/* Include symbols from _socket module */
27#include "socketmodule.h"
28
29/* Include OpenSSL header files */
30#include "openssl/rsa.h"
31#include "openssl/crypto.h"
32#include "openssl/x509.h"
33#include "openssl/pem.h"
34#include "openssl/ssl.h"
35#include "openssl/err.h"
36#include "openssl/rand.h"
37
38/* SSL error object */
39static PyObject *PySSLErrorObject;
40
41/* SSL socket object */
42
43#define X509_NAME_MAXLEN 256
44
45/* RAND_* APIs got added to OpenSSL in 0.9.5 */
46#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
47# define HAVE_OPENSSL_RAND 1
48#else
49# undef HAVE_OPENSSL_RAND
50#endif
51
52typedef struct {
53 PyObject_HEAD
54 PySocketSockObject *Socket; /* Socket on which we're layered */
55 SSL_CTX* ctx;
56 SSL* ssl;
57 X509* server_cert;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000058 char server[X509_NAME_MAXLEN];
59 char issuer[X509_NAME_MAXLEN];
60
61} PySSLObject;
62
Jeremy Hylton938ace62002-07-17 16:30:39 +000063static PyTypeObject PySSL_Type;
64static PyObject *PySSL_SSLwrite(PySSLObject *self, PyObject *args);
65static PyObject *PySSL_SSLread(PySSLObject *self, PyObject *args);
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +000066static int check_socket_and_wait_for_timeout(PySocketSockObject *s,
67 int writing);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000068
69#define PySSLObject_Check(v) ((v)->ob_type == &PySSL_Type)
70
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +000071typedef enum {
72 SOCKET_IS_NONBLOCKING,
73 SOCKET_IS_BLOCKING,
74 SOCKET_HAS_TIMED_OUT,
75 SOCKET_HAS_BEEN_CLOSED,
Neal Norwitz389cea82006-02-13 00:35:21 +000076 SOCKET_TOO_LARGE_FOR_SELECT,
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +000077 SOCKET_OPERATION_OK
78} timeout_state;
79
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000080/* XXX It might be helpful to augment the error message generated
81 below with the name of the SSL function that generated the error.
82 I expect it's obvious most of the time.
83*/
84
85static PyObject *
86PySSL_SetError(PySSLObject *obj, int ret)
87{
88 PyObject *v, *n, *s;
89 char *errstr;
90 int err;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +000091 enum py_ssl_error p;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000092
93 assert(ret <= 0);
94
95 err = SSL_get_error(obj->ssl, ret);
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +000096
97 switch (err) {
98 case SSL_ERROR_ZERO_RETURN:
99 errstr = "TLS/SSL connection has been closed";
Jeremy Hylton4e547302002-07-02 18:25:00 +0000100 p = PY_SSL_ERROR_ZERO_RETURN;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000101 break;
102 case SSL_ERROR_WANT_READ:
103 errstr = "The operation did not complete (read)";
Jeremy Hylton4e547302002-07-02 18:25:00 +0000104 p = PY_SSL_ERROR_WANT_READ;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000105 break;
106 case SSL_ERROR_WANT_WRITE:
Jeremy Hylton4e547302002-07-02 18:25:00 +0000107 p = PY_SSL_ERROR_WANT_WRITE;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000108 errstr = "The operation did not complete (write)";
109 break;
110 case SSL_ERROR_WANT_X509_LOOKUP:
Jeremy Hylton4e547302002-07-02 18:25:00 +0000111 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000112 errstr = "The operation did not complete (X509 lookup)";
113 break;
114 case SSL_ERROR_WANT_CONNECT:
Jeremy Hylton4e547302002-07-02 18:25:00 +0000115 p = PY_SSL_ERROR_WANT_CONNECT;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000116 errstr = "The operation did not complete (connect)";
117 break;
118 case SSL_ERROR_SYSCALL:
119 {
120 unsigned long e = ERR_get_error();
Jeremy Hylton4e547302002-07-02 18:25:00 +0000121 if (e == 0) {
Neal Norwitza9002f82003-06-30 03:25:20 +0000122 if (ret == 0 || !obj->Socket) {
Jeremy Hylton4e547302002-07-02 18:25:00 +0000123 p = PY_SSL_ERROR_EOF;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000124 errstr = "EOF occurred in violation of protocol";
Jeremy Hylton4e547302002-07-02 18:25:00 +0000125 } else if (ret == -1) {
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000126 /* the underlying BIO reported an I/O error */
127 return obj->Socket->errorhandler();
Jeremy Hylton4e547302002-07-02 18:25:00 +0000128 } else { /* possible? */
129 p = PY_SSL_ERROR_SYSCALL;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000130 errstr = "Some I/O error occurred";
131 }
132 } else {
Jeremy Hylton4e547302002-07-02 18:25:00 +0000133 p = PY_SSL_ERROR_SYSCALL;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000134 /* XXX Protected by global interpreter lock */
135 errstr = ERR_error_string(e, NULL);
136 }
137 break;
138 }
139 case SSL_ERROR_SSL:
140 {
141 unsigned long e = ERR_get_error();
Jeremy Hylton4e547302002-07-02 18:25:00 +0000142 p = PY_SSL_ERROR_SSL;
143 if (e != 0)
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000144 /* XXX Protected by global interpreter lock */
145 errstr = ERR_error_string(e, NULL);
Jeremy Hylton4e547302002-07-02 18:25:00 +0000146 else { /* possible? */
147 errstr = "A failure in the SSL library occurred";
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000148 }
149 break;
150 }
151 default:
Jeremy Hylton4e547302002-07-02 18:25:00 +0000152 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000153 errstr = "Invalid error code";
154 }
155 n = PyInt_FromLong((long) p);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000156 if (n == NULL)
157 return NULL;
158 v = PyTuple_New(2);
159 if (v == NULL) {
160 Py_DECREF(n);
161 return NULL;
162 }
163
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000164 s = PyString_FromString(errstr);
165 if (s == NULL) {
166 Py_DECREF(v);
167 Py_DECREF(n);
168 }
169 PyTuple_SET_ITEM(v, 0, n);
170 PyTuple_SET_ITEM(v, 1, s);
171 PyErr_SetObject(PySSLErrorObject, v);
Michael W. Hudson5910d812004-08-04 14:59:00 +0000172 Py_DECREF(v);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000173 return NULL;
174}
175
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000176static PySSLObject *
177newPySSLObject(PySocketSockObject *Sock, char *key_file, char *cert_file)
178{
179 PySSLObject *self;
180 char *errstr = NULL;
181 int ret;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000182 int err;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000183 int sockstate;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000184
185 self = PyObject_New(PySSLObject, &PySSL_Type); /* Create new object */
186 if (self == NULL){
187 errstr = "newPySSLObject error";
188 goto fail;
189 }
190 memset(self->server, '\0', sizeof(char) * X509_NAME_MAXLEN);
191 memset(self->issuer, '\0', sizeof(char) * X509_NAME_MAXLEN);
192 self->server_cert = NULL;
193 self->ssl = NULL;
194 self->ctx = NULL;
195 self->Socket = NULL;
196
197 if ((key_file && !cert_file) || (!key_file && cert_file)) {
198 errstr = "Both the key & certificate files must be specified";
199 goto fail;
200 }
201
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000202 Py_BEGIN_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000203 self->ctx = SSL_CTX_new(SSLv23_method()); /* Set up context */
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000204 Py_END_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000205 if (self->ctx == NULL) {
206 errstr = "SSL_CTX_new error";
207 goto fail;
208 }
209
210 if (key_file) {
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000211 Py_BEGIN_ALLOW_THREADS
212 ret = SSL_CTX_use_PrivateKey_file(self->ctx, key_file,
213 SSL_FILETYPE_PEM);
214 Py_END_ALLOW_THREADS
215 if (ret < 1) {
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000216 errstr = "SSL_CTX_use_PrivateKey_file error";
217 goto fail;
218 }
219
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000220 Py_BEGIN_ALLOW_THREADS
221 ret = SSL_CTX_use_certificate_chain_file(self->ctx,
222 cert_file);
223 Py_END_ALLOW_THREADS
Andrew M. Kuchling27d3dda2004-07-10 21:36:55 +0000224 SSL_CTX_set_options(self->ctx, SSL_OP_ALL); /* ssl compatibility */
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000225 if (ret < 1) {
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000226 errstr = "SSL_CTX_use_certificate_chain_file error";
227 goto fail;
228 }
229 }
230
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000231 Py_BEGIN_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000232 SSL_CTX_set_verify(self->ctx,
233 SSL_VERIFY_NONE, NULL); /* set verify lvl */
234 self->ssl = SSL_new(self->ctx); /* New ssl struct */
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000235 Py_END_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000236 SSL_set_fd(self->ssl, Sock->sock_fd); /* Set the socket for SSL */
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000237
Walter Dörwaldf0dfc7a2003-10-20 14:01:56 +0000238 /* If the socket is in non-blocking mode or timeout mode, set the BIO
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000239 * to non-blocking mode (blocking is the default)
240 */
241 if (Sock->sock_timeout >= 0.0) {
242 /* Set both the read and write BIO's to non-blocking mode */
243 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
244 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
245 }
246
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000247 Py_BEGIN_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000248 SSL_set_connect_state(self->ssl);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000249 Py_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000250
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000251 /* Actually negotiate SSL connection */
252 /* XXX If SSL_connect() returns 0, it's also a failure. */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000253 sockstate = 0;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000254 do {
255 Py_BEGIN_ALLOW_THREADS
256 ret = SSL_connect(self->ssl);
257 err = SSL_get_error(self->ssl, ret);
258 Py_END_ALLOW_THREADS
Martin v. Löwisafec8e32003-06-28 07:40:23 +0000259 if(PyErr_CheckSignals()) {
260 goto fail;
261 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000262 if (err == SSL_ERROR_WANT_READ) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000263 sockstate = check_socket_and_wait_for_timeout(Sock, 0);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000264 } else if (err == SSL_ERROR_WANT_WRITE) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000265 sockstate = check_socket_and_wait_for_timeout(Sock, 1);
266 } else {
267 sockstate = SOCKET_OPERATION_OK;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000268 }
Neal Norwitz19cbcad2006-02-07 06:59:20 +0000269 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000270 PyErr_SetString(PySSLErrorObject, "The connect operation timed out");
Martin v. Löwisafec8e32003-06-28 07:40:23 +0000271 goto fail;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000272 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
273 PyErr_SetString(PySSLErrorObject, "Underlying socket has been closed.");
274 goto fail;
Neal Norwitz389cea82006-02-13 00:35:21 +0000275 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
Neal Norwitz082b2df2006-02-07 07:04:46 +0000276 PyErr_SetString(PySSLErrorObject, "Underlying socket too large for select().");
277 goto fail;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000278 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
279 break;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000280 }
281 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000282 if (ret <= 0) {
283 PySSL_SetError(self, ret);
284 goto fail;
285 }
286 self->ssl->debug = 1;
287
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000288 Py_BEGIN_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000289 if ((self->server_cert = SSL_get_peer_certificate(self->ssl))) {
290 X509_NAME_oneline(X509_get_subject_name(self->server_cert),
291 self->server, X509_NAME_MAXLEN);
292 X509_NAME_oneline(X509_get_issuer_name(self->server_cert),
293 self->issuer, X509_NAME_MAXLEN);
294 }
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000295 Py_END_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000296 self->Socket = Sock;
297 Py_INCREF(self->Socket);
298 return self;
299 fail:
300 if (errstr)
301 PyErr_SetString(PySSLErrorObject, errstr);
302 Py_DECREF(self);
303 return NULL;
304}
305
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000306static PyObject *
307PySocket_ssl(PyObject *self, PyObject *args)
308{
309 PySSLObject *rv;
310 PySocketSockObject *Sock;
311 char *key_file = NULL;
312 char *cert_file = NULL;
313
314 if (!PyArg_ParseTuple(args, "O!|zz:ssl",
315 PySocketModule.Sock_Type,
316 (PyObject*)&Sock,
317 &key_file, &cert_file))
318 return NULL;
319
320 rv = newPySSLObject(Sock, key_file, cert_file);
321 if (rv == NULL)
322 return NULL;
323 return (PyObject *)rv;
324}
325
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000326PyDoc_STRVAR(ssl_doc,
327"ssl(socket, [keyfile, certfile]) -> sslobject");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000328
329/* SSL object methods */
330
331static PyObject *
332PySSL_server(PySSLObject *self)
333{
334 return PyString_FromString(self->server);
335}
336
337static PyObject *
338PySSL_issuer(PySSLObject *self)
339{
340 return PyString_FromString(self->issuer);
341}
342
343
344static void PySSL_dealloc(PySSLObject *self)
345{
346 if (self->server_cert) /* Possible not to have one? */
347 X509_free (self->server_cert);
348 if (self->ssl)
349 SSL_free(self->ssl);
350 if (self->ctx)
351 SSL_CTX_free(self->ctx);
352 Py_XDECREF(self->Socket);
353 PyObject_Del(self);
354}
355
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000356/* If the socket has a timeout, do a select() on the socket.
357 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000358 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000359 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000360
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000361static int
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000362check_socket_and_wait_for_timeout(PySocketSockObject *s, int writing)
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000363{
364 fd_set fds;
365 struct timeval tv;
366 int rc;
367
368 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000369 if (s->sock_timeout < 0.0)
370 return SOCKET_IS_BLOCKING;
371 else if (s->sock_timeout == 0.0)
372 return SOCKET_IS_NONBLOCKING;
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000373
374 /* Guard against closed socket */
375 if (s->sock_fd < 0)
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000376 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000377
Neal Norwitz082b2df2006-02-07 07:04:46 +0000378 /* Guard against socket too large for select*/
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000379#ifndef Py_SOCKET_FD_CAN_BE_GE_FD_SETSIZE
Neal Norwitz082b2df2006-02-07 07:04:46 +0000380 if (s->sock_fd >= FD_SETSIZE)
Neal Norwitz389cea82006-02-13 00:35:21 +0000381 return SOCKET_TOO_LARGE_FOR_SELECT;
Martin v. Löwisf84d1b92006-02-11 09:27:05 +0000382#endif
Neal Norwitz082b2df2006-02-07 07:04:46 +0000383
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000384 /* Construct the arguments to select */
385 tv.tv_sec = (int)s->sock_timeout;
386 tv.tv_usec = (int)((s->sock_timeout - tv.tv_sec) * 1e6);
387 FD_ZERO(&fds);
388 FD_SET(s->sock_fd, &fds);
389
390 /* See if the socket is ready */
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000391 Py_BEGIN_ALLOW_THREADS
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000392 if (writing)
393 rc = select(s->sock_fd+1, NULL, &fds, NULL, &tv);
394 else
395 rc = select(s->sock_fd+1, &fds, NULL, NULL, &tv);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000396 Py_END_ALLOW_THREADS
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000397
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000398 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
399 (when we are able to write or when there's something to read) */
400 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000401}
402
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000403static PyObject *PySSL_SSLwrite(PySSLObject *self, PyObject *args)
404{
405 char *data;
406 int len;
Martin v. Löwis405a7952003-10-27 14:24:37 +0000407 int count;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000408 int sockstate;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000409 int err;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000410
Martin v. Löwis405a7952003-10-27 14:24:37 +0000411 if (!PyArg_ParseTuple(args, "s#:write", &data, &count))
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000412 return NULL;
413
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000414 sockstate = check_socket_and_wait_for_timeout(self->Socket, 1);
415 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000416 PyErr_SetString(PySSLErrorObject, "The write operation timed out");
417 return NULL;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000418 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
419 PyErr_SetString(PySSLErrorObject, "Underlying socket has been closed.");
420 return NULL;
Neal Norwitz389cea82006-02-13 00:35:21 +0000421 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
Neal Norwitz082b2df2006-02-07 07:04:46 +0000422 PyErr_SetString(PySSLErrorObject, "Underlying socket too large for select().");
423 return NULL;
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000424 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000425 do {
426 err = 0;
427 Py_BEGIN_ALLOW_THREADS
Martin v. Löwis405a7952003-10-27 14:24:37 +0000428 len = SSL_write(self->ssl, data, count);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000429 err = SSL_get_error(self->ssl, len);
430 Py_END_ALLOW_THREADS
Martin v. Löwisafec8e32003-06-28 07:40:23 +0000431 if(PyErr_CheckSignals()) {
432 return NULL;
433 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000434 if (err == SSL_ERROR_WANT_READ) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000435 sockstate = check_socket_and_wait_for_timeout(self->Socket, 0);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000436 } else if (err == SSL_ERROR_WANT_WRITE) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000437 sockstate = check_socket_and_wait_for_timeout(self->Socket, 1);
438 } else {
439 sockstate = SOCKET_OPERATION_OK;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000440 }
Neal Norwitz19cbcad2006-02-07 06:59:20 +0000441 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000442 PyErr_SetString(PySSLErrorObject, "The write operation timed out");
443 return NULL;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000444 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
445 PyErr_SetString(PySSLErrorObject, "Underlying socket has been closed.");
446 return NULL;
447 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
448 break;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000449 }
450 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000451 if (len > 0)
452 return PyInt_FromLong(len);
453 else
454 return PySSL_SetError(self, len);
455}
456
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000457PyDoc_STRVAR(PySSL_SSLwrite_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000458"write(s) -> len\n\
459\n\
460Writes the string s into the SSL object. Returns the number\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000461of bytes written.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000462
463static PyObject *PySSL_SSLread(PySSLObject *self, PyObject *args)
464{
465 PyObject *buf;
466 int count = 0;
467 int len = 1024;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000468 int sockstate;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000469 int err;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000470
471 if (!PyArg_ParseTuple(args, "|i:read", &len))
472 return NULL;
473
474 if (!(buf = PyString_FromStringAndSize((char *) 0, len)))
475 return NULL;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000476
477 /* first check if there are bytes ready to be read */
478 Py_BEGIN_ALLOW_THREADS
479 count = SSL_pending(self->ssl);
480 Py_END_ALLOW_THREADS
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000481
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000482 if (!count) {
483 sockstate = check_socket_and_wait_for_timeout(self->Socket, 0);
484 if (sockstate == SOCKET_HAS_TIMED_OUT) {
485 PyErr_SetString(PySSLErrorObject, "The read operation timed out");
486 Py_DECREF(buf);
487 return NULL;
488 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
489 PyErr_SetString(PySSLErrorObject, "Underlying socket too large for select().");
490 return NULL;
491 }
Guido van Rossum99d4abf2003-01-27 22:22:50 +0000492 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000493 do {
494 err = 0;
495 Py_BEGIN_ALLOW_THREADS
496 count = SSL_read(self->ssl, PyString_AsString(buf), len);
497 err = SSL_get_error(self->ssl, count);
498 Py_END_ALLOW_THREADS
Martin v. Löwisafec8e32003-06-28 07:40:23 +0000499 if(PyErr_CheckSignals()) {
500 Py_DECREF(buf);
501 return NULL;
502 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000503 if (err == SSL_ERROR_WANT_READ) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000504 sockstate = check_socket_and_wait_for_timeout(self->Socket, 0);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000505 } else if (err == SSL_ERROR_WANT_WRITE) {
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000506 sockstate = check_socket_and_wait_for_timeout(self->Socket, 1);
507 } else {
508 sockstate = SOCKET_OPERATION_OK;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000509 }
Neal Norwitz19cbcad2006-02-07 06:59:20 +0000510 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000511 PyErr_SetString(PySSLErrorObject, "The read operation timed out");
Martin v. Löwisafec8e32003-06-28 07:40:23 +0000512 Py_DECREF(buf);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000513 return NULL;
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000514 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
515 break;
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000516 }
517 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000518 if (count <= 0) {
519 Py_DECREF(buf);
520 return PySSL_SetError(self, count);
521 }
Tim Peters5de98422002-04-27 18:44:32 +0000522 if (count != len)
523 _PyString_Resize(&buf, count);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000524 return buf;
525}
526
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000527PyDoc_STRVAR(PySSL_SSLread_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000528"read([len]) -> string\n\
529\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000530Read up to len bytes from the SSL socket.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000531
532static PyMethodDef PySSLMethods[] = {
533 {"write", (PyCFunction)PySSL_SSLwrite, METH_VARARGS,
534 PySSL_SSLwrite_doc},
535 {"read", (PyCFunction)PySSL_SSLread, METH_VARARGS,
536 PySSL_SSLread_doc},
537 {"server", (PyCFunction)PySSL_server, METH_NOARGS},
538 {"issuer", (PyCFunction)PySSL_issuer, METH_NOARGS},
539 {NULL, NULL}
540};
541
542static PyObject *PySSL_getattr(PySSLObject *self, char *name)
543{
544 return Py_FindMethod(PySSLMethods, (PyObject *)self, name);
545}
546
Jeremy Hylton938ace62002-07-17 16:30:39 +0000547static PyTypeObject PySSL_Type = {
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000548 PyObject_HEAD_INIT(NULL)
549 0, /*ob_size*/
550 "socket.SSL", /*tp_name*/
551 sizeof(PySSLObject), /*tp_basicsize*/
552 0, /*tp_itemsize*/
553 /* methods */
554 (destructor)PySSL_dealloc, /*tp_dealloc*/
555 0, /*tp_print*/
556 (getattrfunc)PySSL_getattr, /*tp_getattr*/
557 0, /*tp_setattr*/
558 0, /*tp_compare*/
559 0, /*tp_repr*/
560 0, /*tp_as_number*/
561 0, /*tp_as_sequence*/
562 0, /*tp_as_mapping*/
563 0, /*tp_hash*/
564};
565
566#ifdef HAVE_OPENSSL_RAND
567
568/* helper routines for seeding the SSL PRNG */
569static PyObject *
570PySSL_RAND_add(PyObject *self, PyObject *args)
571{
572 char *buf;
573 int len;
574 double entropy;
575
576 if (!PyArg_ParseTuple(args, "s#d:RAND_add", &buf, &len, &entropy))
577 return NULL;
578 RAND_add(buf, len, entropy);
579 Py_INCREF(Py_None);
580 return Py_None;
581}
582
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000583PyDoc_STRVAR(PySSL_RAND_add_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000584"RAND_add(string, entropy)\n\
585\n\
586Mix string into the OpenSSL PRNG state. entropy (a float) is a lower\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000587bound on the entropy contained in string.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000588
589static PyObject *
590PySSL_RAND_status(PyObject *self)
591{
592 return PyInt_FromLong(RAND_status());
593}
594
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000595PyDoc_STRVAR(PySSL_RAND_status_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000596"RAND_status() -> 0 or 1\n\
597\n\
598Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.\n\
599It is necessary to seed the PRNG with RAND_add() on some platforms before\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000600using the ssl() function.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000601
602static PyObject *
603PySSL_RAND_egd(PyObject *self, PyObject *arg)
604{
605 int bytes;
606
607 if (!PyString_Check(arg))
608 return PyErr_Format(PyExc_TypeError,
609 "RAND_egd() expected string, found %s",
610 arg->ob_type->tp_name);
611 bytes = RAND_egd(PyString_AS_STRING(arg));
612 if (bytes == -1) {
613 PyErr_SetString(PySSLErrorObject,
614 "EGD connection failed or EGD did not return "
615 "enough data to seed the PRNG");
616 return NULL;
617 }
618 return PyInt_FromLong(bytes);
619}
620
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000621PyDoc_STRVAR(PySSL_RAND_egd_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000622"RAND_egd(path) -> bytes\n\
623\n\
624Queries the entropy gather daemon (EGD) on socket path. Returns number\n\
625of bytes read. Raises socket.sslerror if connection to EGD fails or\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000626if it does provide enough data to seed PRNG.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000627
628#endif
629
630/* List of functions exported by this module. */
631
632static PyMethodDef PySSL_methods[] = {
633 {"ssl", PySocket_ssl,
634 METH_VARARGS, ssl_doc},
635#ifdef HAVE_OPENSSL_RAND
636 {"RAND_add", PySSL_RAND_add, METH_VARARGS,
637 PySSL_RAND_add_doc},
638 {"RAND_egd", PySSL_RAND_egd, METH_O,
639 PySSL_RAND_egd_doc},
640 {"RAND_status", (PyCFunction)PySSL_RAND_status, METH_NOARGS,
641 PySSL_RAND_status_doc},
642#endif
643 {NULL, NULL} /* Sentinel */
644};
645
646
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000647PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000648"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000649for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000650
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000651PyMODINIT_FUNC
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000652init_ssl(void)
653{
654 PyObject *m, *d;
655
656 PySSL_Type.ob_type = &PyType_Type;
657
658 m = Py_InitModule3("_ssl", PySSL_methods, module_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +0000659 if (m == NULL)
660 return;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000661 d = PyModule_GetDict(m);
662
663 /* Load _socket module and its C API */
664 if (PySocketModule_ImportModuleAndAPI())
665 return;
666
667 /* Init OpenSSL */
668 SSL_load_error_strings();
669 SSLeay_add_ssl_algorithms();
670
671 /* Add symbols to module dict */
Brett Cannon06c34792004-03-23 23:16:54 +0000672 PySSLErrorObject = PyErr_NewException("socket.sslerror",
673 PySocketModule.error,
674 NULL);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000675 if (PySSLErrorObject == NULL)
676 return;
677 PyDict_SetItemString(d, "sslerror", PySSLErrorObject);
678 if (PyDict_SetItemString(d, "SSLType",
679 (PyObject *)&PySSL_Type) != 0)
680 return;
681 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000682 PY_SSL_ERROR_ZERO_RETURN);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000683 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000684 PY_SSL_ERROR_WANT_READ);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000685 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000686 PY_SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000687 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000688 PY_SSL_ERROR_WANT_X509_LOOKUP);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000689 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000690 PY_SSL_ERROR_SYSCALL);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000691 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000692 PY_SSL_ERROR_SSL);
693 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
694 PY_SSL_ERROR_WANT_CONNECT);
695 /* non ssl.h errorcodes */
696 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
697 PY_SSL_ERROR_EOF);
698 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
699 PY_SSL_ERROR_INVALID_ERROR_CODE);
700
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000701}