blob: 28796b376e86239c65df7231827644b206b02c96 [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
Miss Islington (bot)24a88b02020-06-01 00:18:39 -0700145/* 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
Miss Islington (bot)24a88b02020-06-01 00:18:39 -0700222#define ASN1_STRING_get0_data ASN1_STRING_data
223#define X509_get0_notBefore X509_get_notBefore
224#define X509_get0_notAfter X509_get_notAfter
225#define OpenSSL_version_num SSLeay
226#define OpenSSL_version SSLeay_version
227#define OPENSSL_VERSION SSLEAY_VERSION
Christian Heimes598894f2016-09-05 23:19:05 +0200228
229static int X509_NAME_ENTRY_set(const X509_NAME_ENTRY *ne)
230{
231 return ne->set;
232}
233
234#ifndef OPENSSL_NO_COMP
Christian Heimesa5d07652016-09-24 10:48:05 +0200235/* LCOV_EXCL_START */
Christian Heimes598894f2016-09-05 23:19:05 +0200236static int COMP_get_type(const COMP_METHOD *meth)
237{
238 return meth->type;
239}
Christian Heimes1a63b9f2016-09-24 12:07:21 +0200240/* LCOV_EXCL_STOP */
Christian Heimes598894f2016-09-05 23:19:05 +0200241#endif
242
243static pem_password_cb *SSL_CTX_get_default_passwd_cb(SSL_CTX *ctx)
244{
245 return ctx->default_passwd_callback;
246}
247
248static void *SSL_CTX_get_default_passwd_cb_userdata(SSL_CTX *ctx)
249{
250 return ctx->default_passwd_callback_userdata;
251}
252
253static int X509_OBJECT_get_type(X509_OBJECT *x)
254{
255 return x->type;
256}
257
258static X509 *X509_OBJECT_get0_X509(X509_OBJECT *x)
259{
260 return x->data.x509;
261}
262
263static int BIO_up_ref(BIO *b)
264{
265 CRYPTO_add(&b->references, 1, CRYPTO_LOCK_BIO);
266 return 1;
267}
268
269static STACK_OF(X509_OBJECT) *X509_STORE_get0_objects(X509_STORE *store) {
270 return store->objs;
271}
272
Christian Heimes99a65702016-09-10 23:44:53 +0200273static int
274SSL_SESSION_has_ticket(const SSL_SESSION *s)
275{
276 return (s->tlsext_ticklen > 0) ? 1 : 0;
277}
278
279static unsigned long
280SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s)
281{
282 return s->tlsext_tick_lifetime_hint;
283}
284
Christian Heimes4ca07392018-03-24 15:41:37 +0100285#endif /* OpenSSL < 1.1.0 or LibreSSL < 2.7.0 */
Christian Heimes598894f2016-09-05 23:19:05 +0200286
Christian Heimes892d66e2018-01-29 14:10:18 +0100287/* Default cipher suites */
288#ifndef PY_SSL_DEFAULT_CIPHERS
289#define PY_SSL_DEFAULT_CIPHERS 1
290#endif
291
292#if PY_SSL_DEFAULT_CIPHERS == 0
293 #ifndef PY_SSL_DEFAULT_CIPHER_STRING
294 #error "Py_SSL_DEFAULT_CIPHERS 0 needs Py_SSL_DEFAULT_CIPHER_STRING"
295 #endif
296#elif PY_SSL_DEFAULT_CIPHERS == 1
Stéphane Wirtel07fbbfd2018-10-05 16:17:18 +0200297/* Python custom selection of sensible cipher suites
Christian Heimes892d66e2018-01-29 14:10:18 +0100298 * DEFAULT: OpenSSL's default cipher list. Since 1.0.2 the list is in sensible order.
299 * !aNULL:!eNULL: really no NULL ciphers
300 * !MD5:!3DES:!DES:!RC4:!IDEA:!SEED: no weak or broken algorithms on old OpenSSL versions.
301 * !aDSS: no authentication with discrete logarithm DSA algorithm
302 * !SRP:!PSK: no secure remote password or pre-shared key authentication
303 */
304 #define PY_SSL_DEFAULT_CIPHER_STRING "DEFAULT:!aNULL:!eNULL:!MD5:!3DES:!DES:!RC4:!IDEA:!SEED:!aDSS:!SRP:!PSK"
305#elif PY_SSL_DEFAULT_CIPHERS == 2
306/* Ignored in SSLContext constructor, only used to as _ssl.DEFAULT_CIPHER_STRING */
307 #define PY_SSL_DEFAULT_CIPHER_STRING SSL_DEFAULT_CIPHER_LIST
308#else
309 #error "Unsupported PY_SSL_DEFAULT_CIPHERS"
310#endif
311
Christian Heimes598894f2016-09-05 23:19:05 +0200312
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000313enum py_ssl_error {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000314 /* these mirror ssl.h */
315 PY_SSL_ERROR_NONE,
316 PY_SSL_ERROR_SSL,
317 PY_SSL_ERROR_WANT_READ,
318 PY_SSL_ERROR_WANT_WRITE,
319 PY_SSL_ERROR_WANT_X509_LOOKUP,
320 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
321 PY_SSL_ERROR_ZERO_RETURN,
322 PY_SSL_ERROR_WANT_CONNECT,
323 /* start of non ssl.h errorcodes */
324 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
325 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
326 PY_SSL_ERROR_INVALID_ERROR_CODE
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000327};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000328
Thomas Woutersed03b412007-08-28 21:37:11 +0000329enum py_ssl_server_or_client {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000330 PY_SSL_CLIENT,
331 PY_SSL_SERVER
Thomas Woutersed03b412007-08-28 21:37:11 +0000332};
333
334enum py_ssl_cert_requirements {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000335 PY_SSL_CERT_NONE,
336 PY_SSL_CERT_OPTIONAL,
337 PY_SSL_CERT_REQUIRED
Thomas Woutersed03b412007-08-28 21:37:11 +0000338};
339
340enum py_ssl_version {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000341 PY_SSL_VERSION_SSL2,
Victor Stinner3de49192011-05-09 00:42:58 +0200342 PY_SSL_VERSION_SSL3=1,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200343 PY_SSL_VERSION_TLS, /* SSLv23 */
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100344 PY_SSL_VERSION_TLS1,
345 PY_SSL_VERSION_TLS1_1,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200346 PY_SSL_VERSION_TLS1_2,
Christian Heimes5fe668c2016-09-12 00:01:11 +0200347 PY_SSL_VERSION_TLS_CLIENT=0x10,
348 PY_SSL_VERSION_TLS_SERVER,
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100349};
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200350
Christian Heimes698dde12018-02-27 11:54:43 +0100351enum py_proto_version {
352 PY_PROTO_MINIMUM_SUPPORTED = -2,
353 PY_PROTO_SSLv3 = SSL3_VERSION,
354 PY_PROTO_TLSv1 = TLS1_VERSION,
355 PY_PROTO_TLSv1_1 = TLS1_1_VERSION,
356 PY_PROTO_TLSv1_2 = TLS1_2_VERSION,
357#ifdef TLS1_3_VERSION
358 PY_PROTO_TLSv1_3 = TLS1_3_VERSION,
359#else
360 PY_PROTO_TLSv1_3 = 0x304,
361#endif
362 PY_PROTO_MAXIMUM_SUPPORTED = -1,
363
364/* OpenSSL has no dedicated API to set the minimum version to the maximum
365 * available version, and the other way around. We have to figure out the
366 * minimum and maximum available version on our own and hope for the best.
367 */
368#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
369 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_SSLv3,
370#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
371 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1,
372#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
373 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_1,
374#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
375 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_2,
376#elif defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
377 PY_PROTO_MINIMUM_AVAILABLE = PY_PROTO_TLSv1_3,
378#else
379 #error "PY_PROTO_MINIMUM_AVAILABLE not found"
380#endif
381
382#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
383 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_3,
384#elif defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
385 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_2,
386#elif defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
387 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1_1,
388#elif defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
389 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_TLSv1,
390#elif defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
391 PY_PROTO_MAXIMUM_AVAILABLE = PY_PROTO_SSLv3,
392#else
393 #error "PY_PROTO_MAXIMUM_AVAILABLE not found"
394#endif
395};
396
397
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000398/* serves as a flag to see whether we've initialized the SSL thread support. */
399/* 0 means no, greater than 0 means yes */
400
401static unsigned int _ssl_locks_count = 0;
402
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000403/* SSL socket object */
404
405#define X509_NAME_MAXLEN 256
406
Gregory P. Smithbd4dacb2010-10-13 03:53:21 +0000407/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
408 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
409 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
410#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
Antoine Pitroub5218772010-05-21 09:56:06 +0000411# define HAVE_SSL_CTX_CLEAR_OPTIONS
412#else
413# undef HAVE_SSL_CTX_CLEAR_OPTIONS
414#endif
415
Antoine Pitroud6494802011-07-21 01:11:30 +0200416/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
417 * older SSL, but let's be safe */
418#define PySSL_CB_MAXLEN 128
419
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100420
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000421typedef struct {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000422 PyObject_HEAD
Antoine Pitrou152efa22010-05-16 18:19:27 +0000423 SSL_CTX *ctx;
Christian Heimes29eab552018-02-25 12:31:33 +0100424#if HAVE_NPN
Benjamin Petersoncca27322015-01-23 16:35:37 -0500425 unsigned char *npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100426 int npn_protocols_len;
427#endif
Christian Heimes29eab552018-02-25 12:31:33 +0100428#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -0500429 unsigned char *alpn_protocols;
Segev Finer5cff6372017-07-27 01:19:17 +0300430 unsigned int alpn_protocols_len;
Benjamin Petersoncca27322015-01-23 16:35:37 -0500431#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100432#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +0100433 PyObject *set_sni_cb;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100434#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +0100435 int check_hostname;
Christian Heimes61d478c2018-01-27 15:51:38 +0100436 /* OpenSSL has no API to get hostflags from X509_VERIFY_PARAM* struct.
437 * We have to maintain our own copy. OpenSSL's hostflags default to 0.
438 */
439 unsigned int hostflags;
Christian Heimes11a14932018-02-24 02:35:08 +0100440 int protocol;
Christian Heimes9fb051f2018-09-23 08:32:31 +0200441#ifdef TLS1_3_VERSION
442 int post_handshake_auth;
443#endif
Christian Heimesc7f70692019-05-31 11:44:05 +0200444 PyObject *msg_cb;
445#ifdef HAVE_OPENSSL_KEYLOG
446 PyObject *keylog_filename;
447 BIO *keylog_bio;
448#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +0000449} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000450
Antoine Pitrou152efa22010-05-16 18:19:27 +0000451typedef struct {
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700452 int ssl; /* last seen error from SSL */
453 int c; /* last seen error from libc */
454#ifdef MS_WINDOWS
455 int ws; /* last seen error from winsock */
456#endif
457} _PySSLError;
458
459typedef struct {
Antoine Pitrou152efa22010-05-16 18:19:27 +0000460 PyObject_HEAD
461 PyObject *Socket; /* weakref to socket on which we're layered */
462 SSL *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100463 PySSLContext *ctx; /* weakref to SSL context */
Antoine Pitrou20b85552013-09-29 19:50:53 +0200464 char shutdown_seen_zero;
Antoine Pitroud6494802011-07-21 01:11:30 +0200465 enum py_ssl_server_or_client socket_type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200466 PyObject *owner; /* Python level "owner" passed to servername callback */
467 PyObject *server_hostname;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700468 _PySSLError err; /* last seen error from various sources */
Christian Heimesc7f70692019-05-31 11:44:05 +0200469 /* Some SSL callbacks don't have error reporting. Callback wrappers
470 * store exception information on the socket. The handshake, read, write,
471 * and shutdown methods check for chained exceptions.
472 */
473 PyObject *exc_type;
474 PyObject *exc_value;
475 PyObject *exc_tb;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000476} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000477
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200478typedef struct {
479 PyObject_HEAD
480 BIO *bio;
481 int eof_written;
482} PySSLMemoryBIO;
483
Christian Heimes99a65702016-09-10 23:44:53 +0200484typedef struct {
485 PyObject_HEAD
486 SSL_SESSION *session;
487 PySSLContext *ctx;
488} PySSLSession;
489
Antoine Pitrou152efa22010-05-16 18:19:27 +0000490static PyTypeObject PySSLContext_Type;
491static PyTypeObject PySSLSocket_Type;
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200492static PyTypeObject PySSLMemoryBIO_Type;
Christian Heimes99a65702016-09-10 23:44:53 +0200493static PyTypeObject PySSLSession_Type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000494
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700495static inline _PySSLError _PySSL_errno(int failed, const SSL *ssl, int retcode)
496{
497 _PySSLError err = { 0 };
498 if (failed) {
Steve Dowere6eb48c2017-09-08 15:16:15 -0700499#ifdef MS_WINDOWS
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700500 err.ws = WSAGetLastError();
501 _PySSL_FIX_ERRNO;
Steve Dowere6eb48c2017-09-08 15:16:15 -0700502#endif
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700503 err.c = errno;
504 err.ssl = SSL_get_error(ssl, retcode);
505 }
506 return err;
507}
Steve Dowere6eb48c2017-09-08 15:16:15 -0700508
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300509/*[clinic input]
510module _ssl
511class _ssl._SSLContext "PySSLContext *" "&PySSLContext_Type"
512class _ssl._SSLSocket "PySSLSocket *" "&PySSLSocket_Type"
513class _ssl.MemoryBIO "PySSLMemoryBIO *" "&PySSLMemoryBIO_Type"
Christian Heimes99a65702016-09-10 23:44:53 +0200514class _ssl.SSLSession "PySSLSession *" "&PySSLSession_Type"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300515[clinic start generated code]*/
Christian Heimes99a65702016-09-10 23:44:53 +0200516/*[clinic end generated code: output=da39a3ee5e6b4b0d input=bdc67fafeeaa8109]*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +0300517
518#include "clinic/_ssl.c.h"
519
Victor Stinner14690702015-04-06 22:46:13 +0200520static int PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000521
Christian Heimes141c5e82018-02-24 21:10:57 +0100522static int PySSL_set_owner(PySSLSocket *, PyObject *, void *);
523static int PySSL_set_session(PySSLSocket *, PyObject *, void *);
Dong-hee Na1b55b652020-02-17 19:09:15 +0900524#define PySSLSocket_Check(v) Py_IS_TYPE(v, &PySSLSocket_Type)
525#define PySSLMemoryBIO_Check(v) Py_IS_TYPE(v, &PySSLMemoryBIO_Type)
526#define PySSLSession_Check(v) Py_IS_TYPE(v, &PySSLSession_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000527
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000528typedef enum {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000529 SOCKET_IS_NONBLOCKING,
530 SOCKET_IS_BLOCKING,
531 SOCKET_HAS_TIMED_OUT,
532 SOCKET_HAS_BEEN_CLOSED,
533 SOCKET_TOO_LARGE_FOR_SELECT,
534 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000535} timeout_state;
536
Thomas Woutersed03b412007-08-28 21:37:11 +0000537/* Wrap error strings with filename and line # */
Thomas Woutersed03b412007-08-28 21:37:11 +0000538#define ERRSTR1(x,y,z) (x ":" y ": " z)
Victor Stinner45e8e2f2014-05-14 17:24:35 +0200539#define ERRSTR(x) ERRSTR1("_ssl.c", Py_STRINGIFY(__LINE__), x)
Thomas Woutersed03b412007-08-28 21:37:11 +0000540
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200541/* Get the socket from a PySSLSocket, if it has one */
542#define GET_SOCKET(obj) ((obj)->Socket ? \
543 (PySocketSockObject *) PyWeakref_GetObject((obj)->Socket) : NULL)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200544
Victor Stinner14690702015-04-06 22:46:13 +0200545/* If sock is NULL, use a timeout of 0 second */
546#define GET_SOCKET_TIMEOUT(sock) \
547 ((sock != NULL) ? (sock)->sock_timeout : 0)
548
Christian Heimesc7f70692019-05-31 11:44:05 +0200549#include "_ssl/debughelpers.c"
550
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200551/*
552 * SSL errors.
553 */
554
555PyDoc_STRVAR(SSLError_doc,
556"An error occurred in the SSL implementation.");
557
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700558PyDoc_STRVAR(SSLCertVerificationError_doc,
559"A certificate could not be verified.");
560
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200561PyDoc_STRVAR(SSLZeroReturnError_doc,
562"SSL/TLS session closed cleanly.");
563
564PyDoc_STRVAR(SSLWantReadError_doc,
565"Non-blocking SSL socket needs to read more data\n"
566"before the requested operation can be completed.");
567
568PyDoc_STRVAR(SSLWantWriteError_doc,
569"Non-blocking SSL socket needs to write more data\n"
570"before the requested operation can be completed.");
571
572PyDoc_STRVAR(SSLSyscallError_doc,
573"System error when attempting SSL operation.");
574
575PyDoc_STRVAR(SSLEOFError_doc,
576"SSL/TLS connection terminated abruptly.");
577
578static PyObject *
579SSLError_str(PyOSErrorObject *self)
580{
581 if (self->strerror != NULL && PyUnicode_Check(self->strerror)) {
582 Py_INCREF(self->strerror);
583 return self->strerror;
584 }
585 else
586 return PyObject_Str(self->args);
587}
588
589static PyType_Slot sslerror_type_slots[] = {
590 {Py_tp_base, NULL}, /* Filled out in module init as it's not a constant */
Inada Naoki926b0cb2019-04-17 08:39:46 +0900591 {Py_tp_doc, (void*)SSLError_doc},
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200592 {Py_tp_str, SSLError_str},
593 {0, 0},
594};
595
596static PyType_Spec sslerror_type_spec = {
597 "ssl.SSLError",
598 sizeof(PyOSErrorObject),
599 0,
600 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
601 sslerror_type_slots
602};
603
604static void
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700605fill_and_set_sslerror(PySSLSocket *sslsock, PyObject *type, int ssl_errno,
606 const char *errstr, int lineno, unsigned long errcode)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200607{
608 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700609 PyObject *verify_obj = NULL, *verify_code_obj = NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200610 PyObject *init_value, *msg, *key;
611 _Py_IDENTIFIER(reason);
612 _Py_IDENTIFIER(library);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700613 _Py_IDENTIFIER(verify_message);
614 _Py_IDENTIFIER(verify_code);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200615
616 if (errcode != 0) {
617 int lib, reason;
618
619 lib = ERR_GET_LIB(errcode);
620 reason = ERR_GET_REASON(errcode);
621 key = Py_BuildValue("ii", lib, reason);
622 if (key == NULL)
623 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300624 reason_obj = PyDict_GetItemWithError(err_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200625 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300626 if (reason_obj == NULL && PyErr_Occurred()) {
627 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200628 }
629 key = PyLong_FromLong(lib);
630 if (key == NULL)
631 goto fail;
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300632 lib_obj = PyDict_GetItemWithError(lib_codes_to_names, key);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200633 Py_DECREF(key);
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +0300634 if (lib_obj == NULL && PyErr_Occurred()) {
635 goto fail;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200636 }
637 if (errstr == NULL)
638 errstr = ERR_reason_error_string(errcode);
639 }
640 if (errstr == NULL)
641 errstr = "unknown error";
642
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700643 /* verify code for cert validation error */
644 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
645 const char *verify_str = NULL;
646 long verify_code;
647
648 verify_code = SSL_get_verify_result(sslsock->ssl);
649 verify_code_obj = PyLong_FromLong(verify_code);
650 if (verify_code_obj == NULL) {
651 goto fail;
652 }
653
654 switch (verify_code) {
Christian Heimes09153602017-09-08 14:47:58 -0700655#ifdef X509_V_ERR_HOSTNAME_MISMATCH
656 /* OpenSSL >= 1.0.2, LibreSSL >= 2.5.3 */
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700657 case X509_V_ERR_HOSTNAME_MISMATCH:
658 verify_obj = PyUnicode_FromFormat(
659 "Hostname mismatch, certificate is not valid for '%S'.",
660 sslsock->server_hostname
661 );
662 break;
Christian Heimes09153602017-09-08 14:47:58 -0700663#endif
664#ifdef X509_V_ERR_IP_ADDRESS_MISMATCH
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700665 case X509_V_ERR_IP_ADDRESS_MISMATCH:
666 verify_obj = PyUnicode_FromFormat(
667 "IP address mismatch, certificate is not valid for '%S'.",
668 sslsock->server_hostname
669 );
670 break;
Christian Heimes09153602017-09-08 14:47:58 -0700671#endif
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700672 default:
673 verify_str = X509_verify_cert_error_string(verify_code);
674 if (verify_str != NULL) {
675 verify_obj = PyUnicode_FromString(verify_str);
676 } else {
677 verify_obj = Py_None;
678 Py_INCREF(verify_obj);
679 }
680 break;
681 }
682 if (verify_obj == NULL) {
683 goto fail;
684 }
685 }
686
687 if (verify_obj && reason_obj && lib_obj)
688 msg = PyUnicode_FromFormat("[%S: %S] %s: %S (_ssl.c:%d)",
689 lib_obj, reason_obj, errstr, verify_obj,
690 lineno);
691 else if (reason_obj && lib_obj)
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200692 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
693 lib_obj, reason_obj, errstr, lineno);
694 else if (lib_obj)
695 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
696 lib_obj, errstr, lineno);
697 else
698 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200699 if (msg == NULL)
700 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100701
Paul Monsonfb7e7502019-05-15 15:38:55 -0700702 init_value = Py_BuildValue("iN", ERR_GET_REASON(ssl_errno), msg);
Victor Stinnerba9be472013-10-31 15:00:24 +0100703 if (init_value == NULL)
704 goto fail;
705
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200706 err_value = PyObject_CallObject(type, init_value);
707 Py_DECREF(init_value);
708 if (err_value == NULL)
709 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100710
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200711 if (reason_obj == NULL)
712 reason_obj = Py_None;
713 if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))
714 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700715
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200716 if (lib_obj == NULL)
717 lib_obj = Py_None;
718 if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))
719 goto fail;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700720
721 if ((sslsock != NULL) && (type == PySSLCertVerificationErrorObject)) {
722 /* Only set verify code / message for SSLCertVerificationError */
723 if (_PyObject_SetAttrId(err_value, &PyId_verify_code,
724 verify_code_obj))
725 goto fail;
726 if (_PyObject_SetAttrId(err_value, &PyId_verify_message, verify_obj))
727 goto fail;
728 }
729
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200730 PyErr_SetObject(type, err_value);
731fail:
732 Py_XDECREF(err_value);
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700733 Py_XDECREF(verify_code_obj);
734 Py_XDECREF(verify_obj);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200735}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000736
Christian Heimesc7f70692019-05-31 11:44:05 +0200737static int
738PySSL_ChainExceptions(PySSLSocket *sslsock) {
739 if (sslsock->exc_type == NULL)
740 return 0;
741
742 _PyErr_ChainExceptions(sslsock->exc_type, sslsock->exc_value, sslsock->exc_tb);
743 sslsock->exc_type = NULL;
744 sslsock->exc_value = NULL;
745 sslsock->exc_tb = NULL;
746 return -1;
747}
748
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000749static PyObject *
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700750PySSL_SetError(PySSLSocket *sslsock, int ret, const char *filename, int lineno)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000751{
Antoine Pitrou41032a62011-10-27 23:56:55 +0200752 PyObject *type = PySSLErrorObject;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200753 char *errstr = NULL;
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700754 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000755 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200756 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000757
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000758 assert(ret <= 0);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200759 e = ERR_peek_last_error();
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000760
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700761 if (sslsock->ssl != NULL) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700762 err = sslsock->err;
Thomas Woutersed03b412007-08-28 21:37:11 +0000763
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700764 switch (err.ssl) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000765 case SSL_ERROR_ZERO_RETURN:
Antoine Pitrou41032a62011-10-27 23:56:55 +0200766 errstr = "TLS/SSL connection has been closed (EOF)";
767 type = PySSLZeroReturnErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000768 p = PY_SSL_ERROR_ZERO_RETURN;
769 break;
770 case SSL_ERROR_WANT_READ:
771 errstr = "The operation did not complete (read)";
Antoine Pitrou41032a62011-10-27 23:56:55 +0200772 type = PySSLWantReadErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000773 p = PY_SSL_ERROR_WANT_READ;
774 break;
775 case SSL_ERROR_WANT_WRITE:
776 p = PY_SSL_ERROR_WANT_WRITE;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200777 type = PySSLWantWriteErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000778 errstr = "The operation did not complete (write)";
779 break;
780 case SSL_ERROR_WANT_X509_LOOKUP:
781 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000782 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000783 break;
784 case SSL_ERROR_WANT_CONNECT:
785 p = PY_SSL_ERROR_WANT_CONNECT;
786 errstr = "The operation did not complete (connect)";
787 break;
788 case SSL_ERROR_SYSCALL:
789 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000790 if (e == 0) {
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700791 PySocketSockObject *s = GET_SOCKET(sslsock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000792 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000793 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200794 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000795 errstr = "EOF occurred in violation of protocol";
Antoine Pitroub1fdf472014-10-05 20:41:53 +0200796 } else if (s && ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000797 /* underlying BIO reported an I/O error */
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000798 ERR_clear_error();
Steve Dowere6eb48c2017-09-08 15:16:15 -0700799#ifdef MS_WINDOWS
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700800 if (err.ws) {
801 return PyErr_SetFromWindowsErr(err.ws);
802 }
Steve Dowere6eb48c2017-09-08 15:16:15 -0700803#endif
Steve Dowerc6fd1c12018-09-17 11:34:47 -0700804 if (err.c) {
805 errno = err.c;
Steve Dowere6eb48c2017-09-08 15:16:15 -0700806 return PyErr_SetFromErrno(PyExc_OSError);
807 }
Miss Islington (bot)fc8ffe22020-08-15 10:44:57 -0700808 else {
809 p = PY_SSL_ERROR_EOF;
810 type = PySSLEOFErrorObject;
811 errstr = "EOF occurred in violation of protocol";
812 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000813 } else { /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000814 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200815 type = PySSLSyscallErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000816 errstr = "Some I/O error occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000817 }
818 } else {
819 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000820 }
821 break;
822 }
823 case SSL_ERROR_SSL:
824 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000825 p = PY_SSL_ERROR_SSL;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700826 if (e == 0) {
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200827 /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000828 errstr = "A failure in the SSL library occurred";
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700829 }
830 if (ERR_GET_LIB(e) == ERR_LIB_SSL &&
831 ERR_GET_REASON(e) == SSL_R_CERTIFICATE_VERIFY_FAILED) {
832 type = PySSLCertVerificationErrorObject;
833 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000834 break;
835 }
836 default:
837 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
838 errstr = "Invalid error code";
839 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000840 }
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700841 fill_and_set_sslerror(sslsock, type, p, errstr, lineno, e);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000842 ERR_clear_error();
Christian Heimesc7f70692019-05-31 11:44:05 +0200843 PySSL_ChainExceptions(sslsock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000844 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000845}
846
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000847static PyObject *
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200848_setSSLError (const char *errstr, int errcode, const char *filename, int lineno) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000849
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200850 if (errstr == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000851 errcode = ERR_peek_last_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200852 else
853 errcode = 0;
Christian Heimesb3ad0e52017-09-08 12:00:19 -0700854 fill_and_set_sslerror(NULL, PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000855 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000856 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000857}
858
Christian Heimes61d478c2018-01-27 15:51:38 +0100859/*
860 * SSL objects
861 */
862
863static int
864_ssl_configure_hostname(PySSLSocket *self, const char* server_hostname)
865{
866 int retval = -1;
867 ASN1_OCTET_STRING *ip;
868 PyObject *hostname;
869 size_t len;
870
871 assert(server_hostname);
872
873 /* Disable OpenSSL's special mode with leading dot in hostname:
874 * When name starts with a dot (e.g ".example.com"), it will be
875 * matched by a certificate valid for any sub-domain of name.
876 */
877 len = strlen(server_hostname);
878 if (len == 0 || *server_hostname == '.') {
879 PyErr_SetString(
880 PyExc_ValueError,
881 "server_hostname cannot be an empty string or start with a "
882 "leading dot.");
883 return retval;
884 }
885
886 /* inet_pton is not available on all platforms. */
887 ip = a2i_IPADDRESS(server_hostname);
888 if (ip == NULL) {
889 ERR_clear_error();
890 }
891
Christian Heimes11a14932018-02-24 02:35:08 +0100892 hostname = PyUnicode_Decode(server_hostname, len, "ascii", "strict");
Christian Heimes61d478c2018-01-27 15:51:38 +0100893 if (hostname == NULL) {
894 goto error;
895 }
896 self->server_hostname = hostname;
897
898 /* Only send SNI extension for non-IP hostnames */
899 if (ip == NULL) {
900 if (!SSL_set_tlsext_host_name(self->ssl, server_hostname)) {
901 _setSSLError(NULL, 0, __FILE__, __LINE__);
902 }
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 {
Miss Islington (bot)24a88b02020-06-01 00:18:39 -0700913 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
Antoine Pitrou152efa22010-05-16 18:19:27 +0000939 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) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001104 PyErr_SetString(PySocketModule.timeout_error,
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);
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07001389 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;
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07001685 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);
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07001747 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);
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07001764 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
2196 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{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002291 if (self->ssl)
2292 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002293 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002294 Py_XDECREF(self->ctx);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002295 Py_XDECREF(self->server_hostname);
2296 Py_XDECREF(self->owner);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002297 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002298}
2299
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002300/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002301 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002302 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002303 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00002304
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002305static int
Victor Stinner14690702015-04-06 22:46:13 +02002306PySSL_select(PySocketSockObject *s, int writing, _PyTime_t timeout)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002307{
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002308 int rc;
2309#ifdef HAVE_POLL
2310 struct pollfd pollfd;
2311 _PyTime_t ms;
2312#else
2313 int nfds;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002314 fd_set fds;
2315 struct timeval tv;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002316#endif
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002317
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002318 /* Nothing to do unless we're in timeout mode (not non-blocking) */
Victor Stinner14690702015-04-06 22:46:13 +02002319 if ((s == NULL) || (timeout == 0))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002320 return SOCKET_IS_NONBLOCKING;
Victor Stinner14690702015-04-06 22:46:13 +02002321 else if (timeout < 0) {
2322 if (s->sock_timeout > 0)
2323 return SOCKET_HAS_TIMED_OUT;
2324 else
2325 return SOCKET_IS_BLOCKING;
2326 }
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002327
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002328 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002329 if (s->sock_fd == INVALID_SOCKET)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002330 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002331
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002332 /* Prefer poll, if available, since you can poll() any fd
2333 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002334#ifdef HAVE_POLL
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002335 pollfd.fd = s->sock_fd;
2336 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002337
Victor Stinner14690702015-04-06 22:46:13 +02002338 /* timeout is in seconds, poll() uses milliseconds */
2339 ms = (int)_PyTime_AsMilliseconds(timeout, _PyTime_ROUND_CEILING);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002340 assert(ms <= INT_MAX);
Thomas Wouters0e3f5912006-08-11 14:57:12 +00002341
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002342 PySSL_BEGIN_ALLOW_THREADS
2343 rc = poll(&pollfd, 1, (int)ms);
2344 PySSL_END_ALLOW_THREADS
2345#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002346 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02002347 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002348 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00002349
Victor Stinner14690702015-04-06 22:46:13 +02002350 _PyTime_AsTimeval_noraise(timeout, &tv, _PyTime_ROUND_CEILING);
Victor Stinnere2452312015-03-28 03:00:46 +01002351
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002352 FD_ZERO(&fds);
2353 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002354
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002355 /* Wait until the socket becomes ready */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002356 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002357 nfds = Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002358 if (writing)
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002359 rc = select(nfds, NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002360 else
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002361 rc = select(nfds, &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002362 PySSL_END_ALLOW_THREADS
Bill Janssen6e027db2007-11-15 22:23:56 +00002363#endif
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002364
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002365 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
2366 (when we are able to write or when there's something to read) */
2367 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00002368}
2369
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002370/*[clinic input]
2371_ssl._SSLSocket.write
2372 b: Py_buffer
2373 /
2374
2375Writes the bytes-like object b into the SSL object.
2376
2377Returns the number of bytes written.
2378[clinic start generated code]*/
2379
2380static PyObject *
2381_ssl__SSLSocket_write_impl(PySSLSocket *self, Py_buffer *b)
2382/*[clinic end generated code: output=aa7a6be5527358d8 input=77262d994fe5100a]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002383{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002384 int len;
2385 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002386 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002387 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002388 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002389 _PyTime_t timeout, deadline = 0;
2390 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002391
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002392 if (sock != NULL) {
2393 if (((PyObject*)sock) == Py_None) {
2394 _setSSLError("Underlying socket connection gone",
2395 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2396 return NULL;
2397 }
2398 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002399 }
2400
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002401 if (b->len > INT_MAX) {
Victor Stinner6efa9652013-06-25 00:42:31 +02002402 PyErr_Format(PyExc_OverflowError,
2403 "string longer than %d bytes", INT_MAX);
2404 goto error;
2405 }
2406
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002407 if (sock != NULL) {
2408 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002409 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002410 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2411 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2412 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002413
Victor Stinner14690702015-04-06 22:46:13 +02002414 timeout = GET_SOCKET_TIMEOUT(sock);
2415 has_timeout = (timeout > 0);
2416 if (has_timeout)
2417 deadline = _PyTime_GetMonotonicClock() + timeout;
2418
2419 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002420 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002421 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002422 "The write operation timed out");
2423 goto error;
2424 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2425 PyErr_SetString(PySSLErrorObject,
2426 "Underlying socket has been closed.");
2427 goto error;
2428 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2429 PyErr_SetString(PySSLErrorObject,
2430 "Underlying socket too large for select().");
2431 goto error;
2432 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002433
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002434 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002435 PySSL_BEGIN_ALLOW_THREADS
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002436 len = SSL_write(self->ssl, b->buf, (int)b->len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002437 err = _PySSL_errno(len <= 0, self->ssl, len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002438 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002439 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002440
2441 if (PyErr_CheckSignals())
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002442 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002443
Victor Stinner14690702015-04-06 22:46:13 +02002444 if (has_timeout)
2445 timeout = deadline - _PyTime_GetMonotonicClock();
2446
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002447 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002448 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002449 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002450 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002451 } else {
2452 sockstate = SOCKET_OPERATION_OK;
2453 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002454
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002455 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002456 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002457 "The write operation timed out");
2458 goto error;
2459 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
2460 PyErr_SetString(PySSLErrorObject,
2461 "Underlying socket has been closed.");
2462 goto error;
2463 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2464 break;
2465 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002466 } while (err.ssl == SSL_ERROR_WANT_READ ||
2467 err.ssl == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002468
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002469 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002470 if (len <= 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002471 return PySSL_SetError(self, len, __FILE__, __LINE__);
Christian Heimesc7f70692019-05-31 11:44:05 +02002472 if (PySSL_ChainExceptions(self) < 0)
2473 return NULL;
2474 return PyLong_FromLong(len);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00002475error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002476 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002477 PySSL_ChainExceptions(self);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002478 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002479}
2480
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002481/*[clinic input]
2482_ssl._SSLSocket.pending
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002483
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002484Returns the number of already decrypted bytes available for read, pending on the connection.
2485[clinic start generated code]*/
2486
2487static PyObject *
2488_ssl__SSLSocket_pending_impl(PySSLSocket *self)
2489/*[clinic end generated code: output=983d9fecdc308a83 input=2b77487d6dfd597f]*/
Bill Janssen6e027db2007-11-15 22:23:56 +00002490{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002491 int count = 0;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002492 _PySSLError err;
Bill Janssen6e027db2007-11-15 22:23:56 +00002493
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002494 PySSL_BEGIN_ALLOW_THREADS
2495 count = SSL_pending(self->ssl);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002496 err = _PySSL_errno(count < 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002497 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002498 self->err = err;
2499
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002500 if (count < 0)
2501 return PySSL_SetError(self, count, __FILE__, __LINE__);
2502 else
2503 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00002504}
2505
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002506/*[clinic input]
2507_ssl._SSLSocket.read
2508 size as len: int
2509 [
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002510 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002511 ]
2512 /
Bill Janssen6e027db2007-11-15 22:23:56 +00002513
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002514Read up to size bytes from the SSL socket.
2515[clinic start generated code]*/
2516
2517static PyObject *
2518_ssl__SSLSocket_read_impl(PySSLSocket *self, int len, int group_right_1,
2519 Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07002520/*[clinic end generated code: output=00097776cec2a0af input=ff157eb918d0905b]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002521{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002522 PyObject *dest = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002523 char *mem;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002524 int count;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002525 int sockstate;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002526 _PySSLError err;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002527 int nonblocking;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002528 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002529 _PyTime_t timeout, deadline = 0;
2530 int has_timeout;
Bill Janssen54cc54c2007-12-14 22:08:56 +00002531
Martin Panter5503d472016-03-27 05:35:19 +00002532 if (!group_right_1 && len < 0) {
2533 PyErr_SetString(PyExc_ValueError, "size should not be negative");
2534 return NULL;
2535 }
2536
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002537 if (sock != NULL) {
2538 if (((PyObject*)sock) == Py_None) {
2539 _setSSLError("Underlying socket connection gone",
2540 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2541 return NULL;
2542 }
2543 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002544 }
2545
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002546 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002547 dest = PyBytes_FromStringAndSize(NULL, len);
2548 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002549 goto error;
Martin Panterbed7f1a2016-07-11 00:17:13 +00002550 if (len == 0) {
2551 Py_XDECREF(sock);
2552 return dest;
2553 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002554 mem = PyBytes_AS_STRING(dest);
2555 }
2556 else {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002557 mem = buffer->buf;
2558 if (len <= 0 || len > buffer->len) {
2559 len = (int) buffer->len;
2560 if (buffer->len != len) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002561 PyErr_SetString(PyExc_OverflowError,
2562 "maximum length can't fit in a C 'int'");
2563 goto error;
2564 }
Martin Panterbed7f1a2016-07-11 00:17:13 +00002565 if (len == 0) {
2566 count = 0;
2567 goto done;
2568 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002569 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002570 }
2571
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002572 if (sock != NULL) {
2573 /* just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002574 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002575 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2576 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
2577 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002578
Victor Stinner14690702015-04-06 22:46:13 +02002579 timeout = GET_SOCKET_TIMEOUT(sock);
2580 has_timeout = (timeout > 0);
2581 if (has_timeout)
2582 deadline = _PyTime_GetMonotonicClock() + timeout;
2583
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002584 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002585 PySSL_BEGIN_ALLOW_THREADS
2586 count = SSL_read(self->ssl, mem, len);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002587 err = _PySSL_errno(count <= 0, self->ssl, count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002588 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002589 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002590
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002591 if (PyErr_CheckSignals())
2592 goto error;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002593
Victor Stinner14690702015-04-06 22:46:13 +02002594 if (has_timeout)
2595 timeout = deadline - _PyTime_GetMonotonicClock();
2596
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002597 if (err.ssl == SSL_ERROR_WANT_READ) {
Victor Stinner14690702015-04-06 22:46:13 +02002598 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002599 } else if (err.ssl == SSL_ERROR_WANT_WRITE) {
Victor Stinner14690702015-04-06 22:46:13 +02002600 sockstate = PySSL_select(sock, 1, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002601 } else if (err.ssl == SSL_ERROR_ZERO_RETURN &&
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002602 SSL_get_shutdown(self->ssl) == SSL_RECEIVED_SHUTDOWN)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002603 {
2604 count = 0;
2605 goto done;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002606 }
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002607 else
2608 sockstate = SOCKET_OPERATION_OK;
2609
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002610 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002611 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002612 "The read operation timed out");
2613 goto error;
2614 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
2615 break;
2616 }
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002617 } while (err.ssl == SSL_ERROR_WANT_READ ||
2618 err.ssl == SSL_ERROR_WANT_WRITE);
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002619
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002620 if (count <= 0) {
2621 PySSL_SetError(self, count, __FILE__, __LINE__);
2622 goto error;
2623 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002624 if (self->exc_type != NULL)
2625 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002626
2627done:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002628 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002629 if (!group_right_1) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002630 _PyBytes_Resize(&dest, count);
2631 return dest;
2632 }
2633 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002634 return PyLong_FromLong(count);
2635 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00002636
2637error:
Christian Heimesc7f70692019-05-31 11:44:05 +02002638 PySSL_ChainExceptions(self);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002639 Py_XDECREF(sock);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002640 if (!group_right_1)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002641 Py_XDECREF(dest);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002642 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002643}
2644
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002645/*[clinic input]
2646_ssl._SSLSocket.shutdown
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002647
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002648Does the SSL shutdown handshake with the remote end.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002649[clinic start generated code]*/
2650
2651static PyObject *
2652_ssl__SSLSocket_shutdown_impl(PySSLSocket *self)
Christian Heimes141c5e82018-02-24 21:10:57 +01002653/*[clinic end generated code: output=ca1aa7ed9d25ca42 input=11d39e69b0a2bf4a]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002654{
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002655 _PySSLError err;
2656 int sockstate, nonblocking, ret;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002657 int zeros = 0;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002658 PySocketSockObject *sock = GET_SOCKET(self);
Victor Stinner14690702015-04-06 22:46:13 +02002659 _PyTime_t timeout, deadline = 0;
2660 int has_timeout;
Bill Janssen40a0f662008-08-12 16:56:25 +00002661
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002662 if (sock != NULL) {
2663 /* Guard against closed socket */
Victor Stinner524714e2016-07-22 17:43:59 +02002664 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd == INVALID_SOCKET)) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002665 _setSSLError("Underlying socket connection gone",
2666 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
2667 return NULL;
2668 }
2669 Py_INCREF(sock);
2670
2671 /* Just in case the blocking state of the socket has been changed */
Victor Stinnere2452312015-03-28 03:00:46 +01002672 nonblocking = (sock->sock_timeout >= 0);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002673 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
2674 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002675 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002676
Victor Stinner14690702015-04-06 22:46:13 +02002677 timeout = GET_SOCKET_TIMEOUT(sock);
2678 has_timeout = (timeout > 0);
2679 if (has_timeout)
2680 deadline = _PyTime_GetMonotonicClock() + timeout;
2681
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002682 while (1) {
2683 PySSL_BEGIN_ALLOW_THREADS
2684 /* Disable read-ahead so that unwrap can work correctly.
2685 * Otherwise OpenSSL might read in too much data,
2686 * eating clear text data that happens to be
2687 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03002688 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002689 * function is used and the shutdown_seen_zero != 0
2690 * condition is met.
2691 */
2692 if (self->shutdown_seen_zero)
2693 SSL_set_read_ahead(self->ssl, 0);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002694 ret = SSL_shutdown(self->ssl);
2695 err = _PySSL_errno(ret < 0, self->ssl, ret);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002696 PySSL_END_ALLOW_THREADS
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002697 self->err = err;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002698
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002699 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002700 if (ret > 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002701 break;
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002702 if (ret == 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002703 /* Don't loop endlessly; instead preserve legacy
2704 behaviour of trying SSL_shutdown() only twice.
2705 This looks necessary for OpenSSL < 0.9.8m */
2706 if (++zeros > 1)
2707 break;
2708 /* Shutdown was sent, now try receiving */
2709 self->shutdown_seen_zero = 1;
2710 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00002711 }
2712
Victor Stinner14690702015-04-06 22:46:13 +02002713 if (has_timeout)
2714 timeout = deadline - _PyTime_GetMonotonicClock();
2715
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002716 /* Possibly retry shutdown until timeout or failure */
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002717 if (err.ssl == SSL_ERROR_WANT_READ)
Victor Stinner14690702015-04-06 22:46:13 +02002718 sockstate = PySSL_select(sock, 0, timeout);
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002719 else if (err.ssl == SSL_ERROR_WANT_WRITE)
Victor Stinner14690702015-04-06 22:46:13 +02002720 sockstate = PySSL_select(sock, 1, timeout);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002721 else
2722 break;
Victor Stinner4e3cfa42015-04-02 21:28:28 +02002723
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002724 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Steve Dowerc6fd1c12018-09-17 11:34:47 -07002725 if (err.ssl == SSL_ERROR_WANT_READ)
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002726 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002727 "The read operation timed out");
2728 else
Antoine Pitrouc4df7842010-12-03 19:59:41 +00002729 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002730 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002731 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002732 }
2733 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
2734 PyErr_SetString(PySSLErrorObject,
2735 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002736 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002737 }
2738 else if (sockstate != SOCKET_OPERATION_OK)
2739 /* Retain the SSL error code */
2740 break;
2741 }
Nathaniel J. Smithc0da5822018-09-21 21:44:12 -07002742 if (ret < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002743 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002744 PySSL_SetError(self, ret, __FILE__, __LINE__);
2745 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00002746 }
Christian Heimesc7f70692019-05-31 11:44:05 +02002747 if (self->exc_type != NULL)
2748 goto error;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002749 if (sock)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002750 /* It's already INCREF'ed */
2751 return (PyObject *) sock;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002752 else
2753 Py_RETURN_NONE;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002754
2755error:
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002756 Py_XDECREF(sock);
Christian Heimesc7f70692019-05-31 11:44:05 +02002757 PySSL_ChainExceptions(self);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00002758 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00002759}
2760
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002761/*[clinic input]
Christian Heimes141c5e82018-02-24 21:10:57 +01002762_ssl._SSLSocket.get_channel_binding
2763 cb_type: str = "tls-unique"
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002764
Christian Heimes141c5e82018-02-24 21:10:57 +01002765Get channel binding data for current connection.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002766
Christian Heimes141c5e82018-02-24 21:10:57 +01002767Raise ValueError if the requested `cb_type` is not supported. Return bytes
2768of the data or None if the data is not available (e.g. before the handshake).
2769Only 'tls-unique' channel binding data from RFC 5929 is supported.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002770[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00002771
Antoine Pitroud6494802011-07-21 01:11:30 +02002772static PyObject *
Christian Heimes141c5e82018-02-24 21:10:57 +01002773_ssl__SSLSocket_get_channel_binding_impl(PySSLSocket *self,
2774 const char *cb_type)
2775/*[clinic end generated code: output=34bac9acb6a61d31 input=08b7e43b99c17d41]*/
Antoine Pitroud6494802011-07-21 01:11:30 +02002776{
Antoine Pitroud6494802011-07-21 01:11:30 +02002777 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02002778 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02002779
Christian Heimes141c5e82018-02-24 21:10:57 +01002780 if (strcmp(cb_type, "tls-unique") == 0) {
2781 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
2782 /* if session is resumed XOR we are the client */
2783 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2784 }
2785 else {
2786 /* if a new session XOR we are the server */
2787 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
2788 }
Antoine Pitroud6494802011-07-21 01:11:30 +02002789 }
2790 else {
Christian Heimes141c5e82018-02-24 21:10:57 +01002791 PyErr_Format(
2792 PyExc_ValueError,
2793 "'%s' channel binding type not implemented",
2794 cb_type
2795 );
2796 return NULL;
Antoine Pitroud6494802011-07-21 01:11:30 +02002797 }
2798
2799 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02002800 if (len == 0)
2801 Py_RETURN_NONE;
2802
Christian Heimes141c5e82018-02-24 21:10:57 +01002803 return PyBytes_FromStringAndSize(buf, len);
Antoine Pitroud6494802011-07-21 01:11:30 +02002804}
2805
Christian Heimes9fb051f2018-09-23 08:32:31 +02002806/*[clinic input]
2807_ssl._SSLSocket.verify_client_post_handshake
2808
2809Initiate TLS 1.3 post-handshake authentication
2810[clinic start generated code]*/
2811
2812static PyObject *
2813_ssl__SSLSocket_verify_client_post_handshake_impl(PySSLSocket *self)
2814/*[clinic end generated code: output=532147f3b1341425 input=6bfa874810a3d889]*/
2815{
2816#ifdef TLS1_3_VERSION
2817 int err = SSL_verify_client_post_handshake(self->ssl);
2818 if (err == 0)
2819 return _setSSLError(NULL, 0, __FILE__, __LINE__);
2820 else
2821 Py_RETURN_NONE;
2822#else
2823 PyErr_SetString(PyExc_NotImplementedError,
2824 "Post-handshake auth is not supported by your "
2825 "OpenSSL version.");
2826 return NULL;
2827#endif
2828}
2829
Christian Heimes99a65702016-09-10 23:44:53 +02002830#ifdef OPENSSL_VERSION_1_1
2831
2832static SSL_SESSION*
2833_ssl_session_dup(SSL_SESSION *session) {
2834 SSL_SESSION *newsession = NULL;
2835 int slen;
2836 unsigned char *senc = NULL, *p;
2837 const unsigned char *const_p;
2838
2839 if (session == NULL) {
2840 PyErr_SetString(PyExc_ValueError, "Invalid session");
2841 goto error;
2842 }
2843
2844 /* get length */
2845 slen = i2d_SSL_SESSION(session, NULL);
2846 if (slen == 0 || slen > 0xFF00) {
2847 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2848 goto error;
2849 }
2850 if ((senc = PyMem_Malloc(slen)) == NULL) {
2851 PyErr_NoMemory();
2852 goto error;
2853 }
2854 p = senc;
2855 if (!i2d_SSL_SESSION(session, &p)) {
2856 PyErr_SetString(PyExc_ValueError, "i2d() failed.");
2857 goto error;
2858 }
2859 const_p = senc;
2860 newsession = d2i_SSL_SESSION(NULL, &const_p, slen);
2861 if (session == NULL) {
2862 goto error;
2863 }
2864 PyMem_Free(senc);
2865 return newsession;
2866 error:
2867 if (senc != NULL) {
2868 PyMem_Free(senc);
2869 }
2870 return NULL;
2871}
2872#endif
2873
2874static PyObject *
2875PySSL_get_session(PySSLSocket *self, void *closure) {
2876 /* get_session can return sessions from a server-side connection,
2877 * it does not check for handshake done or client socket. */
2878 PySSLSession *pysess;
2879 SSL_SESSION *session;
2880
2881#ifdef OPENSSL_VERSION_1_1
2882 /* duplicate session as workaround for session bug in OpenSSL 1.1.0,
2883 * https://github.com/openssl/openssl/issues/1550 */
2884 session = SSL_get0_session(self->ssl); /* borrowed reference */
2885 if (session == NULL) {
2886 Py_RETURN_NONE;
2887 }
2888 if ((session = _ssl_session_dup(session)) == NULL) {
2889 return NULL;
2890 }
2891#else
2892 session = SSL_get1_session(self->ssl);
2893 if (session == NULL) {
2894 Py_RETURN_NONE;
2895 }
2896#endif
Christian Heimesa5d07652016-09-24 10:48:05 +02002897 pysess = PyObject_GC_New(PySSLSession, &PySSLSession_Type);
Christian Heimes99a65702016-09-10 23:44:53 +02002898 if (pysess == NULL) {
2899 SSL_SESSION_free(session);
2900 return NULL;
2901 }
2902
2903 assert(self->ctx);
2904 pysess->ctx = self->ctx;
2905 Py_INCREF(pysess->ctx);
2906 pysess->session = session;
Christian Heimesa5d07652016-09-24 10:48:05 +02002907 PyObject_GC_Track(pysess);
Christian Heimes99a65702016-09-10 23:44:53 +02002908 return (PyObject *)pysess;
2909}
2910
2911static int PySSL_set_session(PySSLSocket *self, PyObject *value,
2912 void *closure)
2913 {
2914 PySSLSession *pysess;
2915#ifdef OPENSSL_VERSION_1_1
2916 SSL_SESSION *session;
2917#endif
2918 int result;
2919
2920 if (!PySSLSession_Check(value)) {
Ned Deily4531ec72018-06-11 20:26:28 -04002921 PyErr_SetString(PyExc_TypeError, "Value is not a SSLSession.");
Christian Heimes99a65702016-09-10 23:44:53 +02002922 return -1;
2923 }
2924 pysess = (PySSLSession *)value;
2925
2926 if (self->ctx->ctx != pysess->ctx->ctx) {
2927 PyErr_SetString(PyExc_ValueError,
2928 "Session refers to a different SSLContext.");
2929 return -1;
2930 }
2931 if (self->socket_type != PY_SSL_CLIENT) {
2932 PyErr_SetString(PyExc_ValueError,
2933 "Cannot set session for server-side SSLSocket.");
2934 return -1;
2935 }
Christian Heimes66dc33b2017-05-23 16:02:02 -07002936 if (SSL_is_init_finished(self->ssl)) {
Christian Heimes99a65702016-09-10 23:44:53 +02002937 PyErr_SetString(PyExc_ValueError,
2938 "Cannot set session after handshake.");
2939 return -1;
2940 }
2941#ifdef OPENSSL_VERSION_1_1
2942 /* duplicate session */
2943 if ((session = _ssl_session_dup(pysess->session)) == NULL) {
2944 return -1;
2945 }
2946 result = SSL_set_session(self->ssl, session);
2947 /* free duplicate, SSL_set_session() bumps ref count */
2948 SSL_SESSION_free(session);
2949#else
2950 result = SSL_set_session(self->ssl, pysess->session);
2951#endif
2952 if (result == 0) {
2953 _setSSLError(NULL, 0, __FILE__, __LINE__);
2954 return -1;
2955 }
2956 return 0;
2957}
2958
2959PyDoc_STRVAR(PySSL_set_session_doc,
2960"_setter_session(session)\n\
2961\
2962Get / set SSLSession.");
2963
2964static PyObject *
2965PySSL_get_session_reused(PySSLSocket *self, void *closure) {
2966 if (SSL_session_reused(self->ssl)) {
2967 Py_RETURN_TRUE;
2968 } else {
2969 Py_RETURN_FALSE;
2970 }
2971}
2972
2973PyDoc_STRVAR(PySSL_get_session_reused_doc,
2974"Was the client session reused during handshake?");
2975
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002976static PyGetSetDef ssl_getsetlist[] = {
2977 {"context", (getter) PySSL_get_context,
2978 (setter) PySSL_set_context, PySSL_set_context_doc},
Antoine Pitroub1fdf472014-10-05 20:41:53 +02002979 {"server_side", (getter) PySSL_get_server_side, NULL,
2980 PySSL_get_server_side_doc},
2981 {"server_hostname", (getter) PySSL_get_server_hostname, NULL,
2982 PySSL_get_server_hostname_doc},
2983 {"owner", (getter) PySSL_get_owner, (setter) PySSL_set_owner,
2984 PySSL_get_owner_doc},
Christian Heimes99a65702016-09-10 23:44:53 +02002985 {"session", (getter) PySSL_get_session,
2986 (setter) PySSL_set_session, PySSL_set_session_doc},
2987 {"session_reused", (getter) PySSL_get_session_reused, NULL,
2988 PySSL_get_session_reused_doc},
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002989 {NULL}, /* sentinel */
2990};
2991
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00002992static PyMethodDef PySSLMethods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002993 _SSL__SSLSOCKET_DO_HANDSHAKE_METHODDEF
2994 _SSL__SSLSOCKET_WRITE_METHODDEF
2995 _SSL__SSLSOCKET_READ_METHODDEF
2996 _SSL__SSLSOCKET_PENDING_METHODDEF
Christian Heimes141c5e82018-02-24 21:10:57 +01002997 _SSL__SSLSOCKET_GETPEERCERT_METHODDEF
2998 _SSL__SSLSOCKET_GET_CHANNEL_BINDING_METHODDEF
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03002999 _SSL__SSLSOCKET_CIPHER_METHODDEF
3000 _SSL__SSLSOCKET_SHARED_CIPHERS_METHODDEF
3001 _SSL__SSLSOCKET_VERSION_METHODDEF
3002 _SSL__SSLSOCKET_SELECTED_NPN_PROTOCOL_METHODDEF
3003 _SSL__SSLSOCKET_SELECTED_ALPN_PROTOCOL_METHODDEF
3004 _SSL__SSLSOCKET_COMPRESSION_METHODDEF
3005 _SSL__SSLSOCKET_SHUTDOWN_METHODDEF
Christian Heimes9fb051f2018-09-23 08:32:31 +02003006 _SSL__SSLSOCKET_VERIFY_CLIENT_POST_HANDSHAKE_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003007 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003008};
3009
Antoine Pitrou152efa22010-05-16 18:19:27 +00003010static PyTypeObject PySSLSocket_Type = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003011 PyVarObject_HEAD_INIT(NULL, 0)
Antoine Pitrou152efa22010-05-16 18:19:27 +00003012 "_ssl._SSLSocket", /*tp_name*/
3013 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003014 0, /*tp_itemsize*/
3015 /* methods */
3016 (destructor)PySSL_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003017 0, /*tp_vectorcall_offset*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003018 0, /*tp_getattr*/
3019 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02003020 0, /*tp_as_async*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003021 0, /*tp_repr*/
3022 0, /*tp_as_number*/
3023 0, /*tp_as_sequence*/
3024 0, /*tp_as_mapping*/
3025 0, /*tp_hash*/
3026 0, /*tp_call*/
3027 0, /*tp_str*/
3028 0, /*tp_getattro*/
3029 0, /*tp_setattro*/
3030 0, /*tp_as_buffer*/
3031 Py_TPFLAGS_DEFAULT, /*tp_flags*/
3032 0, /*tp_doc*/
Christian Heimesc7f70692019-05-31 11:44:05 +02003033 (traverseproc) PySSL_traverse, /*tp_traverse*/
3034 (inquiry) PySSL_clear, /*tp_clear*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003035 0, /*tp_richcompare*/
3036 0, /*tp_weaklistoffset*/
3037 0, /*tp_iter*/
3038 0, /*tp_iternext*/
3039 PySSLMethods, /*tp_methods*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003040 0, /*tp_members*/
3041 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003042};
3043
Antoine Pitrou152efa22010-05-16 18:19:27 +00003044
3045/*
3046 * _SSLContext objects
3047 */
3048
Christian Heimes5fe668c2016-09-12 00:01:11 +02003049static int
Christian Heimes9fb051f2018-09-23 08:32:31 +02003050_set_verify_mode(PySSLContext *self, enum py_ssl_cert_requirements n)
Christian Heimes5fe668c2016-09-12 00:01:11 +02003051{
3052 int mode;
3053 int (*verify_cb)(int, X509_STORE_CTX *) = NULL;
3054
3055 switch(n) {
3056 case PY_SSL_CERT_NONE:
3057 mode = SSL_VERIFY_NONE;
3058 break;
3059 case PY_SSL_CERT_OPTIONAL:
3060 mode = SSL_VERIFY_PEER;
3061 break;
3062 case PY_SSL_CERT_REQUIRED:
3063 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
3064 break;
3065 default:
3066 PyErr_SetString(PyExc_ValueError,
3067 "invalid value for verify_mode");
3068 return -1;
3069 }
Christian Heimesf0f59302019-07-01 08:29:17 +02003070
3071 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3072 * server sockets and SSL_set_post_handshake_auth() for client. */
3073
Christian Heimes5fe668c2016-09-12 00:01:11 +02003074 /* keep current verify cb */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003075 verify_cb = SSL_CTX_get_verify_callback(self->ctx);
3076 SSL_CTX_set_verify(self->ctx, mode, verify_cb);
Christian Heimes5fe668c2016-09-12 00:01:11 +02003077 return 0;
3078}
3079
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003080/*[clinic input]
3081@classmethod
3082_ssl._SSLContext.__new__
3083 protocol as proto_version: int
3084 /
3085[clinic start generated code]*/
3086
Antoine Pitrou152efa22010-05-16 18:19:27 +00003087static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003088_ssl__SSLContext_impl(PyTypeObject *type, int proto_version)
3089/*[clinic end generated code: output=2cf0d7a0741b6bd1 input=8d58a805b95fc534]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003090{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003091 PySSLContext *self;
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003092 long options;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003093 SSL_CTX *ctx = NULL;
Christian Heimes61d478c2018-01-27 15:51:38 +01003094 X509_VERIFY_PARAM *params;
Christian Heimes358cfd42016-09-10 22:43:48 +02003095 int result;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003096#if defined(SSL_MODE_RELEASE_BUFFERS)
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003097 unsigned long libver;
Berker Peksagdfcb0412016-04-14 16:48:48 +03003098#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003099
Antoine Pitrou152efa22010-05-16 18:19:27 +00003100 PySSL_BEGIN_ALLOW_THREADS
Christian Heimes6e8cda92020-05-16 03:33:05 +02003101 switch(proto_version) {
3102#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
3103 case PY_SSL_VERSION_SSL3:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003104 ctx = SSL_CTX_new(SSLv3_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003105 break;
Benjamin Petersone32467c2014-12-05 21:59:35 -05003106#endif
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07003107#if (defined(TLS1_VERSION) && \
3108 !defined(OPENSSL_NO_TLS1) && \
3109 !defined(OPENSSL_NO_TLS1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003110 case PY_SSL_VERSION_TLS1:
3111 ctx = SSL_CTX_new(TLSv1_method());
3112 break;
Victor Stinner3de49192011-05-09 00:42:58 +02003113#endif
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07003114#if (defined(TLS1_1_VERSION) && \
3115 !defined(OPENSSL_NO_TLS1_1) && \
3116 !defined(OPENSSL_NO_TLS1_1_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003117 case PY_SSL_VERSION_TLS1_1:
3118 ctx = SSL_CTX_new(TLSv1_1_method());
3119 break;
3120#endif
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07003121#if (defined(TLS1_2_VERSION) && \
3122 !defined(OPENSSL_NO_TLS1_2) && \
3123 !defined(OPENSSL_NO_TLS1_2_METHOD))
Christian Heimes6e8cda92020-05-16 03:33:05 +02003124 case PY_SSL_VERSION_TLS1_2:
3125 ctx = SSL_CTX_new(TLSv1_2_method());
3126 break;
3127#endif
3128 case PY_SSL_VERSION_TLS:
3129 /* SSLv23 */
Christian Heimes598894f2016-09-05 23:19:05 +02003130 ctx = SSL_CTX_new(TLS_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003131 break;
3132 case PY_SSL_VERSION_TLS_CLIENT:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003133 ctx = SSL_CTX_new(TLS_client_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003134 break;
3135 case PY_SSL_VERSION_TLS_SERVER:
Christian Heimes5fe668c2016-09-12 00:01:11 +02003136 ctx = SSL_CTX_new(TLS_server_method());
Christian Heimes6e8cda92020-05-16 03:33:05 +02003137 break;
3138 default:
Antoine Pitrou152efa22010-05-16 18:19:27 +00003139 proto_version = -1;
Christian Heimes6e8cda92020-05-16 03:33:05 +02003140 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003141 PySSL_END_ALLOW_THREADS
3142
3143 if (proto_version == -1) {
3144 PyErr_SetString(PyExc_ValueError,
Christian Heimes6e8cda92020-05-16 03:33:05 +02003145 "invalid or unsupported protocol version");
Antoine Pitrou152efa22010-05-16 18:19:27 +00003146 return NULL;
3147 }
3148 if (ctx == NULL) {
Christian Heimes17c9ac92017-09-07 14:14:00 -07003149 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003150 return NULL;
3151 }
3152
3153 assert(type != NULL && type->tp_alloc != NULL);
3154 self = (PySSLContext *) type->tp_alloc(type, 0);
3155 if (self == NULL) {
3156 SSL_CTX_free(ctx);
3157 return NULL;
3158 }
3159 self->ctx = ctx;
Christian Heimes61d478c2018-01-27 15:51:38 +01003160 self->hostflags = X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS;
Christian Heimes11a14932018-02-24 02:35:08 +01003161 self->protocol = proto_version;
Christian Heimesc7f70692019-05-31 11:44:05 +02003162 self->msg_cb = NULL;
3163#ifdef HAVE_OPENSSL_KEYLOG
3164 self->keylog_filename = NULL;
3165 self->keylog_bio = NULL;
3166#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003167#if HAVE_NPN
Christian Heimes5cb31c92012-09-20 12:42:54 +02003168 self->npn_protocols = NULL;
3169#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003170#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003171 self->alpn_protocols = NULL;
3172#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003173#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003174 self->set_sni_cb = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003175#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01003176 /* Don't check host name by default */
Christian Heimes5fe668c2016-09-12 00:01:11 +02003177 if (proto_version == PY_SSL_VERSION_TLS_CLIENT) {
3178 self->check_hostname = 1;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003179 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003180 Py_DECREF(self);
3181 return NULL;
3182 }
3183 } else {
3184 self->check_hostname = 0;
Christian Heimes9fb051f2018-09-23 08:32:31 +02003185 if (_set_verify_mode(self, PY_SSL_CERT_NONE) == -1) {
Christian Heimes5fe668c2016-09-12 00:01:11 +02003186 Py_DECREF(self);
3187 return NULL;
3188 }
3189 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003190 /* Defaults */
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003191 options = SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS;
3192 if (proto_version != PY_SSL_VERSION_SSL2)
3193 options |= SSL_OP_NO_SSLv2;
Benjamin Petersona9dcdab2015-11-11 22:38:41 -08003194 if (proto_version != PY_SSL_VERSION_SSL3)
3195 options |= SSL_OP_NO_SSLv3;
Christian Heimes358cfd42016-09-10 22:43:48 +02003196 /* Minimal security flags for server and client side context.
3197 * Client sockets ignore server-side parameters. */
3198#ifdef SSL_OP_NO_COMPRESSION
3199 options |= SSL_OP_NO_COMPRESSION;
3200#endif
3201#ifdef SSL_OP_CIPHER_SERVER_PREFERENCE
3202 options |= SSL_OP_CIPHER_SERVER_PREFERENCE;
3203#endif
3204#ifdef SSL_OP_SINGLE_DH_USE
3205 options |= SSL_OP_SINGLE_DH_USE;
3206#endif
3207#ifdef SSL_OP_SINGLE_ECDH_USE
3208 options |= SSL_OP_SINGLE_ECDH_USE;
3209#endif
Antoine Pitroucd3d7ca2014-01-09 20:02:20 +01003210 SSL_CTX_set_options(self->ctx, options);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003211
Semen Zhydenko1295e112017-10-15 21:28:31 +02003212 /* A bare minimum cipher list without completely broken cipher suites.
Christian Heimes358cfd42016-09-10 22:43:48 +02003213 * It's far from perfect but gives users a better head start. */
3214 if (proto_version != PY_SSL_VERSION_SSL2) {
Christian Heimes892d66e2018-01-29 14:10:18 +01003215#if PY_SSL_DEFAULT_CIPHERS == 2
3216 /* stick to OpenSSL's default settings */
3217 result = 1;
3218#else
3219 result = SSL_CTX_set_cipher_list(ctx, PY_SSL_DEFAULT_CIPHER_STRING);
3220#endif
Christian Heimes358cfd42016-09-10 22:43:48 +02003221 } else {
3222 /* SSLv2 needs MD5 */
3223 result = SSL_CTX_set_cipher_list(ctx, "HIGH:!aNULL:!eNULL");
3224 }
3225 if (result == 0) {
3226 Py_DECREF(self);
3227 ERR_clear_error();
3228 PyErr_SetString(PySSLErrorObject,
3229 "No cipher can be selected.");
3230 return NULL;
3231 }
3232
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003233#if defined(SSL_MODE_RELEASE_BUFFERS)
3234 /* Set SSL_MODE_RELEASE_BUFFERS. This potentially greatly reduces memory
3235 usage for no cost at all. However, don't do this for OpenSSL versions
3236 between 1.0.1 and 1.0.1h or 1.0.0 and 1.0.0m, which are affected by CVE
3237 2014-0198. I can't find exactly which beta fixed this CVE, so be
3238 conservative and assume it wasn't fixed until release. We do this check
3239 at runtime to avoid problems from the dynamic linker.
3240 See #25672 for more on this. */
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07003241 libver = OpenSSL_version_num();
Benjamin Peterson3b1a8b32016-01-07 21:37:37 -08003242 if (!(libver >= 0x10001000UL && libver < 0x1000108fUL) &&
3243 !(libver >= 0x10000000UL && libver < 0x100000dfUL)) {
3244 SSL_CTX_set_mode(self->ctx, SSL_MODE_RELEASE_BUFFERS);
3245 }
3246#endif
3247
3248
Donald Stufft8ae264c2017-03-02 11:45:29 -05003249#if !defined(OPENSSL_NO_ECDH) && !defined(OPENSSL_VERSION_1_1)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003250 /* Allow automatic ECDH curve selection (on OpenSSL 1.0.2+), or use
3251 prime256v1 by default. This is Apache mod_ssl's initialization
Christian Heimes598894f2016-09-05 23:19:05 +02003252 policy, so we should be safe. OpenSSL 1.1 has it enabled by default.
3253 */
Donald Stufft8ae264c2017-03-02 11:45:29 -05003254#if defined(SSL_CTX_set_ecdh_auto)
Antoine Pitrou0bebbc32014-03-22 18:13:50 +01003255 SSL_CTX_set_ecdh_auto(self->ctx, 1);
3256#else
3257 {
3258 EC_KEY *key = EC_KEY_new_by_curve_name(NID_X9_62_prime256v1);
3259 SSL_CTX_set_tmp_ecdh(self->ctx, key);
3260 EC_KEY_free(key);
3261 }
3262#endif
3263#endif
3264
Antoine Pitroufc113ee2010-10-13 12:46:13 +00003265#define SID_CTX "Python"
3266 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
3267 sizeof(SID_CTX));
3268#undef SID_CTX
3269
Christian Heimes61d478c2018-01-27 15:51:38 +01003270 params = SSL_CTX_get0_param(self->ctx);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003271#ifdef X509_V_FLAG_TRUSTED_FIRST
Christian Heimes61d478c2018-01-27 15:51:38 +01003272 /* Improve trust chain building when cross-signed intermediate
3273 certificates are present. See https://bugs.python.org/issue23476. */
3274 X509_VERIFY_PARAM_set_flags(params, X509_V_FLAG_TRUSTED_FIRST);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003275#endif
Christian Heimes61d478c2018-01-27 15:51:38 +01003276 X509_VERIFY_PARAM_set_hostflags(params, self->hostflags);
Benjamin Petersonfdb19712015-03-04 22:11:12 -05003277
Christian Heimes9fb051f2018-09-23 08:32:31 +02003278#ifdef TLS1_3_VERSION
3279 self->post_handshake_auth = 0;
3280 SSL_CTX_set_post_handshake_auth(self->ctx, self->post_handshake_auth);
3281#endif
3282
Antoine Pitrou152efa22010-05-16 18:19:27 +00003283 return (PyObject *)self;
3284}
3285
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003286static int
3287context_traverse(PySSLContext *self, visitproc visit, void *arg)
3288{
3289#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003290 Py_VISIT(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003291#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003292 Py_VISIT(self->msg_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003293 return 0;
3294}
3295
3296static int
3297context_clear(PySSLContext *self)
3298{
3299#ifndef OPENSSL_NO_TLSEXT
Christian Heimes11a14932018-02-24 02:35:08 +01003300 Py_CLEAR(self->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003301#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02003302 Py_CLEAR(self->msg_cb);
3303#ifdef HAVE_OPENSSL_KEYLOG
3304 Py_CLEAR(self->keylog_filename);
3305 if (self->keylog_bio != NULL) {
3306 PySSL_BEGIN_ALLOW_THREADS
3307 BIO_free_all(self->keylog_bio);
3308 PySSL_END_ALLOW_THREADS
3309 self->keylog_bio = NULL;
3310 }
3311#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003312 return 0;
3313}
3314
Antoine Pitrou152efa22010-05-16 18:19:27 +00003315static void
3316context_dealloc(PySSLContext *self)
3317{
INADA Naokia6296d32017-08-24 14:55:17 +09003318 /* bpo-31095: UnTrack is needed before calling any callbacks */
3319 PyObject_GC_UnTrack(self);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003320 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003321 SSL_CTX_free(self->ctx);
Christian Heimes29eab552018-02-25 12:31:33 +01003322#if HAVE_NPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003323 PyMem_FREE(self->npn_protocols);
3324#endif
Christian Heimes29eab552018-02-25 12:31:33 +01003325#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003326 PyMem_FREE(self->alpn_protocols);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003327#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003328 Py_TYPE(self)->tp_free(self);
3329}
3330
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003331/*[clinic input]
3332_ssl._SSLContext.set_ciphers
3333 cipherlist: str
3334 /
3335[clinic start generated code]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003336
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003337static PyObject *
3338_ssl__SSLContext_set_ciphers_impl(PySSLContext *self, const char *cipherlist)
3339/*[clinic end generated code: output=3a3162f3557c0f3f input=a7ac931b9f3ca7fc]*/
3340{
3341 int ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003342 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00003343 /* Clearing the error queue is necessary on some OpenSSL versions,
3344 otherwise the error will be reported again when another SSL call
3345 is done. */
3346 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003347 PyErr_SetString(PySSLErrorObject,
3348 "No cipher can be selected.");
3349 return NULL;
3350 }
3351 Py_RETURN_NONE;
3352}
3353
Christian Heimes25bfcd52016-09-06 00:04:45 +02003354#if OPENSSL_VERSION_NUMBER >= 0x10002000UL
3355/*[clinic input]
3356_ssl._SSLContext.get_ciphers
3357[clinic start generated code]*/
3358
3359static PyObject *
3360_ssl__SSLContext_get_ciphers_impl(PySSLContext *self)
3361/*[clinic end generated code: output=a56e4d68a406dfc4 input=a2aadc9af89b79c5]*/
3362{
3363 SSL *ssl = NULL;
3364 STACK_OF(SSL_CIPHER) *sk = NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02003365 const SSL_CIPHER *cipher;
Christian Heimes25bfcd52016-09-06 00:04:45 +02003366 int i=0;
3367 PyObject *result = NULL, *dct;
3368
3369 ssl = SSL_new(self->ctx);
3370 if (ssl == NULL) {
3371 _setSSLError(NULL, 0, __FILE__, __LINE__);
3372 goto exit;
3373 }
3374 sk = SSL_get_ciphers(ssl);
3375
3376 result = PyList_New(sk_SSL_CIPHER_num(sk));
3377 if (result == NULL) {
3378 goto exit;
3379 }
3380
3381 for (i = 0; i < sk_SSL_CIPHER_num(sk); i++) {
3382 cipher = sk_SSL_CIPHER_value(sk, i);
3383 dct = cipher_to_dict(cipher);
3384 if (dct == NULL) {
3385 Py_CLEAR(result);
3386 goto exit;
3387 }
3388 PyList_SET_ITEM(result, i, dct);
3389 }
3390
3391 exit:
3392 if (ssl != NULL)
3393 SSL_free(ssl);
3394 return result;
3395
3396}
3397#endif
3398
3399
Christian Heimes29eab552018-02-25 12:31:33 +01003400#if HAVE_NPN || HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003401static int
Benjamin Peterson88615022015-01-23 17:30:26 -05003402do_protocol_selection(int alpn, unsigned char **out, unsigned char *outlen,
3403 const unsigned char *server_protocols, unsigned int server_protocols_len,
3404 const unsigned char *client_protocols, unsigned int client_protocols_len)
Benjamin Petersoncca27322015-01-23 16:35:37 -05003405{
Benjamin Peterson88615022015-01-23 17:30:26 -05003406 int ret;
3407 if (client_protocols == NULL) {
3408 client_protocols = (unsigned char *)"";
3409 client_protocols_len = 0;
3410 }
3411 if (server_protocols == NULL) {
3412 server_protocols = (unsigned char *)"";
3413 server_protocols_len = 0;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003414 }
3415
Benjamin Peterson88615022015-01-23 17:30:26 -05003416 ret = SSL_select_next_proto(out, outlen,
3417 server_protocols, server_protocols_len,
3418 client_protocols, client_protocols_len);
3419 if (alpn && ret != OPENSSL_NPN_NEGOTIATED)
3420 return SSL_TLSEXT_ERR_NOACK;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003421
3422 return SSL_TLSEXT_ERR_OK;
3423}
Melvyn Sopacuab2d096b2017-09-04 23:35:15 +02003424#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05003425
Christian Heimes29eab552018-02-25 12:31:33 +01003426#if HAVE_NPN
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003427/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
3428static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003429_advertiseNPN_cb(SSL *s,
3430 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003431 void *args)
3432{
3433 PySSLContext *ssl_ctx = (PySSLContext *) args;
3434
3435 if (ssl_ctx->npn_protocols == NULL) {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003436 *data = (unsigned char *)"";
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003437 *len = 0;
3438 } else {
Benjamin Petersoncca27322015-01-23 16:35:37 -05003439 *data = ssl_ctx->npn_protocols;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003440 *len = ssl_ctx->npn_protocols_len;
3441 }
3442
3443 return SSL_TLSEXT_ERR_OK;
3444}
3445/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
3446static int
Victor Stinner4569cd52013-06-23 14:58:43 +02003447_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003448 unsigned char **out, unsigned char *outlen,
3449 const unsigned char *server, unsigned int server_len,
3450 void *args)
3451{
Benjamin Petersoncca27322015-01-23 16:35:37 -05003452 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003453 return do_protocol_selection(0, out, outlen, server, server_len,
Benjamin Petersoncca27322015-01-23 16:35:37 -05003454 ctx->npn_protocols, ctx->npn_protocols_len);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003455}
3456#endif
3457
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003458/*[clinic input]
3459_ssl._SSLContext._set_npn_protocols
3460 protos: Py_buffer
3461 /
3462[clinic start generated code]*/
3463
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003464static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003465_ssl__SSLContext__set_npn_protocols_impl(PySSLContext *self,
3466 Py_buffer *protos)
3467/*[clinic end generated code: output=72b002c3324390c6 input=319fcb66abf95bd7]*/
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003468{
Christian Heimes29eab552018-02-25 12:31:33 +01003469#if HAVE_NPN
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003470 PyMem_Free(self->npn_protocols);
3471 self->npn_protocols = PyMem_Malloc(protos->len);
3472 if (self->npn_protocols == NULL)
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003473 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003474 memcpy(self->npn_protocols, protos->buf, protos->len);
3475 self->npn_protocols_len = (int) protos->len;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003476
3477 /* set both server and client callbacks, because the context can
3478 * be used to create both types of sockets */
3479 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
3480 _advertiseNPN_cb,
3481 self);
3482 SSL_CTX_set_next_proto_select_cb(self->ctx,
3483 _selectNPN_cb,
3484 self);
3485
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003486 Py_RETURN_NONE;
3487#else
3488 PyErr_SetString(PyExc_NotImplementedError,
3489 "The NPN extension requires OpenSSL 1.0.1 or later.");
3490 return NULL;
3491#endif
3492}
3493
Christian Heimes29eab552018-02-25 12:31:33 +01003494#if HAVE_ALPN
Benjamin Petersoncca27322015-01-23 16:35:37 -05003495static int
3496_selectALPN_cb(SSL *s,
3497 const unsigned char **out, unsigned char *outlen,
3498 const unsigned char *client_protocols, unsigned int client_protocols_len,
3499 void *args)
3500{
3501 PySSLContext *ctx = (PySSLContext *)args;
Benjamin Peterson88615022015-01-23 17:30:26 -05003502 return do_protocol_selection(1, (unsigned char **)out, outlen,
3503 ctx->alpn_protocols, ctx->alpn_protocols_len,
3504 client_protocols, client_protocols_len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003505}
3506#endif
3507
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003508/*[clinic input]
3509_ssl._SSLContext._set_alpn_protocols
3510 protos: Py_buffer
3511 /
3512[clinic start generated code]*/
3513
Benjamin Petersoncca27322015-01-23 16:35:37 -05003514static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003515_ssl__SSLContext__set_alpn_protocols_impl(PySSLContext *self,
3516 Py_buffer *protos)
3517/*[clinic end generated code: output=87599a7f76651a9b input=9bba964595d519be]*/
Benjamin Petersoncca27322015-01-23 16:35:37 -05003518{
Christian Heimes29eab552018-02-25 12:31:33 +01003519#if HAVE_ALPN
Victor Stinner5a615592017-09-14 01:10:30 -07003520 if ((size_t)protos->len > UINT_MAX) {
Segev Finer5cff6372017-07-27 01:19:17 +03003521 PyErr_Format(PyExc_OverflowError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02003522 "protocols longer than %u bytes", UINT_MAX);
Segev Finer5cff6372017-07-27 01:19:17 +03003523 return NULL;
3524 }
3525
Benjamin Petersoncca27322015-01-23 16:35:37 -05003526 PyMem_FREE(self->alpn_protocols);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003527 self->alpn_protocols = PyMem_Malloc(protos->len);
Benjamin Petersoncca27322015-01-23 16:35:37 -05003528 if (!self->alpn_protocols)
3529 return PyErr_NoMemory();
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003530 memcpy(self->alpn_protocols, protos->buf, protos->len);
Segev Finer5cff6372017-07-27 01:19:17 +03003531 self->alpn_protocols_len = (unsigned int)protos->len;
Benjamin Petersoncca27322015-01-23 16:35:37 -05003532
3533 if (SSL_CTX_set_alpn_protos(self->ctx, self->alpn_protocols, self->alpn_protocols_len))
3534 return PyErr_NoMemory();
3535 SSL_CTX_set_alpn_select_cb(self->ctx, _selectALPN_cb, self);
3536
Benjamin Petersoncca27322015-01-23 16:35:37 -05003537 Py_RETURN_NONE;
3538#else
3539 PyErr_SetString(PyExc_NotImplementedError,
3540 "The ALPN extension requires OpenSSL 1.0.2 or later.");
3541 return NULL;
3542#endif
3543}
3544
Antoine Pitrou152efa22010-05-16 18:19:27 +00003545static PyObject *
3546get_verify_mode(PySSLContext *self, void *c)
3547{
Christian Heimes9fb051f2018-09-23 08:32:31 +02003548 /* ignore SSL_VERIFY_CLIENT_ONCE and SSL_VERIFY_POST_HANDSHAKE */
3549 int mask = (SSL_VERIFY_NONE | SSL_VERIFY_PEER |
3550 SSL_VERIFY_FAIL_IF_NO_PEER_CERT);
3551 switch (SSL_CTX_get_verify_mode(self->ctx) & mask) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00003552 case SSL_VERIFY_NONE:
3553 return PyLong_FromLong(PY_SSL_CERT_NONE);
3554 case SSL_VERIFY_PEER:
3555 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
3556 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
3557 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
3558 }
3559 PyErr_SetString(PySSLErrorObject,
3560 "invalid return value from SSL_CTX_get_verify_mode");
3561 return NULL;
3562}
3563
3564static int
3565set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
3566{
Christian Heimes5fe668c2016-09-12 00:01:11 +02003567 int n;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003568 if (!PyArg_Parse(arg, "i", &n))
3569 return -1;
Christian Heimes5fe668c2016-09-12 00:01:11 +02003570 if (n == PY_SSL_CERT_NONE && self->check_hostname) {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003571 PyErr_SetString(PyExc_ValueError,
3572 "Cannot set verify_mode to CERT_NONE when "
3573 "check_hostname is enabled.");
3574 return -1;
3575 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003576 return _set_verify_mode(self, n);
Antoine Pitrou152efa22010-05-16 18:19:27 +00003577}
3578
3579static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01003580get_verify_flags(PySSLContext *self, void *c)
3581{
Christian Heimes598894f2016-09-05 23:19:05 +02003582 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003583 unsigned long flags;
3584
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 return PyLong_FromUnsignedLong(flags);
3588}
3589
3590static int
3591set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
3592{
Christian Heimes598894f2016-09-05 23:19:05 +02003593 X509_VERIFY_PARAM *param;
Christian Heimes22587792013-11-21 23:56:13 +01003594 unsigned long new_flags, flags, set, clear;
3595
3596 if (!PyArg_Parse(arg, "k", &new_flags))
3597 return -1;
Christian Heimes61d478c2018-01-27 15:51:38 +01003598 param = SSL_CTX_get0_param(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02003599 flags = X509_VERIFY_PARAM_get_flags(param);
Christian Heimes22587792013-11-21 23:56:13 +01003600 clear = flags & ~new_flags;
3601 set = ~flags & new_flags;
3602 if (clear) {
Christian Heimes598894f2016-09-05 23:19:05 +02003603 if (!X509_VERIFY_PARAM_clear_flags(param, clear)) {
Christian Heimes22587792013-11-21 23:56:13 +01003604 _setSSLError(NULL, 0, __FILE__, __LINE__);
3605 return -1;
3606 }
3607 }
3608 if (set) {
Christian Heimes598894f2016-09-05 23:19:05 +02003609 if (!X509_VERIFY_PARAM_set_flags(param, set)) {
Christian Heimes22587792013-11-21 23:56:13 +01003610 _setSSLError(NULL, 0, __FILE__, __LINE__);
3611 return -1;
3612 }
3613 }
3614 return 0;
3615}
3616
Christian Heimes698dde12018-02-27 11:54:43 +01003617/* Getter and setter for protocol version */
3618#if defined(SSL_CTRL_GET_MAX_PROTO_VERSION)
3619
3620
3621static int
3622set_min_max_proto_version(PySSLContext *self, PyObject *arg, int what)
3623{
3624 long v;
3625 int result;
3626
3627 if (!PyArg_Parse(arg, "l", &v))
3628 return -1;
3629 if (v > INT_MAX) {
3630 PyErr_SetString(PyExc_OverflowError, "Option is too long");
3631 return -1;
3632 }
3633
3634 switch(self->protocol) {
3635 case PY_SSL_VERSION_TLS_CLIENT: /* fall through */
3636 case PY_SSL_VERSION_TLS_SERVER: /* fall through */
3637 case PY_SSL_VERSION_TLS:
3638 break;
3639 default:
3640 PyErr_SetString(
3641 PyExc_ValueError,
3642 "The context's protocol doesn't support modification of "
3643 "highest and lowest version."
3644 );
3645 return -1;
3646 }
3647
3648 if (what == 0) {
3649 switch(v) {
3650 case PY_PROTO_MINIMUM_SUPPORTED:
3651 v = 0;
3652 break;
3653 case PY_PROTO_MAXIMUM_SUPPORTED:
3654 /* Emulate max for set_min_proto_version */
3655 v = PY_PROTO_MAXIMUM_AVAILABLE;
3656 break;
3657 default:
3658 break;
3659 }
3660 result = SSL_CTX_set_min_proto_version(self->ctx, v);
3661 }
3662 else {
3663 switch(v) {
3664 case PY_PROTO_MAXIMUM_SUPPORTED:
3665 v = 0;
3666 break;
3667 case PY_PROTO_MINIMUM_SUPPORTED:
3668 /* Emulate max for set_min_proto_version */
3669 v = PY_PROTO_MINIMUM_AVAILABLE;
3670 break;
3671 default:
3672 break;
3673 }
3674 result = SSL_CTX_set_max_proto_version(self->ctx, v);
3675 }
3676 if (result == 0) {
3677 PyErr_Format(PyExc_ValueError,
3678 "Unsupported protocol version 0x%x", v);
3679 return -1;
3680 }
3681 return 0;
3682}
3683
3684static PyObject *
3685get_minimum_version(PySSLContext *self, void *c)
3686{
3687 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MIN_PROTO_VERSION, 0, NULL);
3688 if (v == 0) {
3689 v = PY_PROTO_MINIMUM_SUPPORTED;
3690 }
3691 return PyLong_FromLong(v);
3692}
3693
3694static int
3695set_minimum_version(PySSLContext *self, PyObject *arg, void *c)
3696{
3697 return set_min_max_proto_version(self, arg, 0);
3698}
3699
3700static PyObject *
3701get_maximum_version(PySSLContext *self, void *c)
3702{
3703 int v = SSL_CTX_ctrl(self->ctx, SSL_CTRL_GET_MAX_PROTO_VERSION, 0, NULL);
3704 if (v == 0) {
3705 v = PY_PROTO_MAXIMUM_SUPPORTED;
3706 }
3707 return PyLong_FromLong(v);
3708}
3709
3710static int
3711set_maximum_version(PySSLContext *self, PyObject *arg, void *c)
3712{
3713 return set_min_max_proto_version(self, arg, 1);
3714}
3715#endif /* SSL_CTRL_GET_MAX_PROTO_VERSION */
3716
Christian Heimes78c7d522019-06-03 21:00:10 +02003717#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
3718static PyObject *
3719get_num_tickets(PySSLContext *self, void *c)
3720{
Victor Stinner76611c72019-07-09 13:30:52 +02003721 return PyLong_FromSize_t(SSL_CTX_get_num_tickets(self->ctx));
Christian Heimes78c7d522019-06-03 21:00:10 +02003722}
3723
3724static int
3725set_num_tickets(PySSLContext *self, PyObject *arg, void *c)
3726{
3727 long num;
3728 if (!PyArg_Parse(arg, "l", &num))
3729 return -1;
3730 if (num < 0) {
3731 PyErr_SetString(PyExc_ValueError, "value must be non-negative");
3732 return -1;
3733 }
3734 if (self->protocol != PY_SSL_VERSION_TLS_SERVER) {
3735 PyErr_SetString(PyExc_ValueError,
3736 "SSLContext is not a server context.");
3737 return -1;
3738 }
3739 if (SSL_CTX_set_num_tickets(self->ctx, num) != 1) {
3740 PyErr_SetString(PyExc_ValueError, "failed to set num tickets.");
3741 return -1;
3742 }
3743 return 0;
3744}
3745
3746PyDoc_STRVAR(PySSLContext_num_tickets_doc,
3747"Control the number of TLSv1.3 session tickets");
3748#endif /* OpenSSL 1.1.1 */
3749
Christian Heimes22587792013-11-21 23:56:13 +01003750static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00003751get_options(PySSLContext *self, void *c)
3752{
3753 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
3754}
3755
3756static int
3757set_options(PySSLContext *self, PyObject *arg, void *c)
3758{
3759 long new_opts, opts, set, clear;
3760 if (!PyArg_Parse(arg, "l", &new_opts))
3761 return -1;
3762 opts = SSL_CTX_get_options(self->ctx);
3763 clear = opts & ~new_opts;
3764 set = ~opts & new_opts;
3765 if (clear) {
3766#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
3767 SSL_CTX_clear_options(self->ctx, clear);
3768#else
3769 PyErr_SetString(PyExc_ValueError,
3770 "can't clear options before OpenSSL 0.9.8m");
3771 return -1;
3772#endif
3773 }
3774 if (set)
3775 SSL_CTX_set_options(self->ctx, set);
3776 return 0;
3777}
3778
Christian Heimes1aa9a752013-12-02 02:41:19 +01003779static PyObject *
Christian Heimes61d478c2018-01-27 15:51:38 +01003780get_host_flags(PySSLContext *self, void *c)
3781{
3782 return PyLong_FromUnsignedLong(self->hostflags);
3783}
3784
3785static int
3786set_host_flags(PySSLContext *self, PyObject *arg, void *c)
3787{
3788 X509_VERIFY_PARAM *param;
3789 unsigned int new_flags = 0;
3790
3791 if (!PyArg_Parse(arg, "I", &new_flags))
3792 return -1;
3793
3794 param = SSL_CTX_get0_param(self->ctx);
3795 self->hostflags = new_flags;
3796 X509_VERIFY_PARAM_set_hostflags(param, new_flags);
3797 return 0;
3798}
3799
3800static PyObject *
Christian Heimes1aa9a752013-12-02 02:41:19 +01003801get_check_hostname(PySSLContext *self, void *c)
3802{
3803 return PyBool_FromLong(self->check_hostname);
3804}
3805
3806static int
3807set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
3808{
3809 int check_hostname;
3810 if (!PyArg_Parse(arg, "p", &check_hostname))
3811 return -1;
3812 if (check_hostname &&
3813 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
Christian Heimese82c0342017-09-15 20:29:57 +02003814 /* check_hostname = True sets verify_mode = CERT_REQUIRED */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003815 if (_set_verify_mode(self, PY_SSL_CERT_REQUIRED) == -1) {
Christian Heimese82c0342017-09-15 20:29:57 +02003816 return -1;
3817 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01003818 }
3819 self->check_hostname = check_hostname;
3820 return 0;
3821}
3822
Christian Heimes11a14932018-02-24 02:35:08 +01003823static PyObject *
Christian Heimes9fb051f2018-09-23 08:32:31 +02003824get_post_handshake_auth(PySSLContext *self, void *c) {
3825#if TLS1_3_VERSION
3826 return PyBool_FromLong(self->post_handshake_auth);
3827#else
3828 Py_RETURN_NONE;
3829#endif
3830}
3831
3832#if TLS1_3_VERSION
3833static int
3834set_post_handshake_auth(PySSLContext *self, PyObject *arg, void *c) {
Zackery Spytz842acaa2018-12-17 07:52:45 -07003835 if (arg == NULL) {
3836 PyErr_SetString(PyExc_AttributeError, "cannot delete attribute");
3837 return -1;
3838 }
Christian Heimes9fb051f2018-09-23 08:32:31 +02003839 int pha = PyObject_IsTrue(arg);
3840
3841 if (pha == -1) {
3842 return -1;
3843 }
3844 self->post_handshake_auth = pha;
3845
Christian Heimesf0f59302019-07-01 08:29:17 +02003846 /* bpo-37428: newPySSLSocket() sets SSL_VERIFY_POST_HANDSHAKE flag for
3847 * server sockets and SSL_set_post_handshake_auth() for client. */
Christian Heimes9fb051f2018-09-23 08:32:31 +02003848
3849 return 0;
3850}
3851#endif
3852
3853static PyObject *
Christian Heimes11a14932018-02-24 02:35:08 +01003854get_protocol(PySSLContext *self, void *c) {
3855 return PyLong_FromLong(self->protocol);
3856}
Christian Heimes1aa9a752013-12-02 02:41:19 +01003857
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003858typedef struct {
3859 PyThreadState *thread_state;
3860 PyObject *callable;
3861 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02003862 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003863 int error;
3864} _PySSLPasswordInfo;
3865
3866static int
3867_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
3868 const char *bad_type_error)
3869{
3870 /* Set the password and size fields of a _PySSLPasswordInfo struct
3871 from a unicode, bytes, or byte array object.
3872 The password field will be dynamically allocated and must be freed
3873 by the caller */
3874 PyObject *password_bytes = NULL;
3875 const char *data = NULL;
3876 Py_ssize_t size;
3877
3878 if (PyUnicode_Check(password)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003879 password_bytes = PyUnicode_AsUTF8String(password);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003880 if (!password_bytes) {
3881 goto error;
3882 }
3883 data = PyBytes_AS_STRING(password_bytes);
3884 size = PyBytes_GET_SIZE(password_bytes);
3885 } else if (PyBytes_Check(password)) {
3886 data = PyBytes_AS_STRING(password);
3887 size = PyBytes_GET_SIZE(password);
3888 } else if (PyByteArray_Check(password)) {
3889 data = PyByteArray_AS_STRING(password);
3890 size = PyByteArray_GET_SIZE(password);
3891 } else {
3892 PyErr_SetString(PyExc_TypeError, bad_type_error);
3893 goto error;
3894 }
3895
Victor Stinner9ee02032013-06-23 15:08:23 +02003896 if (size > (Py_ssize_t)INT_MAX) {
3897 PyErr_Format(PyExc_ValueError,
3898 "password cannot be longer than %d bytes", INT_MAX);
3899 goto error;
3900 }
3901
Victor Stinner11ebff22013-07-07 17:07:52 +02003902 PyMem_Free(pw_info->password);
3903 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003904 if (!pw_info->password) {
3905 PyErr_SetString(PyExc_MemoryError,
3906 "unable to allocate password buffer");
3907 goto error;
3908 }
3909 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02003910 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003911
3912 Py_XDECREF(password_bytes);
3913 return 1;
3914
3915error:
3916 Py_XDECREF(password_bytes);
3917 return 0;
3918}
3919
3920static int
3921_password_callback(char *buf, int size, int rwflag, void *userdata)
3922{
3923 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
3924 PyObject *fn_ret = NULL;
3925
3926 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
3927
3928 if (pw_info->callable) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01003929 fn_ret = _PyObject_CallNoArg(pw_info->callable);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003930 if (!fn_ret) {
3931 /* TODO: It would be nice to move _ctypes_add_traceback() into the
3932 core python API, so we could use it to add a frame here */
3933 goto error;
3934 }
3935
3936 if (!_pwinfo_set(pw_info, fn_ret,
3937 "password callback must return a string")) {
3938 goto error;
3939 }
3940 Py_CLEAR(fn_ret);
3941 }
3942
3943 if (pw_info->size > size) {
3944 PyErr_Format(PyExc_ValueError,
3945 "password cannot be longer than %d bytes", size);
3946 goto error;
3947 }
3948
3949 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3950 memcpy(buf, pw_info->password, pw_info->size);
3951 return pw_info->size;
3952
3953error:
3954 Py_XDECREF(fn_ret);
3955 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
3956 pw_info->error = 1;
3957 return -1;
3958}
3959
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003960/*[clinic input]
3961_ssl._SSLContext.load_cert_chain
3962 certfile: object
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003963 keyfile: object = None
3964 password: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003965
3966[clinic start generated code]*/
3967
Antoine Pitroub5218772010-05-21 09:56:06 +00003968static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03003969_ssl__SSLContext_load_cert_chain_impl(PySSLContext *self, PyObject *certfile,
3970 PyObject *keyfile, PyObject *password)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003971/*[clinic end generated code: output=9480bc1c380e2095 input=30bc7e967ea01a58]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003972{
Antoine Pitrou152efa22010-05-16 18:19:27 +00003973 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Christian Heimes598894f2016-09-05 23:19:05 +02003974 pem_password_cb *orig_passwd_cb = SSL_CTX_get_default_passwd_cb(self->ctx);
3975 void *orig_passwd_userdata = SSL_CTX_get_default_passwd_cb_userdata(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003976 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00003977 int r;
3978
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00003979 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00003980 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00003981 if (keyfile == Py_None)
3982 keyfile = NULL;
3983 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003984 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3985 PyErr_SetString(PyExc_TypeError,
3986 "certfile should be a valid filesystem path");
3987 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003988 return NULL;
3989 }
3990 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03003991 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
3992 PyErr_SetString(PyExc_TypeError,
3993 "keyfile should be a valid filesystem path");
3994 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00003995 goto error;
3996 }
Serhiy Storchaka279f4462019-09-14 12:24:05 +03003997 if (password != Py_None) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02003998 if (PyCallable_Check(password)) {
3999 pw_info.callable = password;
4000 } else if (!_pwinfo_set(&pw_info, password,
4001 "password should be a string or callable")) {
4002 goto error;
4003 }
4004 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
4005 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
4006 }
4007 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004008 r = SSL_CTX_use_certificate_chain_file(self->ctx,
4009 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004010 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004011 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004012 if (pw_info.error) {
4013 ERR_clear_error();
4014 /* the password callback has already set the error information */
4015 }
4016 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004017 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004018 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004019 }
4020 else {
4021 _setSSLError(NULL, 0, __FILE__, __LINE__);
4022 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004023 goto error;
4024 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004025 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02004026 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00004027 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
4028 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004029 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
4030 Py_CLEAR(keyfile_bytes);
4031 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004032 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004033 if (pw_info.error) {
4034 ERR_clear_error();
4035 /* the password callback has already set the error information */
4036 }
4037 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00004038 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004039 PyErr_SetFromErrno(PyExc_OSError);
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004040 }
4041 else {
4042 _setSSLError(NULL, 0, __FILE__, __LINE__);
4043 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004044 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004045 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004046 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004047 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004048 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004049 if (r != 1) {
4050 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004051 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004052 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004053 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4054 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004055 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004056 Py_RETURN_NONE;
4057
4058error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02004059 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
4060 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02004061 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00004062 Py_XDECREF(keyfile_bytes);
4063 Py_XDECREF(certfile_bytes);
4064 return NULL;
4065}
4066
Christian Heimesefff7062013-11-21 03:35:02 +01004067/* internal helper function, returns -1 on error
4068 */
4069static int
Serhiy Storchaka8f87eef2020-04-12 14:58:27 +03004070_add_ca_certs(PySSLContext *self, const void *data, Py_ssize_t len,
Christian Heimesefff7062013-11-21 03:35:02 +01004071 int filetype)
4072{
4073 BIO *biobuf = NULL;
4074 X509_STORE *store;
4075 int retval = 0, err, loaded = 0;
4076
4077 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
4078
4079 if (len <= 0) {
4080 PyErr_SetString(PyExc_ValueError,
4081 "Empty certificate data");
4082 return -1;
4083 } else if (len > INT_MAX) {
4084 PyErr_SetString(PyExc_OverflowError,
4085 "Certificate data is too long.");
4086 return -1;
4087 }
4088
Christian Heimes1dbf61f2013-11-22 00:34:18 +01004089 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01004090 if (biobuf == NULL) {
4091 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
4092 return -1;
4093 }
4094
4095 store = SSL_CTX_get_cert_store(self->ctx);
4096 assert(store != NULL);
4097
4098 while (1) {
4099 X509 *cert = NULL;
4100 int r;
4101
4102 if (filetype == SSL_FILETYPE_ASN1) {
4103 cert = d2i_X509_bio(biobuf, NULL);
4104 } else {
4105 cert = PEM_read_bio_X509(biobuf, NULL,
Christian Heimes598894f2016-09-05 23:19:05 +02004106 SSL_CTX_get_default_passwd_cb(self->ctx),
4107 SSL_CTX_get_default_passwd_cb_userdata(self->ctx)
4108 );
Christian Heimesefff7062013-11-21 03:35:02 +01004109 }
4110 if (cert == NULL) {
4111 break;
4112 }
4113 r = X509_STORE_add_cert(store, cert);
4114 X509_free(cert);
4115 if (!r) {
4116 err = ERR_peek_last_error();
4117 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
4118 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
4119 /* cert already in hash table, not an error */
4120 ERR_clear_error();
4121 } else {
4122 break;
4123 }
4124 }
4125 loaded++;
4126 }
4127
4128 err = ERR_peek_last_error();
4129 if ((filetype == SSL_FILETYPE_ASN1) &&
4130 (loaded > 0) &&
4131 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
4132 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
4133 /* EOF ASN1 file, not an error */
4134 ERR_clear_error();
4135 retval = 0;
4136 } else if ((filetype == SSL_FILETYPE_PEM) &&
4137 (loaded > 0) &&
4138 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
4139 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
4140 /* EOF PEM file, not an error */
4141 ERR_clear_error();
4142 retval = 0;
4143 } else {
4144 _setSSLError(NULL, 0, __FILE__, __LINE__);
4145 retval = -1;
4146 }
4147
4148 BIO_free(biobuf);
4149 return retval;
4150}
4151
4152
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004153/*[clinic input]
4154_ssl._SSLContext.load_verify_locations
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004155 cafile: object = None
4156 capath: object = None
4157 cadata: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004158
4159[clinic start generated code]*/
4160
Antoine Pitrou152efa22010-05-16 18:19:27 +00004161static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004162_ssl__SSLContext_load_verify_locations_impl(PySSLContext *self,
4163 PyObject *cafile,
4164 PyObject *capath,
4165 PyObject *cadata)
Serhiy Storchaka279f4462019-09-14 12:24:05 +03004166/*[clinic end generated code: output=454c7e41230ca551 input=42ecfe258233e194]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004167{
Antoine Pitrou152efa22010-05-16 18:19:27 +00004168 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
4169 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004170 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004171
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00004172 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004173 if (cafile == Py_None)
4174 cafile = NULL;
4175 if (capath == Py_None)
4176 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01004177 if (cadata == Py_None)
4178 cadata = NULL;
4179
4180 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004181 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01004182 "cafile, capath and cadata cannot be all omitted");
4183 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004184 }
4185 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004186 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4187 PyErr_SetString(PyExc_TypeError,
4188 "cafile should be a valid filesystem path");
4189 }
Christian Heimesefff7062013-11-21 03:35:02 +01004190 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004191 }
4192 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004193 if (PyErr_ExceptionMatches(PyExc_TypeError)) {
4194 PyErr_SetString(PyExc_TypeError,
4195 "capath should be a valid filesystem path");
4196 }
Christian Heimesefff7062013-11-21 03:35:02 +01004197 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004198 }
Christian Heimesefff7062013-11-21 03:35:02 +01004199
4200 /* validata cadata type and load cadata */
4201 if (cadata) {
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004202 if (PyUnicode_Check(cadata)) {
4203 PyObject *cadata_ascii = PyUnicode_AsASCIIString(cadata);
4204 if (cadata_ascii == NULL) {
4205 if (PyErr_ExceptionMatches(PyExc_UnicodeEncodeError)) {
4206 goto invalid_cadata;
4207 }
4208 goto error;
4209 }
4210 r = _add_ca_certs(self,
4211 PyBytes_AS_STRING(cadata_ascii),
4212 PyBytes_GET_SIZE(cadata_ascii),
4213 SSL_FILETYPE_PEM);
4214 Py_DECREF(cadata_ascii);
4215 if (r == -1) {
4216 goto error;
4217 }
4218 }
4219 else if (PyObject_CheckBuffer(cadata)) {
4220 Py_buffer buf;
4221 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE)) {
4222 goto error;
4223 }
Christian Heimesefff7062013-11-21 03:35:02 +01004224 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
4225 PyBuffer_Release(&buf);
4226 PyErr_SetString(PyExc_TypeError,
4227 "cadata should be a contiguous buffer with "
4228 "a single dimension");
4229 goto error;
4230 }
4231 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
4232 PyBuffer_Release(&buf);
4233 if (r == -1) {
4234 goto error;
4235 }
Serhiy Storchaka65fb2c02019-05-31 10:39:15 +03004236 }
4237 else {
4238 invalid_cadata:
4239 PyErr_SetString(PyExc_TypeError,
4240 "cadata should be an ASCII string or a "
4241 "bytes-like object");
4242 goto error;
Christian Heimesefff7062013-11-21 03:35:02 +01004243 }
4244 }
4245
4246 /* load cafile or capath */
4247 if (cafile || capath) {
4248 if (cafile)
4249 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
4250 if (capath)
4251 capath_buf = PyBytes_AS_STRING(capath_bytes);
4252 PySSL_BEGIN_ALLOW_THREADS
4253 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
4254 PySSL_END_ALLOW_THREADS
4255 if (r != 1) {
Christian Heimesefff7062013-11-21 03:35:02 +01004256 if (errno != 0) {
4257 ERR_clear_error();
Serhiy Storchaka55fe1ae2017-04-16 10:46:38 +03004258 PyErr_SetFromErrno(PyExc_OSError);
Christian Heimesefff7062013-11-21 03:35:02 +01004259 }
4260 else {
4261 _setSSLError(NULL, 0, __FILE__, __LINE__);
4262 }
4263 goto error;
4264 }
4265 }
4266 goto end;
4267
4268 error:
4269 ok = 0;
4270 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00004271 Py_XDECREF(cafile_bytes);
4272 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01004273 if (ok) {
4274 Py_RETURN_NONE;
4275 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00004276 return NULL;
4277 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004278}
4279
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004280/*[clinic input]
4281_ssl._SSLContext.load_dh_params
4282 path as filepath: object
4283 /
4284
4285[clinic start generated code]*/
4286
Antoine Pitrou152efa22010-05-16 18:19:27 +00004287static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004288_ssl__SSLContext_load_dh_params(PySSLContext *self, PyObject *filepath)
4289/*[clinic end generated code: output=1c8e57a38e055af0 input=c8871f3c796ae1d6]*/
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004290{
4291 FILE *f;
4292 DH *dh;
4293
Victor Stinnerdaf45552013-08-28 00:53:59 +02004294 f = _Py_fopen_obj(filepath, "rb");
Victor Stinnere42ccd22015-03-18 01:39:23 +01004295 if (f == NULL)
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004296 return NULL;
Victor Stinnere42ccd22015-03-18 01:39:23 +01004297
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004298 errno = 0;
4299 PySSL_BEGIN_ALLOW_THREADS
4300 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01004301 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004302 PySSL_END_ALLOW_THREADS
4303 if (dh == NULL) {
4304 if (errno != 0) {
4305 ERR_clear_error();
4306 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
4307 }
4308 else {
4309 _setSSLError(NULL, 0, __FILE__, __LINE__);
4310 }
4311 return NULL;
4312 }
Miss Islington (bot)1d1c5742020-07-07 21:40:18 -07004313 if (!SSL_CTX_set_tmp_dh(self->ctx, dh)) {
4314 DH_free(dh);
4315 return _setSSLError(NULL, 0, __FILE__, __LINE__);
4316 }
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004317 DH_free(dh);
4318 Py_RETURN_NONE;
4319}
4320
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004321/*[clinic input]
4322_ssl._SSLContext._wrap_socket
4323 sock: object(subclass_of="PySocketModule.Sock_Type")
4324 server_side: int
4325 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004326 *
4327 owner: object = None
4328 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004329
4330[clinic start generated code]*/
4331
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004332static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004333_ssl__SSLContext__wrap_socket_impl(PySSLContext *self, PyObject *sock,
Christian Heimes141c5e82018-02-24 21:10:57 +01004334 int server_side, PyObject *hostname_obj,
4335 PyObject *owner, PyObject *session)
4336/*[clinic end generated code: output=f103f238633940b4 input=957d5006183d1894]*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004337{
Antoine Pitroud5323212010-10-22 18:19:07 +00004338 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004339 PyObject *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004340
Antoine Pitroud5323212010-10-22 18:19:07 +00004341 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004342 as IDN A-label (ASCII str) without NULL bytes. */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004343 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004344 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroud5323212010-10-22 18:19:07 +00004345 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00004346 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00004347
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004348 res = (PyObject *) newPySSLSocket(self, (PySocketSockObject *)sock,
4349 server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004350 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004351 NULL, NULL);
Antoine Pitroud5323212010-10-22 18:19:07 +00004352 if (hostname != NULL)
4353 PyMem_Free(hostname);
4354 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00004355}
4356
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004357/*[clinic input]
4358_ssl._SSLContext._wrap_bio
4359 incoming: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
4360 outgoing: object(subclass_of="&PySSLMemoryBIO_Type", type="PySSLMemoryBIO *")
4361 server_side: int
4362 server_hostname as hostname_obj: object = None
Christian Heimes141c5e82018-02-24 21:10:57 +01004363 *
4364 owner: object = None
4365 session: object = None
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004366
4367[clinic start generated code]*/
4368
Antoine Pitroub0182c82010-10-12 20:09:02 +00004369static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004370_ssl__SSLContext__wrap_bio_impl(PySSLContext *self, PySSLMemoryBIO *incoming,
4371 PySSLMemoryBIO *outgoing, int server_side,
Christian Heimes141c5e82018-02-24 21:10:57 +01004372 PyObject *hostname_obj, PyObject *owner,
4373 PyObject *session)
4374/*[clinic end generated code: output=5c5d6d9b41f99332 input=8cf22f4d586ac56a]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004375{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004376 char *hostname = NULL;
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004377 PyObject *res;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004378
4379 /* server_hostname is either None (or absent), or to be encoded
Christian Heimesd02ac252018-03-25 12:36:13 +02004380 as IDN A-label (ASCII str) without NULL bytes. */
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004381 if (hostname_obj != Py_None) {
Christian Heimes11a14932018-02-24 02:35:08 +01004382 if (!PyArg_Parse(hostname_obj, "es", "ascii", &hostname))
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004383 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004384 }
4385
4386 res = (PyObject *) newPySSLSocket(self, NULL, server_side, hostname,
Christian Heimes141c5e82018-02-24 21:10:57 +01004387 owner, session,
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004388 incoming, outgoing);
4389
4390 PyMem_Free(hostname);
4391 return res;
4392}
4393
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004394/*[clinic input]
4395_ssl._SSLContext.session_stats
4396[clinic start generated code]*/
4397
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004398static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004399_ssl__SSLContext_session_stats_impl(PySSLContext *self)
4400/*[clinic end generated code: output=0d96411c42893bfb input=7e0a81fb11102c8b]*/
Antoine Pitroub0182c82010-10-12 20:09:02 +00004401{
4402 int r;
4403 PyObject *value, *stats = PyDict_New();
4404 if (!stats)
4405 return NULL;
4406
4407#define ADD_STATS(SSL_NAME, KEY_NAME) \
4408 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
4409 if (value == NULL) \
4410 goto error; \
4411 r = PyDict_SetItemString(stats, KEY_NAME, value); \
4412 Py_DECREF(value); \
4413 if (r < 0) \
4414 goto error;
4415
4416 ADD_STATS(number, "number");
4417 ADD_STATS(connect, "connect");
4418 ADD_STATS(connect_good, "connect_good");
4419 ADD_STATS(connect_renegotiate, "connect_renegotiate");
4420 ADD_STATS(accept, "accept");
4421 ADD_STATS(accept_good, "accept_good");
4422 ADD_STATS(accept_renegotiate, "accept_renegotiate");
4423 ADD_STATS(accept, "accept");
4424 ADD_STATS(hits, "hits");
4425 ADD_STATS(misses, "misses");
4426 ADD_STATS(timeouts, "timeouts");
4427 ADD_STATS(cache_full, "cache_full");
4428
4429#undef ADD_STATS
4430
4431 return stats;
4432
4433error:
4434 Py_DECREF(stats);
4435 return NULL;
4436}
4437
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004438/*[clinic input]
4439_ssl._SSLContext.set_default_verify_paths
4440[clinic start generated code]*/
4441
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004442static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004443_ssl__SSLContext_set_default_verify_paths_impl(PySSLContext *self)
4444/*[clinic end generated code: output=0bee74e6e09deaaa input=35f3408021463d74]*/
Antoine Pitrou664c2d12010-11-17 20:29:42 +00004445{
4446 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
4447 _setSSLError(NULL, 0, __FILE__, __LINE__);
4448 return NULL;
4449 }
4450 Py_RETURN_NONE;
4451}
4452
Antoine Pitrou501da612011-12-21 09:27:41 +01004453#ifndef OPENSSL_NO_ECDH
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004454/*[clinic input]
4455_ssl._SSLContext.set_ecdh_curve
4456 name: object
4457 /
4458
4459[clinic start generated code]*/
4460
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004461static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004462_ssl__SSLContext_set_ecdh_curve(PySSLContext *self, PyObject *name)
4463/*[clinic end generated code: output=23022c196e40d7d2 input=c2bafb6f6e34726b]*/
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004464{
4465 PyObject *name_bytes;
4466 int nid;
4467 EC_KEY *key;
4468
4469 if (!PyUnicode_FSConverter(name, &name_bytes))
4470 return NULL;
4471 assert(PyBytes_Check(name_bytes));
4472 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
4473 Py_DECREF(name_bytes);
4474 if (nid == 0) {
4475 PyErr_Format(PyExc_ValueError,
4476 "unknown elliptic curve name %R", name);
4477 return NULL;
4478 }
4479 key = EC_KEY_new_by_curve_name(nid);
4480 if (key == NULL) {
4481 _setSSLError(NULL, 0, __FILE__, __LINE__);
4482 return NULL;
4483 }
4484 SSL_CTX_set_tmp_ecdh(self->ctx, key);
4485 EC_KEY_free(key);
4486 Py_RETURN_NONE;
4487}
Antoine Pitrou501da612011-12-21 09:27:41 +01004488#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004489
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004490#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004491static int
4492_servername_callback(SSL *s, int *al, void *args)
4493{
4494 int ret;
4495 PySSLContext *ssl_ctx = (PySSLContext *) args;
4496 PySSLSocket *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004497 PyObject *result;
4498 /* The high-level ssl.SSLSocket object */
4499 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004500 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01004501 PyGILState_STATE gstate = PyGILState_Ensure();
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004502
Christian Heimes11a14932018-02-24 02:35:08 +01004503 if (ssl_ctx->set_sni_cb == NULL) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004504 /* remove race condition in this the call back while if removing the
4505 * callback is in progress */
4506 PyGILState_Release(gstate);
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01004507 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004508 }
4509
4510 ssl = SSL_get_app_data(s);
4511 assert(PySSLSocket_Check(ssl));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004512
Serhiy Storchakaf51d7152015-11-02 14:40:41 +02004513 /* The servername callback expects an argument that represents the current
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004514 * SSL connection and that has a .context attribute that can be changed to
4515 * identify the requested hostname. Since the official API is the Python
4516 * level API we want to pass the callback a Python level object rather than
4517 * a _ssl.SSLSocket instance. If there's an "owner" (typically an
4518 * SSLObject) that will be passed. Otherwise if there's a socket then that
4519 * will be passed. If both do not exist only then the C-level object is
4520 * passed. */
4521 if (ssl->owner)
4522 ssl_socket = PyWeakref_GetObject(ssl->owner);
4523 else if (ssl->Socket)
4524 ssl_socket = PyWeakref_GetObject(ssl->Socket);
4525 else
4526 ssl_socket = (PyObject *) ssl;
4527
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004528 Py_INCREF(ssl_socket);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004529 if (ssl_socket == Py_None)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004530 goto error;
Victor Stinner7e001512013-06-25 00:44:31 +02004531
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004532 if (servername == NULL) {
Christian Heimes11a14932018-02-24 02:35:08 +01004533 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_sni_cb, ssl_socket,
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004534 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004535 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004536 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004537 PyObject *servername_bytes;
4538 PyObject *servername_str;
4539
4540 servername_bytes = PyBytes_FromString(servername);
4541 if (servername_bytes == NULL) {
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004542 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
4543 goto error;
4544 }
Christian Heimes11a14932018-02-24 02:35:08 +01004545 /* server_hostname was encoded to an A-label by our caller; put it
4546 * back into a str object, but still as an A-label (bpo-28414)
4547 */
4548 servername_str = PyUnicode_FromEncodedObject(servername_bytes, "ascii", NULL);
Christian Heimes11a14932018-02-24 02:35:08 +01004549 if (servername_str == NULL) {
4550 PyErr_WriteUnraisable(servername_bytes);
Miss Islington (bot)90584c02020-07-09 03:18:30 -07004551 Py_DECREF(servername_bytes);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02004552 goto error;
4553 }
Miss Islington (bot)90584c02020-07-09 03:18:30 -07004554 Py_DECREF(servername_bytes);
Christian Heimes11a14932018-02-24 02:35:08 +01004555 result = PyObject_CallFunctionObjArgs(
4556 ssl_ctx->set_sni_cb, ssl_socket, servername_str,
4557 ssl_ctx, NULL);
4558 Py_DECREF(servername_str);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004559 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004560 Py_DECREF(ssl_socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004561
4562 if (result == NULL) {
Christian Heimes11a14932018-02-24 02:35:08 +01004563 PyErr_WriteUnraisable(ssl_ctx->set_sni_cb);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004564 *al = SSL_AD_HANDSHAKE_FAILURE;
4565 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4566 }
4567 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004568 /* Result may be None, a SSLContext or an integer
4569 * None and SSLContext are OK, integer or other values are an error.
4570 */
4571 if (result == Py_None) {
4572 ret = SSL_TLSEXT_ERR_OK;
4573 } else {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004574 *al = (int) PyLong_AsLong(result);
4575 if (PyErr_Occurred()) {
4576 PyErr_WriteUnraisable(result);
4577 *al = SSL_AD_INTERNAL_ERROR;
4578 }
4579 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4580 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004581 Py_DECREF(result);
4582 }
4583
4584 PyGILState_Release(gstate);
4585 return ret;
4586
4587error:
4588 Py_DECREF(ssl_socket);
4589 *al = SSL_AD_INTERNAL_ERROR;
4590 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
4591 PyGILState_Release(gstate);
4592 return ret;
4593}
Antoine Pitroua5963382013-03-30 16:39:00 +01004594#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004595
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004596static PyObject *
Christian Heimes11a14932018-02-24 02:35:08 +01004597get_sni_callback(PySSLContext *self, void *c)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004598{
Christian Heimes11a14932018-02-24 02:35:08 +01004599 PyObject *cb = self->set_sni_cb;
4600 if (cb == NULL) {
4601 Py_RETURN_NONE;
4602 }
4603 Py_INCREF(cb);
4604 return cb;
4605}
4606
4607static int
4608set_sni_callback(PySSLContext *self, PyObject *arg, void *c)
4609{
4610 if (self->protocol == PY_SSL_VERSION_TLS_CLIENT) {
4611 PyErr_SetString(PyExc_ValueError,
4612 "sni_callback cannot be set on TLS_CLIENT context");
4613 return -1;
4614 }
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004615#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Christian Heimes11a14932018-02-24 02:35:08 +01004616 Py_CLEAR(self->set_sni_cb);
4617 if (arg == Py_None) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004618 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
4619 }
4620 else {
Christian Heimes11a14932018-02-24 02:35:08 +01004621 if (!PyCallable_Check(arg)) {
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004622 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
4623 PyErr_SetString(PyExc_TypeError,
4624 "not a callable object");
Christian Heimes11a14932018-02-24 02:35:08 +01004625 return -1;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004626 }
Christian Heimes11a14932018-02-24 02:35:08 +01004627 Py_INCREF(arg);
4628 self->set_sni_cb = arg;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004629 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
4630 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
4631 }
Christian Heimes11a14932018-02-24 02:35:08 +01004632 return 0;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004633#else
4634 PyErr_SetString(PyExc_NotImplementedError,
4635 "The TLS extension servername callback, "
4636 "SSL_CTX_set_tlsext_servername_callback, "
4637 "is not in the current OpenSSL library.");
Christian Heimes11a14932018-02-24 02:35:08 +01004638 return -1;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004639#endif
4640}
4641
Christian Heimes11a14932018-02-24 02:35:08 +01004642PyDoc_STRVAR(PySSLContext_sni_callback_doc,
4643"Set a callback that will be called when a server name is provided by the SSL/TLS client in the SNI extension.\n\
4644\n\
4645If the argument is None then the callback is disabled. The method is called\n\
4646with the SSLSocket, the server name as a string, and the SSLContext object.\n\
4647See RFC 6066 for details of the SNI extension.");
4648
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004649/*[clinic input]
4650_ssl._SSLContext.cert_store_stats
4651
4652Returns quantities of loaded X.509 certificates.
4653
4654X.509 certificates with a CA extension and certificate revocation lists
4655inside the context's cert store.
4656
4657NOTE: Certificates in a capath directory aren't loaded unless they have
4658been used at least once.
4659[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004660
4661static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004662_ssl__SSLContext_cert_store_stats_impl(PySSLContext *self)
4663/*[clinic end generated code: output=5f356f4d9cca874d input=eb40dd0f6d0e40cf]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004664{
4665 X509_STORE *store;
Christian Heimes598894f2016-09-05 23:19:05 +02004666 STACK_OF(X509_OBJECT) *objs;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004667 X509_OBJECT *obj;
Christian Heimes598894f2016-09-05 23:19:05 +02004668 int x509 = 0, crl = 0, ca = 0, i;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004669
4670 store = SSL_CTX_get_cert_store(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02004671 objs = X509_STORE_get0_objects(store);
4672 for (i = 0; i < sk_X509_OBJECT_num(objs); i++) {
4673 obj = sk_X509_OBJECT_value(objs, i);
4674 switch (X509_OBJECT_get_type(obj)) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004675 case X509_LU_X509:
4676 x509++;
Christian Heimes598894f2016-09-05 23:19:05 +02004677 if (X509_check_ca(X509_OBJECT_get0_X509(obj))) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004678 ca++;
4679 }
4680 break;
4681 case X509_LU_CRL:
4682 crl++;
4683 break;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004684 default:
4685 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
4686 * As far as I can tell they are internal states and never
4687 * stored in a cert store */
4688 break;
4689 }
4690 }
4691 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
4692 "x509_ca", ca);
4693}
4694
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004695/*[clinic input]
4696_ssl._SSLContext.get_ca_certs
4697 binary_form: bool = False
4698
4699Returns a list of dicts with information of loaded CA certs.
4700
4701If the optional argument is True, returns a DER-encoded copy of the CA
4702certificate.
4703
4704NOTE: Certificates in a capath directory aren't loaded unless they have
4705been used at least once.
4706[clinic start generated code]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004707
4708static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004709_ssl__SSLContext_get_ca_certs_impl(PySSLContext *self, int binary_form)
4710/*[clinic end generated code: output=0d58f148f37e2938 input=6887b5a09b7f9076]*/
Christian Heimes9a5395a2013-06-17 15:44:12 +02004711{
4712 X509_STORE *store;
Christian Heimes598894f2016-09-05 23:19:05 +02004713 STACK_OF(X509_OBJECT) *objs;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004714 PyObject *ci = NULL, *rlist = NULL;
4715 int i;
Christian Heimes9a5395a2013-06-17 15:44:12 +02004716
4717 if ((rlist = PyList_New(0)) == NULL) {
4718 return NULL;
4719 }
4720
4721 store = SSL_CTX_get_cert_store(self->ctx);
Christian Heimes598894f2016-09-05 23:19:05 +02004722 objs = X509_STORE_get0_objects(store);
4723 for (i = 0; i < sk_X509_OBJECT_num(objs); i++) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004724 X509_OBJECT *obj;
4725 X509 *cert;
4726
Christian Heimes598894f2016-09-05 23:19:05 +02004727 obj = sk_X509_OBJECT_value(objs, i);
4728 if (X509_OBJECT_get_type(obj) != X509_LU_X509) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004729 /* not a x509 cert */
4730 continue;
4731 }
4732 /* CA for any purpose */
Christian Heimes598894f2016-09-05 23:19:05 +02004733 cert = X509_OBJECT_get0_X509(obj);
Christian Heimes9a5395a2013-06-17 15:44:12 +02004734 if (!X509_check_ca(cert)) {
4735 continue;
4736 }
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004737 if (binary_form) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02004738 ci = _certificate_to_der(cert);
4739 } else {
4740 ci = _decode_certificate(cert);
4741 }
4742 if (ci == NULL) {
4743 goto error;
4744 }
4745 if (PyList_Append(rlist, ci) == -1) {
4746 goto error;
4747 }
4748 Py_CLEAR(ci);
4749 }
4750 return rlist;
4751
4752 error:
4753 Py_XDECREF(ci);
4754 Py_XDECREF(rlist);
4755 return NULL;
4756}
4757
4758
Antoine Pitrou152efa22010-05-16 18:19:27 +00004759static PyGetSetDef context_getsetlist[] = {
Christian Heimes1aa9a752013-12-02 02:41:19 +01004760 {"check_hostname", (getter) get_check_hostname,
4761 (setter) set_check_hostname, NULL},
Christian Heimes61d478c2018-01-27 15:51:38 +01004762 {"_host_flags", (getter) get_host_flags,
4763 (setter) set_host_flags, NULL},
Christian Heimes698dde12018-02-27 11:54:43 +01004764#if SSL_CTRL_GET_MAX_PROTO_VERSION
4765 {"minimum_version", (getter) get_minimum_version,
4766 (setter) set_minimum_version, NULL},
4767 {"maximum_version", (getter) get_maximum_version,
4768 (setter) set_maximum_version, NULL},
4769#endif
Christian Heimesc7f70692019-05-31 11:44:05 +02004770#ifdef HAVE_OPENSSL_KEYLOG
4771 {"keylog_filename", (getter) _PySSLContext_get_keylog_filename,
4772 (setter) _PySSLContext_set_keylog_filename, NULL},
4773#endif
4774 {"_msg_callback", (getter) _PySSLContext_get_msg_callback,
4775 (setter) _PySSLContext_set_msg_callback, NULL},
Christian Heimes11a14932018-02-24 02:35:08 +01004776 {"sni_callback", (getter) get_sni_callback,
Christian Heimes698dde12018-02-27 11:54:43 +01004777 (setter) set_sni_callback, PySSLContext_sni_callback_doc},
Christian Heimes78c7d522019-06-03 21:00:10 +02004778#if (OPENSSL_VERSION_NUMBER >= 0x10101000L) && !defined(LIBRESSL_VERSION_NUMBER)
4779 {"num_tickets", (getter) get_num_tickets,
4780 (setter) set_num_tickets, PySSLContext_num_tickets_doc},
4781#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00004782 {"options", (getter) get_options,
4783 (setter) set_options, NULL},
Christian Heimes9fb051f2018-09-23 08:32:31 +02004784 {"post_handshake_auth", (getter) get_post_handshake_auth,
4785#ifdef TLS1_3_VERSION
4786 (setter) set_post_handshake_auth,
4787#else
4788 NULL,
4789#endif
4790 NULL},
Christian Heimes11a14932018-02-24 02:35:08 +01004791 {"protocol", (getter) get_protocol,
4792 NULL, NULL},
Christian Heimes22587792013-11-21 23:56:13 +01004793 {"verify_flags", (getter) get_verify_flags,
4794 (setter) set_verify_flags, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00004795 {"verify_mode", (getter) get_verify_mode,
4796 (setter) set_verify_mode, NULL},
4797 {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
4818static PyTypeObject PySSLContext_Type = {
4819 PyVarObject_HEAD_INIT(NULL, 0)
4820 "_ssl._SSLContext", /*tp_name*/
4821 sizeof(PySSLContext), /*tp_basicsize*/
4822 0, /*tp_itemsize*/
4823 (destructor)context_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004824 0, /*tp_vectorcall_offset*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004825 0, /*tp_getattr*/
4826 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02004827 0, /*tp_as_async*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004828 0, /*tp_repr*/
4829 0, /*tp_as_number*/
4830 0, /*tp_as_sequence*/
4831 0, /*tp_as_mapping*/
4832 0, /*tp_hash*/
4833 0, /*tp_call*/
4834 0, /*tp_str*/
4835 0, /*tp_getattro*/
4836 0, /*tp_setattro*/
4837 0, /*tp_as_buffer*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004838 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004839 0, /*tp_doc*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004840 (traverseproc) context_traverse, /*tp_traverse*/
4841 (inquiry) context_clear, /*tp_clear*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004842 0, /*tp_richcompare*/
4843 0, /*tp_weaklistoffset*/
4844 0, /*tp_iter*/
4845 0, /*tp_iternext*/
4846 context_methods, /*tp_methods*/
4847 0, /*tp_members*/
4848 context_getsetlist, /*tp_getset*/
4849 0, /*tp_base*/
4850 0, /*tp_dict*/
4851 0, /*tp_descr_get*/
4852 0, /*tp_descr_set*/
4853 0, /*tp_dictoffset*/
4854 0, /*tp_init*/
4855 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004856 _ssl__SSLContext, /*tp_new*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00004857};
4858
4859
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004860/*
4861 * MemoryBIO objects
4862 */
4863
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004864/*[clinic input]
4865@classmethod
4866_ssl.MemoryBIO.__new__
4867
4868[clinic start generated code]*/
4869
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004870static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004871_ssl_MemoryBIO_impl(PyTypeObject *type)
4872/*[clinic end generated code: output=8820a58db78330ac input=26d22e4909ecb1b5]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004873{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004874 BIO *bio;
4875 PySSLMemoryBIO *self;
4876
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004877 bio = BIO_new(BIO_s_mem());
4878 if (bio == NULL) {
4879 PyErr_SetString(PySSLErrorObject,
4880 "failed to allocate BIO");
4881 return NULL;
4882 }
4883 /* Since our BIO is non-blocking an empty read() does not indicate EOF,
4884 * just that no data is currently available. The SSL routines should retry
4885 * the read, which we can achieve by calling BIO_set_retry_read(). */
4886 BIO_set_retry_read(bio);
4887 BIO_set_mem_eof_return(bio, -1);
4888
4889 assert(type != NULL && type->tp_alloc != NULL);
4890 self = (PySSLMemoryBIO *) type->tp_alloc(type, 0);
4891 if (self == NULL) {
4892 BIO_free(bio);
4893 return NULL;
4894 }
4895 self->bio = bio;
4896 self->eof_written = 0;
4897
4898 return (PyObject *) self;
4899}
4900
4901static void
4902memory_bio_dealloc(PySSLMemoryBIO *self)
4903{
4904 BIO_free(self->bio);
4905 Py_TYPE(self)->tp_free(self);
4906}
4907
4908static PyObject *
4909memory_bio_get_pending(PySSLMemoryBIO *self, void *c)
4910{
Segev Finer5cff6372017-07-27 01:19:17 +03004911 return PyLong_FromSize_t(BIO_ctrl_pending(self->bio));
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004912}
4913
4914PyDoc_STRVAR(PySSL_memory_bio_pending_doc,
4915"The number of bytes pending in the memory BIO.");
4916
4917static PyObject *
4918memory_bio_get_eof(PySSLMemoryBIO *self, void *c)
4919{
4920 return PyBool_FromLong((BIO_ctrl_pending(self->bio) == 0)
4921 && self->eof_written);
4922}
4923
4924PyDoc_STRVAR(PySSL_memory_bio_eof_doc,
4925"Whether the memory BIO is at EOF.");
4926
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004927/*[clinic input]
4928_ssl.MemoryBIO.read
4929 size as len: int = -1
4930 /
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004931
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004932Read up to size bytes from the memory BIO.
4933
4934If size is not specified, read the entire buffer.
4935If the return value is an empty bytes instance, this means either
4936EOF or that no data is available. Use the "eof" property to
4937distinguish between the two.
4938[clinic start generated code]*/
4939
4940static PyObject *
4941_ssl_MemoryBIO_read_impl(PySSLMemoryBIO *self, int len)
4942/*[clinic end generated code: output=a657aa1e79cd01b3 input=574d7be06a902366]*/
4943{
4944 int avail, nbytes;
4945 PyObject *result;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004946
Segev Finer5cff6372017-07-27 01:19:17 +03004947 avail = (int)Py_MIN(BIO_ctrl_pending(self->bio), INT_MAX);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004948 if ((len < 0) || (len > avail))
4949 len = avail;
4950
4951 result = PyBytes_FromStringAndSize(NULL, len);
4952 if ((result == NULL) || (len == 0))
4953 return result;
4954
4955 nbytes = BIO_read(self->bio, PyBytes_AS_STRING(result), len);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004956 if (nbytes < 0) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004957 Py_DECREF(result);
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004958 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004959 return NULL;
4960 }
4961
Zackery Spytz365ad2e2018-10-06 11:41:45 -06004962 /* There should never be any short reads but check anyway. */
4963 if (nbytes < len) {
4964 _PyBytes_Resize(&result, nbytes);
4965 }
4966
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004967 return result;
4968}
4969
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004970/*[clinic input]
4971_ssl.MemoryBIO.write
4972 b: Py_buffer
4973 /
4974
4975Writes the bytes b into the memory BIO.
4976
4977Returns the number of bytes written.
4978[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004979
4980static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004981_ssl_MemoryBIO_write_impl(PySSLMemoryBIO *self, Py_buffer *b)
4982/*[clinic end generated code: output=156ec59110d75935 input=e45757b3e17c4808]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004983{
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004984 int nbytes;
4985
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004986 if (b->len > INT_MAX) {
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004987 PyErr_Format(PyExc_OverflowError,
4988 "string longer than %d bytes", INT_MAX);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004989 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004990 }
4991
4992 if (self->eof_written) {
4993 PyErr_SetString(PySSLErrorObject,
4994 "cannot write() after write_eof()");
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03004995 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004996 }
4997
Segev Finer5cff6372017-07-27 01:19:17 +03004998 nbytes = BIO_write(self->bio, b->buf, (int)b->len);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02004999 if (nbytes < 0) {
5000 _setSSLError(NULL, 0, __FILE__, __LINE__);
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005001 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005002 }
5003
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005004 return PyLong_FromLong(nbytes);
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005005}
5006
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005007/*[clinic input]
5008_ssl.MemoryBIO.write_eof
5009
5010Write an EOF marker to the memory BIO.
5011
5012When all data has been read, the "eof" property will be True.
5013[clinic start generated code]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005014
5015static PyObject *
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005016_ssl_MemoryBIO_write_eof_impl(PySSLMemoryBIO *self)
5017/*[clinic end generated code: output=d4106276ccd1ed34 input=56a945f1d29e8bd6]*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005018{
5019 self->eof_written = 1;
5020 /* After an EOF is written, a zero return from read() should be a real EOF
5021 * i.e. it should not be retried. Clear the SHOULD_RETRY flag. */
5022 BIO_clear_retry_flags(self->bio);
5023 BIO_set_mem_eof_return(self->bio, 0);
5024
5025 Py_RETURN_NONE;
5026}
5027
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005028static PyGetSetDef memory_bio_getsetlist[] = {
5029 {"pending", (getter) memory_bio_get_pending, NULL,
5030 PySSL_memory_bio_pending_doc},
5031 {"eof", (getter) memory_bio_get_eof, NULL,
5032 PySSL_memory_bio_eof_doc},
5033 {NULL}, /* sentinel */
5034};
5035
5036static struct PyMethodDef memory_bio_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005037 _SSL_MEMORYBIO_READ_METHODDEF
5038 _SSL_MEMORYBIO_WRITE_METHODDEF
5039 _SSL_MEMORYBIO_WRITE_EOF_METHODDEF
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005040 {NULL, NULL} /* sentinel */
5041};
5042
5043static PyTypeObject PySSLMemoryBIO_Type = {
5044 PyVarObject_HEAD_INIT(NULL, 0)
5045 "_ssl.MemoryBIO", /*tp_name*/
5046 sizeof(PySSLMemoryBIO), /*tp_basicsize*/
5047 0, /*tp_itemsize*/
5048 (destructor)memory_bio_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005049 0, /*tp_vectorcall_offset*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005050 0, /*tp_getattr*/
5051 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005052 0, /*tp_as_async*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005053 0, /*tp_repr*/
5054 0, /*tp_as_number*/
5055 0, /*tp_as_sequence*/
5056 0, /*tp_as_mapping*/
5057 0, /*tp_hash*/
5058 0, /*tp_call*/
5059 0, /*tp_str*/
5060 0, /*tp_getattro*/
5061 0, /*tp_setattro*/
5062 0, /*tp_as_buffer*/
5063 Py_TPFLAGS_DEFAULT, /*tp_flags*/
5064 0, /*tp_doc*/
5065 0, /*tp_traverse*/
5066 0, /*tp_clear*/
5067 0, /*tp_richcompare*/
5068 0, /*tp_weaklistoffset*/
5069 0, /*tp_iter*/
5070 0, /*tp_iternext*/
5071 memory_bio_methods, /*tp_methods*/
5072 0, /*tp_members*/
5073 memory_bio_getsetlist, /*tp_getset*/
5074 0, /*tp_base*/
5075 0, /*tp_dict*/
5076 0, /*tp_descr_get*/
5077 0, /*tp_descr_set*/
5078 0, /*tp_dictoffset*/
5079 0, /*tp_init*/
5080 0, /*tp_alloc*/
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005081 _ssl_MemoryBIO, /*tp_new*/
Antoine Pitroub1fdf472014-10-05 20:41:53 +02005082};
5083
Antoine Pitrou152efa22010-05-16 18:19:27 +00005084
Christian Heimes99a65702016-09-10 23:44:53 +02005085/*
5086 * SSL Session object
5087 */
5088
5089static void
5090PySSLSession_dealloc(PySSLSession *self)
5091{
INADA Naokia6296d32017-08-24 14:55:17 +09005092 /* bpo-31095: UnTrack is needed before calling any callbacks */
Christian Heimesa5d07652016-09-24 10:48:05 +02005093 PyObject_GC_UnTrack(self);
Christian Heimes99a65702016-09-10 23:44:53 +02005094 Py_XDECREF(self->ctx);
5095 if (self->session != NULL) {
5096 SSL_SESSION_free(self->session);
5097 }
Christian Heimesa5d07652016-09-24 10:48:05 +02005098 PyObject_GC_Del(self);
Christian Heimes99a65702016-09-10 23:44:53 +02005099}
5100
5101static PyObject *
5102PySSLSession_richcompare(PyObject *left, PyObject *right, int op)
5103{
5104 int result;
5105
5106 if (left == NULL || right == NULL) {
5107 PyErr_BadInternalCall();
5108 return NULL;
5109 }
5110
5111 if (!PySSLSession_Check(left) || !PySSLSession_Check(right)) {
5112 Py_RETURN_NOTIMPLEMENTED;
5113 }
5114
5115 if (left == right) {
5116 result = 0;
5117 } else {
5118 const unsigned char *left_id, *right_id;
5119 unsigned int left_len, right_len;
5120 left_id = SSL_SESSION_get_id(((PySSLSession *)left)->session,
5121 &left_len);
5122 right_id = SSL_SESSION_get_id(((PySSLSession *)right)->session,
5123 &right_len);
5124 if (left_len == right_len) {
5125 result = memcmp(left_id, right_id, left_len);
5126 } else {
5127 result = 1;
5128 }
5129 }
5130
5131 switch (op) {
5132 case Py_EQ:
5133 if (result == 0) {
5134 Py_RETURN_TRUE;
5135 } else {
5136 Py_RETURN_FALSE;
5137 }
5138 break;
5139 case Py_NE:
5140 if (result != 0) {
5141 Py_RETURN_TRUE;
5142 } else {
5143 Py_RETURN_FALSE;
5144 }
5145 break;
5146 case Py_LT:
5147 case Py_LE:
5148 case Py_GT:
5149 case Py_GE:
5150 Py_RETURN_NOTIMPLEMENTED;
5151 break;
5152 default:
5153 PyErr_BadArgument();
5154 return NULL;
5155 }
5156}
5157
5158static int
5159PySSLSession_traverse(PySSLSession *self, visitproc visit, void *arg)
5160{
5161 Py_VISIT(self->ctx);
5162 return 0;
5163}
5164
5165static int
5166PySSLSession_clear(PySSLSession *self)
5167{
5168 Py_CLEAR(self->ctx);
5169 return 0;
5170}
5171
5172
5173static PyObject *
5174PySSLSession_get_time(PySSLSession *self, void *closure) {
5175 return PyLong_FromLong(SSL_SESSION_get_time(self->session));
5176}
5177
5178PyDoc_STRVAR(PySSLSession_get_time_doc,
5179"Session creation time (seconds since epoch).");
5180
5181
5182static PyObject *
5183PySSLSession_get_timeout(PySSLSession *self, void *closure) {
5184 return PyLong_FromLong(SSL_SESSION_get_timeout(self->session));
5185}
5186
5187PyDoc_STRVAR(PySSLSession_get_timeout_doc,
5188"Session timeout (delta in seconds).");
5189
5190
5191static PyObject *
5192PySSLSession_get_ticket_lifetime_hint(PySSLSession *self, void *closure) {
5193 unsigned long hint = SSL_SESSION_get_ticket_lifetime_hint(self->session);
5194 return PyLong_FromUnsignedLong(hint);
5195}
5196
5197PyDoc_STRVAR(PySSLSession_get_ticket_lifetime_hint_doc,
5198"Ticket life time hint.");
5199
5200
5201static PyObject *
5202PySSLSession_get_session_id(PySSLSession *self, void *closure) {
5203 const unsigned char *id;
5204 unsigned int len;
5205 id = SSL_SESSION_get_id(self->session, &len);
5206 return PyBytes_FromStringAndSize((const char *)id, len);
5207}
5208
5209PyDoc_STRVAR(PySSLSession_get_session_id_doc,
5210"Session id");
5211
5212
5213static PyObject *
5214PySSLSession_get_has_ticket(PySSLSession *self, void *closure) {
5215 if (SSL_SESSION_has_ticket(self->session)) {
5216 Py_RETURN_TRUE;
5217 } else {
5218 Py_RETURN_FALSE;
5219 }
5220}
5221
5222PyDoc_STRVAR(PySSLSession_get_has_ticket_doc,
5223"Does the session contain a ticket?");
5224
5225
5226static PyGetSetDef PySSLSession_getsetlist[] = {
5227 {"has_ticket", (getter) PySSLSession_get_has_ticket, NULL,
5228 PySSLSession_get_has_ticket_doc},
5229 {"id", (getter) PySSLSession_get_session_id, NULL,
5230 PySSLSession_get_session_id_doc},
5231 {"ticket_lifetime_hint", (getter) PySSLSession_get_ticket_lifetime_hint,
5232 NULL, PySSLSession_get_ticket_lifetime_hint_doc},
5233 {"time", (getter) PySSLSession_get_time, NULL,
5234 PySSLSession_get_time_doc},
5235 {"timeout", (getter) PySSLSession_get_timeout, NULL,
5236 PySSLSession_get_timeout_doc},
5237 {NULL}, /* sentinel */
5238};
5239
5240static PyTypeObject PySSLSession_Type = {
5241 PyVarObject_HEAD_INIT(NULL, 0)
5242 "_ssl.Session", /*tp_name*/
5243 sizeof(PySSLSession), /*tp_basicsize*/
5244 0, /*tp_itemsize*/
5245 (destructor)PySSLSession_dealloc, /*tp_dealloc*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005246 0, /*tp_vectorcall_offset*/
Christian Heimes99a65702016-09-10 23:44:53 +02005247 0, /*tp_getattr*/
5248 0, /*tp_setattr*/
Jeroen Demeyer530f5062019-05-31 04:13:39 +02005249 0, /*tp_as_async*/
Christian Heimes99a65702016-09-10 23:44:53 +02005250 0, /*tp_repr*/
5251 0, /*tp_as_number*/
5252 0, /*tp_as_sequence*/
5253 0, /*tp_as_mapping*/
5254 0, /*tp_hash*/
5255 0, /*tp_call*/
5256 0, /*tp_str*/
5257 0, /*tp_getattro*/
5258 0, /*tp_setattro*/
5259 0, /*tp_as_buffer*/
Christian Heimesa5d07652016-09-24 10:48:05 +02005260 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Christian Heimes99a65702016-09-10 23:44:53 +02005261 0, /*tp_doc*/
5262 (traverseproc)PySSLSession_traverse, /*tp_traverse*/
5263 (inquiry)PySSLSession_clear, /*tp_clear*/
5264 PySSLSession_richcompare, /*tp_richcompare*/
5265 0, /*tp_weaklistoffset*/
5266 0, /*tp_iter*/
5267 0, /*tp_iternext*/
5268 0, /*tp_methods*/
5269 0, /*tp_members*/
5270 PySSLSession_getsetlist, /*tp_getset*/
5271};
5272
5273
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005274/* helper routines for seeding the SSL PRNG */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005275/*[clinic input]
5276_ssl.RAND_add
Larry Hastingsdbfdc382015-05-04 06:59:46 -07005277 string as view: Py_buffer(accept={str, buffer})
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005278 entropy: double
5279 /
5280
5281Mix string into the OpenSSL PRNG state.
5282
5283entropy (a float) is a lower bound on the entropy contained in
Chandan Kumar63c2c8a2017-06-09 15:13:58 +05305284string. See RFC 4086.
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005285[clinic start generated code]*/
5286
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005287static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005288_ssl_RAND_add_impl(PyObject *module, Py_buffer *view, double entropy)
Serhiy Storchaka5f31d5c2017-06-10 13:13:51 +03005289/*[clinic end generated code: output=e6dd48df9c9024e9 input=5c33017422828f5c]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005290{
Serhiy Storchaka8490f5a2015-03-20 09:00:36 +02005291 const char *buf;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005292 Py_ssize_t len, written;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005293
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005294 buf = (const char *)view->buf;
5295 len = view->len;
Victor Stinner2e57b4e2014-07-01 16:37:17 +02005296 do {
5297 written = Py_MIN(len, INT_MAX);
5298 RAND_add(buf, (int)written, entropy);
5299 buf += written;
5300 len -= written;
5301 } while (len);
Serhiy Storchaka228b12e2017-01-23 09:47:21 +02005302 Py_RETURN_NONE;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005303}
5304
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005305static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02005306PySSL_RAND(int len, int pseudo)
5307{
5308 int ok;
5309 PyObject *bytes;
5310 unsigned long err;
5311 const char *errstr;
5312 PyObject *v;
5313
Victor Stinner1e81a392013-12-19 16:47:04 +01005314 if (len < 0) {
5315 PyErr_SetString(PyExc_ValueError, "num must be positive");
5316 return NULL;
5317 }
5318
Victor Stinner99c8b162011-05-24 12:05:19 +02005319 bytes = PyBytes_FromStringAndSize(NULL, len);
5320 if (bytes == NULL)
5321 return NULL;
5322 if (pseudo) {
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07005323#ifdef PY_OPENSSL_1_1_API
5324 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5325#else
Victor Stinner99c8b162011-05-24 12:05:19 +02005326 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07005327#endif
Victor Stinner99c8b162011-05-24 12:05:19 +02005328 if (ok == 0 || ok == 1)
5329 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
5330 }
5331 else {
5332 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
5333 if (ok == 1)
5334 return bytes;
5335 }
5336 Py_DECREF(bytes);
5337
5338 err = ERR_get_error();
5339 errstr = ERR_reason_error_string(err);
5340 v = Py_BuildValue("(ks)", err, errstr);
5341 if (v != NULL) {
5342 PyErr_SetObject(PySSLErrorObject, v);
5343 Py_DECREF(v);
5344 }
5345 return NULL;
5346}
5347
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005348/*[clinic input]
5349_ssl.RAND_bytes
5350 n: int
5351 /
5352
5353Generate n cryptographically strong pseudo-random bytes.
5354[clinic start generated code]*/
5355
Victor Stinner99c8b162011-05-24 12:05:19 +02005356static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005357_ssl_RAND_bytes_impl(PyObject *module, int n)
5358/*[clinic end generated code: output=977da635e4838bc7 input=678ddf2872dfebfc]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005359{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005360 return PySSL_RAND(n, 0);
Victor Stinner99c8b162011-05-24 12:05:19 +02005361}
5362
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005363/*[clinic input]
5364_ssl.RAND_pseudo_bytes
5365 n: int
5366 /
5367
5368Generate n pseudo-random bytes.
5369
5370Return a pair (bytes, is_cryptographic). is_cryptographic is True
5371if the bytes generated are cryptographically strong.
5372[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005373
5374static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005375_ssl_RAND_pseudo_bytes_impl(PyObject *module, int n)
5376/*[clinic end generated code: output=b1509e937000e52d input=58312bd53f9bbdd0]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005377{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005378 return PySSL_RAND(n, 1);
Victor Stinner99c8b162011-05-24 12:05:19 +02005379}
5380
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005381/*[clinic input]
5382_ssl.RAND_status
5383
5384Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.
5385
5386It is necessary to seed the PRNG with RAND_add() on some platforms before
5387using the ssl() function.
5388[clinic start generated code]*/
Victor Stinner99c8b162011-05-24 12:05:19 +02005389
5390static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005391_ssl_RAND_status_impl(PyObject *module)
5392/*[clinic end generated code: output=7e0aaa2d39fdc1ad input=8a774b02d1dc81f3]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005393{
Christian Heimes217cfd12007-12-02 14:31:20 +00005394 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005395}
5396
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005397#ifndef OPENSSL_NO_EGD
Christian Heimesa5d07652016-09-24 10:48:05 +02005398/* LCOV_EXCL_START */
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005399/*[clinic input]
5400_ssl.RAND_egd
5401 path: object(converter="PyUnicode_FSConverter")
5402 /
5403
5404Queries the entropy gather daemon (EGD) on the socket named by 'path'.
5405
5406Returns number of bytes read. Raises SSLError if connection to EGD
5407fails or if it does not provide enough data to seed PRNG.
5408[clinic start generated code]*/
5409
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005410static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005411_ssl_RAND_egd_impl(PyObject *module, PyObject *path)
5412/*[clinic end generated code: output=02a67c7c367f52fa input=1aeb7eb948312195]*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005413{
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005414 int bytes = RAND_egd(PyBytes_AsString(path));
Victor Stinnerf9faaad2010-05-16 21:36:37 +00005415 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005416 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00005417 PyErr_SetString(PySSLErrorObject,
5418 "EGD connection failed or EGD did not return "
5419 "enough data to seed the PRNG");
5420 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005421 }
Christian Heimes217cfd12007-12-02 14:31:20 +00005422 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005423}
Christian Heimesa5d07652016-09-24 10:48:05 +02005424/* LCOV_EXCL_STOP */
Benjamin Petersonb8a2f512016-07-06 23:55:15 -07005425#endif /* OPENSSL_NO_EGD */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005426
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005427
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005428
5429/*[clinic input]
5430_ssl.get_default_verify_paths
5431
5432Return search paths and environment vars that are used by SSLContext's set_default_verify_paths() to load default CAs.
5433
5434The values are 'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.
5435[clinic start generated code]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005436
5437static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005438_ssl_get_default_verify_paths_impl(PyObject *module)
5439/*[clinic end generated code: output=e5b62a466271928b input=5210c953d98c3eb5]*/
Christian Heimes6d7ad132013-06-09 18:02:55 +02005440{
5441 PyObject *ofile_env = NULL;
5442 PyObject *ofile = NULL;
5443 PyObject *odir_env = NULL;
5444 PyObject *odir = NULL;
5445
Benjamin Petersond113c962015-07-18 10:59:13 -07005446#define CONVERT(info, target) { \
Christian Heimes6d7ad132013-06-09 18:02:55 +02005447 const char *tmp = (info); \
5448 target = NULL; \
5449 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
5450 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
5451 target = PyBytes_FromString(tmp); } \
5452 if (!target) goto error; \
Benjamin Peterson025a1fd2015-11-14 15:12:38 -08005453 }
Christian Heimes6d7ad132013-06-09 18:02:55 +02005454
Benjamin Petersond113c962015-07-18 10:59:13 -07005455 CONVERT(X509_get_default_cert_file_env(), ofile_env);
5456 CONVERT(X509_get_default_cert_file(), ofile);
5457 CONVERT(X509_get_default_cert_dir_env(), odir_env);
5458 CONVERT(X509_get_default_cert_dir(), odir);
5459#undef CONVERT
Christian Heimes6d7ad132013-06-09 18:02:55 +02005460
Christian Heimes200bb1b2013-06-14 15:14:29 +02005461 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02005462
5463 error:
5464 Py_XDECREF(ofile_env);
5465 Py_XDECREF(ofile);
5466 Py_XDECREF(odir_env);
5467 Py_XDECREF(odir);
5468 return NULL;
5469}
5470
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005471static PyObject*
5472asn1obj2py(ASN1_OBJECT *obj)
5473{
5474 int nid;
5475 const char *ln, *sn;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005476
5477 nid = OBJ_obj2nid(obj);
5478 if (nid == NID_undef) {
5479 PyErr_Format(PyExc_ValueError, "Unknown object");
5480 return NULL;
5481 }
5482 sn = OBJ_nid2sn(nid);
5483 ln = OBJ_nid2ln(nid);
Serhiy Storchakae503ca52017-09-05 01:28:53 +03005484 return Py_BuildValue("issN", nid, sn, ln, _asn1obj2py(obj, 1));
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005485}
5486
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005487/*[clinic input]
5488_ssl.txt2obj
5489 txt: str
5490 name: bool = False
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005491
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005492Lookup NID, short name, long name and OID of an ASN1_OBJECT.
5493
5494By default objects are looked up by OID. With name=True short and
5495long name are also matched.
5496[clinic start generated code]*/
5497
5498static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005499_ssl_txt2obj_impl(PyObject *module, const char *txt, int name)
5500/*[clinic end generated code: output=c38e3991347079c1 input=1c1e7d0aa7c48602]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005501{
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005502 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005503 ASN1_OBJECT *obj;
5504
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005505 obj = OBJ_txt2obj(txt, name ? 0 : 1);
5506 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005507 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005508 return NULL;
5509 }
5510 result = asn1obj2py(obj);
5511 ASN1_OBJECT_free(obj);
5512 return result;
5513}
5514
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005515/*[clinic input]
5516_ssl.nid2obj
5517 nid: int
5518 /
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005519
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005520Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.
5521[clinic start generated code]*/
5522
5523static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005524_ssl_nid2obj_impl(PyObject *module, int nid)
5525/*[clinic end generated code: output=4a98ab691cd4f84a input=51787a3bee7d8f98]*/
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005526{
5527 PyObject *result = NULL;
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005528 ASN1_OBJECT *obj;
5529
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005530 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005531 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005532 return NULL;
5533 }
5534 obj = OBJ_nid2obj(nid);
5535 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01005536 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01005537 return NULL;
5538 }
5539 result = asn1obj2py(obj);
5540 ASN1_OBJECT_free(obj);
5541 return result;
5542}
5543
Christian Heimes46bebee2013-06-09 19:03:31 +02005544#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01005545
5546static PyObject*
5547certEncodingType(DWORD encodingType)
5548{
5549 static PyObject *x509_asn = NULL;
5550 static PyObject *pkcs_7_asn = NULL;
5551
5552 if (x509_asn == NULL) {
5553 x509_asn = PyUnicode_InternFromString("x509_asn");
5554 if (x509_asn == NULL)
5555 return NULL;
5556 }
5557 if (pkcs_7_asn == NULL) {
5558 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
5559 if (pkcs_7_asn == NULL)
5560 return NULL;
5561 }
5562 switch(encodingType) {
5563 case X509_ASN_ENCODING:
5564 Py_INCREF(x509_asn);
5565 return x509_asn;
5566 case PKCS_7_ASN_ENCODING:
5567 Py_INCREF(pkcs_7_asn);
5568 return pkcs_7_asn;
5569 default:
5570 return PyLong_FromLong(encodingType);
5571 }
5572}
5573
5574static PyObject*
5575parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
5576{
5577 CERT_ENHKEY_USAGE *usage;
5578 DWORD size, error, i;
5579 PyObject *retval;
5580
5581 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
5582 error = GetLastError();
5583 if (error == CRYPT_E_NOT_FOUND) {
5584 Py_RETURN_TRUE;
5585 }
5586 return PyErr_SetFromWindowsErr(error);
5587 }
5588
5589 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
5590 if (usage == NULL) {
5591 return PyErr_NoMemory();
5592 }
5593
5594 /* Now get the actual enhanced usage property */
5595 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
5596 PyMem_Free(usage);
5597 error = GetLastError();
5598 if (error == CRYPT_E_NOT_FOUND) {
5599 Py_RETURN_TRUE;
5600 }
5601 return PyErr_SetFromWindowsErr(error);
5602 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005603 retval = PyFrozenSet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005604 if (retval == NULL) {
5605 goto error;
5606 }
5607 for (i = 0; i < usage->cUsageIdentifier; ++i) {
5608 if (usage->rgpszUsageIdentifier[i]) {
5609 PyObject *oid;
5610 int err;
5611 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
5612 if (oid == NULL) {
5613 Py_CLEAR(retval);
5614 goto error;
5615 }
5616 err = PySet_Add(retval, oid);
5617 Py_DECREF(oid);
5618 if (err == -1) {
5619 Py_CLEAR(retval);
5620 goto error;
5621 }
5622 }
5623 }
5624 error:
5625 PyMem_Free(usage);
5626 return retval;
5627}
5628
kctherookied93fbbf2019-03-29 00:59:06 +07005629static HCERTSTORE
5630ssl_collect_certificates(const char *store_name)
5631{
5632/* this function collects the system certificate stores listed in
5633 * system_stores into a collection certificate store for being
5634 * enumerated. The store must be readable to be added to the
5635 * store collection.
5636 */
5637
5638 HCERTSTORE hCollectionStore = NULL, hSystemStore = NULL;
5639 static DWORD system_stores[] = {
5640 CERT_SYSTEM_STORE_LOCAL_MACHINE,
5641 CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE,
5642 CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY,
5643 CERT_SYSTEM_STORE_CURRENT_USER,
5644 CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY,
5645 CERT_SYSTEM_STORE_SERVICES,
5646 CERT_SYSTEM_STORE_USERS};
5647 size_t i, storesAdded;
5648 BOOL result;
5649
5650 hCollectionStore = CertOpenStore(CERT_STORE_PROV_COLLECTION, 0,
5651 (HCRYPTPROV)NULL, 0, NULL);
5652 if (!hCollectionStore) {
5653 return NULL;
5654 }
5655 storesAdded = 0;
5656 for (i = 0; i < sizeof(system_stores) / sizeof(DWORD); i++) {
5657 hSystemStore = CertOpenStore(CERT_STORE_PROV_SYSTEM_A, 0,
5658 (HCRYPTPROV)NULL,
5659 CERT_STORE_READONLY_FLAG |
5660 system_stores[i], store_name);
5661 if (hSystemStore) {
5662 result = CertAddStoreToCollection(hCollectionStore, hSystemStore,
5663 CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG, 0);
5664 if (result) {
5665 ++storesAdded;
5666 }
neoneneed701292019-09-09 21:33:43 +09005667 CertCloseStore(hSystemStore, 0); /* flag must be 0 */
kctherookied93fbbf2019-03-29 00:59:06 +07005668 }
5669 }
5670 if (storesAdded == 0) {
5671 CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG);
5672 return NULL;
5673 }
5674
5675 return hCollectionStore;
5676}
5677
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005678/*[clinic input]
5679_ssl.enum_certificates
5680 store_name: str
5681
5682Retrieve certificates from Windows' cert store.
5683
5684store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5685more cert storages, too. The function returns a list of (bytes,
5686encoding_type, trust) tuples. The encoding_type flag can be interpreted
5687with X509_ASN_ENCODING or PKCS_7_ASN_ENCODING. The trust setting is either
5688a set of OIDs or the boolean True.
5689[clinic start generated code]*/
Bill Janssen40a0f662008-08-12 16:56:25 +00005690
Christian Heimes46bebee2013-06-09 19:03:31 +02005691static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005692_ssl_enum_certificates_impl(PyObject *module, const char *store_name)
5693/*[clinic end generated code: output=5134dc8bb3a3c893 input=915f60d70461ea4e]*/
Christian Heimes46bebee2013-06-09 19:03:31 +02005694{
kctherookied93fbbf2019-03-29 00:59:06 +07005695 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005696 PCCERT_CONTEXT pCertCtx = NULL;
5697 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005698 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02005699
Christian Heimes915cd3f2019-09-09 18:06:55 +02005700 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005701 if (result == NULL) {
5702 return NULL;
5703 }
kctherookied93fbbf2019-03-29 00:59:06 +07005704 hCollectionStore = ssl_collect_certificates(store_name);
5705 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005706 Py_DECREF(result);
5707 return PyErr_SetFromWindowsErr(GetLastError());
5708 }
5709
kctherookied93fbbf2019-03-29 00:59:06 +07005710 while (pCertCtx = CertEnumCertificatesInStore(hCollectionStore, pCertCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005711 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
5712 pCertCtx->cbCertEncoded);
5713 if (!cert) {
5714 Py_CLEAR(result);
5715 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005716 }
Christian Heimes44109d72013-11-22 01:51:30 +01005717 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
5718 Py_CLEAR(result);
5719 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005720 }
Christian Heimes44109d72013-11-22 01:51:30 +01005721 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
5722 if (keyusage == Py_True) {
5723 Py_DECREF(keyusage);
5724 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02005725 }
Christian Heimes44109d72013-11-22 01:51:30 +01005726 if (keyusage == NULL) {
5727 Py_CLEAR(result);
5728 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02005729 }
Christian Heimes44109d72013-11-22 01:51:30 +01005730 if ((tup = PyTuple_New(3)) == NULL) {
5731 Py_CLEAR(result);
5732 break;
5733 }
5734 PyTuple_SET_ITEM(tup, 0, cert);
5735 cert = NULL;
5736 PyTuple_SET_ITEM(tup, 1, enc);
5737 enc = NULL;
5738 PyTuple_SET_ITEM(tup, 2, keyusage);
5739 keyusage = NULL;
Christian Heimes915cd3f2019-09-09 18:06:55 +02005740 if (PySet_Add(result, tup) == -1) {
5741 Py_CLEAR(result);
5742 Py_CLEAR(tup);
5743 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005744 }
5745 Py_CLEAR(tup);
5746 }
5747 if (pCertCtx) {
5748 /* loop ended with an error, need to clean up context manually */
5749 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02005750 }
5751
5752 /* In error cases cert, enc and tup may not be NULL */
5753 Py_XDECREF(cert);
5754 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01005755 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02005756 Py_XDECREF(tup);
5757
kctherookied93fbbf2019-03-29 00:59:06 +07005758 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5759 associated with the store, in this case our collection store and the
5760 associated system stores. */
5761 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005762 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01005763 Py_XDECREF(result);
5764 return PyErr_SetFromWindowsErr(GetLastError());
5765 }
kctherookied93fbbf2019-03-29 00:59:06 +07005766
Christian Heimes915cd3f2019-09-09 18:06:55 +02005767 /* convert set to list */
5768 if (result == NULL) {
5769 return NULL;
5770 } else {
5771 PyObject *lst = PySequence_List(result);
5772 Py_DECREF(result);
5773 return lst;
5774 }
Christian Heimes44109d72013-11-22 01:51:30 +01005775}
5776
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005777/*[clinic input]
5778_ssl.enum_crls
5779 store_name: str
5780
5781Retrieve CRLs from Windows' cert store.
5782
5783store_name may be one of 'CA', 'ROOT' or 'MY'. The system may provide
5784more cert storages, too. The function returns a list of (bytes,
5785encoding_type) tuples. The encoding_type flag can be interpreted with
5786X509_ASN_ENCODING or PKCS_7_ASN_ENCODING.
5787[clinic start generated code]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005788
5789static PyObject *
Serhiy Storchaka1a2b24f2016-07-07 17:35:15 +03005790_ssl_enum_crls_impl(PyObject *module, const char *store_name)
5791/*[clinic end generated code: output=bce467f60ccd03b6 input=a1f1d7629f1c5d3d]*/
Christian Heimes44109d72013-11-22 01:51:30 +01005792{
kctherookied93fbbf2019-03-29 00:59:06 +07005793 HCERTSTORE hCollectionStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01005794 PCCRL_CONTEXT pCrlCtx = NULL;
5795 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
5796 PyObject *result = NULL;
5797
Christian Heimes915cd3f2019-09-09 18:06:55 +02005798 result = PySet_New(NULL);
Christian Heimes44109d72013-11-22 01:51:30 +01005799 if (result == NULL) {
5800 return NULL;
5801 }
kctherookied93fbbf2019-03-29 00:59:06 +07005802 hCollectionStore = ssl_collect_certificates(store_name);
5803 if (hCollectionStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02005804 Py_DECREF(result);
5805 return PyErr_SetFromWindowsErr(GetLastError());
5806 }
Christian Heimes44109d72013-11-22 01:51:30 +01005807
kctherookied93fbbf2019-03-29 00:59:06 +07005808 while (pCrlCtx = CertEnumCRLsInStore(hCollectionStore, pCrlCtx)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005809 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
5810 pCrlCtx->cbCrlEncoded);
5811 if (!crl) {
5812 Py_CLEAR(result);
5813 break;
5814 }
5815 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
5816 Py_CLEAR(result);
5817 break;
5818 }
5819 if ((tup = PyTuple_New(2)) == NULL) {
5820 Py_CLEAR(result);
5821 break;
5822 }
5823 PyTuple_SET_ITEM(tup, 0, crl);
5824 crl = NULL;
5825 PyTuple_SET_ITEM(tup, 1, enc);
5826 enc = NULL;
5827
Christian Heimes915cd3f2019-09-09 18:06:55 +02005828 if (PySet_Add(result, tup) == -1) {
5829 Py_CLEAR(result);
5830 Py_CLEAR(tup);
5831 break;
Christian Heimes44109d72013-11-22 01:51:30 +01005832 }
5833 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02005834 }
Christian Heimes44109d72013-11-22 01:51:30 +01005835 if (pCrlCtx) {
5836 /* loop ended with an error, need to clean up context manually */
5837 CertFreeCRLContext(pCrlCtx);
5838 }
5839
5840 /* In error cases cert, enc and tup may not be NULL */
5841 Py_XDECREF(crl);
5842 Py_XDECREF(enc);
5843 Py_XDECREF(tup);
5844
kctherookied93fbbf2019-03-29 00:59:06 +07005845 /* CERT_CLOSE_STORE_FORCE_FLAG forces freeing of memory for all contexts
5846 associated with the store, in this case our collection store and the
5847 associated system stores. */
5848 if (!CertCloseStore(hCollectionStore, CERT_CLOSE_STORE_FORCE_FLAG)) {
Christian Heimes44109d72013-11-22 01:51:30 +01005849 /* This error case might shadow another exception.*/
5850 Py_XDECREF(result);
5851 return PyErr_SetFromWindowsErr(GetLastError());
5852 }
Christian Heimes915cd3f2019-09-09 18:06:55 +02005853 /* convert set to list */
5854 if (result == NULL) {
5855 return NULL;
5856 } else {
5857 PyObject *lst = PySequence_List(result);
5858 Py_DECREF(result);
5859 return lst;
5860 }
Christian Heimes46bebee2013-06-09 19:03:31 +02005861}
Christian Heimes44109d72013-11-22 01:51:30 +01005862
5863#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00005864
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005865/* List of functions exported by this module. */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005866static PyMethodDef PySSL_methods[] = {
Serhiy Storchaka4b7b82f2015-05-03 16:14:08 +03005867 _SSL__TEST_DECODE_CERT_METHODDEF
5868 _SSL_RAND_ADD_METHODDEF
5869 _SSL_RAND_BYTES_METHODDEF
5870 _SSL_RAND_PSEUDO_BYTES_METHODDEF
5871 _SSL_RAND_EGD_METHODDEF
5872 _SSL_RAND_STATUS_METHODDEF
5873 _SSL_GET_DEFAULT_VERIFY_PATHS_METHODDEF
5874 _SSL_ENUM_CERTIFICATES_METHODDEF
5875 _SSL_ENUM_CRLS_METHODDEF
5876 _SSL_TXT2OBJ_METHODDEF
5877 _SSL_NID2OBJ_METHODDEF
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005878 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005879};
5880
5881
Christian Heimes598894f2016-09-05 23:19:05 +02005882#ifdef HAVE_OPENSSL_CRYPTO_LOCK
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005883
5884/* an implementation of OpenSSL threading operations in terms
Christian Heimes598894f2016-09-05 23:19:05 +02005885 * of the Python C thread library
5886 * Only used up to 1.0.2. OpenSSL 1.1.0+ has its own locking code.
5887 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005888
5889static PyThread_type_lock *_ssl_locks = NULL;
5890
Christian Heimes4d98ca92013-08-19 17:36:29 +02005891#if OPENSSL_VERSION_NUMBER >= 0x10000000
5892/* use new CRYPTO_THREADID API. */
5893static void
5894_ssl_threadid_callback(CRYPTO_THREADID *id)
5895{
Serhiy Storchakaaefa7eb2017-03-23 15:48:39 +02005896 CRYPTO_THREADID_set_numeric(id, PyThread_get_thread_ident());
Christian Heimes4d98ca92013-08-19 17:36:29 +02005897}
5898#else
5899/* deprecated CRYPTO_set_id_callback() API. */
5900static unsigned long
5901_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005902 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005903}
Christian Heimes4d98ca92013-08-19 17:36:29 +02005904#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005905
Bill Janssen6e027db2007-11-15 22:23:56 +00005906static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005907 (int mode, int n, const char *file, int line) {
5908 /* this function is needed to perform locking on shared data
5909 structures. (Note that OpenSSL uses a number of global data
5910 structures that will be implicitly shared whenever multiple
5911 threads use OpenSSL.) Multi-threaded applications will
5912 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005913
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005914 locking_function() must be able to handle up to
5915 CRYPTO_num_locks() different mutex locks. It sets the n-th
5916 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005917
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005918 file and line are the file number of the function setting the
5919 lock. They can be useful for debugging.
5920 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005921
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005922 if ((_ssl_locks == NULL) ||
5923 (n < 0) || ((unsigned)n >= _ssl_locks_count))
5924 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005925
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005926 if (mode & CRYPTO_LOCK) {
5927 PyThread_acquire_lock(_ssl_locks[n], 1);
5928 } else {
5929 PyThread_release_lock(_ssl_locks[n]);
5930 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005931}
5932
5933static int _setup_ssl_threads(void) {
5934
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005935 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005936
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005937 if (_ssl_locks == NULL) {
5938 _ssl_locks_count = CRYPTO_num_locks();
Christian Heimesf6365e32016-09-13 20:48:13 +02005939 _ssl_locks = PyMem_Calloc(_ssl_locks_count,
5940 sizeof(PyThread_type_lock));
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005941 if (_ssl_locks == NULL) {
5942 PyErr_NoMemory();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005943 return 0;
Serhiy Storchaka1a1ff292015-02-16 13:28:22 +02005944 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005945 for (i = 0; i < _ssl_locks_count; i++) {
5946 _ssl_locks[i] = PyThread_allocate_lock();
5947 if (_ssl_locks[i] == NULL) {
5948 unsigned int j;
5949 for (j = 0; j < i; j++) {
5950 PyThread_free_lock(_ssl_locks[j]);
5951 }
Victor Stinnerb6404912013-07-07 16:21:41 +02005952 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005953 return 0;
5954 }
5955 }
5956 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005957#if OPENSSL_VERSION_NUMBER >= 0x10000000
5958 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
5959#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005960 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02005961#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005962 }
5963 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005964}
5965
Antoine Pitroua6a4dc82017-09-07 18:56:24 +02005966#endif /* HAVE_OPENSSL_CRYPTO_LOCK for OpenSSL < 1.1.0 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00005967
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005968PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005969"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00005970for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00005971
Martin v. Löwis1a214512008-06-11 05:26:20 +00005972
5973static struct PyModuleDef _sslmodule = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00005974 PyModuleDef_HEAD_INIT,
5975 "_ssl",
5976 module_doc,
5977 -1,
5978 PySSL_methods,
5979 NULL,
5980 NULL,
5981 NULL,
5982 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00005983};
5984
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02005985
5986static void
5987parse_openssl_version(unsigned long libver,
5988 unsigned int *major, unsigned int *minor,
5989 unsigned int *fix, unsigned int *patch,
5990 unsigned int *status)
5991{
5992 *status = libver & 0xF;
5993 libver >>= 4;
5994 *patch = libver & 0xFF;
5995 libver >>= 8;
5996 *fix = libver & 0xFF;
5997 libver >>= 8;
5998 *minor = libver & 0xFF;
5999 libver >>= 8;
6000 *major = libver & 0xFF;
6001}
6002
Mark Hammondfe51c6d2002-08-02 02:27:13 +00006003PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00006004PyInit__ssl(void)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006005{
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006006 PyObject *m, *d, *r, *bases;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006007 unsigned long libver;
6008 unsigned int major, minor, fix, patch, status;
6009 PySocketModule_APIObject *socket_api;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006010 struct py_ssl_error_code *errcode;
6011 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006012
Antoine Pitrou152efa22010-05-16 18:19:27 +00006013 if (PyType_Ready(&PySSLContext_Type) < 0)
6014 return NULL;
6015 if (PyType_Ready(&PySSLSocket_Type) < 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006016 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02006017 if (PyType_Ready(&PySSLMemoryBIO_Type) < 0)
6018 return NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02006019 if (PyType_Ready(&PySSLSession_Type) < 0)
6020 return NULL;
6021
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006022
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006023 m = PyModule_Create(&_sslmodule);
6024 if (m == NULL)
6025 return NULL;
6026 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006027
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006028 /* Load _socket module and its C API */
6029 socket_api = PySocketModule_ImportModuleAndAPI();
6030 if (!socket_api)
6031 return NULL;
6032 PySocketModule = *socket_api;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006033
Christian Heimesc941e622017-09-05 15:47:11 +02006034#ifndef OPENSSL_VERSION_1_1
6035 /* Load all algorithms and initialize cpuid */
6036 OPENSSL_add_all_algorithms_noconf();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006037 /* Init OpenSSL */
6038 SSL_load_error_strings();
6039 SSL_library_init();
Christian Heimesc941e622017-09-05 15:47:11 +02006040#endif
6041
Christian Heimes598894f2016-09-05 23:19:05 +02006042#ifdef HAVE_OPENSSL_CRYPTO_LOCK
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006043 /* note that this will start threading if not already started */
6044 if (!_setup_ssl_threads()) {
6045 return NULL;
6046 }
Christian Heimesc087a262020-05-15 20:55:25 +02006047#elif OPENSSL_VERSION_1_1
Christian Heimes598894f2016-09-05 23:19:05 +02006048 /* OpenSSL 1.1.0 builtin thread support is enabled */
6049 _ssl_locks_count++;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00006050#endif
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006051
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006052 /* Add symbols to module dict */
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006053 sslerror_type_slots[0].pfunc = PyExc_OSError;
6054 PySSLErrorObject = PyType_FromSpec(&sslerror_type_spec);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006055 if (PySSLErrorObject == NULL)
6056 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006057
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006058 /* ssl.CertificateError used to be a subclass of ValueError */
6059 bases = Py_BuildValue("OO", PySSLErrorObject, PyExc_ValueError);
6060 if (bases == NULL)
6061 return NULL;
6062 PySSLCertVerificationErrorObject = PyErr_NewExceptionWithDoc(
6063 "ssl.SSLCertVerificationError", SSLCertVerificationError_doc,
6064 bases, NULL);
6065 Py_DECREF(bases);
Antoine Pitrou41032a62011-10-27 23:56:55 +02006066 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
6067 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
6068 PySSLErrorObject, NULL);
6069 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
6070 "ssl.SSLWantReadError", SSLWantReadError_doc,
6071 PySSLErrorObject, NULL);
6072 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
6073 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
6074 PySSLErrorObject, NULL);
6075 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
6076 "ssl.SSLSyscallError", SSLSyscallError_doc,
6077 PySSLErrorObject, NULL);
6078 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
6079 "ssl.SSLEOFError", SSLEOFError_doc,
6080 PySSLErrorObject, NULL);
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006081 if (PySSLCertVerificationErrorObject == NULL
6082 || PySSLZeroReturnErrorObject == NULL
Antoine Pitrou41032a62011-10-27 23:56:55 +02006083 || PySSLWantReadErrorObject == NULL
6084 || PySSLWantWriteErrorObject == NULL
6085 || PySSLSyscallErrorObject == NULL
6086 || PySSLEOFErrorObject == NULL)
6087 return NULL;
6088 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
Christian Heimesb3ad0e52017-09-08 12:00:19 -07006089 || PyDict_SetItemString(d, "SSLCertVerificationError",
6090 PySSLCertVerificationErrorObject) != 0
Antoine Pitrou41032a62011-10-27 23:56:55 +02006091 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
6092 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
6093 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
6094 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
6095 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006096 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00006097 if (PyDict_SetItemString(d, "_SSLContext",
6098 (PyObject *)&PySSLContext_Type) != 0)
6099 return NULL;
6100 if (PyDict_SetItemString(d, "_SSLSocket",
6101 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006102 return NULL;
Antoine Pitroub1fdf472014-10-05 20:41:53 +02006103 if (PyDict_SetItemString(d, "MemoryBIO",
6104 (PyObject *)&PySSLMemoryBIO_Type) != 0)
6105 return NULL;
Christian Heimes99a65702016-09-10 23:44:53 +02006106 if (PyDict_SetItemString(d, "SSLSession",
6107 (PyObject *)&PySSLSession_Type) != 0)
6108 return NULL;
6109
Christian Heimes892d66e2018-01-29 14:10:18 +01006110 PyModule_AddStringConstant(m, "_DEFAULT_CIPHERS",
6111 PY_SSL_DEFAULT_CIPHER_STRING);
6112
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006113 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
6114 PY_SSL_ERROR_ZERO_RETURN);
6115 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
6116 PY_SSL_ERROR_WANT_READ);
6117 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
6118 PY_SSL_ERROR_WANT_WRITE);
6119 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
6120 PY_SSL_ERROR_WANT_X509_LOOKUP);
6121 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
6122 PY_SSL_ERROR_SYSCALL);
6123 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
6124 PY_SSL_ERROR_SSL);
6125 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
6126 PY_SSL_ERROR_WANT_CONNECT);
6127 /* non ssl.h errorcodes */
6128 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
6129 PY_SSL_ERROR_EOF);
6130 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
6131 PY_SSL_ERROR_INVALID_ERROR_CODE);
6132 /* cert requirements */
6133 PyModule_AddIntConstant(m, "CERT_NONE",
6134 PY_SSL_CERT_NONE);
6135 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
6136 PY_SSL_CERT_OPTIONAL);
6137 PyModule_AddIntConstant(m, "CERT_REQUIRED",
6138 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01006139 /* CRL verification for verification_flags */
6140 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
6141 0);
6142 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
6143 X509_V_FLAG_CRL_CHECK);
6144 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
6145 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
6146 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
6147 X509_V_FLAG_X509_STRICT);
Benjamin Peterson990fcaa2015-03-04 22:49:41 -05006148#ifdef X509_V_FLAG_TRUSTED_FIRST
6149 PyModule_AddIntConstant(m, "VERIFY_X509_TRUSTED_FIRST",
6150 X509_V_FLAG_TRUSTED_FIRST);
6151#endif
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00006152
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006153 /* Alert Descriptions from ssl.h */
6154 /* note RESERVED constants no longer intended for use have been removed */
6155 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
6156
6157#define ADD_AD_CONSTANT(s) \
6158 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
6159 SSL_AD_##s)
6160
6161 ADD_AD_CONSTANT(CLOSE_NOTIFY);
6162 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
6163 ADD_AD_CONSTANT(BAD_RECORD_MAC);
6164 ADD_AD_CONSTANT(RECORD_OVERFLOW);
6165 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
6166 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
6167 ADD_AD_CONSTANT(BAD_CERTIFICATE);
6168 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
6169 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
6170 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
6171 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
6172 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
6173 ADD_AD_CONSTANT(UNKNOWN_CA);
6174 ADD_AD_CONSTANT(ACCESS_DENIED);
6175 ADD_AD_CONSTANT(DECODE_ERROR);
6176 ADD_AD_CONSTANT(DECRYPT_ERROR);
6177 ADD_AD_CONSTANT(PROTOCOL_VERSION);
6178 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
6179 ADD_AD_CONSTANT(INTERNAL_ERROR);
6180 ADD_AD_CONSTANT(USER_CANCELLED);
6181 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006182 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01006183#ifdef SSL_AD_UNSUPPORTED_EXTENSION
6184 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
6185#endif
6186#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
6187 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
6188#endif
6189#ifdef SSL_AD_UNRECOGNIZED_NAME
6190 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
6191#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01006192#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
6193 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
6194#endif
6195#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
6196 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
6197#endif
6198#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
6199 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
6200#endif
6201
6202#undef ADD_AD_CONSTANT
6203
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006204 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02006205#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006206 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
6207 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02006208#endif
Benjamin Petersone32467c2014-12-05 21:59:35 -05006209#ifndef OPENSSL_NO_SSL3
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006210 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
6211 PY_SSL_VERSION_SSL3);
Benjamin Petersone32467c2014-12-05 21:59:35 -05006212#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006213 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
Christian Heimes598894f2016-09-05 23:19:05 +02006214 PY_SSL_VERSION_TLS);
6215 PyModule_AddIntConstant(m, "PROTOCOL_TLS",
6216 PY_SSL_VERSION_TLS);
Christian Heimes5fe668c2016-09-12 00:01:11 +02006217 PyModule_AddIntConstant(m, "PROTOCOL_TLS_CLIENT",
6218 PY_SSL_VERSION_TLS_CLIENT);
6219 PyModule_AddIntConstant(m, "PROTOCOL_TLS_SERVER",
6220 PY_SSL_VERSION_TLS_SERVER);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006221 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
6222 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006223 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
6224 PY_SSL_VERSION_TLS1_1);
6225 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
6226 PY_SSL_VERSION_TLS1_2);
Antoine Pitrou04f6a322010-04-05 21:40:07 +00006227
Antoine Pitroub5218772010-05-21 09:56:06 +00006228 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01006229 PyModule_AddIntConstant(m, "OP_ALL",
6230 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00006231 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
6232 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
6233 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01006234 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
6235 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006236#ifdef SSL_OP_NO_TLSv1_3
6237 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", SSL_OP_NO_TLSv1_3);
6238#else
6239 PyModule_AddIntConstant(m, "OP_NO_TLSv1_3", 0);
6240#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01006241 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
6242 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01006243 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Christian Heimes99a65702016-09-10 23:44:53 +02006244 PyModule_AddIntConstant(m, "OP_NO_TICKET", SSL_OP_NO_TICKET);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006245#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01006246 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01006247#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01006248#ifdef SSL_OP_NO_COMPRESSION
6249 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
6250 SSL_OP_NO_COMPRESSION);
6251#endif
Christian Heimes05d9fe32018-02-27 08:55:39 +01006252#ifdef SSL_OP_ENABLE_MIDDLEBOX_COMPAT
6253 PyModule_AddIntConstant(m, "OP_ENABLE_MIDDLEBOX_COMPAT",
6254 SSL_OP_ENABLE_MIDDLEBOX_COMPAT);
6255#endif
Christian Heimes67c48012018-05-15 16:25:40 -04006256#ifdef SSL_OP_NO_RENEGOTIATION
6257 PyModule_AddIntConstant(m, "OP_NO_RENEGOTIATION",
6258 SSL_OP_NO_RENEGOTIATION);
6259#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00006260
Christian Heimes61d478c2018-01-27 15:51:38 +01006261#ifdef X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT
6262 PyModule_AddIntConstant(m, "HOSTFLAG_ALWAYS_CHECK_SUBJECT",
6263 X509_CHECK_FLAG_ALWAYS_CHECK_SUBJECT);
6264#endif
6265#ifdef X509_CHECK_FLAG_NEVER_CHECK_SUBJECT
6266 PyModule_AddIntConstant(m, "HOSTFLAG_NEVER_CHECK_SUBJECT",
6267 X509_CHECK_FLAG_NEVER_CHECK_SUBJECT);
6268#endif
6269#ifdef X509_CHECK_FLAG_NO_WILDCARDS
6270 PyModule_AddIntConstant(m, "HOSTFLAG_NO_WILDCARDS",
6271 X509_CHECK_FLAG_NO_WILDCARDS);
6272#endif
6273#ifdef X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS
6274 PyModule_AddIntConstant(m, "HOSTFLAG_NO_PARTIAL_WILDCARDS",
6275 X509_CHECK_FLAG_NO_PARTIAL_WILDCARDS);
6276#endif
6277#ifdef X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS
6278 PyModule_AddIntConstant(m, "HOSTFLAG_MULTI_LABEL_WILDCARDS",
6279 X509_CHECK_FLAG_MULTI_LABEL_WILDCARDS);
6280#endif
6281#ifdef X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS
6282 PyModule_AddIntConstant(m, "HOSTFLAG_SINGLE_LABEL_SUBDOMAINS",
6283 X509_CHECK_FLAG_SINGLE_LABEL_SUBDOMAINS);
6284#endif
6285
Christian Heimes698dde12018-02-27 11:54:43 +01006286 /* protocol versions */
6287 PyModule_AddIntConstant(m, "PROTO_MINIMUM_SUPPORTED",
6288 PY_PROTO_MINIMUM_SUPPORTED);
6289 PyModule_AddIntConstant(m, "PROTO_MAXIMUM_SUPPORTED",
6290 PY_PROTO_MAXIMUM_SUPPORTED);
6291 PyModule_AddIntConstant(m, "PROTO_SSLv3", PY_PROTO_SSLv3);
6292 PyModule_AddIntConstant(m, "PROTO_TLSv1", PY_PROTO_TLSv1);
6293 PyModule_AddIntConstant(m, "PROTO_TLSv1_1", PY_PROTO_TLSv1_1);
6294 PyModule_AddIntConstant(m, "PROTO_TLSv1_2", PY_PROTO_TLSv1_2);
6295 PyModule_AddIntConstant(m, "PROTO_TLSv1_3", PY_PROTO_TLSv1_3);
Antoine Pitroud5323212010-10-22 18:19:07 +00006296
Victor Stinnerb37672d2018-11-22 03:37:50 +01006297#define addbool(m, key, value) \
6298 do { \
6299 PyObject *bool_obj = (value) ? Py_True : Py_False; \
6300 Py_INCREF(bool_obj); \
6301 PyModule_AddObject((m), (key), bool_obj); \
6302 } while (0)
Christian Heimes698dde12018-02-27 11:54:43 +01006303
6304#if HAVE_SNI
6305 addbool(m, "HAS_SNI", 1);
Antoine Pitrou501da612011-12-21 09:27:41 +01006306#else
Christian Heimes698dde12018-02-27 11:54:43 +01006307 addbool(m, "HAS_SNI", 0);
Antoine Pitrou501da612011-12-21 09:27:41 +01006308#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006309
6310 addbool(m, "HAS_TLS_UNIQUE", 1);
6311
6312#ifndef OPENSSL_NO_ECDH
6313 addbool(m, "HAS_ECDH", 1);
6314#else
6315 addbool(m, "HAS_ECDH", 0);
6316#endif
Antoine Pitrou501da612011-12-21 09:27:41 +01006317
Christian Heimes29eab552018-02-25 12:31:33 +01006318#if HAVE_NPN
Christian Heimes698dde12018-02-27 11:54:43 +01006319 addbool(m, "HAS_NPN", 1);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006320#else
Christian Heimes698dde12018-02-27 11:54:43 +01006321 addbool(m, "HAS_NPN", 0);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006322#endif
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01006323
Christian Heimes29eab552018-02-25 12:31:33 +01006324#if HAVE_ALPN
Christian Heimes698dde12018-02-27 11:54:43 +01006325 addbool(m, "HAS_ALPN", 1);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006326#else
Christian Heimes698dde12018-02-27 11:54:43 +01006327 addbool(m, "HAS_ALPN", 0);
Benjamin Petersoncca27322015-01-23 16:35:37 -05006328#endif
Christian Heimes698dde12018-02-27 11:54:43 +01006329
6330#if defined(SSL2_VERSION) && !defined(OPENSSL_NO_SSL2)
6331 addbool(m, "HAS_SSLv2", 1);
6332#else
6333 addbool(m, "HAS_SSLv2", 0);
6334#endif
6335
6336#if defined(SSL3_VERSION) && !defined(OPENSSL_NO_SSL3)
6337 addbool(m, "HAS_SSLv3", 1);
6338#else
6339 addbool(m, "HAS_SSLv3", 0);
6340#endif
6341
6342#if defined(TLS1_VERSION) && !defined(OPENSSL_NO_TLS1)
6343 addbool(m, "HAS_TLSv1", 1);
6344#else
6345 addbool(m, "HAS_TLSv1", 0);
6346#endif
6347
6348#if defined(TLS1_1_VERSION) && !defined(OPENSSL_NO_TLS1_1)
6349 addbool(m, "HAS_TLSv1_1", 1);
6350#else
6351 addbool(m, "HAS_TLSv1_1", 0);
6352#endif
6353
6354#if defined(TLS1_2_VERSION) && !defined(OPENSSL_NO_TLS1_2)
6355 addbool(m, "HAS_TLSv1_2", 1);
6356#else
6357 addbool(m, "HAS_TLSv1_2", 0);
6358#endif
Benjamin Petersoncca27322015-01-23 16:35:37 -05006359
Christian Heimescb5b68a2017-09-07 18:07:00 -07006360#if defined(TLS1_3_VERSION) && !defined(OPENSSL_NO_TLS1_3)
Christian Heimes698dde12018-02-27 11:54:43 +01006361 addbool(m, "HAS_TLSv1_3", 1);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006362#else
Christian Heimes698dde12018-02-27 11:54:43 +01006363 addbool(m, "HAS_TLSv1_3", 0);
Christian Heimescb5b68a2017-09-07 18:07:00 -07006364#endif
Christian Heimescb5b68a2017-09-07 18:07:00 -07006365
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02006366 /* Mappings for error codes */
6367 err_codes_to_names = PyDict_New();
6368 err_names_to_codes = PyDict_New();
6369 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
6370 return NULL;
6371 errcode = error_codes;
6372 while (errcode->mnemonic != NULL) {
6373 PyObject *mnemo, *key;
6374 mnemo = PyUnicode_FromString(errcode->mnemonic);
6375 key = Py_BuildValue("ii", errcode->library, errcode->reason);
6376 if (mnemo == NULL || key == NULL)
6377 return NULL;
6378 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
6379 return NULL;
6380 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
6381 return NULL;
6382 Py_DECREF(key);
6383 Py_DECREF(mnemo);
6384 errcode++;
6385 }
6386 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
6387 return NULL;
6388 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
6389 return NULL;
6390
6391 lib_codes_to_names = PyDict_New();
6392 if (lib_codes_to_names == NULL)
6393 return NULL;
6394 libcode = library_codes;
6395 while (libcode->library != NULL) {
6396 PyObject *mnemo, *key;
6397 key = PyLong_FromLong(libcode->code);
6398 mnemo = PyUnicode_FromString(libcode->library);
6399 if (key == NULL || mnemo == NULL)
6400 return NULL;
6401 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
6402 return NULL;
6403 Py_DECREF(key);
6404 Py_DECREF(mnemo);
6405 libcode++;
6406 }
6407 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
6408 return NULL;
Victor Stinner4569cd52013-06-23 14:58:43 +02006409
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006410 /* OpenSSL version */
6411 /* SSLeay() gives us the version of the library linked against,
6412 which could be different from the headers version.
6413 */
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07006414 libver = OpenSSL_version_num();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006415 r = PyLong_FromUnsignedLong(libver);
6416 if (r == NULL)
6417 return NULL;
6418 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
6419 return NULL;
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006420 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006421 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6422 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
6423 return NULL;
Miss Islington (bot)24a88b02020-06-01 00:18:39 -07006424 r = PyUnicode_FromString(OpenSSL_version(OPENSSL_VERSION));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006425 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
6426 return NULL;
Antoine Pitrou04f6a322010-04-05 21:40:07 +00006427
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02006428 libver = OPENSSL_VERSION_NUMBER;
6429 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
6430 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
6431 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
6432 return NULL;
6433
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00006434 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00006435}