blob: a370b1b41e2e29f4b071184e33a17c73dc3a6a1b [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
17#include "Python.h"
Thomas Woutersed03b412007-08-28 21:37:11 +000018
Thomas Wouters1b7f8912007-09-19 03:06:30 +000019#ifdef WITH_THREAD
20#include "pythread.h"
Christian Heimesf77b4b22013-08-21 13:26:05 +020021
Christian Heimesf77b4b22013-08-21 13:26:05 +020022
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020023#define PySSL_BEGIN_ALLOW_THREADS_S(save) \
24 do { if (_ssl_locks_count>0) { (save) = PyEval_SaveThread(); } } while (0)
25#define PySSL_END_ALLOW_THREADS_S(save) \
26 do { if (_ssl_locks_count>0) { PyEval_RestoreThread(save); } } while (0)
Thomas Wouters1b7f8912007-09-19 03:06:30 +000027#define PySSL_BEGIN_ALLOW_THREADS { \
Antoine Pitroucbb82eb2010-05-05 15:57:33 +000028 PyThreadState *_save = NULL; \
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020029 PySSL_BEGIN_ALLOW_THREADS_S(_save);
30#define PySSL_BLOCK_THREADS PySSL_END_ALLOW_THREADS_S(_save);
31#define PySSL_UNBLOCK_THREADS PySSL_BEGIN_ALLOW_THREADS_S(_save);
32#define PySSL_END_ALLOW_THREADS PySSL_END_ALLOW_THREADS_S(_save); }
Thomas Wouters1b7f8912007-09-19 03:06:30 +000033
Antoine Pitroucbb82eb2010-05-05 15:57:33 +000034#else /* no WITH_THREAD */
Thomas Wouters1b7f8912007-09-19 03:06:30 +000035
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +020036#define PySSL_BEGIN_ALLOW_THREADS_S(save)
37#define PySSL_END_ALLOW_THREADS_S(save)
Thomas Wouters1b7f8912007-09-19 03:06:30 +000038#define PySSL_BEGIN_ALLOW_THREADS
39#define PySSL_BLOCK_THREADS
40#define PySSL_UNBLOCK_THREADS
41#define PySSL_END_ALLOW_THREADS
42
43#endif
44
Antoine Pitrou2463e5f2013-03-28 22:24:43 +010045/* Include symbols from _socket module */
46#include "socketmodule.h"
47
48static PySocketModule_APIObject PySocketModule;
49
50#if defined(HAVE_POLL_H)
51#include <poll.h>
52#elif defined(HAVE_SYS_POLL_H)
53#include <sys/poll.h>
54#endif
55
56/* Include OpenSSL header files */
57#include "openssl/rsa.h"
58#include "openssl/crypto.h"
59#include "openssl/x509.h"
60#include "openssl/x509v3.h"
61#include "openssl/pem.h"
62#include "openssl/ssl.h"
63#include "openssl/err.h"
64#include "openssl/rand.h"
65
66/* SSL error object */
67static PyObject *PySSLErrorObject;
68static PyObject *PySSLZeroReturnErrorObject;
69static PyObject *PySSLWantReadErrorObject;
70static PyObject *PySSLWantWriteErrorObject;
71static PyObject *PySSLSyscallErrorObject;
72static PyObject *PySSLEOFErrorObject;
73
74/* Error mappings */
75static PyObject *err_codes_to_names;
76static PyObject *err_names_to_codes;
77static PyObject *lib_codes_to_names;
78
79struct py_ssl_error_code {
80 const char *mnemonic;
81 int library, reason;
82};
83struct py_ssl_library_code {
84 const char *library;
85 int code;
86};
87
88/* Include generated data (error codes) */
89#include "_ssl_data.h"
90
91/* Openssl comes with TLSv1.1 and TLSv1.2 between 1.0.0h and 1.0.1
92 http://www.openssl.org/news/changelog.html
93 */
94#if OPENSSL_VERSION_NUMBER >= 0x10001000L
95# define HAVE_TLSv1_2 1
96#else
97# define HAVE_TLSv1_2 0
98#endif
99
Christian Heimes470fba12013-11-28 15:12:15 +0100100/* SNI support (client- and server-side) appeared in OpenSSL 1.0.0 and 0.9.8f
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100101 * This includes the SSL_set_SSL_CTX() function.
102 */
103#ifdef SSL_CTRL_SET_TLSEXT_HOSTNAME
104# define HAVE_SNI 1
105#else
106# define HAVE_SNI 0
107#endif
108
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000109enum py_ssl_error {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000110 /* these mirror ssl.h */
111 PY_SSL_ERROR_NONE,
112 PY_SSL_ERROR_SSL,
113 PY_SSL_ERROR_WANT_READ,
114 PY_SSL_ERROR_WANT_WRITE,
115 PY_SSL_ERROR_WANT_X509_LOOKUP,
116 PY_SSL_ERROR_SYSCALL, /* look at error stack/return value/errno */
117 PY_SSL_ERROR_ZERO_RETURN,
118 PY_SSL_ERROR_WANT_CONNECT,
119 /* start of non ssl.h errorcodes */
120 PY_SSL_ERROR_EOF, /* special case of SSL_ERROR_SYSCALL */
121 PY_SSL_ERROR_NO_SOCKET, /* socket has been GC'd */
122 PY_SSL_ERROR_INVALID_ERROR_CODE
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000123};
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000124
Thomas Woutersed03b412007-08-28 21:37:11 +0000125enum py_ssl_server_or_client {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000126 PY_SSL_CLIENT,
127 PY_SSL_SERVER
Thomas Woutersed03b412007-08-28 21:37:11 +0000128};
129
130enum py_ssl_cert_requirements {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000131 PY_SSL_CERT_NONE,
132 PY_SSL_CERT_OPTIONAL,
133 PY_SSL_CERT_REQUIRED
Thomas Woutersed03b412007-08-28 21:37:11 +0000134};
135
136enum py_ssl_version {
Victor Stinner3de49192011-05-09 00:42:58 +0200137#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000138 PY_SSL_VERSION_SSL2,
Victor Stinner3de49192011-05-09 00:42:58 +0200139#endif
140 PY_SSL_VERSION_SSL3=1,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000141 PY_SSL_VERSION_SSL23,
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100142#if HAVE_TLSv1_2
143 PY_SSL_VERSION_TLS1,
144 PY_SSL_VERSION_TLS1_1,
145 PY_SSL_VERSION_TLS1_2
146#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000147 PY_SSL_VERSION_TLS1
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000148#endif
Antoine Pitrou2463e5f2013-03-28 22:24:43 +0100149};
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200150
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000151#ifdef WITH_THREAD
152
153/* serves as a flag to see whether we've initialized the SSL thread support. */
154/* 0 means no, greater than 0 means yes */
155
156static unsigned int _ssl_locks_count = 0;
157
158#endif /* def WITH_THREAD */
159
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000160/* SSL socket object */
161
162#define X509_NAME_MAXLEN 256
163
164/* RAND_* APIs got added to OpenSSL in 0.9.5 */
165#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
166# define HAVE_OPENSSL_RAND 1
167#else
168# undef HAVE_OPENSSL_RAND
169#endif
170
Gregory P. Smithbd4dacb2010-10-13 03:53:21 +0000171/* SSL_CTX_clear_options() and SSL_clear_options() were first added in
172 * OpenSSL 0.9.8m but do not appear in some 0.9.9-dev versions such the
173 * 0.9.9 from "May 2008" that NetBSD 5.0 uses. */
174#if OPENSSL_VERSION_NUMBER >= 0x009080dfL && OPENSSL_VERSION_NUMBER != 0x00909000L
Antoine Pitroub5218772010-05-21 09:56:06 +0000175# define HAVE_SSL_CTX_CLEAR_OPTIONS
176#else
177# undef HAVE_SSL_CTX_CLEAR_OPTIONS
178#endif
179
Antoine Pitroud6494802011-07-21 01:11:30 +0200180/* In case of 'tls-unique' it will be 12 bytes for TLS, 36 bytes for
181 * older SSL, but let's be safe */
182#define PySSL_CB_MAXLEN 128
183
184/* SSL_get_finished got added to OpenSSL in 0.9.5 */
185#if OPENSSL_VERSION_NUMBER >= 0x0090500fL
186# define HAVE_OPENSSL_FINISHED 1
187#else
188# define HAVE_OPENSSL_FINISHED 0
189#endif
190
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100191/* ECDH support got added to OpenSSL in 0.9.8 */
192#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_ECDH)
193# define OPENSSL_NO_ECDH
194#endif
195
Antoine Pitrouc135fa42012-02-19 21:22:39 +0100196/* compression support got added to OpenSSL in 0.9.8 */
197#if OPENSSL_VERSION_NUMBER < 0x0090800fL && !defined(OPENSSL_NO_COMP)
198# define OPENSSL_NO_COMP
199#endif
200
Christian Heimes2427b502013-11-23 11:24:32 +0100201/* X509_VERIFY_PARAM got added to OpenSSL in 0.9.8 */
202#if OPENSSL_VERSION_NUMBER >= 0x0090800fL
203# define HAVE_OPENSSL_VERIFY_PARAM
204#endif
205
Antoine Pitroua9bf2ac2012-02-17 18:47:54 +0100206
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000207typedef struct {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000208 PyObject_HEAD
Antoine Pitrou152efa22010-05-16 18:19:27 +0000209 SSL_CTX *ctx;
Antoine Pitroud5d17eb2012-03-22 00:23:03 +0100210#ifdef OPENSSL_NPN_NEGOTIATED
211 char *npn_protocols;
212 int npn_protocols_len;
213#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100214#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +0200215 PyObject *set_hostname;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100216#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +0100217 int check_hostname;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000218} PySSLContext;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000219
Antoine Pitrou152efa22010-05-16 18:19:27 +0000220typedef struct {
221 PyObject_HEAD
222 PyObject *Socket; /* weakref to socket on which we're layered */
223 SSL *ssl;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100224 PySSLContext *ctx; /* weakref to SSL context */
Antoine Pitrou152efa22010-05-16 18:19:27 +0000225 X509 *peer_cert;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200226 char shutdown_seen_zero;
227 char handshake_done;
Antoine Pitroud6494802011-07-21 01:11:30 +0200228 enum py_ssl_server_or_client socket_type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000229} PySSLSocket;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000230
Antoine Pitrou152efa22010-05-16 18:19:27 +0000231static PyTypeObject PySSLContext_Type;
232static PyTypeObject PySSLSocket_Type;
233
234static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args);
235static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args);
Thomas Woutersed03b412007-08-28 21:37:11 +0000236static int check_socket_and_wait_for_timeout(PySocketSockObject *s,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000237 int writing);
Antoine Pitrou152efa22010-05-16 18:19:27 +0000238static PyObject *PySSL_peercert(PySSLSocket *self, PyObject *args);
239static PyObject *PySSL_cipher(PySSLSocket *self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000240
Antoine Pitrou152efa22010-05-16 18:19:27 +0000241#define PySSLContext_Check(v) (Py_TYPE(v) == &PySSLContext_Type)
242#define PySSLSocket_Check(v) (Py_TYPE(v) == &PySSLSocket_Type)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000243
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000244typedef enum {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000245 SOCKET_IS_NONBLOCKING,
246 SOCKET_IS_BLOCKING,
247 SOCKET_HAS_TIMED_OUT,
248 SOCKET_HAS_BEEN_CLOSED,
249 SOCKET_TOO_LARGE_FOR_SELECT,
250 SOCKET_OPERATION_OK
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +0000251} timeout_state;
252
Thomas Woutersed03b412007-08-28 21:37:11 +0000253/* Wrap error strings with filename and line # */
254#define STRINGIFY1(x) #x
255#define STRINGIFY2(x) STRINGIFY1(x)
256#define ERRSTR1(x,y,z) (x ":" y ": " z)
257#define ERRSTR(x) ERRSTR1("_ssl.c", STRINGIFY2(__LINE__), x)
258
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200259
260/*
261 * SSL errors.
262 */
263
264PyDoc_STRVAR(SSLError_doc,
265"An error occurred in the SSL implementation.");
266
267PyDoc_STRVAR(SSLZeroReturnError_doc,
268"SSL/TLS session closed cleanly.");
269
270PyDoc_STRVAR(SSLWantReadError_doc,
271"Non-blocking SSL socket needs to read more data\n"
272"before the requested operation can be completed.");
273
274PyDoc_STRVAR(SSLWantWriteError_doc,
275"Non-blocking SSL socket needs to write more data\n"
276"before the requested operation can be completed.");
277
278PyDoc_STRVAR(SSLSyscallError_doc,
279"System error when attempting SSL operation.");
280
281PyDoc_STRVAR(SSLEOFError_doc,
282"SSL/TLS connection terminated abruptly.");
283
284static PyObject *
285SSLError_str(PyOSErrorObject *self)
286{
287 if (self->strerror != NULL && PyUnicode_Check(self->strerror)) {
288 Py_INCREF(self->strerror);
289 return self->strerror;
290 }
291 else
292 return PyObject_Str(self->args);
293}
294
295static PyType_Slot sslerror_type_slots[] = {
296 {Py_tp_base, NULL}, /* Filled out in module init as it's not a constant */
297 {Py_tp_doc, SSLError_doc},
298 {Py_tp_str, SSLError_str},
299 {0, 0},
300};
301
302static PyType_Spec sslerror_type_spec = {
303 "ssl.SSLError",
304 sizeof(PyOSErrorObject),
305 0,
306 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
307 sslerror_type_slots
308};
309
310static void
311fill_and_set_sslerror(PyObject *type, int ssl_errno, const char *errstr,
312 int lineno, unsigned long errcode)
313{
314 PyObject *err_value = NULL, *reason_obj = NULL, *lib_obj = NULL;
315 PyObject *init_value, *msg, *key;
316 _Py_IDENTIFIER(reason);
317 _Py_IDENTIFIER(library);
318
319 if (errcode != 0) {
320 int lib, reason;
321
322 lib = ERR_GET_LIB(errcode);
323 reason = ERR_GET_REASON(errcode);
324 key = Py_BuildValue("ii", lib, reason);
325 if (key == NULL)
326 goto fail;
327 reason_obj = PyDict_GetItem(err_codes_to_names, key);
328 Py_DECREF(key);
329 if (reason_obj == NULL) {
330 /* XXX if reason < 100, it might reflect a library number (!!) */
331 PyErr_Clear();
332 }
333 key = PyLong_FromLong(lib);
334 if (key == NULL)
335 goto fail;
336 lib_obj = PyDict_GetItem(lib_codes_to_names, key);
337 Py_DECREF(key);
338 if (lib_obj == NULL) {
339 PyErr_Clear();
340 }
341 if (errstr == NULL)
342 errstr = ERR_reason_error_string(errcode);
343 }
344 if (errstr == NULL)
345 errstr = "unknown error";
346
347 if (reason_obj && lib_obj)
348 msg = PyUnicode_FromFormat("[%S: %S] %s (_ssl.c:%d)",
349 lib_obj, reason_obj, errstr, lineno);
350 else if (lib_obj)
351 msg = PyUnicode_FromFormat("[%S] %s (_ssl.c:%d)",
352 lib_obj, errstr, lineno);
353 else
354 msg = PyUnicode_FromFormat("%s (_ssl.c:%d)", errstr, lineno);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200355 if (msg == NULL)
356 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100357
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200358 init_value = Py_BuildValue("iN", ssl_errno, msg);
Victor Stinnerba9be472013-10-31 15:00:24 +0100359 if (init_value == NULL)
360 goto fail;
361
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200362 err_value = PyObject_CallObject(type, init_value);
363 Py_DECREF(init_value);
364 if (err_value == NULL)
365 goto fail;
Victor Stinnerba9be472013-10-31 15:00:24 +0100366
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200367 if (reason_obj == NULL)
368 reason_obj = Py_None;
369 if (_PyObject_SetAttrId(err_value, &PyId_reason, reason_obj))
370 goto fail;
371 if (lib_obj == NULL)
372 lib_obj = Py_None;
373 if (_PyObject_SetAttrId(err_value, &PyId_library, lib_obj))
374 goto fail;
375 PyErr_SetObject(type, err_value);
376fail:
377 Py_XDECREF(err_value);
378}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000379
380static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +0000381PySSL_SetError(PySSLSocket *obj, int ret, char *filename, int lineno)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000382{
Antoine Pitrou41032a62011-10-27 23:56:55 +0200383 PyObject *type = PySSLErrorObject;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200384 char *errstr = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000385 int err;
386 enum py_ssl_error p = PY_SSL_ERROR_NONE;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200387 unsigned long e = 0;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000388
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000389 assert(ret <= 0);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200390 e = ERR_peek_last_error();
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +0000391
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000392 if (obj->ssl != NULL) {
393 err = SSL_get_error(obj->ssl, ret);
Thomas Woutersed03b412007-08-28 21:37:11 +0000394
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000395 switch (err) {
396 case SSL_ERROR_ZERO_RETURN:
Antoine Pitrou41032a62011-10-27 23:56:55 +0200397 errstr = "TLS/SSL connection has been closed (EOF)";
398 type = PySSLZeroReturnErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000399 p = PY_SSL_ERROR_ZERO_RETURN;
400 break;
401 case SSL_ERROR_WANT_READ:
402 errstr = "The operation did not complete (read)";
Antoine Pitrou41032a62011-10-27 23:56:55 +0200403 type = PySSLWantReadErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000404 p = PY_SSL_ERROR_WANT_READ;
405 break;
406 case SSL_ERROR_WANT_WRITE:
407 p = PY_SSL_ERROR_WANT_WRITE;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200408 type = PySSLWantWriteErrorObject;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000409 errstr = "The operation did not complete (write)";
410 break;
411 case SSL_ERROR_WANT_X509_LOOKUP:
412 p = PY_SSL_ERROR_WANT_X509_LOOKUP;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000413 errstr = "The operation did not complete (X509 lookup)";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000414 break;
415 case SSL_ERROR_WANT_CONNECT:
416 p = PY_SSL_ERROR_WANT_CONNECT;
417 errstr = "The operation did not complete (connect)";
418 break;
419 case SSL_ERROR_SYSCALL:
420 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000421 if (e == 0) {
422 PySocketSockObject *s
423 = (PySocketSockObject *) PyWeakref_GetObject(obj->Socket);
424 if (ret == 0 || (((PyObject *)s) == Py_None)) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000425 p = PY_SSL_ERROR_EOF;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200426 type = PySSLEOFErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000427 errstr = "EOF occurred in violation of protocol";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000428 } else if (ret == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +0000429 /* underlying BIO reported an I/O error */
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000430 Py_INCREF(s);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000431 ERR_clear_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200432 s->errorhandler();
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000433 Py_DECREF(s);
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200434 return NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000435 } else { /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000436 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitrou41032a62011-10-27 23:56:55 +0200437 type = PySSLSyscallErrorObject;
Antoine Pitrou525807b2010-05-12 14:05:24 +0000438 errstr = "Some I/O error occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000439 }
440 } else {
441 p = PY_SSL_ERROR_SYSCALL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000442 }
443 break;
444 }
445 case SSL_ERROR_SSL:
446 {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000447 p = PY_SSL_ERROR_SSL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200448 if (e == 0)
449 /* possible? */
Antoine Pitrou525807b2010-05-12 14:05:24 +0000450 errstr = "A failure in the SSL library occurred";
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000451 break;
452 }
453 default:
454 p = PY_SSL_ERROR_INVALID_ERROR_CODE;
455 errstr = "Invalid error code";
456 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000457 }
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200458 fill_and_set_sslerror(type, p, errstr, lineno, e);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000459 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000460 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000461}
462
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000463static PyObject *
464_setSSLError (char *errstr, int errcode, char *filename, int lineno) {
465
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200466 if (errstr == NULL)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000467 errcode = ERR_peek_last_error();
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200468 else
469 errcode = 0;
470 fill_and_set_sslerror(PySSLErrorObject, errcode, errstr, lineno, errcode);
Antoine Pitrou9d74b422010-05-16 23:14:22 +0000471 ERR_clear_error();
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000472 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000473}
474
Antoine Pitrou3b36fb12012-06-22 21:11:52 +0200475/*
476 * SSL objects
477 */
478
Antoine Pitrou152efa22010-05-16 18:19:27 +0000479static PySSLSocket *
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100480newPySSLSocket(PySSLContext *sslctx, PySocketSockObject *sock,
Antoine Pitroud5323212010-10-22 18:19:07 +0000481 enum py_ssl_server_or_client socket_type,
482 char *server_hostname)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000483{
Antoine Pitrou152efa22010-05-16 18:19:27 +0000484 PySSLSocket *self;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100485 SSL_CTX *ctx = sslctx->ctx;
Antoine Pitrou19fef692013-05-25 13:23:03 +0200486 long mode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000487
Antoine Pitrou152efa22010-05-16 18:19:27 +0000488 self = PyObject_New(PySSLSocket, &PySSLSocket_Type);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000489 if (self == NULL)
490 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000491
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000492 self->peer_cert = NULL;
493 self->ssl = NULL;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000494 self->Socket = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100495 self->ctx = sslctx;
Antoine Pitrou860aee72013-09-29 19:52:45 +0200496 self->shutdown_seen_zero = 0;
Antoine Pitrou20b85552013-09-29 19:50:53 +0200497 self->handshake_done = 0;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100498 Py_INCREF(sslctx);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000499
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000500 /* Make sure the SSL error state is initialized */
501 (void) ERR_get_state();
502 ERR_clear_error();
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000503
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000504 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitrou152efa22010-05-16 18:19:27 +0000505 self->ssl = SSL_new(ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000506 PySSL_END_ALLOW_THREADS
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +0100507 SSL_set_app_data(self->ssl,self);
Christian Heimesb08ff7d2013-11-18 10:04:07 +0100508 SSL_set_fd(self->ssl, Py_SAFE_DOWNCAST(sock->sock_fd, SOCKET_T, int));
Antoine Pitrou19fef692013-05-25 13:23:03 +0200509 mode = SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000510#ifdef SSL_MODE_AUTO_RETRY
Antoine Pitrou19fef692013-05-25 13:23:03 +0200511 mode |= SSL_MODE_AUTO_RETRY;
Antoine Pitrou0ae7b582010-04-09 20:42:09 +0000512#endif
Antoine Pitrou19fef692013-05-25 13:23:03 +0200513 SSL_set_mode(self->ssl, mode);
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000514
Antoine Pitrou912fbff2013-03-30 16:29:32 +0100515#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +0000516 if (server_hostname != NULL)
517 SSL_set_tlsext_host_name(self->ssl, server_hostname);
518#endif
519
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000520 /* If the socket is in non-blocking mode or timeout mode, set the BIO
521 * to non-blocking mode (blocking is the default)
522 */
Antoine Pitrou152efa22010-05-16 18:19:27 +0000523 if (sock->sock_timeout >= 0.0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000524 BIO_set_nbio(SSL_get_rbio(self->ssl), 1);
525 BIO_set_nbio(SSL_get_wbio(self->ssl), 1);
526 }
Guido van Rossum4f707ac2003-01-31 18:13:18 +0000527
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000528 PySSL_BEGIN_ALLOW_THREADS
529 if (socket_type == PY_SSL_CLIENT)
530 SSL_set_connect_state(self->ssl);
531 else
532 SSL_set_accept_state(self->ssl);
533 PySSL_END_ALLOW_THREADS
Martin v. Löwis09c35f72002-07-28 09:57:45 +0000534
Antoine Pitroud6494802011-07-21 01:11:30 +0200535 self->socket_type = socket_type;
Antoine Pitrou152efa22010-05-16 18:19:27 +0000536 self->Socket = PyWeakref_NewRef((PyObject *) sock, NULL);
Victor Stinnera9eb38f2013-10-31 16:35:38 +0100537 if (self->Socket == NULL) {
538 Py_DECREF(self);
539 return NULL;
540 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000541 return self;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000542}
543
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000544/* SSL object methods */
545
Antoine Pitrou152efa22010-05-16 18:19:27 +0000546static PyObject *PySSL_SSLdo_handshake(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000547{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000548 int ret;
549 int err;
550 int sockstate, nonblocking;
551 PySocketSockObject *sock
552 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Antoine Pitroud3f8ab82010-04-24 21:26:44 +0000553
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000554 if (((PyObject*)sock) == Py_None) {
555 _setSSLError("Underlying socket connection gone",
556 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
557 return NULL;
558 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000559 Py_INCREF(sock);
Antoine Pitroud3f8ab82010-04-24 21:26:44 +0000560
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000561 /* just in case the blocking state of the socket has been changed */
562 nonblocking = (sock->sock_timeout >= 0.0);
563 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
564 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000565
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000566 /* Actually negotiate SSL connection */
567 /* XXX If SSL_do_handshake() returns 0, it's also a failure. */
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000568 do {
Bill Janssen6e027db2007-11-15 22:23:56 +0000569 PySSL_BEGIN_ALLOW_THREADS
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000570 ret = SSL_do_handshake(self->ssl);
571 err = SSL_get_error(self->ssl, ret);
572 PySSL_END_ALLOW_THREADS
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000573 if (PyErr_CheckSignals())
574 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000575 if (err == SSL_ERROR_WANT_READ) {
576 sockstate = check_socket_and_wait_for_timeout(sock, 0);
577 } else if (err == SSL_ERROR_WANT_WRITE) {
578 sockstate = check_socket_and_wait_for_timeout(sock, 1);
579 } else {
580 sockstate = SOCKET_OPERATION_OK;
581 }
582 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +0000583 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000584 ERRSTR("The handshake operation timed out"));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000585 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000586 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
587 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000588 ERRSTR("Underlying socket has been closed."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000589 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000590 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
591 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000592 ERRSTR("Underlying socket too large for select()."));
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000593 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000594 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
595 break;
596 }
597 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000598 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000599 if (ret < 1)
600 return PySSL_SetError(self, ret, __FILE__, __LINE__);
Bill Janssen6e027db2007-11-15 22:23:56 +0000601
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000602 if (self->peer_cert)
603 X509_free (self->peer_cert);
604 PySSL_BEGIN_ALLOW_THREADS
605 self->peer_cert = SSL_get_peer_certificate(self->ssl);
606 PySSL_END_ALLOW_THREADS
Antoine Pitrou20b85552013-09-29 19:50:53 +0200607 self->handshake_done = 1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000608
609 Py_INCREF(Py_None);
610 return Py_None;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +0000611
612error:
613 Py_DECREF(sock);
614 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +0000615}
616
Thomas Woutersed03b412007-08-28 21:37:11 +0000617static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000618_create_tuple_for_attribute (ASN1_OBJECT *name, ASN1_STRING *value) {
Thomas Woutersed03b412007-08-28 21:37:11 +0000619
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000620 char namebuf[X509_NAME_MAXLEN];
621 int buflen;
622 PyObject *name_obj;
623 PyObject *value_obj;
624 PyObject *attr;
625 unsigned char *valuebuf = NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000626
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000627 buflen = OBJ_obj2txt(namebuf, sizeof(namebuf), name, 0);
628 if (buflen < 0) {
629 _setSSLError(NULL, 0, __FILE__, __LINE__);
630 goto fail;
631 }
632 name_obj = PyUnicode_FromStringAndSize(namebuf, buflen);
633 if (name_obj == NULL)
634 goto fail;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000635
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000636 buflen = ASN1_STRING_to_UTF8(&valuebuf, value);
637 if (buflen < 0) {
638 _setSSLError(NULL, 0, __FILE__, __LINE__);
639 Py_DECREF(name_obj);
640 goto fail;
641 }
642 value_obj = PyUnicode_DecodeUTF8((char *) valuebuf,
Antoine Pitrou525807b2010-05-12 14:05:24 +0000643 buflen, "strict");
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000644 OPENSSL_free(valuebuf);
645 if (value_obj == NULL) {
646 Py_DECREF(name_obj);
647 goto fail;
648 }
649 attr = PyTuple_New(2);
650 if (attr == NULL) {
651 Py_DECREF(name_obj);
652 Py_DECREF(value_obj);
653 goto fail;
654 }
655 PyTuple_SET_ITEM(attr, 0, name_obj);
656 PyTuple_SET_ITEM(attr, 1, value_obj);
657 return attr;
Thomas Woutersed03b412007-08-28 21:37:11 +0000658
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000659 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000660 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +0000661}
662
663static PyObject *
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000664_create_tuple_for_X509_NAME (X509_NAME *xname)
Thomas Woutersed03b412007-08-28 21:37:11 +0000665{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000666 PyObject *dn = NULL; /* tuple which represents the "distinguished name" */
667 PyObject *rdn = NULL; /* tuple to hold a "relative distinguished name" */
668 PyObject *rdnt;
669 PyObject *attr = NULL; /* tuple to hold an attribute */
670 int entry_count = X509_NAME_entry_count(xname);
671 X509_NAME_ENTRY *entry;
672 ASN1_OBJECT *name;
673 ASN1_STRING *value;
674 int index_counter;
675 int rdn_level = -1;
676 int retcode;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000677
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000678 dn = PyList_New(0);
679 if (dn == NULL)
680 return NULL;
681 /* now create another tuple to hold the top-level RDN */
682 rdn = PyList_New(0);
683 if (rdn == NULL)
684 goto fail0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000685
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000686 for (index_counter = 0;
687 index_counter < entry_count;
688 index_counter++)
689 {
690 entry = X509_NAME_get_entry(xname, index_counter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000691
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000692 /* check to see if we've gotten to a new RDN */
693 if (rdn_level >= 0) {
694 if (rdn_level != entry->set) {
695 /* yes, new RDN */
696 /* add old RDN to DN */
697 rdnt = PyList_AsTuple(rdn);
698 Py_DECREF(rdn);
699 if (rdnt == NULL)
700 goto fail0;
701 retcode = PyList_Append(dn, rdnt);
702 Py_DECREF(rdnt);
703 if (retcode < 0)
704 goto fail0;
705 /* create new RDN */
706 rdn = PyList_New(0);
707 if (rdn == NULL)
708 goto fail0;
709 }
710 }
711 rdn_level = entry->set;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000712
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000713 /* now add this attribute to the current RDN */
714 name = X509_NAME_ENTRY_get_object(entry);
715 value = X509_NAME_ENTRY_get_data(entry);
716 attr = _create_tuple_for_attribute(name, value);
717 /*
718 fprintf(stderr, "RDN level %d, attribute %s: %s\n",
719 entry->set,
720 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 0)),
721 PyBytes_AS_STRING(PyTuple_GET_ITEM(attr, 1)));
722 */
723 if (attr == NULL)
724 goto fail1;
725 retcode = PyList_Append(rdn, attr);
726 Py_DECREF(attr);
727 if (retcode < 0)
728 goto fail1;
729 }
730 /* now, there's typically a dangling RDN */
Antoine Pitrou2f5a1632012-02-15 22:25:27 +0100731 if (rdn != NULL) {
732 if (PyList_GET_SIZE(rdn) > 0) {
733 rdnt = PyList_AsTuple(rdn);
734 Py_DECREF(rdn);
735 if (rdnt == NULL)
736 goto fail0;
737 retcode = PyList_Append(dn, rdnt);
738 Py_DECREF(rdnt);
739 if (retcode < 0)
740 goto fail0;
741 }
742 else {
743 Py_DECREF(rdn);
744 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000745 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000746
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000747 /* convert list to tuple */
748 rdnt = PyList_AsTuple(dn);
749 Py_DECREF(dn);
750 if (rdnt == NULL)
751 return NULL;
752 return rdnt;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000753
754 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000755 Py_XDECREF(rdn);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000756
757 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000758 Py_XDECREF(dn);
759 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000760}
761
762static PyObject *
763_get_peer_alt_names (X509 *certificate) {
Guido van Rossumf06628b2007-11-21 20:01:53 +0000764
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000765 /* this code follows the procedure outlined in
766 OpenSSL's crypto/x509v3/v3_prn.c:X509v3_EXT_print()
767 function to extract the STACK_OF(GENERAL_NAME),
768 then iterates through the stack to add the
769 names. */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000770
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000771 int i, j;
772 PyObject *peer_alt_names = Py_None;
Christian Heimes60bf2fc2013-09-05 16:04:35 +0200773 PyObject *v = NULL, *t;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000774 X509_EXTENSION *ext = NULL;
775 GENERAL_NAMES *names = NULL;
776 GENERAL_NAME *name;
Benjamin Petersoneb1410f2010-10-13 22:06:39 +0000777 const X509V3_EXT_METHOD *method;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000778 BIO *biobuf = NULL;
779 char buf[2048];
780 char *vptr;
781 int len;
782 /* Issue #2973: ASN1_item_d2i() API changed in OpenSSL 0.9.6m */
Victor Stinner7124a412010-03-02 22:48:17 +0000783#if OPENSSL_VERSION_NUMBER >= 0x009060dfL
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000784 const unsigned char *p;
Victor Stinner7124a412010-03-02 22:48:17 +0000785#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000786 unsigned char *p;
Victor Stinner7124a412010-03-02 22:48:17 +0000787#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000788
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000789 if (certificate == NULL)
790 return peer_alt_names;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000791
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000792 /* get a memory buffer */
793 biobuf = BIO_new(BIO_s_mem());
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000794
Antoine Pitroud8c347a2011-10-01 19:20:25 +0200795 i = -1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000796 while ((i = X509_get_ext_by_NID(
797 certificate, NID_subject_alt_name, i)) >= 0) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000798
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000799 if (peer_alt_names == Py_None) {
800 peer_alt_names = PyList_New(0);
801 if (peer_alt_names == NULL)
802 goto fail;
803 }
Guido van Rossumf06628b2007-11-21 20:01:53 +0000804
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000805 /* now decode the altName */
806 ext = X509_get_ext(certificate, i);
807 if(!(method = X509V3_EXT_get(ext))) {
808 PyErr_SetString
809 (PySSLErrorObject,
810 ERRSTR("No method for internalizing subjectAltName!"));
811 goto fail;
812 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000813
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000814 p = ext->value->data;
815 if (method->it)
816 names = (GENERAL_NAMES*)
817 (ASN1_item_d2i(NULL,
818 &p,
819 ext->value->length,
820 ASN1_ITEM_ptr(method->it)));
821 else
822 names = (GENERAL_NAMES*)
823 (method->d2i(NULL,
824 &p,
825 ext->value->length));
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000826
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000827 for(j = 0; j < sk_GENERAL_NAME_num(names); j++) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000828 /* get a rendering of each name in the set of names */
Christian Heimes824f7f32013-08-17 00:54:47 +0200829 int gntype;
830 ASN1_STRING *as = NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000831
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000832 name = sk_GENERAL_NAME_value(names, j);
Christian Heimes474afdd2013-08-17 17:18:56 +0200833 gntype = name->type;
Christian Heimes824f7f32013-08-17 00:54:47 +0200834 switch (gntype) {
835 case GEN_DIRNAME:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000836 /* we special-case DirName as a tuple of
837 tuples of attributes */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000838
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000839 t = PyTuple_New(2);
840 if (t == NULL) {
841 goto fail;
842 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000843
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000844 v = PyUnicode_FromString("DirName");
845 if (v == NULL) {
846 Py_DECREF(t);
847 goto fail;
848 }
849 PyTuple_SET_ITEM(t, 0, v);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000850
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000851 v = _create_tuple_for_X509_NAME (name->d.dirn);
852 if (v == NULL) {
853 Py_DECREF(t);
854 goto fail;
855 }
856 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200857 break;
Guido van Rossumf06628b2007-11-21 20:01:53 +0000858
Christian Heimes824f7f32013-08-17 00:54:47 +0200859 case GEN_EMAIL:
860 case GEN_DNS:
861 case GEN_URI:
862 /* GENERAL_NAME_print() doesn't handle NULL bytes in ASN1_string
863 correctly, CVE-2013-4238 */
864 t = PyTuple_New(2);
865 if (t == NULL)
866 goto fail;
867 switch (gntype) {
868 case GEN_EMAIL:
869 v = PyUnicode_FromString("email");
870 as = name->d.rfc822Name;
871 break;
872 case GEN_DNS:
873 v = PyUnicode_FromString("DNS");
874 as = name->d.dNSName;
875 break;
876 case GEN_URI:
877 v = PyUnicode_FromString("URI");
878 as = name->d.uniformResourceIdentifier;
879 break;
880 }
881 if (v == NULL) {
882 Py_DECREF(t);
883 goto fail;
884 }
885 PyTuple_SET_ITEM(t, 0, v);
886 v = PyUnicode_FromStringAndSize((char *)ASN1_STRING_data(as),
887 ASN1_STRING_length(as));
888 if (v == NULL) {
889 Py_DECREF(t);
890 goto fail;
891 }
892 PyTuple_SET_ITEM(t, 1, v);
893 break;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000894
Christian Heimes824f7f32013-08-17 00:54:47 +0200895 default:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000896 /* for everything else, we use the OpenSSL print form */
Christian Heimes824f7f32013-08-17 00:54:47 +0200897 switch (gntype) {
898 /* check for new general name type */
899 case GEN_OTHERNAME:
900 case GEN_X400:
901 case GEN_EDIPARTY:
902 case GEN_IPADD:
903 case GEN_RID:
904 break;
905 default:
906 if (PyErr_WarnFormat(PyExc_RuntimeWarning, 1,
907 "Unknown general name type %d",
908 gntype) == -1) {
909 goto fail;
910 }
911 break;
912 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000913 (void) BIO_reset(biobuf);
914 GENERAL_NAME_print(biobuf, name);
915 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
916 if (len < 0) {
917 _setSSLError(NULL, 0, __FILE__, __LINE__);
918 goto fail;
919 }
920 vptr = strchr(buf, ':');
921 if (vptr == NULL)
922 goto fail;
923 t = PyTuple_New(2);
924 if (t == NULL)
925 goto fail;
926 v = PyUnicode_FromStringAndSize(buf, (vptr - buf));
927 if (v == NULL) {
928 Py_DECREF(t);
929 goto fail;
930 }
931 PyTuple_SET_ITEM(t, 0, v);
932 v = PyUnicode_FromStringAndSize((vptr + 1),
933 (len - (vptr - buf + 1)));
934 if (v == NULL) {
935 Py_DECREF(t);
936 goto fail;
937 }
938 PyTuple_SET_ITEM(t, 1, v);
Christian Heimes824f7f32013-08-17 00:54:47 +0200939 break;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000940 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000941
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000942 /* and add that rendering to the list */
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000943
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000944 if (PyList_Append(peer_alt_names, t) < 0) {
945 Py_DECREF(t);
946 goto fail;
947 }
948 Py_DECREF(t);
949 }
Antoine Pitrou116d6b92011-11-23 01:39:19 +0100950 sk_GENERAL_NAME_pop_free(names, GENERAL_NAME_free);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000951 }
952 BIO_free(biobuf);
953 if (peer_alt_names != Py_None) {
954 v = PyList_AsTuple(peer_alt_names);
955 Py_DECREF(peer_alt_names);
956 return v;
957 } else {
958 return peer_alt_names;
959 }
Guido van Rossumf06628b2007-11-21 20:01:53 +0000960
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000961
962 fail:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000963 if (biobuf != NULL)
964 BIO_free(biobuf);
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000965
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000966 if (peer_alt_names != Py_None) {
967 Py_XDECREF(peer_alt_names);
968 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000969
Antoine Pitroucbb82eb2010-05-05 15:57:33 +0000970 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +0000971}
972
973static PyObject *
Christian Heimesbd3a7f92013-11-21 03:40:15 +0100974_get_aia_uri(X509 *certificate, int nid) {
975 PyObject *lst = NULL, *ostr = NULL;
976 int i, result;
977 AUTHORITY_INFO_ACCESS *info;
978
979 info = X509_get_ext_d2i(certificate, NID_info_access, NULL, NULL);
980 if ((info == NULL) || (sk_ACCESS_DESCRIPTION_num(info) == 0)) {
981 return Py_None;
982 }
983
984 if ((lst = PyList_New(0)) == NULL) {
985 goto fail;
986 }
987
988 for (i = 0; i < sk_ACCESS_DESCRIPTION_num(info); i++) {
989 ACCESS_DESCRIPTION *ad = sk_ACCESS_DESCRIPTION_value(info, i);
990 ASN1_IA5STRING *uri;
991
992 if ((OBJ_obj2nid(ad->method) != nid) ||
993 (ad->location->type != GEN_URI)) {
994 continue;
995 }
996 uri = ad->location->d.uniformResourceIdentifier;
997 ostr = PyUnicode_FromStringAndSize((char *)uri->data,
998 uri->length);
999 if (ostr == NULL) {
1000 goto fail;
1001 }
1002 result = PyList_Append(lst, ostr);
1003 Py_DECREF(ostr);
1004 if (result < 0) {
1005 goto fail;
1006 }
1007 }
1008 AUTHORITY_INFO_ACCESS_free(info);
1009
1010 /* convert to tuple or None */
1011 if (PyList_Size(lst) == 0) {
1012 Py_DECREF(lst);
1013 return Py_None;
1014 } else {
1015 PyObject *tup;
1016 tup = PyList_AsTuple(lst);
1017 Py_DECREF(lst);
1018 return tup;
1019 }
1020
1021 fail:
1022 AUTHORITY_INFO_ACCESS_free(info);
Christian Heimes18fc7be2013-11-21 23:57:49 +01001023 Py_XDECREF(lst);
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001024 return NULL;
1025}
1026
1027static PyObject *
1028_get_crl_dp(X509 *certificate) {
1029 STACK_OF(DIST_POINT) *dps;
1030 int i, j, result;
1031 PyObject *lst;
1032
Christian Heimes949ec142013-11-21 16:26:51 +01001033#if OPENSSL_VERSION_NUMBER < 0x10001000L
1034 dps = X509_get_ext_d2i(certificate, NID_crl_distribution_points,
1035 NULL, NULL);
1036#else
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001037 /* Calls x509v3_cache_extensions and sets up crldp */
1038 X509_check_ca(certificate);
1039 dps = certificate->crldp;
Christian Heimes949ec142013-11-21 16:26:51 +01001040#endif
1041
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001042 if (dps == NULL) {
1043 return Py_None;
1044 }
1045
1046 if ((lst = PyList_New(0)) == NULL) {
1047 return NULL;
1048 }
1049
1050 for (i=0; i < sk_DIST_POINT_num(dps); i++) {
1051 DIST_POINT *dp;
1052 STACK_OF(GENERAL_NAME) *gns;
1053
1054 dp = sk_DIST_POINT_value(dps, i);
1055 gns = dp->distpoint->name.fullname;
1056
1057 for (j=0; j < sk_GENERAL_NAME_num(gns); j++) {
1058 GENERAL_NAME *gn;
1059 ASN1_IA5STRING *uri;
1060 PyObject *ouri;
1061
1062 gn = sk_GENERAL_NAME_value(gns, j);
1063 if (gn->type != GEN_URI) {
1064 continue;
1065 }
1066 uri = gn->d.uniformResourceIdentifier;
1067 ouri = PyUnicode_FromStringAndSize((char *)uri->data,
1068 uri->length);
1069 if (ouri == NULL) {
1070 Py_DECREF(lst);
1071 return NULL;
1072 }
1073 result = PyList_Append(lst, ouri);
1074 Py_DECREF(ouri);
1075 if (result < 0) {
1076 Py_DECREF(lst);
1077 return NULL;
1078 }
1079 }
1080 }
1081 /* convert to tuple or None */
1082 if (PyList_Size(lst) == 0) {
1083 Py_DECREF(lst);
1084 return Py_None;
1085 } else {
1086 PyObject *tup;
1087 tup = PyList_AsTuple(lst);
1088 Py_DECREF(lst);
1089 return tup;
1090 }
1091}
1092
1093static PyObject *
Antoine Pitroufb046912010-11-09 20:21:19 +00001094_decode_certificate(X509 *certificate) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001095
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001096 PyObject *retval = NULL;
1097 BIO *biobuf = NULL;
1098 PyObject *peer;
1099 PyObject *peer_alt_names = NULL;
1100 PyObject *issuer;
1101 PyObject *version;
1102 PyObject *sn_obj;
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001103 PyObject *obj;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001104 ASN1_INTEGER *serialNumber;
1105 char buf[2048];
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001106 int len, result;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001107 ASN1_TIME *notBefore, *notAfter;
1108 PyObject *pnotBefore, *pnotAfter;
Thomas Woutersed03b412007-08-28 21:37:11 +00001109
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001110 retval = PyDict_New();
1111 if (retval == NULL)
1112 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001113
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001114 peer = _create_tuple_for_X509_NAME(
1115 X509_get_subject_name(certificate));
1116 if (peer == NULL)
1117 goto fail0;
1118 if (PyDict_SetItemString(retval, (const char *) "subject", peer) < 0) {
1119 Py_DECREF(peer);
1120 goto fail0;
1121 }
1122 Py_DECREF(peer);
Thomas Woutersed03b412007-08-28 21:37:11 +00001123
Antoine Pitroufb046912010-11-09 20:21:19 +00001124 issuer = _create_tuple_for_X509_NAME(
1125 X509_get_issuer_name(certificate));
1126 if (issuer == NULL)
1127 goto fail0;
1128 if (PyDict_SetItemString(retval, (const char *)"issuer", issuer) < 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001129 Py_DECREF(issuer);
Antoine Pitroufb046912010-11-09 20:21:19 +00001130 goto fail0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001131 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001132 Py_DECREF(issuer);
1133
1134 version = PyLong_FromLong(X509_get_version(certificate) + 1);
Christian Heimes5962bef2013-07-26 15:51:18 +02001135 if (version == NULL)
1136 goto fail0;
Antoine Pitroufb046912010-11-09 20:21:19 +00001137 if (PyDict_SetItemString(retval, "version", version) < 0) {
1138 Py_DECREF(version);
1139 goto fail0;
1140 }
1141 Py_DECREF(version);
Guido van Rossumf06628b2007-11-21 20:01:53 +00001142
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001143 /* get a memory buffer */
1144 biobuf = BIO_new(BIO_s_mem());
Guido van Rossumf06628b2007-11-21 20:01:53 +00001145
Antoine Pitroufb046912010-11-09 20:21:19 +00001146 (void) BIO_reset(biobuf);
1147 serialNumber = X509_get_serialNumber(certificate);
1148 /* should not exceed 20 octets, 160 bits, so buf is big enough */
1149 i2a_ASN1_INTEGER(biobuf, serialNumber);
1150 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1151 if (len < 0) {
1152 _setSSLError(NULL, 0, __FILE__, __LINE__);
1153 goto fail1;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001154 }
Antoine Pitroufb046912010-11-09 20:21:19 +00001155 sn_obj = PyUnicode_FromStringAndSize(buf, len);
1156 if (sn_obj == NULL)
1157 goto fail1;
1158 if (PyDict_SetItemString(retval, "serialNumber", sn_obj) < 0) {
1159 Py_DECREF(sn_obj);
1160 goto fail1;
1161 }
1162 Py_DECREF(sn_obj);
1163
1164 (void) BIO_reset(biobuf);
1165 notBefore = X509_get_notBefore(certificate);
1166 ASN1_TIME_print(biobuf, notBefore);
1167 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1168 if (len < 0) {
1169 _setSSLError(NULL, 0, __FILE__, __LINE__);
1170 goto fail1;
1171 }
1172 pnotBefore = PyUnicode_FromStringAndSize(buf, len);
1173 if (pnotBefore == NULL)
1174 goto fail1;
1175 if (PyDict_SetItemString(retval, "notBefore", pnotBefore) < 0) {
1176 Py_DECREF(pnotBefore);
1177 goto fail1;
1178 }
1179 Py_DECREF(pnotBefore);
Thomas Woutersed03b412007-08-28 21:37:11 +00001180
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001181 (void) BIO_reset(biobuf);
1182 notAfter = X509_get_notAfter(certificate);
1183 ASN1_TIME_print(biobuf, notAfter);
1184 len = BIO_gets(biobuf, buf, sizeof(buf)-1);
1185 if (len < 0) {
1186 _setSSLError(NULL, 0, __FILE__, __LINE__);
1187 goto fail1;
1188 }
1189 pnotAfter = PyUnicode_FromStringAndSize(buf, len);
1190 if (pnotAfter == NULL)
1191 goto fail1;
1192 if (PyDict_SetItemString(retval, "notAfter", pnotAfter) < 0) {
1193 Py_DECREF(pnotAfter);
1194 goto fail1;
1195 }
1196 Py_DECREF(pnotAfter);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001197
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001198 /* Now look for subjectAltName */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001199
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001200 peer_alt_names = _get_peer_alt_names(certificate);
1201 if (peer_alt_names == NULL)
1202 goto fail1;
1203 else if (peer_alt_names != Py_None) {
1204 if (PyDict_SetItemString(retval, "subjectAltName",
1205 peer_alt_names) < 0) {
1206 Py_DECREF(peer_alt_names);
1207 goto fail1;
1208 }
1209 Py_DECREF(peer_alt_names);
1210 }
Guido van Rossumf06628b2007-11-21 20:01:53 +00001211
Christian Heimesbd3a7f92013-11-21 03:40:15 +01001212 /* Authority Information Access: OCSP URIs */
1213 obj = _get_aia_uri(certificate, NID_ad_OCSP);
1214 if (obj == NULL) {
1215 goto fail1;
1216 } else if (obj != Py_None) {
1217 result = PyDict_SetItemString(retval, "OCSP", obj);
1218 Py_DECREF(obj);
1219 if (result < 0) {
1220 goto fail1;
1221 }
1222 }
1223
1224 obj = _get_aia_uri(certificate, NID_ad_ca_issuers);
1225 if (obj == NULL) {
1226 goto fail1;
1227 } else if (obj != Py_None) {
1228 result = PyDict_SetItemString(retval, "caIssuers", obj);
1229 Py_DECREF(obj);
1230 if (result < 0) {
1231 goto fail1;
1232 }
1233 }
1234
1235 /* CDP (CRL distribution points) */
1236 obj = _get_crl_dp(certificate);
1237 if (obj == NULL) {
1238 goto fail1;
1239 } else if (obj != Py_None) {
1240 result = PyDict_SetItemString(retval, "crlDistributionPoints", obj);
1241 Py_DECREF(obj);
1242 if (result < 0) {
1243 goto fail1;
1244 }
1245 }
1246
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001247 BIO_free(biobuf);
1248 return retval;
Thomas Woutersed03b412007-08-28 21:37:11 +00001249
1250 fail1:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001251 if (biobuf != NULL)
1252 BIO_free(biobuf);
Thomas Woutersed03b412007-08-28 21:37:11 +00001253 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001254 Py_XDECREF(retval);
1255 return NULL;
Thomas Woutersed03b412007-08-28 21:37:11 +00001256}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001257
Christian Heimes9a5395a2013-06-17 15:44:12 +02001258static PyObject *
1259_certificate_to_der(X509 *certificate)
1260{
1261 unsigned char *bytes_buf = NULL;
1262 int len;
1263 PyObject *retval;
1264
1265 bytes_buf = NULL;
1266 len = i2d_X509(certificate, &bytes_buf);
1267 if (len < 0) {
1268 _setSSLError(NULL, 0, __FILE__, __LINE__);
1269 return NULL;
1270 }
1271 /* this is actually an immutable bytes sequence */
1272 retval = PyBytes_FromStringAndSize((const char *) bytes_buf, len);
1273 OPENSSL_free(bytes_buf);
1274 return retval;
1275}
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001276
1277static PyObject *
1278PySSL_test_decode_certificate (PyObject *mod, PyObject *args) {
1279
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001280 PyObject *retval = NULL;
Victor Stinner3800e1e2010-05-16 21:23:48 +00001281 PyObject *filename;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001282 X509 *x=NULL;
1283 BIO *cert;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001284
Antoine Pitroufb046912010-11-09 20:21:19 +00001285 if (!PyArg_ParseTuple(args, "O&:test_decode_certificate",
1286 PyUnicode_FSConverter, &filename))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001287 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001288
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001289 if ((cert=BIO_new(BIO_s_file())) == NULL) {
1290 PyErr_SetString(PySSLErrorObject,
1291 "Can't malloc memory to read file");
1292 goto fail0;
1293 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001294
Victor Stinner3800e1e2010-05-16 21:23:48 +00001295 if (BIO_read_filename(cert, PyBytes_AsString(filename)) <= 0) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001296 PyErr_SetString(PySSLErrorObject,
1297 "Can't open file");
1298 goto fail0;
1299 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001300
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001301 x = PEM_read_bio_X509_AUX(cert,NULL, NULL, NULL);
1302 if (x == NULL) {
1303 PyErr_SetString(PySSLErrorObject,
1304 "Error decoding PEM-encoded file");
1305 goto fail0;
1306 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001307
Antoine Pitroufb046912010-11-09 20:21:19 +00001308 retval = _decode_certificate(x);
Mark Dickinsonee55df52010-08-03 18:31:54 +00001309 X509_free(x);
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001310
1311 fail0:
Victor Stinner3800e1e2010-05-16 21:23:48 +00001312 Py_DECREF(filename);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001313 if (cert != NULL) BIO_free(cert);
1314 return retval;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001315}
1316
1317
1318static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00001319PySSL_peercert(PySSLSocket *self, PyObject *args)
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001320{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001321 int verification;
Antoine Pitrou721738f2012-08-15 23:20:39 +02001322 int binary_mode = 0;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001323
Antoine Pitrou721738f2012-08-15 23:20:39 +02001324 if (!PyArg_ParseTuple(args, "|p:peer_certificate", &binary_mode))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001325 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001326
Antoine Pitrou20b85552013-09-29 19:50:53 +02001327 if (!self->handshake_done) {
1328 PyErr_SetString(PyExc_ValueError,
1329 "handshake not done yet");
1330 return NULL;
1331 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001332 if (!self->peer_cert)
1333 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001334
Antoine Pitrou721738f2012-08-15 23:20:39 +02001335 if (binary_mode) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001336 /* return cert in DER-encoded format */
Christian Heimes9a5395a2013-06-17 15:44:12 +02001337 return _certificate_to_der(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001338 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00001339 verification = SSL_CTX_get_verify_mode(SSL_get_SSL_CTX(self->ssl));
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001340 if ((verification & SSL_VERIFY_PEER) == 0)
1341 return PyDict_New();
1342 else
Antoine Pitroufb046912010-11-09 20:21:19 +00001343 return _decode_certificate(self->peer_cert);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001344 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001345}
1346
1347PyDoc_STRVAR(PySSL_peercert_doc,
1348"peer_certificate([der=False]) -> certificate\n\
1349\n\
1350Returns the certificate for the peer. If no certificate was provided,\n\
1351returns None. If a certificate was provided, but not validated, returns\n\
1352an empty dictionary. Otherwise returns a dict containing information\n\
1353about the peer certificate.\n\
1354\n\
1355If the optional argument is True, returns a DER-encoded copy of the\n\
1356peer certificate, or None if no certificate was provided. This will\n\
1357return the certificate even if it wasn't validated.");
1358
Antoine Pitrou152efa22010-05-16 18:19:27 +00001359static PyObject *PySSL_cipher (PySSLSocket *self) {
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001360
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001361 PyObject *retval, *v;
Benjamin Petersoneb1410f2010-10-13 22:06:39 +00001362 const SSL_CIPHER *current;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001363 char *cipher_name;
1364 char *cipher_protocol;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001365
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001366 if (self->ssl == NULL)
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001367 Py_RETURN_NONE;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001368 current = SSL_get_current_cipher(self->ssl);
1369 if (current == NULL)
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001370 Py_RETURN_NONE;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001371
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001372 retval = PyTuple_New(3);
1373 if (retval == NULL)
1374 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001375
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001376 cipher_name = (char *) SSL_CIPHER_get_name(current);
1377 if (cipher_name == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001378 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001379 PyTuple_SET_ITEM(retval, 0, Py_None);
1380 } else {
1381 v = PyUnicode_FromString(cipher_name);
1382 if (v == NULL)
1383 goto fail0;
1384 PyTuple_SET_ITEM(retval, 0, v);
1385 }
1386 cipher_protocol = SSL_CIPHER_get_version(current);
1387 if (cipher_protocol == NULL) {
Hirokazu Yamamoto524f1032010-12-09 10:49:00 +00001388 Py_INCREF(Py_None);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001389 PyTuple_SET_ITEM(retval, 1, Py_None);
1390 } else {
1391 v = PyUnicode_FromString(cipher_protocol);
1392 if (v == NULL)
1393 goto fail0;
1394 PyTuple_SET_ITEM(retval, 1, v);
1395 }
1396 v = PyLong_FromLong(SSL_CIPHER_get_bits(current, NULL));
1397 if (v == NULL)
1398 goto fail0;
1399 PyTuple_SET_ITEM(retval, 2, v);
1400 return retval;
Guido van Rossumf06628b2007-11-21 20:01:53 +00001401
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001402 fail0:
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001403 Py_DECREF(retval);
1404 return NULL;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00001405}
1406
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001407#ifdef OPENSSL_NPN_NEGOTIATED
1408static PyObject *PySSL_selected_npn_protocol(PySSLSocket *self) {
1409 const unsigned char *out;
1410 unsigned int outlen;
1411
Victor Stinner4569cd52013-06-23 14:58:43 +02001412 SSL_get0_next_proto_negotiated(self->ssl,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001413 &out, &outlen);
1414
1415 if (out == NULL)
1416 Py_RETURN_NONE;
1417 return PyUnicode_FromStringAndSize((char *) out, outlen);
1418}
1419#endif
1420
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001421static PyObject *PySSL_compression(PySSLSocket *self) {
1422#ifdef OPENSSL_NO_COMP
1423 Py_RETURN_NONE;
1424#else
1425 const COMP_METHOD *comp_method;
1426 const char *short_name;
1427
1428 if (self->ssl == NULL)
1429 Py_RETURN_NONE;
1430 comp_method = SSL_get_current_compression(self->ssl);
1431 if (comp_method == NULL || comp_method->type == NID_undef)
1432 Py_RETURN_NONE;
1433 short_name = OBJ_nid2sn(comp_method->type);
1434 if (short_name == NULL)
1435 Py_RETURN_NONE;
1436 return PyUnicode_DecodeFSDefault(short_name);
1437#endif
1438}
1439
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001440static PySSLContext *PySSL_get_context(PySSLSocket *self, void *closure) {
1441 Py_INCREF(self->ctx);
1442 return self->ctx;
1443}
1444
1445static int PySSL_set_context(PySSLSocket *self, PyObject *value,
1446 void *closure) {
1447
1448 if (PyObject_TypeCheck(value, &PySSLContext_Type)) {
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001449#if !HAVE_SNI
1450 PyErr_SetString(PyExc_NotImplementedError, "setting a socket's "
1451 "context is not supported by your OpenSSL library");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01001452 return -1;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001453#else
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001454 Py_INCREF(value);
1455 Py_DECREF(self->ctx);
1456 self->ctx = (PySSLContext *) value;
1457 SSL_set_SSL_CTX(self->ssl, self->ctx->ctx);
Antoine Pitrou912fbff2013-03-30 16:29:32 +01001458#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001459 } else {
1460 PyErr_SetString(PyExc_TypeError, "The value must be a SSLContext");
1461 return -1;
1462 }
1463
1464 return 0;
1465}
1466
1467PyDoc_STRVAR(PySSL_set_context_doc,
1468"_setter_context(ctx)\n\
1469\
1470This changes the context associated with the SSLSocket. This is typically\n\
1471used from within a callback function set by the set_servername_callback\n\
1472on the SSLContext to change the certificate information associated with the\n\
1473SSLSocket before the cryptographic exchange handshake messages\n");
1474
1475
1476
Antoine Pitrou152efa22010-05-16 18:19:27 +00001477static void PySSL_dealloc(PySSLSocket *self)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001478{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001479 if (self->peer_cert) /* Possible not to have one? */
1480 X509_free (self->peer_cert);
1481 if (self->ssl)
1482 SSL_free(self->ssl);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001483 Py_XDECREF(self->Socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001484 Py_XDECREF(self->ctx);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001485 PyObject_Del(self);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001486}
1487
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001488/* If the socket has a timeout, do a select()/poll() on the socket.
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001489 The argument writing indicates the direction.
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001490 Returns one of the possibilities in the timeout_state enum (above).
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001491 */
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001492
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001493static int
Andrew M. Kuchling9c3efe32004-07-10 21:15:17 +00001494check_socket_and_wait_for_timeout(PySocketSockObject *s, int writing)
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001495{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001496 fd_set fds;
1497 struct timeval tv;
1498 int rc;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001499
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001500 /* Nothing to do unless we're in timeout mode (not non-blocking) */
1501 if (s->sock_timeout < 0.0)
1502 return SOCKET_IS_BLOCKING;
1503 else if (s->sock_timeout == 0.0)
1504 return SOCKET_IS_NONBLOCKING;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001505
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001506 /* Guard against closed socket */
1507 if (s->sock_fd < 0)
1508 return SOCKET_HAS_BEEN_CLOSED;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001509
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001510 /* Prefer poll, if available, since you can poll() any fd
1511 * which can't be done with select(). */
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001512#ifdef HAVE_POLL
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001513 {
1514 struct pollfd pollfd;
1515 int timeout;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001516
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001517 pollfd.fd = s->sock_fd;
1518 pollfd.events = writing ? POLLOUT : POLLIN;
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001519
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001520 /* s->sock_timeout is in seconds, timeout in ms */
1521 timeout = (int)(s->sock_timeout * 1000 + 0.5);
1522 PySSL_BEGIN_ALLOW_THREADS
1523 rc = poll(&pollfd, 1, timeout);
1524 PySSL_END_ALLOW_THREADS
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001525
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001526 goto normal_return;
1527 }
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001528#endif
1529
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001530 /* Guard against socket too large for select*/
Charles-François Nataliaa26b272011-08-28 17:51:43 +02001531 if (!_PyIsSelectable_fd(s->sock_fd))
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001532 return SOCKET_TOO_LARGE_FOR_SELECT;
Neal Norwitz082b2df2006-02-07 07:04:46 +00001533
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001534 /* Construct the arguments to select */
1535 tv.tv_sec = (int)s->sock_timeout;
1536 tv.tv_usec = (int)((s->sock_timeout - tv.tv_sec) * 1e6);
1537 FD_ZERO(&fds);
1538 FD_SET(s->sock_fd, &fds);
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001539
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001540 /* See if the socket is ready */
1541 PySSL_BEGIN_ALLOW_THREADS
1542 if (writing)
Christian Heimesb08ff7d2013-11-18 10:04:07 +01001543 rc = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
1544 NULL, &fds, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001545 else
Christian Heimesb08ff7d2013-11-18 10:04:07 +01001546 rc = select(Py_SAFE_DOWNCAST(s->sock_fd+1, SOCKET_T, int),
1547 &fds, NULL, NULL, &tv);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001548 PySSL_END_ALLOW_THREADS
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001549
Bill Janssen6e027db2007-11-15 22:23:56 +00001550#ifdef HAVE_POLL
Thomas Wouters0e3f5912006-08-11 14:57:12 +00001551normal_return:
Bill Janssen6e027db2007-11-15 22:23:56 +00001552#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001553 /* Return SOCKET_TIMED_OUT on timeout, SOCKET_OPERATION_OK otherwise
1554 (when we are able to write or when there's something to read) */
1555 return rc == 0 ? SOCKET_HAS_TIMED_OUT : SOCKET_OPERATION_OK;
Guido van Rossum99d4abf2003-01-27 22:22:50 +00001556}
1557
Antoine Pitrou152efa22010-05-16 18:19:27 +00001558static PyObject *PySSL_SSLwrite(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001559{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001560 Py_buffer buf;
1561 int len;
1562 int sockstate;
1563 int err;
1564 int nonblocking;
1565 PySocketSockObject *sock
1566 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen54cc54c2007-12-14 22:08:56 +00001567
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001568 if (((PyObject*)sock) == Py_None) {
1569 _setSSLError("Underlying socket connection gone",
1570 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1571 return NULL;
1572 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001573 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001574
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001575 if (!PyArg_ParseTuple(args, "y*:write", &buf)) {
1576 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001577 return NULL;
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001578 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001579
Victor Stinner6efa9652013-06-25 00:42:31 +02001580 if (buf.len > INT_MAX) {
1581 PyErr_Format(PyExc_OverflowError,
1582 "string longer than %d bytes", INT_MAX);
1583 goto error;
1584 }
1585
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001586 /* just in case the blocking state of the socket has been changed */
1587 nonblocking = (sock->sock_timeout >= 0.0);
1588 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1589 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1590
1591 sockstate = check_socket_and_wait_for_timeout(sock, 1);
1592 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001593 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001594 "The write operation timed out");
1595 goto error;
1596 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1597 PyErr_SetString(PySSLErrorObject,
1598 "Underlying socket has been closed.");
1599 goto error;
1600 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1601 PyErr_SetString(PySSLErrorObject,
1602 "Underlying socket too large for select().");
1603 goto error;
1604 }
1605 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001606 PySSL_BEGIN_ALLOW_THREADS
Victor Stinner6efa9652013-06-25 00:42:31 +02001607 len = SSL_write(self->ssl, buf.buf, (int)buf.len);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001608 err = SSL_get_error(self->ssl, len);
1609 PySSL_END_ALLOW_THREADS
1610 if (PyErr_CheckSignals()) {
1611 goto error;
Bill Janssen54cc54c2007-12-14 22:08:56 +00001612 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001613 if (err == SSL_ERROR_WANT_READ) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001614 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001615 } else if (err == SSL_ERROR_WANT_WRITE) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001616 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001617 } else {
1618 sockstate = SOCKET_OPERATION_OK;
1619 }
1620 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001621 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001622 "The write operation timed out");
1623 goto error;
1624 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1625 PyErr_SetString(PySSLErrorObject,
1626 "Underlying socket has been closed.");
1627 goto error;
1628 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1629 break;
1630 }
1631 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001632
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001633 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001634 PyBuffer_Release(&buf);
1635 if (len > 0)
1636 return PyLong_FromLong(len);
1637 else
1638 return PySSL_SetError(self, len, __FILE__, __LINE__);
Antoine Pitrou7d7aede2009-11-25 18:55:32 +00001639
1640error:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001641 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001642 PyBuffer_Release(&buf);
1643 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001644}
1645
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001646PyDoc_STRVAR(PySSL_SSLwrite_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001647"write(s) -> len\n\
1648\n\
1649Writes the string s into the SSL object. Returns the number\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001650of bytes written.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001651
Antoine Pitrou152efa22010-05-16 18:19:27 +00001652static PyObject *PySSL_SSLpending(PySSLSocket *self)
Bill Janssen6e027db2007-11-15 22:23:56 +00001653{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001654 int count = 0;
Bill Janssen6e027db2007-11-15 22:23:56 +00001655
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001656 PySSL_BEGIN_ALLOW_THREADS
1657 count = SSL_pending(self->ssl);
1658 PySSL_END_ALLOW_THREADS
1659 if (count < 0)
1660 return PySSL_SetError(self, count, __FILE__, __LINE__);
1661 else
1662 return PyLong_FromLong(count);
Bill Janssen6e027db2007-11-15 22:23:56 +00001663}
1664
1665PyDoc_STRVAR(PySSL_SSLpending_doc,
1666"pending() -> count\n\
1667\n\
1668Returns the number of already decrypted bytes available for read,\n\
1669pending on the connection.\n");
1670
Antoine Pitrou152efa22010-05-16 18:19:27 +00001671static PyObject *PySSL_SSLread(PySSLSocket *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001672{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001673 PyObject *dest = NULL;
1674 Py_buffer buf;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001675 char *mem;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001676 int len, count;
1677 int buf_passed = 0;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001678 int sockstate;
1679 int err;
1680 int nonblocking;
1681 PySocketSockObject *sock
1682 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen54cc54c2007-12-14 22:08:56 +00001683
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001684 if (((PyObject*)sock) == Py_None) {
1685 _setSSLError("Underlying socket connection gone",
1686 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1687 return NULL;
1688 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001689 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001690
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001691 buf.obj = NULL;
1692 buf.buf = NULL;
1693 if (!PyArg_ParseTuple(args, "i|w*:read", &len, &buf))
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001694 goto error;
1695
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001696 if ((buf.buf == NULL) && (buf.obj == NULL)) {
1697 dest = PyBytes_FromStringAndSize(NULL, len);
1698 if (dest == NULL)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001699 goto error;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001700 mem = PyBytes_AS_STRING(dest);
1701 }
1702 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001703 buf_passed = 1;
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001704 mem = buf.buf;
1705 if (len <= 0 || len > buf.len) {
1706 len = (int) buf.len;
1707 if (buf.len != len) {
1708 PyErr_SetString(PyExc_OverflowError,
1709 "maximum length can't fit in a C 'int'");
1710 goto error;
1711 }
1712 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001713 }
1714
1715 /* just in case the blocking state of the socket has been changed */
1716 nonblocking = (sock->sock_timeout >= 0.0);
1717 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1718 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1719
1720 /* first check if there are bytes ready to be read */
1721 PySSL_BEGIN_ALLOW_THREADS
1722 count = SSL_pending(self->ssl);
1723 PySSL_END_ALLOW_THREADS
1724
1725 if (!count) {
1726 sockstate = check_socket_and_wait_for_timeout(sock, 0);
1727 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001728 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001729 "The read operation timed out");
1730 goto error;
1731 } else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1732 PyErr_SetString(PySSLErrorObject,
Antoine Pitrou525807b2010-05-12 14:05:24 +00001733 "Underlying socket too large for select().");
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001734 goto error;
1735 } else if (sockstate == SOCKET_HAS_BEEN_CLOSED) {
1736 count = 0;
1737 goto done;
Bill Janssen54cc54c2007-12-14 22:08:56 +00001738 }
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001739 }
1740 do {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001741 PySSL_BEGIN_ALLOW_THREADS
1742 count = SSL_read(self->ssl, mem, len);
1743 err = SSL_get_error(self->ssl, count);
1744 PySSL_END_ALLOW_THREADS
1745 if (PyErr_CheckSignals())
1746 goto error;
1747 if (err == SSL_ERROR_WANT_READ) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001748 sockstate = check_socket_and_wait_for_timeout(sock, 0);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001749 } else if (err == SSL_ERROR_WANT_WRITE) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00001750 sockstate = check_socket_and_wait_for_timeout(sock, 1);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001751 } else if ((err == SSL_ERROR_ZERO_RETURN) &&
1752 (SSL_get_shutdown(self->ssl) ==
1753 SSL_RECEIVED_SHUTDOWN))
1754 {
1755 count = 0;
1756 goto done;
1757 } else {
1758 sockstate = SOCKET_OPERATION_OK;
1759 }
1760 if (sockstate == SOCKET_HAS_TIMED_OUT) {
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001761 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001762 "The read operation timed out");
1763 goto error;
1764 } else if (sockstate == SOCKET_IS_NONBLOCKING) {
1765 break;
1766 }
1767 } while (err == SSL_ERROR_WANT_READ || err == SSL_ERROR_WANT_WRITE);
1768 if (count <= 0) {
1769 PySSL_SetError(self, count, __FILE__, __LINE__);
1770 goto error;
1771 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001772
1773done:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001774 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001775 if (!buf_passed) {
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001776 _PyBytes_Resize(&dest, count);
1777 return dest;
1778 }
1779 else {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001780 PyBuffer_Release(&buf);
1781 return PyLong_FromLong(count);
1782 }
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001783
1784error:
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001785 Py_DECREF(sock);
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001786 if (!buf_passed)
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001787 Py_XDECREF(dest);
Antoine Pitrou24e561a2010-09-03 18:38:17 +00001788 else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001789 PyBuffer_Release(&buf);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001790 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001791}
1792
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001793PyDoc_STRVAR(PySSL_SSLread_doc,
Bill Janssen6e027db2007-11-15 22:23:56 +00001794"read([len]) -> string\n\
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001795\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001796Read up to len bytes from the SSL socket.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001797
Antoine Pitrou152efa22010-05-16 18:19:27 +00001798static PyObject *PySSL_SSLshutdown(PySSLSocket *self)
Bill Janssen40a0f662008-08-12 16:56:25 +00001799{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001800 int err, ssl_err, sockstate, nonblocking;
1801 int zeros = 0;
1802 PySocketSockObject *sock
1803 = (PySocketSockObject *) PyWeakref_GetObject(self->Socket);
Bill Janssen40a0f662008-08-12 16:56:25 +00001804
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001805 /* Guard against closed socket */
1806 if ((((PyObject*)sock) == Py_None) || (sock->sock_fd < 0)) {
1807 _setSSLError("Underlying socket connection gone",
1808 PY_SSL_ERROR_NO_SOCKET, __FILE__, __LINE__);
1809 return NULL;
1810 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001811 Py_INCREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001812
1813 /* Just in case the blocking state of the socket has been changed */
1814 nonblocking = (sock->sock_timeout >= 0.0);
1815 BIO_set_nbio(SSL_get_rbio(self->ssl), nonblocking);
1816 BIO_set_nbio(SSL_get_wbio(self->ssl), nonblocking);
1817
1818 while (1) {
1819 PySSL_BEGIN_ALLOW_THREADS
1820 /* Disable read-ahead so that unwrap can work correctly.
1821 * Otherwise OpenSSL might read in too much data,
1822 * eating clear text data that happens to be
1823 * transmitted after the SSL shutdown.
Ezio Melotti85a86292013-08-17 16:57:41 +03001824 * Should be safe to call repeatedly every time this
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001825 * function is used and the shutdown_seen_zero != 0
1826 * condition is met.
1827 */
1828 if (self->shutdown_seen_zero)
1829 SSL_set_read_ahead(self->ssl, 0);
1830 err = SSL_shutdown(self->ssl);
1831 PySSL_END_ALLOW_THREADS
1832 /* If err == 1, a secure shutdown with SSL_shutdown() is complete */
1833 if (err > 0)
1834 break;
1835 if (err == 0) {
1836 /* Don't loop endlessly; instead preserve legacy
1837 behaviour of trying SSL_shutdown() only twice.
1838 This looks necessary for OpenSSL < 0.9.8m */
1839 if (++zeros > 1)
1840 break;
1841 /* Shutdown was sent, now try receiving */
1842 self->shutdown_seen_zero = 1;
1843 continue;
Bill Janssen40a0f662008-08-12 16:56:25 +00001844 }
1845
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001846 /* Possibly retry shutdown until timeout or failure */
1847 ssl_err = SSL_get_error(self->ssl, err);
1848 if (ssl_err == SSL_ERROR_WANT_READ)
1849 sockstate = check_socket_and_wait_for_timeout(sock, 0);
1850 else if (ssl_err == SSL_ERROR_WANT_WRITE)
1851 sockstate = check_socket_and_wait_for_timeout(sock, 1);
1852 else
1853 break;
1854 if (sockstate == SOCKET_HAS_TIMED_OUT) {
1855 if (ssl_err == SSL_ERROR_WANT_READ)
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001856 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001857 "The read operation timed out");
1858 else
Antoine Pitrouc4df7842010-12-03 19:59:41 +00001859 PyErr_SetString(PySocketModule.timeout_error,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001860 "The write operation timed out");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001861 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001862 }
1863 else if (sockstate == SOCKET_TOO_LARGE_FOR_SELECT) {
1864 PyErr_SetString(PySSLErrorObject,
1865 "Underlying socket too large for select().");
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001866 goto error;
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001867 }
1868 else if (sockstate != SOCKET_OPERATION_OK)
1869 /* Retain the SSL error code */
1870 break;
1871 }
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +00001872
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001873 if (err < 0) {
1874 Py_DECREF(sock);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001875 return PySSL_SetError(self, err, __FILE__, __LINE__);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001876 }
Antoine Pitrou8bae4ec2010-06-24 22:34:04 +00001877 else
1878 /* It's already INCREF'ed */
1879 return (PyObject *) sock;
1880
1881error:
1882 Py_DECREF(sock);
1883 return NULL;
Bill Janssen40a0f662008-08-12 16:56:25 +00001884}
1885
1886PyDoc_STRVAR(PySSL_SSLshutdown_doc,
1887"shutdown(s) -> socket\n\
1888\n\
1889Does the SSL shutdown handshake with the remote end, and returns\n\
1890the underlying socket object.");
1891
Antoine Pitroud6494802011-07-21 01:11:30 +02001892#if HAVE_OPENSSL_FINISHED
1893static PyObject *
1894PySSL_tls_unique_cb(PySSLSocket *self)
1895{
1896 PyObject *retval = NULL;
1897 char buf[PySSL_CB_MAXLEN];
Victor Stinner9ee02032013-06-23 15:08:23 +02001898 size_t len;
Antoine Pitroud6494802011-07-21 01:11:30 +02001899
1900 if (SSL_session_reused(self->ssl) ^ !self->socket_type) {
1901 /* if session is resumed XOR we are the client */
1902 len = SSL_get_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1903 }
1904 else {
1905 /* if a new session XOR we are the server */
1906 len = SSL_get_peer_finished(self->ssl, buf, PySSL_CB_MAXLEN);
1907 }
1908
1909 /* It cannot be negative in current OpenSSL version as of July 2011 */
Antoine Pitroud6494802011-07-21 01:11:30 +02001910 if (len == 0)
1911 Py_RETURN_NONE;
1912
1913 retval = PyBytes_FromStringAndSize(buf, len);
1914
1915 return retval;
1916}
1917
1918PyDoc_STRVAR(PySSL_tls_unique_cb_doc,
1919"tls_unique_cb() -> bytes\n\
1920\n\
1921Returns the 'tls-unique' channel binding data, as defined by RFC 5929.\n\
1922\n\
1923If the TLS handshake is not yet complete, None is returned");
1924
1925#endif /* HAVE_OPENSSL_FINISHED */
Bill Janssen40a0f662008-08-12 16:56:25 +00001926
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001927static PyGetSetDef ssl_getsetlist[] = {
1928 {"context", (getter) PySSL_get_context,
1929 (setter) PySSL_set_context, PySSL_set_context_doc},
1930 {NULL}, /* sentinel */
1931};
1932
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001933static PyMethodDef PySSLMethods[] = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001934 {"do_handshake", (PyCFunction)PySSL_SSLdo_handshake, METH_NOARGS},
1935 {"write", (PyCFunction)PySSL_SSLwrite, METH_VARARGS,
1936 PySSL_SSLwrite_doc},
1937 {"read", (PyCFunction)PySSL_SSLread, METH_VARARGS,
1938 PySSL_SSLread_doc},
1939 {"pending", (PyCFunction)PySSL_SSLpending, METH_NOARGS,
1940 PySSL_SSLpending_doc},
1941 {"peer_certificate", (PyCFunction)PySSL_peercert, METH_VARARGS,
1942 PySSL_peercert_doc},
1943 {"cipher", (PyCFunction)PySSL_cipher, METH_NOARGS},
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01001944#ifdef OPENSSL_NPN_NEGOTIATED
1945 {"selected_npn_protocol", (PyCFunction)PySSL_selected_npn_protocol, METH_NOARGS},
1946#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01001947 {"compression", (PyCFunction)PySSL_compression, METH_NOARGS},
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001948 {"shutdown", (PyCFunction)PySSL_SSLshutdown, METH_NOARGS,
1949 PySSL_SSLshutdown_doc},
Antoine Pitroud6494802011-07-21 01:11:30 +02001950#if HAVE_OPENSSL_FINISHED
1951 {"tls_unique_cb", (PyCFunction)PySSL_tls_unique_cb, METH_NOARGS,
1952 PySSL_tls_unique_cb_doc},
1953#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001954 {NULL, NULL}
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001955};
1956
Antoine Pitrou152efa22010-05-16 18:19:27 +00001957static PyTypeObject PySSLSocket_Type = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001958 PyVarObject_HEAD_INIT(NULL, 0)
Antoine Pitrou152efa22010-05-16 18:19:27 +00001959 "_ssl._SSLSocket", /*tp_name*/
1960 sizeof(PySSLSocket), /*tp_basicsize*/
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00001961 0, /*tp_itemsize*/
1962 /* methods */
1963 (destructor)PySSL_dealloc, /*tp_dealloc*/
1964 0, /*tp_print*/
1965 0, /*tp_getattr*/
1966 0, /*tp_setattr*/
1967 0, /*tp_reserved*/
1968 0, /*tp_repr*/
1969 0, /*tp_as_number*/
1970 0, /*tp_as_sequence*/
1971 0, /*tp_as_mapping*/
1972 0, /*tp_hash*/
1973 0, /*tp_call*/
1974 0, /*tp_str*/
1975 0, /*tp_getattro*/
1976 0, /*tp_setattro*/
1977 0, /*tp_as_buffer*/
1978 Py_TPFLAGS_DEFAULT, /*tp_flags*/
1979 0, /*tp_doc*/
1980 0, /*tp_traverse*/
1981 0, /*tp_clear*/
1982 0, /*tp_richcompare*/
1983 0, /*tp_weaklistoffset*/
1984 0, /*tp_iter*/
1985 0, /*tp_iternext*/
1986 PySSLMethods, /*tp_methods*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01001987 0, /*tp_members*/
1988 ssl_getsetlist, /*tp_getset*/
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00001989};
1990
Antoine Pitrou152efa22010-05-16 18:19:27 +00001991
1992/*
1993 * _SSLContext objects
1994 */
1995
1996static PyObject *
1997context_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1998{
1999 char *kwlist[] = {"protocol", NULL};
2000 PySSLContext *self;
2001 int proto_version = PY_SSL_VERSION_SSL23;
2002 SSL_CTX *ctx = NULL;
2003
2004 if (!PyArg_ParseTupleAndKeywords(
2005 args, kwds, "i:_SSLContext", kwlist,
2006 &proto_version))
2007 return NULL;
2008
2009 PySSL_BEGIN_ALLOW_THREADS
2010 if (proto_version == PY_SSL_VERSION_TLS1)
2011 ctx = SSL_CTX_new(TLSv1_method());
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01002012#if HAVE_TLSv1_2
2013 else if (proto_version == PY_SSL_VERSION_TLS1_1)
2014 ctx = SSL_CTX_new(TLSv1_1_method());
2015 else if (proto_version == PY_SSL_VERSION_TLS1_2)
2016 ctx = SSL_CTX_new(TLSv1_2_method());
2017#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002018 else if (proto_version == PY_SSL_VERSION_SSL3)
2019 ctx = SSL_CTX_new(SSLv3_method());
Victor Stinner3de49192011-05-09 00:42:58 +02002020#ifndef OPENSSL_NO_SSL2
Antoine Pitrou152efa22010-05-16 18:19:27 +00002021 else if (proto_version == PY_SSL_VERSION_SSL2)
2022 ctx = SSL_CTX_new(SSLv2_method());
Victor Stinner3de49192011-05-09 00:42:58 +02002023#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002024 else if (proto_version == PY_SSL_VERSION_SSL23)
2025 ctx = SSL_CTX_new(SSLv23_method());
2026 else
2027 proto_version = -1;
2028 PySSL_END_ALLOW_THREADS
2029
2030 if (proto_version == -1) {
2031 PyErr_SetString(PyExc_ValueError,
2032 "invalid protocol version");
2033 return NULL;
2034 }
2035 if (ctx == NULL) {
2036 PyErr_SetString(PySSLErrorObject,
2037 "failed to allocate SSL context");
2038 return NULL;
2039 }
2040
2041 assert(type != NULL && type->tp_alloc != NULL);
2042 self = (PySSLContext *) type->tp_alloc(type, 0);
2043 if (self == NULL) {
2044 SSL_CTX_free(ctx);
2045 return NULL;
2046 }
2047 self->ctx = ctx;
Christian Heimes5cb31c92012-09-20 12:42:54 +02002048#ifdef OPENSSL_NPN_NEGOTIATED
2049 self->npn_protocols = NULL;
2050#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002051#ifndef OPENSSL_NO_TLSEXT
Victor Stinner7e001512013-06-25 00:44:31 +02002052 self->set_hostname = NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002053#endif
Christian Heimes1aa9a752013-12-02 02:41:19 +01002054 /* Don't check host name by default */
2055 self->check_hostname = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002056 /* Defaults */
2057 SSL_CTX_set_verify(self->ctx, SSL_VERIFY_NONE, NULL);
Antoine Pitrou3f366312012-01-27 09:50:45 +01002058 SSL_CTX_set_options(self->ctx,
2059 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002060
Antoine Pitroufc113ee2010-10-13 12:46:13 +00002061#define SID_CTX "Python"
2062 SSL_CTX_set_session_id_context(self->ctx, (const unsigned char *) SID_CTX,
2063 sizeof(SID_CTX));
2064#undef SID_CTX
2065
Antoine Pitrou152efa22010-05-16 18:19:27 +00002066 return (PyObject *)self;
2067}
2068
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002069static int
2070context_traverse(PySSLContext *self, visitproc visit, void *arg)
2071{
2072#ifndef OPENSSL_NO_TLSEXT
2073 Py_VISIT(self->set_hostname);
2074#endif
2075 return 0;
2076}
2077
2078static int
2079context_clear(PySSLContext *self)
2080{
2081#ifndef OPENSSL_NO_TLSEXT
2082 Py_CLEAR(self->set_hostname);
2083#endif
2084 return 0;
2085}
2086
Antoine Pitrou152efa22010-05-16 18:19:27 +00002087static void
2088context_dealloc(PySSLContext *self)
2089{
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002090 context_clear(self);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002091 SSL_CTX_free(self->ctx);
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002092#ifdef OPENSSL_NPN_NEGOTIATED
2093 PyMem_Free(self->npn_protocols);
2094#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00002095 Py_TYPE(self)->tp_free(self);
2096}
2097
2098static PyObject *
2099set_ciphers(PySSLContext *self, PyObject *args)
2100{
2101 int ret;
2102 const char *cipherlist;
2103
2104 if (!PyArg_ParseTuple(args, "s:set_ciphers", &cipherlist))
2105 return NULL;
2106 ret = SSL_CTX_set_cipher_list(self->ctx, cipherlist);
2107 if (ret == 0) {
Antoine Pitrou65ec8ae2010-05-16 19:56:32 +00002108 /* Clearing the error queue is necessary on some OpenSSL versions,
2109 otherwise the error will be reported again when another SSL call
2110 is done. */
2111 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002112 PyErr_SetString(PySSLErrorObject,
2113 "No cipher can be selected.");
2114 return NULL;
2115 }
2116 Py_RETURN_NONE;
2117}
2118
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002119#ifdef OPENSSL_NPN_NEGOTIATED
2120/* this callback gets passed to SSL_CTX_set_next_protos_advertise_cb */
2121static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002122_advertiseNPN_cb(SSL *s,
2123 const unsigned char **data, unsigned int *len,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002124 void *args)
2125{
2126 PySSLContext *ssl_ctx = (PySSLContext *) args;
2127
2128 if (ssl_ctx->npn_protocols == NULL) {
2129 *data = (unsigned char *) "";
2130 *len = 0;
2131 } else {
2132 *data = (unsigned char *) ssl_ctx->npn_protocols;
2133 *len = ssl_ctx->npn_protocols_len;
2134 }
2135
2136 return SSL_TLSEXT_ERR_OK;
2137}
2138/* this callback gets passed to SSL_CTX_set_next_proto_select_cb */
2139static int
Victor Stinner4569cd52013-06-23 14:58:43 +02002140_selectNPN_cb(SSL *s,
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002141 unsigned char **out, unsigned char *outlen,
2142 const unsigned char *server, unsigned int server_len,
2143 void *args)
2144{
2145 PySSLContext *ssl_ctx = (PySSLContext *) args;
2146
2147 unsigned char *client = (unsigned char *) ssl_ctx->npn_protocols;
2148 int client_len;
2149
2150 if (client == NULL) {
2151 client = (unsigned char *) "";
2152 client_len = 0;
2153 } else {
2154 client_len = ssl_ctx->npn_protocols_len;
2155 }
2156
2157 SSL_select_next_proto(out, outlen,
2158 server, server_len,
2159 client, client_len);
2160
2161 return SSL_TLSEXT_ERR_OK;
2162}
2163#endif
2164
2165static PyObject *
2166_set_npn_protocols(PySSLContext *self, PyObject *args)
2167{
2168#ifdef OPENSSL_NPN_NEGOTIATED
2169 Py_buffer protos;
2170
2171 if (!PyArg_ParseTuple(args, "y*:set_npn_protocols", &protos))
2172 return NULL;
2173
Christian Heimes5cb31c92012-09-20 12:42:54 +02002174 if (self->npn_protocols != NULL) {
2175 PyMem_Free(self->npn_protocols);
2176 }
2177
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01002178 self->npn_protocols = PyMem_Malloc(protos.len);
2179 if (self->npn_protocols == NULL) {
2180 PyBuffer_Release(&protos);
2181 return PyErr_NoMemory();
2182 }
2183 memcpy(self->npn_protocols, protos.buf, protos.len);
2184 self->npn_protocols_len = (int) protos.len;
2185
2186 /* set both server and client callbacks, because the context can
2187 * be used to create both types of sockets */
2188 SSL_CTX_set_next_protos_advertised_cb(self->ctx,
2189 _advertiseNPN_cb,
2190 self);
2191 SSL_CTX_set_next_proto_select_cb(self->ctx,
2192 _selectNPN_cb,
2193 self);
2194
2195 PyBuffer_Release(&protos);
2196 Py_RETURN_NONE;
2197#else
2198 PyErr_SetString(PyExc_NotImplementedError,
2199 "The NPN extension requires OpenSSL 1.0.1 or later.");
2200 return NULL;
2201#endif
2202}
2203
Antoine Pitrou152efa22010-05-16 18:19:27 +00002204static PyObject *
2205get_verify_mode(PySSLContext *self, void *c)
2206{
2207 switch (SSL_CTX_get_verify_mode(self->ctx)) {
2208 case SSL_VERIFY_NONE:
2209 return PyLong_FromLong(PY_SSL_CERT_NONE);
2210 case SSL_VERIFY_PEER:
2211 return PyLong_FromLong(PY_SSL_CERT_OPTIONAL);
2212 case SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT:
2213 return PyLong_FromLong(PY_SSL_CERT_REQUIRED);
2214 }
2215 PyErr_SetString(PySSLErrorObject,
2216 "invalid return value from SSL_CTX_get_verify_mode");
2217 return NULL;
2218}
2219
2220static int
2221set_verify_mode(PySSLContext *self, PyObject *arg, void *c)
2222{
2223 int n, mode;
2224 if (!PyArg_Parse(arg, "i", &n))
2225 return -1;
2226 if (n == PY_SSL_CERT_NONE)
2227 mode = SSL_VERIFY_NONE;
2228 else if (n == PY_SSL_CERT_OPTIONAL)
2229 mode = SSL_VERIFY_PEER;
2230 else if (n == PY_SSL_CERT_REQUIRED)
2231 mode = SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT;
2232 else {
2233 PyErr_SetString(PyExc_ValueError,
2234 "invalid value for verify_mode");
2235 return -1;
2236 }
Christian Heimes1aa9a752013-12-02 02:41:19 +01002237 if (mode == SSL_VERIFY_NONE && self->check_hostname) {
2238 PyErr_SetString(PyExc_ValueError,
2239 "Cannot set verify_mode to CERT_NONE when "
2240 "check_hostname is enabled.");
2241 return -1;
2242 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002243 SSL_CTX_set_verify(self->ctx, mode, NULL);
2244 return 0;
2245}
2246
Christian Heimes2427b502013-11-23 11:24:32 +01002247#ifdef HAVE_OPENSSL_VERIFY_PARAM
Antoine Pitrou152efa22010-05-16 18:19:27 +00002248static PyObject *
Christian Heimes22587792013-11-21 23:56:13 +01002249get_verify_flags(PySSLContext *self, void *c)
2250{
2251 X509_STORE *store;
2252 unsigned long flags;
2253
2254 store = SSL_CTX_get_cert_store(self->ctx);
2255 flags = X509_VERIFY_PARAM_get_flags(store->param);
2256 return PyLong_FromUnsignedLong(flags);
2257}
2258
2259static int
2260set_verify_flags(PySSLContext *self, PyObject *arg, void *c)
2261{
2262 X509_STORE *store;
2263 unsigned long new_flags, flags, set, clear;
2264
2265 if (!PyArg_Parse(arg, "k", &new_flags))
2266 return -1;
2267 store = SSL_CTX_get_cert_store(self->ctx);
2268 flags = X509_VERIFY_PARAM_get_flags(store->param);
2269 clear = flags & ~new_flags;
2270 set = ~flags & new_flags;
2271 if (clear) {
2272 if (!X509_VERIFY_PARAM_clear_flags(store->param, clear)) {
2273 _setSSLError(NULL, 0, __FILE__, __LINE__);
2274 return -1;
2275 }
2276 }
2277 if (set) {
2278 if (!X509_VERIFY_PARAM_set_flags(store->param, set)) {
2279 _setSSLError(NULL, 0, __FILE__, __LINE__);
2280 return -1;
2281 }
2282 }
2283 return 0;
2284}
Christian Heimes2427b502013-11-23 11:24:32 +01002285#endif
Christian Heimes22587792013-11-21 23:56:13 +01002286
2287static PyObject *
Antoine Pitroub5218772010-05-21 09:56:06 +00002288get_options(PySSLContext *self, void *c)
2289{
2290 return PyLong_FromLong(SSL_CTX_get_options(self->ctx));
2291}
2292
2293static int
2294set_options(PySSLContext *self, PyObject *arg, void *c)
2295{
2296 long new_opts, opts, set, clear;
2297 if (!PyArg_Parse(arg, "l", &new_opts))
2298 return -1;
2299 opts = SSL_CTX_get_options(self->ctx);
2300 clear = opts & ~new_opts;
2301 set = ~opts & new_opts;
2302 if (clear) {
2303#ifdef HAVE_SSL_CTX_CLEAR_OPTIONS
2304 SSL_CTX_clear_options(self->ctx, clear);
2305#else
2306 PyErr_SetString(PyExc_ValueError,
2307 "can't clear options before OpenSSL 0.9.8m");
2308 return -1;
2309#endif
2310 }
2311 if (set)
2312 SSL_CTX_set_options(self->ctx, set);
2313 return 0;
2314}
2315
Christian Heimes1aa9a752013-12-02 02:41:19 +01002316static PyObject *
2317get_check_hostname(PySSLContext *self, void *c)
2318{
2319 return PyBool_FromLong(self->check_hostname);
2320}
2321
2322static int
2323set_check_hostname(PySSLContext *self, PyObject *arg, void *c)
2324{
2325 int check_hostname;
2326 if (!PyArg_Parse(arg, "p", &check_hostname))
2327 return -1;
2328 if (check_hostname &&
2329 SSL_CTX_get_verify_mode(self->ctx) == SSL_VERIFY_NONE) {
2330 PyErr_SetString(PyExc_ValueError,
2331 "check_hostname needs a SSL context with either "
2332 "CERT_OPTIONAL or CERT_REQUIRED");
2333 return -1;
2334 }
2335 self->check_hostname = check_hostname;
2336 return 0;
2337}
2338
2339
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002340typedef struct {
2341 PyThreadState *thread_state;
2342 PyObject *callable;
2343 char *password;
Victor Stinner9ee02032013-06-23 15:08:23 +02002344 int size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002345 int error;
2346} _PySSLPasswordInfo;
2347
2348static int
2349_pwinfo_set(_PySSLPasswordInfo *pw_info, PyObject* password,
2350 const char *bad_type_error)
2351{
2352 /* Set the password and size fields of a _PySSLPasswordInfo struct
2353 from a unicode, bytes, or byte array object.
2354 The password field will be dynamically allocated and must be freed
2355 by the caller */
2356 PyObject *password_bytes = NULL;
2357 const char *data = NULL;
2358 Py_ssize_t size;
2359
2360 if (PyUnicode_Check(password)) {
2361 password_bytes = PyUnicode_AsEncodedString(password, NULL, NULL);
2362 if (!password_bytes) {
2363 goto error;
2364 }
2365 data = PyBytes_AS_STRING(password_bytes);
2366 size = PyBytes_GET_SIZE(password_bytes);
2367 } else if (PyBytes_Check(password)) {
2368 data = PyBytes_AS_STRING(password);
2369 size = PyBytes_GET_SIZE(password);
2370 } else if (PyByteArray_Check(password)) {
2371 data = PyByteArray_AS_STRING(password);
2372 size = PyByteArray_GET_SIZE(password);
2373 } else {
2374 PyErr_SetString(PyExc_TypeError, bad_type_error);
2375 goto error;
2376 }
2377
Victor Stinner9ee02032013-06-23 15:08:23 +02002378 if (size > (Py_ssize_t)INT_MAX) {
2379 PyErr_Format(PyExc_ValueError,
2380 "password cannot be longer than %d bytes", INT_MAX);
2381 goto error;
2382 }
2383
Victor Stinner11ebff22013-07-07 17:07:52 +02002384 PyMem_Free(pw_info->password);
2385 pw_info->password = PyMem_Malloc(size);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002386 if (!pw_info->password) {
2387 PyErr_SetString(PyExc_MemoryError,
2388 "unable to allocate password buffer");
2389 goto error;
2390 }
2391 memcpy(pw_info->password, data, size);
Victor Stinner9ee02032013-06-23 15:08:23 +02002392 pw_info->size = (int)size;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002393
2394 Py_XDECREF(password_bytes);
2395 return 1;
2396
2397error:
2398 Py_XDECREF(password_bytes);
2399 return 0;
2400}
2401
2402static int
2403_password_callback(char *buf, int size, int rwflag, void *userdata)
2404{
2405 _PySSLPasswordInfo *pw_info = (_PySSLPasswordInfo*) userdata;
2406 PyObject *fn_ret = NULL;
2407
2408 PySSL_END_ALLOW_THREADS_S(pw_info->thread_state);
2409
2410 if (pw_info->callable) {
2411 fn_ret = PyObject_CallFunctionObjArgs(pw_info->callable, NULL);
2412 if (!fn_ret) {
2413 /* TODO: It would be nice to move _ctypes_add_traceback() into the
2414 core python API, so we could use it to add a frame here */
2415 goto error;
2416 }
2417
2418 if (!_pwinfo_set(pw_info, fn_ret,
2419 "password callback must return a string")) {
2420 goto error;
2421 }
2422 Py_CLEAR(fn_ret);
2423 }
2424
2425 if (pw_info->size > size) {
2426 PyErr_Format(PyExc_ValueError,
2427 "password cannot be longer than %d bytes", size);
2428 goto error;
2429 }
2430
2431 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2432 memcpy(buf, pw_info->password, pw_info->size);
2433 return pw_info->size;
2434
2435error:
2436 Py_XDECREF(fn_ret);
2437 PySSL_BEGIN_ALLOW_THREADS_S(pw_info->thread_state);
2438 pw_info->error = 1;
2439 return -1;
2440}
2441
Antoine Pitroub5218772010-05-21 09:56:06 +00002442static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00002443load_cert_chain(PySSLContext *self, PyObject *args, PyObject *kwds)
2444{
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002445 char *kwlist[] = {"certfile", "keyfile", "password", NULL};
2446 PyObject *certfile, *keyfile = NULL, *password = NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002447 PyObject *certfile_bytes = NULL, *keyfile_bytes = NULL;
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002448 pem_password_cb *orig_passwd_cb = self->ctx->default_passwd_callback;
2449 void *orig_passwd_userdata = self->ctx->default_passwd_callback_userdata;
2450 _PySSLPasswordInfo pw_info = { NULL, NULL, NULL, 0, 0 };
Antoine Pitrou152efa22010-05-16 18:19:27 +00002451 int r;
2452
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002453 errno = 0;
Antoine Pitrou67e8e562010-09-01 20:55:41 +00002454 ERR_clear_error();
Antoine Pitrou152efa22010-05-16 18:19:27 +00002455 if (!PyArg_ParseTupleAndKeywords(args, kwds,
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002456 "O|OO:load_cert_chain", kwlist,
2457 &certfile, &keyfile, &password))
Antoine Pitrou152efa22010-05-16 18:19:27 +00002458 return NULL;
2459 if (keyfile == Py_None)
2460 keyfile = NULL;
2461 if (!PyUnicode_FSConverter(certfile, &certfile_bytes)) {
2462 PyErr_SetString(PyExc_TypeError,
2463 "certfile should be a valid filesystem path");
2464 return NULL;
2465 }
2466 if (keyfile && !PyUnicode_FSConverter(keyfile, &keyfile_bytes)) {
2467 PyErr_SetString(PyExc_TypeError,
2468 "keyfile should be a valid filesystem path");
2469 goto error;
2470 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002471 if (password && password != Py_None) {
2472 if (PyCallable_Check(password)) {
2473 pw_info.callable = password;
2474 } else if (!_pwinfo_set(&pw_info, password,
2475 "password should be a string or callable")) {
2476 goto error;
2477 }
2478 SSL_CTX_set_default_passwd_cb(self->ctx, _password_callback);
2479 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, &pw_info);
2480 }
2481 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002482 r = SSL_CTX_use_certificate_chain_file(self->ctx,
2483 PyBytes_AS_STRING(certfile_bytes));
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002484 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002485 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002486 if (pw_info.error) {
2487 ERR_clear_error();
2488 /* the password callback has already set the error information */
2489 }
2490 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002491 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002492 PyErr_SetFromErrno(PyExc_IOError);
2493 }
2494 else {
2495 _setSSLError(NULL, 0, __FILE__, __LINE__);
2496 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002497 goto error;
2498 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002499 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou9c254862011-04-03 18:15:34 +02002500 r = SSL_CTX_use_PrivateKey_file(self->ctx,
Antoine Pitrou152efa22010-05-16 18:19:27 +00002501 PyBytes_AS_STRING(keyfile ? keyfile_bytes : certfile_bytes),
2502 SSL_FILETYPE_PEM);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002503 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
2504 Py_CLEAR(keyfile_bytes);
2505 Py_CLEAR(certfile_bytes);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002506 if (r != 1) {
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002507 if (pw_info.error) {
2508 ERR_clear_error();
2509 /* the password callback has already set the error information */
2510 }
2511 else if (errno != 0) {
Giampaolo Rodolàe0f98632010-09-01 19:28:49 +00002512 ERR_clear_error();
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002513 PyErr_SetFromErrno(PyExc_IOError);
2514 }
2515 else {
2516 _setSSLError(NULL, 0, __FILE__, __LINE__);
2517 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002518 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002519 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002520 PySSL_BEGIN_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002521 r = SSL_CTX_check_private_key(self->ctx);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002522 PySSL_END_ALLOW_THREADS_S(pw_info.thread_state);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002523 if (r != 1) {
2524 _setSSLError(NULL, 0, __FILE__, __LINE__);
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002525 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002526 }
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002527 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2528 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002529 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002530 Py_RETURN_NONE;
2531
2532error:
Antoine Pitrou4fd1e6a2011-08-25 14:39:44 +02002533 SSL_CTX_set_default_passwd_cb(self->ctx, orig_passwd_cb);
2534 SSL_CTX_set_default_passwd_cb_userdata(self->ctx, orig_passwd_userdata);
Victor Stinner11ebff22013-07-07 17:07:52 +02002535 PyMem_Free(pw_info.password);
Antoine Pitrou152efa22010-05-16 18:19:27 +00002536 Py_XDECREF(keyfile_bytes);
2537 Py_XDECREF(certfile_bytes);
2538 return NULL;
2539}
2540
Christian Heimesefff7062013-11-21 03:35:02 +01002541/* internal helper function, returns -1 on error
2542 */
2543static int
2544_add_ca_certs(PySSLContext *self, void *data, Py_ssize_t len,
2545 int filetype)
2546{
2547 BIO *biobuf = NULL;
2548 X509_STORE *store;
2549 int retval = 0, err, loaded = 0;
2550
2551 assert(filetype == SSL_FILETYPE_ASN1 || filetype == SSL_FILETYPE_PEM);
2552
2553 if (len <= 0) {
2554 PyErr_SetString(PyExc_ValueError,
2555 "Empty certificate data");
2556 return -1;
2557 } else if (len > INT_MAX) {
2558 PyErr_SetString(PyExc_OverflowError,
2559 "Certificate data is too long.");
2560 return -1;
2561 }
2562
Christian Heimes1dbf61f2013-11-22 00:34:18 +01002563 biobuf = BIO_new_mem_buf(data, (int)len);
Christian Heimesefff7062013-11-21 03:35:02 +01002564 if (biobuf == NULL) {
2565 _setSSLError("Can't allocate buffer", 0, __FILE__, __LINE__);
2566 return -1;
2567 }
2568
2569 store = SSL_CTX_get_cert_store(self->ctx);
2570 assert(store != NULL);
2571
2572 while (1) {
2573 X509 *cert = NULL;
2574 int r;
2575
2576 if (filetype == SSL_FILETYPE_ASN1) {
2577 cert = d2i_X509_bio(biobuf, NULL);
2578 } else {
2579 cert = PEM_read_bio_X509(biobuf, NULL,
2580 self->ctx->default_passwd_callback,
2581 self->ctx->default_passwd_callback_userdata);
2582 }
2583 if (cert == NULL) {
2584 break;
2585 }
2586 r = X509_STORE_add_cert(store, cert);
2587 X509_free(cert);
2588 if (!r) {
2589 err = ERR_peek_last_error();
2590 if ((ERR_GET_LIB(err) == ERR_LIB_X509) &&
2591 (ERR_GET_REASON(err) == X509_R_CERT_ALREADY_IN_HASH_TABLE)) {
2592 /* cert already in hash table, not an error */
2593 ERR_clear_error();
2594 } else {
2595 break;
2596 }
2597 }
2598 loaded++;
2599 }
2600
2601 err = ERR_peek_last_error();
2602 if ((filetype == SSL_FILETYPE_ASN1) &&
2603 (loaded > 0) &&
2604 (ERR_GET_LIB(err) == ERR_LIB_ASN1) &&
2605 (ERR_GET_REASON(err) == ASN1_R_HEADER_TOO_LONG)) {
2606 /* EOF ASN1 file, not an error */
2607 ERR_clear_error();
2608 retval = 0;
2609 } else if ((filetype == SSL_FILETYPE_PEM) &&
2610 (loaded > 0) &&
2611 (ERR_GET_LIB(err) == ERR_LIB_PEM) &&
2612 (ERR_GET_REASON(err) == PEM_R_NO_START_LINE)) {
2613 /* EOF PEM file, not an error */
2614 ERR_clear_error();
2615 retval = 0;
2616 } else {
2617 _setSSLError(NULL, 0, __FILE__, __LINE__);
2618 retval = -1;
2619 }
2620
2621 BIO_free(biobuf);
2622 return retval;
2623}
2624
2625
Antoine Pitrou152efa22010-05-16 18:19:27 +00002626static PyObject *
2627load_verify_locations(PySSLContext *self, PyObject *args, PyObject *kwds)
2628{
Christian Heimesefff7062013-11-21 03:35:02 +01002629 char *kwlist[] = {"cafile", "capath", "cadata", NULL};
2630 PyObject *cafile = NULL, *capath = NULL, *cadata = NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002631 PyObject *cafile_bytes = NULL, *capath_bytes = NULL;
2632 const char *cafile_buf = NULL, *capath_buf = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002633 int r = 0, ok = 1;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002634
Giampaolo Rodolà745ab382010-08-29 19:25:49 +00002635 errno = 0;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002636 if (!PyArg_ParseTupleAndKeywords(args, kwds,
Christian Heimesefff7062013-11-21 03:35:02 +01002637 "|OOO:load_verify_locations", kwlist,
2638 &cafile, &capath, &cadata))
Antoine Pitrou152efa22010-05-16 18:19:27 +00002639 return NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002640
Antoine Pitrou152efa22010-05-16 18:19:27 +00002641 if (cafile == Py_None)
2642 cafile = NULL;
2643 if (capath == Py_None)
2644 capath = NULL;
Christian Heimesefff7062013-11-21 03:35:02 +01002645 if (cadata == Py_None)
2646 cadata = NULL;
2647
2648 if (cafile == NULL && capath == NULL && cadata == NULL) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002649 PyErr_SetString(PyExc_TypeError,
Christian Heimesefff7062013-11-21 03:35:02 +01002650 "cafile, capath and cadata cannot be all omitted");
2651 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002652 }
2653 if (cafile && !PyUnicode_FSConverter(cafile, &cafile_bytes)) {
2654 PyErr_SetString(PyExc_TypeError,
2655 "cafile should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002656 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002657 }
2658 if (capath && !PyUnicode_FSConverter(capath, &capath_bytes)) {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002659 PyErr_SetString(PyExc_TypeError,
2660 "capath should be a valid filesystem path");
Christian Heimesefff7062013-11-21 03:35:02 +01002661 goto error;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002662 }
Christian Heimesefff7062013-11-21 03:35:02 +01002663
2664 /* validata cadata type and load cadata */
2665 if (cadata) {
2666 Py_buffer buf;
2667 PyObject *cadata_ascii = NULL;
2668
2669 if (PyObject_GetBuffer(cadata, &buf, PyBUF_SIMPLE) == 0) {
2670 if (!PyBuffer_IsContiguous(&buf, 'C') || buf.ndim > 1) {
2671 PyBuffer_Release(&buf);
2672 PyErr_SetString(PyExc_TypeError,
2673 "cadata should be a contiguous buffer with "
2674 "a single dimension");
2675 goto error;
2676 }
2677 r = _add_ca_certs(self, buf.buf, buf.len, SSL_FILETYPE_ASN1);
2678 PyBuffer_Release(&buf);
2679 if (r == -1) {
2680 goto error;
2681 }
2682 } else {
2683 PyErr_Clear();
2684 cadata_ascii = PyUnicode_AsASCIIString(cadata);
2685 if (cadata_ascii == NULL) {
2686 PyErr_SetString(PyExc_TypeError,
2687 "cadata should be a ASCII string or a "
2688 "bytes-like object");
2689 goto error;
2690 }
2691 r = _add_ca_certs(self,
2692 PyBytes_AS_STRING(cadata_ascii),
2693 PyBytes_GET_SIZE(cadata_ascii),
2694 SSL_FILETYPE_PEM);
2695 Py_DECREF(cadata_ascii);
2696 if (r == -1) {
2697 goto error;
2698 }
2699 }
2700 }
2701
2702 /* load cafile or capath */
2703 if (cafile || capath) {
2704 if (cafile)
2705 cafile_buf = PyBytes_AS_STRING(cafile_bytes);
2706 if (capath)
2707 capath_buf = PyBytes_AS_STRING(capath_bytes);
2708 PySSL_BEGIN_ALLOW_THREADS
2709 r = SSL_CTX_load_verify_locations(self->ctx, cafile_buf, capath_buf);
2710 PySSL_END_ALLOW_THREADS
2711 if (r != 1) {
2712 ok = 0;
2713 if (errno != 0) {
2714 ERR_clear_error();
2715 PyErr_SetFromErrno(PyExc_IOError);
2716 }
2717 else {
2718 _setSSLError(NULL, 0, __FILE__, __LINE__);
2719 }
2720 goto error;
2721 }
2722 }
2723 goto end;
2724
2725 error:
2726 ok = 0;
2727 end:
Antoine Pitrou152efa22010-05-16 18:19:27 +00002728 Py_XDECREF(cafile_bytes);
2729 Py_XDECREF(capath_bytes);
Christian Heimesefff7062013-11-21 03:35:02 +01002730 if (ok) {
2731 Py_RETURN_NONE;
2732 } else {
Antoine Pitrou152efa22010-05-16 18:19:27 +00002733 return NULL;
2734 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002735}
2736
2737static PyObject *
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002738load_dh_params(PySSLContext *self, PyObject *filepath)
2739{
2740 FILE *f;
2741 DH *dh;
2742
Victor Stinnerdaf45552013-08-28 00:53:59 +02002743 f = _Py_fopen_obj(filepath, "rb");
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002744 if (f == NULL) {
2745 if (!PyErr_Occurred())
2746 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
2747 return NULL;
2748 }
2749 errno = 0;
2750 PySSL_BEGIN_ALLOW_THREADS
2751 dh = PEM_read_DHparams(f, NULL, NULL, NULL);
Antoine Pitrou457a2292013-01-12 21:43:45 +01002752 fclose(f);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01002753 PySSL_END_ALLOW_THREADS
2754 if (dh == NULL) {
2755 if (errno != 0) {
2756 ERR_clear_error();
2757 PyErr_SetFromErrnoWithFilenameObject(PyExc_OSError, filepath);
2758 }
2759 else {
2760 _setSSLError(NULL, 0, __FILE__, __LINE__);
2761 }
2762 return NULL;
2763 }
2764 if (SSL_CTX_set_tmp_dh(self->ctx, dh) == 0)
2765 _setSSLError(NULL, 0, __FILE__, __LINE__);
2766 DH_free(dh);
2767 Py_RETURN_NONE;
2768}
2769
2770static PyObject *
Antoine Pitrou152efa22010-05-16 18:19:27 +00002771context_wrap_socket(PySSLContext *self, PyObject *args, PyObject *kwds)
2772{
Antoine Pitroud5323212010-10-22 18:19:07 +00002773 char *kwlist[] = {"sock", "server_side", "server_hostname", NULL};
Antoine Pitrou152efa22010-05-16 18:19:27 +00002774 PySocketSockObject *sock;
2775 int server_side = 0;
Antoine Pitroud5323212010-10-22 18:19:07 +00002776 char *hostname = NULL;
2777 PyObject *hostname_obj, *res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002778
Antoine Pitroud5323212010-10-22 18:19:07 +00002779 /* server_hostname is either None (or absent), or to be encoded
2780 using the idna encoding. */
2781 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!i|O!:_wrap_socket", kwlist,
Antoine Pitrou152efa22010-05-16 18:19:27 +00002782 PySocketModule.Sock_Type,
Antoine Pitroud5323212010-10-22 18:19:07 +00002783 &sock, &server_side,
2784 Py_TYPE(Py_None), &hostname_obj)) {
2785 PyErr_Clear();
2786 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O!iet:_wrap_socket", kwlist,
2787 PySocketModule.Sock_Type,
2788 &sock, &server_side,
2789 "idna", &hostname))
2790 return NULL;
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002791#if !HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +00002792 PyMem_Free(hostname);
2793 PyErr_SetString(PyExc_ValueError, "server_hostname is not supported "
2794 "by your OpenSSL library");
Antoine Pitrou152efa22010-05-16 18:19:27 +00002795 return NULL;
Antoine Pitroud5323212010-10-22 18:19:07 +00002796#endif
2797 }
Antoine Pitrou152efa22010-05-16 18:19:27 +00002798
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002799 res = (PyObject *) newPySSLSocket(self, sock, server_side,
Antoine Pitroud5323212010-10-22 18:19:07 +00002800 hostname);
2801 if (hostname != NULL)
2802 PyMem_Free(hostname);
2803 return res;
Antoine Pitrou152efa22010-05-16 18:19:27 +00002804}
2805
Antoine Pitroub0182c82010-10-12 20:09:02 +00002806static PyObject *
2807session_stats(PySSLContext *self, PyObject *unused)
2808{
2809 int r;
2810 PyObject *value, *stats = PyDict_New();
2811 if (!stats)
2812 return NULL;
2813
2814#define ADD_STATS(SSL_NAME, KEY_NAME) \
2815 value = PyLong_FromLong(SSL_CTX_sess_ ## SSL_NAME (self->ctx)); \
2816 if (value == NULL) \
2817 goto error; \
2818 r = PyDict_SetItemString(stats, KEY_NAME, value); \
2819 Py_DECREF(value); \
2820 if (r < 0) \
2821 goto error;
2822
2823 ADD_STATS(number, "number");
2824 ADD_STATS(connect, "connect");
2825 ADD_STATS(connect_good, "connect_good");
2826 ADD_STATS(connect_renegotiate, "connect_renegotiate");
2827 ADD_STATS(accept, "accept");
2828 ADD_STATS(accept_good, "accept_good");
2829 ADD_STATS(accept_renegotiate, "accept_renegotiate");
2830 ADD_STATS(accept, "accept");
2831 ADD_STATS(hits, "hits");
2832 ADD_STATS(misses, "misses");
2833 ADD_STATS(timeouts, "timeouts");
2834 ADD_STATS(cache_full, "cache_full");
2835
2836#undef ADD_STATS
2837
2838 return stats;
2839
2840error:
2841 Py_DECREF(stats);
2842 return NULL;
2843}
2844
Antoine Pitrou664c2d12010-11-17 20:29:42 +00002845static PyObject *
2846set_default_verify_paths(PySSLContext *self, PyObject *unused)
2847{
2848 if (!SSL_CTX_set_default_verify_paths(self->ctx)) {
2849 _setSSLError(NULL, 0, __FILE__, __LINE__);
2850 return NULL;
2851 }
2852 Py_RETURN_NONE;
2853}
2854
Antoine Pitrou501da612011-12-21 09:27:41 +01002855#ifndef OPENSSL_NO_ECDH
Antoine Pitrou923df6f2011-12-19 17:16:51 +01002856static PyObject *
2857set_ecdh_curve(PySSLContext *self, PyObject *name)
2858{
2859 PyObject *name_bytes;
2860 int nid;
2861 EC_KEY *key;
2862
2863 if (!PyUnicode_FSConverter(name, &name_bytes))
2864 return NULL;
2865 assert(PyBytes_Check(name_bytes));
2866 nid = OBJ_sn2nid(PyBytes_AS_STRING(name_bytes));
2867 Py_DECREF(name_bytes);
2868 if (nid == 0) {
2869 PyErr_Format(PyExc_ValueError,
2870 "unknown elliptic curve name %R", name);
2871 return NULL;
2872 }
2873 key = EC_KEY_new_by_curve_name(nid);
2874 if (key == NULL) {
2875 _setSSLError(NULL, 0, __FILE__, __LINE__);
2876 return NULL;
2877 }
2878 SSL_CTX_set_tmp_ecdh(self->ctx, key);
2879 EC_KEY_free(key);
2880 Py_RETURN_NONE;
2881}
Antoine Pitrou501da612011-12-21 09:27:41 +01002882#endif
Antoine Pitrou923df6f2011-12-19 17:16:51 +01002883
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002884#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002885static int
2886_servername_callback(SSL *s, int *al, void *args)
2887{
2888 int ret;
2889 PySSLContext *ssl_ctx = (PySSLContext *) args;
2890 PySSLSocket *ssl;
2891 PyObject *servername_o;
2892 PyObject *servername_idna;
2893 PyObject *result;
2894 /* The high-level ssl.SSLSocket object */
2895 PyObject *ssl_socket;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002896 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
Stefan Krah20d60802013-01-17 17:07:17 +01002897#ifdef WITH_THREAD
2898 PyGILState_STATE gstate = PyGILState_Ensure();
2899#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002900
2901 if (ssl_ctx->set_hostname == NULL) {
2902 /* remove race condition in this the call back while if removing the
2903 * callback is in progress */
Stefan Krah20d60802013-01-17 17:07:17 +01002904#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002905 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002906#endif
Antoine Pitrou5dd12a52013-01-06 15:25:36 +01002907 return SSL_TLSEXT_ERR_OK;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002908 }
2909
2910 ssl = SSL_get_app_data(s);
2911 assert(PySSLSocket_Check(ssl));
2912 ssl_socket = PyWeakref_GetObject(ssl->Socket);
2913 Py_INCREF(ssl_socket);
2914 if (ssl_socket == Py_None) {
2915 goto error;
2916 }
Victor Stinner7e001512013-06-25 00:44:31 +02002917
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002918 if (servername == NULL) {
2919 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
2920 Py_None, ssl_ctx, NULL);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002921 }
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002922 else {
2923 servername_o = PyBytes_FromString(servername);
2924 if (servername_o == NULL) {
2925 PyErr_WriteUnraisable((PyObject *) ssl_ctx);
2926 goto error;
2927 }
2928 servername_idna = PyUnicode_FromEncodedObject(servername_o, "idna", NULL);
2929 if (servername_idna == NULL) {
2930 PyErr_WriteUnraisable(servername_o);
2931 Py_DECREF(servername_o);
2932 goto error;
2933 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002934 Py_DECREF(servername_o);
Antoine Pitrou50b24d02013-04-11 20:48:42 +02002935 result = PyObject_CallFunctionObjArgs(ssl_ctx->set_hostname, ssl_socket,
2936 servername_idna, ssl_ctx, NULL);
2937 Py_DECREF(servername_idna);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002938 }
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002939 Py_DECREF(ssl_socket);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002940
2941 if (result == NULL) {
2942 PyErr_WriteUnraisable(ssl_ctx->set_hostname);
2943 *al = SSL_AD_HANDSHAKE_FAILURE;
2944 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
2945 }
2946 else {
2947 if (result != Py_None) {
2948 *al = (int) PyLong_AsLong(result);
2949 if (PyErr_Occurred()) {
2950 PyErr_WriteUnraisable(result);
2951 *al = SSL_AD_INTERNAL_ERROR;
2952 }
2953 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
2954 }
2955 else {
2956 ret = SSL_TLSEXT_ERR_OK;
2957 }
2958 Py_DECREF(result);
2959 }
2960
Stefan Krah20d60802013-01-17 17:07:17 +01002961#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002962 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002963#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002964 return ret;
2965
2966error:
2967 Py_DECREF(ssl_socket);
2968 *al = SSL_AD_INTERNAL_ERROR;
2969 ret = SSL_TLSEXT_ERR_ALERT_FATAL;
Stefan Krah20d60802013-01-17 17:07:17 +01002970#ifdef WITH_THREAD
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002971 PyGILState_Release(gstate);
Stefan Krah20d60802013-01-17 17:07:17 +01002972#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002973 return ret;
2974}
Antoine Pitroua5963382013-03-30 16:39:00 +01002975#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002976
2977PyDoc_STRVAR(PySSL_set_servername_callback_doc,
2978"set_servername_callback(method)\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002979\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002980This sets a callback that will be called when a server name is provided by\n\
2981the SSL/TLS client in the SNI extension.\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002982\n\
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002983If the argument is None then the callback is disabled. The method is called\n\
2984with the SSLSocket, the server name as a string, and the SSLContext object.\n\
Antoine Pitrouedbc18e2013-03-30 16:40:27 +01002985See RFC 6066 for details of the SNI extension.");
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002986
2987static PyObject *
2988set_servername_callback(PySSLContext *self, PyObject *args)
2989{
Antoine Pitrou912fbff2013-03-30 16:29:32 +01002990#if HAVE_SNI && !defined(OPENSSL_NO_TLSEXT)
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01002991 PyObject *cb;
2992
2993 if (!PyArg_ParseTuple(args, "O", &cb))
2994 return NULL;
2995
2996 Py_CLEAR(self->set_hostname);
2997 if (cb == Py_None) {
2998 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
2999 }
3000 else {
3001 if (!PyCallable_Check(cb)) {
3002 SSL_CTX_set_tlsext_servername_callback(self->ctx, NULL);
3003 PyErr_SetString(PyExc_TypeError,
3004 "not a callable object");
3005 return NULL;
3006 }
3007 Py_INCREF(cb);
3008 self->set_hostname = cb;
3009 SSL_CTX_set_tlsext_servername_callback(self->ctx, _servername_callback);
3010 SSL_CTX_set_tlsext_servername_arg(self->ctx, self);
3011 }
3012 Py_RETURN_NONE;
3013#else
3014 PyErr_SetString(PyExc_NotImplementedError,
3015 "The TLS extension servername callback, "
3016 "SSL_CTX_set_tlsext_servername_callback, "
3017 "is not in the current OpenSSL library.");
Antoine Pitrou41f8c4f2013-03-30 16:36:54 +01003018 return NULL;
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003019#endif
3020}
3021
Christian Heimes9a5395a2013-06-17 15:44:12 +02003022PyDoc_STRVAR(PySSL_get_stats_doc,
3023"cert_store_stats() -> {'crl': int, 'x509_ca': int, 'x509': int}\n\
3024\n\
3025Returns quantities of loaded X.509 certificates. X.509 certificates with a\n\
3026CA extension and certificate revocation lists inside the context's cert\n\
3027store.\n\
3028NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3029been used at least once.");
3030
3031static PyObject *
3032cert_store_stats(PySSLContext *self)
3033{
3034 X509_STORE *store;
3035 X509_OBJECT *obj;
3036 int x509 = 0, crl = 0, pkey = 0, ca = 0, i;
3037
3038 store = SSL_CTX_get_cert_store(self->ctx);
3039 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3040 obj = sk_X509_OBJECT_value(store->objs, i);
3041 switch (obj->type) {
3042 case X509_LU_X509:
3043 x509++;
3044 if (X509_check_ca(obj->data.x509)) {
3045 ca++;
3046 }
3047 break;
3048 case X509_LU_CRL:
3049 crl++;
3050 break;
3051 case X509_LU_PKEY:
3052 pkey++;
3053 break;
3054 default:
3055 /* Ignore X509_LU_FAIL, X509_LU_RETRY, X509_LU_PKEY.
3056 * As far as I can tell they are internal states and never
3057 * stored in a cert store */
3058 break;
3059 }
3060 }
3061 return Py_BuildValue("{sisisi}", "x509", x509, "crl", crl,
3062 "x509_ca", ca);
3063}
3064
3065PyDoc_STRVAR(PySSL_get_ca_certs_doc,
Christian Heimesf22e8e52013-11-22 02:22:51 +01003066"get_ca_certs(binary_form=False) -> list of loaded certificate\n\
Christian Heimes9a5395a2013-06-17 15:44:12 +02003067\n\
3068Returns a list of dicts with information of loaded CA certs. If the\n\
3069optional argument is True, returns a DER-encoded copy of the CA certificate.\n\
3070NOTE: Certificates in a capath directory aren't loaded unless they have\n\
3071been used at least once.");
3072
3073static PyObject *
Christian Heimesf22e8e52013-11-22 02:22:51 +01003074get_ca_certs(PySSLContext *self, PyObject *args, PyObject *kwds)
Christian Heimes9a5395a2013-06-17 15:44:12 +02003075{
Christian Heimesf22e8e52013-11-22 02:22:51 +01003076 char *kwlist[] = {"binary_form", NULL};
Christian Heimes9a5395a2013-06-17 15:44:12 +02003077 X509_STORE *store;
3078 PyObject *ci = NULL, *rlist = NULL;
3079 int i;
3080 int binary_mode = 0;
3081
Christian Heimesf22e8e52013-11-22 02:22:51 +01003082 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|p:get_ca_certs",
3083 kwlist, &binary_mode)) {
Christian Heimes9a5395a2013-06-17 15:44:12 +02003084 return NULL;
3085 }
3086
3087 if ((rlist = PyList_New(0)) == NULL) {
3088 return NULL;
3089 }
3090
3091 store = SSL_CTX_get_cert_store(self->ctx);
3092 for (i = 0; i < sk_X509_OBJECT_num(store->objs); i++) {
3093 X509_OBJECT *obj;
3094 X509 *cert;
3095
3096 obj = sk_X509_OBJECT_value(store->objs, i);
3097 if (obj->type != X509_LU_X509) {
3098 /* not a x509 cert */
3099 continue;
3100 }
3101 /* CA for any purpose */
3102 cert = obj->data.x509;
3103 if (!X509_check_ca(cert)) {
3104 continue;
3105 }
3106 if (binary_mode) {
3107 ci = _certificate_to_der(cert);
3108 } else {
3109 ci = _decode_certificate(cert);
3110 }
3111 if (ci == NULL) {
3112 goto error;
3113 }
3114 if (PyList_Append(rlist, ci) == -1) {
3115 goto error;
3116 }
3117 Py_CLEAR(ci);
3118 }
3119 return rlist;
3120
3121 error:
3122 Py_XDECREF(ci);
3123 Py_XDECREF(rlist);
3124 return NULL;
3125}
3126
3127
Antoine Pitrou152efa22010-05-16 18:19:27 +00003128static PyGetSetDef context_getsetlist[] = {
Christian Heimes1aa9a752013-12-02 02:41:19 +01003129 {"check_hostname", (getter) get_check_hostname,
3130 (setter) set_check_hostname, NULL},
Antoine Pitroub5218772010-05-21 09:56:06 +00003131 {"options", (getter) get_options,
3132 (setter) set_options, NULL},
Christian Heimes2427b502013-11-23 11:24:32 +01003133#ifdef HAVE_OPENSSL_VERIFY_PARAM
Christian Heimes22587792013-11-21 23:56:13 +01003134 {"verify_flags", (getter) get_verify_flags,
3135 (setter) set_verify_flags, NULL},
Christian Heimes2427b502013-11-23 11:24:32 +01003136#endif
Antoine Pitrou152efa22010-05-16 18:19:27 +00003137 {"verify_mode", (getter) get_verify_mode,
3138 (setter) set_verify_mode, NULL},
3139 {NULL}, /* sentinel */
3140};
3141
3142static struct PyMethodDef context_methods[] = {
3143 {"_wrap_socket", (PyCFunction) context_wrap_socket,
3144 METH_VARARGS | METH_KEYWORDS, NULL},
3145 {"set_ciphers", (PyCFunction) set_ciphers,
3146 METH_VARARGS, NULL},
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01003147 {"_set_npn_protocols", (PyCFunction) _set_npn_protocols,
3148 METH_VARARGS, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003149 {"load_cert_chain", (PyCFunction) load_cert_chain,
3150 METH_VARARGS | METH_KEYWORDS, NULL},
Antoine Pitrou0e576f12011-12-22 10:03:38 +01003151 {"load_dh_params", (PyCFunction) load_dh_params,
3152 METH_O, NULL},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003153 {"load_verify_locations", (PyCFunction) load_verify_locations,
3154 METH_VARARGS | METH_KEYWORDS, NULL},
Antoine Pitroub0182c82010-10-12 20:09:02 +00003155 {"session_stats", (PyCFunction) session_stats,
3156 METH_NOARGS, NULL},
Antoine Pitrou664c2d12010-11-17 20:29:42 +00003157 {"set_default_verify_paths", (PyCFunction) set_default_verify_paths,
3158 METH_NOARGS, NULL},
Antoine Pitrou501da612011-12-21 09:27:41 +01003159#ifndef OPENSSL_NO_ECDH
Antoine Pitrou923df6f2011-12-19 17:16:51 +01003160 {"set_ecdh_curve", (PyCFunction) set_ecdh_curve,
3161 METH_O, NULL},
Antoine Pitrou501da612011-12-21 09:27:41 +01003162#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003163 {"set_servername_callback", (PyCFunction) set_servername_callback,
3164 METH_VARARGS, PySSL_set_servername_callback_doc},
Christian Heimes9a5395a2013-06-17 15:44:12 +02003165 {"cert_store_stats", (PyCFunction) cert_store_stats,
3166 METH_NOARGS, PySSL_get_stats_doc},
3167 {"get_ca_certs", (PyCFunction) get_ca_certs,
Christian Heimesf22e8e52013-11-22 02:22:51 +01003168 METH_VARARGS | METH_KEYWORDS, PySSL_get_ca_certs_doc},
Antoine Pitrou152efa22010-05-16 18:19:27 +00003169 {NULL, NULL} /* sentinel */
3170};
3171
3172static PyTypeObject PySSLContext_Type = {
3173 PyVarObject_HEAD_INIT(NULL, 0)
3174 "_ssl._SSLContext", /*tp_name*/
3175 sizeof(PySSLContext), /*tp_basicsize*/
3176 0, /*tp_itemsize*/
3177 (destructor)context_dealloc, /*tp_dealloc*/
3178 0, /*tp_print*/
3179 0, /*tp_getattr*/
3180 0, /*tp_setattr*/
3181 0, /*tp_reserved*/
3182 0, /*tp_repr*/
3183 0, /*tp_as_number*/
3184 0, /*tp_as_sequence*/
3185 0, /*tp_as_mapping*/
3186 0, /*tp_hash*/
3187 0, /*tp_call*/
3188 0, /*tp_str*/
3189 0, /*tp_getattro*/
3190 0, /*tp_setattro*/
3191 0, /*tp_as_buffer*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003192 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003193 0, /*tp_doc*/
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003194 (traverseproc) context_traverse, /*tp_traverse*/
3195 (inquiry) context_clear, /*tp_clear*/
Antoine Pitrou152efa22010-05-16 18:19:27 +00003196 0, /*tp_richcompare*/
3197 0, /*tp_weaklistoffset*/
3198 0, /*tp_iter*/
3199 0, /*tp_iternext*/
3200 context_methods, /*tp_methods*/
3201 0, /*tp_members*/
3202 context_getsetlist, /*tp_getset*/
3203 0, /*tp_base*/
3204 0, /*tp_dict*/
3205 0, /*tp_descr_get*/
3206 0, /*tp_descr_set*/
3207 0, /*tp_dictoffset*/
3208 0, /*tp_init*/
3209 0, /*tp_alloc*/
3210 context_new, /*tp_new*/
3211};
3212
3213
3214
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003215#ifdef HAVE_OPENSSL_RAND
3216
3217/* helper routines for seeding the SSL PRNG */
3218static PyObject *
3219PySSL_RAND_add(PyObject *self, PyObject *args)
3220{
3221 char *buf;
3222 int len;
3223 double entropy;
3224
3225 if (!PyArg_ParseTuple(args, "s#d:RAND_add", &buf, &len, &entropy))
Antoine Pitrou525807b2010-05-12 14:05:24 +00003226 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003227 RAND_add(buf, len, entropy);
3228 Py_INCREF(Py_None);
3229 return Py_None;
3230}
3231
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003232PyDoc_STRVAR(PySSL_RAND_add_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003233"RAND_add(string, entropy)\n\
3234\n\
3235Mix string into the OpenSSL PRNG state. entropy (a float) is a lower\n\
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003236bound on the entropy contained in string. See RFC 1750.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003237
3238static PyObject *
Victor Stinner99c8b162011-05-24 12:05:19 +02003239PySSL_RAND(int len, int pseudo)
3240{
3241 int ok;
3242 PyObject *bytes;
3243 unsigned long err;
3244 const char *errstr;
3245 PyObject *v;
3246
Victor Stinner1e81a392013-12-19 16:47:04 +01003247 if (len < 0) {
3248 PyErr_SetString(PyExc_ValueError, "num must be positive");
3249 return NULL;
3250 }
3251
Victor Stinner99c8b162011-05-24 12:05:19 +02003252 bytes = PyBytes_FromStringAndSize(NULL, len);
3253 if (bytes == NULL)
3254 return NULL;
3255 if (pseudo) {
3256 ok = RAND_pseudo_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3257 if (ok == 0 || ok == 1)
3258 return Py_BuildValue("NO", bytes, ok == 1 ? Py_True : Py_False);
3259 }
3260 else {
3261 ok = RAND_bytes((unsigned char*)PyBytes_AS_STRING(bytes), len);
3262 if (ok == 1)
3263 return bytes;
3264 }
3265 Py_DECREF(bytes);
3266
3267 err = ERR_get_error();
3268 errstr = ERR_reason_error_string(err);
3269 v = Py_BuildValue("(ks)", err, errstr);
3270 if (v != NULL) {
3271 PyErr_SetObject(PySSLErrorObject, v);
3272 Py_DECREF(v);
3273 }
3274 return NULL;
3275}
3276
3277static PyObject *
3278PySSL_RAND_bytes(PyObject *self, PyObject *args)
3279{
3280 int len;
3281 if (!PyArg_ParseTuple(args, "i:RAND_bytes", &len))
3282 return NULL;
3283 return PySSL_RAND(len, 0);
3284}
3285
3286PyDoc_STRVAR(PySSL_RAND_bytes_doc,
3287"RAND_bytes(n) -> bytes\n\
3288\n\
3289Generate n cryptographically strong pseudo-random bytes.");
3290
3291static PyObject *
3292PySSL_RAND_pseudo_bytes(PyObject *self, PyObject *args)
3293{
3294 int len;
3295 if (!PyArg_ParseTuple(args, "i:RAND_pseudo_bytes", &len))
3296 return NULL;
3297 return PySSL_RAND(len, 1);
3298}
3299
3300PyDoc_STRVAR(PySSL_RAND_pseudo_bytes_doc,
3301"RAND_pseudo_bytes(n) -> (bytes, is_cryptographic)\n\
3302\n\
3303Generate n pseudo-random bytes. is_cryptographic is True if the bytes\
3304generated are cryptographically strong.");
3305
3306static PyObject *
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003307PySSL_RAND_status(PyObject *self)
3308{
Christian Heimes217cfd12007-12-02 14:31:20 +00003309 return PyLong_FromLong(RAND_status());
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003310}
3311
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003312PyDoc_STRVAR(PySSL_RAND_status_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003313"RAND_status() -> 0 or 1\n\
3314\n\
Bill Janssen6e027db2007-11-15 22:23:56 +00003315Returns 1 if the OpenSSL PRNG has been seeded with enough data and 0 if not.\n\
3316It is necessary to seed the PRNG with RAND_add() on some platforms before\n\
3317using the ssl() function.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003318
3319static PyObject *
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003320PySSL_RAND_egd(PyObject *self, PyObject *args)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003321{
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003322 PyObject *path;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003323 int bytes;
3324
Jesus Ceac8754a12012-09-11 02:00:58 +02003325 if (!PyArg_ParseTuple(args, "O&:RAND_egd",
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003326 PyUnicode_FSConverter, &path))
3327 return NULL;
3328
3329 bytes = RAND_egd(PyBytes_AsString(path));
3330 Py_DECREF(path);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003331 if (bytes == -1) {
Antoine Pitrou525807b2010-05-12 14:05:24 +00003332 PyErr_SetString(PySSLErrorObject,
3333 "EGD connection failed or EGD did not return "
3334 "enough data to seed the PRNG");
3335 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003336 }
Christian Heimes217cfd12007-12-02 14:31:20 +00003337 return PyLong_FromLong(bytes);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003338}
3339
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003340PyDoc_STRVAR(PySSL_RAND_egd_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003341"RAND_egd(path) -> bytes\n\
3342\n\
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003343Queries the entropy gather daemon (EGD) on the socket named by 'path'.\n\
3344Returns number of bytes read. Raises SSLError if connection to EGD\n\
Christian Heimes3c2593b2013-08-17 17:25:18 +02003345fails or if it does not provide enough data to seed PRNG.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003346
Christian Heimesf77b4b22013-08-21 13:26:05 +02003347#endif /* HAVE_OPENSSL_RAND */
3348
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003349
Christian Heimes6d7ad132013-06-09 18:02:55 +02003350PyDoc_STRVAR(PySSL_get_default_verify_paths_doc,
3351"get_default_verify_paths() -> tuple\n\
3352\n\
3353Return search paths and environment vars that are used by SSLContext's\n\
3354set_default_verify_paths() to load default CAs. The values are\n\
3355'cert_file_env', 'cert_file', 'cert_dir_env', 'cert_dir'.");
3356
3357static PyObject *
Christian Heimes200bb1b2013-06-14 15:14:29 +02003358PySSL_get_default_verify_paths(PyObject *self)
Christian Heimes6d7ad132013-06-09 18:02:55 +02003359{
3360 PyObject *ofile_env = NULL;
3361 PyObject *ofile = NULL;
3362 PyObject *odir_env = NULL;
3363 PyObject *odir = NULL;
3364
3365#define convert(info, target) { \
3366 const char *tmp = (info); \
3367 target = NULL; \
3368 if (!tmp) { Py_INCREF(Py_None); target = Py_None; } \
3369 else if ((target = PyUnicode_DecodeFSDefault(tmp)) == NULL) { \
3370 target = PyBytes_FromString(tmp); } \
3371 if (!target) goto error; \
3372 } while(0)
3373
3374 convert(X509_get_default_cert_file_env(), ofile_env);
3375 convert(X509_get_default_cert_file(), ofile);
3376 convert(X509_get_default_cert_dir_env(), odir_env);
3377 convert(X509_get_default_cert_dir(), odir);
3378#undef convert
3379
Christian Heimes200bb1b2013-06-14 15:14:29 +02003380 return Py_BuildValue("NNNN", ofile_env, ofile, odir_env, odir);
Christian Heimes6d7ad132013-06-09 18:02:55 +02003381
3382 error:
3383 Py_XDECREF(ofile_env);
3384 Py_XDECREF(ofile);
3385 Py_XDECREF(odir_env);
3386 Py_XDECREF(odir);
3387 return NULL;
3388}
3389
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003390static PyObject*
3391asn1obj2py(ASN1_OBJECT *obj)
3392{
3393 int nid;
3394 const char *ln, *sn;
3395 char buf[100];
3396 int buflen;
3397
3398 nid = OBJ_obj2nid(obj);
3399 if (nid == NID_undef) {
3400 PyErr_Format(PyExc_ValueError, "Unknown object");
3401 return NULL;
3402 }
3403 sn = OBJ_nid2sn(nid);
3404 ln = OBJ_nid2ln(nid);
3405 buflen = OBJ_obj2txt(buf, sizeof(buf), obj, 1);
3406 if (buflen < 0) {
3407 _setSSLError(NULL, 0, __FILE__, __LINE__);
3408 return NULL;
3409 }
3410 if (buflen) {
3411 return Py_BuildValue("isss#", nid, sn, ln, buf, buflen);
3412 } else {
3413 return Py_BuildValue("issO", nid, sn, ln, Py_None);
3414 }
3415}
3416
3417PyDoc_STRVAR(PySSL_txt2obj_doc,
3418"txt2obj(txt, name=False) -> (nid, shortname, longname, oid)\n\
3419\n\
3420Lookup NID, short name, long name and OID of an ASN1_OBJECT. By default\n\
3421objects are looked up by OID. With name=True short and long name are also\n\
3422matched.");
3423
3424static PyObject*
3425PySSL_txt2obj(PyObject *self, PyObject *args, PyObject *kwds)
3426{
3427 char *kwlist[] = {"txt", "name", NULL};
3428 PyObject *result = NULL;
3429 char *txt;
3430 int name = 0;
3431 ASN1_OBJECT *obj;
3432
3433 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s|p:txt2obj",
3434 kwlist, &txt, &name)) {
3435 return NULL;
3436 }
3437 obj = OBJ_txt2obj(txt, name ? 0 : 1);
3438 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003439 PyErr_Format(PyExc_ValueError, "unknown object '%.100s'", txt);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003440 return NULL;
3441 }
3442 result = asn1obj2py(obj);
3443 ASN1_OBJECT_free(obj);
3444 return result;
3445}
3446
3447PyDoc_STRVAR(PySSL_nid2obj_doc,
3448"nid2obj(nid) -> (nid, shortname, longname, oid)\n\
3449\n\
3450Lookup NID, short name, long name and OID of an ASN1_OBJECT by NID.");
3451
3452static PyObject*
3453PySSL_nid2obj(PyObject *self, PyObject *args)
3454{
3455 PyObject *result = NULL;
3456 int nid;
3457 ASN1_OBJECT *obj;
3458
3459 if (!PyArg_ParseTuple(args, "i:nid2obj", &nid)) {
3460 return NULL;
3461 }
3462 if (nid < NID_undef) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003463 PyErr_SetString(PyExc_ValueError, "NID must be positive.");
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003464 return NULL;
3465 }
3466 obj = OBJ_nid2obj(nid);
3467 if (obj == NULL) {
Christian Heimes5398e1a2013-11-22 16:20:53 +01003468 PyErr_Format(PyExc_ValueError, "unknown NID %i", nid);
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003469 return NULL;
3470 }
3471 result = asn1obj2py(obj);
3472 ASN1_OBJECT_free(obj);
3473 return result;
3474}
3475
Christian Heimes46bebee2013-06-09 19:03:31 +02003476#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01003477
3478static PyObject*
3479certEncodingType(DWORD encodingType)
3480{
3481 static PyObject *x509_asn = NULL;
3482 static PyObject *pkcs_7_asn = NULL;
3483
3484 if (x509_asn == NULL) {
3485 x509_asn = PyUnicode_InternFromString("x509_asn");
3486 if (x509_asn == NULL)
3487 return NULL;
3488 }
3489 if (pkcs_7_asn == NULL) {
3490 pkcs_7_asn = PyUnicode_InternFromString("pkcs_7_asn");
3491 if (pkcs_7_asn == NULL)
3492 return NULL;
3493 }
3494 switch(encodingType) {
3495 case X509_ASN_ENCODING:
3496 Py_INCREF(x509_asn);
3497 return x509_asn;
3498 case PKCS_7_ASN_ENCODING:
3499 Py_INCREF(pkcs_7_asn);
3500 return pkcs_7_asn;
3501 default:
3502 return PyLong_FromLong(encodingType);
3503 }
3504}
3505
3506static PyObject*
3507parseKeyUsage(PCCERT_CONTEXT pCertCtx, DWORD flags)
3508{
3509 CERT_ENHKEY_USAGE *usage;
3510 DWORD size, error, i;
3511 PyObject *retval;
3512
3513 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, NULL, &size)) {
3514 error = GetLastError();
3515 if (error == CRYPT_E_NOT_FOUND) {
3516 Py_RETURN_TRUE;
3517 }
3518 return PyErr_SetFromWindowsErr(error);
3519 }
3520
3521 usage = (CERT_ENHKEY_USAGE*)PyMem_Malloc(size);
3522 if (usage == NULL) {
3523 return PyErr_NoMemory();
3524 }
3525
3526 /* Now get the actual enhanced usage property */
3527 if (!CertGetEnhancedKeyUsage(pCertCtx, flags, usage, &size)) {
3528 PyMem_Free(usage);
3529 error = GetLastError();
3530 if (error == CRYPT_E_NOT_FOUND) {
3531 Py_RETURN_TRUE;
3532 }
3533 return PyErr_SetFromWindowsErr(error);
3534 }
3535 retval = PySet_New(NULL);
3536 if (retval == NULL) {
3537 goto error;
3538 }
3539 for (i = 0; i < usage->cUsageIdentifier; ++i) {
3540 if (usage->rgpszUsageIdentifier[i]) {
3541 PyObject *oid;
3542 int err;
3543 oid = PyUnicode_FromString(usage->rgpszUsageIdentifier[i]);
3544 if (oid == NULL) {
3545 Py_CLEAR(retval);
3546 goto error;
3547 }
3548 err = PySet_Add(retval, oid);
3549 Py_DECREF(oid);
3550 if (err == -1) {
3551 Py_CLEAR(retval);
3552 goto error;
3553 }
3554 }
3555 }
3556 error:
3557 PyMem_Free(usage);
3558 return retval;
3559}
3560
3561PyDoc_STRVAR(PySSL_enum_certificates_doc,
3562"enum_certificates(store_name) -> []\n\
Christian Heimes46bebee2013-06-09 19:03:31 +02003563\n\
3564Retrieve certificates from Windows' cert store. store_name may be one of\n\
3565'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
Christian Heimes44109d72013-11-22 01:51:30 +01003566The function returns a list of (bytes, encoding_type, trust) tuples. The\n\
Christian Heimes46bebee2013-06-09 19:03:31 +02003567encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
Christian Heimes44109d72013-11-22 01:51:30 +01003568PKCS_7_ASN_ENCODING. The trust setting is either a set of OIDs or the\n\
3569boolean True.");
Bill Janssen40a0f662008-08-12 16:56:25 +00003570
Christian Heimes46bebee2013-06-09 19:03:31 +02003571static PyObject *
Christian Heimes44109d72013-11-22 01:51:30 +01003572PySSL_enum_certificates(PyObject *self, PyObject *args, PyObject *kwds)
Christian Heimes46bebee2013-06-09 19:03:31 +02003573{
Christian Heimes44109d72013-11-22 01:51:30 +01003574 char *kwlist[] = {"store_name", NULL};
Christian Heimes46bebee2013-06-09 19:03:31 +02003575 char *store_name;
Christian Heimes46bebee2013-06-09 19:03:31 +02003576 HCERTSTORE hStore = NULL;
Christian Heimes44109d72013-11-22 01:51:30 +01003577 PCCERT_CONTEXT pCertCtx = NULL;
3578 PyObject *keyusage = NULL, *cert = NULL, *enc = NULL, *tup = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02003579 PyObject *result = NULL;
Christian Heimes46bebee2013-06-09 19:03:31 +02003580
Christian Heimes44109d72013-11-22 01:51:30 +01003581 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s|s:enum_certificates",
3582 kwlist, &store_name)) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003583 return NULL;
3584 }
Christian Heimes44109d72013-11-22 01:51:30 +01003585 result = PyList_New(0);
3586 if (result == NULL) {
3587 return NULL;
3588 }
3589 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3590 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003591 Py_DECREF(result);
3592 return PyErr_SetFromWindowsErr(GetLastError());
3593 }
3594
Christian Heimes44109d72013-11-22 01:51:30 +01003595 while (pCertCtx = CertEnumCertificatesInStore(hStore, pCertCtx)) {
3596 cert = PyBytes_FromStringAndSize((const char*)pCertCtx->pbCertEncoded,
3597 pCertCtx->cbCertEncoded);
3598 if (!cert) {
3599 Py_CLEAR(result);
3600 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003601 }
Christian Heimes44109d72013-11-22 01:51:30 +01003602 if ((enc = certEncodingType(pCertCtx->dwCertEncodingType)) == NULL) {
3603 Py_CLEAR(result);
3604 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003605 }
Christian Heimes44109d72013-11-22 01:51:30 +01003606 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG);
3607 if (keyusage == Py_True) {
3608 Py_DECREF(keyusage);
3609 keyusage = parseKeyUsage(pCertCtx, CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG);
Christian Heimes46bebee2013-06-09 19:03:31 +02003610 }
Christian Heimes44109d72013-11-22 01:51:30 +01003611 if (keyusage == NULL) {
3612 Py_CLEAR(result);
3613 break;
Christian Heimes46bebee2013-06-09 19:03:31 +02003614 }
Christian Heimes44109d72013-11-22 01:51:30 +01003615 if ((tup = PyTuple_New(3)) == NULL) {
3616 Py_CLEAR(result);
3617 break;
3618 }
3619 PyTuple_SET_ITEM(tup, 0, cert);
3620 cert = NULL;
3621 PyTuple_SET_ITEM(tup, 1, enc);
3622 enc = NULL;
3623 PyTuple_SET_ITEM(tup, 2, keyusage);
3624 keyusage = NULL;
3625 if (PyList_Append(result, tup) < 0) {
3626 Py_CLEAR(result);
3627 break;
3628 }
3629 Py_CLEAR(tup);
3630 }
3631 if (pCertCtx) {
3632 /* loop ended with an error, need to clean up context manually */
3633 CertFreeCertificateContext(pCertCtx);
Christian Heimes46bebee2013-06-09 19:03:31 +02003634 }
3635
3636 /* In error cases cert, enc and tup may not be NULL */
3637 Py_XDECREF(cert);
3638 Py_XDECREF(enc);
Christian Heimes44109d72013-11-22 01:51:30 +01003639 Py_XDECREF(keyusage);
Christian Heimes46bebee2013-06-09 19:03:31 +02003640 Py_XDECREF(tup);
3641
3642 if (!CertCloseStore(hStore, 0)) {
3643 /* This error case might shadow another exception.*/
Christian Heimes44109d72013-11-22 01:51:30 +01003644 Py_XDECREF(result);
3645 return PyErr_SetFromWindowsErr(GetLastError());
3646 }
3647 return result;
3648}
3649
3650PyDoc_STRVAR(PySSL_enum_crls_doc,
3651"enum_crls(store_name) -> []\n\
3652\n\
3653Retrieve CRLs from Windows' cert store. store_name may be one of\n\
3654'CA', 'ROOT' or 'MY'. The system may provide more cert storages, too.\n\
3655The function returns a list of (bytes, encoding_type) tuples. The\n\
3656encoding_type flag can be interpreted with X509_ASN_ENCODING or\n\
3657PKCS_7_ASN_ENCODING.");
3658
3659static PyObject *
3660PySSL_enum_crls(PyObject *self, PyObject *args, PyObject *kwds)
3661{
3662 char *kwlist[] = {"store_name", NULL};
3663 char *store_name;
3664 HCERTSTORE hStore = NULL;
3665 PCCRL_CONTEXT pCrlCtx = NULL;
3666 PyObject *crl = NULL, *enc = NULL, *tup = NULL;
3667 PyObject *result = NULL;
3668
3669 if (!PyArg_ParseTupleAndKeywords(args, kwds, "s|s:enum_crls",
3670 kwlist, &store_name)) {
3671 return NULL;
3672 }
3673 result = PyList_New(0);
3674 if (result == NULL) {
3675 return NULL;
3676 }
3677 hStore = CertOpenSystemStore((HCRYPTPROV)NULL, store_name);
3678 if (hStore == NULL) {
Christian Heimes46bebee2013-06-09 19:03:31 +02003679 Py_DECREF(result);
3680 return PyErr_SetFromWindowsErr(GetLastError());
3681 }
Christian Heimes44109d72013-11-22 01:51:30 +01003682
3683 while (pCrlCtx = CertEnumCRLsInStore(hStore, pCrlCtx)) {
3684 crl = PyBytes_FromStringAndSize((const char*)pCrlCtx->pbCrlEncoded,
3685 pCrlCtx->cbCrlEncoded);
3686 if (!crl) {
3687 Py_CLEAR(result);
3688 break;
3689 }
3690 if ((enc = certEncodingType(pCrlCtx->dwCertEncodingType)) == NULL) {
3691 Py_CLEAR(result);
3692 break;
3693 }
3694 if ((tup = PyTuple_New(2)) == NULL) {
3695 Py_CLEAR(result);
3696 break;
3697 }
3698 PyTuple_SET_ITEM(tup, 0, crl);
3699 crl = NULL;
3700 PyTuple_SET_ITEM(tup, 1, enc);
3701 enc = NULL;
3702
3703 if (PyList_Append(result, tup) < 0) {
3704 Py_CLEAR(result);
3705 break;
3706 }
3707 Py_CLEAR(tup);
Christian Heimes46bebee2013-06-09 19:03:31 +02003708 }
Christian Heimes44109d72013-11-22 01:51:30 +01003709 if (pCrlCtx) {
3710 /* loop ended with an error, need to clean up context manually */
3711 CertFreeCRLContext(pCrlCtx);
3712 }
3713
3714 /* In error cases cert, enc and tup may not be NULL */
3715 Py_XDECREF(crl);
3716 Py_XDECREF(enc);
3717 Py_XDECREF(tup);
3718
3719 if (!CertCloseStore(hStore, 0)) {
3720 /* This error case might shadow another exception.*/
3721 Py_XDECREF(result);
3722 return PyErr_SetFromWindowsErr(GetLastError());
3723 }
3724 return result;
Christian Heimes46bebee2013-06-09 19:03:31 +02003725}
Christian Heimes44109d72013-11-22 01:51:30 +01003726
3727#endif /* _MSC_VER */
Bill Janssen40a0f662008-08-12 16:56:25 +00003728
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003729/* List of functions exported by this module. */
3730
3731static PyMethodDef PySSL_methods[] = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003732 {"_test_decode_cert", PySSL_test_decode_certificate,
3733 METH_VARARGS},
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003734#ifdef HAVE_OPENSSL_RAND
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003735 {"RAND_add", PySSL_RAND_add, METH_VARARGS,
3736 PySSL_RAND_add_doc},
Victor Stinner99c8b162011-05-24 12:05:19 +02003737 {"RAND_bytes", PySSL_RAND_bytes, METH_VARARGS,
3738 PySSL_RAND_bytes_doc},
3739 {"RAND_pseudo_bytes", PySSL_RAND_pseudo_bytes, METH_VARARGS,
3740 PySSL_RAND_pseudo_bytes_doc},
Victor Stinnerf9faaad2010-05-16 21:36:37 +00003741 {"RAND_egd", PySSL_RAND_egd, METH_VARARGS,
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003742 PySSL_RAND_egd_doc},
3743 {"RAND_status", (PyCFunction)PySSL_RAND_status, METH_NOARGS,
3744 PySSL_RAND_status_doc},
Christian Heimes142ec2c2013-06-09 18:29:54 +02003745#endif
Christian Heimes200bb1b2013-06-14 15:14:29 +02003746 {"get_default_verify_paths", (PyCFunction)PySSL_get_default_verify_paths,
Christian Heimes6d7ad132013-06-09 18:02:55 +02003747 METH_NOARGS, PySSL_get_default_verify_paths_doc},
Christian Heimes46bebee2013-06-09 19:03:31 +02003748#ifdef _MSC_VER
Christian Heimes44109d72013-11-22 01:51:30 +01003749 {"enum_certificates", (PyCFunction)PySSL_enum_certificates,
3750 METH_VARARGS | METH_KEYWORDS, PySSL_enum_certificates_doc},
3751 {"enum_crls", (PyCFunction)PySSL_enum_crls,
3752 METH_VARARGS | METH_KEYWORDS, PySSL_enum_crls_doc},
Christian Heimes46bebee2013-06-09 19:03:31 +02003753#endif
Christian Heimesa6bc95a2013-11-17 19:59:14 +01003754 {"txt2obj", (PyCFunction)PySSL_txt2obj,
3755 METH_VARARGS | METH_KEYWORDS, PySSL_txt2obj_doc},
3756 {"nid2obj", (PyCFunction)PySSL_nid2obj,
3757 METH_VARARGS, PySSL_nid2obj_doc},
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003758 {NULL, NULL} /* Sentinel */
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003759};
3760
3761
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003762#ifdef WITH_THREAD
3763
3764/* an implementation of OpenSSL threading operations in terms
3765 of the Python C thread library */
3766
3767static PyThread_type_lock *_ssl_locks = NULL;
3768
Christian Heimes4d98ca92013-08-19 17:36:29 +02003769#if OPENSSL_VERSION_NUMBER >= 0x10000000
3770/* use new CRYPTO_THREADID API. */
3771static void
3772_ssl_threadid_callback(CRYPTO_THREADID *id)
3773{
3774 CRYPTO_THREADID_set_numeric(id,
3775 (unsigned long)PyThread_get_thread_ident());
3776}
3777#else
3778/* deprecated CRYPTO_set_id_callback() API. */
3779static unsigned long
3780_ssl_thread_id_function (void) {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003781 return PyThread_get_thread_ident();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003782}
Christian Heimes4d98ca92013-08-19 17:36:29 +02003783#endif
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003784
Bill Janssen6e027db2007-11-15 22:23:56 +00003785static void _ssl_thread_locking_function
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003786 (int mode, int n, const char *file, int line) {
3787 /* this function is needed to perform locking on shared data
3788 structures. (Note that OpenSSL uses a number of global data
3789 structures that will be implicitly shared whenever multiple
3790 threads use OpenSSL.) Multi-threaded applications will
3791 crash at random if it is not set.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003792
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003793 locking_function() must be able to handle up to
3794 CRYPTO_num_locks() different mutex locks. It sets the n-th
3795 lock if mode & CRYPTO_LOCK, and releases it otherwise.
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003796
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003797 file and line are the file number of the function setting the
3798 lock. They can be useful for debugging.
3799 */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003800
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003801 if ((_ssl_locks == NULL) ||
3802 (n < 0) || ((unsigned)n >= _ssl_locks_count))
3803 return;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003804
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003805 if (mode & CRYPTO_LOCK) {
3806 PyThread_acquire_lock(_ssl_locks[n], 1);
3807 } else {
3808 PyThread_release_lock(_ssl_locks[n]);
3809 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003810}
3811
3812static int _setup_ssl_threads(void) {
3813
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003814 unsigned int i;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003815
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003816 if (_ssl_locks == NULL) {
3817 _ssl_locks_count = CRYPTO_num_locks();
3818 _ssl_locks = (PyThread_type_lock *)
Victor Stinnerb6404912013-07-07 16:21:41 +02003819 PyMem_Malloc(sizeof(PyThread_type_lock) * _ssl_locks_count);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003820 if (_ssl_locks == NULL)
3821 return 0;
3822 memset(_ssl_locks, 0,
3823 sizeof(PyThread_type_lock) * _ssl_locks_count);
3824 for (i = 0; i < _ssl_locks_count; i++) {
3825 _ssl_locks[i] = PyThread_allocate_lock();
3826 if (_ssl_locks[i] == NULL) {
3827 unsigned int j;
3828 for (j = 0; j < i; j++) {
3829 PyThread_free_lock(_ssl_locks[j]);
3830 }
Victor Stinnerb6404912013-07-07 16:21:41 +02003831 PyMem_Free(_ssl_locks);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003832 return 0;
3833 }
3834 }
3835 CRYPTO_set_locking_callback(_ssl_thread_locking_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02003836#if OPENSSL_VERSION_NUMBER >= 0x10000000
3837 CRYPTO_THREADID_set_callback(_ssl_threadid_callback);
3838#else
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003839 CRYPTO_set_id_callback(_ssl_thread_id_function);
Christian Heimes4d98ca92013-08-19 17:36:29 +02003840#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003841 }
3842 return 1;
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003843}
3844
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003845#endif /* def HAVE_THREAD */
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003846
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003847PyDoc_STRVAR(module_doc,
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003848"Implementation module for SSL socket operations. See the socket module\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00003849for documentation.");
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003850
Martin v. Löwis1a214512008-06-11 05:26:20 +00003851
3852static struct PyModuleDef _sslmodule = {
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003853 PyModuleDef_HEAD_INIT,
3854 "_ssl",
3855 module_doc,
3856 -1,
3857 PySSL_methods,
3858 NULL,
3859 NULL,
3860 NULL,
3861 NULL
Martin v. Löwis1a214512008-06-11 05:26:20 +00003862};
3863
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02003864
3865static void
3866parse_openssl_version(unsigned long libver,
3867 unsigned int *major, unsigned int *minor,
3868 unsigned int *fix, unsigned int *patch,
3869 unsigned int *status)
3870{
3871 *status = libver & 0xF;
3872 libver >>= 4;
3873 *patch = libver & 0xFF;
3874 libver >>= 8;
3875 *fix = libver & 0xFF;
3876 libver >>= 8;
3877 *minor = libver & 0xFF;
3878 libver >>= 8;
3879 *major = libver & 0xFF;
3880}
3881
Mark Hammondfe51c6d2002-08-02 02:27:13 +00003882PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +00003883PyInit__ssl(void)
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003884{
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003885 PyObject *m, *d, *r;
3886 unsigned long libver;
3887 unsigned int major, minor, fix, patch, status;
3888 PySocketModule_APIObject *socket_api;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003889 struct py_ssl_error_code *errcode;
3890 struct py_ssl_library_code *libcode;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003891
Antoine Pitrou152efa22010-05-16 18:19:27 +00003892 if (PyType_Ready(&PySSLContext_Type) < 0)
3893 return NULL;
3894 if (PyType_Ready(&PySSLSocket_Type) < 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003895 return NULL;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003896
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003897 m = PyModule_Create(&_sslmodule);
3898 if (m == NULL)
3899 return NULL;
3900 d = PyModule_GetDict(m);
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003901
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003902 /* Load _socket module and its C API */
3903 socket_api = PySocketModule_ImportModuleAndAPI();
3904 if (!socket_api)
3905 return NULL;
3906 PySocketModule = *socket_api;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003907
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003908 /* Init OpenSSL */
3909 SSL_load_error_strings();
3910 SSL_library_init();
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003911#ifdef WITH_THREAD
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003912 /* note that this will start threading if not already started */
3913 if (!_setup_ssl_threads()) {
3914 return NULL;
3915 }
Thomas Wouters1b7f8912007-09-19 03:06:30 +00003916#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003917 OpenSSL_add_all_algorithms();
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00003918
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003919 /* Add symbols to module dict */
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003920 sslerror_type_slots[0].pfunc = PyExc_OSError;
3921 PySSLErrorObject = PyType_FromSpec(&sslerror_type_spec);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003922 if (PySSLErrorObject == NULL)
3923 return NULL;
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02003924
Antoine Pitrou41032a62011-10-27 23:56:55 +02003925 PySSLZeroReturnErrorObject = PyErr_NewExceptionWithDoc(
3926 "ssl.SSLZeroReturnError", SSLZeroReturnError_doc,
3927 PySSLErrorObject, NULL);
3928 PySSLWantReadErrorObject = PyErr_NewExceptionWithDoc(
3929 "ssl.SSLWantReadError", SSLWantReadError_doc,
3930 PySSLErrorObject, NULL);
3931 PySSLWantWriteErrorObject = PyErr_NewExceptionWithDoc(
3932 "ssl.SSLWantWriteError", SSLWantWriteError_doc,
3933 PySSLErrorObject, NULL);
3934 PySSLSyscallErrorObject = PyErr_NewExceptionWithDoc(
3935 "ssl.SSLSyscallError", SSLSyscallError_doc,
3936 PySSLErrorObject, NULL);
3937 PySSLEOFErrorObject = PyErr_NewExceptionWithDoc(
3938 "ssl.SSLEOFError", SSLEOFError_doc,
3939 PySSLErrorObject, NULL);
3940 if (PySSLZeroReturnErrorObject == NULL
3941 || PySSLWantReadErrorObject == NULL
3942 || PySSLWantWriteErrorObject == NULL
3943 || PySSLSyscallErrorObject == NULL
3944 || PySSLEOFErrorObject == NULL)
3945 return NULL;
3946 if (PyDict_SetItemString(d, "SSLError", PySSLErrorObject) != 0
3947 || PyDict_SetItemString(d, "SSLZeroReturnError", PySSLZeroReturnErrorObject) != 0
3948 || PyDict_SetItemString(d, "SSLWantReadError", PySSLWantReadErrorObject) != 0
3949 || PyDict_SetItemString(d, "SSLWantWriteError", PySSLWantWriteErrorObject) != 0
3950 || PyDict_SetItemString(d, "SSLSyscallError", PySSLSyscallErrorObject) != 0
3951 || PyDict_SetItemString(d, "SSLEOFError", PySSLEOFErrorObject) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003952 return NULL;
Antoine Pitrou152efa22010-05-16 18:19:27 +00003953 if (PyDict_SetItemString(d, "_SSLContext",
3954 (PyObject *)&PySSLContext_Type) != 0)
3955 return NULL;
3956 if (PyDict_SetItemString(d, "_SSLSocket",
3957 (PyObject *)&PySSLSocket_Type) != 0)
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00003958 return NULL;
3959 PyModule_AddIntConstant(m, "SSL_ERROR_ZERO_RETURN",
3960 PY_SSL_ERROR_ZERO_RETURN);
3961 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_READ",
3962 PY_SSL_ERROR_WANT_READ);
3963 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_WRITE",
3964 PY_SSL_ERROR_WANT_WRITE);
3965 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_X509_LOOKUP",
3966 PY_SSL_ERROR_WANT_X509_LOOKUP);
3967 PyModule_AddIntConstant(m, "SSL_ERROR_SYSCALL",
3968 PY_SSL_ERROR_SYSCALL);
3969 PyModule_AddIntConstant(m, "SSL_ERROR_SSL",
3970 PY_SSL_ERROR_SSL);
3971 PyModule_AddIntConstant(m, "SSL_ERROR_WANT_CONNECT",
3972 PY_SSL_ERROR_WANT_CONNECT);
3973 /* non ssl.h errorcodes */
3974 PyModule_AddIntConstant(m, "SSL_ERROR_EOF",
3975 PY_SSL_ERROR_EOF);
3976 PyModule_AddIntConstant(m, "SSL_ERROR_INVALID_ERROR_CODE",
3977 PY_SSL_ERROR_INVALID_ERROR_CODE);
3978 /* cert requirements */
3979 PyModule_AddIntConstant(m, "CERT_NONE",
3980 PY_SSL_CERT_NONE);
3981 PyModule_AddIntConstant(m, "CERT_OPTIONAL",
3982 PY_SSL_CERT_OPTIONAL);
3983 PyModule_AddIntConstant(m, "CERT_REQUIRED",
3984 PY_SSL_CERT_REQUIRED);
Christian Heimes22587792013-11-21 23:56:13 +01003985 /* CRL verification for verification_flags */
3986 PyModule_AddIntConstant(m, "VERIFY_DEFAULT",
3987 0);
3988 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_LEAF",
3989 X509_V_FLAG_CRL_CHECK);
3990 PyModule_AddIntConstant(m, "VERIFY_CRL_CHECK_CHAIN",
3991 X509_V_FLAG_CRL_CHECK|X509_V_FLAG_CRL_CHECK_ALL);
3992 PyModule_AddIntConstant(m, "VERIFY_X509_STRICT",
3993 X509_V_FLAG_X509_STRICT);
Martin v. Löwis6af3e2d2002-04-20 07:47:40 +00003994
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01003995 /* Alert Descriptions from ssl.h */
3996 /* note RESERVED constants no longer intended for use have been removed */
3997 /* http://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6 */
3998
3999#define ADD_AD_CONSTANT(s) \
4000 PyModule_AddIntConstant(m, "ALERT_DESCRIPTION_"#s, \
4001 SSL_AD_##s)
4002
4003 ADD_AD_CONSTANT(CLOSE_NOTIFY);
4004 ADD_AD_CONSTANT(UNEXPECTED_MESSAGE);
4005 ADD_AD_CONSTANT(BAD_RECORD_MAC);
4006 ADD_AD_CONSTANT(RECORD_OVERFLOW);
4007 ADD_AD_CONSTANT(DECOMPRESSION_FAILURE);
4008 ADD_AD_CONSTANT(HANDSHAKE_FAILURE);
4009 ADD_AD_CONSTANT(BAD_CERTIFICATE);
4010 ADD_AD_CONSTANT(UNSUPPORTED_CERTIFICATE);
4011 ADD_AD_CONSTANT(CERTIFICATE_REVOKED);
4012 ADD_AD_CONSTANT(CERTIFICATE_EXPIRED);
4013 ADD_AD_CONSTANT(CERTIFICATE_UNKNOWN);
4014 ADD_AD_CONSTANT(ILLEGAL_PARAMETER);
4015 ADD_AD_CONSTANT(UNKNOWN_CA);
4016 ADD_AD_CONSTANT(ACCESS_DENIED);
4017 ADD_AD_CONSTANT(DECODE_ERROR);
4018 ADD_AD_CONSTANT(DECRYPT_ERROR);
4019 ADD_AD_CONSTANT(PROTOCOL_VERSION);
4020 ADD_AD_CONSTANT(INSUFFICIENT_SECURITY);
4021 ADD_AD_CONSTANT(INTERNAL_ERROR);
4022 ADD_AD_CONSTANT(USER_CANCELLED);
4023 ADD_AD_CONSTANT(NO_RENEGOTIATION);
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004024 /* Not all constants are in old OpenSSL versions */
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004025#ifdef SSL_AD_UNSUPPORTED_EXTENSION
4026 ADD_AD_CONSTANT(UNSUPPORTED_EXTENSION);
4027#endif
4028#ifdef SSL_AD_CERTIFICATE_UNOBTAINABLE
4029 ADD_AD_CONSTANT(CERTIFICATE_UNOBTAINABLE);
4030#endif
4031#ifdef SSL_AD_UNRECOGNIZED_NAME
4032 ADD_AD_CONSTANT(UNRECOGNIZED_NAME);
4033#endif
Antoine Pitrou58ddc9d2013-01-05 21:20:29 +01004034#ifdef SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE
4035 ADD_AD_CONSTANT(BAD_CERTIFICATE_STATUS_RESPONSE);
4036#endif
4037#ifdef SSL_AD_BAD_CERTIFICATE_HASH_VALUE
4038 ADD_AD_CONSTANT(BAD_CERTIFICATE_HASH_VALUE);
4039#endif
4040#ifdef SSL_AD_UNKNOWN_PSK_IDENTITY
4041 ADD_AD_CONSTANT(UNKNOWN_PSK_IDENTITY);
4042#endif
4043
4044#undef ADD_AD_CONSTANT
4045
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004046 /* protocol versions */
Victor Stinner3de49192011-05-09 00:42:58 +02004047#ifndef OPENSSL_NO_SSL2
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004048 PyModule_AddIntConstant(m, "PROTOCOL_SSLv2",
4049 PY_SSL_VERSION_SSL2);
Victor Stinner3de49192011-05-09 00:42:58 +02004050#endif
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004051 PyModule_AddIntConstant(m, "PROTOCOL_SSLv3",
4052 PY_SSL_VERSION_SSL3);
4053 PyModule_AddIntConstant(m, "PROTOCOL_SSLv23",
4054 PY_SSL_VERSION_SSL23);
4055 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1",
4056 PY_SSL_VERSION_TLS1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004057#if HAVE_TLSv1_2
4058 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_1",
4059 PY_SSL_VERSION_TLS1_1);
4060 PyModule_AddIntConstant(m, "PROTOCOL_TLSv1_2",
4061 PY_SSL_VERSION_TLS1_2);
4062#endif
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004063
Antoine Pitroub5218772010-05-21 09:56:06 +00004064 /* protocol options */
Antoine Pitrou3f366312012-01-27 09:50:45 +01004065 PyModule_AddIntConstant(m, "OP_ALL",
4066 SSL_OP_ALL & ~SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS);
Antoine Pitroub5218772010-05-21 09:56:06 +00004067 PyModule_AddIntConstant(m, "OP_NO_SSLv2", SSL_OP_NO_SSLv2);
4068 PyModule_AddIntConstant(m, "OP_NO_SSLv3", SSL_OP_NO_SSLv3);
4069 PyModule_AddIntConstant(m, "OP_NO_TLSv1", SSL_OP_NO_TLSv1);
Antoine Pitrou2463e5f2013-03-28 22:24:43 +01004070#if HAVE_TLSv1_2
4071 PyModule_AddIntConstant(m, "OP_NO_TLSv1_1", SSL_OP_NO_TLSv1_1);
4072 PyModule_AddIntConstant(m, "OP_NO_TLSv1_2", SSL_OP_NO_TLSv1_2);
4073#endif
Antoine Pitrou6db49442011-12-19 13:27:11 +01004074 PyModule_AddIntConstant(m, "OP_CIPHER_SERVER_PREFERENCE",
4075 SSL_OP_CIPHER_SERVER_PREFERENCE);
Antoine Pitrou0e576f12011-12-22 10:03:38 +01004076 PyModule_AddIntConstant(m, "OP_SINGLE_DH_USE", SSL_OP_SINGLE_DH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004077#ifdef SSL_OP_SINGLE_ECDH_USE
Antoine Pitrou923df6f2011-12-19 17:16:51 +01004078 PyModule_AddIntConstant(m, "OP_SINGLE_ECDH_USE", SSL_OP_SINGLE_ECDH_USE);
Antoine Pitroue9fccb32012-02-17 11:53:10 +01004079#endif
Antoine Pitrou8abdb8a2011-12-20 10:13:40 +01004080#ifdef SSL_OP_NO_COMPRESSION
4081 PyModule_AddIntConstant(m, "OP_NO_COMPRESSION",
4082 SSL_OP_NO_COMPRESSION);
4083#endif
Antoine Pitroub5218772010-05-21 09:56:06 +00004084
Antoine Pitrou912fbff2013-03-30 16:29:32 +01004085#if HAVE_SNI
Antoine Pitroud5323212010-10-22 18:19:07 +00004086 r = Py_True;
4087#else
4088 r = Py_False;
4089#endif
4090 Py_INCREF(r);
4091 PyModule_AddObject(m, "HAS_SNI", r);
4092
Antoine Pitroud6494802011-07-21 01:11:30 +02004093#if HAVE_OPENSSL_FINISHED
4094 r = Py_True;
4095#else
4096 r = Py_False;
4097#endif
4098 Py_INCREF(r);
4099 PyModule_AddObject(m, "HAS_TLS_UNIQUE", r);
4100
Antoine Pitrou501da612011-12-21 09:27:41 +01004101#ifdef OPENSSL_NO_ECDH
4102 r = Py_False;
4103#else
4104 r = Py_True;
4105#endif
4106 Py_INCREF(r);
4107 PyModule_AddObject(m, "HAS_ECDH", r);
4108
Antoine Pitroud5d17eb2012-03-22 00:23:03 +01004109#ifdef OPENSSL_NPN_NEGOTIATED
4110 r = Py_True;
4111#else
4112 r = Py_False;
4113#endif
4114 Py_INCREF(r);
4115 PyModule_AddObject(m, "HAS_NPN", r);
4116
Antoine Pitrou3b36fb12012-06-22 21:11:52 +02004117 /* Mappings for error codes */
4118 err_codes_to_names = PyDict_New();
4119 err_names_to_codes = PyDict_New();
4120 if (err_codes_to_names == NULL || err_names_to_codes == NULL)
4121 return NULL;
4122 errcode = error_codes;
4123 while (errcode->mnemonic != NULL) {
4124 PyObject *mnemo, *key;
4125 mnemo = PyUnicode_FromString(errcode->mnemonic);
4126 key = Py_BuildValue("ii", errcode->library, errcode->reason);
4127 if (mnemo == NULL || key == NULL)
4128 return NULL;
4129 if (PyDict_SetItem(err_codes_to_names, key, mnemo))
4130 return NULL;
4131 if (PyDict_SetItem(err_names_to_codes, mnemo, key))
4132 return NULL;
4133 Py_DECREF(key);
4134 Py_DECREF(mnemo);
4135 errcode++;
4136 }
4137 if (PyModule_AddObject(m, "err_codes_to_names", err_codes_to_names))
4138 return NULL;
4139 if (PyModule_AddObject(m, "err_names_to_codes", err_names_to_codes))
4140 return NULL;
4141
4142 lib_codes_to_names = PyDict_New();
4143 if (lib_codes_to_names == NULL)
4144 return NULL;
4145 libcode = library_codes;
4146 while (libcode->library != NULL) {
4147 PyObject *mnemo, *key;
4148 key = PyLong_FromLong(libcode->code);
4149 mnemo = PyUnicode_FromString(libcode->library);
4150 if (key == NULL || mnemo == NULL)
4151 return NULL;
4152 if (PyDict_SetItem(lib_codes_to_names, key, mnemo))
4153 return NULL;
4154 Py_DECREF(key);
4155 Py_DECREF(mnemo);
4156 libcode++;
4157 }
4158 if (PyModule_AddObject(m, "lib_codes_to_names", lib_codes_to_names))
4159 return NULL;
Victor Stinner4569cd52013-06-23 14:58:43 +02004160
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004161 /* OpenSSL version */
4162 /* SSLeay() gives us the version of the library linked against,
4163 which could be different from the headers version.
4164 */
4165 libver = SSLeay();
4166 r = PyLong_FromUnsignedLong(libver);
4167 if (r == NULL)
4168 return NULL;
4169 if (PyModule_AddObject(m, "OPENSSL_VERSION_NUMBER", r))
4170 return NULL;
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004171 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004172 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4173 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION_INFO", r))
4174 return NULL;
4175 r = PyUnicode_FromString(SSLeay_version(SSLEAY_VERSION));
4176 if (r == NULL || PyModule_AddObject(m, "OPENSSL_VERSION", r))
4177 return NULL;
Antoine Pitrou04f6a322010-04-05 21:40:07 +00004178
Antoine Pitroub9ac25d2011-07-08 18:47:06 +02004179 libver = OPENSSL_VERSION_NUMBER;
4180 parse_openssl_version(libver, &major, &minor, &fix, &patch, &status);
4181 r = Py_BuildValue("IIIII", major, minor, fix, patch, status);
4182 if (r == NULL || PyModule_AddObject(m, "_OPENSSL_API_VERSION", r))
4183 return NULL;
4184
Antoine Pitroucbb82eb2010-05-05 15:57:33 +00004185 return m;
Marc-André Lemburga5d2b4c2002-02-16 18:23:30 +00004186}