blob: 1c68000b9aa9994b4996475944f8d9a6ebbb3aa8 [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"
Antoine Pitroub1fdf472014-10-05 20:41:53 +020067#include "openssl/bio.h"
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010068
69/* SSL error object */
70static PyObject *PySSLErrorObject;
71static PyObject *PySSLZeroReturnErrorObject;
72static PyObject *PySSLWantReadErrorObject;
73static PyObject *PySSLWantWriteErrorObject;
74static PyObject *PySSLSyscallErrorObject;
75static PyObject *PySSLEOFErrorObject;
76
77/* Error mappings */
78static PyObject *err_codes_to_names;
79static PyObject *err_names_to_codes;
80static PyObject *lib_codes_to_names;
81
82struct py_ssl_error_code {
83 const char *mnemonic;
84 int library, reason;
85};
86struct py_ssl_library_code {
87 const char *library;
88 int code;
89};
90
91/* Include generated data (error codes) */
92#include "_ssl_data.h"
93
94/* Openssl comes with TLSv1.1 and TLSv1.2 between 1.0.0h and 1.0.1
95 http://www.openssl.org/news/changelog.html
96 */
97#if OPENSSL_VERSION_NUMBER >= 0x10001000L
98# define HAVE_TLSv1_2 1
99#else
100# define HAVE_TLSv1_2 0
101#endif
102
Christian Heimes470fba12013-11-28 15:12:15 +0100103/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100104 * This includes the SSL_set_SSL_CTX() function.
105 */
106#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
107# define HAVE_SNI 1
108#else
109# define HAVE_SNI 0
110#endif
111
Benjamin Petersond3308222015-09-27 00:09:02 -0700112#ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
Benjamin Petersoncca27322015-01-23 16:35:37 -0500113# define HAVE_ALPN
114#endif
115
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000116enum py_ssl_error {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000117 /* these mirror ssl.h */
118 PY_SSL_ERROR_NONE,
119 PY_SSL_ERROR_SSL,
120 PY_SSL_ERROR_WANT_READ,
121 PY_SSL_ERROR_WANT_WRITE,
122 PY_SSL_ERROR_WANT_X509_LOOKUP,
123 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
124 PY_SSL_ERROR_ZERO_RETURN,
125 PY_SSL_ERROR_WANT_CONNECT,
126 /* start of non ssl.h errorcodes */
127 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
128 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
129 PY_SSL_ERROR_INVALID_ERROR_CODE
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000130};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000131
Thomas Woutersed03b412007-08-28 21:37:11 +0000132enum py_ssl_server_or_client {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000133 PY_SSL_CLIENT,
134 PY_SSL_SERVER
Thomas Woutersed03b412007-08-28 21:37:11 +0000135};
136
137enum py_ssl_cert_requirements {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000138 PY_SSL_CERT_NONE,
139 PY_SSL_CERT_OPTIONAL,
140 PY_SSL_CERT_REQUIRED
Thomas Woutersed03b412007-08-28 21:37:11 +0000141};
142
143enum py_ssl_version {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000144 PY_SSL_VERSION_SSL2,
Victor Stinner3de49192011-05-09 00:42:58 +0200145 PY_SSL_VERSION_SSL3=1,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000146 PY_SSL_VERSION_SSL23,
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100147#if HAVE_TLSv1_2
148 PY_SSL_VERSION_TLS1,
149 PY_SSL_VERSION_TLS1_1,
150 PY_SSL_VERSION_TLS1_2
151#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000152 PY_SSL_VERSION_TLS1
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000153#endif
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100154};
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200155
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000156#ifdef WITH_THREAD
157
158/* serves as a flag to see whether we've initialized the SSL thread support. */
159/* 0 means no, greater than 0 means yes */
160
161static unsigned int _ssl_locks_count = 0;
162
163#endif /* def WITH_THREAD */
164
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000165/* SSL socket object */
166
167#define X509_NAME_MAXLEN 256
168
Gregory P. Smithbd4dacb2010-10-13 03:53:21 +0000169/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
170 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
171 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
172#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
Antoine Pitroub5218772010-05-21 09:56:06 +0000173# define HAVE_SSL_CTX_CLEAR_OPTIONS
174#else
175# undef HAVE_SSL_CTX_CLEAR_OPTIONS
176#endif
177
Antoine Pitroud6494802011-07-21 01:11:30 +0200178/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
179 * older SSL, but let's be safe */
180#define PySSL_CB_MAXLEN 128
181
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100182
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000183typedef struct {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000184 PyObject_HEAD
Antoine Pitrou152efa22010-05-16 18:19:27 +0000185 SSL_CTX *ctx;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100186#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersoncca27322015-01-23 16:35:37 -0500187 unsigned char *npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100188 int npn_protocols_len;
189#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -0500190#ifdef HAVE_ALPN
191 unsigned char *alpn_protocols;
192 int alpn_protocols_len;
193#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100194#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +0200195 PyObject *set_hostname;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100196#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +0100197 int check_hostname;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000198} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000199
Antoine Pitrou152efa22010-05-16 18:19:27 +0000200typedef struct {
201 PyObject_HEAD
202 PyObject *Socket; /* weakref to socket on which we're layered */
203 SSL *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100204 PySSLContext *ctx; /* weakref to SSL context */
Antoine Pitrou152efa22010-05-16 18:19:27 +0000205 X509 *peer_cert;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200206 char shutdown_seen_zero;
207 char handshake_done;
Antoine Pitroud6494802011-07-21 01:11:30 +0200208 enum py_ssl_server_or_client socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200209 PyObject *owner; /* Python level "owner" passed to servername callback */
210 PyObject *server_hostname;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000211} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000212
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200213typedef struct {
214 PyObject_HEAD
215 BIO *bio;
216 int eof_written;
217} PySSLMemoryBIO;
218
Antoine Pitrou152efa22010-05-16 18:19:27 +0000219static PyTypeObject PySSLContext_Type;
220static PyTypeObject PySSLSocket_Type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200221static PyTypeObject PySSLMemoryBIO_Type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000222
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300223/*[clinic input]
224module _ssl
225class _ssl._SSLContext "PySSLContext *" "&PySSLContext_Type"
226class _ssl._SSLSocket "PySSLSocket *" "&PySSLSocket_Type"
227class _ssl.MemoryBIO "PySSLMemoryBIO *" "&PySSLMemoryBIO_Type"
228[clinic start generated code]*/
229/*[clinic end generated code: output=da39a3ee5e6b4b0d input=7bf7cb832638e2e1]*/
230
231#include "clinic/_ssl.c.h"
232
Victor Stinner14690702015-04-06 22:46:13 +0200233static int PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000234
Antoine Pitrou152efa22010-05-16 18:19:27 +0000235#define PySSLContext_Check(v) (Py_TYPE(v) == &PySSLContext_Type)
236#define PySSLSocket_Check(v) (Py_TYPE(v) == &PySSLSocket_Type)
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200237#define PySSLMemoryBIO_Check(v) (Py_TYPE(v) == &PySSLMemoryBIO_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000238
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000239typedef enum {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000240 SOCKET_IS_NONBLOCKING,
241 SOCKET_IS_BLOCKING,
242 SOCKET_HAS_TIMED_OUT,
243 SOCKET_HAS_BEEN_CLOSED,
244 SOCKET_TOO_LARGE_FOR_SELECT,
245 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000246} timeout_state;
247
Thomas Woutersed03b412007-08-28 21:37:11 +0000248/* Wrap error strings with filename and line # */
Thomas Woutersed03b412007-08-28 21:37:11 +0000249#define ERRSTR1(x,y,z) (x ":" y ": " z)
Victor Stinner45e8e2f2014-05-14 17:24:35 +0200250#define ERRSTR(x) ERRSTR1("_ssl.c", Py_STRINGIFY(__LINE__), x)
Thomas Woutersed03b412007-08-28 21:37:11 +0000251
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200252/* Get the socket from a PySSLSocket, if it has one */
253#define GET_SOCKET(obj) ((obj)->Socket ? \
254 (PySocketSockObject *) PyWeakref_GetObject((obj)->Socket) : NULL)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200255
Victor Stinner14690702015-04-06 22:46:13 +0200256/* If sock is NULL, use a timeout of 0 second */
257#define GET_SOCKET_TIMEOUT(sock) \
258 ((sock != NULL) ? (sock)->sock_timeout : 0)
259
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200260/*
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) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200422 PySocketSockObject *s = GET_SOCKET(obj);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000423 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000424 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200425 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000426 errstr = "EOF occurred in violation of protocol";
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200427 } else if (s && ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000428 /* underlying BIO reported an I/O error */
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000429 Py_INCREF(s);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000430 ERR_clear_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200431 s->errorhandler();
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000432 Py_DECREF(s);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200433 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000434 } else { /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000435 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200436 type = PySSLSyscallErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000437 errstr = "Some I/O error occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000438 }
439 } else {
440 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000441 }
442 break;
443 }
444 case SSL_ERROR_SSL:
445 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000446 p = PY_SSL_ERROR_SSL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200447 if (e == 0)
448 /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000449 errstr = "A failure in the SSL library occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000450 break;
451 }
452 default:
453 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
454 errstr = "Invalid error code";
455 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000456 }
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200457 fill_and_set_sslerror(type, p, errstr, lineno, e);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000458 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000459 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000460}
461
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000462static PyObject *
463_setSSLError (char *errstr, int errcode, char *filename, int lineno) {
464
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200465 if (errstr == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000466 errcode = ERR_peek_last_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200467 else
468 errcode = 0;
469 fill_and_set_sslerror(PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000470 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000471 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000472}
473
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200474/*
475 * SSL objects
476 */
477
Antoine Pitrou152efa22010-05-16 18:19:27 +0000478static PySSLSocket *
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100479newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
Antoine Pitroud5323212010-10-22 18:19:07 +0000480 enum py_ssl_server_or_client socket_type,
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200481 char *server_hostname,
482 PySSLMemoryBIO *inbio, PySSLMemoryBIO *outbio)
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 Pitroub1fdf472014-10-05 20:41:53 +0200486 PyObject *hostname;
Antoine Pitrou19fef692013-05-25 13:23:03 +0200487 long mode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000488
Antoine Pitrou152efa22010-05-16 18:19:27 +0000489 self = PyObject_New(PySSLSocket, &PySSLSocket_Type);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000490 if (self == NULL)
491 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000492
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000493 self->peer_cert = NULL;
494 self->ssl = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000495 self->Socket = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100496 self->ctx = sslctx;
Antoine Pitrou860aee72013-09-29 19:52:45 +0200497 self->shutdown_seen_zero = 0;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200498 self->handshake_done = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200499 self->owner = NULL;
500 if (server_hostname != NULL) {
501 hostname = PyUnicode_Decode(server_hostname, strlen(server_hostname),
502 "idna", "strict");
503 if (hostname == NULL) {
504 Py_DECREF(self);
505 return NULL;
506 }
507 self->server_hostname = hostname;
508 } else
509 self->server_hostname = NULL;
510
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100511 Py_INCREF(sslctx);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000512
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000513 /* Make sure the SSL error state is initialized */
514 (void) ERR_get_state();
515 ERR_clear_error();
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000516
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000517 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitrou152efa22010-05-16 18:19:27 +0000518 self->ssl = SSL_new(ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000519 PySSL_END_ALLOW_THREADS
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200520 SSL_set_app_data(self->ssl, self);
521 if (sock) {
522 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
523 } else {
524 /* BIOs are reference counted and SSL_set_bio borrows our reference.
525 * To prevent a double free in memory_bio_dealloc() we need to take an
526 * extra reference here. */
527 CRYPTO_add(&inbio->bio->references, 1, CRYPTO_LOCK_BIO);
528 CRYPTO_add(&outbio->bio->references, 1, CRYPTO_LOCK_BIO);
529 SSL_set_bio(self->ssl, inbio->bio, outbio->bio);
530 }
Antoine Pitrou19fef692013-05-25 13:23:03 +0200531 mode = SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000532#ifdef SSL_MODE_AUTO_RETRY
Antoine Pitrou19fef692013-05-25 13:23:03 +0200533 mode |= SSL_MODE_AUTO_RETRY;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000534#endif
Antoine Pitrou19fef692013-05-25 13:23:03 +0200535 SSL_set_mode(self->ssl, mode);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000536
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100537#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +0000538 if (server_hostname != NULL)
539 SSL_set_tlsext_host_name(self->ssl, server_hostname);
540#endif
541
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000542 /* If the socket is in non-blocking mode or timeout mode, set the BIO
543 * to non-blocking mode (blocking is the default)
544 */
Victor Stinnere2452312015-03-28 03:00:46 +0100545 if (sock && sock->sock_timeout >= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000546 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
547 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
548 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000549
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000550 PySSL_BEGIN_ALLOW_THREADS
551 if (socket_type == PY_SSL_CLIENT)
552 SSL_set_connect_state(self->ssl);
553 else
554 SSL_set_accept_state(self->ssl);
555 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000556
Antoine Pitroud6494802011-07-21 01:11:30 +0200557 self->socket_type = socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200558 if (sock != NULL) {
559 self->Socket = PyWeakref_NewRef((PyObject *) sock, NULL);
560 if (self->Socket == NULL) {
561 Py_DECREF(self);
562 Py_XDECREF(self->server_hostname);
563 return NULL;
564 }
Victor Stinnera9eb38f2013-10-31 16:35:38 +0100565 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000566 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000567}
568
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000569/* SSL object methods */
570
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300571/*[clinic input]
572_ssl._SSLSocket.do_handshake
573[clinic start generated code]*/
574
575static PyObject *
576_ssl__SSLSocket_do_handshake_impl(PySSLSocket *self)
577/*[clinic end generated code: output=6c0898a8936548f6 input=d2d737de3df018c8]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000578{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000579 int ret;
580 int err;
581 int sockstate, nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200582 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +0200583 _PyTime_t timeout, deadline = 0;
584 int has_timeout;
Antoine Pitroud3f8ab82010-04-24 21:26:44 +0000585
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200586 if (sock) {
587 if (((PyObject*)sock) == Py_None) {
588 _setSSLError("Underlying socket connection gone",
589 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
590 return NULL;
591 }
592 Py_INCREF(sock);
593
594 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +0100595 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200596 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
597 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000598 }
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000599
Victor Stinner14690702015-04-06 22:46:13 +0200600 timeout = GET_SOCKET_TIMEOUT(sock);
601 has_timeout = (timeout > 0);
602 if (has_timeout)
603 deadline = _PyTime_GetMonotonicClock() + timeout;
604
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000605 /* Actually negotiate SSL connection */
606 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000607 do {
Bill Janssen6e027db2007-11-15 22:23:56 +0000608 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000609 ret = SSL_do_handshake(self->ssl);
610 err = SSL_get_error(self->ssl, ret);
611 PySSL_END_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +0200612
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000613 if (PyErr_CheckSignals())
614 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +0200615
Victor Stinner14690702015-04-06 22:46:13 +0200616 if (has_timeout)
617 timeout = deadline - _PyTime_GetMonotonicClock();
618
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000619 if (err == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +0200620 sockstate = PySSL_select(sock, 0, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000621 } else if (err == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +0200622 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000623 } else {
624 sockstate = SOCKET_OPERATION_OK;
625 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +0200626
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000627 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +0000628 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000629 ERRSTR("The handshake operation timed out"));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000630 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000631 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
632 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000633 ERRSTR("Underlying socket has been closed."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000634 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000635 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
636 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000637 ERRSTR("Underlying socket too large for select()."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000638 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000639 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
640 break;
641 }
642 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200643 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000644 if (ret < 1)
645 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Bill Janssen6e027db2007-11-15 22:23:56 +0000646
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000647 if (self->peer_cert)
648 X509_free (self->peer_cert);
649 PySSL_BEGIN_ALLOW_THREADS
650 self->peer_cert = SSL_get_peer_certificate(self->ssl);
651 PySSL_END_ALLOW_THREADS
Antoine Pitrou20b85552013-09-29 19:50:53 +0200652 self->handshake_done = 1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000653
654 Py_INCREF(Py_None);
655 return Py_None;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000656
657error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200658 Py_XDECREF(sock);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000659 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000660}
661
Thomas Woutersed03b412007-08-28 21:37:11 +0000662static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000663_create_tuple_for_attribute (ASN1_OBJECT *name, ASN1_STRING *value) {
Thomas Woutersed03b412007-08-28 21:37:11 +0000664
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000665 char namebuf[X509_NAME_MAXLEN];
666 int buflen;
667 PyObject *name_obj;
668 PyObject *value_obj;
669 PyObject *attr;
670 unsigned char *valuebuf = NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000671
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000672 buflen = OBJ_obj2txt(namebuf, sizeof(namebuf), name, 0);
673 if (buflen < 0) {
674 _setSSLError(NULL, 0, __FILE__, __LINE__);
675 goto fail;
676 }
677 name_obj = PyUnicode_FromStringAndSize(namebuf, buflen);
678 if (name_obj == NULL)
679 goto fail;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000680
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000681 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
682 if (buflen < 0) {
683 _setSSLError(NULL, 0, __FILE__, __LINE__);
684 Py_DECREF(name_obj);
685 goto fail;
686 }
687 value_obj = PyUnicode_DecodeUTF8((char *) valuebuf,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000688 buflen, "strict");
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000689 OPENSSL_free(valuebuf);
690 if (value_obj == NULL) {
691 Py_DECREF(name_obj);
692 goto fail;
693 }
694 attr = PyTuple_New(2);
695 if (attr == NULL) {
696 Py_DECREF(name_obj);
697 Py_DECREF(value_obj);
698 goto fail;
699 }
700 PyTuple_SET_ITEM(attr, 0, name_obj);
701 PyTuple_SET_ITEM(attr, 1, value_obj);
702 return attr;
Thomas Woutersed03b412007-08-28 21:37:11 +0000703
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000704 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000705 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000706}
707
708static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000709_create_tuple_for_X509_NAME (X509_NAME *xname)
Thomas Woutersed03b412007-08-28 21:37:11 +0000710{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000711 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
712 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
713 PyObject *rdnt;
714 PyObject *attr = NULL; /* tuple to hold an attribute */
715 int entry_count = X509_NAME_entry_count(xname);
716 X509_NAME_ENTRY *entry;
717 ASN1_OBJECT *name;
718 ASN1_STRING *value;
719 int index_counter;
720 int rdn_level = -1;
721 int retcode;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000722
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000723 dn = PyList_New(0);
724 if (dn == NULL)
725 return NULL;
726 /* now create another tuple to hold the top-level RDN */
727 rdn = PyList_New(0);
728 if (rdn == NULL)
729 goto fail0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000730
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000731 for (index_counter = 0;
732 index_counter < entry_count;
733 index_counter++)
734 {
735 entry = X509_NAME_get_entry(xname, index_counter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000736
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000737 /* check to see if we've gotten to a new RDN */
738 if (rdn_level >= 0) {
739 if (rdn_level != entry->set) {
740 /* yes, new RDN */
741 /* add old RDN to DN */
742 rdnt = PyList_AsTuple(rdn);
743 Py_DECREF(rdn);
744 if (rdnt == NULL)
745 goto fail0;
746 retcode = PyList_Append(dn, rdnt);
747 Py_DECREF(rdnt);
748 if (retcode < 0)
749 goto fail0;
750 /* create new RDN */
751 rdn = PyList_New(0);
752 if (rdn == NULL)
753 goto fail0;
754 }
755 }
756 rdn_level = entry->set;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000757
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000758 /* now add this attribute to the current RDN */
759 name = X509_NAME_ENTRY_get_object(entry);
760 value = X509_NAME_ENTRY_get_data(entry);
761 attr = _create_tuple_for_attribute(name, value);
762 /*
763 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
764 entry->set,
765 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
766 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
767 */
768 if (attr == NULL)
769 goto fail1;
770 retcode = PyList_Append(rdn, attr);
771 Py_DECREF(attr);
772 if (retcode < 0)
773 goto fail1;
774 }
775 /* now, there's typically a dangling RDN */
Antoine Pitrou2f5a1632012-02-15 22:25:27 +0100776 if (rdn != NULL) {
777 if (PyList_GET_SIZE(rdn) > 0) {
778 rdnt = PyList_AsTuple(rdn);
779 Py_DECREF(rdn);
780 if (rdnt == NULL)
781 goto fail0;
782 retcode = PyList_Append(dn, rdnt);
783 Py_DECREF(rdnt);
784 if (retcode < 0)
785 goto fail0;
786 }
787 else {
788 Py_DECREF(rdn);
789 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000790 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000791
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000792 /* convert list to tuple */
793 rdnt = PyList_AsTuple(dn);
794 Py_DECREF(dn);
795 if (rdnt == NULL)
796 return NULL;
797 return rdnt;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000798
799 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000800 Py_XDECREF(rdn);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000801
802 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000803 Py_XDECREF(dn);
804 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000805}
806
807static PyObject *
808_get_peer_alt_names (X509 *certificate) {
Guido van Rossumf06628b2007-11-21 20:01:53 +0000809
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000810 /* this code follows the procedure outlined in
811 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
812 function to extract the STACK_OF(GENERAL_NAME),
813 then iterates through the stack to add the
814 names. */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000815
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000816 int i, j;
817 PyObject *peer_alt_names = Py_None;
Christian Heimes60bf2fc2013-09-05 16:04:35 +0200818 PyObject *v = NULL, *t;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000819 X509_EXTENSION *ext = NULL;
820 GENERAL_NAMES *names = NULL;
821 GENERAL_NAME *name;
Benjamin Petersoneb1410f2010-10-13 22:06:39 +0000822 const X509V3_EXT_METHOD *method;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000823 BIO *biobuf = NULL;
824 char buf[2048];
825 char *vptr;
826 int len;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000827 const unsigned char *p;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000828
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000829 if (certificate == NULL)
830 return peer_alt_names;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000831
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000832 /* get a memory buffer */
833 biobuf = BIO_new(BIO_s_mem());
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000834
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200835 i = -1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000836 while ((i = X509_get_ext_by_NID(
837 certificate, NID_subject_alt_name, i)) >= 0) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000839 if (peer_alt_names == Py_None) {
840 peer_alt_names = PyList_New(0);
841 if (peer_alt_names == NULL)
842 goto fail;
843 }
Guido van Rossumf06628b2007-11-21 20:01:53 +0000844
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000845 /* now decode the altName */
846 ext = X509_get_ext(certificate, i);
847 if(!(method = X509V3_EXT_get(ext))) {
848 PyErr_SetString
849 (PySSLErrorObject,
850 ERRSTR("No method for internalizing subjectAltName!"));
851 goto fail;
852 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000853
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000854 p = ext->value->data;
855 if (method->it)
856 names = (GENERAL_NAMES*)
857 (ASN1_item_d2i(NULL,
858 &p,
859 ext->value->length,
860 ASN1_ITEM_ptr(method->it)));
861 else
862 names = (GENERAL_NAMES*)
863 (method->d2i(NULL,
864 &p,
865 ext->value->length));
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000866
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000867 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000868 /* get a rendering of each name in the set of names */
Christian Heimes824f7f32013-08-17 00:54:47 +0200869 int gntype;
870 ASN1_STRING *as = NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000871
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000872 name = sk_GENERAL_NAME_value(names, j);
Christian Heimes474afdd2013-08-17 17:18:56 +0200873 gntype = name->type;
Christian Heimes824f7f32013-08-17 00:54:47 +0200874 switch (gntype) {
875 case GEN_DIRNAME:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000876 /* we special-case DirName as a tuple of
877 tuples of attributes */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000878
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000879 t = PyTuple_New(2);
880 if (t == NULL) {
881 goto fail;
882 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000883
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000884 v = PyUnicode_FromString("DirName");
885 if (v == NULL) {
886 Py_DECREF(t);
887 goto fail;
888 }
889 PyTuple_SET_ITEM(t, 0, v);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000890
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000891 v = _create_tuple_for_X509_NAME (name->d.dirn);
892 if (v == NULL) {
893 Py_DECREF(t);
894 goto fail;
895 }
896 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200897 break;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000898
Christian Heimes824f7f32013-08-17 00:54:47 +0200899 case GEN_EMAIL:
900 case GEN_DNS:
901 case GEN_URI:
902 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
903 correctly, CVE-2013-4238 */
904 t = PyTuple_New(2);
905 if (t == NULL)
906 goto fail;
907 switch (gntype) {
908 case GEN_EMAIL:
909 v = PyUnicode_FromString("email");
910 as = name->d.rfc822Name;
911 break;
912 case GEN_DNS:
913 v = PyUnicode_FromString("DNS");
914 as = name->d.dNSName;
915 break;
916 case GEN_URI:
917 v = PyUnicode_FromString("URI");
918 as = name->d.uniformResourceIdentifier;
919 break;
920 }
921 if (v == NULL) {
922 Py_DECREF(t);
923 goto fail;
924 }
925 PyTuple_SET_ITEM(t, 0, v);
926 v = PyUnicode_FromStringAndSize((char *)ASN1_STRING_data(as),
927 ASN1_STRING_length(as));
928 if (v == NULL) {
929 Py_DECREF(t);
930 goto fail;
931 }
932 PyTuple_SET_ITEM(t, 1, v);
933 break;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000934
Christian Heimes824f7f32013-08-17 00:54:47 +0200935 default:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000936 /* for everything else, we use the OpenSSL print form */
Christian Heimes824f7f32013-08-17 00:54:47 +0200937 switch (gntype) {
938 /* check for new general name type */
939 case GEN_OTHERNAME:
940 case GEN_X400:
941 case GEN_EDIPARTY:
942 case GEN_IPADD:
943 case GEN_RID:
944 break;
945 default:
946 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
947 "Unknown general name type %d",
948 gntype) == -1) {
949 goto fail;
950 }
951 break;
952 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000953 (void) BIO_reset(biobuf);
954 GENERAL_NAME_print(biobuf, name);
955 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
956 if (len < 0) {
957 _setSSLError(NULL, 0, __FILE__, __LINE__);
958 goto fail;
959 }
960 vptr = strchr(buf, ':');
961 if (vptr == NULL)
962 goto fail;
963 t = PyTuple_New(2);
964 if (t == NULL)
965 goto fail;
966 v = PyUnicode_FromStringAndSize(buf, (vptr - buf));
967 if (v == NULL) {
968 Py_DECREF(t);
969 goto fail;
970 }
971 PyTuple_SET_ITEM(t, 0, v);
972 v = PyUnicode_FromStringAndSize((vptr + 1),
973 (len - (vptr - buf + 1)));
974 if (v == NULL) {
975 Py_DECREF(t);
976 goto fail;
977 }
978 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200979 break;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000980 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000981
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000982 /* and add that rendering to the list */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000983
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000984 if (PyList_Append(peer_alt_names, t) < 0) {
985 Py_DECREF(t);
986 goto fail;
987 }
988 Py_DECREF(t);
989 }
Antoine Pitrou116d6b92011-11-23 01:39:19 +0100990 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000991 }
992 BIO_free(biobuf);
993 if (peer_alt_names != Py_None) {
994 v = PyList_AsTuple(peer_alt_names);
995 Py_DECREF(peer_alt_names);
996 return v;
997 } else {
998 return peer_alt_names;
999 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001000
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001001
1002 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001003 if (biobuf != NULL)
1004 BIO_free(biobuf);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001005
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001006 if (peer_alt_names != Py_None) {
1007 Py_XDECREF(peer_alt_names);
1008 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001009
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001010 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001011}
1012
1013static PyObject *
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001014_get_aia_uri(X509 *certificate, int nid) {
1015 PyObject *lst = NULL, *ostr = NULL;
1016 int i, result;
1017 AUTHORITY_INFO_ACCESS *info;
1018
1019 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
Benjamin Petersonf0c90382015-11-14 15:12:18 -08001020 if (info == NULL)
1021 return Py_None;
1022 if (sk_ACCESS_DESCRIPTION_num(info) == 0) {
1023 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001024 return Py_None;
1025 }
1026
1027 if ((lst = PyList_New(0)) == NULL) {
1028 goto fail;
1029 }
1030
1031 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
1032 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
1033 ASN1_IA5STRING *uri;
1034
1035 if ((OBJ_obj2nid(ad->method) != nid) ||
1036 (ad->location->type != GEN_URI)) {
1037 continue;
1038 }
1039 uri = ad->location->d.uniformResourceIdentifier;
1040 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
1041 uri->length);
1042 if (ostr == NULL) {
1043 goto fail;
1044 }
1045 result = PyList_Append(lst, ostr);
1046 Py_DECREF(ostr);
1047 if (result < 0) {
1048 goto fail;
1049 }
1050 }
1051 AUTHORITY_INFO_ACCESS_free(info);
1052
1053 /* convert to tuple or None */
1054 if (PyList_Size(lst) == 0) {
1055 Py_DECREF(lst);
1056 return Py_None;
1057 } else {
1058 PyObject *tup;
1059 tup = PyList_AsTuple(lst);
1060 Py_DECREF(lst);
1061 return tup;
1062 }
1063
1064 fail:
1065 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimes18fc7be2013-11-21 23:57:49 +01001066 Py_XDECREF(lst);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001067 return NULL;
1068}
1069
1070static PyObject *
1071_get_crl_dp(X509 *certificate) {
1072 STACK_OF(DIST_POINT) *dps;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001073 int i, j;
1074 PyObject *lst, *res = NULL;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001075
Christian Heimes949ec142013-11-21 16:26:51 +01001076#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001077 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points, NULL, NULL);
Christian Heimes949ec142013-11-21 16:26:51 +01001078#else
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001079 /* Calls x509v3_cache_extensions and sets up crldp */
1080 X509_check_ca(certificate);
1081 dps = certificate->crldp;
Christian Heimes949ec142013-11-21 16:26:51 +01001082#endif
1083
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001084 if (dps == NULL)
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001085 return Py_None;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001086
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001087 lst = PyList_New(0);
1088 if (lst == NULL)
1089 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001090
1091 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1092 DIST_POINT *dp;
1093 STACK_OF(GENERAL_NAME) *gns;
1094
1095 dp = sk_DIST_POINT_value(dps, i);
1096 gns = dp->distpoint->name.fullname;
1097
1098 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1099 GENERAL_NAME *gn;
1100 ASN1_IA5STRING *uri;
1101 PyObject *ouri;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001102 int err;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001103
1104 gn = sk_GENERAL_NAME_value(gns, j);
1105 if (gn->type != GEN_URI) {
1106 continue;
1107 }
1108 uri = gn->d.uniformResourceIdentifier;
1109 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1110 uri->length);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001111 if (ouri == NULL)
1112 goto done;
1113
1114 err = PyList_Append(lst, ouri);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001115 Py_DECREF(ouri);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001116 if (err < 0)
1117 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001118 }
1119 }
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001120
1121 /* Convert to tuple. */
1122 res = (PyList_GET_SIZE(lst) > 0) ? PyList_AsTuple(lst) : Py_None;
1123
1124 done:
1125 Py_XDECREF(lst);
1126#if OPENSSL_VERSION_NUMBER < 0x10001000L
Benjamin Peterson806fb252015-11-14 00:09:22 -08001127 sk_DIST_POINT_free(dps);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001128#endif
1129 return res;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001130}
1131
1132static PyObject *
Antoine Pitroufb046912010-11-09 20:21:19 +00001133_decode_certificate(X509 *certificate) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001134
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001135 PyObject *retval = NULL;
1136 BIO *biobuf = NULL;
1137 PyObject *peer;
1138 PyObject *peer_alt_names = NULL;
1139 PyObject *issuer;
1140 PyObject *version;
1141 PyObject *sn_obj;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001142 PyObject *obj;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001143 ASN1_INTEGER *serialNumber;
1144 char buf[2048];
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001145 int len, result;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001146 ASN1_TIME *notBefore, *notAfter;
1147 PyObject *pnotBefore, *pnotAfter;
Thomas Woutersed03b412007-08-28 21:37:11 +00001148
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001149 retval = PyDict_New();
1150 if (retval == NULL)
1151 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001152
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001153 peer = _create_tuple_for_X509_NAME(
1154 X509_get_subject_name(certificate));
1155 if (peer == NULL)
1156 goto fail0;
1157 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1158 Py_DECREF(peer);
1159 goto fail0;
1160 }
1161 Py_DECREF(peer);
Thomas Woutersed03b412007-08-28 21:37:11 +00001162
Antoine Pitroufb046912010-11-09 20:21:19 +00001163 issuer = _create_tuple_for_X509_NAME(
1164 X509_get_issuer_name(certificate));
1165 if (issuer == NULL)
1166 goto fail0;
1167 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001168 Py_DECREF(issuer);
Antoine Pitroufb046912010-11-09 20:21:19 +00001169 goto fail0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001170 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001171 Py_DECREF(issuer);
1172
1173 version = PyLong_FromLong(X509_get_version(certificate) + 1);
Christian Heimes5962bef2013-07-26 15:51:18 +02001174 if (version == NULL)
1175 goto fail0;
Antoine Pitroufb046912010-11-09 20:21:19 +00001176 if (PyDict_SetItemString(retval, "version", version) < 0) {
1177 Py_DECREF(version);
1178 goto fail0;
1179 }
1180 Py_DECREF(version);
Guido van Rossumf06628b2007-11-21 20:01:53 +00001181
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001182 /* get a memory buffer */
1183 biobuf = BIO_new(BIO_s_mem());
Guido van Rossumf06628b2007-11-21 20:01:53 +00001184
Antoine Pitroufb046912010-11-09 20:21:19 +00001185 (void) BIO_reset(biobuf);
1186 serialNumber = X509_get_serialNumber(certificate);
1187 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1188 i2a_ASN1_INTEGER(biobuf, serialNumber);
1189 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1190 if (len < 0) {
1191 _setSSLError(NULL, 0, __FILE__, __LINE__);
1192 goto fail1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001193 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001194 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1195 if (sn_obj == NULL)
1196 goto fail1;
1197 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1198 Py_DECREF(sn_obj);
1199 goto fail1;
1200 }
1201 Py_DECREF(sn_obj);
1202
1203 (void) BIO_reset(biobuf);
1204 notBefore = X509_get_notBefore(certificate);
1205 ASN1_TIME_print(biobuf, notBefore);
1206 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1207 if (len < 0) {
1208 _setSSLError(NULL, 0, __FILE__, __LINE__);
1209 goto fail1;
1210 }
1211 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1212 if (pnotBefore == NULL)
1213 goto fail1;
1214 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1215 Py_DECREF(pnotBefore);
1216 goto fail1;
1217 }
1218 Py_DECREF(pnotBefore);
Thomas Woutersed03b412007-08-28 21:37:11 +00001219
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001220 (void) BIO_reset(biobuf);
1221 notAfter = X509_get_notAfter(certificate);
1222 ASN1_TIME_print(biobuf, notAfter);
1223 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1224 if (len < 0) {
1225 _setSSLError(NULL, 0, __FILE__, __LINE__);
1226 goto fail1;
1227 }
1228 pnotAfter = PyUnicode_FromStringAndSize(buf, len);
1229 if (pnotAfter == NULL)
1230 goto fail1;
1231 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1232 Py_DECREF(pnotAfter);
1233 goto fail1;
1234 }
1235 Py_DECREF(pnotAfter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001236
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001237 /* Now look for subjectAltName */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001238
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001239 peer_alt_names = _get_peer_alt_names(certificate);
1240 if (peer_alt_names == NULL)
1241 goto fail1;
1242 else if (peer_alt_names != Py_None) {
1243 if (PyDict_SetItemString(retval, "subjectAltName",
1244 peer_alt_names) < 0) {
1245 Py_DECREF(peer_alt_names);
1246 goto fail1;
1247 }
1248 Py_DECREF(peer_alt_names);
1249 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001250
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001251 /* Authority Information Access: OCSP URIs */
1252 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1253 if (obj == NULL) {
1254 goto fail1;
1255 } else if (obj != Py_None) {
1256 result = PyDict_SetItemString(retval, "OCSP", obj);
1257 Py_DECREF(obj);
1258 if (result < 0) {
1259 goto fail1;
1260 }
1261 }
1262
1263 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1264 if (obj == NULL) {
1265 goto fail1;
1266 } else if (obj != Py_None) {
1267 result = PyDict_SetItemString(retval, "caIssuers", obj);
1268 Py_DECREF(obj);
1269 if (result < 0) {
1270 goto fail1;
1271 }
1272 }
1273
1274 /* CDP (CRL distribution points) */
1275 obj = _get_crl_dp(certificate);
1276 if (obj == NULL) {
1277 goto fail1;
1278 } else if (obj != Py_None) {
1279 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1280 Py_DECREF(obj);
1281 if (result < 0) {
1282 goto fail1;
1283 }
1284 }
1285
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001286 BIO_free(biobuf);
1287 return retval;
Thomas Woutersed03b412007-08-28 21:37:11 +00001288
1289 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001290 if (biobuf != NULL)
1291 BIO_free(biobuf);
Thomas Woutersed03b412007-08-28 21:37:11 +00001292 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001293 Py_XDECREF(retval);
1294 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001295}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001296
Christian Heimes9a5395a2013-06-17 15:44:12 +02001297static PyObject *
1298_certificate_to_der(X509 *certificate)
1299{
1300 unsigned char *bytes_buf = NULL;
1301 int len;
1302 PyObject *retval;
1303
1304 bytes_buf = NULL;
1305 len = i2d_X509(certificate, &bytes_buf);
1306 if (len < 0) {
1307 _setSSLError(NULL, 0, __FILE__, __LINE__);
1308 return NULL;
1309 }
1310 /* this is actually an immutable bytes sequence */
1311 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1312 OPENSSL_free(bytes_buf);
1313 return retval;
1314}
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001315
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001316/*[clinic input]
1317_ssl._test_decode_cert
1318 path: object(converter="PyUnicode_FSConverter")
1319 /
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001320
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001321[clinic start generated code]*/
1322
1323static PyObject *
1324_ssl__test_decode_cert_impl(PyModuleDef *module, PyObject *path)
1325/*[clinic end generated code: output=679e01db282804e9 input=cdeaaf02d4346628]*/
1326{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001327 PyObject *retval = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001328 X509 *x=NULL;
1329 BIO *cert;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001330
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001331 if ((cert=BIO_new(BIO_s_file())) == NULL) {
1332 PyErr_SetString(PySSLErrorObject,
1333 "Can't malloc memory to read file");
1334 goto fail0;
1335 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001336
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001337 if (BIO_read_filename(cert, PyBytes_AsString(path)) <= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001338 PyErr_SetString(PySSLErrorObject,
1339 "Can't open file");
1340 goto fail0;
1341 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001342
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001343 x = PEM_read_bio_X509_AUX(cert,NULL, NULL, NULL);
1344 if (x == NULL) {
1345 PyErr_SetString(PySSLErrorObject,
1346 "Error decoding PEM-encoded file");
1347 goto fail0;
1348 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001349
Antoine Pitroufb046912010-11-09 20:21:19 +00001350 retval = _decode_certificate(x);
Mark Dickinsonee55df52010-08-03 18:31:54 +00001351 X509_free(x);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001352
1353 fail0:
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001354 Py_DECREF(path);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001355 if (cert != NULL) BIO_free(cert);
1356 return retval;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001357}
1358
1359
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001360/*[clinic input]
1361_ssl._SSLSocket.peer_certificate
1362 der as binary_mode: bool = False
1363 /
1364
1365Returns the certificate for the peer.
1366
1367If no certificate was provided, returns None. If a certificate was
1368provided, but not validated, returns an empty dictionary. Otherwise
1369returns a dict containing information about the peer certificate.
1370
1371If the optional argument is True, returns a DER-encoded copy of the
1372peer certificate, or None if no certificate was provided. This will
1373return the certificate even if it wasn't validated.
1374[clinic start generated code]*/
1375
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001376static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001377_ssl__SSLSocket_peer_certificate_impl(PySSLSocket *self, int binary_mode)
1378/*[clinic end generated code: output=f0dc3e4d1d818a1d input=8281bd1d193db843]*/
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001379{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001380 int verification;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001381
Antoine Pitrou20b85552013-09-29 19:50:53 +02001382 if (!self->handshake_done) {
1383 PyErr_SetString(PyExc_ValueError,
1384 "handshake not done yet");
1385 return NULL;
1386 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001387 if (!self->peer_cert)
1388 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001389
Antoine Pitrou721738f2012-08-15 23:20:39 +02001390 if (binary_mode) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001391 /* return cert in DER-encoded format */
Christian Heimes9a5395a2013-06-17 15:44:12 +02001392 return _certificate_to_der(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001393 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00001394 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001395 if ((verification & SSL_VERIFY_PEER) == 0)
1396 return PyDict_New();
1397 else
Antoine Pitroufb046912010-11-09 20:21:19 +00001398 return _decode_certificate(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001399 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001400}
1401
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001402static PyObject *
1403cipher_to_tuple(const SSL_CIPHER *cipher)
1404{
1405 const char *cipher_name, *cipher_protocol;
1406 PyObject *v, *retval = PyTuple_New(3);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001407 if (retval == NULL)
1408 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001409
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001410 cipher_name = SSL_CIPHER_get_name(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001411 if (cipher_name == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001412 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001413 PyTuple_SET_ITEM(retval, 0, Py_None);
1414 } else {
1415 v = PyUnicode_FromString(cipher_name);
1416 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001417 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001418 PyTuple_SET_ITEM(retval, 0, v);
1419 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001420
1421 cipher_protocol = SSL_CIPHER_get_version(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001422 if (cipher_protocol == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001423 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001424 PyTuple_SET_ITEM(retval, 1, Py_None);
1425 } else {
1426 v = PyUnicode_FromString(cipher_protocol);
1427 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001428 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001429 PyTuple_SET_ITEM(retval, 1, v);
1430 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001431
1432 v = PyLong_FromLong(SSL_CIPHER_get_bits(cipher, NULL));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001433 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001434 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001435 PyTuple_SET_ITEM(retval, 2, v);
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001436
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001437 return retval;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001438
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001439 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001440 Py_DECREF(retval);
1441 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001442}
1443
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001444/*[clinic input]
1445_ssl._SSLSocket.shared_ciphers
1446[clinic start generated code]*/
1447
1448static PyObject *
1449_ssl__SSLSocket_shared_ciphers_impl(PySSLSocket *self)
1450/*[clinic end generated code: output=3d174ead2e42c4fd input=0bfe149da8fe6306]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001451{
Benjamin Petersonbaf7c1e2015-01-07 11:32:00 -06001452 SSL_SESSION *sess = SSL_get_session(self->ssl);
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001453 STACK_OF(SSL_CIPHER) *ciphers;
1454 int i;
1455 PyObject *res;
1456
Benjamin Petersonbaf7c1e2015-01-07 11:32:00 -06001457 if (!sess || !sess->ciphers)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001458 Py_RETURN_NONE;
Benjamin Petersonbaf7c1e2015-01-07 11:32:00 -06001459 ciphers = sess->ciphers;
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001460 res = PyList_New(sk_SSL_CIPHER_num(ciphers));
1461 if (!res)
1462 return NULL;
1463 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
1464 PyObject *tup = cipher_to_tuple(sk_SSL_CIPHER_value(ciphers, i));
1465 if (!tup) {
1466 Py_DECREF(res);
1467 return NULL;
1468 }
1469 PyList_SET_ITEM(res, i, tup);
1470 }
1471 return res;
1472}
1473
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001474/*[clinic input]
1475_ssl._SSLSocket.cipher
1476[clinic start generated code]*/
1477
1478static PyObject *
1479_ssl__SSLSocket_cipher_impl(PySSLSocket *self)
1480/*[clinic end generated code: output=376417c16d0e5815 input=548fb0e27243796d]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001481{
1482 const SSL_CIPHER *current;
1483
1484 if (self->ssl == NULL)
1485 Py_RETURN_NONE;
1486 current = SSL_get_current_cipher(self->ssl);
1487 if (current == NULL)
1488 Py_RETURN_NONE;
1489 return cipher_to_tuple(current);
1490}
1491
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001492/*[clinic input]
1493_ssl._SSLSocket.version
1494[clinic start generated code]*/
1495
1496static PyObject *
1497_ssl__SSLSocket_version_impl(PySSLSocket *self)
1498/*[clinic end generated code: output=178aed33193b2cdb input=900186a503436fd6]*/
Antoine Pitrou47e40422014-09-04 21:00:10 +02001499{
1500 const char *version;
1501
1502 if (self->ssl == NULL)
1503 Py_RETURN_NONE;
1504 version = SSL_get_version(self->ssl);
1505 if (!strcmp(version, "unknown"))
1506 Py_RETURN_NONE;
1507 return PyUnicode_FromString(version);
1508}
1509
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001510#ifdef OPENSSL_NPN_NEGOTIATED
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001511/*[clinic input]
1512_ssl._SSLSocket.selected_npn_protocol
1513[clinic start generated code]*/
1514
1515static PyObject *
1516_ssl__SSLSocket_selected_npn_protocol_impl(PySSLSocket *self)
1517/*[clinic end generated code: output=b91d494cd207ecf6 input=c28fde139204b826]*/
1518{
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001519 const unsigned char *out;
1520 unsigned int outlen;
1521
Victor Stinner4569cd52013-06-23 14:58:43 +02001522 SSL_get0_next_proto_negotiated(self->ssl,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001523 &out, &outlen);
1524
1525 if (out == NULL)
1526 Py_RETURN_NONE;
Benjamin Petersoncca27322015-01-23 16:35:37 -05001527 return PyUnicode_FromStringAndSize((char *)out, outlen);
1528}
1529#endif
1530
1531#ifdef HAVE_ALPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001532/*[clinic input]
1533_ssl._SSLSocket.selected_alpn_protocol
1534[clinic start generated code]*/
1535
1536static PyObject *
1537_ssl__SSLSocket_selected_alpn_protocol_impl(PySSLSocket *self)
1538/*[clinic end generated code: output=ec33688b303d250f input=442de30e35bc2913]*/
1539{
Benjamin Petersoncca27322015-01-23 16:35:37 -05001540 const unsigned char *out;
1541 unsigned int outlen;
1542
1543 SSL_get0_alpn_selected(self->ssl, &out, &outlen);
1544
1545 if (out == NULL)
1546 Py_RETURN_NONE;
1547 return PyUnicode_FromStringAndSize((char *)out, outlen);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001548}
1549#endif
1550
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001551/*[clinic input]
1552_ssl._SSLSocket.compression
1553[clinic start generated code]*/
1554
1555static PyObject *
1556_ssl__SSLSocket_compression_impl(PySSLSocket *self)
1557/*[clinic end generated code: output=bd16cb1bb4646ae7 input=5d059d0a2bbc32c8]*/
1558{
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001559#ifdef OPENSSL_NO_COMP
1560 Py_RETURN_NONE;
1561#else
1562 const COMP_METHOD *comp_method;
1563 const char *short_name;
1564
1565 if (self->ssl == NULL)
1566 Py_RETURN_NONE;
1567 comp_method = SSL_get_current_compression(self->ssl);
1568 if (comp_method == NULL || comp_method->type == NID_undef)
1569 Py_RETURN_NONE;
1570 short_name = OBJ_nid2sn(comp_method->type);
1571 if (short_name == NULL)
1572 Py_RETURN_NONE;
1573 return PyUnicode_DecodeFSDefault(short_name);
1574#endif
1575}
1576
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001577static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
1578 Py_INCREF(self->ctx);
1579 return self->ctx;
1580}
1581
1582static int PySSL_set_context(PySSLSocket *self, PyObject *value,
1583 void *closure) {
1584
1585 if (PyObject_TypeCheck(value, &PySSLContext_Type)) {
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001586#if !HAVE_SNI
1587 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
1588 "context is not supported by your OpenSSL library");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01001589 return -1;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001590#else
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001591 Py_INCREF(value);
Serhiy Storchaka5a57ade2015-12-24 10:35:59 +02001592 Py_SETREF(self->ctx, (PySSLContext *)value);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001593 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001594#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001595 } else {
1596 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
1597 return -1;
1598 }
1599
1600 return 0;
1601}
1602
1603PyDoc_STRVAR(PySSL_set_context_doc,
1604"_setter_context(ctx)\n\
1605\
1606This changes the context associated with the SSLSocket. This is typically\n\
1607used from within a callback function set by the set_servername_callback\n\
1608on the SSLContext to change the certificate information associated with the\n\
1609SSLSocket before the cryptographic exchange handshake messages\n");
1610
1611
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001612static PyObject *
1613PySSL_get_server_side(PySSLSocket *self, void *c)
1614{
1615 return PyBool_FromLong(self->socket_type == PY_SSL_SERVER);
1616}
1617
1618PyDoc_STRVAR(PySSL_get_server_side_doc,
1619"Whether this is a server-side socket.");
1620
1621static PyObject *
1622PySSL_get_server_hostname(PySSLSocket *self, void *c)
1623{
1624 if (self->server_hostname == NULL)
1625 Py_RETURN_NONE;
1626 Py_INCREF(self->server_hostname);
1627 return self->server_hostname;
1628}
1629
1630PyDoc_STRVAR(PySSL_get_server_hostname_doc,
1631"The currently set server hostname (for SNI).");
1632
1633static PyObject *
1634PySSL_get_owner(PySSLSocket *self, void *c)
1635{
1636 PyObject *owner;
1637
1638 if (self->owner == NULL)
1639 Py_RETURN_NONE;
1640
1641 owner = PyWeakref_GetObject(self->owner);
1642 Py_INCREF(owner);
1643 return owner;
1644}
1645
1646static int
1647PySSL_set_owner(PySSLSocket *self, PyObject *value, void *c)
1648{
Serhiy Storchaka5a57ade2015-12-24 10:35:59 +02001649 Py_SETREF(self->owner, PyWeakref_NewRef(value, NULL));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001650 if (self->owner == NULL)
1651 return -1;
1652 return 0;
1653}
1654
1655PyDoc_STRVAR(PySSL_get_owner_doc,
1656"The Python-level owner of this object.\
1657Passed as \"self\" in servername callback.");
1658
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001659
Antoine Pitrou152efa22010-05-16 18:19:27 +00001660static void PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001661{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001662 if (self->peer_cert) /* Possible not to have one? */
1663 X509_free (self->peer_cert);
1664 if (self->ssl)
1665 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001666 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001667 Py_XDECREF(self->ctx);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001668 Py_XDECREF(self->server_hostname);
1669 Py_XDECREF(self->owner);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001670 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001671}
1672
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001673/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001674 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001675 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001676 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001677
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001678static int
Victor Stinner14690702015-04-06 22:46:13 +02001679PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001680{
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001681 int rc;
1682#ifdef HAVE_POLL
1683 struct pollfd pollfd;
1684 _PyTime_t ms;
1685#else
1686 int nfds;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001687 fd_set fds;
1688 struct timeval tv;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001689#endif
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001690
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001691 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner14690702015-04-06 22:46:13 +02001692 if ((s == NULL) || (timeout == 0))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001693 return SOCKET_IS_NONBLOCKING;
Victor Stinner14690702015-04-06 22:46:13 +02001694 else if (timeout < 0) {
1695 if (s->sock_timeout > 0)
1696 return SOCKET_HAS_TIMED_OUT;
1697 else
1698 return SOCKET_IS_BLOCKING;
1699 }
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001700
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001701 /* Guard against closed socket */
1702 if (s->sock_fd < 0)
1703 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001704
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001705 /* Prefer poll, if available, since you can poll() any fd
1706 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001707#ifdef HAVE_POLL
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001708 pollfd.fd = s->sock_fd;
1709 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001710
Victor Stinner14690702015-04-06 22:46:13 +02001711 /* timeout is in seconds, poll() uses milliseconds */
1712 ms = (int)_PyTime_AsMilliseconds(timeout, _PyTime_ROUND_CEILING);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001713 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001714
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001715 PySSL_BEGIN_ALLOW_THREADS
1716 rc = poll(&pollfd, 1, (int)ms);
1717 PySSL_END_ALLOW_THREADS
1718#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001719 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02001720 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001721 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00001722
Victor Stinner14690702015-04-06 22:46:13 +02001723 _PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
Victor Stinnere2452312015-03-28 03:00:46 +01001724
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001725 FD_ZERO(&fds);
1726 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001727
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001728 /* Wait until the socket becomes ready */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001729 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001730 nfds = Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001731 if (writing)
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001732 rc = select(nfds, NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001733 else
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001734 rc = select(nfds, &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001735 PySSL_END_ALLOW_THREADS
Bill Janssen6e027db2007-11-15 22:23:56 +00001736#endif
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001737
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001738 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
1739 (when we are able to write or when there's something to read) */
1740 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001741}
1742
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001743/*[clinic input]
1744_ssl._SSLSocket.write
1745 b: Py_buffer
1746 /
1747
1748Writes the bytes-like object b into the SSL object.
1749
1750Returns the number of bytes written.
1751[clinic start generated code]*/
1752
1753static PyObject *
1754_ssl__SSLSocket_write_impl(PySSLSocket *self, Py_buffer *b)
1755/*[clinic end generated code: output=aa7a6be5527358d8 input=77262d994fe5100a]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001756{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001757 int len;
1758 int sockstate;
1759 int err;
1760 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001761 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02001762 _PyTime_t timeout, deadline = 0;
1763 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00001764
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001765 if (sock != NULL) {
1766 if (((PyObject*)sock) == Py_None) {
1767 _setSSLError("Underlying socket connection gone",
1768 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1769 return NULL;
1770 }
1771 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001772 }
1773
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001774 if (b->len > INT_MAX) {
Victor Stinner6efa9652013-06-25 00:42:31 +02001775 PyErr_Format(PyExc_OverflowError,
1776 "string longer than %d bytes", INT_MAX);
1777 goto error;
1778 }
1779
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001780 if (sock != NULL) {
1781 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01001782 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001783 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1784 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1785 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001786
Victor Stinner14690702015-04-06 22:46:13 +02001787 timeout = GET_SOCKET_TIMEOUT(sock);
1788 has_timeout = (timeout > 0);
1789 if (has_timeout)
1790 deadline = _PyTime_GetMonotonicClock() + timeout;
1791
1792 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001793 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001794 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001795 "The write operation timed out");
1796 goto error;
1797 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1798 PyErr_SetString(PySSLErrorObject,
1799 "Underlying socket has been closed.");
1800 goto error;
1801 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1802 PyErr_SetString(PySSLErrorObject,
1803 "Underlying socket too large for select().");
1804 goto error;
1805 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001806
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001807 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001808 PySSL_BEGIN_ALLOW_THREADS
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001809 len = SSL_write(self->ssl, b->buf, (int)b->len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001810 err = SSL_get_error(self->ssl, len);
1811 PySSL_END_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001812
1813 if (PyErr_CheckSignals())
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001814 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001815
Victor Stinner14690702015-04-06 22:46:13 +02001816 if (has_timeout)
1817 timeout = deadline - _PyTime_GetMonotonicClock();
1818
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001819 if (err == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02001820 sockstate = PySSL_select(sock, 0, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001821 } else if (err == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02001822 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001823 } else {
1824 sockstate = SOCKET_OPERATION_OK;
1825 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001826
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001827 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001828 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001829 "The write operation timed out");
1830 goto error;
1831 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1832 PyErr_SetString(PySSLErrorObject,
1833 "Underlying socket has been closed.");
1834 goto error;
1835 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1836 break;
1837 }
1838 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001839
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001840 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001841 if (len > 0)
1842 return PyLong_FromLong(len);
1843 else
1844 return PySSL_SetError(self, len, __FILE__, __LINE__);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001845
1846error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001847 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001848 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001849}
1850
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001851/*[clinic input]
1852_ssl._SSLSocket.pending
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001853
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001854Returns the number of already decrypted bytes available for read, pending on the connection.
1855[clinic start generated code]*/
1856
1857static PyObject *
1858_ssl__SSLSocket_pending_impl(PySSLSocket *self)
1859/*[clinic end generated code: output=983d9fecdc308a83 input=2b77487d6dfd597f]*/
Bill Janssen6e027db2007-11-15 22:23:56 +00001860{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001861 int count = 0;
Bill Janssen6e027db2007-11-15 22:23:56 +00001862
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001863 PySSL_BEGIN_ALLOW_THREADS
1864 count = SSL_pending(self->ssl);
1865 PySSL_END_ALLOW_THREADS
1866 if (count < 0)
1867 return PySSL_SetError(self, count, __FILE__, __LINE__);
1868 else
1869 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00001870}
1871
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001872/*[clinic input]
1873_ssl._SSLSocket.read
1874 size as len: int
1875 [
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001876 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001877 ]
1878 /
Bill Janssen6e027db2007-11-15 22:23:56 +00001879
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001880Read up to size bytes from the SSL socket.
1881[clinic start generated code]*/
1882
1883static PyObject *
1884_ssl__SSLSocket_read_impl(PySSLSocket *self, int len, int group_right_1,
1885 Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001886/*[clinic end generated code: output=00097776cec2a0af input=ff157eb918d0905b]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001887{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001888 PyObject *dest = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001889 char *mem;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001890 int count;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001891 int sockstate;
1892 int err;
1893 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001894 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02001895 _PyTime_t timeout, deadline = 0;
1896 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00001897
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001898 if (sock != NULL) {
1899 if (((PyObject*)sock) == Py_None) {
1900 _setSSLError("Underlying socket connection gone",
1901 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1902 return NULL;
1903 }
1904 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001905 }
1906
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001907 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001908 dest = PyBytes_FromStringAndSize(NULL, len);
1909 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001910 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001911 mem = PyBytes_AS_STRING(dest);
1912 }
1913 else {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001914 mem = buffer->buf;
1915 if (len <= 0 || len > buffer->len) {
1916 len = (int) buffer->len;
1917 if (buffer->len != len) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001918 PyErr_SetString(PyExc_OverflowError,
1919 "maximum length can't fit in a C 'int'");
1920 goto error;
1921 }
1922 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001923 }
1924
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001925 if (sock != NULL) {
1926 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01001927 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001928 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1929 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1930 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001931
Victor Stinner14690702015-04-06 22:46:13 +02001932 timeout = GET_SOCKET_TIMEOUT(sock);
1933 has_timeout = (timeout > 0);
1934 if (has_timeout)
1935 deadline = _PyTime_GetMonotonicClock() + timeout;
1936
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001937 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001938 PySSL_BEGIN_ALLOW_THREADS
1939 count = SSL_read(self->ssl, mem, len);
1940 err = SSL_get_error(self->ssl, count);
1941 PySSL_END_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001942
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001943 if (PyErr_CheckSignals())
1944 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001945
Victor Stinner14690702015-04-06 22:46:13 +02001946 if (has_timeout)
1947 timeout = deadline - _PyTime_GetMonotonicClock();
1948
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001949 if (err == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02001950 sockstate = PySSL_select(sock, 0, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001951 } else if (err == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02001952 sockstate = PySSL_select(sock, 1, timeout);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001953 } else if (err == SSL_ERROR_ZERO_RETURN &&
1954 SSL_get_shutdown(self->ssl) == SSL_RECEIVED_SHUTDOWN)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001955 {
1956 count = 0;
1957 goto done;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001958 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001959 else
1960 sockstate = SOCKET_OPERATION_OK;
1961
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001962 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001963 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001964 "The read operation timed out");
1965 goto error;
1966 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1967 break;
1968 }
1969 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001970
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001971 if (count <= 0) {
1972 PySSL_SetError(self, count, __FILE__, __LINE__);
1973 goto error;
1974 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001975
1976done:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001977 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001978 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001979 _PyBytes_Resize(&dest, count);
1980 return dest;
1981 }
1982 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001983 return PyLong_FromLong(count);
1984 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001985
1986error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001987 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001988 if (!group_right_1)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001989 Py_XDECREF(dest);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001990 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001991}
1992
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001993/*[clinic input]
1994_ssl._SSLSocket.shutdown
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001995
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001996Does the SSL shutdown handshake with the remote end.
1997
1998Returns the underlying socket object.
1999[clinic start generated code]*/
2000
2001static PyObject *
2002_ssl__SSLSocket_shutdown_impl(PySSLSocket *self)
2003/*[clinic end generated code: output=ca1aa7ed9d25ca42 input=ede2cc1a2ddf0ee4]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002004{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002005 int err, ssl_err, sockstate, nonblocking;
2006 int zeros = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002007 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002008 _PyTime_t timeout, deadline = 0;
2009 int has_timeout;
Bill Janssen40a0f662008-08-12 16:56:25 +00002010
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002011 if (sock != NULL) {
2012 /* Guard against closed socket */
2013 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd < 0)) {
2014 _setSSLError("Underlying socket connection gone",
2015 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2016 return NULL;
2017 }
2018 Py_INCREF(sock);
2019
2020 /* Just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002021 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002022 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2023 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002024 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002025
Victor Stinner14690702015-04-06 22:46:13 +02002026 timeout = GET_SOCKET_TIMEOUT(sock);
2027 has_timeout = (timeout > 0);
2028 if (has_timeout)
2029 deadline = _PyTime_GetMonotonicClock() + timeout;
2030
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002031 while (1) {
2032 PySSL_BEGIN_ALLOW_THREADS
2033 /* Disable read-ahead so that unwrap can work correctly.
2034 * Otherwise OpenSSL might read in too much data,
2035 * eating clear text data that happens to be
2036 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03002037 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002038 * function is used and the shutdown_seen_zero != 0
2039 * condition is met.
2040 */
2041 if (self->shutdown_seen_zero)
2042 SSL_set_read_ahead(self->ssl, 0);
2043 err = SSL_shutdown(self->ssl);
2044 PySSL_END_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002045
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002046 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
2047 if (err > 0)
2048 break;
2049 if (err == 0) {
2050 /* Don't loop endlessly; instead preserve legacy
2051 behaviour of trying SSL_shutdown() only twice.
2052 This looks necessary for OpenSSL < 0.9.8m */
2053 if (++zeros > 1)
2054 break;
2055 /* Shutdown was sent, now try receiving */
2056 self->shutdown_seen_zero = 1;
2057 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00002058 }
2059
Victor Stinner14690702015-04-06 22:46:13 +02002060 if (has_timeout)
2061 timeout = deadline - _PyTime_GetMonotonicClock();
2062
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002063 /* Possibly retry shutdown until timeout or failure */
2064 ssl_err = SSL_get_error(self->ssl, err);
2065 if (ssl_err == SSL_ERROR_WANT_READ)
Victor Stinner14690702015-04-06 22:46:13 +02002066 sockstate = PySSL_select(sock, 0, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002067 else if (ssl_err == SSL_ERROR_WANT_WRITE)
Victor Stinner14690702015-04-06 22:46:13 +02002068 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002069 else
2070 break;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002071
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002072 if (sockstate == SOCKET_HAS_TIMED_OUT) {
2073 if (ssl_err == SSL_ERROR_WANT_READ)
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002074 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002075 "The read operation timed out");
2076 else
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002077 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002078 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002079 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002080 }
2081 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2082 PyErr_SetString(PySSLErrorObject,
2083 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002084 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002085 }
2086 else if (sockstate != SOCKET_OPERATION_OK)
2087 /* Retain the SSL error code */
2088 break;
2089 }
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +00002090
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002091 if (err < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002092 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002093 return PySSL_SetError(self, err, __FILE__, __LINE__);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002094 }
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002095 if (sock)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002096 /* It's already INCREF'ed */
2097 return (PyObject *) sock;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002098 else
2099 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002100
2101error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002102 Py_XDECREF(sock);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002103 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00002104}
2105
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002106/*[clinic input]
2107_ssl._SSLSocket.tls_unique_cb
2108
2109Returns the 'tls-unique' channel binding data, as defined by RFC 5929.
2110
2111If the TLS handshake is not yet complete, None is returned.
2112[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002113
Antoine Pitroud6494802011-07-21 01:11:30 +02002114static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002115_ssl__SSLSocket_tls_unique_cb_impl(PySSLSocket *self)
2116/*[clinic end generated code: output=f3a832d603f586af input=439525c7b3d8d34d]*/
Antoine Pitroud6494802011-07-21 01:11:30 +02002117{
2118 PyObject *retval = NULL;
2119 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02002120 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02002121
2122 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
2123 /* if session is resumed XOR we are the client */
2124 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2125 }
2126 else {
2127 /* if a new session XOR we are the server */
2128 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2129 }
2130
2131 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02002132 if (len == 0)
2133 Py_RETURN_NONE;
2134
2135 retval = PyBytes_FromStringAndSize(buf, len);
2136
2137 return retval;
2138}
2139
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002140static PyGetSetDef ssl_getsetlist[] = {
2141 {"context", (getter) PySSL_get_context,
2142 (setter) PySSL_set_context, PySSL_set_context_doc},
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002143 {"server_side", (getter) PySSL_get_server_side, NULL,
2144 PySSL_get_server_side_doc},
2145 {"server_hostname", (getter) PySSL_get_server_hostname, NULL,
2146 PySSL_get_server_hostname_doc},
2147 {"owner", (getter) PySSL_get_owner, (setter) PySSL_set_owner,
2148 PySSL_get_owner_doc},
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002149 {NULL}, /* sentinel */
2150};
2151
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002152static PyMethodDef PySSLMethods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002153 _SSL__SSLSOCKET_DO_HANDSHAKE_METHODDEF
2154 _SSL__SSLSOCKET_WRITE_METHODDEF
2155 _SSL__SSLSOCKET_READ_METHODDEF
2156 _SSL__SSLSOCKET_PENDING_METHODDEF
2157 _SSL__SSLSOCKET_PEER_CERTIFICATE_METHODDEF
2158 _SSL__SSLSOCKET_CIPHER_METHODDEF
2159 _SSL__SSLSOCKET_SHARED_CIPHERS_METHODDEF
2160 _SSL__SSLSOCKET_VERSION_METHODDEF
2161 _SSL__SSLSOCKET_SELECTED_NPN_PROTOCOL_METHODDEF
2162 _SSL__SSLSOCKET_SELECTED_ALPN_PROTOCOL_METHODDEF
2163 _SSL__SSLSOCKET_COMPRESSION_METHODDEF
2164 _SSL__SSLSOCKET_SHUTDOWN_METHODDEF
2165 _SSL__SSLSOCKET_TLS_UNIQUE_CB_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002166 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002167};
2168
Antoine Pitrou152efa22010-05-16 18:19:27 +00002169static PyTypeObject PySSLSocket_Type = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002170 PyVarObject_HEAD_INIT(NULL, 0)
Antoine Pitrou152efa22010-05-16 18:19:27 +00002171 "_ssl._SSLSocket", /*tp_name*/
2172 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002173 0, /*tp_itemsize*/
2174 /* methods */
2175 (destructor)PySSL_dealloc, /*tp_dealloc*/
2176 0, /*tp_print*/
2177 0, /*tp_getattr*/
2178 0, /*tp_setattr*/
2179 0, /*tp_reserved*/
2180 0, /*tp_repr*/
2181 0, /*tp_as_number*/
2182 0, /*tp_as_sequence*/
2183 0, /*tp_as_mapping*/
2184 0, /*tp_hash*/
2185 0, /*tp_call*/
2186 0, /*tp_str*/
2187 0, /*tp_getattro*/
2188 0, /*tp_setattro*/
2189 0, /*tp_as_buffer*/
2190 Py_TPFLAGS_DEFAULT, /*tp_flags*/
2191 0, /*tp_doc*/
2192 0, /*tp_traverse*/
2193 0, /*tp_clear*/
2194 0, /*tp_richcompare*/
2195 0, /*tp_weaklistoffset*/
2196 0, /*tp_iter*/
2197 0, /*tp_iternext*/
2198 PySSLMethods, /*tp_methods*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002199 0, /*tp_members*/
2200 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002201};
2202
Antoine Pitrou152efa22010-05-16 18:19:27 +00002203
2204/*
2205 * _SSLContext objects
2206 */
2207
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002208/*[clinic input]
2209@classmethod
2210_ssl._SSLContext.__new__
2211 protocol as proto_version: int
2212 /
2213[clinic start generated code]*/
2214
Antoine Pitrou152efa22010-05-16 18:19:27 +00002215static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002216_ssl__SSLContext_impl(PyTypeObject *type, int proto_version)
2217/*[clinic end generated code: output=2cf0d7a0741b6bd1 input=8d58a805b95fc534]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00002218{
Antoine Pitrou152efa22010-05-16 18:19:27 +00002219 PySSLContext *self;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002220 long options;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002221 SSL_CTX *ctx = NULL;
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08002222 unsigned long libver;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002223
Antoine Pitrou152efa22010-05-16 18:19:27 +00002224 PySSL_BEGIN_ALLOW_THREADS
2225 if (proto_version == PY_SSL_VERSION_TLS1)
2226 ctx = SSL_CTX_new(TLSv1_method());
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002227#if HAVE_TLSv1_2
2228 else if (proto_version == PY_SSL_VERSION_TLS1_1)
2229 ctx = SSL_CTX_new(TLSv1_1_method());
2230 else if (proto_version == PY_SSL_VERSION_TLS1_2)
2231 ctx = SSL_CTX_new(TLSv1_2_method());
2232#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05002233#ifndef OPENSSL_NO_SSL3
Antoine Pitrou152efa22010-05-16 18:19:27 +00002234 else if (proto_version == PY_SSL_VERSION_SSL3)
2235 ctx = SSL_CTX_new(SSLv3_method());
Benjamin Petersone32467c2014-12-05 21:59:35 -05002236#endif
Victor Stinner3de49192011-05-09 00:42:58 +02002237#ifndef OPENSSL_NO_SSL2
Antoine Pitrou152efa22010-05-16 18:19:27 +00002238 else if (proto_version == PY_SSL_VERSION_SSL2)
2239 ctx = SSL_CTX_new(SSLv2_method());
Victor Stinner3de49192011-05-09 00:42:58 +02002240#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002241 else if (proto_version == PY_SSL_VERSION_SSL23)
2242 ctx = SSL_CTX_new(SSLv23_method());
2243 else
2244 proto_version = -1;
2245 PySSL_END_ALLOW_THREADS
2246
2247 if (proto_version == -1) {
2248 PyErr_SetString(PyExc_ValueError,
2249 "invalid protocol version");
2250 return NULL;
2251 }
2252 if (ctx == NULL) {
2253 PyErr_SetString(PySSLErrorObject,
2254 "failed to allocate SSL context");
2255 return NULL;
2256 }
2257
2258 assert(type != NULL && type->tp_alloc != NULL);
2259 self = (PySSLContext *) type->tp_alloc(type, 0);
2260 if (self == NULL) {
2261 SSL_CTX_free(ctx);
2262 return NULL;
2263 }
2264 self->ctx = ctx;
Christian Heimes5cb31c92012-09-20 12:42:54 +02002265#ifdef OPENSSL_NPN_NEGOTIATED
2266 self->npn_protocols = NULL;
2267#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05002268#ifdef HAVE_ALPN
2269 self->alpn_protocols = NULL;
2270#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002271#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +02002272 self->set_hostname = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002273#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01002274 /* Don't check host name by default */
2275 self->check_hostname = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002276 /* Defaults */
2277 SSL_CTX_set_verify(self->ctx, SSL_VERIFY_NONE, NULL);
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002278 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
2279 if (proto_version != PY_SSL_VERSION_SSL2)
2280 options |= SSL_OP_NO_SSLv2;
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08002281 if (proto_version != PY_SSL_VERSION_SSL3)
2282 options |= SSL_OP_NO_SSLv3;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01002283 SSL_CTX_set_options(self->ctx, options);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002284
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08002285#if defined(SSL_MODE_RELEASE_BUFFERS)
2286 /* Set SSL_MODE_RELEASE_BUFFERS. This potentially greatly reduces memory
2287 usage for no cost at all. However, don't do this for OpenSSL versions
2288 between 1.0.1 and 1.0.1h or 1.0.0 and 1.0.0m, which are affected by CVE
2289 2014-0198. I can't find exactly which beta fixed this CVE, so be
2290 conservative and assume it wasn't fixed until release. We do this check
2291 at runtime to avoid problems from the dynamic linker.
2292 See #25672 for more on this. */
2293 libver = SSLeay();
2294 if (!(libver >= 0x10001000UL && libver < 0x1000108fUL) &&
2295 !(libver >= 0x10000000UL && libver < 0x100000dfUL)) {
2296 SSL_CTX_set_mode(self->ctx, SSL_MODE_RELEASE_BUFFERS);
2297 }
2298#endif
2299
2300
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01002301#ifndef OPENSSL_NO_ECDH
2302 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
2303 prime256v1 by default. This is Apache mod_ssl's initialization
2304 policy, so we should be safe. */
2305#if defined(SSL_CTX_set_ecdh_auto)
2306 SSL_CTX_set_ecdh_auto(self->ctx, 1);
2307#else
2308 {
2309 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
2310 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2311 EC_KEY_free(key);
2312 }
2313#endif
2314#endif
2315
Antoine Pitroufc113ee2010-10-13 12:46:13 +00002316#define SID_CTX "Python"
2317 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
2318 sizeof(SID_CTX));
2319#undef SID_CTX
2320
Benjamin Petersonfdb19712015-03-04 22:11:12 -05002321#ifdef X509_V_FLAG_TRUSTED_FIRST
2322 {
2323 /* Improve trust chain building when cross-signed intermediate
2324 certificates are present. See https://bugs.python.org/issue23476. */
2325 X509_STORE *store = SSL_CTX_get_cert_store(self->ctx);
2326 X509_STORE_set_flags(store, X509_V_FLAG_TRUSTED_FIRST);
2327 }
2328#endif
2329
Antoine Pitrou152efa22010-05-16 18:19:27 +00002330 return (PyObject *)self;
2331}
2332
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002333static int
2334context_traverse(PySSLContext *self, visitproc visit, void *arg)
2335{
2336#ifndef OPENSSL_NO_TLSEXT
2337 Py_VISIT(self->set_hostname);
2338#endif
2339 return 0;
2340}
2341
2342static int
2343context_clear(PySSLContext *self)
2344{
2345#ifndef OPENSSL_NO_TLSEXT
2346 Py_CLEAR(self->set_hostname);
2347#endif
2348 return 0;
2349}
2350
Antoine Pitrou152efa22010-05-16 18:19:27 +00002351static void
2352context_dealloc(PySSLContext *self)
2353{
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002354 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002355 SSL_CTX_free(self->ctx);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002356#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersoncca27322015-01-23 16:35:37 -05002357 PyMem_FREE(self->npn_protocols);
2358#endif
2359#ifdef HAVE_ALPN
2360 PyMem_FREE(self->alpn_protocols);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002361#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002362 Py_TYPE(self)->tp_free(self);
2363}
2364
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002365/*[clinic input]
2366_ssl._SSLContext.set_ciphers
2367 cipherlist: str
2368 /
2369[clinic start generated code]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00002370
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002371static PyObject *
2372_ssl__SSLContext_set_ciphers_impl(PySSLContext *self, const char *cipherlist)
2373/*[clinic end generated code: output=3a3162f3557c0f3f input=a7ac931b9f3ca7fc]*/
2374{
2375 int ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002376 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00002377 /* Clearing the error queue is necessary on some OpenSSL versions,
2378 otherwise the error will be reported again when another SSL call
2379 is done. */
2380 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002381 PyErr_SetString(PySSLErrorObject,
2382 "No cipher can be selected.");
2383 return NULL;
2384 }
2385 Py_RETURN_NONE;
2386}
2387
Benjamin Petersonc54de472015-01-28 12:06:39 -05002388#ifdef OPENSSL_NPN_NEGOTIATED
Benjamin Petersoncca27322015-01-23 16:35:37 -05002389static int
Benjamin Peterson88615022015-01-23 17:30:26 -05002390do_protocol_selection(int alpn, unsigned char **out, unsigned char *outlen,
2391 const unsigned char *server_protocols, unsigned int server_protocols_len,
2392 const unsigned char *client_protocols, unsigned int client_protocols_len)
Benjamin Petersoncca27322015-01-23 16:35:37 -05002393{
Benjamin Peterson88615022015-01-23 17:30:26 -05002394 int ret;
2395 if (client_protocols == NULL) {
2396 client_protocols = (unsigned char *)"";
2397 client_protocols_len = 0;
2398 }
2399 if (server_protocols == NULL) {
2400 server_protocols = (unsigned char *)"";
2401 server_protocols_len = 0;
Benjamin Petersoncca27322015-01-23 16:35:37 -05002402 }
2403
Benjamin Peterson88615022015-01-23 17:30:26 -05002404 ret = SSL_select_next_proto(out, outlen,
2405 server_protocols, server_protocols_len,
2406 client_protocols, client_protocols_len);
2407 if (alpn && ret != OPENSSL_NPN_NEGOTIATED)
2408 return SSL_TLSEXT_ERR_NOACK;
Benjamin Petersoncca27322015-01-23 16:35:37 -05002409
2410 return SSL_TLSEXT_ERR_OK;
2411}
2412
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002413/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
2414static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002415_advertiseNPN_cb(SSL *s,
2416 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002417 void *args)
2418{
2419 PySSLContext *ssl_ctx = (PySSLContext *) args;
2420
2421 if (ssl_ctx->npn_protocols == NULL) {
Benjamin Petersoncca27322015-01-23 16:35:37 -05002422 *data = (unsigned char *)"";
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002423 *len = 0;
2424 } else {
Benjamin Petersoncca27322015-01-23 16:35:37 -05002425 *data = ssl_ctx->npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002426 *len = ssl_ctx->npn_protocols_len;
2427 }
2428
2429 return SSL_TLSEXT_ERR_OK;
2430}
2431/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
2432static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002433_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002434 unsigned char **out, unsigned char *outlen,
2435 const unsigned char *server, unsigned int server_len,
2436 void *args)
2437{
Benjamin Petersoncca27322015-01-23 16:35:37 -05002438 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05002439 return do_protocol_selection(0, out, outlen, server, server_len,
Benjamin Petersoncca27322015-01-23 16:35:37 -05002440 ctx->npn_protocols, ctx->npn_protocols_len);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002441}
2442#endif
2443
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002444/*[clinic input]
2445_ssl._SSLContext._set_npn_protocols
2446 protos: Py_buffer
2447 /
2448[clinic start generated code]*/
2449
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002450static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002451_ssl__SSLContext__set_npn_protocols_impl(PySSLContext *self,
2452 Py_buffer *protos)
2453/*[clinic end generated code: output=72b002c3324390c6 input=319fcb66abf95bd7]*/
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002454{
2455#ifdef OPENSSL_NPN_NEGOTIATED
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002456 PyMem_Free(self->npn_protocols);
2457 self->npn_protocols = PyMem_Malloc(protos->len);
2458 if (self->npn_protocols == NULL)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002459 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002460 memcpy(self->npn_protocols, protos->buf, protos->len);
2461 self->npn_protocols_len = (int) protos->len;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002462
2463 /* set both server and client callbacks, because the context can
2464 * be used to create both types of sockets */
2465 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
2466 _advertiseNPN_cb,
2467 self);
2468 SSL_CTX_set_next_proto_select_cb(self->ctx,
2469 _selectNPN_cb,
2470 self);
2471
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002472 Py_RETURN_NONE;
2473#else
2474 PyErr_SetString(PyExc_NotImplementedError,
2475 "The NPN extension requires OpenSSL 1.0.1 or later.");
2476 return NULL;
2477#endif
2478}
2479
Benjamin Petersoncca27322015-01-23 16:35:37 -05002480#ifdef HAVE_ALPN
2481static int
2482_selectALPN_cb(SSL *s,
2483 const unsigned char **out, unsigned char *outlen,
2484 const unsigned char *client_protocols, unsigned int client_protocols_len,
2485 void *args)
2486{
2487 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05002488 return do_protocol_selection(1, (unsigned char **)out, outlen,
2489 ctx->alpn_protocols, ctx->alpn_protocols_len,
2490 client_protocols, client_protocols_len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05002491}
2492#endif
2493
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002494/*[clinic input]
2495_ssl._SSLContext._set_alpn_protocols
2496 protos: Py_buffer
2497 /
2498[clinic start generated code]*/
2499
Benjamin Petersoncca27322015-01-23 16:35:37 -05002500static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002501_ssl__SSLContext__set_alpn_protocols_impl(PySSLContext *self,
2502 Py_buffer *protos)
2503/*[clinic end generated code: output=87599a7f76651a9b input=9bba964595d519be]*/
Benjamin Petersoncca27322015-01-23 16:35:37 -05002504{
2505#ifdef HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05002506 PyMem_FREE(self->alpn_protocols);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002507 self->alpn_protocols = PyMem_Malloc(protos->len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05002508 if (!self->alpn_protocols)
2509 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002510 memcpy(self->alpn_protocols, protos->buf, protos->len);
2511 self->alpn_protocols_len = protos->len;
Benjamin Petersoncca27322015-01-23 16:35:37 -05002512
2513 if (SSL_CTX_set_alpn_protos(self->ctx, self->alpn_protocols, self->alpn_protocols_len))
2514 return PyErr_NoMemory();
2515 SSL_CTX_set_alpn_select_cb(self->ctx, _selectALPN_cb, self);
2516
Benjamin Petersoncca27322015-01-23 16:35:37 -05002517 Py_RETURN_NONE;
2518#else
2519 PyErr_SetString(PyExc_NotImplementedError,
2520 "The ALPN extension requires OpenSSL 1.0.2 or later.");
2521 return NULL;
2522#endif
2523}
2524
Antoine Pitrou152efa22010-05-16 18:19:27 +00002525static PyObject *
2526get_verify_mode(PySSLContext *self, void *c)
2527{
2528 switch (SSL_CTX_get_verify_mode(self->ctx)) {
2529 case SSL_VERIFY_NONE:
2530 return PyLong_FromLong(PY_SSL_CERT_NONE);
2531 case SSL_VERIFY_PEER:
2532 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
2533 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
2534 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
2535 }
2536 PyErr_SetString(PySSLErrorObject,
2537 "invalid return value from SSL_CTX_get_verify_mode");
2538 return NULL;
2539}
2540
2541static int
2542set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
2543{
2544 int n, mode;
2545 if (!PyArg_Parse(arg, "i", &n))
2546 return -1;
2547 if (n == PY_SSL_CERT_NONE)
2548 mode = SSL_VERIFY_NONE;
2549 else if (n == PY_SSL_CERT_OPTIONAL)
2550 mode = SSL_VERIFY_PEER;
2551 else if (n == PY_SSL_CERT_REQUIRED)
2552 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2553 else {
2554 PyErr_SetString(PyExc_ValueError,
2555 "invalid value for verify_mode");
2556 return -1;
2557 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01002558 if (mode == SSL_VERIFY_NONE && self->check_hostname) {
2559 PyErr_SetString(PyExc_ValueError,
2560 "Cannot set verify_mode to CERT_NONE when "
2561 "check_hostname is enabled.");
2562 return -1;
2563 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002564 SSL_CTX_set_verify(self->ctx, mode, NULL);
2565 return 0;
2566}
2567
2568static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01002569get_verify_flags(PySSLContext *self, void *c)
2570{
2571 X509_STORE *store;
2572 unsigned long flags;
2573
2574 store = SSL_CTX_get_cert_store(self->ctx);
2575 flags = X509_VERIFY_PARAM_get_flags(store->param);
2576 return PyLong_FromUnsignedLong(flags);
2577}
2578
2579static int
2580set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
2581{
2582 X509_STORE *store;
2583 unsigned long new_flags, flags, set, clear;
2584
2585 if (!PyArg_Parse(arg, "k", &new_flags))
2586 return -1;
2587 store = SSL_CTX_get_cert_store(self->ctx);
2588 flags = X509_VERIFY_PARAM_get_flags(store->param);
2589 clear = flags & ~new_flags;
2590 set = ~flags & new_flags;
2591 if (clear) {
2592 if (!X509_VERIFY_PARAM_clear_flags(store->param, clear)) {
2593 _setSSLError(NULL, 0, __FILE__, __LINE__);
2594 return -1;
2595 }
2596 }
2597 if (set) {
2598 if (!X509_VERIFY_PARAM_set_flags(store->param, set)) {
2599 _setSSLError(NULL, 0, __FILE__, __LINE__);
2600 return -1;
2601 }
2602 }
2603 return 0;
2604}
2605
2606static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00002607get_options(PySSLContext *self, void *c)
2608{
2609 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
2610}
2611
2612static int
2613set_options(PySSLContext *self, PyObject *arg, void *c)
2614{
2615 long new_opts, opts, set, clear;
2616 if (!PyArg_Parse(arg, "l", &new_opts))
2617 return -1;
2618 opts = SSL_CTX_get_options(self->ctx);
2619 clear = opts & ~new_opts;
2620 set = ~opts & new_opts;
2621 if (clear) {
2622#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
2623 SSL_CTX_clear_options(self->ctx, clear);
2624#else
2625 PyErr_SetString(PyExc_ValueError,
2626 "can't clear options before OpenSSL 0.9.8m");
2627 return -1;
2628#endif
2629 }
2630 if (set)
2631 SSL_CTX_set_options(self->ctx, set);
2632 return 0;
2633}
2634
Christian Heimes1aa9a752013-12-02 02:41:19 +01002635static PyObject *
2636get_check_hostname(PySSLContext *self, void *c)
2637{
2638 return PyBool_FromLong(self->check_hostname);
2639}
2640
2641static int
2642set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
2643{
2644 int check_hostname;
2645 if (!PyArg_Parse(arg, "p", &check_hostname))
2646 return -1;
2647 if (check_hostname &&
2648 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
2649 PyErr_SetString(PyExc_ValueError,
2650 "check_hostname needs a SSL context with either "
2651 "CERT_OPTIONAL or CERT_REQUIRED");
2652 return -1;
2653 }
2654 self->check_hostname = check_hostname;
2655 return 0;
2656}
2657
2658
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002659typedef struct {
2660 PyThreadState *thread_state;
2661 PyObject *callable;
2662 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02002663 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002664 int error;
2665} _PySSLPasswordInfo;
2666
2667static int
2668_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
2669 const char *bad_type_error)
2670{
2671 /* Set the password and size fields of a _PySSLPasswordInfo struct
2672 from a unicode, bytes, or byte array object.
2673 The password field will be dynamically allocated and must be freed
2674 by the caller */
2675 PyObject *password_bytes = NULL;
2676 const char *data = NULL;
2677 Py_ssize_t size;
2678
2679 if (PyUnicode_Check(password)) {
2680 password_bytes = PyUnicode_AsEncodedString(password, NULL, NULL);
2681 if (!password_bytes) {
2682 goto error;
2683 }
2684 data = PyBytes_AS_STRING(password_bytes);
2685 size = PyBytes_GET_SIZE(password_bytes);
2686 } else if (PyBytes_Check(password)) {
2687 data = PyBytes_AS_STRING(password);
2688 size = PyBytes_GET_SIZE(password);
2689 } else if (PyByteArray_Check(password)) {
2690 data = PyByteArray_AS_STRING(password);
2691 size = PyByteArray_GET_SIZE(password);
2692 } else {
2693 PyErr_SetString(PyExc_TypeError, bad_type_error);
2694 goto error;
2695 }
2696
Victor Stinner9ee02032013-06-23 15:08:23 +02002697 if (size > (Py_ssize_t)INT_MAX) {
2698 PyErr_Format(PyExc_ValueError,
2699 "password cannot be longer than %d bytes", INT_MAX);
2700 goto error;
2701 }
2702
Victor Stinner11ebff22013-07-07 17:07:52 +02002703 PyMem_Free(pw_info->password);
2704 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002705 if (!pw_info->password) {
2706 PyErr_SetString(PyExc_MemoryError,
2707 "unable to allocate password buffer");
2708 goto error;
2709 }
2710 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02002711 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002712
2713 Py_XDECREF(password_bytes);
2714 return 1;
2715
2716error:
2717 Py_XDECREF(password_bytes);
2718 return 0;
2719}
2720
2721static int
2722_password_callback(char *buf, int size, int rwflag, void *userdata)
2723{
2724 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
2725 PyObject *fn_ret = NULL;
2726
2727 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
2728
2729 if (pw_info->callable) {
2730 fn_ret = PyObject_CallFunctionObjArgs(pw_info->callable, NULL);
2731 if (!fn_ret) {
2732 /* TODO: It would be nice to move _ctypes_add_traceback() into the
2733 core python API, so we could use it to add a frame here */
2734 goto error;
2735 }
2736
2737 if (!_pwinfo_set(pw_info, fn_ret,
2738 "password callback must return a string")) {
2739 goto error;
2740 }
2741 Py_CLEAR(fn_ret);
2742 }
2743
2744 if (pw_info->size > size) {
2745 PyErr_Format(PyExc_ValueError,
2746 "password cannot be longer than %d bytes", size);
2747 goto error;
2748 }
2749
2750 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2751 memcpy(buf, pw_info->password, pw_info->size);
2752 return pw_info->size;
2753
2754error:
2755 Py_XDECREF(fn_ret);
2756 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2757 pw_info->error = 1;
2758 return -1;
2759}
2760
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002761/*[clinic input]
2762_ssl._SSLContext.load_cert_chain
2763 certfile: object
2764 keyfile: object = NULL
2765 password: object = NULL
2766
2767[clinic start generated code]*/
2768
Antoine Pitroub5218772010-05-21 09:56:06 +00002769static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002770_ssl__SSLContext_load_cert_chain_impl(PySSLContext *self, PyObject *certfile,
2771 PyObject *keyfile, PyObject *password)
2772/*[clinic end generated code: output=9480bc1c380e2095 input=7cf9ac673cbee6fc]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00002773{
Antoine Pitrou152efa22010-05-16 18:19:27 +00002774 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002775 pem_password_cb *orig_passwd_cb = self->ctx->default_passwd_callback;
2776 void *orig_passwd_userdata = self->ctx->default_passwd_callback_userdata;
2777 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00002778 int r;
2779
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002780 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00002781 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002782 if (keyfile == Py_None)
2783 keyfile = NULL;
2784 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
2785 PyErr_SetString(PyExc_TypeError,
2786 "certfile should be a valid filesystem path");
2787 return NULL;
2788 }
2789 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
2790 PyErr_SetString(PyExc_TypeError,
2791 "keyfile should be a valid filesystem path");
2792 goto error;
2793 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002794 if (password && password != Py_None) {
2795 if (PyCallable_Check(password)) {
2796 pw_info.callable = password;
2797 } else if (!_pwinfo_set(&pw_info, password,
2798 "password should be a string or callable")) {
2799 goto error;
2800 }
2801 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
2802 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
2803 }
2804 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002805 r = SSL_CTX_use_certificate_chain_file(self->ctx,
2806 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002807 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002808 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002809 if (pw_info.error) {
2810 ERR_clear_error();
2811 /* the password callback has already set the error information */
2812 }
2813 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002814 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002815 PyErr_SetFromErrno(PyExc_IOError);
2816 }
2817 else {
2818 _setSSLError(NULL, 0, __FILE__, __LINE__);
2819 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002820 goto error;
2821 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002822 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02002823 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00002824 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
2825 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002826 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2827 Py_CLEAR(keyfile_bytes);
2828 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002829 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002830 if (pw_info.error) {
2831 ERR_clear_error();
2832 /* the password callback has already set the error information */
2833 }
2834 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002835 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002836 PyErr_SetFromErrno(PyExc_IOError);
2837 }
2838 else {
2839 _setSSLError(NULL, 0, __FILE__, __LINE__);
2840 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002841 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002842 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002843 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002844 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002845 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002846 if (r != 1) {
2847 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002848 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002849 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002850 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2851 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002852 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002853 Py_RETURN_NONE;
2854
2855error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002856 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2857 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002858 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002859 Py_XDECREF(keyfile_bytes);
2860 Py_XDECREF(certfile_bytes);
2861 return NULL;
2862}
2863
Christian Heimesefff7062013-11-21 03:35:02 +01002864/* internal helper function, returns -1 on error
2865 */
2866static int
2867_add_ca_certs(PySSLContext *self, void *data, Py_ssize_t len,
2868 int filetype)
2869{
2870 BIO *biobuf = NULL;
2871 X509_STORE *store;
2872 int retval = 0, err, loaded = 0;
2873
2874 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
2875
2876 if (len <= 0) {
2877 PyErr_SetString(PyExc_ValueError,
2878 "Empty certificate data");
2879 return -1;
2880 } else if (len > INT_MAX) {
2881 PyErr_SetString(PyExc_OverflowError,
2882 "Certificate data is too long.");
2883 return -1;
2884 }
2885
Christian Heimes1dbf61f2013-11-22 00:34:18 +01002886 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01002887 if (biobuf == NULL) {
2888 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
2889 return -1;
2890 }
2891
2892 store = SSL_CTX_get_cert_store(self->ctx);
2893 assert(store != NULL);
2894
2895 while (1) {
2896 X509 *cert = NULL;
2897 int r;
2898
2899 if (filetype == SSL_FILETYPE_ASN1) {
2900 cert = d2i_X509_bio(biobuf, NULL);
2901 } else {
2902 cert = PEM_read_bio_X509(biobuf, NULL,
2903 self->ctx->default_passwd_callback,
2904 self->ctx->default_passwd_callback_userdata);
2905 }
2906 if (cert == NULL) {
2907 break;
2908 }
2909 r = X509_STORE_add_cert(store, cert);
2910 X509_free(cert);
2911 if (!r) {
2912 err = ERR_peek_last_error();
2913 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
2914 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
2915 /* cert already in hash table, not an error */
2916 ERR_clear_error();
2917 } else {
2918 break;
2919 }
2920 }
2921 loaded++;
2922 }
2923
2924 err = ERR_peek_last_error();
2925 if ((filetype == SSL_FILETYPE_ASN1) &&
2926 (loaded > 0) &&
2927 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
2928 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
2929 /* EOF ASN1 file, not an error */
2930 ERR_clear_error();
2931 retval = 0;
2932 } else if ((filetype == SSL_FILETYPE_PEM) &&
2933 (loaded > 0) &&
2934 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
2935 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
2936 /* EOF PEM file, not an error */
2937 ERR_clear_error();
2938 retval = 0;
2939 } else {
2940 _setSSLError(NULL, 0, __FILE__, __LINE__);
2941 retval = -1;
2942 }
2943
2944 BIO_free(biobuf);
2945 return retval;
2946}
2947
2948
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002949/*[clinic input]
2950_ssl._SSLContext.load_verify_locations
2951 cafile: object = NULL
2952 capath: object = NULL
2953 cadata: object = NULL
2954
2955[clinic start generated code]*/
2956
Antoine Pitrou152efa22010-05-16 18:19:27 +00002957static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002958_ssl__SSLContext_load_verify_locations_impl(PySSLContext *self,
2959 PyObject *cafile,
2960 PyObject *capath,
2961 PyObject *cadata)
2962/*[clinic end generated code: output=454c7e41230ca551 input=997f1fb3a784ef88]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00002963{
Antoine Pitrou152efa22010-05-16 18:19:27 +00002964 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
2965 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002966 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002967
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002968 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002969 if (cafile == Py_None)
2970 cafile = NULL;
2971 if (capath == Py_None)
2972 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002973 if (cadata == Py_None)
2974 cadata = NULL;
2975
2976 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002977 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01002978 "cafile, capath and cadata cannot be all omitted");
2979 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002980 }
2981 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
2982 PyErr_SetString(PyExc_TypeError,
2983 "cafile should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002984 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002985 }
2986 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002987 PyErr_SetString(PyExc_TypeError,
2988 "capath should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002989 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002990 }
Christian Heimesefff7062013-11-21 03:35:02 +01002991
2992 /* validata cadata type and load cadata */
2993 if (cadata) {
2994 Py_buffer buf;
2995 PyObject *cadata_ascii = NULL;
2996
2997 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE) == 0) {
2998 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
2999 PyBuffer_Release(&buf);
3000 PyErr_SetString(PyExc_TypeError,
3001 "cadata should be a contiguous buffer with "
3002 "a single dimension");
3003 goto error;
3004 }
3005 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
3006 PyBuffer_Release(&buf);
3007 if (r == -1) {
3008 goto error;
3009 }
3010 } else {
3011 PyErr_Clear();
3012 cadata_ascii = PyUnicode_AsASCIIString(cadata);
3013 if (cadata_ascii == NULL) {
3014 PyErr_SetString(PyExc_TypeError,
Serhiy Storchakad65c9492015-11-02 14:10:23 +02003015 "cadata should be an ASCII string or a "
Christian Heimesefff7062013-11-21 03:35:02 +01003016 "bytes-like object");
3017 goto error;
3018 }
3019 r = _add_ca_certs(self,
3020 PyBytes_AS_STRING(cadata_ascii),
3021 PyBytes_GET_SIZE(cadata_ascii),
3022 SSL_FILETYPE_PEM);
3023 Py_DECREF(cadata_ascii);
3024 if (r == -1) {
3025 goto error;
3026 }
3027 }
3028 }
3029
3030 /* load cafile or capath */
3031 if (cafile || capath) {
3032 if (cafile)
3033 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
3034 if (capath)
3035 capath_buf = PyBytes_AS_STRING(capath_bytes);
3036 PySSL_BEGIN_ALLOW_THREADS
3037 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
3038 PySSL_END_ALLOW_THREADS
3039 if (r != 1) {
3040 ok = 0;
3041 if (errno != 0) {
3042 ERR_clear_error();
3043 PyErr_SetFromErrno(PyExc_IOError);
3044 }
3045 else {
3046 _setSSLError(NULL, 0, __FILE__, __LINE__);
3047 }
3048 goto error;
3049 }
3050 }
3051 goto end;
3052
3053 error:
3054 ok = 0;
3055 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003056 Py_XDECREF(cafile_bytes);
3057 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01003058 if (ok) {
3059 Py_RETURN_NONE;
3060 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00003061 return NULL;
3062 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003063}
3064
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003065/*[clinic input]
3066_ssl._SSLContext.load_dh_params
3067 path as filepath: object
3068 /
3069
3070[clinic start generated code]*/
3071
Antoine Pitrou152efa22010-05-16 18:19:27 +00003072static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003073_ssl__SSLContext_load_dh_params(PySSLContext *self, PyObject *filepath)
3074/*[clinic end generated code: output=1c8e57a38e055af0 input=c8871f3c796ae1d6]*/
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003075{
3076 FILE *f;
3077 DH *dh;
3078
Victor Stinnerdaf45552013-08-28 00:53:59 +02003079 f = _Py_fopen_obj(filepath, "rb");
Victor Stinnere42ccd22015-03-18 01:39:23 +01003080 if (f == NULL)
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003081 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01003082
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003083 errno = 0;
3084 PySSL_BEGIN_ALLOW_THREADS
3085 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01003086 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003087 PySSL_END_ALLOW_THREADS
3088 if (dh == NULL) {
3089 if (errno != 0) {
3090 ERR_clear_error();
3091 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
3092 }
3093 else {
3094 _setSSLError(NULL, 0, __FILE__, __LINE__);
3095 }
3096 return NULL;
3097 }
3098 if (SSL_CTX_set_tmp_dh(self->ctx, dh) == 0)
3099 _setSSLError(NULL, 0, __FILE__, __LINE__);
3100 DH_free(dh);
3101 Py_RETURN_NONE;
3102}
3103
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003104/*[clinic input]
3105_ssl._SSLContext._wrap_socket
3106 sock: object(subclass_of="PySocketModule.Sock_Type")
3107 server_side: int
3108 server_hostname as hostname_obj: object = None
3109
3110[clinic start generated code]*/
3111
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003112static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003113_ssl__SSLContext__wrap_socket_impl(PySSLContext *self, PyObject *sock,
3114 int server_side, PyObject *hostname_obj)
3115/*[clinic end generated code: output=6973e4b60995e933 input=83859b9156ddfc63]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003116{
Antoine Pitroud5323212010-10-22 18:19:07 +00003117 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003118 PyObject *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003119
Antoine Pitroud5323212010-10-22 18:19:07 +00003120 /* server_hostname is either None (or absent), or to be encoded
3121 using the idna encoding. */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003122 if (hostname_obj != Py_None) {
3123 if (!PyArg_Parse(hostname_obj, "et", "idna", &hostname))
Antoine Pitroud5323212010-10-22 18:19:07 +00003124 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00003125 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003126
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003127 res = (PyObject *) newPySSLSocket(self, (PySocketSockObject *)sock,
3128 server_side, hostname,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003129 NULL, NULL);
Antoine Pitroud5323212010-10-22 18:19:07 +00003130 if (hostname != NULL)
3131 PyMem_Free(hostname);
3132 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003133}
3134
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003135/*[clinic input]
3136_ssl._SSLContext._wrap_bio
3137 incoming: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
3138 outgoing: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
3139 server_side: int
3140 server_hostname as hostname_obj: object = None
3141
3142[clinic start generated code]*/
3143
Antoine Pitroub0182c82010-10-12 20:09:02 +00003144static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003145_ssl__SSLContext__wrap_bio_impl(PySSLContext *self, PySSLMemoryBIO *incoming,
3146 PySSLMemoryBIO *outgoing, int server_side,
3147 PyObject *hostname_obj)
3148/*[clinic end generated code: output=4fe4ba75ad95940d input=17725ecdac0bf220]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003149{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003150 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003151 PyObject *res;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003152
3153 /* server_hostname is either None (or absent), or to be encoded
3154 using the idna encoding. */
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003155 if (hostname_obj != Py_None) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003156 if (!PyArg_Parse(hostname_obj, "et", "idna", &hostname))
3157 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003158 }
3159
3160 res = (PyObject *) newPySSLSocket(self, NULL, server_side, hostname,
3161 incoming, outgoing);
3162
3163 PyMem_Free(hostname);
3164 return res;
3165}
3166
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003167/*[clinic input]
3168_ssl._SSLContext.session_stats
3169[clinic start generated code]*/
3170
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003171static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003172_ssl__SSLContext_session_stats_impl(PySSLContext *self)
3173/*[clinic end generated code: output=0d96411c42893bfb input=7e0a81fb11102c8b]*/
Antoine Pitroub0182c82010-10-12 20:09:02 +00003174{
3175 int r;
3176 PyObject *value, *stats = PyDict_New();
3177 if (!stats)
3178 return NULL;
3179
3180#define ADD_STATS(SSL_NAME, KEY_NAME) \
3181 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
3182 if (value == NULL) \
3183 goto error; \
3184 r = PyDict_SetItemString(stats, KEY_NAME, value); \
3185 Py_DECREF(value); \
3186 if (r < 0) \
3187 goto error;
3188
3189 ADD_STATS(number, "number");
3190 ADD_STATS(connect, "connect");
3191 ADD_STATS(connect_good, "connect_good");
3192 ADD_STATS(connect_renegotiate, "connect_renegotiate");
3193 ADD_STATS(accept, "accept");
3194 ADD_STATS(accept_good, "accept_good");
3195 ADD_STATS(accept_renegotiate, "accept_renegotiate");
3196 ADD_STATS(accept, "accept");
3197 ADD_STATS(hits, "hits");
3198 ADD_STATS(misses, "misses");
3199 ADD_STATS(timeouts, "timeouts");
3200 ADD_STATS(cache_full, "cache_full");
3201
3202#undef ADD_STATS
3203
3204 return stats;
3205
3206error:
3207 Py_DECREF(stats);
3208 return NULL;
3209}
3210
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003211/*[clinic input]
3212_ssl._SSLContext.set_default_verify_paths
3213[clinic start generated code]*/
3214
Antoine Pitrou664c2d12010-11-17 20:29:42 +00003215static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003216_ssl__SSLContext_set_default_verify_paths_impl(PySSLContext *self)
3217/*[clinic end generated code: output=0bee74e6e09deaaa input=35f3408021463d74]*/
Antoine Pitrou664c2d12010-11-17 20:29:42 +00003218{
3219 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
3220 _setSSLError(NULL, 0, __FILE__, __LINE__);
3221 return NULL;
3222 }
3223 Py_RETURN_NONE;
3224}
3225
Antoine Pitrou501da612011-12-21 09:27:41 +01003226#ifndef OPENSSL_NO_ECDH
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003227/*[clinic input]
3228_ssl._SSLContext.set_ecdh_curve
3229 name: object
3230 /
3231
3232[clinic start generated code]*/
3233
Antoine Pitrou923df6f2011-12-19 17:16:51 +01003234static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003235_ssl__SSLContext_set_ecdh_curve(PySSLContext *self, PyObject *name)
3236/*[clinic end generated code: output=23022c196e40d7d2 input=c2bafb6f6e34726b]*/
Antoine Pitrou923df6f2011-12-19 17:16:51 +01003237{
3238 PyObject *name_bytes;
3239 int nid;
3240 EC_KEY *key;
3241
3242 if (!PyUnicode_FSConverter(name, &name_bytes))
3243 return NULL;
3244 assert(PyBytes_Check(name_bytes));
3245 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
3246 Py_DECREF(name_bytes);
3247 if (nid == 0) {
3248 PyErr_Format(PyExc_ValueError,
3249 "unknown elliptic curve name %R", name);
3250 return NULL;
3251 }
3252 key = EC_KEY_new_by_curve_name(nid);
3253 if (key == NULL) {
3254 _setSSLError(NULL, 0, __FILE__, __LINE__);
3255 return NULL;
3256 }
3257 SSL_CTX_set_tmp_ecdh(self->ctx, key);
3258 EC_KEY_free(key);
3259 Py_RETURN_NONE;
3260}
Antoine Pitrou501da612011-12-21 09:27:41 +01003261#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01003262
Antoine Pitrou912fbff2013-03-30 16:29:32 +01003263#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003264static int
3265_servername_callback(SSL *s, int *al, void *args)
3266{
3267 int ret;
3268 PySSLContext *ssl_ctx = (PySSLContext *) args;
3269 PySSLSocket *ssl;
3270 PyObject *servername_o;
3271 PyObject *servername_idna;
3272 PyObject *result;
3273 /* The high-level ssl.SSLSocket object */
3274 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003275 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01003276#ifdef WITH_THREAD
3277 PyGILState_STATE gstate = PyGILState_Ensure();
3278#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003279
3280 if (ssl_ctx->set_hostname == NULL) {
3281 /* remove race condition in this the call back while if removing the
3282 * callback is in progress */
Stefan Krah20d60802013-01-17 17:07:17 +01003283#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003284 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01003285#endif
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01003286 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003287 }
3288
3289 ssl = SSL_get_app_data(s);
3290 assert(PySSLSocket_Check(ssl));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003291
Serhiy Storchakaf51d7152015-11-02 14:40:41 +02003292 /* The servername callback expects an argument that represents the current
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003293 * SSL connection and that has a .context attribute that can be changed to
3294 * identify the requested hostname. Since the official API is the Python
3295 * level API we want to pass the callback a Python level object rather than
3296 * a _ssl.SSLSocket instance. If there's an "owner" (typically an
3297 * SSLObject) that will be passed. Otherwise if there's a socket then that
3298 * will be passed. If both do not exist only then the C-level object is
3299 * passed. */
3300 if (ssl->owner)
3301 ssl_socket = PyWeakref_GetObject(ssl->owner);
3302 else if (ssl->Socket)
3303 ssl_socket = PyWeakref_GetObject(ssl->Socket);
3304 else
3305 ssl_socket = (PyObject *) ssl;
3306
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003307 Py_INCREF(ssl_socket);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003308 if (ssl_socket == Py_None)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003309 goto error;
Victor Stinner7e001512013-06-25 00:44:31 +02003310
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003311 if (servername == NULL) {
3312 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
3313 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003314 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003315 else {
3316 servername_o = PyBytes_FromString(servername);
3317 if (servername_o == NULL) {
3318 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
3319 goto error;
3320 }
3321 servername_idna = PyUnicode_FromEncodedObject(servername_o, "idna", NULL);
3322 if (servername_idna == NULL) {
3323 PyErr_WriteUnraisable(servername_o);
3324 Py_DECREF(servername_o);
3325 goto error;
3326 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003327 Py_DECREF(servername_o);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02003328 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
3329 servername_idna, ssl_ctx, NULL);
3330 Py_DECREF(servername_idna);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003331 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003332 Py_DECREF(ssl_socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003333
3334 if (result == NULL) {
3335 PyErr_WriteUnraisable(ssl_ctx->set_hostname);
3336 *al = SSL_AD_HANDSHAKE_FAILURE;
3337 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
3338 }
3339 else {
3340 if (result != Py_None) {
3341 *al = (int) PyLong_AsLong(result);
3342 if (PyErr_Occurred()) {
3343 PyErr_WriteUnraisable(result);
3344 *al = SSL_AD_INTERNAL_ERROR;
3345 }
3346 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
3347 }
3348 else {
3349 ret = SSL_TLSEXT_ERR_OK;
3350 }
3351 Py_DECREF(result);
3352 }
3353
Stefan Krah20d60802013-01-17 17:07:17 +01003354#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003355 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01003356#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003357 return ret;
3358
3359error:
3360 Py_DECREF(ssl_socket);
3361 *al = SSL_AD_INTERNAL_ERROR;
3362 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
Stefan Krah20d60802013-01-17 17:07:17 +01003363#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003364 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01003365#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003366 return ret;
3367}
Antoine Pitroua5963382013-03-30 16:39:00 +01003368#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003369
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003370/*[clinic input]
3371_ssl._SSLContext.set_servername_callback
3372 method as cb: object
3373 /
3374
3375Set a callback that will be called when a server name is provided by the SSL/TLS client in the SNI extension.
3376
3377If the argument is None then the callback is disabled. The method is called
3378with the SSLSocket, the server name as a string, and the SSLContext object.
3379See RFC 6066 for details of the SNI extension.
3380[clinic start generated code]*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003381
3382static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003383_ssl__SSLContext_set_servername_callback(PySSLContext *self, PyObject *cb)
3384/*[clinic end generated code: output=3439a1b2d5d3b7ea input=a2a83620197d602b]*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003385{
Antoine Pitrou912fbff2013-03-30 16:29:32 +01003386#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003387 Py_CLEAR(self->set_hostname);
3388 if (cb == Py_None) {
3389 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3390 }
3391 else {
3392 if (!PyCallable_Check(cb)) {
3393 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3394 PyErr_SetString(PyExc_TypeError,
3395 "not a callable object");
3396 return NULL;
3397 }
3398 Py_INCREF(cb);
3399 self->set_hostname = cb;
3400 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
3401 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
3402 }
3403 Py_RETURN_NONE;
3404#else
3405 PyErr_SetString(PyExc_NotImplementedError,
3406 "The TLS extension servername callback, "
3407 "SSL_CTX_set_tlsext_servername_callback, "
3408 "is not in the current OpenSSL library.");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01003409 return NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003410#endif
3411}
3412
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003413/*[clinic input]
3414_ssl._SSLContext.cert_store_stats
3415
3416Returns quantities of loaded X.509 certificates.
3417
3418X.509 certificates with a CA extension and certificate revocation lists
3419inside the context's cert store.
3420
3421NOTE: Certificates in a capath directory aren't loaded unless they have
3422been used at least once.
3423[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02003424
3425static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003426_ssl__SSLContext_cert_store_stats_impl(PySSLContext *self)
3427/*[clinic end generated code: output=5f356f4d9cca874d input=eb40dd0f6d0e40cf]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02003428{
3429 X509_STORE *store;
3430 X509_OBJECT *obj;
3431 int x509 = 0, crl = 0, pkey = 0, ca = 0, i;
3432
3433 store = SSL_CTX_get_cert_store(self->ctx);
3434 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3435 obj = sk_X509_OBJECT_value(store->objs, i);
3436 switch (obj->type) {
3437 case X509_LU_X509:
3438 x509++;
3439 if (X509_check_ca(obj->data.x509)) {
3440 ca++;
3441 }
3442 break;
3443 case X509_LU_CRL:
3444 crl++;
3445 break;
3446 case X509_LU_PKEY:
3447 pkey++;
3448 break;
3449 default:
3450 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
3451 * As far as I can tell they are internal states and never
3452 * stored in a cert store */
3453 break;
3454 }
3455 }
3456 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
3457 "x509_ca", ca);
3458}
3459
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003460/*[clinic input]
3461_ssl._SSLContext.get_ca_certs
3462 binary_form: bool = False
3463
3464Returns a list of dicts with information of loaded CA certs.
3465
3466If the optional argument is True, returns a DER-encoded copy of the CA
3467certificate.
3468
3469NOTE: Certificates in a capath directory aren't loaded unless they have
3470been used at least once.
3471[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02003472
3473static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003474_ssl__SSLContext_get_ca_certs_impl(PySSLContext *self, int binary_form)
3475/*[clinic end generated code: output=0d58f148f37e2938 input=6887b5a09b7f9076]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02003476{
3477 X509_STORE *store;
3478 PyObject *ci = NULL, *rlist = NULL;
3479 int i;
Christian Heimes9a5395a2013-06-17 15:44:12 +02003480
3481 if ((rlist = PyList_New(0)) == NULL) {
3482 return NULL;
3483 }
3484
3485 store = SSL_CTX_get_cert_store(self->ctx);
3486 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3487 X509_OBJECT *obj;
3488 X509 *cert;
3489
3490 obj = sk_X509_OBJECT_value(store->objs, i);
3491 if (obj->type != X509_LU_X509) {
3492 /* not a x509 cert */
3493 continue;
3494 }
3495 /* CA for any purpose */
3496 cert = obj->data.x509;
3497 if (!X509_check_ca(cert)) {
3498 continue;
3499 }
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003500 if (binary_form) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02003501 ci = _certificate_to_der(cert);
3502 } else {
3503 ci = _decode_certificate(cert);
3504 }
3505 if (ci == NULL) {
3506 goto error;
3507 }
3508 if (PyList_Append(rlist, ci) == -1) {
3509 goto error;
3510 }
3511 Py_CLEAR(ci);
3512 }
3513 return rlist;
3514
3515 error:
3516 Py_XDECREF(ci);
3517 Py_XDECREF(rlist);
3518 return NULL;
3519}
3520
3521
Antoine Pitrou152efa22010-05-16 18:19:27 +00003522static PyGetSetDef context_getsetlist[] = {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003523 {"check_hostname", (getter) get_check_hostname,
3524 (setter) set_check_hostname, NULL},
Antoine Pitroub5218772010-05-21 09:56:06 +00003525 {"options", (getter) get_options,
3526 (setter) set_options, NULL},
Christian Heimes22587792013-11-21 23:56:13 +01003527 {"verify_flags", (getter) get_verify_flags,
3528 (setter) set_verify_flags, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003529 {"verify_mode", (getter) get_verify_mode,
3530 (setter) set_verify_mode, NULL},
3531 {NULL}, /* sentinel */
3532};
3533
3534static struct PyMethodDef context_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003535 _SSL__SSLCONTEXT__WRAP_SOCKET_METHODDEF
3536 _SSL__SSLCONTEXT__WRAP_BIO_METHODDEF
3537 _SSL__SSLCONTEXT_SET_CIPHERS_METHODDEF
3538 _SSL__SSLCONTEXT__SET_ALPN_PROTOCOLS_METHODDEF
3539 _SSL__SSLCONTEXT__SET_NPN_PROTOCOLS_METHODDEF
3540 _SSL__SSLCONTEXT_LOAD_CERT_CHAIN_METHODDEF
3541 _SSL__SSLCONTEXT_LOAD_DH_PARAMS_METHODDEF
3542 _SSL__SSLCONTEXT_LOAD_VERIFY_LOCATIONS_METHODDEF
3543 _SSL__SSLCONTEXT_SESSION_STATS_METHODDEF
3544 _SSL__SSLCONTEXT_SET_DEFAULT_VERIFY_PATHS_METHODDEF
3545 _SSL__SSLCONTEXT_SET_ECDH_CURVE_METHODDEF
3546 _SSL__SSLCONTEXT_SET_SERVERNAME_CALLBACK_METHODDEF
3547 _SSL__SSLCONTEXT_CERT_STORE_STATS_METHODDEF
3548 _SSL__SSLCONTEXT_GET_CA_CERTS_METHODDEF
Antoine Pitrou152efa22010-05-16 18:19:27 +00003549 {NULL, NULL} /* sentinel */
3550};
3551
3552static PyTypeObject PySSLContext_Type = {
3553 PyVarObject_HEAD_INIT(NULL, 0)
3554 "_ssl._SSLContext", /*tp_name*/
3555 sizeof(PySSLContext), /*tp_basicsize*/
3556 0, /*tp_itemsize*/
3557 (destructor)context_dealloc, /*tp_dealloc*/
3558 0, /*tp_print*/
3559 0, /*tp_getattr*/
3560 0, /*tp_setattr*/
3561 0, /*tp_reserved*/
3562 0, /*tp_repr*/
3563 0, /*tp_as_number*/
3564 0, /*tp_as_sequence*/
3565 0, /*tp_as_mapping*/
3566 0, /*tp_hash*/
3567 0, /*tp_call*/
3568 0, /*tp_str*/
3569 0, /*tp_getattro*/
3570 0, /*tp_setattro*/
3571 0, /*tp_as_buffer*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003572 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003573 0, /*tp_doc*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003574 (traverseproc) context_traverse, /*tp_traverse*/
3575 (inquiry) context_clear, /*tp_clear*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003576 0, /*tp_richcompare*/
3577 0, /*tp_weaklistoffset*/
3578 0, /*tp_iter*/
3579 0, /*tp_iternext*/
3580 context_methods, /*tp_methods*/
3581 0, /*tp_members*/
3582 context_getsetlist, /*tp_getset*/
3583 0, /*tp_base*/
3584 0, /*tp_dict*/
3585 0, /*tp_descr_get*/
3586 0, /*tp_descr_set*/
3587 0, /*tp_dictoffset*/
3588 0, /*tp_init*/
3589 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003590 _ssl__SSLContext, /*tp_new*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003591};
3592
3593
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003594/*
3595 * MemoryBIO objects
3596 */
3597
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003598/*[clinic input]
3599@classmethod
3600_ssl.MemoryBIO.__new__
3601
3602[clinic start generated code]*/
3603
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003604static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003605_ssl_MemoryBIO_impl(PyTypeObject *type)
3606/*[clinic end generated code: output=8820a58db78330ac input=26d22e4909ecb1b5]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003607{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003608 BIO *bio;
3609 PySSLMemoryBIO *self;
3610
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003611 bio = BIO_new(BIO_s_mem());
3612 if (bio == NULL) {
3613 PyErr_SetString(PySSLErrorObject,
3614 "failed to allocate BIO");
3615 return NULL;
3616 }
3617 /* Since our BIO is non-blocking an empty read() does not indicate EOF,
3618 * just that no data is currently available. The SSL routines should retry
3619 * the read, which we can achieve by calling BIO_set_retry_read(). */
3620 BIO_set_retry_read(bio);
3621 BIO_set_mem_eof_return(bio, -1);
3622
3623 assert(type != NULL && type->tp_alloc != NULL);
3624 self = (PySSLMemoryBIO *) type->tp_alloc(type, 0);
3625 if (self == NULL) {
3626 BIO_free(bio);
3627 return NULL;
3628 }
3629 self->bio = bio;
3630 self->eof_written = 0;
3631
3632 return (PyObject *) self;
3633}
3634
3635static void
3636memory_bio_dealloc(PySSLMemoryBIO *self)
3637{
3638 BIO_free(self->bio);
3639 Py_TYPE(self)->tp_free(self);
3640}
3641
3642static PyObject *
3643memory_bio_get_pending(PySSLMemoryBIO *self, void *c)
3644{
3645 return PyLong_FromLong(BIO_ctrl_pending(self->bio));
3646}
3647
3648PyDoc_STRVAR(PySSL_memory_bio_pending_doc,
3649"The number of bytes pending in the memory BIO.");
3650
3651static PyObject *
3652memory_bio_get_eof(PySSLMemoryBIO *self, void *c)
3653{
3654 return PyBool_FromLong((BIO_ctrl_pending(self->bio) == 0)
3655 && self->eof_written);
3656}
3657
3658PyDoc_STRVAR(PySSL_memory_bio_eof_doc,
3659"Whether the memory BIO is at EOF.");
3660
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003661/*[clinic input]
3662_ssl.MemoryBIO.read
3663 size as len: int = -1
3664 /
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003665
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003666Read up to size bytes from the memory BIO.
3667
3668If size is not specified, read the entire buffer.
3669If the return value is an empty bytes instance, this means either
3670EOF or that no data is available. Use the "eof" property to
3671distinguish between the two.
3672[clinic start generated code]*/
3673
3674static PyObject *
3675_ssl_MemoryBIO_read_impl(PySSLMemoryBIO *self, int len)
3676/*[clinic end generated code: output=a657aa1e79cd01b3 input=574d7be06a902366]*/
3677{
3678 int avail, nbytes;
3679 PyObject *result;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003680
3681 avail = BIO_ctrl_pending(self->bio);
3682 if ((len < 0) || (len > avail))
3683 len = avail;
3684
3685 result = PyBytes_FromStringAndSize(NULL, len);
3686 if ((result == NULL) || (len == 0))
3687 return result;
3688
3689 nbytes = BIO_read(self->bio, PyBytes_AS_STRING(result), len);
3690 /* There should never be any short reads but check anyway. */
3691 if ((nbytes < len) && (_PyBytes_Resize(&result, len) < 0)) {
3692 Py_DECREF(result);
3693 return NULL;
3694 }
3695
3696 return result;
3697}
3698
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003699/*[clinic input]
3700_ssl.MemoryBIO.write
3701 b: Py_buffer
3702 /
3703
3704Writes the bytes b into the memory BIO.
3705
3706Returns the number of bytes written.
3707[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003708
3709static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003710_ssl_MemoryBIO_write_impl(PySSLMemoryBIO *self, Py_buffer *b)
3711/*[clinic end generated code: output=156ec59110d75935 input=e45757b3e17c4808]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003712{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003713 int nbytes;
3714
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003715 if (b->len > INT_MAX) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003716 PyErr_Format(PyExc_OverflowError,
3717 "string longer than %d bytes", INT_MAX);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003718 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003719 }
3720
3721 if (self->eof_written) {
3722 PyErr_SetString(PySSLErrorObject,
3723 "cannot write() after write_eof()");
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003724 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003725 }
3726
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003727 nbytes = BIO_write(self->bio, b->buf, b->len);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003728 if (nbytes < 0) {
3729 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003730 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003731 }
3732
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003733 return PyLong_FromLong(nbytes);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003734}
3735
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003736/*[clinic input]
3737_ssl.MemoryBIO.write_eof
3738
3739Write an EOF marker to the memory BIO.
3740
3741When all data has been read, the "eof" property will be True.
3742[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003743
3744static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003745_ssl_MemoryBIO_write_eof_impl(PySSLMemoryBIO *self)
3746/*[clinic end generated code: output=d4106276ccd1ed34 input=56a945f1d29e8bd6]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003747{
3748 self->eof_written = 1;
3749 /* After an EOF is written, a zero return from read() should be a real EOF
3750 * i.e. it should not be retried. Clear the SHOULD_RETRY flag. */
3751 BIO_clear_retry_flags(self->bio);
3752 BIO_set_mem_eof_return(self->bio, 0);
3753
3754 Py_RETURN_NONE;
3755}
3756
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003757static PyGetSetDef memory_bio_getsetlist[] = {
3758 {"pending", (getter) memory_bio_get_pending, NULL,
3759 PySSL_memory_bio_pending_doc},
3760 {"eof", (getter) memory_bio_get_eof, NULL,
3761 PySSL_memory_bio_eof_doc},
3762 {NULL}, /* sentinel */
3763};
3764
3765static struct PyMethodDef memory_bio_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003766 _SSL_MEMORYBIO_READ_METHODDEF
3767 _SSL_MEMORYBIO_WRITE_METHODDEF
3768 _SSL_MEMORYBIO_WRITE_EOF_METHODDEF
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003769 {NULL, NULL} /* sentinel */
3770};
3771
3772static PyTypeObject PySSLMemoryBIO_Type = {
3773 PyVarObject_HEAD_INIT(NULL, 0)
3774 "_ssl.MemoryBIO", /*tp_name*/
3775 sizeof(PySSLMemoryBIO), /*tp_basicsize*/
3776 0, /*tp_itemsize*/
3777 (destructor)memory_bio_dealloc, /*tp_dealloc*/
3778 0, /*tp_print*/
3779 0, /*tp_getattr*/
3780 0, /*tp_setattr*/
3781 0, /*tp_reserved*/
3782 0, /*tp_repr*/
3783 0, /*tp_as_number*/
3784 0, /*tp_as_sequence*/
3785 0, /*tp_as_mapping*/
3786 0, /*tp_hash*/
3787 0, /*tp_call*/
3788 0, /*tp_str*/
3789 0, /*tp_getattro*/
3790 0, /*tp_setattro*/
3791 0, /*tp_as_buffer*/
3792 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3793 0, /*tp_doc*/
3794 0, /*tp_traverse*/
3795 0, /*tp_clear*/
3796 0, /*tp_richcompare*/
3797 0, /*tp_weaklistoffset*/
3798 0, /*tp_iter*/
3799 0, /*tp_iternext*/
3800 memory_bio_methods, /*tp_methods*/
3801 0, /*tp_members*/
3802 memory_bio_getsetlist, /*tp_getset*/
3803 0, /*tp_base*/
3804 0, /*tp_dict*/
3805 0, /*tp_descr_get*/
3806 0, /*tp_descr_set*/
3807 0, /*tp_dictoffset*/
3808 0, /*tp_init*/
3809 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003810 _ssl_MemoryBIO, /*tp_new*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02003811};
3812
Antoine Pitrou152efa22010-05-16 18:19:27 +00003813
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003814/* helper routines for seeding the SSL PRNG */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003815/*[clinic input]
3816_ssl.RAND_add
Larry Hastingsdbfdc382015-05-04 06:59:46 -07003817 string as view: Py_buffer(accept={str, buffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003818 entropy: double
3819 /
3820
3821Mix string into the OpenSSL PRNG state.
3822
3823entropy (a float) is a lower bound on the entropy contained in
3824string. See RFC 1750.
3825[clinic start generated code]*/
3826
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003827static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003828_ssl_RAND_add_impl(PyModuleDef *module, Py_buffer *view, double entropy)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07003829/*[clinic end generated code: output=0f8d5c8cce328958 input=580c85e6a3a4fe29]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003830{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02003831 const char *buf;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02003832 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003833
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003834 buf = (const char *)view->buf;
3835 len = view->len;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02003836 do {
3837 written = Py_MIN(len, INT_MAX);
3838 RAND_add(buf, (int)written, entropy);
3839 buf += written;
3840 len -= written;
3841 } while (len);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003842 Py_INCREF(Py_None);
3843 return Py_None;
3844}
3845
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003846static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02003847PySSL_RAND(int len, int pseudo)
3848{
3849 int ok;
3850 PyObject *bytes;
3851 unsigned long err;
3852 const char *errstr;
3853 PyObject *v;
3854
Victor Stinner1e81a392013-12-19 16:47:04 +01003855 if (len < 0) {
3856 PyErr_SetString(PyExc_ValueError, "num must be positive");
3857 return NULL;
3858 }
3859
Victor Stinner99c8b162011-05-24 12:05:19 +02003860 bytes = PyBytes_FromStringAndSize(NULL, len);
3861 if (bytes == NULL)
3862 return NULL;
3863 if (pseudo) {
3864 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3865 if (ok == 0 || ok == 1)
3866 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
3867 }
3868 else {
3869 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3870 if (ok == 1)
3871 return bytes;
3872 }
3873 Py_DECREF(bytes);
3874
3875 err = ERR_get_error();
3876 errstr = ERR_reason_error_string(err);
3877 v = Py_BuildValue("(ks)", err, errstr);
3878 if (v != NULL) {
3879 PyErr_SetObject(PySSLErrorObject, v);
3880 Py_DECREF(v);
3881 }
3882 return NULL;
3883}
3884
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003885/*[clinic input]
3886_ssl.RAND_bytes
3887 n: int
3888 /
3889
3890Generate n cryptographically strong pseudo-random bytes.
3891[clinic start generated code]*/
3892
Victor Stinner99c8b162011-05-24 12:05:19 +02003893static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003894_ssl_RAND_bytes_impl(PyModuleDef *module, int n)
3895/*[clinic end generated code: output=7d8741bdc1d435f3 input=678ddf2872dfebfc]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02003896{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003897 return PySSL_RAND(n, 0);
Victor Stinner99c8b162011-05-24 12:05:19 +02003898}
3899
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003900/*[clinic input]
3901_ssl.RAND_pseudo_bytes
3902 n: int
3903 /
3904
3905Generate n pseudo-random bytes.
3906
3907Return a pair (bytes, is_cryptographic). is_cryptographic is True
3908if the bytes generated are cryptographically strong.
3909[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02003910
3911static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003912_ssl_RAND_pseudo_bytes_impl(PyModuleDef *module, int n)
3913/*[clinic end generated code: output=dd673813107f3875 input=58312bd53f9bbdd0]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02003914{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003915 return PySSL_RAND(n, 1);
Victor Stinner99c8b162011-05-24 12:05:19 +02003916}
3917
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003918/*[clinic input]
3919_ssl.RAND_status
3920
3921Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.
3922
3923It is necessary to seed the PRNG with RAND_add() on some platforms before
3924using the ssl() function.
3925[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02003926
3927static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003928_ssl_RAND_status_impl(PyModuleDef *module)
3929/*[clinic end generated code: output=7f7ef57bc7dd1d1c input=8a774b02d1dc81f3]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003930{
Christian Heimes217cfd12007-12-02 14:31:20 +00003931 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003932}
3933
Victor Stinnerbeeb5122014-11-28 13:28:25 +01003934#ifdef HAVE_RAND_EGD
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003935/*[clinic input]
3936_ssl.RAND_egd
3937 path: object(converter="PyUnicode_FSConverter")
3938 /
3939
3940Queries the entropy gather daemon (EGD) on the socket named by 'path'.
3941
3942Returns number of bytes read. Raises SSLError if connection to EGD
3943fails or if it does not provide enough data to seed PRNG.
3944[clinic start generated code]*/
3945
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003946static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003947_ssl_RAND_egd_impl(PyModuleDef *module, PyObject *path)
3948/*[clinic end generated code: output=8e728e501e28541b input=1aeb7eb948312195]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003949{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003950 int bytes = RAND_egd(PyBytes_AsString(path));
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003951 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003952 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00003953 PyErr_SetString(PySSLErrorObject,
3954 "EGD connection failed or EGD did not return "
3955 "enough data to seed the PRNG");
3956 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003957 }
Christian Heimes217cfd12007-12-02 14:31:20 +00003958 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003959}
Victor Stinnerbeeb5122014-11-28 13:28:25 +01003960#endif /* HAVE_RAND_EGD */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003961
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003962
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003963
3964/*[clinic input]
3965_ssl.get_default_verify_paths
3966
3967Return search paths and environment vars that are used by SSLContext's set_default_verify_paths() to load default CAs.
3968
3969The values are 'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.
3970[clinic start generated code]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02003971
3972static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003973_ssl_get_default_verify_paths_impl(PyModuleDef *module)
3974/*[clinic end generated code: output=5a2820ce7e3304d3 input=5210c953d98c3eb5]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02003975{
3976 PyObject *ofile_env = NULL;
3977 PyObject *ofile = NULL;
3978 PyObject *odir_env = NULL;
3979 PyObject *odir = NULL;
3980
Benjamin Petersond113c962015-07-18 10:59:13 -07003981#define CONVERT(info, target) { \
Christian Heimes6d7ad132013-06-09 18:02:55 +02003982 const char *tmp = (info); \
3983 target = NULL; \
3984 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
3985 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
3986 target = PyBytes_FromString(tmp); } \
3987 if (!target) goto error; \
Benjamin Peterson025a1fd2015-11-14 15:12:38 -08003988 }
Christian Heimes6d7ad132013-06-09 18:02:55 +02003989
Benjamin Petersond113c962015-07-18 10:59:13 -07003990 CONVERT(X509_get_default_cert_file_env(), ofile_env);
3991 CONVERT(X509_get_default_cert_file(), ofile);
3992 CONVERT(X509_get_default_cert_dir_env(), odir_env);
3993 CONVERT(X509_get_default_cert_dir(), odir);
3994#undef CONVERT
Christian Heimes6d7ad132013-06-09 18:02:55 +02003995
Christian Heimes200bb1b2013-06-14 15:14:29 +02003996 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02003997
3998 error:
3999 Py_XDECREF(ofile_env);
4000 Py_XDECREF(ofile);
4001 Py_XDECREF(odir_env);
4002 Py_XDECREF(odir);
4003 return NULL;
4004}
4005
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004006static PyObject*
4007asn1obj2py(ASN1_OBJECT *obj)
4008{
4009 int nid;
4010 const char *ln, *sn;
4011 char buf[100];
Victor Stinnercd752982014-07-07 21:52:29 +02004012 Py_ssize_t buflen;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004013
4014 nid = OBJ_obj2nid(obj);
4015 if (nid == NID_undef) {
4016 PyErr_Format(PyExc_ValueError, "Unknown object");
4017 return NULL;
4018 }
4019 sn = OBJ_nid2sn(nid);
4020 ln = OBJ_nid2ln(nid);
4021 buflen = OBJ_obj2txt(buf, sizeof(buf), obj, 1);
4022 if (buflen < 0) {
4023 _setSSLError(NULL, 0, __FILE__, __LINE__);
4024 return NULL;
4025 }
4026 if (buflen) {
4027 return Py_BuildValue("isss#", nid, sn, ln, buf, buflen);
4028 } else {
4029 return Py_BuildValue("issO", nid, sn, ln, Py_None);
4030 }
4031}
4032
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004033/*[clinic input]
4034_ssl.txt2obj
4035 txt: str
4036 name: bool = False
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004037
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004038Lookup NID, short name, long name and OID of an ASN1_OBJECT.
4039
4040By default objects are looked up by OID. With name=True short and
4041long name are also matched.
4042[clinic start generated code]*/
4043
4044static PyObject *
4045_ssl_txt2obj_impl(PyModuleDef *module, const char *txt, int name)
4046/*[clinic end generated code: output=2ae2c30531b8809f input=1c1e7d0aa7c48602]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004047{
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004048 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004049 ASN1_OBJECT *obj;
4050
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004051 obj = OBJ_txt2obj(txt, name ? 0 : 1);
4052 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01004053 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004054 return NULL;
4055 }
4056 result = asn1obj2py(obj);
4057 ASN1_OBJECT_free(obj);
4058 return result;
4059}
4060
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004061/*[clinic input]
4062_ssl.nid2obj
4063 nid: int
4064 /
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004065
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004066Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.
4067[clinic start generated code]*/
4068
4069static PyObject *
4070_ssl_nid2obj_impl(PyModuleDef *module, int nid)
4071/*[clinic end generated code: output=8db1df89e44badb8 input=51787a3bee7d8f98]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004072{
4073 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004074 ASN1_OBJECT *obj;
4075
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004076 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01004077 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004078 return NULL;
4079 }
4080 obj = OBJ_nid2obj(nid);
4081 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01004082 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01004083 return NULL;
4084 }
4085 result = asn1obj2py(obj);
4086 ASN1_OBJECT_free(obj);
4087 return result;
4088}
4089
Christian Heimes46bebee2013-06-09 19:03:31 +02004090#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01004091
4092static PyObject*
4093certEncodingType(DWORD encodingType)
4094{
4095 static PyObject *x509_asn = NULL;
4096 static PyObject *pkcs_7_asn = NULL;
4097
4098 if (x509_asn == NULL) {
4099 x509_asn = PyUnicode_InternFromString("x509_asn");
4100 if (x509_asn == NULL)
4101 return NULL;
4102 }
4103 if (pkcs_7_asn == NULL) {
4104 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
4105 if (pkcs_7_asn == NULL)
4106 return NULL;
4107 }
4108 switch(encodingType) {
4109 case X509_ASN_ENCODING:
4110 Py_INCREF(x509_asn);
4111 return x509_asn;
4112 case PKCS_7_ASN_ENCODING:
4113 Py_INCREF(pkcs_7_asn);
4114 return pkcs_7_asn;
4115 default:
4116 return PyLong_FromLong(encodingType);
4117 }
4118}
4119
4120static PyObject*
4121parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
4122{
4123 CERT_ENHKEY_USAGE *usage;
4124 DWORD size, error, i;
4125 PyObject *retval;
4126
4127 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
4128 error = GetLastError();
4129 if (error == CRYPT_E_NOT_FOUND) {
4130 Py_RETURN_TRUE;
4131 }
4132 return PyErr_SetFromWindowsErr(error);
4133 }
4134
4135 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
4136 if (usage == NULL) {
4137 return PyErr_NoMemory();
4138 }
4139
4140 /* Now get the actual enhanced usage property */
4141 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
4142 PyMem_Free(usage);
4143 error = GetLastError();
4144 if (error == CRYPT_E_NOT_FOUND) {
4145 Py_RETURN_TRUE;
4146 }
4147 return PyErr_SetFromWindowsErr(error);
4148 }
4149 retval = PySet_New(NULL);
4150 if (retval == NULL) {
4151 goto error;
4152 }
4153 for (i = 0; i < usage->cUsageIdentifier; ++i) {
4154 if (usage->rgpszUsageIdentifier[i]) {
4155 PyObject *oid;
4156 int err;
4157 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
4158 if (oid == NULL) {
4159 Py_CLEAR(retval);
4160 goto error;
4161 }
4162 err = PySet_Add(retval, oid);
4163 Py_DECREF(oid);
4164 if (err == -1) {
4165 Py_CLEAR(retval);
4166 goto error;
4167 }
4168 }
4169 }
4170 error:
4171 PyMem_Free(usage);
4172 return retval;
4173}
4174
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004175/*[clinic input]
4176_ssl.enum_certificates
4177 store_name: str
4178
4179Retrieve certificates from Windows' cert store.
4180
4181store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
4182more cert storages, too. The function returns a list of (bytes,
4183encoding_type, trust) tuples. The encoding_type flag can be interpreted
4184with X509_ASN_ENCODING or PKCS_7_ASN_ENCODING. The trust setting is either
4185a set of OIDs or the boolean True.
4186[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00004187
Christian Heimes46bebee2013-06-09 19:03:31 +02004188static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004189_ssl_enum_certificates_impl(PyModuleDef *module, const char *store_name)
4190/*[clinic end generated code: output=cc4ebc10b8adacfc input=915f60d70461ea4e]*/
Christian Heimes46bebee2013-06-09 19:03:31 +02004191{
Christian Heimes46bebee2013-06-09 19:03:31 +02004192 HCERTSTORE hStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01004193 PCCERT_CONTEXT pCertCtx = NULL;
4194 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02004195 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02004196
Christian Heimes44109d72013-11-22 01:51:30 +01004197 result = PyList_New(0);
4198 if (result == NULL) {
4199 return NULL;
4200 }
4201 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
4202 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02004203 Py_DECREF(result);
4204 return PyErr_SetFromWindowsErr(GetLastError());
4205 }
4206
Christian Heimes44109d72013-11-22 01:51:30 +01004207 while (pCertCtx = CertEnumCertificatesInStore(hStore, pCertCtx)) {
4208 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
4209 pCertCtx->cbCertEncoded);
4210 if (!cert) {
4211 Py_CLEAR(result);
4212 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02004213 }
Christian Heimes44109d72013-11-22 01:51:30 +01004214 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
4215 Py_CLEAR(result);
4216 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02004217 }
Christian Heimes44109d72013-11-22 01:51:30 +01004218 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
4219 if (keyusage == Py_True) {
4220 Py_DECREF(keyusage);
4221 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02004222 }
Christian Heimes44109d72013-11-22 01:51:30 +01004223 if (keyusage == NULL) {
4224 Py_CLEAR(result);
4225 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02004226 }
Christian Heimes44109d72013-11-22 01:51:30 +01004227 if ((tup = PyTuple_New(3)) == NULL) {
4228 Py_CLEAR(result);
4229 break;
4230 }
4231 PyTuple_SET_ITEM(tup, 0, cert);
4232 cert = NULL;
4233 PyTuple_SET_ITEM(tup, 1, enc);
4234 enc = NULL;
4235 PyTuple_SET_ITEM(tup, 2, keyusage);
4236 keyusage = NULL;
4237 if (PyList_Append(result, tup) < 0) {
4238 Py_CLEAR(result);
4239 break;
4240 }
4241 Py_CLEAR(tup);
4242 }
4243 if (pCertCtx) {
4244 /* loop ended with an error, need to clean up context manually */
4245 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02004246 }
4247
4248 /* In error cases cert, enc and tup may not be NULL */
4249 Py_XDECREF(cert);
4250 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01004251 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02004252 Py_XDECREF(tup);
4253
4254 if (!CertCloseStore(hStore, 0)) {
4255 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01004256 Py_XDECREF(result);
4257 return PyErr_SetFromWindowsErr(GetLastError());
4258 }
4259 return result;
4260}
4261
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004262/*[clinic input]
4263_ssl.enum_crls
4264 store_name: str
4265
4266Retrieve CRLs from Windows' cert store.
4267
4268store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
4269more cert storages, too. The function returns a list of (bytes,
4270encoding_type) tuples. The encoding_type flag can be interpreted with
4271X509_ASN_ENCODING or PKCS_7_ASN_ENCODING.
4272[clinic start generated code]*/
Christian Heimes44109d72013-11-22 01:51:30 +01004273
4274static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004275_ssl_enum_crls_impl(PyModuleDef *module, const char *store_name)
4276/*[clinic end generated code: output=763490a2aa1c50d5 input=a1f1d7629f1c5d3d]*/
Christian Heimes44109d72013-11-22 01:51:30 +01004277{
Christian Heimes44109d72013-11-22 01:51:30 +01004278 HCERTSTORE hStore = NULL;
4279 PCCRL_CONTEXT pCrlCtx = NULL;
4280 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
4281 PyObject *result = NULL;
4282
Christian Heimes44109d72013-11-22 01:51:30 +01004283 result = PyList_New(0);
4284 if (result == NULL) {
4285 return NULL;
4286 }
4287 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
4288 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02004289 Py_DECREF(result);
4290 return PyErr_SetFromWindowsErr(GetLastError());
4291 }
Christian Heimes44109d72013-11-22 01:51:30 +01004292
4293 while (pCrlCtx = CertEnumCRLsInStore(hStore, pCrlCtx)) {
4294 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
4295 pCrlCtx->cbCrlEncoded);
4296 if (!crl) {
4297 Py_CLEAR(result);
4298 break;
4299 }
4300 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
4301 Py_CLEAR(result);
4302 break;
4303 }
4304 if ((tup = PyTuple_New(2)) == NULL) {
4305 Py_CLEAR(result);
4306 break;
4307 }
4308 PyTuple_SET_ITEM(tup, 0, crl);
4309 crl = NULL;
4310 PyTuple_SET_ITEM(tup, 1, enc);
4311 enc = NULL;
4312
4313 if (PyList_Append(result, tup) < 0) {
4314 Py_CLEAR(result);
4315 break;
4316 }
4317 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02004318 }
Christian Heimes44109d72013-11-22 01:51:30 +01004319 if (pCrlCtx) {
4320 /* loop ended with an error, need to clean up context manually */
4321 CertFreeCRLContext(pCrlCtx);
4322 }
4323
4324 /* In error cases cert, enc and tup may not be NULL */
4325 Py_XDECREF(crl);
4326 Py_XDECREF(enc);
4327 Py_XDECREF(tup);
4328
4329 if (!CertCloseStore(hStore, 0)) {
4330 /* This error case might shadow another exception.*/
4331 Py_XDECREF(result);
4332 return PyErr_SetFromWindowsErr(GetLastError());
4333 }
4334 return result;
Christian Heimes46bebee2013-06-09 19:03:31 +02004335}
Christian Heimes44109d72013-11-22 01:51:30 +01004336
4337#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00004338
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004339/* List of functions exported by this module. */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004340static PyMethodDef PySSL_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004341 _SSL__TEST_DECODE_CERT_METHODDEF
4342 _SSL_RAND_ADD_METHODDEF
4343 _SSL_RAND_BYTES_METHODDEF
4344 _SSL_RAND_PSEUDO_BYTES_METHODDEF
4345 _SSL_RAND_EGD_METHODDEF
4346 _SSL_RAND_STATUS_METHODDEF
4347 _SSL_GET_DEFAULT_VERIFY_PATHS_METHODDEF
4348 _SSL_ENUM_CERTIFICATES_METHODDEF
4349 _SSL_ENUM_CRLS_METHODDEF
4350 _SSL_TXT2OBJ_METHODDEF
4351 _SSL_NID2OBJ_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004352 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004353};
4354
4355
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004356#ifdef WITH_THREAD
4357
4358/* an implementation of OpenSSL threading operations in terms
4359 of the Python C thread library */
4360
4361static PyThread_type_lock *_ssl_locks = NULL;
4362
Christian Heimes4d98ca92013-08-19 17:36:29 +02004363#if OPENSSL_VERSION_NUMBER >= 0x10000000
4364/* use new CRYPTO_THREADID API. */
4365static void
4366_ssl_threadid_callback(CRYPTO_THREADID *id)
4367{
4368 CRYPTO_THREADID_set_numeric(id,
4369 (unsigned long)PyThread_get_thread_ident());
4370}
4371#else
4372/* deprecated CRYPTO_set_id_callback() API. */
4373static unsigned long
4374_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004375 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004376}
Christian Heimes4d98ca92013-08-19 17:36:29 +02004377#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004378
Bill Janssen6e027db2007-11-15 22:23:56 +00004379static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004380 (int mode, int n, const char *file, int line) {
4381 /* this function is needed to perform locking on shared data
4382 structures. (Note that OpenSSL uses a number of global data
4383 structures that will be implicitly shared whenever multiple
4384 threads use OpenSSL.) Multi-threaded applications will
4385 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004386
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004387 locking_function() must be able to handle up to
4388 CRYPTO_num_locks() different mutex locks. It sets the n-th
4389 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004390
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004391 file and line are the file number of the function setting the
4392 lock. They can be useful for debugging.
4393 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004394
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004395 if ((_ssl_locks == NULL) ||
4396 (n < 0) || ((unsigned)n >= _ssl_locks_count))
4397 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004398
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004399 if (mode & CRYPTO_LOCK) {
4400 PyThread_acquire_lock(_ssl_locks[n], 1);
4401 } else {
4402 PyThread_release_lock(_ssl_locks[n]);
4403 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004404}
4405
4406static int _setup_ssl_threads(void) {
4407
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004408 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004409
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004410 if (_ssl_locks == NULL) {
4411 _ssl_locks_count = CRYPTO_num_locks();
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004412 _ssl_locks = PyMem_New(PyThread_type_lock, _ssl_locks_count);
4413 if (_ssl_locks == NULL) {
4414 PyErr_NoMemory();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004415 return 0;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02004416 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004417 memset(_ssl_locks, 0,
4418 sizeof(PyThread_type_lock) * _ssl_locks_count);
4419 for (i = 0; i < _ssl_locks_count; i++) {
4420 _ssl_locks[i] = PyThread_allocate_lock();
4421 if (_ssl_locks[i] == NULL) {
4422 unsigned int j;
4423 for (j = 0; j < i; j++) {
4424 PyThread_free_lock(_ssl_locks[j]);
4425 }
Victor Stinnerb6404912013-07-07 16:21:41 +02004426 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004427 return 0;
4428 }
4429 }
4430 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02004431#if OPENSSL_VERSION_NUMBER >= 0x10000000
4432 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
4433#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004434 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02004435#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004436 }
4437 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004438}
4439
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004440#endif /* def HAVE_THREAD */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004441
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004442PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004443"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00004444for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004445
Martin v. Löwis1a214512008-06-11 05:26:20 +00004446
4447static struct PyModuleDef _sslmodule = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004448 PyModuleDef_HEAD_INIT,
4449 "_ssl",
4450 module_doc,
4451 -1,
4452 PySSL_methods,
4453 NULL,
4454 NULL,
4455 NULL,
4456 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00004457};
4458
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004459
4460static void
4461parse_openssl_version(unsigned long libver,
4462 unsigned int *major, unsigned int *minor,
4463 unsigned int *fix, unsigned int *patch,
4464 unsigned int *status)
4465{
4466 *status = libver & 0xF;
4467 libver >>= 4;
4468 *patch = libver & 0xFF;
4469 libver >>= 8;
4470 *fix = libver & 0xFF;
4471 libver >>= 8;
4472 *minor = libver & 0xFF;
4473 libver >>= 8;
4474 *major = libver & 0xFF;
4475}
4476
Mark Hammondfe51c6d2002-08-02 02:27:13 +00004477PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00004478PyInit__ssl(void)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004479{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004480 PyObject *m, *d, *r;
4481 unsigned long libver;
4482 unsigned int major, minor, fix, patch, status;
4483 PySocketModule_APIObject *socket_api;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004484 struct py_ssl_error_code *errcode;
4485 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004486
Antoine Pitrou152efa22010-05-16 18:19:27 +00004487 if (PyType_Ready(&PySSLContext_Type) < 0)
4488 return NULL;
4489 if (PyType_Ready(&PySSLSocket_Type) < 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004490 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004491 if (PyType_Ready(&PySSLMemoryBIO_Type) < 0)
4492 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004493
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004494 m = PyModule_Create(&_sslmodule);
4495 if (m == NULL)
4496 return NULL;
4497 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004498
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004499 /* Load _socket module and its C API */
4500 socket_api = PySocketModule_ImportModuleAndAPI();
4501 if (!socket_api)
4502 return NULL;
4503 PySocketModule = *socket_api;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004504
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004505 /* Init OpenSSL */
4506 SSL_load_error_strings();
4507 SSL_library_init();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004508#ifdef WITH_THREAD
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004509 /* note that this will start threading if not already started */
4510 if (!_setup_ssl_threads()) {
4511 return NULL;
4512 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00004513#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004514 OpenSSL_add_all_algorithms();
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004515
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004516 /* Add symbols to module dict */
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004517 sslerror_type_slots[0].pfunc = PyExc_OSError;
4518 PySSLErrorObject = PyType_FromSpec(&sslerror_type_spec);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004519 if (PySSLErrorObject == NULL)
4520 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004521
Antoine Pitrou41032a62011-10-27 23:56:55 +02004522 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
4523 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
4524 PySSLErrorObject, NULL);
4525 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
4526 "ssl.SSLWantReadError", SSLWantReadError_doc,
4527 PySSLErrorObject, NULL);
4528 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
4529 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
4530 PySSLErrorObject, NULL);
4531 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
4532 "ssl.SSLSyscallError", SSLSyscallError_doc,
4533 PySSLErrorObject, NULL);
4534 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
4535 "ssl.SSLEOFError", SSLEOFError_doc,
4536 PySSLErrorObject, NULL);
4537 if (PySSLZeroReturnErrorObject == NULL
4538 || PySSLWantReadErrorObject == NULL
4539 || PySSLWantWriteErrorObject == NULL
4540 || PySSLSyscallErrorObject == NULL
4541 || PySSLEOFErrorObject == NULL)
4542 return NULL;
4543 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
4544 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
4545 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
4546 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
4547 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
4548 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004549 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004550 if (PyDict_SetItemString(d, "_SSLContext",
4551 (PyObject *)&PySSLContext_Type) != 0)
4552 return NULL;
4553 if (PyDict_SetItemString(d, "_SSLSocket",
4554 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004555 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004556 if (PyDict_SetItemString(d, "MemoryBIO",
4557 (PyObject *)&PySSLMemoryBIO_Type) != 0)
4558 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004559 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
4560 PY_SSL_ERROR_ZERO_RETURN);
4561 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
4562 PY_SSL_ERROR_WANT_READ);
4563 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
4564 PY_SSL_ERROR_WANT_WRITE);
4565 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
4566 PY_SSL_ERROR_WANT_X509_LOOKUP);
4567 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
4568 PY_SSL_ERROR_SYSCALL);
4569 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
4570 PY_SSL_ERROR_SSL);
4571 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
4572 PY_SSL_ERROR_WANT_CONNECT);
4573 /* non ssl.h errorcodes */
4574 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
4575 PY_SSL_ERROR_EOF);
4576 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
4577 PY_SSL_ERROR_INVALID_ERROR_CODE);
4578 /* cert requirements */
4579 PyModule_AddIntConstant(m, "CERT_NONE",
4580 PY_SSL_CERT_NONE);
4581 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
4582 PY_SSL_CERT_OPTIONAL);
4583 PyModule_AddIntConstant(m, "CERT_REQUIRED",
4584 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01004585 /* CRL verification for verification_flags */
4586 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
4587 0);
4588 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
4589 X509_V_FLAG_CRL_CHECK);
4590 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
4591 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
4592 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
4593 X509_V_FLAG_X509_STRICT);
Benjamin Peterson990fcaa2015-03-04 22:49:41 -05004594#ifdef X509_V_FLAG_TRUSTED_FIRST
4595 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
4596 X509_V_FLAG_TRUSTED_FIRST);
4597#endif
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00004598
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004599 /* Alert Descriptions from ssl.h */
4600 /* note RESERVED constants no longer intended for use have been removed */
4601 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
4602
4603#define ADD_AD_CONSTANT(s) \
4604 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
4605 SSL_AD_##s)
4606
4607 ADD_AD_CONSTANT(CLOSE_NOTIFY);
4608 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
4609 ADD_AD_CONSTANT(BAD_RECORD_MAC);
4610 ADD_AD_CONSTANT(RECORD_OVERFLOW);
4611 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
4612 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
4613 ADD_AD_CONSTANT(BAD_CERTIFICATE);
4614 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
4615 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
4616 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
4617 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
4618 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
4619 ADD_AD_CONSTANT(UNKNOWN_CA);
4620 ADD_AD_CONSTANT(ACCESS_DENIED);
4621 ADD_AD_CONSTANT(DECODE_ERROR);
4622 ADD_AD_CONSTANT(DECRYPT_ERROR);
4623 ADD_AD_CONSTANT(PROTOCOL_VERSION);
4624 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
4625 ADD_AD_CONSTANT(INTERNAL_ERROR);
4626 ADD_AD_CONSTANT(USER_CANCELLED);
4627 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004628 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004629#ifdef SSL_AD_UNSUPPORTED_EXTENSION
4630 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
4631#endif
4632#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
4633 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
4634#endif
4635#ifdef SSL_AD_UNRECOGNIZED_NAME
4636 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
4637#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004638#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
4639 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
4640#endif
4641#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
4642 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
4643#endif
4644#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
4645 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
4646#endif
4647
4648#undef ADD_AD_CONSTANT
4649
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004650 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02004651#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004652 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
4653 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02004654#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05004655#ifndef OPENSSL_NO_SSL3
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004656 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
4657 PY_SSL_VERSION_SSL3);
Benjamin Petersone32467c2014-12-05 21:59:35 -05004658#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004659 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
4660 PY_SSL_VERSION_SSL23);
4661 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
4662 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004663#if HAVE_TLSv1_2
4664 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
4665 PY_SSL_VERSION_TLS1_1);
4666 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
4667 PY_SSL_VERSION_TLS1_2);
4668#endif
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004669
Antoine Pitroub5218772010-05-21 09:56:06 +00004670 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01004671 PyModule_AddIntConstant(m, "OP_ALL",
4672 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00004673 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
4674 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
4675 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004676#if HAVE_TLSv1_2
4677 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
4678 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
4679#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01004680 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
4681 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004682 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004683#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004684 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004685#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01004686#ifdef SSL_OP_NO_COMPRESSION
4687 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
4688 SSL_OP_NO_COMPRESSION);
4689#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00004690
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004691#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +00004692 r = Py_True;
4693#else
4694 r = Py_False;
4695#endif
4696 Py_INCREF(r);
4697 PyModule_AddObject(m, "HAS_SNI", r);
4698
Antoine Pitroud6494802011-07-21 01:11:30 +02004699 r = Py_True;
Antoine Pitroud6494802011-07-21 01:11:30 +02004700 Py_INCREF(r);
4701 PyModule_AddObject(m, "HAS_TLS_UNIQUE", r);
4702
Antoine Pitrou501da612011-12-21 09:27:41 +01004703#ifdef OPENSSL_NO_ECDH
4704 r = Py_False;
4705#else
4706 r = Py_True;
4707#endif
4708 Py_INCREF(r);
4709 PyModule_AddObject(m, "HAS_ECDH", r);
4710
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01004711#ifdef OPENSSL_NPN_NEGOTIATED
4712 r = Py_True;
4713#else
4714 r = Py_False;
4715#endif
4716 Py_INCREF(r);
4717 PyModule_AddObject(m, "HAS_NPN", r);
4718
Benjamin Petersoncca27322015-01-23 16:35:37 -05004719#ifdef HAVE_ALPN
4720 r = Py_True;
4721#else
4722 r = Py_False;
4723#endif
4724 Py_INCREF(r);
4725 PyModule_AddObject(m, "HAS_ALPN", r);
4726
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004727 /* Mappings for error codes */
4728 err_codes_to_names = PyDict_New();
4729 err_names_to_codes = PyDict_New();
4730 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
4731 return NULL;
4732 errcode = error_codes;
4733 while (errcode->mnemonic != NULL) {
4734 PyObject *mnemo, *key;
4735 mnemo = PyUnicode_FromString(errcode->mnemonic);
4736 key = Py_BuildValue("ii", errcode->library, errcode->reason);
4737 if (mnemo == NULL || key == NULL)
4738 return NULL;
4739 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
4740 return NULL;
4741 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
4742 return NULL;
4743 Py_DECREF(key);
4744 Py_DECREF(mnemo);
4745 errcode++;
4746 }
4747 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
4748 return NULL;
4749 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
4750 return NULL;
4751
4752 lib_codes_to_names = PyDict_New();
4753 if (lib_codes_to_names == NULL)
4754 return NULL;
4755 libcode = library_codes;
4756 while (libcode->library != NULL) {
4757 PyObject *mnemo, *key;
4758 key = PyLong_FromLong(libcode->code);
4759 mnemo = PyUnicode_FromString(libcode->library);
4760 if (key == NULL || mnemo == NULL)
4761 return NULL;
4762 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
4763 return NULL;
4764 Py_DECREF(key);
4765 Py_DECREF(mnemo);
4766 libcode++;
4767 }
4768 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
4769 return NULL;
Victor Stinner4569cd52013-06-23 14:58:43 +02004770
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004771 /* OpenSSL version */
4772 /* SSLeay() gives us the version of the library linked against,
4773 which could be different from the headers version.
4774 */
4775 libver = SSLeay();
4776 r = PyLong_FromUnsignedLong(libver);
4777 if (r == NULL)
4778 return NULL;
4779 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
4780 return NULL;
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004781 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004782 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4783 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
4784 return NULL;
4785 r = PyUnicode_FromString(SSLeay_version(SSLEAY_VERSION));
4786 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
4787 return NULL;
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004788
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004789 libver = OPENSSL_VERSION_NUMBER;
4790 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
4791 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4792 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
4793 return NULL;
4794
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004795 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004796}