blob: 5e82fe41a76ec294be1b9a22fc2ad74abc019e70 [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
Steve Dower68d663c2017-07-17 11:15:48 +020021/* Redefined below for Windows debug builds after important #includes */
22#define _PySSL_FIX_ERRNO
Christian Heimesf77b4b22013-08-21 13:26:05 +020023
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020024#define PySSL_BEGIN_ALLOW_THREADS_S(save) \
25 do { if (_ssl_locks_count>0) { (save) = PyEval_SaveThread(); } } while (0)
26#define PySSL_END_ALLOW_THREADS_S(save) \
Steve Dower68d663c2017-07-17 11:15:48 +020027 do { if (_ssl_locks_count>0) { PyEval_RestoreThread(save); } _PySSL_FIX_ERRNO; } while (0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +000028#define PySSL_BEGIN_ALLOW_THREADS { \
Antoine Pitroucbb82eb2010-05-05 15:57:33 +000029 PyThreadState *_save = NULL; \
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020030 PySSL_BEGIN_ALLOW_THREADS_S(_save);
31#define PySSL_BLOCK_THREADS PySSL_END_ALLOW_THREADS_S(_save);
32#define PySSL_UNBLOCK_THREADS PySSL_BEGIN_ALLOW_THREADS_S(_save);
33#define PySSL_END_ALLOW_THREADS PySSL_END_ALLOW_THREADS_S(_save); }
Thomas Wouters1b7f8912007-09-19 03:06:30 +000034
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010035/* Include symbols from _socket module */
36#include "socketmodule.h"
37
38static PySocketModule_APIObject PySocketModule;
39
40#if defined(HAVE_POLL_H)
41#include <poll.h>
42#elif defined(HAVE_SYS_POLL_H)
43#include <sys/poll.h>
44#endif
45
Christian Heimes598894f2016-09-05 23:19:05 +020046/* Don't warn about deprecated functions */
47#ifdef __GNUC__
48#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
49#endif
50#ifdef __clang__
51#pragma clang diagnostic ignored "-Wdeprecated-declarations"
52#endif
53
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010054/* Include OpenSSL header files */
55#include "openssl/rsa.h"
56#include "openssl/crypto.h"
57#include "openssl/x509.h"
58#include "openssl/x509v3.h"
59#include "openssl/pem.h"
60#include "openssl/ssl.h"
61#include "openssl/err.h"
62#include "openssl/rand.h"
Antoine Pitroub1fdf472014-10-05 20:41:53 +020063#include "openssl/bio.h"
Alexandru Ardeleanb3a271f2018-09-17 14:53:31 +030064#include "openssl/dh.h"
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010065
Christian Heimesff5be6e2018-01-20 13:19:21 +010066#ifndef HAVE_X509_VERIFY_PARAM_SET1_HOST
Christian Heimes61d478c2018-01-27 15:51:38 +010067# ifdef LIBRESSL_VERSION_NUMBER
68# error "LibreSSL is missing X509_VERIFY_PARAM_set1_host(), see https://github.com/libressl-portable/portable/issues/381"
69# elif OPENSSL_VERSION_NUMBER > 0x1000200fL
Christian Heimesff5be6e2018-01-20 13:19:21 +010070# define HAVE_X509_VERIFY_PARAM_SET1_HOST
Christian Heimes61d478c2018-01-27 15:51:38 +010071# else
72# error "libssl is too old and does not support X509_VERIFY_PARAM_set1_host()"
Christian Heimesff5be6e2018-01-20 13:19:21 +010073# endif
74#endif
75
Christian Heimesc087a262020-05-15 20:55:25 +020076#ifndef OPENSSL_THREADS
77# error "OPENSSL_THREADS is not defined, Python requires thread-safe OpenSSL"
78#endif
79
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010080/* SSL error object */
81static PyObject *PySSLErrorObject;
Christian Heimesb3ad0e52017-09-08 12:00:19 -070082static PyObject *PySSLCertVerificationErrorObject;
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010083static PyObject *PySSLZeroReturnErrorObject;
84static PyObject *PySSLWantReadErrorObject;
85static PyObject *PySSLWantWriteErrorObject;
86static PyObject *PySSLSyscallErrorObject;
87static PyObject *PySSLEOFErrorObject;
88
89/* Error mappings */
90static PyObject *err_codes_to_names;
91static PyObject *err_names_to_codes;
92static PyObject *lib_codes_to_names;
93
94struct py_ssl_error_code {
95 const char *mnemonic;
96 int library, reason;
97};
98struct py_ssl_library_code {
99 const char *library;
100 int code;
101};
102
Steve Dower68d663c2017-07-17 11:15:48 +0200103#if defined(MS_WINDOWS) && defined(Py_DEBUG)
104/* Debug builds on Windows rely on getting errno directly from OpenSSL.
105 * However, because it uses a different CRT, we need to transfer the
106 * value of errno from OpenSSL into our debug CRT.
107 *
108 * Don't be fooled - this is horribly ugly code. The only reasonable
109 * alternative is to do both debug and release builds of OpenSSL, which
110 * requires much uglier code to transform their automatically generated
111 * makefile. This is the lesser of all the evils.
112 */
113
114static void _PySSLFixErrno(void) {
115 HMODULE ucrtbase = GetModuleHandleW(L"ucrtbase.dll");
116 if (!ucrtbase) {
117 /* If ucrtbase.dll is not loaded but the SSL DLLs are, we likely
118 * have a catastrophic failure, but this function is not the
119 * place to raise it. */
120 return;
121 }
122
123 typedef int *(__stdcall *errno_func)(void);
124 errno_func ssl_errno = (errno_func)GetProcAddress(ucrtbase, "_errno");
125 if (ssl_errno) {
126 errno = *ssl_errno();
127 *ssl_errno() = 0;
128 } else {
129 errno = ENOTRECOVERABLE;
130 }
131}
132
133#undef _PySSL_FIX_ERRNO
134#define _PySSL_FIX_ERRNO _PySSLFixErrno()
135#endif
136
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100137/* Include generated data (error codes) */
138#include "_ssl_data.h"
139
Christian Heimes598894f2016-09-05 23:19:05 +0200140#if (OPENSSL_VERSION_NUMBER >= 0x10100000L) && !defined(LIBRESSL_VERSION_NUMBER)
141# define OPENSSL_VERSION_1_1 1
Christian Heimes4ca07392018-03-24 15:41:37 +0100142# define PY_OPENSSL_1_1_API 1
143#endif
144
Christian Heimesa871f692020-06-01 08:58:14 +0200145/* OpenSSL API compat */
146#ifdef OPENSSL_API_COMPAT
147#if OPENSSL_API_COMPAT >= 0x10100000L
148
149/* OpenSSL API 1.1.0+ does not include version methods */
150#ifndef OPENSSL_NO_TLS1_METHOD
151#define OPENSSL_NO_TLS1_METHOD 1
152#endif
153#ifndef OPENSSL_NO_TLS1_1_METHOD
154#define OPENSSL_NO_TLS1_1_METHOD 1
155#endif
156#ifndef OPENSSL_NO_TLS1_2_METHOD
157#define OPENSSL_NO_TLS1_2_METHOD 1
158#endif
159
160#endif /* >= 1.1.0 compcat */
161#endif /* OPENSSL_API_COMPAT */
162
Christian Heimes4ca07392018-03-24 15:41:37 +0100163/* LibreSSL 2.7.0 provides necessary OpenSSL 1.1.0 APIs */
164#if defined(LIBRESSL_VERSION_NUMBER) && LIBRESSL_VERSION_NUMBER >= 0x2070000fL
165# define PY_OPENSSL_1_1_API 1
Christian Heimes598894f2016-09-05 23:19:05 +0200166#endif
167
Christian Heimes470fba12013-11-28 15:12:15 +0100168/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100169 * This includes the SSL_set_SSL_CTX() function.
170 */
171#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
172# define HAVE_SNI 1
173#else
174# define HAVE_SNI 0
175#endif
176
Benjamin Petersond3308222015-09-27 00:09:02 -0700177#ifdef TLSEXT_TYPE_application_layer_protocol_negotiation
Christian Heimes29eab552018-02-25 12:31:33 +0100178# define HAVE_ALPN 1
179#else
180# define HAVE_ALPN 0
Benjamin Petersoncca27322015-01-23 16:35:37 -0500181#endif
182
Christian Heimes6cdb7952018-02-24 22:12:40 +0100183/* We cannot rely on OPENSSL_NO_NEXTPROTONEG because LibreSSL 2.6.1 dropped
184 * NPN support but did not set OPENSSL_NO_NEXTPROTONEG for compatibility
185 * reasons. The check for TLSEXT_TYPE_next_proto_neg works with
186 * OpenSSL 1.0.1+ and LibreSSL.
Christian Heimes29eab552018-02-25 12:31:33 +0100187 * OpenSSL 1.1.1-pre1 dropped NPN but still has TLSEXT_TYPE_next_proto_neg.
Christian Heimes6cdb7952018-02-24 22:12:40 +0100188 */
189#ifdef OPENSSL_NO_NEXTPROTONEG
Christian Heimes29eab552018-02-25 12:31:33 +0100190# define HAVE_NPN 0
191#elif (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
192# define HAVE_NPN 0
Christian Heimes6cdb7952018-02-24 22:12:40 +0100193#elif defined(TLSEXT_TYPE_next_proto_neg)
Christian Heimes29eab552018-02-25 12:31:33 +0100194# define HAVE_NPN 1
Christian Heimes6cdb7952018-02-24 22:12:40 +0100195#else
Christian Heimes29eab552018-02-25 12:31:33 +0100196# define HAVE_NPN 0
197#endif
Christian Heimes6cdb7952018-02-24 22:12:40 +0100198
Christian Heimesc7f70692019-05-31 11:44:05 +0200199#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
200#define HAVE_OPENSSL_KEYLOG 1
201#endif
202
Victor Stinner524714e2016-07-22 17:43:59 +0200203#ifndef INVALID_SOCKET /* MS defines this */
204#define INVALID_SOCKET (-1)
205#endif
206
Christian Heimes4ca07392018-03-24 15:41:37 +0100207/* OpenSSL 1.0.2 and LibreSSL needs extra code for locking */
208#ifndef OPENSSL_VERSION_1_1
209#define HAVE_OPENSSL_CRYPTO_LOCK
210#endif
211
212#if defined(OPENSSL_VERSION_1_1) && !defined(OPENSSL_NO_SSL2)
Christian Heimes598894f2016-09-05 23:19:05 +0200213#define OPENSSL_NO_SSL2
214#endif
Christian Heimes4ca07392018-03-24 15:41:37 +0100215
216#ifndef PY_OPENSSL_1_1_API
217/* OpenSSL 1.1 API shims for OpenSSL < 1.1.0 and LibreSSL < 2.7.0 */
Christian Heimes598894f2016-09-05 23:19:05 +0200218
219#define TLS_method SSLv23_method
Christian Heimes5fe668c2016-09-12 00:01:11 +0200220#define TLS_client_method SSLv23_client_method
221#define TLS_server_method SSLv23_server_method
Christian Heimesa871f692020-06-01 08:58:14 +0200222#define ASN1_STRING_get0_data ASN1_STRING_data
223#define X509_get0_notBefore X509_get_notBefore
224#define X509_get0_notAfter X509_get_notAfter
225#define OpenSSL_version_num SSLeay
226#define OpenSSL_version SSLeay_version
227#define OPENSSL_VERSION SSLEAY_VERSION
Christian Heimes598894f2016-09-05 23:19:05 +0200228
229static int X509_NAME_ENTRY_set(const X509_NAME_ENTRY *ne)
230{
231 return ne->set;
232}
233
234#ifndef OPENSSL_NO_COMP
Christian Heimesa5d07652016-09-24 10:48:05 +0200235/* LCOV_EXCL_START */
Christian Heimes598894f2016-09-05 23:19:05 +0200236static int COMP_get_type(const COMP_METHOD *meth)
237{
238 return meth->type;
239}
Christian Heimes1a63b9f2016-09-24 12:07:21 +0200240/* LCOV_EXCL_STOP */
Christian Heimes598894f2016-09-05 23:19:05 +0200241#endif
242
243static pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
244{
245 return ctx->default_passwd_callback;
246}
247
248static void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
249{
250 return ctx->default_passwd_callback_userdata;
251}
252
253static int X509_OBJECT_get_type(X509_OBJECT *x)
254{
255 return x->type;
256}
257
258static X509 *X509_OBJECT_get0_X509(X509_OBJECT *x)
259{
260 return x->data.x509;
261}
262
263static int BIO_up_ref(BIO *b)
264{
265 CRYPTO_add(&b->references, 1, CRYPTO_LOCK_BIO);
266 return 1;
267}
268
269static STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(X509_STORE *store) {
270 return store->objs;
271}
272
Christian Heimes99a65702016-09-10 23:44:53 +0200273static int
274SSL_SESSION_has_ticket(const SSL_SESSION *s)
275{
276 return (s->tlsext_ticklen > 0) ? 1 : 0;
277}
278
279static unsigned long
280SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
281{
282 return s->tlsext_tick_lifetime_hint;
283}
284
Christian Heimes4ca07392018-03-24 15:41:37 +0100285#endif /* OpenSSL < 1.1.0 or LibreSSL < 2.7.0 */
Christian Heimes598894f2016-09-05 23:19:05 +0200286
Christian Heimes892d66e2018-01-29 14:10:18 +0100287/* Default cipher suites */
288#ifndef PY_SSL_DEFAULT_CIPHERS
289#define PY_SSL_DEFAULT_CIPHERS 1
290#endif
291
292#if PY_SSL_DEFAULT_CIPHERS == 0
293 #ifndef PY_SSL_DEFAULT_CIPHER_STRING
294 #error "Py_SSL_DEFAULT_CIPHERS 0 needs Py_SSL_DEFAULT_CIPHER_STRING"
295 #endif
296#elif PY_SSL_DEFAULT_CIPHERS == 1
Stéphane Wirtel07fbbfd2018-10-05 16:17:18 +0200297/* Python custom selection of sensible cipher suites
Christian Heimes892d66e2018-01-29 14:10:18 +0100298 * DEFAULT: OpenSSL's default cipher list. Since 1.0.2 the list is in sensible order.
299 * !aNULL:!eNULL: really no NULL ciphers
300 * !MD5:!3DES:!DES:!RC4:!IDEA:!SEED: no weak or broken algorithms on old OpenSSL versions.
301 * !aDSS: no authentication with discrete logarithm DSA algorithm
302 * !SRP:!PSK: no secure remote password or pre-shared key authentication
303 */
304 #define PY_SSL_DEFAULT_CIPHER_STRING "DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK"
305#elif PY_SSL_DEFAULT_CIPHERS == 2
306/* Ignored in SSLContext constructor, only used to as _ssl.DEFAULT_CIPHER_STRING */
307 #define PY_SSL_DEFAULT_CIPHER_STRING SSL_DEFAULT_CIPHER_LIST
308#else
309 #error "Unsupported PY_SSL_DEFAULT_CIPHERS"
310#endif
311
Christian Heimes598894f2016-09-05 23:19:05 +0200312
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000313enum py_ssl_error {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000314 /* these mirror ssl.h */
315 PY_SSL_ERROR_NONE,
316 PY_SSL_ERROR_SSL,
317 PY_SSL_ERROR_WANT_READ,
318 PY_SSL_ERROR_WANT_WRITE,
319 PY_SSL_ERROR_WANT_X509_LOOKUP,
320 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
321 PY_SSL_ERROR_ZERO_RETURN,
322 PY_SSL_ERROR_WANT_CONNECT,
323 /* start of non ssl.h errorcodes */
324 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
325 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
326 PY_SSL_ERROR_INVALID_ERROR_CODE
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000327};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000328
Thomas Woutersed03b412007-08-28 21:37:11 +0000329enum py_ssl_server_or_client {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000330 PY_SSL_CLIENT,
331 PY_SSL_SERVER
Thomas Woutersed03b412007-08-28 21:37:11 +0000332};
333
334enum py_ssl_cert_requirements {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000335 PY_SSL_CERT_NONE,
336 PY_SSL_CERT_OPTIONAL,
337 PY_SSL_CERT_REQUIRED
Thomas Woutersed03b412007-08-28 21:37:11 +0000338};
339
340enum py_ssl_version {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000341 PY_SSL_VERSION_SSL2,
Victor Stinner3de49192011-05-09 00:42:58 +0200342 PY_SSL_VERSION_SSL3=1,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200343 PY_SSL_VERSION_TLS, /* SSLv23 */
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100344 PY_SSL_VERSION_TLS1,
345 PY_SSL_VERSION_TLS1_1,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200346 PY_SSL_VERSION_TLS1_2,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200347 PY_SSL_VERSION_TLS_CLIENT=0x10,
348 PY_SSL_VERSION_TLS_SERVER,
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100349};
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200350
Christian Heimes698dde12018-02-27 11:54:43 +0100351enum py_proto_version {
352 PY_PROTO_MINIMUM_SUPPORTED = -2,
353 PY_PROTO_SSLv3 = SSL3_VERSION,
354 PY_PROTO_TLSv1 = TLS1_VERSION,
355 PY_PROTO_TLSv1_1 = TLS1_1_VERSION,
356 PY_PROTO_TLSv1_2 = TLS1_2_VERSION,
357#ifdef TLS1_3_VERSION
358 PY_PROTO_TLSv1_3 = TLS1_3_VERSION,
359#else
360 PY_PROTO_TLSv1_3 = 0x304,
361#endif
362 PY_PROTO_MAXIMUM_SUPPORTED = -1,
363
364/* OpenSSL has no dedicated API to set the minimum version to the maximum
365 * available version, and the other way around. We have to figure out the
366 * minimum and maximum available version on our own and hope for the best.
367 */
368#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
369 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_SSLv3,
370#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
371 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1,
372#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
373 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_1,
374#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
375 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_2,
376#elif defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
377 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_3,
378#else
379 #error "PY_PROTO_MINIMUM_AVAILABLE not found"
380#endif
381
382#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
383 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_3,
384#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
385 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_2,
386#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
387 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_1,
388#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
389 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1,
390#elif defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
391 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_SSLv3,
392#else
393 #error "PY_PROTO_MAXIMUM_AVAILABLE not found"
394#endif
395};
396
397
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000398/* serves as a flag to see whether we've initialized the SSL thread support. */
399/* 0 means no, greater than 0 means yes */
400
401static unsigned int _ssl_locks_count = 0;
402
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000403/* SSL socket object */
404
405#define X509_NAME_MAXLEN 256
406
Gregory P. Smithbd4dacb2010-10-13 03:53:21 +0000407/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
408 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
409 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
410#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
Antoine Pitroub5218772010-05-21 09:56:06 +0000411# define HAVE_SSL_CTX_CLEAR_OPTIONS
412#else
413# undef HAVE_SSL_CTX_CLEAR_OPTIONS
414#endif
415
Antoine Pitroud6494802011-07-21 01:11:30 +0200416/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
417 * older SSL, but let's be safe */
418#define PySSL_CB_MAXLEN 128
419
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100420
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000421typedef struct {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000422 PyObject_HEAD
Antoine Pitrou152efa22010-05-16 18:19:27 +0000423 SSL_CTX *ctx;
Christian Heimes29eab552018-02-25 12:31:33 +0100424#if HAVE_NPN
Benjamin Petersoncca27322015-01-23 16:35:37 -0500425 unsigned char *npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100426 int npn_protocols_len;
427#endif
Christian Heimes29eab552018-02-25 12:31:33 +0100428#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -0500429 unsigned char *alpn_protocols;
Segev Finer5cff6372017-07-27 01:19:17 +0300430 unsigned int alpn_protocols_len;
Benjamin Petersoncca27322015-01-23 16:35:37 -0500431#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100432#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +0100433 PyObject *set_sni_cb;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100434#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +0100435 int check_hostname;
Christian Heimes61d478c2018-01-27 15:51:38 +0100436 /* OpenSSL has no API to get hostflags from X509_VERIFY_PARAM* struct.
437 * We have to maintain our own copy. OpenSSL's hostflags default to 0.
438 */
439 unsigned int hostflags;
Christian Heimes11a14932018-02-24 02:35:08 +0100440 int protocol;
Christian Heimes9fb051f2018-09-23 08:32:31 +0200441#ifdef TLS1_3_VERSION
442 int post_handshake_auth;
443#endif
Christian Heimesc7f70692019-05-31 11:44:05 +0200444 PyObject *msg_cb;
445#ifdef HAVE_OPENSSL_KEYLOG
446 PyObject *keylog_filename;
447 BIO *keylog_bio;
448#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +0000449} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000450
Antoine Pitrou152efa22010-05-16 18:19:27 +0000451typedef struct {
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700452 int ssl; /* last seen error from SSL */
453 int c; /* last seen error from libc */
454#ifdef MS_WINDOWS
455 int ws; /* last seen error from winsock */
456#endif
457} _PySSLError;
458
459typedef struct {
Antoine Pitrou152efa22010-05-16 18:19:27 +0000460 PyObject_HEAD
461 PyObject *Socket; /* weakref to socket on which we're layered */
462 SSL *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100463 PySSLContext *ctx; /* weakref to SSL context */
Antoine Pitrou20b85552013-09-29 19:50:53 +0200464 char shutdown_seen_zero;
Antoine Pitroud6494802011-07-21 01:11:30 +0200465 enum py_ssl_server_or_client socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200466 PyObject *owner; /* Python level "owner" passed to servername callback */
467 PyObject *server_hostname;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700468 _PySSLError err; /* last seen error from various sources */
Christian Heimesc7f70692019-05-31 11:44:05 +0200469 /* Some SSL callbacks don't have error reporting. Callback wrappers
470 * store exception information on the socket. The handshake, read, write,
471 * and shutdown methods check for chained exceptions.
472 */
473 PyObject *exc_type;
474 PyObject *exc_value;
475 PyObject *exc_tb;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000476} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000477
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200478typedef struct {
479 PyObject_HEAD
480 BIO *bio;
481 int eof_written;
482} PySSLMemoryBIO;
483
Christian Heimes99a65702016-09-10 23:44:53 +0200484typedef struct {
485 PyObject_HEAD
486 SSL_SESSION *session;
487 PySSLContext *ctx;
488} PySSLSession;
489
Antoine Pitrou152efa22010-05-16 18:19:27 +0000490static PyTypeObject PySSLContext_Type;
491static PyTypeObject PySSLSocket_Type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200492static PyTypeObject PySSLMemoryBIO_Type;
Christian Heimes99a65702016-09-10 23:44:53 +0200493static PyTypeObject PySSLSession_Type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000494
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700495static inline _PySSLError _PySSL_errno(int failed, const SSL *ssl, int retcode)
496{
497 _PySSLError err = { 0 };
498 if (failed) {
Steve Dowere6eb48c2017-09-08 15:16:15 -0700499#ifdef MS_WINDOWS
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700500 err.ws = WSAGetLastError();
501 _PySSL_FIX_ERRNO;
Steve Dowere6eb48c2017-09-08 15:16:15 -0700502#endif
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700503 err.c = errno;
504 err.ssl = SSL_get_error(ssl, retcode);
505 }
506 return err;
507}
Steve Dowere6eb48c2017-09-08 15:16:15 -0700508
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300509/*[clinic input]
510module _ssl
511class _ssl._SSLContext "PySSLContext *" "&PySSLContext_Type"
512class _ssl._SSLSocket "PySSLSocket *" "&PySSLSocket_Type"
513class _ssl.MemoryBIO "PySSLMemoryBIO *" "&PySSLMemoryBIO_Type"
Christian Heimes99a65702016-09-10 23:44:53 +0200514class _ssl.SSLSession "PySSLSession *" "&PySSLSession_Type"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300515[clinic start generated code]*/
Christian Heimes99a65702016-09-10 23:44:53 +0200516/*[clinic end generated code: output=da39a3ee5e6b4b0d input=bdc67fafeeaa8109]*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300517
518#include "clinic/_ssl.c.h"
519
Victor Stinner14690702015-04-06 22:46:13 +0200520static int PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000521
Christian Heimes141c5e82018-02-24 21:10:57 +0100522static int PySSL_set_owner(PySSLSocket *, PyObject *, void *);
523static int PySSL_set_session(PySSLSocket *, PyObject *, void *);
Dong-hee Na1b55b652020-02-17 19:09:15 +0900524#define PySSLSocket_Check(v) Py_IS_TYPE(v, &PySSLSocket_Type)
525#define PySSLMemoryBIO_Check(v) Py_IS_TYPE(v, &PySSLMemoryBIO_Type)
526#define PySSLSession_Check(v) Py_IS_TYPE(v, &PySSLSession_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000527
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000528typedef enum {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000529 SOCKET_IS_NONBLOCKING,
530 SOCKET_IS_BLOCKING,
531 SOCKET_HAS_TIMED_OUT,
532 SOCKET_HAS_BEEN_CLOSED,
533 SOCKET_TOO_LARGE_FOR_SELECT,
534 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000535} timeout_state;
536
Thomas Woutersed03b412007-08-28 21:37:11 +0000537/* Wrap error strings with filename and line # */
Thomas Woutersed03b412007-08-28 21:37:11 +0000538#define ERRSTR1(x,y,z) (x ":" y ": " z)
Victor Stinner45e8e2f2014-05-14 17:24:35 +0200539#define ERRSTR(x) ERRSTR1("_ssl.c", Py_STRINGIFY(__LINE__), x)
Thomas Woutersed03b412007-08-28 21:37:11 +0000540
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200541/* Get the socket from a PySSLSocket, if it has one */
542#define GET_SOCKET(obj) ((obj)->Socket ? \
543 (PySocketSockObject *) PyWeakref_GetObject((obj)->Socket) : NULL)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200544
Victor Stinner14690702015-04-06 22:46:13 +0200545/* If sock is NULL, use a timeout of 0 second */
546#define GET_SOCKET_TIMEOUT(sock) \
547 ((sock != NULL) ? (sock)->sock_timeout : 0)
548
Christian Heimesc7f70692019-05-31 11:44:05 +0200549#include "_ssl/debughelpers.c"
550
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200551/*
552 * SSL errors.
553 */
554
555PyDoc_STRVAR(SSLError_doc,
556"An error occurred in the SSL implementation.");
557
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700558PyDoc_STRVAR(SSLCertVerificationError_doc,
559"A certificate could not be verified.");
560
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200561PyDoc_STRVAR(SSLZeroReturnError_doc,
562"SSL/TLS session closed cleanly.");
563
564PyDoc_STRVAR(SSLWantReadError_doc,
565"Non-blocking SSL socket needs to read more data\n"
566"before the requested operation can be completed.");
567
568PyDoc_STRVAR(SSLWantWriteError_doc,
569"Non-blocking SSL socket needs to write more data\n"
570"before the requested operation can be completed.");
571
572PyDoc_STRVAR(SSLSyscallError_doc,
573"System error when attempting SSL operation.");
574
575PyDoc_STRVAR(SSLEOFError_doc,
576"SSL/TLS connection terminated abruptly.");
577
578static PyObject *
579SSLError_str(PyOSErrorObject *self)
580{
581 if (self->strerror != NULL && PyUnicode_Check(self->strerror)) {
582 Py_INCREF(self->strerror);
583 return self->strerror;
584 }
585 else
586 return PyObject_Str(self->args);
587}
588
589static PyType_Slot sslerror_type_slots[] = {
590 {Py_tp_base, NULL}, /* Filled out in module init as it's not a constant */
Inada Naoki926b0cb2019-04-17 08:39:46 +0900591 {Py_tp_doc, (void*)SSLError_doc},
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200592 {Py_tp_str, SSLError_str},
593 {0, 0},
594};
595
596static PyType_Spec sslerror_type_spec = {
597 "ssl.SSLError",
598 sizeof(PyOSErrorObject),
599 0,
600 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
601 sslerror_type_slots
602};
603
604static void
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700605fill_and_set_sslerror(PySSLSocket *sslsock, PyObject *type, int ssl_errno,
606 const char *errstr, int lineno, unsigned long errcode)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200607{
608 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700609 PyObject *verify_obj = NULL, *verify_code_obj = NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200610 PyObject *init_value, *msg, *key;
611 _Py_IDENTIFIER(reason);
612 _Py_IDENTIFIER(library);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700613 _Py_IDENTIFIER(verify_message);
614 _Py_IDENTIFIER(verify_code);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200615
616 if (errcode != 0) {
617 int lib, reason;
618
619 lib = ERR_GET_LIB(errcode);
620 reason = ERR_GET_REASON(errcode);
621 key = Py_BuildValue("ii", lib, reason);
622 if (key == NULL)
623 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300624 reason_obj = PyDict_GetItemWithError(err_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200625 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300626 if (reason_obj == NULL && PyErr_Occurred()) {
627 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200628 }
629 key = PyLong_FromLong(lib);
630 if (key == NULL)
631 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300632 lib_obj = PyDict_GetItemWithError(lib_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200633 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300634 if (lib_obj == NULL && PyErr_Occurred()) {
635 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200636 }
637 if (errstr == NULL)
638 errstr = ERR_reason_error_string(errcode);
639 }
640 if (errstr == NULL)
641 errstr = "unknown error";
642
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700643 /* verify code for cert validation error */
644 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
645 const char *verify_str = NULL;
646 long verify_code;
647
648 verify_code = SSL_get_verify_result(sslsock->ssl);
649 verify_code_obj = PyLong_FromLong(verify_code);
650 if (verify_code_obj == NULL) {
651 goto fail;
652 }
653
654 switch (verify_code) {
Christian Heimes09153602017-09-08 14:47:58 -0700655#ifdef X509_V_ERR_HOSTNAME_MISMATCH
656 /* OpenSSL >= 1.0.2, LibreSSL >= 2.5.3 */
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700657 case X509_V_ERR_HOSTNAME_MISMATCH:
658 verify_obj = PyUnicode_FromFormat(
659 "Hostname mismatch, certificate is not valid for '%S'.",
660 sslsock->server_hostname
661 );
662 break;
Christian Heimes09153602017-09-08 14:47:58 -0700663#endif
664#ifdef X509_V_ERR_IP_ADDRESS_MISMATCH
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700665 case X509_V_ERR_IP_ADDRESS_MISMATCH:
666 verify_obj = PyUnicode_FromFormat(
667 "IP address mismatch, certificate is not valid for '%S'.",
668 sslsock->server_hostname
669 );
670 break;
Christian Heimes09153602017-09-08 14:47:58 -0700671#endif
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700672 default:
673 verify_str = X509_verify_cert_error_string(verify_code);
674 if (verify_str != NULL) {
675 verify_obj = PyUnicode_FromString(verify_str);
676 } else {
677 verify_obj = Py_None;
678 Py_INCREF(verify_obj);
679 }
680 break;
681 }
682 if (verify_obj == NULL) {
683 goto fail;
684 }
685 }
686
687 if (verify_obj && reason_obj && lib_obj)
688 msg = PyUnicode_FromFormat("[%S: %S] %s: %S (_ssl.c:%d)",
689 lib_obj, reason_obj, errstr, verify_obj,
690 lineno);
691 else if (reason_obj && lib_obj)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200692 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
693 lib_obj, reason_obj, errstr, lineno);
694 else if (lib_obj)
695 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
696 lib_obj, errstr, lineno);
697 else
698 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200699 if (msg == NULL)
700 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100701
Paul Monsonfb7e7502019-05-15 15:38:55 -0700702 init_value = Py_BuildValue("iN", ERR_GET_REASON(ssl_errno), msg);
Victor Stinnerba9be472013-10-31 15:00:24 +0100703 if (init_value == NULL)
704 goto fail;
705
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200706 err_value = PyObject_CallObject(type, init_value);
707 Py_DECREF(init_value);
708 if (err_value == NULL)
709 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100710
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200711 if (reason_obj == NULL)
712 reason_obj = Py_None;
713 if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))
714 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700715
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200716 if (lib_obj == NULL)
717 lib_obj = Py_None;
718 if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))
719 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700720
721 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
722 /* Only set verify code / message for SSLCertVerificationError */
723 if (_PyObject_SetAttrId(err_value, &PyId_verify_code,
724 verify_code_obj))
725 goto fail;
726 if (_PyObject_SetAttrId(err_value, &PyId_verify_message, verify_obj))
727 goto fail;
728 }
729
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200730 PyErr_SetObject(type, err_value);
731fail:
732 Py_XDECREF(err_value);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700733 Py_XDECREF(verify_code_obj);
734 Py_XDECREF(verify_obj);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200735}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000736
Christian Heimesc7f70692019-05-31 11:44:05 +0200737static int
738PySSL_ChainExceptions(PySSLSocket *sslsock) {
739 if (sslsock->exc_type == NULL)
740 return 0;
741
742 _PyErr_ChainExceptions(sslsock->exc_type, sslsock->exc_value, sslsock->exc_tb);
743 sslsock->exc_type = NULL;
744 sslsock->exc_value = NULL;
745 sslsock->exc_tb = NULL;
746 return -1;
747}
748
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000749static PyObject *
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700750PySSL_SetError(PySSLSocket *sslsock, int ret, const char *filename, int lineno)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000751{
Antoine Pitrou41032a62011-10-27 23:56:55 +0200752 PyObject *type = PySSLErrorObject;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200753 char *errstr = NULL;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700754 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000755 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200756 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000757
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000758 assert(ret <= 0);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200759 e = ERR_peek_last_error();
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000760
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700761 if (sslsock->ssl != NULL) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700762 err = sslsock->err;
Thomas Woutersed03b412007-08-28 21:37:11 +0000763
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700764 switch (err.ssl) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000765 case SSL_ERROR_ZERO_RETURN:
Antoine Pitrou41032a62011-10-27 23:56:55 +0200766 errstr = "TLS/SSL connection has been closed (EOF)";
767 type = PySSLZeroReturnErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000768 p = PY_SSL_ERROR_ZERO_RETURN;
769 break;
770 case SSL_ERROR_WANT_READ:
771 errstr = "The operation did not complete (read)";
Antoine Pitrou41032a62011-10-27 23:56:55 +0200772 type = PySSLWantReadErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000773 p = PY_SSL_ERROR_WANT_READ;
774 break;
775 case SSL_ERROR_WANT_WRITE:
776 p = PY_SSL_ERROR_WANT_WRITE;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200777 type = PySSLWantWriteErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000778 errstr = "The operation did not complete (write)";
779 break;
780 case SSL_ERROR_WANT_X509_LOOKUP:
781 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000782 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000783 break;
784 case SSL_ERROR_WANT_CONNECT:
785 p = PY_SSL_ERROR_WANT_CONNECT;
786 errstr = "The operation did not complete (connect)";
787 break;
788 case SSL_ERROR_SYSCALL:
789 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000790 if (e == 0) {
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700791 PySocketSockObject *s = GET_SOCKET(sslsock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000792 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000793 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200794 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000795 errstr = "EOF occurred in violation of protocol";
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200796 } else if (s && ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000797 /* underlying BIO reported an I/O error */
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000798 ERR_clear_error();
Steve Dowere6eb48c2017-09-08 15:16:15 -0700799#ifdef MS_WINDOWS
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700800 if (err.ws) {
801 return PyErr_SetFromWindowsErr(err.ws);
802 }
Steve Dowere6eb48c2017-09-08 15:16:15 -0700803#endif
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700804 if (err.c) {
805 errno = err.c;
Steve Dowere6eb48c2017-09-08 15:16:15 -0700806 return PyErr_SetFromErrno(PyExc_OSError);
807 }
808 Py_INCREF(s);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200809 s->errorhandler();
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000810 Py_DECREF(s);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200811 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000812 } else { /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000813 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200814 type = PySSLSyscallErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000815 errstr = "Some I/O error occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000816 }
817 } else {
818 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000819 }
820 break;
821 }
822 case SSL_ERROR_SSL:
823 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000824 p = PY_SSL_ERROR_SSL;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700825 if (e == 0) {
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200826 /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000827 errstr = "A failure in the SSL library occurred";
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700828 }
829 if (ERR_GET_LIB(e) == ERR_LIB_SSL &&
830 ERR_GET_REASON(e) == SSL_R_CERTIFICATE_VERIFY_FAILED) {
831 type = PySSLCertVerificationErrorObject;
832 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000833 break;
834 }
835 default:
836 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
837 errstr = "Invalid error code";
838 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000839 }
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700840 fill_and_set_sslerror(sslsock, type, p, errstr, lineno, e);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000841 ERR_clear_error();
Christian Heimesc7f70692019-05-31 11:44:05 +0200842 PySSL_ChainExceptions(sslsock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000843 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000844}
845
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000846static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200847_setSSLError (const char *errstr, int errcode, const char *filename, int lineno) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000848
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200849 if (errstr == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000850 errcode = ERR_peek_last_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200851 else
852 errcode = 0;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700853 fill_and_set_sslerror(NULL, PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000854 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000855 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000856}
857
Christian Heimes61d478c2018-01-27 15:51:38 +0100858/*
859 * SSL objects
860 */
861
862static int
863_ssl_configure_hostname(PySSLSocket *self, const char* server_hostname)
864{
865 int retval = -1;
866 ASN1_OCTET_STRING *ip;
867 PyObject *hostname;
868 size_t len;
869
870 assert(server_hostname);
871
872 /* Disable OpenSSL's special mode with leading dot in hostname:
873 * When name starts with a dot (e.g ".example.com"), it will be
874 * matched by a certificate valid for any sub-domain of name.
875 */
876 len = strlen(server_hostname);
877 if (len == 0 || *server_hostname == '.') {
878 PyErr_SetString(
879 PyExc_ValueError,
880 "server_hostname cannot be an empty string or start with a "
881 "leading dot.");
882 return retval;
883 }
884
885 /* inet_pton is not available on all platforms. */
886 ip = a2i_IPADDRESS(server_hostname);
887 if (ip == NULL) {
888 ERR_clear_error();
889 }
890
Christian Heimes11a14932018-02-24 02:35:08 +0100891 hostname = PyUnicode_Decode(server_hostname, len, "ascii", "strict");
Christian Heimes61d478c2018-01-27 15:51:38 +0100892 if (hostname == NULL) {
893 goto error;
894 }
895 self->server_hostname = hostname;
896
897 /* Only send SNI extension for non-IP hostnames */
898 if (ip == NULL) {
899 if (!SSL_set_tlsext_host_name(self->ssl, server_hostname)) {
900 _setSSLError(NULL, 0, __FILE__, __LINE__);
901 }
902 }
903 if (self->ctx->check_hostname) {
904 X509_VERIFY_PARAM *param = SSL_get0_param(self->ssl);
905 if (ip == NULL) {
Christian Heimesd02ac252018-03-25 12:36:13 +0200906 if (!X509_VERIFY_PARAM_set1_host(param, server_hostname,
907 strlen(server_hostname))) {
Christian Heimes61d478c2018-01-27 15:51:38 +0100908 _setSSLError(NULL, 0, __FILE__, __LINE__);
909 goto error;
910 }
911 } else {
Christian Heimesa871f692020-06-01 08:58:14 +0200912 if (!X509_VERIFY_PARAM_set1_ip(param, ASN1_STRING_get0_data(ip),
Christian Heimes61d478c2018-01-27 15:51:38 +0100913 ASN1_STRING_length(ip))) {
914 _setSSLError(NULL, 0, __FILE__, __LINE__);
915 goto error;
916 }
917 }
918 }
919 retval = 0;
920 error:
921 if (ip != NULL) {
922 ASN1_OCTET_STRING_free(ip);
923 }
924 return retval;
925}
926
Antoine Pitrou152efa22010-05-16 18:19:27 +0000927static PySSLSocket *
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100928newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
Antoine Pitroud5323212010-10-22 18:19:07 +0000929 enum py_ssl_server_or_client socket_type,
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200930 char *server_hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +0100931 PyObject *owner, PyObject *session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200932 PySSLMemoryBIO *inbio, PySSLMemoryBIO *outbio)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000933{
Antoine Pitrou152efa22010-05-16 18:19:27 +0000934 PySSLSocket *self;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100935 SSL_CTX *ctx = sslctx->ctx;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700936 _PySSLError err = { 0 };
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000937
Antoine Pitrou152efa22010-05-16 18:19:27 +0000938 self = PyObject_New(PySSLSocket, &PySSLSocket_Type);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000939 if (self == NULL)
940 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000941
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000942 self->ssl = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000943 self->Socket = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100944 self->ctx = sslctx;
Nathaniel J. Smith65ece7c2017-06-07 23:30:43 -0700945 Py_INCREF(sslctx);
Antoine Pitrou860aee72013-09-29 19:52:45 +0200946 self->shutdown_seen_zero = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200947 self->owner = NULL;
Benjamin Peterson81b9ecd2016-08-15 21:55:37 -0700948 self->server_hostname = NULL;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700949 self->err = err;
Christian Heimesc7f70692019-05-31 11:44:05 +0200950 self->exc_type = NULL;
951 self->exc_value = NULL;
952 self->exc_tb = NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200953
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000954 /* Make sure the SSL error state is initialized */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000955 ERR_clear_error();
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000956
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000957 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitrou152efa22010-05-16 18:19:27 +0000958 self->ssl = SSL_new(ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000959 PySSL_END_ALLOW_THREADS
Zackery Spytz4c49da02018-12-07 03:11:30 -0700960 if (self->ssl == NULL) {
961 Py_DECREF(self);
962 _setSSLError(NULL, 0, __FILE__, __LINE__);
963 return NULL;
964 }
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200965 SSL_set_app_data(self->ssl, self);
966 if (sock) {
967 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
968 } else {
969 /* BIOs are reference counted and SSL_set_bio borrows our reference.
970 * To prevent a double free in memory_bio_dealloc() we need to take an
971 * extra reference here. */
Christian Heimes598894f2016-09-05 23:19:05 +0200972 BIO_up_ref(inbio->bio);
973 BIO_up_ref(outbio->bio);
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200974 SSL_set_bio(self->ssl, inbio->bio, outbio->bio);
975 }
Alex Gaynorf0422422018-05-14 11:51:45 -0400976 SSL_set_mode(self->ssl,
977 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000978
Christian Heimesf0f59302019-07-01 08:29:17 +0200979#ifdef TLS1_3_VERSION
980 if (sslctx->post_handshake_auth == 1) {
981 if (socket_type == PY_SSL_SERVER) {
982 /* bpo-37428: OpenSSL does not ignore SSL_VERIFY_POST_HANDSHAKE.
983 * Set SSL_VERIFY_POST_HANDSHAKE flag only for server sockets and
984 * only in combination with SSL_VERIFY_PEER flag. */
985 int mode = SSL_get_verify_mode(self->ssl);
986 if (mode & SSL_VERIFY_PEER) {
987 int (*verify_cb)(int, X509_STORE_CTX *) = NULL;
988 verify_cb = SSL_get_verify_callback(self->ssl);
989 mode |= SSL_VERIFY_POST_HANDSHAKE;
990 SSL_set_verify(self->ssl, mode, verify_cb);
991 }
992 } else {
993 /* client socket */
994 SSL_set_post_handshake_auth(self->ssl, 1);
995 }
996 }
997#endif
998
Christian Heimes61d478c2018-01-27 15:51:38 +0100999 if (server_hostname != NULL) {
1000 if (_ssl_configure_hostname(self, server_hostname) < 0) {
1001 Py_DECREF(self);
1002 return NULL;
1003 }
1004 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001005 /* If the socket is in non-blocking mode or timeout mode, set the BIO
1006 * to non-blocking mode (blocking is the default)
1007 */
Victor Stinnere2452312015-03-28 03:00:46 +01001008 if (sock && sock->sock_timeout >= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001009 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
1010 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
1011 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +00001012
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001013 PySSL_BEGIN_ALLOW_THREADS
1014 if (socket_type == PY_SSL_CLIENT)
1015 SSL_set_connect_state(self->ssl);
1016 else
1017 SSL_set_accept_state(self->ssl);
1018 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +00001019
Antoine Pitroud6494802011-07-21 01:11:30 +02001020 self->socket_type = socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001021 if (sock != NULL) {
1022 self->Socket = PyWeakref_NewRef((PyObject *) sock, NULL);
1023 if (self->Socket == NULL) {
1024 Py_DECREF(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001025 return NULL;
1026 }
Victor Stinnera9eb38f2013-10-31 16:35:38 +01001027 }
Christian Heimes141c5e82018-02-24 21:10:57 +01001028 if (owner && owner != Py_None) {
1029 if (PySSL_set_owner(self, owner, NULL) == -1) {
1030 Py_DECREF(self);
1031 return NULL;
1032 }
1033 }
1034 if (session && session != Py_None) {
1035 if (PySSL_set_session(self, session, NULL) == -1) {
1036 Py_DECREF(self);
1037 return NULL;
1038 }
1039 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001040 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001041}
1042
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001043/* SSL object methods */
1044
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001045/*[clinic input]
1046_ssl._SSLSocket.do_handshake
1047[clinic start generated code]*/
1048
1049static PyObject *
1050_ssl__SSLSocket_do_handshake_impl(PySSLSocket *self)
1051/*[clinic end generated code: output=6c0898a8936548f6 input=d2d737de3df018c8]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001052{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001053 int ret;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001054 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001055 int sockstate, nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001056 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02001057 _PyTime_t timeout, deadline = 0;
1058 int has_timeout;
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001059
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001060 if (sock) {
1061 if (((PyObject*)sock) == Py_None) {
1062 _setSSLError("Underlying socket connection gone",
1063 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1064 return NULL;
1065 }
1066 Py_INCREF(sock);
1067
1068 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01001069 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001070 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1071 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001072 }
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001073
Victor Stinner14690702015-04-06 22:46:13 +02001074 timeout = GET_SOCKET_TIMEOUT(sock);
1075 has_timeout = (timeout > 0);
1076 if (has_timeout)
1077 deadline = _PyTime_GetMonotonicClock() + timeout;
1078
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001079 /* Actually negotiate SSL connection */
1080 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001081 do {
Bill Janssen6e027db2007-11-15 22:23:56 +00001082 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001083 ret = SSL_do_handshake(self->ssl);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001084 err = _PySSL_errno(ret < 1, self->ssl, ret);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001085 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001086 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001087
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001088 if (PyErr_CheckSignals())
1089 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001090
Victor Stinner14690702015-04-06 22:46:13 +02001091 if (has_timeout)
1092 timeout = deadline - _PyTime_GetMonotonicClock();
1093
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001094 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02001095 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001096 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02001097 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001098 } else {
1099 sockstate = SOCKET_OPERATION_OK;
1100 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001101
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001102 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001103 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001104 ERRSTR("The handshake operation timed out"));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001105 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001106 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1107 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001108 ERRSTR("Underlying socket has been closed."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001109 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001110 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1111 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001112 ERRSTR("Underlying socket too large for select()."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001113 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001114 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1115 break;
1116 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001117 } while (err.ssl == SSL_ERROR_WANT_READ ||
1118 err.ssl == SSL_ERROR_WANT_WRITE);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001119 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001120 if (ret < 1)
1121 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Christian Heimesc7f70692019-05-31 11:44:05 +02001122 if (PySSL_ChainExceptions(self) < 0)
1123 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001124 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001125error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001126 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02001127 PySSL_ChainExceptions(self);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001128 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001129}
1130
Thomas Woutersed03b412007-08-28 21:37:11 +00001131static PyObject *
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001132_asn1obj2py(const ASN1_OBJECT *name, int no_name)
1133{
1134 char buf[X509_NAME_MAXLEN];
1135 char *namebuf = buf;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001136 int buflen;
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001137 PyObject *name_obj = NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001138
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001139 buflen = OBJ_obj2txt(namebuf, X509_NAME_MAXLEN, name, no_name);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001140 if (buflen < 0) {
1141 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001142 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001143 }
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001144 /* initial buffer is too small for oid + terminating null byte */
1145 if (buflen > X509_NAME_MAXLEN - 1) {
1146 /* make OBJ_obj2txt() calculate the required buflen */
1147 buflen = OBJ_obj2txt(NULL, 0, name, no_name);
1148 /* allocate len + 1 for terminating NULL byte */
1149 namebuf = PyMem_Malloc(buflen + 1);
1150 if (namebuf == NULL) {
1151 PyErr_NoMemory();
1152 return NULL;
1153 }
1154 buflen = OBJ_obj2txt(namebuf, buflen + 1, name, no_name);
1155 if (buflen < 0) {
1156 _setSSLError(NULL, 0, __FILE__, __LINE__);
1157 goto done;
1158 }
1159 }
1160 if (!buflen && no_name) {
1161 Py_INCREF(Py_None);
1162 name_obj = Py_None;
1163 }
1164 else {
1165 name_obj = PyUnicode_FromStringAndSize(namebuf, buflen);
1166 }
1167
1168 done:
1169 if (buf != namebuf) {
1170 PyMem_Free(namebuf);
1171 }
1172 return name_obj;
1173}
1174
1175static PyObject *
1176_create_tuple_for_attribute(ASN1_OBJECT *name, ASN1_STRING *value)
1177{
1178 Py_ssize_t buflen;
1179 unsigned char *valuebuf = NULL;
1180 PyObject *attr;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001181
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001182 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
1183 if (buflen < 0) {
1184 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001185 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001186 }
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001187 attr = Py_BuildValue("Ns#", _asn1obj2py(name, 0), valuebuf, buflen);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001188 OPENSSL_free(valuebuf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001189 return attr;
Thomas Woutersed03b412007-08-28 21:37:11 +00001190}
1191
1192static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001193_create_tuple_for_X509_NAME (X509_NAME *xname)
Thomas Woutersed03b412007-08-28 21:37:11 +00001194{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001195 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
1196 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
1197 PyObject *rdnt;
1198 PyObject *attr = NULL; /* tuple to hold an attribute */
1199 int entry_count = X509_NAME_entry_count(xname);
1200 X509_NAME_ENTRY *entry;
1201 ASN1_OBJECT *name;
1202 ASN1_STRING *value;
1203 int index_counter;
1204 int rdn_level = -1;
1205 int retcode;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001206
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001207 dn = PyList_New(0);
1208 if (dn == NULL)
1209 return NULL;
1210 /* now create another tuple to hold the top-level RDN */
1211 rdn = PyList_New(0);
1212 if (rdn == NULL)
1213 goto fail0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001214
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001215 for (index_counter = 0;
1216 index_counter < entry_count;
1217 index_counter++)
1218 {
1219 entry = X509_NAME_get_entry(xname, index_counter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001220
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001221 /* check to see if we've gotten to a new RDN */
1222 if (rdn_level >= 0) {
Christian Heimes598894f2016-09-05 23:19:05 +02001223 if (rdn_level != X509_NAME_ENTRY_set(entry)) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001224 /* yes, new RDN */
1225 /* add old RDN to DN */
1226 rdnt = PyList_AsTuple(rdn);
1227 Py_DECREF(rdn);
1228 if (rdnt == NULL)
1229 goto fail0;
1230 retcode = PyList_Append(dn, rdnt);
1231 Py_DECREF(rdnt);
1232 if (retcode < 0)
1233 goto fail0;
1234 /* create new RDN */
1235 rdn = PyList_New(0);
1236 if (rdn == NULL)
1237 goto fail0;
1238 }
1239 }
Christian Heimes598894f2016-09-05 23:19:05 +02001240 rdn_level = X509_NAME_ENTRY_set(entry);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001241
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001242 /* now add this attribute to the current RDN */
1243 name = X509_NAME_ENTRY_get_object(entry);
1244 value = X509_NAME_ENTRY_get_data(entry);
1245 attr = _create_tuple_for_attribute(name, value);
1246 /*
1247 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
1248 entry->set,
1249 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
1250 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
1251 */
1252 if (attr == NULL)
1253 goto fail1;
1254 retcode = PyList_Append(rdn, attr);
1255 Py_DECREF(attr);
1256 if (retcode < 0)
1257 goto fail1;
1258 }
1259 /* now, there's typically a dangling RDN */
Antoine Pitrou2f5a1632012-02-15 22:25:27 +01001260 if (rdn != NULL) {
1261 if (PyList_GET_SIZE(rdn) > 0) {
1262 rdnt = PyList_AsTuple(rdn);
1263 Py_DECREF(rdn);
1264 if (rdnt == NULL)
1265 goto fail0;
1266 retcode = PyList_Append(dn, rdnt);
1267 Py_DECREF(rdnt);
1268 if (retcode < 0)
1269 goto fail0;
1270 }
1271 else {
1272 Py_DECREF(rdn);
1273 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001274 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001275
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001276 /* convert list to tuple */
1277 rdnt = PyList_AsTuple(dn);
1278 Py_DECREF(dn);
1279 if (rdnt == NULL)
1280 return NULL;
1281 return rdnt;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001282
1283 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001284 Py_XDECREF(rdn);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001285
1286 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001287 Py_XDECREF(dn);
1288 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001289}
1290
1291static PyObject *
1292_get_peer_alt_names (X509 *certificate) {
Guido van Rossumf06628b2007-11-21 20:01:53 +00001293
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001294 /* this code follows the procedure outlined in
1295 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
1296 function to extract the STACK_OF(GENERAL_NAME),
1297 then iterates through the stack to add the
1298 names. */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001299
Alex Gaynorb87c0df2017-06-06 07:53:11 -04001300 int j;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001301 PyObject *peer_alt_names = Py_None;
Christian Heimes60bf2fc2013-09-05 16:04:35 +02001302 PyObject *v = NULL, *t;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001303 GENERAL_NAMES *names = NULL;
1304 GENERAL_NAME *name;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001305 BIO *biobuf = NULL;
1306 char buf[2048];
1307 char *vptr;
1308 int len;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001309
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001310 if (certificate == NULL)
1311 return peer_alt_names;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001312
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001313 /* get a memory buffer */
1314 biobuf = BIO_new(BIO_s_mem());
Zackery Spytz4c49da02018-12-07 03:11:30 -07001315 if (biobuf == NULL) {
1316 PyErr_SetString(PySSLErrorObject, "failed to allocate BIO");
1317 return NULL;
1318 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001319
Alex Gaynorb87c0df2017-06-06 07:53:11 -04001320 names = (GENERAL_NAMES *)X509_get_ext_d2i(
1321 certificate, NID_subject_alt_name, NULL, NULL);
1322 if (names != NULL) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001323 if (peer_alt_names == Py_None) {
1324 peer_alt_names = PyList_New(0);
1325 if (peer_alt_names == NULL)
1326 goto fail;
1327 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001328
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001329 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001330 /* get a rendering of each name in the set of names */
Christian Heimes824f7f32013-08-17 00:54:47 +02001331 int gntype;
1332 ASN1_STRING *as = NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001333
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001334 name = sk_GENERAL_NAME_value(names, j);
Christian Heimes474afdd2013-08-17 17:18:56 +02001335 gntype = name->type;
Christian Heimes824f7f32013-08-17 00:54:47 +02001336 switch (gntype) {
1337 case GEN_DIRNAME:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001338 /* we special-case DirName as a tuple of
1339 tuples of attributes */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001340
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001341 t = PyTuple_New(2);
1342 if (t == NULL) {
1343 goto fail;
1344 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001345
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001346 v = PyUnicode_FromString("DirName");
1347 if (v == NULL) {
1348 Py_DECREF(t);
1349 goto fail;
1350 }
1351 PyTuple_SET_ITEM(t, 0, v);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001352
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001353 v = _create_tuple_for_X509_NAME (name->d.dirn);
1354 if (v == NULL) {
1355 Py_DECREF(t);
1356 goto fail;
1357 }
1358 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +02001359 break;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001360
Christian Heimes824f7f32013-08-17 00:54:47 +02001361 case GEN_EMAIL:
1362 case GEN_DNS:
1363 case GEN_URI:
1364 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
1365 correctly, CVE-2013-4238 */
1366 t = PyTuple_New(2);
1367 if (t == NULL)
1368 goto fail;
1369 switch (gntype) {
1370 case GEN_EMAIL:
1371 v = PyUnicode_FromString("email");
1372 as = name->d.rfc822Name;
1373 break;
1374 case GEN_DNS:
1375 v = PyUnicode_FromString("DNS");
1376 as = name->d.dNSName;
1377 break;
1378 case GEN_URI:
1379 v = PyUnicode_FromString("URI");
1380 as = name->d.uniformResourceIdentifier;
1381 break;
1382 }
1383 if (v == NULL) {
1384 Py_DECREF(t);
1385 goto fail;
1386 }
1387 PyTuple_SET_ITEM(t, 0, v);
Christian Heimesa871f692020-06-01 08:58:14 +02001388 v = PyUnicode_FromStringAndSize((char *)ASN1_STRING_get0_data(as),
Christian Heimes824f7f32013-08-17 00:54:47 +02001389 ASN1_STRING_length(as));
1390 if (v == NULL) {
1391 Py_DECREF(t);
1392 goto fail;
1393 }
1394 PyTuple_SET_ITEM(t, 1, v);
1395 break;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001396
Christian Heimes1c03abd2016-09-06 23:25:35 +02001397 case GEN_RID:
1398 t = PyTuple_New(2);
1399 if (t == NULL)
1400 goto fail;
1401
1402 v = PyUnicode_FromString("Registered ID");
1403 if (v == NULL) {
1404 Py_DECREF(t);
1405 goto fail;
1406 }
1407 PyTuple_SET_ITEM(t, 0, v);
1408
1409 len = i2t_ASN1_OBJECT(buf, sizeof(buf)-1, name->d.rid);
1410 if (len < 0) {
1411 Py_DECREF(t);
1412 _setSSLError(NULL, 0, __FILE__, __LINE__);
1413 goto fail;
1414 } else if (len >= (int)sizeof(buf)) {
1415 v = PyUnicode_FromString("<INVALID>");
1416 } else {
1417 v = PyUnicode_FromStringAndSize(buf, len);
1418 }
1419 if (v == NULL) {
1420 Py_DECREF(t);
1421 goto fail;
1422 }
1423 PyTuple_SET_ITEM(t, 1, v);
1424 break;
1425
Christian Heimes2b7de662019-12-07 17:59:36 +01001426 case GEN_IPADD:
1427 /* OpenSSL < 3.0.0 adds a trailing \n to IPv6. 3.0.0 removed
1428 * the trailing newline. Remove it in all versions
1429 */
1430 t = PyTuple_New(2);
1431 if (t == NULL)
1432 goto fail;
1433
1434 v = PyUnicode_FromString("IP Address");
1435 if (v == NULL) {
1436 Py_DECREF(t);
1437 goto fail;
1438 }
1439 PyTuple_SET_ITEM(t, 0, v);
1440
1441 if (name->d.ip->length == 4) {
1442 unsigned char *p = name->d.ip->data;
1443 v = PyUnicode_FromFormat(
1444 "%d.%d.%d.%d",
1445 p[0], p[1], p[2], p[3]
1446 );
1447 } else if (name->d.ip->length == 16) {
1448 /* PyUnicode_FromFormat() does not support %X */
1449 unsigned char *p = name->d.ip->data;
1450 len = sprintf(
1451 buf,
1452 "%X:%X:%X:%X:%X:%X:%X:%X",
1453 p[0] << 8 | p[1],
1454 p[2] << 8 | p[3],
1455 p[4] << 8 | p[5],
1456 p[6] << 8 | p[7],
1457 p[8] << 8 | p[9],
1458 p[10] << 8 | p[11],
1459 p[12] << 8 | p[13],
1460 p[14] << 8 | p[15]
1461 );
1462 v = PyUnicode_FromStringAndSize(buf, len);
1463 } else {
1464 v = PyUnicode_FromString("<invalid>");
1465 }
1466
1467 if (v == NULL) {
1468 Py_DECREF(t);
1469 goto fail;
1470 }
1471 PyTuple_SET_ITEM(t, 1, v);
1472 break;
1473
Christian Heimes824f7f32013-08-17 00:54:47 +02001474 default:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001475 /* for everything else, we use the OpenSSL print form */
Christian Heimes824f7f32013-08-17 00:54:47 +02001476 switch (gntype) {
1477 /* check for new general name type */
1478 case GEN_OTHERNAME:
1479 case GEN_X400:
1480 case GEN_EDIPARTY:
Christian Heimes824f7f32013-08-17 00:54:47 +02001481 case GEN_RID:
1482 break;
1483 default:
1484 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
1485 "Unknown general name type %d",
1486 gntype) == -1) {
1487 goto fail;
1488 }
1489 break;
1490 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001491 (void) BIO_reset(biobuf);
1492 GENERAL_NAME_print(biobuf, name);
1493 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1494 if (len < 0) {
1495 _setSSLError(NULL, 0, __FILE__, __LINE__);
1496 goto fail;
1497 }
1498 vptr = strchr(buf, ':');
Christian Heimes1c03abd2016-09-06 23:25:35 +02001499 if (vptr == NULL) {
1500 PyErr_Format(PyExc_ValueError,
1501 "Invalid value %.200s",
1502 buf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001503 goto fail;
Christian Heimes1c03abd2016-09-06 23:25:35 +02001504 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001505 t = PyTuple_New(2);
1506 if (t == NULL)
1507 goto fail;
1508 v = PyUnicode_FromStringAndSize(buf, (vptr - buf));
1509 if (v == NULL) {
1510 Py_DECREF(t);
1511 goto fail;
1512 }
1513 PyTuple_SET_ITEM(t, 0, v);
1514 v = PyUnicode_FromStringAndSize((vptr + 1),
1515 (len - (vptr - buf + 1)));
1516 if (v == NULL) {
1517 Py_DECREF(t);
1518 goto fail;
1519 }
1520 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +02001521 break;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001522 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001523
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001524 /* and add that rendering to the list */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001525
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001526 if (PyList_Append(peer_alt_names, t) < 0) {
1527 Py_DECREF(t);
1528 goto fail;
1529 }
1530 Py_DECREF(t);
1531 }
Antoine Pitrou116d6b92011-11-23 01:39:19 +01001532 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001533 }
1534 BIO_free(biobuf);
1535 if (peer_alt_names != Py_None) {
1536 v = PyList_AsTuple(peer_alt_names);
1537 Py_DECREF(peer_alt_names);
1538 return v;
1539 } else {
1540 return peer_alt_names;
1541 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001542
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001543
1544 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001545 if (biobuf != NULL)
1546 BIO_free(biobuf);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001547
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001548 if (peer_alt_names != Py_None) {
1549 Py_XDECREF(peer_alt_names);
1550 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001551
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001552 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001553}
1554
1555static PyObject *
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001556_get_aia_uri(X509 *certificate, int nid) {
1557 PyObject *lst = NULL, *ostr = NULL;
1558 int i, result;
1559 AUTHORITY_INFO_ACCESS *info;
1560
1561 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
Benjamin Petersonf0c90382015-11-14 15:12:18 -08001562 if (info == NULL)
1563 return Py_None;
1564 if (sk_ACCESS_DESCRIPTION_num(info) == 0) {
1565 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001566 return Py_None;
1567 }
1568
1569 if ((lst = PyList_New(0)) == NULL) {
1570 goto fail;
1571 }
1572
1573 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
1574 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
1575 ASN1_IA5STRING *uri;
1576
1577 if ((OBJ_obj2nid(ad->method) != nid) ||
1578 (ad->location->type != GEN_URI)) {
1579 continue;
1580 }
1581 uri = ad->location->d.uniformResourceIdentifier;
1582 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
1583 uri->length);
1584 if (ostr == NULL) {
1585 goto fail;
1586 }
1587 result = PyList_Append(lst, ostr);
1588 Py_DECREF(ostr);
1589 if (result < 0) {
1590 goto fail;
1591 }
1592 }
1593 AUTHORITY_INFO_ACCESS_free(info);
1594
1595 /* convert to tuple or None */
1596 if (PyList_Size(lst) == 0) {
1597 Py_DECREF(lst);
1598 return Py_None;
1599 } else {
1600 PyObject *tup;
1601 tup = PyList_AsTuple(lst);
1602 Py_DECREF(lst);
1603 return tup;
1604 }
1605
1606 fail:
1607 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimes18fc7be2013-11-21 23:57:49 +01001608 Py_XDECREF(lst);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001609 return NULL;
1610}
1611
1612static PyObject *
1613_get_crl_dp(X509 *certificate) {
1614 STACK_OF(DIST_POINT) *dps;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001615 int i, j;
1616 PyObject *lst, *res = NULL;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001617
Christian Heimes598894f2016-09-05 23:19:05 +02001618 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points, NULL, NULL);
Christian Heimes949ec142013-11-21 16:26:51 +01001619
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001620 if (dps == NULL)
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001621 return Py_None;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001622
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001623 lst = PyList_New(0);
1624 if (lst == NULL)
1625 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001626
1627 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1628 DIST_POINT *dp;
1629 STACK_OF(GENERAL_NAME) *gns;
1630
1631 dp = sk_DIST_POINT_value(dps, i);
Christian Heimesa37f5242019-01-15 23:47:42 +01001632 if (dp->distpoint == NULL) {
1633 /* Ignore empty DP value, CVE-2019-5010 */
1634 continue;
1635 }
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001636 gns = dp->distpoint->name.fullname;
1637
1638 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1639 GENERAL_NAME *gn;
1640 ASN1_IA5STRING *uri;
1641 PyObject *ouri;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001642 int err;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001643
1644 gn = sk_GENERAL_NAME_value(gns, j);
1645 if (gn->type != GEN_URI) {
1646 continue;
1647 }
1648 uri = gn->d.uniformResourceIdentifier;
1649 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1650 uri->length);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001651 if (ouri == NULL)
1652 goto done;
1653
1654 err = PyList_Append(lst, ouri);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001655 Py_DECREF(ouri);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001656 if (err < 0)
1657 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001658 }
1659 }
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001660
1661 /* Convert to tuple. */
1662 res = (PyList_GET_SIZE(lst) > 0) ? PyList_AsTuple(lst) : Py_None;
1663
1664 done:
1665 Py_XDECREF(lst);
Olivier Vielpeau2849cc32017-04-14 21:06:07 -04001666 CRL_DIST_POINTS_free(dps);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001667 return res;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001668}
1669
1670static PyObject *
Antoine Pitroufb046912010-11-09 20:21:19 +00001671_decode_certificate(X509 *certificate) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001672
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001673 PyObject *retval = NULL;
1674 BIO *biobuf = NULL;
1675 PyObject *peer;
1676 PyObject *peer_alt_names = NULL;
1677 PyObject *issuer;
1678 PyObject *version;
1679 PyObject *sn_obj;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001680 PyObject *obj;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001681 ASN1_INTEGER *serialNumber;
1682 char buf[2048];
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001683 int len, result;
Christian Heimesa871f692020-06-01 08:58:14 +02001684 const ASN1_TIME *notBefore, *notAfter;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001685 PyObject *pnotBefore, *pnotAfter;
Thomas Woutersed03b412007-08-28 21:37:11 +00001686
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001687 retval = PyDict_New();
1688 if (retval == NULL)
1689 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001690
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001691 peer = _create_tuple_for_X509_NAME(
1692 X509_get_subject_name(certificate));
1693 if (peer == NULL)
1694 goto fail0;
1695 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1696 Py_DECREF(peer);
1697 goto fail0;
1698 }
1699 Py_DECREF(peer);
Thomas Woutersed03b412007-08-28 21:37:11 +00001700
Antoine Pitroufb046912010-11-09 20:21:19 +00001701 issuer = _create_tuple_for_X509_NAME(
1702 X509_get_issuer_name(certificate));
1703 if (issuer == NULL)
1704 goto fail0;
1705 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001706 Py_DECREF(issuer);
Antoine Pitroufb046912010-11-09 20:21:19 +00001707 goto fail0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001708 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001709 Py_DECREF(issuer);
1710
1711 version = PyLong_FromLong(X509_get_version(certificate) + 1);
Christian Heimes5962bef2013-07-26 15:51:18 +02001712 if (version == NULL)
1713 goto fail0;
Antoine Pitroufb046912010-11-09 20:21:19 +00001714 if (PyDict_SetItemString(retval, "version", version) < 0) {
1715 Py_DECREF(version);
1716 goto fail0;
1717 }
1718 Py_DECREF(version);
Guido van Rossumf06628b2007-11-21 20:01:53 +00001719
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001720 /* get a memory buffer */
1721 biobuf = BIO_new(BIO_s_mem());
Zackery Spytz4c49da02018-12-07 03:11:30 -07001722 if (biobuf == NULL) {
1723 PyErr_SetString(PySSLErrorObject, "failed to allocate BIO");
1724 goto fail0;
1725 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001726
Antoine Pitroufb046912010-11-09 20:21:19 +00001727 (void) BIO_reset(biobuf);
1728 serialNumber = X509_get_serialNumber(certificate);
1729 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1730 i2a_ASN1_INTEGER(biobuf, serialNumber);
1731 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1732 if (len < 0) {
1733 _setSSLError(NULL, 0, __FILE__, __LINE__);
1734 goto fail1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001735 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001736 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1737 if (sn_obj == NULL)
1738 goto fail1;
1739 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1740 Py_DECREF(sn_obj);
1741 goto fail1;
1742 }
1743 Py_DECREF(sn_obj);
1744
1745 (void) BIO_reset(biobuf);
Christian Heimesa871f692020-06-01 08:58:14 +02001746 notBefore = X509_get0_notBefore(certificate);
Antoine Pitroufb046912010-11-09 20:21:19 +00001747 ASN1_TIME_print(biobuf, notBefore);
1748 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1749 if (len < 0) {
1750 _setSSLError(NULL, 0, __FILE__, __LINE__);
1751 goto fail1;
1752 }
1753 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1754 if (pnotBefore == NULL)
1755 goto fail1;
1756 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1757 Py_DECREF(pnotBefore);
1758 goto fail1;
1759 }
1760 Py_DECREF(pnotBefore);
Thomas Woutersed03b412007-08-28 21:37:11 +00001761
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001762 (void) BIO_reset(biobuf);
Christian Heimesa871f692020-06-01 08:58:14 +02001763 notAfter = X509_get0_notAfter(certificate);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001764 ASN1_TIME_print(biobuf, notAfter);
1765 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1766 if (len < 0) {
1767 _setSSLError(NULL, 0, __FILE__, __LINE__);
1768 goto fail1;
1769 }
1770 pnotAfter = PyUnicode_FromStringAndSize(buf, len);
1771 if (pnotAfter == NULL)
1772 goto fail1;
1773 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1774 Py_DECREF(pnotAfter);
1775 goto fail1;
1776 }
1777 Py_DECREF(pnotAfter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001778
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001779 /* Now look for subjectAltName */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001780
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001781 peer_alt_names = _get_peer_alt_names(certificate);
1782 if (peer_alt_names == NULL)
1783 goto fail1;
1784 else if (peer_alt_names != Py_None) {
1785 if (PyDict_SetItemString(retval, "subjectAltName",
1786 peer_alt_names) < 0) {
1787 Py_DECREF(peer_alt_names);
1788 goto fail1;
1789 }
1790 Py_DECREF(peer_alt_names);
1791 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001792
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001793 /* Authority Information Access: OCSP URIs */
1794 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1795 if (obj == NULL) {
1796 goto fail1;
1797 } else if (obj != Py_None) {
1798 result = PyDict_SetItemString(retval, "OCSP", obj);
1799 Py_DECREF(obj);
1800 if (result < 0) {
1801 goto fail1;
1802 }
1803 }
1804
1805 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1806 if (obj == NULL) {
1807 goto fail1;
1808 } else if (obj != Py_None) {
1809 result = PyDict_SetItemString(retval, "caIssuers", obj);
1810 Py_DECREF(obj);
1811 if (result < 0) {
1812 goto fail1;
1813 }
1814 }
1815
1816 /* CDP (CRL distribution points) */
1817 obj = _get_crl_dp(certificate);
1818 if (obj == NULL) {
1819 goto fail1;
1820 } else if (obj != Py_None) {
1821 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1822 Py_DECREF(obj);
1823 if (result < 0) {
1824 goto fail1;
1825 }
1826 }
1827
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001828 BIO_free(biobuf);
1829 return retval;
Thomas Woutersed03b412007-08-28 21:37:11 +00001830
1831 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001832 if (biobuf != NULL)
1833 BIO_free(biobuf);
Thomas Woutersed03b412007-08-28 21:37:11 +00001834 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001835 Py_XDECREF(retval);
1836 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001837}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001838
Christian Heimes9a5395a2013-06-17 15:44:12 +02001839static PyObject *
1840_certificate_to_der(X509 *certificate)
1841{
1842 unsigned char *bytes_buf = NULL;
1843 int len;
1844 PyObject *retval;
1845
1846 bytes_buf = NULL;
1847 len = i2d_X509(certificate, &bytes_buf);
1848 if (len < 0) {
1849 _setSSLError(NULL, 0, __FILE__, __LINE__);
1850 return NULL;
1851 }
1852 /* this is actually an immutable bytes sequence */
1853 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1854 OPENSSL_free(bytes_buf);
1855 return retval;
1856}
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001857
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001858/*[clinic input]
1859_ssl._test_decode_cert
1860 path: object(converter="PyUnicode_FSConverter")
1861 /
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001862
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001863[clinic start generated code]*/
1864
1865static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001866_ssl__test_decode_cert_impl(PyObject *module, PyObject *path)
1867/*[clinic end generated code: output=96becb9abb23c091 input=cdeaaf02d4346628]*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001868{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001869 PyObject *retval = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001870 X509 *x=NULL;
1871 BIO *cert;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001872
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001873 if ((cert=BIO_new(BIO_s_file())) == NULL) {
1874 PyErr_SetString(PySSLErrorObject,
1875 "Can't malloc memory to read file");
1876 goto fail0;
1877 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001878
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001879 if (BIO_read_filename(cert, PyBytes_AsString(path)) <= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001880 PyErr_SetString(PySSLErrorObject,
1881 "Can't open file");
1882 goto fail0;
1883 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001884
Alex Gaynor40dad952019-08-15 08:31:28 -04001885 x = PEM_read_bio_X509(cert, NULL, NULL, NULL);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001886 if (x == NULL) {
1887 PyErr_SetString(PySSLErrorObject,
1888 "Error decoding PEM-encoded file");
1889 goto fail0;
1890 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001891
Antoine Pitroufb046912010-11-09 20:21:19 +00001892 retval = _decode_certificate(x);
Mark Dickinsonee55df52010-08-03 18:31:54 +00001893 X509_free(x);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001894
1895 fail0:
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001896 Py_DECREF(path);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001897 if (cert != NULL) BIO_free(cert);
1898 return retval;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001899}
1900
1901
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001902/*[clinic input]
Christian Heimes141c5e82018-02-24 21:10:57 +01001903_ssl._SSLSocket.getpeercert
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001904 der as binary_mode: bool = False
1905 /
1906
1907Returns the certificate for the peer.
1908
1909If no certificate was provided, returns None. If a certificate was
1910provided, but not validated, returns an empty dictionary. Otherwise
1911returns a dict containing information about the peer certificate.
1912
1913If the optional argument is True, returns a DER-encoded copy of the
1914peer certificate, or None if no certificate was provided. This will
1915return the certificate even if it wasn't validated.
1916[clinic start generated code]*/
1917
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001918static PyObject *
Christian Heimes141c5e82018-02-24 21:10:57 +01001919_ssl__SSLSocket_getpeercert_impl(PySSLSocket *self, int binary_mode)
1920/*[clinic end generated code: output=1f0ab66dfb693c88 input=c0fbe802e57629b7]*/
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001921{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001922 int verification;
Christian Heimes66dc33b2017-05-23 16:02:02 -07001923 X509 *peer_cert;
1924 PyObject *result;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001925
Christian Heimes66dc33b2017-05-23 16:02:02 -07001926 if (!SSL_is_init_finished(self->ssl)) {
Antoine Pitrou20b85552013-09-29 19:50:53 +02001927 PyErr_SetString(PyExc_ValueError,
1928 "handshake not done yet");
1929 return NULL;
1930 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07001931 peer_cert = SSL_get_peer_certificate(self->ssl);
1932 if (peer_cert == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001933 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001934
Antoine Pitrou721738f2012-08-15 23:20:39 +02001935 if (binary_mode) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001936 /* return cert in DER-encoded format */
Christian Heimes66dc33b2017-05-23 16:02:02 -07001937 result = _certificate_to_der(peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001938 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00001939 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001940 if ((verification & SSL_VERIFY_PEER) == 0)
Christian Heimes66dc33b2017-05-23 16:02:02 -07001941 result = PyDict_New();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001942 else
Christian Heimes66dc33b2017-05-23 16:02:02 -07001943 result = _decode_certificate(peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001944 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07001945 X509_free(peer_cert);
1946 return result;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001947}
1948
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001949static PyObject *
1950cipher_to_tuple(const SSL_CIPHER *cipher)
1951{
1952 const char *cipher_name, *cipher_protocol;
1953 PyObject *v, *retval = PyTuple_New(3);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001954 if (retval == NULL)
1955 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001956
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001957 cipher_name = SSL_CIPHER_get_name(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001958 if (cipher_name == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001959 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001960 PyTuple_SET_ITEM(retval, 0, Py_None);
1961 } else {
1962 v = PyUnicode_FromString(cipher_name);
1963 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001964 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001965 PyTuple_SET_ITEM(retval, 0, v);
1966 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001967
1968 cipher_protocol = SSL_CIPHER_get_version(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001969 if (cipher_protocol == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001970 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001971 PyTuple_SET_ITEM(retval, 1, Py_None);
1972 } else {
1973 v = PyUnicode_FromString(cipher_protocol);
1974 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001975 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001976 PyTuple_SET_ITEM(retval, 1, v);
1977 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001978
1979 v = PyLong_FromLong(SSL_CIPHER_get_bits(cipher, NULL));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001980 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001981 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001982 PyTuple_SET_ITEM(retval, 2, v);
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001983
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001984 return retval;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001985
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001986 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001987 Py_DECREF(retval);
1988 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001989}
1990
Christian Heimes25bfcd52016-09-06 00:04:45 +02001991#if OPENSSL_VERSION_NUMBER >= 0x10002000UL
1992static PyObject *
1993cipher_to_dict(const SSL_CIPHER *cipher)
1994{
1995 const char *cipher_name, *cipher_protocol;
1996
1997 unsigned long cipher_id;
1998 int alg_bits, strength_bits, len;
1999 char buf[512] = {0};
2000#if OPENSSL_VERSION_1_1
2001 int aead, nid;
2002 const char *skcipher = NULL, *digest = NULL, *kx = NULL, *auth = NULL;
2003#endif
Christian Heimes25bfcd52016-09-06 00:04:45 +02002004
2005 /* can be NULL */
2006 cipher_name = SSL_CIPHER_get_name(cipher);
2007 cipher_protocol = SSL_CIPHER_get_version(cipher);
2008 cipher_id = SSL_CIPHER_get_id(cipher);
2009 SSL_CIPHER_description(cipher, buf, sizeof(buf) - 1);
Segev Finer5cff6372017-07-27 01:19:17 +03002010 /* Downcast to avoid a warning. Safe since buf is always 512 bytes */
2011 len = (int)strlen(buf);
Christian Heimes25bfcd52016-09-06 00:04:45 +02002012 if (len > 1 && buf[len-1] == '\n')
2013 buf[len-1] = '\0';
2014 strength_bits = SSL_CIPHER_get_bits(cipher, &alg_bits);
2015
2016#if OPENSSL_VERSION_1_1
2017 aead = SSL_CIPHER_is_aead(cipher);
2018 nid = SSL_CIPHER_get_cipher_nid(cipher);
2019 skcipher = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2020 nid = SSL_CIPHER_get_digest_nid(cipher);
2021 digest = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2022 nid = SSL_CIPHER_get_kx_nid(cipher);
2023 kx = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2024 nid = SSL_CIPHER_get_auth_nid(cipher);
2025 auth = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2026#endif
2027
Victor Stinner410b9882016-09-12 12:00:23 +02002028 return Py_BuildValue(
Christian Heimes25bfcd52016-09-06 00:04:45 +02002029 "{sksssssssisi"
2030#if OPENSSL_VERSION_1_1
2031 "sOssssssss"
2032#endif
2033 "}",
2034 "id", cipher_id,
2035 "name", cipher_name,
2036 "protocol", cipher_protocol,
2037 "description", buf,
2038 "strength_bits", strength_bits,
2039 "alg_bits", alg_bits
2040#if OPENSSL_VERSION_1_1
2041 ,"aead", aead ? Py_True : Py_False,
2042 "symmetric", skcipher,
2043 "digest", digest,
2044 "kea", kx,
2045 "auth", auth
2046#endif
2047 );
Christian Heimes25bfcd52016-09-06 00:04:45 +02002048}
2049#endif
2050
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002051/*[clinic input]
2052_ssl._SSLSocket.shared_ciphers
2053[clinic start generated code]*/
2054
2055static PyObject *
2056_ssl__SSLSocket_shared_ciphers_impl(PySSLSocket *self)
2057/*[clinic end generated code: output=3d174ead2e42c4fd input=0bfe149da8fe6306]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002058{
2059 STACK_OF(SSL_CIPHER) *ciphers;
2060 int i;
2061 PyObject *res;
2062
Christian Heimes598894f2016-09-05 23:19:05 +02002063 ciphers = SSL_get_ciphers(self->ssl);
2064 if (!ciphers)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002065 Py_RETURN_NONE;
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002066 res = PyList_New(sk_SSL_CIPHER_num(ciphers));
2067 if (!res)
2068 return NULL;
2069 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2070 PyObject *tup = cipher_to_tuple(sk_SSL_CIPHER_value(ciphers, i));
2071 if (!tup) {
2072 Py_DECREF(res);
2073 return NULL;
2074 }
2075 PyList_SET_ITEM(res, i, tup);
2076 }
2077 return res;
2078}
2079
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002080/*[clinic input]
2081_ssl._SSLSocket.cipher
2082[clinic start generated code]*/
2083
2084static PyObject *
2085_ssl__SSLSocket_cipher_impl(PySSLSocket *self)
2086/*[clinic end generated code: output=376417c16d0e5815 input=548fb0e27243796d]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002087{
2088 const SSL_CIPHER *current;
2089
2090 if (self->ssl == NULL)
2091 Py_RETURN_NONE;
2092 current = SSL_get_current_cipher(self->ssl);
2093 if (current == NULL)
2094 Py_RETURN_NONE;
2095 return cipher_to_tuple(current);
2096}
2097
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002098/*[clinic input]
2099_ssl._SSLSocket.version
2100[clinic start generated code]*/
2101
2102static PyObject *
2103_ssl__SSLSocket_version_impl(PySSLSocket *self)
2104/*[clinic end generated code: output=178aed33193b2cdb input=900186a503436fd6]*/
Antoine Pitrou47e40422014-09-04 21:00:10 +02002105{
2106 const char *version;
2107
2108 if (self->ssl == NULL)
2109 Py_RETURN_NONE;
Christian Heimes68771112017-09-05 21:55:40 -07002110 if (!SSL_is_init_finished(self->ssl)) {
2111 /* handshake not finished */
2112 Py_RETURN_NONE;
2113 }
Antoine Pitrou47e40422014-09-04 21:00:10 +02002114 version = SSL_get_version(self->ssl);
2115 if (!strcmp(version, "unknown"))
2116 Py_RETURN_NONE;
2117 return PyUnicode_FromString(version);
2118}
2119
Christian Heimes29eab552018-02-25 12:31:33 +01002120#if HAVE_NPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002121/*[clinic input]
2122_ssl._SSLSocket.selected_npn_protocol
2123[clinic start generated code]*/
2124
2125static PyObject *
2126_ssl__SSLSocket_selected_npn_protocol_impl(PySSLSocket *self)
2127/*[clinic end generated code: output=b91d494cd207ecf6 input=c28fde139204b826]*/
2128{
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002129 const unsigned char *out;
2130 unsigned int outlen;
2131
Victor Stinner4569cd52013-06-23 14:58:43 +02002132 SSL_get0_next_proto_negotiated(self->ssl,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002133 &out, &outlen);
2134
2135 if (out == NULL)
2136 Py_RETURN_NONE;
Benjamin Petersoncca27322015-01-23 16:35:37 -05002137 return PyUnicode_FromStringAndSize((char *)out, outlen);
2138}
2139#endif
2140
Christian Heimes29eab552018-02-25 12:31:33 +01002141#if HAVE_ALPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002142/*[clinic input]
2143_ssl._SSLSocket.selected_alpn_protocol
2144[clinic start generated code]*/
2145
2146static PyObject *
2147_ssl__SSLSocket_selected_alpn_protocol_impl(PySSLSocket *self)
2148/*[clinic end generated code: output=ec33688b303d250f input=442de30e35bc2913]*/
2149{
Benjamin Petersoncca27322015-01-23 16:35:37 -05002150 const unsigned char *out;
2151 unsigned int outlen;
2152
2153 SSL_get0_alpn_selected(self->ssl, &out, &outlen);
2154
2155 if (out == NULL)
2156 Py_RETURN_NONE;
2157 return PyUnicode_FromStringAndSize((char *)out, outlen);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002158}
2159#endif
2160
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002161/*[clinic input]
2162_ssl._SSLSocket.compression
2163[clinic start generated code]*/
2164
2165static PyObject *
2166_ssl__SSLSocket_compression_impl(PySSLSocket *self)
2167/*[clinic end generated code: output=bd16cb1bb4646ae7 input=5d059d0a2bbc32c8]*/
2168{
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002169#ifdef OPENSSL_NO_COMP
2170 Py_RETURN_NONE;
2171#else
2172 const COMP_METHOD *comp_method;
2173 const char *short_name;
2174
2175 if (self->ssl == NULL)
2176 Py_RETURN_NONE;
2177 comp_method = SSL_get_current_compression(self->ssl);
Christian Heimes598894f2016-09-05 23:19:05 +02002178 if (comp_method == NULL || COMP_get_type(comp_method) == NID_undef)
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002179 Py_RETURN_NONE;
Christian Heimes281e5f82016-09-06 01:10:39 +02002180 short_name = OBJ_nid2sn(COMP_get_type(comp_method));
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002181 if (short_name == NULL)
2182 Py_RETURN_NONE;
2183 return PyUnicode_DecodeFSDefault(short_name);
2184#endif
2185}
2186
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002187static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
2188 Py_INCREF(self->ctx);
2189 return self->ctx;
2190}
2191
2192static int PySSL_set_context(PySSLSocket *self, PyObject *value,
2193 void *closure) {
2194
2195 if (PyObject_TypeCheck(value, &PySSLContext_Type)) {
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002196#if !HAVE_SNI
2197 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
2198 "context is not supported by your OpenSSL library");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01002199 return -1;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002200#else
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002201 Py_INCREF(value);
Serhiy Storchaka57a01d32016-04-10 18:05:40 +03002202 Py_SETREF(self->ctx, (PySSLContext *)value);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002203 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002204#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002205 } else {
Ned Deily4531ec72018-06-11 20:26:28 -04002206 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002207 return -1;
2208 }
2209
2210 return 0;
2211}
2212
2213PyDoc_STRVAR(PySSL_set_context_doc,
2214"_setter_context(ctx)\n\
2215\
2216This changes the context associated with the SSLSocket. This is typically\n\
Christian Heimes11a14932018-02-24 02:35:08 +01002217used from within a callback function set by the sni_callback\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002218on the SSLContext to change the certificate information associated with the\n\
2219SSLSocket before the cryptographic exchange handshake messages\n");
2220
2221
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002222static PyObject *
2223PySSL_get_server_side(PySSLSocket *self, void *c)
2224{
2225 return PyBool_FromLong(self->socket_type == PY_SSL_SERVER);
2226}
2227
2228PyDoc_STRVAR(PySSL_get_server_side_doc,
2229"Whether this is a server-side socket.");
2230
2231static PyObject *
2232PySSL_get_server_hostname(PySSLSocket *self, void *c)
2233{
2234 if (self->server_hostname == NULL)
2235 Py_RETURN_NONE;
2236 Py_INCREF(self->server_hostname);
2237 return self->server_hostname;
2238}
2239
2240PyDoc_STRVAR(PySSL_get_server_hostname_doc,
2241"The currently set server hostname (for SNI).");
2242
2243static PyObject *
2244PySSL_get_owner(PySSLSocket *self, void *c)
2245{
2246 PyObject *owner;
2247
2248 if (self->owner == NULL)
2249 Py_RETURN_NONE;
2250
2251 owner = PyWeakref_GetObject(self->owner);
2252 Py_INCREF(owner);
2253 return owner;
2254}
2255
2256static int
2257PySSL_set_owner(PySSLSocket *self, PyObject *value, void *c)
2258{
Serhiy Storchaka48842712016-04-06 09:45:48 +03002259 Py_XSETREF(self->owner, PyWeakref_NewRef(value, NULL));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002260 if (self->owner == NULL)
2261 return -1;
2262 return 0;
2263}
2264
2265PyDoc_STRVAR(PySSL_get_owner_doc,
2266"The Python-level owner of this object.\
2267Passed as \"self\" in servername callback.");
2268
Christian Heimesc7f70692019-05-31 11:44:05 +02002269static int
2270PySSL_traverse(PySSLSocket *self, visitproc visit, void *arg)
2271{
2272 Py_VISIT(self->exc_type);
2273 Py_VISIT(self->exc_value);
2274 Py_VISIT(self->exc_tb);
2275 return 0;
2276}
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002277
Christian Heimesc7f70692019-05-31 11:44:05 +02002278static int
2279PySSL_clear(PySSLSocket *self)
2280{
2281 Py_CLEAR(self->exc_type);
2282 Py_CLEAR(self->exc_value);
2283 Py_CLEAR(self->exc_tb);
2284 return 0;
2285}
2286
2287static void
2288PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002289{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002290 if (self->ssl)
2291 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002292 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002293 Py_XDECREF(self->ctx);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002294 Py_XDECREF(self->server_hostname);
2295 Py_XDECREF(self->owner);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002296 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002297}
2298
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002299/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002300 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002301 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002302 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002303
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002304static int
Victor Stinner14690702015-04-06 22:46:13 +02002305PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002306{
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002307 int rc;
2308#ifdef HAVE_POLL
2309 struct pollfd pollfd;
2310 _PyTime_t ms;
2311#else
2312 int nfds;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002313 fd_set fds;
2314 struct timeval tv;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002315#endif
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002316
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002317 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner14690702015-04-06 22:46:13 +02002318 if ((s == NULL) || (timeout == 0))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002319 return SOCKET_IS_NONBLOCKING;
Victor Stinner14690702015-04-06 22:46:13 +02002320 else if (timeout < 0) {
2321 if (s->sock_timeout > 0)
2322 return SOCKET_HAS_TIMED_OUT;
2323 else
2324 return SOCKET_IS_BLOCKING;
2325 }
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002326
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002327 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002328 if (s->sock_fd == INVALID_SOCKET)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002329 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002330
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002331 /* Prefer poll, if available, since you can poll() any fd
2332 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002333#ifdef HAVE_POLL
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002334 pollfd.fd = s->sock_fd;
2335 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002336
Victor Stinner14690702015-04-06 22:46:13 +02002337 /* timeout is in seconds, poll() uses milliseconds */
2338 ms = (int)_PyTime_AsMilliseconds(timeout, _PyTime_ROUND_CEILING);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002339 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002340
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002341 PySSL_BEGIN_ALLOW_THREADS
2342 rc = poll(&pollfd, 1, (int)ms);
2343 PySSL_END_ALLOW_THREADS
2344#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002345 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02002346 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002347 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00002348
Victor Stinner14690702015-04-06 22:46:13 +02002349 _PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
Victor Stinnere2452312015-03-28 03:00:46 +01002350
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002351 FD_ZERO(&fds);
2352 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002353
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002354 /* Wait until the socket becomes ready */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002355 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002356 nfds = Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002357 if (writing)
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002358 rc = select(nfds, NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002359 else
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002360 rc = select(nfds, &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002361 PySSL_END_ALLOW_THREADS
Bill Janssen6e027db2007-11-15 22:23:56 +00002362#endif
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002363
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002364 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
2365 (when we are able to write or when there's something to read) */
2366 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002367}
2368
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002369/*[clinic input]
2370_ssl._SSLSocket.write
2371 b: Py_buffer
2372 /
2373
2374Writes the bytes-like object b into the SSL object.
2375
2376Returns the number of bytes written.
2377[clinic start generated code]*/
2378
2379static PyObject *
2380_ssl__SSLSocket_write_impl(PySSLSocket *self, Py_buffer *b)
2381/*[clinic end generated code: output=aa7a6be5527358d8 input=77262d994fe5100a]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002382{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002383 int len;
2384 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002385 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002386 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002387 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002388 _PyTime_t timeout, deadline = 0;
2389 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002390
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002391 if (sock != NULL) {
2392 if (((PyObject*)sock) == Py_None) {
2393 _setSSLError("Underlying socket connection gone",
2394 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2395 return NULL;
2396 }
2397 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002398 }
2399
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002400 if (b->len > INT_MAX) {
Victor Stinner6efa9652013-06-25 00:42:31 +02002401 PyErr_Format(PyExc_OverflowError,
2402 "string longer than %d bytes", INT_MAX);
2403 goto error;
2404 }
2405
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002406 if (sock != NULL) {
2407 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002408 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002409 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2410 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2411 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002412
Victor Stinner14690702015-04-06 22:46:13 +02002413 timeout = GET_SOCKET_TIMEOUT(sock);
2414 has_timeout = (timeout > 0);
2415 if (has_timeout)
2416 deadline = _PyTime_GetMonotonicClock() + timeout;
2417
2418 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002419 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002420 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002421 "The write operation timed out");
2422 goto error;
2423 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2424 PyErr_SetString(PySSLErrorObject,
2425 "Underlying socket has been closed.");
2426 goto error;
2427 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2428 PyErr_SetString(PySSLErrorObject,
2429 "Underlying socket too large for select().");
2430 goto error;
2431 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002432
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002433 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002434 PySSL_BEGIN_ALLOW_THREADS
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002435 len = SSL_write(self->ssl, b->buf, (int)b->len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002436 err = _PySSL_errno(len <= 0, self->ssl, len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002437 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002438 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002439
2440 if (PyErr_CheckSignals())
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002441 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002442
Victor Stinner14690702015-04-06 22:46:13 +02002443 if (has_timeout)
2444 timeout = deadline - _PyTime_GetMonotonicClock();
2445
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002446 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002447 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002448 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002449 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002450 } else {
2451 sockstate = SOCKET_OPERATION_OK;
2452 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002453
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002454 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002455 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002456 "The write operation timed out");
2457 goto error;
2458 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2459 PyErr_SetString(PySSLErrorObject,
2460 "Underlying socket has been closed.");
2461 goto error;
2462 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2463 break;
2464 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002465 } while (err.ssl == SSL_ERROR_WANT_READ ||
2466 err.ssl == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002467
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002468 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002469 if (len <= 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002470 return PySSL_SetError(self, len, __FILE__, __LINE__);
Christian Heimesc7f70692019-05-31 11:44:05 +02002471 if (PySSL_ChainExceptions(self) < 0)
2472 return NULL;
2473 return PyLong_FromLong(len);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00002474error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002475 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002476 PySSL_ChainExceptions(self);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002477 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002478}
2479
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002480/*[clinic input]
2481_ssl._SSLSocket.pending
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002482
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002483Returns the number of already decrypted bytes available for read, pending on the connection.
2484[clinic start generated code]*/
2485
2486static PyObject *
2487_ssl__SSLSocket_pending_impl(PySSLSocket *self)
2488/*[clinic end generated code: output=983d9fecdc308a83 input=2b77487d6dfd597f]*/
Bill Janssen6e027db2007-11-15 22:23:56 +00002489{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002490 int count = 0;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002491 _PySSLError err;
Bill Janssen6e027db2007-11-15 22:23:56 +00002492
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002493 PySSL_BEGIN_ALLOW_THREADS
2494 count = SSL_pending(self->ssl);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002495 err = _PySSL_errno(count < 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002496 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002497 self->err = err;
2498
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002499 if (count < 0)
2500 return PySSL_SetError(self, count, __FILE__, __LINE__);
2501 else
2502 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00002503}
2504
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002505/*[clinic input]
2506_ssl._SSLSocket.read
2507 size as len: int
2508 [
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002509 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002510 ]
2511 /
Bill Janssen6e027db2007-11-15 22:23:56 +00002512
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002513Read up to size bytes from the SSL socket.
2514[clinic start generated code]*/
2515
2516static PyObject *
2517_ssl__SSLSocket_read_impl(PySSLSocket *self, int len, int group_right_1,
2518 Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002519/*[clinic end generated code: output=00097776cec2a0af input=ff157eb918d0905b]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002520{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002521 PyObject *dest = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002522 char *mem;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002523 int count;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002524 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002525 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002526 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002527 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002528 _PyTime_t timeout, deadline = 0;
2529 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002530
Martin Panter5503d472016-03-27 05:35:19 +00002531 if (!group_right_1 && len < 0) {
2532 PyErr_SetString(PyExc_ValueError, "size should not be negative");
2533 return NULL;
2534 }
2535
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002536 if (sock != NULL) {
2537 if (((PyObject*)sock) == Py_None) {
2538 _setSSLError("Underlying socket connection gone",
2539 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2540 return NULL;
2541 }
2542 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002543 }
2544
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002545 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002546 dest = PyBytes_FromStringAndSize(NULL, len);
2547 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002548 goto error;
Martin Panterbed7f1a2016-07-11 00:17:13 +00002549 if (len == 0) {
2550 Py_XDECREF(sock);
2551 return dest;
2552 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002553 mem = PyBytes_AS_STRING(dest);
2554 }
2555 else {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002556 mem = buffer->buf;
2557 if (len <= 0 || len > buffer->len) {
2558 len = (int) buffer->len;
2559 if (buffer->len != len) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002560 PyErr_SetString(PyExc_OverflowError,
2561 "maximum length can't fit in a C 'int'");
2562 goto error;
2563 }
Martin Panterbed7f1a2016-07-11 00:17:13 +00002564 if (len == 0) {
2565 count = 0;
2566 goto done;
2567 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002568 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002569 }
2570
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002571 if (sock != NULL) {
2572 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002573 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002574 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2575 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2576 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002577
Victor Stinner14690702015-04-06 22:46:13 +02002578 timeout = GET_SOCKET_TIMEOUT(sock);
2579 has_timeout = (timeout > 0);
2580 if (has_timeout)
2581 deadline = _PyTime_GetMonotonicClock() + timeout;
2582
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002583 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002584 PySSL_BEGIN_ALLOW_THREADS
2585 count = SSL_read(self->ssl, mem, len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002586 err = _PySSL_errno(count <= 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002587 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002588 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002589
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002590 if (PyErr_CheckSignals())
2591 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002592
Victor Stinner14690702015-04-06 22:46:13 +02002593 if (has_timeout)
2594 timeout = deadline - _PyTime_GetMonotonicClock();
2595
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002596 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002597 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002598 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002599 sockstate = PySSL_select(sock, 1, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002600 } else if (err.ssl == SSL_ERROR_ZERO_RETURN &&
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002601 SSL_get_shutdown(self->ssl) == SSL_RECEIVED_SHUTDOWN)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002602 {
2603 count = 0;
2604 goto done;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002605 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002606 else
2607 sockstate = SOCKET_OPERATION_OK;
2608
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002609 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002610 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002611 "The read operation timed out");
2612 goto error;
2613 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2614 break;
2615 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002616 } while (err.ssl == SSL_ERROR_WANT_READ ||
2617 err.ssl == SSL_ERROR_WANT_WRITE);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002618
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002619 if (count <= 0) {
2620 PySSL_SetError(self, count, __FILE__, __LINE__);
2621 goto error;
2622 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002623 if (self->exc_type != NULL)
2624 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002625
2626done:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002627 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002628 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002629 _PyBytes_Resize(&dest, count);
2630 return dest;
2631 }
2632 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002633 return PyLong_FromLong(count);
2634 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002635
2636error:
Christian Heimesc7f70692019-05-31 11:44:05 +02002637 PySSL_ChainExceptions(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002638 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002639 if (!group_right_1)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002640 Py_XDECREF(dest);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002641 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002642}
2643
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002644/*[clinic input]
2645_ssl._SSLSocket.shutdown
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002646
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002647Does the SSL shutdown handshake with the remote end.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002648[clinic start generated code]*/
2649
2650static PyObject *
2651_ssl__SSLSocket_shutdown_impl(PySSLSocket *self)
Christian Heimes141c5e82018-02-24 21:10:57 +01002652/*[clinic end generated code: output=ca1aa7ed9d25ca42 input=11d39e69b0a2bf4a]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002653{
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002654 _PySSLError err;
2655 int sockstate, nonblocking, ret;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002656 int zeros = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002657 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002658 _PyTime_t timeout, deadline = 0;
2659 int has_timeout;
Bill Janssen40a0f662008-08-12 16:56:25 +00002660
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002661 if (sock != NULL) {
2662 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002663 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd == INVALID_SOCKET)) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002664 _setSSLError("Underlying socket connection gone",
2665 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2666 return NULL;
2667 }
2668 Py_INCREF(sock);
2669
2670 /* Just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002671 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002672 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2673 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002674 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002675
Victor Stinner14690702015-04-06 22:46:13 +02002676 timeout = GET_SOCKET_TIMEOUT(sock);
2677 has_timeout = (timeout > 0);
2678 if (has_timeout)
2679 deadline = _PyTime_GetMonotonicClock() + timeout;
2680
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002681 while (1) {
2682 PySSL_BEGIN_ALLOW_THREADS
2683 /* Disable read-ahead so that unwrap can work correctly.
2684 * Otherwise OpenSSL might read in too much data,
2685 * eating clear text data that happens to be
2686 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03002687 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002688 * function is used and the shutdown_seen_zero != 0
2689 * condition is met.
2690 */
2691 if (self->shutdown_seen_zero)
2692 SSL_set_read_ahead(self->ssl, 0);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002693 ret = SSL_shutdown(self->ssl);
2694 err = _PySSL_errno(ret < 0, self->ssl, ret);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002695 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002696 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002697
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002698 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002699 if (ret > 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002700 break;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002701 if (ret == 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002702 /* Don't loop endlessly; instead preserve legacy
2703 behaviour of trying SSL_shutdown() only twice.
2704 This looks necessary for OpenSSL < 0.9.8m */
2705 if (++zeros > 1)
2706 break;
2707 /* Shutdown was sent, now try receiving */
2708 self->shutdown_seen_zero = 1;
2709 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00002710 }
2711
Victor Stinner14690702015-04-06 22:46:13 +02002712 if (has_timeout)
2713 timeout = deadline - _PyTime_GetMonotonicClock();
2714
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002715 /* Possibly retry shutdown until timeout or failure */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002716 if (err.ssl == SSL_ERROR_WANT_READ)
Victor Stinner14690702015-04-06 22:46:13 +02002717 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002718 else if (err.ssl == SSL_ERROR_WANT_WRITE)
Victor Stinner14690702015-04-06 22:46:13 +02002719 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002720 else
2721 break;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002722
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002723 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002724 if (err.ssl == SSL_ERROR_WANT_READ)
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002725 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002726 "The read operation timed out");
2727 else
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002728 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002729 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002730 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002731 }
2732 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2733 PyErr_SetString(PySSLErrorObject,
2734 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002735 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002736 }
2737 else if (sockstate != SOCKET_OPERATION_OK)
2738 /* Retain the SSL error code */
2739 break;
2740 }
Nathaniel J. Smithc0da5822018-09-21 21:44:12 -07002741 if (ret < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002742 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002743 PySSL_SetError(self, ret, __FILE__, __LINE__);
2744 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002745 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002746 if (self->exc_type != NULL)
2747 goto error;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002748 if (sock)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002749 /* It's already INCREF'ed */
2750 return (PyObject *) sock;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002751 else
2752 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002753
2754error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002755 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002756 PySSL_ChainExceptions(self);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002757 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00002758}
2759
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002760/*[clinic input]
Christian Heimes141c5e82018-02-24 21:10:57 +01002761_ssl._SSLSocket.get_channel_binding
2762 cb_type: str = "tls-unique"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002763
Christian Heimes141c5e82018-02-24 21:10:57 +01002764Get channel binding data for current connection.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002765
Christian Heimes141c5e82018-02-24 21:10:57 +01002766Raise ValueError if the requested `cb_type` is not supported. Return bytes
2767of the data or None if the data is not available (e.g. before the handshake).
2768Only 'tls-unique' channel binding data from RFC 5929 is supported.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002769[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002770
Antoine Pitroud6494802011-07-21 01:11:30 +02002771static PyObject *
Christian Heimes141c5e82018-02-24 21:10:57 +01002772_ssl__SSLSocket_get_channel_binding_impl(PySSLSocket *self,
2773 const char *cb_type)
2774/*[clinic end generated code: output=34bac9acb6a61d31 input=08b7e43b99c17d41]*/
Antoine Pitroud6494802011-07-21 01:11:30 +02002775{
Antoine Pitroud6494802011-07-21 01:11:30 +02002776 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02002777 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02002778
Christian Heimes141c5e82018-02-24 21:10:57 +01002779 if (strcmp(cb_type, "tls-unique") == 0) {
2780 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
2781 /* if session is resumed XOR we are the client */
2782 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2783 }
2784 else {
2785 /* if a new session XOR we are the server */
2786 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2787 }
Antoine Pitroud6494802011-07-21 01:11:30 +02002788 }
2789 else {
Christian Heimes141c5e82018-02-24 21:10:57 +01002790 PyErr_Format(
2791 PyExc_ValueError,
2792 "'%s' channel binding type not implemented",
2793 cb_type
2794 );
2795 return NULL;
Antoine Pitroud6494802011-07-21 01:11:30 +02002796 }
2797
2798 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02002799 if (len == 0)
2800 Py_RETURN_NONE;
2801
Christian Heimes141c5e82018-02-24 21:10:57 +01002802 return PyBytes_FromStringAndSize(buf, len);
Antoine Pitroud6494802011-07-21 01:11:30 +02002803}
2804
Christian Heimes9fb051f2018-09-23 08:32:31 +02002805/*[clinic input]
2806_ssl._SSLSocket.verify_client_post_handshake
2807
2808Initiate TLS 1.3 post-handshake authentication
2809[clinic start generated code]*/
2810
2811static PyObject *
2812_ssl__SSLSocket_verify_client_post_handshake_impl(PySSLSocket *self)
2813/*[clinic end generated code: output=532147f3b1341425 input=6bfa874810a3d889]*/
2814{
2815#ifdef TLS1_3_VERSION
2816 int err = SSL_verify_client_post_handshake(self->ssl);
2817 if (err == 0)
2818 return _setSSLError(NULL, 0, __FILE__, __LINE__);
2819 else
2820 Py_RETURN_NONE;
2821#else
2822 PyErr_SetString(PyExc_NotImplementedError,
2823 "Post-handshake auth is not supported by your "
2824 "OpenSSL version.");
2825 return NULL;
2826#endif
2827}
2828
Christian Heimes99a65702016-09-10 23:44:53 +02002829#ifdef OPENSSL_VERSION_1_1
2830
2831static SSL_SESSION*
2832_ssl_session_dup(SSL_SESSION *session) {
2833 SSL_SESSION *newsession = NULL;
2834 int slen;
2835 unsigned char *senc = NULL, *p;
2836 const unsigned char *const_p;
2837
2838 if (session == NULL) {
2839 PyErr_SetString(PyExc_ValueError, "Invalid session");
2840 goto error;
2841 }
2842
2843 /* get length */
2844 slen = i2d_SSL_SESSION(session, NULL);
2845 if (slen == 0 || slen > 0xFF00) {
2846 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2847 goto error;
2848 }
2849 if ((senc = PyMem_Malloc(slen)) == NULL) {
2850 PyErr_NoMemory();
2851 goto error;
2852 }
2853 p = senc;
2854 if (!i2d_SSL_SESSION(session, &p)) {
2855 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2856 goto error;
2857 }
2858 const_p = senc;
2859 newsession = d2i_SSL_SESSION(NULL, &const_p, slen);
2860 if (session == NULL) {
2861 goto error;
2862 }
2863 PyMem_Free(senc);
2864 return newsession;
2865 error:
2866 if (senc != NULL) {
2867 PyMem_Free(senc);
2868 }
2869 return NULL;
2870}
2871#endif
2872
2873static PyObject *
2874PySSL_get_session(PySSLSocket *self, void *closure) {
2875 /* get_session can return sessions from a server-side connection,
2876 * it does not check for handshake done or client socket. */
2877 PySSLSession *pysess;
2878 SSL_SESSION *session;
2879
2880#ifdef OPENSSL_VERSION_1_1
2881 /* duplicate session as workaround for session bug in OpenSSL 1.1.0,
2882 * https://github.com/openssl/openssl/issues/1550 */
2883 session = SSL_get0_session(self->ssl); /* borrowed reference */
2884 if (session == NULL) {
2885 Py_RETURN_NONE;
2886 }
2887 if ((session = _ssl_session_dup(session)) == NULL) {
2888 return NULL;
2889 }
2890#else
2891 session = SSL_get1_session(self->ssl);
2892 if (session == NULL) {
2893 Py_RETURN_NONE;
2894 }
2895#endif
Christian Heimesa5d07652016-09-24 10:48:05 +02002896 pysess = PyObject_GC_New(PySSLSession, &PySSLSession_Type);
Christian Heimes99a65702016-09-10 23:44:53 +02002897 if (pysess == NULL) {
2898 SSL_SESSION_free(session);
2899 return NULL;
2900 }
2901
2902 assert(self->ctx);
2903 pysess->ctx = self->ctx;
2904 Py_INCREF(pysess->ctx);
2905 pysess->session = session;
Christian Heimesa5d07652016-09-24 10:48:05 +02002906 PyObject_GC_Track(pysess);
Christian Heimes99a65702016-09-10 23:44:53 +02002907 return (PyObject *)pysess;
2908}
2909
2910static int PySSL_set_session(PySSLSocket *self, PyObject *value,
2911 void *closure)
2912 {
2913 PySSLSession *pysess;
2914#ifdef OPENSSL_VERSION_1_1
2915 SSL_SESSION *session;
2916#endif
2917 int result;
2918
2919 if (!PySSLSession_Check(value)) {
Ned Deily4531ec72018-06-11 20:26:28 -04002920 PyErr_SetString(PyExc_TypeError, "Value is not a SSLSession.");
Christian Heimes99a65702016-09-10 23:44:53 +02002921 return -1;
2922 }
2923 pysess = (PySSLSession *)value;
2924
2925 if (self->ctx->ctx != pysess->ctx->ctx) {
2926 PyErr_SetString(PyExc_ValueError,
2927 "Session refers to a different SSLContext.");
2928 return -1;
2929 }
2930 if (self->socket_type != PY_SSL_CLIENT) {
2931 PyErr_SetString(PyExc_ValueError,
2932 "Cannot set session for server-side SSLSocket.");
2933 return -1;
2934 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07002935 if (SSL_is_init_finished(self->ssl)) {
Christian Heimes99a65702016-09-10 23:44:53 +02002936 PyErr_SetString(PyExc_ValueError,
2937 "Cannot set session after handshake.");
2938 return -1;
2939 }
2940#ifdef OPENSSL_VERSION_1_1
2941 /* duplicate session */
2942 if ((session = _ssl_session_dup(pysess->session)) == NULL) {
2943 return -1;
2944 }
2945 result = SSL_set_session(self->ssl, session);
2946 /* free duplicate, SSL_set_session() bumps ref count */
2947 SSL_SESSION_free(session);
2948#else
2949 result = SSL_set_session(self->ssl, pysess->session);
2950#endif
2951 if (result == 0) {
2952 _setSSLError(NULL, 0, __FILE__, __LINE__);
2953 return -1;
2954 }
2955 return 0;
2956}
2957
2958PyDoc_STRVAR(PySSL_set_session_doc,
2959"_setter_session(session)\n\
2960\
2961Get / set SSLSession.");
2962
2963static PyObject *
2964PySSL_get_session_reused(PySSLSocket *self, void *closure) {
2965 if (SSL_session_reused(self->ssl)) {
2966 Py_RETURN_TRUE;
2967 } else {
2968 Py_RETURN_FALSE;
2969 }
2970}
2971
2972PyDoc_STRVAR(PySSL_get_session_reused_doc,
2973"Was the client session reused during handshake?");
2974
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002975static PyGetSetDef ssl_getsetlist[] = {
2976 {"context", (getter) PySSL_get_context,
2977 (setter) PySSL_set_context, PySSL_set_context_doc},
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002978 {"server_side", (getter) PySSL_get_server_side, NULL,
2979 PySSL_get_server_side_doc},
2980 {"server_hostname", (getter) PySSL_get_server_hostname, NULL,
2981 PySSL_get_server_hostname_doc},
2982 {"owner", (getter) PySSL_get_owner, (setter) PySSL_set_owner,
2983 PySSL_get_owner_doc},
Christian Heimes99a65702016-09-10 23:44:53 +02002984 {"session", (getter) PySSL_get_session,
2985 (setter) PySSL_set_session, PySSL_set_session_doc},
2986 {"session_reused", (getter) PySSL_get_session_reused, NULL,
2987 PySSL_get_session_reused_doc},
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002988 {NULL}, /* sentinel */
2989};
2990
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002991static PyMethodDef PySSLMethods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002992 _SSL__SSLSOCKET_DO_HANDSHAKE_METHODDEF
2993 _SSL__SSLSOCKET_WRITE_METHODDEF
2994 _SSL__SSLSOCKET_READ_METHODDEF
2995 _SSL__SSLSOCKET_PENDING_METHODDEF
Christian Heimes141c5e82018-02-24 21:10:57 +01002996 _SSL__SSLSOCKET_GETPEERCERT_METHODDEF
2997 _SSL__SSLSOCKET_GET_CHANNEL_BINDING_METHODDEF
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002998 _SSL__SSLSOCKET_CIPHER_METHODDEF
2999 _SSL__SSLSOCKET_SHARED_CIPHERS_METHODDEF
3000 _SSL__SSLSOCKET_VERSION_METHODDEF
3001 _SSL__SSLSOCKET_SELECTED_NPN_PROTOCOL_METHODDEF
3002 _SSL__SSLSOCKET_SELECTED_ALPN_PROTOCOL_METHODDEF
3003 _SSL__SSLSOCKET_COMPRESSION_METHODDEF
3004 _SSL__SSLSOCKET_SHUTDOWN_METHODDEF
Christian Heimes9fb051f2018-09-23 08:32:31 +02003005 _SSL__SSLSOCKET_VERIFY_CLIENT_POST_HANDSHAKE_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003006 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003007};
3008
Antoine Pitrou152efa22010-05-16 18:19:27 +00003009static PyTypeObject PySSLSocket_Type = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003010 PyVarObject_HEAD_INIT(NULL, 0)
Antoine Pitrou152efa22010-05-16 18:19:27 +00003011 "_ssl._SSLSocket", /*tp_name*/
3012 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003013 0, /*tp_itemsize*/
3014 /* methods */
3015 (destructor)PySSL_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003016 0, /*tp_vectorcall_offset*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003017 0, /*tp_getattr*/
3018 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003019 0, /*tp_as_async*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003020 0, /*tp_repr*/
3021 0, /*tp_as_number*/
3022 0, /*tp_as_sequence*/
3023 0, /*tp_as_mapping*/
3024 0, /*tp_hash*/
3025 0, /*tp_call*/
3026 0, /*tp_str*/
3027 0, /*tp_getattro*/
3028 0, /*tp_setattro*/
3029 0, /*tp_as_buffer*/
3030 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3031 0, /*tp_doc*/
Christian Heimesc7f70692019-05-31 11:44:05 +02003032 (traverseproc) PySSL_traverse, /*tp_traverse*/
3033 (inquiry) PySSL_clear, /*tp_clear*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003034 0, /*tp_richcompare*/
3035 0, /*tp_weaklistoffset*/
3036 0, /*tp_iter*/
3037 0, /*tp_iternext*/
3038 PySSLMethods, /*tp_methods*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003039 0, /*tp_members*/
3040 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003041};
3042
Antoine Pitrou152efa22010-05-16 18:19:27 +00003043
3044/*
3045 * _SSLContext objects
3046 */
3047
Christian Heimes5fe668c2016-09-12 00:01:11 +02003048static int
Christian Heimes9fb051f2018-09-23 08:32:31 +02003049_set_verify_mode(PySSLContext *self, enum py_ssl_cert_requirements n)
Christian Heimes5fe668c2016-09-12 00:01:11 +02003050{
3051 int mode;
3052 int (*verify_cb)(int, X509_STORE_CTX *) = NULL;
3053
3054 switch(n) {
3055 case PY_SSL_CERT_NONE:
3056 mode = SSL_VERIFY_NONE;
3057 break;
3058 case PY_SSL_CERT_OPTIONAL:
3059 mode = SSL_VERIFY_PEER;
3060 break;
3061 case PY_SSL_CERT_REQUIRED:
3062 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
3063 break;
3064 default:
3065 PyErr_SetString(PyExc_ValueError,
3066 "invalid value for verify_mode");
3067 return -1;
3068 }
Christian Heimesf0f59302019-07-01 08:29:17 +02003069
3070 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3071 * server sockets and SSL_set_post_handshake_auth() for client. */
3072
Christian Heimes5fe668c2016-09-12 00:01:11 +02003073 /* keep current verify cb */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003074 verify_cb = SSL_CTX_get_verify_callback(self->ctx);
3075 SSL_CTX_set_verify(self->ctx, mode, verify_cb);
Christian Heimes5fe668c2016-09-12 00:01:11 +02003076 return 0;
3077}
3078
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003079/*[clinic input]
3080@classmethod
3081_ssl._SSLContext.__new__
3082 protocol as proto_version: int
3083 /
3084[clinic start generated code]*/
3085
Antoine Pitrou152efa22010-05-16 18:19:27 +00003086static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003087_ssl__SSLContext_impl(PyTypeObject *type, int proto_version)
3088/*[clinic end generated code: output=2cf0d7a0741b6bd1 input=8d58a805b95fc534]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003089{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003090 PySSLContext *self;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003091 long options;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003092 SSL_CTX *ctx = NULL;
Christian Heimes61d478c2018-01-27 15:51:38 +01003093 X509_VERIFY_PARAM *params;
Christian Heimes358cfd42016-09-10 22:43:48 +02003094 int result;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003095#if defined(SSL_MODE_RELEASE_BUFFERS)
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003096 unsigned long libver;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003097#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003098
Antoine Pitrou152efa22010-05-16 18:19:27 +00003099 PySSL_BEGIN_ALLOW_THREADS
Christian Heimes6e8cda92020-05-16 03:33:05 +02003100 switch(proto_version) {
3101#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
3102 case PY_SSL_VERSION_SSL3:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003103 ctx = SSL_CTX_new(SSLv3_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003104 break;
Benjamin Petersone32467c2014-12-05 21:59:35 -05003105#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003106#if (defined(TLS1_VERSION) && \
3107 !defined(OPENSSL_NO_TLS1) && \
3108 !defined(OPENSSL_NO_TLS1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003109 case PY_SSL_VERSION_TLS1:
3110 ctx = SSL_CTX_new(TLSv1_method());
3111 break;
Victor Stinner3de49192011-05-09 00:42:58 +02003112#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003113#if (defined(TLS1_1_VERSION) && \
3114 !defined(OPENSSL_NO_TLS1_1) && \
3115 !defined(OPENSSL_NO_TLS1_1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003116 case PY_SSL_VERSION_TLS1_1:
3117 ctx = SSL_CTX_new(TLSv1_1_method());
3118 break;
3119#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003120#if (defined(TLS1_2_VERSION) && \
3121 !defined(OPENSSL_NO_TLS1_2) && \
3122 !defined(OPENSSL_NO_TLS1_2_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003123 case PY_SSL_VERSION_TLS1_2:
3124 ctx = SSL_CTX_new(TLSv1_2_method());
3125 break;
3126#endif
3127 case PY_SSL_VERSION_TLS:
3128 /* SSLv23 */
Christian Heimes598894f2016-09-05 23:19:05 +02003129 ctx = SSL_CTX_new(TLS_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003130 break;
3131 case PY_SSL_VERSION_TLS_CLIENT:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003132 ctx = SSL_CTX_new(TLS_client_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003133 break;
3134 case PY_SSL_VERSION_TLS_SERVER:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003135 ctx = SSL_CTX_new(TLS_server_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003136 break;
3137 default:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003138 proto_version = -1;
Christian Heimes6e8cda92020-05-16 03:33:05 +02003139 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003140 PySSL_END_ALLOW_THREADS
3141
3142 if (proto_version == -1) {
3143 PyErr_SetString(PyExc_ValueError,
Christian Heimes6e8cda92020-05-16 03:33:05 +02003144 "invalid or unsupported protocol version");
Antoine Pitrou152efa22010-05-16 18:19:27 +00003145 return NULL;
3146 }
3147 if (ctx == NULL) {
Christian Heimes17c9ac92017-09-07 14:14:00 -07003148 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003149 return NULL;
3150 }
3151
3152 assert(type != NULL && type->tp_alloc != NULL);
3153 self = (PySSLContext *) type->tp_alloc(type, 0);
3154 if (self == NULL) {
3155 SSL_CTX_free(ctx);
3156 return NULL;
3157 }
3158 self->ctx = ctx;
Christian Heimes61d478c2018-01-27 15:51:38 +01003159 self->hostflags = X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS;
Christian Heimes11a14932018-02-24 02:35:08 +01003160 self->protocol = proto_version;
Christian Heimesc7f70692019-05-31 11:44:05 +02003161 self->msg_cb = NULL;
3162#ifdef HAVE_OPENSSL_KEYLOG
3163 self->keylog_filename = NULL;
3164 self->keylog_bio = NULL;
3165#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003166#if HAVE_NPN
Christian Heimes5cb31c92012-09-20 12:42:54 +02003167 self->npn_protocols = NULL;
3168#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003169#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003170 self->alpn_protocols = NULL;
3171#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003172#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003173 self->set_sni_cb = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003174#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01003175 /* Don't check host name by default */
Christian Heimes5fe668c2016-09-12 00:01:11 +02003176 if (proto_version == PY_SSL_VERSION_TLS_CLIENT) {
3177 self->check_hostname = 1;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003178 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003179 Py_DECREF(self);
3180 return NULL;
3181 }
3182 } else {
3183 self->check_hostname = 0;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003184 if (_set_verify_mode(self, PY_SSL_CERT_NONE) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003185 Py_DECREF(self);
3186 return NULL;
3187 }
3188 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003189 /* Defaults */
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003190 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
3191 if (proto_version != PY_SSL_VERSION_SSL2)
3192 options |= SSL_OP_NO_SSLv2;
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08003193 if (proto_version != PY_SSL_VERSION_SSL3)
3194 options |= SSL_OP_NO_SSLv3;
Christian Heimes358cfd42016-09-10 22:43:48 +02003195 /* Minimal security flags for server and client side context.
3196 * Client sockets ignore server-side parameters. */
3197#ifdef SSL_OP_NO_COMPRESSION
3198 options |= SSL_OP_NO_COMPRESSION;
3199#endif
3200#ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
3201 options |= SSL_OP_CIPHER_SERVER_PREFERENCE;
3202#endif
3203#ifdef SSL_OP_SINGLE_DH_USE
3204 options |= SSL_OP_SINGLE_DH_USE;
3205#endif
3206#ifdef SSL_OP_SINGLE_ECDH_USE
3207 options |= SSL_OP_SINGLE_ECDH_USE;
3208#endif
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003209 SSL_CTX_set_options(self->ctx, options);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003210
Semen Zhydenko1295e112017-10-15 21:28:31 +02003211 /* A bare minimum cipher list without completely broken cipher suites.
Christian Heimes358cfd42016-09-10 22:43:48 +02003212 * It's far from perfect but gives users a better head start. */
3213 if (proto_version != PY_SSL_VERSION_SSL2) {
Christian Heimes892d66e2018-01-29 14:10:18 +01003214#if PY_SSL_DEFAULT_CIPHERS == 2
3215 /* stick to OpenSSL's default settings */
3216 result = 1;
3217#else
3218 result = SSL_CTX_set_cipher_list(ctx, PY_SSL_DEFAULT_CIPHER_STRING);
3219#endif
Christian Heimes358cfd42016-09-10 22:43:48 +02003220 } else {
3221 /* SSLv2 needs MD5 */
3222 result = SSL_CTX_set_cipher_list(ctx, "HIGH:!aNULL:!eNULL");
3223 }
3224 if (result == 0) {
3225 Py_DECREF(self);
3226 ERR_clear_error();
3227 PyErr_SetString(PySSLErrorObject,
3228 "No cipher can be selected.");
3229 return NULL;
3230 }
3231
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003232#if defined(SSL_MODE_RELEASE_BUFFERS)
3233 /* Set SSL_MODE_RELEASE_BUFFERS. This potentially greatly reduces memory
3234 usage for no cost at all. However, don't do this for OpenSSL versions
3235 between 1.0.1 and 1.0.1h or 1.0.0 and 1.0.0m, which are affected by CVE
3236 2014-0198. I can't find exactly which beta fixed this CVE, so be
3237 conservative and assume it wasn't fixed until release. We do this check
3238 at runtime to avoid problems from the dynamic linker.
3239 See #25672 for more on this. */
Christian Heimesa871f692020-06-01 08:58:14 +02003240 libver = OpenSSL_version_num();
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003241 if (!(libver >= 0x10001000UL && libver < 0x1000108fUL) &&
3242 !(libver >= 0x10000000UL && libver < 0x100000dfUL)) {
3243 SSL_CTX_set_mode(self->ctx, SSL_MODE_RELEASE_BUFFERS);
3244 }
3245#endif
3246
3247
Donald Stufft8ae264c2017-03-02 11:45:29 -05003248#if !defined(OPENSSL_NO_ECDH) && !defined(OPENSSL_VERSION_1_1)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003249 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
3250 prime256v1 by default. This is Apache mod_ssl's initialization
Christian Heimes598894f2016-09-05 23:19:05 +02003251 policy, so we should be safe. OpenSSL 1.1 has it enabled by default.
3252 */
Donald Stufft8ae264c2017-03-02 11:45:29 -05003253#if defined(SSL_CTX_set_ecdh_auto)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003254 SSL_CTX_set_ecdh_auto(self->ctx, 1);
3255#else
3256 {
3257 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
3258 SSL_CTX_set_tmp_ecdh(self->ctx, key);
3259 EC_KEY_free(key);
3260 }
3261#endif
3262#endif
3263
Antoine Pitroufc113ee2010-10-13 12:46:13 +00003264#define SID_CTX "Python"
3265 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
3266 sizeof(SID_CTX));
3267#undef SID_CTX
3268
Christian Heimes61d478c2018-01-27 15:51:38 +01003269 params = SSL_CTX_get0_param(self->ctx);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003270#ifdef X509_V_FLAG_TRUSTED_FIRST
Christian Heimes61d478c2018-01-27 15:51:38 +01003271 /* Improve trust chain building when cross-signed intermediate
3272 certificates are present. See https://bugs.python.org/issue23476. */
3273 X509_VERIFY_PARAM_set_flags(params, X509_V_FLAG_TRUSTED_FIRST);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003274#endif
Christian Heimes61d478c2018-01-27 15:51:38 +01003275 X509_VERIFY_PARAM_set_hostflags(params, self->hostflags);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003276
Christian Heimes9fb051f2018-09-23 08:32:31 +02003277#ifdef TLS1_3_VERSION
3278 self->post_handshake_auth = 0;
3279 SSL_CTX_set_post_handshake_auth(self->ctx, self->post_handshake_auth);
3280#endif
3281
Antoine Pitrou152efa22010-05-16 18:19:27 +00003282 return (PyObject *)self;
3283}
3284
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003285static int
3286context_traverse(PySSLContext *self, visitproc visit, void *arg)
3287{
3288#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003289 Py_VISIT(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003290#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003291 Py_VISIT(self->msg_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003292 return 0;
3293}
3294
3295static int
3296context_clear(PySSLContext *self)
3297{
3298#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003299 Py_CLEAR(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003300#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003301 Py_CLEAR(self->msg_cb);
3302#ifdef HAVE_OPENSSL_KEYLOG
3303 Py_CLEAR(self->keylog_filename);
3304 if (self->keylog_bio != NULL) {
3305 PySSL_BEGIN_ALLOW_THREADS
3306 BIO_free_all(self->keylog_bio);
3307 PySSL_END_ALLOW_THREADS
3308 self->keylog_bio = NULL;
3309 }
3310#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003311 return 0;
3312}
3313
Antoine Pitrou152efa22010-05-16 18:19:27 +00003314static void
3315context_dealloc(PySSLContext *self)
3316{
INADA Naokia6296d32017-08-24 14:55:17 +09003317 /* bpo-31095: UnTrack is needed before calling any callbacks */
3318 PyObject_GC_UnTrack(self);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003319 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003320 SSL_CTX_free(self->ctx);
Christian Heimes29eab552018-02-25 12:31:33 +01003321#if HAVE_NPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003322 PyMem_FREE(self->npn_protocols);
3323#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003324#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003325 PyMem_FREE(self->alpn_protocols);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003326#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003327 Py_TYPE(self)->tp_free(self);
3328}
3329
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003330/*[clinic input]
3331_ssl._SSLContext.set_ciphers
3332 cipherlist: str
3333 /
3334[clinic start generated code]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003335
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003336static PyObject *
3337_ssl__SSLContext_set_ciphers_impl(PySSLContext *self, const char *cipherlist)
3338/*[clinic end generated code: output=3a3162f3557c0f3f input=a7ac931b9f3ca7fc]*/
3339{
3340 int ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003341 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00003342 /* Clearing the error queue is necessary on some OpenSSL versions,
3343 otherwise the error will be reported again when another SSL call
3344 is done. */
3345 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003346 PyErr_SetString(PySSLErrorObject,
3347 "No cipher can be selected.");
3348 return NULL;
3349 }
3350 Py_RETURN_NONE;
3351}
3352
Christian Heimes25bfcd52016-09-06 00:04:45 +02003353#if OPENSSL_VERSION_NUMBER >= 0x10002000UL
3354/*[clinic input]
3355_ssl._SSLContext.get_ciphers
3356[clinic start generated code]*/
3357
3358static PyObject *
3359_ssl__SSLContext_get_ciphers_impl(PySSLContext *self)
3360/*[clinic end generated code: output=a56e4d68a406dfc4 input=a2aadc9af89b79c5]*/
3361{
3362 SSL *ssl = NULL;
3363 STACK_OF(SSL_CIPHER) *sk = NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02003364 const SSL_CIPHER *cipher;
Christian Heimes25bfcd52016-09-06 00:04:45 +02003365 int i=0;
3366 PyObject *result = NULL, *dct;
3367
3368 ssl = SSL_new(self->ctx);
3369 if (ssl == NULL) {
3370 _setSSLError(NULL, 0, __FILE__, __LINE__);
3371 goto exit;
3372 }
3373 sk = SSL_get_ciphers(ssl);
3374
3375 result = PyList_New(sk_SSL_CIPHER_num(sk));
3376 if (result == NULL) {
3377 goto exit;
3378 }
3379
3380 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
3381 cipher = sk_SSL_CIPHER_value(sk, i);
3382 dct = cipher_to_dict(cipher);
3383 if (dct == NULL) {
3384 Py_CLEAR(result);
3385 goto exit;
3386 }
3387 PyList_SET_ITEM(result, i, dct);
3388 }
3389
3390 exit:
3391 if (ssl != NULL)
3392 SSL_free(ssl);
3393 return result;
3394
3395}
3396#endif
3397
3398
Christian Heimes29eab552018-02-25 12:31:33 +01003399#if HAVE_NPN || HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003400static int
Benjamin Peterson88615022015-01-23 17:30:26 -05003401do_protocol_selection(int alpn, unsigned char **out, unsigned char *outlen,
3402 const unsigned char *server_protocols, unsigned int server_protocols_len,
3403 const unsigned char *client_protocols, unsigned int client_protocols_len)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003404{
Benjamin Peterson88615022015-01-23 17:30:26 -05003405 int ret;
3406 if (client_protocols == NULL) {
3407 client_protocols = (unsigned char *)"";
3408 client_protocols_len = 0;
3409 }
3410 if (server_protocols == NULL) {
3411 server_protocols = (unsigned char *)"";
3412 server_protocols_len = 0;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003413 }
3414
Benjamin Peterson88615022015-01-23 17:30:26 -05003415 ret = SSL_select_next_proto(out, outlen,
3416 server_protocols, server_protocols_len,
3417 client_protocols, client_protocols_len);
3418 if (alpn && ret != OPENSSL_NPN_NEGOTIATED)
3419 return SSL_TLSEXT_ERR_NOACK;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003420
3421 return SSL_TLSEXT_ERR_OK;
3422}
Melvyn Sopacuab2d096b2017-09-04 23:35:15 +02003423#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05003424
Christian Heimes29eab552018-02-25 12:31:33 +01003425#if HAVE_NPN
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003426/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
3427static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003428_advertiseNPN_cb(SSL *s,
3429 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003430 void *args)
3431{
3432 PySSLContext *ssl_ctx = (PySSLContext *) args;
3433
3434 if (ssl_ctx->npn_protocols == NULL) {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003435 *data = (unsigned char *)"";
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003436 *len = 0;
3437 } else {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003438 *data = ssl_ctx->npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003439 *len = ssl_ctx->npn_protocols_len;
3440 }
3441
3442 return SSL_TLSEXT_ERR_OK;
3443}
3444/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
3445static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003446_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003447 unsigned char **out, unsigned char *outlen,
3448 const unsigned char *server, unsigned int server_len,
3449 void *args)
3450{
Benjamin Petersoncca27322015-01-23 16:35:37 -05003451 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003452 return do_protocol_selection(0, out, outlen, server, server_len,
Benjamin Petersoncca27322015-01-23 16:35:37 -05003453 ctx->npn_protocols, ctx->npn_protocols_len);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003454}
3455#endif
3456
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003457/*[clinic input]
3458_ssl._SSLContext._set_npn_protocols
3459 protos: Py_buffer
3460 /
3461[clinic start generated code]*/
3462
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003463static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003464_ssl__SSLContext__set_npn_protocols_impl(PySSLContext *self,
3465 Py_buffer *protos)
3466/*[clinic end generated code: output=72b002c3324390c6 input=319fcb66abf95bd7]*/
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003467{
Christian Heimes29eab552018-02-25 12:31:33 +01003468#if HAVE_NPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003469 PyMem_Free(self->npn_protocols);
3470 self->npn_protocols = PyMem_Malloc(protos->len);
3471 if (self->npn_protocols == NULL)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003472 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003473 memcpy(self->npn_protocols, protos->buf, protos->len);
3474 self->npn_protocols_len = (int) protos->len;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003475
3476 /* set both server and client callbacks, because the context can
3477 * be used to create both types of sockets */
3478 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
3479 _advertiseNPN_cb,
3480 self);
3481 SSL_CTX_set_next_proto_select_cb(self->ctx,
3482 _selectNPN_cb,
3483 self);
3484
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003485 Py_RETURN_NONE;
3486#else
3487 PyErr_SetString(PyExc_NotImplementedError,
3488 "The NPN extension requires OpenSSL 1.0.1 or later.");
3489 return NULL;
3490#endif
3491}
3492
Christian Heimes29eab552018-02-25 12:31:33 +01003493#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003494static int
3495_selectALPN_cb(SSL *s,
3496 const unsigned char **out, unsigned char *outlen,
3497 const unsigned char *client_protocols, unsigned int client_protocols_len,
3498 void *args)
3499{
3500 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003501 return do_protocol_selection(1, (unsigned char **)out, outlen,
3502 ctx->alpn_protocols, ctx->alpn_protocols_len,
3503 client_protocols, client_protocols_len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003504}
3505#endif
3506
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003507/*[clinic input]
3508_ssl._SSLContext._set_alpn_protocols
3509 protos: Py_buffer
3510 /
3511[clinic start generated code]*/
3512
Benjamin Petersoncca27322015-01-23 16:35:37 -05003513static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003514_ssl__SSLContext__set_alpn_protocols_impl(PySSLContext *self,
3515 Py_buffer *protos)
3516/*[clinic end generated code: output=87599a7f76651a9b input=9bba964595d519be]*/
Benjamin Petersoncca27322015-01-23 16:35:37 -05003517{
Christian Heimes29eab552018-02-25 12:31:33 +01003518#if HAVE_ALPN
Victor Stinner5a615592017-09-14 01:10:30 -07003519 if ((size_t)protos->len > UINT_MAX) {
Segev Finer5cff6372017-07-27 01:19:17 +03003520 PyErr_Format(PyExc_OverflowError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02003521 "protocols longer than %u bytes", UINT_MAX);
Segev Finer5cff6372017-07-27 01:19:17 +03003522 return NULL;
3523 }
3524
Benjamin Petersoncca27322015-01-23 16:35:37 -05003525 PyMem_FREE(self->alpn_protocols);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003526 self->alpn_protocols = PyMem_Malloc(protos->len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003527 if (!self->alpn_protocols)
3528 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003529 memcpy(self->alpn_protocols, protos->buf, protos->len);
Segev Finer5cff6372017-07-27 01:19:17 +03003530 self->alpn_protocols_len = (unsigned int)protos->len;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003531
3532 if (SSL_CTX_set_alpn_protos(self->ctx, self->alpn_protocols, self->alpn_protocols_len))
3533 return PyErr_NoMemory();
3534 SSL_CTX_set_alpn_select_cb(self->ctx, _selectALPN_cb, self);
3535
Benjamin Petersoncca27322015-01-23 16:35:37 -05003536 Py_RETURN_NONE;
3537#else
3538 PyErr_SetString(PyExc_NotImplementedError,
3539 "The ALPN extension requires OpenSSL 1.0.2 or later.");
3540 return NULL;
3541#endif
3542}
3543
Antoine Pitrou152efa22010-05-16 18:19:27 +00003544static PyObject *
3545get_verify_mode(PySSLContext *self, void *c)
3546{
Christian Heimes9fb051f2018-09-23 08:32:31 +02003547 /* ignore SSL_VERIFY_CLIENT_ONCE and SSL_VERIFY_POST_HANDSHAKE */
3548 int mask = (SSL_VERIFY_NONE | SSL_VERIFY_PEER |
3549 SSL_VERIFY_FAIL_IF_NO_PEER_CERT);
3550 switch (SSL_CTX_get_verify_mode(self->ctx) & mask) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00003551 case SSL_VERIFY_NONE:
3552 return PyLong_FromLong(PY_SSL_CERT_NONE);
3553 case SSL_VERIFY_PEER:
3554 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
3555 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
3556 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
3557 }
3558 PyErr_SetString(PySSLErrorObject,
3559 "invalid return value from SSL_CTX_get_verify_mode");
3560 return NULL;
3561}
3562
3563static int
3564set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
3565{
Christian Heimes5fe668c2016-09-12 00:01:11 +02003566 int n;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003567 if (!PyArg_Parse(arg, "i", &n))
3568 return -1;
Christian Heimes5fe668c2016-09-12 00:01:11 +02003569 if (n == PY_SSL_CERT_NONE && self->check_hostname) {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003570 PyErr_SetString(PyExc_ValueError,
3571 "Cannot set verify_mode to CERT_NONE when "
3572 "check_hostname is enabled.");
3573 return -1;
3574 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003575 return _set_verify_mode(self, n);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003576}
3577
3578static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01003579get_verify_flags(PySSLContext *self, void *c)
3580{
Christian Heimes598894f2016-09-05 23:19:05 +02003581 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003582 unsigned long flags;
3583
Christian Heimes61d478c2018-01-27 15:51:38 +01003584 param = SSL_CTX_get0_param(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02003585 flags = X509_VERIFY_PARAM_get_flags(param);
Christian Heimes22587792013-11-21 23:56:13 +01003586 return PyLong_FromUnsignedLong(flags);
3587}
3588
3589static int
3590set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
3591{
Christian Heimes598894f2016-09-05 23:19:05 +02003592 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003593 unsigned long new_flags, flags, set, clear;
3594
3595 if (!PyArg_Parse(arg, "k", &new_flags))
3596 return -1;
Christian Heimes61d478c2018-01-27 15:51:38 +01003597 param = SSL_CTX_get0_param(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02003598 flags = X509_VERIFY_PARAM_get_flags(param);
Christian Heimes22587792013-11-21 23:56:13 +01003599 clear = flags & ~new_flags;
3600 set = ~flags & new_flags;
3601 if (clear) {
Christian Heimes598894f2016-09-05 23:19:05 +02003602 if (!X509_VERIFY_PARAM_clear_flags(param, clear)) {
Christian Heimes22587792013-11-21 23:56:13 +01003603 _setSSLError(NULL, 0, __FILE__, __LINE__);
3604 return -1;
3605 }
3606 }
3607 if (set) {
Christian Heimes598894f2016-09-05 23:19:05 +02003608 if (!X509_VERIFY_PARAM_set_flags(param, set)) {
Christian Heimes22587792013-11-21 23:56:13 +01003609 _setSSLError(NULL, 0, __FILE__, __LINE__);
3610 return -1;
3611 }
3612 }
3613 return 0;
3614}
3615
Christian Heimes698dde12018-02-27 11:54:43 +01003616/* Getter and setter for protocol version */
3617#if defined(SSL_CTRL_GET_MAX_PROTO_VERSION)
3618
3619
3620static int
3621set_min_max_proto_version(PySSLContext *self, PyObject *arg, int what)
3622{
3623 long v;
3624 int result;
3625
3626 if (!PyArg_Parse(arg, "l", &v))
3627 return -1;
3628 if (v > INT_MAX) {
3629 PyErr_SetString(PyExc_OverflowError, "Option is too long");
3630 return -1;
3631 }
3632
3633 switch(self->protocol) {
3634 case PY_SSL_VERSION_TLS_CLIENT: /* fall through */
3635 case PY_SSL_VERSION_TLS_SERVER: /* fall through */
3636 case PY_SSL_VERSION_TLS:
3637 break;
3638 default:
3639 PyErr_SetString(
3640 PyExc_ValueError,
3641 "The context's protocol doesn't support modification of "
3642 "highest and lowest version."
3643 );
3644 return -1;
3645 }
3646
3647 if (what == 0) {
3648 switch(v) {
3649 case PY_PROTO_MINIMUM_SUPPORTED:
3650 v = 0;
3651 break;
3652 case PY_PROTO_MAXIMUM_SUPPORTED:
3653 /* Emulate max for set_min_proto_version */
3654 v = PY_PROTO_MAXIMUM_AVAILABLE;
3655 break;
3656 default:
3657 break;
3658 }
3659 result = SSL_CTX_set_min_proto_version(self->ctx, v);
3660 }
3661 else {
3662 switch(v) {
3663 case PY_PROTO_MAXIMUM_SUPPORTED:
3664 v = 0;
3665 break;
3666 case PY_PROTO_MINIMUM_SUPPORTED:
3667 /* Emulate max for set_min_proto_version */
3668 v = PY_PROTO_MINIMUM_AVAILABLE;
3669 break;
3670 default:
3671 break;
3672 }
3673 result = SSL_CTX_set_max_proto_version(self->ctx, v);
3674 }
3675 if (result == 0) {
3676 PyErr_Format(PyExc_ValueError,
3677 "Unsupported protocol version 0x%x", v);
3678 return -1;
3679 }
3680 return 0;
3681}
3682
3683static PyObject *
3684get_minimum_version(PySSLContext *self, void *c)
3685{
3686 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL);
3687 if (v == 0) {
3688 v = PY_PROTO_MINIMUM_SUPPORTED;
3689 }
3690 return PyLong_FromLong(v);
3691}
3692
3693static int
3694set_minimum_version(PySSLContext *self, PyObject *arg, void *c)
3695{
3696 return set_min_max_proto_version(self, arg, 0);
3697}
3698
3699static PyObject *
3700get_maximum_version(PySSLContext *self, void *c)
3701{
3702 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL);
3703 if (v == 0) {
3704 v = PY_PROTO_MAXIMUM_SUPPORTED;
3705 }
3706 return PyLong_FromLong(v);
3707}
3708
3709static int
3710set_maximum_version(PySSLContext *self, PyObject *arg, void *c)
3711{
3712 return set_min_max_proto_version(self, arg, 1);
3713}
3714#endif /* SSL_CTRL_GET_MAX_PROTO_VERSION */
3715
Christian Heimes78c7d522019-06-03 21:00:10 +02003716#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
3717static PyObject *
3718get_num_tickets(PySSLContext *self, void *c)
3719{
Victor Stinner76611c72019-07-09 13:30:52 +02003720 return PyLong_FromSize_t(SSL_CTX_get_num_tickets(self->ctx));
Christian Heimes78c7d522019-06-03 21:00:10 +02003721}
3722
3723static int
3724set_num_tickets(PySSLContext *self, PyObject *arg, void *c)
3725{
3726 long num;
3727 if (!PyArg_Parse(arg, "l", &num))
3728 return -1;
3729 if (num < 0) {
3730 PyErr_SetString(PyExc_ValueError, "value must be non-negative");
3731 return -1;
3732 }
3733 if (self->protocol != PY_SSL_VERSION_TLS_SERVER) {
3734 PyErr_SetString(PyExc_ValueError,
3735 "SSLContext is not a server context.");
3736 return -1;
3737 }
3738 if (SSL_CTX_set_num_tickets(self->ctx, num) != 1) {
3739 PyErr_SetString(PyExc_ValueError, "failed to set num tickets.");
3740 return -1;
3741 }
3742 return 0;
3743}
3744
3745PyDoc_STRVAR(PySSLContext_num_tickets_doc,
3746"Control the number of TLSv1.3 session tickets");
3747#endif /* OpenSSL 1.1.1 */
3748
Christian Heimes22587792013-11-21 23:56:13 +01003749static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00003750get_options(PySSLContext *self, void *c)
3751{
3752 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
3753}
3754
3755static int
3756set_options(PySSLContext *self, PyObject *arg, void *c)
3757{
3758 long new_opts, opts, set, clear;
3759 if (!PyArg_Parse(arg, "l", &new_opts))
3760 return -1;
3761 opts = SSL_CTX_get_options(self->ctx);
3762 clear = opts & ~new_opts;
3763 set = ~opts & new_opts;
3764 if (clear) {
3765#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
3766 SSL_CTX_clear_options(self->ctx, clear);
3767#else
3768 PyErr_SetString(PyExc_ValueError,
3769 "can't clear options before OpenSSL 0.9.8m");
3770 return -1;
3771#endif
3772 }
3773 if (set)
3774 SSL_CTX_set_options(self->ctx, set);
3775 return 0;
3776}
3777
Christian Heimes1aa9a752013-12-02 02:41:19 +01003778static PyObject *
Christian Heimes61d478c2018-01-27 15:51:38 +01003779get_host_flags(PySSLContext *self, void *c)
3780{
3781 return PyLong_FromUnsignedLong(self->hostflags);
3782}
3783
3784static int
3785set_host_flags(PySSLContext *self, PyObject *arg, void *c)
3786{
3787 X509_VERIFY_PARAM *param;
3788 unsigned int new_flags = 0;
3789
3790 if (!PyArg_Parse(arg, "I", &new_flags))
3791 return -1;
3792
3793 param = SSL_CTX_get0_param(self->ctx);
3794 self->hostflags = new_flags;
3795 X509_VERIFY_PARAM_set_hostflags(param, new_flags);
3796 return 0;
3797}
3798
3799static PyObject *
Christian Heimes1aa9a752013-12-02 02:41:19 +01003800get_check_hostname(PySSLContext *self, void *c)
3801{
3802 return PyBool_FromLong(self->check_hostname);
3803}
3804
3805static int
3806set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
3807{
3808 int check_hostname;
3809 if (!PyArg_Parse(arg, "p", &check_hostname))
3810 return -1;
3811 if (check_hostname &&
3812 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
Christian Heimese82c0342017-09-15 20:29:57 +02003813 /* check_hostname = True sets verify_mode = CERT_REQUIRED */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003814 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimese82c0342017-09-15 20:29:57 +02003815 return -1;
3816 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01003817 }
3818 self->check_hostname = check_hostname;
3819 return 0;
3820}
3821
Christian Heimes11a14932018-02-24 02:35:08 +01003822static PyObject *
Christian Heimes9fb051f2018-09-23 08:32:31 +02003823get_post_handshake_auth(PySSLContext *self, void *c) {
3824#if TLS1_3_VERSION
3825 return PyBool_FromLong(self->post_handshake_auth);
3826#else
3827 Py_RETURN_NONE;
3828#endif
3829}
3830
3831#if TLS1_3_VERSION
3832static int
3833set_post_handshake_auth(PySSLContext *self, PyObject *arg, void *c) {
Zackery Spytz842acaa2018-12-17 07:52:45 -07003834 if (arg == NULL) {
3835 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
3836 return -1;
3837 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003838 int pha = PyObject_IsTrue(arg);
3839
3840 if (pha == -1) {
3841 return -1;
3842 }
3843 self->post_handshake_auth = pha;
3844
Christian Heimesf0f59302019-07-01 08:29:17 +02003845 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3846 * server sockets and SSL_set_post_handshake_auth() for client. */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003847
3848 return 0;
3849}
3850#endif
3851
3852static PyObject *
Christian Heimes11a14932018-02-24 02:35:08 +01003853get_protocol(PySSLContext *self, void *c) {
3854 return PyLong_FromLong(self->protocol);
3855}
Christian Heimes1aa9a752013-12-02 02:41:19 +01003856
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003857typedef struct {
3858 PyThreadState *thread_state;
3859 PyObject *callable;
3860 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02003861 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003862 int error;
3863} _PySSLPasswordInfo;
3864
3865static int
3866_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
3867 const char *bad_type_error)
3868{
3869 /* Set the password and size fields of a _PySSLPasswordInfo struct
3870 from a unicode, bytes, or byte array object.
3871 The password field will be dynamically allocated and must be freed
3872 by the caller */
3873 PyObject *password_bytes = NULL;
3874 const char *data = NULL;
3875 Py_ssize_t size;
3876
3877 if (PyUnicode_Check(password)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003878 password_bytes = PyUnicode_AsUTF8String(password);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003879 if (!password_bytes) {
3880 goto error;
3881 }
3882 data = PyBytes_AS_STRING(password_bytes);
3883 size = PyBytes_GET_SIZE(password_bytes);
3884 } else if (PyBytes_Check(password)) {
3885 data = PyBytes_AS_STRING(password);
3886 size = PyBytes_GET_SIZE(password);
3887 } else if (PyByteArray_Check(password)) {
3888 data = PyByteArray_AS_STRING(password);
3889 size = PyByteArray_GET_SIZE(password);
3890 } else {
3891 PyErr_SetString(PyExc_TypeError, bad_type_error);
3892 goto error;
3893 }
3894
Victor Stinner9ee02032013-06-23 15:08:23 +02003895 if (size > (Py_ssize_t)INT_MAX) {
3896 PyErr_Format(PyExc_ValueError,
3897 "password cannot be longer than %d bytes", INT_MAX);
3898 goto error;
3899 }
3900
Victor Stinner11ebff22013-07-07 17:07:52 +02003901 PyMem_Free(pw_info->password);
3902 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003903 if (!pw_info->password) {
3904 PyErr_SetString(PyExc_MemoryError,
3905 "unable to allocate password buffer");
3906 goto error;
3907 }
3908 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02003909 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003910
3911 Py_XDECREF(password_bytes);
3912 return 1;
3913
3914error:
3915 Py_XDECREF(password_bytes);
3916 return 0;
3917}
3918
3919static int
3920_password_callback(char *buf, int size, int rwflag, void *userdata)
3921{
3922 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
3923 PyObject *fn_ret = NULL;
3924
3925 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
3926
3927 if (pw_info->callable) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01003928 fn_ret = _PyObject_CallNoArg(pw_info->callable);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003929 if (!fn_ret) {
3930 /* TODO: It would be nice to move _ctypes_add_traceback() into the
3931 core python API, so we could use it to add a frame here */
3932 goto error;
3933 }
3934
3935 if (!_pwinfo_set(pw_info, fn_ret,
3936 "password callback must return a string")) {
3937 goto error;
3938 }
3939 Py_CLEAR(fn_ret);
3940 }
3941
3942 if (pw_info->size > size) {
3943 PyErr_Format(PyExc_ValueError,
3944 "password cannot be longer than %d bytes", size);
3945 goto error;
3946 }
3947
3948 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3949 memcpy(buf, pw_info->password, pw_info->size);
3950 return pw_info->size;
3951
3952error:
3953 Py_XDECREF(fn_ret);
3954 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3955 pw_info->error = 1;
3956 return -1;
3957}
3958
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003959/*[clinic input]
3960_ssl._SSLContext.load_cert_chain
3961 certfile: object
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003962 keyfile: object = None
3963 password: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003964
3965[clinic start generated code]*/
3966
Antoine Pitroub5218772010-05-21 09:56:06 +00003967static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003968_ssl__SSLContext_load_cert_chain_impl(PySSLContext *self, PyObject *certfile,
3969 PyObject *keyfile, PyObject *password)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003970/*[clinic end generated code: output=9480bc1c380e2095 input=30bc7e967ea01a58]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003971{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003972 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Christian Heimes598894f2016-09-05 23:19:05 +02003973 pem_password_cb *orig_passwd_cb = SSL_CTX_get_default_passwd_cb(self->ctx);
3974 void *orig_passwd_userdata = SSL_CTX_get_default_passwd_cb_userdata(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003975 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00003976 int r;
3977
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00003978 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00003979 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003980 if (keyfile == Py_None)
3981 keyfile = NULL;
3982 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003983 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3984 PyErr_SetString(PyExc_TypeError,
3985 "certfile should be a valid filesystem path");
3986 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003987 return NULL;
3988 }
3989 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003990 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3991 PyErr_SetString(PyExc_TypeError,
3992 "keyfile should be a valid filesystem path");
3993 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003994 goto error;
3995 }
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003996 if (password != Py_None) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003997 if (PyCallable_Check(password)) {
3998 pw_info.callable = password;
3999 } else if (!_pwinfo_set(&pw_info, password,
4000 "password should be a string or callable")) {
4001 goto error;
4002 }
4003 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
4004 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
4005 }
4006 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004007 r = SSL_CTX_use_certificate_chain_file(self->ctx,
4008 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004009 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004010 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004011 if (pw_info.error) {
4012 ERR_clear_error();
4013 /* the password callback has already set the error information */
4014 }
4015 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004016 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004017 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004018 }
4019 else {
4020 _setSSLError(NULL, 0, __FILE__, __LINE__);
4021 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004022 goto error;
4023 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004024 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02004025 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00004026 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
4027 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004028 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
4029 Py_CLEAR(keyfile_bytes);
4030 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004031 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004032 if (pw_info.error) {
4033 ERR_clear_error();
4034 /* the password callback has already set the error information */
4035 }
4036 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004037 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004038 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004039 }
4040 else {
4041 _setSSLError(NULL, 0, __FILE__, __LINE__);
4042 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004043 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004044 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004045 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004046 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004047 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004048 if (r != 1) {
4049 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004050 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004051 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004052 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4053 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004054 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004055 Py_RETURN_NONE;
4056
4057error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004058 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4059 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004060 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004061 Py_XDECREF(keyfile_bytes);
4062 Py_XDECREF(certfile_bytes);
4063 return NULL;
4064}
4065
Christian Heimesefff7062013-11-21 03:35:02 +01004066/* internal helper function, returns -1 on error
4067 */
4068static int
Serhiy Storchaka8f87eef2020-04-12 14:58:27 +03004069_add_ca_certs(PySSLContext *self, const void *data, Py_ssize_t len,
Christian Heimesefff7062013-11-21 03:35:02 +01004070 int filetype)
4071{
4072 BIO *biobuf = NULL;
4073 X509_STORE *store;
4074 int retval = 0, err, loaded = 0;
4075
4076 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
4077
4078 if (len <= 0) {
4079 PyErr_SetString(PyExc_ValueError,
4080 "Empty certificate data");
4081 return -1;
4082 } else if (len > INT_MAX) {
4083 PyErr_SetString(PyExc_OverflowError,
4084 "Certificate data is too long.");
4085 return -1;
4086 }
4087
Christian Heimes1dbf61f2013-11-22 00:34:18 +01004088 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01004089 if (biobuf == NULL) {
4090 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
4091 return -1;
4092 }
4093
4094 store = SSL_CTX_get_cert_store(self->ctx);
4095 assert(store != NULL);
4096
4097 while (1) {
4098 X509 *cert = NULL;
4099 int r;
4100
4101 if (filetype == SSL_FILETYPE_ASN1) {
4102 cert = d2i_X509_bio(biobuf, NULL);
4103 } else {
4104 cert = PEM_read_bio_X509(biobuf, NULL,
Christian Heimes598894f2016-09-05 23:19:05 +02004105 SSL_CTX_get_default_passwd_cb(self->ctx),
4106 SSL_CTX_get_default_passwd_cb_userdata(self->ctx)
4107 );
Christian Heimesefff7062013-11-21 03:35:02 +01004108 }
4109 if (cert == NULL) {
4110 break;
4111 }
4112 r = X509_STORE_add_cert(store, cert);
4113 X509_free(cert);
4114 if (!r) {
4115 err = ERR_peek_last_error();
4116 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
4117 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
4118 /* cert already in hash table, not an error */
4119 ERR_clear_error();
4120 } else {
4121 break;
4122 }
4123 }
4124 loaded++;
4125 }
4126
4127 err = ERR_peek_last_error();
4128 if ((filetype == SSL_FILETYPE_ASN1) &&
4129 (loaded > 0) &&
4130 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
4131 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
4132 /* EOF ASN1 file, not an error */
4133 ERR_clear_error();
4134 retval = 0;
4135 } else if ((filetype == SSL_FILETYPE_PEM) &&
4136 (loaded > 0) &&
4137 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
4138 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
4139 /* EOF PEM file, not an error */
4140 ERR_clear_error();
4141 retval = 0;
4142 } else {
4143 _setSSLError(NULL, 0, __FILE__, __LINE__);
4144 retval = -1;
4145 }
4146
4147 BIO_free(biobuf);
4148 return retval;
4149}
4150
4151
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004152/*[clinic input]
4153_ssl._SSLContext.load_verify_locations
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004154 cafile: object = None
4155 capath: object = None
4156 cadata: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004157
4158[clinic start generated code]*/
4159
Antoine Pitrou152efa22010-05-16 18:19:27 +00004160static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004161_ssl__SSLContext_load_verify_locations_impl(PySSLContext *self,
4162 PyObject *cafile,
4163 PyObject *capath,
4164 PyObject *cadata)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004165/*[clinic end generated code: output=454c7e41230ca551 input=42ecfe258233e194]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004166{
Antoine Pitrou152efa22010-05-16 18:19:27 +00004167 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
4168 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004169 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004170
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004171 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004172 if (cafile == Py_None)
4173 cafile = NULL;
4174 if (capath == Py_None)
4175 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004176 if (cadata == Py_None)
4177 cadata = NULL;
4178
4179 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004180 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01004181 "cafile, capath and cadata cannot be all omitted");
4182 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004183 }
4184 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004185 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4186 PyErr_SetString(PyExc_TypeError,
4187 "cafile should be a valid filesystem path");
4188 }
Christian Heimesefff7062013-11-21 03:35:02 +01004189 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004190 }
4191 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004192 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4193 PyErr_SetString(PyExc_TypeError,
4194 "capath should be a valid filesystem path");
4195 }
Christian Heimesefff7062013-11-21 03:35:02 +01004196 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004197 }
Christian Heimesefff7062013-11-21 03:35:02 +01004198
4199 /* validata cadata type and load cadata */
4200 if (cadata) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004201 if (PyUnicode_Check(cadata)) {
4202 PyObject *cadata_ascii = PyUnicode_AsASCIIString(cadata);
4203 if (cadata_ascii == NULL) {
4204 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
4205 goto invalid_cadata;
4206 }
4207 goto error;
4208 }
4209 r = _add_ca_certs(self,
4210 PyBytes_AS_STRING(cadata_ascii),
4211 PyBytes_GET_SIZE(cadata_ascii),
4212 SSL_FILETYPE_PEM);
4213 Py_DECREF(cadata_ascii);
4214 if (r == -1) {
4215 goto error;
4216 }
4217 }
4218 else if (PyObject_CheckBuffer(cadata)) {
4219 Py_buffer buf;
4220 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE)) {
4221 goto error;
4222 }
Christian Heimesefff7062013-11-21 03:35:02 +01004223 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
4224 PyBuffer_Release(&buf);
4225 PyErr_SetString(PyExc_TypeError,
4226 "cadata should be a contiguous buffer with "
4227 "a single dimension");
4228 goto error;
4229 }
4230 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
4231 PyBuffer_Release(&buf);
4232 if (r == -1) {
4233 goto error;
4234 }
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004235 }
4236 else {
4237 invalid_cadata:
4238 PyErr_SetString(PyExc_TypeError,
4239 "cadata should be an ASCII string or a "
4240 "bytes-like object");
4241 goto error;
Christian Heimesefff7062013-11-21 03:35:02 +01004242 }
4243 }
4244
4245 /* load cafile or capath */
4246 if (cafile || capath) {
4247 if (cafile)
4248 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
4249 if (capath)
4250 capath_buf = PyBytes_AS_STRING(capath_bytes);
4251 PySSL_BEGIN_ALLOW_THREADS
4252 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
4253 PySSL_END_ALLOW_THREADS
4254 if (r != 1) {
Christian Heimesefff7062013-11-21 03:35:02 +01004255 if (errno != 0) {
4256 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004257 PyErr_SetFromErrno(PyExc_OSError);
Christian Heimesefff7062013-11-21 03:35:02 +01004258 }
4259 else {
4260 _setSSLError(NULL, 0, __FILE__, __LINE__);
4261 }
4262 goto error;
4263 }
4264 }
4265 goto end;
4266
4267 error:
4268 ok = 0;
4269 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00004270 Py_XDECREF(cafile_bytes);
4271 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01004272 if (ok) {
4273 Py_RETURN_NONE;
4274 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004275 return NULL;
4276 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004277}
4278
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004279/*[clinic input]
4280_ssl._SSLContext.load_dh_params
4281 path as filepath: object
4282 /
4283
4284[clinic start generated code]*/
4285
Antoine Pitrou152efa22010-05-16 18:19:27 +00004286static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004287_ssl__SSLContext_load_dh_params(PySSLContext *self, PyObject *filepath)
4288/*[clinic end generated code: output=1c8e57a38e055af0 input=c8871f3c796ae1d6]*/
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004289{
4290 FILE *f;
4291 DH *dh;
4292
Victor Stinnerdaf45552013-08-28 00:53:59 +02004293 f = _Py_fopen_obj(filepath, "rb");
Victor Stinnere42ccd22015-03-18 01:39:23 +01004294 if (f == NULL)
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004295 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01004296
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004297 errno = 0;
4298 PySSL_BEGIN_ALLOW_THREADS
4299 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01004300 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004301 PySSL_END_ALLOW_THREADS
4302 if (dh == NULL) {
4303 if (errno != 0) {
4304 ERR_clear_error();
4305 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
4306 }
4307 else {
4308 _setSSLError(NULL, 0, __FILE__, __LINE__);
4309 }
4310 return NULL;
4311 }
4312 if (SSL_CTX_set_tmp_dh(self->ctx, dh) == 0)
4313 _setSSLError(NULL, 0, __FILE__, __LINE__);
4314 DH_free(dh);
4315 Py_RETURN_NONE;
4316}
4317
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004318/*[clinic input]
4319_ssl._SSLContext._wrap_socket
4320 sock: object(subclass_of="PySocketModule.Sock_Type")
4321 server_side: int
4322 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004323 *
4324 owner: object = None
4325 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004326
4327[clinic start generated code]*/
4328
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004329static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004330_ssl__SSLContext__wrap_socket_impl(PySSLContext *self, PyObject *sock,
Christian Heimes141c5e82018-02-24 21:10:57 +01004331 int server_side, PyObject *hostname_obj,
4332 PyObject *owner, PyObject *session)
4333/*[clinic end generated code: output=f103f238633940b4 input=957d5006183d1894]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004334{
Antoine Pitroud5323212010-10-22 18:19:07 +00004335 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004336 PyObject *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004337
Antoine Pitroud5323212010-10-22 18:19:07 +00004338 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004339 as IDN A-label (ASCII str) without NULL bytes. */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004340 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004341 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroud5323212010-10-22 18:19:07 +00004342 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00004343 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004344
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004345 res = (PyObject *) newPySSLSocket(self, (PySocketSockObject *)sock,
4346 server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004347 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004348 NULL, NULL);
Antoine Pitroud5323212010-10-22 18:19:07 +00004349 if (hostname != NULL)
4350 PyMem_Free(hostname);
4351 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004352}
4353
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004354/*[clinic input]
4355_ssl._SSLContext._wrap_bio
4356 incoming: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
4357 outgoing: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
4358 server_side: int
4359 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004360 *
4361 owner: object = None
4362 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004363
4364[clinic start generated code]*/
4365
Antoine Pitroub0182c82010-10-12 20:09:02 +00004366static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004367_ssl__SSLContext__wrap_bio_impl(PySSLContext *self, PySSLMemoryBIO *incoming,
4368 PySSLMemoryBIO *outgoing, int server_side,
Christian Heimes141c5e82018-02-24 21:10:57 +01004369 PyObject *hostname_obj, PyObject *owner,
4370 PyObject *session)
4371/*[clinic end generated code: output=5c5d6d9b41f99332 input=8cf22f4d586ac56a]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004372{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004373 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004374 PyObject *res;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004375
4376 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004377 as IDN A-label (ASCII str) without NULL bytes. */
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004378 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004379 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004380 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004381 }
4382
4383 res = (PyObject *) newPySSLSocket(self, NULL, server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004384 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004385 incoming, outgoing);
4386
4387 PyMem_Free(hostname);
4388 return res;
4389}
4390
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004391/*[clinic input]
4392_ssl._SSLContext.session_stats
4393[clinic start generated code]*/
4394
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004395static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004396_ssl__SSLContext_session_stats_impl(PySSLContext *self)
4397/*[clinic end generated code: output=0d96411c42893bfb input=7e0a81fb11102c8b]*/
Antoine Pitroub0182c82010-10-12 20:09:02 +00004398{
4399 int r;
4400 PyObject *value, *stats = PyDict_New();
4401 if (!stats)
4402 return NULL;
4403
4404#define ADD_STATS(SSL_NAME, KEY_NAME) \
4405 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
4406 if (value == NULL) \
4407 goto error; \
4408 r = PyDict_SetItemString(stats, KEY_NAME, value); \
4409 Py_DECREF(value); \
4410 if (r < 0) \
4411 goto error;
4412
4413 ADD_STATS(number, "number");
4414 ADD_STATS(connect, "connect");
4415 ADD_STATS(connect_good, "connect_good");
4416 ADD_STATS(connect_renegotiate, "connect_renegotiate");
4417 ADD_STATS(accept, "accept");
4418 ADD_STATS(accept_good, "accept_good");
4419 ADD_STATS(accept_renegotiate, "accept_renegotiate");
4420 ADD_STATS(accept, "accept");
4421 ADD_STATS(hits, "hits");
4422 ADD_STATS(misses, "misses");
4423 ADD_STATS(timeouts, "timeouts");
4424 ADD_STATS(cache_full, "cache_full");
4425
4426#undef ADD_STATS
4427
4428 return stats;
4429
4430error:
4431 Py_DECREF(stats);
4432 return NULL;
4433}
4434
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004435/*[clinic input]
4436_ssl._SSLContext.set_default_verify_paths
4437[clinic start generated code]*/
4438
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004439static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004440_ssl__SSLContext_set_default_verify_paths_impl(PySSLContext *self)
4441/*[clinic end generated code: output=0bee74e6e09deaaa input=35f3408021463d74]*/
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004442{
4443 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
4444 _setSSLError(NULL, 0, __FILE__, __LINE__);
4445 return NULL;
4446 }
4447 Py_RETURN_NONE;
4448}
4449
Antoine Pitrou501da612011-12-21 09:27:41 +01004450#ifndef OPENSSL_NO_ECDH
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004451/*[clinic input]
4452_ssl._SSLContext.set_ecdh_curve
4453 name: object
4454 /
4455
4456[clinic start generated code]*/
4457
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004458static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004459_ssl__SSLContext_set_ecdh_curve(PySSLContext *self, PyObject *name)
4460/*[clinic end generated code: output=23022c196e40d7d2 input=c2bafb6f6e34726b]*/
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004461{
4462 PyObject *name_bytes;
4463 int nid;
4464 EC_KEY *key;
4465
4466 if (!PyUnicode_FSConverter(name, &name_bytes))
4467 return NULL;
4468 assert(PyBytes_Check(name_bytes));
4469 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
4470 Py_DECREF(name_bytes);
4471 if (nid == 0) {
4472 PyErr_Format(PyExc_ValueError,
4473 "unknown elliptic curve name %R", name);
4474 return NULL;
4475 }
4476 key = EC_KEY_new_by_curve_name(nid);
4477 if (key == NULL) {
4478 _setSSLError(NULL, 0, __FILE__, __LINE__);
4479 return NULL;
4480 }
4481 SSL_CTX_set_tmp_ecdh(self->ctx, key);
4482 EC_KEY_free(key);
4483 Py_RETURN_NONE;
4484}
Antoine Pitrou501da612011-12-21 09:27:41 +01004485#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004486
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004487#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004488static int
4489_servername_callback(SSL *s, int *al, void *args)
4490{
4491 int ret;
4492 PySSLContext *ssl_ctx = (PySSLContext *) args;
4493 PySSLSocket *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004494 PyObject *result;
4495 /* The high-level ssl.SSLSocket object */
4496 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004497 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01004498 PyGILState_STATE gstate = PyGILState_Ensure();
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004499
Christian Heimes11a14932018-02-24 02:35:08 +01004500 if (ssl_ctx->set_sni_cb == NULL) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004501 /* remove race condition in this the call back while if removing the
4502 * callback is in progress */
4503 PyGILState_Release(gstate);
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01004504 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004505 }
4506
4507 ssl = SSL_get_app_data(s);
4508 assert(PySSLSocket_Check(ssl));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004509
Serhiy Storchakaf51d7152015-11-02 14:40:41 +02004510 /* The servername callback expects an argument that represents the current
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004511 * SSL connection and that has a .context attribute that can be changed to
4512 * identify the requested hostname. Since the official API is the Python
4513 * level API we want to pass the callback a Python level object rather than
4514 * a _ssl.SSLSocket instance. If there's an "owner" (typically an
4515 * SSLObject) that will be passed. Otherwise if there's a socket then that
4516 * will be passed. If both do not exist only then the C-level object is
4517 * passed. */
4518 if (ssl->owner)
4519 ssl_socket = PyWeakref_GetObject(ssl->owner);
4520 else if (ssl->Socket)
4521 ssl_socket = PyWeakref_GetObject(ssl->Socket);
4522 else
4523 ssl_socket = (PyObject *) ssl;
4524
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004525 Py_INCREF(ssl_socket);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004526 if (ssl_socket == Py_None)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004527 goto error;
Victor Stinner7e001512013-06-25 00:44:31 +02004528
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004529 if (servername == NULL) {
Christian Heimes11a14932018-02-24 02:35:08 +01004530 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_sni_cb, ssl_socket,
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004531 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004532 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004533 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004534 PyObject *servername_bytes;
4535 PyObject *servername_str;
4536
4537 servername_bytes = PyBytes_FromString(servername);
4538 if (servername_bytes == NULL) {
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004539 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
4540 goto error;
4541 }
Christian Heimes11a14932018-02-24 02:35:08 +01004542 /* server_hostname was encoded to an A-label by our caller; put it
4543 * back into a str object, but still as an A-label (bpo-28414)
4544 */
4545 servername_str = PyUnicode_FromEncodedObject(servername_bytes, "ascii", NULL);
4546 Py_DECREF(servername_bytes);
4547 if (servername_str == NULL) {
4548 PyErr_WriteUnraisable(servername_bytes);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004549 goto error;
4550 }
Christian Heimes11a14932018-02-24 02:35:08 +01004551 result = PyObject_CallFunctionObjArgs(
4552 ssl_ctx->set_sni_cb, ssl_socket, servername_str,
4553 ssl_ctx, NULL);
4554 Py_DECREF(servername_str);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004555 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004556 Py_DECREF(ssl_socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004557
4558 if (result == NULL) {
Christian Heimes11a14932018-02-24 02:35:08 +01004559 PyErr_WriteUnraisable(ssl_ctx->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004560 *al = SSL_AD_HANDSHAKE_FAILURE;
4561 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4562 }
4563 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004564 /* Result may be None, a SSLContext or an integer
4565 * None and SSLContext are OK, integer or other values are an error.
4566 */
4567 if (result == Py_None) {
4568 ret = SSL_TLSEXT_ERR_OK;
4569 } else {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004570 *al = (int) PyLong_AsLong(result);
4571 if (PyErr_Occurred()) {
4572 PyErr_WriteUnraisable(result);
4573 *al = SSL_AD_INTERNAL_ERROR;
4574 }
4575 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4576 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004577 Py_DECREF(result);
4578 }
4579
4580 PyGILState_Release(gstate);
4581 return ret;
4582
4583error:
4584 Py_DECREF(ssl_socket);
4585 *al = SSL_AD_INTERNAL_ERROR;
4586 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4587 PyGILState_Release(gstate);
4588 return ret;
4589}
Antoine Pitroua5963382013-03-30 16:39:00 +01004590#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004591
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004592static PyObject *
Christian Heimes11a14932018-02-24 02:35:08 +01004593get_sni_callback(PySSLContext *self, void *c)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004594{
Christian Heimes11a14932018-02-24 02:35:08 +01004595 PyObject *cb = self->set_sni_cb;
4596 if (cb == NULL) {
4597 Py_RETURN_NONE;
4598 }
4599 Py_INCREF(cb);
4600 return cb;
4601}
4602
4603static int
4604set_sni_callback(PySSLContext *self, PyObject *arg, void *c)
4605{
4606 if (self->protocol == PY_SSL_VERSION_TLS_CLIENT) {
4607 PyErr_SetString(PyExc_ValueError,
4608 "sni_callback cannot be set on TLS_CLIENT context");
4609 return -1;
4610 }
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004611#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Christian Heimes11a14932018-02-24 02:35:08 +01004612 Py_CLEAR(self->set_sni_cb);
4613 if (arg == Py_None) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004614 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
4615 }
4616 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004617 if (!PyCallable_Check(arg)) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004618 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
4619 PyErr_SetString(PyExc_TypeError,
4620 "not a callable object");
Christian Heimes11a14932018-02-24 02:35:08 +01004621 return -1;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004622 }
Christian Heimes11a14932018-02-24 02:35:08 +01004623 Py_INCREF(arg);
4624 self->set_sni_cb = arg;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004625 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
4626 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
4627 }
Christian Heimes11a14932018-02-24 02:35:08 +01004628 return 0;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004629#else
4630 PyErr_SetString(PyExc_NotImplementedError,
4631 "The TLS extension servername callback, "
4632 "SSL_CTX_set_tlsext_servername_callback, "
4633 "is not in the current OpenSSL library.");
Christian Heimes11a14932018-02-24 02:35:08 +01004634 return -1;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004635#endif
4636}
4637
Christian Heimes11a14932018-02-24 02:35:08 +01004638PyDoc_STRVAR(PySSLContext_sni_callback_doc,
4639"Set a callback that will be called when a server name is provided by the SSL/TLS client in the SNI extension.\n\
4640\n\
4641If the argument is None then the callback is disabled. The method is called\n\
4642with the SSLSocket, the server name as a string, and the SSLContext object.\n\
4643See RFC 6066 for details of the SNI extension.");
4644
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004645/*[clinic input]
4646_ssl._SSLContext.cert_store_stats
4647
4648Returns quantities of loaded X.509 certificates.
4649
4650X.509 certificates with a CA extension and certificate revocation lists
4651inside the context's cert store.
4652
4653NOTE: Certificates in a capath directory aren't loaded unless they have
4654been used at least once.
4655[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004656
4657static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004658_ssl__SSLContext_cert_store_stats_impl(PySSLContext *self)
4659/*[clinic end generated code: output=5f356f4d9cca874d input=eb40dd0f6d0e40cf]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004660{
4661 X509_STORE *store;
Christian Heimes598894f2016-09-05 23:19:05 +02004662 STACK_OF(X509_OBJECT) *objs;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004663 X509_OBJECT *obj;
Christian Heimes598894f2016-09-05 23:19:05 +02004664 int x509 = 0, crl = 0, ca = 0, i;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004665
4666 store = SSL_CTX_get_cert_store(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02004667 objs = X509_STORE_get0_objects(store);
4668 for (i = 0; i < sk_X509_OBJECT_num(objs); i++) {
4669 obj = sk_X509_OBJECT_value(objs, i);
4670 switch (X509_OBJECT_get_type(obj)) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004671 case X509_LU_X509:
4672 x509++;
Christian Heimes598894f2016-09-05 23:19:05 +02004673 if (X509_check_ca(X509_OBJECT_get0_X509(obj))) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004674 ca++;
4675 }
4676 break;
4677 case X509_LU_CRL:
4678 crl++;
4679 break;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004680 default:
4681 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
4682 * As far as I can tell they are internal states and never
4683 * stored in a cert store */
4684 break;
4685 }
4686 }
4687 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
4688 "x509_ca", ca);
4689}
4690
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004691/*[clinic input]
4692_ssl._SSLContext.get_ca_certs
4693 binary_form: bool = False
4694
4695Returns a list of dicts with information of loaded CA certs.
4696
4697If the optional argument is True, returns a DER-encoded copy of the CA
4698certificate.
4699
4700NOTE: Certificates in a capath directory aren't loaded unless they have
4701been used at least once.
4702[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004703
4704static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004705_ssl__SSLContext_get_ca_certs_impl(PySSLContext *self, int binary_form)
4706/*[clinic end generated code: output=0d58f148f37e2938 input=6887b5a09b7f9076]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004707{
4708 X509_STORE *store;
Christian Heimes598894f2016-09-05 23:19:05 +02004709 STACK_OF(X509_OBJECT) *objs;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004710 PyObject *ci = NULL, *rlist = NULL;
4711 int i;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004712
4713 if ((rlist = PyList_New(0)) == NULL) {
4714 return NULL;
4715 }
4716
4717 store = SSL_CTX_get_cert_store(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02004718 objs = X509_STORE_get0_objects(store);
4719 for (i = 0; i < sk_X509_OBJECT_num(objs); i++) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004720 X509_OBJECT *obj;
4721 X509 *cert;
4722
Christian Heimes598894f2016-09-05 23:19:05 +02004723 obj = sk_X509_OBJECT_value(objs, i);
4724 if (X509_OBJECT_get_type(obj) != X509_LU_X509) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004725 /* not a x509 cert */
4726 continue;
4727 }
4728 /* CA for any purpose */
Christian Heimes598894f2016-09-05 23:19:05 +02004729 cert = X509_OBJECT_get0_X509(obj);
Christian Heimes9a5395a2013-06-17 15:44:12 +02004730 if (!X509_check_ca(cert)) {
4731 continue;
4732 }
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004733 if (binary_form) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004734 ci = _certificate_to_der(cert);
4735 } else {
4736 ci = _decode_certificate(cert);
4737 }
4738 if (ci == NULL) {
4739 goto error;
4740 }
4741 if (PyList_Append(rlist, ci) == -1) {
4742 goto error;
4743 }
4744 Py_CLEAR(ci);
4745 }
4746 return rlist;
4747
4748 error:
4749 Py_XDECREF(ci);
4750 Py_XDECREF(rlist);
4751 return NULL;
4752}
4753
4754
Antoine Pitrou152efa22010-05-16 18:19:27 +00004755static PyGetSetDef context_getsetlist[] = {
Christian Heimes1aa9a752013-12-02 02:41:19 +01004756 {"check_hostname", (getter) get_check_hostname,
4757 (setter) set_check_hostname, NULL},
Christian Heimes61d478c2018-01-27 15:51:38 +01004758 {"_host_flags", (getter) get_host_flags,
4759 (setter) set_host_flags, NULL},
Christian Heimes698dde12018-02-27 11:54:43 +01004760#if SSL_CTRL_GET_MAX_PROTO_VERSION
4761 {"minimum_version", (getter) get_minimum_version,
4762 (setter) set_minimum_version, NULL},
4763 {"maximum_version", (getter) get_maximum_version,
4764 (setter) set_maximum_version, NULL},
4765#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02004766#ifdef HAVE_OPENSSL_KEYLOG
4767 {"keylog_filename", (getter) _PySSLContext_get_keylog_filename,
4768 (setter) _PySSLContext_set_keylog_filename, NULL},
4769#endif
4770 {"_msg_callback", (getter) _PySSLContext_get_msg_callback,
4771 (setter) _PySSLContext_set_msg_callback, NULL},
Christian Heimes11a14932018-02-24 02:35:08 +01004772 {"sni_callback", (getter) get_sni_callback,
Christian Heimes698dde12018-02-27 11:54:43 +01004773 (setter) set_sni_callback, PySSLContext_sni_callback_doc},
Christian Heimes78c7d522019-06-03 21:00:10 +02004774#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
4775 {"num_tickets", (getter) get_num_tickets,
4776 (setter) set_num_tickets, PySSLContext_num_tickets_doc},
4777#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00004778 {"options", (getter) get_options,
4779 (setter) set_options, NULL},
Christian Heimes9fb051f2018-09-23 08:32:31 +02004780 {"post_handshake_auth", (getter) get_post_handshake_auth,
4781#ifdef TLS1_3_VERSION
4782 (setter) set_post_handshake_auth,
4783#else
4784 NULL,
4785#endif
4786 NULL},
Christian Heimes11a14932018-02-24 02:35:08 +01004787 {"protocol", (getter) get_protocol,
4788 NULL, NULL},
Christian Heimes22587792013-11-21 23:56:13 +01004789 {"verify_flags", (getter) get_verify_flags,
4790 (setter) set_verify_flags, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00004791 {"verify_mode", (getter) get_verify_mode,
4792 (setter) set_verify_mode, NULL},
4793 {NULL}, /* sentinel */
4794};
4795
4796static struct PyMethodDef context_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004797 _SSL__SSLCONTEXT__WRAP_SOCKET_METHODDEF
4798 _SSL__SSLCONTEXT__WRAP_BIO_METHODDEF
4799 _SSL__SSLCONTEXT_SET_CIPHERS_METHODDEF
4800 _SSL__SSLCONTEXT__SET_ALPN_PROTOCOLS_METHODDEF
4801 _SSL__SSLCONTEXT__SET_NPN_PROTOCOLS_METHODDEF
4802 _SSL__SSLCONTEXT_LOAD_CERT_CHAIN_METHODDEF
4803 _SSL__SSLCONTEXT_LOAD_DH_PARAMS_METHODDEF
4804 _SSL__SSLCONTEXT_LOAD_VERIFY_LOCATIONS_METHODDEF
4805 _SSL__SSLCONTEXT_SESSION_STATS_METHODDEF
4806 _SSL__SSLCONTEXT_SET_DEFAULT_VERIFY_PATHS_METHODDEF
4807 _SSL__SSLCONTEXT_SET_ECDH_CURVE_METHODDEF
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004808 _SSL__SSLCONTEXT_CERT_STORE_STATS_METHODDEF
4809 _SSL__SSLCONTEXT_GET_CA_CERTS_METHODDEF
Christian Heimes25bfcd52016-09-06 00:04:45 +02004810 _SSL__SSLCONTEXT_GET_CIPHERS_METHODDEF
Antoine Pitrou152efa22010-05-16 18:19:27 +00004811 {NULL, NULL} /* sentinel */
4812};
4813
4814static PyTypeObject PySSLContext_Type = {
4815 PyVarObject_HEAD_INIT(NULL, 0)
4816 "_ssl._SSLContext", /*tp_name*/
4817 sizeof(PySSLContext), /*tp_basicsize*/
4818 0, /*tp_itemsize*/
4819 (destructor)context_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004820 0, /*tp_vectorcall_offset*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004821 0, /*tp_getattr*/
4822 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004823 0, /*tp_as_async*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004824 0, /*tp_repr*/
4825 0, /*tp_as_number*/
4826 0, /*tp_as_sequence*/
4827 0, /*tp_as_mapping*/
4828 0, /*tp_hash*/
4829 0, /*tp_call*/
4830 0, /*tp_str*/
4831 0, /*tp_getattro*/
4832 0, /*tp_setattro*/
4833 0, /*tp_as_buffer*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004834 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004835 0, /*tp_doc*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004836 (traverseproc) context_traverse, /*tp_traverse*/
4837 (inquiry) context_clear, /*tp_clear*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004838 0, /*tp_richcompare*/
4839 0, /*tp_weaklistoffset*/
4840 0, /*tp_iter*/
4841 0, /*tp_iternext*/
4842 context_methods, /*tp_methods*/
4843 0, /*tp_members*/
4844 context_getsetlist, /*tp_getset*/
4845 0, /*tp_base*/
4846 0, /*tp_dict*/
4847 0, /*tp_descr_get*/
4848 0, /*tp_descr_set*/
4849 0, /*tp_dictoffset*/
4850 0, /*tp_init*/
4851 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004852 _ssl__SSLContext, /*tp_new*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004853};
4854
4855
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004856/*
4857 * MemoryBIO objects
4858 */
4859
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004860/*[clinic input]
4861@classmethod
4862_ssl.MemoryBIO.__new__
4863
4864[clinic start generated code]*/
4865
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004866static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004867_ssl_MemoryBIO_impl(PyTypeObject *type)
4868/*[clinic end generated code: output=8820a58db78330ac input=26d22e4909ecb1b5]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004869{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004870 BIO *bio;
4871 PySSLMemoryBIO *self;
4872
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004873 bio = BIO_new(BIO_s_mem());
4874 if (bio == NULL) {
4875 PyErr_SetString(PySSLErrorObject,
4876 "failed to allocate BIO");
4877 return NULL;
4878 }
4879 /* Since our BIO is non-blocking an empty read() does not indicate EOF,
4880 * just that no data is currently available. The SSL routines should retry
4881 * the read, which we can achieve by calling BIO_set_retry_read(). */
4882 BIO_set_retry_read(bio);
4883 BIO_set_mem_eof_return(bio, -1);
4884
4885 assert(type != NULL && type->tp_alloc != NULL);
4886 self = (PySSLMemoryBIO *) type->tp_alloc(type, 0);
4887 if (self == NULL) {
4888 BIO_free(bio);
4889 return NULL;
4890 }
4891 self->bio = bio;
4892 self->eof_written = 0;
4893
4894 return (PyObject *) self;
4895}
4896
4897static void
4898memory_bio_dealloc(PySSLMemoryBIO *self)
4899{
4900 BIO_free(self->bio);
4901 Py_TYPE(self)->tp_free(self);
4902}
4903
4904static PyObject *
4905memory_bio_get_pending(PySSLMemoryBIO *self, void *c)
4906{
Segev Finer5cff6372017-07-27 01:19:17 +03004907 return PyLong_FromSize_t(BIO_ctrl_pending(self->bio));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004908}
4909
4910PyDoc_STRVAR(PySSL_memory_bio_pending_doc,
4911"The number of bytes pending in the memory BIO.");
4912
4913static PyObject *
4914memory_bio_get_eof(PySSLMemoryBIO *self, void *c)
4915{
4916 return PyBool_FromLong((BIO_ctrl_pending(self->bio) == 0)
4917 && self->eof_written);
4918}
4919
4920PyDoc_STRVAR(PySSL_memory_bio_eof_doc,
4921"Whether the memory BIO is at EOF.");
4922
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004923/*[clinic input]
4924_ssl.MemoryBIO.read
4925 size as len: int = -1
4926 /
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004927
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004928Read up to size bytes from the memory BIO.
4929
4930If size is not specified, read the entire buffer.
4931If the return value is an empty bytes instance, this means either
4932EOF or that no data is available. Use the "eof" property to
4933distinguish between the two.
4934[clinic start generated code]*/
4935
4936static PyObject *
4937_ssl_MemoryBIO_read_impl(PySSLMemoryBIO *self, int len)
4938/*[clinic end generated code: output=a657aa1e79cd01b3 input=574d7be06a902366]*/
4939{
4940 int avail, nbytes;
4941 PyObject *result;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004942
Segev Finer5cff6372017-07-27 01:19:17 +03004943 avail = (int)Py_MIN(BIO_ctrl_pending(self->bio), INT_MAX);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004944 if ((len < 0) || (len > avail))
4945 len = avail;
4946
4947 result = PyBytes_FromStringAndSize(NULL, len);
4948 if ((result == NULL) || (len == 0))
4949 return result;
4950
4951 nbytes = BIO_read(self->bio, PyBytes_AS_STRING(result), len);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004952 if (nbytes < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004953 Py_DECREF(result);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004954 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004955 return NULL;
4956 }
4957
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004958 /* There should never be any short reads but check anyway. */
4959 if (nbytes < len) {
4960 _PyBytes_Resize(&result, nbytes);
4961 }
4962
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004963 return result;
4964}
4965
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004966/*[clinic input]
4967_ssl.MemoryBIO.write
4968 b: Py_buffer
4969 /
4970
4971Writes the bytes b into the memory BIO.
4972
4973Returns the number of bytes written.
4974[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004975
4976static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004977_ssl_MemoryBIO_write_impl(PySSLMemoryBIO *self, Py_buffer *b)
4978/*[clinic end generated code: output=156ec59110d75935 input=e45757b3e17c4808]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004979{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004980 int nbytes;
4981
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004982 if (b->len > INT_MAX) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004983 PyErr_Format(PyExc_OverflowError,
4984 "string longer than %d bytes", INT_MAX);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004985 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004986 }
4987
4988 if (self->eof_written) {
4989 PyErr_SetString(PySSLErrorObject,
4990 "cannot write() after write_eof()");
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004991 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004992 }
4993
Segev Finer5cff6372017-07-27 01:19:17 +03004994 nbytes = BIO_write(self->bio, b->buf, (int)b->len);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004995 if (nbytes < 0) {
4996 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004997 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004998 }
4999
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005000 return PyLong_FromLong(nbytes);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005001}
5002
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005003/*[clinic input]
5004_ssl.MemoryBIO.write_eof
5005
5006Write an EOF marker to the memory BIO.
5007
5008When all data has been read, the "eof" property will be True.
5009[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005010
5011static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005012_ssl_MemoryBIO_write_eof_impl(PySSLMemoryBIO *self)
5013/*[clinic end generated code: output=d4106276ccd1ed34 input=56a945f1d29e8bd6]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005014{
5015 self->eof_written = 1;
5016 /* After an EOF is written, a zero return from read() should be a real EOF
5017 * i.e. it should not be retried. Clear the SHOULD_RETRY flag. */
5018 BIO_clear_retry_flags(self->bio);
5019 BIO_set_mem_eof_return(self->bio, 0);
5020
5021 Py_RETURN_NONE;
5022}
5023
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005024static PyGetSetDef memory_bio_getsetlist[] = {
5025 {"pending", (getter) memory_bio_get_pending, NULL,
5026 PySSL_memory_bio_pending_doc},
5027 {"eof", (getter) memory_bio_get_eof, NULL,
5028 PySSL_memory_bio_eof_doc},
5029 {NULL}, /* sentinel */
5030};
5031
5032static struct PyMethodDef memory_bio_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005033 _SSL_MEMORYBIO_READ_METHODDEF
5034 _SSL_MEMORYBIO_WRITE_METHODDEF
5035 _SSL_MEMORYBIO_WRITE_EOF_METHODDEF
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005036 {NULL, NULL} /* sentinel */
5037};
5038
5039static PyTypeObject PySSLMemoryBIO_Type = {
5040 PyVarObject_HEAD_INIT(NULL, 0)
5041 "_ssl.MemoryBIO", /*tp_name*/
5042 sizeof(PySSLMemoryBIO), /*tp_basicsize*/
5043 0, /*tp_itemsize*/
5044 (destructor)memory_bio_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005045 0, /*tp_vectorcall_offset*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005046 0, /*tp_getattr*/
5047 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005048 0, /*tp_as_async*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005049 0, /*tp_repr*/
5050 0, /*tp_as_number*/
5051 0, /*tp_as_sequence*/
5052 0, /*tp_as_mapping*/
5053 0, /*tp_hash*/
5054 0, /*tp_call*/
5055 0, /*tp_str*/
5056 0, /*tp_getattro*/
5057 0, /*tp_setattro*/
5058 0, /*tp_as_buffer*/
5059 Py_TPFLAGS_DEFAULT, /*tp_flags*/
5060 0, /*tp_doc*/
5061 0, /*tp_traverse*/
5062 0, /*tp_clear*/
5063 0, /*tp_richcompare*/
5064 0, /*tp_weaklistoffset*/
5065 0, /*tp_iter*/
5066 0, /*tp_iternext*/
5067 memory_bio_methods, /*tp_methods*/
5068 0, /*tp_members*/
5069 memory_bio_getsetlist, /*tp_getset*/
5070 0, /*tp_base*/
5071 0, /*tp_dict*/
5072 0, /*tp_descr_get*/
5073 0, /*tp_descr_set*/
5074 0, /*tp_dictoffset*/
5075 0, /*tp_init*/
5076 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005077 _ssl_MemoryBIO, /*tp_new*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005078};
5079
Antoine Pitrou152efa22010-05-16 18:19:27 +00005080
Christian Heimes99a65702016-09-10 23:44:53 +02005081/*
5082 * SSL Session object
5083 */
5084
5085static void
5086PySSLSession_dealloc(PySSLSession *self)
5087{
INADA Naokia6296d32017-08-24 14:55:17 +09005088 /* bpo-31095: UnTrack is needed before calling any callbacks */
Christian Heimesa5d07652016-09-24 10:48:05 +02005089 PyObject_GC_UnTrack(self);
Christian Heimes99a65702016-09-10 23:44:53 +02005090 Py_XDECREF(self->ctx);
5091 if (self->session != NULL) {
5092 SSL_SESSION_free(self->session);
5093 }
Christian Heimesa5d07652016-09-24 10:48:05 +02005094 PyObject_GC_Del(self);
Christian Heimes99a65702016-09-10 23:44:53 +02005095}
5096
5097static PyObject *
5098PySSLSession_richcompare(PyObject *left, PyObject *right, int op)
5099{
5100 int result;
5101
5102 if (left == NULL || right == NULL) {
5103 PyErr_BadInternalCall();
5104 return NULL;
5105 }
5106
5107 if (!PySSLSession_Check(left) || !PySSLSession_Check(right)) {
5108 Py_RETURN_NOTIMPLEMENTED;
5109 }
5110
5111 if (left == right) {
5112 result = 0;
5113 } else {
5114 const unsigned char *left_id, *right_id;
5115 unsigned int left_len, right_len;
5116 left_id = SSL_SESSION_get_id(((PySSLSession *)left)->session,
5117 &left_len);
5118 right_id = SSL_SESSION_get_id(((PySSLSession *)right)->session,
5119 &right_len);
5120 if (left_len == right_len) {
5121 result = memcmp(left_id, right_id, left_len);
5122 } else {
5123 result = 1;
5124 }
5125 }
5126
5127 switch (op) {
5128 case Py_EQ:
5129 if (result == 0) {
5130 Py_RETURN_TRUE;
5131 } else {
5132 Py_RETURN_FALSE;
5133 }
5134 break;
5135 case Py_NE:
5136 if (result != 0) {
5137 Py_RETURN_TRUE;
5138 } else {
5139 Py_RETURN_FALSE;
5140 }
5141 break;
5142 case Py_LT:
5143 case Py_LE:
5144 case Py_GT:
5145 case Py_GE:
5146 Py_RETURN_NOTIMPLEMENTED;
5147 break;
5148 default:
5149 PyErr_BadArgument();
5150 return NULL;
5151 }
5152}
5153
5154static int
5155PySSLSession_traverse(PySSLSession *self, visitproc visit, void *arg)
5156{
5157 Py_VISIT(self->ctx);
5158 return 0;
5159}
5160
5161static int
5162PySSLSession_clear(PySSLSession *self)
5163{
5164 Py_CLEAR(self->ctx);
5165 return 0;
5166}
5167
5168
5169static PyObject *
5170PySSLSession_get_time(PySSLSession *self, void *closure) {
5171 return PyLong_FromLong(SSL_SESSION_get_time(self->session));
5172}
5173
5174PyDoc_STRVAR(PySSLSession_get_time_doc,
5175"Session creation time (seconds since epoch).");
5176
5177
5178static PyObject *
5179PySSLSession_get_timeout(PySSLSession *self, void *closure) {
5180 return PyLong_FromLong(SSL_SESSION_get_timeout(self->session));
5181}
5182
5183PyDoc_STRVAR(PySSLSession_get_timeout_doc,
5184"Session timeout (delta in seconds).");
5185
5186
5187static PyObject *
5188PySSLSession_get_ticket_lifetime_hint(PySSLSession *self, void *closure) {
5189 unsigned long hint = SSL_SESSION_get_ticket_lifetime_hint(self->session);
5190 return PyLong_FromUnsignedLong(hint);
5191}
5192
5193PyDoc_STRVAR(PySSLSession_get_ticket_lifetime_hint_doc,
5194"Ticket life time hint.");
5195
5196
5197static PyObject *
5198PySSLSession_get_session_id(PySSLSession *self, void *closure) {
5199 const unsigned char *id;
5200 unsigned int len;
5201 id = SSL_SESSION_get_id(self->session, &len);
5202 return PyBytes_FromStringAndSize((const char *)id, len);
5203}
5204
5205PyDoc_STRVAR(PySSLSession_get_session_id_doc,
5206"Session id");
5207
5208
5209static PyObject *
5210PySSLSession_get_has_ticket(PySSLSession *self, void *closure) {
5211 if (SSL_SESSION_has_ticket(self->session)) {
5212 Py_RETURN_TRUE;
5213 } else {
5214 Py_RETURN_FALSE;
5215 }
5216}
5217
5218PyDoc_STRVAR(PySSLSession_get_has_ticket_doc,
5219"Does the session contain a ticket?");
5220
5221
5222static PyGetSetDef PySSLSession_getsetlist[] = {
5223 {"has_ticket", (getter) PySSLSession_get_has_ticket, NULL,
5224 PySSLSession_get_has_ticket_doc},
5225 {"id", (getter) PySSLSession_get_session_id, NULL,
5226 PySSLSession_get_session_id_doc},
5227 {"ticket_lifetime_hint", (getter) PySSLSession_get_ticket_lifetime_hint,
5228 NULL, PySSLSession_get_ticket_lifetime_hint_doc},
5229 {"time", (getter) PySSLSession_get_time, NULL,
5230 PySSLSession_get_time_doc},
5231 {"timeout", (getter) PySSLSession_get_timeout, NULL,
5232 PySSLSession_get_timeout_doc},
5233 {NULL}, /* sentinel */
5234};
5235
5236static PyTypeObject PySSLSession_Type = {
5237 PyVarObject_HEAD_INIT(NULL, 0)
5238 "_ssl.Session", /*tp_name*/
5239 sizeof(PySSLSession), /*tp_basicsize*/
5240 0, /*tp_itemsize*/
5241 (destructor)PySSLSession_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005242 0, /*tp_vectorcall_offset*/
Christian Heimes99a65702016-09-10 23:44:53 +02005243 0, /*tp_getattr*/
5244 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005245 0, /*tp_as_async*/
Christian Heimes99a65702016-09-10 23:44:53 +02005246 0, /*tp_repr*/
5247 0, /*tp_as_number*/
5248 0, /*tp_as_sequence*/
5249 0, /*tp_as_mapping*/
5250 0, /*tp_hash*/
5251 0, /*tp_call*/
5252 0, /*tp_str*/
5253 0, /*tp_getattro*/
5254 0, /*tp_setattro*/
5255 0, /*tp_as_buffer*/
Christian Heimesa5d07652016-09-24 10:48:05 +02005256 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Christian Heimes99a65702016-09-10 23:44:53 +02005257 0, /*tp_doc*/
5258 (traverseproc)PySSLSession_traverse, /*tp_traverse*/
5259 (inquiry)PySSLSession_clear, /*tp_clear*/
5260 PySSLSession_richcompare, /*tp_richcompare*/
5261 0, /*tp_weaklistoffset*/
5262 0, /*tp_iter*/
5263 0, /*tp_iternext*/
5264 0, /*tp_methods*/
5265 0, /*tp_members*/
5266 PySSLSession_getsetlist, /*tp_getset*/
5267};
5268
5269
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005270/* helper routines for seeding the SSL PRNG */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005271/*[clinic input]
5272_ssl.RAND_add
Larry Hastingsdbfdc382015-05-04 06:59:46 -07005273 string as view: Py_buffer(accept={str, buffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005274 entropy: double
5275 /
5276
5277Mix string into the OpenSSL PRNG state.
5278
5279entropy (a float) is a lower bound on the entropy contained in
Chandan Kumar63c2c8a2017-06-09 15:13:58 +05305280string. See RFC 4086.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005281[clinic start generated code]*/
5282
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005283static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005284_ssl_RAND_add_impl(PyObject *module, Py_buffer *view, double entropy)
Serhiy Storchaka5f31d5c2017-06-10 13:13:51 +03005285/*[clinic end generated code: output=e6dd48df9c9024e9 input=5c33017422828f5c]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005286{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005287 const char *buf;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005288 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005289
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005290 buf = (const char *)view->buf;
5291 len = view->len;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005292 do {
5293 written = Py_MIN(len, INT_MAX);
5294 RAND_add(buf, (int)written, entropy);
5295 buf += written;
5296 len -= written;
5297 } while (len);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02005298 Py_RETURN_NONE;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005299}
5300
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005301static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02005302PySSL_RAND(int len, int pseudo)
5303{
5304 int ok;
5305 PyObject *bytes;
5306 unsigned long err;
5307 const char *errstr;
5308 PyObject *v;
5309
Victor Stinner1e81a392013-12-19 16:47:04 +01005310 if (len < 0) {
5311 PyErr_SetString(PyExc_ValueError, "num must be positive");
5312 return NULL;
5313 }
5314
Victor Stinner99c8b162011-05-24 12:05:19 +02005315 bytes = PyBytes_FromStringAndSize(NULL, len);
5316 if (bytes == NULL)
5317 return NULL;
5318 if (pseudo) {
Christian Heimesa871f692020-06-01 08:58:14 +02005319#ifdef PY_OPENSSL_1_1_API
5320 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5321#else
Victor Stinner99c8b162011-05-24 12:05:19 +02005322 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
Christian Heimesa871f692020-06-01 08:58:14 +02005323#endif
Victor Stinner99c8b162011-05-24 12:05:19 +02005324 if (ok == 0 || ok == 1)
5325 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
5326 }
5327 else {
5328 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5329 if (ok == 1)
5330 return bytes;
5331 }
5332 Py_DECREF(bytes);
5333
5334 err = ERR_get_error();
5335 errstr = ERR_reason_error_string(err);
5336 v = Py_BuildValue("(ks)", err, errstr);
5337 if (v != NULL) {
5338 PyErr_SetObject(PySSLErrorObject, v);
5339 Py_DECREF(v);
5340 }
5341 return NULL;
5342}
5343
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005344/*[clinic input]
5345_ssl.RAND_bytes
5346 n: int
5347 /
5348
5349Generate n cryptographically strong pseudo-random bytes.
5350[clinic start generated code]*/
5351
Victor Stinner99c8b162011-05-24 12:05:19 +02005352static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005353_ssl_RAND_bytes_impl(PyObject *module, int n)
5354/*[clinic end generated code: output=977da635e4838bc7 input=678ddf2872dfebfc]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005355{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005356 return PySSL_RAND(n, 0);
Victor Stinner99c8b162011-05-24 12:05:19 +02005357}
5358
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005359/*[clinic input]
5360_ssl.RAND_pseudo_bytes
5361 n: int
5362 /
5363
5364Generate n pseudo-random bytes.
5365
5366Return a pair (bytes, is_cryptographic). is_cryptographic is True
5367if the bytes generated are cryptographically strong.
5368[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005369
5370static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005371_ssl_RAND_pseudo_bytes_impl(PyObject *module, int n)
5372/*[clinic end generated code: output=b1509e937000e52d input=58312bd53f9bbdd0]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005373{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005374 return PySSL_RAND(n, 1);
Victor Stinner99c8b162011-05-24 12:05:19 +02005375}
5376
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005377/*[clinic input]
5378_ssl.RAND_status
5379
5380Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.
5381
5382It is necessary to seed the PRNG with RAND_add() on some platforms before
5383using the ssl() function.
5384[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005385
5386static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005387_ssl_RAND_status_impl(PyObject *module)
5388/*[clinic end generated code: output=7e0aaa2d39fdc1ad input=8a774b02d1dc81f3]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005389{
Christian Heimes217cfd12007-12-02 14:31:20 +00005390 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005391}
5392
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005393#ifndef OPENSSL_NO_EGD
Christian Heimesa5d07652016-09-24 10:48:05 +02005394/* LCOV_EXCL_START */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005395/*[clinic input]
5396_ssl.RAND_egd
5397 path: object(converter="PyUnicode_FSConverter")
5398 /
5399
5400Queries the entropy gather daemon (EGD) on the socket named by 'path'.
5401
5402Returns number of bytes read. Raises SSLError if connection to EGD
5403fails or if it does not provide enough data to seed PRNG.
5404[clinic start generated code]*/
5405
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005406static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005407_ssl_RAND_egd_impl(PyObject *module, PyObject *path)
5408/*[clinic end generated code: output=02a67c7c367f52fa input=1aeb7eb948312195]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005409{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005410 int bytes = RAND_egd(PyBytes_AsString(path));
Victor Stinnerf9faaad2010-05-16 21:36:37 +00005411 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005412 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00005413 PyErr_SetString(PySSLErrorObject,
5414 "EGD connection failed or EGD did not return "
5415 "enough data to seed the PRNG");
5416 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005417 }
Christian Heimes217cfd12007-12-02 14:31:20 +00005418 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005419}
Christian Heimesa5d07652016-09-24 10:48:05 +02005420/* LCOV_EXCL_STOP */
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005421#endif /* OPENSSL_NO_EGD */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005422
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005423
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005424
5425/*[clinic input]
5426_ssl.get_default_verify_paths
5427
5428Return search paths and environment vars that are used by SSLContext's set_default_verify_paths() to load default CAs.
5429
5430The values are 'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.
5431[clinic start generated code]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005432
5433static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005434_ssl_get_default_verify_paths_impl(PyObject *module)
5435/*[clinic end generated code: output=e5b62a466271928b input=5210c953d98c3eb5]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005436{
5437 PyObject *ofile_env = NULL;
5438 PyObject *ofile = NULL;
5439 PyObject *odir_env = NULL;
5440 PyObject *odir = NULL;
5441
Benjamin Petersond113c962015-07-18 10:59:13 -07005442#define CONVERT(info, target) { \
Christian Heimes6d7ad132013-06-09 18:02:55 +02005443 const char *tmp = (info); \
5444 target = NULL; \
5445 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
5446 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
5447 target = PyBytes_FromString(tmp); } \
5448 if (!target) goto error; \
Benjamin Peterson025a1fd2015-11-14 15:12:38 -08005449 }
Christian Heimes6d7ad132013-06-09 18:02:55 +02005450
Benjamin Petersond113c962015-07-18 10:59:13 -07005451 CONVERT(X509_get_default_cert_file_env(), ofile_env);
5452 CONVERT(X509_get_default_cert_file(), ofile);
5453 CONVERT(X509_get_default_cert_dir_env(), odir_env);
5454 CONVERT(X509_get_default_cert_dir(), odir);
5455#undef CONVERT
Christian Heimes6d7ad132013-06-09 18:02:55 +02005456
Christian Heimes200bb1b2013-06-14 15:14:29 +02005457 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02005458
5459 error:
5460 Py_XDECREF(ofile_env);
5461 Py_XDECREF(ofile);
5462 Py_XDECREF(odir_env);
5463 Py_XDECREF(odir);
5464 return NULL;
5465}
5466
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005467static PyObject*
5468asn1obj2py(ASN1_OBJECT *obj)
5469{
5470 int nid;
5471 const char *ln, *sn;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005472
5473 nid = OBJ_obj2nid(obj);
5474 if (nid == NID_undef) {
5475 PyErr_Format(PyExc_ValueError, "Unknown object");
5476 return NULL;
5477 }
5478 sn = OBJ_nid2sn(nid);
5479 ln = OBJ_nid2ln(nid);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03005480 return Py_BuildValue("issN", nid, sn, ln, _asn1obj2py(obj, 1));
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005481}
5482
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005483/*[clinic input]
5484_ssl.txt2obj
5485 txt: str
5486 name: bool = False
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005487
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005488Lookup NID, short name, long name and OID of an ASN1_OBJECT.
5489
5490By default objects are looked up by OID. With name=True short and
5491long name are also matched.
5492[clinic start generated code]*/
5493
5494static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005495_ssl_txt2obj_impl(PyObject *module, const char *txt, int name)
5496/*[clinic end generated code: output=c38e3991347079c1 input=1c1e7d0aa7c48602]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005497{
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005498 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005499 ASN1_OBJECT *obj;
5500
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005501 obj = OBJ_txt2obj(txt, name ? 0 : 1);
5502 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005503 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005504 return NULL;
5505 }
5506 result = asn1obj2py(obj);
5507 ASN1_OBJECT_free(obj);
5508 return result;
5509}
5510
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005511/*[clinic input]
5512_ssl.nid2obj
5513 nid: int
5514 /
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005515
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005516Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.
5517[clinic start generated code]*/
5518
5519static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005520_ssl_nid2obj_impl(PyObject *module, int nid)
5521/*[clinic end generated code: output=4a98ab691cd4f84a input=51787a3bee7d8f98]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005522{
5523 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005524 ASN1_OBJECT *obj;
5525
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005526 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005527 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005528 return NULL;
5529 }
5530 obj = OBJ_nid2obj(nid);
5531 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005532 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005533 return NULL;
5534 }
5535 result = asn1obj2py(obj);
5536 ASN1_OBJECT_free(obj);
5537 return result;
5538}
5539
Christian Heimes46bebee2013-06-09 19:03:31 +02005540#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01005541
5542static PyObject*
5543certEncodingType(DWORD encodingType)
5544{
5545 static PyObject *x509_asn = NULL;
5546 static PyObject *pkcs_7_asn = NULL;
5547
5548 if (x509_asn == NULL) {
5549 x509_asn = PyUnicode_InternFromString("x509_asn");
5550 if (x509_asn == NULL)
5551 return NULL;
5552 }
5553 if (pkcs_7_asn == NULL) {
5554 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
5555 if (pkcs_7_asn == NULL)
5556 return NULL;
5557 }
5558 switch(encodingType) {
5559 case X509_ASN_ENCODING:
5560 Py_INCREF(x509_asn);
5561 return x509_asn;
5562 case PKCS_7_ASN_ENCODING:
5563 Py_INCREF(pkcs_7_asn);
5564 return pkcs_7_asn;
5565 default:
5566 return PyLong_FromLong(encodingType);
5567 }
5568}
5569
5570static PyObject*
5571parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
5572{
5573 CERT_ENHKEY_USAGE *usage;
5574 DWORD size, error, i;
5575 PyObject *retval;
5576
5577 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
5578 error = GetLastError();
5579 if (error == CRYPT_E_NOT_FOUND) {
5580 Py_RETURN_TRUE;
5581 }
5582 return PyErr_SetFromWindowsErr(error);
5583 }
5584
5585 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
5586 if (usage == NULL) {
5587 return PyErr_NoMemory();
5588 }
5589
5590 /* Now get the actual enhanced usage property */
5591 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
5592 PyMem_Free(usage);
5593 error = GetLastError();
5594 if (error == CRYPT_E_NOT_FOUND) {
5595 Py_RETURN_TRUE;
5596 }
5597 return PyErr_SetFromWindowsErr(error);
5598 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005599 retval = PyFrozenSet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005600 if (retval == NULL) {
5601 goto error;
5602 }
5603 for (i = 0; i < usage->cUsageIdentifier; ++i) {
5604 if (usage->rgpszUsageIdentifier[i]) {
5605 PyObject *oid;
5606 int err;
5607 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
5608 if (oid == NULL) {
5609 Py_CLEAR(retval);
5610 goto error;
5611 }
5612 err = PySet_Add(retval, oid);
5613 Py_DECREF(oid);
5614 if (err == -1) {
5615 Py_CLEAR(retval);
5616 goto error;
5617 }
5618 }
5619 }
5620 error:
5621 PyMem_Free(usage);
5622 return retval;
5623}
5624
kctherookied93fbbf2019-03-29 00:59:06 +07005625static HCERTSTORE
5626ssl_collect_certificates(const char *store_name)
5627{
5628/* this function collects the system certificate stores listed in
5629 * system_stores into a collection certificate store for being
5630 * enumerated. The store must be readable to be added to the
5631 * store collection.
5632 */
5633
5634 HCERTSTORE hCollectionStore = NULL, hSystemStore = NULL;
5635 static DWORD system_stores[] = {
5636 CERT_SYSTEM_STORE_LOCAL_MACHINE,
5637 CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE,
5638 CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY,
5639 CERT_SYSTEM_STORE_CURRENT_USER,
5640 CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY,
5641 CERT_SYSTEM_STORE_SERVICES,
5642 CERT_SYSTEM_STORE_USERS};
5643 size_t i, storesAdded;
5644 BOOL result;
5645
5646 hCollectionStore = CertOpenStore(CERT_STORE_PROV_COLLECTION, 0,
5647 (HCRYPTPROV)NULL, 0, NULL);
5648 if (!hCollectionStore) {
5649 return NULL;
5650 }
5651 storesAdded = 0;
5652 for (i = 0; i < sizeof(system_stores) / sizeof(DWORD); i++) {
5653 hSystemStore = CertOpenStore(CERT_STORE_PROV_SYSTEM_A, 0,
5654 (HCRYPTPROV)NULL,
5655 CERT_STORE_READONLY_FLAG |
5656 system_stores[i], store_name);
5657 if (hSystemStore) {
5658 result = CertAddStoreToCollection(hCollectionStore, hSystemStore,
5659 CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG, 0);
5660 if (result) {
5661 ++storesAdded;
5662 }
neoneneed701292019-09-09 21:33:43 +09005663 CertCloseStore(hSystemStore, 0); /* flag must be 0 */
kctherookied93fbbf2019-03-29 00:59:06 +07005664 }
5665 }
5666 if (storesAdded == 0) {
5667 CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG);
5668 return NULL;
5669 }
5670
5671 return hCollectionStore;
5672}
5673
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005674/*[clinic input]
5675_ssl.enum_certificates
5676 store_name: str
5677
5678Retrieve certificates from Windows' cert store.
5679
5680store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5681more cert storages, too. The function returns a list of (bytes,
5682encoding_type, trust) tuples. The encoding_type flag can be interpreted
5683with X509_ASN_ENCODING or PKCS_7_ASN_ENCODING. The trust setting is either
5684a set of OIDs or the boolean True.
5685[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00005686
Christian Heimes46bebee2013-06-09 19:03:31 +02005687static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005688_ssl_enum_certificates_impl(PyObject *module, const char *store_name)
5689/*[clinic end generated code: output=5134dc8bb3a3c893 input=915f60d70461ea4e]*/
Christian Heimes46bebee2013-06-09 19:03:31 +02005690{
kctherookied93fbbf2019-03-29 00:59:06 +07005691 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005692 PCCERT_CONTEXT pCertCtx = NULL;
5693 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005694 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005695
Christian Heimes915cd3f2019-09-09 18:06:55 +02005696 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005697 if (result == NULL) {
5698 return NULL;
5699 }
kctherookied93fbbf2019-03-29 00:59:06 +07005700 hCollectionStore = ssl_collect_certificates(store_name);
5701 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005702 Py_DECREF(result);
5703 return PyErr_SetFromWindowsErr(GetLastError());
5704 }
5705
kctherookied93fbbf2019-03-29 00:59:06 +07005706 while (pCertCtx = CertEnumCertificatesInStore(hCollectionStore, pCertCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005707 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
5708 pCertCtx->cbCertEncoded);
5709 if (!cert) {
5710 Py_CLEAR(result);
5711 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005712 }
Christian Heimes44109d72013-11-22 01:51:30 +01005713 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
5714 Py_CLEAR(result);
5715 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005716 }
Christian Heimes44109d72013-11-22 01:51:30 +01005717 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
5718 if (keyusage == Py_True) {
5719 Py_DECREF(keyusage);
5720 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02005721 }
Christian Heimes44109d72013-11-22 01:51:30 +01005722 if (keyusage == NULL) {
5723 Py_CLEAR(result);
5724 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005725 }
Christian Heimes44109d72013-11-22 01:51:30 +01005726 if ((tup = PyTuple_New(3)) == NULL) {
5727 Py_CLEAR(result);
5728 break;
5729 }
5730 PyTuple_SET_ITEM(tup, 0, cert);
5731 cert = NULL;
5732 PyTuple_SET_ITEM(tup, 1, enc);
5733 enc = NULL;
5734 PyTuple_SET_ITEM(tup, 2, keyusage);
5735 keyusage = NULL;
Christian Heimes915cd3f2019-09-09 18:06:55 +02005736 if (PySet_Add(result, tup) == -1) {
5737 Py_CLEAR(result);
5738 Py_CLEAR(tup);
5739 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005740 }
5741 Py_CLEAR(tup);
5742 }
5743 if (pCertCtx) {
5744 /* loop ended with an error, need to clean up context manually */
5745 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02005746 }
5747
5748 /* In error cases cert, enc and tup may not be NULL */
5749 Py_XDECREF(cert);
5750 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01005751 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02005752 Py_XDECREF(tup);
5753
kctherookied93fbbf2019-03-29 00:59:06 +07005754 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5755 associated with the store, in this case our collection store and the
5756 associated system stores. */
5757 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005758 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01005759 Py_XDECREF(result);
5760 return PyErr_SetFromWindowsErr(GetLastError());
5761 }
kctherookied93fbbf2019-03-29 00:59:06 +07005762
Christian Heimes915cd3f2019-09-09 18:06:55 +02005763 /* convert set to list */
5764 if (result == NULL) {
5765 return NULL;
5766 } else {
5767 PyObject *lst = PySequence_List(result);
5768 Py_DECREF(result);
5769 return lst;
5770 }
Christian Heimes44109d72013-11-22 01:51:30 +01005771}
5772
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005773/*[clinic input]
5774_ssl.enum_crls
5775 store_name: str
5776
5777Retrieve CRLs from Windows' cert store.
5778
5779store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5780more cert storages, too. The function returns a list of (bytes,
5781encoding_type) tuples. The encoding_type flag can be interpreted with
5782X509_ASN_ENCODING or PKCS_7_ASN_ENCODING.
5783[clinic start generated code]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005784
5785static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005786_ssl_enum_crls_impl(PyObject *module, const char *store_name)
5787/*[clinic end generated code: output=bce467f60ccd03b6 input=a1f1d7629f1c5d3d]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005788{
kctherookied93fbbf2019-03-29 00:59:06 +07005789 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005790 PCCRL_CONTEXT pCrlCtx = NULL;
5791 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
5792 PyObject *result = NULL;
5793
Christian Heimes915cd3f2019-09-09 18:06:55 +02005794 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005795 if (result == NULL) {
5796 return NULL;
5797 }
kctherookied93fbbf2019-03-29 00:59:06 +07005798 hCollectionStore = ssl_collect_certificates(store_name);
5799 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005800 Py_DECREF(result);
5801 return PyErr_SetFromWindowsErr(GetLastError());
5802 }
Christian Heimes44109d72013-11-22 01:51:30 +01005803
kctherookied93fbbf2019-03-29 00:59:06 +07005804 while (pCrlCtx = CertEnumCRLsInStore(hCollectionStore, pCrlCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005805 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
5806 pCrlCtx->cbCrlEncoded);
5807 if (!crl) {
5808 Py_CLEAR(result);
5809 break;
5810 }
5811 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
5812 Py_CLEAR(result);
5813 break;
5814 }
5815 if ((tup = PyTuple_New(2)) == NULL) {
5816 Py_CLEAR(result);
5817 break;
5818 }
5819 PyTuple_SET_ITEM(tup, 0, crl);
5820 crl = NULL;
5821 PyTuple_SET_ITEM(tup, 1, enc);
5822 enc = NULL;
5823
Christian Heimes915cd3f2019-09-09 18:06:55 +02005824 if (PySet_Add(result, tup) == -1) {
5825 Py_CLEAR(result);
5826 Py_CLEAR(tup);
5827 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005828 }
5829 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02005830 }
Christian Heimes44109d72013-11-22 01:51:30 +01005831 if (pCrlCtx) {
5832 /* loop ended with an error, need to clean up context manually */
5833 CertFreeCRLContext(pCrlCtx);
5834 }
5835
5836 /* In error cases cert, enc and tup may not be NULL */
5837 Py_XDECREF(crl);
5838 Py_XDECREF(enc);
5839 Py_XDECREF(tup);
5840
kctherookied93fbbf2019-03-29 00:59:06 +07005841 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5842 associated with the store, in this case our collection store and the
5843 associated system stores. */
5844 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005845 /* This error case might shadow another exception.*/
5846 Py_XDECREF(result);
5847 return PyErr_SetFromWindowsErr(GetLastError());
5848 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005849 /* convert set to list */
5850 if (result == NULL) {
5851 return NULL;
5852 } else {
5853 PyObject *lst = PySequence_List(result);
5854 Py_DECREF(result);
5855 return lst;
5856 }
Christian Heimes46bebee2013-06-09 19:03:31 +02005857}
Christian Heimes44109d72013-11-22 01:51:30 +01005858
5859#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00005860
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005861/* List of functions exported by this module. */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005862static PyMethodDef PySSL_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005863 _SSL__TEST_DECODE_CERT_METHODDEF
5864 _SSL_RAND_ADD_METHODDEF
5865 _SSL_RAND_BYTES_METHODDEF
5866 _SSL_RAND_PSEUDO_BYTES_METHODDEF
5867 _SSL_RAND_EGD_METHODDEF
5868 _SSL_RAND_STATUS_METHODDEF
5869 _SSL_GET_DEFAULT_VERIFY_PATHS_METHODDEF
5870 _SSL_ENUM_CERTIFICATES_METHODDEF
5871 _SSL_ENUM_CRLS_METHODDEF
5872 _SSL_TXT2OBJ_METHODDEF
5873 _SSL_NID2OBJ_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005874 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005875};
5876
5877
Christian Heimes598894f2016-09-05 23:19:05 +02005878#ifdef HAVE_OPENSSL_CRYPTO_LOCK
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005879
5880/* an implementation of OpenSSL threading operations in terms
Christian Heimes598894f2016-09-05 23:19:05 +02005881 * of the Python C thread library
5882 * Only used up to 1.0.2. OpenSSL 1.1.0+ has its own locking code.
5883 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005884
5885static PyThread_type_lock *_ssl_locks = NULL;
5886
Christian Heimes4d98ca92013-08-19 17:36:29 +02005887#if OPENSSL_VERSION_NUMBER >= 0x10000000
5888/* use new CRYPTO_THREADID API. */
5889static void
5890_ssl_threadid_callback(CRYPTO_THREADID *id)
5891{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +02005892 CRYPTO_THREADID_set_numeric(id, PyThread_get_thread_ident());
Christian Heimes4d98ca92013-08-19 17:36:29 +02005893}
5894#else
5895/* deprecated CRYPTO_set_id_callback() API. */
5896static unsigned long
5897_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005898 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005899}
Christian Heimes4d98ca92013-08-19 17:36:29 +02005900#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005901
Bill Janssen6e027db2007-11-15 22:23:56 +00005902static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005903 (int mode, int n, const char *file, int line) {
5904 /* this function is needed to perform locking on shared data
5905 structures. (Note that OpenSSL uses a number of global data
5906 structures that will be implicitly shared whenever multiple
5907 threads use OpenSSL.) Multi-threaded applications will
5908 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005909
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005910 locking_function() must be able to handle up to
5911 CRYPTO_num_locks() different mutex locks. It sets the n-th
5912 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005913
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005914 file and line are the file number of the function setting the
5915 lock. They can be useful for debugging.
5916 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005917
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005918 if ((_ssl_locks == NULL) ||
5919 (n < 0) || ((unsigned)n >= _ssl_locks_count))
5920 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005921
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005922 if (mode & CRYPTO_LOCK) {
5923 PyThread_acquire_lock(_ssl_locks[n], 1);
5924 } else {
5925 PyThread_release_lock(_ssl_locks[n]);
5926 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005927}
5928
5929static int _setup_ssl_threads(void) {
5930
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005931 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005932
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005933 if (_ssl_locks == NULL) {
5934 _ssl_locks_count = CRYPTO_num_locks();
Christian Heimesf6365e32016-09-13 20:48:13 +02005935 _ssl_locks = PyMem_Calloc(_ssl_locks_count,
5936 sizeof(PyThread_type_lock));
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005937 if (_ssl_locks == NULL) {
5938 PyErr_NoMemory();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005939 return 0;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005940 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005941 for (i = 0; i < _ssl_locks_count; i++) {
5942 _ssl_locks[i] = PyThread_allocate_lock();
5943 if (_ssl_locks[i] == NULL) {
5944 unsigned int j;
5945 for (j = 0; j < i; j++) {
5946 PyThread_free_lock(_ssl_locks[j]);
5947 }
Victor Stinnerb6404912013-07-07 16:21:41 +02005948 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005949 return 0;
5950 }
5951 }
5952 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005953#if OPENSSL_VERSION_NUMBER >= 0x10000000
5954 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
5955#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005956 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005957#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005958 }
5959 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005960}
5961
Antoine Pitroua6a4dc82017-09-07 18:56:24 +02005962#endif /* HAVE_OPENSSL_CRYPTO_LOCK for OpenSSL < 1.1.0 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005963
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005964PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005965"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005966for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005967
Martin v. Löwis1a214512008-06-11 05:26:20 +00005968
5969static struct PyModuleDef _sslmodule = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005970 PyModuleDef_HEAD_INIT,
5971 "_ssl",
5972 module_doc,
5973 -1,
5974 PySSL_methods,
5975 NULL,
5976 NULL,
5977 NULL,
5978 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005979};
5980
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02005981
5982static void
5983parse_openssl_version(unsigned long libver,
5984 unsigned int *major, unsigned int *minor,
5985 unsigned int *fix, unsigned int *patch,
5986 unsigned int *status)
5987{
5988 *status = libver & 0xF;
5989 libver >>= 4;
5990 *patch = libver & 0xFF;
5991 libver >>= 8;
5992 *fix = libver & 0xFF;
5993 libver >>= 8;
5994 *minor = libver & 0xFF;
5995 libver >>= 8;
5996 *major = libver & 0xFF;
5997}
5998
Mark Hammondfe51c6d2002-08-02 02:27:13 +00005999PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00006000PyInit__ssl(void)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006001{
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006002 PyObject *m, *d, *r, *bases;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006003 unsigned long libver;
6004 unsigned int major, minor, fix, patch, status;
6005 PySocketModule_APIObject *socket_api;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006006 struct py_ssl_error_code *errcode;
6007 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006008
Antoine Pitrou152efa22010-05-16 18:19:27 +00006009 if (PyType_Ready(&PySSLContext_Type) < 0)
6010 return NULL;
6011 if (PyType_Ready(&PySSLSocket_Type) < 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006012 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02006013 if (PyType_Ready(&PySSLMemoryBIO_Type) < 0)
6014 return NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02006015 if (PyType_Ready(&PySSLSession_Type) < 0)
6016 return NULL;
6017
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006018
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006019 m = PyModule_Create(&_sslmodule);
6020 if (m == NULL)
6021 return NULL;
6022 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006023
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006024 /* Load _socket module and its C API */
6025 socket_api = PySocketModule_ImportModuleAndAPI();
6026 if (!socket_api)
6027 return NULL;
6028 PySocketModule = *socket_api;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006029
Christian Heimesc941e622017-09-05 15:47:11 +02006030#ifndef OPENSSL_VERSION_1_1
6031 /* Load all algorithms and initialize cpuid */
6032 OPENSSL_add_all_algorithms_noconf();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006033 /* Init OpenSSL */
6034 SSL_load_error_strings();
6035 SSL_library_init();
Christian Heimesc941e622017-09-05 15:47:11 +02006036#endif
6037
Christian Heimes598894f2016-09-05 23:19:05 +02006038#ifdef HAVE_OPENSSL_CRYPTO_LOCK
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006039 /* note that this will start threading if not already started */
6040 if (!_setup_ssl_threads()) {
6041 return NULL;
6042 }
Christian Heimesc087a262020-05-15 20:55:25 +02006043#elif OPENSSL_VERSION_1_1
Christian Heimes598894f2016-09-05 23:19:05 +02006044 /* OpenSSL 1.1.0 builtin thread support is enabled */
6045 _ssl_locks_count++;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00006046#endif
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006047
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006048 /* Add symbols to module dict */
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006049 sslerror_type_slots[0].pfunc = PyExc_OSError;
6050 PySSLErrorObject = PyType_FromSpec(&sslerror_type_spec);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006051 if (PySSLErrorObject == NULL)
6052 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006053
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006054 /* ssl.CertificateError used to be a subclass of ValueError */
6055 bases = Py_BuildValue("OO", PySSLErrorObject, PyExc_ValueError);
6056 if (bases == NULL)
6057 return NULL;
6058 PySSLCertVerificationErrorObject = PyErr_NewExceptionWithDoc(
6059 "ssl.SSLCertVerificationError", SSLCertVerificationError_doc,
6060 bases, NULL);
6061 Py_DECREF(bases);
Antoine Pitrou41032a62011-10-27 23:56:55 +02006062 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
6063 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
6064 PySSLErrorObject, NULL);
6065 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
6066 "ssl.SSLWantReadError", SSLWantReadError_doc,
6067 PySSLErrorObject, NULL);
6068 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
6069 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
6070 PySSLErrorObject, NULL);
6071 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
6072 "ssl.SSLSyscallError", SSLSyscallError_doc,
6073 PySSLErrorObject, NULL);
6074 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
6075 "ssl.SSLEOFError", SSLEOFError_doc,
6076 PySSLErrorObject, NULL);
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006077 if (PySSLCertVerificationErrorObject == NULL
6078 || PySSLZeroReturnErrorObject == NULL
Antoine Pitrou41032a62011-10-27 23:56:55 +02006079 || PySSLWantReadErrorObject == NULL
6080 || PySSLWantWriteErrorObject == NULL
6081 || PySSLSyscallErrorObject == NULL
6082 || PySSLEOFErrorObject == NULL)
6083 return NULL;
6084 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006085 || PyDict_SetItemString(d, "SSLCertVerificationError",
6086 PySSLCertVerificationErrorObject) != 0
Antoine Pitrou41032a62011-10-27 23:56:55 +02006087 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
6088 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
6089 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
6090 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
6091 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006092 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00006093 if (PyDict_SetItemString(d, "_SSLContext",
6094 (PyObject *)&PySSLContext_Type) != 0)
6095 return NULL;
6096 if (PyDict_SetItemString(d, "_SSLSocket",
6097 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006098 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02006099 if (PyDict_SetItemString(d, "MemoryBIO",
6100 (PyObject *)&PySSLMemoryBIO_Type) != 0)
6101 return NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02006102 if (PyDict_SetItemString(d, "SSLSession",
6103 (PyObject *)&PySSLSession_Type) != 0)
6104 return NULL;
6105
Christian Heimes892d66e2018-01-29 14:10:18 +01006106 PyModule_AddStringConstant(m, "_DEFAULT_CIPHERS",
6107 PY_SSL_DEFAULT_CIPHER_STRING);
6108
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006109 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
6110 PY_SSL_ERROR_ZERO_RETURN);
6111 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
6112 PY_SSL_ERROR_WANT_READ);
6113 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
6114 PY_SSL_ERROR_WANT_WRITE);
6115 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
6116 PY_SSL_ERROR_WANT_X509_LOOKUP);
6117 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
6118 PY_SSL_ERROR_SYSCALL);
6119 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
6120 PY_SSL_ERROR_SSL);
6121 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
6122 PY_SSL_ERROR_WANT_CONNECT);
6123 /* non ssl.h errorcodes */
6124 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
6125 PY_SSL_ERROR_EOF);
6126 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
6127 PY_SSL_ERROR_INVALID_ERROR_CODE);
6128 /* cert requirements */
6129 PyModule_AddIntConstant(m, "CERT_NONE",
6130 PY_SSL_CERT_NONE);
6131 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
6132 PY_SSL_CERT_OPTIONAL);
6133 PyModule_AddIntConstant(m, "CERT_REQUIRED",
6134 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01006135 /* CRL verification for verification_flags */
6136 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
6137 0);
6138 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
6139 X509_V_FLAG_CRL_CHECK);
6140 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
6141 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
6142 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
6143 X509_V_FLAG_X509_STRICT);
Benjamin Peterson990fcaa2015-03-04 22:49:41 -05006144#ifdef X509_V_FLAG_TRUSTED_FIRST
6145 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
6146 X509_V_FLAG_TRUSTED_FIRST);
6147#endif
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00006148
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006149 /* Alert Descriptions from ssl.h */
6150 /* note RESERVED constants no longer intended for use have been removed */
6151 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
6152
6153#define ADD_AD_CONSTANT(s) \
6154 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
6155 SSL_AD_##s)
6156
6157 ADD_AD_CONSTANT(CLOSE_NOTIFY);
6158 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
6159 ADD_AD_CONSTANT(BAD_RECORD_MAC);
6160 ADD_AD_CONSTANT(RECORD_OVERFLOW);
6161 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
6162 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
6163 ADD_AD_CONSTANT(BAD_CERTIFICATE);
6164 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
6165 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
6166 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
6167 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
6168 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
6169 ADD_AD_CONSTANT(UNKNOWN_CA);
6170 ADD_AD_CONSTANT(ACCESS_DENIED);
6171 ADD_AD_CONSTANT(DECODE_ERROR);
6172 ADD_AD_CONSTANT(DECRYPT_ERROR);
6173 ADD_AD_CONSTANT(PROTOCOL_VERSION);
6174 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
6175 ADD_AD_CONSTANT(INTERNAL_ERROR);
6176 ADD_AD_CONSTANT(USER_CANCELLED);
6177 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006178 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01006179#ifdef SSL_AD_UNSUPPORTED_EXTENSION
6180 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
6181#endif
6182#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
6183 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
6184#endif
6185#ifdef SSL_AD_UNRECOGNIZED_NAME
6186 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
6187#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006188#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
6189 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
6190#endif
6191#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
6192 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
6193#endif
6194#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
6195 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
6196#endif
6197
6198#undef ADD_AD_CONSTANT
6199
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006200 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02006201#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006202 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
6203 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02006204#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05006205#ifndef OPENSSL_NO_SSL3
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006206 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
6207 PY_SSL_VERSION_SSL3);
Benjamin Petersone32467c2014-12-05 21:59:35 -05006208#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006209 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
Christian Heimes598894f2016-09-05 23:19:05 +02006210 PY_SSL_VERSION_TLS);
6211 PyModule_AddIntConstant(m, "PROTOCOL_TLS",
6212 PY_SSL_VERSION_TLS);
Christian Heimes5fe668c2016-09-12 00:01:11 +02006213 PyModule_AddIntConstant(m, "PROTOCOL_TLS_CLIENT",
6214 PY_SSL_VERSION_TLS_CLIENT);
6215 PyModule_AddIntConstant(m, "PROTOCOL_TLS_SERVER",
6216 PY_SSL_VERSION_TLS_SERVER);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006217 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
6218 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006219 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
6220 PY_SSL_VERSION_TLS1_1);
6221 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
6222 PY_SSL_VERSION_TLS1_2);
Antoine Pitrou04f6a322010-04-05 21:40:07 +00006223
Antoine Pitroub5218772010-05-21 09:56:06 +00006224 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01006225 PyModule_AddIntConstant(m, "OP_ALL",
6226 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00006227 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
6228 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
6229 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006230 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
6231 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006232#ifdef SSL_OP_NO_TLSv1_3
6233 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", SSL_OP_NO_TLSv1_3);
6234#else
6235 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", 0);
6236#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01006237 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
6238 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01006239 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Christian Heimes99a65702016-09-10 23:44:53 +02006240 PyModule_AddIntConstant(m, "OP_NO_TICKET", SSL_OP_NO_TICKET);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006241#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01006242 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006243#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01006244#ifdef SSL_OP_NO_COMPRESSION
6245 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
6246 SSL_OP_NO_COMPRESSION);
6247#endif
Christian Heimes05d9fe32018-02-27 08:55:39 +01006248#ifdef SSL_OP_ENABLE_MIDDLEBOX_COMPAT
6249 PyModule_AddIntConstant(m, "OP_ENABLE_MIDDLEBOX_COMPAT",
6250 SSL_OP_ENABLE_MIDDLEBOX_COMPAT);
6251#endif
Christian Heimes67c48012018-05-15 16:25:40 -04006252#ifdef SSL_OP_NO_RENEGOTIATION
6253 PyModule_AddIntConstant(m, "OP_NO_RENEGOTIATION",
6254 SSL_OP_NO_RENEGOTIATION);
6255#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00006256
Christian Heimes61d478c2018-01-27 15:51:38 +01006257#ifdef X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT
6258 PyModule_AddIntConstant(m, "HOSTFLAG_ALWAYS_CHECK_SUBJECT",
6259 X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT);
6260#endif
6261#ifdef X509_CHECK_FLAG_NEVER_CHECK_SUBJECT
6262 PyModule_AddIntConstant(m, "HOSTFLAG_NEVER_CHECK_SUBJECT",
6263 X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
6264#endif
6265#ifdef X509_CHECK_FLAG_NO_WILDCARDS
6266 PyModule_AddIntConstant(m, "HOSTFLAG_NO_WILDCARDS",
6267 X509_CHECK_FLAG_NO_WILDCARDS);
6268#endif
6269#ifdef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
6270 PyModule_AddIntConstant(m, "HOSTFLAG_NO_PARTIAL_WILDCARDS",
6271 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
6272#endif
6273#ifdef X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS
6274 PyModule_AddIntConstant(m, "HOSTFLAG_MULTI_LABEL_WILDCARDS",
6275 X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS);
6276#endif
6277#ifdef X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS
6278 PyModule_AddIntConstant(m, "HOSTFLAG_SINGLE_LABEL_SUBDOMAINS",
6279 X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS);
6280#endif
6281
Christian Heimes698dde12018-02-27 11:54:43 +01006282 /* protocol versions */
6283 PyModule_AddIntConstant(m, "PROTO_MINIMUM_SUPPORTED",
6284 PY_PROTO_MINIMUM_SUPPORTED);
6285 PyModule_AddIntConstant(m, "PROTO_MAXIMUM_SUPPORTED",
6286 PY_PROTO_MAXIMUM_SUPPORTED);
6287 PyModule_AddIntConstant(m, "PROTO_SSLv3", PY_PROTO_SSLv3);
6288 PyModule_AddIntConstant(m, "PROTO_TLSv1", PY_PROTO_TLSv1);
6289 PyModule_AddIntConstant(m, "PROTO_TLSv1_1", PY_PROTO_TLSv1_1);
6290 PyModule_AddIntConstant(m, "PROTO_TLSv1_2", PY_PROTO_TLSv1_2);
6291 PyModule_AddIntConstant(m, "PROTO_TLSv1_3", PY_PROTO_TLSv1_3);
Antoine Pitroud5323212010-10-22 18:19:07 +00006292
Victor Stinnerb37672d2018-11-22 03:37:50 +01006293#define addbool(m, key, value) \
6294 do { \
6295 PyObject *bool_obj = (value) ? Py_True : Py_False; \
6296 Py_INCREF(bool_obj); \
6297 PyModule_AddObject((m), (key), bool_obj); \
6298 } while (0)
Christian Heimes698dde12018-02-27 11:54:43 +01006299
6300#if HAVE_SNI
6301 addbool(m, "HAS_SNI", 1);
Antoine Pitrou501da612011-12-21 09:27:41 +01006302#else
Christian Heimes698dde12018-02-27 11:54:43 +01006303 addbool(m, "HAS_SNI", 0);
Antoine Pitrou501da612011-12-21 09:27:41 +01006304#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006305
6306 addbool(m, "HAS_TLS_UNIQUE", 1);
6307
6308#ifndef OPENSSL_NO_ECDH
6309 addbool(m, "HAS_ECDH", 1);
6310#else
6311 addbool(m, "HAS_ECDH", 0);
6312#endif
Antoine Pitrou501da612011-12-21 09:27:41 +01006313
Christian Heimes29eab552018-02-25 12:31:33 +01006314#if HAVE_NPN
Christian Heimes698dde12018-02-27 11:54:43 +01006315 addbool(m, "HAS_NPN", 1);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006316#else
Christian Heimes698dde12018-02-27 11:54:43 +01006317 addbool(m, "HAS_NPN", 0);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006318#endif
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006319
Christian Heimes29eab552018-02-25 12:31:33 +01006320#if HAVE_ALPN
Christian Heimes698dde12018-02-27 11:54:43 +01006321 addbool(m, "HAS_ALPN", 1);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006322#else
Christian Heimes698dde12018-02-27 11:54:43 +01006323 addbool(m, "HAS_ALPN", 0);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006324#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006325
6326#if defined(SSL2_VERSION) && !defined(OPENSSL_NO_SSL2)
6327 addbool(m, "HAS_SSLv2", 1);
6328#else
6329 addbool(m, "HAS_SSLv2", 0);
6330#endif
6331
6332#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
6333 addbool(m, "HAS_SSLv3", 1);
6334#else
6335 addbool(m, "HAS_SSLv3", 0);
6336#endif
6337
6338#if defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
6339 addbool(m, "HAS_TLSv1", 1);
6340#else
6341 addbool(m, "HAS_TLSv1", 0);
6342#endif
6343
6344#if defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
6345 addbool(m, "HAS_TLSv1_1", 1);
6346#else
6347 addbool(m, "HAS_TLSv1_1", 0);
6348#endif
6349
6350#if defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
6351 addbool(m, "HAS_TLSv1_2", 1);
6352#else
6353 addbool(m, "HAS_TLSv1_2", 0);
6354#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05006355
Christian Heimescb5b68a2017-09-07 18:07:00 -07006356#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
Christian Heimes698dde12018-02-27 11:54:43 +01006357 addbool(m, "HAS_TLSv1_3", 1);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006358#else
Christian Heimes698dde12018-02-27 11:54:43 +01006359 addbool(m, "HAS_TLSv1_3", 0);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006360#endif
Christian Heimescb5b68a2017-09-07 18:07:00 -07006361
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006362 /* Mappings for error codes */
6363 err_codes_to_names = PyDict_New();
6364 err_names_to_codes = PyDict_New();
6365 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
6366 return NULL;
6367 errcode = error_codes;
6368 while (errcode->mnemonic != NULL) {
6369 PyObject *mnemo, *key;
6370 mnemo = PyUnicode_FromString(errcode->mnemonic);
6371 key = Py_BuildValue("ii", errcode->library, errcode->reason);
6372 if (mnemo == NULL || key == NULL)
6373 return NULL;
6374 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
6375 return NULL;
6376 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
6377 return NULL;
6378 Py_DECREF(key);
6379 Py_DECREF(mnemo);
6380 errcode++;
6381 }
6382 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
6383 return NULL;
6384 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
6385 return NULL;
6386
6387 lib_codes_to_names = PyDict_New();
6388 if (lib_codes_to_names == NULL)
6389 return NULL;
6390 libcode = library_codes;
6391 while (libcode->library != NULL) {
6392 PyObject *mnemo, *key;
6393 key = PyLong_FromLong(libcode->code);
6394 mnemo = PyUnicode_FromString(libcode->library);
6395 if (key == NULL || mnemo == NULL)
6396 return NULL;
6397 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
6398 return NULL;
6399 Py_DECREF(key);
6400 Py_DECREF(mnemo);
6401 libcode++;
6402 }
6403 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
6404 return NULL;
Victor Stinner4569cd52013-06-23 14:58:43 +02006405
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006406 /* OpenSSL version */
6407 /* SSLeay() gives us the version of the library linked against,
6408 which could be different from the headers version.
6409 */
Christian Heimesa871f692020-06-01 08:58:14 +02006410 libver = OpenSSL_version_num();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006411 r = PyLong_FromUnsignedLong(libver);
6412 if (r == NULL)
6413 return NULL;
6414 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
6415 return NULL;
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006416 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006417 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6418 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
6419 return NULL;
Christian Heimesa871f692020-06-01 08:58:14 +02006420 r = PyUnicode_FromString(OpenSSL_version(OPENSSL_VERSION));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006421 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
6422 return NULL;
Antoine Pitrou04f6a322010-04-05 21:40:07 +00006423
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006424 libver = OPENSSL_VERSION_NUMBER;
6425 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
6426 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6427 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
6428 return NULL;
6429
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006430 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006431}