Maximilian Hils | 1d95dea | 2015-08-17 19:27:20 +0200 | [diff] [blame] | 1 | import socket |
Konstantinos Koukopoulos | 541150d | 2014-01-31 01:00:19 +0200 | [diff] [blame] | 2 | from sys import platform |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 3 | from functools import wraps, partial |
Cory Benfield | be3e7b8 | 2014-05-10 09:48:55 +0100 | [diff] [blame] | 4 | from itertools import count, chain |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 5 | from weakref import WeakValueDictionary |
| 6 | from errno import errorcode |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 7 | |
Cory Benfield | 63759dc | 2015-04-12 08:57:03 -0400 | [diff] [blame] | 8 | from six import binary_type as _binary_type |
Konstantinos Koukopoulos | c8b13ea | 2014-01-28 00:21:50 -0800 | [diff] [blame] | 9 | from six import integer_types as integer_types |
Cory Benfield | cd010f6 | 2014-05-15 19:00:27 +0100 | [diff] [blame] | 10 | from six import int2byte, indexbytes |
Jean-Paul Calderone | 63eab69 | 2014-01-18 10:19:56 -0500 | [diff] [blame] | 11 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 12 | from OpenSSL._util import ( |
Hynek Schlawack | aa86121 | 2016-03-13 13:53:48 +0100 | [diff] [blame] | 13 | UNSPECIFIED as _UNSPECIFIED, |
| 14 | exception_from_error_queue as _exception_from_error_queue, |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 15 | ffi as _ffi, |
| 16 | lib as _lib, |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 17 | make_assert as _make_assert, |
Hynek Schlawack | aa86121 | 2016-03-13 13:53:48 +0100 | [diff] [blame] | 18 | native as _native, |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 19 | path_string as _path_string, |
Hynek Schlawack | aa86121 | 2016-03-13 13:53:48 +0100 | [diff] [blame] | 20 | text_to_bytes_and_warn as _text_to_bytes_and_warn, |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 21 | no_zero_allocator as _no_zero_allocator, |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 22 | ) |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 23 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 24 | from OpenSSL.crypto import ( |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 25 | FILETYPE_PEM, _PassphraseHelper, PKey, X509Name, X509, X509Store) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 26 | |
Jean-Paul Calderone | 8fb5318 | 2013-12-30 08:35:49 -0500 | [diff] [blame] | 27 | try: |
| 28 | _memoryview = memoryview |
| 29 | except NameError: |
| 30 | class _memoryview(object): |
| 31 | pass |
| 32 | |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 33 | try: |
| 34 | _buffer = buffer |
| 35 | except NameError: |
| 36 | class _buffer(object): |
| 37 | pass |
| 38 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 39 | OPENSSL_VERSION_NUMBER = _lib.OPENSSL_VERSION_NUMBER |
| 40 | SSLEAY_VERSION = _lib.SSLEAY_VERSION |
| 41 | SSLEAY_CFLAGS = _lib.SSLEAY_CFLAGS |
| 42 | SSLEAY_PLATFORM = _lib.SSLEAY_PLATFORM |
| 43 | SSLEAY_DIR = _lib.SSLEAY_DIR |
| 44 | SSLEAY_BUILT_ON = _lib.SSLEAY_BUILT_ON |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 45 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 46 | SENT_SHUTDOWN = _lib.SSL_SENT_SHUTDOWN |
| 47 | RECEIVED_SHUTDOWN = _lib.SSL_RECEIVED_SHUTDOWN |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 48 | |
| 49 | SSLv2_METHOD = 1 |
| 50 | SSLv3_METHOD = 2 |
| 51 | SSLv23_METHOD = 3 |
| 52 | TLSv1_METHOD = 4 |
Jean-Paul Calderone | 56bff94 | 2013-11-03 11:30:43 -0500 | [diff] [blame] | 53 | TLSv1_1_METHOD = 5 |
| 54 | TLSv1_2_METHOD = 6 |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 55 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 56 | OP_NO_SSLv2 = _lib.SSL_OP_NO_SSLv2 |
| 57 | OP_NO_SSLv3 = _lib.SSL_OP_NO_SSLv3 |
| 58 | OP_NO_TLSv1 = _lib.SSL_OP_NO_TLSv1 |
Jean-Paul Calderone | be2bb42 | 2013-12-29 07:34:08 -0500 | [diff] [blame] | 59 | |
| 60 | OP_NO_TLSv1_1 = getattr(_lib, "SSL_OP_NO_TLSv1_1", 0) |
| 61 | OP_NO_TLSv1_2 = getattr(_lib, "SSL_OP_NO_TLSv1_2", 0) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 62 | |
Alex Gaynor | bf01287 | 2016-06-04 13:18:39 -0700 | [diff] [blame] | 63 | MODE_RELEASE_BUFFERS = _lib.SSL_MODE_RELEASE_BUFFERS |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 64 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 65 | OP_SINGLE_DH_USE = _lib.SSL_OP_SINGLE_DH_USE |
Akihiro Yamazaki | e64d80c | 2015-09-06 00:16:57 +0900 | [diff] [blame] | 66 | OP_SINGLE_ECDH_USE = _lib.SSL_OP_SINGLE_ECDH_USE |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 67 | OP_EPHEMERAL_RSA = _lib.SSL_OP_EPHEMERAL_RSA |
| 68 | OP_MICROSOFT_SESS_ID_BUG = _lib.SSL_OP_MICROSOFT_SESS_ID_BUG |
| 69 | OP_NETSCAPE_CHALLENGE_BUG = _lib.SSL_OP_NETSCAPE_CHALLENGE_BUG |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 70 | OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG = ( |
| 71 | _lib.SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG |
| 72 | ) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 73 | OP_SSLREF2_REUSE_CERT_TYPE_BUG = _lib.SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG |
| 74 | OP_MICROSOFT_BIG_SSLV3_BUFFER = _lib.SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER |
Alex Gaynor | 5bb2bd1 | 2016-07-03 10:48:32 -0400 | [diff] [blame] | 75 | OP_MSIE_SSLV2_RSA_PADDING = _lib.SSL_OP_MSIE_SSLV2_RSA_PADDING |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 76 | OP_SSLEAY_080_CLIENT_DH_BUG = _lib.SSL_OP_SSLEAY_080_CLIENT_DH_BUG |
| 77 | OP_TLS_D5_BUG = _lib.SSL_OP_TLS_D5_BUG |
| 78 | OP_TLS_BLOCK_PADDING_BUG = _lib.SSL_OP_TLS_BLOCK_PADDING_BUG |
| 79 | OP_DONT_INSERT_EMPTY_FRAGMENTS = _lib.SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS |
| 80 | OP_CIPHER_SERVER_PREFERENCE = _lib.SSL_OP_CIPHER_SERVER_PREFERENCE |
| 81 | OP_TLS_ROLLBACK_BUG = _lib.SSL_OP_TLS_ROLLBACK_BUG |
| 82 | OP_PKCS1_CHECK_1 = _lib.SSL_OP_PKCS1_CHECK_1 |
| 83 | OP_PKCS1_CHECK_2 = _lib.SSL_OP_PKCS1_CHECK_2 |
| 84 | OP_NETSCAPE_CA_DN_BUG = _lib.SSL_OP_NETSCAPE_CA_DN_BUG |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 85 | OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG = ( |
| 86 | _lib.SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG |
| 87 | ) |
Alex Gaynor | bf01287 | 2016-06-04 13:18:39 -0700 | [diff] [blame] | 88 | OP_NO_COMPRESSION = _lib.SSL_OP_NO_COMPRESSION |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 89 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 90 | OP_NO_QUERY_MTU = _lib.SSL_OP_NO_QUERY_MTU |
| 91 | OP_COOKIE_EXCHANGE = _lib.SSL_OP_COOKIE_EXCHANGE |
Alex Gaynor | 5bb2bd1 | 2016-07-03 10:48:32 -0400 | [diff] [blame] | 92 | OP_NO_TICKET = _lib.SSL_OP_NO_TICKET |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 93 | |
Alex Gaynor | c488981 | 2015-09-04 08:43:17 -0400 | [diff] [blame] | 94 | OP_ALL = _lib.SSL_OP_ALL |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 95 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 96 | VERIFY_PEER = _lib.SSL_VERIFY_PEER |
| 97 | VERIFY_FAIL_IF_NO_PEER_CERT = _lib.SSL_VERIFY_FAIL_IF_NO_PEER_CERT |
| 98 | VERIFY_CLIENT_ONCE = _lib.SSL_VERIFY_CLIENT_ONCE |
| 99 | VERIFY_NONE = _lib.SSL_VERIFY_NONE |
Jean-Paul Calderone | 935d2da | 2013-03-04 08:11:19 -0800 | [diff] [blame] | 100 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 101 | SESS_CACHE_OFF = _lib.SSL_SESS_CACHE_OFF |
| 102 | SESS_CACHE_CLIENT = _lib.SSL_SESS_CACHE_CLIENT |
| 103 | SESS_CACHE_SERVER = _lib.SSL_SESS_CACHE_SERVER |
| 104 | SESS_CACHE_BOTH = _lib.SSL_SESS_CACHE_BOTH |
| 105 | SESS_CACHE_NO_AUTO_CLEAR = _lib.SSL_SESS_CACHE_NO_AUTO_CLEAR |
| 106 | SESS_CACHE_NO_INTERNAL_LOOKUP = _lib.SSL_SESS_CACHE_NO_INTERNAL_LOOKUP |
| 107 | SESS_CACHE_NO_INTERNAL_STORE = _lib.SSL_SESS_CACHE_NO_INTERNAL_STORE |
| 108 | SESS_CACHE_NO_INTERNAL = _lib.SSL_SESS_CACHE_NO_INTERNAL |
Jean-Paul Calderone | d39a3f6 | 2013-03-04 12:23:51 -0800 | [diff] [blame] | 109 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 110 | SSL_ST_CONNECT = _lib.SSL_ST_CONNECT |
| 111 | SSL_ST_ACCEPT = _lib.SSL_ST_ACCEPT |
| 112 | SSL_ST_MASK = _lib.SSL_ST_MASK |
Alex Gaynor | 5af32d0 | 2016-09-24 01:52:21 -0400 | [diff] [blame] | 113 | if _lib.Cryptography_HAS_SSL_ST: |
| 114 | SSL_ST_INIT = _lib.SSL_ST_INIT |
| 115 | SSL_ST_BEFORE = _lib.SSL_ST_BEFORE |
| 116 | SSL_ST_OK = _lib.SSL_ST_OK |
| 117 | SSL_ST_RENEGOTIATE = _lib.SSL_ST_RENEGOTIATE |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 118 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 119 | SSL_CB_LOOP = _lib.SSL_CB_LOOP |
| 120 | SSL_CB_EXIT = _lib.SSL_CB_EXIT |
| 121 | SSL_CB_READ = _lib.SSL_CB_READ |
| 122 | SSL_CB_WRITE = _lib.SSL_CB_WRITE |
| 123 | SSL_CB_ALERT = _lib.SSL_CB_ALERT |
| 124 | SSL_CB_READ_ALERT = _lib.SSL_CB_READ_ALERT |
| 125 | SSL_CB_WRITE_ALERT = _lib.SSL_CB_WRITE_ALERT |
| 126 | SSL_CB_ACCEPT_LOOP = _lib.SSL_CB_ACCEPT_LOOP |
| 127 | SSL_CB_ACCEPT_EXIT = _lib.SSL_CB_ACCEPT_EXIT |
| 128 | SSL_CB_CONNECT_LOOP = _lib.SSL_CB_CONNECT_LOOP |
| 129 | SSL_CB_CONNECT_EXIT = _lib.SSL_CB_CONNECT_EXIT |
| 130 | SSL_CB_HANDSHAKE_START = _lib.SSL_CB_HANDSHAKE_START |
| 131 | SSL_CB_HANDSHAKE_DONE = _lib.SSL_CB_HANDSHAKE_DONE |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 132 | |
Alex Gaynor | 8328495 | 2015-09-05 10:43:30 -0400 | [diff] [blame] | 133 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 134 | class Error(Exception): |
Jean-Paul Calderone | 511cde0 | 2013-12-29 10:31:13 -0500 | [diff] [blame] | 135 | """ |
| 136 | An error occurred in an `OpenSSL.SSL` API. |
| 137 | """ |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 138 | |
| 139 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 140 | _raise_current_error = partial(_exception_from_error_queue, Error) |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 141 | _openssl_assert = _make_assert(Error) |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 142 | |
| 143 | |
| 144 | class WantReadError(Error): |
| 145 | pass |
| 146 | |
| 147 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 148 | class WantWriteError(Error): |
| 149 | pass |
| 150 | |
| 151 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 152 | class WantX509LookupError(Error): |
| 153 | pass |
| 154 | |
| 155 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 156 | class ZeroReturnError(Error): |
| 157 | pass |
| 158 | |
| 159 | |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 160 | class SysCallError(Error): |
| 161 | pass |
| 162 | |
| 163 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 164 | class _CallbackExceptionHelper(object): |
| 165 | """ |
| 166 | A base class for wrapper classes that allow for intelligent exception |
| 167 | handling in OpenSSL callbacks. |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 168 | |
Jean-Paul Calderone | 1b17298 | 2015-03-22 19:37:11 -0400 | [diff] [blame] | 169 | :ivar list _problems: Any exceptions that occurred while executing in a |
| 170 | context where they could not be raised in the normal way. Typically |
| 171 | this is because OpenSSL has called into some Python code and requires a |
| 172 | return value. The exceptions are saved to be raised later when it is |
| 173 | possible to do so. |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 174 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 175 | |
Jean-Paul Calderone | 09540d7 | 2015-03-22 19:37:20 -0400 | [diff] [blame] | 176 | def __init__(self): |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 177 | self._problems = [] |
| 178 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 179 | def raise_if_problem(self): |
Jean-Paul Calderone | 1b17298 | 2015-03-22 19:37:11 -0400 | [diff] [blame] | 180 | """ |
| 181 | Raise an exception from the OpenSSL error queue or that was previously |
| 182 | captured whe running a callback. |
| 183 | """ |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 184 | if self._problems: |
| 185 | try: |
| 186 | _raise_current_error() |
| 187 | except Error: |
| 188 | pass |
| 189 | raise self._problems.pop(0) |
| 190 | |
| 191 | |
| 192 | class _VerifyHelper(_CallbackExceptionHelper): |
Jean-Paul Calderone | 1b17298 | 2015-03-22 19:37:11 -0400 | [diff] [blame] | 193 | """ |
| 194 | Wrap a callback such that it can be used as a certificate verification |
| 195 | callback. |
| 196 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 197 | |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 198 | def __init__(self, callback): |
Jean-Paul Calderone | 837f403 | 2015-03-22 17:38:28 -0400 | [diff] [blame] | 199 | _CallbackExceptionHelper.__init__(self) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 200 | |
| 201 | @wraps(callback) |
| 202 | def wrapper(ok, store_ctx): |
| 203 | cert = X509.__new__(X509) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 204 | cert._x509 = _lib.X509_STORE_CTX_get_current_cert(store_ctx) |
| 205 | error_number = _lib.X509_STORE_CTX_get_error(store_ctx) |
| 206 | error_depth = _lib.X509_STORE_CTX_get_error_depth(store_ctx) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 207 | |
Jean-Paul Calderone | 6a8cd11 | 2014-04-02 21:09:08 -0400 | [diff] [blame] | 208 | index = _lib.SSL_get_ex_data_X509_STORE_CTX_idx() |
| 209 | ssl = _lib.X509_STORE_CTX_get_ex_data(store_ctx, index) |
| 210 | connection = Connection._reverse_mapping[ssl] |
| 211 | |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 212 | try: |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 213 | result = callback( |
| 214 | connection, cert, error_number, error_depth, ok |
| 215 | ) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 216 | except Exception as e: |
| 217 | self._problems.append(e) |
| 218 | return 0 |
| 219 | else: |
| 220 | if result: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 221 | _lib.X509_STORE_CTX_set_error(store_ctx, _lib.X509_V_OK) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 222 | return 1 |
| 223 | else: |
| 224 | return 0 |
| 225 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 226 | self.callback = _ffi.callback( |
| 227 | "int (*)(int, X509_STORE_CTX *)", wrapper) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 228 | |
| 229 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 230 | class _NpnAdvertiseHelper(_CallbackExceptionHelper): |
Jean-Paul Calderone | 1b17298 | 2015-03-22 19:37:11 -0400 | [diff] [blame] | 231 | """ |
| 232 | Wrap a callback such that it can be used as an NPN advertisement callback. |
| 233 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 234 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 235 | def __init__(self, callback): |
Jean-Paul Calderone | 837f403 | 2015-03-22 17:38:28 -0400 | [diff] [blame] | 236 | _CallbackExceptionHelper.__init__(self) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 237 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 238 | @wraps(callback) |
| 239 | def wrapper(ssl, out, outlen, arg): |
| 240 | try: |
| 241 | conn = Connection._reverse_mapping[ssl] |
| 242 | protos = callback(conn) |
| 243 | |
| 244 | # Join the protocols into a Python bytestring, length-prefixing |
| 245 | # each element. |
| 246 | protostr = b''.join( |
| 247 | chain.from_iterable((int2byte(len(p)), p) for p in protos) |
| 248 | ) |
| 249 | |
| 250 | # Save our callback arguments on the connection object. This is |
| 251 | # done to make sure that they don't get freed before OpenSSL |
| 252 | # uses them. Then, return them appropriately in the output |
| 253 | # parameters. |
| 254 | conn._npn_advertise_callback_args = [ |
| 255 | _ffi.new("unsigned int *", len(protostr)), |
| 256 | _ffi.new("unsigned char[]", protostr), |
| 257 | ] |
| 258 | outlen[0] = conn._npn_advertise_callback_args[0][0] |
| 259 | out[0] = conn._npn_advertise_callback_args[1] |
| 260 | return 0 |
| 261 | except Exception as e: |
| 262 | self._problems.append(e) |
| 263 | return 2 # SSL_TLSEXT_ERR_ALERT_FATAL |
| 264 | |
| 265 | self.callback = _ffi.callback( |
| 266 | "int (*)(SSL *, const unsigned char **, unsigned int *, void *)", |
| 267 | wrapper |
| 268 | ) |
| 269 | |
| 270 | |
| 271 | class _NpnSelectHelper(_CallbackExceptionHelper): |
Jean-Paul Calderone | 1b17298 | 2015-03-22 19:37:11 -0400 | [diff] [blame] | 272 | """ |
| 273 | Wrap a callback such that it can be used as an NPN selection callback. |
| 274 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 275 | |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 276 | def __init__(self, callback): |
Jean-Paul Calderone | 837f403 | 2015-03-22 17:38:28 -0400 | [diff] [blame] | 277 | _CallbackExceptionHelper.__init__(self) |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 278 | |
| 279 | @wraps(callback) |
| 280 | def wrapper(ssl, out, outlen, in_, inlen, arg): |
| 281 | try: |
| 282 | conn = Connection._reverse_mapping[ssl] |
| 283 | |
| 284 | # The string passed to us is actually made up of multiple |
| 285 | # length-prefixed bytestrings. We need to split that into a |
| 286 | # list. |
| 287 | instr = _ffi.buffer(in_, inlen)[:] |
| 288 | protolist = [] |
| 289 | while instr: |
| 290 | l = indexbytes(instr, 0) |
Alex Gaynor | ca87ff6 | 2015-09-04 23:31:03 -0400 | [diff] [blame] | 291 | proto = instr[1:l + 1] |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 292 | protolist.append(proto) |
Alex Gaynor | ca87ff6 | 2015-09-04 23:31:03 -0400 | [diff] [blame] | 293 | instr = instr[l + 1:] |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 294 | |
| 295 | # Call the callback |
| 296 | outstr = callback(conn, protolist) |
| 297 | |
| 298 | # Save our callback arguments on the connection object. This is |
| 299 | # done to make sure that they don't get freed before OpenSSL |
| 300 | # uses them. Then, return them appropriately in the output |
| 301 | # parameters. |
| 302 | conn._npn_select_callback_args = [ |
| 303 | _ffi.new("unsigned char *", len(outstr)), |
| 304 | _ffi.new("unsigned char[]", outstr), |
| 305 | ] |
| 306 | outlen[0] = conn._npn_select_callback_args[0][0] |
| 307 | out[0] = conn._npn_select_callback_args[1] |
| 308 | return 0 |
| 309 | except Exception as e: |
| 310 | self._problems.append(e) |
| 311 | return 2 # SSL_TLSEXT_ERR_ALERT_FATAL |
| 312 | |
| 313 | self.callback = _ffi.callback( |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 314 | ("int (*)(SSL *, unsigned char **, unsigned char *, " |
| 315 | "const unsigned char *, unsigned int, void *)"), |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 316 | wrapper |
| 317 | ) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 318 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 319 | |
Cory Benfield | 9da5ffb | 2015-04-13 17:20:14 -0400 | [diff] [blame] | 320 | class _ALPNSelectHelper(_CallbackExceptionHelper): |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 321 | """ |
| 322 | Wrap a callback such that it can be used as an ALPN selection callback. |
| 323 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 324 | |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 325 | def __init__(self, callback): |
| 326 | _CallbackExceptionHelper.__init__(self) |
| 327 | |
| 328 | @wraps(callback) |
| 329 | def wrapper(ssl, out, outlen, in_, inlen, arg): |
| 330 | try: |
| 331 | conn = Connection._reverse_mapping[ssl] |
| 332 | |
| 333 | # The string passed to us is made up of multiple |
| 334 | # length-prefixed bytestrings. We need to split that into a |
| 335 | # list. |
| 336 | instr = _ffi.buffer(in_, inlen)[:] |
| 337 | protolist = [] |
| 338 | while instr: |
Cory Benfield | 93134db | 2015-04-13 17:22:13 -0400 | [diff] [blame] | 339 | encoded_len = indexbytes(instr, 0) |
| 340 | proto = instr[1:encoded_len + 1] |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 341 | protolist.append(proto) |
Cory Benfield | 93134db | 2015-04-13 17:22:13 -0400 | [diff] [blame] | 342 | instr = instr[encoded_len + 1:] |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 343 | |
| 344 | # Call the callback |
| 345 | outstr = callback(conn, protolist) |
| 346 | |
| 347 | if not isinstance(outstr, _binary_type): |
| 348 | raise TypeError("ALPN callback must return a bytestring.") |
| 349 | |
| 350 | # Save our callback arguments on the connection object to make |
| 351 | # sure that they don't get freed before OpenSSL can use them. |
| 352 | # Then, return them in the appropriate output parameters. |
| 353 | conn._alpn_select_callback_args = [ |
| 354 | _ffi.new("unsigned char *", len(outstr)), |
| 355 | _ffi.new("unsigned char[]", outstr), |
| 356 | ] |
| 357 | outlen[0] = conn._alpn_select_callback_args[0][0] |
| 358 | out[0] = conn._alpn_select_callback_args[1] |
| 359 | return 0 |
| 360 | except Exception as e: |
| 361 | self._problems.append(e) |
| 362 | return 2 # SSL_TLSEXT_ERR_ALERT_FATAL |
| 363 | |
| 364 | self.callback = _ffi.callback( |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 365 | ("int (*)(SSL *, unsigned char **, unsigned char *, " |
| 366 | "const unsigned char *, unsigned int, void *)"), |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 367 | wrapper |
| 368 | ) |
| 369 | |
| 370 | |
Cory Benfield | 496652a | 2017-01-24 11:42:56 +0000 | [diff] [blame] | 371 | class _OCSPServerCallbackHelper(_CallbackExceptionHelper): |
| 372 | """ |
| 373 | Wrap a callback such that it can be used as an OCSP callback for the server |
| 374 | side. |
| 375 | |
| 376 | Annoyingly, OpenSSL defines one OCSP callback but uses it in two different |
| 377 | ways. For servers, that callback is expected to retrieve some OCSP data and |
| 378 | hand it to OpenSSL, and may return only SSL_TLSEXT_ERR_OK, |
| 379 | SSL_TLSEXT_ERR_FATAL, and SSL_TLSEXT_ERR_NOACK. For clients, that callback |
| 380 | is expected to check the OCSP data, and returns a negative value on error, |
| 381 | 0 if the response is not acceptable, or positive if it is. These are |
| 382 | mutually exclusive return code behaviours, and they mean that we need two |
| 383 | helpers so that we always return an appropriate error code if the user's |
| 384 | code throws an exception. |
| 385 | |
| 386 | Given that we have to have two helpers anyway, these helpers are a bit more |
| 387 | helpery than most: specifically, they hide a few more of the OpenSSL |
| 388 | functions so that the user has an easier time writing these callbacks. |
| 389 | |
| 390 | This helper implements the server side. |
| 391 | """ |
| 392 | |
| 393 | def __init__(self, callback): |
| 394 | _CallbackExceptionHelper.__init__(self) |
| 395 | |
| 396 | @wraps(callback) |
| 397 | def wrapper(ssl, cdata): |
| 398 | try: |
| 399 | conn = Connection._reverse_mapping[ssl] |
| 400 | |
| 401 | # Extract the data if any was provided. |
| 402 | if cdata != _ffi.NULL: |
| 403 | data = _ffi.from_handle(cdata) |
| 404 | else: |
| 405 | data = None |
| 406 | |
| 407 | # Call the callback. |
| 408 | ocsp_data = callback(conn, data) |
| 409 | |
| 410 | if not isinstance(ocsp_data, _binary_type): |
| 411 | raise TypeError("OCSP callback must return a bytestring.") |
| 412 | |
| 413 | # If the OCSP data was provided, we will pass it to OpenSSL. |
| 414 | # However, we have an early exit here: if no OCSP data was |
| 415 | # provided we will just exit out and tell OpenSSL that there |
| 416 | # is nothing to do. |
| 417 | if not ocsp_data: |
| 418 | return 3 # SSL_TLSEXT_ERR_NOACK |
| 419 | |
| 420 | # Pass the data to OpenSSL. Insanely, OpenSSL doesn't make a |
| 421 | # private copy of this data, so we need to keep it alive, but |
| 422 | # it *does* want to free it itself if it gets replaced. This |
| 423 | # somewhat bonkers behaviour means we need to use |
| 424 | # OPENSSL_malloc directly, which is a pain in the butt to work |
| 425 | # with. It's ok for us to "leak" the memory here because |
| 426 | # OpenSSL now owns it and will free it. |
| 427 | ocsp_data_length = len(ocsp_data) |
| 428 | data_ptr = _lib.OPENSSL_malloc(ocsp_data_length) |
| 429 | _ffi.buffer(data_ptr, ocsp_data_length)[:] = ocsp_data |
| 430 | |
| 431 | _lib.SSL_set_tlsext_status_ocsp_resp( |
| 432 | ssl, data_ptr, ocsp_data_length |
| 433 | ) |
| 434 | |
| 435 | return 0 |
| 436 | except Exception as e: |
| 437 | self._problems.append(e) |
| 438 | return 2 # SSL_TLSEXT_ERR_ALERT_FATAL |
| 439 | |
| 440 | self.callback = _ffi.callback("int (*)(SSL *, void *)", wrapper) |
| 441 | |
| 442 | |
| 443 | class _OCSPClientCallbackHelper(_CallbackExceptionHelper): |
| 444 | """ |
| 445 | Wrap a callback such that it can be used as an OCSP callback for the client |
| 446 | side. |
| 447 | |
| 448 | Annoyingly, OpenSSL defines one OCSP callback but uses it in two different |
| 449 | ways. For servers, that callback is expected to retrieve some OCSP data and |
| 450 | hand it to OpenSSL, and may return only SSL_TLSEXT_ERR_OK, |
| 451 | SSL_TLSEXT_ERR_FATAL, and SSL_TLSEXT_ERR_NOACK. For clients, that callback |
| 452 | is expected to check the OCSP data, and returns a negative value on error, |
| 453 | 0 if the response is not acceptable, or positive if it is. These are |
| 454 | mutually exclusive return code behaviours, and they mean that we need two |
| 455 | helpers so that we always return an appropriate error code if the user's |
| 456 | code throws an exception. |
| 457 | |
| 458 | Given that we have to have two helpers anyway, these helpers are a bit more |
| 459 | helpery than most: specifically, they hide a few more of the OpenSSL |
| 460 | functions so that the user has an easier time writing these callbacks. |
| 461 | |
| 462 | This helper implements the client side. |
| 463 | """ |
| 464 | |
| 465 | def __init__(self, callback): |
| 466 | _CallbackExceptionHelper.__init__(self) |
| 467 | |
| 468 | @wraps(callback) |
| 469 | def wrapper(ssl, cdata): |
| 470 | try: |
| 471 | conn = Connection._reverse_mapping[ssl] |
| 472 | |
| 473 | # Extract the data if any was provided. |
| 474 | if cdata != _ffi.NULL: |
| 475 | data = _ffi.from_handle(cdata) |
| 476 | else: |
| 477 | data = None |
| 478 | |
| 479 | # Get the OCSP data. |
| 480 | ocsp_ptr = _ffi.new("unsigned char **") |
| 481 | ocsp_len = _lib.SSL_get_tlsext_status_ocsp_resp(ssl, ocsp_ptr) |
| 482 | if ocsp_len < 0: |
| 483 | # No OCSP data. |
| 484 | ocsp_data = b'' |
| 485 | else: |
| 486 | # Copy the OCSP data, then pass it to the callback. |
| 487 | ocsp_data = _ffi.buffer(ocsp_ptr[0], ocsp_len)[:] |
| 488 | |
| 489 | valid = callback(conn, ocsp_data, data) |
| 490 | |
| 491 | # Return 1 on success or 0 on error. |
| 492 | return int(bool(valid)) |
| 493 | |
| 494 | except Exception as e: |
| 495 | self._problems.append(e) |
| 496 | # Return negative value if an exception is hit. |
| 497 | return -1 |
| 498 | |
| 499 | self.callback = _ffi.callback("int (*)(SSL *, void *)", wrapper) |
| 500 | |
| 501 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 502 | def _asFileDescriptor(obj): |
| 503 | fd = None |
Konstantinos Koukopoulos | c8b13ea | 2014-01-28 00:21:50 -0800 | [diff] [blame] | 504 | if not isinstance(obj, integer_types): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 505 | meth = getattr(obj, "fileno", None) |
| 506 | if meth is not None: |
| 507 | obj = meth() |
| 508 | |
Konstantinos Koukopoulos | c8b13ea | 2014-01-28 00:21:50 -0800 | [diff] [blame] | 509 | if isinstance(obj, integer_types): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 510 | fd = obj |
| 511 | |
Konstantinos Koukopoulos | c8b13ea | 2014-01-28 00:21:50 -0800 | [diff] [blame] | 512 | if not isinstance(fd, integer_types): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 513 | raise TypeError("argument must be an int, or have a fileno() method.") |
| 514 | elif fd < 0: |
| 515 | raise ValueError( |
| 516 | "file descriptor cannot be a negative integer (%i)" % (fd,)) |
| 517 | |
| 518 | return fd |
| 519 | |
| 520 | |
Jean-Paul Calderone | d39a3f6 | 2013-03-04 12:23:51 -0800 | [diff] [blame] | 521 | def SSLeay_version(type): |
| 522 | """ |
| 523 | Return a string describing the version of OpenSSL in use. |
| 524 | |
| 525 | :param type: One of the SSLEAY_ constants defined in this module. |
| 526 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 527 | return _ffi.string(_lib.SSLeay_version(type)) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 528 | |
| 529 | |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 530 | def _make_requires(flag, error): |
Cory Benfield | a876cef | 2015-04-13 17:29:12 -0400 | [diff] [blame] | 531 | """ |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 532 | Builds a decorator that ensures that functions that rely on OpenSSL |
| 533 | functions that are not present in this build raise NotImplementedError, |
| 534 | rather than AttributeError coming out of cryptography. |
| 535 | |
| 536 | :param flag: A cryptography flag that guards the functions, e.g. |
| 537 | ``Cryptography_HAS_NEXTPROTONEG``. |
| 538 | :param error: The string to be used in the exception if the flag is false. |
Cory Benfield | a876cef | 2015-04-13 17:29:12 -0400 | [diff] [blame] | 539 | """ |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 540 | def _requires_decorator(func): |
| 541 | if not flag: |
| 542 | @wraps(func) |
| 543 | def explode(*args, **kwargs): |
| 544 | raise NotImplementedError(error) |
| 545 | return explode |
| 546 | else: |
| 547 | return func |
Cory Benfield | 10b277f | 2015-04-13 17:12:42 -0400 | [diff] [blame] | 548 | |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 549 | return _requires_decorator |
Cory Benfield | 10b277f | 2015-04-13 17:12:42 -0400 | [diff] [blame] | 550 | |
| 551 | |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 552 | _requires_npn = _make_requires( |
| 553 | _lib.Cryptography_HAS_NEXTPROTONEG, "NPN not available" |
| 554 | ) |
Cory Benfield | 7907e33 | 2015-04-13 17:18:25 -0400 | [diff] [blame] | 555 | |
| 556 | |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 557 | _requires_alpn = _make_requires( |
| 558 | _lib.Cryptography_HAS_ALPN, "ALPN not available" |
| 559 | ) |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 560 | |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 561 | |
Cory Benfield | ef404df | 2016-03-29 15:32:48 +0100 | [diff] [blame] | 562 | _requires_sni = _make_requires( |
| 563 | _lib.Cryptography_HAS_TLSEXT_HOSTNAME, "SNI not available" |
| 564 | ) |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 565 | |
| 566 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 567 | class Session(object): |
| 568 | pass |
| 569 | |
| 570 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 571 | class Context(object): |
| 572 | """ |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 573 | :class:`OpenSSL.SSL.Context` instances define the parameters for setting |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 574 | up new SSL connections. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 575 | """ |
| 576 | _methods = { |
Andrew Dunham | ec84a0a | 2014-02-24 12:41:37 -0800 | [diff] [blame] | 577 | SSLv2_METHOD: "SSLv2_method", |
Jean-Paul Calderone | be2bb42 | 2013-12-29 07:34:08 -0500 | [diff] [blame] | 578 | SSLv3_METHOD: "SSLv3_method", |
| 579 | SSLv23_METHOD: "SSLv23_method", |
| 580 | TLSv1_METHOD: "TLSv1_method", |
| 581 | TLSv1_1_METHOD: "TLSv1_1_method", |
| 582 | TLSv1_2_METHOD: "TLSv1_2_method", |
Alex Gaynor | c488981 | 2015-09-04 08:43:17 -0400 | [diff] [blame] | 583 | } |
Jean-Paul Calderone | be2bb42 | 2013-12-29 07:34:08 -0500 | [diff] [blame] | 584 | _methods = dict( |
| 585 | (identifier, getattr(_lib, name)) |
| 586 | for (identifier, name) in _methods.items() |
| 587 | if getattr(_lib, name, None) is not None) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 588 | |
| 589 | def __init__(self, method): |
| 590 | """ |
| 591 | :param method: One of SSLv2_METHOD, SSLv3_METHOD, SSLv23_METHOD, or |
| 592 | TLSv1_METHOD. |
| 593 | """ |
Jean-Paul Calderone | f73a3cb | 2014-02-09 08:49:06 -0500 | [diff] [blame] | 594 | if not isinstance(method, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 595 | raise TypeError("method must be an integer") |
| 596 | |
| 597 | try: |
| 598 | method_func = self._methods[method] |
| 599 | except KeyError: |
| 600 | raise ValueError("No such protocol") |
| 601 | |
| 602 | method_obj = method_func() |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 603 | _openssl_assert(method_obj != _ffi.NULL) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 604 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 605 | context = _lib.SSL_CTX_new(method_obj) |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 606 | _openssl_assert(context != _ffi.NULL) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 607 | context = _ffi.gc(context, _lib.SSL_CTX_free) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 608 | |
Paul Kehrer | 6c6bf86 | 2016-12-19 06:03:48 -0600 | [diff] [blame] | 609 | # If SSL_CTX_set_ecdh_auto is available then set it so the ECDH curve |
| 610 | # will be auto-selected. This function was added in 1.0.2 and made a |
| 611 | # noop in 1.1.0+ (where it is set automatically). |
| 612 | try: |
| 613 | res = _lib.SSL_CTX_set_ecdh_auto(context, 1) |
| 614 | _openssl_assert(res == 1) |
| 615 | except AttributeError: |
| 616 | pass |
| 617 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 618 | self._context = context |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 619 | self._passphrase_helper = None |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 620 | self._passphrase_callback = None |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 621 | self._passphrase_userdata = None |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 622 | self._verify_helper = None |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 623 | self._verify_callback = None |
| 624 | self._info_callback = None |
| 625 | self._tlsext_servername_callback = None |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 626 | self._app_data = None |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 627 | self._npn_advertise_helper = None |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 628 | self._npn_advertise_callback = None |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 629 | self._npn_select_helper = None |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 630 | self._npn_select_callback = None |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 631 | self._alpn_select_helper = None |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 632 | self._alpn_select_callback = None |
Cory Benfield | 496652a | 2017-01-24 11:42:56 +0000 | [diff] [blame] | 633 | self._ocsp_helper = None |
| 634 | self._ocsp_callback = None |
| 635 | self._ocsp_data = None |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 636 | |
Jean-Paul Calderone | 1aba416 | 2013-03-05 18:50:00 -0800 | [diff] [blame] | 637 | # SSL_CTX_set_app_data(self->ctx, self); |
| 638 | # SSL_CTX_set_mode(self->ctx, SSL_MODE_ENABLE_PARTIAL_WRITE | |
| 639 | # SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | |
| 640 | # SSL_MODE_AUTO_RETRY); |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 641 | self.set_mode(_lib.SSL_MODE_ENABLE_PARTIAL_WRITE) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 642 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 643 | def load_verify_locations(self, cafile, capath=None): |
| 644 | """ |
| 645 | Let SSL know where we can find trusted certificates for the certificate |
| 646 | chain |
| 647 | |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 648 | :param cafile: In which file we can find the certificates (``bytes`` or |
| 649 | ``unicode``). |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 650 | :param capath: In which directory we can find the certificates |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 651 | (``bytes`` or ``unicode``). |
| 652 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 653 | :return: None |
| 654 | """ |
| 655 | if cafile is None: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 656 | cafile = _ffi.NULL |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 657 | else: |
| 658 | cafile = _path_string(cafile) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 659 | |
| 660 | if capath is None: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 661 | capath = _ffi.NULL |
Jean-Paul Calderone | 55f9e88 | 2015-04-12 09:31:03 -0400 | [diff] [blame] | 662 | else: |
| 663 | capath = _path_string(capath) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 664 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 665 | load_result = _lib.SSL_CTX_load_verify_locations( |
| 666 | self._context, cafile, capath |
| 667 | ) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 668 | if not load_result: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 669 | _raise_current_error() |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 670 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 671 | def _wrap_callback(self, callback): |
| 672 | @wraps(callback) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 673 | def wrapper(size, verify, userdata): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 674 | return callback(size, verify, self._passphrase_userdata) |
| 675 | return _PassphraseHelper( |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 676 | FILETYPE_PEM, wrapper, more_args=True, truncate=True) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 677 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 678 | def set_passwd_cb(self, callback, userdata=None): |
| 679 | """ |
| 680 | Set the passphrase callback |
| 681 | |
| 682 | :param callback: The Python callback to use |
| 683 | :param userdata: (optional) A Python object which will be given as |
| 684 | argument to the callback |
| 685 | :return: None |
| 686 | """ |
| 687 | if not callable(callback): |
| 688 | raise TypeError("callback must be callable") |
| 689 | |
| 690 | self._passphrase_helper = self._wrap_callback(callback) |
| 691 | self._passphrase_callback = self._passphrase_helper.callback |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 692 | _lib.SSL_CTX_set_default_passwd_cb( |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 693 | self._context, self._passphrase_callback) |
| 694 | self._passphrase_userdata = userdata |
| 695 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 696 | def set_default_verify_paths(self): |
| 697 | """ |
| 698 | Use the platform-specific CA certificate locations |
| 699 | |
| 700 | :return: None |
| 701 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 702 | set_result = _lib.SSL_CTX_set_default_verify_paths(self._context) |
Alex Gaynor | 09f19f5 | 2016-07-03 09:54:09 -0400 | [diff] [blame] | 703 | _openssl_assert(set_result == 1) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 704 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 705 | def use_certificate_chain_file(self, certfile): |
| 706 | """ |
| 707 | Load a certificate chain from a file |
| 708 | |
Jean-Paul Calderone | b6f8a79 | 2015-04-13 10:10:06 -0400 | [diff] [blame] | 709 | :param certfile: The name of the certificate chain file (``bytes`` or |
| 710 | ``unicode``). |
| 711 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 712 | :return: None |
| 713 | """ |
Jean-Paul Calderone | aac43a3 | 2015-04-12 09:51:21 -0400 | [diff] [blame] | 714 | certfile = _path_string(certfile) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 715 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 716 | result = _lib.SSL_CTX_use_certificate_chain_file( |
| 717 | self._context, certfile |
| 718 | ) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 719 | if not result: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 720 | _raise_current_error() |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 721 | |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 722 | def use_certificate_file(self, certfile, filetype=FILETYPE_PEM): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 723 | """ |
| 724 | Load a certificate from a file |
| 725 | |
Jean-Paul Calderone | b6f8a79 | 2015-04-13 10:10:06 -0400 | [diff] [blame] | 726 | :param certfile: The name of the certificate file (``bytes`` or |
| 727 | ``unicode``). |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 728 | :param filetype: (optional) The encoding of the file, default is PEM |
Jean-Paul Calderone | b6f8a79 | 2015-04-13 10:10:06 -0400 | [diff] [blame] | 729 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 730 | :return: None |
| 731 | """ |
Jean-Paul Calderone | d57a7b6 | 2015-04-12 09:57:36 -0400 | [diff] [blame] | 732 | certfile = _path_string(certfile) |
Jean-Paul Calderone | f73a3cb | 2014-02-09 08:49:06 -0500 | [diff] [blame] | 733 | if not isinstance(filetype, integer_types): |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 734 | raise TypeError("filetype must be an integer") |
| 735 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 736 | use_result = _lib.SSL_CTX_use_certificate_file( |
| 737 | self._context, certfile, filetype |
| 738 | ) |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 739 | if not use_result: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 740 | _raise_current_error() |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 741 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 742 | def use_certificate(self, cert): |
| 743 | """ |
| 744 | Load a certificate from a X509 object |
| 745 | |
| 746 | :param cert: The X509 object |
| 747 | :return: None |
| 748 | """ |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 749 | if not isinstance(cert, X509): |
| 750 | raise TypeError("cert must be an X509 instance") |
| 751 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 752 | use_result = _lib.SSL_CTX_use_certificate(self._context, cert._x509) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 753 | if not use_result: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 754 | _raise_current_error() |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 755 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 756 | def add_extra_chain_cert(self, certobj): |
| 757 | """ |
| 758 | Add certificate to chain |
| 759 | |
| 760 | :param certobj: The X509 certificate object to add to the chain |
| 761 | :return: None |
| 762 | """ |
| 763 | if not isinstance(certobj, X509): |
| 764 | raise TypeError("certobj must be an X509 instance") |
| 765 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 766 | copy = _lib.X509_dup(certobj._x509) |
| 767 | add_result = _lib.SSL_CTX_add_extra_chain_cert(self._context, copy) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 768 | if not add_result: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 769 | # TODO: This is untested. |
| 770 | _lib.X509_free(copy) |
| 771 | _raise_current_error() |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 772 | |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 773 | def _raise_passphrase_exception(self): |
| 774 | if self._passphrase_helper is None: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 775 | _raise_current_error() |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 776 | exception = self._passphrase_helper.raise_if_problem(Error) |
| 777 | if exception is not None: |
| 778 | raise exception |
| 779 | |
Jean-Paul Calderone | 00f84eb | 2015-04-13 12:47:21 -0400 | [diff] [blame] | 780 | def use_privatekey_file(self, keyfile, filetype=_UNSPECIFIED): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 781 | """ |
| 782 | Load a private key from a file |
| 783 | |
Jean-Paul Calderone | b6f8a79 | 2015-04-13 10:10:06 -0400 | [diff] [blame] | 784 | :param keyfile: The name of the key file (``bytes`` or ``unicode``) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 785 | :param filetype: (optional) The encoding of the file, default is PEM |
Jean-Paul Calderone | b6f8a79 | 2015-04-13 10:10:06 -0400 | [diff] [blame] | 786 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 787 | :return: None |
| 788 | """ |
Jean-Paul Calderone | 69a4e5b | 2015-04-12 10:04:28 -0400 | [diff] [blame] | 789 | keyfile = _path_string(keyfile) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 790 | |
Jean-Paul Calderone | 00f84eb | 2015-04-13 12:47:21 -0400 | [diff] [blame] | 791 | if filetype is _UNSPECIFIED: |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 792 | filetype = FILETYPE_PEM |
Jean-Paul Calderone | f73a3cb | 2014-02-09 08:49:06 -0500 | [diff] [blame] | 793 | elif not isinstance(filetype, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 794 | raise TypeError("filetype must be an integer") |
| 795 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 796 | use_result = _lib.SSL_CTX_use_PrivateKey_file( |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 797 | self._context, keyfile, filetype) |
| 798 | if not use_result: |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 799 | self._raise_passphrase_exception() |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 800 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 801 | def use_privatekey(self, pkey): |
| 802 | """ |
| 803 | Load a private key from a PKey object |
| 804 | |
| 805 | :param pkey: The PKey object |
| 806 | :return: None |
| 807 | """ |
| 808 | if not isinstance(pkey, PKey): |
| 809 | raise TypeError("pkey must be a PKey instance") |
| 810 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 811 | use_result = _lib.SSL_CTX_use_PrivateKey(self._context, pkey._pkey) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 812 | if not use_result: |
Jean-Paul Calderone | 173cff9 | 2013-03-06 10:29:21 -0800 | [diff] [blame] | 813 | self._raise_passphrase_exception() |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 814 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 815 | def check_privatekey(self): |
| 816 | """ |
| 817 | Check that the private key and certificate match up |
| 818 | |
| 819 | :return: None (raises an exception if something's wrong) |
| 820 | """ |
Jean-Paul Calderone | a034492 | 2014-12-11 14:02:31 -0500 | [diff] [blame] | 821 | if not _lib.SSL_CTX_check_private_key(self._context): |
| 822 | _raise_current_error() |
| 823 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 824 | def load_client_ca(self, cafile): |
| 825 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 826 | Load the trusted certificates that will be sent to the client. Does |
| 827 | not actually imply any of the certificates are trusted; that must be |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 828 | configured separately. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 829 | |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 830 | :param bytes cafile: The path to a certificates file in PEM format. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 831 | :return: None |
| 832 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 833 | ca_list = _lib.SSL_load_client_CA_file( |
| 834 | _text_to_bytes_and_warn("cafile", cafile) |
| 835 | ) |
| 836 | _openssl_assert(ca_list != _ffi.NULL) |
| 837 | # SSL_CTX_set_client_CA_list doesn't return anything. |
| 838 | _lib.SSL_CTX_set_client_CA_list(self._context, ca_list) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 839 | |
| 840 | def set_session_id(self, buf): |
| 841 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 842 | Set the session id to *buf* within which a session can be reused for |
| 843 | this Context object. This is needed when doing session resumption, |
| 844 | because there is no way for a stored session to know which Context |
| 845 | object it is associated with. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 846 | |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 847 | :param bytes buf: The session id. |
| 848 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 849 | :returns: None |
| 850 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 851 | buf = _text_to_bytes_and_warn("buf", buf) |
| 852 | _openssl_assert( |
| 853 | _lib.SSL_CTX_set_session_id_context( |
| 854 | self._context, |
| 855 | buf, |
| 856 | len(buf), |
| 857 | ) == 1 |
| 858 | ) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 859 | |
| 860 | def set_session_cache_mode(self, mode): |
| 861 | """ |
| 862 | Enable/disable session caching and specify the mode used. |
| 863 | |
| 864 | :param mode: One or more of the SESS_CACHE_* flags (combine using |
| 865 | bitwise or) |
| 866 | :returns: The previously set caching mode. |
| 867 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 868 | if not isinstance(mode, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 869 | raise TypeError("mode must be an integer") |
| 870 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 871 | return _lib.SSL_CTX_set_session_cache_mode(self._context, mode) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 872 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 873 | def get_session_cache_mode(self): |
| 874 | """ |
| 875 | :returns: The currently used cache mode. |
| 876 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 877 | return _lib.SSL_CTX_get_session_cache_mode(self._context) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 878 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 879 | def set_verify(self, mode, callback): |
| 880 | """ |
| 881 | Set the verify mode and verify callback |
| 882 | |
| 883 | :param mode: The verify mode, this is either VERIFY_NONE or |
| 884 | VERIFY_PEER combined with possible other flags |
| 885 | :param callback: The Python callback to use |
| 886 | :return: None |
| 887 | |
| 888 | See SSL_CTX_set_verify(3SSL) for further details. |
| 889 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 890 | if not isinstance(mode, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 891 | raise TypeError("mode must be an integer") |
| 892 | |
| 893 | if not callable(callback): |
| 894 | raise TypeError("callback must be callable") |
| 895 | |
Jean-Paul Calderone | 6a8cd11 | 2014-04-02 21:09:08 -0400 | [diff] [blame] | 896 | self._verify_helper = _VerifyHelper(callback) |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 897 | self._verify_callback = self._verify_helper.callback |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 898 | _lib.SSL_CTX_set_verify(self._context, mode, self._verify_callback) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 899 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 900 | def set_verify_depth(self, depth): |
| 901 | """ |
| 902 | Set the verify depth |
| 903 | |
| 904 | :param depth: An integer specifying the verify depth |
| 905 | :return: None |
| 906 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 907 | if not isinstance(depth, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 908 | raise TypeError("depth must be an integer") |
| 909 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 910 | _lib.SSL_CTX_set_verify_depth(self._context, depth) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 911 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 912 | def get_verify_mode(self): |
| 913 | """ |
| 914 | Get the verify mode |
| 915 | |
| 916 | :return: The verify mode |
| 917 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 918 | return _lib.SSL_CTX_get_verify_mode(self._context) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 919 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 920 | def get_verify_depth(self): |
| 921 | """ |
| 922 | Get the verify depth |
| 923 | |
| 924 | :return: The verify depth |
| 925 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 926 | return _lib.SSL_CTX_get_verify_depth(self._context) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 927 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 928 | def load_tmp_dh(self, dhfile): |
| 929 | """ |
| 930 | Load parameters for Ephemeral Diffie-Hellman |
| 931 | |
Jean-Paul Calderone | 4e0c43f | 2015-04-13 10:15:17 -0400 | [diff] [blame] | 932 | :param dhfile: The file to load EDH parameters from (``bytes`` or |
| 933 | ``unicode``). |
| 934 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 935 | :return: None |
| 936 | """ |
Jean-Paul Calderone | 9e1c1dd | 2015-04-12 10:13:13 -0400 | [diff] [blame] | 937 | dhfile = _path_string(dhfile) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 938 | |
Jean-Paul Calderone | 4f0467a | 2014-01-11 11:58:41 -0500 | [diff] [blame] | 939 | bio = _lib.BIO_new_file(dhfile, b"r") |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 940 | if bio == _ffi.NULL: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 941 | _raise_current_error() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 942 | bio = _ffi.gc(bio, _lib.BIO_free) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 943 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 944 | dh = _lib.PEM_read_bio_DHparams(bio, _ffi.NULL, _ffi.NULL, _ffi.NULL) |
| 945 | dh = _ffi.gc(dh, _lib.DH_free) |
| 946 | _lib.SSL_CTX_set_tmp_dh(self._context, dh) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 947 | |
Jean-Paul Calderone | 3e4e335 | 2014-04-19 09:28:28 -0400 | [diff] [blame] | 948 | def set_tmp_ecdh(self, curve): |
Alex Gaynor | 7b8d57a | 2014-01-17 12:08:54 -0600 | [diff] [blame] | 949 | """ |
Andy Lutomirski | 76a6133 | 2014-03-12 15:02:56 -0700 | [diff] [blame] | 950 | Select a curve to use for ECDHE key exchange. |
Alex Gaynor | 7b8d57a | 2014-01-17 12:08:54 -0600 | [diff] [blame] | 951 | |
Jean-Paul Calderone | c09fd58 | 2014-04-18 22:00:10 -0400 | [diff] [blame] | 952 | :param curve: A curve object to use as returned by either |
| 953 | :py:meth:`OpenSSL.crypto.get_elliptic_curve` or |
| 954 | :py:meth:`OpenSSL.crypto.get_elliptic_curves`. |
Andy Lutomirski | f05a273 | 2014-03-13 17:22:25 -0700 | [diff] [blame] | 955 | |
Alex Gaynor | 7b8d57a | 2014-01-17 12:08:54 -0600 | [diff] [blame] | 956 | :return: None |
| 957 | """ |
Jean-Paul Calderone | c09fd58 | 2014-04-18 22:00:10 -0400 | [diff] [blame] | 958 | _lib.SSL_CTX_set_tmp_ecdh(self._context, curve._to_EC_KEY()) |
Alex Gaynor | 7b8d57a | 2014-01-17 12:08:54 -0600 | [diff] [blame] | 959 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 960 | def set_cipher_list(self, cipher_list): |
| 961 | """ |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 962 | Set the list of ciphers to be used in this context. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 963 | |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 964 | See the OpenSSL manual for more information (e.g. |
| 965 | :manpage:`ciphers(1)`). |
| 966 | |
| 967 | :param bytes cipher_list: An OpenSSL cipher string. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 968 | :return: None |
| 969 | """ |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 970 | cipher_list = _text_to_bytes_and_warn("cipher_list", cipher_list) |
Jean-Paul Calderone | 63eab69 | 2014-01-18 10:19:56 -0500 | [diff] [blame] | 971 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 972 | if not isinstance(cipher_list, bytes): |
Hynek Schlawack | a7a63af | 2016-03-11 12:05:26 +0100 | [diff] [blame] | 973 | raise TypeError("cipher_list must be a byte string.") |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 974 | |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 975 | _openssl_assert( |
Hynek Schlawack | 22a4b66 | 2016-03-11 14:59:39 +0100 | [diff] [blame] | 976 | _lib.SSL_CTX_set_cipher_list(self._context, cipher_list) == 1 |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 977 | ) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 978 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 979 | def set_client_ca_list(self, certificate_authorities): |
| 980 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 981 | Set the list of preferred client certificate signers for this server |
| 982 | context. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 983 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 984 | This list of certificate authorities will be sent to the client when |
| 985 | the server requests a client certificate. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 986 | |
| 987 | :param certificate_authorities: a sequence of X509Names. |
| 988 | :return: None |
| 989 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 990 | name_stack = _lib.sk_X509_NAME_new_null() |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 991 | _openssl_assert(name_stack != _ffi.NULL) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 992 | |
| 993 | try: |
| 994 | for ca_name in certificate_authorities: |
| 995 | if not isinstance(ca_name, X509Name): |
| 996 | raise TypeError( |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 997 | "client CAs must be X509Name objects, not %s " |
| 998 | "objects" % ( |
| 999 | type(ca_name).__name__, |
| 1000 | ) |
| 1001 | ) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1002 | copy = _lib.X509_NAME_dup(ca_name._name) |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 1003 | _openssl_assert(copy != _ffi.NULL) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1004 | push_result = _lib.sk_X509_NAME_push(name_stack, copy) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1005 | if not push_result: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1006 | _lib.X509_NAME_free(copy) |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 1007 | _raise_current_error() |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1008 | except: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1009 | _lib.sk_X509_NAME_free(name_stack) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1010 | raise |
| 1011 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1012 | _lib.SSL_CTX_set_client_CA_list(self._context, name_stack) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1013 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1014 | def add_client_ca(self, certificate_authority): |
| 1015 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1016 | Add the CA certificate to the list of preferred signers for this |
| 1017 | context. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1018 | |
| 1019 | The list of certificate authorities will be sent to the client when the |
| 1020 | server requests a client certificate. |
| 1021 | |
| 1022 | :param certificate_authority: certificate authority's X509 certificate. |
| 1023 | :return: None |
| 1024 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1025 | if not isinstance(certificate_authority, X509): |
| 1026 | raise TypeError("certificate_authority must be an X509 instance") |
| 1027 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1028 | add_result = _lib.SSL_CTX_add_client_CA( |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1029 | self._context, certificate_authority._x509) |
Alex Gaynor | 09f19f5 | 2016-07-03 09:54:09 -0400 | [diff] [blame] | 1030 | _openssl_assert(add_result == 1) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1031 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1032 | def set_timeout(self, timeout): |
| 1033 | """ |
| 1034 | Set session timeout |
| 1035 | |
| 1036 | :param timeout: The timeout in seconds |
| 1037 | :return: The previous session timeout |
| 1038 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 1039 | if not isinstance(timeout, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1040 | raise TypeError("timeout must be an integer") |
| 1041 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1042 | return _lib.SSL_CTX_set_timeout(self._context, timeout) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1043 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1044 | def get_timeout(self): |
| 1045 | """ |
| 1046 | Get the session timeout |
| 1047 | |
| 1048 | :return: The session timeout |
| 1049 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1050 | return _lib.SSL_CTX_get_timeout(self._context) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1051 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1052 | def set_info_callback(self, callback): |
| 1053 | """ |
| 1054 | Set the info callback |
| 1055 | |
| 1056 | :param callback: The Python callback to use |
| 1057 | :return: None |
| 1058 | """ |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1059 | @wraps(callback) |
| 1060 | def wrapper(ssl, where, return_code): |
Jean-Paul Calderone | f2bbc9c | 2014-02-02 10:59:14 -0500 | [diff] [blame] | 1061 | callback(Connection._reverse_mapping[ssl], where, return_code) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1062 | self._info_callback = _ffi.callback( |
| 1063 | "void (*)(const SSL *, int, int)", wrapper) |
| 1064 | _lib.SSL_CTX_set_info_callback(self._context, self._info_callback) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1065 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1066 | def get_app_data(self): |
| 1067 | """ |
| 1068 | Get the application data (supplied via set_app_data()) |
| 1069 | |
| 1070 | :return: The application data |
| 1071 | """ |
| 1072 | return self._app_data |
| 1073 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1074 | def set_app_data(self, data): |
| 1075 | """ |
| 1076 | Set the application data (will be returned from get_app_data()) |
| 1077 | |
| 1078 | :param data: Any Python object |
| 1079 | :return: None |
| 1080 | """ |
| 1081 | self._app_data = data |
| 1082 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1083 | def get_cert_store(self): |
| 1084 | """ |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1085 | Get the certificate store for the context. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1086 | |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1087 | :return: A X509Store object or None if it does not have one. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1088 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1089 | store = _lib.SSL_CTX_get_cert_store(self._context) |
| 1090 | if store == _ffi.NULL: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1091 | # TODO: This is untested. |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1092 | return None |
| 1093 | |
| 1094 | pystore = X509Store.__new__(X509Store) |
| 1095 | pystore._store = store |
| 1096 | return pystore |
| 1097 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1098 | def set_options(self, options): |
| 1099 | """ |
| 1100 | Add options. Options set before are not cleared! |
| 1101 | |
| 1102 | :param options: The options to add. |
| 1103 | :return: The new option bitmask. |
| 1104 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 1105 | if not isinstance(options, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1106 | raise TypeError("options must be an integer") |
| 1107 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1108 | return _lib.SSL_CTX_set_options(self._context, options) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1109 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1110 | def set_mode(self, mode): |
| 1111 | """ |
| 1112 | Add modes via bitmask. Modes set before are not cleared! |
| 1113 | |
| 1114 | :param mode: The mode to add. |
| 1115 | :return: The new mode bitmask. |
| 1116 | """ |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 1117 | if not isinstance(mode, integer_types): |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1118 | raise TypeError("mode must be an integer") |
| 1119 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1120 | return _lib.SSL_CTX_set_mode(self._context, mode) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1121 | |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 1122 | @_requires_sni |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1123 | def set_tlsext_servername_callback(self, callback): |
| 1124 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1125 | Specify a callback function to be called when clients specify a server |
| 1126 | name. |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1127 | |
| 1128 | :param callback: The callback function. It will be invoked with one |
| 1129 | argument, the Connection instance. |
| 1130 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1131 | @wraps(callback) |
| 1132 | def wrapper(ssl, alert, arg): |
| 1133 | callback(Connection._reverse_mapping[ssl]) |
| 1134 | return 0 |
| 1135 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1136 | self._tlsext_servername_callback = _ffi.callback( |
| 1137 | "int (*)(const SSL *, int *, void *)", wrapper) |
| 1138 | _lib.SSL_CTX_set_tlsext_servername_callback( |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1139 | self._context, self._tlsext_servername_callback) |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1140 | |
Cory Benfield | 10b277f | 2015-04-13 17:12:42 -0400 | [diff] [blame] | 1141 | @_requires_npn |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1142 | def set_npn_advertise_callback(self, callback): |
| 1143 | """ |
Cory Benfield | be3e7b8 | 2014-05-10 09:48:55 +0100 | [diff] [blame] | 1144 | Specify a callback function that will be called when offering `Next |
| 1145 | Protocol Negotiation |
| 1146 | <https://technotes.googlecode.com/git/nextprotoneg.html>`_ as a server. |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1147 | |
| 1148 | :param callback: The callback function. It will be invoked with one |
Cory Benfield | be3e7b8 | 2014-05-10 09:48:55 +0100 | [diff] [blame] | 1149 | argument, the Connection instance. It should return a list of |
| 1150 | bytestrings representing the advertised protocols, like |
| 1151 | ``[b'http/1.1', b'spdy/2']``. |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1152 | """ |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 1153 | self._npn_advertise_helper = _NpnAdvertiseHelper(callback) |
| 1154 | self._npn_advertise_callback = self._npn_advertise_helper.callback |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1155 | _lib.SSL_CTX_set_next_protos_advertised_cb( |
| 1156 | self._context, self._npn_advertise_callback, _ffi.NULL) |
| 1157 | |
Cory Benfield | 10b277f | 2015-04-13 17:12:42 -0400 | [diff] [blame] | 1158 | @_requires_npn |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1159 | def set_npn_select_callback(self, callback): |
| 1160 | """ |
| 1161 | Specify a callback function that will be called when a server offers |
| 1162 | Next Protocol Negotiation options. |
| 1163 | |
| 1164 | :param callback: The callback function. It will be invoked with two |
| 1165 | arguments: the Connection, and a list of offered protocols as |
Cory Benfield | be3e7b8 | 2014-05-10 09:48:55 +0100 | [diff] [blame] | 1166 | bytestrings, e.g. ``[b'http/1.1', b'spdy/2']``. It should return |
| 1167 | one of those bytestrings, the chosen protocol. |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1168 | """ |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 1169 | self._npn_select_helper = _NpnSelectHelper(callback) |
| 1170 | self._npn_select_callback = self._npn_select_helper.callback |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 1171 | _lib.SSL_CTX_set_next_proto_select_cb( |
| 1172 | self._context, self._npn_select_callback, _ffi.NULL) |
| 1173 | |
Cory Benfield | 7907e33 | 2015-04-13 17:18:25 -0400 | [diff] [blame] | 1174 | @_requires_alpn |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1175 | def set_alpn_protos(self, protos): |
| 1176 | """ |
Cory Benfield | e8e9c38 | 2015-04-11 17:33:48 -0400 | [diff] [blame] | 1177 | Specify the clients ALPN protocol list. |
| 1178 | |
| 1179 | These protocols are offered to the server during protocol negotiation. |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1180 | |
| 1181 | :param protos: A list of the protocols to be offered to the server. |
| 1182 | This list should be a Python list of bytestrings representing the |
| 1183 | protocols to offer, e.g. ``[b'http/1.1', b'spdy/2']``. |
| 1184 | """ |
| 1185 | # Take the list of protocols and join them together, prefixing them |
| 1186 | # with their lengths. |
| 1187 | protostr = b''.join( |
| 1188 | chain.from_iterable((int2byte(len(p)), p) for p in protos) |
| 1189 | ) |
| 1190 | |
| 1191 | # Build a C string from the list. We don't need to save this off |
| 1192 | # because OpenSSL immediately copies the data out. |
| 1193 | input_str = _ffi.new("unsigned char[]", protostr) |
Cory Benfield | e871af5 | 2015-04-11 17:57:50 -0400 | [diff] [blame] | 1194 | input_str_len = _ffi.cast("unsigned", len(protostr)) |
| 1195 | _lib.SSL_CTX_set_alpn_protos(self._context, input_str, input_str_len) |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1196 | |
Cory Benfield | 7907e33 | 2015-04-13 17:18:25 -0400 | [diff] [blame] | 1197 | @_requires_alpn |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1198 | def set_alpn_select_callback(self, callback): |
| 1199 | """ |
Cory Benfield | e8e9c38 | 2015-04-11 17:33:48 -0400 | [diff] [blame] | 1200 | Set the callback to handle ALPN protocol choice. |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1201 | |
| 1202 | :param callback: The callback function. It will be invoked with two |
| 1203 | arguments: the Connection, and a list of offered protocols as |
| 1204 | bytestrings, e.g ``[b'http/1.1', b'spdy/2']``. It should return |
Cory Benfield | e8e9c38 | 2015-04-11 17:33:48 -0400 | [diff] [blame] | 1205 | one of those bytestrings, the chosen protocol. |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1206 | """ |
Cory Benfield | 9da5ffb | 2015-04-13 17:20:14 -0400 | [diff] [blame] | 1207 | self._alpn_select_helper = _ALPNSelectHelper(callback) |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 1208 | self._alpn_select_callback = self._alpn_select_helper.callback |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1209 | _lib.SSL_CTX_set_alpn_select_cb( |
| 1210 | self._context, self._alpn_select_callback, _ffi.NULL) |
| 1211 | |
Cory Benfield | 496652a | 2017-01-24 11:42:56 +0000 | [diff] [blame] | 1212 | def _set_ocsp_callback(self, helper, data): |
| 1213 | """ |
| 1214 | This internal helper does the common work for |
| 1215 | ``set_ocsp_server_callback`` and ``set_ocsp_client_callback``, which is |
| 1216 | almost all of it. |
| 1217 | """ |
| 1218 | self._ocsp_helper = helper |
| 1219 | self._ocsp_callback = helper.callback |
| 1220 | if data is None: |
| 1221 | self._ocsp_data = _ffi.NULL |
| 1222 | else: |
| 1223 | self._ocsp_data = _ffi.new_handle(data) |
| 1224 | |
| 1225 | rc = _lib.SSL_CTX_set_tlsext_status_cb( |
| 1226 | self._context, self._ocsp_callback |
| 1227 | ) |
| 1228 | _openssl_assert(rc == 1) |
| 1229 | rc = _lib.SSL_CTX_set_tlsext_status_arg(self._context, self._ocsp_data) |
| 1230 | _openssl_assert(rc == 1) |
| 1231 | |
| 1232 | def set_ocsp_server_callback(self, callback, data=None): |
| 1233 | """ |
| 1234 | Set a callback to provide OCSP data to be stapled to the TLS handshake |
| 1235 | on the server side. |
| 1236 | |
| 1237 | :param callback: The callback function. It will be invoked with two |
| 1238 | arguments: the Connection, and the optional arbitrary data you have |
| 1239 | provided. The callback must return a bytestring that contains the |
| 1240 | OCSP data to staple to the handshake. If no OCSP data is available |
| 1241 | for this connection, return the empty bytestring. |
| 1242 | :param data: Some opaque data that will be passed into the callback |
| 1243 | function when called. This can be used to avoid needing to do |
| 1244 | complex data lookups or to keep track of what context is being |
| 1245 | used. This parameter is optional. |
| 1246 | """ |
| 1247 | helper = _OCSPServerCallbackHelper(callback) |
| 1248 | self._set_ocsp_callback(helper, data) |
| 1249 | |
| 1250 | def set_ocsp_client_callback(self, callback, data=None): |
| 1251 | """ |
| 1252 | Set a callback to validate OCSP data stapled to the TLS handshake on |
| 1253 | the client side. |
| 1254 | |
| 1255 | :param callback: The callback function. It will be invoked with three |
| 1256 | arguments: the Connection, a bytestring containing the stapled OCSP |
| 1257 | assertion, and the optional arbitrary data you have provided. The |
| 1258 | callback must return a boolean that indicates the result of |
| 1259 | validating the OCSP data: ``True`` if the OCSP data is valid and |
| 1260 | the certificate can be trusted, or ``False`` if either the OCSP |
| 1261 | data is invalid or the certificate has been revoked. |
| 1262 | :param data: Some opaque data that will be passed into the callback |
| 1263 | function when called. This can be used to avoid needing to do |
| 1264 | complex data lookups or to keep track of what context is being |
| 1265 | used. This parameter is optional. |
| 1266 | """ |
| 1267 | helper = _OCSPClientCallbackHelper(callback) |
| 1268 | self._set_ocsp_callback(helper, data) |
| 1269 | |
Alex Chan | c607706 | 2016-11-18 13:53:39 +0000 | [diff] [blame] | 1270 | |
Jean-Paul Calderone | 8a1bea5 | 2013-03-05 07:57:57 -0800 | [diff] [blame] | 1271 | ContextType = Context |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1272 | |
| 1273 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1274 | class Connection(object): |
| 1275 | """ |
| 1276 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1277 | _reverse_mapping = WeakValueDictionary() |
| 1278 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1279 | def __init__(self, context, socket=None): |
| 1280 | """ |
| 1281 | Create a new Connection object, using the given OpenSSL.SSL.Context |
| 1282 | instance and socket. |
| 1283 | |
| 1284 | :param context: An SSL Context to use for this connection |
| 1285 | :param socket: The socket to use for transport layer |
| 1286 | """ |
| 1287 | if not isinstance(context, Context): |
| 1288 | raise TypeError("context must be a Context instance") |
| 1289 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1290 | ssl = _lib.SSL_new(context._context) |
| 1291 | self._ssl = _ffi.gc(ssl, _lib.SSL_free) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1292 | self._context = context |
Todd Chapman | 4f73e4f | 2015-08-27 11:26:43 -0400 | [diff] [blame] | 1293 | self._app_data = None |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1294 | |
Cory Benfield | be3e7b8 | 2014-05-10 09:48:55 +0100 | [diff] [blame] | 1295 | # References to strings used for Next Protocol Negotiation. OpenSSL's |
| 1296 | # header files suggest that these might get copied at some point, but |
| 1297 | # doesn't specify when, so we store them here to make sure they don't |
| 1298 | # get freed before OpenSSL uses them. |
| 1299 | self._npn_advertise_callback_args = None |
| 1300 | self._npn_select_callback_args = None |
| 1301 | |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 1302 | # References to strings used for Application Layer Protocol |
| 1303 | # Negotiation. These strings get copied at some point but it's well |
| 1304 | # after the callback returns, so we have to hang them somewhere to |
| 1305 | # avoid them getting freed. |
| 1306 | self._alpn_select_callback_args = None |
| 1307 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1308 | self._reverse_mapping[self._ssl] = self |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1309 | |
| 1310 | if socket is None: |
| 1311 | self._socket = None |
Jean-Paul Calderone | 73b15c2 | 2013-03-05 18:30:39 -0800 | [diff] [blame] | 1312 | # Don't set up any gc for these, SSL_free will take care of them. |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1313 | self._into_ssl = _lib.BIO_new(_lib.BIO_s_mem()) |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 1314 | _openssl_assert(self._into_ssl != _ffi.NULL) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1315 | |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 1316 | self._from_ssl = _lib.BIO_new(_lib.BIO_s_mem()) |
| 1317 | _openssl_assert(self._from_ssl != _ffi.NULL) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1318 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1319 | _lib.SSL_set_bio(self._ssl, self._into_ssl, self._from_ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1320 | else: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1321 | self._into_ssl = None |
| 1322 | self._from_ssl = None |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1323 | self._socket = socket |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1324 | set_result = _lib.SSL_set_fd( |
| 1325 | self._ssl, _asFileDescriptor(self._socket)) |
Alex Gaynor | 09f19f5 | 2016-07-03 09:54:09 -0400 | [diff] [blame] | 1326 | _openssl_assert(set_result == 1) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1327 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1328 | def __getattr__(self, name): |
| 1329 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1330 | Look up attributes on the wrapped socket object if they are not found |
| 1331 | on the Connection object. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1332 | """ |
kjav | 0b66fa1 | 2015-09-02 11:51:26 +0100 | [diff] [blame] | 1333 | if self._socket is None: |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1334 | raise AttributeError("'%s' object has no attribute '%s'" % ( |
| 1335 | self.__class__.__name__, name |
| 1336 | )) |
kjav | 0b66fa1 | 2015-09-02 11:51:26 +0100 | [diff] [blame] | 1337 | else: |
| 1338 | return getattr(self._socket, name) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1339 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1340 | def _raise_ssl_error(self, ssl, result): |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 1341 | if self._context._verify_helper is not None: |
| 1342 | self._context._verify_helper.raise_if_problem() |
Cory Benfield | 0ea76e7 | 2015-03-22 09:05:28 +0000 | [diff] [blame] | 1343 | if self._context._npn_advertise_helper is not None: |
| 1344 | self._context._npn_advertise_helper.raise_if_problem() |
| 1345 | if self._context._npn_select_helper is not None: |
| 1346 | self._context._npn_select_helper.raise_if_problem() |
Cory Benfield | f1177e7 | 2015-04-12 09:11:49 -0400 | [diff] [blame] | 1347 | if self._context._alpn_select_helper is not None: |
| 1348 | self._context._alpn_select_helper.raise_if_problem() |
Cory Benfield | 496652a | 2017-01-24 11:42:56 +0000 | [diff] [blame] | 1349 | if self._context._ocsp_helper is not None: |
| 1350 | self._context._ocsp_helper.raise_if_problem() |
Jean-Paul Calderone | 7e166fe | 2013-03-06 20:54:38 -0800 | [diff] [blame] | 1351 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1352 | error = _lib.SSL_get_error(ssl, result) |
| 1353 | if error == _lib.SSL_ERROR_WANT_READ: |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1354 | raise WantReadError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1355 | elif error == _lib.SSL_ERROR_WANT_WRITE: |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1356 | raise WantWriteError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1357 | elif error == _lib.SSL_ERROR_ZERO_RETURN: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1358 | raise ZeroReturnError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1359 | elif error == _lib.SSL_ERROR_WANT_X509_LOOKUP: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1360 | # TODO: This is untested. |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1361 | raise WantX509LookupError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1362 | elif error == _lib.SSL_ERROR_SYSCALL: |
| 1363 | if _lib.ERR_peek_error() == 0: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1364 | if result < 0: |
Konstantinos Koukopoulos | 541150d | 2014-01-31 01:00:19 +0200 | [diff] [blame] | 1365 | if platform == "win32": |
| 1366 | errno = _ffi.getwinerror()[0] |
| 1367 | else: |
| 1368 | errno = _ffi.errno |
Alex Gaynor | 5af32d0 | 2016-09-24 01:52:21 -0400 | [diff] [blame] | 1369 | |
| 1370 | if errno != 0: |
| 1371 | raise SysCallError(errno, errorcode.get(errno)) |
| 1372 | raise SysCallError(-1, "Unexpected EOF") |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1373 | else: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1374 | # TODO: This is untested. |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 1375 | _raise_current_error() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1376 | elif error == _lib.SSL_ERROR_NONE: |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1377 | pass |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1378 | else: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 1379 | _raise_current_error() |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1380 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1381 | def get_context(self): |
| 1382 | """ |
| 1383 | Get session context |
| 1384 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1385 | return self._context |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1386 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1387 | def set_context(self, context): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1388 | """ |
| 1389 | Switch this connection to a new session context |
| 1390 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1391 | :param context: A :py:class:`Context` instance giving the new session |
| 1392 | context to use. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1393 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1394 | if not isinstance(context, Context): |
| 1395 | raise TypeError("context must be a Context instance") |
| 1396 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1397 | _lib.SSL_set_SSL_CTX(self._ssl, context._context) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1398 | self._context = context |
| 1399 | |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 1400 | @_requires_sni |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1401 | def get_servername(self): |
| 1402 | """ |
| 1403 | Retrieve the servername extension value if provided in the client hello |
| 1404 | message, or None if there wasn't one. |
| 1405 | |
| 1406 | :return: A byte string giving the server name or :py:data:`None`. |
| 1407 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1408 | name = _lib.SSL_get_servername( |
| 1409 | self._ssl, _lib.TLSEXT_NAMETYPE_host_name |
| 1410 | ) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1411 | if name == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1412 | return None |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1413 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1414 | return _ffi.string(name) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1415 | |
Cory Benfield | e6f3588 | 2016-03-29 11:21:04 +0100 | [diff] [blame] | 1416 | @_requires_sni |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1417 | def set_tlsext_host_name(self, name): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1418 | """ |
| 1419 | Set the value of the servername extension to send in the client hello. |
| 1420 | |
| 1421 | :param name: A byte string giving the name. |
| 1422 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1423 | if not isinstance(name, bytes): |
| 1424 | raise TypeError("name must be a byte string") |
Jean-Paul Calderone | 4f0467a | 2014-01-11 11:58:41 -0500 | [diff] [blame] | 1425 | elif b"\0" in name: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1426 | raise TypeError("name must not contain NUL byte") |
| 1427 | |
| 1428 | # XXX I guess this can fail sometimes? |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1429 | _lib.SSL_set_tlsext_host_name(self._ssl, name) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1430 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1431 | def pending(self): |
| 1432 | """ |
| 1433 | Get the number of bytes that can be safely read from the connection |
| 1434 | |
| 1435 | :return: The number of bytes available in the receive buffer. |
| 1436 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1437 | return _lib.SSL_pending(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1438 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1439 | def send(self, buf, flags=0): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1440 | """ |
| 1441 | Send data on the connection. NOTE: If you get one of the WantRead, |
| 1442 | WantWrite or WantX509Lookup exceptions on this, you have to call the |
| 1443 | method again with the SAME buffer. |
| 1444 | |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1445 | :param buf: The string, buffer or memoryview to send |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1446 | :param flags: (optional) Included for compatibility with the socket |
| 1447 | API, the value is ignored |
| 1448 | :return: The number of bytes written |
| 1449 | """ |
Abraham Martin | e82326c | 2015-02-04 10:18:10 +0000 | [diff] [blame] | 1450 | # Backward compatibility |
Jean-Paul Calderone | 39a8d59 | 2015-04-13 20:49:50 -0400 | [diff] [blame] | 1451 | buf = _text_to_bytes_and_warn("buf", buf) |
Abraham Martin | e82326c | 2015-02-04 10:18:10 +0000 | [diff] [blame] | 1452 | |
Jean-Paul Calderone | 8fb5318 | 2013-12-30 08:35:49 -0500 | [diff] [blame] | 1453 | if isinstance(buf, _memoryview): |
Jean-Paul Calderone | 1aba416 | 2013-03-05 18:50:00 -0800 | [diff] [blame] | 1454 | buf = buf.tobytes() |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1455 | if isinstance(buf, _buffer): |
| 1456 | buf = str(buf) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1457 | if not isinstance(buf, bytes): |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1458 | raise TypeError("data must be a memoryview, buffer or byte string") |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1459 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1460 | result = _lib.SSL_write(self._ssl, buf, len(buf)) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1461 | self._raise_ssl_error(self._ssl, result) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1462 | return result |
| 1463 | write = send |
| 1464 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1465 | def sendall(self, buf, flags=0): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1466 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1467 | Send "all" data on the connection. This calls send() repeatedly until |
| 1468 | all data is sent. If an error occurs, it's impossible to tell how much |
| 1469 | data has been sent. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1470 | |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1471 | :param buf: The string, buffer or memoryview to send |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1472 | :param flags: (optional) Included for compatibility with the socket |
| 1473 | API, the value is ignored |
| 1474 | :return: The number of bytes written |
| 1475 | """ |
Jean-Paul Calderone | 39a8d59 | 2015-04-13 20:49:50 -0400 | [diff] [blame] | 1476 | buf = _text_to_bytes_and_warn("buf", buf) |
Abraham Martin | e82326c | 2015-02-04 10:18:10 +0000 | [diff] [blame] | 1477 | |
Jean-Paul Calderone | 8fb5318 | 2013-12-30 08:35:49 -0500 | [diff] [blame] | 1478 | if isinstance(buf, _memoryview): |
Jean-Paul Calderone | 1aba416 | 2013-03-05 18:50:00 -0800 | [diff] [blame] | 1479 | buf = buf.tobytes() |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1480 | if isinstance(buf, _buffer): |
| 1481 | buf = str(buf) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1482 | if not isinstance(buf, bytes): |
Markus Unterwaditzer | 8e41d02 | 2014-04-19 12:27:11 +0200 | [diff] [blame] | 1483 | raise TypeError("buf must be a memoryview, buffer or byte string") |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1484 | |
| 1485 | left_to_send = len(buf) |
| 1486 | total_sent = 0 |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1487 | data = _ffi.new("char[]", buf) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1488 | |
| 1489 | while left_to_send: |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1490 | result = _lib.SSL_write(self._ssl, data + total_sent, left_to_send) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1491 | self._raise_ssl_error(self._ssl, result) |
| 1492 | total_sent += result |
| 1493 | left_to_send -= result |
| 1494 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1495 | def recv(self, bufsiz, flags=None): |
| 1496 | """ |
Alex Gaynor | 67fc8c9 | 2016-05-27 08:27:19 -0400 | [diff] [blame] | 1497 | Receive data on the connection. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1498 | |
| 1499 | :param bufsiz: The maximum number of bytes to read |
Maximilian Hils | 1d95dea | 2015-08-17 19:27:20 +0200 | [diff] [blame] | 1500 | :param flags: (optional) The only supported flag is ``MSG_PEEK``, |
| 1501 | all other flags are ignored. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1502 | :return: The string read from the Connection |
| 1503 | """ |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1504 | buf = _no_zero_allocator("char[]", bufsiz) |
Maximilian Hils | 1d95dea | 2015-08-17 19:27:20 +0200 | [diff] [blame] | 1505 | if flags is not None and flags & socket.MSG_PEEK: |
| 1506 | result = _lib.SSL_peek(self._ssl, buf, bufsiz) |
| 1507 | else: |
| 1508 | result = _lib.SSL_read(self._ssl, buf, bufsiz) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1509 | self._raise_ssl_error(self._ssl, result) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1510 | return _ffi.buffer(buf, result)[:] |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1511 | read = recv |
| 1512 | |
Cory Benfield | 62d1033 | 2014-06-15 10:03:41 +0100 | [diff] [blame] | 1513 | def recv_into(self, buffer, nbytes=None, flags=None): |
| 1514 | """ |
| 1515 | Receive data on the connection and store the data into a buffer rather |
| 1516 | than creating a new string. |
| 1517 | |
| 1518 | :param buffer: The buffer to copy into. |
| 1519 | :param nbytes: (optional) The maximum number of bytes to read into the |
| 1520 | buffer. If not present, defaults to the size of the buffer. If |
| 1521 | larger than the size of the buffer, is reduced to the size of the |
| 1522 | buffer. |
Maximilian Hils | 1d95dea | 2015-08-17 19:27:20 +0200 | [diff] [blame] | 1523 | :param flags: (optional) The only supported flag is ``MSG_PEEK``, |
| 1524 | all other flags are ignored. |
Cory Benfield | 62d1033 | 2014-06-15 10:03:41 +0100 | [diff] [blame] | 1525 | :return: The number of bytes read into the buffer. |
| 1526 | """ |
| 1527 | if nbytes is None: |
| 1528 | nbytes = len(buffer) |
| 1529 | else: |
| 1530 | nbytes = min(nbytes, len(buffer)) |
| 1531 | |
| 1532 | # We need to create a temporary buffer. This is annoying, it would be |
| 1533 | # better if we could pass memoryviews straight into the SSL_read call, |
| 1534 | # but right now we can't. Revisit this if CFFI gets that ability. |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1535 | buf = _no_zero_allocator("char[]", nbytes) |
Maximilian Hils | 1d95dea | 2015-08-17 19:27:20 +0200 | [diff] [blame] | 1536 | if flags is not None and flags & socket.MSG_PEEK: |
| 1537 | result = _lib.SSL_peek(self._ssl, buf, nbytes) |
| 1538 | else: |
| 1539 | result = _lib.SSL_read(self._ssl, buf, nbytes) |
Cory Benfield | 62d1033 | 2014-06-15 10:03:41 +0100 | [diff] [blame] | 1540 | self._raise_ssl_error(self._ssl, result) |
| 1541 | |
| 1542 | # This strange line is all to avoid a memory copy. The buffer protocol |
| 1543 | # should allow us to assign a CFFI buffer to the LHS of this line, but |
| 1544 | # on CPython 3.3+ that segfaults. As a workaround, we can temporarily |
| 1545 | # wrap it in a memoryview, except on Python 2.6 which doesn't have a |
| 1546 | # memoryview type. |
| 1547 | try: |
| 1548 | buffer[:result] = memoryview(_ffi.buffer(buf, result)) |
| 1549 | except NameError: |
| 1550 | buffer[:result] = _ffi.buffer(buf, result) |
| 1551 | |
| 1552 | return result |
| 1553 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1554 | def _handle_bio_errors(self, bio, result): |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1555 | if _lib.BIO_should_retry(bio): |
| 1556 | if _lib.BIO_should_read(bio): |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1557 | raise WantReadError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1558 | elif _lib.BIO_should_write(bio): |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1559 | # TODO: This is untested. |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1560 | raise WantWriteError() |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1561 | elif _lib.BIO_should_io_special(bio): |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1562 | # TODO: This is untested. I think io_special means the socket |
| 1563 | # BIO has a not-yet connected socket. |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1564 | raise ValueError("BIO_should_io_special") |
| 1565 | else: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1566 | # TODO: This is untested. |
Jean-Paul Calderone | d899af0 | 2013-03-19 22:10:37 -0700 | [diff] [blame] | 1567 | raise ValueError("unknown bio failure") |
| 1568 | else: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1569 | # TODO: This is untested. |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 1570 | _raise_current_error() |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1571 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1572 | def bio_read(self, bufsiz): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1573 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1574 | When using non-socket connections this function reads the "dirty" data |
| 1575 | that would have traveled away on the network. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1576 | |
| 1577 | :param bufsiz: The maximum number of bytes to read |
| 1578 | :return: The string read. |
| 1579 | """ |
Jean-Paul Calderone | 97e041d | 2013-03-05 21:03:12 -0800 | [diff] [blame] | 1580 | if self._from_ssl is None: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1581 | raise TypeError("Connection sock was not None") |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1582 | |
Jean-Paul Calderone | bef4f4c | 2014-02-02 18:13:31 -0500 | [diff] [blame] | 1583 | if not isinstance(bufsiz, integer_types): |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1584 | raise TypeError("bufsiz must be an integer") |
| 1585 | |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1586 | buf = _no_zero_allocator("char[]", bufsiz) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1587 | result = _lib.BIO_read(self._from_ssl, buf, bufsiz) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1588 | if result <= 0: |
| 1589 | self._handle_bio_errors(self._from_ssl, result) |
| 1590 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1591 | return _ffi.buffer(buf, result)[:] |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1592 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1593 | def bio_write(self, buf): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1594 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1595 | When using non-socket connections this function sends "dirty" data that |
| 1596 | would have traveled in on the network. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1597 | |
| 1598 | :param buf: The string to put into the memory BIO. |
| 1599 | :return: The number of bytes written |
| 1600 | """ |
Jean-Paul Calderone | 39a8d59 | 2015-04-13 20:49:50 -0400 | [diff] [blame] | 1601 | buf = _text_to_bytes_and_warn("buf", buf) |
Abraham Martin | e82326c | 2015-02-04 10:18:10 +0000 | [diff] [blame] | 1602 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1603 | if self._into_ssl is None: |
| 1604 | raise TypeError("Connection sock was not None") |
| 1605 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1606 | result = _lib.BIO_write(self._into_ssl, buf, len(buf)) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1607 | if result <= 0: |
| 1608 | self._handle_bio_errors(self._into_ssl, result) |
| 1609 | return result |
| 1610 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1611 | def renegotiate(self): |
| 1612 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1613 | Renegotiate the session. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1614 | |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1615 | :return: True if the renegotiation can be started, False otherwise |
| 1616 | :rtype: bool |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1617 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1618 | if not self.renegotiate_pending(): |
| 1619 | _openssl_assert(_lib.SSL_renegotiate(self._ssl) == 1) |
| 1620 | return True |
| 1621 | return False |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1622 | |
| 1623 | def do_handshake(self): |
| 1624 | """ |
| 1625 | Perform an SSL handshake (usually called after renegotiate() or one of |
| 1626 | set_*_state()). This can raise the same exceptions as send and recv. |
| 1627 | |
| 1628 | :return: None. |
| 1629 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1630 | result = _lib.SSL_do_handshake(self._ssl) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1631 | self._raise_ssl_error(self._ssl, result) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1632 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1633 | def renegotiate_pending(self): |
| 1634 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1635 | Check if there's a renegotiation in progress, it will return False once |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1636 | a renegotiation is finished. |
| 1637 | |
| 1638 | :return: Whether there's a renegotiation in progress |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1639 | :rtype: bool |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1640 | """ |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1641 | return _lib.SSL_renegotiate_pending(self._ssl) == 1 |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1642 | |
| 1643 | def total_renegotiations(self): |
| 1644 | """ |
| 1645 | Find out the total number of renegotiations. |
| 1646 | |
| 1647 | :return: The number of renegotiations. |
Hynek Schlawack | b1f3ca8 | 2016-02-13 09:10:04 +0100 | [diff] [blame] | 1648 | :rtype: int |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1649 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1650 | return _lib.SSL_total_renegotiations(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1651 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1652 | def connect(self, addr): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1653 | """ |
| 1654 | Connect to remote host and set up client-side SSL |
| 1655 | |
| 1656 | :param addr: A remote address |
| 1657 | :return: What the socket's connect method returns |
| 1658 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1659 | _lib.SSL_set_connect_state(self._ssl) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1660 | return self._socket.connect(addr) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1661 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1662 | def connect_ex(self, addr): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1663 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1664 | Connect to remote host and set up client-side SSL. Note that if the |
| 1665 | socket's connect_ex method doesn't return 0, SSL won't be initialized. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1666 | |
| 1667 | :param addr: A remove address |
| 1668 | :return: What the socket's connect_ex method returns |
| 1669 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1670 | connect_ex = self._socket.connect_ex |
| 1671 | self.set_connect_state() |
| 1672 | return connect_ex(addr) |
| 1673 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1674 | def accept(self): |
| 1675 | """ |
| 1676 | Accept incoming connection and set up SSL on it |
| 1677 | |
| 1678 | :return: A (conn,addr) pair where conn is a Connection and addr is an |
| 1679 | address |
| 1680 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1681 | client, addr = self._socket.accept() |
| 1682 | conn = Connection(self._context, client) |
| 1683 | conn.set_accept_state() |
| 1684 | return (conn, addr) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1685 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1686 | def bio_shutdown(self): |
| 1687 | """ |
| 1688 | When using non-socket connections this function signals end of |
| 1689 | data on the input for this connection. |
| 1690 | |
| 1691 | :return: None |
| 1692 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1693 | if self._from_ssl is None: |
| 1694 | raise TypeError("Connection sock was not None") |
| 1695 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1696 | _lib.BIO_set_mem_eof_return(self._into_ssl, 0) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1697 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1698 | def shutdown(self): |
| 1699 | """ |
| 1700 | Send closure alert |
| 1701 | |
| 1702 | :return: True if the shutdown completed successfully (i.e. both sides |
| 1703 | have sent closure alerts), false otherwise (i.e. you have to |
| 1704 | wait for a ZeroReturnError on a recv() method call |
| 1705 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1706 | result = _lib.SSL_shutdown(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1707 | if result < 0: |
Paul Aurich | bff1d1a | 2015-01-08 08:36:53 -0800 | [diff] [blame] | 1708 | self._raise_ssl_error(self._ssl, result) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1709 | elif result > 0: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1710 | return True |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1711 | else: |
| 1712 | return False |
| 1713 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1714 | def get_cipher_list(self): |
| 1715 | """ |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 1716 | Retrieve the list of ciphers used by the Connection object. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1717 | |
Hynek Schlawack | f90e368 | 2016-03-11 11:21:13 +0100 | [diff] [blame] | 1718 | :return: A list of native cipher strings. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1719 | """ |
| 1720 | ciphers = [] |
| 1721 | for i in count(): |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1722 | result = _lib.SSL_get_cipher_list(self._ssl, i) |
| 1723 | if result == _ffi.NULL: |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1724 | break |
Jean-Paul Calderone | 4f0467a | 2014-01-11 11:58:41 -0500 | [diff] [blame] | 1725 | ciphers.append(_native(_ffi.string(result))) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1726 | return ciphers |
| 1727 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1728 | def get_client_ca_list(self): |
| 1729 | """ |
| 1730 | Get CAs whose certificates are suggested for client authentication. |
| 1731 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1732 | :return: If this is a server connection, a list of X509Names |
| 1733 | representing the acceptable CAs as set by |
| 1734 | :py:meth:`OpenSSL.SSL.Context.set_client_ca_list` or |
| 1735 | :py:meth:`OpenSSL.SSL.Context.add_client_ca`. If this is a client |
| 1736 | connection, the list of such X509Names sent by the server, or an |
| 1737 | empty list if that has not yet happened. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1738 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1739 | ca_names = _lib.SSL_get_client_CA_list(self._ssl) |
| 1740 | if ca_names == _ffi.NULL: |
Jean-Paul Calderone | a9f84ad | 2013-12-29 17:06:11 -0500 | [diff] [blame] | 1741 | # TODO: This is untested. |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1742 | return [] |
| 1743 | |
| 1744 | result = [] |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1745 | for i in range(_lib.sk_X509_NAME_num(ca_names)): |
| 1746 | name = _lib.sk_X509_NAME_value(ca_names, i) |
| 1747 | copy = _lib.X509_NAME_dup(name) |
Alex Gaynor | a829e90 | 2016-06-04 18:16:01 -0700 | [diff] [blame] | 1748 | _openssl_assert(copy != _ffi.NULL) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1749 | |
| 1750 | pyname = X509Name.__new__(X509Name) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1751 | pyname._name = _ffi.gc(copy, _lib.X509_NAME_free) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1752 | result.append(pyname) |
| 1753 | return result |
| 1754 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1755 | def makefile(self): |
| 1756 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1757 | The makefile() method is not implemented, since there is no dup |
| 1758 | semantics for SSL connections |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1759 | |
Jean-Paul Calderone | 6749ec2 | 2014-04-17 16:30:21 -0400 | [diff] [blame] | 1760 | :raise: NotImplementedError |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1761 | """ |
Alex Gaynor | 8328495 | 2015-09-05 10:43:30 -0400 | [diff] [blame] | 1762 | raise NotImplementedError( |
| 1763 | "Cannot make file object of OpenSSL.SSL.Connection") |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1764 | |
| 1765 | def get_app_data(self): |
| 1766 | """ |
| 1767 | Get application data |
| 1768 | |
| 1769 | :return: The application data |
| 1770 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1771 | return self._app_data |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1772 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1773 | def set_app_data(self, data): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1774 | """ |
| 1775 | Set application data |
| 1776 | |
| 1777 | :param data - The application data |
| 1778 | :return: None |
| 1779 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1780 | self._app_data = data |
| 1781 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1782 | def get_shutdown(self): |
| 1783 | """ |
| 1784 | Get shutdown state |
| 1785 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1786 | :return: The shutdown state, a bitvector of SENT_SHUTDOWN, |
| 1787 | RECEIVED_SHUTDOWN. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1788 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1789 | return _lib.SSL_get_shutdown(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1790 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1791 | def set_shutdown(self, state): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1792 | """ |
| 1793 | Set shutdown state |
| 1794 | |
| 1795 | :param state - bitvector of SENT_SHUTDOWN, RECEIVED_SHUTDOWN. |
| 1796 | :return: None |
| 1797 | """ |
Jean-Paul Calderone | f73a3cb | 2014-02-09 08:49:06 -0500 | [diff] [blame] | 1798 | if not isinstance(state, integer_types): |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1799 | raise TypeError("state must be an integer") |
| 1800 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1801 | _lib.SSL_set_shutdown(self._ssl, state) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1802 | |
Hynek Schlawack | ea94f2b | 2016-03-13 16:17:53 +0100 | [diff] [blame] | 1803 | def get_state_string(self): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1804 | """ |
Hynek Schlawack | ea94f2b | 2016-03-13 16:17:53 +0100 | [diff] [blame] | 1805 | Retrieve a verbose string detailing the state of the Connection. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1806 | |
| 1807 | :return: A string representing the state |
Hynek Schlawack | ea94f2b | 2016-03-13 16:17:53 +0100 | [diff] [blame] | 1808 | :rtype: bytes |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1809 | """ |
kjav | c704a2e | 2015-09-07 12:12:27 +0100 | [diff] [blame] | 1810 | return _ffi.string(_lib.SSL_state_string_long(self._ssl)) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1811 | |
| 1812 | def server_random(self): |
| 1813 | """ |
| 1814 | Get a copy of the server hello nonce. |
| 1815 | |
| 1816 | :return: A string representing the state |
| 1817 | """ |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1818 | session = _lib.SSL_get_session(self._ssl) |
| 1819 | if session == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1820 | return None |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1821 | length = _lib.SSL_get_server_random(self._ssl, _ffi.NULL, 0) |
| 1822 | assert length > 0 |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1823 | outp = _no_zero_allocator("unsigned char[]", length) |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1824 | _lib.SSL_get_server_random(self._ssl, outp, length) |
| 1825 | return _ffi.buffer(outp, length)[:] |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1826 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1827 | def client_random(self): |
| 1828 | """ |
| 1829 | Get a copy of the client hello nonce. |
| 1830 | |
| 1831 | :return: A string representing the state |
| 1832 | """ |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1833 | session = _lib.SSL_get_session(self._ssl) |
| 1834 | if session == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1835 | return None |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1836 | |
| 1837 | length = _lib.SSL_get_client_random(self._ssl, _ffi.NULL, 0) |
| 1838 | assert length > 0 |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1839 | outp = _no_zero_allocator("unsigned char[]", length) |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1840 | _lib.SSL_get_client_random(self._ssl, outp, length) |
| 1841 | return _ffi.buffer(outp, length)[:] |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1842 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1843 | def master_key(self): |
| 1844 | """ |
| 1845 | Get a copy of the master key. |
| 1846 | |
| 1847 | :return: A string representing the state |
| 1848 | """ |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1849 | session = _lib.SSL_get_session(self._ssl) |
| 1850 | if session == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1851 | return None |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1852 | |
| 1853 | length = _lib.SSL_SESSION_get_master_key(session, _ffi.NULL, 0) |
| 1854 | assert length > 0 |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1855 | outp = _no_zero_allocator("unsigned char[]", length) |
Alex Gaynor | 9360306 | 2016-06-01 20:13:09 -0700 | [diff] [blame] | 1856 | _lib.SSL_SESSION_get_master_key(session, outp, length) |
| 1857 | return _ffi.buffer(outp, length)[:] |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1858 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1859 | def sock_shutdown(self, *args, **kwargs): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1860 | """ |
| 1861 | See shutdown(2) |
| 1862 | |
| 1863 | :return: What the socket's shutdown() method returns |
| 1864 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1865 | return self._socket.shutdown(*args, **kwargs) |
| 1866 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1867 | def get_peer_certificate(self): |
| 1868 | """ |
| 1869 | Retrieve the other side's certificate (if any) |
| 1870 | |
| 1871 | :return: The peer's certificate |
| 1872 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1873 | cert = _lib.SSL_get_peer_certificate(self._ssl) |
| 1874 | if cert != _ffi.NULL: |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1875 | pycert = X509.__new__(X509) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1876 | pycert._x509 = _ffi.gc(cert, _lib.X509_free) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1877 | return pycert |
| 1878 | return None |
| 1879 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1880 | def get_peer_cert_chain(self): |
| 1881 | """ |
| 1882 | Retrieve the other side's certificate (if any) |
| 1883 | |
| 1884 | :return: A list of X509 instances giving the peer's certificate chain, |
| 1885 | or None if it does not have one. |
| 1886 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1887 | cert_stack = _lib.SSL_get_peer_cert_chain(self._ssl) |
| 1888 | if cert_stack == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1889 | return None |
| 1890 | |
| 1891 | result = [] |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1892 | for i in range(_lib.sk_X509_num(cert_stack)): |
Jean-Paul Calderone | 73b15c2 | 2013-03-05 18:30:39 -0800 | [diff] [blame] | 1893 | # TODO could incref instead of dup here |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1894 | cert = _lib.X509_dup(_lib.sk_X509_value(cert_stack, i)) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1895 | pycert = X509.__new__(X509) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1896 | pycert._x509 = _ffi.gc(cert, _lib.X509_free) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1897 | result.append(pycert) |
| 1898 | return result |
| 1899 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1900 | def want_read(self): |
| 1901 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1902 | Checks if more data has to be read from the transport layer to complete |
| 1903 | an operation. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1904 | |
| 1905 | :return: True iff more data has to be read |
| 1906 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1907 | return _lib.SSL_want_read(self._ssl) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1908 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1909 | def want_write(self): |
| 1910 | """ |
| 1911 | Checks if there is data to write to the transport layer to complete an |
| 1912 | operation. |
| 1913 | |
| 1914 | :return: True iff there is data to write |
| 1915 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1916 | return _lib.SSL_want_write(self._ssl) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1917 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1918 | def set_accept_state(self): |
| 1919 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1920 | Set the connection to work in server mode. The handshake will be |
| 1921 | handled automatically by read/write. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1922 | |
| 1923 | :return: None |
| 1924 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1925 | _lib.SSL_set_accept_state(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1926 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1927 | def set_connect_state(self): |
| 1928 | """ |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1929 | Set the connection to work in client mode. The handshake will be |
| 1930 | handled automatically by read/write. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1931 | |
| 1932 | :return: None |
| 1933 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1934 | _lib.SSL_set_connect_state(self._ssl) |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1935 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1936 | def get_session(self): |
| 1937 | """ |
| 1938 | Returns the Session currently used. |
| 1939 | |
Alex Gaynor | 62da94d | 2015-09-05 14:37:34 -0400 | [diff] [blame] | 1940 | @return: An instance of :py:class:`OpenSSL.SSL.Session` or |
| 1941 | :py:obj:`None` if no session exists. |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1942 | """ |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1943 | session = _lib.SSL_get1_session(self._ssl) |
| 1944 | if session == _ffi.NULL: |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1945 | return None |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1946 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1947 | pysession = Session.__new__(Session) |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1948 | pysession._session = _ffi.gc(session, _lib.SSL_SESSION_free) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1949 | return pysession |
| 1950 | |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1951 | def set_session(self, session): |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1952 | """ |
| 1953 | Set the session to be used when the TLS/SSL connection is established. |
| 1954 | |
| 1955 | :param session: A Session instance representing the session to use. |
| 1956 | :returns: None |
| 1957 | """ |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1958 | if not isinstance(session, Session): |
| 1959 | raise TypeError("session must be a Session instance") |
| 1960 | |
Jean-Paul Calderone | 6037d07 | 2013-12-28 18:04:00 -0500 | [diff] [blame] | 1961 | result = _lib.SSL_set_session(self._ssl, session._session) |
Jean-Paul Calderone | a63714c | 2013-03-05 17:02:26 -0800 | [diff] [blame] | 1962 | if not result: |
Jean-Paul Calderone | c86bb7d | 2013-12-29 10:25:59 -0500 | [diff] [blame] | 1963 | _raise_current_error() |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 1964 | |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 1965 | def _get_finished_message(self, function): |
| 1966 | """ |
| 1967 | Helper to implement :py:meth:`get_finished` and |
| 1968 | :py:meth:`get_peer_finished`. |
| 1969 | |
| 1970 | :param function: Either :py:data:`SSL_get_finished`: or |
| 1971 | :py:data:`SSL_get_peer_finished`. |
| 1972 | |
| 1973 | :return: :py:data:`None` if the desired message has not yet been |
| 1974 | received, otherwise the contents of the message. |
| 1975 | :rtype: :py:class:`bytes` or :py:class:`NoneType` |
| 1976 | """ |
Jean-Paul Calderone | 01af904 | 2014-03-30 11:40:42 -0400 | [diff] [blame] | 1977 | # The OpenSSL documentation says nothing about what might happen if the |
| 1978 | # count argument given is zero. Specifically, it doesn't say whether |
| 1979 | # the output buffer may be NULL in that case or not. Inspection of the |
| 1980 | # implementation reveals that it calls memcpy() unconditionally. |
| 1981 | # Section 7.1.4, paragraph 1 of the C standard suggests that |
| 1982 | # memcpy(NULL, source, 0) is not guaranteed to produce defined (let |
| 1983 | # alone desirable) behavior (though it probably does on just about |
| 1984 | # every implementation...) |
| 1985 | # |
| 1986 | # Allocate a tiny buffer to pass in (instead of just passing NULL as |
| 1987 | # one might expect) for the initial call so as to be safe against this |
| 1988 | # potentially undefined behavior. |
| 1989 | empty = _ffi.new("char[]", 0) |
| 1990 | size = function(self._ssl, empty, 0) |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 1991 | if size == 0: |
| 1992 | # No Finished message so far. |
| 1993 | return None |
| 1994 | |
Cory Benfield | e62840e | 2016-11-28 12:17:08 +0000 | [diff] [blame] | 1995 | buf = _no_zero_allocator("char[]", size) |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 1996 | function(self._ssl, buf, size) |
| 1997 | return _ffi.buffer(buf, size)[:] |
| 1998 | |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 1999 | def get_finished(self): |
| 2000 | """ |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2001 | Obtain the latest `handshake finished` message sent to the peer. |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2002 | |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2003 | :return: The contents of the message or :py:obj:`None` if the TLS |
| 2004 | handshake has not yet completed. |
| 2005 | :rtype: :py:class:`bytes` or :py:class:`NoneType` |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2006 | """ |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2007 | return self._get_finished_message(_lib.SSL_get_finished) |
| 2008 | |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2009 | def get_peer_finished(self): |
| 2010 | """ |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2011 | Obtain the latest `handshake finished` message received from the peer. |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2012 | |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2013 | :return: The contents of the message or :py:obj:`None` if the TLS |
| 2014 | handshake has not yet completed. |
| 2015 | :rtype: :py:class:`bytes` or :py:class:`NoneType` |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2016 | """ |
Jean-Paul Calderone | ac20956 | 2014-03-30 11:26:32 -0400 | [diff] [blame] | 2017 | return self._get_finished_message(_lib.SSL_get_peer_finished) |
Fedor Brunner | 5747b93 | 2014-03-05 14:22:34 +0100 | [diff] [blame] | 2018 | |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2019 | def get_cipher_name(self): |
| 2020 | """ |
| 2021 | Obtain the name of the currently used cipher. |
Jean-Paul Calderone | 9e3ccd4 | 2014-03-29 18:13:36 -0400 | [diff] [blame] | 2022 | |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2023 | :returns: The name of the currently used cipher or :py:obj:`None` |
| 2024 | if no connection has been established. |
Jean-Paul Calderone | 7f0ded4 | 2014-03-30 10:34:17 -0400 | [diff] [blame] | 2025 | :rtype: :py:class:`unicode` or :py:class:`NoneType` |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2026 | """ |
| 2027 | cipher = _lib.SSL_get_current_cipher(self._ssl) |
| 2028 | if cipher == _ffi.NULL: |
| 2029 | return None |
| 2030 | else: |
Jean-Paul Calderone | 7f0ded4 | 2014-03-30 10:34:17 -0400 | [diff] [blame] | 2031 | name = _ffi.string(_lib.SSL_CIPHER_get_name(cipher)) |
| 2032 | return name.decode("utf-8") |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2033 | |
| 2034 | def get_cipher_bits(self): |
| 2035 | """ |
| 2036 | Obtain the number of secret bits of the currently used cipher. |
Jean-Paul Calderone | 9e3ccd4 | 2014-03-29 18:13:36 -0400 | [diff] [blame] | 2037 | |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2038 | :returns: The number of secret bits of the currently used cipher |
| 2039 | or :py:obj:`None` if no connection has been established. |
Jean-Paul Calderone | 9e3ccd4 | 2014-03-29 18:13:36 -0400 | [diff] [blame] | 2040 | :rtype: :py:class:`int` or :py:class:`NoneType` |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2041 | """ |
| 2042 | cipher = _lib.SSL_get_current_cipher(self._ssl) |
| 2043 | if cipher == _ffi.NULL: |
| 2044 | return None |
| 2045 | else: |
| 2046 | return _lib.SSL_CIPHER_get_bits(cipher, _ffi.NULL) |
| 2047 | |
| 2048 | def get_cipher_version(self): |
| 2049 | """ |
Jean-Paul Calderone | 9e3ccd4 | 2014-03-29 18:13:36 -0400 | [diff] [blame] | 2050 | Obtain the protocol version of the currently used cipher. |
| 2051 | |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2052 | :returns: The protocol name of the currently used cipher |
| 2053 | or :py:obj:`None` if no connection has been established. |
Jean-Paul Calderone | 7f0ded4 | 2014-03-30 10:34:17 -0400 | [diff] [blame] | 2054 | :rtype: :py:class:`unicode` or :py:class:`NoneType` |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2055 | """ |
| 2056 | cipher = _lib.SSL_get_current_cipher(self._ssl) |
| 2057 | if cipher == _ffi.NULL: |
| 2058 | return None |
| 2059 | else: |
Alex Gaynor | c488981 | 2015-09-04 08:43:17 -0400 | [diff] [blame] | 2060 | version = _ffi.string(_lib.SSL_CIPHER_get_version(cipher)) |
Jean-Paul Calderone | 7f0ded4 | 2014-03-30 10:34:17 -0400 | [diff] [blame] | 2061 | return version.decode("utf-8") |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2062 | |
Jim Shaver | abff188 | 2015-05-27 09:15:55 -0400 | [diff] [blame] | 2063 | def get_protocol_version_name(self): |
Jim Shaver | ba65e66 | 2015-04-26 12:23:40 -0400 | [diff] [blame] | 2064 | """ |
| 2065 | Obtain the protocol version of the current connection. |
| 2066 | |
| 2067 | :returns: The TLS version of the current connection, for example |
Jim Shaver | 58d2573 | 2015-05-28 11:52:32 -0400 | [diff] [blame] | 2068 | the value for TLS 1.2 would be ``TLSv1.2``or ``Unknown`` |
Jim Shaver | b5b6b0e | 2015-05-28 16:47:36 -0400 | [diff] [blame] | 2069 | for connections that were not successfully established. |
Jim Shaver | 58d2573 | 2015-05-28 11:52:32 -0400 | [diff] [blame] | 2070 | :rtype: :py:class:`unicode` |
Jim Shaver | ba65e66 | 2015-04-26 12:23:40 -0400 | [diff] [blame] | 2071 | """ |
Jim Shaver | d1c896e | 2015-05-27 17:50:21 -0400 | [diff] [blame] | 2072 | version = _ffi.string(_lib.SSL_get_version(self._ssl)) |
Jim Shaver | 58d2573 | 2015-05-28 11:52:32 -0400 | [diff] [blame] | 2073 | return version.decode("utf-8") |
Jim Shaver | b296792 | 2015-04-26 23:58:52 -0400 | [diff] [blame] | 2074 | |
Jim Shaver | 208438c | 2015-05-28 09:52:38 -0400 | [diff] [blame] | 2075 | def get_protocol_version(self): |
| 2076 | """ |
| 2077 | Obtain the protocol version of the current connection. |
| 2078 | |
| 2079 | :returns: The TLS version of the current connection, for example |
| 2080 | the value for TLS 1 would be 0x769. |
| 2081 | :rtype: :py:class:`int` |
| 2082 | """ |
| 2083 | version = _lib.SSL_version(self._ssl) |
| 2084 | return version |
| 2085 | |
Cory Benfield | 10b277f | 2015-04-13 17:12:42 -0400 | [diff] [blame] | 2086 | @_requires_npn |
Cory Benfield | 84a121e | 2014-03-31 20:30:25 +0100 | [diff] [blame] | 2087 | def get_next_proto_negotiated(self): |
| 2088 | """ |
| 2089 | Get the protocol that was negotiated by NPN. |
| 2090 | """ |
| 2091 | data = _ffi.new("unsigned char **") |
| 2092 | data_len = _ffi.new("unsigned int *") |
| 2093 | |
| 2094 | _lib.SSL_get0_next_proto_negotiated(self._ssl, data, data_len) |
| 2095 | |
Cory Benfield | cd010f6 | 2014-05-15 19:00:27 +0100 | [diff] [blame] | 2096 | return _ffi.buffer(data[0], data_len[0])[:] |
Fedor Brunner | d95014a | 2014-03-03 17:34:41 +0100 | [diff] [blame] | 2097 | |
Cory Benfield | 7907e33 | 2015-04-13 17:18:25 -0400 | [diff] [blame] | 2098 | @_requires_alpn |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2099 | def set_alpn_protos(self, protos): |
| 2100 | """ |
Cory Benfield | e8e9c38 | 2015-04-11 17:33:48 -0400 | [diff] [blame] | 2101 | Specify the client's ALPN protocol list. |
| 2102 | |
| 2103 | These protocols are offered to the server during protocol negotiation. |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2104 | |
| 2105 | :param protos: A list of the protocols to be offered to the server. |
| 2106 | This list should be a Python list of bytestrings representing the |
| 2107 | protocols to offer, e.g. ``[b'http/1.1', b'spdy/2']``. |
| 2108 | """ |
| 2109 | # Take the list of protocols and join them together, prefixing them |
| 2110 | # with their lengths. |
| 2111 | protostr = b''.join( |
| 2112 | chain.from_iterable((int2byte(len(p)), p) for p in protos) |
| 2113 | ) |
| 2114 | |
| 2115 | # Build a C string from the list. We don't need to save this off |
| 2116 | # because OpenSSL immediately copies the data out. |
| 2117 | input_str = _ffi.new("unsigned char[]", protostr) |
Cory Benfield | 9c1979a | 2015-04-12 08:51:52 -0400 | [diff] [blame] | 2118 | input_str_len = _ffi.cast("unsigned", len(protostr)) |
| 2119 | _lib.SSL_set_alpn_protos(self._ssl, input_str, input_str_len) |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2120 | |
Maximilian Hils | 66ded6a | 2015-08-26 06:02:03 +0200 | [diff] [blame] | 2121 | @_requires_alpn |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2122 | def get_alpn_proto_negotiated(self): |
Cory Benfield | 222f30e | 2015-04-13 18:10:21 -0400 | [diff] [blame] | 2123 | """ |
| 2124 | Get the protocol that was negotiated by ALPN. |
| 2125 | """ |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2126 | data = _ffi.new("unsigned char **") |
| 2127 | data_len = _ffi.new("unsigned int *") |
| 2128 | |
| 2129 | _lib.SSL_get0_alpn_selected(self._ssl, data, data_len) |
| 2130 | |
Cory Benfield | e8e9c38 | 2015-04-11 17:33:48 -0400 | [diff] [blame] | 2131 | if not data_len: |
| 2132 | return b'' |
| 2133 | |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2134 | return _ffi.buffer(data[0], data_len[0])[:] |
| 2135 | |
Cory Benfield | 496652a | 2017-01-24 11:42:56 +0000 | [diff] [blame] | 2136 | def request_ocsp(self): |
| 2137 | """ |
| 2138 | Called to request that the server sends stapled OCSP data, if |
| 2139 | available. If this is not called on the client side then the server |
| 2140 | will not send OCSP data. Should be used in conjunction with |
| 2141 | :meth:`Context.set_ocsp_client_callback`. |
| 2142 | """ |
| 2143 | rc = _lib.SSL_set_tlsext_status_type( |
| 2144 | self._ssl, _lib.TLSEXT_STATUSTYPE_ocsp |
| 2145 | ) |
| 2146 | _openssl_assert(rc == 1) |
| 2147 | |
Cory Benfield | 12eae89 | 2014-06-07 15:42:56 +0100 | [diff] [blame] | 2148 | |
Jean-Paul Calderone | 131052e | 2013-03-05 11:56:19 -0800 | [diff] [blame] | 2149 | ConnectionType = Connection |
Jean-Paul Calderone | 11ed8e8 | 2014-01-18 10:21:50 -0500 | [diff] [blame] | 2150 | |
Jean-Paul Calderone | fab157b | 2014-01-18 11:21:38 -0500 | [diff] [blame] | 2151 | # This is similar to the initialization calls at the end of OpenSSL/crypto.py |
| 2152 | # but is exercised mostly by the Context initializer. |
Jean-Paul Calderone | 11ed8e8 | 2014-01-18 10:21:50 -0500 | [diff] [blame] | 2153 | _lib.SSL_library_init() |