blob: 6f799ee66185200af4a9bcf3d1287fcf271f8e65 [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
Christian Heimes5c36da72020-11-20 09:40:12 +0100490static PyTypeObject *PySSLContext_Type;
491static PyTypeObject *PySSLSocket_Type;
492static PyTypeObject *PySSLMemoryBIO_Type;
493static 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
Christian Heimes5c36da72020-11-20 09:40:12 +0100511class _ssl._SSLContext "PySSLContext *" "PySSLContext_Type"
512class _ssl._SSLSocket "PySSLSocket *" "PySSLSocket_Type"
513class _ssl.MemoryBIO "PySSLMemoryBIO *" "PySSLMemoryBIO_Type"
514class _ssl.SSLSession "PySSLSession *" "PySSLSession_Type"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300515[clinic start generated code]*/
Christian Heimes5c36da72020-11-20 09:40:12 +0100516/*[clinic end generated code: output=da39a3ee5e6b4b0d input=cc4883756da17954]*/
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 *);
Christian Heimes5c36da72020-11-20 09:40:12 +0100524#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[] = {
Inada Naoki926b0cb2019-04-17 08:39:46 +0900590 {Py_tp_doc, (void*)SSLError_doc},
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200591 {Py_tp_str, SSLError_str},
592 {0, 0},
593};
594
595static PyType_Spec sslerror_type_spec = {
596 "ssl.SSLError",
597 sizeof(PyOSErrorObject),
598 0,
599 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
600 sslerror_type_slots
601};
602
603static void
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700604fill_and_set_sslerror(PySSLSocket *sslsock, PyObject *type, int ssl_errno,
605 const char *errstr, int lineno, unsigned long errcode)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200606{
607 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700608 PyObject *verify_obj = NULL, *verify_code_obj = NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200609 PyObject *init_value, *msg, *key;
610 _Py_IDENTIFIER(reason);
611 _Py_IDENTIFIER(library);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700612 _Py_IDENTIFIER(verify_message);
613 _Py_IDENTIFIER(verify_code);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200614
615 if (errcode != 0) {
616 int lib, reason;
617
618 lib = ERR_GET_LIB(errcode);
619 reason = ERR_GET_REASON(errcode);
620 key = Py_BuildValue("ii", lib, reason);
621 if (key == NULL)
622 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300623 reason_obj = PyDict_GetItemWithError(err_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200624 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300625 if (reason_obj == NULL && PyErr_Occurred()) {
626 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200627 }
628 key = PyLong_FromLong(lib);
629 if (key == NULL)
630 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300631 lib_obj = PyDict_GetItemWithError(lib_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200632 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300633 if (lib_obj == NULL && PyErr_Occurred()) {
634 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200635 }
636 if (errstr == NULL)
637 errstr = ERR_reason_error_string(errcode);
638 }
639 if (errstr == NULL)
640 errstr = "unknown error";
641
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700642 /* verify code for cert validation error */
643 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
644 const char *verify_str = NULL;
645 long verify_code;
646
647 verify_code = SSL_get_verify_result(sslsock->ssl);
648 verify_code_obj = PyLong_FromLong(verify_code);
649 if (verify_code_obj == NULL) {
650 goto fail;
651 }
652
653 switch (verify_code) {
Christian Heimes09153602017-09-08 14:47:58 -0700654#ifdef X509_V_ERR_HOSTNAME_MISMATCH
655 /* OpenSSL >= 1.0.2, LibreSSL >= 2.5.3 */
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700656 case X509_V_ERR_HOSTNAME_MISMATCH:
657 verify_obj = PyUnicode_FromFormat(
658 "Hostname mismatch, certificate is not valid for '%S'.",
659 sslsock->server_hostname
660 );
661 break;
Christian Heimes09153602017-09-08 14:47:58 -0700662#endif
663#ifdef X509_V_ERR_IP_ADDRESS_MISMATCH
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700664 case X509_V_ERR_IP_ADDRESS_MISMATCH:
665 verify_obj = PyUnicode_FromFormat(
666 "IP address mismatch, certificate is not valid for '%S'.",
667 sslsock->server_hostname
668 );
669 break;
Christian Heimes09153602017-09-08 14:47:58 -0700670#endif
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700671 default:
672 verify_str = X509_verify_cert_error_string(verify_code);
673 if (verify_str != NULL) {
674 verify_obj = PyUnicode_FromString(verify_str);
675 } else {
676 verify_obj = Py_None;
677 Py_INCREF(verify_obj);
678 }
679 break;
680 }
681 if (verify_obj == NULL) {
682 goto fail;
683 }
684 }
685
686 if (verify_obj && reason_obj && lib_obj)
687 msg = PyUnicode_FromFormat("[%S: %S] %s: %S (_ssl.c:%d)",
688 lib_obj, reason_obj, errstr, verify_obj,
689 lineno);
690 else if (reason_obj && lib_obj)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200691 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
692 lib_obj, reason_obj, errstr, lineno);
693 else if (lib_obj)
694 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
695 lib_obj, errstr, lineno);
696 else
697 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200698 if (msg == NULL)
699 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100700
Paul Monsonfb7e7502019-05-15 15:38:55 -0700701 init_value = Py_BuildValue("iN", ERR_GET_REASON(ssl_errno), msg);
Victor Stinnerba9be472013-10-31 15:00:24 +0100702 if (init_value == NULL)
703 goto fail;
704
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200705 err_value = PyObject_CallObject(type, init_value);
706 Py_DECREF(init_value);
707 if (err_value == NULL)
708 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100709
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200710 if (reason_obj == NULL)
711 reason_obj = Py_None;
712 if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))
713 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700714
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200715 if (lib_obj == NULL)
716 lib_obj = Py_None;
717 if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))
718 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700719
720 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
721 /* Only set verify code / message for SSLCertVerificationError */
722 if (_PyObject_SetAttrId(err_value, &PyId_verify_code,
723 verify_code_obj))
724 goto fail;
725 if (_PyObject_SetAttrId(err_value, &PyId_verify_message, verify_obj))
726 goto fail;
727 }
728
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200729 PyErr_SetObject(type, err_value);
730fail:
731 Py_XDECREF(err_value);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700732 Py_XDECREF(verify_code_obj);
733 Py_XDECREF(verify_obj);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200734}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000735
Christian Heimesc7f70692019-05-31 11:44:05 +0200736static int
737PySSL_ChainExceptions(PySSLSocket *sslsock) {
738 if (sslsock->exc_type == NULL)
739 return 0;
740
741 _PyErr_ChainExceptions(sslsock->exc_type, sslsock->exc_value, sslsock->exc_tb);
742 sslsock->exc_type = NULL;
743 sslsock->exc_value = NULL;
744 sslsock->exc_tb = NULL;
745 return -1;
746}
747
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000748static PyObject *
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700749PySSL_SetError(PySSLSocket *sslsock, int ret, const char *filename, int lineno)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000750{
Antoine Pitrou41032a62011-10-27 23:56:55 +0200751 PyObject *type = PySSLErrorObject;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200752 char *errstr = NULL;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700753 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000754 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200755 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000756
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000757 assert(ret <= 0);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200758 e = ERR_peek_last_error();
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000759
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700760 if (sslsock->ssl != NULL) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700761 err = sslsock->err;
Thomas Woutersed03b412007-08-28 21:37:11 +0000762
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700763 switch (err.ssl) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000764 case SSL_ERROR_ZERO_RETURN:
Antoine Pitrou41032a62011-10-27 23:56:55 +0200765 errstr = "TLS/SSL connection has been closed (EOF)";
766 type = PySSLZeroReturnErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000767 p = PY_SSL_ERROR_ZERO_RETURN;
768 break;
769 case SSL_ERROR_WANT_READ:
770 errstr = "The operation did not complete (read)";
Antoine Pitrou41032a62011-10-27 23:56:55 +0200771 type = PySSLWantReadErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000772 p = PY_SSL_ERROR_WANT_READ;
773 break;
774 case SSL_ERROR_WANT_WRITE:
775 p = PY_SSL_ERROR_WANT_WRITE;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200776 type = PySSLWantWriteErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000777 errstr = "The operation did not complete (write)";
778 break;
779 case SSL_ERROR_WANT_X509_LOOKUP:
780 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000781 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000782 break;
783 case SSL_ERROR_WANT_CONNECT:
784 p = PY_SSL_ERROR_WANT_CONNECT;
785 errstr = "The operation did not complete (connect)";
786 break;
787 case SSL_ERROR_SYSCALL:
788 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000789 if (e == 0) {
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700790 PySocketSockObject *s = GET_SOCKET(sslsock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000791 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000792 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200793 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000794 errstr = "EOF occurred in violation of protocol";
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200795 } else if (s && ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000796 /* underlying BIO reported an I/O error */
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000797 ERR_clear_error();
Steve Dowere6eb48c2017-09-08 15:16:15 -0700798#ifdef MS_WINDOWS
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700799 if (err.ws) {
800 return PyErr_SetFromWindowsErr(err.ws);
801 }
Steve Dowere6eb48c2017-09-08 15:16:15 -0700802#endif
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700803 if (err.c) {
804 errno = err.c;
Steve Dowere6eb48c2017-09-08 15:16:15 -0700805 return PyErr_SetFromErrno(PyExc_OSError);
806 }
Dima Tisnek495bd032020-08-16 02:01:19 +0900807 else {
808 p = PY_SSL_ERROR_EOF;
809 type = PySSLEOFErrorObject;
810 errstr = "EOF occurred in violation of protocol";
811 }
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__);
Zackery Spytzc32f2972020-10-25 12:02:30 -0600901 goto error;
Christian Heimes61d478c2018-01-27 15:51:38 +0100902 }
903 }
904 if (self->ctx->check_hostname) {
905 X509_VERIFY_PARAM *param = SSL_get0_param(self->ssl);
906 if (ip == NULL) {
Christian Heimesd02ac252018-03-25 12:36:13 +0200907 if (!X509_VERIFY_PARAM_set1_host(param, server_hostname,
908 strlen(server_hostname))) {
Christian Heimes61d478c2018-01-27 15:51:38 +0100909 _setSSLError(NULL, 0, __FILE__, __LINE__);
910 goto error;
911 }
912 } else {
Christian Heimesa871f692020-06-01 08:58:14 +0200913 if (!X509_VERIFY_PARAM_set1_ip(param, ASN1_STRING_get0_data(ip),
Christian Heimes61d478c2018-01-27 15:51:38 +0100914 ASN1_STRING_length(ip))) {
915 _setSSLError(NULL, 0, __FILE__, __LINE__);
916 goto error;
917 }
918 }
919 }
920 retval = 0;
921 error:
922 if (ip != NULL) {
923 ASN1_OCTET_STRING_free(ip);
924 }
925 return retval;
926}
927
Antoine Pitrou152efa22010-05-16 18:19:27 +0000928static PySSLSocket *
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100929newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
Antoine Pitroud5323212010-10-22 18:19:07 +0000930 enum py_ssl_server_or_client socket_type,
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200931 char *server_hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +0100932 PyObject *owner, PyObject *session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200933 PySSLMemoryBIO *inbio, PySSLMemoryBIO *outbio)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000934{
Antoine Pitrou152efa22010-05-16 18:19:27 +0000935 PySSLSocket *self;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100936 SSL_CTX *ctx = sslctx->ctx;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700937 _PySSLError err = { 0 };
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000938
Christian Heimes5c36da72020-11-20 09:40:12 +0100939 self = PyObject_New(PySSLSocket, PySSLSocket_Type);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000940 if (self == NULL)
941 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000942
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000943 self->ssl = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000944 self->Socket = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100945 self->ctx = sslctx;
Nathaniel J. Smith65ece7c2017-06-07 23:30:43 -0700946 Py_INCREF(sslctx);
Antoine Pitrou860aee72013-09-29 19:52:45 +0200947 self->shutdown_seen_zero = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200948 self->owner = NULL;
Benjamin Peterson81b9ecd2016-08-15 21:55:37 -0700949 self->server_hostname = NULL;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700950 self->err = err;
Christian Heimesc7f70692019-05-31 11:44:05 +0200951 self->exc_type = NULL;
952 self->exc_value = NULL;
953 self->exc_tb = NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200954
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000955 /* Make sure the SSL error state is initialized */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000956 ERR_clear_error();
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000957
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000958 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitrou152efa22010-05-16 18:19:27 +0000959 self->ssl = SSL_new(ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000960 PySSL_END_ALLOW_THREADS
Zackery Spytz4c49da02018-12-07 03:11:30 -0700961 if (self->ssl == NULL) {
962 Py_DECREF(self);
963 _setSSLError(NULL, 0, __FILE__, __LINE__);
964 return NULL;
965 }
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200966 SSL_set_app_data(self->ssl, self);
967 if (sock) {
968 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
969 } else {
970 /* BIOs are reference counted and SSL_set_bio borrows our reference.
971 * To prevent a double free in memory_bio_dealloc() we need to take an
972 * extra reference here. */
Christian Heimes598894f2016-09-05 23:19:05 +0200973 BIO_up_ref(inbio->bio);
974 BIO_up_ref(outbio->bio);
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200975 SSL_set_bio(self->ssl, inbio->bio, outbio->bio);
976 }
Alex Gaynorf0422422018-05-14 11:51:45 -0400977 SSL_set_mode(self->ssl,
978 SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | SSL_MODE_AUTO_RETRY);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000979
Christian Heimesf0f59302019-07-01 08:29:17 +0200980#ifdef TLS1_3_VERSION
981 if (sslctx->post_handshake_auth == 1) {
982 if (socket_type == PY_SSL_SERVER) {
983 /* bpo-37428: OpenSSL does not ignore SSL_VERIFY_POST_HANDSHAKE.
984 * Set SSL_VERIFY_POST_HANDSHAKE flag only for server sockets and
985 * only in combination with SSL_VERIFY_PEER flag. */
986 int mode = SSL_get_verify_mode(self->ssl);
987 if (mode & SSL_VERIFY_PEER) {
988 int (*verify_cb)(int, X509_STORE_CTX *) = NULL;
989 verify_cb = SSL_get_verify_callback(self->ssl);
990 mode |= SSL_VERIFY_POST_HANDSHAKE;
991 SSL_set_verify(self->ssl, mode, verify_cb);
992 }
993 } else {
994 /* client socket */
995 SSL_set_post_handshake_auth(self->ssl, 1);
996 }
997 }
998#endif
999
Christian Heimes61d478c2018-01-27 15:51:38 +01001000 if (server_hostname != NULL) {
1001 if (_ssl_configure_hostname(self, server_hostname) < 0) {
1002 Py_DECREF(self);
1003 return NULL;
1004 }
1005 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001006 /* If the socket is in non-blocking mode or timeout mode, set the BIO
1007 * to non-blocking mode (blocking is the default)
1008 */
Victor Stinnere2452312015-03-28 03:00:46 +01001009 if (sock && sock->sock_timeout >= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001010 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
1011 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
1012 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +00001013
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001014 PySSL_BEGIN_ALLOW_THREADS
1015 if (socket_type == PY_SSL_CLIENT)
1016 SSL_set_connect_state(self->ssl);
1017 else
1018 SSL_set_accept_state(self->ssl);
1019 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +00001020
Antoine Pitroud6494802011-07-21 01:11:30 +02001021 self->socket_type = socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001022 if (sock != NULL) {
1023 self->Socket = PyWeakref_NewRef((PyObject *) sock, NULL);
1024 if (self->Socket == NULL) {
1025 Py_DECREF(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001026 return NULL;
1027 }
Victor Stinnera9eb38f2013-10-31 16:35:38 +01001028 }
Christian Heimes141c5e82018-02-24 21:10:57 +01001029 if (owner && owner != Py_None) {
1030 if (PySSL_set_owner(self, owner, NULL) == -1) {
1031 Py_DECREF(self);
1032 return NULL;
1033 }
1034 }
1035 if (session && session != Py_None) {
1036 if (PySSL_set_session(self, session, NULL) == -1) {
1037 Py_DECREF(self);
1038 return NULL;
1039 }
1040 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001041 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001042}
1043
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001044/* SSL object methods */
1045
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001046/*[clinic input]
1047_ssl._SSLSocket.do_handshake
1048[clinic start generated code]*/
1049
1050static PyObject *
1051_ssl__SSLSocket_do_handshake_impl(PySSLSocket *self)
1052/*[clinic end generated code: output=6c0898a8936548f6 input=d2d737de3df018c8]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001053{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001054 int ret;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001055 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001056 int sockstate, nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001057 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02001058 _PyTime_t timeout, deadline = 0;
1059 int has_timeout;
Antoine Pitroud3f8ab82010-04-24 21:26:44 +00001060
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001061 if (sock) {
1062 if (((PyObject*)sock) == Py_None) {
1063 _setSSLError("Underlying socket connection gone",
1064 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1065 return NULL;
1066 }
1067 Py_INCREF(sock);
1068
1069 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01001070 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001071 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1072 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001073 }
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001074
Victor Stinner14690702015-04-06 22:46:13 +02001075 timeout = GET_SOCKET_TIMEOUT(sock);
1076 has_timeout = (timeout > 0);
1077 if (has_timeout)
1078 deadline = _PyTime_GetMonotonicClock() + timeout;
1079
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001080 /* Actually negotiate SSL connection */
1081 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001082 do {
Bill Janssen6e027db2007-11-15 22:23:56 +00001083 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001084 ret = SSL_do_handshake(self->ssl);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001085 err = _PySSL_errno(ret < 1, self->ssl, ret);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001086 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001087 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001088
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001089 if (PyErr_CheckSignals())
1090 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001091
Victor Stinner14690702015-04-06 22:46:13 +02001092 if (has_timeout)
1093 timeout = deadline - _PyTime_GetMonotonicClock();
1094
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001095 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02001096 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001097 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02001098 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001099 } else {
1100 sockstate = SOCKET_OPERATION_OK;
1101 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02001102
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001103 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Christian Heimes03c8ddd2020-11-20 09:26:07 +01001104 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001105 ERRSTR("The handshake operation timed out"));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001106 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001107 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1108 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001109 ERRSTR("Underlying socket has been closed."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001110 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001111 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1112 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001113 ERRSTR("Underlying socket too large for select()."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001114 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001115 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1116 break;
1117 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07001118 } while (err.ssl == SSL_ERROR_WANT_READ ||
1119 err.ssl == SSL_ERROR_WANT_WRITE);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001120 Py_XDECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001121 if (ret < 1)
1122 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Christian Heimesc7f70692019-05-31 11:44:05 +02001123 if (PySSL_ChainExceptions(self) < 0)
1124 return NULL;
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02001125 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001126error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02001127 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02001128 PySSL_ChainExceptions(self);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001129 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001130}
1131
Thomas Woutersed03b412007-08-28 21:37:11 +00001132static PyObject *
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001133_asn1obj2py(const ASN1_OBJECT *name, int no_name)
1134{
1135 char buf[X509_NAME_MAXLEN];
1136 char *namebuf = buf;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001137 int buflen;
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001138 PyObject *name_obj = NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001139
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001140 buflen = OBJ_obj2txt(namebuf, X509_NAME_MAXLEN, name, no_name);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001141 if (buflen < 0) {
1142 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001143 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001144 }
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001145 /* initial buffer is too small for oid + terminating null byte */
1146 if (buflen > X509_NAME_MAXLEN - 1) {
1147 /* make OBJ_obj2txt() calculate the required buflen */
1148 buflen = OBJ_obj2txt(NULL, 0, name, no_name);
1149 /* allocate len + 1 for terminating NULL byte */
1150 namebuf = PyMem_Malloc(buflen + 1);
1151 if (namebuf == NULL) {
1152 PyErr_NoMemory();
1153 return NULL;
1154 }
1155 buflen = OBJ_obj2txt(namebuf, buflen + 1, name, no_name);
1156 if (buflen < 0) {
1157 _setSSLError(NULL, 0, __FILE__, __LINE__);
1158 goto done;
1159 }
1160 }
1161 if (!buflen && no_name) {
1162 Py_INCREF(Py_None);
1163 name_obj = Py_None;
1164 }
1165 else {
1166 name_obj = PyUnicode_FromStringAndSize(namebuf, buflen);
1167 }
1168
1169 done:
1170 if (buf != namebuf) {
1171 PyMem_Free(namebuf);
1172 }
1173 return name_obj;
1174}
1175
1176static PyObject *
1177_create_tuple_for_attribute(ASN1_OBJECT *name, ASN1_STRING *value)
1178{
1179 Py_ssize_t buflen;
1180 unsigned char *valuebuf = NULL;
1181 PyObject *attr;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001182
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001183 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
1184 if (buflen < 0) {
1185 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001186 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001187 }
Serhiy Storchakae503ca52017-09-05 01:28:53 +03001188 attr = Py_BuildValue("Ns#", _asn1obj2py(name, 0), valuebuf, buflen);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001189 OPENSSL_free(valuebuf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001190 return attr;
Thomas Woutersed03b412007-08-28 21:37:11 +00001191}
1192
1193static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001194_create_tuple_for_X509_NAME (X509_NAME *xname)
Thomas Woutersed03b412007-08-28 21:37:11 +00001195{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001196 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
1197 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
1198 PyObject *rdnt;
1199 PyObject *attr = NULL; /* tuple to hold an attribute */
1200 int entry_count = X509_NAME_entry_count(xname);
1201 X509_NAME_ENTRY *entry;
1202 ASN1_OBJECT *name;
1203 ASN1_STRING *value;
1204 int index_counter;
1205 int rdn_level = -1;
1206 int retcode;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001207
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001208 dn = PyList_New(0);
1209 if (dn == NULL)
1210 return NULL;
1211 /* now create another tuple to hold the top-level RDN */
1212 rdn = PyList_New(0);
1213 if (rdn == NULL)
1214 goto fail0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001215
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001216 for (index_counter = 0;
1217 index_counter < entry_count;
1218 index_counter++)
1219 {
1220 entry = X509_NAME_get_entry(xname, index_counter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001221
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001222 /* check to see if we've gotten to a new RDN */
1223 if (rdn_level >= 0) {
Christian Heimes598894f2016-09-05 23:19:05 +02001224 if (rdn_level != X509_NAME_ENTRY_set(entry)) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001225 /* yes, new RDN */
1226 /* add old RDN to DN */
1227 rdnt = PyList_AsTuple(rdn);
1228 Py_DECREF(rdn);
1229 if (rdnt == NULL)
1230 goto fail0;
1231 retcode = PyList_Append(dn, rdnt);
1232 Py_DECREF(rdnt);
1233 if (retcode < 0)
1234 goto fail0;
1235 /* create new RDN */
1236 rdn = PyList_New(0);
1237 if (rdn == NULL)
1238 goto fail0;
1239 }
1240 }
Christian Heimes598894f2016-09-05 23:19:05 +02001241 rdn_level = X509_NAME_ENTRY_set(entry);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001242
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001243 /* now add this attribute to the current RDN */
1244 name = X509_NAME_ENTRY_get_object(entry);
1245 value = X509_NAME_ENTRY_get_data(entry);
1246 attr = _create_tuple_for_attribute(name, value);
1247 /*
1248 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
1249 entry->set,
1250 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
1251 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
1252 */
1253 if (attr == NULL)
1254 goto fail1;
1255 retcode = PyList_Append(rdn, attr);
1256 Py_DECREF(attr);
1257 if (retcode < 0)
1258 goto fail1;
1259 }
1260 /* now, there's typically a dangling RDN */
Antoine Pitrou2f5a1632012-02-15 22:25:27 +01001261 if (rdn != NULL) {
1262 if (PyList_GET_SIZE(rdn) > 0) {
1263 rdnt = PyList_AsTuple(rdn);
1264 Py_DECREF(rdn);
1265 if (rdnt == NULL)
1266 goto fail0;
1267 retcode = PyList_Append(dn, rdnt);
1268 Py_DECREF(rdnt);
1269 if (retcode < 0)
1270 goto fail0;
1271 }
1272 else {
1273 Py_DECREF(rdn);
1274 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001275 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001276
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001277 /* convert list to tuple */
1278 rdnt = PyList_AsTuple(dn);
1279 Py_DECREF(dn);
1280 if (rdnt == NULL)
1281 return NULL;
1282 return rdnt;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001283
1284 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001285 Py_XDECREF(rdn);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001286
1287 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001288 Py_XDECREF(dn);
1289 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001290}
1291
1292static PyObject *
1293_get_peer_alt_names (X509 *certificate) {
Guido van Rossumf06628b2007-11-21 20:01:53 +00001294
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001295 /* this code follows the procedure outlined in
1296 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
1297 function to extract the STACK_OF(GENERAL_NAME),
1298 then iterates through the stack to add the
1299 names. */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001300
Alex Gaynorb87c0df2017-06-06 07:53:11 -04001301 int j;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001302 PyObject *peer_alt_names = Py_None;
Christian Heimes60bf2fc2013-09-05 16:04:35 +02001303 PyObject *v = NULL, *t;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001304 GENERAL_NAMES *names = NULL;
1305 GENERAL_NAME *name;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001306 BIO *biobuf = NULL;
1307 char buf[2048];
1308 char *vptr;
1309 int len;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001310
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001311 if (certificate == NULL)
1312 return peer_alt_names;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001313
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001314 /* get a memory buffer */
1315 biobuf = BIO_new(BIO_s_mem());
Zackery Spytz4c49da02018-12-07 03:11:30 -07001316 if (biobuf == NULL) {
1317 PyErr_SetString(PySSLErrorObject, "failed to allocate BIO");
1318 return NULL;
1319 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001320
Alex Gaynorb87c0df2017-06-06 07:53:11 -04001321 names = (GENERAL_NAMES *)X509_get_ext_d2i(
1322 certificate, NID_subject_alt_name, NULL, NULL);
1323 if (names != NULL) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001324 if (peer_alt_names == Py_None) {
1325 peer_alt_names = PyList_New(0);
1326 if (peer_alt_names == NULL)
1327 goto fail;
1328 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001329
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001330 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001331 /* get a rendering of each name in the set of names */
Christian Heimes824f7f32013-08-17 00:54:47 +02001332 int gntype;
1333 ASN1_STRING *as = NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001334
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001335 name = sk_GENERAL_NAME_value(names, j);
Christian Heimes474afdd2013-08-17 17:18:56 +02001336 gntype = name->type;
Christian Heimes824f7f32013-08-17 00:54:47 +02001337 switch (gntype) {
1338 case GEN_DIRNAME:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001339 /* we special-case DirName as a tuple of
1340 tuples of attributes */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001341
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001342 t = PyTuple_New(2);
1343 if (t == NULL) {
1344 goto fail;
1345 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001346
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001347 v = PyUnicode_FromString("DirName");
1348 if (v == NULL) {
1349 Py_DECREF(t);
1350 goto fail;
1351 }
1352 PyTuple_SET_ITEM(t, 0, v);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001353
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001354 v = _create_tuple_for_X509_NAME (name->d.dirn);
1355 if (v == NULL) {
1356 Py_DECREF(t);
1357 goto fail;
1358 }
1359 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +02001360 break;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001361
Christian Heimes824f7f32013-08-17 00:54:47 +02001362 case GEN_EMAIL:
1363 case GEN_DNS:
1364 case GEN_URI:
1365 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
1366 correctly, CVE-2013-4238 */
1367 t = PyTuple_New(2);
1368 if (t == NULL)
1369 goto fail;
1370 switch (gntype) {
1371 case GEN_EMAIL:
1372 v = PyUnicode_FromString("email");
1373 as = name->d.rfc822Name;
1374 break;
1375 case GEN_DNS:
1376 v = PyUnicode_FromString("DNS");
1377 as = name->d.dNSName;
1378 break;
1379 case GEN_URI:
1380 v = PyUnicode_FromString("URI");
1381 as = name->d.uniformResourceIdentifier;
1382 break;
1383 }
1384 if (v == NULL) {
1385 Py_DECREF(t);
1386 goto fail;
1387 }
1388 PyTuple_SET_ITEM(t, 0, v);
Christian Heimesa871f692020-06-01 08:58:14 +02001389 v = PyUnicode_FromStringAndSize((char *)ASN1_STRING_get0_data(as),
Christian Heimes824f7f32013-08-17 00:54:47 +02001390 ASN1_STRING_length(as));
1391 if (v == NULL) {
1392 Py_DECREF(t);
1393 goto fail;
1394 }
1395 PyTuple_SET_ITEM(t, 1, v);
1396 break;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001397
Christian Heimes1c03abd2016-09-06 23:25:35 +02001398 case GEN_RID:
1399 t = PyTuple_New(2);
1400 if (t == NULL)
1401 goto fail;
1402
1403 v = PyUnicode_FromString("Registered ID");
1404 if (v == NULL) {
1405 Py_DECREF(t);
1406 goto fail;
1407 }
1408 PyTuple_SET_ITEM(t, 0, v);
1409
1410 len = i2t_ASN1_OBJECT(buf, sizeof(buf)-1, name->d.rid);
1411 if (len < 0) {
1412 Py_DECREF(t);
1413 _setSSLError(NULL, 0, __FILE__, __LINE__);
1414 goto fail;
1415 } else if (len >= (int)sizeof(buf)) {
1416 v = PyUnicode_FromString("<INVALID>");
1417 } else {
1418 v = PyUnicode_FromStringAndSize(buf, len);
1419 }
1420 if (v == NULL) {
1421 Py_DECREF(t);
1422 goto fail;
1423 }
1424 PyTuple_SET_ITEM(t, 1, v);
1425 break;
1426
Christian Heimes2b7de662019-12-07 17:59:36 +01001427 case GEN_IPADD:
1428 /* OpenSSL < 3.0.0 adds a trailing \n to IPv6. 3.0.0 removed
1429 * the trailing newline. Remove it in all versions
1430 */
1431 t = PyTuple_New(2);
1432 if (t == NULL)
1433 goto fail;
1434
1435 v = PyUnicode_FromString("IP Address");
1436 if (v == NULL) {
1437 Py_DECREF(t);
1438 goto fail;
1439 }
1440 PyTuple_SET_ITEM(t, 0, v);
1441
1442 if (name->d.ip->length == 4) {
1443 unsigned char *p = name->d.ip->data;
1444 v = PyUnicode_FromFormat(
1445 "%d.%d.%d.%d",
1446 p[0], p[1], p[2], p[3]
1447 );
1448 } else if (name->d.ip->length == 16) {
1449 /* PyUnicode_FromFormat() does not support %X */
1450 unsigned char *p = name->d.ip->data;
1451 len = sprintf(
1452 buf,
1453 "%X:%X:%X:%X:%X:%X:%X:%X",
1454 p[0] << 8 | p[1],
1455 p[2] << 8 | p[3],
1456 p[4] << 8 | p[5],
1457 p[6] << 8 | p[7],
1458 p[8] << 8 | p[9],
1459 p[10] << 8 | p[11],
1460 p[12] << 8 | p[13],
1461 p[14] << 8 | p[15]
1462 );
1463 v = PyUnicode_FromStringAndSize(buf, len);
1464 } else {
1465 v = PyUnicode_FromString("<invalid>");
1466 }
1467
1468 if (v == NULL) {
1469 Py_DECREF(t);
1470 goto fail;
1471 }
1472 PyTuple_SET_ITEM(t, 1, v);
1473 break;
1474
Christian Heimes824f7f32013-08-17 00:54:47 +02001475 default:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001476 /* for everything else, we use the OpenSSL print form */
Christian Heimes824f7f32013-08-17 00:54:47 +02001477 switch (gntype) {
1478 /* check for new general name type */
1479 case GEN_OTHERNAME:
1480 case GEN_X400:
1481 case GEN_EDIPARTY:
Christian Heimes824f7f32013-08-17 00:54:47 +02001482 case GEN_RID:
1483 break;
1484 default:
1485 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
1486 "Unknown general name type %d",
1487 gntype) == -1) {
1488 goto fail;
1489 }
1490 break;
1491 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001492 (void) BIO_reset(biobuf);
1493 GENERAL_NAME_print(biobuf, name);
1494 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1495 if (len < 0) {
1496 _setSSLError(NULL, 0, __FILE__, __LINE__);
1497 goto fail;
1498 }
1499 vptr = strchr(buf, ':');
Christian Heimes1c03abd2016-09-06 23:25:35 +02001500 if (vptr == NULL) {
1501 PyErr_Format(PyExc_ValueError,
1502 "Invalid value %.200s",
1503 buf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001504 goto fail;
Christian Heimes1c03abd2016-09-06 23:25:35 +02001505 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001506 t = PyTuple_New(2);
1507 if (t == NULL)
1508 goto fail;
1509 v = PyUnicode_FromStringAndSize(buf, (vptr - buf));
1510 if (v == NULL) {
1511 Py_DECREF(t);
1512 goto fail;
1513 }
1514 PyTuple_SET_ITEM(t, 0, v);
1515 v = PyUnicode_FromStringAndSize((vptr + 1),
1516 (len - (vptr - buf + 1)));
1517 if (v == NULL) {
1518 Py_DECREF(t);
1519 goto fail;
1520 }
1521 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +02001522 break;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001523 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001524
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001525 /* and add that rendering to the list */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001526
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001527 if (PyList_Append(peer_alt_names, t) < 0) {
1528 Py_DECREF(t);
1529 goto fail;
1530 }
1531 Py_DECREF(t);
1532 }
Antoine Pitrou116d6b92011-11-23 01:39:19 +01001533 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001534 }
1535 BIO_free(biobuf);
1536 if (peer_alt_names != Py_None) {
1537 v = PyList_AsTuple(peer_alt_names);
1538 Py_DECREF(peer_alt_names);
1539 return v;
1540 } else {
1541 return peer_alt_names;
1542 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001543
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001544
1545 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001546 if (biobuf != NULL)
1547 BIO_free(biobuf);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001548
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001549 if (peer_alt_names != Py_None) {
1550 Py_XDECREF(peer_alt_names);
1551 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001552
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001553 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001554}
1555
1556static PyObject *
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001557_get_aia_uri(X509 *certificate, int nid) {
1558 PyObject *lst = NULL, *ostr = NULL;
1559 int i, result;
1560 AUTHORITY_INFO_ACCESS *info;
1561
1562 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
Benjamin Petersonf0c90382015-11-14 15:12:18 -08001563 if (info == NULL)
1564 return Py_None;
1565 if (sk_ACCESS_DESCRIPTION_num(info) == 0) {
1566 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001567 return Py_None;
1568 }
1569
1570 if ((lst = PyList_New(0)) == NULL) {
1571 goto fail;
1572 }
1573
1574 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
1575 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
1576 ASN1_IA5STRING *uri;
1577
1578 if ((OBJ_obj2nid(ad->method) != nid) ||
1579 (ad->location->type != GEN_URI)) {
1580 continue;
1581 }
1582 uri = ad->location->d.uniformResourceIdentifier;
1583 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
1584 uri->length);
1585 if (ostr == NULL) {
1586 goto fail;
1587 }
1588 result = PyList_Append(lst, ostr);
1589 Py_DECREF(ostr);
1590 if (result < 0) {
1591 goto fail;
1592 }
1593 }
1594 AUTHORITY_INFO_ACCESS_free(info);
1595
1596 /* convert to tuple or None */
1597 if (PyList_Size(lst) == 0) {
1598 Py_DECREF(lst);
1599 return Py_None;
1600 } else {
1601 PyObject *tup;
1602 tup = PyList_AsTuple(lst);
1603 Py_DECREF(lst);
1604 return tup;
1605 }
1606
1607 fail:
1608 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimes18fc7be2013-11-21 23:57:49 +01001609 Py_XDECREF(lst);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001610 return NULL;
1611}
1612
1613static PyObject *
1614_get_crl_dp(X509 *certificate) {
1615 STACK_OF(DIST_POINT) *dps;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001616 int i, j;
1617 PyObject *lst, *res = NULL;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001618
Christian Heimes598894f2016-09-05 23:19:05 +02001619 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points, NULL, NULL);
Christian Heimes949ec142013-11-21 16:26:51 +01001620
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001621 if (dps == NULL)
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001622 return Py_None;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001623
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001624 lst = PyList_New(0);
1625 if (lst == NULL)
1626 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001627
1628 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1629 DIST_POINT *dp;
1630 STACK_OF(GENERAL_NAME) *gns;
1631
1632 dp = sk_DIST_POINT_value(dps, i);
Christian Heimesa37f5242019-01-15 23:47:42 +01001633 if (dp->distpoint == NULL) {
1634 /* Ignore empty DP value, CVE-2019-5010 */
1635 continue;
1636 }
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001637 gns = dp->distpoint->name.fullname;
1638
1639 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1640 GENERAL_NAME *gn;
1641 ASN1_IA5STRING *uri;
1642 PyObject *ouri;
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001643 int err;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001644
1645 gn = sk_GENERAL_NAME_value(gns, j);
1646 if (gn->type != GEN_URI) {
1647 continue;
1648 }
1649 uri = gn->d.uniformResourceIdentifier;
1650 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1651 uri->length);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001652 if (ouri == NULL)
1653 goto done;
1654
1655 err = PyList_Append(lst, ouri);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001656 Py_DECREF(ouri);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001657 if (err < 0)
1658 goto done;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001659 }
1660 }
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001661
1662 /* Convert to tuple. */
1663 res = (PyList_GET_SIZE(lst) > 0) ? PyList_AsTuple(lst) : Py_None;
1664
1665 done:
1666 Py_XDECREF(lst);
Olivier Vielpeau2849cc32017-04-14 21:06:07 -04001667 CRL_DIST_POINTS_free(dps);
Benjamin Petersoneda06c82015-11-11 22:07:38 -08001668 return res;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001669}
1670
1671static PyObject *
Antoine Pitroufb046912010-11-09 20:21:19 +00001672_decode_certificate(X509 *certificate) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001673
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001674 PyObject *retval = NULL;
1675 BIO *biobuf = NULL;
1676 PyObject *peer;
1677 PyObject *peer_alt_names = NULL;
1678 PyObject *issuer;
1679 PyObject *version;
1680 PyObject *sn_obj;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001681 PyObject *obj;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001682 ASN1_INTEGER *serialNumber;
1683 char buf[2048];
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001684 int len, result;
Christian Heimesa871f692020-06-01 08:58:14 +02001685 const ASN1_TIME *notBefore, *notAfter;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001686 PyObject *pnotBefore, *pnotAfter;
Thomas Woutersed03b412007-08-28 21:37:11 +00001687
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001688 retval = PyDict_New();
1689 if (retval == NULL)
1690 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001691
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001692 peer = _create_tuple_for_X509_NAME(
1693 X509_get_subject_name(certificate));
1694 if (peer == NULL)
1695 goto fail0;
1696 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1697 Py_DECREF(peer);
1698 goto fail0;
1699 }
1700 Py_DECREF(peer);
Thomas Woutersed03b412007-08-28 21:37:11 +00001701
Antoine Pitroufb046912010-11-09 20:21:19 +00001702 issuer = _create_tuple_for_X509_NAME(
1703 X509_get_issuer_name(certificate));
1704 if (issuer == NULL)
1705 goto fail0;
1706 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001707 Py_DECREF(issuer);
Antoine Pitroufb046912010-11-09 20:21:19 +00001708 goto fail0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001709 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001710 Py_DECREF(issuer);
1711
1712 version = PyLong_FromLong(X509_get_version(certificate) + 1);
Christian Heimes5962bef2013-07-26 15:51:18 +02001713 if (version == NULL)
1714 goto fail0;
Antoine Pitroufb046912010-11-09 20:21:19 +00001715 if (PyDict_SetItemString(retval, "version", version) < 0) {
1716 Py_DECREF(version);
1717 goto fail0;
1718 }
1719 Py_DECREF(version);
Guido van Rossumf06628b2007-11-21 20:01:53 +00001720
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001721 /* get a memory buffer */
1722 biobuf = BIO_new(BIO_s_mem());
Zackery Spytz4c49da02018-12-07 03:11:30 -07001723 if (biobuf == NULL) {
1724 PyErr_SetString(PySSLErrorObject, "failed to allocate BIO");
1725 goto fail0;
1726 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001727
Antoine Pitroufb046912010-11-09 20:21:19 +00001728 (void) BIO_reset(biobuf);
1729 serialNumber = X509_get_serialNumber(certificate);
1730 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1731 i2a_ASN1_INTEGER(biobuf, serialNumber);
1732 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1733 if (len < 0) {
1734 _setSSLError(NULL, 0, __FILE__, __LINE__);
1735 goto fail1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001736 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001737 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1738 if (sn_obj == NULL)
1739 goto fail1;
1740 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1741 Py_DECREF(sn_obj);
1742 goto fail1;
1743 }
1744 Py_DECREF(sn_obj);
1745
1746 (void) BIO_reset(biobuf);
Christian Heimesa871f692020-06-01 08:58:14 +02001747 notBefore = X509_get0_notBefore(certificate);
Antoine Pitroufb046912010-11-09 20:21:19 +00001748 ASN1_TIME_print(biobuf, notBefore);
1749 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1750 if (len < 0) {
1751 _setSSLError(NULL, 0, __FILE__, __LINE__);
1752 goto fail1;
1753 }
1754 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1755 if (pnotBefore == NULL)
1756 goto fail1;
1757 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1758 Py_DECREF(pnotBefore);
1759 goto fail1;
1760 }
1761 Py_DECREF(pnotBefore);
Thomas Woutersed03b412007-08-28 21:37:11 +00001762
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001763 (void) BIO_reset(biobuf);
Christian Heimesa871f692020-06-01 08:58:14 +02001764 notAfter = X509_get0_notAfter(certificate);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001765 ASN1_TIME_print(biobuf, notAfter);
1766 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1767 if (len < 0) {
1768 _setSSLError(NULL, 0, __FILE__, __LINE__);
1769 goto fail1;
1770 }
1771 pnotAfter = PyUnicode_FromStringAndSize(buf, len);
1772 if (pnotAfter == NULL)
1773 goto fail1;
1774 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1775 Py_DECREF(pnotAfter);
1776 goto fail1;
1777 }
1778 Py_DECREF(pnotAfter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001779
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001780 /* Now look for subjectAltName */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001781
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001782 peer_alt_names = _get_peer_alt_names(certificate);
1783 if (peer_alt_names == NULL)
1784 goto fail1;
1785 else if (peer_alt_names != Py_None) {
1786 if (PyDict_SetItemString(retval, "subjectAltName",
1787 peer_alt_names) < 0) {
1788 Py_DECREF(peer_alt_names);
1789 goto fail1;
1790 }
1791 Py_DECREF(peer_alt_names);
1792 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001793
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001794 /* Authority Information Access: OCSP URIs */
1795 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1796 if (obj == NULL) {
1797 goto fail1;
1798 } else if (obj != Py_None) {
1799 result = PyDict_SetItemString(retval, "OCSP", obj);
1800 Py_DECREF(obj);
1801 if (result < 0) {
1802 goto fail1;
1803 }
1804 }
1805
1806 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1807 if (obj == NULL) {
1808 goto fail1;
1809 } else if (obj != Py_None) {
1810 result = PyDict_SetItemString(retval, "caIssuers", obj);
1811 Py_DECREF(obj);
1812 if (result < 0) {
1813 goto fail1;
1814 }
1815 }
1816
1817 /* CDP (CRL distribution points) */
1818 obj = _get_crl_dp(certificate);
1819 if (obj == NULL) {
1820 goto fail1;
1821 } else if (obj != Py_None) {
1822 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1823 Py_DECREF(obj);
1824 if (result < 0) {
1825 goto fail1;
1826 }
1827 }
1828
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001829 BIO_free(biobuf);
1830 return retval;
Thomas Woutersed03b412007-08-28 21:37:11 +00001831
1832 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001833 if (biobuf != NULL)
1834 BIO_free(biobuf);
Thomas Woutersed03b412007-08-28 21:37:11 +00001835 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001836 Py_XDECREF(retval);
1837 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001838}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001839
Christian Heimes9a5395a2013-06-17 15:44:12 +02001840static PyObject *
1841_certificate_to_der(X509 *certificate)
1842{
1843 unsigned char *bytes_buf = NULL;
1844 int len;
1845 PyObject *retval;
1846
1847 bytes_buf = NULL;
1848 len = i2d_X509(certificate, &bytes_buf);
1849 if (len < 0) {
1850 _setSSLError(NULL, 0, __FILE__, __LINE__);
1851 return NULL;
1852 }
1853 /* this is actually an immutable bytes sequence */
1854 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1855 OPENSSL_free(bytes_buf);
1856 return retval;
1857}
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001858
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001859/*[clinic input]
1860_ssl._test_decode_cert
1861 path: object(converter="PyUnicode_FSConverter")
1862 /
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001863
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001864[clinic start generated code]*/
1865
1866static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03001867_ssl__test_decode_cert_impl(PyObject *module, PyObject *path)
1868/*[clinic end generated code: output=96becb9abb23c091 input=cdeaaf02d4346628]*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001869{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001870 PyObject *retval = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001871 X509 *x=NULL;
1872 BIO *cert;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001873
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001874 if ((cert=BIO_new(BIO_s_file())) == NULL) {
1875 PyErr_SetString(PySSLErrorObject,
1876 "Can't malloc memory to read file");
1877 goto fail0;
1878 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001879
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001880 if (BIO_read_filename(cert, PyBytes_AsString(path)) <= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001881 PyErr_SetString(PySSLErrorObject,
1882 "Can't open file");
1883 goto fail0;
1884 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001885
Alex Gaynor40dad952019-08-15 08:31:28 -04001886 x = PEM_read_bio_X509(cert, NULL, NULL, NULL);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001887 if (x == NULL) {
1888 PyErr_SetString(PySSLErrorObject,
1889 "Error decoding PEM-encoded file");
1890 goto fail0;
1891 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001892
Antoine Pitroufb046912010-11-09 20:21:19 +00001893 retval = _decode_certificate(x);
Mark Dickinsonee55df52010-08-03 18:31:54 +00001894 X509_free(x);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001895
1896 fail0:
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001897 Py_DECREF(path);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001898 if (cert != NULL) BIO_free(cert);
1899 return retval;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001900}
1901
1902
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001903/*[clinic input]
Christian Heimes141c5e82018-02-24 21:10:57 +01001904_ssl._SSLSocket.getpeercert
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03001905 der as binary_mode: bool = False
1906 /
1907
1908Returns the certificate for the peer.
1909
1910If no certificate was provided, returns None. If a certificate was
1911provided, but not validated, returns an empty dictionary. Otherwise
1912returns a dict containing information about the peer certificate.
1913
1914If the optional argument is True, returns a DER-encoded copy of the
1915peer certificate, or None if no certificate was provided. This will
1916return the certificate even if it wasn't validated.
1917[clinic start generated code]*/
1918
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001919static PyObject *
Christian Heimes141c5e82018-02-24 21:10:57 +01001920_ssl__SSLSocket_getpeercert_impl(PySSLSocket *self, int binary_mode)
1921/*[clinic end generated code: output=1f0ab66dfb693c88 input=c0fbe802e57629b7]*/
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001922{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001923 int verification;
Christian Heimes66dc33b2017-05-23 16:02:02 -07001924 X509 *peer_cert;
1925 PyObject *result;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001926
Christian Heimes66dc33b2017-05-23 16:02:02 -07001927 if (!SSL_is_init_finished(self->ssl)) {
Antoine Pitrou20b85552013-09-29 19:50:53 +02001928 PyErr_SetString(PyExc_ValueError,
1929 "handshake not done yet");
1930 return NULL;
1931 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07001932 peer_cert = SSL_get_peer_certificate(self->ssl);
1933 if (peer_cert == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001934 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001935
Antoine Pitrou721738f2012-08-15 23:20:39 +02001936 if (binary_mode) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001937 /* return cert in DER-encoded format */
Christian Heimes66dc33b2017-05-23 16:02:02 -07001938 result = _certificate_to_der(peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001939 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00001940 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001941 if ((verification & SSL_VERIFY_PEER) == 0)
Christian Heimes66dc33b2017-05-23 16:02:02 -07001942 result = PyDict_New();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001943 else
Christian Heimes66dc33b2017-05-23 16:02:02 -07001944 result = _decode_certificate(peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001945 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07001946 X509_free(peer_cert);
1947 return result;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001948}
1949
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001950static PyObject *
1951cipher_to_tuple(const SSL_CIPHER *cipher)
1952{
1953 const char *cipher_name, *cipher_protocol;
1954 PyObject *v, *retval = PyTuple_New(3);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001955 if (retval == NULL)
1956 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001957
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001958 cipher_name = SSL_CIPHER_get_name(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001959 if (cipher_name == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001960 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001961 PyTuple_SET_ITEM(retval, 0, Py_None);
1962 } else {
1963 v = PyUnicode_FromString(cipher_name);
1964 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001965 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001966 PyTuple_SET_ITEM(retval, 0, v);
1967 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001968
1969 cipher_protocol = SSL_CIPHER_get_version(cipher);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001970 if (cipher_protocol == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001971 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001972 PyTuple_SET_ITEM(retval, 1, Py_None);
1973 } else {
1974 v = PyUnicode_FromString(cipher_protocol);
1975 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001976 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001977 PyTuple_SET_ITEM(retval, 1, v);
1978 }
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001979
1980 v = PyLong_FromLong(SSL_CIPHER_get_bits(cipher, NULL));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001981 if (v == NULL)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001982 goto fail;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001983 PyTuple_SET_ITEM(retval, 2, v);
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001984
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001985 return retval;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001986
Benjamin Peterson4cb17812015-01-07 11:14:26 -06001987 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001988 Py_DECREF(retval);
1989 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001990}
1991
Christian Heimes25bfcd52016-09-06 00:04:45 +02001992#if OPENSSL_VERSION_NUMBER >= 0x10002000UL
1993static PyObject *
1994cipher_to_dict(const SSL_CIPHER *cipher)
1995{
1996 const char *cipher_name, *cipher_protocol;
1997
1998 unsigned long cipher_id;
1999 int alg_bits, strength_bits, len;
2000 char buf[512] = {0};
2001#if OPENSSL_VERSION_1_1
2002 int aead, nid;
2003 const char *skcipher = NULL, *digest = NULL, *kx = NULL, *auth = NULL;
2004#endif
Christian Heimes25bfcd52016-09-06 00:04:45 +02002005
2006 /* can be NULL */
2007 cipher_name = SSL_CIPHER_get_name(cipher);
2008 cipher_protocol = SSL_CIPHER_get_version(cipher);
2009 cipher_id = SSL_CIPHER_get_id(cipher);
2010 SSL_CIPHER_description(cipher, buf, sizeof(buf) - 1);
Segev Finer5cff6372017-07-27 01:19:17 +03002011 /* Downcast to avoid a warning. Safe since buf is always 512 bytes */
2012 len = (int)strlen(buf);
Christian Heimes25bfcd52016-09-06 00:04:45 +02002013 if (len > 1 && buf[len-1] == '\n')
2014 buf[len-1] = '\0';
2015 strength_bits = SSL_CIPHER_get_bits(cipher, &alg_bits);
2016
2017#if OPENSSL_VERSION_1_1
2018 aead = SSL_CIPHER_is_aead(cipher);
2019 nid = SSL_CIPHER_get_cipher_nid(cipher);
2020 skcipher = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2021 nid = SSL_CIPHER_get_digest_nid(cipher);
2022 digest = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2023 nid = SSL_CIPHER_get_kx_nid(cipher);
2024 kx = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2025 nid = SSL_CIPHER_get_auth_nid(cipher);
2026 auth = nid != NID_undef ? OBJ_nid2ln(nid) : NULL;
2027#endif
2028
Victor Stinner410b9882016-09-12 12:00:23 +02002029 return Py_BuildValue(
Christian Heimes25bfcd52016-09-06 00:04:45 +02002030 "{sksssssssisi"
2031#if OPENSSL_VERSION_1_1
2032 "sOssssssss"
2033#endif
2034 "}",
2035 "id", cipher_id,
2036 "name", cipher_name,
2037 "protocol", cipher_protocol,
2038 "description", buf,
2039 "strength_bits", strength_bits,
2040 "alg_bits", alg_bits
2041#if OPENSSL_VERSION_1_1
2042 ,"aead", aead ? Py_True : Py_False,
2043 "symmetric", skcipher,
2044 "digest", digest,
2045 "kea", kx,
2046 "auth", auth
2047#endif
2048 );
Christian Heimes25bfcd52016-09-06 00:04:45 +02002049}
2050#endif
2051
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002052/*[clinic input]
2053_ssl._SSLSocket.shared_ciphers
2054[clinic start generated code]*/
2055
2056static PyObject *
2057_ssl__SSLSocket_shared_ciphers_impl(PySSLSocket *self)
2058/*[clinic end generated code: output=3d174ead2e42c4fd input=0bfe149da8fe6306]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002059{
2060 STACK_OF(SSL_CIPHER) *ciphers;
2061 int i;
2062 PyObject *res;
2063
Christian Heimes598894f2016-09-05 23:19:05 +02002064 ciphers = SSL_get_ciphers(self->ssl);
2065 if (!ciphers)
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002066 Py_RETURN_NONE;
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002067 res = PyList_New(sk_SSL_CIPHER_num(ciphers));
2068 if (!res)
2069 return NULL;
2070 for (i = 0; i < sk_SSL_CIPHER_num(ciphers); i++) {
2071 PyObject *tup = cipher_to_tuple(sk_SSL_CIPHER_value(ciphers, i));
2072 if (!tup) {
2073 Py_DECREF(res);
2074 return NULL;
2075 }
2076 PyList_SET_ITEM(res, i, tup);
2077 }
2078 return res;
2079}
2080
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002081/*[clinic input]
2082_ssl._SSLSocket.cipher
2083[clinic start generated code]*/
2084
2085static PyObject *
2086_ssl__SSLSocket_cipher_impl(PySSLSocket *self)
2087/*[clinic end generated code: output=376417c16d0e5815 input=548fb0e27243796d]*/
Benjamin Peterson4cb17812015-01-07 11:14:26 -06002088{
2089 const SSL_CIPHER *current;
2090
2091 if (self->ssl == NULL)
2092 Py_RETURN_NONE;
2093 current = SSL_get_current_cipher(self->ssl);
2094 if (current == NULL)
2095 Py_RETURN_NONE;
2096 return cipher_to_tuple(current);
2097}
2098
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002099/*[clinic input]
2100_ssl._SSLSocket.version
2101[clinic start generated code]*/
2102
2103static PyObject *
2104_ssl__SSLSocket_version_impl(PySSLSocket *self)
2105/*[clinic end generated code: output=178aed33193b2cdb input=900186a503436fd6]*/
Antoine Pitrou47e40422014-09-04 21:00:10 +02002106{
2107 const char *version;
2108
2109 if (self->ssl == NULL)
2110 Py_RETURN_NONE;
Christian Heimes68771112017-09-05 21:55:40 -07002111 if (!SSL_is_init_finished(self->ssl)) {
2112 /* handshake not finished */
2113 Py_RETURN_NONE;
2114 }
Antoine Pitrou47e40422014-09-04 21:00:10 +02002115 version = SSL_get_version(self->ssl);
2116 if (!strcmp(version, "unknown"))
2117 Py_RETURN_NONE;
2118 return PyUnicode_FromString(version);
2119}
2120
Christian Heimes29eab552018-02-25 12:31:33 +01002121#if HAVE_NPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002122/*[clinic input]
2123_ssl._SSLSocket.selected_npn_protocol
2124[clinic start generated code]*/
2125
2126static PyObject *
2127_ssl__SSLSocket_selected_npn_protocol_impl(PySSLSocket *self)
2128/*[clinic end generated code: output=b91d494cd207ecf6 input=c28fde139204b826]*/
2129{
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002130 const unsigned char *out;
2131 unsigned int outlen;
2132
Victor Stinner4569cd52013-06-23 14:58:43 +02002133 SSL_get0_next_proto_negotiated(self->ssl,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002134 &out, &outlen);
2135
2136 if (out == NULL)
2137 Py_RETURN_NONE;
Benjamin Petersoncca27322015-01-23 16:35:37 -05002138 return PyUnicode_FromStringAndSize((char *)out, outlen);
2139}
2140#endif
2141
Christian Heimes29eab552018-02-25 12:31:33 +01002142#if HAVE_ALPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002143/*[clinic input]
2144_ssl._SSLSocket.selected_alpn_protocol
2145[clinic start generated code]*/
2146
2147static PyObject *
2148_ssl__SSLSocket_selected_alpn_protocol_impl(PySSLSocket *self)
2149/*[clinic end generated code: output=ec33688b303d250f input=442de30e35bc2913]*/
2150{
Benjamin Petersoncca27322015-01-23 16:35:37 -05002151 const unsigned char *out;
2152 unsigned int outlen;
2153
2154 SSL_get0_alpn_selected(self->ssl, &out, &outlen);
2155
2156 if (out == NULL)
2157 Py_RETURN_NONE;
2158 return PyUnicode_FromStringAndSize((char *)out, outlen);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002159}
2160#endif
2161
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002162/*[clinic input]
2163_ssl._SSLSocket.compression
2164[clinic start generated code]*/
2165
2166static PyObject *
2167_ssl__SSLSocket_compression_impl(PySSLSocket *self)
2168/*[clinic end generated code: output=bd16cb1bb4646ae7 input=5d059d0a2bbc32c8]*/
2169{
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002170#ifdef OPENSSL_NO_COMP
2171 Py_RETURN_NONE;
2172#else
2173 const COMP_METHOD *comp_method;
2174 const char *short_name;
2175
2176 if (self->ssl == NULL)
2177 Py_RETURN_NONE;
2178 comp_method = SSL_get_current_compression(self->ssl);
Christian Heimes598894f2016-09-05 23:19:05 +02002179 if (comp_method == NULL || COMP_get_type(comp_method) == NID_undef)
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002180 Py_RETURN_NONE;
Christian Heimes281e5f82016-09-06 01:10:39 +02002181 short_name = OBJ_nid2sn(COMP_get_type(comp_method));
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01002182 if (short_name == NULL)
2183 Py_RETURN_NONE;
2184 return PyUnicode_DecodeFSDefault(short_name);
2185#endif
2186}
2187
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002188static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
2189 Py_INCREF(self->ctx);
2190 return self->ctx;
2191}
2192
2193static int PySSL_set_context(PySSLSocket *self, PyObject *value,
2194 void *closure) {
2195
Christian Heimes5c36da72020-11-20 09:40:12 +01002196 if (PyObject_TypeCheck(value, PySSLContext_Type)) {
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002197#if !HAVE_SNI
2198 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
2199 "context is not supported by your OpenSSL library");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01002200 return -1;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002201#else
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002202 Py_INCREF(value);
Serhiy Storchaka57a01d32016-04-10 18:05:40 +03002203 Py_SETREF(self->ctx, (PySSLContext *)value);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002204 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002205#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002206 } else {
Ned Deily4531ec72018-06-11 20:26:28 -04002207 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002208 return -1;
2209 }
2210
2211 return 0;
2212}
2213
2214PyDoc_STRVAR(PySSL_set_context_doc,
2215"_setter_context(ctx)\n\
2216\
2217This changes the context associated with the SSLSocket. This is typically\n\
Christian Heimes11a14932018-02-24 02:35:08 +01002218used from within a callback function set by the sni_callback\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002219on the SSLContext to change the certificate information associated with the\n\
2220SSLSocket before the cryptographic exchange handshake messages\n");
2221
2222
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002223static PyObject *
2224PySSL_get_server_side(PySSLSocket *self, void *c)
2225{
2226 return PyBool_FromLong(self->socket_type == PY_SSL_SERVER);
2227}
2228
2229PyDoc_STRVAR(PySSL_get_server_side_doc,
2230"Whether this is a server-side socket.");
2231
2232static PyObject *
2233PySSL_get_server_hostname(PySSLSocket *self, void *c)
2234{
2235 if (self->server_hostname == NULL)
2236 Py_RETURN_NONE;
2237 Py_INCREF(self->server_hostname);
2238 return self->server_hostname;
2239}
2240
2241PyDoc_STRVAR(PySSL_get_server_hostname_doc,
2242"The currently set server hostname (for SNI).");
2243
2244static PyObject *
2245PySSL_get_owner(PySSLSocket *self, void *c)
2246{
2247 PyObject *owner;
2248
2249 if (self->owner == NULL)
2250 Py_RETURN_NONE;
2251
2252 owner = PyWeakref_GetObject(self->owner);
2253 Py_INCREF(owner);
2254 return owner;
2255}
2256
2257static int
2258PySSL_set_owner(PySSLSocket *self, PyObject *value, void *c)
2259{
Serhiy Storchaka48842712016-04-06 09:45:48 +03002260 Py_XSETREF(self->owner, PyWeakref_NewRef(value, NULL));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002261 if (self->owner == NULL)
2262 return -1;
2263 return 0;
2264}
2265
2266PyDoc_STRVAR(PySSL_get_owner_doc,
2267"The Python-level owner of this object.\
2268Passed as \"self\" in servername callback.");
2269
Christian Heimesc7f70692019-05-31 11:44:05 +02002270static int
2271PySSL_traverse(PySSLSocket *self, visitproc visit, void *arg)
2272{
2273 Py_VISIT(self->exc_type);
2274 Py_VISIT(self->exc_value);
2275 Py_VISIT(self->exc_tb);
2276 return 0;
2277}
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002278
Christian Heimesc7f70692019-05-31 11:44:05 +02002279static int
2280PySSL_clear(PySSLSocket *self)
2281{
2282 Py_CLEAR(self->exc_type);
2283 Py_CLEAR(self->exc_value);
2284 Py_CLEAR(self->exc_tb);
2285 return 0;
2286}
2287
2288static void
2289PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002290{
Christian Heimes5c36da72020-11-20 09:40:12 +01002291 PyTypeObject *tp = Py_TYPE(self);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002292 if (self->ssl)
2293 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002294 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002295 Py_XDECREF(self->ctx);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002296 Py_XDECREF(self->server_hostname);
2297 Py_XDECREF(self->owner);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002298 PyObject_Del(self);
Christian Heimes5c36da72020-11-20 09:40:12 +01002299 Py_DECREF(tp);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002300}
2301
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002302/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002303 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002304 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002305 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002306
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002307static int
Victor Stinner14690702015-04-06 22:46:13 +02002308PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002309{
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002310 int rc;
2311#ifdef HAVE_POLL
2312 struct pollfd pollfd;
2313 _PyTime_t ms;
2314#else
2315 int nfds;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002316 fd_set fds;
2317 struct timeval tv;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002318#endif
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002319
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002320 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner14690702015-04-06 22:46:13 +02002321 if ((s == NULL) || (timeout == 0))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002322 return SOCKET_IS_NONBLOCKING;
Victor Stinner14690702015-04-06 22:46:13 +02002323 else if (timeout < 0) {
2324 if (s->sock_timeout > 0)
2325 return SOCKET_HAS_TIMED_OUT;
2326 else
2327 return SOCKET_IS_BLOCKING;
2328 }
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002329
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002330 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002331 if (s->sock_fd == INVALID_SOCKET)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002332 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002333
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002334 /* Prefer poll, if available, since you can poll() any fd
2335 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002336#ifdef HAVE_POLL
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002337 pollfd.fd = s->sock_fd;
2338 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002339
Victor Stinner14690702015-04-06 22:46:13 +02002340 /* timeout is in seconds, poll() uses milliseconds */
2341 ms = (int)_PyTime_AsMilliseconds(timeout, _PyTime_ROUND_CEILING);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002342 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002343
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002344 PySSL_BEGIN_ALLOW_THREADS
2345 rc = poll(&pollfd, 1, (int)ms);
2346 PySSL_END_ALLOW_THREADS
2347#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002348 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02002349 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002350 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00002351
Victor Stinner14690702015-04-06 22:46:13 +02002352 _PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
Victor Stinnere2452312015-03-28 03:00:46 +01002353
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002354 FD_ZERO(&fds);
2355 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002356
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002357 /* Wait until the socket becomes ready */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002358 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002359 nfds = Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002360 if (writing)
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002361 rc = select(nfds, NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002362 else
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002363 rc = select(nfds, &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002364 PySSL_END_ALLOW_THREADS
Bill Janssen6e027db2007-11-15 22:23:56 +00002365#endif
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002366
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002367 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
2368 (when we are able to write or when there's something to read) */
2369 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002370}
2371
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002372/*[clinic input]
2373_ssl._SSLSocket.write
2374 b: Py_buffer
2375 /
2376
2377Writes the bytes-like object b into the SSL object.
2378
2379Returns the number of bytes written.
2380[clinic start generated code]*/
2381
2382static PyObject *
2383_ssl__SSLSocket_write_impl(PySSLSocket *self, Py_buffer *b)
2384/*[clinic end generated code: output=aa7a6be5527358d8 input=77262d994fe5100a]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002385{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002386 int len;
2387 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002388 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002389 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002390 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002391 _PyTime_t timeout, deadline = 0;
2392 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002393
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002394 if (sock != NULL) {
2395 if (((PyObject*)sock) == Py_None) {
2396 _setSSLError("Underlying socket connection gone",
2397 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2398 return NULL;
2399 }
2400 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002401 }
2402
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002403 if (b->len > INT_MAX) {
Victor Stinner6efa9652013-06-25 00:42:31 +02002404 PyErr_Format(PyExc_OverflowError,
2405 "string longer than %d bytes", INT_MAX);
2406 goto error;
2407 }
2408
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002409 if (sock != NULL) {
2410 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002411 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002412 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2413 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2414 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002415
Victor Stinner14690702015-04-06 22:46:13 +02002416 timeout = GET_SOCKET_TIMEOUT(sock);
2417 has_timeout = (timeout > 0);
2418 if (has_timeout)
2419 deadline = _PyTime_GetMonotonicClock() + timeout;
2420
2421 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002422 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Christian Heimes03c8ddd2020-11-20 09:26:07 +01002423 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002424 "The write operation timed out");
2425 goto error;
2426 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2427 PyErr_SetString(PySSLErrorObject,
2428 "Underlying socket has been closed.");
2429 goto error;
2430 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2431 PyErr_SetString(PySSLErrorObject,
2432 "Underlying socket too large for select().");
2433 goto error;
2434 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002435
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002436 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002437 PySSL_BEGIN_ALLOW_THREADS
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002438 len = SSL_write(self->ssl, b->buf, (int)b->len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002439 err = _PySSL_errno(len <= 0, self->ssl, len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002440 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002441 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002442
2443 if (PyErr_CheckSignals())
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002444 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002445
Victor Stinner14690702015-04-06 22:46:13 +02002446 if (has_timeout)
2447 timeout = deadline - _PyTime_GetMonotonicClock();
2448
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002449 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002450 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002451 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002452 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002453 } else {
2454 sockstate = SOCKET_OPERATION_OK;
2455 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002456
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002457 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Christian Heimes03c8ddd2020-11-20 09:26:07 +01002458 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002459 "The write operation timed out");
2460 goto error;
2461 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2462 PyErr_SetString(PySSLErrorObject,
2463 "Underlying socket has been closed.");
2464 goto error;
2465 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2466 break;
2467 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002468 } while (err.ssl == SSL_ERROR_WANT_READ ||
2469 err.ssl == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002470
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002471 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002472 if (len <= 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002473 return PySSL_SetError(self, len, __FILE__, __LINE__);
Christian Heimesc7f70692019-05-31 11:44:05 +02002474 if (PySSL_ChainExceptions(self) < 0)
2475 return NULL;
2476 return PyLong_FromLong(len);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00002477error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002478 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002479 PySSL_ChainExceptions(self);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002480 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002481}
2482
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002483/*[clinic input]
2484_ssl._SSLSocket.pending
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002485
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002486Returns the number of already decrypted bytes available for read, pending on the connection.
2487[clinic start generated code]*/
2488
2489static PyObject *
2490_ssl__SSLSocket_pending_impl(PySSLSocket *self)
2491/*[clinic end generated code: output=983d9fecdc308a83 input=2b77487d6dfd597f]*/
Bill Janssen6e027db2007-11-15 22:23:56 +00002492{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002493 int count = 0;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002494 _PySSLError err;
Bill Janssen6e027db2007-11-15 22:23:56 +00002495
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002496 PySSL_BEGIN_ALLOW_THREADS
2497 count = SSL_pending(self->ssl);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002498 err = _PySSL_errno(count < 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002499 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002500 self->err = err;
2501
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002502 if (count < 0)
2503 return PySSL_SetError(self, count, __FILE__, __LINE__);
2504 else
2505 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00002506}
2507
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002508/*[clinic input]
2509_ssl._SSLSocket.read
2510 size as len: int
2511 [
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002512 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002513 ]
2514 /
Bill Janssen6e027db2007-11-15 22:23:56 +00002515
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002516Read up to size bytes from the SSL socket.
2517[clinic start generated code]*/
2518
2519static PyObject *
2520_ssl__SSLSocket_read_impl(PySSLSocket *self, int len, int group_right_1,
2521 Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002522/*[clinic end generated code: output=00097776cec2a0af input=ff157eb918d0905b]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002523{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002524 PyObject *dest = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002525 char *mem;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002526 int count;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002527 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002528 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002529 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002530 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002531 _PyTime_t timeout, deadline = 0;
2532 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002533
Martin Panter5503d472016-03-27 05:35:19 +00002534 if (!group_right_1 && len < 0) {
2535 PyErr_SetString(PyExc_ValueError, "size should not be negative");
2536 return NULL;
2537 }
2538
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002539 if (sock != NULL) {
2540 if (((PyObject*)sock) == Py_None) {
2541 _setSSLError("Underlying socket connection gone",
2542 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2543 return NULL;
2544 }
2545 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002546 }
2547
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002548 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002549 dest = PyBytes_FromStringAndSize(NULL, len);
2550 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002551 goto error;
Martin Panterbed7f1a2016-07-11 00:17:13 +00002552 if (len == 0) {
2553 Py_XDECREF(sock);
2554 return dest;
2555 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002556 mem = PyBytes_AS_STRING(dest);
2557 }
2558 else {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002559 mem = buffer->buf;
2560 if (len <= 0 || len > buffer->len) {
2561 len = (int) buffer->len;
2562 if (buffer->len != len) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002563 PyErr_SetString(PyExc_OverflowError,
2564 "maximum length can't fit in a C 'int'");
2565 goto error;
2566 }
Martin Panterbed7f1a2016-07-11 00:17:13 +00002567 if (len == 0) {
2568 count = 0;
2569 goto done;
2570 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002571 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002572 }
2573
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002574 if (sock != NULL) {
2575 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002576 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002577 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2578 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2579 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002580
Victor Stinner14690702015-04-06 22:46:13 +02002581 timeout = GET_SOCKET_TIMEOUT(sock);
2582 has_timeout = (timeout > 0);
2583 if (has_timeout)
2584 deadline = _PyTime_GetMonotonicClock() + timeout;
2585
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002586 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002587 PySSL_BEGIN_ALLOW_THREADS
2588 count = SSL_read(self->ssl, mem, len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002589 err = _PySSL_errno(count <= 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002590 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002591 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002592
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002593 if (PyErr_CheckSignals())
2594 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002595
Victor Stinner14690702015-04-06 22:46:13 +02002596 if (has_timeout)
2597 timeout = deadline - _PyTime_GetMonotonicClock();
2598
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002599 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002600 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002601 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002602 sockstate = PySSL_select(sock, 1, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002603 } else if (err.ssl == SSL_ERROR_ZERO_RETURN &&
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002604 SSL_get_shutdown(self->ssl) == SSL_RECEIVED_SHUTDOWN)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002605 {
2606 count = 0;
2607 goto done;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002608 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002609 else
2610 sockstate = SOCKET_OPERATION_OK;
2611
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002612 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Christian Heimes03c8ddd2020-11-20 09:26:07 +01002613 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002614 "The read operation timed out");
2615 goto error;
2616 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2617 break;
2618 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002619 } while (err.ssl == SSL_ERROR_WANT_READ ||
2620 err.ssl == SSL_ERROR_WANT_WRITE);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002621
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002622 if (count <= 0) {
2623 PySSL_SetError(self, count, __FILE__, __LINE__);
2624 goto error;
2625 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002626 if (self->exc_type != NULL)
2627 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002628
2629done:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002630 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002631 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002632 _PyBytes_Resize(&dest, count);
2633 return dest;
2634 }
2635 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002636 return PyLong_FromLong(count);
2637 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002638
2639error:
Christian Heimesc7f70692019-05-31 11:44:05 +02002640 PySSL_ChainExceptions(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002641 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002642 if (!group_right_1)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002643 Py_XDECREF(dest);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002644 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002645}
2646
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002647/*[clinic input]
2648_ssl._SSLSocket.shutdown
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002649
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002650Does the SSL shutdown handshake with the remote end.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002651[clinic start generated code]*/
2652
2653static PyObject *
2654_ssl__SSLSocket_shutdown_impl(PySSLSocket *self)
Christian Heimes141c5e82018-02-24 21:10:57 +01002655/*[clinic end generated code: output=ca1aa7ed9d25ca42 input=11d39e69b0a2bf4a]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002656{
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002657 _PySSLError err;
2658 int sockstate, nonblocking, ret;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002659 int zeros = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002660 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002661 _PyTime_t timeout, deadline = 0;
2662 int has_timeout;
Bill Janssen40a0f662008-08-12 16:56:25 +00002663
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002664 if (sock != NULL) {
2665 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002666 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd == INVALID_SOCKET)) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002667 _setSSLError("Underlying socket connection gone",
2668 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2669 return NULL;
2670 }
2671 Py_INCREF(sock);
2672
2673 /* Just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002674 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002675 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2676 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002677 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002678
Victor Stinner14690702015-04-06 22:46:13 +02002679 timeout = GET_SOCKET_TIMEOUT(sock);
2680 has_timeout = (timeout > 0);
2681 if (has_timeout)
2682 deadline = _PyTime_GetMonotonicClock() + timeout;
2683
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002684 while (1) {
2685 PySSL_BEGIN_ALLOW_THREADS
2686 /* Disable read-ahead so that unwrap can work correctly.
2687 * Otherwise OpenSSL might read in too much data,
2688 * eating clear text data that happens to be
2689 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03002690 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002691 * function is used and the shutdown_seen_zero != 0
2692 * condition is met.
2693 */
2694 if (self->shutdown_seen_zero)
2695 SSL_set_read_ahead(self->ssl, 0);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002696 ret = SSL_shutdown(self->ssl);
2697 err = _PySSL_errno(ret < 0, self->ssl, ret);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002698 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002699 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002700
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002701 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002702 if (ret > 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002703 break;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002704 if (ret == 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002705 /* Don't loop endlessly; instead preserve legacy
2706 behaviour of trying SSL_shutdown() only twice.
2707 This looks necessary for OpenSSL < 0.9.8m */
2708 if (++zeros > 1)
2709 break;
2710 /* Shutdown was sent, now try receiving */
2711 self->shutdown_seen_zero = 1;
2712 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00002713 }
2714
Victor Stinner14690702015-04-06 22:46:13 +02002715 if (has_timeout)
2716 timeout = deadline - _PyTime_GetMonotonicClock();
2717
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002718 /* Possibly retry shutdown until timeout or failure */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002719 if (err.ssl == SSL_ERROR_WANT_READ)
Victor Stinner14690702015-04-06 22:46:13 +02002720 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002721 else if (err.ssl == SSL_ERROR_WANT_WRITE)
Victor Stinner14690702015-04-06 22:46:13 +02002722 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002723 else
2724 break;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002725
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002726 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002727 if (err.ssl == SSL_ERROR_WANT_READ)
Christian Heimes03c8ddd2020-11-20 09:26:07 +01002728 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002729 "The read operation timed out");
2730 else
Christian Heimes03c8ddd2020-11-20 09:26:07 +01002731 PyErr_SetString(PyExc_TimeoutError,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002732 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002733 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002734 }
2735 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2736 PyErr_SetString(PySSLErrorObject,
2737 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002738 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002739 }
2740 else if (sockstate != SOCKET_OPERATION_OK)
2741 /* Retain the SSL error code */
2742 break;
2743 }
Nathaniel J. Smithc0da5822018-09-21 21:44:12 -07002744 if (ret < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002745 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002746 PySSL_SetError(self, ret, __FILE__, __LINE__);
2747 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002748 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002749 if (self->exc_type != NULL)
2750 goto error;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002751 if (sock)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002752 /* It's already INCREF'ed */
2753 return (PyObject *) sock;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002754 else
2755 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002756
2757error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002758 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002759 PySSL_ChainExceptions(self);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002760 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00002761}
2762
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002763/*[clinic input]
Christian Heimes141c5e82018-02-24 21:10:57 +01002764_ssl._SSLSocket.get_channel_binding
2765 cb_type: str = "tls-unique"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002766
Christian Heimes141c5e82018-02-24 21:10:57 +01002767Get channel binding data for current connection.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002768
Christian Heimes141c5e82018-02-24 21:10:57 +01002769Raise ValueError if the requested `cb_type` is not supported. Return bytes
2770of the data or None if the data is not available (e.g. before the handshake).
2771Only 'tls-unique' channel binding data from RFC 5929 is supported.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002772[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002773
Antoine Pitroud6494802011-07-21 01:11:30 +02002774static PyObject *
Christian Heimes141c5e82018-02-24 21:10:57 +01002775_ssl__SSLSocket_get_channel_binding_impl(PySSLSocket *self,
2776 const char *cb_type)
2777/*[clinic end generated code: output=34bac9acb6a61d31 input=08b7e43b99c17d41]*/
Antoine Pitroud6494802011-07-21 01:11:30 +02002778{
Antoine Pitroud6494802011-07-21 01:11:30 +02002779 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02002780 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02002781
Christian Heimes141c5e82018-02-24 21:10:57 +01002782 if (strcmp(cb_type, "tls-unique") == 0) {
2783 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
2784 /* if session is resumed XOR we are the client */
2785 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2786 }
2787 else {
2788 /* if a new session XOR we are the server */
2789 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2790 }
Antoine Pitroud6494802011-07-21 01:11:30 +02002791 }
2792 else {
Christian Heimes141c5e82018-02-24 21:10:57 +01002793 PyErr_Format(
2794 PyExc_ValueError,
2795 "'%s' channel binding type not implemented",
2796 cb_type
2797 );
2798 return NULL;
Antoine Pitroud6494802011-07-21 01:11:30 +02002799 }
2800
2801 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02002802 if (len == 0)
2803 Py_RETURN_NONE;
2804
Christian Heimes141c5e82018-02-24 21:10:57 +01002805 return PyBytes_FromStringAndSize(buf, len);
Antoine Pitroud6494802011-07-21 01:11:30 +02002806}
2807
Christian Heimes9fb051f2018-09-23 08:32:31 +02002808/*[clinic input]
2809_ssl._SSLSocket.verify_client_post_handshake
2810
2811Initiate TLS 1.3 post-handshake authentication
2812[clinic start generated code]*/
2813
2814static PyObject *
2815_ssl__SSLSocket_verify_client_post_handshake_impl(PySSLSocket *self)
2816/*[clinic end generated code: output=532147f3b1341425 input=6bfa874810a3d889]*/
2817{
2818#ifdef TLS1_3_VERSION
2819 int err = SSL_verify_client_post_handshake(self->ssl);
2820 if (err == 0)
2821 return _setSSLError(NULL, 0, __FILE__, __LINE__);
2822 else
2823 Py_RETURN_NONE;
2824#else
2825 PyErr_SetString(PyExc_NotImplementedError,
2826 "Post-handshake auth is not supported by your "
2827 "OpenSSL version.");
2828 return NULL;
2829#endif
2830}
2831
Christian Heimes99a65702016-09-10 23:44:53 +02002832#ifdef OPENSSL_VERSION_1_1
2833
2834static SSL_SESSION*
2835_ssl_session_dup(SSL_SESSION *session) {
2836 SSL_SESSION *newsession = NULL;
2837 int slen;
2838 unsigned char *senc = NULL, *p;
2839 const unsigned char *const_p;
2840
2841 if (session == NULL) {
2842 PyErr_SetString(PyExc_ValueError, "Invalid session");
2843 goto error;
2844 }
2845
2846 /* get length */
2847 slen = i2d_SSL_SESSION(session, NULL);
2848 if (slen == 0 || slen > 0xFF00) {
2849 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2850 goto error;
2851 }
2852 if ((senc = PyMem_Malloc(slen)) == NULL) {
2853 PyErr_NoMemory();
2854 goto error;
2855 }
2856 p = senc;
2857 if (!i2d_SSL_SESSION(session, &p)) {
2858 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2859 goto error;
2860 }
2861 const_p = senc;
2862 newsession = d2i_SSL_SESSION(NULL, &const_p, slen);
2863 if (session == NULL) {
2864 goto error;
2865 }
2866 PyMem_Free(senc);
2867 return newsession;
2868 error:
2869 if (senc != NULL) {
2870 PyMem_Free(senc);
2871 }
2872 return NULL;
2873}
2874#endif
2875
2876static PyObject *
2877PySSL_get_session(PySSLSocket *self, void *closure) {
2878 /* get_session can return sessions from a server-side connection,
2879 * it does not check for handshake done or client socket. */
2880 PySSLSession *pysess;
2881 SSL_SESSION *session;
2882
2883#ifdef OPENSSL_VERSION_1_1
2884 /* duplicate session as workaround for session bug in OpenSSL 1.1.0,
2885 * https://github.com/openssl/openssl/issues/1550 */
2886 session = SSL_get0_session(self->ssl); /* borrowed reference */
2887 if (session == NULL) {
2888 Py_RETURN_NONE;
2889 }
2890 if ((session = _ssl_session_dup(session)) == NULL) {
2891 return NULL;
2892 }
2893#else
2894 session = SSL_get1_session(self->ssl);
2895 if (session == NULL) {
2896 Py_RETURN_NONE;
2897 }
2898#endif
Christian Heimes5c36da72020-11-20 09:40:12 +01002899 pysess = PyObject_GC_New(PySSLSession, PySSLSession_Type);
Christian Heimes99a65702016-09-10 23:44:53 +02002900 if (pysess == NULL) {
2901 SSL_SESSION_free(session);
2902 return NULL;
2903 }
2904
2905 assert(self->ctx);
2906 pysess->ctx = self->ctx;
2907 Py_INCREF(pysess->ctx);
2908 pysess->session = session;
Christian Heimesa5d07652016-09-24 10:48:05 +02002909 PyObject_GC_Track(pysess);
Christian Heimes99a65702016-09-10 23:44:53 +02002910 return (PyObject *)pysess;
2911}
2912
2913static int PySSL_set_session(PySSLSocket *self, PyObject *value,
2914 void *closure)
2915 {
2916 PySSLSession *pysess;
2917#ifdef OPENSSL_VERSION_1_1
2918 SSL_SESSION *session;
2919#endif
2920 int result;
2921
2922 if (!PySSLSession_Check(value)) {
Ned Deily4531ec72018-06-11 20:26:28 -04002923 PyErr_SetString(PyExc_TypeError, "Value is not a SSLSession.");
Christian Heimes99a65702016-09-10 23:44:53 +02002924 return -1;
2925 }
2926 pysess = (PySSLSession *)value;
2927
2928 if (self->ctx->ctx != pysess->ctx->ctx) {
2929 PyErr_SetString(PyExc_ValueError,
2930 "Session refers to a different SSLContext.");
2931 return -1;
2932 }
2933 if (self->socket_type != PY_SSL_CLIENT) {
2934 PyErr_SetString(PyExc_ValueError,
2935 "Cannot set session for server-side SSLSocket.");
2936 return -1;
2937 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07002938 if (SSL_is_init_finished(self->ssl)) {
Christian Heimes99a65702016-09-10 23:44:53 +02002939 PyErr_SetString(PyExc_ValueError,
2940 "Cannot set session after handshake.");
2941 return -1;
2942 }
2943#ifdef OPENSSL_VERSION_1_1
2944 /* duplicate session */
2945 if ((session = _ssl_session_dup(pysess->session)) == NULL) {
2946 return -1;
2947 }
2948 result = SSL_set_session(self->ssl, session);
2949 /* free duplicate, SSL_set_session() bumps ref count */
2950 SSL_SESSION_free(session);
2951#else
2952 result = SSL_set_session(self->ssl, pysess->session);
2953#endif
2954 if (result == 0) {
2955 _setSSLError(NULL, 0, __FILE__, __LINE__);
2956 return -1;
2957 }
2958 return 0;
2959}
2960
2961PyDoc_STRVAR(PySSL_set_session_doc,
2962"_setter_session(session)\n\
2963\
2964Get / set SSLSession.");
2965
2966static PyObject *
2967PySSL_get_session_reused(PySSLSocket *self, void *closure) {
2968 if (SSL_session_reused(self->ssl)) {
2969 Py_RETURN_TRUE;
2970 } else {
2971 Py_RETURN_FALSE;
2972 }
2973}
2974
2975PyDoc_STRVAR(PySSL_get_session_reused_doc,
2976"Was the client session reused during handshake?");
2977
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002978static PyGetSetDef ssl_getsetlist[] = {
2979 {"context", (getter) PySSL_get_context,
2980 (setter) PySSL_set_context, PySSL_set_context_doc},
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002981 {"server_side", (getter) PySSL_get_server_side, NULL,
2982 PySSL_get_server_side_doc},
2983 {"server_hostname", (getter) PySSL_get_server_hostname, NULL,
2984 PySSL_get_server_hostname_doc},
2985 {"owner", (getter) PySSL_get_owner, (setter) PySSL_set_owner,
2986 PySSL_get_owner_doc},
Christian Heimes99a65702016-09-10 23:44:53 +02002987 {"session", (getter) PySSL_get_session,
2988 (setter) PySSL_set_session, PySSL_set_session_doc},
2989 {"session_reused", (getter) PySSL_get_session_reused, NULL,
2990 PySSL_get_session_reused_doc},
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002991 {NULL}, /* sentinel */
2992};
2993
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002994static PyMethodDef PySSLMethods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002995 _SSL__SSLSOCKET_DO_HANDSHAKE_METHODDEF
2996 _SSL__SSLSOCKET_WRITE_METHODDEF
2997 _SSL__SSLSOCKET_READ_METHODDEF
2998 _SSL__SSLSOCKET_PENDING_METHODDEF
Christian Heimes141c5e82018-02-24 21:10:57 +01002999 _SSL__SSLSOCKET_GETPEERCERT_METHODDEF
3000 _SSL__SSLSOCKET_GET_CHANNEL_BINDING_METHODDEF
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003001 _SSL__SSLSOCKET_CIPHER_METHODDEF
3002 _SSL__SSLSOCKET_SHARED_CIPHERS_METHODDEF
3003 _SSL__SSLSOCKET_VERSION_METHODDEF
3004 _SSL__SSLSOCKET_SELECTED_NPN_PROTOCOL_METHODDEF
3005 _SSL__SSLSOCKET_SELECTED_ALPN_PROTOCOL_METHODDEF
3006 _SSL__SSLSOCKET_COMPRESSION_METHODDEF
3007 _SSL__SSLSOCKET_SHUTDOWN_METHODDEF
Christian Heimes9fb051f2018-09-23 08:32:31 +02003008 _SSL__SSLSOCKET_VERIFY_CLIENT_POST_HANDSHAKE_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003009 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003010};
3011
Christian Heimes5c36da72020-11-20 09:40:12 +01003012static PyType_Slot PySSLSocket_slots[] = {
3013 {Py_tp_methods, PySSLMethods},
3014 {Py_tp_getset, ssl_getsetlist},
3015 {Py_tp_dealloc, PySSL_dealloc},
3016 {Py_tp_traverse, PySSL_traverse},
3017 {Py_tp_clear, PySSL_clear},
3018 {0, 0},
3019};
3020
3021static PyType_Spec PySSLSocket_spec = {
3022 "_ssl._SSLSocket",
3023 sizeof(PySSLSocket),
3024 0,
3025 Py_TPFLAGS_DEFAULT,
3026 PySSLSocket_slots,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003027};
3028
Antoine Pitrou152efa22010-05-16 18:19:27 +00003029
3030/*
3031 * _SSLContext objects
3032 */
3033
Christian Heimes5fe668c2016-09-12 00:01:11 +02003034static int
Christian Heimes9fb051f2018-09-23 08:32:31 +02003035_set_verify_mode(PySSLContext *self, enum py_ssl_cert_requirements n)
Christian Heimes5fe668c2016-09-12 00:01:11 +02003036{
3037 int mode;
3038 int (*verify_cb)(int, X509_STORE_CTX *) = NULL;
3039
3040 switch(n) {
3041 case PY_SSL_CERT_NONE:
3042 mode = SSL_VERIFY_NONE;
3043 break;
3044 case PY_SSL_CERT_OPTIONAL:
3045 mode = SSL_VERIFY_PEER;
3046 break;
3047 case PY_SSL_CERT_REQUIRED:
3048 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
3049 break;
3050 default:
3051 PyErr_SetString(PyExc_ValueError,
3052 "invalid value for verify_mode");
3053 return -1;
3054 }
Christian Heimesf0f59302019-07-01 08:29:17 +02003055
3056 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3057 * server sockets and SSL_set_post_handshake_auth() for client. */
3058
Christian Heimes5fe668c2016-09-12 00:01:11 +02003059 /* keep current verify cb */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003060 verify_cb = SSL_CTX_get_verify_callback(self->ctx);
3061 SSL_CTX_set_verify(self->ctx, mode, verify_cb);
Christian Heimes5fe668c2016-09-12 00:01:11 +02003062 return 0;
3063}
3064
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003065/*[clinic input]
3066@classmethod
3067_ssl._SSLContext.__new__
3068 protocol as proto_version: int
3069 /
3070[clinic start generated code]*/
3071
Antoine Pitrou152efa22010-05-16 18:19:27 +00003072static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003073_ssl__SSLContext_impl(PyTypeObject *type, int proto_version)
3074/*[clinic end generated code: output=2cf0d7a0741b6bd1 input=8d58a805b95fc534]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003075{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003076 PySSLContext *self;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003077 long options;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003078 SSL_CTX *ctx = NULL;
Christian Heimes61d478c2018-01-27 15:51:38 +01003079 X509_VERIFY_PARAM *params;
Christian Heimes358cfd42016-09-10 22:43:48 +02003080 int result;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003081#if defined(SSL_MODE_RELEASE_BUFFERS)
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003082 unsigned long libver;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003083#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003084
Antoine Pitrou152efa22010-05-16 18:19:27 +00003085 PySSL_BEGIN_ALLOW_THREADS
Christian Heimes6e8cda92020-05-16 03:33:05 +02003086 switch(proto_version) {
3087#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
3088 case PY_SSL_VERSION_SSL3:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003089 ctx = SSL_CTX_new(SSLv3_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003090 break;
Benjamin Petersone32467c2014-12-05 21:59:35 -05003091#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003092#if (defined(TLS1_VERSION) && \
3093 !defined(OPENSSL_NO_TLS1) && \
3094 !defined(OPENSSL_NO_TLS1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003095 case PY_SSL_VERSION_TLS1:
3096 ctx = SSL_CTX_new(TLSv1_method());
3097 break;
Victor Stinner3de49192011-05-09 00:42:58 +02003098#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003099#if (defined(TLS1_1_VERSION) && \
3100 !defined(OPENSSL_NO_TLS1_1) && \
3101 !defined(OPENSSL_NO_TLS1_1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003102 case PY_SSL_VERSION_TLS1_1:
3103 ctx = SSL_CTX_new(TLSv1_1_method());
3104 break;
3105#endif
Christian Heimesa871f692020-06-01 08:58:14 +02003106#if (defined(TLS1_2_VERSION) && \
3107 !defined(OPENSSL_NO_TLS1_2) && \
3108 !defined(OPENSSL_NO_TLS1_2_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003109 case PY_SSL_VERSION_TLS1_2:
3110 ctx = SSL_CTX_new(TLSv1_2_method());
3111 break;
3112#endif
3113 case PY_SSL_VERSION_TLS:
3114 /* SSLv23 */
Christian Heimes598894f2016-09-05 23:19:05 +02003115 ctx = SSL_CTX_new(TLS_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003116 break;
3117 case PY_SSL_VERSION_TLS_CLIENT:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003118 ctx = SSL_CTX_new(TLS_client_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003119 break;
3120 case PY_SSL_VERSION_TLS_SERVER:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003121 ctx = SSL_CTX_new(TLS_server_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003122 break;
3123 default:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003124 proto_version = -1;
Christian Heimes6e8cda92020-05-16 03:33:05 +02003125 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003126 PySSL_END_ALLOW_THREADS
3127
3128 if (proto_version == -1) {
3129 PyErr_SetString(PyExc_ValueError,
Christian Heimes6e8cda92020-05-16 03:33:05 +02003130 "invalid or unsupported protocol version");
Antoine Pitrou152efa22010-05-16 18:19:27 +00003131 return NULL;
3132 }
3133 if (ctx == NULL) {
Christian Heimes17c9ac92017-09-07 14:14:00 -07003134 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003135 return NULL;
3136 }
3137
3138 assert(type != NULL && type->tp_alloc != NULL);
3139 self = (PySSLContext *) type->tp_alloc(type, 0);
3140 if (self == NULL) {
3141 SSL_CTX_free(ctx);
3142 return NULL;
3143 }
3144 self->ctx = ctx;
Christian Heimes61d478c2018-01-27 15:51:38 +01003145 self->hostflags = X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS;
Christian Heimes11a14932018-02-24 02:35:08 +01003146 self->protocol = proto_version;
Christian Heimesc7f70692019-05-31 11:44:05 +02003147 self->msg_cb = NULL;
3148#ifdef HAVE_OPENSSL_KEYLOG
3149 self->keylog_filename = NULL;
3150 self->keylog_bio = NULL;
3151#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003152#if HAVE_NPN
Christian Heimes5cb31c92012-09-20 12:42:54 +02003153 self->npn_protocols = NULL;
3154#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003155#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003156 self->alpn_protocols = NULL;
3157#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003158#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003159 self->set_sni_cb = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003160#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01003161 /* Don't check host name by default */
Christian Heimes5fe668c2016-09-12 00:01:11 +02003162 if (proto_version == PY_SSL_VERSION_TLS_CLIENT) {
3163 self->check_hostname = 1;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003164 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003165 Py_DECREF(self);
3166 return NULL;
3167 }
3168 } else {
3169 self->check_hostname = 0;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003170 if (_set_verify_mode(self, PY_SSL_CERT_NONE) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003171 Py_DECREF(self);
3172 return NULL;
3173 }
3174 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003175 /* Defaults */
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003176 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
3177 if (proto_version != PY_SSL_VERSION_SSL2)
3178 options |= SSL_OP_NO_SSLv2;
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08003179 if (proto_version != PY_SSL_VERSION_SSL3)
3180 options |= SSL_OP_NO_SSLv3;
Christian Heimes358cfd42016-09-10 22:43:48 +02003181 /* Minimal security flags for server and client side context.
3182 * Client sockets ignore server-side parameters. */
3183#ifdef SSL_OP_NO_COMPRESSION
3184 options |= SSL_OP_NO_COMPRESSION;
3185#endif
3186#ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
3187 options |= SSL_OP_CIPHER_SERVER_PREFERENCE;
3188#endif
3189#ifdef SSL_OP_SINGLE_DH_USE
3190 options |= SSL_OP_SINGLE_DH_USE;
3191#endif
3192#ifdef SSL_OP_SINGLE_ECDH_USE
3193 options |= SSL_OP_SINGLE_ECDH_USE;
3194#endif
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003195 SSL_CTX_set_options(self->ctx, options);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003196
Semen Zhydenko1295e112017-10-15 21:28:31 +02003197 /* A bare minimum cipher list without completely broken cipher suites.
Christian Heimes358cfd42016-09-10 22:43:48 +02003198 * It's far from perfect but gives users a better head start. */
3199 if (proto_version != PY_SSL_VERSION_SSL2) {
Christian Heimes892d66e2018-01-29 14:10:18 +01003200#if PY_SSL_DEFAULT_CIPHERS == 2
3201 /* stick to OpenSSL's default settings */
3202 result = 1;
3203#else
3204 result = SSL_CTX_set_cipher_list(ctx, PY_SSL_DEFAULT_CIPHER_STRING);
3205#endif
Christian Heimes358cfd42016-09-10 22:43:48 +02003206 } else {
3207 /* SSLv2 needs MD5 */
3208 result = SSL_CTX_set_cipher_list(ctx, "HIGH:!aNULL:!eNULL");
3209 }
3210 if (result == 0) {
3211 Py_DECREF(self);
3212 ERR_clear_error();
3213 PyErr_SetString(PySSLErrorObject,
3214 "No cipher can be selected.");
3215 return NULL;
3216 }
3217
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003218#if defined(SSL_MODE_RELEASE_BUFFERS)
3219 /* Set SSL_MODE_RELEASE_BUFFERS. This potentially greatly reduces memory
3220 usage for no cost at all. However, don't do this for OpenSSL versions
3221 between 1.0.1 and 1.0.1h or 1.0.0 and 1.0.0m, which are affected by CVE
3222 2014-0198. I can't find exactly which beta fixed this CVE, so be
3223 conservative and assume it wasn't fixed until release. We do this check
3224 at runtime to avoid problems from the dynamic linker.
3225 See #25672 for more on this. */
Christian Heimesa871f692020-06-01 08:58:14 +02003226 libver = OpenSSL_version_num();
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003227 if (!(libver >= 0x10001000UL && libver < 0x1000108fUL) &&
3228 !(libver >= 0x10000000UL && libver < 0x100000dfUL)) {
3229 SSL_CTX_set_mode(self->ctx, SSL_MODE_RELEASE_BUFFERS);
3230 }
3231#endif
3232
3233
Donald Stufft8ae264c2017-03-02 11:45:29 -05003234#if !defined(OPENSSL_NO_ECDH) && !defined(OPENSSL_VERSION_1_1)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003235 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
3236 prime256v1 by default. This is Apache mod_ssl's initialization
Christian Heimes598894f2016-09-05 23:19:05 +02003237 policy, so we should be safe. OpenSSL 1.1 has it enabled by default.
3238 */
Donald Stufft8ae264c2017-03-02 11:45:29 -05003239#if defined(SSL_CTX_set_ecdh_auto)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003240 SSL_CTX_set_ecdh_auto(self->ctx, 1);
3241#else
3242 {
3243 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
3244 SSL_CTX_set_tmp_ecdh(self->ctx, key);
3245 EC_KEY_free(key);
3246 }
3247#endif
3248#endif
3249
Antoine Pitroufc113ee2010-10-13 12:46:13 +00003250#define SID_CTX "Python"
3251 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
3252 sizeof(SID_CTX));
3253#undef SID_CTX
3254
Christian Heimes61d478c2018-01-27 15:51:38 +01003255 params = SSL_CTX_get0_param(self->ctx);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003256#ifdef X509_V_FLAG_TRUSTED_FIRST
Christian Heimes61d478c2018-01-27 15:51:38 +01003257 /* Improve trust chain building when cross-signed intermediate
3258 certificates are present. See https://bugs.python.org/issue23476. */
3259 X509_VERIFY_PARAM_set_flags(params, X509_V_FLAG_TRUSTED_FIRST);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003260#endif
Christian Heimes61d478c2018-01-27 15:51:38 +01003261 X509_VERIFY_PARAM_set_hostflags(params, self->hostflags);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003262
Christian Heimes9fb051f2018-09-23 08:32:31 +02003263#ifdef TLS1_3_VERSION
3264 self->post_handshake_auth = 0;
3265 SSL_CTX_set_post_handshake_auth(self->ctx, self->post_handshake_auth);
3266#endif
3267
Antoine Pitrou152efa22010-05-16 18:19:27 +00003268 return (PyObject *)self;
3269}
3270
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003271static int
3272context_traverse(PySSLContext *self, visitproc visit, void *arg)
3273{
3274#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003275 Py_VISIT(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003276#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003277 Py_VISIT(self->msg_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003278 return 0;
3279}
3280
3281static int
3282context_clear(PySSLContext *self)
3283{
3284#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003285 Py_CLEAR(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003286#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003287 Py_CLEAR(self->msg_cb);
3288#ifdef HAVE_OPENSSL_KEYLOG
3289 Py_CLEAR(self->keylog_filename);
3290 if (self->keylog_bio != NULL) {
3291 PySSL_BEGIN_ALLOW_THREADS
3292 BIO_free_all(self->keylog_bio);
3293 PySSL_END_ALLOW_THREADS
3294 self->keylog_bio = NULL;
3295 }
3296#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003297 return 0;
3298}
3299
Antoine Pitrou152efa22010-05-16 18:19:27 +00003300static void
3301context_dealloc(PySSLContext *self)
3302{
Christian Heimes5c36da72020-11-20 09:40:12 +01003303 PyTypeObject *tp = Py_TYPE(self);
INADA Naokia6296d32017-08-24 14:55:17 +09003304 /* bpo-31095: UnTrack is needed before calling any callbacks */
3305 PyObject_GC_UnTrack(self);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003306 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003307 SSL_CTX_free(self->ctx);
Christian Heimes29eab552018-02-25 12:31:33 +01003308#if HAVE_NPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003309 PyMem_FREE(self->npn_protocols);
3310#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003311#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003312 PyMem_FREE(self->alpn_protocols);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003313#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003314 Py_TYPE(self)->tp_free(self);
Christian Heimes5c36da72020-11-20 09:40:12 +01003315 Py_DECREF(tp);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003316}
3317
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003318/*[clinic input]
3319_ssl._SSLContext.set_ciphers
3320 cipherlist: str
3321 /
3322[clinic start generated code]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003323
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003324static PyObject *
3325_ssl__SSLContext_set_ciphers_impl(PySSLContext *self, const char *cipherlist)
3326/*[clinic end generated code: output=3a3162f3557c0f3f input=a7ac931b9f3ca7fc]*/
3327{
3328 int ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003329 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00003330 /* Clearing the error queue is necessary on some OpenSSL versions,
3331 otherwise the error will be reported again when another SSL call
3332 is done. */
3333 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003334 PyErr_SetString(PySSLErrorObject,
3335 "No cipher can be selected.");
3336 return NULL;
3337 }
3338 Py_RETURN_NONE;
3339}
3340
Christian Heimes25bfcd52016-09-06 00:04:45 +02003341#if OPENSSL_VERSION_NUMBER >= 0x10002000UL
3342/*[clinic input]
3343_ssl._SSLContext.get_ciphers
3344[clinic start generated code]*/
3345
3346static PyObject *
3347_ssl__SSLContext_get_ciphers_impl(PySSLContext *self)
3348/*[clinic end generated code: output=a56e4d68a406dfc4 input=a2aadc9af89b79c5]*/
3349{
3350 SSL *ssl = NULL;
3351 STACK_OF(SSL_CIPHER) *sk = NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02003352 const SSL_CIPHER *cipher;
Christian Heimes25bfcd52016-09-06 00:04:45 +02003353 int i=0;
3354 PyObject *result = NULL, *dct;
3355
3356 ssl = SSL_new(self->ctx);
3357 if (ssl == NULL) {
3358 _setSSLError(NULL, 0, __FILE__, __LINE__);
3359 goto exit;
3360 }
3361 sk = SSL_get_ciphers(ssl);
3362
3363 result = PyList_New(sk_SSL_CIPHER_num(sk));
3364 if (result == NULL) {
3365 goto exit;
3366 }
3367
3368 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
3369 cipher = sk_SSL_CIPHER_value(sk, i);
3370 dct = cipher_to_dict(cipher);
3371 if (dct == NULL) {
3372 Py_CLEAR(result);
3373 goto exit;
3374 }
3375 PyList_SET_ITEM(result, i, dct);
3376 }
3377
3378 exit:
3379 if (ssl != NULL)
3380 SSL_free(ssl);
3381 return result;
3382
3383}
3384#endif
3385
3386
Christian Heimes29eab552018-02-25 12:31:33 +01003387#if HAVE_NPN || HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003388static int
Benjamin Peterson88615022015-01-23 17:30:26 -05003389do_protocol_selection(int alpn, unsigned char **out, unsigned char *outlen,
3390 const unsigned char *server_protocols, unsigned int server_protocols_len,
3391 const unsigned char *client_protocols, unsigned int client_protocols_len)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003392{
Benjamin Peterson88615022015-01-23 17:30:26 -05003393 int ret;
3394 if (client_protocols == NULL) {
3395 client_protocols = (unsigned char *)"";
3396 client_protocols_len = 0;
3397 }
3398 if (server_protocols == NULL) {
3399 server_protocols = (unsigned char *)"";
3400 server_protocols_len = 0;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003401 }
3402
Benjamin Peterson88615022015-01-23 17:30:26 -05003403 ret = SSL_select_next_proto(out, outlen,
3404 server_protocols, server_protocols_len,
3405 client_protocols, client_protocols_len);
3406 if (alpn && ret != OPENSSL_NPN_NEGOTIATED)
3407 return SSL_TLSEXT_ERR_NOACK;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003408
3409 return SSL_TLSEXT_ERR_OK;
3410}
Melvyn Sopacuab2d096b2017-09-04 23:35:15 +02003411#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05003412
Christian Heimes29eab552018-02-25 12:31:33 +01003413#if HAVE_NPN
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003414/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
3415static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003416_advertiseNPN_cb(SSL *s,
3417 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003418 void *args)
3419{
3420 PySSLContext *ssl_ctx = (PySSLContext *) args;
3421
3422 if (ssl_ctx->npn_protocols == NULL) {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003423 *data = (unsigned char *)"";
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003424 *len = 0;
3425 } else {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003426 *data = ssl_ctx->npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003427 *len = ssl_ctx->npn_protocols_len;
3428 }
3429
3430 return SSL_TLSEXT_ERR_OK;
3431}
3432/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
3433static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003434_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003435 unsigned char **out, unsigned char *outlen,
3436 const unsigned char *server, unsigned int server_len,
3437 void *args)
3438{
Benjamin Petersoncca27322015-01-23 16:35:37 -05003439 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003440 return do_protocol_selection(0, out, outlen, server, server_len,
Benjamin Petersoncca27322015-01-23 16:35:37 -05003441 ctx->npn_protocols, ctx->npn_protocols_len);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003442}
3443#endif
3444
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003445/*[clinic input]
3446_ssl._SSLContext._set_npn_protocols
3447 protos: Py_buffer
3448 /
3449[clinic start generated code]*/
3450
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003451static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003452_ssl__SSLContext__set_npn_protocols_impl(PySSLContext *self,
3453 Py_buffer *protos)
3454/*[clinic end generated code: output=72b002c3324390c6 input=319fcb66abf95bd7]*/
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003455{
Christian Heimes29eab552018-02-25 12:31:33 +01003456#if HAVE_NPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003457 PyMem_Free(self->npn_protocols);
3458 self->npn_protocols = PyMem_Malloc(protos->len);
3459 if (self->npn_protocols == NULL)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003460 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003461 memcpy(self->npn_protocols, protos->buf, protos->len);
3462 self->npn_protocols_len = (int) protos->len;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003463
3464 /* set both server and client callbacks, because the context can
3465 * be used to create both types of sockets */
3466 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
3467 _advertiseNPN_cb,
3468 self);
3469 SSL_CTX_set_next_proto_select_cb(self->ctx,
3470 _selectNPN_cb,
3471 self);
3472
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003473 Py_RETURN_NONE;
3474#else
3475 PyErr_SetString(PyExc_NotImplementedError,
3476 "The NPN extension requires OpenSSL 1.0.1 or later.");
3477 return NULL;
3478#endif
3479}
3480
Christian Heimes29eab552018-02-25 12:31:33 +01003481#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003482static int
3483_selectALPN_cb(SSL *s,
3484 const unsigned char **out, unsigned char *outlen,
3485 const unsigned char *client_protocols, unsigned int client_protocols_len,
3486 void *args)
3487{
3488 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003489 return do_protocol_selection(1, (unsigned char **)out, outlen,
3490 ctx->alpn_protocols, ctx->alpn_protocols_len,
3491 client_protocols, client_protocols_len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003492}
3493#endif
3494
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003495/*[clinic input]
3496_ssl._SSLContext._set_alpn_protocols
3497 protos: Py_buffer
3498 /
3499[clinic start generated code]*/
3500
Benjamin Petersoncca27322015-01-23 16:35:37 -05003501static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003502_ssl__SSLContext__set_alpn_protocols_impl(PySSLContext *self,
3503 Py_buffer *protos)
3504/*[clinic end generated code: output=87599a7f76651a9b input=9bba964595d519be]*/
Benjamin Petersoncca27322015-01-23 16:35:37 -05003505{
Christian Heimes29eab552018-02-25 12:31:33 +01003506#if HAVE_ALPN
Victor Stinner5a615592017-09-14 01:10:30 -07003507 if ((size_t)protos->len > UINT_MAX) {
Segev Finer5cff6372017-07-27 01:19:17 +03003508 PyErr_Format(PyExc_OverflowError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02003509 "protocols longer than %u bytes", UINT_MAX);
Segev Finer5cff6372017-07-27 01:19:17 +03003510 return NULL;
3511 }
3512
Benjamin Petersoncca27322015-01-23 16:35:37 -05003513 PyMem_FREE(self->alpn_protocols);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003514 self->alpn_protocols = PyMem_Malloc(protos->len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003515 if (!self->alpn_protocols)
3516 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003517 memcpy(self->alpn_protocols, protos->buf, protos->len);
Segev Finer5cff6372017-07-27 01:19:17 +03003518 self->alpn_protocols_len = (unsigned int)protos->len;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003519
3520 if (SSL_CTX_set_alpn_protos(self->ctx, self->alpn_protocols, self->alpn_protocols_len))
3521 return PyErr_NoMemory();
3522 SSL_CTX_set_alpn_select_cb(self->ctx, _selectALPN_cb, self);
3523
Benjamin Petersoncca27322015-01-23 16:35:37 -05003524 Py_RETURN_NONE;
3525#else
3526 PyErr_SetString(PyExc_NotImplementedError,
3527 "The ALPN extension requires OpenSSL 1.0.2 or later.");
3528 return NULL;
3529#endif
3530}
3531
Antoine Pitrou152efa22010-05-16 18:19:27 +00003532static PyObject *
3533get_verify_mode(PySSLContext *self, void *c)
3534{
Christian Heimes9fb051f2018-09-23 08:32:31 +02003535 /* ignore SSL_VERIFY_CLIENT_ONCE and SSL_VERIFY_POST_HANDSHAKE */
3536 int mask = (SSL_VERIFY_NONE | SSL_VERIFY_PEER |
3537 SSL_VERIFY_FAIL_IF_NO_PEER_CERT);
3538 switch (SSL_CTX_get_verify_mode(self->ctx) & mask) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00003539 case SSL_VERIFY_NONE:
3540 return PyLong_FromLong(PY_SSL_CERT_NONE);
3541 case SSL_VERIFY_PEER:
3542 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
3543 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
3544 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
3545 }
3546 PyErr_SetString(PySSLErrorObject,
3547 "invalid return value from SSL_CTX_get_verify_mode");
3548 return NULL;
3549}
3550
3551static int
3552set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
3553{
Christian Heimes5fe668c2016-09-12 00:01:11 +02003554 int n;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003555 if (!PyArg_Parse(arg, "i", &n))
3556 return -1;
Christian Heimes5fe668c2016-09-12 00:01:11 +02003557 if (n == PY_SSL_CERT_NONE && self->check_hostname) {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003558 PyErr_SetString(PyExc_ValueError,
3559 "Cannot set verify_mode to CERT_NONE when "
3560 "check_hostname is enabled.");
3561 return -1;
3562 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003563 return _set_verify_mode(self, n);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003564}
3565
3566static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01003567get_verify_flags(PySSLContext *self, void *c)
3568{
Christian Heimes598894f2016-09-05 23:19:05 +02003569 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003570 unsigned long flags;
3571
Christian Heimes61d478c2018-01-27 15:51:38 +01003572 param = SSL_CTX_get0_param(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02003573 flags = X509_VERIFY_PARAM_get_flags(param);
Christian Heimes22587792013-11-21 23:56:13 +01003574 return PyLong_FromUnsignedLong(flags);
3575}
3576
3577static int
3578set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
3579{
Christian Heimes598894f2016-09-05 23:19:05 +02003580 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003581 unsigned long new_flags, flags, set, clear;
3582
3583 if (!PyArg_Parse(arg, "k", &new_flags))
3584 return -1;
Christian Heimes61d478c2018-01-27 15:51:38 +01003585 param = SSL_CTX_get0_param(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02003586 flags = X509_VERIFY_PARAM_get_flags(param);
Christian Heimes22587792013-11-21 23:56:13 +01003587 clear = flags & ~new_flags;
3588 set = ~flags & new_flags;
3589 if (clear) {
Christian Heimes598894f2016-09-05 23:19:05 +02003590 if (!X509_VERIFY_PARAM_clear_flags(param, clear)) {
Christian Heimes22587792013-11-21 23:56:13 +01003591 _setSSLError(NULL, 0, __FILE__, __LINE__);
3592 return -1;
3593 }
3594 }
3595 if (set) {
Christian Heimes598894f2016-09-05 23:19:05 +02003596 if (!X509_VERIFY_PARAM_set_flags(param, set)) {
Christian Heimes22587792013-11-21 23:56:13 +01003597 _setSSLError(NULL, 0, __FILE__, __LINE__);
3598 return -1;
3599 }
3600 }
3601 return 0;
3602}
3603
Christian Heimes698dde12018-02-27 11:54:43 +01003604/* Getter and setter for protocol version */
3605#if defined(SSL_CTRL_GET_MAX_PROTO_VERSION)
3606
3607
3608static int
3609set_min_max_proto_version(PySSLContext *self, PyObject *arg, int what)
3610{
3611 long v;
3612 int result;
3613
3614 if (!PyArg_Parse(arg, "l", &v))
3615 return -1;
3616 if (v > INT_MAX) {
3617 PyErr_SetString(PyExc_OverflowError, "Option is too long");
3618 return -1;
3619 }
3620
3621 switch(self->protocol) {
3622 case PY_SSL_VERSION_TLS_CLIENT: /* fall through */
3623 case PY_SSL_VERSION_TLS_SERVER: /* fall through */
3624 case PY_SSL_VERSION_TLS:
3625 break;
3626 default:
3627 PyErr_SetString(
3628 PyExc_ValueError,
3629 "The context's protocol doesn't support modification of "
3630 "highest and lowest version."
3631 );
3632 return -1;
3633 }
3634
3635 if (what == 0) {
3636 switch(v) {
3637 case PY_PROTO_MINIMUM_SUPPORTED:
3638 v = 0;
3639 break;
3640 case PY_PROTO_MAXIMUM_SUPPORTED:
3641 /* Emulate max for set_min_proto_version */
3642 v = PY_PROTO_MAXIMUM_AVAILABLE;
3643 break;
3644 default:
3645 break;
3646 }
3647 result = SSL_CTX_set_min_proto_version(self->ctx, v);
3648 }
3649 else {
3650 switch(v) {
3651 case PY_PROTO_MAXIMUM_SUPPORTED:
3652 v = 0;
3653 break;
3654 case PY_PROTO_MINIMUM_SUPPORTED:
3655 /* Emulate max for set_min_proto_version */
3656 v = PY_PROTO_MINIMUM_AVAILABLE;
3657 break;
3658 default:
3659 break;
3660 }
3661 result = SSL_CTX_set_max_proto_version(self->ctx, v);
3662 }
3663 if (result == 0) {
3664 PyErr_Format(PyExc_ValueError,
3665 "Unsupported protocol version 0x%x", v);
3666 return -1;
3667 }
3668 return 0;
3669}
3670
3671static PyObject *
3672get_minimum_version(PySSLContext *self, void *c)
3673{
3674 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL);
3675 if (v == 0) {
3676 v = PY_PROTO_MINIMUM_SUPPORTED;
3677 }
3678 return PyLong_FromLong(v);
3679}
3680
3681static int
3682set_minimum_version(PySSLContext *self, PyObject *arg, void *c)
3683{
3684 return set_min_max_proto_version(self, arg, 0);
3685}
3686
3687static PyObject *
3688get_maximum_version(PySSLContext *self, void *c)
3689{
3690 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL);
3691 if (v == 0) {
3692 v = PY_PROTO_MAXIMUM_SUPPORTED;
3693 }
3694 return PyLong_FromLong(v);
3695}
3696
3697static int
3698set_maximum_version(PySSLContext *self, PyObject *arg, void *c)
3699{
3700 return set_min_max_proto_version(self, arg, 1);
3701}
3702#endif /* SSL_CTRL_GET_MAX_PROTO_VERSION */
3703
Christian Heimes78c7d522019-06-03 21:00:10 +02003704#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
3705static PyObject *
3706get_num_tickets(PySSLContext *self, void *c)
3707{
Victor Stinner76611c72019-07-09 13:30:52 +02003708 return PyLong_FromSize_t(SSL_CTX_get_num_tickets(self->ctx));
Christian Heimes78c7d522019-06-03 21:00:10 +02003709}
3710
3711static int
3712set_num_tickets(PySSLContext *self, PyObject *arg, void *c)
3713{
3714 long num;
3715 if (!PyArg_Parse(arg, "l", &num))
3716 return -1;
3717 if (num < 0) {
3718 PyErr_SetString(PyExc_ValueError, "value must be non-negative");
3719 return -1;
3720 }
3721 if (self->protocol != PY_SSL_VERSION_TLS_SERVER) {
3722 PyErr_SetString(PyExc_ValueError,
3723 "SSLContext is not a server context.");
3724 return -1;
3725 }
3726 if (SSL_CTX_set_num_tickets(self->ctx, num) != 1) {
3727 PyErr_SetString(PyExc_ValueError, "failed to set num tickets.");
3728 return -1;
3729 }
3730 return 0;
3731}
3732
3733PyDoc_STRVAR(PySSLContext_num_tickets_doc,
3734"Control the number of TLSv1.3 session tickets");
3735#endif /* OpenSSL 1.1.1 */
3736
matthewhughes9348e836bb2020-07-17 09:59:15 +01003737#if (OPENSSL_VERSION_NUMBER >= 0x10100000L) && !defined(LIBRESSL_VERSION_NUMBER)
3738static PyObject *
3739get_security_level(PySSLContext *self, void *c)
3740{
3741 return PyLong_FromLong(SSL_CTX_get_security_level(self->ctx));
3742}
3743PyDoc_STRVAR(PySSLContext_security_level_doc, "The current security level");
3744#endif /* OpenSSL 1.1.0 */
3745
Christian Heimes22587792013-11-21 23:56:13 +01003746static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00003747get_options(PySSLContext *self, void *c)
3748{
3749 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
3750}
3751
3752static int
3753set_options(PySSLContext *self, PyObject *arg, void *c)
3754{
3755 long new_opts, opts, set, clear;
3756 if (!PyArg_Parse(arg, "l", &new_opts))
3757 return -1;
3758 opts = SSL_CTX_get_options(self->ctx);
3759 clear = opts & ~new_opts;
3760 set = ~opts & new_opts;
3761 if (clear) {
3762#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
3763 SSL_CTX_clear_options(self->ctx, clear);
3764#else
3765 PyErr_SetString(PyExc_ValueError,
3766 "can't clear options before OpenSSL 0.9.8m");
3767 return -1;
3768#endif
3769 }
3770 if (set)
3771 SSL_CTX_set_options(self->ctx, set);
3772 return 0;
3773}
3774
Christian Heimes1aa9a752013-12-02 02:41:19 +01003775static PyObject *
Christian Heimes61d478c2018-01-27 15:51:38 +01003776get_host_flags(PySSLContext *self, void *c)
3777{
3778 return PyLong_FromUnsignedLong(self->hostflags);
3779}
3780
3781static int
3782set_host_flags(PySSLContext *self, PyObject *arg, void *c)
3783{
3784 X509_VERIFY_PARAM *param;
3785 unsigned int new_flags = 0;
3786
3787 if (!PyArg_Parse(arg, "I", &new_flags))
3788 return -1;
3789
3790 param = SSL_CTX_get0_param(self->ctx);
3791 self->hostflags = new_flags;
3792 X509_VERIFY_PARAM_set_hostflags(param, new_flags);
3793 return 0;
3794}
3795
3796static PyObject *
Christian Heimes1aa9a752013-12-02 02:41:19 +01003797get_check_hostname(PySSLContext *self, void *c)
3798{
3799 return PyBool_FromLong(self->check_hostname);
3800}
3801
3802static int
3803set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
3804{
3805 int check_hostname;
3806 if (!PyArg_Parse(arg, "p", &check_hostname))
3807 return -1;
3808 if (check_hostname &&
3809 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
Christian Heimese82c0342017-09-15 20:29:57 +02003810 /* check_hostname = True sets verify_mode = CERT_REQUIRED */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003811 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimese82c0342017-09-15 20:29:57 +02003812 return -1;
3813 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01003814 }
3815 self->check_hostname = check_hostname;
3816 return 0;
3817}
3818
Christian Heimes11a14932018-02-24 02:35:08 +01003819static PyObject *
Christian Heimes9fb051f2018-09-23 08:32:31 +02003820get_post_handshake_auth(PySSLContext *self, void *c) {
3821#if TLS1_3_VERSION
3822 return PyBool_FromLong(self->post_handshake_auth);
3823#else
3824 Py_RETURN_NONE;
3825#endif
3826}
3827
3828#if TLS1_3_VERSION
3829static int
3830set_post_handshake_auth(PySSLContext *self, PyObject *arg, void *c) {
Zackery Spytz842acaa2018-12-17 07:52:45 -07003831 if (arg == NULL) {
3832 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
3833 return -1;
3834 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003835 int pha = PyObject_IsTrue(arg);
3836
3837 if (pha == -1) {
3838 return -1;
3839 }
3840 self->post_handshake_auth = pha;
3841
Christian Heimesf0f59302019-07-01 08:29:17 +02003842 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3843 * server sockets and SSL_set_post_handshake_auth() for client. */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003844
3845 return 0;
3846}
3847#endif
3848
3849static PyObject *
Christian Heimes11a14932018-02-24 02:35:08 +01003850get_protocol(PySSLContext *self, void *c) {
3851 return PyLong_FromLong(self->protocol);
3852}
Christian Heimes1aa9a752013-12-02 02:41:19 +01003853
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003854typedef struct {
3855 PyThreadState *thread_state;
3856 PyObject *callable;
3857 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02003858 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003859 int error;
3860} _PySSLPasswordInfo;
3861
3862static int
3863_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
3864 const char *bad_type_error)
3865{
3866 /* Set the password and size fields of a _PySSLPasswordInfo struct
3867 from a unicode, bytes, or byte array object.
3868 The password field will be dynamically allocated and must be freed
3869 by the caller */
3870 PyObject *password_bytes = NULL;
3871 const char *data = NULL;
3872 Py_ssize_t size;
3873
3874 if (PyUnicode_Check(password)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003875 password_bytes = PyUnicode_AsUTF8String(password);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003876 if (!password_bytes) {
3877 goto error;
3878 }
3879 data = PyBytes_AS_STRING(password_bytes);
3880 size = PyBytes_GET_SIZE(password_bytes);
3881 } else if (PyBytes_Check(password)) {
3882 data = PyBytes_AS_STRING(password);
3883 size = PyBytes_GET_SIZE(password);
3884 } else if (PyByteArray_Check(password)) {
3885 data = PyByteArray_AS_STRING(password);
3886 size = PyByteArray_GET_SIZE(password);
3887 } else {
3888 PyErr_SetString(PyExc_TypeError, bad_type_error);
3889 goto error;
3890 }
3891
Victor Stinner9ee02032013-06-23 15:08:23 +02003892 if (size > (Py_ssize_t)INT_MAX) {
3893 PyErr_Format(PyExc_ValueError,
3894 "password cannot be longer than %d bytes", INT_MAX);
3895 goto error;
3896 }
3897
Victor Stinner11ebff22013-07-07 17:07:52 +02003898 PyMem_Free(pw_info->password);
3899 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003900 if (!pw_info->password) {
3901 PyErr_SetString(PyExc_MemoryError,
3902 "unable to allocate password buffer");
3903 goto error;
3904 }
3905 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02003906 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003907
3908 Py_XDECREF(password_bytes);
3909 return 1;
3910
3911error:
3912 Py_XDECREF(password_bytes);
3913 return 0;
3914}
3915
3916static int
3917_password_callback(char *buf, int size, int rwflag, void *userdata)
3918{
3919 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
3920 PyObject *fn_ret = NULL;
3921
3922 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
3923
3924 if (pw_info->callable) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01003925 fn_ret = _PyObject_CallNoArg(pw_info->callable);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003926 if (!fn_ret) {
3927 /* TODO: It would be nice to move _ctypes_add_traceback() into the
3928 core python API, so we could use it to add a frame here */
3929 goto error;
3930 }
3931
3932 if (!_pwinfo_set(pw_info, fn_ret,
3933 "password callback must return a string")) {
3934 goto error;
3935 }
3936 Py_CLEAR(fn_ret);
3937 }
3938
3939 if (pw_info->size > size) {
3940 PyErr_Format(PyExc_ValueError,
3941 "password cannot be longer than %d bytes", size);
3942 goto error;
3943 }
3944
3945 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3946 memcpy(buf, pw_info->password, pw_info->size);
3947 return pw_info->size;
3948
3949error:
3950 Py_XDECREF(fn_ret);
3951 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3952 pw_info->error = 1;
3953 return -1;
3954}
3955
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003956/*[clinic input]
3957_ssl._SSLContext.load_cert_chain
3958 certfile: object
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003959 keyfile: object = None
3960 password: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003961
3962[clinic start generated code]*/
3963
Antoine Pitroub5218772010-05-21 09:56:06 +00003964static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003965_ssl__SSLContext_load_cert_chain_impl(PySSLContext *self, PyObject *certfile,
3966 PyObject *keyfile, PyObject *password)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003967/*[clinic end generated code: output=9480bc1c380e2095 input=30bc7e967ea01a58]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003968{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003969 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Christian Heimes598894f2016-09-05 23:19:05 +02003970 pem_password_cb *orig_passwd_cb = SSL_CTX_get_default_passwd_cb(self->ctx);
3971 void *orig_passwd_userdata = SSL_CTX_get_default_passwd_cb_userdata(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003972 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00003973 int r;
3974
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00003975 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00003976 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003977 if (keyfile == Py_None)
3978 keyfile = NULL;
3979 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003980 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3981 PyErr_SetString(PyExc_TypeError,
3982 "certfile should be a valid filesystem path");
3983 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003984 return NULL;
3985 }
3986 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003987 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3988 PyErr_SetString(PyExc_TypeError,
3989 "keyfile should be a valid filesystem path");
3990 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003991 goto error;
3992 }
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003993 if (password != Py_None) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003994 if (PyCallable_Check(password)) {
3995 pw_info.callable = password;
3996 } else if (!_pwinfo_set(&pw_info, password,
3997 "password should be a string or callable")) {
3998 goto error;
3999 }
4000 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
4001 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
4002 }
4003 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004004 r = SSL_CTX_use_certificate_chain_file(self->ctx,
4005 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004006 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004007 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004008 if (pw_info.error) {
4009 ERR_clear_error();
4010 /* the password callback has already set the error information */
4011 }
4012 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004013 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004014 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004015 }
4016 else {
4017 _setSSLError(NULL, 0, __FILE__, __LINE__);
4018 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004019 goto error;
4020 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004021 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02004022 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00004023 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
4024 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004025 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
4026 Py_CLEAR(keyfile_bytes);
4027 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004028 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004029 if (pw_info.error) {
4030 ERR_clear_error();
4031 /* the password callback has already set the error information */
4032 }
4033 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004034 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004035 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004036 }
4037 else {
4038 _setSSLError(NULL, 0, __FILE__, __LINE__);
4039 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004040 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004041 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004042 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004043 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004044 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004045 if (r != 1) {
4046 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004047 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004048 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004049 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4050 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004051 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004052 Py_RETURN_NONE;
4053
4054error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004055 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4056 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004057 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004058 Py_XDECREF(keyfile_bytes);
4059 Py_XDECREF(certfile_bytes);
4060 return NULL;
4061}
4062
Christian Heimesefff7062013-11-21 03:35:02 +01004063/* internal helper function, returns -1 on error
4064 */
4065static int
Serhiy Storchaka8f87eef2020-04-12 14:58:27 +03004066_add_ca_certs(PySSLContext *self, const void *data, Py_ssize_t len,
Christian Heimesefff7062013-11-21 03:35:02 +01004067 int filetype)
4068{
4069 BIO *biobuf = NULL;
4070 X509_STORE *store;
4071 int retval = 0, err, loaded = 0;
4072
4073 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
4074
4075 if (len <= 0) {
4076 PyErr_SetString(PyExc_ValueError,
4077 "Empty certificate data");
4078 return -1;
4079 } else if (len > INT_MAX) {
4080 PyErr_SetString(PyExc_OverflowError,
4081 "Certificate data is too long.");
4082 return -1;
4083 }
4084
Christian Heimes1dbf61f2013-11-22 00:34:18 +01004085 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01004086 if (biobuf == NULL) {
4087 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
4088 return -1;
4089 }
4090
4091 store = SSL_CTX_get_cert_store(self->ctx);
4092 assert(store != NULL);
4093
4094 while (1) {
4095 X509 *cert = NULL;
4096 int r;
4097
4098 if (filetype == SSL_FILETYPE_ASN1) {
4099 cert = d2i_X509_bio(biobuf, NULL);
4100 } else {
4101 cert = PEM_read_bio_X509(biobuf, NULL,
Christian Heimes598894f2016-09-05 23:19:05 +02004102 SSL_CTX_get_default_passwd_cb(self->ctx),
4103 SSL_CTX_get_default_passwd_cb_userdata(self->ctx)
4104 );
Christian Heimesefff7062013-11-21 03:35:02 +01004105 }
4106 if (cert == NULL) {
4107 break;
4108 }
4109 r = X509_STORE_add_cert(store, cert);
4110 X509_free(cert);
4111 if (!r) {
4112 err = ERR_peek_last_error();
4113 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
4114 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
4115 /* cert already in hash table, not an error */
4116 ERR_clear_error();
4117 } else {
4118 break;
4119 }
4120 }
4121 loaded++;
4122 }
4123
4124 err = ERR_peek_last_error();
4125 if ((filetype == SSL_FILETYPE_ASN1) &&
4126 (loaded > 0) &&
4127 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
4128 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
4129 /* EOF ASN1 file, not an error */
4130 ERR_clear_error();
4131 retval = 0;
4132 } else if ((filetype == SSL_FILETYPE_PEM) &&
4133 (loaded > 0) &&
4134 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
4135 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
4136 /* EOF PEM file, not an error */
4137 ERR_clear_error();
4138 retval = 0;
4139 } else {
4140 _setSSLError(NULL, 0, __FILE__, __LINE__);
4141 retval = -1;
4142 }
4143
4144 BIO_free(biobuf);
4145 return retval;
4146}
4147
4148
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004149/*[clinic input]
4150_ssl._SSLContext.load_verify_locations
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004151 cafile: object = None
4152 capath: object = None
4153 cadata: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004154
4155[clinic start generated code]*/
4156
Antoine Pitrou152efa22010-05-16 18:19:27 +00004157static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004158_ssl__SSLContext_load_verify_locations_impl(PySSLContext *self,
4159 PyObject *cafile,
4160 PyObject *capath,
4161 PyObject *cadata)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004162/*[clinic end generated code: output=454c7e41230ca551 input=42ecfe258233e194]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004163{
Antoine Pitrou152efa22010-05-16 18:19:27 +00004164 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
4165 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004166 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004167
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004168 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004169 if (cafile == Py_None)
4170 cafile = NULL;
4171 if (capath == Py_None)
4172 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004173 if (cadata == Py_None)
4174 cadata = NULL;
4175
4176 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004177 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01004178 "cafile, capath and cadata cannot be all omitted");
4179 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004180 }
4181 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004182 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4183 PyErr_SetString(PyExc_TypeError,
4184 "cafile should be a valid filesystem path");
4185 }
Christian Heimesefff7062013-11-21 03:35:02 +01004186 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004187 }
4188 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004189 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4190 PyErr_SetString(PyExc_TypeError,
4191 "capath should be a valid filesystem path");
4192 }
Christian Heimesefff7062013-11-21 03:35:02 +01004193 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004194 }
Christian Heimesefff7062013-11-21 03:35:02 +01004195
4196 /* validata cadata type and load cadata */
4197 if (cadata) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004198 if (PyUnicode_Check(cadata)) {
4199 PyObject *cadata_ascii = PyUnicode_AsASCIIString(cadata);
4200 if (cadata_ascii == NULL) {
4201 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
4202 goto invalid_cadata;
4203 }
4204 goto error;
4205 }
4206 r = _add_ca_certs(self,
4207 PyBytes_AS_STRING(cadata_ascii),
4208 PyBytes_GET_SIZE(cadata_ascii),
4209 SSL_FILETYPE_PEM);
4210 Py_DECREF(cadata_ascii);
4211 if (r == -1) {
4212 goto error;
4213 }
4214 }
4215 else if (PyObject_CheckBuffer(cadata)) {
4216 Py_buffer buf;
4217 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE)) {
4218 goto error;
4219 }
Christian Heimesefff7062013-11-21 03:35:02 +01004220 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
4221 PyBuffer_Release(&buf);
4222 PyErr_SetString(PyExc_TypeError,
4223 "cadata should be a contiguous buffer with "
4224 "a single dimension");
4225 goto error;
4226 }
4227 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
4228 PyBuffer_Release(&buf);
4229 if (r == -1) {
4230 goto error;
4231 }
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004232 }
4233 else {
4234 invalid_cadata:
4235 PyErr_SetString(PyExc_TypeError,
4236 "cadata should be an ASCII string or a "
4237 "bytes-like object");
4238 goto error;
Christian Heimesefff7062013-11-21 03:35:02 +01004239 }
4240 }
4241
4242 /* load cafile or capath */
4243 if (cafile || capath) {
4244 if (cafile)
4245 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
4246 if (capath)
4247 capath_buf = PyBytes_AS_STRING(capath_bytes);
4248 PySSL_BEGIN_ALLOW_THREADS
4249 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
4250 PySSL_END_ALLOW_THREADS
4251 if (r != 1) {
Christian Heimesefff7062013-11-21 03:35:02 +01004252 if (errno != 0) {
4253 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004254 PyErr_SetFromErrno(PyExc_OSError);
Christian Heimesefff7062013-11-21 03:35:02 +01004255 }
4256 else {
4257 _setSSLError(NULL, 0, __FILE__, __LINE__);
4258 }
4259 goto error;
4260 }
4261 }
4262 goto end;
4263
4264 error:
4265 ok = 0;
4266 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00004267 Py_XDECREF(cafile_bytes);
4268 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01004269 if (ok) {
4270 Py_RETURN_NONE;
4271 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004272 return NULL;
4273 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004274}
4275
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004276/*[clinic input]
4277_ssl._SSLContext.load_dh_params
4278 path as filepath: object
4279 /
4280
4281[clinic start generated code]*/
4282
Antoine Pitrou152efa22010-05-16 18:19:27 +00004283static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004284_ssl__SSLContext_load_dh_params(PySSLContext *self, PyObject *filepath)
4285/*[clinic end generated code: output=1c8e57a38e055af0 input=c8871f3c796ae1d6]*/
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004286{
4287 FILE *f;
4288 DH *dh;
4289
Victor Stinnerdaf45552013-08-28 00:53:59 +02004290 f = _Py_fopen_obj(filepath, "rb");
Victor Stinnere42ccd22015-03-18 01:39:23 +01004291 if (f == NULL)
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004292 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01004293
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004294 errno = 0;
4295 PySSL_BEGIN_ALLOW_THREADS
4296 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01004297 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004298 PySSL_END_ALLOW_THREADS
4299 if (dh == NULL) {
4300 if (errno != 0) {
4301 ERR_clear_error();
4302 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
4303 }
4304 else {
4305 _setSSLError(NULL, 0, __FILE__, __LINE__);
4306 }
4307 return NULL;
4308 }
Zackery Spytzaebc0492020-07-07 22:21:58 -06004309 if (!SSL_CTX_set_tmp_dh(self->ctx, dh)) {
4310 DH_free(dh);
4311 return _setSSLError(NULL, 0, __FILE__, __LINE__);
4312 }
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004313 DH_free(dh);
4314 Py_RETURN_NONE;
4315}
4316
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004317/*[clinic input]
4318_ssl._SSLContext._wrap_socket
4319 sock: object(subclass_of="PySocketModule.Sock_Type")
4320 server_side: int
4321 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004322 *
4323 owner: object = None
4324 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004325
4326[clinic start generated code]*/
4327
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004328static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004329_ssl__SSLContext__wrap_socket_impl(PySSLContext *self, PyObject *sock,
Christian Heimes141c5e82018-02-24 21:10:57 +01004330 int server_side, PyObject *hostname_obj,
4331 PyObject *owner, PyObject *session)
4332/*[clinic end generated code: output=f103f238633940b4 input=957d5006183d1894]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004333{
Antoine Pitroud5323212010-10-22 18:19:07 +00004334 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004335 PyObject *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004336
Antoine Pitroud5323212010-10-22 18:19:07 +00004337 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004338 as IDN A-label (ASCII str) without NULL bytes. */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004339 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004340 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroud5323212010-10-22 18:19:07 +00004341 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00004342 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004343
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004344 res = (PyObject *) newPySSLSocket(self, (PySocketSockObject *)sock,
4345 server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004346 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004347 NULL, NULL);
Antoine Pitroud5323212010-10-22 18:19:07 +00004348 if (hostname != NULL)
4349 PyMem_Free(hostname);
4350 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004351}
4352
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004353/*[clinic input]
4354_ssl._SSLContext._wrap_bio
Christian Heimes5c36da72020-11-20 09:40:12 +01004355 incoming: object(subclass_of="PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
4356 outgoing: object(subclass_of="PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004357 server_side: int
4358 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004359 *
4360 owner: object = None
4361 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004362
4363[clinic start generated code]*/
4364
Antoine Pitroub0182c82010-10-12 20:09:02 +00004365static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004366_ssl__SSLContext__wrap_bio_impl(PySSLContext *self, PySSLMemoryBIO *incoming,
4367 PySSLMemoryBIO *outgoing, int server_side,
Christian Heimes141c5e82018-02-24 21:10:57 +01004368 PyObject *hostname_obj, PyObject *owner,
4369 PyObject *session)
Christian Heimes5c36da72020-11-20 09:40:12 +01004370/*[clinic end generated code: output=5c5d6d9b41f99332 input=63867b8f3e1a1aa3]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004371{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004372 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004373 PyObject *res;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004374
4375 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004376 as IDN A-label (ASCII str) without NULL bytes. */
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004377 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004378 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004379 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004380 }
4381
4382 res = (PyObject *) newPySSLSocket(self, NULL, server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004383 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004384 incoming, outgoing);
4385
4386 PyMem_Free(hostname);
4387 return res;
4388}
4389
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004390/*[clinic input]
4391_ssl._SSLContext.session_stats
4392[clinic start generated code]*/
4393
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004394static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004395_ssl__SSLContext_session_stats_impl(PySSLContext *self)
4396/*[clinic end generated code: output=0d96411c42893bfb input=7e0a81fb11102c8b]*/
Antoine Pitroub0182c82010-10-12 20:09:02 +00004397{
4398 int r;
4399 PyObject *value, *stats = PyDict_New();
4400 if (!stats)
4401 return NULL;
4402
4403#define ADD_STATS(SSL_NAME, KEY_NAME) \
4404 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
4405 if (value == NULL) \
4406 goto error; \
4407 r = PyDict_SetItemString(stats, KEY_NAME, value); \
4408 Py_DECREF(value); \
4409 if (r < 0) \
4410 goto error;
4411
4412 ADD_STATS(number, "number");
4413 ADD_STATS(connect, "connect");
4414 ADD_STATS(connect_good, "connect_good");
4415 ADD_STATS(connect_renegotiate, "connect_renegotiate");
4416 ADD_STATS(accept, "accept");
4417 ADD_STATS(accept_good, "accept_good");
4418 ADD_STATS(accept_renegotiate, "accept_renegotiate");
4419 ADD_STATS(accept, "accept");
4420 ADD_STATS(hits, "hits");
4421 ADD_STATS(misses, "misses");
4422 ADD_STATS(timeouts, "timeouts");
4423 ADD_STATS(cache_full, "cache_full");
4424
4425#undef ADD_STATS
4426
4427 return stats;
4428
4429error:
4430 Py_DECREF(stats);
4431 return NULL;
4432}
4433
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004434/*[clinic input]
4435_ssl._SSLContext.set_default_verify_paths
4436[clinic start generated code]*/
4437
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004438static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004439_ssl__SSLContext_set_default_verify_paths_impl(PySSLContext *self)
4440/*[clinic end generated code: output=0bee74e6e09deaaa input=35f3408021463d74]*/
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004441{
4442 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
4443 _setSSLError(NULL, 0, __FILE__, __LINE__);
4444 return NULL;
4445 }
4446 Py_RETURN_NONE;
4447}
4448
Antoine Pitrou501da612011-12-21 09:27:41 +01004449#ifndef OPENSSL_NO_ECDH
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004450/*[clinic input]
4451_ssl._SSLContext.set_ecdh_curve
4452 name: object
4453 /
4454
4455[clinic start generated code]*/
4456
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004457static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004458_ssl__SSLContext_set_ecdh_curve(PySSLContext *self, PyObject *name)
4459/*[clinic end generated code: output=23022c196e40d7d2 input=c2bafb6f6e34726b]*/
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004460{
4461 PyObject *name_bytes;
4462 int nid;
4463 EC_KEY *key;
4464
4465 if (!PyUnicode_FSConverter(name, &name_bytes))
4466 return NULL;
4467 assert(PyBytes_Check(name_bytes));
4468 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
4469 Py_DECREF(name_bytes);
4470 if (nid == 0) {
4471 PyErr_Format(PyExc_ValueError,
4472 "unknown elliptic curve name %R", name);
4473 return NULL;
4474 }
4475 key = EC_KEY_new_by_curve_name(nid);
4476 if (key == NULL) {
4477 _setSSLError(NULL, 0, __FILE__, __LINE__);
4478 return NULL;
4479 }
4480 SSL_CTX_set_tmp_ecdh(self->ctx, key);
4481 EC_KEY_free(key);
4482 Py_RETURN_NONE;
4483}
Antoine Pitrou501da612011-12-21 09:27:41 +01004484#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004485
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004486#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004487static int
4488_servername_callback(SSL *s, int *al, void *args)
4489{
4490 int ret;
4491 PySSLContext *ssl_ctx = (PySSLContext *) args;
4492 PySSLSocket *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004493 PyObject *result;
4494 /* The high-level ssl.SSLSocket object */
4495 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004496 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01004497 PyGILState_STATE gstate = PyGILState_Ensure();
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004498
Christian Heimes11a14932018-02-24 02:35:08 +01004499 if (ssl_ctx->set_sni_cb == NULL) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004500 /* remove race condition in this the call back while if removing the
4501 * callback is in progress */
4502 PyGILState_Release(gstate);
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01004503 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004504 }
4505
4506 ssl = SSL_get_app_data(s);
4507 assert(PySSLSocket_Check(ssl));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004508
Serhiy Storchakaf51d7152015-11-02 14:40:41 +02004509 /* The servername callback expects an argument that represents the current
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004510 * SSL connection and that has a .context attribute that can be changed to
4511 * identify the requested hostname. Since the official API is the Python
4512 * level API we want to pass the callback a Python level object rather than
4513 * a _ssl.SSLSocket instance. If there's an "owner" (typically an
4514 * SSLObject) that will be passed. Otherwise if there's a socket then that
4515 * will be passed. If both do not exist only then the C-level object is
4516 * passed. */
4517 if (ssl->owner)
4518 ssl_socket = PyWeakref_GetObject(ssl->owner);
4519 else if (ssl->Socket)
4520 ssl_socket = PyWeakref_GetObject(ssl->Socket);
4521 else
4522 ssl_socket = (PyObject *) ssl;
4523
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004524 Py_INCREF(ssl_socket);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004525 if (ssl_socket == Py_None)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004526 goto error;
Victor Stinner7e001512013-06-25 00:44:31 +02004527
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004528 if (servername == NULL) {
Christian Heimes11a14932018-02-24 02:35:08 +01004529 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_sni_cb, ssl_socket,
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004530 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004531 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004532 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004533 PyObject *servername_bytes;
4534 PyObject *servername_str;
4535
4536 servername_bytes = PyBytes_FromString(servername);
4537 if (servername_bytes == NULL) {
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004538 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
4539 goto error;
4540 }
Christian Heimes11a14932018-02-24 02:35:08 +01004541 /* server_hostname was encoded to an A-label by our caller; put it
4542 * back into a str object, but still as an A-label (bpo-28414)
4543 */
4544 servername_str = PyUnicode_FromEncodedObject(servername_bytes, "ascii", NULL);
Christian Heimes11a14932018-02-24 02:35:08 +01004545 if (servername_str == NULL) {
4546 PyErr_WriteUnraisable(servername_bytes);
Zackery Spytzee96f322020-07-09 04:00:21 -06004547 Py_DECREF(servername_bytes);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004548 goto error;
4549 }
Zackery Spytzee96f322020-07-09 04:00:21 -06004550 Py_DECREF(servername_bytes);
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},
matthewhughes9348e836bb2020-07-17 09:59:15 +01004793#if (OPENSSL_VERSION_NUMBER >= 0x10100000L) && !defined(LIBRESSL_VERSION_NUMBER)
4794 {"security_level", (getter) get_security_level,
4795 NULL, PySSLContext_security_level_doc},
4796#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00004797 {NULL}, /* sentinel */
4798};
4799
4800static struct PyMethodDef context_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004801 _SSL__SSLCONTEXT__WRAP_SOCKET_METHODDEF
4802 _SSL__SSLCONTEXT__WRAP_BIO_METHODDEF
4803 _SSL__SSLCONTEXT_SET_CIPHERS_METHODDEF
4804 _SSL__SSLCONTEXT__SET_ALPN_PROTOCOLS_METHODDEF
4805 _SSL__SSLCONTEXT__SET_NPN_PROTOCOLS_METHODDEF
4806 _SSL__SSLCONTEXT_LOAD_CERT_CHAIN_METHODDEF
4807 _SSL__SSLCONTEXT_LOAD_DH_PARAMS_METHODDEF
4808 _SSL__SSLCONTEXT_LOAD_VERIFY_LOCATIONS_METHODDEF
4809 _SSL__SSLCONTEXT_SESSION_STATS_METHODDEF
4810 _SSL__SSLCONTEXT_SET_DEFAULT_VERIFY_PATHS_METHODDEF
4811 _SSL__SSLCONTEXT_SET_ECDH_CURVE_METHODDEF
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004812 _SSL__SSLCONTEXT_CERT_STORE_STATS_METHODDEF
4813 _SSL__SSLCONTEXT_GET_CA_CERTS_METHODDEF
Christian Heimes25bfcd52016-09-06 00:04:45 +02004814 _SSL__SSLCONTEXT_GET_CIPHERS_METHODDEF
Antoine Pitrou152efa22010-05-16 18:19:27 +00004815 {NULL, NULL} /* sentinel */
4816};
4817
Christian Heimes5c36da72020-11-20 09:40:12 +01004818static PyType_Slot PySSLContext_slots[] = {
4819 {Py_tp_methods, context_methods},
4820 {Py_tp_getset, context_getsetlist},
4821 {Py_tp_new, _ssl__SSLContext},
4822 {Py_tp_dealloc, context_dealloc},
4823 {Py_tp_traverse, context_traverse},
4824 {Py_tp_clear, context_clear},
4825 {0, 0},
4826};
4827
4828static PyType_Spec PySSLContext_spec = {
4829 "_ssl._SSLContext",
4830 sizeof(PySSLContext),
4831 0,
4832 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
4833 PySSLContext_slots,
Antoine Pitrou152efa22010-05-16 18:19:27 +00004834};
4835
4836
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004837/*
4838 * MemoryBIO objects
4839 */
4840
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004841/*[clinic input]
4842@classmethod
4843_ssl.MemoryBIO.__new__
4844
4845[clinic start generated code]*/
4846
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004847static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004848_ssl_MemoryBIO_impl(PyTypeObject *type)
4849/*[clinic end generated code: output=8820a58db78330ac input=26d22e4909ecb1b5]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004850{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004851 BIO *bio;
4852 PySSLMemoryBIO *self;
4853
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004854 bio = BIO_new(BIO_s_mem());
4855 if (bio == NULL) {
4856 PyErr_SetString(PySSLErrorObject,
4857 "failed to allocate BIO");
4858 return NULL;
4859 }
4860 /* Since our BIO is non-blocking an empty read() does not indicate EOF,
4861 * just that no data is currently available. The SSL routines should retry
4862 * the read, which we can achieve by calling BIO_set_retry_read(). */
4863 BIO_set_retry_read(bio);
4864 BIO_set_mem_eof_return(bio, -1);
4865
4866 assert(type != NULL && type->tp_alloc != NULL);
4867 self = (PySSLMemoryBIO *) type->tp_alloc(type, 0);
4868 if (self == NULL) {
4869 BIO_free(bio);
4870 return NULL;
4871 }
4872 self->bio = bio;
4873 self->eof_written = 0;
4874
4875 return (PyObject *) self;
4876}
4877
4878static void
4879memory_bio_dealloc(PySSLMemoryBIO *self)
4880{
Christian Heimes5c36da72020-11-20 09:40:12 +01004881 PyTypeObject *tp = Py_TYPE(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004882 BIO_free(self->bio);
4883 Py_TYPE(self)->tp_free(self);
Christian Heimes5c36da72020-11-20 09:40:12 +01004884 Py_DECREF(tp);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004885}
4886
4887static PyObject *
4888memory_bio_get_pending(PySSLMemoryBIO *self, void *c)
4889{
Segev Finer5cff6372017-07-27 01:19:17 +03004890 return PyLong_FromSize_t(BIO_ctrl_pending(self->bio));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004891}
4892
4893PyDoc_STRVAR(PySSL_memory_bio_pending_doc,
4894"The number of bytes pending in the memory BIO.");
4895
4896static PyObject *
4897memory_bio_get_eof(PySSLMemoryBIO *self, void *c)
4898{
4899 return PyBool_FromLong((BIO_ctrl_pending(self->bio) == 0)
4900 && self->eof_written);
4901}
4902
4903PyDoc_STRVAR(PySSL_memory_bio_eof_doc,
4904"Whether the memory BIO is at EOF.");
4905
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004906/*[clinic input]
4907_ssl.MemoryBIO.read
4908 size as len: int = -1
4909 /
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004910
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004911Read up to size bytes from the memory BIO.
4912
4913If size is not specified, read the entire buffer.
4914If the return value is an empty bytes instance, this means either
4915EOF or that no data is available. Use the "eof" property to
4916distinguish between the two.
4917[clinic start generated code]*/
4918
4919static PyObject *
4920_ssl_MemoryBIO_read_impl(PySSLMemoryBIO *self, int len)
4921/*[clinic end generated code: output=a657aa1e79cd01b3 input=574d7be06a902366]*/
4922{
4923 int avail, nbytes;
4924 PyObject *result;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004925
Segev Finer5cff6372017-07-27 01:19:17 +03004926 avail = (int)Py_MIN(BIO_ctrl_pending(self->bio), INT_MAX);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004927 if ((len < 0) || (len > avail))
4928 len = avail;
4929
4930 result = PyBytes_FromStringAndSize(NULL, len);
4931 if ((result == NULL) || (len == 0))
4932 return result;
4933
4934 nbytes = BIO_read(self->bio, PyBytes_AS_STRING(result), len);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004935 if (nbytes < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004936 Py_DECREF(result);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004937 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004938 return NULL;
4939 }
4940
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004941 /* There should never be any short reads but check anyway. */
4942 if (nbytes < len) {
4943 _PyBytes_Resize(&result, nbytes);
4944 }
4945
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004946 return result;
4947}
4948
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004949/*[clinic input]
4950_ssl.MemoryBIO.write
4951 b: Py_buffer
4952 /
4953
4954Writes the bytes b into the memory BIO.
4955
4956Returns the number of bytes written.
4957[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004958
4959static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004960_ssl_MemoryBIO_write_impl(PySSLMemoryBIO *self, Py_buffer *b)
4961/*[clinic end generated code: output=156ec59110d75935 input=e45757b3e17c4808]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004962{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004963 int nbytes;
4964
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004965 if (b->len > INT_MAX) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004966 PyErr_Format(PyExc_OverflowError,
4967 "string longer than %d bytes", INT_MAX);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004968 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004969 }
4970
4971 if (self->eof_written) {
4972 PyErr_SetString(PySSLErrorObject,
4973 "cannot write() after write_eof()");
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004974 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004975 }
4976
Segev Finer5cff6372017-07-27 01:19:17 +03004977 nbytes = BIO_write(self->bio, b->buf, (int)b->len);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004978 if (nbytes < 0) {
4979 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004980 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004981 }
4982
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004983 return PyLong_FromLong(nbytes);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004984}
4985
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004986/*[clinic input]
4987_ssl.MemoryBIO.write_eof
4988
4989Write an EOF marker to the memory BIO.
4990
4991When all data has been read, the "eof" property will be True.
4992[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004993
4994static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004995_ssl_MemoryBIO_write_eof_impl(PySSLMemoryBIO *self)
4996/*[clinic end generated code: output=d4106276ccd1ed34 input=56a945f1d29e8bd6]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004997{
4998 self->eof_written = 1;
4999 /* After an EOF is written, a zero return from read() should be a real EOF
5000 * i.e. it should not be retried. Clear the SHOULD_RETRY flag. */
5001 BIO_clear_retry_flags(self->bio);
5002 BIO_set_mem_eof_return(self->bio, 0);
5003
5004 Py_RETURN_NONE;
5005}
5006
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005007static PyGetSetDef memory_bio_getsetlist[] = {
5008 {"pending", (getter) memory_bio_get_pending, NULL,
5009 PySSL_memory_bio_pending_doc},
5010 {"eof", (getter) memory_bio_get_eof, NULL,
5011 PySSL_memory_bio_eof_doc},
5012 {NULL}, /* sentinel */
5013};
5014
5015static struct PyMethodDef memory_bio_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005016 _SSL_MEMORYBIO_READ_METHODDEF
5017 _SSL_MEMORYBIO_WRITE_METHODDEF
5018 _SSL_MEMORYBIO_WRITE_EOF_METHODDEF
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005019 {NULL, NULL} /* sentinel */
5020};
5021
Christian Heimes5c36da72020-11-20 09:40:12 +01005022static PyType_Slot PySSLMemoryBIO_slots[] = {
5023 {Py_tp_methods, memory_bio_methods},
5024 {Py_tp_getset, memory_bio_getsetlist},
5025 {Py_tp_new, _ssl_MemoryBIO},
5026 {Py_tp_dealloc, memory_bio_dealloc},
5027 {0, 0},
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005028};
5029
Christian Heimes5c36da72020-11-20 09:40:12 +01005030static PyType_Spec PySSLMemoryBIO_spec = {
5031 "_ssl.MemoryBIO",
5032 sizeof(PySSLMemoryBIO),
5033 0,
5034 Py_TPFLAGS_DEFAULT,
5035 PySSLMemoryBIO_slots,
5036};
Antoine Pitrou152efa22010-05-16 18:19:27 +00005037
Christian Heimes99a65702016-09-10 23:44:53 +02005038/*
5039 * SSL Session object
5040 */
5041
5042static void
5043PySSLSession_dealloc(PySSLSession *self)
5044{
Christian Heimes5c36da72020-11-20 09:40:12 +01005045 PyTypeObject *tp = Py_TYPE(self);
INADA Naokia6296d32017-08-24 14:55:17 +09005046 /* bpo-31095: UnTrack is needed before calling any callbacks */
Christian Heimesa5d07652016-09-24 10:48:05 +02005047 PyObject_GC_UnTrack(self);
Christian Heimes99a65702016-09-10 23:44:53 +02005048 Py_XDECREF(self->ctx);
5049 if (self->session != NULL) {
5050 SSL_SESSION_free(self->session);
5051 }
Christian Heimesa5d07652016-09-24 10:48:05 +02005052 PyObject_GC_Del(self);
Christian Heimes5c36da72020-11-20 09:40:12 +01005053 Py_DECREF(tp);
Christian Heimes99a65702016-09-10 23:44:53 +02005054}
5055
5056static PyObject *
5057PySSLSession_richcompare(PyObject *left, PyObject *right, int op)
5058{
5059 int result;
5060
5061 if (left == NULL || right == NULL) {
5062 PyErr_BadInternalCall();
5063 return NULL;
5064 }
5065
5066 if (!PySSLSession_Check(left) || !PySSLSession_Check(right)) {
5067 Py_RETURN_NOTIMPLEMENTED;
5068 }
5069
5070 if (left == right) {
5071 result = 0;
5072 } else {
5073 const unsigned char *left_id, *right_id;
5074 unsigned int left_len, right_len;
5075 left_id = SSL_SESSION_get_id(((PySSLSession *)left)->session,
5076 &left_len);
5077 right_id = SSL_SESSION_get_id(((PySSLSession *)right)->session,
5078 &right_len);
5079 if (left_len == right_len) {
5080 result = memcmp(left_id, right_id, left_len);
5081 } else {
5082 result = 1;
5083 }
5084 }
5085
5086 switch (op) {
5087 case Py_EQ:
5088 if (result == 0) {
5089 Py_RETURN_TRUE;
5090 } else {
5091 Py_RETURN_FALSE;
5092 }
5093 break;
5094 case Py_NE:
5095 if (result != 0) {
5096 Py_RETURN_TRUE;
5097 } else {
5098 Py_RETURN_FALSE;
5099 }
5100 break;
5101 case Py_LT:
5102 case Py_LE:
5103 case Py_GT:
5104 case Py_GE:
5105 Py_RETURN_NOTIMPLEMENTED;
5106 break;
5107 default:
5108 PyErr_BadArgument();
5109 return NULL;
5110 }
5111}
5112
5113static int
5114PySSLSession_traverse(PySSLSession *self, visitproc visit, void *arg)
5115{
5116 Py_VISIT(self->ctx);
5117 return 0;
5118}
5119
5120static int
5121PySSLSession_clear(PySSLSession *self)
5122{
5123 Py_CLEAR(self->ctx);
5124 return 0;
5125}
5126
5127
5128static PyObject *
5129PySSLSession_get_time(PySSLSession *self, void *closure) {
5130 return PyLong_FromLong(SSL_SESSION_get_time(self->session));
5131}
5132
5133PyDoc_STRVAR(PySSLSession_get_time_doc,
5134"Session creation time (seconds since epoch).");
5135
5136
5137static PyObject *
5138PySSLSession_get_timeout(PySSLSession *self, void *closure) {
5139 return PyLong_FromLong(SSL_SESSION_get_timeout(self->session));
5140}
5141
5142PyDoc_STRVAR(PySSLSession_get_timeout_doc,
5143"Session timeout (delta in seconds).");
5144
5145
5146static PyObject *
5147PySSLSession_get_ticket_lifetime_hint(PySSLSession *self, void *closure) {
5148 unsigned long hint = SSL_SESSION_get_ticket_lifetime_hint(self->session);
5149 return PyLong_FromUnsignedLong(hint);
5150}
5151
5152PyDoc_STRVAR(PySSLSession_get_ticket_lifetime_hint_doc,
5153"Ticket life time hint.");
5154
5155
5156static PyObject *
5157PySSLSession_get_session_id(PySSLSession *self, void *closure) {
5158 const unsigned char *id;
5159 unsigned int len;
5160 id = SSL_SESSION_get_id(self->session, &len);
5161 return PyBytes_FromStringAndSize((const char *)id, len);
5162}
5163
5164PyDoc_STRVAR(PySSLSession_get_session_id_doc,
5165"Session id");
5166
5167
5168static PyObject *
5169PySSLSession_get_has_ticket(PySSLSession *self, void *closure) {
5170 if (SSL_SESSION_has_ticket(self->session)) {
5171 Py_RETURN_TRUE;
5172 } else {
5173 Py_RETURN_FALSE;
5174 }
5175}
5176
5177PyDoc_STRVAR(PySSLSession_get_has_ticket_doc,
5178"Does the session contain a ticket?");
5179
5180
5181static PyGetSetDef PySSLSession_getsetlist[] = {
5182 {"has_ticket", (getter) PySSLSession_get_has_ticket, NULL,
5183 PySSLSession_get_has_ticket_doc},
5184 {"id", (getter) PySSLSession_get_session_id, NULL,
5185 PySSLSession_get_session_id_doc},
5186 {"ticket_lifetime_hint", (getter) PySSLSession_get_ticket_lifetime_hint,
5187 NULL, PySSLSession_get_ticket_lifetime_hint_doc},
5188 {"time", (getter) PySSLSession_get_time, NULL,
5189 PySSLSession_get_time_doc},
5190 {"timeout", (getter) PySSLSession_get_timeout, NULL,
5191 PySSLSession_get_timeout_doc},
5192 {NULL}, /* sentinel */
5193};
5194
Christian Heimes5c36da72020-11-20 09:40:12 +01005195static PyType_Slot PySSLSession_slots[] = {
5196 {Py_tp_getset,PySSLSession_getsetlist},
5197 {Py_tp_richcompare, PySSLSession_richcompare},
5198 {Py_tp_dealloc, PySSLSession_dealloc},
5199 {Py_tp_traverse, PySSLSession_traverse},
5200 {Py_tp_clear, PySSLSession_clear},
5201 {0, 0},
5202};
5203
5204static PyType_Spec PySSLSession_spec = {
5205 "_ssl.SSLSession",
5206 sizeof(PySSLSession),
5207 0,
5208 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
5209 PySSLSession_slots,
Christian Heimes99a65702016-09-10 23:44:53 +02005210};
5211
5212
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005213/* helper routines for seeding the SSL PRNG */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005214/*[clinic input]
5215_ssl.RAND_add
Larry Hastingsdbfdc382015-05-04 06:59:46 -07005216 string as view: Py_buffer(accept={str, buffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005217 entropy: double
5218 /
5219
5220Mix string into the OpenSSL PRNG state.
5221
5222entropy (a float) is a lower bound on the entropy contained in
Chandan Kumar63c2c8a2017-06-09 15:13:58 +05305223string. See RFC 4086.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005224[clinic start generated code]*/
5225
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005226static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005227_ssl_RAND_add_impl(PyObject *module, Py_buffer *view, double entropy)
Serhiy Storchaka5f31d5c2017-06-10 13:13:51 +03005228/*[clinic end generated code: output=e6dd48df9c9024e9 input=5c33017422828f5c]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005229{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005230 const char *buf;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005231 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005232
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005233 buf = (const char *)view->buf;
5234 len = view->len;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005235 do {
5236 written = Py_MIN(len, INT_MAX);
5237 RAND_add(buf, (int)written, entropy);
5238 buf += written;
5239 len -= written;
5240 } while (len);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02005241 Py_RETURN_NONE;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005242}
5243
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005244static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02005245PySSL_RAND(int len, int pseudo)
5246{
5247 int ok;
5248 PyObject *bytes;
5249 unsigned long err;
5250 const char *errstr;
5251 PyObject *v;
5252
Victor Stinner1e81a392013-12-19 16:47:04 +01005253 if (len < 0) {
5254 PyErr_SetString(PyExc_ValueError, "num must be positive");
5255 return NULL;
5256 }
5257
Victor Stinner99c8b162011-05-24 12:05:19 +02005258 bytes = PyBytes_FromStringAndSize(NULL, len);
5259 if (bytes == NULL)
5260 return NULL;
5261 if (pseudo) {
Christian Heimesa871f692020-06-01 08:58:14 +02005262#ifdef PY_OPENSSL_1_1_API
5263 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5264#else
Victor Stinner99c8b162011-05-24 12:05:19 +02005265 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
Christian Heimesa871f692020-06-01 08:58:14 +02005266#endif
Victor Stinner99c8b162011-05-24 12:05:19 +02005267 if (ok == 0 || ok == 1)
5268 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
5269 }
5270 else {
5271 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5272 if (ok == 1)
5273 return bytes;
5274 }
5275 Py_DECREF(bytes);
5276
5277 err = ERR_get_error();
5278 errstr = ERR_reason_error_string(err);
5279 v = Py_BuildValue("(ks)", err, errstr);
5280 if (v != NULL) {
5281 PyErr_SetObject(PySSLErrorObject, v);
5282 Py_DECREF(v);
5283 }
5284 return NULL;
5285}
5286
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005287/*[clinic input]
5288_ssl.RAND_bytes
5289 n: int
5290 /
5291
5292Generate n cryptographically strong pseudo-random bytes.
5293[clinic start generated code]*/
5294
Victor Stinner99c8b162011-05-24 12:05:19 +02005295static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005296_ssl_RAND_bytes_impl(PyObject *module, int n)
5297/*[clinic end generated code: output=977da635e4838bc7 input=678ddf2872dfebfc]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005298{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005299 return PySSL_RAND(n, 0);
Victor Stinner99c8b162011-05-24 12:05:19 +02005300}
5301
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005302/*[clinic input]
5303_ssl.RAND_pseudo_bytes
5304 n: int
5305 /
5306
5307Generate n pseudo-random bytes.
5308
5309Return a pair (bytes, is_cryptographic). is_cryptographic is True
5310if the bytes generated are cryptographically strong.
5311[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005312
5313static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005314_ssl_RAND_pseudo_bytes_impl(PyObject *module, int n)
5315/*[clinic end generated code: output=b1509e937000e52d input=58312bd53f9bbdd0]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005316{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005317 return PySSL_RAND(n, 1);
Victor Stinner99c8b162011-05-24 12:05:19 +02005318}
5319
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005320/*[clinic input]
5321_ssl.RAND_status
5322
5323Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.
5324
5325It is necessary to seed the PRNG with RAND_add() on some platforms before
5326using the ssl() function.
5327[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005328
5329static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005330_ssl_RAND_status_impl(PyObject *module)
5331/*[clinic end generated code: output=7e0aaa2d39fdc1ad input=8a774b02d1dc81f3]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005332{
Christian Heimes217cfd12007-12-02 14:31:20 +00005333 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005334}
5335
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005336#ifndef OPENSSL_NO_EGD
Christian Heimesa5d07652016-09-24 10:48:05 +02005337/* LCOV_EXCL_START */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005338/*[clinic input]
5339_ssl.RAND_egd
5340 path: object(converter="PyUnicode_FSConverter")
5341 /
5342
5343Queries the entropy gather daemon (EGD) on the socket named by 'path'.
5344
5345Returns number of bytes read. Raises SSLError if connection to EGD
5346fails or if it does not provide enough data to seed PRNG.
5347[clinic start generated code]*/
5348
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005349static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005350_ssl_RAND_egd_impl(PyObject *module, PyObject *path)
5351/*[clinic end generated code: output=02a67c7c367f52fa input=1aeb7eb948312195]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005352{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005353 int bytes = RAND_egd(PyBytes_AsString(path));
Victor Stinnerf9faaad2010-05-16 21:36:37 +00005354 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005355 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00005356 PyErr_SetString(PySSLErrorObject,
5357 "EGD connection failed or EGD did not return "
5358 "enough data to seed the PRNG");
5359 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005360 }
Christian Heimes217cfd12007-12-02 14:31:20 +00005361 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005362}
Christian Heimesa5d07652016-09-24 10:48:05 +02005363/* LCOV_EXCL_STOP */
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005364#endif /* OPENSSL_NO_EGD */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005365
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005366
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005367
5368/*[clinic input]
5369_ssl.get_default_verify_paths
5370
5371Return search paths and environment vars that are used by SSLContext's set_default_verify_paths() to load default CAs.
5372
5373The values are 'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.
5374[clinic start generated code]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005375
5376static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005377_ssl_get_default_verify_paths_impl(PyObject *module)
5378/*[clinic end generated code: output=e5b62a466271928b input=5210c953d98c3eb5]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005379{
5380 PyObject *ofile_env = NULL;
5381 PyObject *ofile = NULL;
5382 PyObject *odir_env = NULL;
5383 PyObject *odir = NULL;
5384
Benjamin Petersond113c962015-07-18 10:59:13 -07005385#define CONVERT(info, target) { \
Christian Heimes6d7ad132013-06-09 18:02:55 +02005386 const char *tmp = (info); \
5387 target = NULL; \
5388 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
5389 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
5390 target = PyBytes_FromString(tmp); } \
5391 if (!target) goto error; \
Benjamin Peterson025a1fd2015-11-14 15:12:38 -08005392 }
Christian Heimes6d7ad132013-06-09 18:02:55 +02005393
Benjamin Petersond113c962015-07-18 10:59:13 -07005394 CONVERT(X509_get_default_cert_file_env(), ofile_env);
5395 CONVERT(X509_get_default_cert_file(), ofile);
5396 CONVERT(X509_get_default_cert_dir_env(), odir_env);
5397 CONVERT(X509_get_default_cert_dir(), odir);
5398#undef CONVERT
Christian Heimes6d7ad132013-06-09 18:02:55 +02005399
Christian Heimes200bb1b2013-06-14 15:14:29 +02005400 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02005401
5402 error:
5403 Py_XDECREF(ofile_env);
5404 Py_XDECREF(ofile);
5405 Py_XDECREF(odir_env);
5406 Py_XDECREF(odir);
5407 return NULL;
5408}
5409
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005410static PyObject*
5411asn1obj2py(ASN1_OBJECT *obj)
5412{
5413 int nid;
5414 const char *ln, *sn;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005415
5416 nid = OBJ_obj2nid(obj);
5417 if (nid == NID_undef) {
5418 PyErr_Format(PyExc_ValueError, "Unknown object");
5419 return NULL;
5420 }
5421 sn = OBJ_nid2sn(nid);
5422 ln = OBJ_nid2ln(nid);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03005423 return Py_BuildValue("issN", nid, sn, ln, _asn1obj2py(obj, 1));
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005424}
5425
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005426/*[clinic input]
5427_ssl.txt2obj
5428 txt: str
5429 name: bool = False
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005430
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005431Lookup NID, short name, long name and OID of an ASN1_OBJECT.
5432
5433By default objects are looked up by OID. With name=True short and
5434long name are also matched.
5435[clinic start generated code]*/
5436
5437static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005438_ssl_txt2obj_impl(PyObject *module, const char *txt, int name)
5439/*[clinic end generated code: output=c38e3991347079c1 input=1c1e7d0aa7c48602]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005440{
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005441 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005442 ASN1_OBJECT *obj;
5443
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005444 obj = OBJ_txt2obj(txt, name ? 0 : 1);
5445 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005446 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005447 return NULL;
5448 }
5449 result = asn1obj2py(obj);
5450 ASN1_OBJECT_free(obj);
5451 return result;
5452}
5453
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005454/*[clinic input]
5455_ssl.nid2obj
5456 nid: int
5457 /
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005458
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005459Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.
5460[clinic start generated code]*/
5461
5462static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005463_ssl_nid2obj_impl(PyObject *module, int nid)
5464/*[clinic end generated code: output=4a98ab691cd4f84a input=51787a3bee7d8f98]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005465{
5466 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005467 ASN1_OBJECT *obj;
5468
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005469 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005470 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005471 return NULL;
5472 }
5473 obj = OBJ_nid2obj(nid);
5474 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005475 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005476 return NULL;
5477 }
5478 result = asn1obj2py(obj);
5479 ASN1_OBJECT_free(obj);
5480 return result;
5481}
5482
Christian Heimes46bebee2013-06-09 19:03:31 +02005483#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01005484
5485static PyObject*
5486certEncodingType(DWORD encodingType)
5487{
5488 static PyObject *x509_asn = NULL;
5489 static PyObject *pkcs_7_asn = NULL;
5490
5491 if (x509_asn == NULL) {
5492 x509_asn = PyUnicode_InternFromString("x509_asn");
5493 if (x509_asn == NULL)
5494 return NULL;
5495 }
5496 if (pkcs_7_asn == NULL) {
5497 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
5498 if (pkcs_7_asn == NULL)
5499 return NULL;
5500 }
5501 switch(encodingType) {
5502 case X509_ASN_ENCODING:
5503 Py_INCREF(x509_asn);
5504 return x509_asn;
5505 case PKCS_7_ASN_ENCODING:
5506 Py_INCREF(pkcs_7_asn);
5507 return pkcs_7_asn;
5508 default:
5509 return PyLong_FromLong(encodingType);
5510 }
5511}
5512
5513static PyObject*
5514parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
5515{
5516 CERT_ENHKEY_USAGE *usage;
5517 DWORD size, error, i;
5518 PyObject *retval;
5519
5520 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
5521 error = GetLastError();
5522 if (error == CRYPT_E_NOT_FOUND) {
5523 Py_RETURN_TRUE;
5524 }
5525 return PyErr_SetFromWindowsErr(error);
5526 }
5527
5528 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
5529 if (usage == NULL) {
5530 return PyErr_NoMemory();
5531 }
5532
5533 /* Now get the actual enhanced usage property */
5534 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
5535 PyMem_Free(usage);
5536 error = GetLastError();
5537 if (error == CRYPT_E_NOT_FOUND) {
5538 Py_RETURN_TRUE;
5539 }
5540 return PyErr_SetFromWindowsErr(error);
5541 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005542 retval = PyFrozenSet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005543 if (retval == NULL) {
5544 goto error;
5545 }
5546 for (i = 0; i < usage->cUsageIdentifier; ++i) {
5547 if (usage->rgpszUsageIdentifier[i]) {
5548 PyObject *oid;
5549 int err;
5550 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
5551 if (oid == NULL) {
5552 Py_CLEAR(retval);
5553 goto error;
5554 }
5555 err = PySet_Add(retval, oid);
5556 Py_DECREF(oid);
5557 if (err == -1) {
5558 Py_CLEAR(retval);
5559 goto error;
5560 }
5561 }
5562 }
5563 error:
5564 PyMem_Free(usage);
5565 return retval;
5566}
5567
kctherookied93fbbf2019-03-29 00:59:06 +07005568static HCERTSTORE
5569ssl_collect_certificates(const char *store_name)
5570{
5571/* this function collects the system certificate stores listed in
5572 * system_stores into a collection certificate store for being
5573 * enumerated. The store must be readable to be added to the
5574 * store collection.
5575 */
5576
5577 HCERTSTORE hCollectionStore = NULL, hSystemStore = NULL;
5578 static DWORD system_stores[] = {
5579 CERT_SYSTEM_STORE_LOCAL_MACHINE,
5580 CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE,
5581 CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY,
5582 CERT_SYSTEM_STORE_CURRENT_USER,
5583 CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY,
5584 CERT_SYSTEM_STORE_SERVICES,
5585 CERT_SYSTEM_STORE_USERS};
5586 size_t i, storesAdded;
5587 BOOL result;
5588
5589 hCollectionStore = CertOpenStore(CERT_STORE_PROV_COLLECTION, 0,
5590 (HCRYPTPROV)NULL, 0, NULL);
5591 if (!hCollectionStore) {
5592 return NULL;
5593 }
5594 storesAdded = 0;
5595 for (i = 0; i < sizeof(system_stores) / sizeof(DWORD); i++) {
5596 hSystemStore = CertOpenStore(CERT_STORE_PROV_SYSTEM_A, 0,
5597 (HCRYPTPROV)NULL,
5598 CERT_STORE_READONLY_FLAG |
5599 system_stores[i], store_name);
5600 if (hSystemStore) {
5601 result = CertAddStoreToCollection(hCollectionStore, hSystemStore,
5602 CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG, 0);
5603 if (result) {
5604 ++storesAdded;
5605 }
neoneneed701292019-09-09 21:33:43 +09005606 CertCloseStore(hSystemStore, 0); /* flag must be 0 */
kctherookied93fbbf2019-03-29 00:59:06 +07005607 }
5608 }
5609 if (storesAdded == 0) {
5610 CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG);
5611 return NULL;
5612 }
5613
5614 return hCollectionStore;
5615}
5616
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005617/*[clinic input]
5618_ssl.enum_certificates
5619 store_name: str
5620
5621Retrieve certificates from Windows' cert store.
5622
5623store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5624more cert storages, too. The function returns a list of (bytes,
5625encoding_type, trust) tuples. The encoding_type flag can be interpreted
5626with X509_ASN_ENCODING or PKCS_7_ASN_ENCODING. The trust setting is either
5627a set of OIDs or the boolean True.
5628[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00005629
Christian Heimes46bebee2013-06-09 19:03:31 +02005630static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005631_ssl_enum_certificates_impl(PyObject *module, const char *store_name)
5632/*[clinic end generated code: output=5134dc8bb3a3c893 input=915f60d70461ea4e]*/
Christian Heimes46bebee2013-06-09 19:03:31 +02005633{
kctherookied93fbbf2019-03-29 00:59:06 +07005634 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005635 PCCERT_CONTEXT pCertCtx = NULL;
5636 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005637 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005638
Christian Heimes915cd3f2019-09-09 18:06:55 +02005639 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005640 if (result == NULL) {
5641 return NULL;
5642 }
kctherookied93fbbf2019-03-29 00:59:06 +07005643 hCollectionStore = ssl_collect_certificates(store_name);
5644 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005645 Py_DECREF(result);
5646 return PyErr_SetFromWindowsErr(GetLastError());
5647 }
5648
kctherookied93fbbf2019-03-29 00:59:06 +07005649 while (pCertCtx = CertEnumCertificatesInStore(hCollectionStore, pCertCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005650 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
5651 pCertCtx->cbCertEncoded);
5652 if (!cert) {
5653 Py_CLEAR(result);
5654 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005655 }
Christian Heimes44109d72013-11-22 01:51:30 +01005656 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
5657 Py_CLEAR(result);
5658 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005659 }
Christian Heimes44109d72013-11-22 01:51:30 +01005660 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
5661 if (keyusage == Py_True) {
5662 Py_DECREF(keyusage);
5663 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02005664 }
Christian Heimes44109d72013-11-22 01:51:30 +01005665 if (keyusage == NULL) {
5666 Py_CLEAR(result);
5667 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005668 }
Christian Heimes44109d72013-11-22 01:51:30 +01005669 if ((tup = PyTuple_New(3)) == NULL) {
5670 Py_CLEAR(result);
5671 break;
5672 }
5673 PyTuple_SET_ITEM(tup, 0, cert);
5674 cert = NULL;
5675 PyTuple_SET_ITEM(tup, 1, enc);
5676 enc = NULL;
5677 PyTuple_SET_ITEM(tup, 2, keyusage);
5678 keyusage = NULL;
Christian Heimes915cd3f2019-09-09 18:06:55 +02005679 if (PySet_Add(result, tup) == -1) {
5680 Py_CLEAR(result);
5681 Py_CLEAR(tup);
5682 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005683 }
5684 Py_CLEAR(tup);
5685 }
5686 if (pCertCtx) {
5687 /* loop ended with an error, need to clean up context manually */
5688 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02005689 }
5690
5691 /* In error cases cert, enc and tup may not be NULL */
5692 Py_XDECREF(cert);
5693 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01005694 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02005695 Py_XDECREF(tup);
5696
kctherookied93fbbf2019-03-29 00:59:06 +07005697 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5698 associated with the store, in this case our collection store and the
5699 associated system stores. */
5700 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005701 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01005702 Py_XDECREF(result);
5703 return PyErr_SetFromWindowsErr(GetLastError());
5704 }
kctherookied93fbbf2019-03-29 00:59:06 +07005705
Christian Heimes915cd3f2019-09-09 18:06:55 +02005706 /* convert set to list */
5707 if (result == NULL) {
5708 return NULL;
5709 } else {
5710 PyObject *lst = PySequence_List(result);
5711 Py_DECREF(result);
5712 return lst;
5713 }
Christian Heimes44109d72013-11-22 01:51:30 +01005714}
5715
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005716/*[clinic input]
5717_ssl.enum_crls
5718 store_name: str
5719
5720Retrieve CRLs from Windows' cert store.
5721
5722store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5723more cert storages, too. The function returns a list of (bytes,
5724encoding_type) tuples. The encoding_type flag can be interpreted with
5725X509_ASN_ENCODING or PKCS_7_ASN_ENCODING.
5726[clinic start generated code]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005727
5728static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005729_ssl_enum_crls_impl(PyObject *module, const char *store_name)
5730/*[clinic end generated code: output=bce467f60ccd03b6 input=a1f1d7629f1c5d3d]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005731{
kctherookied93fbbf2019-03-29 00:59:06 +07005732 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005733 PCCRL_CONTEXT pCrlCtx = NULL;
5734 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
5735 PyObject *result = NULL;
5736
Christian Heimes915cd3f2019-09-09 18:06:55 +02005737 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005738 if (result == NULL) {
5739 return NULL;
5740 }
kctherookied93fbbf2019-03-29 00:59:06 +07005741 hCollectionStore = ssl_collect_certificates(store_name);
5742 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005743 Py_DECREF(result);
5744 return PyErr_SetFromWindowsErr(GetLastError());
5745 }
Christian Heimes44109d72013-11-22 01:51:30 +01005746
kctherookied93fbbf2019-03-29 00:59:06 +07005747 while (pCrlCtx = CertEnumCRLsInStore(hCollectionStore, pCrlCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005748 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
5749 pCrlCtx->cbCrlEncoded);
5750 if (!crl) {
5751 Py_CLEAR(result);
5752 break;
5753 }
5754 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
5755 Py_CLEAR(result);
5756 break;
5757 }
5758 if ((tup = PyTuple_New(2)) == NULL) {
5759 Py_CLEAR(result);
5760 break;
5761 }
5762 PyTuple_SET_ITEM(tup, 0, crl);
5763 crl = NULL;
5764 PyTuple_SET_ITEM(tup, 1, enc);
5765 enc = NULL;
5766
Christian Heimes915cd3f2019-09-09 18:06:55 +02005767 if (PySet_Add(result, tup) == -1) {
5768 Py_CLEAR(result);
5769 Py_CLEAR(tup);
5770 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005771 }
5772 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02005773 }
Christian Heimes44109d72013-11-22 01:51:30 +01005774 if (pCrlCtx) {
5775 /* loop ended with an error, need to clean up context manually */
5776 CertFreeCRLContext(pCrlCtx);
5777 }
5778
5779 /* In error cases cert, enc and tup may not be NULL */
5780 Py_XDECREF(crl);
5781 Py_XDECREF(enc);
5782 Py_XDECREF(tup);
5783
kctherookied93fbbf2019-03-29 00:59:06 +07005784 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5785 associated with the store, in this case our collection store and the
5786 associated system stores. */
5787 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005788 /* This error case might shadow another exception.*/
5789 Py_XDECREF(result);
5790 return PyErr_SetFromWindowsErr(GetLastError());
5791 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005792 /* convert set to list */
5793 if (result == NULL) {
5794 return NULL;
5795 } else {
5796 PyObject *lst = PySequence_List(result);
5797 Py_DECREF(result);
5798 return lst;
5799 }
Christian Heimes46bebee2013-06-09 19:03:31 +02005800}
Christian Heimes44109d72013-11-22 01:51:30 +01005801
5802#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00005803
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005804/* List of functions exported by this module. */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005805static PyMethodDef PySSL_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005806 _SSL__TEST_DECODE_CERT_METHODDEF
5807 _SSL_RAND_ADD_METHODDEF
5808 _SSL_RAND_BYTES_METHODDEF
5809 _SSL_RAND_PSEUDO_BYTES_METHODDEF
5810 _SSL_RAND_EGD_METHODDEF
5811 _SSL_RAND_STATUS_METHODDEF
5812 _SSL_GET_DEFAULT_VERIFY_PATHS_METHODDEF
5813 _SSL_ENUM_CERTIFICATES_METHODDEF
5814 _SSL_ENUM_CRLS_METHODDEF
5815 _SSL_TXT2OBJ_METHODDEF
5816 _SSL_NID2OBJ_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005817 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005818};
5819
5820
Christian Heimes598894f2016-09-05 23:19:05 +02005821#ifdef HAVE_OPENSSL_CRYPTO_LOCK
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005822
5823/* an implementation of OpenSSL threading operations in terms
Christian Heimes598894f2016-09-05 23:19:05 +02005824 * of the Python C thread library
5825 * Only used up to 1.0.2. OpenSSL 1.1.0+ has its own locking code.
5826 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005827
5828static PyThread_type_lock *_ssl_locks = NULL;
5829
Christian Heimes4d98ca92013-08-19 17:36:29 +02005830#if OPENSSL_VERSION_NUMBER >= 0x10000000
5831/* use new CRYPTO_THREADID API. */
5832static void
5833_ssl_threadid_callback(CRYPTO_THREADID *id)
5834{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +02005835 CRYPTO_THREADID_set_numeric(id, PyThread_get_thread_ident());
Christian Heimes4d98ca92013-08-19 17:36:29 +02005836}
5837#else
5838/* deprecated CRYPTO_set_id_callback() API. */
5839static unsigned long
5840_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005841 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005842}
Christian Heimes4d98ca92013-08-19 17:36:29 +02005843#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005844
Bill Janssen6e027db2007-11-15 22:23:56 +00005845static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005846 (int mode, int n, const char *file, int line) {
5847 /* this function is needed to perform locking on shared data
5848 structures. (Note that OpenSSL uses a number of global data
5849 structures that will be implicitly shared whenever multiple
5850 threads use OpenSSL.) Multi-threaded applications will
5851 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005852
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005853 locking_function() must be able to handle up to
5854 CRYPTO_num_locks() different mutex locks. It sets the n-th
5855 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005856
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005857 file and line are the file number of the function setting the
5858 lock. They can be useful for debugging.
5859 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005860
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005861 if ((_ssl_locks == NULL) ||
5862 (n < 0) || ((unsigned)n >= _ssl_locks_count))
5863 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005864
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005865 if (mode & CRYPTO_LOCK) {
5866 PyThread_acquire_lock(_ssl_locks[n], 1);
5867 } else {
5868 PyThread_release_lock(_ssl_locks[n]);
5869 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005870}
5871
5872static int _setup_ssl_threads(void) {
5873
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005874 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005875
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005876 if (_ssl_locks == NULL) {
5877 _ssl_locks_count = CRYPTO_num_locks();
Christian Heimesf6365e32016-09-13 20:48:13 +02005878 _ssl_locks = PyMem_Calloc(_ssl_locks_count,
5879 sizeof(PyThread_type_lock));
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005880 if (_ssl_locks == NULL) {
5881 PyErr_NoMemory();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005882 return 0;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005883 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005884 for (i = 0; i < _ssl_locks_count; i++) {
5885 _ssl_locks[i] = PyThread_allocate_lock();
5886 if (_ssl_locks[i] == NULL) {
5887 unsigned int j;
5888 for (j = 0; j < i; j++) {
5889 PyThread_free_lock(_ssl_locks[j]);
5890 }
Victor Stinnerb6404912013-07-07 16:21:41 +02005891 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005892 return 0;
5893 }
5894 }
5895 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005896#if OPENSSL_VERSION_NUMBER >= 0x10000000
5897 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
5898#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005899 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005900#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005901 }
5902 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005903}
5904
Antoine Pitroua6a4dc82017-09-07 18:56:24 +02005905#endif /* HAVE_OPENSSL_CRYPTO_LOCK for OpenSSL < 1.1.0 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005906
Christian Heimes5c36da72020-11-20 09:40:12 +01005907static int
5908sslmodule_init_types(PyObject *module)
5909{
5910 PySSLContext_Type = (PyTypeObject *)PyType_FromModuleAndSpec(
5911 module, &PySSLContext_spec, NULL
5912 );
5913 if (PySSLContext_Type == NULL)
5914 return -1;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005915
Christian Heimes5c36da72020-11-20 09:40:12 +01005916 PySSLSocket_Type = (PyTypeObject *)PyType_FromModuleAndSpec(
5917 module, &PySSLSocket_spec, NULL
5918 );
5919 if (PySSLSocket_Type == NULL)
5920 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00005921
Christian Heimes5c36da72020-11-20 09:40:12 +01005922 PySSLMemoryBIO_Type = (PyTypeObject *)PyType_FromModuleAndSpec(
5923 module, &PySSLMemoryBIO_spec, NULL
5924 );
5925 if (PySSLMemoryBIO_Type == NULL)
5926 return -1;
Martin v. Löwis1a214512008-06-11 05:26:20 +00005927
Christian Heimes5c36da72020-11-20 09:40:12 +01005928 PySSLSession_Type = (PyTypeObject *)PyType_FromModuleAndSpec(
5929 module, &PySSLSession_spec, NULL
5930 );
5931 if (PySSLSession_Type == NULL)
5932 return -1;
5933
5934 if (PyModule_AddType(module, PySSLContext_Type))
5935 return -1;
5936 if (PyModule_AddType(module, PySSLSocket_Type))
5937 return -1;
5938 if (PyModule_AddType(module, PySSLMemoryBIO_Type))
5939 return -1;
5940 if (PyModule_AddType(module, PySSLSession_Type))
5941 return -1;
5942
5943 return 0;
5944}
5945
5946static int
5947sslmodule_init_exceptions(PyObject *module)
5948{
5949 PyObject *bases = NULL;
5950
5951#define add_exception(exc, name, doc, base) \
5952do { \
5953 (exc) = PyErr_NewExceptionWithDoc("ssl." name, (doc), (base), NULL); \
5954 if ((exc) == NULL) goto error; \
5955 if (PyModule_AddObjectRef(module, name, exc) < 0) goto error; \
5956} while(0)
5957
Serhiy Storchaka686c2032020-11-22 13:25:02 +02005958 PySSLErrorObject = PyType_FromSpecWithBases(&sslerror_type_spec, PyExc_OSError);
Christian Heimes5c36da72020-11-20 09:40:12 +01005959 if (PySSLErrorObject == NULL) {
5960 goto error;
5961 }
5962 if (PyModule_AddObjectRef(module, "SSLError", PySSLErrorObject) < 0) {
5963 goto error;
5964 }
5965
5966 /* ssl.CertificateError used to be a subclass of ValueError */
5967 bases = PyTuple_Pack(2, PySSLErrorObject, PyExc_ValueError);
5968 if (bases == NULL) {
5969 goto error;
5970 }
5971 add_exception(
5972 PySSLCertVerificationErrorObject,
5973 "SSLCertVerificationError",
5974 SSLCertVerificationError_doc,
5975 bases
5976 );
5977 Py_CLEAR(bases);
5978
5979 add_exception(
5980 PySSLZeroReturnErrorObject,
5981 "SSLZeroReturnError",
5982 SSLZeroReturnError_doc,
5983 PySSLErrorObject
5984 );
5985
5986 add_exception(
5987 PySSLWantWriteErrorObject,
5988 "SSLWantWriteError",
5989 SSLWantWriteError_doc,
5990 PySSLErrorObject
5991 );
5992
5993 add_exception(
5994 PySSLWantReadErrorObject,
5995 "SSLWantReadError",
5996 SSLWantReadError_doc,
5997 PySSLErrorObject
5998 );
5999
6000 add_exception(
6001 PySSLSyscallErrorObject,
6002 "SSLSyscallError",
6003 SSLSyscallError_doc,
6004 PySSLErrorObject
6005 );
6006
6007 add_exception(
6008 PySSLEOFErrorObject,
6009 "SSLEOFError",
6010 SSLEOFError_doc,
6011 PySSLErrorObject
6012 );
6013#undef add_exception
6014
6015 return 0;
6016 error:
6017 Py_XDECREF(bases);
6018 return -1;
6019}
6020
6021static int
6022sslmodule_init_socketapi(PyObject *module)
6023{
6024 PySocketModule_APIObject *socket_api;
6025
6026 /* Load _socket module and its C API */
6027 socket_api = PySocketModule_ImportModuleAndAPI();
6028 if (socket_api == NULL)
6029 return -1;
6030 PySocketModule = *socket_api;
6031
6032 return 0;
6033}
6034
6035static int
6036sslmodule_init_errorcodes(PyObject *module)
6037{
6038 struct py_ssl_error_code *errcode;
6039 struct py_ssl_library_code *libcode;
6040
6041 /* Mappings for error codes */
6042 err_codes_to_names = PyDict_New();
6043 if (err_codes_to_names == NULL)
6044 return -1;
6045 err_names_to_codes = PyDict_New();
6046 if (err_names_to_codes == NULL)
6047 return -1;
6048 lib_codes_to_names = PyDict_New();
6049 if (lib_codes_to_names == NULL)
6050 return -1;
6051
6052 errcode = error_codes;
6053 while (errcode->mnemonic != NULL) {
6054 PyObject *mnemo, *key;
6055 mnemo = PyUnicode_FromString(errcode->mnemonic);
6056 key = Py_BuildValue("ii", errcode->library, errcode->reason);
6057 if (mnemo == NULL || key == NULL)
6058 return -1;
6059 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
6060 return -1;
6061 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
6062 return -1;
6063 Py_DECREF(key);
6064 Py_DECREF(mnemo);
6065 errcode++;
6066 }
6067
6068 libcode = library_codes;
6069 while (libcode->library != NULL) {
6070 PyObject *mnemo, *key;
6071 key = PyLong_FromLong(libcode->code);
6072 mnemo = PyUnicode_FromString(libcode->library);
6073 if (key == NULL || mnemo == NULL)
6074 return -1;
6075 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
6076 return -1;
6077 Py_DECREF(key);
6078 Py_DECREF(mnemo);
6079 libcode++;
6080 }
6081
6082 if (PyModule_AddObject(module, "err_codes_to_names", err_codes_to_names))
6083 return -1;
6084 if (PyModule_AddObject(module, "err_names_to_codes", err_names_to_codes))
6085 return -1;
6086 if (PyModule_AddObject(module, "lib_codes_to_names", lib_codes_to_names))
6087 return -1;
6088
6089 return 0;
6090}
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006091
6092static void
6093parse_openssl_version(unsigned long libver,
6094 unsigned int *major, unsigned int *minor,
6095 unsigned int *fix, unsigned int *patch,
6096 unsigned int *status)
6097{
6098 *status = libver & 0xF;
6099 libver >>= 4;
6100 *patch = libver & 0xFF;
6101 libver >>= 8;
6102 *fix = libver & 0xFF;
6103 libver >>= 8;
6104 *minor = libver & 0xFF;
6105 libver >>= 8;
6106 *major = libver & 0xFF;
6107}
6108
Christian Heimes5c36da72020-11-20 09:40:12 +01006109static int
6110sslmodule_init_versioninfo(PyObject *m)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006111{
Christian Heimes5c36da72020-11-20 09:40:12 +01006112 PyObject *r;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006113 unsigned long libver;
6114 unsigned int major, minor, fix, patch, status;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006115
Christian Heimes5c36da72020-11-20 09:40:12 +01006116 /* OpenSSL version */
6117 /* SSLeay() gives us the version of the library linked against,
6118 which could be different from the headers version.
6119 */
6120 libver = OpenSSL_version_num();
6121 r = PyLong_FromUnsignedLong(libver);
6122 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
6123 return -1;
Christian Heimes99a65702016-09-10 23:44:53 +02006124
Christian Heimes5c36da72020-11-20 09:40:12 +01006125 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
6126 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6127 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
6128 return -1;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006129
Christian Heimes5c36da72020-11-20 09:40:12 +01006130 r = PyUnicode_FromString(OpenSSL_version(OPENSSL_VERSION));
6131 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
6132 return -1;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006133
Christian Heimes5c36da72020-11-20 09:40:12 +01006134 libver = OPENSSL_VERSION_NUMBER;
6135 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
6136 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6137 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
6138 return -1;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006139
Christian Heimes5c36da72020-11-20 09:40:12 +01006140 return 0;
6141}
Christian Heimesc941e622017-09-05 15:47:11 +02006142
Christian Heimes5c36da72020-11-20 09:40:12 +01006143static int
6144sslmodule_init_constants(PyObject *m)
6145{
Christian Heimes892d66e2018-01-29 14:10:18 +01006146 PyModule_AddStringConstant(m, "_DEFAULT_CIPHERS",
6147 PY_SSL_DEFAULT_CIPHER_STRING);
6148
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006149 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
6150 PY_SSL_ERROR_ZERO_RETURN);
6151 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
6152 PY_SSL_ERROR_WANT_READ);
6153 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
6154 PY_SSL_ERROR_WANT_WRITE);
6155 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
6156 PY_SSL_ERROR_WANT_X509_LOOKUP);
6157 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
6158 PY_SSL_ERROR_SYSCALL);
6159 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
6160 PY_SSL_ERROR_SSL);
6161 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
6162 PY_SSL_ERROR_WANT_CONNECT);
6163 /* non ssl.h errorcodes */
6164 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
6165 PY_SSL_ERROR_EOF);
6166 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
6167 PY_SSL_ERROR_INVALID_ERROR_CODE);
6168 /* cert requirements */
6169 PyModule_AddIntConstant(m, "CERT_NONE",
6170 PY_SSL_CERT_NONE);
6171 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
6172 PY_SSL_CERT_OPTIONAL);
6173 PyModule_AddIntConstant(m, "CERT_REQUIRED",
6174 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01006175 /* CRL verification for verification_flags */
6176 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
6177 0);
6178 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
6179 X509_V_FLAG_CRL_CHECK);
6180 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
6181 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
6182 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
6183 X509_V_FLAG_X509_STRICT);
Benjamin Peterson990fcaa2015-03-04 22:49:41 -05006184#ifdef X509_V_FLAG_TRUSTED_FIRST
6185 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
6186 X509_V_FLAG_TRUSTED_FIRST);
6187#endif
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00006188
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006189 /* Alert Descriptions from ssl.h */
6190 /* note RESERVED constants no longer intended for use have been removed */
6191 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
6192
6193#define ADD_AD_CONSTANT(s) \
6194 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
6195 SSL_AD_##s)
6196
6197 ADD_AD_CONSTANT(CLOSE_NOTIFY);
6198 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
6199 ADD_AD_CONSTANT(BAD_RECORD_MAC);
6200 ADD_AD_CONSTANT(RECORD_OVERFLOW);
6201 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
6202 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
6203 ADD_AD_CONSTANT(BAD_CERTIFICATE);
6204 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
6205 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
6206 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
6207 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
6208 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
6209 ADD_AD_CONSTANT(UNKNOWN_CA);
6210 ADD_AD_CONSTANT(ACCESS_DENIED);
6211 ADD_AD_CONSTANT(DECODE_ERROR);
6212 ADD_AD_CONSTANT(DECRYPT_ERROR);
6213 ADD_AD_CONSTANT(PROTOCOL_VERSION);
6214 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
6215 ADD_AD_CONSTANT(INTERNAL_ERROR);
6216 ADD_AD_CONSTANT(USER_CANCELLED);
6217 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006218 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01006219#ifdef SSL_AD_UNSUPPORTED_EXTENSION
6220 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
6221#endif
6222#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
6223 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
6224#endif
6225#ifdef SSL_AD_UNRECOGNIZED_NAME
6226 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
6227#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006228#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
6229 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
6230#endif
6231#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
6232 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
6233#endif
6234#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
6235 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
6236#endif
6237
6238#undef ADD_AD_CONSTANT
6239
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006240 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02006241#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006242 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
6243 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02006244#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05006245#ifndef OPENSSL_NO_SSL3
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006246 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
6247 PY_SSL_VERSION_SSL3);
Benjamin Petersone32467c2014-12-05 21:59:35 -05006248#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006249 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
Christian Heimes598894f2016-09-05 23:19:05 +02006250 PY_SSL_VERSION_TLS);
6251 PyModule_AddIntConstant(m, "PROTOCOL_TLS",
6252 PY_SSL_VERSION_TLS);
Christian Heimes5fe668c2016-09-12 00:01:11 +02006253 PyModule_AddIntConstant(m, "PROTOCOL_TLS_CLIENT",
6254 PY_SSL_VERSION_TLS_CLIENT);
6255 PyModule_AddIntConstant(m, "PROTOCOL_TLS_SERVER",
6256 PY_SSL_VERSION_TLS_SERVER);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006257 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
6258 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006259 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
6260 PY_SSL_VERSION_TLS1_1);
6261 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
6262 PY_SSL_VERSION_TLS1_2);
Antoine Pitrou04f6a322010-04-05 21:40:07 +00006263
Antoine Pitroub5218772010-05-21 09:56:06 +00006264 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01006265 PyModule_AddIntConstant(m, "OP_ALL",
6266 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00006267 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
6268 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
6269 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006270 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
6271 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006272#ifdef SSL_OP_NO_TLSv1_3
6273 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", SSL_OP_NO_TLSv1_3);
6274#else
6275 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", 0);
6276#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01006277 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
6278 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01006279 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Christian Heimes99a65702016-09-10 23:44:53 +02006280 PyModule_AddIntConstant(m, "OP_NO_TICKET", SSL_OP_NO_TICKET);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006281#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01006282 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006283#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01006284#ifdef SSL_OP_NO_COMPRESSION
6285 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
6286 SSL_OP_NO_COMPRESSION);
6287#endif
Christian Heimes05d9fe32018-02-27 08:55:39 +01006288#ifdef SSL_OP_ENABLE_MIDDLEBOX_COMPAT
6289 PyModule_AddIntConstant(m, "OP_ENABLE_MIDDLEBOX_COMPAT",
6290 SSL_OP_ENABLE_MIDDLEBOX_COMPAT);
6291#endif
Christian Heimes67c48012018-05-15 16:25:40 -04006292#ifdef SSL_OP_NO_RENEGOTIATION
6293 PyModule_AddIntConstant(m, "OP_NO_RENEGOTIATION",
6294 SSL_OP_NO_RENEGOTIATION);
6295#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00006296
Christian Heimes61d478c2018-01-27 15:51:38 +01006297#ifdef X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT
6298 PyModule_AddIntConstant(m, "HOSTFLAG_ALWAYS_CHECK_SUBJECT",
6299 X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT);
6300#endif
6301#ifdef X509_CHECK_FLAG_NEVER_CHECK_SUBJECT
6302 PyModule_AddIntConstant(m, "HOSTFLAG_NEVER_CHECK_SUBJECT",
6303 X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
6304#endif
6305#ifdef X509_CHECK_FLAG_NO_WILDCARDS
6306 PyModule_AddIntConstant(m, "HOSTFLAG_NO_WILDCARDS",
6307 X509_CHECK_FLAG_NO_WILDCARDS);
6308#endif
6309#ifdef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
6310 PyModule_AddIntConstant(m, "HOSTFLAG_NO_PARTIAL_WILDCARDS",
6311 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
6312#endif
6313#ifdef X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS
6314 PyModule_AddIntConstant(m, "HOSTFLAG_MULTI_LABEL_WILDCARDS",
6315 X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS);
6316#endif
6317#ifdef X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS
6318 PyModule_AddIntConstant(m, "HOSTFLAG_SINGLE_LABEL_SUBDOMAINS",
6319 X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS);
6320#endif
6321
Christian Heimes698dde12018-02-27 11:54:43 +01006322 /* protocol versions */
6323 PyModule_AddIntConstant(m, "PROTO_MINIMUM_SUPPORTED",
6324 PY_PROTO_MINIMUM_SUPPORTED);
6325 PyModule_AddIntConstant(m, "PROTO_MAXIMUM_SUPPORTED",
6326 PY_PROTO_MAXIMUM_SUPPORTED);
6327 PyModule_AddIntConstant(m, "PROTO_SSLv3", PY_PROTO_SSLv3);
6328 PyModule_AddIntConstant(m, "PROTO_TLSv1", PY_PROTO_TLSv1);
6329 PyModule_AddIntConstant(m, "PROTO_TLSv1_1", PY_PROTO_TLSv1_1);
6330 PyModule_AddIntConstant(m, "PROTO_TLSv1_2", PY_PROTO_TLSv1_2);
6331 PyModule_AddIntConstant(m, "PROTO_TLSv1_3", PY_PROTO_TLSv1_3);
Antoine Pitroud5323212010-10-22 18:19:07 +00006332
Victor Stinnerb37672d2018-11-22 03:37:50 +01006333#define addbool(m, key, value) \
6334 do { \
6335 PyObject *bool_obj = (value) ? Py_True : Py_False; \
6336 Py_INCREF(bool_obj); \
6337 PyModule_AddObject((m), (key), bool_obj); \
6338 } while (0)
Christian Heimes698dde12018-02-27 11:54:43 +01006339
6340#if HAVE_SNI
6341 addbool(m, "HAS_SNI", 1);
Antoine Pitrou501da612011-12-21 09:27:41 +01006342#else
Christian Heimes698dde12018-02-27 11:54:43 +01006343 addbool(m, "HAS_SNI", 0);
Antoine Pitrou501da612011-12-21 09:27:41 +01006344#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006345
6346 addbool(m, "HAS_TLS_UNIQUE", 1);
6347
6348#ifndef OPENSSL_NO_ECDH
6349 addbool(m, "HAS_ECDH", 1);
6350#else
6351 addbool(m, "HAS_ECDH", 0);
6352#endif
Antoine Pitrou501da612011-12-21 09:27:41 +01006353
Christian Heimes29eab552018-02-25 12:31:33 +01006354#if HAVE_NPN
Christian Heimes698dde12018-02-27 11:54:43 +01006355 addbool(m, "HAS_NPN", 1);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006356#else
Christian Heimes698dde12018-02-27 11:54:43 +01006357 addbool(m, "HAS_NPN", 0);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006358#endif
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006359
Christian Heimes29eab552018-02-25 12:31:33 +01006360#if HAVE_ALPN
Christian Heimes698dde12018-02-27 11:54:43 +01006361 addbool(m, "HAS_ALPN", 1);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006362#else
Christian Heimes698dde12018-02-27 11:54:43 +01006363 addbool(m, "HAS_ALPN", 0);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006364#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006365
6366#if defined(SSL2_VERSION) && !defined(OPENSSL_NO_SSL2)
6367 addbool(m, "HAS_SSLv2", 1);
6368#else
6369 addbool(m, "HAS_SSLv2", 0);
6370#endif
6371
6372#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
6373 addbool(m, "HAS_SSLv3", 1);
6374#else
6375 addbool(m, "HAS_SSLv3", 0);
6376#endif
6377
6378#if defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
6379 addbool(m, "HAS_TLSv1", 1);
6380#else
6381 addbool(m, "HAS_TLSv1", 0);
6382#endif
6383
6384#if defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
6385 addbool(m, "HAS_TLSv1_1", 1);
6386#else
6387 addbool(m, "HAS_TLSv1_1", 0);
6388#endif
6389
6390#if defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
6391 addbool(m, "HAS_TLSv1_2", 1);
6392#else
6393 addbool(m, "HAS_TLSv1_2", 0);
6394#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05006395
Christian Heimescb5b68a2017-09-07 18:07:00 -07006396#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
Christian Heimes698dde12018-02-27 11:54:43 +01006397 addbool(m, "HAS_TLSv1_3", 1);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006398#else
Christian Heimes698dde12018-02-27 11:54:43 +01006399 addbool(m, "HAS_TLSv1_3", 0);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006400#endif
Christian Heimescb5b68a2017-09-07 18:07:00 -07006401
Christian Heimes5c36da72020-11-20 09:40:12 +01006402 return 0;
6403}
6404
6405static int
6406sslmodule_legacy(PyObject *module)
6407{
6408#ifndef OPENSSL_VERSION_1_1
6409 /* Load all algorithms and initialize cpuid */
6410 OPENSSL_add_all_algorithms_noconf();
6411 /* Init OpenSSL */
6412 SSL_load_error_strings();
6413 SSL_library_init();
6414#endif
6415
6416#ifdef HAVE_OPENSSL_CRYPTO_LOCK
6417 /* note that this will start threading if not already started */
6418 if (!_setup_ssl_threads()) {
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006419 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006420 }
Christian Heimes5c36da72020-11-20 09:40:12 +01006421#elif OPENSSL_VERSION_1_1
6422 /* OpenSSL 1.1.0 builtin thread support is enabled */
6423 _ssl_locks_count++;
6424#endif
6425 return 0;
6426}
6427
6428PyDoc_STRVAR(module_doc,
6429"Implementation module for SSL socket operations. See the socket module\n\
6430for documentation.");
6431
6432
6433static struct PyModuleDef _sslmodule = {
6434 PyModuleDef_HEAD_INIT,
6435 "_ssl",
6436 module_doc,
6437 -1,
6438 PySSL_methods,
6439 NULL,
6440 NULL,
6441 NULL,
6442 NULL
6443};
6444
6445PyMODINIT_FUNC
6446PyInit__ssl(void)
6447{
6448 PyObject *m;
6449
6450 m = PyModule_Create(&_sslmodule);
6451 if (m == NULL)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006452 return NULL;
6453
Christian Heimes5c36da72020-11-20 09:40:12 +01006454 if (sslmodule_init_types(m) != 0)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006455 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006456 if (sslmodule_init_exceptions(m) != 0)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006457 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006458 if (sslmodule_init_socketapi(m) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006459 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006460 if (sslmodule_init_errorcodes(m) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006461 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006462 if (sslmodule_init_constants(m) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006463 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006464 if (sslmodule_init_versioninfo(m) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006465 return NULL;
Christian Heimes5c36da72020-11-20 09:40:12 +01006466 if (sslmodule_legacy(m) != 0)
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006467 return NULL;
6468
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006469 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006470}