blob: 23e9be767cd10202f1ada8a9f81a167442fca7d8 [file] [log] [blame]
Thomas Woutersed03b412007-08-28 21:37:11 +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.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004 Re-worked a bit by Bill Janssen to add server-side support and
Bill Janssen6e027db2007-11-15 22:23:56 +00005 certificate decoding. Chris Stawarz contributed some non-blocking
6 patches.
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00007
Thomas Wouters1b7f8912007-09-19 03:06:30 +00008 This module is imported by ssl.py. It should *not* be used
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00009 directly.
10
Thomas Wouters1b7f8912007-09-19 03:06:30 +000011 XXX should partial writes be enabled, SSL_MODE_ENABLE_PARTIAL_WRITE?
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +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
Victor Stinner2e57b4e2014-07-01 16:37:17 +020017#define PY_SSIZE_T_CLEAN
18
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +000019#include "Python.h"
Thomas Woutersed03b412007-08-28 21:37:11 +000020
Thomas Wouters1b7f8912007-09-19 03:06:30 +000021#ifdef WITH_THREAD
22#include "pythread.h"
Christian Heimesf77b4b22013-08-21 13:26:05 +020023
Christian Heimesf77b4b22013-08-21 13:26:05 +020024
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020025#define PySSL_BEGIN_ALLOW_THREADS_S(save) \
26 do { if (_ssl_locks_count>0) { (save) = PyEval_SaveThread(); } } while (0)
27#define PySSL_END_ALLOW_THREADS_S(save) \
28 do { if (_ssl_locks_count>0) { PyEval_RestoreThread(save); } } while (0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +000029#define PySSL_BEGIN_ALLOW_THREADS { \
Antoine Pitroucbb82eb2010-05-05 15:57:33 +000030 PyThreadState *_save = NULL; \
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020031 PySSL_BEGIN_ALLOW_THREADS_S(_save);
32#define PySSL_BLOCK_THREADS PySSL_END_ALLOW_THREADS_S(_save);
33#define PySSL_UNBLOCK_THREADS PySSL_BEGIN_ALLOW_THREADS_S(_save);
34#define PySSL_END_ALLOW_THREADS PySSL_END_ALLOW_THREADS_S(_save); }
Thomas Wouters1b7f8912007-09-19 03:06:30 +000035
Antoine Pitroucbb82eb2010-05-05 15:57:33 +000036#else /* no WITH_THREAD */
Thomas Wouters1b7f8912007-09-19 03:06:30 +000037
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020038#define PySSL_BEGIN_ALLOW_THREADS_S(save)
39#define PySSL_END_ALLOW_THREADS_S(save)
Thomas Wouters1b7f8912007-09-19 03:06:30 +000040#define PySSL_BEGIN_ALLOW_THREADS
41#define PySSL_BLOCK_THREADS
42#define PySSL_UNBLOCK_THREADS
43#define PySSL_END_ALLOW_THREADS
44
45#endif
46
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010047/* Include symbols from _socket module */
48#include "socketmodule.h"
49
50static PySocketModule_APIObject PySocketModule;
51
52#if defined(HAVE_POLL_H)
53#include <poll.h>
54#elif defined(HAVE_SYS_POLL_H)
55#include <sys/poll.h>
56#endif
57
58/* Include OpenSSL header files */
59#include "openssl/rsa.h"
60#include "openssl/crypto.h"
61#include "openssl/x509.h"
62#include "openssl/x509v3.h"
63#include "openssl/pem.h"
64#include "openssl/ssl.h"
65#include "openssl/err.h"
66#include "openssl/rand.h"
67
68/* SSL error object */
69static PyObject *PySSLErrorObject;
70static PyObject *PySSLZeroReturnErrorObject;
71static PyObject *PySSLWantReadErrorObject;
72static PyObject *PySSLWantWriteErrorObject;
73static PyObject *PySSLSyscallErrorObject;
74static PyObject *PySSLEOFErrorObject;
75
76/* Error mappings */
77static PyObject *err_codes_to_names;
78static PyObject *err_names_to_codes;
79static PyObject *lib_codes_to_names;
80
81struct py_ssl_error_code {
82 const char *mnemonic;
83 int library, reason;
84};
85struct py_ssl_library_code {
86 const char *library;
87 int code;
88};
89
90/* Include generated data (error codes) */
91#include "_ssl_data.h"
92
93/* Openssl comes with TLSv1.1 and TLSv1.2 between 1.0.0h and 1.0.1
94 http://www.openssl.org/news/changelog.html
95 */
96#if OPENSSL_VERSION_NUMBER >= 0x10001000L
97# define HAVE_TLSv1_2 1
98#else
99# define HAVE_TLSv1_2 0
100#endif
101
Christian Heimes470fba12013-11-28 15:12:15 +0100102/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100103 * This includes the SSL_set_SSL_CTX() function.
104 */
105#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
106# define HAVE_SNI 1
107#else
108# define HAVE_SNI 0
109#endif
110
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000111enum py_ssl_error {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000112 /* these mirror ssl.h */
113 PY_SSL_ERROR_NONE,
114 PY_SSL_ERROR_SSL,
115 PY_SSL_ERROR_WANT_READ,
116 PY_SSL_ERROR_WANT_WRITE,
117 PY_SSL_ERROR_WANT_X509_LOOKUP,
118 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
119 PY_SSL_ERROR_ZERO_RETURN,
120 PY_SSL_ERROR_WANT_CONNECT,
121 /* start of non ssl.h errorcodes */
122 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
123 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
124 PY_SSL_ERROR_INVALID_ERROR_CODE
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000125};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000126
Thomas Woutersed03b412007-08-28 21:37:11 +0000127enum py_ssl_server_or_client {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000128 PY_SSL_CLIENT,
129 PY_SSL_SERVER
Thomas Woutersed03b412007-08-28 21:37:11 +0000130};
131
132enum py_ssl_cert_requirements {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000133 PY_SSL_CERT_NONE,
134 PY_SSL_CERT_OPTIONAL,
135 PY_SSL_CERT_REQUIRED
Thomas Woutersed03b412007-08-28 21:37:11 +0000136};
137
138enum py_ssl_version {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000139 PY_SSL_VERSION_SSL2,
Victor Stinner3de49192011-05-09 00:42:58 +0200140 PY_SSL_VERSION_SSL3=1,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000141 PY_SSL_VERSION_SSL23,
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100142#if HAVE_TLSv1_2
143 PY_SSL_VERSION_TLS1,
144 PY_SSL_VERSION_TLS1_1,
145 PY_SSL_VERSION_TLS1_2
146#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000147 PY_SSL_VERSION_TLS1
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000148#endif
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100149};
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200150
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000151#ifdef WITH_THREAD
152
153/* serves as a flag to see whether we've initialized the SSL thread support. */
154/* 0 means no, greater than 0 means yes */
155
156static unsigned int _ssl_locks_count = 0;
157
158#endif /* def WITH_THREAD */
159
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000160/* SSL socket object */
161
162#define X509_NAME_MAXLEN 256
163
164/* RAND_* APIs got added to OpenSSL in 0.9.5 */
165#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
166# define HAVE_OPENSSL_RAND 1
167#else
168# undef HAVE_OPENSSL_RAND
169#endif
170
Gregory P. Smithbd4dacb2010-10-13 03:53:21 +0000171/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
172 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
173 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
174#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
Antoine Pitroub5218772010-05-21 09:56:06 +0000175# define HAVE_SSL_CTX_CLEAR_OPTIONS
176#else
177# undef HAVE_SSL_CTX_CLEAR_OPTIONS
178#endif
179
Antoine Pitroud6494802011-07-21 01:11:30 +0200180/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
181 * older SSL, but let's be safe */
182#define PySSL_CB_MAXLEN 128
183
184/* SSL_get_finished got added to OpenSSL in 0.9.5 */
185#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
186# define HAVE_OPENSSL_FINISHED 1
187#else
188# define HAVE_OPENSSL_FINISHED 0
189#endif
190
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100191/* ECDH support got added to OpenSSL in 0.9.8 */
192#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_ECDH)
193# define OPENSSL_NO_ECDH
194#endif
195
Antoine Pitrouc135fa42012-02-19 21:22:39 +0100196/* compression support got added to OpenSSL in 0.9.8 */
197#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_COMP)
198# define OPENSSL_NO_COMP
199#endif
200
Christian Heimes2427b502013-11-23 11:24:32 +0100201/* X509_VERIFY_PARAM got added to OpenSSL in 0.9.8 */
202#if OPENSSL_VERSION_NUMBER >= 0x0090800fL
203# define HAVE_OPENSSL_VERIFY_PARAM
204#endif
205
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100206
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000207typedef struct {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000208 PyObject_HEAD
Antoine Pitrou152efa22010-05-16 18:19:27 +0000209 SSL_CTX *ctx;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100210#ifdef OPENSSL_NPN_NEGOTIATED
211 char *npn_protocols;
212 int npn_protocols_len;
213#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100214#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +0200215 PyObject *set_hostname;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100216#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +0100217 int check_hostname;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000218} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000219
Antoine Pitrou152efa22010-05-16 18:19:27 +0000220typedef struct {
221 PyObject_HEAD
222 PyObject *Socket; /* weakref to socket on which we're layered */
223 SSL *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100224 PySSLContext *ctx; /* weakref to SSL context */
Antoine Pitrou152efa22010-05-16 18:19:27 +0000225 X509 *peer_cert;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200226 char shutdown_seen_zero;
227 char handshake_done;
Antoine Pitroud6494802011-07-21 01:11:30 +0200228 enum py_ssl_server_or_client socket_type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000229} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000230
Antoine Pitrou152efa22010-05-16 18:19:27 +0000231static PyTypeObject PySSLContext_Type;
232static PyTypeObject PySSLSocket_Type;
233
234static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args);
235static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args);
Thomas Woutersed03b412007-08-28 21:37:11 +0000236static int check_socket_and_wait_for_timeout(PySocketSockObject *s,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000237 int writing);
Antoine Pitrou152efa22010-05-16 18:19:27 +0000238static PyObject *PySSL_peercert(PySSLSocket *self, PyObject *args);
239static PyObject *PySSL_cipher(PySSLSocket *self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000240
Antoine Pitrou152efa22010-05-16 18:19:27 +0000241#define PySSLContext_Check(v) (Py_TYPE(v) == &PySSLContext_Type)
242#define PySSLSocket_Check(v) (Py_TYPE(v) == &PySSLSocket_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000243
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000244typedef enum {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000245 SOCKET_IS_NONBLOCKING,
246 SOCKET_IS_BLOCKING,
247 SOCKET_HAS_TIMED_OUT,
248 SOCKET_HAS_BEEN_CLOSED,
249 SOCKET_TOO_LARGE_FOR_SELECT,
250 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000251} timeout_state;
252
Thomas Woutersed03b412007-08-28 21:37:11 +0000253/* Wrap error strings with filename and line # */
254#define STRINGIFY1(x) #x
255#define STRINGIFY2(x) STRINGIFY1(x)
256#define ERRSTR1(x,y,z) (x ":" y ": " z)
257#define ERRSTR(x) ERRSTR1("_ssl.c", STRINGIFY2(__LINE__), x)
258
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200259
260/*
261 * SSL errors.
262 */
263
264PyDoc_STRVAR(SSLError_doc,
265"An error occurred in the SSL implementation.");
266
267PyDoc_STRVAR(SSLZeroReturnError_doc,
268"SSL/TLS session closed cleanly.");
269
270PyDoc_STRVAR(SSLWantReadError_doc,
271"Non-blocking SSL socket needs to read more data\n"
272"before the requested operation can be completed.");
273
274PyDoc_STRVAR(SSLWantWriteError_doc,
275"Non-blocking SSL socket needs to write more data\n"
276"before the requested operation can be completed.");
277
278PyDoc_STRVAR(SSLSyscallError_doc,
279"System error when attempting SSL operation.");
280
281PyDoc_STRVAR(SSLEOFError_doc,
282"SSL/TLS connection terminated abruptly.");
283
284static PyObject *
285SSLError_str(PyOSErrorObject *self)
286{
287 if (self->strerror != NULL && PyUnicode_Check(self->strerror)) {
288 Py_INCREF(self->strerror);
289 return self->strerror;
290 }
291 else
292 return PyObject_Str(self->args);
293}
294
295static PyType_Slot sslerror_type_slots[] = {
296 {Py_tp_base, NULL}, /* Filled out in module init as it's not a constant */
297 {Py_tp_doc, SSLError_doc},
298 {Py_tp_str, SSLError_str},
299 {0, 0},
300};
301
302static PyType_Spec sslerror_type_spec = {
303 "ssl.SSLError",
304 sizeof(PyOSErrorObject),
305 0,
306 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
307 sslerror_type_slots
308};
309
310static void
311fill_and_set_sslerror(PyObject *type, int ssl_errno, const char *errstr,
312 int lineno, unsigned long errcode)
313{
314 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
315 PyObject *init_value, *msg, *key;
316 _Py_IDENTIFIER(reason);
317 _Py_IDENTIFIER(library);
318
319 if (errcode != 0) {
320 int lib, reason;
321
322 lib = ERR_GET_LIB(errcode);
323 reason = ERR_GET_REASON(errcode);
324 key = Py_BuildValue("ii", lib, reason);
325 if (key == NULL)
326 goto fail;
327 reason_obj = PyDict_GetItem(err_codes_to_names, key);
328 Py_DECREF(key);
329 if (reason_obj == NULL) {
330 /* XXX if reason < 100, it might reflect a library number (!!) */
331 PyErr_Clear();
332 }
333 key = PyLong_FromLong(lib);
334 if (key == NULL)
335 goto fail;
336 lib_obj = PyDict_GetItem(lib_codes_to_names, key);
337 Py_DECREF(key);
338 if (lib_obj == NULL) {
339 PyErr_Clear();
340 }
341 if (errstr == NULL)
342 errstr = ERR_reason_error_string(errcode);
343 }
344 if (errstr == NULL)
345 errstr = "unknown error";
346
347 if (reason_obj && lib_obj)
348 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
349 lib_obj, reason_obj, errstr, lineno);
350 else if (lib_obj)
351 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
352 lib_obj, errstr, lineno);
353 else
354 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200355 if (msg == NULL)
356 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100357
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200358 init_value = Py_BuildValue("iN", ssl_errno, msg);
Victor Stinnerba9be472013-10-31 15:00:24 +0100359 if (init_value == NULL)
360 goto fail;
361
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200362 err_value = PyObject_CallObject(type, init_value);
363 Py_DECREF(init_value);
364 if (err_value == NULL)
365 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100366
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200367 if (reason_obj == NULL)
368 reason_obj = Py_None;
369 if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))
370 goto fail;
371 if (lib_obj == NULL)
372 lib_obj = Py_None;
373 if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))
374 goto fail;
375 PyErr_SetObject(type, err_value);
376fail:
377 Py_XDECREF(err_value);
378}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000379
380static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +0000381PySSL_SetError(PySSLSocket *obj, int ret, char *filename, int lineno)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000382{
Antoine Pitrou41032a62011-10-27 23:56:55 +0200383 PyObject *type = PySSLErrorObject;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200384 char *errstr = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000385 int err;
386 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200387 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000388
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000389 assert(ret <= 0);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200390 e = ERR_peek_last_error();
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000391
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000392 if (obj->ssl != NULL) {
393 err = SSL_get_error(obj->ssl, ret);
Thomas Woutersed03b412007-08-28 21:37:11 +0000394
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000395 switch (err) {
396 case SSL_ERROR_ZERO_RETURN:
Antoine Pitrou41032a62011-10-27 23:56:55 +0200397 errstr = "TLS/SSL connection has been closed (EOF)";
398 type = PySSLZeroReturnErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000399 p = PY_SSL_ERROR_ZERO_RETURN;
400 break;
401 case SSL_ERROR_WANT_READ:
402 errstr = "The operation did not complete (read)";
Antoine Pitrou41032a62011-10-27 23:56:55 +0200403 type = PySSLWantReadErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000404 p = PY_SSL_ERROR_WANT_READ;
405 break;
406 case SSL_ERROR_WANT_WRITE:
407 p = PY_SSL_ERROR_WANT_WRITE;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200408 type = PySSLWantWriteErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000409 errstr = "The operation did not complete (write)";
410 break;
411 case SSL_ERROR_WANT_X509_LOOKUP:
412 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000413 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000414 break;
415 case SSL_ERROR_WANT_CONNECT:
416 p = PY_SSL_ERROR_WANT_CONNECT;
417 errstr = "The operation did not complete (connect)";
418 break;
419 case SSL_ERROR_SYSCALL:
420 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000421 if (e == 0) {
422 PySocketSockObject *s
423 = (PySocketSockObject *) PyWeakref_GetObject(obj->Socket);
424 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000425 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200426 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000427 errstr = "EOF occurred in violation of protocol";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000428 } else if (ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000429 /* underlying BIO reported an I/O error */
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000430 Py_INCREF(s);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000431 ERR_clear_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200432 s->errorhandler();
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000433 Py_DECREF(s);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200434 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000435 } else { /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000436 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200437 type = PySSLSyscallErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000438 errstr = "Some I/O error occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000439 }
440 } else {
441 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000442 }
443 break;
444 }
445 case SSL_ERROR_SSL:
446 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000447 p = PY_SSL_ERROR_SSL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200448 if (e == 0)
449 /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000450 errstr = "A failure in the SSL library occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000451 break;
452 }
453 default:
454 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
455 errstr = "Invalid error code";
456 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000457 }
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200458 fill_and_set_sslerror(type, p, errstr, lineno, e);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000459 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000460 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000461}
462
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000463static PyObject *
464_setSSLError (char *errstr, int errcode, char *filename, int lineno) {
465
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200466 if (errstr == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000467 errcode = ERR_peek_last_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200468 else
469 errcode = 0;
470 fill_and_set_sslerror(PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000471 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000472 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000473}
474
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200475/*
476 * SSL objects
477 */
478
Antoine Pitrou152efa22010-05-16 18:19:27 +0000479static PySSLSocket *
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100480newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
Antoine Pitroud5323212010-10-22 18:19:07 +0000481 enum py_ssl_server_or_client socket_type,
482 char *server_hostname)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000483{
Antoine Pitrou152efa22010-05-16 18:19:27 +0000484 PySSLSocket *self;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100485 SSL_CTX *ctx = sslctx->ctx;
Antoine Pitrou19fef692013-05-25 13:23:03 +0200486 long mode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000487
Antoine Pitrou152efa22010-05-16 18:19:27 +0000488 self = PyObject_New(PySSLSocket, &PySSLSocket_Type);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000489 if (self == NULL)
490 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000491
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000492 self->peer_cert = NULL;
493 self->ssl = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000494 self->Socket = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100495 self->ctx = sslctx;
Antoine Pitrou860aee72013-09-29 19:52:45 +0200496 self->shutdown_seen_zero = 0;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200497 self->handshake_done = 0;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100498 Py_INCREF(sslctx);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000499
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000500 /* Make sure the SSL error state is initialized */
501 (void) ERR_get_state();
502 ERR_clear_error();
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000503
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000504 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitrou152efa22010-05-16 18:19:27 +0000505 self->ssl = SSL_new(ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000506 PySSL_END_ALLOW_THREADS
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100507 SSL_set_app_data(self->ssl,self);
Christian Heimesb08ff7d2013-11-18 10:04:07 +0100508 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
Antoine Pitrou19fef692013-05-25 13:23:03 +0200509 mode = SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000510#ifdef SSL_MODE_AUTO_RETRY
Antoine Pitrou19fef692013-05-25 13:23:03 +0200511 mode |= SSL_MODE_AUTO_RETRY;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000512#endif
Antoine Pitrou19fef692013-05-25 13:23:03 +0200513 SSL_set_mode(self->ssl, mode);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000514
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100515#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +0000516 if (server_hostname != NULL)
517 SSL_set_tlsext_host_name(self->ssl, server_hostname);
518#endif
519
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000520 /* If the socket is in non-blocking mode or timeout mode, set the BIO
521 * to non-blocking mode (blocking is the default)
522 */
Antoine Pitrou152efa22010-05-16 18:19:27 +0000523 if (sock->sock_timeout >= 0.0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000524 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
525 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
526 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000527
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000528 PySSL_BEGIN_ALLOW_THREADS
529 if (socket_type == PY_SSL_CLIENT)
530 SSL_set_connect_state(self->ssl);
531 else
532 SSL_set_accept_state(self->ssl);
533 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000534
Antoine Pitroud6494802011-07-21 01:11:30 +0200535 self->socket_type = socket_type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000536 self->Socket = PyWeakref_NewRef((PyObject *) sock, NULL);
Victor Stinnera9eb38f2013-10-31 16:35:38 +0100537 if (self->Socket == NULL) {
538 Py_DECREF(self);
539 return NULL;
540 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000541 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000542}
543
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000544/* SSL object methods */
545
Antoine Pitrou152efa22010-05-16 18:19:27 +0000546static PyObject *PySSL_SSLdo_handshake(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000547{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000548 int ret;
549 int err;
550 int sockstate, nonblocking;
551 PySocketSockObject *sock
552 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Antoine Pitroud3f8ab82010-04-24 21:26:44 +0000553
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000554 if (((PyObject*)sock) == Py_None) {
555 _setSSLError("Underlying socket connection gone",
556 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
557 return NULL;
558 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000559 Py_INCREF(sock);
Antoine Pitroud3f8ab82010-04-24 21:26:44 +0000560
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000561 /* just in case the blocking state of the socket has been changed */
562 nonblocking = (sock->sock_timeout >= 0.0);
563 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
564 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000565
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000566 /* Actually negotiate SSL connection */
567 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000568 do {
Bill Janssen6e027db2007-11-15 22:23:56 +0000569 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000570 ret = SSL_do_handshake(self->ssl);
571 err = SSL_get_error(self->ssl, ret);
572 PySSL_END_ALLOW_THREADS
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000573 if (PyErr_CheckSignals())
574 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000575 if (err == SSL_ERROR_WANT_READ) {
576 sockstate = check_socket_and_wait_for_timeout(sock, 0);
577 } else if (err == SSL_ERROR_WANT_WRITE) {
578 sockstate = check_socket_and_wait_for_timeout(sock, 1);
579 } else {
580 sockstate = SOCKET_OPERATION_OK;
581 }
582 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +0000583 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000584 ERRSTR("The handshake operation timed out"));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000585 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000586 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
587 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000588 ERRSTR("Underlying socket has been closed."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000589 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000590 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
591 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000592 ERRSTR("Underlying socket too large for select()."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000593 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000594 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
595 break;
596 }
597 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000598 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000599 if (ret < 1)
600 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Bill Janssen6e027db2007-11-15 22:23:56 +0000601
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000602 if (self->peer_cert)
603 X509_free (self->peer_cert);
604 PySSL_BEGIN_ALLOW_THREADS
605 self->peer_cert = SSL_get_peer_certificate(self->ssl);
606 PySSL_END_ALLOW_THREADS
Antoine Pitrou20b85552013-09-29 19:50:53 +0200607 self->handshake_done = 1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000608
609 Py_INCREF(Py_None);
610 return Py_None;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000611
612error:
613 Py_DECREF(sock);
614 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000615}
616
Thomas Woutersed03b412007-08-28 21:37:11 +0000617static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000618_create_tuple_for_attribute (ASN1_OBJECT *name, ASN1_STRING *value) {
Thomas Woutersed03b412007-08-28 21:37:11 +0000619
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000620 char namebuf[X509_NAME_MAXLEN];
621 int buflen;
622 PyObject *name_obj;
623 PyObject *value_obj;
624 PyObject *attr;
625 unsigned char *valuebuf = NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000626
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000627 buflen = OBJ_obj2txt(namebuf, sizeof(namebuf), name, 0);
628 if (buflen < 0) {
629 _setSSLError(NULL, 0, __FILE__, __LINE__);
630 goto fail;
631 }
632 name_obj = PyUnicode_FromStringAndSize(namebuf, buflen);
633 if (name_obj == NULL)
634 goto fail;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000635
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000636 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
637 if (buflen < 0) {
638 _setSSLError(NULL, 0, __FILE__, __LINE__);
639 Py_DECREF(name_obj);
640 goto fail;
641 }
642 value_obj = PyUnicode_DecodeUTF8((char *) valuebuf,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000643 buflen, "strict");
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000644 OPENSSL_free(valuebuf);
645 if (value_obj == NULL) {
646 Py_DECREF(name_obj);
647 goto fail;
648 }
649 attr = PyTuple_New(2);
650 if (attr == NULL) {
651 Py_DECREF(name_obj);
652 Py_DECREF(value_obj);
653 goto fail;
654 }
655 PyTuple_SET_ITEM(attr, 0, name_obj);
656 PyTuple_SET_ITEM(attr, 1, value_obj);
657 return attr;
Thomas Woutersed03b412007-08-28 21:37:11 +0000658
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000659 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000660 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000661}
662
663static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000664_create_tuple_for_X509_NAME (X509_NAME *xname)
Thomas Woutersed03b412007-08-28 21:37:11 +0000665{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000666 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
667 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
668 PyObject *rdnt;
669 PyObject *attr = NULL; /* tuple to hold an attribute */
670 int entry_count = X509_NAME_entry_count(xname);
671 X509_NAME_ENTRY *entry;
672 ASN1_OBJECT *name;
673 ASN1_STRING *value;
674 int index_counter;
675 int rdn_level = -1;
676 int retcode;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000677
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000678 dn = PyList_New(0);
679 if (dn == NULL)
680 return NULL;
681 /* now create another tuple to hold the top-level RDN */
682 rdn = PyList_New(0);
683 if (rdn == NULL)
684 goto fail0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000685
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000686 for (index_counter = 0;
687 index_counter < entry_count;
688 index_counter++)
689 {
690 entry = X509_NAME_get_entry(xname, index_counter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000691
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000692 /* check to see if we've gotten to a new RDN */
693 if (rdn_level >= 0) {
694 if (rdn_level != entry->set) {
695 /* yes, new RDN */
696 /* add old RDN to DN */
697 rdnt = PyList_AsTuple(rdn);
698 Py_DECREF(rdn);
699 if (rdnt == NULL)
700 goto fail0;
701 retcode = PyList_Append(dn, rdnt);
702 Py_DECREF(rdnt);
703 if (retcode < 0)
704 goto fail0;
705 /* create new RDN */
706 rdn = PyList_New(0);
707 if (rdn == NULL)
708 goto fail0;
709 }
710 }
711 rdn_level = entry->set;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000712
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000713 /* now add this attribute to the current RDN */
714 name = X509_NAME_ENTRY_get_object(entry);
715 value = X509_NAME_ENTRY_get_data(entry);
716 attr = _create_tuple_for_attribute(name, value);
717 /*
718 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
719 entry->set,
720 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
721 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
722 */
723 if (attr == NULL)
724 goto fail1;
725 retcode = PyList_Append(rdn, attr);
726 Py_DECREF(attr);
727 if (retcode < 0)
728 goto fail1;
729 }
730 /* now, there's typically a dangling RDN */
Antoine Pitrou2f5a1632012-02-15 22:25:27 +0100731 if (rdn != NULL) {
732 if (PyList_GET_SIZE(rdn) > 0) {
733 rdnt = PyList_AsTuple(rdn);
734 Py_DECREF(rdn);
735 if (rdnt == NULL)
736 goto fail0;
737 retcode = PyList_Append(dn, rdnt);
738 Py_DECREF(rdnt);
739 if (retcode < 0)
740 goto fail0;
741 }
742 else {
743 Py_DECREF(rdn);
744 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000745 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000746
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000747 /* convert list to tuple */
748 rdnt = PyList_AsTuple(dn);
749 Py_DECREF(dn);
750 if (rdnt == NULL)
751 return NULL;
752 return rdnt;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753
754 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000755 Py_XDECREF(rdn);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000756
757 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000758 Py_XDECREF(dn);
759 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000760}
761
762static PyObject *
763_get_peer_alt_names (X509 *certificate) {
Guido van Rossumf06628b2007-11-21 20:01:53 +0000764
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000765 /* this code follows the procedure outlined in
766 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
767 function to extract the STACK_OF(GENERAL_NAME),
768 then iterates through the stack to add the
769 names. */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000770
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000771 int i, j;
772 PyObject *peer_alt_names = Py_None;
Christian Heimes60bf2fc2013-09-05 16:04:35 +0200773 PyObject *v = NULL, *t;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000774 X509_EXTENSION *ext = NULL;
775 GENERAL_NAMES *names = NULL;
776 GENERAL_NAME *name;
Benjamin Petersoneb1410f2010-10-13 22:06:39 +0000777 const X509V3_EXT_METHOD *method;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000778 BIO *biobuf = NULL;
779 char buf[2048];
780 char *vptr;
781 int len;
782 /* Issue #2973: ASN1_item_d2i() API changed in OpenSSL 0.9.6m */
Victor Stinner7124a412010-03-02 22:48:17 +0000783#if OPENSSL_VERSION_NUMBER >= 0x009060dfL
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000784 const unsigned char *p;
Victor Stinner7124a412010-03-02 22:48:17 +0000785#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000786 unsigned char *p;
Victor Stinner7124a412010-03-02 22:48:17 +0000787#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000788
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000789 if (certificate == NULL)
790 return peer_alt_names;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000791
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000792 /* get a memory buffer */
793 biobuf = BIO_new(BIO_s_mem());
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000794
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200795 i = -1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000796 while ((i = X509_get_ext_by_NID(
797 certificate, NID_subject_alt_name, i)) >= 0) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000798
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000799 if (peer_alt_names == Py_None) {
800 peer_alt_names = PyList_New(0);
801 if (peer_alt_names == NULL)
802 goto fail;
803 }
Guido van Rossumf06628b2007-11-21 20:01:53 +0000804
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000805 /* now decode the altName */
806 ext = X509_get_ext(certificate, i);
807 if(!(method = X509V3_EXT_get(ext))) {
808 PyErr_SetString
809 (PySSLErrorObject,
810 ERRSTR("No method for internalizing subjectAltName!"));
811 goto fail;
812 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000813
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000814 p = ext->value->data;
815 if (method->it)
816 names = (GENERAL_NAMES*)
817 (ASN1_item_d2i(NULL,
818 &p,
819 ext->value->length,
820 ASN1_ITEM_ptr(method->it)));
821 else
822 names = (GENERAL_NAMES*)
823 (method->d2i(NULL,
824 &p,
825 ext->value->length));
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000826
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000827 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000828 /* get a rendering of each name in the set of names */
Christian Heimes824f7f32013-08-17 00:54:47 +0200829 int gntype;
830 ASN1_STRING *as = NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000831
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000832 name = sk_GENERAL_NAME_value(names, j);
Christian Heimes474afdd2013-08-17 17:18:56 +0200833 gntype = name->type;
Christian Heimes824f7f32013-08-17 00:54:47 +0200834 switch (gntype) {
835 case GEN_DIRNAME:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000836 /* we special-case DirName as a tuple of
837 tuples of attributes */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000839 t = PyTuple_New(2);
840 if (t == NULL) {
841 goto fail;
842 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000843
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000844 v = PyUnicode_FromString("DirName");
845 if (v == NULL) {
846 Py_DECREF(t);
847 goto fail;
848 }
849 PyTuple_SET_ITEM(t, 0, v);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000850
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000851 v = _create_tuple_for_X509_NAME (name->d.dirn);
852 if (v == NULL) {
853 Py_DECREF(t);
854 goto fail;
855 }
856 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200857 break;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000858
Christian Heimes824f7f32013-08-17 00:54:47 +0200859 case GEN_EMAIL:
860 case GEN_DNS:
861 case GEN_URI:
862 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
863 correctly, CVE-2013-4238 */
864 t = PyTuple_New(2);
865 if (t == NULL)
866 goto fail;
867 switch (gntype) {
868 case GEN_EMAIL:
869 v = PyUnicode_FromString("email");
870 as = name->d.rfc822Name;
871 break;
872 case GEN_DNS:
873 v = PyUnicode_FromString("DNS");
874 as = name->d.dNSName;
875 break;
876 case GEN_URI:
877 v = PyUnicode_FromString("URI");
878 as = name->d.uniformResourceIdentifier;
879 break;
880 }
881 if (v == NULL) {
882 Py_DECREF(t);
883 goto fail;
884 }
885 PyTuple_SET_ITEM(t, 0, v);
886 v = PyUnicode_FromStringAndSize((char *)ASN1_STRING_data(as),
887 ASN1_STRING_length(as));
888 if (v == NULL) {
889 Py_DECREF(t);
890 goto fail;
891 }
892 PyTuple_SET_ITEM(t, 1, v);
893 break;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000894
Christian Heimes824f7f32013-08-17 00:54:47 +0200895 default:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000896 /* for everything else, we use the OpenSSL print form */
Christian Heimes824f7f32013-08-17 00:54:47 +0200897 switch (gntype) {
898 /* check for new general name type */
899 case GEN_OTHERNAME:
900 case GEN_X400:
901 case GEN_EDIPARTY:
902 case GEN_IPADD:
903 case GEN_RID:
904 break;
905 default:
906 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
907 "Unknown general name type %d",
908 gntype) == -1) {
909 goto fail;
910 }
911 break;
912 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000913 (void) BIO_reset(biobuf);
914 GENERAL_NAME_print(biobuf, name);
915 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
916 if (len < 0) {
917 _setSSLError(NULL, 0, __FILE__, __LINE__);
918 goto fail;
919 }
920 vptr = strchr(buf, ':');
921 if (vptr == NULL)
922 goto fail;
923 t = PyTuple_New(2);
924 if (t == NULL)
925 goto fail;
926 v = PyUnicode_FromStringAndSize(buf, (vptr - buf));
927 if (v == NULL) {
928 Py_DECREF(t);
929 goto fail;
930 }
931 PyTuple_SET_ITEM(t, 0, v);
932 v = PyUnicode_FromStringAndSize((vptr + 1),
933 (len - (vptr - buf + 1)));
934 if (v == NULL) {
935 Py_DECREF(t);
936 goto fail;
937 }
938 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200939 break;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000940 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000941
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000942 /* and add that rendering to the list */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000943
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000944 if (PyList_Append(peer_alt_names, t) < 0) {
945 Py_DECREF(t);
946 goto fail;
947 }
948 Py_DECREF(t);
949 }
Antoine Pitrou116d6b92011-11-23 01:39:19 +0100950 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000951 }
952 BIO_free(biobuf);
953 if (peer_alt_names != Py_None) {
954 v = PyList_AsTuple(peer_alt_names);
955 Py_DECREF(peer_alt_names);
956 return v;
957 } else {
958 return peer_alt_names;
959 }
Guido van Rossumf06628b2007-11-21 20:01:53 +0000960
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000961
962 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000963 if (biobuf != NULL)
964 BIO_free(biobuf);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000965
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000966 if (peer_alt_names != Py_None) {
967 Py_XDECREF(peer_alt_names);
968 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000969
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000970 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000971}
972
973static PyObject *
Christian Heimesbd3a7f92013-11-21 03:40:15 +0100974_get_aia_uri(X509 *certificate, int nid) {
975 PyObject *lst = NULL, *ostr = NULL;
976 int i, result;
977 AUTHORITY_INFO_ACCESS *info;
978
979 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
980 if ((info == NULL) || (sk_ACCESS_DESCRIPTION_num(info) == 0)) {
981 return Py_None;
982 }
983
984 if ((lst = PyList_New(0)) == NULL) {
985 goto fail;
986 }
987
988 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
989 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
990 ASN1_IA5STRING *uri;
991
992 if ((OBJ_obj2nid(ad->method) != nid) ||
993 (ad->location->type != GEN_URI)) {
994 continue;
995 }
996 uri = ad->location->d.uniformResourceIdentifier;
997 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
998 uri->length);
999 if (ostr == NULL) {
1000 goto fail;
1001 }
1002 result = PyList_Append(lst, ostr);
1003 Py_DECREF(ostr);
1004 if (result < 0) {
1005 goto fail;
1006 }
1007 }
1008 AUTHORITY_INFO_ACCESS_free(info);
1009
1010 /* convert to tuple or None */
1011 if (PyList_Size(lst) == 0) {
1012 Py_DECREF(lst);
1013 return Py_None;
1014 } else {
1015 PyObject *tup;
1016 tup = PyList_AsTuple(lst);
1017 Py_DECREF(lst);
1018 return tup;
1019 }
1020
1021 fail:
1022 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimes18fc7be2013-11-21 23:57:49 +01001023 Py_XDECREF(lst);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001024 return NULL;
1025}
1026
1027static PyObject *
1028_get_crl_dp(X509 *certificate) {
1029 STACK_OF(DIST_POINT) *dps;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001030 int i, j;
1031 PyObject *lst, *res = NULL;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001032
Christian Heimes949ec142013-11-21 16:26:51 +01001033#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001034 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points, NULL, NULL);
Christian Heimes949ec142013-11-21 16:26:51 +01001035#else
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001036 /* Calls x509v3_cache_extensions and sets up crldp */
1037 X509_check_ca(certificate);
1038 dps = certificate->crldp;
Christian Heimes949ec142013-11-21 16:26:51 +01001039#endif
1040
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001041 if (dps == NULL)
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001042 return Py_None;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001043
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001044 lst = PyList_New(0);
1045 if (lst == NULL)
1046 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001047
1048 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1049 DIST_POINT *dp;
1050 STACK_OF(GENERAL_NAME) *gns;
1051
1052 dp = sk_DIST_POINT_value(dps, i);
1053 gns = dp->distpoint->name.fullname;
1054
1055 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1056 GENERAL_NAME *gn;
1057 ASN1_IA5STRING *uri;
1058 PyObject *ouri;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001059 int err;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001060
1061 gn = sk_GENERAL_NAME_value(gns, j);
1062 if (gn->type != GEN_URI) {
1063 continue;
1064 }
1065 uri = gn->d.uniformResourceIdentifier;
1066 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1067 uri->length);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001068 if (ouri == NULL)
1069 goto done;
1070
1071 err = PyList_Append(lst, ouri);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001072 Py_DECREF(ouri);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001073 if (err < 0)
1074 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001075 }
1076 }
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001077
1078 /* Convert to tuple. */
1079 res = (PyList_GET_SIZE(lst) > 0) ? PyList_AsTuple(lst) : Py_None;
1080
1081 done:
1082 Py_XDECREF(lst);
1083#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Peterson806fb252015-11-14 00:09:22 -08001084 sk_DIST_POINT_free(dps);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001085#endif
1086 return res;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001087}
1088
1089static PyObject *
Antoine Pitroufb046912010-11-09 20:21:19 +00001090_decode_certificate(X509 *certificate) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001091
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001092 PyObject *retval = NULL;
1093 BIO *biobuf = NULL;
1094 PyObject *peer;
1095 PyObject *peer_alt_names = NULL;
1096 PyObject *issuer;
1097 PyObject *version;
1098 PyObject *sn_obj;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001099 PyObject *obj;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001100 ASN1_INTEGER *serialNumber;
1101 char buf[2048];
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001102 int len, result;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001103 ASN1_TIME *notBefore, *notAfter;
1104 PyObject *pnotBefore, *pnotAfter;
Thomas Woutersed03b412007-08-28 21:37:11 +00001105
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001106 retval = PyDict_New();
1107 if (retval == NULL)
1108 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001109
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001110 peer = _create_tuple_for_X509_NAME(
1111 X509_get_subject_name(certificate));
1112 if (peer == NULL)
1113 goto fail0;
1114 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1115 Py_DECREF(peer);
1116 goto fail0;
1117 }
1118 Py_DECREF(peer);
Thomas Woutersed03b412007-08-28 21:37:11 +00001119
Antoine Pitroufb046912010-11-09 20:21:19 +00001120 issuer = _create_tuple_for_X509_NAME(
1121 X509_get_issuer_name(certificate));
1122 if (issuer == NULL)
1123 goto fail0;
1124 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001125 Py_DECREF(issuer);
Antoine Pitroufb046912010-11-09 20:21:19 +00001126 goto fail0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001127 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001128 Py_DECREF(issuer);
1129
1130 version = PyLong_FromLong(X509_get_version(certificate) + 1);
Christian Heimes5962bef2013-07-26 15:51:18 +02001131 if (version == NULL)
1132 goto fail0;
Antoine Pitroufb046912010-11-09 20:21:19 +00001133 if (PyDict_SetItemString(retval, "version", version) < 0) {
1134 Py_DECREF(version);
1135 goto fail0;
1136 }
1137 Py_DECREF(version);
Guido van Rossumf06628b2007-11-21 20:01:53 +00001138
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001139 /* get a memory buffer */
1140 biobuf = BIO_new(BIO_s_mem());
Guido van Rossumf06628b2007-11-21 20:01:53 +00001141
Antoine Pitroufb046912010-11-09 20:21:19 +00001142 (void) BIO_reset(biobuf);
1143 serialNumber = X509_get_serialNumber(certificate);
1144 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1145 i2a_ASN1_INTEGER(biobuf, serialNumber);
1146 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1147 if (len < 0) {
1148 _setSSLError(NULL, 0, __FILE__, __LINE__);
1149 goto fail1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001150 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001151 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1152 if (sn_obj == NULL)
1153 goto fail1;
1154 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1155 Py_DECREF(sn_obj);
1156 goto fail1;
1157 }
1158 Py_DECREF(sn_obj);
1159
1160 (void) BIO_reset(biobuf);
1161 notBefore = X509_get_notBefore(certificate);
1162 ASN1_TIME_print(biobuf, notBefore);
1163 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1164 if (len < 0) {
1165 _setSSLError(NULL, 0, __FILE__, __LINE__);
1166 goto fail1;
1167 }
1168 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1169 if (pnotBefore == NULL)
1170 goto fail1;
1171 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1172 Py_DECREF(pnotBefore);
1173 goto fail1;
1174 }
1175 Py_DECREF(pnotBefore);
Thomas Woutersed03b412007-08-28 21:37:11 +00001176
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001177 (void) BIO_reset(biobuf);
1178 notAfter = X509_get_notAfter(certificate);
1179 ASN1_TIME_print(biobuf, notAfter);
1180 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1181 if (len < 0) {
1182 _setSSLError(NULL, 0, __FILE__, __LINE__);
1183 goto fail1;
1184 }
1185 pnotAfter = PyUnicode_FromStringAndSize(buf, len);
1186 if (pnotAfter == NULL)
1187 goto fail1;
1188 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1189 Py_DECREF(pnotAfter);
1190 goto fail1;
1191 }
1192 Py_DECREF(pnotAfter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001193
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001194 /* Now look for subjectAltName */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001195
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001196 peer_alt_names = _get_peer_alt_names(certificate);
1197 if (peer_alt_names == NULL)
1198 goto fail1;
1199 else if (peer_alt_names != Py_None) {
1200 if (PyDict_SetItemString(retval, "subjectAltName",
1201 peer_alt_names) < 0) {
1202 Py_DECREF(peer_alt_names);
1203 goto fail1;
1204 }
1205 Py_DECREF(peer_alt_names);
1206 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001207
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001208 /* Authority Information Access: OCSP URIs */
1209 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1210 if (obj == NULL) {
1211 goto fail1;
1212 } else if (obj != Py_None) {
1213 result = PyDict_SetItemString(retval, "OCSP", obj);
1214 Py_DECREF(obj);
1215 if (result < 0) {
1216 goto fail1;
1217 }
1218 }
1219
1220 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1221 if (obj == NULL) {
1222 goto fail1;
1223 } else if (obj != Py_None) {
1224 result = PyDict_SetItemString(retval, "caIssuers", obj);
1225 Py_DECREF(obj);
1226 if (result < 0) {
1227 goto fail1;
1228 }
1229 }
1230
1231 /* CDP (CRL distribution points) */
1232 obj = _get_crl_dp(certificate);
1233 if (obj == NULL) {
1234 goto fail1;
1235 } else if (obj != Py_None) {
1236 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1237 Py_DECREF(obj);
1238 if (result < 0) {
1239 goto fail1;
1240 }
1241 }
1242
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001243 BIO_free(biobuf);
1244 return retval;
Thomas Woutersed03b412007-08-28 21:37:11 +00001245
1246 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001247 if (biobuf != NULL)
1248 BIO_free(biobuf);
Thomas Woutersed03b412007-08-28 21:37:11 +00001249 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001250 Py_XDECREF(retval);
1251 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001252}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001253
Christian Heimes9a5395a2013-06-17 15:44:12 +02001254static PyObject *
1255_certificate_to_der(X509 *certificate)
1256{
1257 unsigned char *bytes_buf = NULL;
1258 int len;
1259 PyObject *retval;
1260
1261 bytes_buf = NULL;
1262 len = i2d_X509(certificate, &bytes_buf);
1263 if (len < 0) {
1264 _setSSLError(NULL, 0, __FILE__, __LINE__);
1265 return NULL;
1266 }
1267 /* this is actually an immutable bytes sequence */
1268 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1269 OPENSSL_free(bytes_buf);
1270 return retval;
1271}
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001272
1273static PyObject *
1274PySSL_test_decode_certificate (PyObject *mod, PyObject *args) {
1275
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001276 PyObject *retval = NULL;
Victor Stinner3800e1e2010-05-16 21:23:48 +00001277 PyObject *filename;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001278 X509 *x=NULL;
1279 BIO *cert;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001280
Antoine Pitroufb046912010-11-09 20:21:19 +00001281 if (!PyArg_ParseTuple(args, "O&:test_decode_certificate",
1282 PyUnicode_FSConverter, &filename))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001283 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001284
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001285 if ((cert=BIO_new(BIO_s_file())) == NULL) {
1286 PyErr_SetString(PySSLErrorObject,
1287 "Can't malloc memory to read file");
1288 goto fail0;
1289 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001290
Victor Stinner3800e1e2010-05-16 21:23:48 +00001291 if (BIO_read_filename(cert, PyBytes_AsString(filename)) <= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001292 PyErr_SetString(PySSLErrorObject,
1293 "Can't open file");
1294 goto fail0;
1295 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001296
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001297 x = PEM_read_bio_X509_AUX(cert,NULL, NULL, NULL);
1298 if (x == NULL) {
1299 PyErr_SetString(PySSLErrorObject,
1300 "Error decoding PEM-encoded file");
1301 goto fail0;
1302 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001303
Antoine Pitroufb046912010-11-09 20:21:19 +00001304 retval = _decode_certificate(x);
Mark Dickinsonee55df52010-08-03 18:31:54 +00001305 X509_free(x);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001306
1307 fail0:
Victor Stinner3800e1e2010-05-16 21:23:48 +00001308 Py_DECREF(filename);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001309 if (cert != NULL) BIO_free(cert);
1310 return retval;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001311}
1312
1313
1314static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00001315PySSL_peercert(PySSLSocket *self, PyObject *args)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001316{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001317 int verification;
Antoine Pitrou721738f2012-08-15 23:20:39 +02001318 int binary_mode = 0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319
Antoine Pitrou721738f2012-08-15 23:20:39 +02001320 if (!PyArg_ParseTuple(args, "|p:peer_certificate", &binary_mode))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001321 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001322
Antoine Pitrou20b85552013-09-29 19:50:53 +02001323 if (!self->handshake_done) {
1324 PyErr_SetString(PyExc_ValueError,
1325 "handshake not done yet");
1326 return NULL;
1327 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001328 if (!self->peer_cert)
1329 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001330
Antoine Pitrou721738f2012-08-15 23:20:39 +02001331 if (binary_mode) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001332 /* return cert in DER-encoded format */
Christian Heimes9a5395a2013-06-17 15:44:12 +02001333 return _certificate_to_der(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001334 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00001335 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001336 if ((verification & SSL_VERIFY_PEER) == 0)
1337 return PyDict_New();
1338 else
Antoine Pitroufb046912010-11-09 20:21:19 +00001339 return _decode_certificate(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001340 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001341}
1342
1343PyDoc_STRVAR(PySSL_peercert_doc,
1344"peer_certificate([der=False]) -> certificate\n\
1345\n\
1346Returns the certificate for the peer. If no certificate was provided,\n\
1347returns None. If a certificate was provided, but not validated, returns\n\
1348an empty dictionary. Otherwise returns a dict containing information\n\
1349about the peer certificate.\n\
1350\n\
1351If the optional argument is True, returns a DER-encoded copy of the\n\
1352peer certificate, or None if no certificate was provided. This will\n\
1353return the certificate even if it wasn't validated.");
1354
Antoine Pitrou152efa22010-05-16 18:19:27 +00001355static PyObject *PySSL_cipher (PySSLSocket *self) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001356
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001357 PyObject *retval, *v;
Benjamin Petersoneb1410f2010-10-13 22:06:39 +00001358 const SSL_CIPHER *current;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001359 char *cipher_name;
1360 char *cipher_protocol;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001361
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001362 if (self->ssl == NULL)
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001363 Py_RETURN_NONE;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001364 current = SSL_get_current_cipher(self->ssl);
1365 if (current == NULL)
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001366 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001367
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001368 retval = PyTuple_New(3);
1369 if (retval == NULL)
1370 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001371
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001372 cipher_name = (char *) SSL_CIPHER_get_name(current);
1373 if (cipher_name == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001374 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001375 PyTuple_SET_ITEM(retval, 0, Py_None);
1376 } else {
1377 v = PyUnicode_FromString(cipher_name);
1378 if (v == NULL)
1379 goto fail0;
1380 PyTuple_SET_ITEM(retval, 0, v);
1381 }
Gregory P. Smithf3489092014-01-17 12:08:49 -08001382 cipher_protocol = (char *) SSL_CIPHER_get_version(current);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001383 if (cipher_protocol == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001384 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001385 PyTuple_SET_ITEM(retval, 1, Py_None);
1386 } else {
1387 v = PyUnicode_FromString(cipher_protocol);
1388 if (v == NULL)
1389 goto fail0;
1390 PyTuple_SET_ITEM(retval, 1, v);
1391 }
1392 v = PyLong_FromLong(SSL_CIPHER_get_bits(current, NULL));
1393 if (v == NULL)
1394 goto fail0;
1395 PyTuple_SET_ITEM(retval, 2, v);
1396 return retval;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001397
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001398 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001399 Py_DECREF(retval);
1400 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001401}
1402
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001403#ifdef OPENSSL_NPN_NEGOTIATED
1404static PyObject *PySSL_selected_npn_protocol(PySSLSocket *self) {
1405 const unsigned char *out;
1406 unsigned int outlen;
1407
Victor Stinner4569cd52013-06-23 14:58:43 +02001408 SSL_get0_next_proto_negotiated(self->ssl,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001409 &out, &outlen);
1410
1411 if (out == NULL)
1412 Py_RETURN_NONE;
1413 return PyUnicode_FromStringAndSize((char *) out, outlen);
1414}
1415#endif
1416
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001417static PyObject *PySSL_compression(PySSLSocket *self) {
1418#ifdef OPENSSL_NO_COMP
1419 Py_RETURN_NONE;
1420#else
1421 const COMP_METHOD *comp_method;
1422 const char *short_name;
1423
1424 if (self->ssl == NULL)
1425 Py_RETURN_NONE;
1426 comp_method = SSL_get_current_compression(self->ssl);
1427 if (comp_method == NULL || comp_method->type == NID_undef)
1428 Py_RETURN_NONE;
1429 short_name = OBJ_nid2sn(comp_method->type);
1430 if (short_name == NULL)
1431 Py_RETURN_NONE;
1432 return PyUnicode_DecodeFSDefault(short_name);
1433#endif
1434}
1435
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001436static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
1437 Py_INCREF(self->ctx);
1438 return self->ctx;
1439}
1440
1441static int PySSL_set_context(PySSLSocket *self, PyObject *value,
1442 void *closure) {
1443
1444 if (PyObject_TypeCheck(value, &PySSLContext_Type)) {
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001445#if !HAVE_SNI
1446 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
1447 "context is not supported by your OpenSSL library");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01001448 return -1;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001449#else
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001450 Py_INCREF(value);
1451 Py_DECREF(self->ctx);
1452 self->ctx = (PySSLContext *) value;
1453 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001454#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001455 } else {
1456 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
1457 return -1;
1458 }
1459
1460 return 0;
1461}
1462
1463PyDoc_STRVAR(PySSL_set_context_doc,
1464"_setter_context(ctx)\n\
1465\
1466This changes the context associated with the SSLSocket. This is typically\n\
1467used from within a callback function set by the set_servername_callback\n\
1468on the SSLContext to change the certificate information associated with the\n\
1469SSLSocket before the cryptographic exchange handshake messages\n");
1470
1471
1472
Antoine Pitrou152efa22010-05-16 18:19:27 +00001473static void PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001474{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001475 if (self->peer_cert) /* Possible not to have one? */
1476 X509_free (self->peer_cert);
1477 if (self->ssl)
1478 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001479 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001480 Py_XDECREF(self->ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001481 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001482}
1483
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001484/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001485 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001486 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001487 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001488
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001489static int
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001490check_socket_and_wait_for_timeout(PySocketSockObject *s, int writing)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001491{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001492 fd_set fds;
1493 struct timeval tv;
1494 int rc;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001495
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001496 /* Nothing to do unless we're in timeout mode (not non-blocking) */
1497 if (s->sock_timeout < 0.0)
1498 return SOCKET_IS_BLOCKING;
1499 else if (s->sock_timeout == 0.0)
1500 return SOCKET_IS_NONBLOCKING;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001501
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001502 /* Guard against closed socket */
1503 if (s->sock_fd < 0)
1504 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001505
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001506 /* Prefer poll, if available, since you can poll() any fd
1507 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001508#ifdef HAVE_POLL
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001509 {
1510 struct pollfd pollfd;
1511 int timeout;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001512
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001513 pollfd.fd = s->sock_fd;
1514 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001515
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001516 /* s->sock_timeout is in seconds, timeout in ms */
1517 timeout = (int)(s->sock_timeout * 1000 + 0.5);
1518 PySSL_BEGIN_ALLOW_THREADS
1519 rc = poll(&pollfd, 1, timeout);
1520 PySSL_END_ALLOW_THREADS
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001521
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001522 goto normal_return;
1523 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001524#endif
1525
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001526 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02001527 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001528 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00001529
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001530 /* Construct the arguments to select */
1531 tv.tv_sec = (int)s->sock_timeout;
1532 tv.tv_usec = (int)((s->sock_timeout - tv.tv_sec) * 1e6);
1533 FD_ZERO(&fds);
1534 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001535
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001536 /* See if the socket is ready */
1537 PySSL_BEGIN_ALLOW_THREADS
1538 if (writing)
Christian Heimesb08ff7d2013-11-18 10:04:07 +01001539 rc = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
1540 NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001541 else
Christian Heimesb08ff7d2013-11-18 10:04:07 +01001542 rc = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
1543 &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001544 PySSL_END_ALLOW_THREADS
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001545
Bill Janssen6e027db2007-11-15 22:23:56 +00001546#ifdef HAVE_POLL
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001547normal_return:
Bill Janssen6e027db2007-11-15 22:23:56 +00001548#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001549 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
1550 (when we are able to write or when there's something to read) */
1551 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001552}
1553
Antoine Pitrou152efa22010-05-16 18:19:27 +00001554static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001555{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001556 Py_buffer buf;
1557 int len;
1558 int sockstate;
1559 int err;
1560 int nonblocking;
1561 PySocketSockObject *sock
1562 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen54cc54c2007-12-14 22:08:56 +00001563
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001564 if (((PyObject*)sock) == Py_None) {
1565 _setSSLError("Underlying socket connection gone",
1566 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1567 return NULL;
1568 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001569 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001570
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001571 if (!PyArg_ParseTuple(args, "y*:write", &buf)) {
1572 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001573 return NULL;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001574 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001575
Victor Stinner6efa9652013-06-25 00:42:31 +02001576 if (buf.len > INT_MAX) {
1577 PyErr_Format(PyExc_OverflowError,
1578 "string longer than %d bytes", INT_MAX);
1579 goto error;
1580 }
1581
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001582 /* just in case the blocking state of the socket has been changed */
1583 nonblocking = (sock->sock_timeout >= 0.0);
1584 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1585 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1586
1587 sockstate = check_socket_and_wait_for_timeout(sock, 1);
1588 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001589 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001590 "The write operation timed out");
1591 goto error;
1592 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1593 PyErr_SetString(PySSLErrorObject,
1594 "Underlying socket has been closed.");
1595 goto error;
1596 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1597 PyErr_SetString(PySSLErrorObject,
1598 "Underlying socket too large for select().");
1599 goto error;
1600 }
1601 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001602 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner6efa9652013-06-25 00:42:31 +02001603 len = SSL_write(self->ssl, buf.buf, (int)buf.len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001604 err = SSL_get_error(self->ssl, len);
1605 PySSL_END_ALLOW_THREADS
1606 if (PyErr_CheckSignals()) {
1607 goto error;
Bill Janssen54cc54c2007-12-14 22:08:56 +00001608 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001609 if (err == SSL_ERROR_WANT_READ) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001610 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001611 } else if (err == SSL_ERROR_WANT_WRITE) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001612 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001613 } else {
1614 sockstate = SOCKET_OPERATION_OK;
1615 }
1616 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001617 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001618 "The write operation timed out");
1619 goto error;
1620 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1621 PyErr_SetString(PySSLErrorObject,
1622 "Underlying socket has been closed.");
1623 goto error;
1624 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1625 break;
1626 }
1627 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001628
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001629 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001630 PyBuffer_Release(&buf);
1631 if (len > 0)
1632 return PyLong_FromLong(len);
1633 else
1634 return PySSL_SetError(self, len, __FILE__, __LINE__);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001635
1636error:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001637 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001638 PyBuffer_Release(&buf);
1639 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001640}
1641
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001642PyDoc_STRVAR(PySSL_SSLwrite_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001643"write(s) -> len\n\
1644\n\
1645Writes the string s into the SSL object. Returns the number\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001646of bytes written.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001647
Antoine Pitrou152efa22010-05-16 18:19:27 +00001648static PyObject *PySSL_SSLpending(PySSLSocket *self)
Bill Janssen6e027db2007-11-15 22:23:56 +00001649{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001650 int count = 0;
Bill Janssen6e027db2007-11-15 22:23:56 +00001651
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001652 PySSL_BEGIN_ALLOW_THREADS
1653 count = SSL_pending(self->ssl);
1654 PySSL_END_ALLOW_THREADS
1655 if (count < 0)
1656 return PySSL_SetError(self, count, __FILE__, __LINE__);
1657 else
1658 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00001659}
1660
1661PyDoc_STRVAR(PySSL_SSLpending_doc,
1662"pending() -> count\n\
1663\n\
1664Returns the number of already decrypted bytes available for read,\n\
1665pending on the connection.\n");
1666
Antoine Pitrou152efa22010-05-16 18:19:27 +00001667static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001668{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001669 PyObject *dest = NULL;
1670 Py_buffer buf;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001671 char *mem;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001672 int len, count;
1673 int buf_passed = 0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001674 int sockstate;
1675 int err;
1676 int nonblocking;
1677 PySocketSockObject *sock
1678 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen54cc54c2007-12-14 22:08:56 +00001679
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001680 if (((PyObject*)sock) == Py_None) {
1681 _setSSLError("Underlying socket connection gone",
1682 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1683 return NULL;
1684 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001685 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001686
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001687 buf.obj = NULL;
1688 buf.buf = NULL;
1689 if (!PyArg_ParseTuple(args, "i|w*:read", &len, &buf))
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001690 goto error;
1691
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001692 if ((buf.buf == NULL) && (buf.obj == NULL)) {
1693 dest = PyBytes_FromStringAndSize(NULL, len);
1694 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001695 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001696 mem = PyBytes_AS_STRING(dest);
1697 }
1698 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001699 buf_passed = 1;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001700 mem = buf.buf;
1701 if (len <= 0 || len > buf.len) {
1702 len = (int) buf.len;
1703 if (buf.len != len) {
1704 PyErr_SetString(PyExc_OverflowError,
1705 "maximum length can't fit in a C 'int'");
1706 goto error;
1707 }
1708 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001709 }
1710
1711 /* just in case the blocking state of the socket has been changed */
1712 nonblocking = (sock->sock_timeout >= 0.0);
1713 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1714 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1715
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001716 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001717 PySSL_BEGIN_ALLOW_THREADS
1718 count = SSL_read(self->ssl, mem, len);
1719 err = SSL_get_error(self->ssl, count);
1720 PySSL_END_ALLOW_THREADS
1721 if (PyErr_CheckSignals())
1722 goto error;
1723 if (err == SSL_ERROR_WANT_READ) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001724 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001725 } else if (err == SSL_ERROR_WANT_WRITE) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001726 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001727 } else if ((err == SSL_ERROR_ZERO_RETURN) &&
1728 (SSL_get_shutdown(self->ssl) ==
1729 SSL_RECEIVED_SHUTDOWN))
1730 {
1731 count = 0;
1732 goto done;
1733 } else {
1734 sockstate = SOCKET_OPERATION_OK;
1735 }
1736 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001737 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001738 "The read operation timed out");
1739 goto error;
1740 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1741 break;
1742 }
1743 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
1744 if (count <= 0) {
1745 PySSL_SetError(self, count, __FILE__, __LINE__);
1746 goto error;
1747 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001748
1749done:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001750 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001751 if (!buf_passed) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001752 _PyBytes_Resize(&dest, count);
1753 return dest;
1754 }
1755 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001756 PyBuffer_Release(&buf);
1757 return PyLong_FromLong(count);
1758 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001759
1760error:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001761 Py_DECREF(sock);
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001762 if (!buf_passed)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001763 Py_XDECREF(dest);
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001764 else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001765 PyBuffer_Release(&buf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001766 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001767}
1768
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001769PyDoc_STRVAR(PySSL_SSLread_doc,
Bill Janssen6e027db2007-11-15 22:23:56 +00001770"read([len]) -> string\n\
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001771\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001772Read up to len bytes from the SSL socket.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001773
Antoine Pitrou152efa22010-05-16 18:19:27 +00001774static PyObject *PySSL_SSLshutdown(PySSLSocket *self)
Bill Janssen40a0f662008-08-12 16:56:25 +00001775{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001776 int err, ssl_err, sockstate, nonblocking;
1777 int zeros = 0;
1778 PySocketSockObject *sock
1779 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen40a0f662008-08-12 16:56:25 +00001780
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001781 /* Guard against closed socket */
1782 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd < 0)) {
1783 _setSSLError("Underlying socket connection gone",
1784 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1785 return NULL;
1786 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001787 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001788
1789 /* Just in case the blocking state of the socket has been changed */
1790 nonblocking = (sock->sock_timeout >= 0.0);
1791 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1792 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1793
1794 while (1) {
1795 PySSL_BEGIN_ALLOW_THREADS
1796 /* Disable read-ahead so that unwrap can work correctly.
1797 * Otherwise OpenSSL might read in too much data,
1798 * eating clear text data that happens to be
1799 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03001800 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001801 * function is used and the shutdown_seen_zero != 0
1802 * condition is met.
1803 */
1804 if (self->shutdown_seen_zero)
1805 SSL_set_read_ahead(self->ssl, 0);
1806 err = SSL_shutdown(self->ssl);
1807 PySSL_END_ALLOW_THREADS
1808 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
1809 if (err > 0)
1810 break;
1811 if (err == 0) {
1812 /* Don't loop endlessly; instead preserve legacy
1813 behaviour of trying SSL_shutdown() only twice.
1814 This looks necessary for OpenSSL < 0.9.8m */
1815 if (++zeros > 1)
1816 break;
1817 /* Shutdown was sent, now try receiving */
1818 self->shutdown_seen_zero = 1;
1819 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00001820 }
1821
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001822 /* Possibly retry shutdown until timeout or failure */
1823 ssl_err = SSL_get_error(self->ssl, err);
1824 if (ssl_err == SSL_ERROR_WANT_READ)
1825 sockstate = check_socket_and_wait_for_timeout(sock, 0);
1826 else if (ssl_err == SSL_ERROR_WANT_WRITE)
1827 sockstate = check_socket_and_wait_for_timeout(sock, 1);
1828 else
1829 break;
1830 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1831 if (ssl_err == SSL_ERROR_WANT_READ)
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001832 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001833 "The read operation timed out");
1834 else
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001835 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001836 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001837 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001838 }
1839 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1840 PyErr_SetString(PySSLErrorObject,
1841 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001842 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001843 }
1844 else if (sockstate != SOCKET_OPERATION_OK)
1845 /* Retain the SSL error code */
1846 break;
1847 }
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +00001848
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001849 if (err < 0) {
1850 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001851 return PySSL_SetError(self, err, __FILE__, __LINE__);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001852 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001853 else
1854 /* It's already INCREF'ed */
1855 return (PyObject *) sock;
1856
1857error:
1858 Py_DECREF(sock);
1859 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00001860}
1861
1862PyDoc_STRVAR(PySSL_SSLshutdown_doc,
1863"shutdown(s) -> socket\n\
1864\n\
1865Does the SSL shutdown handshake with the remote end, and returns\n\
1866the underlying socket object.");
1867
Antoine Pitroud6494802011-07-21 01:11:30 +02001868#if HAVE_OPENSSL_FINISHED
1869static PyObject *
1870PySSL_tls_unique_cb(PySSLSocket *self)
1871{
1872 PyObject *retval = NULL;
1873 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02001874 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02001875
1876 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
1877 /* if session is resumed XOR we are the client */
1878 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1879 }
1880 else {
1881 /* if a new session XOR we are the server */
1882 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1883 }
1884
1885 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02001886 if (len == 0)
1887 Py_RETURN_NONE;
1888
1889 retval = PyBytes_FromStringAndSize(buf, len);
1890
1891 return retval;
1892}
1893
1894PyDoc_STRVAR(PySSL_tls_unique_cb_doc,
1895"tls_unique_cb() -> bytes\n\
1896\n\
1897Returns the 'tls-unique' channel binding data, as defined by RFC 5929.\n\
1898\n\
1899If the TLS handshake is not yet complete, None is returned");
1900
1901#endif /* HAVE_OPENSSL_FINISHED */
Bill Janssen40a0f662008-08-12 16:56:25 +00001902
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001903static PyGetSetDef ssl_getsetlist[] = {
1904 {"context", (getter) PySSL_get_context,
1905 (setter) PySSL_set_context, PySSL_set_context_doc},
1906 {NULL}, /* sentinel */
1907};
1908
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001909static PyMethodDef PySSLMethods[] = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001910 {"do_handshake", (PyCFunction)PySSL_SSLdo_handshake, METH_NOARGS},
1911 {"write", (PyCFunction)PySSL_SSLwrite, METH_VARARGS,
1912 PySSL_SSLwrite_doc},
1913 {"read", (PyCFunction)PySSL_SSLread, METH_VARARGS,
1914 PySSL_SSLread_doc},
1915 {"pending", (PyCFunction)PySSL_SSLpending, METH_NOARGS,
1916 PySSL_SSLpending_doc},
1917 {"peer_certificate", (PyCFunction)PySSL_peercert, METH_VARARGS,
1918 PySSL_peercert_doc},
1919 {"cipher", (PyCFunction)PySSL_cipher, METH_NOARGS},
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001920#ifdef OPENSSL_NPN_NEGOTIATED
1921 {"selected_npn_protocol", (PyCFunction)PySSL_selected_npn_protocol, METH_NOARGS},
1922#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001923 {"compression", (PyCFunction)PySSL_compression, METH_NOARGS},
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001924 {"shutdown", (PyCFunction)PySSL_SSLshutdown, METH_NOARGS,
1925 PySSL_SSLshutdown_doc},
Antoine Pitroud6494802011-07-21 01:11:30 +02001926#if HAVE_OPENSSL_FINISHED
1927 {"tls_unique_cb", (PyCFunction)PySSL_tls_unique_cb, METH_NOARGS,
1928 PySSL_tls_unique_cb_doc},
1929#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001930 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001931};
1932
Antoine Pitrou152efa22010-05-16 18:19:27 +00001933static PyTypeObject PySSLSocket_Type = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001934 PyVarObject_HEAD_INIT(NULL, 0)
Antoine Pitrou152efa22010-05-16 18:19:27 +00001935 "_ssl._SSLSocket", /*tp_name*/
1936 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001937 0, /*tp_itemsize*/
1938 /* methods */
1939 (destructor)PySSL_dealloc, /*tp_dealloc*/
1940 0, /*tp_print*/
1941 0, /*tp_getattr*/
1942 0, /*tp_setattr*/
1943 0, /*tp_reserved*/
1944 0, /*tp_repr*/
1945 0, /*tp_as_number*/
1946 0, /*tp_as_sequence*/
1947 0, /*tp_as_mapping*/
1948 0, /*tp_hash*/
1949 0, /*tp_call*/
1950 0, /*tp_str*/
1951 0, /*tp_getattro*/
1952 0, /*tp_setattro*/
1953 0, /*tp_as_buffer*/
1954 Py_TPFLAGS_DEFAULT, /*tp_flags*/
1955 0, /*tp_doc*/
1956 0, /*tp_traverse*/
1957 0, /*tp_clear*/
1958 0, /*tp_richcompare*/
1959 0, /*tp_weaklistoffset*/
1960 0, /*tp_iter*/
1961 0, /*tp_iternext*/
1962 PySSLMethods, /*tp_methods*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001963 0, /*tp_members*/
1964 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001965};
1966
Antoine Pitrou152efa22010-05-16 18:19:27 +00001967
1968/*
1969 * _SSLContext objects
1970 */
1971
1972static PyObject *
1973context_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1974{
1975 char *kwlist[] = {"protocol", NULL};
1976 PySSLContext *self;
1977 int proto_version = PY_SSL_VERSION_SSL23;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01001978 long options;
Antoine Pitrou152efa22010-05-16 18:19:27 +00001979 SSL_CTX *ctx = NULL;
1980
1981 if (!PyArg_ParseTupleAndKeywords(
1982 args, kwds, "i:_SSLContext", kwlist,
1983 &proto_version))
1984 return NULL;
1985
1986 PySSL_BEGIN_ALLOW_THREADS
1987 if (proto_version == PY_SSL_VERSION_TLS1)
1988 ctx = SSL_CTX_new(TLSv1_method());
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01001989#if HAVE_TLSv1_2
1990 else if (proto_version == PY_SSL_VERSION_TLS1_1)
1991 ctx = SSL_CTX_new(TLSv1_1_method());
1992 else if (proto_version == PY_SSL_VERSION_TLS1_2)
1993 ctx = SSL_CTX_new(TLSv1_2_method());
1994#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05001995#ifndef OPENSSL_NO_SSL3
Antoine Pitrou152efa22010-05-16 18:19:27 +00001996 else if (proto_version == PY_SSL_VERSION_SSL3)
1997 ctx = SSL_CTX_new(SSLv3_method());
Benjamin Petersone32467c2014-12-05 21:59:35 -05001998#endif
Victor Stinner3de49192011-05-09 00:42:58 +02001999#ifndef OPENSSL_NO_SSL2
Antoine Pitrou152efa22010-05-16 18:19:27 +00002000 else if (proto_version == PY_SSL_VERSION_SSL2)
2001 ctx = SSL_CTX_new(SSLv2_method());
Victor Stinner3de49192011-05-09 00:42:58 +02002002#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002003 else if (proto_version == PY_SSL_VERSION_SSL23)
2004 ctx = SSL_CTX_new(SSLv23_method());
2005 else
2006 proto_version = -1;
2007 PySSL_END_ALLOW_THREADS
2008
2009 if (proto_version == -1) {
2010 PyErr_SetString(PyExc_ValueError,
2011 "invalid protocol version");
2012 return NULL;
2013 }
2014 if (ctx == NULL) {
2015 PyErr_SetString(PySSLErrorObject,
2016 "failed to allocate SSL context");
2017 return NULL;
2018 }
2019
2020 assert(type != NULL && type->tp_alloc != NULL);
2021 self = (PySSLContext *) type->tp_alloc(type, 0);
2022 if (self == NULL) {
2023 SSL_CTX_free(ctx);
2024 return NULL;
2025 }
2026 self->ctx = ctx;
Christian Heimes5cb31c92012-09-20 12:42:54 +02002027#ifdef OPENSSL_NPN_NEGOTIATED
2028 self->npn_protocols = NULL;
2029#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002030#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +02002031 self->set_hostname = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002032#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01002033 /* Don't check host name by default */
2034 self->check_hostname = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002035 /* Defaults */
2036 SSL_CTX_set_verify(self->ctx, SSL_VERIFY_NONE, NULL);
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002037 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2038 if (proto_version != PY_SSL_VERSION_SSL2)
2039 options |= SSL_OP_NO_SSLv2;
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002040 if (proto_version != PY_SSL_VERSION_SSL3)
2041 options |= SSL_OP_NO_SSLv3;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002042 SSL_CTX_set_options(self->ctx, options);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002043
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01002044#ifndef OPENSSL_NO_ECDH
2045 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
2046 prime256v1 by default. This is Apache mod_ssl's initialization
2047 policy, so we should be safe. */
2048#if defined(SSL_CTX_set_ecdh_auto)
2049 SSL_CTX_set_ecdh_auto(self->ctx, 1);
2050#else
2051 {
2052 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
2053 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2054 EC_KEY_free(key);
2055 }
2056#endif
2057#endif
2058
Antoine Pitroufc113ee2010-10-13 12:46:13 +00002059#define SID_CTX "Python"
2060 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
2061 sizeof(SID_CTX));
2062#undef SID_CTX
2063
Benjamin Petersonfdb19712015-03-04 22:11:12 -05002064#ifdef X509_V_FLAG_TRUSTED_FIRST
2065 {
2066 /* Improve trust chain building when cross-signed intermediate
2067 certificates are present. See https://bugs.python.org/issue23476. */
2068 X509_STORE *store = SSL_CTX_get_cert_store(self->ctx);
2069 X509_STORE_set_flags(store, X509_V_FLAG_TRUSTED_FIRST);
2070 }
2071#endif
2072
Antoine Pitrou152efa22010-05-16 18:19:27 +00002073 return (PyObject *)self;
2074}
2075
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002076static int
2077context_traverse(PySSLContext *self, visitproc visit, void *arg)
2078{
2079#ifndef OPENSSL_NO_TLSEXT
2080 Py_VISIT(self->set_hostname);
2081#endif
2082 return 0;
2083}
2084
2085static int
2086context_clear(PySSLContext *self)
2087{
2088#ifndef OPENSSL_NO_TLSEXT
2089 Py_CLEAR(self->set_hostname);
2090#endif
2091 return 0;
2092}
2093
Antoine Pitrou152efa22010-05-16 18:19:27 +00002094static void
2095context_dealloc(PySSLContext *self)
2096{
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002097 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002098 SSL_CTX_free(self->ctx);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002099#ifdef OPENSSL_NPN_NEGOTIATED
2100 PyMem_Free(self->npn_protocols);
2101#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002102 Py_TYPE(self)->tp_free(self);
2103}
2104
2105static PyObject *
2106set_ciphers(PySSLContext *self, PyObject *args)
2107{
2108 int ret;
2109 const char *cipherlist;
2110
2111 if (!PyArg_ParseTuple(args, "s:set_ciphers", &cipherlist))
2112 return NULL;
2113 ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
2114 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00002115 /* Clearing the error queue is necessary on some OpenSSL versions,
2116 otherwise the error will be reported again when another SSL call
2117 is done. */
2118 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002119 PyErr_SetString(PySSLErrorObject,
2120 "No cipher can be selected.");
2121 return NULL;
2122 }
2123 Py_RETURN_NONE;
2124}
2125
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002126#ifdef OPENSSL_NPN_NEGOTIATED
2127/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
2128static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002129_advertiseNPN_cb(SSL *s,
2130 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002131 void *args)
2132{
2133 PySSLContext *ssl_ctx = (PySSLContext *) args;
2134
2135 if (ssl_ctx->npn_protocols == NULL) {
2136 *data = (unsigned char *) "";
2137 *len = 0;
2138 } else {
2139 *data = (unsigned char *) ssl_ctx->npn_protocols;
2140 *len = ssl_ctx->npn_protocols_len;
2141 }
2142
2143 return SSL_TLSEXT_ERR_OK;
2144}
2145/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
2146static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002147_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002148 unsigned char **out, unsigned char *outlen,
2149 const unsigned char *server, unsigned int server_len,
2150 void *args)
2151{
2152 PySSLContext *ssl_ctx = (PySSLContext *) args;
2153
2154 unsigned char *client = (unsigned char *) ssl_ctx->npn_protocols;
2155 int client_len;
2156
2157 if (client == NULL) {
2158 client = (unsigned char *) "";
2159 client_len = 0;
2160 } else {
2161 client_len = ssl_ctx->npn_protocols_len;
2162 }
2163
2164 SSL_select_next_proto(out, outlen,
2165 server, server_len,
2166 client, client_len);
2167
2168 return SSL_TLSEXT_ERR_OK;
2169}
2170#endif
2171
2172static PyObject *
2173_set_npn_protocols(PySSLContext *self, PyObject *args)
2174{
2175#ifdef OPENSSL_NPN_NEGOTIATED
2176 Py_buffer protos;
2177
2178 if (!PyArg_ParseTuple(args, "y*:set_npn_protocols", &protos))
2179 return NULL;
2180
Christian Heimes5cb31c92012-09-20 12:42:54 +02002181 if (self->npn_protocols != NULL) {
2182 PyMem_Free(self->npn_protocols);
2183 }
2184
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002185 self->npn_protocols = PyMem_Malloc(protos.len);
2186 if (self->npn_protocols == NULL) {
2187 PyBuffer_Release(&protos);
2188 return PyErr_NoMemory();
2189 }
2190 memcpy(self->npn_protocols, protos.buf, protos.len);
2191 self->npn_protocols_len = (int) protos.len;
2192
2193 /* set both server and client callbacks, because the context can
2194 * be used to create both types of sockets */
2195 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
2196 _advertiseNPN_cb,
2197 self);
2198 SSL_CTX_set_next_proto_select_cb(self->ctx,
2199 _selectNPN_cb,
2200 self);
2201
2202 PyBuffer_Release(&protos);
2203 Py_RETURN_NONE;
2204#else
2205 PyErr_SetString(PyExc_NotImplementedError,
2206 "The NPN extension requires OpenSSL 1.0.1 or later.");
2207 return NULL;
2208#endif
2209}
2210
Antoine Pitrou152efa22010-05-16 18:19:27 +00002211static PyObject *
2212get_verify_mode(PySSLContext *self, void *c)
2213{
2214 switch (SSL_CTX_get_verify_mode(self->ctx)) {
2215 case SSL_VERIFY_NONE:
2216 return PyLong_FromLong(PY_SSL_CERT_NONE);
2217 case SSL_VERIFY_PEER:
2218 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
2219 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
2220 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
2221 }
2222 PyErr_SetString(PySSLErrorObject,
2223 "invalid return value from SSL_CTX_get_verify_mode");
2224 return NULL;
2225}
2226
2227static int
2228set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
2229{
2230 int n, mode;
2231 if (!PyArg_Parse(arg, "i", &n))
2232 return -1;
2233 if (n == PY_SSL_CERT_NONE)
2234 mode = SSL_VERIFY_NONE;
2235 else if (n == PY_SSL_CERT_OPTIONAL)
2236 mode = SSL_VERIFY_PEER;
2237 else if (n == PY_SSL_CERT_REQUIRED)
2238 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2239 else {
2240 PyErr_SetString(PyExc_ValueError,
2241 "invalid value for verify_mode");
2242 return -1;
2243 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01002244 if (mode == SSL_VERIFY_NONE && self->check_hostname) {
2245 PyErr_SetString(PyExc_ValueError,
2246 "Cannot set verify_mode to CERT_NONE when "
2247 "check_hostname is enabled.");
2248 return -1;
2249 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002250 SSL_CTX_set_verify(self->ctx, mode, NULL);
2251 return 0;
2252}
2253
Christian Heimes2427b502013-11-23 11:24:32 +01002254#ifdef HAVE_OPENSSL_VERIFY_PARAM
Antoine Pitrou152efa22010-05-16 18:19:27 +00002255static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01002256get_verify_flags(PySSLContext *self, void *c)
2257{
2258 X509_STORE *store;
2259 unsigned long flags;
2260
2261 store = SSL_CTX_get_cert_store(self->ctx);
2262 flags = X509_VERIFY_PARAM_get_flags(store->param);
2263 return PyLong_FromUnsignedLong(flags);
2264}
2265
2266static int
2267set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
2268{
2269 X509_STORE *store;
2270 unsigned long new_flags, flags, set, clear;
2271
2272 if (!PyArg_Parse(arg, "k", &new_flags))
2273 return -1;
2274 store = SSL_CTX_get_cert_store(self->ctx);
2275 flags = X509_VERIFY_PARAM_get_flags(store->param);
2276 clear = flags & ~new_flags;
2277 set = ~flags & new_flags;
2278 if (clear) {
2279 if (!X509_VERIFY_PARAM_clear_flags(store->param, clear)) {
2280 _setSSLError(NULL, 0, __FILE__, __LINE__);
2281 return -1;
2282 }
2283 }
2284 if (set) {
2285 if (!X509_VERIFY_PARAM_set_flags(store->param, set)) {
2286 _setSSLError(NULL, 0, __FILE__, __LINE__);
2287 return -1;
2288 }
2289 }
2290 return 0;
2291}
Christian Heimes2427b502013-11-23 11:24:32 +01002292#endif
Christian Heimes22587792013-11-21 23:56:13 +01002293
2294static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00002295get_options(PySSLContext *self, void *c)
2296{
2297 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
2298}
2299
2300static int
2301set_options(PySSLContext *self, PyObject *arg, void *c)
2302{
2303 long new_opts, opts, set, clear;
2304 if (!PyArg_Parse(arg, "l", &new_opts))
2305 return -1;
2306 opts = SSL_CTX_get_options(self->ctx);
2307 clear = opts & ~new_opts;
2308 set = ~opts & new_opts;
2309 if (clear) {
2310#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
2311 SSL_CTX_clear_options(self->ctx, clear);
2312#else
2313 PyErr_SetString(PyExc_ValueError,
2314 "can't clear options before OpenSSL 0.9.8m");
2315 return -1;
2316#endif
2317 }
2318 if (set)
2319 SSL_CTX_set_options(self->ctx, set);
2320 return 0;
2321}
2322
Christian Heimes1aa9a752013-12-02 02:41:19 +01002323static PyObject *
2324get_check_hostname(PySSLContext *self, void *c)
2325{
2326 return PyBool_FromLong(self->check_hostname);
2327}
2328
2329static int
2330set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
2331{
2332 int check_hostname;
2333 if (!PyArg_Parse(arg, "p", &check_hostname))
2334 return -1;
2335 if (check_hostname &&
2336 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
2337 PyErr_SetString(PyExc_ValueError,
2338 "check_hostname needs a SSL context with either "
2339 "CERT_OPTIONAL or CERT_REQUIRED");
2340 return -1;
2341 }
2342 self->check_hostname = check_hostname;
2343 return 0;
2344}
2345
2346
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002347typedef struct {
2348 PyThreadState *thread_state;
2349 PyObject *callable;
2350 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02002351 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002352 int error;
2353} _PySSLPasswordInfo;
2354
2355static int
2356_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
2357 const char *bad_type_error)
2358{
2359 /* Set the password and size fields of a _PySSLPasswordInfo struct
2360 from a unicode, bytes, or byte array object.
2361 The password field will be dynamically allocated and must be freed
2362 by the caller */
2363 PyObject *password_bytes = NULL;
2364 const char *data = NULL;
2365 Py_ssize_t size;
2366
2367 if (PyUnicode_Check(password)) {
2368 password_bytes = PyUnicode_AsEncodedString(password, NULL, NULL);
2369 if (!password_bytes) {
2370 goto error;
2371 }
2372 data = PyBytes_AS_STRING(password_bytes);
2373 size = PyBytes_GET_SIZE(password_bytes);
2374 } else if (PyBytes_Check(password)) {
2375 data = PyBytes_AS_STRING(password);
2376 size = PyBytes_GET_SIZE(password);
2377 } else if (PyByteArray_Check(password)) {
2378 data = PyByteArray_AS_STRING(password);
2379 size = PyByteArray_GET_SIZE(password);
2380 } else {
2381 PyErr_SetString(PyExc_TypeError, bad_type_error);
2382 goto error;
2383 }
2384
Victor Stinner9ee02032013-06-23 15:08:23 +02002385 if (size > (Py_ssize_t)INT_MAX) {
2386 PyErr_Format(PyExc_ValueError,
2387 "password cannot be longer than %d bytes", INT_MAX);
2388 goto error;
2389 }
2390
Victor Stinner11ebff22013-07-07 17:07:52 +02002391 PyMem_Free(pw_info->password);
2392 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002393 if (!pw_info->password) {
2394 PyErr_SetString(PyExc_MemoryError,
2395 "unable to allocate password buffer");
2396 goto error;
2397 }
2398 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02002399 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002400
2401 Py_XDECREF(password_bytes);
2402 return 1;
2403
2404error:
2405 Py_XDECREF(password_bytes);
2406 return 0;
2407}
2408
2409static int
2410_password_callback(char *buf, int size, int rwflag, void *userdata)
2411{
2412 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
2413 PyObject *fn_ret = NULL;
2414
2415 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
2416
2417 if (pw_info->callable) {
2418 fn_ret = PyObject_CallFunctionObjArgs(pw_info->callable, NULL);
2419 if (!fn_ret) {
2420 /* TODO: It would be nice to move _ctypes_add_traceback() into the
2421 core python API, so we could use it to add a frame here */
2422 goto error;
2423 }
2424
2425 if (!_pwinfo_set(pw_info, fn_ret,
2426 "password callback must return a string")) {
2427 goto error;
2428 }
2429 Py_CLEAR(fn_ret);
2430 }
2431
2432 if (pw_info->size > size) {
2433 PyErr_Format(PyExc_ValueError,
2434 "password cannot be longer than %d bytes", size);
2435 goto error;
2436 }
2437
2438 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2439 memcpy(buf, pw_info->password, pw_info->size);
2440 return pw_info->size;
2441
2442error:
2443 Py_XDECREF(fn_ret);
2444 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2445 pw_info->error = 1;
2446 return -1;
2447}
2448
Antoine Pitroub5218772010-05-21 09:56:06 +00002449static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00002450load_cert_chain(PySSLContext *self, PyObject *args, PyObject *kwds)
2451{
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002452 char *kwlist[] = {"certfile", "keyfile", "password", NULL};
2453 PyObject *certfile, *keyfile = NULL, *password = NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002454 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002455 pem_password_cb *orig_passwd_cb = self->ctx->default_passwd_callback;
2456 void *orig_passwd_userdata = self->ctx->default_passwd_callback_userdata;
2457 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00002458 int r;
2459
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002460 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00002461 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002462 if (!PyArg_ParseTupleAndKeywords(args, kwds,
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002463 "O|OO:load_cert_chain", kwlist,
2464 &certfile, &keyfile, &password))
Antoine Pitrou152efa22010-05-16 18:19:27 +00002465 return NULL;
2466 if (keyfile == Py_None)
2467 keyfile = NULL;
2468 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
2469 PyErr_SetString(PyExc_TypeError,
2470 "certfile should be a valid filesystem path");
2471 return NULL;
2472 }
2473 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
2474 PyErr_SetString(PyExc_TypeError,
2475 "keyfile should be a valid filesystem path");
2476 goto error;
2477 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002478 if (password && password != Py_None) {
2479 if (PyCallable_Check(password)) {
2480 pw_info.callable = password;
2481 } else if (!_pwinfo_set(&pw_info, password,
2482 "password should be a string or callable")) {
2483 goto error;
2484 }
2485 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
2486 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
2487 }
2488 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002489 r = SSL_CTX_use_certificate_chain_file(self->ctx,
2490 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002491 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002492 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002493 if (pw_info.error) {
2494 ERR_clear_error();
2495 /* the password callback has already set the error information */
2496 }
2497 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002498 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002499 PyErr_SetFromErrno(PyExc_IOError);
2500 }
2501 else {
2502 _setSSLError(NULL, 0, __FILE__, __LINE__);
2503 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002504 goto error;
2505 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002506 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02002507 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00002508 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
2509 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002510 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2511 Py_CLEAR(keyfile_bytes);
2512 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002513 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002514 if (pw_info.error) {
2515 ERR_clear_error();
2516 /* the password callback has already set the error information */
2517 }
2518 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002519 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002520 PyErr_SetFromErrno(PyExc_IOError);
2521 }
2522 else {
2523 _setSSLError(NULL, 0, __FILE__, __LINE__);
2524 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002525 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002526 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002527 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002528 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002529 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002530 if (r != 1) {
2531 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002532 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002533 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002534 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2535 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002536 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002537 Py_RETURN_NONE;
2538
2539error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002540 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2541 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002542 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002543 Py_XDECREF(keyfile_bytes);
2544 Py_XDECREF(certfile_bytes);
2545 return NULL;
2546}
2547
Christian Heimesefff7062013-11-21 03:35:02 +01002548/* internal helper function, returns -1 on error
2549 */
2550static int
2551_add_ca_certs(PySSLContext *self, void *data, Py_ssize_t len,
2552 int filetype)
2553{
2554 BIO *biobuf = NULL;
2555 X509_STORE *store;
2556 int retval = 0, err, loaded = 0;
2557
2558 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
2559
2560 if (len <= 0) {
2561 PyErr_SetString(PyExc_ValueError,
2562 "Empty certificate data");
2563 return -1;
2564 } else if (len > INT_MAX) {
2565 PyErr_SetString(PyExc_OverflowError,
2566 "Certificate data is too long.");
2567 return -1;
2568 }
2569
Christian Heimes1dbf61f2013-11-22 00:34:18 +01002570 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01002571 if (biobuf == NULL) {
2572 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
2573 return -1;
2574 }
2575
2576 store = SSL_CTX_get_cert_store(self->ctx);
2577 assert(store != NULL);
2578
2579 while (1) {
2580 X509 *cert = NULL;
2581 int r;
2582
2583 if (filetype == SSL_FILETYPE_ASN1) {
2584 cert = d2i_X509_bio(biobuf, NULL);
2585 } else {
2586 cert = PEM_read_bio_X509(biobuf, NULL,
2587 self->ctx->default_passwd_callback,
2588 self->ctx->default_passwd_callback_userdata);
2589 }
2590 if (cert == NULL) {
2591 break;
2592 }
2593 r = X509_STORE_add_cert(store, cert);
2594 X509_free(cert);
2595 if (!r) {
2596 err = ERR_peek_last_error();
2597 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
2598 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
2599 /* cert already in hash table, not an error */
2600 ERR_clear_error();
2601 } else {
2602 break;
2603 }
2604 }
2605 loaded++;
2606 }
2607
2608 err = ERR_peek_last_error();
2609 if ((filetype == SSL_FILETYPE_ASN1) &&
2610 (loaded > 0) &&
2611 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
2612 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
2613 /* EOF ASN1 file, not an error */
2614 ERR_clear_error();
2615 retval = 0;
2616 } else if ((filetype == SSL_FILETYPE_PEM) &&
2617 (loaded > 0) &&
2618 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
2619 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
2620 /* EOF PEM file, not an error */
2621 ERR_clear_error();
2622 retval = 0;
2623 } else {
2624 _setSSLError(NULL, 0, __FILE__, __LINE__);
2625 retval = -1;
2626 }
2627
2628 BIO_free(biobuf);
2629 return retval;
2630}
2631
2632
Antoine Pitrou152efa22010-05-16 18:19:27 +00002633static PyObject *
2634load_verify_locations(PySSLContext *self, PyObject *args, PyObject *kwds)
2635{
Christian Heimesefff7062013-11-21 03:35:02 +01002636 char *kwlist[] = {"cafile", "capath", "cadata", NULL};
2637 PyObject *cafile = NULL, *capath = NULL, *cadata = NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002638 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
2639 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002640 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002641
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002642 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002643 if (!PyArg_ParseTupleAndKeywords(args, kwds,
Christian Heimesefff7062013-11-21 03:35:02 +01002644 "|OOO:load_verify_locations", kwlist,
2645 &cafile, &capath, &cadata))
Antoine Pitrou152efa22010-05-16 18:19:27 +00002646 return NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002647
Antoine Pitrou152efa22010-05-16 18:19:27 +00002648 if (cafile == Py_None)
2649 cafile = NULL;
2650 if (capath == Py_None)
2651 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002652 if (cadata == Py_None)
2653 cadata = NULL;
2654
2655 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002656 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01002657 "cafile, capath and cadata cannot be all omitted");
2658 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002659 }
2660 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
2661 PyErr_SetString(PyExc_TypeError,
2662 "cafile should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002663 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002664 }
2665 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002666 PyErr_SetString(PyExc_TypeError,
2667 "capath should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002668 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002669 }
Christian Heimesefff7062013-11-21 03:35:02 +01002670
2671 /* validata cadata type and load cadata */
2672 if (cadata) {
2673 Py_buffer buf;
2674 PyObject *cadata_ascii = NULL;
2675
2676 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE) == 0) {
2677 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
2678 PyBuffer_Release(&buf);
2679 PyErr_SetString(PyExc_TypeError,
2680 "cadata should be a contiguous buffer with "
2681 "a single dimension");
2682 goto error;
2683 }
2684 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
2685 PyBuffer_Release(&buf);
2686 if (r == -1) {
2687 goto error;
2688 }
2689 } else {
2690 PyErr_Clear();
2691 cadata_ascii = PyUnicode_AsASCIIString(cadata);
2692 if (cadata_ascii == NULL) {
2693 PyErr_SetString(PyExc_TypeError,
Serhiy Storchakad65c9492015-11-02 14:10:23 +02002694 "cadata should be an ASCII string or a "
Christian Heimesefff7062013-11-21 03:35:02 +01002695 "bytes-like object");
2696 goto error;
2697 }
2698 r = _add_ca_certs(self,
2699 PyBytes_AS_STRING(cadata_ascii),
2700 PyBytes_GET_SIZE(cadata_ascii),
2701 SSL_FILETYPE_PEM);
2702 Py_DECREF(cadata_ascii);
2703 if (r == -1) {
2704 goto error;
2705 }
2706 }
2707 }
2708
2709 /* load cafile or capath */
2710 if (cafile || capath) {
2711 if (cafile)
2712 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
2713 if (capath)
2714 capath_buf = PyBytes_AS_STRING(capath_bytes);
2715 PySSL_BEGIN_ALLOW_THREADS
2716 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
2717 PySSL_END_ALLOW_THREADS
2718 if (r != 1) {
2719 ok = 0;
2720 if (errno != 0) {
2721 ERR_clear_error();
2722 PyErr_SetFromErrno(PyExc_IOError);
2723 }
2724 else {
2725 _setSSLError(NULL, 0, __FILE__, __LINE__);
2726 }
2727 goto error;
2728 }
2729 }
2730 goto end;
2731
2732 error:
2733 ok = 0;
2734 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00002735 Py_XDECREF(cafile_bytes);
2736 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01002737 if (ok) {
2738 Py_RETURN_NONE;
2739 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002740 return NULL;
2741 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002742}
2743
2744static PyObject *
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002745load_dh_params(PySSLContext *self, PyObject *filepath)
2746{
2747 FILE *f;
2748 DH *dh;
2749
Victor Stinnerdaf45552013-08-28 00:53:59 +02002750 f = _Py_fopen_obj(filepath, "rb");
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002751 if (f == NULL) {
2752 if (!PyErr_Occurred())
2753 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
2754 return NULL;
2755 }
2756 errno = 0;
2757 PySSL_BEGIN_ALLOW_THREADS
2758 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01002759 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002760 PySSL_END_ALLOW_THREADS
2761 if (dh == NULL) {
2762 if (errno != 0) {
2763 ERR_clear_error();
2764 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
2765 }
2766 else {
2767 _setSSLError(NULL, 0, __FILE__, __LINE__);
2768 }
2769 return NULL;
2770 }
2771 if (SSL_CTX_set_tmp_dh(self->ctx, dh) == 0)
2772 _setSSLError(NULL, 0, __FILE__, __LINE__);
2773 DH_free(dh);
2774 Py_RETURN_NONE;
2775}
2776
2777static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00002778context_wrap_socket(PySSLContext *self, PyObject *args, PyObject *kwds)
2779{
Antoine Pitroud5323212010-10-22 18:19:07 +00002780 char *kwlist[] = {"sock", "server_side", "server_hostname", NULL};
Antoine Pitrou152efa22010-05-16 18:19:27 +00002781 PySocketSockObject *sock;
2782 int server_side = 0;
Antoine Pitroud5323212010-10-22 18:19:07 +00002783 char *hostname = NULL;
2784 PyObject *hostname_obj, *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002785
Antoine Pitroud5323212010-10-22 18:19:07 +00002786 /* server_hostname is either None (or absent), or to be encoded
2787 using the idna encoding. */
2788 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!i|O!:_wrap_socket", kwlist,
Antoine Pitrou152efa22010-05-16 18:19:27 +00002789 PySocketModule.Sock_Type,
Antoine Pitroud5323212010-10-22 18:19:07 +00002790 &sock, &server_side,
2791 Py_TYPE(Py_None), &hostname_obj)) {
2792 PyErr_Clear();
2793 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!iet:_wrap_socket", kwlist,
2794 PySocketModule.Sock_Type,
2795 &sock, &server_side,
2796 "idna", &hostname))
2797 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00002798 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002799
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002800 res = (PyObject *) newPySSLSocket(self, sock, server_side,
Antoine Pitroud5323212010-10-22 18:19:07 +00002801 hostname);
2802 if (hostname != NULL)
2803 PyMem_Free(hostname);
2804 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002805}
2806
Antoine Pitroub0182c82010-10-12 20:09:02 +00002807static PyObject *
2808session_stats(PySSLContext *self, PyObject *unused)
2809{
2810 int r;
2811 PyObject *value, *stats = PyDict_New();
2812 if (!stats)
2813 return NULL;
2814
2815#define ADD_STATS(SSL_NAME, KEY_NAME) \
2816 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
2817 if (value == NULL) \
2818 goto error; \
2819 r = PyDict_SetItemString(stats, KEY_NAME, value); \
2820 Py_DECREF(value); \
2821 if (r < 0) \
2822 goto error;
2823
2824 ADD_STATS(number, "number");
2825 ADD_STATS(connect, "connect");
2826 ADD_STATS(connect_good, "connect_good");
2827 ADD_STATS(connect_renegotiate, "connect_renegotiate");
2828 ADD_STATS(accept, "accept");
2829 ADD_STATS(accept_good, "accept_good");
2830 ADD_STATS(accept_renegotiate, "accept_renegotiate");
2831 ADD_STATS(accept, "accept");
2832 ADD_STATS(hits, "hits");
2833 ADD_STATS(misses, "misses");
2834 ADD_STATS(timeouts, "timeouts");
2835 ADD_STATS(cache_full, "cache_full");
2836
2837#undef ADD_STATS
2838
2839 return stats;
2840
2841error:
2842 Py_DECREF(stats);
2843 return NULL;
2844}
2845
Antoine Pitrou664c2d12010-11-17 20:29:42 +00002846static PyObject *
2847set_default_verify_paths(PySSLContext *self, PyObject *unused)
2848{
2849 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
2850 _setSSLError(NULL, 0, __FILE__, __LINE__);
2851 return NULL;
2852 }
2853 Py_RETURN_NONE;
2854}
2855
Antoine Pitrou501da612011-12-21 09:27:41 +01002856#ifndef OPENSSL_NO_ECDH
Antoine Pitrou923df6f2011-12-19 17:16:51 +01002857static PyObject *
2858set_ecdh_curve(PySSLContext *self, PyObject *name)
2859{
2860 PyObject *name_bytes;
2861 int nid;
2862 EC_KEY *key;
2863
2864 if (!PyUnicode_FSConverter(name, &name_bytes))
2865 return NULL;
2866 assert(PyBytes_Check(name_bytes));
2867 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
2868 Py_DECREF(name_bytes);
2869 if (nid == 0) {
2870 PyErr_Format(PyExc_ValueError,
2871 "unknown elliptic curve name %R", name);
2872 return NULL;
2873 }
2874 key = EC_KEY_new_by_curve_name(nid);
2875 if (key == NULL) {
2876 _setSSLError(NULL, 0, __FILE__, __LINE__);
2877 return NULL;
2878 }
2879 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2880 EC_KEY_free(key);
2881 Py_RETURN_NONE;
2882}
Antoine Pitrou501da612011-12-21 09:27:41 +01002883#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01002884
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002885#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002886static int
2887_servername_callback(SSL *s, int *al, void *args)
2888{
2889 int ret;
2890 PySSLContext *ssl_ctx = (PySSLContext *) args;
2891 PySSLSocket *ssl;
2892 PyObject *servername_o;
2893 PyObject *servername_idna;
2894 PyObject *result;
2895 /* The high-level ssl.SSLSocket object */
2896 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002897 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01002898#ifdef WITH_THREAD
2899 PyGILState_STATE gstate = PyGILState_Ensure();
2900#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002901
2902 if (ssl_ctx->set_hostname == NULL) {
2903 /* remove race condition in this the call back while if removing the
2904 * callback is in progress */
Stefan Krah20d60802013-01-17 17:07:17 +01002905#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002906 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002907#endif
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01002908 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002909 }
2910
2911 ssl = SSL_get_app_data(s);
2912 assert(PySSLSocket_Check(ssl));
2913 ssl_socket = PyWeakref_GetObject(ssl->Socket);
2914 Py_INCREF(ssl_socket);
2915 if (ssl_socket == Py_None) {
2916 goto error;
2917 }
Victor Stinner7e001512013-06-25 00:44:31 +02002918
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002919 if (servername == NULL) {
2920 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
2921 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002922 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002923 else {
2924 servername_o = PyBytes_FromString(servername);
2925 if (servername_o == NULL) {
2926 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
2927 goto error;
2928 }
2929 servername_idna = PyUnicode_FromEncodedObject(servername_o, "idna", NULL);
2930 if (servername_idna == NULL) {
2931 PyErr_WriteUnraisable(servername_o);
2932 Py_DECREF(servername_o);
2933 goto error;
2934 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002935 Py_DECREF(servername_o);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002936 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
2937 servername_idna, ssl_ctx, NULL);
2938 Py_DECREF(servername_idna);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002939 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002940 Py_DECREF(ssl_socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002941
2942 if (result == NULL) {
2943 PyErr_WriteUnraisable(ssl_ctx->set_hostname);
2944 *al = SSL_AD_HANDSHAKE_FAILURE;
2945 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
2946 }
2947 else {
2948 if (result != Py_None) {
2949 *al = (int) PyLong_AsLong(result);
2950 if (PyErr_Occurred()) {
2951 PyErr_WriteUnraisable(result);
2952 *al = SSL_AD_INTERNAL_ERROR;
2953 }
2954 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
2955 }
2956 else {
2957 ret = SSL_TLSEXT_ERR_OK;
2958 }
2959 Py_DECREF(result);
2960 }
2961
Stefan Krah20d60802013-01-17 17:07:17 +01002962#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002963 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002964#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002965 return ret;
2966
2967error:
2968 Py_DECREF(ssl_socket);
2969 *al = SSL_AD_INTERNAL_ERROR;
2970 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
Stefan Krah20d60802013-01-17 17:07:17 +01002971#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002972 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002973#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002974 return ret;
2975}
Antoine Pitroua5963382013-03-30 16:39:00 +01002976#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002977
2978PyDoc_STRVAR(PySSL_set_servername_callback_doc,
2979"set_servername_callback(method)\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002980\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002981This sets a callback that will be called when a server name is provided by\n\
2982the SSL/TLS client in the SNI extension.\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002983\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002984If the argument is None then the callback is disabled. The method is called\n\
2985with the SSLSocket, the server name as a string, and the SSLContext object.\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002986See RFC 6066 for details of the SNI extension.");
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002987
2988static PyObject *
2989set_servername_callback(PySSLContext *self, PyObject *args)
2990{
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002991#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002992 PyObject *cb;
2993
2994 if (!PyArg_ParseTuple(args, "O", &cb))
2995 return NULL;
2996
2997 Py_CLEAR(self->set_hostname);
2998 if (cb == Py_None) {
2999 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3000 }
3001 else {
3002 if (!PyCallable_Check(cb)) {
3003 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3004 PyErr_SetString(PyExc_TypeError,
3005 "not a callable object");
3006 return NULL;
3007 }
3008 Py_INCREF(cb);
3009 self->set_hostname = cb;
3010 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
3011 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
3012 }
3013 Py_RETURN_NONE;
3014#else
3015 PyErr_SetString(PyExc_NotImplementedError,
3016 "The TLS extension servername callback, "
3017 "SSL_CTX_set_tlsext_servername_callback, "
3018 "is not in the current OpenSSL library.");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01003019 return NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003020#endif
3021}
3022
Christian Heimes9a5395a2013-06-17 15:44:12 +02003023PyDoc_STRVAR(PySSL_get_stats_doc,
3024"cert_store_stats() -> {'crl': int, 'x509_ca': int, 'x509': int}\n\
3025\n\
3026Returns quantities of loaded X.509 certificates. X.509 certificates with a\n\
3027CA extension and certificate revocation lists inside the context's cert\n\
3028store.\n\
3029NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3030been used at least once.");
3031
3032static PyObject *
3033cert_store_stats(PySSLContext *self)
3034{
3035 X509_STORE *store;
3036 X509_OBJECT *obj;
3037 int x509 = 0, crl = 0, pkey = 0, ca = 0, i;
3038
3039 store = SSL_CTX_get_cert_store(self->ctx);
3040 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3041 obj = sk_X509_OBJECT_value(store->objs, i);
3042 switch (obj->type) {
3043 case X509_LU_X509:
3044 x509++;
3045 if (X509_check_ca(obj->data.x509)) {
3046 ca++;
3047 }
3048 break;
3049 case X509_LU_CRL:
3050 crl++;
3051 break;
3052 case X509_LU_PKEY:
3053 pkey++;
3054 break;
3055 default:
3056 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
3057 * As far as I can tell they are internal states and never
3058 * stored in a cert store */
3059 break;
3060 }
3061 }
3062 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
3063 "x509_ca", ca);
3064}
3065
3066PyDoc_STRVAR(PySSL_get_ca_certs_doc,
Christian Heimesf22e8e52013-11-22 02:22:51 +01003067"get_ca_certs(binary_form=False) -> list of loaded certificate\n\
Christian Heimes9a5395a2013-06-17 15:44:12 +02003068\n\
3069Returns a list of dicts with information of loaded CA certs. If the\n\
3070optional argument is True, returns a DER-encoded copy of the CA certificate.\n\
3071NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3072been used at least once.");
3073
3074static PyObject *
Christian Heimesf22e8e52013-11-22 02:22:51 +01003075get_ca_certs(PySSLContext *self, PyObject *args, PyObject *kwds)
Christian Heimes9a5395a2013-06-17 15:44:12 +02003076{
Christian Heimesf22e8e52013-11-22 02:22:51 +01003077 char *kwlist[] = {"binary_form", NULL};
Christian Heimes9a5395a2013-06-17 15:44:12 +02003078 X509_STORE *store;
3079 PyObject *ci = NULL, *rlist = NULL;
3080 int i;
3081 int binary_mode = 0;
3082
Christian Heimesf22e8e52013-11-22 02:22:51 +01003083 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|p:get_ca_certs",
3084 kwlist, &binary_mode)) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02003085 return NULL;
3086 }
3087
3088 if ((rlist = PyList_New(0)) == NULL) {
3089 return NULL;
3090 }
3091
3092 store = SSL_CTX_get_cert_store(self->ctx);
3093 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3094 X509_OBJECT *obj;
3095 X509 *cert;
3096
3097 obj = sk_X509_OBJECT_value(store->objs, i);
3098 if (obj->type != X509_LU_X509) {
3099 /* not a x509 cert */
3100 continue;
3101 }
3102 /* CA for any purpose */
3103 cert = obj->data.x509;
3104 if (!X509_check_ca(cert)) {
3105 continue;
3106 }
3107 if (binary_mode) {
3108 ci = _certificate_to_der(cert);
3109 } else {
3110 ci = _decode_certificate(cert);
3111 }
3112 if (ci == NULL) {
3113 goto error;
3114 }
3115 if (PyList_Append(rlist, ci) == -1) {
3116 goto error;
3117 }
3118 Py_CLEAR(ci);
3119 }
3120 return rlist;
3121
3122 error:
3123 Py_XDECREF(ci);
3124 Py_XDECREF(rlist);
3125 return NULL;
3126}
3127
3128
Antoine Pitrou152efa22010-05-16 18:19:27 +00003129static PyGetSetDef context_getsetlist[] = {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003130 {"check_hostname", (getter) get_check_hostname,
3131 (setter) set_check_hostname, NULL},
Antoine Pitroub5218772010-05-21 09:56:06 +00003132 {"options", (getter) get_options,
3133 (setter) set_options, NULL},
Christian Heimes2427b502013-11-23 11:24:32 +01003134#ifdef HAVE_OPENSSL_VERIFY_PARAM
Christian Heimes22587792013-11-21 23:56:13 +01003135 {"verify_flags", (getter) get_verify_flags,
3136 (setter) set_verify_flags, NULL},
Christian Heimes2427b502013-11-23 11:24:32 +01003137#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003138 {"verify_mode", (getter) get_verify_mode,
3139 (setter) set_verify_mode, NULL},
3140 {NULL}, /* sentinel */
3141};
3142
3143static struct PyMethodDef context_methods[] = {
3144 {"_wrap_socket", (PyCFunction) context_wrap_socket,
3145 METH_VARARGS | METH_KEYWORDS, NULL},
3146 {"set_ciphers", (PyCFunction) set_ciphers,
3147 METH_VARARGS, NULL},
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003148 {"_set_npn_protocols", (PyCFunction) _set_npn_protocols,
3149 METH_VARARGS, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003150 {"load_cert_chain", (PyCFunction) load_cert_chain,
3151 METH_VARARGS | METH_KEYWORDS, NULL},
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003152 {"load_dh_params", (PyCFunction) load_dh_params,
3153 METH_O, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003154 {"load_verify_locations", (PyCFunction) load_verify_locations,
3155 METH_VARARGS | METH_KEYWORDS, NULL},
Antoine Pitroub0182c82010-10-12 20:09:02 +00003156 {"session_stats", (PyCFunction) session_stats,
3157 METH_NOARGS, NULL},
Antoine Pitrou664c2d12010-11-17 20:29:42 +00003158 {"set_default_verify_paths", (PyCFunction) set_default_verify_paths,
3159 METH_NOARGS, NULL},
Antoine Pitrou501da612011-12-21 09:27:41 +01003160#ifndef OPENSSL_NO_ECDH
Antoine Pitrou923df6f2011-12-19 17:16:51 +01003161 {"set_ecdh_curve", (PyCFunction) set_ecdh_curve,
3162 METH_O, NULL},
Antoine Pitrou501da612011-12-21 09:27:41 +01003163#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003164 {"set_servername_callback", (PyCFunction) set_servername_callback,
3165 METH_VARARGS, PySSL_set_servername_callback_doc},
Christian Heimes9a5395a2013-06-17 15:44:12 +02003166 {"cert_store_stats", (PyCFunction) cert_store_stats,
3167 METH_NOARGS, PySSL_get_stats_doc},
3168 {"get_ca_certs", (PyCFunction) get_ca_certs,
Christian Heimesf22e8e52013-11-22 02:22:51 +01003169 METH_VARARGS | METH_KEYWORDS, PySSL_get_ca_certs_doc},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003170 {NULL, NULL} /* sentinel */
3171};
3172
3173static PyTypeObject PySSLContext_Type = {
3174 PyVarObject_HEAD_INIT(NULL, 0)
3175 "_ssl._SSLContext", /*tp_name*/
3176 sizeof(PySSLContext), /*tp_basicsize*/
3177 0, /*tp_itemsize*/
3178 (destructor)context_dealloc, /*tp_dealloc*/
3179 0, /*tp_print*/
3180 0, /*tp_getattr*/
3181 0, /*tp_setattr*/
3182 0, /*tp_reserved*/
3183 0, /*tp_repr*/
3184 0, /*tp_as_number*/
3185 0, /*tp_as_sequence*/
3186 0, /*tp_as_mapping*/
3187 0, /*tp_hash*/
3188 0, /*tp_call*/
3189 0, /*tp_str*/
3190 0, /*tp_getattro*/
3191 0, /*tp_setattro*/
3192 0, /*tp_as_buffer*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003193 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003194 0, /*tp_doc*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003195 (traverseproc) context_traverse, /*tp_traverse*/
3196 (inquiry) context_clear, /*tp_clear*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003197 0, /*tp_richcompare*/
3198 0, /*tp_weaklistoffset*/
3199 0, /*tp_iter*/
3200 0, /*tp_iternext*/
3201 context_methods, /*tp_methods*/
3202 0, /*tp_members*/
3203 context_getsetlist, /*tp_getset*/
3204 0, /*tp_base*/
3205 0, /*tp_dict*/
3206 0, /*tp_descr_get*/
3207 0, /*tp_descr_set*/
3208 0, /*tp_dictoffset*/
3209 0, /*tp_init*/
3210 0, /*tp_alloc*/
3211 context_new, /*tp_new*/
3212};
3213
3214
3215
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003216#ifdef HAVE_OPENSSL_RAND
3217
3218/* helper routines for seeding the SSL PRNG */
3219static PyObject *
3220PySSL_RAND_add(PyObject *self, PyObject *args)
3221{
3222 char *buf;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02003223 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003224 double entropy;
3225
3226 if (!PyArg_ParseTuple(args, "s#d:RAND_add", &buf, &len, &entropy))
Antoine Pitrou525807b2010-05-12 14:05:24 +00003227 return NULL;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02003228 do {
3229 written = Py_MIN(len, INT_MAX);
3230 RAND_add(buf, (int)written, entropy);
3231 buf += written;
3232 len -= written;
3233 } while (len);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003234 Py_INCREF(Py_None);
3235 return Py_None;
3236}
3237
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003238PyDoc_STRVAR(PySSL_RAND_add_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003239"RAND_add(string, entropy)\n\
3240\n\
3241Mix string into the OpenSSL PRNG state. entropy (a float) is a lower\n\
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003242bound on the entropy contained in string. See RFC 1750.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003243
3244static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02003245PySSL_RAND(int len, int pseudo)
3246{
3247 int ok;
3248 PyObject *bytes;
3249 unsigned long err;
3250 const char *errstr;
3251 PyObject *v;
3252
Victor Stinner1e81a392013-12-19 16:47:04 +01003253 if (len < 0) {
3254 PyErr_SetString(PyExc_ValueError, "num must be positive");
3255 return NULL;
3256 }
3257
Victor Stinner99c8b162011-05-24 12:05:19 +02003258 bytes = PyBytes_FromStringAndSize(NULL, len);
3259 if (bytes == NULL)
3260 return NULL;
3261 if (pseudo) {
3262 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3263 if (ok == 0 || ok == 1)
3264 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
3265 }
3266 else {
3267 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3268 if (ok == 1)
3269 return bytes;
3270 }
3271 Py_DECREF(bytes);
3272
3273 err = ERR_get_error();
3274 errstr = ERR_reason_error_string(err);
3275 v = Py_BuildValue("(ks)", err, errstr);
3276 if (v != NULL) {
3277 PyErr_SetObject(PySSLErrorObject, v);
3278 Py_DECREF(v);
3279 }
3280 return NULL;
3281}
3282
3283static PyObject *
3284PySSL_RAND_bytes(PyObject *self, PyObject *args)
3285{
3286 int len;
3287 if (!PyArg_ParseTuple(args, "i:RAND_bytes", &len))
3288 return NULL;
3289 return PySSL_RAND(len, 0);
3290}
3291
3292PyDoc_STRVAR(PySSL_RAND_bytes_doc,
3293"RAND_bytes(n) -> bytes\n\
3294\n\
3295Generate n cryptographically strong pseudo-random bytes.");
3296
3297static PyObject *
3298PySSL_RAND_pseudo_bytes(PyObject *self, PyObject *args)
3299{
3300 int len;
3301 if (!PyArg_ParseTuple(args, "i:RAND_pseudo_bytes", &len))
3302 return NULL;
3303 return PySSL_RAND(len, 1);
3304}
3305
3306PyDoc_STRVAR(PySSL_RAND_pseudo_bytes_doc,
3307"RAND_pseudo_bytes(n) -> (bytes, is_cryptographic)\n\
3308\n\
3309Generate n pseudo-random bytes. is_cryptographic is True if the bytes\
3310generated are cryptographically strong.");
3311
3312static PyObject *
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003313PySSL_RAND_status(PyObject *self)
3314{
Christian Heimes217cfd12007-12-02 14:31:20 +00003315 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003316}
3317
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003318PyDoc_STRVAR(PySSL_RAND_status_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003319"RAND_status() -> 0 or 1\n\
3320\n\
Bill Janssen6e027db2007-11-15 22:23:56 +00003321Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.\n\
3322It is necessary to seed the PRNG with RAND_add() on some platforms before\n\
3323using the ssl() function.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003324
Victor Stinnerfcfed192015-01-06 13:54:58 +01003325#ifdef HAVE_RAND_EGD
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003326static PyObject *
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003327PySSL_RAND_egd(PyObject *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003328{
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003329 PyObject *path;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003330 int bytes;
3331
Jesus Ceac8754a12012-09-11 02:00:58 +02003332 if (!PyArg_ParseTuple(args, "O&:RAND_egd",
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003333 PyUnicode_FSConverter, &path))
3334 return NULL;
3335
3336 bytes = RAND_egd(PyBytes_AsString(path));
3337 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003338 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00003339 PyErr_SetString(PySSLErrorObject,
3340 "EGD connection failed or EGD did not return "
3341 "enough data to seed the PRNG");
3342 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003343 }
Christian Heimes217cfd12007-12-02 14:31:20 +00003344 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003345}
3346
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003347PyDoc_STRVAR(PySSL_RAND_egd_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003348"RAND_egd(path) -> bytes\n\
3349\n\
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003350Queries the entropy gather daemon (EGD) on the socket named by 'path'.\n\
3351Returns number of bytes read. Raises SSLError if connection to EGD\n\
Christian Heimes3c2593b2013-08-17 17:25:18 +02003352fails or if it does not provide enough data to seed PRNG.");
Victor Stinnerfcfed192015-01-06 13:54:58 +01003353#endif /* HAVE_RAND_EGD */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003354
Christian Heimesf77b4b22013-08-21 13:26:05 +02003355#endif /* HAVE_OPENSSL_RAND */
3356
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003357
Christian Heimes6d7ad132013-06-09 18:02:55 +02003358PyDoc_STRVAR(PySSL_get_default_verify_paths_doc,
3359"get_default_verify_paths() -> tuple\n\
3360\n\
3361Return search paths and environment vars that are used by SSLContext's\n\
3362set_default_verify_paths() to load default CAs. The values are\n\
3363'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.");
3364
3365static PyObject *
Christian Heimes200bb1b2013-06-14 15:14:29 +02003366PySSL_get_default_verify_paths(PyObject *self)
Christian Heimes6d7ad132013-06-09 18:02:55 +02003367{
3368 PyObject *ofile_env = NULL;
3369 PyObject *ofile = NULL;
3370 PyObject *odir_env = NULL;
3371 PyObject *odir = NULL;
3372
Benjamin Petersond113c962015-07-18 10:59:13 -07003373#define CONVERT(info, target) { \
Christian Heimes6d7ad132013-06-09 18:02:55 +02003374 const char *tmp = (info); \
3375 target = NULL; \
3376 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
3377 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
3378 target = PyBytes_FromString(tmp); } \
3379 if (!target) goto error; \
Benjamin Petersond113c962015-07-18 10:59:13 -07003380 }
Christian Heimes6d7ad132013-06-09 18:02:55 +02003381
Benjamin Petersond113c962015-07-18 10:59:13 -07003382 CONVERT(X509_get_default_cert_file_env(), ofile_env);
3383 CONVERT(X509_get_default_cert_file(), ofile);
3384 CONVERT(X509_get_default_cert_dir_env(), odir_env);
3385 CONVERT(X509_get_default_cert_dir(), odir);
3386#undef CONVERT
Christian Heimes6d7ad132013-06-09 18:02:55 +02003387
Christian Heimes200bb1b2013-06-14 15:14:29 +02003388 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02003389
3390 error:
3391 Py_XDECREF(ofile_env);
3392 Py_XDECREF(ofile);
3393 Py_XDECREF(odir_env);
3394 Py_XDECREF(odir);
3395 return NULL;
3396}
3397
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003398static PyObject*
3399asn1obj2py(ASN1_OBJECT *obj)
3400{
3401 int nid;
3402 const char *ln, *sn;
3403 char buf[100];
Victor Stinnercd752982014-07-07 21:52:29 +02003404 Py_ssize_t buflen;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003405
3406 nid = OBJ_obj2nid(obj);
3407 if (nid == NID_undef) {
3408 PyErr_Format(PyExc_ValueError, "Unknown object");
3409 return NULL;
3410 }
3411 sn = OBJ_nid2sn(nid);
3412 ln = OBJ_nid2ln(nid);
3413 buflen = OBJ_obj2txt(buf, sizeof(buf), obj, 1);
3414 if (buflen < 0) {
3415 _setSSLError(NULL, 0, __FILE__, __LINE__);
3416 return NULL;
3417 }
3418 if (buflen) {
3419 return Py_BuildValue("isss#", nid, sn, ln, buf, buflen);
3420 } else {
3421 return Py_BuildValue("issO", nid, sn, ln, Py_None);
3422 }
3423}
3424
3425PyDoc_STRVAR(PySSL_txt2obj_doc,
3426"txt2obj(txt, name=False) -> (nid, shortname, longname, oid)\n\
3427\n\
3428Lookup NID, short name, long name and OID of an ASN1_OBJECT. By default\n\
3429objects are looked up by OID. With name=True short and long name are also\n\
3430matched.");
3431
3432static PyObject*
3433PySSL_txt2obj(PyObject *self, PyObject *args, PyObject *kwds)
3434{
3435 char *kwlist[] = {"txt", "name", NULL};
3436 PyObject *result = NULL;
3437 char *txt;
3438 int name = 0;
3439 ASN1_OBJECT *obj;
3440
3441 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s|p:txt2obj",
3442 kwlist, &txt, &name)) {
3443 return NULL;
3444 }
3445 obj = OBJ_txt2obj(txt, name ? 0 : 1);
3446 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003447 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003448 return NULL;
3449 }
3450 result = asn1obj2py(obj);
3451 ASN1_OBJECT_free(obj);
3452 return result;
3453}
3454
3455PyDoc_STRVAR(PySSL_nid2obj_doc,
3456"nid2obj(nid) -> (nid, shortname, longname, oid)\n\
3457\n\
3458Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.");
3459
3460static PyObject*
3461PySSL_nid2obj(PyObject *self, PyObject *args)
3462{
3463 PyObject *result = NULL;
3464 int nid;
3465 ASN1_OBJECT *obj;
3466
3467 if (!PyArg_ParseTuple(args, "i:nid2obj", &nid)) {
3468 return NULL;
3469 }
3470 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003471 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003472 return NULL;
3473 }
3474 obj = OBJ_nid2obj(nid);
3475 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003476 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003477 return NULL;
3478 }
3479 result = asn1obj2py(obj);
3480 ASN1_OBJECT_free(obj);
3481 return result;
3482}
3483
Christian Heimes46bebee2013-06-09 19:03:31 +02003484#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01003485
3486static PyObject*
3487certEncodingType(DWORD encodingType)
3488{
3489 static PyObject *x509_asn = NULL;
3490 static PyObject *pkcs_7_asn = NULL;
3491
3492 if (x509_asn == NULL) {
3493 x509_asn = PyUnicode_InternFromString("x509_asn");
3494 if (x509_asn == NULL)
3495 return NULL;
3496 }
3497 if (pkcs_7_asn == NULL) {
3498 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
3499 if (pkcs_7_asn == NULL)
3500 return NULL;
3501 }
3502 switch(encodingType) {
3503 case X509_ASN_ENCODING:
3504 Py_INCREF(x509_asn);
3505 return x509_asn;
3506 case PKCS_7_ASN_ENCODING:
3507 Py_INCREF(pkcs_7_asn);
3508 return pkcs_7_asn;
3509 default:
3510 return PyLong_FromLong(encodingType);
3511 }
3512}
3513
3514static PyObject*
3515parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
3516{
3517 CERT_ENHKEY_USAGE *usage;
3518 DWORD size, error, i;
3519 PyObject *retval;
3520
3521 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
3522 error = GetLastError();
3523 if (error == CRYPT_E_NOT_FOUND) {
3524 Py_RETURN_TRUE;
3525 }
3526 return PyErr_SetFromWindowsErr(error);
3527 }
3528
3529 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
3530 if (usage == NULL) {
3531 return PyErr_NoMemory();
3532 }
3533
3534 /* Now get the actual enhanced usage property */
3535 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
3536 PyMem_Free(usage);
3537 error = GetLastError();
3538 if (error == CRYPT_E_NOT_FOUND) {
3539 Py_RETURN_TRUE;
3540 }
3541 return PyErr_SetFromWindowsErr(error);
3542 }
3543 retval = PySet_New(NULL);
3544 if (retval == NULL) {
3545 goto error;
3546 }
3547 for (i = 0; i < usage->cUsageIdentifier; ++i) {
3548 if (usage->rgpszUsageIdentifier[i]) {
3549 PyObject *oid;
3550 int err;
3551 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
3552 if (oid == NULL) {
3553 Py_CLEAR(retval);
3554 goto error;
3555 }
3556 err = PySet_Add(retval, oid);
3557 Py_DECREF(oid);
3558 if (err == -1) {
3559 Py_CLEAR(retval);
3560 goto error;
3561 }
3562 }
3563 }
3564 error:
3565 PyMem_Free(usage);
3566 return retval;
3567}
3568
3569PyDoc_STRVAR(PySSL_enum_certificates_doc,
3570"enum_certificates(store_name) -> []\n\
Christian Heimes46bebee2013-06-09 19:03:31 +02003571\n\
3572Retrieve certificates from Windows' cert store. store_name may be one of\n\
3573'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
Christian Heimes44109d72013-11-22 01:51:30 +01003574The function returns a list of (bytes, encoding_type, trust) tuples. The\n\
Christian Heimes46bebee2013-06-09 19:03:31 +02003575encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
Christian Heimes44109d72013-11-22 01:51:30 +01003576PKCS_7_ASN_ENCODING. The trust setting is either a set of OIDs or the\n\
3577boolean True.");
Bill Janssen40a0f662008-08-12 16:56:25 +00003578
Christian Heimes46bebee2013-06-09 19:03:31 +02003579static PyObject *
Christian Heimes44109d72013-11-22 01:51:30 +01003580PySSL_enum_certificates(PyObject *self, PyObject *args, PyObject *kwds)
Christian Heimes46bebee2013-06-09 19:03:31 +02003581{
Christian Heimes44109d72013-11-22 01:51:30 +01003582 char *kwlist[] = {"store_name", NULL};
Christian Heimes46bebee2013-06-09 19:03:31 +02003583 char *store_name;
Christian Heimes46bebee2013-06-09 19:03:31 +02003584 HCERTSTORE hStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01003585 PCCERT_CONTEXT pCertCtx = NULL;
3586 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02003587 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02003588
Benjamin Peterson43b84272015-04-06 13:05:22 -04003589 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s:enum_certificates",
Christian Heimes44109d72013-11-22 01:51:30 +01003590 kwlist, &store_name)) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003591 return NULL;
3592 }
Christian Heimes44109d72013-11-22 01:51:30 +01003593 result = PyList_New(0);
3594 if (result == NULL) {
3595 return NULL;
3596 }
3597 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3598 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003599 Py_DECREF(result);
3600 return PyErr_SetFromWindowsErr(GetLastError());
3601 }
3602
Christian Heimes44109d72013-11-22 01:51:30 +01003603 while (pCertCtx = CertEnumCertificatesInStore(hStore, pCertCtx)) {
3604 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
3605 pCertCtx->cbCertEncoded);
3606 if (!cert) {
3607 Py_CLEAR(result);
3608 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003609 }
Christian Heimes44109d72013-11-22 01:51:30 +01003610 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
3611 Py_CLEAR(result);
3612 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003613 }
Christian Heimes44109d72013-11-22 01:51:30 +01003614 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
3615 if (keyusage == Py_True) {
3616 Py_DECREF(keyusage);
3617 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02003618 }
Christian Heimes44109d72013-11-22 01:51:30 +01003619 if (keyusage == NULL) {
3620 Py_CLEAR(result);
3621 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003622 }
Christian Heimes44109d72013-11-22 01:51:30 +01003623 if ((tup = PyTuple_New(3)) == NULL) {
3624 Py_CLEAR(result);
3625 break;
3626 }
3627 PyTuple_SET_ITEM(tup, 0, cert);
3628 cert = NULL;
3629 PyTuple_SET_ITEM(tup, 1, enc);
3630 enc = NULL;
3631 PyTuple_SET_ITEM(tup, 2, keyusage);
3632 keyusage = NULL;
3633 if (PyList_Append(result, tup) < 0) {
3634 Py_CLEAR(result);
3635 break;
3636 }
3637 Py_CLEAR(tup);
3638 }
3639 if (pCertCtx) {
3640 /* loop ended with an error, need to clean up context manually */
3641 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02003642 }
3643
3644 /* In error cases cert, enc and tup may not be NULL */
3645 Py_XDECREF(cert);
3646 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01003647 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02003648 Py_XDECREF(tup);
3649
3650 if (!CertCloseStore(hStore, 0)) {
3651 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01003652 Py_XDECREF(result);
3653 return PyErr_SetFromWindowsErr(GetLastError());
3654 }
3655 return result;
3656}
3657
3658PyDoc_STRVAR(PySSL_enum_crls_doc,
3659"enum_crls(store_name) -> []\n\
3660\n\
3661Retrieve CRLs from Windows' cert store. store_name may be one of\n\
3662'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
3663The function returns a list of (bytes, encoding_type) tuples. The\n\
3664encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
3665PKCS_7_ASN_ENCODING.");
3666
3667static PyObject *
3668PySSL_enum_crls(PyObject *self, PyObject *args, PyObject *kwds)
3669{
3670 char *kwlist[] = {"store_name", NULL};
3671 char *store_name;
3672 HCERTSTORE hStore = NULL;
3673 PCCRL_CONTEXT pCrlCtx = NULL;
3674 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
3675 PyObject *result = NULL;
3676
Benjamin Peterson43b84272015-04-06 13:05:22 -04003677 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s:enum_crls",
Christian Heimes44109d72013-11-22 01:51:30 +01003678 kwlist, &store_name)) {
3679 return NULL;
3680 }
3681 result = PyList_New(0);
3682 if (result == NULL) {
3683 return NULL;
3684 }
3685 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3686 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003687 Py_DECREF(result);
3688 return PyErr_SetFromWindowsErr(GetLastError());
3689 }
Christian Heimes44109d72013-11-22 01:51:30 +01003690
3691 while (pCrlCtx = CertEnumCRLsInStore(hStore, pCrlCtx)) {
3692 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
3693 pCrlCtx->cbCrlEncoded);
3694 if (!crl) {
3695 Py_CLEAR(result);
3696 break;
3697 }
3698 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
3699 Py_CLEAR(result);
3700 break;
3701 }
3702 if ((tup = PyTuple_New(2)) == NULL) {
3703 Py_CLEAR(result);
3704 break;
3705 }
3706 PyTuple_SET_ITEM(tup, 0, crl);
3707 crl = NULL;
3708 PyTuple_SET_ITEM(tup, 1, enc);
3709 enc = NULL;
3710
3711 if (PyList_Append(result, tup) < 0) {
3712 Py_CLEAR(result);
3713 break;
3714 }
3715 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02003716 }
Christian Heimes44109d72013-11-22 01:51:30 +01003717 if (pCrlCtx) {
3718 /* loop ended with an error, need to clean up context manually */
3719 CertFreeCRLContext(pCrlCtx);
3720 }
3721
3722 /* In error cases cert, enc and tup may not be NULL */
3723 Py_XDECREF(crl);
3724 Py_XDECREF(enc);
3725 Py_XDECREF(tup);
3726
3727 if (!CertCloseStore(hStore, 0)) {
3728 /* This error case might shadow another exception.*/
3729 Py_XDECREF(result);
3730 return PyErr_SetFromWindowsErr(GetLastError());
3731 }
3732 return result;
Christian Heimes46bebee2013-06-09 19:03:31 +02003733}
Christian Heimes44109d72013-11-22 01:51:30 +01003734
3735#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00003736
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003737/* List of functions exported by this module. */
3738
3739static PyMethodDef PySSL_methods[] = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003740 {"_test_decode_cert", PySSL_test_decode_certificate,
3741 METH_VARARGS},
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003742#ifdef HAVE_OPENSSL_RAND
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003743 {"RAND_add", PySSL_RAND_add, METH_VARARGS,
3744 PySSL_RAND_add_doc},
Victor Stinner99c8b162011-05-24 12:05:19 +02003745 {"RAND_bytes", PySSL_RAND_bytes, METH_VARARGS,
3746 PySSL_RAND_bytes_doc},
3747 {"RAND_pseudo_bytes", PySSL_RAND_pseudo_bytes, METH_VARARGS,
3748 PySSL_RAND_pseudo_bytes_doc},
Victor Stinnerfcfed192015-01-06 13:54:58 +01003749#ifdef HAVE_RAND_EGD
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003750 {"RAND_egd", PySSL_RAND_egd, METH_VARARGS,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003751 PySSL_RAND_egd_doc},
Victor Stinnerfcfed192015-01-06 13:54:58 +01003752#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003753 {"RAND_status", (PyCFunction)PySSL_RAND_status, METH_NOARGS,
3754 PySSL_RAND_status_doc},
Christian Heimes142ec2c2013-06-09 18:29:54 +02003755#endif
Christian Heimes200bb1b2013-06-14 15:14:29 +02003756 {"get_default_verify_paths", (PyCFunction)PySSL_get_default_verify_paths,
Christian Heimes6d7ad132013-06-09 18:02:55 +02003757 METH_NOARGS, PySSL_get_default_verify_paths_doc},
Christian Heimes46bebee2013-06-09 19:03:31 +02003758#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01003759 {"enum_certificates", (PyCFunction)PySSL_enum_certificates,
3760 METH_VARARGS | METH_KEYWORDS, PySSL_enum_certificates_doc},
3761 {"enum_crls", (PyCFunction)PySSL_enum_crls,
3762 METH_VARARGS | METH_KEYWORDS, PySSL_enum_crls_doc},
Christian Heimes46bebee2013-06-09 19:03:31 +02003763#endif
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003764 {"txt2obj", (PyCFunction)PySSL_txt2obj,
3765 METH_VARARGS | METH_KEYWORDS, PySSL_txt2obj_doc},
3766 {"nid2obj", (PyCFunction)PySSL_nid2obj,
3767 METH_VARARGS, PySSL_nid2obj_doc},
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003768 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003769};
3770
3771
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003772#ifdef WITH_THREAD
3773
3774/* an implementation of OpenSSL threading operations in terms
3775 of the Python C thread library */
3776
3777static PyThread_type_lock *_ssl_locks = NULL;
3778
Christian Heimes4d98ca92013-08-19 17:36:29 +02003779#if OPENSSL_VERSION_NUMBER >= 0x10000000
3780/* use new CRYPTO_THREADID API. */
3781static void
3782_ssl_threadid_callback(CRYPTO_THREADID *id)
3783{
3784 CRYPTO_THREADID_set_numeric(id,
3785 (unsigned long)PyThread_get_thread_ident());
3786}
3787#else
3788/* deprecated CRYPTO_set_id_callback() API. */
3789static unsigned long
3790_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003791 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003792}
Christian Heimes4d98ca92013-08-19 17:36:29 +02003793#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003794
Bill Janssen6e027db2007-11-15 22:23:56 +00003795static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003796 (int mode, int n, const char *file, int line) {
3797 /* this function is needed to perform locking on shared data
3798 structures. (Note that OpenSSL uses a number of global data
3799 structures that will be implicitly shared whenever multiple
3800 threads use OpenSSL.) Multi-threaded applications will
3801 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003802
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003803 locking_function() must be able to handle up to
3804 CRYPTO_num_locks() different mutex locks. It sets the n-th
3805 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003806
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003807 file and line are the file number of the function setting the
3808 lock. They can be useful for debugging.
3809 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003810
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003811 if ((_ssl_locks == NULL) ||
3812 (n < 0) || ((unsigned)n >= _ssl_locks_count))
3813 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003814
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003815 if (mode & CRYPTO_LOCK) {
3816 PyThread_acquire_lock(_ssl_locks[n], 1);
3817 } else {
3818 PyThread_release_lock(_ssl_locks[n]);
3819 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003820}
3821
3822static int _setup_ssl_threads(void) {
3823
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003824 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003825
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003826 if (_ssl_locks == NULL) {
3827 _ssl_locks_count = CRYPTO_num_locks();
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003828 _ssl_locks = PyMem_New(PyThread_type_lock, _ssl_locks_count);
3829 if (_ssl_locks == NULL) {
3830 PyErr_NoMemory();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003831 return 0;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02003832 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003833 memset(_ssl_locks, 0,
3834 sizeof(PyThread_type_lock) * _ssl_locks_count);
3835 for (i = 0; i < _ssl_locks_count; i++) {
3836 _ssl_locks[i] = PyThread_allocate_lock();
3837 if (_ssl_locks[i] == NULL) {
3838 unsigned int j;
3839 for (j = 0; j < i; j++) {
3840 PyThread_free_lock(_ssl_locks[j]);
3841 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003842 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003843 return 0;
3844 }
3845 }
3846 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02003847#if OPENSSL_VERSION_NUMBER >= 0x10000000
3848 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
3849#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003850 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02003851#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003852 }
3853 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003854}
3855
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003856#endif /* def HAVE_THREAD */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003857
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003858PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003859"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003860for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003861
Martin v. Löwis1a214512008-06-11 05:26:20 +00003862
3863static struct PyModuleDef _sslmodule = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003864 PyModuleDef_HEAD_INIT,
3865 "_ssl",
3866 module_doc,
3867 -1,
3868 PySSL_methods,
3869 NULL,
3870 NULL,
3871 NULL,
3872 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003873};
3874
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02003875
3876static void
3877parse_openssl_version(unsigned long libver,
3878 unsigned int *major, unsigned int *minor,
3879 unsigned int *fix, unsigned int *patch,
3880 unsigned int *status)
3881{
3882 *status = libver & 0xF;
3883 libver >>= 4;
3884 *patch = libver & 0xFF;
3885 libver >>= 8;
3886 *fix = libver & 0xFF;
3887 libver >>= 8;
3888 *minor = libver & 0xFF;
3889 libver >>= 8;
3890 *major = libver & 0xFF;
3891}
3892
Mark Hammondfe51c6d2002-08-02 02:27:13 +00003893PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003894PyInit__ssl(void)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003895{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003896 PyObject *m, *d, *r;
3897 unsigned long libver;
3898 unsigned int major, minor, fix, patch, status;
3899 PySocketModule_APIObject *socket_api;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003900 struct py_ssl_error_code *errcode;
3901 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003902
Antoine Pitrou152efa22010-05-16 18:19:27 +00003903 if (PyType_Ready(&PySSLContext_Type) < 0)
3904 return NULL;
3905 if (PyType_Ready(&PySSLSocket_Type) < 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003906 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003907
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003908 m = PyModule_Create(&_sslmodule);
3909 if (m == NULL)
3910 return NULL;
3911 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003912
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003913 /* Load _socket module and its C API */
3914 socket_api = PySocketModule_ImportModuleAndAPI();
3915 if (!socket_api)
3916 return NULL;
3917 PySocketModule = *socket_api;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003918
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003919 /* Init OpenSSL */
3920 SSL_load_error_strings();
3921 SSL_library_init();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003922#ifdef WITH_THREAD
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003923 /* note that this will start threading if not already started */
3924 if (!_setup_ssl_threads()) {
3925 return NULL;
3926 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003927#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003928 OpenSSL_add_all_algorithms();
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003929
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003930 /* Add symbols to module dict */
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003931 sslerror_type_slots[0].pfunc = PyExc_OSError;
3932 PySSLErrorObject = PyType_FromSpec(&sslerror_type_spec);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003933 if (PySSLErrorObject == NULL)
3934 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003935
Antoine Pitrou41032a62011-10-27 23:56:55 +02003936 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
3937 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
3938 PySSLErrorObject, NULL);
3939 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
3940 "ssl.SSLWantReadError", SSLWantReadError_doc,
3941 PySSLErrorObject, NULL);
3942 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
3943 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
3944 PySSLErrorObject, NULL);
3945 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
3946 "ssl.SSLSyscallError", SSLSyscallError_doc,
3947 PySSLErrorObject, NULL);
3948 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
3949 "ssl.SSLEOFError", SSLEOFError_doc,
3950 PySSLErrorObject, NULL);
3951 if (PySSLZeroReturnErrorObject == NULL
3952 || PySSLWantReadErrorObject == NULL
3953 || PySSLWantWriteErrorObject == NULL
3954 || PySSLSyscallErrorObject == NULL
3955 || PySSLEOFErrorObject == NULL)
3956 return NULL;
3957 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
3958 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
3959 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
3960 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
3961 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
3962 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003963 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003964 if (PyDict_SetItemString(d, "_SSLContext",
3965 (PyObject *)&PySSLContext_Type) != 0)
3966 return NULL;
3967 if (PyDict_SetItemString(d, "_SSLSocket",
3968 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003969 return NULL;
3970 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
3971 PY_SSL_ERROR_ZERO_RETURN);
3972 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
3973 PY_SSL_ERROR_WANT_READ);
3974 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
3975 PY_SSL_ERROR_WANT_WRITE);
3976 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
3977 PY_SSL_ERROR_WANT_X509_LOOKUP);
3978 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
3979 PY_SSL_ERROR_SYSCALL);
3980 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
3981 PY_SSL_ERROR_SSL);
3982 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
3983 PY_SSL_ERROR_WANT_CONNECT);
3984 /* non ssl.h errorcodes */
3985 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
3986 PY_SSL_ERROR_EOF);
3987 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
3988 PY_SSL_ERROR_INVALID_ERROR_CODE);
3989 /* cert requirements */
3990 PyModule_AddIntConstant(m, "CERT_NONE",
3991 PY_SSL_CERT_NONE);
3992 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
3993 PY_SSL_CERT_OPTIONAL);
3994 PyModule_AddIntConstant(m, "CERT_REQUIRED",
3995 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01003996 /* CRL verification for verification_flags */
3997 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
3998 0);
3999 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
4000 X509_V_FLAG_CRL_CHECK);
4001 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
4002 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
4003 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
4004 X509_V_FLAG_X509_STRICT);
Benjamin Peterson990fcaa2015-03-04 22:49:41 -05004005#ifdef X509_V_FLAG_TRUSTED_FIRST
4006 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
4007 X509_V_FLAG_TRUSTED_FIRST);
4008#endif
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00004009
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004010 /* Alert Descriptions from ssl.h */
4011 /* note RESERVED constants no longer intended for use have been removed */
4012 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
4013
4014#define ADD_AD_CONSTANT(s) \
4015 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
4016 SSL_AD_##s)
4017
4018 ADD_AD_CONSTANT(CLOSE_NOTIFY);
4019 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
4020 ADD_AD_CONSTANT(BAD_RECORD_MAC);
4021 ADD_AD_CONSTANT(RECORD_OVERFLOW);
4022 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
4023 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
4024 ADD_AD_CONSTANT(BAD_CERTIFICATE);
4025 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
4026 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
4027 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
4028 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
4029 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
4030 ADD_AD_CONSTANT(UNKNOWN_CA);
4031 ADD_AD_CONSTANT(ACCESS_DENIED);
4032 ADD_AD_CONSTANT(DECODE_ERROR);
4033 ADD_AD_CONSTANT(DECRYPT_ERROR);
4034 ADD_AD_CONSTANT(PROTOCOL_VERSION);
4035 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
4036 ADD_AD_CONSTANT(INTERNAL_ERROR);
4037 ADD_AD_CONSTANT(USER_CANCELLED);
4038 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004039 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004040#ifdef SSL_AD_UNSUPPORTED_EXTENSION
4041 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
4042#endif
4043#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
4044 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
4045#endif
4046#ifdef SSL_AD_UNRECOGNIZED_NAME
4047 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
4048#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004049#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
4050 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
4051#endif
4052#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
4053 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
4054#endif
4055#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
4056 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
4057#endif
4058
4059#undef ADD_AD_CONSTANT
4060
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004061 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02004062#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004063 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
4064 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02004065#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05004066#ifndef OPENSSL_NO_SSL3
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004067 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
4068 PY_SSL_VERSION_SSL3);
Benjamin Petersone32467c2014-12-05 21:59:35 -05004069#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004070 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
4071 PY_SSL_VERSION_SSL23);
4072 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
4073 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004074#if HAVE_TLSv1_2
4075 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
4076 PY_SSL_VERSION_TLS1_1);
4077 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
4078 PY_SSL_VERSION_TLS1_2);
4079#endif
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004080
Antoine Pitroub5218772010-05-21 09:56:06 +00004081 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01004082 PyModule_AddIntConstant(m, "OP_ALL",
4083 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00004084 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
4085 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
4086 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004087#if HAVE_TLSv1_2
4088 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
4089 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
4090#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01004091 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
4092 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004093 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004094#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004095 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004096#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01004097#ifdef SSL_OP_NO_COMPRESSION
4098 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
4099 SSL_OP_NO_COMPRESSION);
4100#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00004101
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004102#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +00004103 r = Py_True;
4104#else
4105 r = Py_False;
4106#endif
4107 Py_INCREF(r);
4108 PyModule_AddObject(m, "HAS_SNI", r);
4109
Antoine Pitroud6494802011-07-21 01:11:30 +02004110#if HAVE_OPENSSL_FINISHED
4111 r = Py_True;
4112#else
4113 r = Py_False;
4114#endif
4115 Py_INCREF(r);
4116 PyModule_AddObject(m, "HAS_TLS_UNIQUE", r);
4117
Antoine Pitrou501da612011-12-21 09:27:41 +01004118#ifdef OPENSSL_NO_ECDH
4119 r = Py_False;
4120#else
4121 r = Py_True;
4122#endif
4123 Py_INCREF(r);
4124 PyModule_AddObject(m, "HAS_ECDH", r);
4125
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01004126#ifdef OPENSSL_NPN_NEGOTIATED
4127 r = Py_True;
4128#else
4129 r = Py_False;
4130#endif
4131 Py_INCREF(r);
4132 PyModule_AddObject(m, "HAS_NPN", r);
4133
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004134 /* Mappings for error codes */
4135 err_codes_to_names = PyDict_New();
4136 err_names_to_codes = PyDict_New();
4137 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
4138 return NULL;
4139 errcode = error_codes;
4140 while (errcode->mnemonic != NULL) {
4141 PyObject *mnemo, *key;
4142 mnemo = PyUnicode_FromString(errcode->mnemonic);
4143 key = Py_BuildValue("ii", errcode->library, errcode->reason);
4144 if (mnemo == NULL || key == NULL)
4145 return NULL;
4146 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
4147 return NULL;
4148 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
4149 return NULL;
4150 Py_DECREF(key);
4151 Py_DECREF(mnemo);
4152 errcode++;
4153 }
4154 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
4155 return NULL;
4156 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
4157 return NULL;
4158
4159 lib_codes_to_names = PyDict_New();
4160 if (lib_codes_to_names == NULL)
4161 return NULL;
4162 libcode = library_codes;
4163 while (libcode->library != NULL) {
4164 PyObject *mnemo, *key;
4165 key = PyLong_FromLong(libcode->code);
4166 mnemo = PyUnicode_FromString(libcode->library);
4167 if (key == NULL || mnemo == NULL)
4168 return NULL;
4169 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
4170 return NULL;
4171 Py_DECREF(key);
4172 Py_DECREF(mnemo);
4173 libcode++;
4174 }
4175 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
4176 return NULL;
Victor Stinner4569cd52013-06-23 14:58:43 +02004177
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004178 /* OpenSSL version */
4179 /* SSLeay() gives us the version of the library linked against,
4180 which could be different from the headers version.
4181 */
4182 libver = SSLeay();
4183 r = PyLong_FromUnsignedLong(libver);
4184 if (r == NULL)
4185 return NULL;
4186 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
4187 return NULL;
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004188 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004189 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4190 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
4191 return NULL;
4192 r = PyUnicode_FromString(SSLeay_version(SSLEAY_VERSION));
4193 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
4194 return NULL;
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004195
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004196 libver = OPENSSL_VERSION_NUMBER;
4197 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
4198 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4199 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
4200 return NULL;
4201
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004202 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004203}