blob: 89f2aaa02ddae6dfb7aeb7c2a1b086e79cf5c0d0 [file] [log] [blame]
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001/* SSL socket module
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002
3 SSL support based on patches by Brian E Gallew and Laszlo Kovacs.
Bill Janssen98d19da2007-09-10 21:51:02 +00004 Re-worked a bit by Bill Janssen to add server-side support and
Bill Janssen934b16d2008-06-28 22:19:33 +00005 certificate decoding. Chris Stawarz contributed some non-blocking
6 patches.
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00007
Bill Janssen98d19da2007-09-10 21:51:02 +00008 This module is imported by ssl.py. It should *not* be used
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00009 directly.
10
Bill Janssen98d19da2007-09-10 21:51:02 +000011 XXX should partial writes be enabled, SSL_MODE_ENABLE_PARTIAL_WRITE?
Antoine Pitroua5c4b552010-04-22 23:33:02 +000012
13 XXX integrate several "shutdown modes" as suggested in
14 http://bugs.python.org/issue8108#msg102867 ?
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000015*/
16
Benjamin Petersondaeb9252014-08-20 14:14:50 -050017#define PY_SSIZE_T_CLEAN
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000018#include "Python.h"
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +000019
Bill Janssen98d19da2007-09-10 21:51:02 +000020#ifdef WITH_THREAD
21#include "pythread.h"
Christian Heimes0d604cf2013-08-21 13:26:05 +020022
Christian Heimes0d604cf2013-08-21 13:26:05 +020023
Benjamin Petersondaeb9252014-08-20 14:14:50 -050024#define PySSL_BEGIN_ALLOW_THREADS_S(save) \
25 do { if (_ssl_locks_count>0) { (save) = PyEval_SaveThread(); } } while (0)
26#define PySSL_END_ALLOW_THREADS_S(save) \
27 do { if (_ssl_locks_count>0) { PyEval_RestoreThread(save); } } while (0)
Bill Janssen98d19da2007-09-10 21:51:02 +000028#define PySSL_BEGIN_ALLOW_THREADS { \
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +000029 PyThreadState *_save = NULL; \
Benjamin Petersondaeb9252014-08-20 14:14:50 -050030 PySSL_BEGIN_ALLOW_THREADS_S(_save);
31#define PySSL_BLOCK_THREADS PySSL_END_ALLOW_THREADS_S(_save);
32#define PySSL_UNBLOCK_THREADS PySSL_BEGIN_ALLOW_THREADS_S(_save);
33#define PySSL_END_ALLOW_THREADS PySSL_END_ALLOW_THREADS_S(_save); }
Bill Janssen98d19da2007-09-10 21:51:02 +000034
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +000035#else /* no WITH_THREAD */
Bill Janssen98d19da2007-09-10 21:51:02 +000036
Benjamin Petersondaeb9252014-08-20 14:14:50 -050037#define PySSL_BEGIN_ALLOW_THREADS_S(save)
38#define PySSL_END_ALLOW_THREADS_S(save)
Bill Janssen98d19da2007-09-10 21:51:02 +000039#define PySSL_BEGIN_ALLOW_THREADS
40#define PySSL_BLOCK_THREADS
41#define PySSL_UNBLOCK_THREADS
42#define PySSL_END_ALLOW_THREADS
43
44#endif
45
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000046/* Include symbols from _socket module */
47#include "socketmodule.h"
48
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +000049#if defined(HAVE_POLL_H)
Anthony Baxter93ab5fa2006-07-11 02:04:09 +000050#include <poll.h>
51#elif defined(HAVE_SYS_POLL_H)
52#include <sys/poll.h>
53#endif
54
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000055/* Include OpenSSL header files */
56#include "openssl/rsa.h"
57#include "openssl/crypto.h"
58#include "openssl/x509.h"
Bill Janssen98d19da2007-09-10 21:51:02 +000059#include "openssl/x509v3.h"
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000060#include "openssl/pem.h"
61#include "openssl/ssl.h"
62#include "openssl/err.h"
63#include "openssl/rand.h"
64
65/* SSL error object */
66static PyObject *PySSLErrorObject;
Benjamin Petersondaeb9252014-08-20 14:14:50 -050067static PyObject *PySSLZeroReturnErrorObject;
68static PyObject *PySSLWantReadErrorObject;
69static PyObject *PySSLWantWriteErrorObject;
70static PyObject *PySSLSyscallErrorObject;
71static PyObject *PySSLEOFErrorObject;
72
73/* Error mappings */
74static PyObject *err_codes_to_names;
75static PyObject *err_names_to_codes;
76static PyObject *lib_codes_to_names;
77
78struct py_ssl_error_code {
79 const char *mnemonic;
80 int library, reason;
81};
82struct py_ssl_library_code {
83 const char *library;
84 int code;
85};
86
87/* Include generated data (error codes) */
88#include "_ssl_data.h"
89
90/* Openssl comes with TLSv1.1 and TLSv1.2 between 1.0.0h and 1.0.1
91 http://www.openssl.org/news/changelog.html
92 */
93#if OPENSSL_VERSION_NUMBER >= 0x10001000L
94# define HAVE_TLSv1_2 1
95#else
96# define HAVE_TLSv1_2 0
97#endif
98
99/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f
100 * This includes the SSL_set_SSL_CTX() function.
101 */
102#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
103# define HAVE_SNI 1
104#else
105# define HAVE_SNI 0
106#endif
107
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -0500108/* ALPN added in OpenSSL 1.0.2 */
Benjamin Petersonf4bb2312015-01-27 11:10:18 -0500109#if !defined(LIBRESSL_VERSION_NUMBER) && OPENSSL_VERSION_NUMBER >= 0x1000200fL && !defined(OPENSSL_NO_TLSEXT)
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -0500110# define HAVE_ALPN
111#endif
112
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500113enum py_ssl_error {
114 /* these mirror ssl.h */
115 PY_SSL_ERROR_NONE,
116 PY_SSL_ERROR_SSL,
117 PY_SSL_ERROR_WANT_READ,
118 PY_SSL_ERROR_WANT_WRITE,
119 PY_SSL_ERROR_WANT_X509_LOOKUP,
120 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
121 PY_SSL_ERROR_ZERO_RETURN,
122 PY_SSL_ERROR_WANT_CONNECT,
123 /* start of non ssl.h errorcodes */
124 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
125 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
126 PY_SSL_ERROR_INVALID_ERROR_CODE
127};
128
129enum py_ssl_server_or_client {
130 PY_SSL_CLIENT,
131 PY_SSL_SERVER
132};
133
134enum py_ssl_cert_requirements {
135 PY_SSL_CERT_NONE,
136 PY_SSL_CERT_OPTIONAL,
137 PY_SSL_CERT_REQUIRED
138};
139
140enum py_ssl_version {
141 PY_SSL_VERSION_SSL2,
142 PY_SSL_VERSION_SSL3=1,
143 PY_SSL_VERSION_SSL23,
144#if HAVE_TLSv1_2
145 PY_SSL_VERSION_TLS1,
146 PY_SSL_VERSION_TLS1_1,
147 PY_SSL_VERSION_TLS1_2
148#else
149 PY_SSL_VERSION_TLS1
150#endif
151};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000152
Bill Janssen98d19da2007-09-10 21:51:02 +0000153#ifdef WITH_THREAD
154
155/* serves as a flag to see whether we've initialized the SSL thread support. */
156/* 0 means no, greater than 0 means yes */
157
158static unsigned int _ssl_locks_count = 0;
159
160#endif /* def WITH_THREAD */
161
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000162/* SSL socket object */
163
164#define X509_NAME_MAXLEN 256
165
166/* RAND_* APIs got added to OpenSSL in 0.9.5 */
167#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
168# define HAVE_OPENSSL_RAND 1
169#else
170# undef HAVE_OPENSSL_RAND
171#endif
172
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500173/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
174 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
175 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
176#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
177# define HAVE_SSL_CTX_CLEAR_OPTIONS
178#else
179# undef HAVE_SSL_CTX_CLEAR_OPTIONS
180#endif
181
182/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
183 * older SSL, but let's be safe */
184#define PySSL_CB_MAXLEN 128
185
186/* SSL_get_finished got added to OpenSSL in 0.9.5 */
187#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
188# define HAVE_OPENSSL_FINISHED 1
189#else
190# define HAVE_OPENSSL_FINISHED 0
191#endif
192
193/* ECDH support got added to OpenSSL in 0.9.8 */
194#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_ECDH)
195# define OPENSSL_NO_ECDH
196#endif
197
198/* compression support got added to OpenSSL in 0.9.8 */
199#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_COMP)
200# define OPENSSL_NO_COMP
201#endif
202
203/* X509_VERIFY_PARAM got added to OpenSSL in 0.9.8 */
204#if OPENSSL_VERSION_NUMBER >= 0x0090800fL
205# define HAVE_OPENSSL_VERIFY_PARAM
206#endif
207
208
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000209typedef struct {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000210 PyObject_HEAD
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500211 SSL_CTX *ctx;
212#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -0500213 unsigned char *npn_protocols;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500214 int npn_protocols_len;
215#endif
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -0500216#ifdef HAVE_ALPN
217 unsigned char *alpn_protocols;
218 int alpn_protocols_len;
219#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500220#ifndef OPENSSL_NO_TLSEXT
221 PyObject *set_hostname;
222#endif
223 int check_hostname;
224} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000225
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500226typedef struct {
227 PyObject_HEAD
228 PySocketSockObject *Socket;
229 PyObject *ssl_sock;
230 SSL *ssl;
231 PySSLContext *ctx; /* weakref to SSL context */
232 X509 *peer_cert;
233 char shutdown_seen_zero;
234 char handshake_done;
235 enum py_ssl_server_or_client socket_type;
236} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000237
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500238static PyTypeObject PySSLContext_Type;
239static PyTypeObject PySSLSocket_Type;
240
241static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args);
242static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args);
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000243static int check_socket_and_wait_for_timeout(PySocketSockObject *s,
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000244 int writing);
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500245static PyObject *PySSL_peercert(PySSLSocket *self, PyObject *args);
246static PyObject *PySSL_cipher(PySSLSocket *self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000247
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500248#define PySSLContext_Check(v) (Py_TYPE(v) == &PySSLContext_Type)
249#define PySSLSocket_Check(v) (Py_TYPE(v) == &PySSLSocket_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000250
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000251typedef enum {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000252 SOCKET_IS_NONBLOCKING,
253 SOCKET_IS_BLOCKING,
254 SOCKET_HAS_TIMED_OUT,
255 SOCKET_HAS_BEEN_CLOSED,
256 SOCKET_TOO_LARGE_FOR_SELECT,
257 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000258} timeout_state;
259
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000260/* Wrap error strings with filename and line # */
261#define STRINGIFY1(x) #x
262#define STRINGIFY2(x) STRINGIFY1(x)
263#define ERRSTR1(x,y,z) (x ":" y ": " z)
264#define ERRSTR(x) ERRSTR1("_ssl.c", STRINGIFY2(__LINE__), x)
265
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500266
267/*
268 * SSL errors.
269 */
270
271PyDoc_STRVAR(SSLError_doc,
272"An error occurred in the SSL implementation.");
273
274PyDoc_STRVAR(SSLZeroReturnError_doc,
275"SSL/TLS session closed cleanly.");
276
277PyDoc_STRVAR(SSLWantReadError_doc,
278"Non-blocking SSL socket needs to read more data\n"
279"before the requested operation can be completed.");
280
281PyDoc_STRVAR(SSLWantWriteError_doc,
282"Non-blocking SSL socket needs to write more data\n"
283"before the requested operation can be completed.");
284
285PyDoc_STRVAR(SSLSyscallError_doc,
286"System error when attempting SSL operation.");
287
288PyDoc_STRVAR(SSLEOFError_doc,
289"SSL/TLS connection terminated abruptly.");
290
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000291
292static PyObject *
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500293SSLError_str(PyEnvironmentErrorObject *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000294{
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500295 if (self->strerror != NULL) {
296 Py_INCREF(self->strerror);
297 return self->strerror;
298 }
299 else
300 return PyObject_Str(self->args);
301}
302
303static void
304fill_and_set_sslerror(PyObject *type, int ssl_errno, const char *errstr,
305 int lineno, unsigned long errcode)
306{
307 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
308 PyObject *init_value, *msg, *key;
309
310 if (errcode != 0) {
311 int lib, reason;
312
313 lib = ERR_GET_LIB(errcode);
314 reason = ERR_GET_REASON(errcode);
315 key = Py_BuildValue("ii", lib, reason);
316 if (key == NULL)
317 goto fail;
318 reason_obj = PyDict_GetItem(err_codes_to_names, key);
319 Py_DECREF(key);
320 if (reason_obj == NULL) {
321 /* XXX if reason < 100, it might reflect a library number (!!) */
322 PyErr_Clear();
323 }
324 key = PyLong_FromLong(lib);
325 if (key == NULL)
326 goto fail;
327 lib_obj = PyDict_GetItem(lib_codes_to_names, key);
328 Py_DECREF(key);
329 if (lib_obj == NULL) {
330 PyErr_Clear();
331 }
332 if (errstr == NULL)
333 errstr = ERR_reason_error_string(errcode);
334 }
335 if (errstr == NULL)
336 errstr = "unknown error";
337
338 if (reason_obj && lib_obj)
339 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
340 lib_obj, reason_obj, errstr, lineno);
341 else if (lib_obj)
342 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
343 lib_obj, errstr, lineno);
344 else
345 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
346 if (msg == NULL)
347 goto fail;
348
349 init_value = Py_BuildValue("iN", ssl_errno, msg);
350 if (init_value == NULL)
351 goto fail;
352
353 err_value = PyObject_CallObject(type, init_value);
354 Py_DECREF(init_value);
355 if (err_value == NULL)
356 goto fail;
357
358 if (reason_obj == NULL)
359 reason_obj = Py_None;
360 if (PyObject_SetAttrString(err_value, "reason", reason_obj))
361 goto fail;
362 if (lib_obj == NULL)
363 lib_obj = Py_None;
364 if (PyObject_SetAttrString(err_value, "library", lib_obj))
365 goto fail;
366 PyErr_SetObject(type, err_value);
367fail:
368 Py_XDECREF(err_value);
369}
370
371static PyObject *
372PySSL_SetError(PySSLSocket *obj, int ret, char *filename, int lineno)
373{
374 PyObject *type = PySSLErrorObject;
375 char *errstr = NULL;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000376 int err;
377 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500378 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000379
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000380 assert(ret <= 0);
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500381 e = ERR_peek_last_error();
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000382
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000383 if (obj->ssl != NULL) {
384 err = SSL_get_error(obj->ssl, ret);
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000385
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000386 switch (err) {
387 case SSL_ERROR_ZERO_RETURN:
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500388 errstr = "TLS/SSL connection has been closed (EOF)";
389 type = PySSLZeroReturnErrorObject;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000390 p = PY_SSL_ERROR_ZERO_RETURN;
391 break;
392 case SSL_ERROR_WANT_READ:
393 errstr = "The operation did not complete (read)";
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500394 type = PySSLWantReadErrorObject;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000395 p = PY_SSL_ERROR_WANT_READ;
396 break;
397 case SSL_ERROR_WANT_WRITE:
398 p = PY_SSL_ERROR_WANT_WRITE;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500399 type = PySSLWantWriteErrorObject;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000400 errstr = "The operation did not complete (write)";
401 break;
402 case SSL_ERROR_WANT_X509_LOOKUP:
403 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000404 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000405 break;
406 case SSL_ERROR_WANT_CONNECT:
407 p = PY_SSL_ERROR_WANT_CONNECT;
408 errstr = "The operation did not complete (connect)";
409 break;
410 case SSL_ERROR_SYSCALL:
411 {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000412 if (e == 0) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500413 PySocketSockObject *s = obj->Socket;
414 if (ret == 0) {
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000415 p = PY_SSL_ERROR_EOF;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500416 type = PySSLEOFErrorObject;
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000417 errstr = "EOF occurred in violation of protocol";
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000418 } else if (ret == -1) {
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000419 /* underlying BIO reported an I/O error */
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500420 Py_INCREF(s);
Antoine Pitrou508a2372010-05-16 23:11:46 +0000421 ERR_clear_error();
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500422 s->errorhandler();
423 Py_DECREF(s);
424 return NULL;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000425 } else { /* possible? */
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000426 p = PY_SSL_ERROR_SYSCALL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500427 type = PySSLSyscallErrorObject;
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000428 errstr = "Some I/O error occurred";
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000429 }
430 } else {
431 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000432 }
433 break;
434 }
435 case SSL_ERROR_SSL:
436 {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000437 p = PY_SSL_ERROR_SSL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500438 if (e == 0)
439 /* possible? */
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000440 errstr = "A failure in the SSL library occurred";
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000441 break;
442 }
443 default:
444 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
445 errstr = "Invalid error code";
446 }
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000447 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500448 fill_and_set_sslerror(type, p, errstr, lineno, e);
Antoine Pitrou508a2372010-05-16 23:11:46 +0000449 ERR_clear_error();
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000450 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000451}
452
Bill Janssen98d19da2007-09-10 21:51:02 +0000453static PyObject *
454_setSSLError (char *errstr, int errcode, char *filename, int lineno) {
455
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500456 if (errstr == NULL)
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000457 errcode = ERR_peek_last_error();
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500458 else
459 errcode = 0;
460 fill_and_set_sslerror(PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou508a2372010-05-16 23:11:46 +0000461 ERR_clear_error();
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000462 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +0000463}
464
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500465/*
466 * SSL objects
467 */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000468
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500469static PySSLSocket *
470newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
471 enum py_ssl_server_or_client socket_type,
472 char *server_hostname, PyObject *ssl_sock)
473{
474 PySSLSocket *self;
475 SSL_CTX *ctx = sslctx->ctx;
476 long mode;
477
478 self = PyObject_New(PySSLSocket, &PySSLSocket_Type);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000479 if (self == NULL)
480 return NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500481
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000482 self->peer_cert = NULL;
483 self->ssl = NULL;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000484 self->Socket = NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500485 self->ssl_sock = NULL;
486 self->ctx = sslctx;
Antoine Pitrou87c99a02013-09-29 19:52:45 +0200487 self->shutdown_seen_zero = 0;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500488 self->handshake_done = 0;
489 Py_INCREF(sslctx);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000490
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000491 /* Make sure the SSL error state is initialized */
492 (void) ERR_get_state();
493 ERR_clear_error();
Bill Janssen98d19da2007-09-10 21:51:02 +0000494
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000495 PySSL_BEGIN_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500496 self->ssl = SSL_new(ctx);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000497 PySSL_END_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500498 SSL_set_app_data(self->ssl,self);
499 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
500 mode = SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER;
Antoine Pitrou92719c52010-04-09 20:38:39 +0000501#ifdef SSL_MODE_AUTO_RETRY
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500502 mode |= SSL_MODE_AUTO_RETRY;
503#endif
504 SSL_set_mode(self->ssl, mode);
505
506#if HAVE_SNI
507 if (server_hostname != NULL)
508 SSL_set_tlsext_host_name(self->ssl, server_hostname);
Antoine Pitrou92719c52010-04-09 20:38:39 +0000509#endif
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000510
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000511 /* If the socket is in non-blocking mode or timeout mode, set the BIO
512 * to non-blocking mode (blocking is the default)
513 */
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500514 if (sock->sock_timeout >= 0.0) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000515 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
516 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
517 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000518
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000519 PySSL_BEGIN_ALLOW_THREADS
520 if (socket_type == PY_SSL_CLIENT)
521 SSL_set_connect_state(self->ssl);
522 else
523 SSL_set_accept_state(self->ssl);
524 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000525
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500526 self->socket_type = socket_type;
527 self->Socket = sock;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000528 Py_INCREF(self->Socket);
Benjamin Peterson2f334562014-10-01 23:53:01 -0400529 if (ssl_sock != Py_None) {
530 self->ssl_sock = PyWeakref_NewRef(ssl_sock, NULL);
531 if (self->ssl_sock == NULL) {
532 Py_DECREF(self);
533 return NULL;
534 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500535 }
536 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000537}
538
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000539
540/* SSL object methods */
541
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500542static PyObject *PySSL_SSLdo_handshake(PySSLSocket *self)
Bill Janssen934b16d2008-06-28 22:19:33 +0000543{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000544 int ret;
545 int err;
546 int sockstate, nonblocking;
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500547 PySocketSockObject *sock = self->Socket;
548
549 Py_INCREF(sock);
Antoine Pitrou4d3e3722010-04-24 19:57:01 +0000550
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000551 /* just in case the blocking state of the socket has been changed */
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500552 nonblocking = (sock->sock_timeout >= 0.0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000553 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
554 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Bill Janssen934b16d2008-06-28 22:19:33 +0000555
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000556 /* Actually negotiate SSL connection */
557 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
558 do {
559 PySSL_BEGIN_ALLOW_THREADS
560 ret = SSL_do_handshake(self->ssl);
561 err = SSL_get_error(self->ssl, ret);
562 PySSL_END_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500563 if (PyErr_CheckSignals())
564 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000565 if (err == SSL_ERROR_WANT_READ) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500566 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000567 } else if (err == SSL_ERROR_WANT_WRITE) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500568 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000569 } else {
570 sockstate = SOCKET_OPERATION_OK;
571 }
572 if (sockstate == SOCKET_HAS_TIMED_OUT) {
573 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000574 ERRSTR("The handshake operation timed out"));
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500575 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000576 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
577 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000578 ERRSTR("Underlying socket has been closed."));
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500579 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000580 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
581 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000582 ERRSTR("Underlying socket too large for select()."));
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500583 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000584 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
585 break;
586 }
587 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500588 Py_DECREF(sock);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000589 if (ret < 1)
590 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Bill Janssen934b16d2008-06-28 22:19:33 +0000591
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000592 if (self->peer_cert)
593 X509_free (self->peer_cert);
594 PySSL_BEGIN_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500595 self->peer_cert = SSL_get_peer_certificate(self->ssl);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000596 PySSL_END_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500597 self->handshake_done = 1;
Bill Janssen934b16d2008-06-28 22:19:33 +0000598
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000599 Py_INCREF(Py_None);
600 return Py_None;
Bill Janssen934b16d2008-06-28 22:19:33 +0000601
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500602error:
603 Py_DECREF(sock);
604 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000605}
606
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000607static PyObject *
Bill Janssen98d19da2007-09-10 21:51:02 +0000608_create_tuple_for_attribute (ASN1_OBJECT *name, ASN1_STRING *value) {
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000609
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000610 char namebuf[X509_NAME_MAXLEN];
611 int buflen;
612 PyObject *name_obj;
613 PyObject *value_obj;
614 PyObject *attr;
615 unsigned char *valuebuf = NULL;
Guido van Rossum780b80d2007-08-27 18:42:23 +0000616
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000617 buflen = OBJ_obj2txt(namebuf, sizeof(namebuf), name, 0);
618 if (buflen < 0) {
619 _setSSLError(NULL, 0, __FILE__, __LINE__);
620 goto fail;
621 }
622 name_obj = PyString_FromStringAndSize(namebuf, buflen);
623 if (name_obj == NULL)
624 goto fail;
625
626 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
627 if (buflen < 0) {
628 _setSSLError(NULL, 0, __FILE__, __LINE__);
629 Py_DECREF(name_obj);
630 goto fail;
631 }
632 value_obj = PyUnicode_DecodeUTF8((char *) valuebuf,
Antoine Pitrou2e136ab2010-05-12 14:02:34 +0000633 buflen, "strict");
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000634 OPENSSL_free(valuebuf);
635 if (value_obj == NULL) {
636 Py_DECREF(name_obj);
637 goto fail;
638 }
639 attr = PyTuple_New(2);
640 if (attr == NULL) {
641 Py_DECREF(name_obj);
642 Py_DECREF(value_obj);
643 goto fail;
644 }
645 PyTuple_SET_ITEM(attr, 0, name_obj);
646 PyTuple_SET_ITEM(attr, 1, value_obj);
647 return attr;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000648
Bill Janssen98d19da2007-09-10 21:51:02 +0000649 fail:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000650 return NULL;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000651}
652
653static PyObject *
Bill Janssen98d19da2007-09-10 21:51:02 +0000654_create_tuple_for_X509_NAME (X509_NAME *xname)
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +0000655{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000656 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
657 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
658 PyObject *rdnt;
659 PyObject *attr = NULL; /* tuple to hold an attribute */
660 int entry_count = X509_NAME_entry_count(xname);
661 X509_NAME_ENTRY *entry;
662 ASN1_OBJECT *name;
663 ASN1_STRING *value;
664 int index_counter;
665 int rdn_level = -1;
666 int retcode;
Bill Janssen98d19da2007-09-10 21:51:02 +0000667
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000668 dn = PyList_New(0);
669 if (dn == NULL)
670 return NULL;
671 /* now create another tuple to hold the top-level RDN */
672 rdn = PyList_New(0);
673 if (rdn == NULL)
674 goto fail0;
Bill Janssen98d19da2007-09-10 21:51:02 +0000675
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000676 for (index_counter = 0;
677 index_counter < entry_count;
678 index_counter++)
679 {
680 entry = X509_NAME_get_entry(xname, index_counter);
Bill Janssen98d19da2007-09-10 21:51:02 +0000681
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000682 /* check to see if we've gotten to a new RDN */
683 if (rdn_level >= 0) {
684 if (rdn_level != entry->set) {
685 /* yes, new RDN */
686 /* add old RDN to DN */
687 rdnt = PyList_AsTuple(rdn);
688 Py_DECREF(rdn);
689 if (rdnt == NULL)
690 goto fail0;
691 retcode = PyList_Append(dn, rdnt);
692 Py_DECREF(rdnt);
693 if (retcode < 0)
694 goto fail0;
695 /* create new RDN */
696 rdn = PyList_New(0);
697 if (rdn == NULL)
698 goto fail0;
699 }
700 }
701 rdn_level = entry->set;
Bill Janssen98d19da2007-09-10 21:51:02 +0000702
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000703 /* now add this attribute to the current RDN */
704 name = X509_NAME_ENTRY_get_object(entry);
705 value = X509_NAME_ENTRY_get_data(entry);
706 attr = _create_tuple_for_attribute(name, value);
707 /*
708 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
709 entry->set,
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500710 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
711 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000712 */
713 if (attr == NULL)
714 goto fail1;
715 retcode = PyList_Append(rdn, attr);
716 Py_DECREF(attr);
717 if (retcode < 0)
718 goto fail1;
719 }
720 /* now, there's typically a dangling RDN */
Antoine Pitroudd7e0712012-02-15 22:25:27 +0100721 if (rdn != NULL) {
722 if (PyList_GET_SIZE(rdn) > 0) {
723 rdnt = PyList_AsTuple(rdn);
724 Py_DECREF(rdn);
725 if (rdnt == NULL)
726 goto fail0;
727 retcode = PyList_Append(dn, rdnt);
728 Py_DECREF(rdnt);
729 if (retcode < 0)
730 goto fail0;
731 }
732 else {
733 Py_DECREF(rdn);
734 }
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000735 }
Bill Janssen98d19da2007-09-10 21:51:02 +0000736
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000737 /* convert list to tuple */
738 rdnt = PyList_AsTuple(dn);
739 Py_DECREF(dn);
740 if (rdnt == NULL)
741 return NULL;
742 return rdnt;
Bill Janssen98d19da2007-09-10 21:51:02 +0000743
744 fail1:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000745 Py_XDECREF(rdn);
Bill Janssen98d19da2007-09-10 21:51:02 +0000746
747 fail0:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000748 Py_XDECREF(dn);
749 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +0000750}
751
752static PyObject *
753_get_peer_alt_names (X509 *certificate) {
Bill Janssen98d19da2007-09-10 21:51:02 +0000754
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000755 /* this code follows the procedure outlined in
756 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
757 function to extract the STACK_OF(GENERAL_NAME),
758 then iterates through the stack to add the
759 names. */
760
761 int i, j;
762 PyObject *peer_alt_names = Py_None;
Christian Heimesed9884b2013-09-05 16:04:35 +0200763 PyObject *v = NULL, *t;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000764 X509_EXTENSION *ext = NULL;
765 GENERAL_NAMES *names = NULL;
766 GENERAL_NAME *name;
Benjamin Peterson8e734032010-10-13 22:10:31 +0000767 const X509V3_EXT_METHOD *method;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000768 BIO *biobuf = NULL;
769 char buf[2048];
770 char *vptr;
771 int len;
772 /* Issue #2973: ASN1_item_d2i() API changed in OpenSSL 0.9.6m */
Victor Stinner3f75cc52010-03-02 22:44:42 +0000773#if OPENSSL_VERSION_NUMBER >= 0x009060dfL
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000774 const unsigned char *p;
Victor Stinner3f75cc52010-03-02 22:44:42 +0000775#else
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000776 unsigned char *p;
Victor Stinner3f75cc52010-03-02 22:44:42 +0000777#endif
Bill Janssen98d19da2007-09-10 21:51:02 +0000778
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000779 if (certificate == NULL)
780 return peer_alt_names;
Bill Janssen98d19da2007-09-10 21:51:02 +0000781
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000782 /* get a memory buffer */
783 biobuf = BIO_new(BIO_s_mem());
Bill Janssen98d19da2007-09-10 21:51:02 +0000784
Antoine Pitrouf06eb462011-10-01 19:30:58 +0200785 i = -1;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000786 while ((i = X509_get_ext_by_NID(
787 certificate, NID_subject_alt_name, i)) >= 0) {
Bill Janssen98d19da2007-09-10 21:51:02 +0000788
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000789 if (peer_alt_names == Py_None) {
790 peer_alt_names = PyList_New(0);
791 if (peer_alt_names == NULL)
792 goto fail;
793 }
Bill Janssen98d19da2007-09-10 21:51:02 +0000794
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000795 /* now decode the altName */
796 ext = X509_get_ext(certificate, i);
797 if(!(method = X509V3_EXT_get(ext))) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500798 PyErr_SetString
799 (PySSLErrorObject,
800 ERRSTR("No method for internalizing subjectAltName!"));
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000801 goto fail;
802 }
Bill Janssen98d19da2007-09-10 21:51:02 +0000803
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000804 p = ext->value->data;
805 if (method->it)
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500806 names = (GENERAL_NAMES*)
807 (ASN1_item_d2i(NULL,
808 &p,
809 ext->value->length,
810 ASN1_ITEM_ptr(method->it)));
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000811 else
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500812 names = (GENERAL_NAMES*)
813 (method->d2i(NULL,
814 &p,
815 ext->value->length));
Bill Janssen98d19da2007-09-10 21:51:02 +0000816
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000817 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000818 /* get a rendering of each name in the set of names */
Christian Heimes88b174c2013-08-17 00:54:47 +0200819 int gntype;
820 ASN1_STRING *as = NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +0000821
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000822 name = sk_GENERAL_NAME_value(names, j);
Christian Heimesf1bd47a2013-08-17 17:18:56 +0200823 gntype = name->type;
Christian Heimes88b174c2013-08-17 00:54:47 +0200824 switch (gntype) {
825 case GEN_DIRNAME:
826 /* we special-case DirName as a tuple of
827 tuples of attributes */
Bill Janssen98d19da2007-09-10 21:51:02 +0000828
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000829 t = PyTuple_New(2);
830 if (t == NULL) {
831 goto fail;
832 }
Bill Janssen98d19da2007-09-10 21:51:02 +0000833
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000834 v = PyString_FromString("DirName");
835 if (v == NULL) {
836 Py_DECREF(t);
837 goto fail;
838 }
839 PyTuple_SET_ITEM(t, 0, v);
Bill Janssen98d19da2007-09-10 21:51:02 +0000840
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000841 v = _create_tuple_for_X509_NAME (name->d.dirn);
842 if (v == NULL) {
843 Py_DECREF(t);
844 goto fail;
845 }
846 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes88b174c2013-08-17 00:54:47 +0200847 break;
Bill Janssen98d19da2007-09-10 21:51:02 +0000848
Christian Heimes88b174c2013-08-17 00:54:47 +0200849 case GEN_EMAIL:
850 case GEN_DNS:
851 case GEN_URI:
852 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
853 correctly, CVE-2013-4238 */
854 t = PyTuple_New(2);
855 if (t == NULL)
856 goto fail;
857 switch (gntype) {
858 case GEN_EMAIL:
859 v = PyString_FromString("email");
860 as = name->d.rfc822Name;
861 break;
862 case GEN_DNS:
863 v = PyString_FromString("DNS");
864 as = name->d.dNSName;
865 break;
866 case GEN_URI:
867 v = PyString_FromString("URI");
868 as = name->d.uniformResourceIdentifier;
869 break;
870 }
871 if (v == NULL) {
872 Py_DECREF(t);
873 goto fail;
874 }
875 PyTuple_SET_ITEM(t, 0, v);
876 v = PyString_FromStringAndSize((char *)ASN1_STRING_data(as),
877 ASN1_STRING_length(as));
878 if (v == NULL) {
879 Py_DECREF(t);
880 goto fail;
881 }
882 PyTuple_SET_ITEM(t, 1, v);
883 break;
Bill Janssen98d19da2007-09-10 21:51:02 +0000884
Christian Heimes88b174c2013-08-17 00:54:47 +0200885 default:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000886 /* for everything else, we use the OpenSSL print form */
Christian Heimes88b174c2013-08-17 00:54:47 +0200887 switch (gntype) {
888 /* check for new general name type */
889 case GEN_OTHERNAME:
890 case GEN_X400:
891 case GEN_EDIPARTY:
892 case GEN_IPADD:
893 case GEN_RID:
894 break;
895 default:
896 if (PyErr_Warn(PyExc_RuntimeWarning,
897 "Unknown general name type") == -1) {
898 goto fail;
899 }
900 break;
901 }
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000902 (void) BIO_reset(biobuf);
903 GENERAL_NAME_print(biobuf, name);
904 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
905 if (len < 0) {
906 _setSSLError(NULL, 0, __FILE__, __LINE__);
907 goto fail;
908 }
909 vptr = strchr(buf, ':');
910 if (vptr == NULL)
911 goto fail;
912 t = PyTuple_New(2);
913 if (t == NULL)
914 goto fail;
915 v = PyString_FromStringAndSize(buf, (vptr - buf));
916 if (v == NULL) {
917 Py_DECREF(t);
918 goto fail;
919 }
920 PyTuple_SET_ITEM(t, 0, v);
921 v = PyString_FromStringAndSize((vptr + 1), (len - (vptr - buf + 1)));
922 if (v == NULL) {
923 Py_DECREF(t);
924 goto fail;
925 }
926 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes88b174c2013-08-17 00:54:47 +0200927 break;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000928 }
929
930 /* and add that rendering to the list */
931
932 if (PyList_Append(peer_alt_names, t) < 0) {
933 Py_DECREF(t);
934 goto fail;
935 }
936 Py_DECREF(t);
937 }
Antoine Pitrouaa1c9672011-11-23 01:39:19 +0100938 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000939 }
940 BIO_free(biobuf);
941 if (peer_alt_names != Py_None) {
942 v = PyList_AsTuple(peer_alt_names);
943 Py_DECREF(peer_alt_names);
944 return v;
945 } else {
946 return peer_alt_names;
947 }
948
Bill Janssen98d19da2007-09-10 21:51:02 +0000949
950 fail:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000951 if (biobuf != NULL)
952 BIO_free(biobuf);
Bill Janssen98d19da2007-09-10 21:51:02 +0000953
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000954 if (peer_alt_names != Py_None) {
955 Py_XDECREF(peer_alt_names);
956 }
Bill Janssen98d19da2007-09-10 21:51:02 +0000957
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +0000958 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +0000959}
960
961static PyObject *
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500962_get_aia_uri(X509 *certificate, int nid) {
963 PyObject *lst = NULL, *ostr = NULL;
964 int i, result;
965 AUTHORITY_INFO_ACCESS *info;
966
967 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
Benjamin Petersonc5919362015-11-14 15:12:18 -0800968 if (info == NULL)
969 return Py_None;
970 if (sk_ACCESS_DESCRIPTION_num(info) == 0) {
971 AUTHORITY_INFO_ACCESS_free(info);
Benjamin Petersondaeb9252014-08-20 14:14:50 -0500972 return Py_None;
973 }
974
975 if ((lst = PyList_New(0)) == NULL) {
976 goto fail;
977 }
978
979 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
980 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
981 ASN1_IA5STRING *uri;
982
983 if ((OBJ_obj2nid(ad->method) != nid) ||
984 (ad->location->type != GEN_URI)) {
985 continue;
986 }
987 uri = ad->location->d.uniformResourceIdentifier;
988 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
989 uri->length);
990 if (ostr == NULL) {
991 goto fail;
992 }
993 result = PyList_Append(lst, ostr);
994 Py_DECREF(ostr);
995 if (result < 0) {
996 goto fail;
997 }
998 }
999 AUTHORITY_INFO_ACCESS_free(info);
1000
1001 /* convert to tuple or None */
1002 if (PyList_Size(lst) == 0) {
1003 Py_DECREF(lst);
1004 return Py_None;
1005 } else {
1006 PyObject *tup;
1007 tup = PyList_AsTuple(lst);
1008 Py_DECREF(lst);
1009 return tup;
1010 }
1011
1012 fail:
1013 AUTHORITY_INFO_ACCESS_free(info);
1014 Py_XDECREF(lst);
1015 return NULL;
1016}
1017
1018static PyObject *
1019_get_crl_dp(X509 *certificate) {
1020 STACK_OF(DIST_POINT) *dps;
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001021 int i, j;
1022 PyObject *lst, *res = NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001023
1024#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001025 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points, NULL, NULL);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001026#else
1027 /* Calls x509v3_cache_extensions and sets up crldp */
1028 X509_check_ca(certificate);
1029 dps = certificate->crldp;
1030#endif
1031
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001032 if (dps == NULL)
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001033 return Py_None;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001034
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001035 lst = PyList_New(0);
1036 if (lst == NULL)
1037 goto done;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001038
1039 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1040 DIST_POINT *dp;
1041 STACK_OF(GENERAL_NAME) *gns;
1042
1043 dp = sk_DIST_POINT_value(dps, i);
1044 gns = dp->distpoint->name.fullname;
1045
1046 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1047 GENERAL_NAME *gn;
1048 ASN1_IA5STRING *uri;
1049 PyObject *ouri;
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001050 int err;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001051
1052 gn = sk_GENERAL_NAME_value(gns, j);
1053 if (gn->type != GEN_URI) {
1054 continue;
1055 }
1056 uri = gn->d.uniformResourceIdentifier;
1057 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1058 uri->length);
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001059 if (ouri == NULL)
1060 goto done;
1061
1062 err = PyList_Append(lst, ouri);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001063 Py_DECREF(ouri);
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001064 if (err < 0)
1065 goto done;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001066 }
1067 }
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001068
1069 /* Convert to tuple. */
1070 res = (PyList_GET_SIZE(lst) > 0) ? PyList_AsTuple(lst) : Py_None;
1071
1072 done:
1073 Py_XDECREF(lst);
1074#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Petersonb1c1e672015-11-14 00:09:22 -08001075 sk_DIST_POINT_free(dps);
Benjamin Peterson59d451d2015-11-11 22:07:38 -08001076#endif
1077 return res;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001078}
1079
1080static PyObject *
1081_decode_certificate(X509 *certificate) {
Bill Janssen98d19da2007-09-10 21:51:02 +00001082
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001083 PyObject *retval = NULL;
1084 BIO *biobuf = NULL;
1085 PyObject *peer;
1086 PyObject *peer_alt_names = NULL;
1087 PyObject *issuer;
1088 PyObject *version;
1089 PyObject *sn_obj;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001090 PyObject *obj;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001091 ASN1_INTEGER *serialNumber;
1092 char buf[2048];
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001093 int len, result;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001094 ASN1_TIME *notBefore, *notAfter;
1095 PyObject *pnotBefore, *pnotAfter;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001096
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001097 retval = PyDict_New();
1098 if (retval == NULL)
1099 return NULL;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001100
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001101 peer = _create_tuple_for_X509_NAME(
1102 X509_get_subject_name(certificate));
1103 if (peer == NULL)
1104 goto fail0;
1105 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1106 Py_DECREF(peer);
1107 goto fail0;
1108 }
1109 Py_DECREF(peer);
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001110
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001111 issuer = _create_tuple_for_X509_NAME(
1112 X509_get_issuer_name(certificate));
1113 if (issuer == NULL)
1114 goto fail0;
1115 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001116 Py_DECREF(issuer);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001117 goto fail0;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001118 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001119 Py_DECREF(issuer);
1120
1121 version = PyLong_FromLong(X509_get_version(certificate) + 1);
1122 if (version == NULL)
1123 goto fail0;
1124 if (PyDict_SetItemString(retval, "version", version) < 0) {
1125 Py_DECREF(version);
1126 goto fail0;
1127 }
1128 Py_DECREF(version);
Bill Janssen98d19da2007-09-10 21:51:02 +00001129
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001130 /* get a memory buffer */
1131 biobuf = BIO_new(BIO_s_mem());
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001132
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001133 (void) BIO_reset(biobuf);
1134 serialNumber = X509_get_serialNumber(certificate);
1135 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1136 i2a_ASN1_INTEGER(biobuf, serialNumber);
1137 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1138 if (len < 0) {
1139 _setSSLError(NULL, 0, __FILE__, __LINE__);
1140 goto fail1;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001141 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001142 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1143 if (sn_obj == NULL)
1144 goto fail1;
1145 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1146 Py_DECREF(sn_obj);
1147 goto fail1;
1148 }
1149 Py_DECREF(sn_obj);
1150
1151 (void) BIO_reset(biobuf);
1152 notBefore = X509_get_notBefore(certificate);
1153 ASN1_TIME_print(biobuf, notBefore);
1154 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1155 if (len < 0) {
1156 _setSSLError(NULL, 0, __FILE__, __LINE__);
1157 goto fail1;
1158 }
1159 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1160 if (pnotBefore == NULL)
1161 goto fail1;
1162 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1163 Py_DECREF(pnotBefore);
1164 goto fail1;
1165 }
1166 Py_DECREF(pnotBefore);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001167
1168 (void) BIO_reset(biobuf);
1169 notAfter = X509_get_notAfter(certificate);
1170 ASN1_TIME_print(biobuf, notAfter);
1171 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1172 if (len < 0) {
1173 _setSSLError(NULL, 0, __FILE__, __LINE__);
1174 goto fail1;
1175 }
1176 pnotAfter = PyString_FromStringAndSize(buf, len);
1177 if (pnotAfter == NULL)
1178 goto fail1;
1179 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1180 Py_DECREF(pnotAfter);
1181 goto fail1;
1182 }
1183 Py_DECREF(pnotAfter);
1184
1185 /* Now look for subjectAltName */
1186
1187 peer_alt_names = _get_peer_alt_names(certificate);
1188 if (peer_alt_names == NULL)
1189 goto fail1;
1190 else if (peer_alt_names != Py_None) {
1191 if (PyDict_SetItemString(retval, "subjectAltName",
1192 peer_alt_names) < 0) {
1193 Py_DECREF(peer_alt_names);
1194 goto fail1;
1195 }
1196 Py_DECREF(peer_alt_names);
1197 }
1198
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001199 /* Authority Information Access: OCSP URIs */
1200 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1201 if (obj == NULL) {
1202 goto fail1;
1203 } else if (obj != Py_None) {
1204 result = PyDict_SetItemString(retval, "OCSP", obj);
1205 Py_DECREF(obj);
1206 if (result < 0) {
1207 goto fail1;
1208 }
1209 }
1210
1211 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1212 if (obj == NULL) {
1213 goto fail1;
1214 } else if (obj != Py_None) {
1215 result = PyDict_SetItemString(retval, "caIssuers", obj);
1216 Py_DECREF(obj);
1217 if (result < 0) {
1218 goto fail1;
1219 }
1220 }
1221
1222 /* CDP (CRL distribution points) */
1223 obj = _get_crl_dp(certificate);
1224 if (obj == NULL) {
1225 goto fail1;
1226 } else if (obj != Py_None) {
1227 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1228 Py_DECREF(obj);
1229 if (result < 0) {
1230 goto fail1;
1231 }
1232 }
1233
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001234 BIO_free(biobuf);
1235 return retval;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001236
1237 fail1:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001238 if (biobuf != NULL)
1239 BIO_free(biobuf);
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001240 fail0:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001241 Py_XDECREF(retval);
1242 return NULL;
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001243}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001244
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001245static PyObject *
1246_certificate_to_der(X509 *certificate)
1247{
1248 unsigned char *bytes_buf = NULL;
1249 int len;
1250 PyObject *retval;
1251
1252 bytes_buf = NULL;
1253 len = i2d_X509(certificate, &bytes_buf);
1254 if (len < 0) {
1255 _setSSLError(NULL, 0, __FILE__, __LINE__);
1256 return NULL;
1257 }
1258 /* this is actually an immutable bytes sequence */
1259 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1260 OPENSSL_free(bytes_buf);
1261 return retval;
1262}
Bill Janssen98d19da2007-09-10 21:51:02 +00001263
1264static PyObject *
1265PySSL_test_decode_certificate (PyObject *mod, PyObject *args) {
1266
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001267 PyObject *retval = NULL;
1268 char *filename = NULL;
1269 X509 *x=NULL;
1270 BIO *cert;
Bill Janssen98d19da2007-09-10 21:51:02 +00001271
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001272 if (!PyArg_ParseTuple(args, "s:test_decode_certificate", &filename))
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001273 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +00001274
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001275 if ((cert=BIO_new(BIO_s_file())) == NULL) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001276 PyErr_SetString(PySSLErrorObject,
1277 "Can't malloc memory to read file");
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001278 goto fail0;
1279 }
Bill Janssen98d19da2007-09-10 21:51:02 +00001280
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001281 if (BIO_read_filename(cert,filename) <= 0) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001282 PyErr_SetString(PySSLErrorObject,
1283 "Can't open file");
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001284 goto fail0;
1285 }
Bill Janssen98d19da2007-09-10 21:51:02 +00001286
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001287 x = PEM_read_bio_X509_AUX(cert,NULL, NULL, NULL);
1288 if (x == NULL) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001289 PyErr_SetString(PySSLErrorObject,
1290 "Error decoding PEM-encoded file");
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001291 goto fail0;
1292 }
Bill Janssen98d19da2007-09-10 21:51:02 +00001293
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001294 retval = _decode_certificate(x);
Mark Dickinson793c71c2010-08-03 18:34:53 +00001295 X509_free(x);
Bill Janssen98d19da2007-09-10 21:51:02 +00001296
1297 fail0:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001298
1299 if (cert != NULL) BIO_free(cert);
1300 return retval;
Bill Janssen98d19da2007-09-10 21:51:02 +00001301}
1302
1303
1304static PyObject *
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001305PySSL_peercert(PySSLSocket *self, PyObject *args)
Bill Janssen98d19da2007-09-10 21:51:02 +00001306{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001307 int verification;
1308 PyObject *binary_mode = Py_None;
Antoine Pitrouc5bef752012-08-15 23:16:51 +02001309 int b;
Bill Janssen98d19da2007-09-10 21:51:02 +00001310
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001311 if (!PyArg_ParseTuple(args, "|O:peer_certificate", &binary_mode))
1312 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +00001313
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001314 if (!self->handshake_done) {
1315 PyErr_SetString(PyExc_ValueError,
1316 "handshake not done yet");
1317 return NULL;
1318 }
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001319 if (!self->peer_cert)
1320 Py_RETURN_NONE;
Bill Janssen98d19da2007-09-10 21:51:02 +00001321
Antoine Pitrouc5bef752012-08-15 23:16:51 +02001322 b = PyObject_IsTrue(binary_mode);
1323 if (b < 0)
1324 return NULL;
1325 if (b) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001326 /* return cert in DER-encoded format */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001327 return _certificate_to_der(self->peer_cert);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001328 } else {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001329 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001330 if ((verification & SSL_VERIFY_PEER) == 0)
1331 return PyDict_New();
1332 else
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001333 return _decode_certificate(self->peer_cert);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001334 }
Bill Janssen98d19da2007-09-10 21:51:02 +00001335}
1336
1337PyDoc_STRVAR(PySSL_peercert_doc,
1338"peer_certificate([der=False]) -> certificate\n\
1339\n\
1340Returns the certificate for the peer. If no certificate was provided,\n\
1341returns None. If a certificate was provided, but not validated, returns\n\
1342an empty dictionary. Otherwise returns a dict containing information\n\
1343about the peer certificate.\n\
1344\n\
1345If the optional argument is True, returns a DER-encoded copy of the\n\
1346peer certificate, or None if no certificate was provided. This will\n\
1347return the certificate even if it wasn't validated.");
1348
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001349static PyObject *PySSL_cipher (PySSLSocket *self) {
Bill Janssen98d19da2007-09-10 21:51:02 +00001350
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001351 PyObject *retval, *v;
Benjamin Peterson8e734032010-10-13 22:10:31 +00001352 const SSL_CIPHER *current;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001353 char *cipher_name;
1354 char *cipher_protocol;
Bill Janssen98d19da2007-09-10 21:51:02 +00001355
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001356 if (self->ssl == NULL)
Hirokazu Yamamotoa9b16892010-12-09 12:12:42 +00001357 Py_RETURN_NONE;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001358 current = SSL_get_current_cipher(self->ssl);
1359 if (current == NULL)
Hirokazu Yamamotoa9b16892010-12-09 12:12:42 +00001360 Py_RETURN_NONE;
Bill Janssen98d19da2007-09-10 21:51:02 +00001361
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001362 retval = PyTuple_New(3);
1363 if (retval == NULL)
1364 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +00001365
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001366 cipher_name = (char *) SSL_CIPHER_get_name(current);
1367 if (cipher_name == NULL) {
Hirokazu Yamamotoa9b16892010-12-09 12:12:42 +00001368 Py_INCREF(Py_None);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001369 PyTuple_SET_ITEM(retval, 0, Py_None);
1370 } else {
1371 v = PyString_FromString(cipher_name);
1372 if (v == NULL)
1373 goto fail0;
1374 PyTuple_SET_ITEM(retval, 0, v);
1375 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001376 cipher_protocol = (char *) SSL_CIPHER_get_version(current);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001377 if (cipher_protocol == NULL) {
Hirokazu Yamamotoa9b16892010-12-09 12:12:42 +00001378 Py_INCREF(Py_None);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001379 PyTuple_SET_ITEM(retval, 1, Py_None);
1380 } else {
1381 v = PyString_FromString(cipher_protocol);
1382 if (v == NULL)
1383 goto fail0;
1384 PyTuple_SET_ITEM(retval, 1, v);
1385 }
1386 v = PyInt_FromLong(SSL_CIPHER_get_bits(current, NULL));
1387 if (v == NULL)
1388 goto fail0;
1389 PyTuple_SET_ITEM(retval, 2, v);
1390 return retval;
1391
Bill Janssen98d19da2007-09-10 21:51:02 +00001392 fail0:
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001393 Py_DECREF(retval);
1394 return NULL;
Bill Janssen98d19da2007-09-10 21:51:02 +00001395}
1396
Alex Gaynore98205d2014-09-04 13:33:22 -07001397static PyObject *PySSL_version(PySSLSocket *self)
1398{
1399 const char *version;
1400
1401 if (self->ssl == NULL)
1402 Py_RETURN_NONE;
1403 version = SSL_get_version(self->ssl);
1404 if (!strcmp(version, "unknown"))
1405 Py_RETURN_NONE;
1406 return PyUnicode_FromString(version);
1407}
1408
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001409#ifdef OPENSSL_NPN_NEGOTIATED
1410static PyObject *PySSL_selected_npn_protocol(PySSLSocket *self) {
1411 const unsigned char *out;
1412 unsigned int outlen;
1413
1414 SSL_get0_next_proto_negotiated(self->ssl,
1415 &out, &outlen);
1416
1417 if (out == NULL)
1418 Py_RETURN_NONE;
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05001419 return PyString_FromStringAndSize((char *)out, outlen);
1420}
1421#endif
1422
1423#ifdef HAVE_ALPN
1424static PyObject *PySSL_selected_alpn_protocol(PySSLSocket *self) {
1425 const unsigned char *out;
1426 unsigned int outlen;
1427
1428 SSL_get0_alpn_selected(self->ssl, &out, &outlen);
1429
1430 if (out == NULL)
1431 Py_RETURN_NONE;
1432 return PyString_FromStringAndSize((char *)out, outlen);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001433}
1434#endif
1435
1436static PyObject *PySSL_compression(PySSLSocket *self) {
1437#ifdef OPENSSL_NO_COMP
1438 Py_RETURN_NONE;
1439#else
1440 const COMP_METHOD *comp_method;
1441 const char *short_name;
1442
1443 if (self->ssl == NULL)
1444 Py_RETURN_NONE;
1445 comp_method = SSL_get_current_compression(self->ssl);
1446 if (comp_method == NULL || comp_method->type == NID_undef)
1447 Py_RETURN_NONE;
1448 short_name = OBJ_nid2sn(comp_method->type);
1449 if (short_name == NULL)
1450 Py_RETURN_NONE;
1451 return PyBytes_FromString(short_name);
1452#endif
1453}
1454
1455static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
1456 Py_INCREF(self->ctx);
1457 return self->ctx;
1458}
1459
1460static int PySSL_set_context(PySSLSocket *self, PyObject *value,
1461 void *closure) {
1462
1463 if (PyObject_TypeCheck(value, &PySSLContext_Type)) {
1464#if !HAVE_SNI
1465 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
1466 "context is not supported by your OpenSSL library");
1467 return -1;
1468#else
1469 Py_INCREF(value);
1470 Py_DECREF(self->ctx);
1471 self->ctx = (PySSLContext *) value;
1472 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
1473#endif
1474 } else {
1475 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
1476 return -1;
1477 }
1478
1479 return 0;
1480}
1481
1482PyDoc_STRVAR(PySSL_set_context_doc,
1483"_setter_context(ctx)\n\
1484\
1485This changes the context associated with the SSLSocket. This is typically\n\
1486used from within a callback function set by the set_servername_callback\n\
1487on the SSLContext to change the certificate information associated with the\n\
1488SSLSocket before the cryptographic exchange handshake messages\n");
1489
1490
1491
1492static void PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001493{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001494 if (self->peer_cert) /* Possible not to have one? */
1495 X509_free (self->peer_cert);
1496 if (self->ssl)
1497 SSL_free(self->ssl);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001498 Py_XDECREF(self->Socket);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001499 Py_XDECREF(self->ssl_sock);
1500 Py_XDECREF(self->ctx);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001501 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001502}
1503
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001504/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001505 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001506 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001507 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001508
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001509static int
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001510check_socket_and_wait_for_timeout(PySocketSockObject *s, int writing)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001511{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001512 fd_set fds;
1513 struct timeval tv;
1514 int rc;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001515
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001516 /* Nothing to do unless we're in timeout mode (not non-blocking) */
1517 if (s->sock_timeout < 0.0)
1518 return SOCKET_IS_BLOCKING;
1519 else if (s->sock_timeout == 0.0)
1520 return SOCKET_IS_NONBLOCKING;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001521
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001522 /* Guard against closed socket */
1523 if (s->sock_fd < 0)
1524 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001525
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001526 /* Prefer poll, if available, since you can poll() any fd
1527 * which can't be done with select(). */
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001528#ifdef HAVE_POLL
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001529 {
1530 struct pollfd pollfd;
1531 int timeout;
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001532
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001533 pollfd.fd = s->sock_fd;
1534 pollfd.events = writing ? POLLOUT : POLLIN;
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001535
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001536 /* s->sock_timeout is in seconds, timeout in ms */
1537 timeout = (int)(s->sock_timeout * 1000 + 0.5);
1538 PySSL_BEGIN_ALLOW_THREADS
1539 rc = poll(&pollfd, 1, timeout);
1540 PySSL_END_ALLOW_THREADS
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001541
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001542 goto normal_return;
1543 }
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001544#endif
1545
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001546 /* Guard against socket too large for select*/
Charles-François Natalifda7b372011-08-28 16:22:33 +02001547 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001548 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00001549
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001550 /* Construct the arguments to select */
1551 tv.tv_sec = (int)s->sock_timeout;
1552 tv.tv_usec = (int)((s->sock_timeout - tv.tv_sec) * 1e6);
1553 FD_ZERO(&fds);
1554 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001555
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001556 /* See if the socket is ready */
1557 PySSL_BEGIN_ALLOW_THREADS
1558 if (writing)
1559 rc = select(s->sock_fd+1, NULL, &fds, NULL, &tv);
1560 else
1561 rc = select(s->sock_fd+1, &fds, NULL, NULL, &tv);
1562 PySSL_END_ALLOW_THREADS
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001563
Bill Janssen934b16d2008-06-28 22:19:33 +00001564#ifdef HAVE_POLL
Anthony Baxter93ab5fa2006-07-11 02:04:09 +00001565normal_return:
Bill Janssen934b16d2008-06-28 22:19:33 +00001566#endif
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001567 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
1568 (when we are able to write or when there's something to read) */
1569 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001570}
1571
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001572static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001573{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001574 Py_buffer buf;
1575 int len;
1576 int sockstate;
1577 int err;
1578 int nonblocking;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001579 PySocketSockObject *sock = self->Socket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001580
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001581 Py_INCREF(sock);
1582
1583 if (!PyArg_ParseTuple(args, "s*:write", &buf)) {
1584 Py_DECREF(sock);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001585 return NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001586 }
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001587
Victor Stinnerc1a44262013-06-25 00:48:02 +02001588 if (buf.len > INT_MAX) {
1589 PyErr_Format(PyExc_OverflowError,
1590 "string longer than %d bytes", INT_MAX);
1591 goto error;
1592 }
1593
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001594 /* just in case the blocking state of the socket has been changed */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001595 nonblocking = (sock->sock_timeout >= 0.0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001596 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1597 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Bill Janssen934b16d2008-06-28 22:19:33 +00001598
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001599 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001600 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1601 PyErr_SetString(PySSLErrorObject,
1602 "The write operation timed out");
1603 goto error;
1604 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1605 PyErr_SetString(PySSLErrorObject,
1606 "Underlying socket has been closed.");
1607 goto error;
1608 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1609 PyErr_SetString(PySSLErrorObject,
1610 "Underlying socket too large for select().");
1611 goto error;
1612 }
1613 do {
1614 PySSL_BEGIN_ALLOW_THREADS
Victor Stinnerc1a44262013-06-25 00:48:02 +02001615 len = SSL_write(self->ssl, buf.buf, (int)buf.len);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001616 err = SSL_get_error(self->ssl, len);
1617 PySSL_END_ALLOW_THREADS
1618 if (PyErr_CheckSignals()) {
1619 goto error;
1620 }
1621 if (err == SSL_ERROR_WANT_READ) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001622 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001623 } else if (err == SSL_ERROR_WANT_WRITE) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001624 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001625 } else {
1626 sockstate = SOCKET_OPERATION_OK;
1627 }
1628 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1629 PyErr_SetString(PySSLErrorObject,
1630 "The write operation timed out");
1631 goto error;
1632 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1633 PyErr_SetString(PySSLErrorObject,
1634 "Underlying socket has been closed.");
1635 goto error;
1636 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1637 break;
1638 }
1639 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Antoine Pitrou5ba84912009-10-19 17:59:07 +00001640
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001641 Py_DECREF(sock);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001642 PyBuffer_Release(&buf);
1643 if (len > 0)
1644 return PyInt_FromLong(len);
1645 else
1646 return PySSL_SetError(self, len, __FILE__, __LINE__);
Antoine Pitrou5ba84912009-10-19 17:59:07 +00001647
1648error:
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001649 Py_DECREF(sock);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001650 PyBuffer_Release(&buf);
1651 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001652}
1653
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001654PyDoc_STRVAR(PySSL_SSLwrite_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001655"write(s) -> len\n\
1656\n\
1657Writes the string s into the SSL object. Returns the number\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001658of bytes written.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001659
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001660static PyObject *PySSL_SSLpending(PySSLSocket *self)
Bill Janssen934b16d2008-06-28 22:19:33 +00001661{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001662 int count = 0;
Bill Janssen934b16d2008-06-28 22:19:33 +00001663
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001664 PySSL_BEGIN_ALLOW_THREADS
1665 count = SSL_pending(self->ssl);
1666 PySSL_END_ALLOW_THREADS
1667 if (count < 0)
1668 return PySSL_SetError(self, count, __FILE__, __LINE__);
1669 else
1670 return PyInt_FromLong(count);
Bill Janssen934b16d2008-06-28 22:19:33 +00001671}
1672
1673PyDoc_STRVAR(PySSL_SSLpending_doc,
1674"pending() -> count\n\
1675\n\
1676Returns the number of already decrypted bytes available for read,\n\
1677pending on the connection.\n");
1678
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001679static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001680{
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001681 PyObject *dest = NULL;
1682 Py_buffer buf;
1683 char *mem;
1684 int len, count;
1685 int buf_passed = 0;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001686 int sockstate;
1687 int err;
1688 int nonblocking;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001689 PySocketSockObject *sock = self->Socket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001690
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001691 Py_INCREF(sock);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001692
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001693 buf.obj = NULL;
1694 buf.buf = NULL;
1695 if (!PyArg_ParseTuple(args, "i|w*:read", &len, &buf))
1696 goto error;
1697
1698 if ((buf.buf == NULL) && (buf.obj == NULL)) {
1699 dest = PyBytes_FromStringAndSize(NULL, len);
1700 if (dest == NULL)
1701 goto error;
1702 mem = PyBytes_AS_STRING(dest);
1703 }
1704 else {
1705 buf_passed = 1;
1706 mem = buf.buf;
1707 if (len <= 0 || len > buf.len) {
1708 len = (int) buf.len;
1709 if (buf.len != len) {
1710 PyErr_SetString(PyExc_OverflowError,
1711 "maximum length can't fit in a C 'int'");
1712 goto error;
1713 }
1714 }
1715 }
Guido van Rossum4f2c3dd2007-08-25 15:08:43 +00001716
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001717 /* just in case the blocking state of the socket has been changed */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001718 nonblocking = (sock->sock_timeout >= 0.0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001719 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1720 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Bill Janssen934b16d2008-06-28 22:19:33 +00001721
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001722 do {
1723 PySSL_BEGIN_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001724 count = SSL_read(self->ssl, mem, len);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001725 err = SSL_get_error(self->ssl, count);
1726 PySSL_END_ALLOW_THREADS
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001727 if (PyErr_CheckSignals())
1728 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001729 if (err == SSL_ERROR_WANT_READ) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001730 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001731 } else if (err == SSL_ERROR_WANT_WRITE) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001732 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001733 } else if ((err == SSL_ERROR_ZERO_RETURN) &&
1734 (SSL_get_shutdown(self->ssl) ==
1735 SSL_RECEIVED_SHUTDOWN))
1736 {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001737 count = 0;
1738 goto done;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001739 } else {
1740 sockstate = SOCKET_OPERATION_OK;
1741 }
1742 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1743 PyErr_SetString(PySSLErrorObject,
1744 "The read operation timed out");
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001745 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001746 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1747 break;
1748 }
1749 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
1750 if (count <= 0) {
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001751 PySSL_SetError(self, count, __FILE__, __LINE__);
1752 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001753 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001754
1755done:
1756 Py_DECREF(sock);
1757 if (!buf_passed) {
1758 _PyBytes_Resize(&dest, count);
1759 return dest;
1760 }
1761 else {
1762 PyBuffer_Release(&buf);
1763 return PyLong_FromLong(count);
1764 }
1765
1766error:
1767 Py_DECREF(sock);
1768 if (!buf_passed)
1769 Py_XDECREF(dest);
1770 else
1771 PyBuffer_Release(&buf);
1772 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001773}
1774
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001775PyDoc_STRVAR(PySSL_SSLread_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001776"read([len]) -> string\n\
1777\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001778Read up to len bytes from the SSL socket.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001779
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001780static PyObject *PySSL_SSLshutdown(PySSLSocket *self)
Bill Janssen934b16d2008-06-28 22:19:33 +00001781{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001782 int err, ssl_err, sockstate, nonblocking;
1783 int zeros = 0;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001784 PySocketSockObject *sock = self->Socket;
Bill Janssen934b16d2008-06-28 22:19:33 +00001785
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001786 /* Guard against closed socket */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001787 if (sock->sock_fd < 0) {
1788 _setSSLError("Underlying socket connection gone",
1789 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001790 return NULL;
1791 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001792 Py_INCREF(sock);
Bill Janssen934b16d2008-06-28 22:19:33 +00001793
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001794 /* Just in case the blocking state of the socket has been changed */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001795 nonblocking = (sock->sock_timeout >= 0.0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001796 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1797 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroua5c4b552010-04-22 23:33:02 +00001798
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001799 while (1) {
1800 PySSL_BEGIN_ALLOW_THREADS
1801 /* Disable read-ahead so that unwrap can work correctly.
1802 * Otherwise OpenSSL might read in too much data,
1803 * eating clear text data that happens to be
1804 * transmitted after the SSL shutdown.
Ezio Melotti419e23c2013-08-17 16:56:09 +03001805 * Should be safe to call repeatedly every time this
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001806 * function is used and the shutdown_seen_zero != 0
1807 * condition is met.
1808 */
1809 if (self->shutdown_seen_zero)
1810 SSL_set_read_ahead(self->ssl, 0);
1811 err = SSL_shutdown(self->ssl);
1812 PySSL_END_ALLOW_THREADS
1813 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
1814 if (err > 0)
1815 break;
1816 if (err == 0) {
1817 /* Don't loop endlessly; instead preserve legacy
1818 behaviour of trying SSL_shutdown() only twice.
1819 This looks necessary for OpenSSL < 0.9.8m */
1820 if (++zeros > 1)
1821 break;
1822 /* Shutdown was sent, now try receiving */
1823 self->shutdown_seen_zero = 1;
1824 continue;
1825 }
Antoine Pitroua5c4b552010-04-22 23:33:02 +00001826
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001827 /* Possibly retry shutdown until timeout or failure */
1828 ssl_err = SSL_get_error(self->ssl, err);
1829 if (ssl_err == SSL_ERROR_WANT_READ)
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001830 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001831 else if (ssl_err == SSL_ERROR_WANT_WRITE)
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001832 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001833 else
1834 break;
1835 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1836 if (ssl_err == SSL_ERROR_WANT_READ)
1837 PyErr_SetString(PySSLErrorObject,
1838 "The read operation timed out");
1839 else
1840 PyErr_SetString(PySSLErrorObject,
1841 "The write operation timed out");
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001842 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001843 }
1844 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1845 PyErr_SetString(PySSLErrorObject,
1846 "Underlying socket too large for select().");
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001847 goto error;
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001848 }
1849 else if (sockstate != SOCKET_OPERATION_OK)
1850 /* Retain the SSL error code */
1851 break;
1852 }
Bill Janssen934b16d2008-06-28 22:19:33 +00001853
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001854 if (err < 0) {
1855 Py_DECREF(sock);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001856 return PySSL_SetError(self, err, __FILE__, __LINE__);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001857 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001858 else
1859 /* It's already INCREF'ed */
1860 return (PyObject *) sock;
1861
1862error:
1863 Py_DECREF(sock);
1864 return NULL;
Bill Janssen934b16d2008-06-28 22:19:33 +00001865}
1866
1867PyDoc_STRVAR(PySSL_SSLshutdown_doc,
1868"shutdown(s) -> socket\n\
1869\n\
1870Does the SSL shutdown handshake with the remote end, and returns\n\
1871the underlying socket object.");
1872
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001873#if HAVE_OPENSSL_FINISHED
1874static PyObject *
1875PySSL_tls_unique_cb(PySSLSocket *self)
1876{
1877 PyObject *retval = NULL;
1878 char buf[PySSL_CB_MAXLEN];
1879 size_t len;
1880
1881 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
1882 /* if session is resumed XOR we are the client */
1883 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1884 }
1885 else {
1886 /* if a new session XOR we are the server */
1887 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1888 }
1889
1890 /* It cannot be negative in current OpenSSL version as of July 2011 */
1891 if (len == 0)
1892 Py_RETURN_NONE;
1893
1894 retval = PyBytes_FromStringAndSize(buf, len);
1895
1896 return retval;
1897}
1898
1899PyDoc_STRVAR(PySSL_tls_unique_cb_doc,
1900"tls_unique_cb() -> bytes\n\
1901\n\
1902Returns the 'tls-unique' channel binding data, as defined by RFC 5929.\n\
1903\n\
1904If the TLS handshake is not yet complete, None is returned");
1905
1906#endif /* HAVE_OPENSSL_FINISHED */
1907
1908static PyGetSetDef ssl_getsetlist[] = {
1909 {"context", (getter) PySSL_get_context,
1910 (setter) PySSL_set_context, PySSL_set_context_doc},
1911 {NULL}, /* sentinel */
1912};
1913
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001914static PyMethodDef PySSLMethods[] = {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001915 {"do_handshake", (PyCFunction)PySSL_SSLdo_handshake, METH_NOARGS},
1916 {"write", (PyCFunction)PySSL_SSLwrite, METH_VARARGS,
1917 PySSL_SSLwrite_doc},
1918 {"read", (PyCFunction)PySSL_SSLread, METH_VARARGS,
1919 PySSL_SSLread_doc},
1920 {"pending", (PyCFunction)PySSL_SSLpending, METH_NOARGS,
1921 PySSL_SSLpending_doc},
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001922 {"peer_certificate", (PyCFunction)PySSL_peercert, METH_VARARGS,
1923 PySSL_peercert_doc},
1924 {"cipher", (PyCFunction)PySSL_cipher, METH_NOARGS},
Alex Gaynore98205d2014-09-04 13:33:22 -07001925 {"version", (PyCFunction)PySSL_version, METH_NOARGS},
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001926#ifdef OPENSSL_NPN_NEGOTIATED
1927 {"selected_npn_protocol", (PyCFunction)PySSL_selected_npn_protocol, METH_NOARGS},
1928#endif
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05001929#ifdef HAVE_ALPN
1930 {"selected_alpn_protocol", (PyCFunction)PySSL_selected_alpn_protocol, METH_NOARGS},
1931#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001932 {"compression", (PyCFunction)PySSL_compression, METH_NOARGS},
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001933 {"shutdown", (PyCFunction)PySSL_SSLshutdown, METH_NOARGS,
1934 PySSL_SSLshutdown_doc},
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001935#if HAVE_OPENSSL_FINISHED
1936 {"tls_unique_cb", (PyCFunction)PySSL_tls_unique_cb, METH_NOARGS,
1937 PySSL_tls_unique_cb_doc},
1938#endif
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001939 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001940};
1941
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001942static PyTypeObject PySSLSocket_Type = {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001943 PyVarObject_HEAD_INIT(NULL, 0)
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001944 "_ssl._SSLSocket", /*tp_name*/
1945 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001946 0, /*tp_itemsize*/
1947 /* methods */
1948 (destructor)PySSL_dealloc, /*tp_dealloc*/
1949 0, /*tp_print*/
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001950 0, /*tp_getattr*/
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001951 0, /*tp_setattr*/
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001952 0, /*tp_reserved*/
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00001953 0, /*tp_repr*/
1954 0, /*tp_as_number*/
1955 0, /*tp_as_sequence*/
1956 0, /*tp_as_mapping*/
1957 0, /*tp_hash*/
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001958 0, /*tp_call*/
1959 0, /*tp_str*/
1960 0, /*tp_getattro*/
1961 0, /*tp_setattro*/
1962 0, /*tp_as_buffer*/
1963 Py_TPFLAGS_DEFAULT, /*tp_flags*/
1964 0, /*tp_doc*/
1965 0, /*tp_traverse*/
1966 0, /*tp_clear*/
1967 0, /*tp_richcompare*/
1968 0, /*tp_weaklistoffset*/
1969 0, /*tp_iter*/
1970 0, /*tp_iternext*/
1971 PySSLMethods, /*tp_methods*/
1972 0, /*tp_members*/
1973 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001974};
1975
Benjamin Petersondaeb9252014-08-20 14:14:50 -05001976
1977/*
1978 * _SSLContext objects
1979 */
1980
1981static PyObject *
1982context_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1983{
1984 char *kwlist[] = {"protocol", NULL};
1985 PySSLContext *self;
1986 int proto_version = PY_SSL_VERSION_SSL23;
1987 long options;
1988 SSL_CTX *ctx = NULL;
1989
1990 if (!PyArg_ParseTupleAndKeywords(
1991 args, kwds, "i:_SSLContext", kwlist,
1992 &proto_version))
1993 return NULL;
1994
1995 PySSL_BEGIN_ALLOW_THREADS
1996 if (proto_version == PY_SSL_VERSION_TLS1)
1997 ctx = SSL_CTX_new(TLSv1_method());
1998#if HAVE_TLSv1_2
1999 else if (proto_version == PY_SSL_VERSION_TLS1_1)
2000 ctx = SSL_CTX_new(TLSv1_1_method());
2001 else if (proto_version == PY_SSL_VERSION_TLS1_2)
2002 ctx = SSL_CTX_new(TLSv1_2_method());
2003#endif
Benjamin Peterson60766c42014-12-05 21:59:35 -05002004#ifndef OPENSSL_NO_SSL3
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002005 else if (proto_version == PY_SSL_VERSION_SSL3)
2006 ctx = SSL_CTX_new(SSLv3_method());
Benjamin Peterson60766c42014-12-05 21:59:35 -05002007#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002008#ifndef OPENSSL_NO_SSL2
2009 else if (proto_version == PY_SSL_VERSION_SSL2)
2010 ctx = SSL_CTX_new(SSLv2_method());
2011#endif
2012 else if (proto_version == PY_SSL_VERSION_SSL23)
2013 ctx = SSL_CTX_new(SSLv23_method());
2014 else
2015 proto_version = -1;
2016 PySSL_END_ALLOW_THREADS
2017
2018 if (proto_version == -1) {
2019 PyErr_SetString(PyExc_ValueError,
2020 "invalid protocol version");
2021 return NULL;
2022 }
2023 if (ctx == NULL) {
2024 PyErr_SetString(PySSLErrorObject,
2025 "failed to allocate SSL context");
2026 return NULL;
2027 }
2028
2029 assert(type != NULL && type->tp_alloc != NULL);
2030 self = (PySSLContext *) type->tp_alloc(type, 0);
2031 if (self == NULL) {
2032 SSL_CTX_free(ctx);
2033 return NULL;
2034 }
2035 self->ctx = ctx;
2036#ifdef OPENSSL_NPN_NEGOTIATED
2037 self->npn_protocols = NULL;
2038#endif
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002039#ifdef HAVE_ALPN
2040 self->alpn_protocols = NULL;
2041#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002042#ifndef OPENSSL_NO_TLSEXT
2043 self->set_hostname = NULL;
2044#endif
2045 /* Don't check host name by default */
2046 self->check_hostname = 0;
2047 /* Defaults */
2048 SSL_CTX_set_verify(self->ctx, SSL_VERIFY_NONE, NULL);
2049 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2050 if (proto_version != PY_SSL_VERSION_SSL2)
2051 options |= SSL_OP_NO_SSLv2;
Benjamin Peterson10aaca92015-11-11 22:38:41 -08002052 if (proto_version != PY_SSL_VERSION_SSL3)
2053 options |= SSL_OP_NO_SSLv3;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002054 SSL_CTX_set_options(self->ctx, options);
2055
2056#ifndef OPENSSL_NO_ECDH
2057 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
2058 prime256v1 by default. This is Apache mod_ssl's initialization
2059 policy, so we should be safe. */
2060#if defined(SSL_CTX_set_ecdh_auto)
2061 SSL_CTX_set_ecdh_auto(self->ctx, 1);
2062#else
2063 {
2064 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
2065 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2066 EC_KEY_free(key);
2067 }
2068#endif
2069#endif
2070
2071#define SID_CTX "Python"
2072 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
2073 sizeof(SID_CTX));
2074#undef SID_CTX
2075
Benjamin Petersonb1ebba52015-03-04 22:11:12 -05002076#ifdef X509_V_FLAG_TRUSTED_FIRST
2077 {
2078 /* Improve trust chain building when cross-signed intermediate
2079 certificates are present. See https://bugs.python.org/issue23476. */
2080 X509_STORE *store = SSL_CTX_get_cert_store(self->ctx);
2081 X509_STORE_set_flags(store, X509_V_FLAG_TRUSTED_FIRST);
2082 }
2083#endif
2084
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002085 return (PyObject *)self;
2086}
2087
2088static int
2089context_traverse(PySSLContext *self, visitproc visit, void *arg)
2090{
2091#ifndef OPENSSL_NO_TLSEXT
2092 Py_VISIT(self->set_hostname);
2093#endif
2094 return 0;
2095}
2096
2097static int
2098context_clear(PySSLContext *self)
2099{
2100#ifndef OPENSSL_NO_TLSEXT
2101 Py_CLEAR(self->set_hostname);
2102#endif
2103 return 0;
2104}
2105
2106static void
2107context_dealloc(PySSLContext *self)
2108{
2109 context_clear(self);
2110 SSL_CTX_free(self->ctx);
2111#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002112 PyMem_FREE(self->npn_protocols);
2113#endif
2114#ifdef HAVE_ALPN
2115 PyMem_FREE(self->alpn_protocols);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002116#endif
2117 Py_TYPE(self)->tp_free(self);
2118}
2119
2120static PyObject *
2121set_ciphers(PySSLContext *self, PyObject *args)
2122{
2123 int ret;
2124 const char *cipherlist;
2125
2126 if (!PyArg_ParseTuple(args, "s:set_ciphers", &cipherlist))
2127 return NULL;
2128 ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
2129 if (ret == 0) {
2130 /* Clearing the error queue is necessary on some OpenSSL versions,
2131 otherwise the error will be reported again when another SSL call
2132 is done. */
2133 ERR_clear_error();
2134 PyErr_SetString(PySSLErrorObject,
2135 "No cipher can be selected.");
2136 return NULL;
2137 }
2138 Py_RETURN_NONE;
2139}
2140
Benjamin Petersona99e48c2015-01-28 12:06:39 -05002141#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002142static int
Benjamin Petersonaa707582015-01-23 17:30:26 -05002143do_protocol_selection(int alpn, unsigned char **out, unsigned char *outlen,
2144 const unsigned char *server_protocols, unsigned int server_protocols_len,
2145 const unsigned char *client_protocols, unsigned int client_protocols_len)
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002146{
Benjamin Petersonaa707582015-01-23 17:30:26 -05002147 int ret;
2148 if (client_protocols == NULL) {
2149 client_protocols = (unsigned char *)"";
2150 client_protocols_len = 0;
2151 }
2152 if (server_protocols == NULL) {
2153 server_protocols = (unsigned char *)"";
2154 server_protocols_len = 0;
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002155 }
2156
Benjamin Petersonaa707582015-01-23 17:30:26 -05002157 ret = SSL_select_next_proto(out, outlen,
2158 server_protocols, server_protocols_len,
2159 client_protocols, client_protocols_len);
2160 if (alpn && ret != OPENSSL_NPN_NEGOTIATED)
2161 return SSL_TLSEXT_ERR_NOACK;
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002162
2163 return SSL_TLSEXT_ERR_OK;
2164}
2165
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002166/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
2167static int
2168_advertiseNPN_cb(SSL *s,
2169 const unsigned char **data, unsigned int *len,
2170 void *args)
2171{
2172 PySSLContext *ssl_ctx = (PySSLContext *) args;
2173
2174 if (ssl_ctx->npn_protocols == NULL) {
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002175 *data = (unsigned char *)"";
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002176 *len = 0;
2177 } else {
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002178 *data = ssl_ctx->npn_protocols;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002179 *len = ssl_ctx->npn_protocols_len;
2180 }
2181
2182 return SSL_TLSEXT_ERR_OK;
2183}
2184/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
2185static int
2186_selectNPN_cb(SSL *s,
2187 unsigned char **out, unsigned char *outlen,
2188 const unsigned char *server, unsigned int server_len,
2189 void *args)
2190{
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002191 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Petersonaa707582015-01-23 17:30:26 -05002192 return do_protocol_selection(0, out, outlen, server, server_len,
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002193 ctx->npn_protocols, ctx->npn_protocols_len);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002194}
2195#endif
2196
2197static PyObject *
2198_set_npn_protocols(PySSLContext *self, PyObject *args)
2199{
2200#ifdef OPENSSL_NPN_NEGOTIATED
2201 Py_buffer protos;
2202
2203 if (!PyArg_ParseTuple(args, "s*:set_npn_protocols", &protos))
2204 return NULL;
2205
2206 if (self->npn_protocols != NULL) {
2207 PyMem_Free(self->npn_protocols);
2208 }
2209
2210 self->npn_protocols = PyMem_Malloc(protos.len);
2211 if (self->npn_protocols == NULL) {
2212 PyBuffer_Release(&protos);
2213 return PyErr_NoMemory();
2214 }
2215 memcpy(self->npn_protocols, protos.buf, protos.len);
2216 self->npn_protocols_len = (int) protos.len;
2217
2218 /* set both server and client callbacks, because the context can
2219 * be used to create both types of sockets */
2220 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
2221 _advertiseNPN_cb,
2222 self);
2223 SSL_CTX_set_next_proto_select_cb(self->ctx,
2224 _selectNPN_cb,
2225 self);
2226
2227 PyBuffer_Release(&protos);
2228 Py_RETURN_NONE;
2229#else
2230 PyErr_SetString(PyExc_NotImplementedError,
2231 "The NPN extension requires OpenSSL 1.0.1 or later.");
2232 return NULL;
2233#endif
2234}
2235
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002236#ifdef HAVE_ALPN
2237static int
2238_selectALPN_cb(SSL *s,
2239 const unsigned char **out, unsigned char *outlen,
2240 const unsigned char *client_protocols, unsigned int client_protocols_len,
2241 void *args)
2242{
2243 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Petersonaa707582015-01-23 17:30:26 -05002244 return do_protocol_selection(1, (unsigned char **)out, outlen,
2245 ctx->alpn_protocols, ctx->alpn_protocols_len,
2246 client_protocols, client_protocols_len);
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05002247}
2248#endif
2249
2250static PyObject *
2251_set_alpn_protocols(PySSLContext *self, PyObject *args)
2252{
2253#ifdef HAVE_ALPN
2254 Py_buffer protos;
2255
2256 if (!PyArg_ParseTuple(args, "s*:set_npn_protocols", &protos))
2257 return NULL;
2258
2259 PyMem_FREE(self->alpn_protocols);
2260 self->alpn_protocols = PyMem_Malloc(protos.len);
2261 if (!self->alpn_protocols)
2262 return PyErr_NoMemory();
2263 memcpy(self->alpn_protocols, protos.buf, protos.len);
2264 self->alpn_protocols_len = protos.len;
2265 PyBuffer_Release(&protos);
2266
2267 if (SSL_CTX_set_alpn_protos(self->ctx, self->alpn_protocols, self->alpn_protocols_len))
2268 return PyErr_NoMemory();
2269 SSL_CTX_set_alpn_select_cb(self->ctx, _selectALPN_cb, self);
2270
2271 PyBuffer_Release(&protos);
2272 Py_RETURN_NONE;
2273#else
2274 PyErr_SetString(PyExc_NotImplementedError,
2275 "The ALPN extension requires OpenSSL 1.0.2 or later.");
2276 return NULL;
2277#endif
2278}
2279
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002280static PyObject *
2281get_verify_mode(PySSLContext *self, void *c)
2282{
2283 switch (SSL_CTX_get_verify_mode(self->ctx)) {
2284 case SSL_VERIFY_NONE:
2285 return PyLong_FromLong(PY_SSL_CERT_NONE);
2286 case SSL_VERIFY_PEER:
2287 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
2288 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
2289 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
2290 }
2291 PyErr_SetString(PySSLErrorObject,
2292 "invalid return value from SSL_CTX_get_verify_mode");
2293 return NULL;
2294}
2295
2296static int
2297set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
2298{
2299 int n, mode;
2300 if (!PyArg_Parse(arg, "i", &n))
2301 return -1;
2302 if (n == PY_SSL_CERT_NONE)
2303 mode = SSL_VERIFY_NONE;
2304 else if (n == PY_SSL_CERT_OPTIONAL)
2305 mode = SSL_VERIFY_PEER;
2306 else if (n == PY_SSL_CERT_REQUIRED)
2307 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2308 else {
2309 PyErr_SetString(PyExc_ValueError,
2310 "invalid value for verify_mode");
2311 return -1;
2312 }
2313 if (mode == SSL_VERIFY_NONE && self->check_hostname) {
2314 PyErr_SetString(PyExc_ValueError,
2315 "Cannot set verify_mode to CERT_NONE when "
2316 "check_hostname is enabled.");
2317 return -1;
2318 }
2319 SSL_CTX_set_verify(self->ctx, mode, NULL);
2320 return 0;
2321}
2322
2323#ifdef HAVE_OPENSSL_VERIFY_PARAM
2324static PyObject *
2325get_verify_flags(PySSLContext *self, void *c)
2326{
2327 X509_STORE *store;
2328 unsigned long flags;
2329
2330 store = SSL_CTX_get_cert_store(self->ctx);
2331 flags = X509_VERIFY_PARAM_get_flags(store->param);
2332 return PyLong_FromUnsignedLong(flags);
2333}
2334
2335static int
2336set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
2337{
2338 X509_STORE *store;
2339 unsigned long new_flags, flags, set, clear;
2340
2341 if (!PyArg_Parse(arg, "k", &new_flags))
2342 return -1;
2343 store = SSL_CTX_get_cert_store(self->ctx);
2344 flags = X509_VERIFY_PARAM_get_flags(store->param);
2345 clear = flags & ~new_flags;
2346 set = ~flags & new_flags;
2347 if (clear) {
2348 if (!X509_VERIFY_PARAM_clear_flags(store->param, clear)) {
2349 _setSSLError(NULL, 0, __FILE__, __LINE__);
2350 return -1;
2351 }
2352 }
2353 if (set) {
2354 if (!X509_VERIFY_PARAM_set_flags(store->param, set)) {
2355 _setSSLError(NULL, 0, __FILE__, __LINE__);
2356 return -1;
2357 }
2358 }
2359 return 0;
2360}
2361#endif
2362
2363static PyObject *
2364get_options(PySSLContext *self, void *c)
2365{
2366 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
2367}
2368
2369static int
2370set_options(PySSLContext *self, PyObject *arg, void *c)
2371{
2372 long new_opts, opts, set, clear;
2373 if (!PyArg_Parse(arg, "l", &new_opts))
2374 return -1;
2375 opts = SSL_CTX_get_options(self->ctx);
2376 clear = opts & ~new_opts;
2377 set = ~opts & new_opts;
2378 if (clear) {
2379#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
2380 SSL_CTX_clear_options(self->ctx, clear);
2381#else
2382 PyErr_SetString(PyExc_ValueError,
2383 "can't clear options before OpenSSL 0.9.8m");
2384 return -1;
2385#endif
2386 }
2387 if (set)
2388 SSL_CTX_set_options(self->ctx, set);
2389 return 0;
2390}
2391
2392static PyObject *
2393get_check_hostname(PySSLContext *self, void *c)
2394{
2395 return PyBool_FromLong(self->check_hostname);
2396}
2397
2398static int
2399set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
2400{
2401 PyObject *py_check_hostname;
2402 int check_hostname;
2403 if (!PyArg_Parse(arg, "O", &py_check_hostname))
2404 return -1;
2405
2406 check_hostname = PyObject_IsTrue(py_check_hostname);
2407 if (check_hostname < 0)
2408 return -1;
2409 if (check_hostname &&
2410 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
2411 PyErr_SetString(PyExc_ValueError,
2412 "check_hostname needs a SSL context with either "
2413 "CERT_OPTIONAL or CERT_REQUIRED");
2414 return -1;
2415 }
2416 self->check_hostname = check_hostname;
2417 return 0;
2418}
2419
2420
2421typedef struct {
2422 PyThreadState *thread_state;
2423 PyObject *callable;
2424 char *password;
2425 int size;
2426 int error;
2427} _PySSLPasswordInfo;
2428
2429static int
2430_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
2431 const char *bad_type_error)
2432{
2433 /* Set the password and size fields of a _PySSLPasswordInfo struct
2434 from a unicode, bytes, or byte array object.
2435 The password field will be dynamically allocated and must be freed
2436 by the caller */
2437 PyObject *password_bytes = NULL;
2438 const char *data = NULL;
2439 Py_ssize_t size;
2440
2441 if (PyUnicode_Check(password)) {
2442 password_bytes = PyUnicode_AsEncodedString(password, NULL, NULL);
2443 if (!password_bytes) {
2444 goto error;
2445 }
2446 data = PyBytes_AS_STRING(password_bytes);
2447 size = PyBytes_GET_SIZE(password_bytes);
2448 } else if (PyBytes_Check(password)) {
2449 data = PyBytes_AS_STRING(password);
2450 size = PyBytes_GET_SIZE(password);
2451 } else if (PyByteArray_Check(password)) {
2452 data = PyByteArray_AS_STRING(password);
2453 size = PyByteArray_GET_SIZE(password);
2454 } else {
2455 PyErr_SetString(PyExc_TypeError, bad_type_error);
2456 goto error;
2457 }
2458
2459 if (size > (Py_ssize_t)INT_MAX) {
2460 PyErr_Format(PyExc_ValueError,
2461 "password cannot be longer than %d bytes", INT_MAX);
2462 goto error;
2463 }
2464
2465 PyMem_Free(pw_info->password);
2466 pw_info->password = PyMem_Malloc(size);
2467 if (!pw_info->password) {
2468 PyErr_SetString(PyExc_MemoryError,
2469 "unable to allocate password buffer");
2470 goto error;
2471 }
2472 memcpy(pw_info->password, data, size);
2473 pw_info->size = (int)size;
2474
2475 Py_XDECREF(password_bytes);
2476 return 1;
2477
2478error:
2479 Py_XDECREF(password_bytes);
2480 return 0;
2481}
2482
2483static int
2484_password_callback(char *buf, int size, int rwflag, void *userdata)
2485{
2486 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
2487 PyObject *fn_ret = NULL;
2488
2489 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
2490
2491 if (pw_info->callable) {
2492 fn_ret = PyObject_CallFunctionObjArgs(pw_info->callable, NULL);
2493 if (!fn_ret) {
2494 /* TODO: It would be nice to move _ctypes_add_traceback() into the
2495 core python API, so we could use it to add a frame here */
2496 goto error;
2497 }
2498
2499 if (!_pwinfo_set(pw_info, fn_ret,
2500 "password callback must return a string")) {
2501 goto error;
2502 }
2503 Py_CLEAR(fn_ret);
2504 }
2505
2506 if (pw_info->size > size) {
2507 PyErr_Format(PyExc_ValueError,
2508 "password cannot be longer than %d bytes", size);
2509 goto error;
2510 }
2511
2512 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2513 memcpy(buf, pw_info->password, pw_info->size);
2514 return pw_info->size;
2515
2516error:
2517 Py_XDECREF(fn_ret);
2518 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2519 pw_info->error = 1;
2520 return -1;
2521}
2522
2523static PyObject *
2524load_cert_chain(PySSLContext *self, PyObject *args, PyObject *kwds)
2525{
2526 char *kwlist[] = {"certfile", "keyfile", "password", NULL};
Benjamin Peterson93c41332014-11-03 21:12:05 -05002527 PyObject *keyfile = NULL, *keyfile_bytes = NULL, *password = NULL;
2528 char *certfile_bytes = NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002529 pem_password_cb *orig_passwd_cb = self->ctx->default_passwd_callback;
2530 void *orig_passwd_userdata = self->ctx->default_passwd_callback_userdata;
2531 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
2532 int r;
2533
2534 errno = 0;
2535 ERR_clear_error();
2536 if (!PyArg_ParseTupleAndKeywords(args, kwds,
Benjamin Peterson93c41332014-11-03 21:12:05 -05002537 "et|OO:load_cert_chain", kwlist,
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002538 Py_FileSystemDefaultEncoding, &certfile_bytes,
Benjamin Peterson93c41332014-11-03 21:12:05 -05002539 &keyfile, &password))
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002540 return NULL;
Benjamin Peterson93c41332014-11-03 21:12:05 -05002541
2542 if (keyfile && keyfile != Py_None) {
2543 if (PyString_Check(keyfile)) {
2544 Py_INCREF(keyfile);
2545 keyfile_bytes = keyfile;
2546 } else {
2547 PyObject *u = PyUnicode_FromObject(keyfile);
2548 if (!u)
2549 goto error;
2550 keyfile_bytes = PyUnicode_AsEncodedString(
2551 u, Py_FileSystemDefaultEncoding, NULL);
2552 Py_DECREF(u);
2553 if (!keyfile_bytes)
2554 goto error;
2555 }
2556 }
2557
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002558 if (password && password != Py_None) {
2559 if (PyCallable_Check(password)) {
2560 pw_info.callable = password;
2561 } else if (!_pwinfo_set(&pw_info, password,
2562 "password should be a string or callable")) {
2563 goto error;
2564 }
2565 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
2566 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
2567 }
2568 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
2569 r = SSL_CTX_use_certificate_chain_file(self->ctx, certfile_bytes);
2570 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2571 if (r != 1) {
2572 if (pw_info.error) {
2573 ERR_clear_error();
2574 /* the password callback has already set the error information */
2575 }
2576 else if (errno != 0) {
2577 ERR_clear_error();
2578 PyErr_SetFromErrno(PyExc_IOError);
2579 }
2580 else {
2581 _setSSLError(NULL, 0, __FILE__, __LINE__);
2582 }
2583 goto error;
2584 }
2585 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
2586 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Benjamin Peterson93c41332014-11-03 21:12:05 -05002587 keyfile_bytes ? PyBytes_AS_STRING(keyfile_bytes) : certfile_bytes,
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002588 SSL_FILETYPE_PEM);
2589 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2590 if (r != 1) {
2591 if (pw_info.error) {
2592 ERR_clear_error();
2593 /* the password callback has already set the error information */
2594 }
2595 else if (errno != 0) {
2596 ERR_clear_error();
2597 PyErr_SetFromErrno(PyExc_IOError);
2598 }
2599 else {
2600 _setSSLError(NULL, 0, __FILE__, __LINE__);
2601 }
2602 goto error;
2603 }
2604 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
2605 r = SSL_CTX_check_private_key(self->ctx);
2606 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2607 if (r != 1) {
2608 _setSSLError(NULL, 0, __FILE__, __LINE__);
2609 goto error;
2610 }
2611 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2612 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
2613 PyMem_Free(pw_info.password);
2614 Py_RETURN_NONE;
2615
2616error:
2617 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2618 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Benjamin Peterson93c41332014-11-03 21:12:05 -05002619 Py_XDECREF(keyfile_bytes);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002620 PyMem_Free(pw_info.password);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002621 PyMem_Free(certfile_bytes);
2622 return NULL;
2623}
2624
2625/* internal helper function, returns -1 on error
2626 */
2627static int
2628_add_ca_certs(PySSLContext *self, void *data, Py_ssize_t len,
2629 int filetype)
2630{
2631 BIO *biobuf = NULL;
2632 X509_STORE *store;
2633 int retval = 0, err, loaded = 0;
2634
2635 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
2636
2637 if (len <= 0) {
2638 PyErr_SetString(PyExc_ValueError,
2639 "Empty certificate data");
2640 return -1;
2641 } else if (len > INT_MAX) {
2642 PyErr_SetString(PyExc_OverflowError,
2643 "Certificate data is too long.");
2644 return -1;
2645 }
2646
2647 biobuf = BIO_new_mem_buf(data, (int)len);
2648 if (biobuf == NULL) {
2649 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
2650 return -1;
2651 }
2652
2653 store = SSL_CTX_get_cert_store(self->ctx);
2654 assert(store != NULL);
2655
2656 while (1) {
2657 X509 *cert = NULL;
2658 int r;
2659
2660 if (filetype == SSL_FILETYPE_ASN1) {
2661 cert = d2i_X509_bio(biobuf, NULL);
2662 } else {
2663 cert = PEM_read_bio_X509(biobuf, NULL,
2664 self->ctx->default_passwd_callback,
2665 self->ctx->default_passwd_callback_userdata);
2666 }
2667 if (cert == NULL) {
2668 break;
2669 }
2670 r = X509_STORE_add_cert(store, cert);
2671 X509_free(cert);
2672 if (!r) {
2673 err = ERR_peek_last_error();
2674 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
2675 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
2676 /* cert already in hash table, not an error */
2677 ERR_clear_error();
2678 } else {
2679 break;
2680 }
2681 }
2682 loaded++;
2683 }
2684
2685 err = ERR_peek_last_error();
2686 if ((filetype == SSL_FILETYPE_ASN1) &&
2687 (loaded > 0) &&
2688 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
2689 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
2690 /* EOF ASN1 file, not an error */
2691 ERR_clear_error();
2692 retval = 0;
2693 } else if ((filetype == SSL_FILETYPE_PEM) &&
2694 (loaded > 0) &&
2695 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
2696 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
2697 /* EOF PEM file, not an error */
2698 ERR_clear_error();
2699 retval = 0;
2700 } else {
2701 _setSSLError(NULL, 0, __FILE__, __LINE__);
2702 retval = -1;
2703 }
2704
2705 BIO_free(biobuf);
2706 return retval;
2707}
2708
2709
2710static PyObject *
2711load_verify_locations(PySSLContext *self, PyObject *args, PyObject *kwds)
2712{
2713 char *kwlist[] = {"cafile", "capath", "cadata", NULL};
2714 PyObject *cadata = NULL, *cafile = NULL, *capath = NULL;
2715 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
2716 const char *cafile_buf = NULL, *capath_buf = NULL;
2717 int r = 0, ok = 1;
2718
2719 errno = 0;
2720 if (!PyArg_ParseTupleAndKeywords(args, kwds,
2721 "|OOO:load_verify_locations", kwlist,
2722 &cafile, &capath, &cadata))
2723 return NULL;
2724
2725 if (cafile == Py_None)
2726 cafile = NULL;
2727 if (capath == Py_None)
2728 capath = NULL;
2729 if (cadata == Py_None)
2730 cadata = NULL;
2731
2732 if (cafile == NULL && capath == NULL && cadata == NULL) {
2733 PyErr_SetString(PyExc_TypeError,
2734 "cafile, capath and cadata cannot be all omitted");
2735 goto error;
2736 }
2737
2738 if (cafile) {
Benjamin Peterson876473e2014-08-28 09:33:21 -04002739 if (PyString_Check(cafile)) {
2740 Py_INCREF(cafile);
2741 cafile_bytes = cafile;
2742 } else {
2743 PyObject *u = PyUnicode_FromObject(cafile);
2744 if (!u)
2745 goto error;
2746 cafile_bytes = PyUnicode_AsEncodedString(
2747 u, Py_FileSystemDefaultEncoding, NULL);
2748 Py_DECREF(u);
2749 if (!cafile_bytes)
2750 goto error;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002751 }
2752 }
2753 if (capath) {
Benjamin Peterson876473e2014-08-28 09:33:21 -04002754 if (PyString_Check(capath)) {
2755 Py_INCREF(capath);
2756 capath_bytes = capath;
2757 } else {
2758 PyObject *u = PyUnicode_FromObject(capath);
2759 if (!u)
2760 goto error;
2761 capath_bytes = PyUnicode_AsEncodedString(
2762 u, Py_FileSystemDefaultEncoding, NULL);
2763 Py_DECREF(u);
2764 if (!capath_bytes)
2765 goto error;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002766 }
2767 }
2768
2769 /* validata cadata type and load cadata */
2770 if (cadata) {
2771 Py_buffer buf;
2772 PyObject *cadata_ascii = NULL;
2773
2774 if (!PyUnicode_Check(cadata) && PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE) == 0) {
2775 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
2776 PyBuffer_Release(&buf);
2777 PyErr_SetString(PyExc_TypeError,
2778 "cadata should be a contiguous buffer with "
2779 "a single dimension");
2780 goto error;
2781 }
2782 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
2783 PyBuffer_Release(&buf);
2784 if (r == -1) {
2785 goto error;
2786 }
2787 } else {
2788 PyErr_Clear();
2789 cadata_ascii = PyUnicode_AsASCIIString(cadata);
2790 if (cadata_ascii == NULL) {
2791 PyErr_SetString(PyExc_TypeError,
Serhiy Storchakac72e66a2015-11-02 15:06:09 +02002792 "cadata should be an ASCII string or a "
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002793 "bytes-like object");
2794 goto error;
2795 }
2796 r = _add_ca_certs(self,
2797 PyBytes_AS_STRING(cadata_ascii),
2798 PyBytes_GET_SIZE(cadata_ascii),
2799 SSL_FILETYPE_PEM);
2800 Py_DECREF(cadata_ascii);
2801 if (r == -1) {
2802 goto error;
2803 }
2804 }
2805 }
2806
2807 /* load cafile or capath */
2808 if (cafile_bytes || capath_bytes) {
2809 if (cafile)
2810 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
2811 if (capath)
2812 capath_buf = PyBytes_AS_STRING(capath_bytes);
2813 PySSL_BEGIN_ALLOW_THREADS
2814 r = SSL_CTX_load_verify_locations(
2815 self->ctx,
2816 cafile_buf,
2817 capath_buf);
2818 PySSL_END_ALLOW_THREADS
2819 if (r != 1) {
2820 ok = 0;
2821 if (errno != 0) {
2822 ERR_clear_error();
2823 PyErr_SetFromErrno(PyExc_IOError);
2824 }
2825 else {
2826 _setSSLError(NULL, 0, __FILE__, __LINE__);
2827 }
2828 goto error;
2829 }
2830 }
2831 goto end;
2832
2833 error:
2834 ok = 0;
2835 end:
2836 Py_XDECREF(cafile_bytes);
2837 Py_XDECREF(capath_bytes);
2838 if (ok) {
2839 Py_RETURN_NONE;
2840 } else {
2841 return NULL;
2842 }
2843}
2844
2845static PyObject *
2846load_dh_params(PySSLContext *self, PyObject *filepath)
2847{
2848 BIO *bio;
2849 DH *dh;
2850 char *path = PyBytes_AsString(filepath);
2851 if (!path) {
2852 return NULL;
2853 }
2854
2855 bio = BIO_new_file(path, "r");
2856 if (bio == NULL) {
2857 ERR_clear_error();
2858 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, filepath);
2859 return NULL;
2860 }
2861 errno = 0;
2862 PySSL_BEGIN_ALLOW_THREADS
2863 dh = PEM_read_bio_DHparams(bio, NULL, NULL, NULL);
2864 BIO_free(bio);
2865 PySSL_END_ALLOW_THREADS
2866 if (dh == NULL) {
2867 if (errno != 0) {
2868 ERR_clear_error();
2869 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
2870 }
2871 else {
2872 _setSSLError(NULL, 0, __FILE__, __LINE__);
2873 }
2874 return NULL;
2875 }
2876 if (SSL_CTX_set_tmp_dh(self->ctx, dh) == 0)
2877 _setSSLError(NULL, 0, __FILE__, __LINE__);
2878 DH_free(dh);
2879 Py_RETURN_NONE;
2880}
2881
2882static PyObject *
2883context_wrap_socket(PySSLContext *self, PyObject *args, PyObject *kwds)
2884{
2885 char *kwlist[] = {"sock", "server_side", "server_hostname", "ssl_sock", NULL};
2886 PySocketSockObject *sock;
2887 int server_side = 0;
2888 char *hostname = NULL;
2889 PyObject *hostname_obj, *ssl_sock = Py_None, *res;
2890
2891 /* server_hostname is either None (or absent), or to be encoded
2892 using the idna encoding. */
2893 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!i|O!O:_wrap_socket", kwlist,
2894 PySocketModule.Sock_Type,
2895 &sock, &server_side,
2896 Py_TYPE(Py_None), &hostname_obj,
2897 &ssl_sock)) {
2898 PyErr_Clear();
2899 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!iet|O:_wrap_socket", kwlist,
2900 PySocketModule.Sock_Type,
2901 &sock, &server_side,
2902 "idna", &hostname, &ssl_sock))
2903 return NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002904 }
2905
2906 res = (PyObject *) newPySSLSocket(self, sock, server_side,
2907 hostname, ssl_sock);
2908 if (hostname != NULL)
2909 PyMem_Free(hostname);
2910 return res;
2911}
2912
2913static PyObject *
2914session_stats(PySSLContext *self, PyObject *unused)
2915{
2916 int r;
2917 PyObject *value, *stats = PyDict_New();
2918 if (!stats)
2919 return NULL;
2920
2921#define ADD_STATS(SSL_NAME, KEY_NAME) \
2922 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
2923 if (value == NULL) \
2924 goto error; \
2925 r = PyDict_SetItemString(stats, KEY_NAME, value); \
2926 Py_DECREF(value); \
2927 if (r < 0) \
2928 goto error;
2929
2930 ADD_STATS(number, "number");
2931 ADD_STATS(connect, "connect");
2932 ADD_STATS(connect_good, "connect_good");
2933 ADD_STATS(connect_renegotiate, "connect_renegotiate");
2934 ADD_STATS(accept, "accept");
2935 ADD_STATS(accept_good, "accept_good");
2936 ADD_STATS(accept_renegotiate, "accept_renegotiate");
2937 ADD_STATS(accept, "accept");
2938 ADD_STATS(hits, "hits");
2939 ADD_STATS(misses, "misses");
2940 ADD_STATS(timeouts, "timeouts");
2941 ADD_STATS(cache_full, "cache_full");
2942
2943#undef ADD_STATS
2944
2945 return stats;
2946
2947error:
2948 Py_DECREF(stats);
2949 return NULL;
2950}
2951
2952static PyObject *
2953set_default_verify_paths(PySSLContext *self, PyObject *unused)
2954{
2955 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
2956 _setSSLError(NULL, 0, __FILE__, __LINE__);
2957 return NULL;
2958 }
2959 Py_RETURN_NONE;
2960}
2961
2962#ifndef OPENSSL_NO_ECDH
2963static PyObject *
2964set_ecdh_curve(PySSLContext *self, PyObject *name)
2965{
2966 char *name_bytes;
2967 int nid;
2968 EC_KEY *key;
2969
2970 name_bytes = PyBytes_AsString(name);
2971 if (!name_bytes) {
2972 return NULL;
2973 }
2974 nid = OBJ_sn2nid(name_bytes);
2975 if (nid == 0) {
Benjamin Peterson7ed3e292014-08-20 21:37:01 -05002976 PyObject *r = PyObject_Repr(name);
2977 if (!r)
2978 return NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002979 PyErr_Format(PyExc_ValueError,
Benjamin Peterson7ed3e292014-08-20 21:37:01 -05002980 "unknown elliptic curve name %s", PyString_AS_STRING(r));
2981 Py_DECREF(r);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05002982 return NULL;
2983 }
2984 key = EC_KEY_new_by_curve_name(nid);
2985 if (key == NULL) {
2986 _setSSLError(NULL, 0, __FILE__, __LINE__);
2987 return NULL;
2988 }
2989 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2990 EC_KEY_free(key);
2991 Py_RETURN_NONE;
2992}
2993#endif
2994
2995#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
2996static int
2997_servername_callback(SSL *s, int *al, void *args)
2998{
2999 int ret;
3000 PySSLContext *ssl_ctx = (PySSLContext *) args;
3001 PySSLSocket *ssl;
3002 PyObject *servername_o;
3003 PyObject *servername_idna;
3004 PyObject *result;
3005 /* The high-level ssl.SSLSocket object */
3006 PyObject *ssl_socket;
3007 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
3008#ifdef WITH_THREAD
3009 PyGILState_STATE gstate = PyGILState_Ensure();
3010#endif
3011
3012 if (ssl_ctx->set_hostname == NULL) {
3013 /* remove race condition in this the call back while if removing the
3014 * callback is in progress */
3015#ifdef WITH_THREAD
3016 PyGILState_Release(gstate);
3017#endif
3018 return SSL_TLSEXT_ERR_OK;
3019 }
3020
3021 ssl = SSL_get_app_data(s);
3022 assert(PySSLSocket_Check(ssl));
Benjamin Peterson2f334562014-10-01 23:53:01 -04003023 if (ssl->ssl_sock == NULL) {
3024 ssl_socket = Py_None;
3025 } else {
3026 ssl_socket = PyWeakref_GetObject(ssl->ssl_sock);
3027 Py_INCREF(ssl_socket);
3028 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003029 if (ssl_socket == Py_None) {
3030 goto error;
3031 }
3032
3033 if (servername == NULL) {
3034 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
3035 Py_None, ssl_ctx, NULL);
3036 }
3037 else {
3038 servername_o = PyBytes_FromString(servername);
3039 if (servername_o == NULL) {
3040 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
3041 goto error;
3042 }
3043 servername_idna = PyUnicode_FromEncodedObject(servername_o, "idna", NULL);
3044 if (servername_idna == NULL) {
3045 PyErr_WriteUnraisable(servername_o);
3046 Py_DECREF(servername_o);
3047 goto error;
3048 }
3049 Py_DECREF(servername_o);
3050 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
3051 servername_idna, ssl_ctx, NULL);
3052 Py_DECREF(servername_idna);
3053 }
3054 Py_DECREF(ssl_socket);
3055
3056 if (result == NULL) {
3057 PyErr_WriteUnraisable(ssl_ctx->set_hostname);
3058 *al = SSL_AD_HANDSHAKE_FAILURE;
3059 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
3060 }
3061 else {
3062 if (result != Py_None) {
3063 *al = (int) PyLong_AsLong(result);
3064 if (PyErr_Occurred()) {
3065 PyErr_WriteUnraisable(result);
3066 *al = SSL_AD_INTERNAL_ERROR;
3067 }
3068 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
3069 }
3070 else {
3071 ret = SSL_TLSEXT_ERR_OK;
3072 }
3073 Py_DECREF(result);
3074 }
3075
3076#ifdef WITH_THREAD
3077 PyGILState_Release(gstate);
3078#endif
3079 return ret;
3080
3081error:
3082 Py_DECREF(ssl_socket);
3083 *al = SSL_AD_INTERNAL_ERROR;
3084 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
3085#ifdef WITH_THREAD
3086 PyGILState_Release(gstate);
3087#endif
3088 return ret;
3089}
3090#endif
3091
3092PyDoc_STRVAR(PySSL_set_servername_callback_doc,
3093"set_servername_callback(method)\n\
3094\n\
3095This sets a callback that will be called when a server name is provided by\n\
3096the SSL/TLS client in the SNI extension.\n\
3097\n\
3098If the argument is None then the callback is disabled. The method is called\n\
3099with the SSLSocket, the server name as a string, and the SSLContext object.\n\
3100See RFC 6066 for details of the SNI extension.");
3101
3102static PyObject *
3103set_servername_callback(PySSLContext *self, PyObject *args)
3104{
3105#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
3106 PyObject *cb;
3107
3108 if (!PyArg_ParseTuple(args, "O", &cb))
3109 return NULL;
3110
3111 Py_CLEAR(self->set_hostname);
3112 if (cb == Py_None) {
3113 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3114 }
3115 else {
3116 if (!PyCallable_Check(cb)) {
3117 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3118 PyErr_SetString(PyExc_TypeError,
3119 "not a callable object");
3120 return NULL;
3121 }
3122 Py_INCREF(cb);
3123 self->set_hostname = cb;
3124 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
3125 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
3126 }
3127 Py_RETURN_NONE;
3128#else
3129 PyErr_SetString(PyExc_NotImplementedError,
3130 "The TLS extension servername callback, "
3131 "SSL_CTX_set_tlsext_servername_callback, "
3132 "is not in the current OpenSSL library.");
3133 return NULL;
3134#endif
3135}
3136
3137PyDoc_STRVAR(PySSL_get_stats_doc,
3138"cert_store_stats() -> {'crl': int, 'x509_ca': int, 'x509': int}\n\
3139\n\
3140Returns quantities of loaded X.509 certificates. X.509 certificates with a\n\
3141CA extension and certificate revocation lists inside the context's cert\n\
3142store.\n\
3143NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3144been used at least once.");
3145
3146static PyObject *
3147cert_store_stats(PySSLContext *self)
3148{
3149 X509_STORE *store;
3150 X509_OBJECT *obj;
3151 int x509 = 0, crl = 0, pkey = 0, ca = 0, i;
3152
3153 store = SSL_CTX_get_cert_store(self->ctx);
3154 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3155 obj = sk_X509_OBJECT_value(store->objs, i);
3156 switch (obj->type) {
3157 case X509_LU_X509:
3158 x509++;
3159 if (X509_check_ca(obj->data.x509)) {
3160 ca++;
3161 }
3162 break;
3163 case X509_LU_CRL:
3164 crl++;
3165 break;
3166 case X509_LU_PKEY:
3167 pkey++;
3168 break;
3169 default:
3170 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
3171 * As far as I can tell they are internal states and never
3172 * stored in a cert store */
3173 break;
3174 }
3175 }
3176 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
3177 "x509_ca", ca);
3178}
3179
3180PyDoc_STRVAR(PySSL_get_ca_certs_doc,
3181"get_ca_certs(binary_form=False) -> list of loaded certificate\n\
3182\n\
3183Returns a list of dicts with information of loaded CA certs. If the\n\
3184optional argument is True, returns a DER-encoded copy of the CA certificate.\n\
3185NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3186been used at least once.");
3187
3188static PyObject *
3189get_ca_certs(PySSLContext *self, PyObject *args, PyObject *kwds)
3190{
3191 char *kwlist[] = {"binary_form", NULL};
3192 X509_STORE *store;
3193 PyObject *ci = NULL, *rlist = NULL, *py_binary_mode = Py_False;
3194 int i;
3195 int binary_mode = 0;
3196
3197 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:get_ca_certs",
3198 kwlist, &py_binary_mode)) {
3199 return NULL;
3200 }
3201 binary_mode = PyObject_IsTrue(py_binary_mode);
3202 if (binary_mode < 0) {
3203 return NULL;
3204 }
3205
3206 if ((rlist = PyList_New(0)) == NULL) {
3207 return NULL;
3208 }
3209
3210 store = SSL_CTX_get_cert_store(self->ctx);
3211 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3212 X509_OBJECT *obj;
3213 X509 *cert;
3214
3215 obj = sk_X509_OBJECT_value(store->objs, i);
3216 if (obj->type != X509_LU_X509) {
3217 /* not a x509 cert */
3218 continue;
3219 }
3220 /* CA for any purpose */
3221 cert = obj->data.x509;
3222 if (!X509_check_ca(cert)) {
3223 continue;
3224 }
3225 if (binary_mode) {
3226 ci = _certificate_to_der(cert);
3227 } else {
3228 ci = _decode_certificate(cert);
3229 }
3230 if (ci == NULL) {
3231 goto error;
3232 }
3233 if (PyList_Append(rlist, ci) == -1) {
3234 goto error;
3235 }
3236 Py_CLEAR(ci);
3237 }
3238 return rlist;
3239
3240 error:
3241 Py_XDECREF(ci);
3242 Py_XDECREF(rlist);
3243 return NULL;
3244}
3245
3246
3247static PyGetSetDef context_getsetlist[] = {
3248 {"check_hostname", (getter) get_check_hostname,
3249 (setter) set_check_hostname, NULL},
3250 {"options", (getter) get_options,
3251 (setter) set_options, NULL},
3252#ifdef HAVE_OPENSSL_VERIFY_PARAM
3253 {"verify_flags", (getter) get_verify_flags,
3254 (setter) set_verify_flags, NULL},
3255#endif
3256 {"verify_mode", (getter) get_verify_mode,
3257 (setter) set_verify_mode, NULL},
3258 {NULL}, /* sentinel */
3259};
3260
3261static struct PyMethodDef context_methods[] = {
3262 {"_wrap_socket", (PyCFunction) context_wrap_socket,
3263 METH_VARARGS | METH_KEYWORDS, NULL},
3264 {"set_ciphers", (PyCFunction) set_ciphers,
3265 METH_VARARGS, NULL},
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05003266 {"_set_alpn_protocols", (PyCFunction) _set_alpn_protocols,
3267 METH_VARARGS, NULL},
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003268 {"_set_npn_protocols", (PyCFunction) _set_npn_protocols,
3269 METH_VARARGS, NULL},
3270 {"load_cert_chain", (PyCFunction) load_cert_chain,
3271 METH_VARARGS | METH_KEYWORDS, NULL},
3272 {"load_dh_params", (PyCFunction) load_dh_params,
3273 METH_O, NULL},
3274 {"load_verify_locations", (PyCFunction) load_verify_locations,
3275 METH_VARARGS | METH_KEYWORDS, NULL},
3276 {"session_stats", (PyCFunction) session_stats,
3277 METH_NOARGS, NULL},
3278 {"set_default_verify_paths", (PyCFunction) set_default_verify_paths,
3279 METH_NOARGS, NULL},
3280#ifndef OPENSSL_NO_ECDH
3281 {"set_ecdh_curve", (PyCFunction) set_ecdh_curve,
3282 METH_O, NULL},
3283#endif
3284 {"set_servername_callback", (PyCFunction) set_servername_callback,
3285 METH_VARARGS, PySSL_set_servername_callback_doc},
3286 {"cert_store_stats", (PyCFunction) cert_store_stats,
3287 METH_NOARGS, PySSL_get_stats_doc},
3288 {"get_ca_certs", (PyCFunction) get_ca_certs,
3289 METH_VARARGS | METH_KEYWORDS, PySSL_get_ca_certs_doc},
3290 {NULL, NULL} /* sentinel */
3291};
3292
3293static PyTypeObject PySSLContext_Type = {
3294 PyVarObject_HEAD_INIT(NULL, 0)
3295 "_ssl._SSLContext", /*tp_name*/
3296 sizeof(PySSLContext), /*tp_basicsize*/
3297 0, /*tp_itemsize*/
3298 (destructor)context_dealloc, /*tp_dealloc*/
3299 0, /*tp_print*/
3300 0, /*tp_getattr*/
3301 0, /*tp_setattr*/
3302 0, /*tp_reserved*/
3303 0, /*tp_repr*/
3304 0, /*tp_as_number*/
3305 0, /*tp_as_sequence*/
3306 0, /*tp_as_mapping*/
3307 0, /*tp_hash*/
3308 0, /*tp_call*/
3309 0, /*tp_str*/
3310 0, /*tp_getattro*/
3311 0, /*tp_setattro*/
3312 0, /*tp_as_buffer*/
3313 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
3314 0, /*tp_doc*/
3315 (traverseproc) context_traverse, /*tp_traverse*/
3316 (inquiry) context_clear, /*tp_clear*/
3317 0, /*tp_richcompare*/
3318 0, /*tp_weaklistoffset*/
3319 0, /*tp_iter*/
3320 0, /*tp_iternext*/
3321 context_methods, /*tp_methods*/
3322 0, /*tp_members*/
3323 context_getsetlist, /*tp_getset*/
3324 0, /*tp_base*/
3325 0, /*tp_dict*/
3326 0, /*tp_descr_get*/
3327 0, /*tp_descr_set*/
3328 0, /*tp_dictoffset*/
3329 0, /*tp_init*/
3330 0, /*tp_alloc*/
3331 context_new, /*tp_new*/
3332};
3333
3334
3335
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003336#ifdef HAVE_OPENSSL_RAND
3337
3338/* helper routines for seeding the SSL PRNG */
3339static PyObject *
3340PySSL_RAND_add(PyObject *self, PyObject *args)
3341{
3342 char *buf;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003343 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003344 double entropy;
3345
3346 if (!PyArg_ParseTuple(args, "s#d:RAND_add", &buf, &len, &entropy))
Antoine Pitrou2e136ab2010-05-12 14:02:34 +00003347 return NULL;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003348 do {
3349 if (len >= INT_MAX) {
3350 written = INT_MAX;
3351 } else {
3352 written = len;
3353 }
3354 RAND_add(buf, (int)written, entropy);
3355 buf += written;
3356 len -= written;
3357 } while (len);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003358 Py_INCREF(Py_None);
3359 return Py_None;
3360}
3361
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003362PyDoc_STRVAR(PySSL_RAND_add_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003363"RAND_add(string, entropy)\n\
3364\n\
3365Mix string into the OpenSSL PRNG state. entropy (a float) is a lower\n\
Bill Janssen98d19da2007-09-10 21:51:02 +00003366bound on the entropy contained in string. See RFC 1750.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003367
3368static PyObject *
3369PySSL_RAND_status(PyObject *self)
3370{
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003371 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003372}
3373
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003374PyDoc_STRVAR(PySSL_RAND_status_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003375"RAND_status() -> 0 or 1\n\
3376\n\
3377Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.\n\
3378It is necessary to seed the PRNG with RAND_add() on some platforms before\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003379using the ssl() function.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003380
Victor Stinner7c906672015-01-06 13:53:37 +01003381#endif /* HAVE_OPENSSL_RAND */
3382
3383
3384#ifdef HAVE_RAND_EGD
3385
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003386static PyObject *
3387PySSL_RAND_egd(PyObject *self, PyObject *arg)
3388{
3389 int bytes;
3390
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003391 if (!PyString_Check(arg))
Antoine Pitrou2e136ab2010-05-12 14:02:34 +00003392 return PyErr_Format(PyExc_TypeError,
3393 "RAND_egd() expected string, found %s",
3394 Py_TYPE(arg)->tp_name);
Gregory P. Smithdd96db62008-06-09 04:58:54 +00003395 bytes = RAND_egd(PyString_AS_STRING(arg));
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003396 if (bytes == -1) {
Antoine Pitrou2e136ab2010-05-12 14:02:34 +00003397 PyErr_SetString(PySSLErrorObject,
3398 "EGD connection failed or EGD did not return "
3399 "enough data to seed the PRNG");
3400 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003401 }
3402 return PyInt_FromLong(bytes);
3403}
3404
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003405PyDoc_STRVAR(PySSL_RAND_egd_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003406"RAND_egd(path) -> bytes\n\
3407\n\
Bill Janssen98d19da2007-09-10 21:51:02 +00003408Queries the entropy gather daemon (EGD) on the socket named by 'path'.\n\
3409Returns number of bytes read. Raises SSLError if connection to EGD\n\
Christian Heimesb4ec8422013-08-17 17:25:18 +02003410fails or if it does not provide enough data to seed PRNG.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003411
Victor Stinner7c906672015-01-06 13:53:37 +01003412#endif /* HAVE_RAND_EGD */
Christian Heimes0d604cf2013-08-21 13:26:05 +02003413
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003414
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003415PyDoc_STRVAR(PySSL_get_default_verify_paths_doc,
3416"get_default_verify_paths() -> tuple\n\
3417\n\
3418Return search paths and environment vars that are used by SSLContext's\n\
3419set_default_verify_paths() to load default CAs. The values are\n\
3420'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.");
3421
3422static PyObject *
3423PySSL_get_default_verify_paths(PyObject *self)
3424{
3425 PyObject *ofile_env = NULL;
3426 PyObject *ofile = NULL;
3427 PyObject *odir_env = NULL;
3428 PyObject *odir = NULL;
3429
Benjamin Peterson65192c12015-07-18 10:59:13 -07003430#define CONVERT(info, target) { \
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003431 const char *tmp = (info); \
3432 target = NULL; \
3433 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
3434 else { target = PyBytes_FromString(tmp); } \
3435 if (!target) goto error; \
Benjamin Peterson93ed9462015-11-14 15:12:38 -08003436 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003437
Benjamin Peterson65192c12015-07-18 10:59:13 -07003438 CONVERT(X509_get_default_cert_file_env(), ofile_env);
3439 CONVERT(X509_get_default_cert_file(), ofile);
3440 CONVERT(X509_get_default_cert_dir_env(), odir_env);
3441 CONVERT(X509_get_default_cert_dir(), odir);
3442#undef CONVERT
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003443
3444 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
3445
3446 error:
3447 Py_XDECREF(ofile_env);
3448 Py_XDECREF(ofile);
3449 Py_XDECREF(odir_env);
3450 Py_XDECREF(odir);
3451 return NULL;
3452}
3453
3454static PyObject*
3455asn1obj2py(ASN1_OBJECT *obj)
3456{
3457 int nid;
3458 const char *ln, *sn;
3459 char buf[100];
3460 Py_ssize_t buflen;
3461
3462 nid = OBJ_obj2nid(obj);
3463 if (nid == NID_undef) {
3464 PyErr_Format(PyExc_ValueError, "Unknown object");
3465 return NULL;
3466 }
3467 sn = OBJ_nid2sn(nid);
3468 ln = OBJ_nid2ln(nid);
3469 buflen = OBJ_obj2txt(buf, sizeof(buf), obj, 1);
3470 if (buflen < 0) {
3471 _setSSLError(NULL, 0, __FILE__, __LINE__);
3472 return NULL;
3473 }
3474 if (buflen) {
3475 return Py_BuildValue("isss#", nid, sn, ln, buf, buflen);
3476 } else {
3477 return Py_BuildValue("issO", nid, sn, ln, Py_None);
3478 }
3479}
3480
3481PyDoc_STRVAR(PySSL_txt2obj_doc,
3482"txt2obj(txt, name=False) -> (nid, shortname, longname, oid)\n\
3483\n\
3484Lookup NID, short name, long name and OID of an ASN1_OBJECT. By default\n\
3485objects are looked up by OID. With name=True short and long name are also\n\
3486matched.");
3487
3488static PyObject*
3489PySSL_txt2obj(PyObject *self, PyObject *args, PyObject *kwds)
3490{
3491 char *kwlist[] = {"txt", "name", NULL};
3492 PyObject *result = NULL;
3493 char *txt;
3494 PyObject *pyname = Py_None;
3495 int name = 0;
3496 ASN1_OBJECT *obj;
3497
3498 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s|O:txt2obj",
3499 kwlist, &txt, &pyname)) {
3500 return NULL;
3501 }
3502 name = PyObject_IsTrue(pyname);
3503 if (name < 0)
3504 return NULL;
3505 obj = OBJ_txt2obj(txt, name ? 0 : 1);
3506 if (obj == NULL) {
3507 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
3508 return NULL;
3509 }
3510 result = asn1obj2py(obj);
3511 ASN1_OBJECT_free(obj);
3512 return result;
3513}
3514
3515PyDoc_STRVAR(PySSL_nid2obj_doc,
3516"nid2obj(nid) -> (nid, shortname, longname, oid)\n\
3517\n\
3518Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.");
3519
3520static PyObject*
3521PySSL_nid2obj(PyObject *self, PyObject *args)
3522{
3523 PyObject *result = NULL;
3524 int nid;
3525 ASN1_OBJECT *obj;
3526
3527 if (!PyArg_ParseTuple(args, "i:nid2obj", &nid)) {
3528 return NULL;
3529 }
3530 if (nid < NID_undef) {
3531 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
3532 return NULL;
3533 }
3534 obj = OBJ_nid2obj(nid);
3535 if (obj == NULL) {
3536 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
3537 return NULL;
3538 }
3539 result = asn1obj2py(obj);
3540 ASN1_OBJECT_free(obj);
3541 return result;
3542}
3543
3544#ifdef _MSC_VER
3545
3546static PyObject*
3547certEncodingType(DWORD encodingType)
3548{
3549 static PyObject *x509_asn = NULL;
3550 static PyObject *pkcs_7_asn = NULL;
3551
3552 if (x509_asn == NULL) {
Benjamin Petersoncbb144a2014-08-20 14:25:32 -05003553 x509_asn = PyString_InternFromString("x509_asn");
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003554 if (x509_asn == NULL)
3555 return NULL;
3556 }
3557 if (pkcs_7_asn == NULL) {
Benjamin Petersoncbb144a2014-08-20 14:25:32 -05003558 pkcs_7_asn = PyString_InternFromString("pkcs_7_asn");
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003559 if (pkcs_7_asn == NULL)
3560 return NULL;
3561 }
3562 switch(encodingType) {
3563 case X509_ASN_ENCODING:
3564 Py_INCREF(x509_asn);
3565 return x509_asn;
3566 case PKCS_7_ASN_ENCODING:
3567 Py_INCREF(pkcs_7_asn);
3568 return pkcs_7_asn;
3569 default:
Benjamin Petersoncbb144a2014-08-20 14:25:32 -05003570 return PyInt_FromLong(encodingType);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003571 }
3572}
3573
3574static PyObject*
3575parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
3576{
3577 CERT_ENHKEY_USAGE *usage;
3578 DWORD size, error, i;
3579 PyObject *retval;
3580
3581 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
3582 error = GetLastError();
3583 if (error == CRYPT_E_NOT_FOUND) {
3584 Py_RETURN_TRUE;
3585 }
3586 return PyErr_SetFromWindowsErr(error);
3587 }
3588
3589 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
3590 if (usage == NULL) {
3591 return PyErr_NoMemory();
3592 }
3593
3594 /* Now get the actual enhanced usage property */
3595 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
3596 PyMem_Free(usage);
3597 error = GetLastError();
3598 if (error == CRYPT_E_NOT_FOUND) {
3599 Py_RETURN_TRUE;
3600 }
3601 return PyErr_SetFromWindowsErr(error);
3602 }
3603 retval = PySet_New(NULL);
3604 if (retval == NULL) {
3605 goto error;
3606 }
3607 for (i = 0; i < usage->cUsageIdentifier; ++i) {
3608 if (usage->rgpszUsageIdentifier[i]) {
3609 PyObject *oid;
3610 int err;
Benjamin Petersoncbb144a2014-08-20 14:25:32 -05003611 oid = PyString_FromString(usage->rgpszUsageIdentifier[i]);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003612 if (oid == NULL) {
3613 Py_CLEAR(retval);
3614 goto error;
3615 }
3616 err = PySet_Add(retval, oid);
3617 Py_DECREF(oid);
3618 if (err == -1) {
3619 Py_CLEAR(retval);
3620 goto error;
3621 }
3622 }
3623 }
3624 error:
3625 PyMem_Free(usage);
3626 return retval;
3627}
3628
3629PyDoc_STRVAR(PySSL_enum_certificates_doc,
3630"enum_certificates(store_name) -> []\n\
3631\n\
3632Retrieve certificates from Windows' cert store. store_name may be one of\n\
3633'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
3634The function returns a list of (bytes, encoding_type, trust) tuples. The\n\
3635encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
3636PKCS_7_ASN_ENCODING. The trust setting is either a set of OIDs or the\n\
3637boolean True.");
3638
3639static PyObject *
3640PySSL_enum_certificates(PyObject *self, PyObject *args, PyObject *kwds)
3641{
3642 char *kwlist[] = {"store_name", NULL};
3643 char *store_name;
3644 HCERTSTORE hStore = NULL;
3645 PCCERT_CONTEXT pCertCtx = NULL;
3646 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
3647 PyObject *result = NULL;
3648
Benjamin Peterson9c5a8d42015-04-06 13:05:22 -04003649 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s:enum_certificates",
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003650 kwlist, &store_name)) {
3651 return NULL;
3652 }
3653 result = PyList_New(0);
3654 if (result == NULL) {
3655 return NULL;
3656 }
3657 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3658 if (hStore == NULL) {
3659 Py_DECREF(result);
3660 return PyErr_SetFromWindowsErr(GetLastError());
3661 }
3662
3663 while (pCertCtx = CertEnumCertificatesInStore(hStore, pCertCtx)) {
3664 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
3665 pCertCtx->cbCertEncoded);
3666 if (!cert) {
3667 Py_CLEAR(result);
3668 break;
3669 }
3670 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
3671 Py_CLEAR(result);
3672 break;
3673 }
3674 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
3675 if (keyusage == Py_True) {
3676 Py_DECREF(keyusage);
3677 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
3678 }
3679 if (keyusage == NULL) {
3680 Py_CLEAR(result);
3681 break;
3682 }
3683 if ((tup = PyTuple_New(3)) == NULL) {
3684 Py_CLEAR(result);
3685 break;
3686 }
3687 PyTuple_SET_ITEM(tup, 0, cert);
3688 cert = NULL;
3689 PyTuple_SET_ITEM(tup, 1, enc);
3690 enc = NULL;
3691 PyTuple_SET_ITEM(tup, 2, keyusage);
3692 keyusage = NULL;
3693 if (PyList_Append(result, tup) < 0) {
3694 Py_CLEAR(result);
3695 break;
3696 }
3697 Py_CLEAR(tup);
3698 }
3699 if (pCertCtx) {
3700 /* loop ended with an error, need to clean up context manually */
3701 CertFreeCertificateContext(pCertCtx);
3702 }
3703
3704 /* In error cases cert, enc and tup may not be NULL */
3705 Py_XDECREF(cert);
3706 Py_XDECREF(enc);
3707 Py_XDECREF(keyusage);
3708 Py_XDECREF(tup);
3709
3710 if (!CertCloseStore(hStore, 0)) {
3711 /* This error case might shadow another exception.*/
3712 Py_XDECREF(result);
3713 return PyErr_SetFromWindowsErr(GetLastError());
3714 }
3715 return result;
3716}
3717
3718PyDoc_STRVAR(PySSL_enum_crls_doc,
3719"enum_crls(store_name) -> []\n\
3720\n\
3721Retrieve CRLs from Windows' cert store. store_name may be one of\n\
3722'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
3723The function returns a list of (bytes, encoding_type) tuples. The\n\
3724encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
3725PKCS_7_ASN_ENCODING.");
3726
3727static PyObject *
3728PySSL_enum_crls(PyObject *self, PyObject *args, PyObject *kwds)
3729{
3730 char *kwlist[] = {"store_name", NULL};
3731 char *store_name;
3732 HCERTSTORE hStore = NULL;
3733 PCCRL_CONTEXT pCrlCtx = NULL;
3734 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
3735 PyObject *result = NULL;
3736
Benjamin Peterson9c5a8d42015-04-06 13:05:22 -04003737 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s:enum_crls",
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003738 kwlist, &store_name)) {
3739 return NULL;
3740 }
3741 result = PyList_New(0);
3742 if (result == NULL) {
3743 return NULL;
3744 }
3745 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3746 if (hStore == NULL) {
3747 Py_DECREF(result);
3748 return PyErr_SetFromWindowsErr(GetLastError());
3749 }
3750
3751 while (pCrlCtx = CertEnumCRLsInStore(hStore, pCrlCtx)) {
3752 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
3753 pCrlCtx->cbCrlEncoded);
3754 if (!crl) {
3755 Py_CLEAR(result);
3756 break;
3757 }
3758 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
3759 Py_CLEAR(result);
3760 break;
3761 }
3762 if ((tup = PyTuple_New(2)) == NULL) {
3763 Py_CLEAR(result);
3764 break;
3765 }
3766 PyTuple_SET_ITEM(tup, 0, crl);
3767 crl = NULL;
3768 PyTuple_SET_ITEM(tup, 1, enc);
3769 enc = NULL;
3770
3771 if (PyList_Append(result, tup) < 0) {
3772 Py_CLEAR(result);
3773 break;
3774 }
3775 Py_CLEAR(tup);
3776 }
3777 if (pCrlCtx) {
3778 /* loop ended with an error, need to clean up context manually */
3779 CertFreeCRLContext(pCrlCtx);
3780 }
3781
3782 /* In error cases cert, enc and tup may not be NULL */
3783 Py_XDECREF(crl);
3784 Py_XDECREF(enc);
3785 Py_XDECREF(tup);
3786
3787 if (!CertCloseStore(hStore, 0)) {
3788 /* This error case might shadow another exception.*/
3789 Py_XDECREF(result);
3790 return PyErr_SetFromWindowsErr(GetLastError());
3791 }
3792 return result;
3793}
3794
3795#endif /* _MSC_VER */
3796
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003797/* List of functions exported by this module. */
3798
3799static PyMethodDef PySSL_methods[] = {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003800 {"_test_decode_cert", PySSL_test_decode_certificate,
3801 METH_VARARGS},
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003802#ifdef HAVE_OPENSSL_RAND
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003803 {"RAND_add", PySSL_RAND_add, METH_VARARGS,
3804 PySSL_RAND_add_doc},
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003805 {"RAND_status", (PyCFunction)PySSL_RAND_status, METH_NOARGS,
3806 PySSL_RAND_status_doc},
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003807#endif
Victor Stinner7c906672015-01-06 13:53:37 +01003808#ifdef HAVE_RAND_EGD
3809 {"RAND_egd", PySSL_RAND_egd, METH_VARARGS,
3810 PySSL_RAND_egd_doc},
3811#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003812 {"get_default_verify_paths", (PyCFunction)PySSL_get_default_verify_paths,
3813 METH_NOARGS, PySSL_get_default_verify_paths_doc},
3814#ifdef _MSC_VER
3815 {"enum_certificates", (PyCFunction)PySSL_enum_certificates,
3816 METH_VARARGS | METH_KEYWORDS, PySSL_enum_certificates_doc},
3817 {"enum_crls", (PyCFunction)PySSL_enum_crls,
3818 METH_VARARGS | METH_KEYWORDS, PySSL_enum_crls_doc},
3819#endif
3820 {"txt2obj", (PyCFunction)PySSL_txt2obj,
3821 METH_VARARGS | METH_KEYWORDS, PySSL_txt2obj_doc},
3822 {"nid2obj", (PyCFunction)PySSL_nid2obj,
3823 METH_VARARGS, PySSL_nid2obj_doc},
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003824 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003825};
3826
3827
Bill Janssen98d19da2007-09-10 21:51:02 +00003828#ifdef WITH_THREAD
3829
3830/* an implementation of OpenSSL threading operations in terms
3831 of the Python C thread library */
3832
3833static PyThread_type_lock *_ssl_locks = NULL;
3834
Christian Heimes10107812013-08-19 17:36:29 +02003835#if OPENSSL_VERSION_NUMBER >= 0x10000000
3836/* use new CRYPTO_THREADID API. */
3837static void
3838_ssl_threadid_callback(CRYPTO_THREADID *id)
3839{
3840 CRYPTO_THREADID_set_numeric(id,
3841 (unsigned long)PyThread_get_thread_ident());
3842}
3843#else
3844/* deprecated CRYPTO_set_id_callback() API. */
3845static unsigned long
3846_ssl_thread_id_function (void) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003847 return PyThread_get_thread_ident();
Bill Janssen98d19da2007-09-10 21:51:02 +00003848}
Christian Heimes10107812013-08-19 17:36:29 +02003849#endif
Bill Janssen98d19da2007-09-10 21:51:02 +00003850
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003851static void _ssl_thread_locking_function
3852 (int mode, int n, const char *file, int line) {
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003853 /* this function is needed to perform locking on shared data
3854 structures. (Note that OpenSSL uses a number of global data
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003855 structures that will be implicitly shared whenever multiple
3856 threads use OpenSSL.) Multi-threaded applications will
3857 crash at random if it is not set.
Bill Janssen98d19da2007-09-10 21:51:02 +00003858
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003859 locking_function() must be able to handle up to
3860 CRYPTO_num_locks() different mutex locks. It sets the n-th
3861 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Bill Janssen98d19da2007-09-10 21:51:02 +00003862
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003863 file and line are the file number of the function setting the
3864 lock. They can be useful for debugging.
3865 */
Bill Janssen98d19da2007-09-10 21:51:02 +00003866
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003867 if ((_ssl_locks == NULL) ||
3868 (n < 0) || ((unsigned)n >= _ssl_locks_count))
3869 return;
Bill Janssen98d19da2007-09-10 21:51:02 +00003870
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003871 if (mode & CRYPTO_LOCK) {
3872 PyThread_acquire_lock(_ssl_locks[n], 1);
3873 } else {
3874 PyThread_release_lock(_ssl_locks[n]);
3875 }
Bill Janssen98d19da2007-09-10 21:51:02 +00003876}
3877
3878static int _setup_ssl_threads(void) {
3879
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003880 unsigned int i;
Bill Janssen98d19da2007-09-10 21:51:02 +00003881
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003882 if (_ssl_locks == NULL) {
3883 _ssl_locks_count = CRYPTO_num_locks();
Serhiy Storchakaa2269d02015-02-16 13:16:07 +02003884 _ssl_locks = PyMem_New(PyThread_type_lock, _ssl_locks_count);
3885 if (_ssl_locks == NULL) {
3886 PyErr_NoMemory();
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003887 return 0;
Serhiy Storchakaa2269d02015-02-16 13:16:07 +02003888 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003889 memset(_ssl_locks, 0,
3890 sizeof(PyThread_type_lock) * _ssl_locks_count);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003891 for (i = 0; i < _ssl_locks_count; i++) {
3892 _ssl_locks[i] = PyThread_allocate_lock();
3893 if (_ssl_locks[i] == NULL) {
3894 unsigned int j;
3895 for (j = 0; j < i; j++) {
3896 PyThread_free_lock(_ssl_locks[j]);
3897 }
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003898 PyMem_Free(_ssl_locks);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003899 return 0;
3900 }
3901 }
3902 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes10107812013-08-19 17:36:29 +02003903#if OPENSSL_VERSION_NUMBER >= 0x10000000
3904 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
3905#else
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003906 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes10107812013-08-19 17:36:29 +02003907#endif
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003908 }
3909 return 1;
Bill Janssen98d19da2007-09-10 21:51:02 +00003910}
3911
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003912#endif /* def HAVE_THREAD */
Bill Janssen98d19da2007-09-10 21:51:02 +00003913
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003914PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003915"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003916for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003917
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003918
3919
3920
3921static void
3922parse_openssl_version(unsigned long libver,
3923 unsigned int *major, unsigned int *minor,
3924 unsigned int *fix, unsigned int *patch,
3925 unsigned int *status)
3926{
3927 *status = libver & 0xF;
3928 libver >>= 4;
3929 *patch = libver & 0xFF;
3930 libver >>= 8;
3931 *fix = libver & 0xFF;
3932 libver >>= 8;
3933 *minor = libver & 0xFF;
3934 libver >>= 8;
3935 *major = libver & 0xFF;
3936}
3937
Mark Hammondfe51c6d2002-08-02 02:27:13 +00003938PyMODINIT_FUNC
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003939init_ssl(void)
3940{
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003941 PyObject *m, *d, *r;
3942 unsigned long libver;
3943 unsigned int major, minor, fix, patch, status;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003944 struct py_ssl_error_code *errcode;
3945 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003946
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003947 if (PyType_Ready(&PySSLContext_Type) < 0)
3948 return;
3949 if (PyType_Ready(&PySSLSocket_Type) < 0)
3950 return;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003951
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003952 m = Py_InitModule3("_ssl", PySSL_methods, module_doc);
3953 if (m == NULL)
3954 return;
3955 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003956
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003957 /* Load _socket module and its C API */
3958 if (PySocketModule_ImportModuleAndAPI())
3959 return;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003960
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003961 /* Init OpenSSL */
3962 SSL_load_error_strings();
3963 SSL_library_init();
Bill Janssen98d19da2007-09-10 21:51:02 +00003964#ifdef WITH_THREAD
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003965 /* note that this will start threading if not already started */
3966 if (!_setup_ssl_threads()) {
3967 return;
3968 }
Bill Janssen98d19da2007-09-10 21:51:02 +00003969#endif
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003970 OpenSSL_add_all_algorithms();
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003971
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003972 /* Add symbols to module dict */
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003973 PySSLErrorObject = PyErr_NewExceptionWithDoc(
3974 "ssl.SSLError", SSLError_doc,
3975 PySocketModule.error, NULL);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00003976 if (PySSLErrorObject == NULL)
3977 return;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05003978 ((PyTypeObject *)PySSLErrorObject)->tp_str = (reprfunc)SSLError_str;
3979
3980 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
3981 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
3982 PySSLErrorObject, NULL);
3983 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
3984 "ssl.SSLWantReadError", SSLWantReadError_doc,
3985 PySSLErrorObject, NULL);
3986 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
3987 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
3988 PySSLErrorObject, NULL);
3989 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
3990 "ssl.SSLSyscallError", SSLSyscallError_doc,
3991 PySSLErrorObject, NULL);
3992 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
3993 "ssl.SSLEOFError", SSLEOFError_doc,
3994 PySSLErrorObject, NULL);
3995 if (PySSLZeroReturnErrorObject == NULL
3996 || PySSLWantReadErrorObject == NULL
3997 || PySSLWantWriteErrorObject == NULL
3998 || PySSLSyscallErrorObject == NULL
3999 || PySSLEOFErrorObject == NULL)
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004000 return;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004001
4002 ((PyTypeObject *)PySSLZeroReturnErrorObject)->tp_str = (reprfunc)SSLError_str;
4003 ((PyTypeObject *)PySSLWantReadErrorObject)->tp_str = (reprfunc)SSLError_str;
4004 ((PyTypeObject *)PySSLWantWriteErrorObject)->tp_str = (reprfunc)SSLError_str;
4005 ((PyTypeObject *)PySSLSyscallErrorObject)->tp_str = (reprfunc)SSLError_str;
4006 ((PyTypeObject *)PySSLEOFErrorObject)->tp_str = (reprfunc)SSLError_str;
4007
4008 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
4009 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
4010 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
4011 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
4012 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
4013 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
4014 return;
4015 if (PyDict_SetItemString(d, "_SSLContext",
4016 (PyObject *)&PySSLContext_Type) != 0)
4017 return;
4018 if (PyDict_SetItemString(d, "_SSLSocket",
4019 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004020 return;
4021 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
4022 PY_SSL_ERROR_ZERO_RETURN);
4023 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
4024 PY_SSL_ERROR_WANT_READ);
4025 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
4026 PY_SSL_ERROR_WANT_WRITE);
4027 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
4028 PY_SSL_ERROR_WANT_X509_LOOKUP);
4029 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
4030 PY_SSL_ERROR_SYSCALL);
4031 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
4032 PY_SSL_ERROR_SSL);
4033 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
4034 PY_SSL_ERROR_WANT_CONNECT);
4035 /* non ssl.h errorcodes */
4036 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
4037 PY_SSL_ERROR_EOF);
4038 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
4039 PY_SSL_ERROR_INVALID_ERROR_CODE);
4040 /* cert requirements */
4041 PyModule_AddIntConstant(m, "CERT_NONE",
4042 PY_SSL_CERT_NONE);
4043 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
4044 PY_SSL_CERT_OPTIONAL);
4045 PyModule_AddIntConstant(m, "CERT_REQUIRED",
4046 PY_SSL_CERT_REQUIRED);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004047 /* CRL verification for verification_flags */
4048 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
4049 0);
4050 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
4051 X509_V_FLAG_CRL_CHECK);
4052 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
4053 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
4054 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
4055 X509_V_FLAG_X509_STRICT);
Benjamin Peterson72ef9612015-03-04 22:49:41 -05004056#ifdef X509_V_FLAG_TRUSTED_FIRST
4057 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
4058 X509_V_FLAG_TRUSTED_FIRST);
4059#endif
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004060
4061 /* Alert Descriptions from ssl.h */
4062 /* note RESERVED constants no longer intended for use have been removed */
4063 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
4064
4065#define ADD_AD_CONSTANT(s) \
4066 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
4067 SSL_AD_##s)
4068
4069 ADD_AD_CONSTANT(CLOSE_NOTIFY);
4070 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
4071 ADD_AD_CONSTANT(BAD_RECORD_MAC);
4072 ADD_AD_CONSTANT(RECORD_OVERFLOW);
4073 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
4074 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
4075 ADD_AD_CONSTANT(BAD_CERTIFICATE);
4076 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
4077 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
4078 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
4079 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
4080 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
4081 ADD_AD_CONSTANT(UNKNOWN_CA);
4082 ADD_AD_CONSTANT(ACCESS_DENIED);
4083 ADD_AD_CONSTANT(DECODE_ERROR);
4084 ADD_AD_CONSTANT(DECRYPT_ERROR);
4085 ADD_AD_CONSTANT(PROTOCOL_VERSION);
4086 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
4087 ADD_AD_CONSTANT(INTERNAL_ERROR);
4088 ADD_AD_CONSTANT(USER_CANCELLED);
4089 ADD_AD_CONSTANT(NO_RENEGOTIATION);
4090 /* Not all constants are in old OpenSSL versions */
4091#ifdef SSL_AD_UNSUPPORTED_EXTENSION
4092 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
4093#endif
4094#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
4095 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
4096#endif
4097#ifdef SSL_AD_UNRECOGNIZED_NAME
4098 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
4099#endif
4100#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
4101 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
4102#endif
4103#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
4104 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
4105#endif
4106#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
4107 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
4108#endif
4109
4110#undef ADD_AD_CONSTANT
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00004111
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004112 /* protocol versions */
Victor Stinnerb1241f92011-05-10 01:52:03 +02004113#ifndef OPENSSL_NO_SSL2
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004114 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
4115 PY_SSL_VERSION_SSL2);
Victor Stinnerb1241f92011-05-10 01:52:03 +02004116#endif
Benjamin Peterson60766c42014-12-05 21:59:35 -05004117#ifndef OPENSSL_NO_SSL3
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004118 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
4119 PY_SSL_VERSION_SSL3);
Benjamin Peterson60766c42014-12-05 21:59:35 -05004120#endif
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004121 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
4122 PY_SSL_VERSION_SSL23);
4123 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
4124 PY_SSL_VERSION_TLS1);
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004125#if HAVE_TLSv1_2
4126 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
4127 PY_SSL_VERSION_TLS1_1);
4128 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
4129 PY_SSL_VERSION_TLS1_2);
4130#endif
4131
4132 /* protocol options */
4133 PyModule_AddIntConstant(m, "OP_ALL",
4134 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
4135 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
4136 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
4137 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
4138#if HAVE_TLSv1_2
4139 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
4140 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
4141#endif
4142 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
4143 SSL_OP_CIPHER_SERVER_PREFERENCE);
4144 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
4145#ifdef SSL_OP_SINGLE_ECDH_USE
4146 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
4147#endif
4148#ifdef SSL_OP_NO_COMPRESSION
4149 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
4150 SSL_OP_NO_COMPRESSION);
4151#endif
4152
4153#if HAVE_SNI
4154 r = Py_True;
4155#else
4156 r = Py_False;
4157#endif
4158 Py_INCREF(r);
4159 PyModule_AddObject(m, "HAS_SNI", r);
4160
4161#if HAVE_OPENSSL_FINISHED
4162 r = Py_True;
4163#else
4164 r = Py_False;
4165#endif
4166 Py_INCREF(r);
4167 PyModule_AddObject(m, "HAS_TLS_UNIQUE", r);
4168
4169#ifdef OPENSSL_NO_ECDH
4170 r = Py_False;
4171#else
4172 r = Py_True;
4173#endif
4174 Py_INCREF(r);
4175 PyModule_AddObject(m, "HAS_ECDH", r);
4176
4177#ifdef OPENSSL_NPN_NEGOTIATED
4178 r = Py_True;
4179#else
4180 r = Py_False;
4181#endif
4182 Py_INCREF(r);
4183 PyModule_AddObject(m, "HAS_NPN", r);
4184
Benjamin Petersonb10bfbe2015-01-23 16:35:37 -05004185#ifdef HAVE_ALPN
4186 r = Py_True;
4187#else
4188 r = Py_False;
4189#endif
4190 Py_INCREF(r);
4191 PyModule_AddObject(m, "HAS_ALPN", r);
4192
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004193 /* Mappings for error codes */
4194 err_codes_to_names = PyDict_New();
4195 err_names_to_codes = PyDict_New();
4196 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
4197 return;
4198 errcode = error_codes;
4199 while (errcode->mnemonic != NULL) {
4200 PyObject *mnemo, *key;
4201 mnemo = PyUnicode_FromString(errcode->mnemonic);
4202 key = Py_BuildValue("ii", errcode->library, errcode->reason);
4203 if (mnemo == NULL || key == NULL)
4204 return;
4205 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
4206 return;
4207 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
4208 return;
4209 Py_DECREF(key);
4210 Py_DECREF(mnemo);
4211 errcode++;
4212 }
4213 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
4214 return;
4215 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
4216 return;
4217
4218 lib_codes_to_names = PyDict_New();
4219 if (lib_codes_to_names == NULL)
4220 return;
4221 libcode = library_codes;
4222 while (libcode->library != NULL) {
4223 PyObject *mnemo, *key;
4224 key = PyLong_FromLong(libcode->code);
4225 mnemo = PyUnicode_FromString(libcode->library);
4226 if (key == NULL || mnemo == NULL)
4227 return;
4228 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
4229 return;
4230 Py_DECREF(key);
4231 Py_DECREF(mnemo);
4232 libcode++;
4233 }
4234 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
4235 return;
Antoine Pitrouf9de5342010-04-05 21:35:07 +00004236
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004237 /* OpenSSL version */
4238 /* SSLeay() gives us the version of the library linked against,
4239 which could be different from the headers version.
4240 */
4241 libver = SSLeay();
4242 r = PyLong_FromUnsignedLong(libver);
4243 if (r == NULL)
4244 return;
4245 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
4246 return;
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004247 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroua4c2a5c2010-05-05 15:53:45 +00004248 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4249 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
4250 return;
4251 r = PyString_FromString(SSLeay_version(SSLEAY_VERSION));
4252 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
4253 return;
Christian Heimes0d604cf2013-08-21 13:26:05 +02004254
Benjamin Petersondaeb9252014-08-20 14:14:50 -05004255 libver = OPENSSL_VERSION_NUMBER;
4256 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
4257 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4258 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
4259 return;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004260}