ssltransport.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. import io
  2. import socket
  3. import ssl
  4. from urllib3.exceptions import ProxySchemeUnsupported
  5. from urllib3.packages import six
  6. SSL_BLOCKSIZE = 16384
  7. class SSLTransport:
  8. """
  9. The SSLTransport wraps an existing socket and establishes an SSL connection.
  10. Contrary to Python's implementation of SSLSocket, it allows you to chain
  11. multiple TLS connections together. It's particularly useful if you need to
  12. implement TLS within TLS.
  13. The class supports most of the socket API operations.
  14. """
  15. @staticmethod
  16. def _validate_ssl_context_for_tls_in_tls(ssl_context):
  17. """
  18. Raises a ProxySchemeUnsupported if the provided ssl_context can't be used
  19. for TLS in TLS.
  20. The only requirement is that the ssl_context provides the 'wrap_bio'
  21. methods.
  22. """
  23. if not hasattr(ssl_context, "wrap_bio"):
  24. if six.PY2:
  25. raise ProxySchemeUnsupported(
  26. "TLS in TLS requires SSLContext.wrap_bio() which isn't "
  27. "supported on Python 2"
  28. )
  29. else:
  30. raise ProxySchemeUnsupported(
  31. "TLS in TLS requires SSLContext.wrap_bio() which isn't "
  32. "available on non-native SSLContext"
  33. )
  34. def __init__(
  35. self, socket, ssl_context, server_hostname=None, suppress_ragged_eofs=True
  36. ):
  37. """
  38. Create an SSLTransport around socket using the provided ssl_context.
  39. """
  40. self.incoming = ssl.MemoryBIO()
  41. self.outgoing = ssl.MemoryBIO()
  42. self.suppress_ragged_eofs = suppress_ragged_eofs
  43. self.socket = socket
  44. self.sslobj = ssl_context.wrap_bio(
  45. self.incoming, self.outgoing, server_hostname=server_hostname
  46. )
  47. # Perform initial handshake.
  48. self._ssl_io_loop(self.sslobj.do_handshake)
  49. def __enter__(self):
  50. return self
  51. def __exit__(self, *_):
  52. self.close()
  53. def fileno(self):
  54. return self.socket.fileno()
  55. def read(self, len=1024, buffer=None):
  56. return self._wrap_ssl_read(len, buffer)
  57. def recv(self, len=1024, flags=0):
  58. if flags != 0:
  59. raise ValueError("non-zero flags not allowed in calls to recv")
  60. return self._wrap_ssl_read(len)
  61. def recv_into(self, buffer, nbytes=None, flags=0):
  62. if flags != 0:
  63. raise ValueError("non-zero flags not allowed in calls to recv_into")
  64. if buffer and (nbytes is None):
  65. nbytes = len(buffer)
  66. elif nbytes is None:
  67. nbytes = 1024
  68. return self.read(nbytes, buffer)
  69. def sendall(self, data, flags=0):
  70. if flags != 0:
  71. raise ValueError("non-zero flags not allowed in calls to sendall")
  72. count = 0
  73. with memoryview(data) as view, view.cast("B") as byte_view:
  74. amount = len(byte_view)
  75. while count < amount:
  76. v = self.send(byte_view[count:])
  77. count += v
  78. def send(self, data, flags=0):
  79. if flags != 0:
  80. raise ValueError("non-zero flags not allowed in calls to send")
  81. response = self._ssl_io_loop(self.sslobj.write, data)
  82. return response
  83. def makefile(
  84. self, mode="r", buffering=None, encoding=None, errors=None, newline=None
  85. ):
  86. """
  87. Python's httpclient uses makefile and buffered io when reading HTTP
  88. messages and we need to support it.
  89. This is unfortunately a copy and paste of socket.py makefile with small
  90. changes to point to the socket directly.
  91. """
  92. if not set(mode) <= {"r", "w", "b"}:
  93. raise ValueError("invalid mode %r (only r, w, b allowed)" % (mode,))
  94. writing = "w" in mode
  95. reading = "r" in mode or not writing
  96. assert reading or writing
  97. binary = "b" in mode
  98. rawmode = ""
  99. if reading:
  100. rawmode += "r"
  101. if writing:
  102. rawmode += "w"
  103. raw = socket.SocketIO(self, rawmode)
  104. self.socket._io_refs += 1
  105. if buffering is None:
  106. buffering = -1
  107. if buffering < 0:
  108. buffering = io.DEFAULT_BUFFER_SIZE
  109. if buffering == 0:
  110. if not binary:
  111. raise ValueError("unbuffered streams must be binary")
  112. return raw
  113. if reading and writing:
  114. buffer = io.BufferedRWPair(raw, raw, buffering)
  115. elif reading:
  116. buffer = io.BufferedReader(raw, buffering)
  117. else:
  118. assert writing
  119. buffer = io.BufferedWriter(raw, buffering)
  120. if binary:
  121. return buffer
  122. text = io.TextIOWrapper(buffer, encoding, errors, newline)
  123. text.mode = mode
  124. return text
  125. def unwrap(self):
  126. self._ssl_io_loop(self.sslobj.unwrap)
  127. def close(self):
  128. self.socket.close()
  129. def getpeercert(self, binary_form=False):
  130. return self.sslobj.getpeercert(binary_form)
  131. def version(self):
  132. return self.sslobj.version()
  133. def cipher(self):
  134. return self.sslobj.cipher()
  135. def selected_alpn_protocol(self):
  136. return self.sslobj.selected_alpn_protocol()
  137. def selected_npn_protocol(self):
  138. return self.sslobj.selected_npn_protocol()
  139. def shared_ciphers(self):
  140. return self.sslobj.shared_ciphers()
  141. def compression(self):
  142. return self.sslobj.compression()
  143. def settimeout(self, value):
  144. self.socket.settimeout(value)
  145. def gettimeout(self):
  146. return self.socket.gettimeout()
  147. def _decref_socketios(self):
  148. self.socket._decref_socketios()
  149. def _wrap_ssl_read(self, len, buffer=None):
  150. try:
  151. return self._ssl_io_loop(self.sslobj.read, len, buffer)
  152. except ssl.SSLError as e:
  153. if e.errno == ssl.SSL_ERROR_EOF and self.suppress_ragged_eofs:
  154. return 0 # eof, return 0.
  155. else:
  156. raise
  157. def _ssl_io_loop(self, func, *args):
  158. """ Performs an I/O loop between incoming/outgoing and the socket."""
  159. should_loop = True
  160. ret = None
  161. while should_loop:
  162. errno = None
  163. try:
  164. ret = func(*args)
  165. except ssl.SSLError as e:
  166. if e.errno not in (ssl.SSL_ERROR_WANT_READ, ssl.SSL_ERROR_WANT_WRITE):
  167. # WANT_READ, and WANT_WRITE are expected, others are not.
  168. raise e
  169. errno = e.errno
  170. buf = self.outgoing.read()
  171. self.socket.sendall(buf)
  172. if errno is None:
  173. should_loop = False
  174. elif errno == ssl.SSL_ERROR_WANT_READ:
  175. buf = self.socket.recv(SSL_BLOCKSIZE)
  176. if buf:
  177. self.incoming.write(buf)
  178. else:
  179. self.incoming.write_eof()
  180. return ret