webull-openapi-python-sdk 1.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (295) hide show
  1. samples/__init__.py +1 -0
  2. samples/data/__init__.py +1 -0
  3. samples/data/data_client.py +57 -0
  4. samples/data/data_streaming_client.py +86 -0
  5. samples/data/data_streaming_client_async.py +101 -0
  6. samples/trade/__init__.py +0 -0
  7. samples/trade/trade_client.py +163 -0
  8. samples/trade/trade_client_v2.py +181 -0
  9. samples/trade/trade_event_client.py +47 -0
  10. webull/__init__.py +1 -0
  11. webull/core/__init__.py +12 -0
  12. webull/core/auth/__init__.py +0 -0
  13. webull/core/auth/algorithm/__init__.py +0 -0
  14. webull/core/auth/algorithm/sha_hmac1.py +65 -0
  15. webull/core/auth/algorithm/sha_hmac256.py +75 -0
  16. webull/core/auth/composer/__init__.py +0 -0
  17. webull/core/auth/composer/default_signature_composer.py +125 -0
  18. webull/core/auth/credentials.py +46 -0
  19. webull/core/auth/signers/__init__.py +0 -0
  20. webull/core/auth/signers/app_key_signer.py +72 -0
  21. webull/core/auth/signers/signer.py +48 -0
  22. webull/core/auth/signers/signer_factory.py +58 -0
  23. webull/core/cache/__init__.py +225 -0
  24. webull/core/client.py +410 -0
  25. webull/core/common/__init__.py +0 -0
  26. webull/core/common/api_type.py +19 -0
  27. webull/core/common/easy_enum.py +35 -0
  28. webull/core/common/region.py +7 -0
  29. webull/core/compat.py +85 -0
  30. webull/core/context/__init__.py +0 -0
  31. webull/core/context/request_context_holder.py +33 -0
  32. webull/core/data/endpoints.json +22 -0
  33. webull/core/data/retry_config.json +15 -0
  34. webull/core/endpoint/__init__.py +8 -0
  35. webull/core/endpoint/chained_endpoint_resolver.py +57 -0
  36. webull/core/endpoint/default_endpoint_resolver.py +60 -0
  37. webull/core/endpoint/local_config_regional_endpoint_resolver.py +77 -0
  38. webull/core/endpoint/resolver_endpoint_request.py +46 -0
  39. webull/core/endpoint/user_customized_endpoint_resolver.py +55 -0
  40. webull/core/exception/__init__.py +0 -0
  41. webull/core/exception/error_code.py +23 -0
  42. webull/core/exception/error_msg.py +21 -0
  43. webull/core/exception/exceptions.py +53 -0
  44. webull/core/headers.py +57 -0
  45. webull/core/http/__init__.py +0 -0
  46. webull/core/http/initializer/__init__.py +0 -0
  47. webull/core/http/initializer/client_initializer.py +79 -0
  48. webull/core/http/initializer/token/__init__.py +0 -0
  49. webull/core/http/initializer/token/bean/__init__.py +0 -0
  50. webull/core/http/initializer/token/bean/access_token.py +40 -0
  51. webull/core/http/initializer/token/bean/check_token_request.py +44 -0
  52. webull/core/http/initializer/token/bean/create_token_request.py +45 -0
  53. webull/core/http/initializer/token/bean/refresh_token_request.py +44 -0
  54. webull/core/http/initializer/token/token_manager.py +208 -0
  55. webull/core/http/initializer/token/token_operation.py +72 -0
  56. webull/core/http/method_type.py +43 -0
  57. webull/core/http/protocol_type.py +43 -0
  58. webull/core/http/request.py +121 -0
  59. webull/core/http/response.py +166 -0
  60. webull/core/request.py +278 -0
  61. webull/core/retry/__init__.py +0 -0
  62. webull/core/retry/backoff_strategy.py +102 -0
  63. webull/core/retry/retry_condition.py +214 -0
  64. webull/core/retry/retry_policy.py +63 -0
  65. webull/core/retry/retry_policy_context.py +51 -0
  66. webull/core/utils/__init__.py +0 -0
  67. webull/core/utils/common.py +62 -0
  68. webull/core/utils/data.py +25 -0
  69. webull/core/utils/desensitize.py +33 -0
  70. webull/core/utils/validation.py +49 -0
  71. webull/core/vendored/__init__.py +0 -0
  72. webull/core/vendored/requests/__init__.py +94 -0
  73. webull/core/vendored/requests/__version__.py +28 -0
  74. webull/core/vendored/requests/_internal_utils.py +56 -0
  75. webull/core/vendored/requests/adapters.py +539 -0
  76. webull/core/vendored/requests/api.py +166 -0
  77. webull/core/vendored/requests/auth.py +307 -0
  78. webull/core/vendored/requests/certs.py +34 -0
  79. webull/core/vendored/requests/compat.py +85 -0
  80. webull/core/vendored/requests/cookies.py +555 -0
  81. webull/core/vendored/requests/exceptions.py +136 -0
  82. webull/core/vendored/requests/help.py +134 -0
  83. webull/core/vendored/requests/hooks.py +48 -0
  84. webull/core/vendored/requests/models.py +960 -0
  85. webull/core/vendored/requests/packages/__init__.py +17 -0
  86. webull/core/vendored/requests/packages/certifi/__init__.py +17 -0
  87. webull/core/vendored/requests/packages/certifi/__main__.py +16 -0
  88. webull/core/vendored/requests/packages/certifi/cacert.pem +4433 -0
  89. webull/core/vendored/requests/packages/certifi/core.py +51 -0
  90. webull/core/vendored/requests/packages/chardet/__init__.py +53 -0
  91. webull/core/vendored/requests/packages/chardet/big5freq.py +400 -0
  92. webull/core/vendored/requests/packages/chardet/big5prober.py +61 -0
  93. webull/core/vendored/requests/packages/chardet/chardistribution.py +247 -0
  94. webull/core/vendored/requests/packages/chardet/charsetgroupprober.py +120 -0
  95. webull/core/vendored/requests/packages/chardet/charsetprober.py +159 -0
  96. webull/core/vendored/requests/packages/chardet/cli/__init__.py +1 -0
  97. webull/core/vendored/requests/packages/chardet/cli/chardetect.py +99 -0
  98. webull/core/vendored/requests/packages/chardet/codingstatemachine.py +102 -0
  99. webull/core/vendored/requests/packages/chardet/compat.py +48 -0
  100. webull/core/vendored/requests/packages/chardet/cp949prober.py +63 -0
  101. webull/core/vendored/requests/packages/chardet/enums.py +90 -0
  102. webull/core/vendored/requests/packages/chardet/escprober.py +115 -0
  103. webull/core/vendored/requests/packages/chardet/escsm.py +260 -0
  104. webull/core/vendored/requests/packages/chardet/eucjpprober.py +106 -0
  105. webull/core/vendored/requests/packages/chardet/euckrfreq.py +209 -0
  106. webull/core/vendored/requests/packages/chardet/euckrprober.py +61 -0
  107. webull/core/vendored/requests/packages/chardet/euctwfreq.py +401 -0
  108. webull/core/vendored/requests/packages/chardet/euctwprober.py +60 -0
  109. webull/core/vendored/requests/packages/chardet/gb2312freq.py +297 -0
  110. webull/core/vendored/requests/packages/chardet/gb2312prober.py +60 -0
  111. webull/core/vendored/requests/packages/chardet/hebrewprober.py +306 -0
  112. webull/core/vendored/requests/packages/chardet/jisfreq.py +339 -0
  113. webull/core/vendored/requests/packages/chardet/jpcntx.py +247 -0
  114. webull/core/vendored/requests/packages/chardet/langbulgarianmodel.py +242 -0
  115. webull/core/vendored/requests/packages/chardet/langcyrillicmodel.py +347 -0
  116. webull/core/vendored/requests/packages/chardet/langgreekmodel.py +239 -0
  117. webull/core/vendored/requests/packages/chardet/langhebrewmodel.py +214 -0
  118. webull/core/vendored/requests/packages/chardet/langhungarianmodel.py +239 -0
  119. webull/core/vendored/requests/packages/chardet/langthaimodel.py +213 -0
  120. webull/core/vendored/requests/packages/chardet/langturkishmodel.py +207 -0
  121. webull/core/vendored/requests/packages/chardet/latin1prober.py +159 -0
  122. webull/core/vendored/requests/packages/chardet/mbcharsetprober.py +105 -0
  123. webull/core/vendored/requests/packages/chardet/mbcsgroupprober.py +68 -0
  124. webull/core/vendored/requests/packages/chardet/mbcssm.py +586 -0
  125. webull/core/vendored/requests/packages/chardet/sbcharsetprober.py +146 -0
  126. webull/core/vendored/requests/packages/chardet/sbcsgroupprober.py +87 -0
  127. webull/core/vendored/requests/packages/chardet/sjisprober.py +106 -0
  128. webull/core/vendored/requests/packages/chardet/universaldetector.py +300 -0
  129. webull/core/vendored/requests/packages/chardet/utf8prober.py +96 -0
  130. webull/core/vendored/requests/packages/chardet/version.py +23 -0
  131. webull/core/vendored/requests/packages/urllib3/__init__.py +114 -0
  132. webull/core/vendored/requests/packages/urllib3/_collections.py +346 -0
  133. webull/core/vendored/requests/packages/urllib3/connection.py +405 -0
  134. webull/core/vendored/requests/packages/urllib3/connectionpool.py +910 -0
  135. webull/core/vendored/requests/packages/urllib3/contrib/__init__.py +0 -0
  136. webull/core/vendored/requests/packages/urllib3/contrib/_appengine_environ.py +44 -0
  137. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/__init__.py +0 -0
  138. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/bindings.py +607 -0
  139. webull/core/vendored/requests/packages/urllib3/contrib/_securetransport/low_level.py +360 -0
  140. webull/core/vendored/requests/packages/urllib3/contrib/appengine.py +303 -0
  141. webull/core/vendored/requests/packages/urllib3/contrib/ntlmpool.py +125 -0
  142. webull/core/vendored/requests/packages/urllib3/contrib/pyopenssl.py +484 -0
  143. webull/core/vendored/requests/packages/urllib3/contrib/securetransport.py +818 -0
  144. webull/core/vendored/requests/packages/urllib3/contrib/socks.py +206 -0
  145. webull/core/vendored/requests/packages/urllib3/exceptions.py +260 -0
  146. webull/core/vendored/requests/packages/urllib3/fields.py +192 -0
  147. webull/core/vendored/requests/packages/urllib3/filepost.py +112 -0
  148. webull/core/vendored/requests/packages/urllib3/packages/__init__.py +19 -0
  149. webull/core/vendored/requests/packages/urllib3/packages/backports/__init__.py +0 -0
  150. webull/core/vendored/requests/packages/urllib3/packages/backports/makefile.py +67 -0
  151. webull/core/vendored/requests/packages/urllib3/packages/ordered_dict.py +273 -0
  152. webull/core/vendored/requests/packages/urllib3/packages/six.py +882 -0
  153. webull/core/vendored/requests/packages/urllib3/packages/socks.py +887 -0
  154. webull/core/vendored/requests/packages/urllib3/packages/ssl_match_hostname/__init__.py +19 -0
  155. webull/core/vendored/requests/packages/urllib3/packages/ssl_match_hostname/_implementation.py +170 -0
  156. webull/core/vendored/requests/packages/urllib3/poolmanager.py +467 -0
  157. webull/core/vendored/requests/packages/urllib3/request.py +164 -0
  158. webull/core/vendored/requests/packages/urllib3/response.py +721 -0
  159. webull/core/vendored/requests/packages/urllib3/util/__init__.py +68 -0
  160. webull/core/vendored/requests/packages/urllib3/util/connection.py +148 -0
  161. webull/core/vendored/requests/packages/urllib3/util/queue.py +35 -0
  162. webull/core/vendored/requests/packages/urllib3/util/request.py +132 -0
  163. webull/core/vendored/requests/packages/urllib3/util/response.py +101 -0
  164. webull/core/vendored/requests/packages/urllib3/util/retry.py +426 -0
  165. webull/core/vendored/requests/packages/urllib3/util/selectors.py +601 -0
  166. webull/core/vendored/requests/packages/urllib3/util/ssl_.py +396 -0
  167. webull/core/vendored/requests/packages/urllib3/util/timeout.py +256 -0
  168. webull/core/vendored/requests/packages/urllib3/util/url.py +252 -0
  169. webull/core/vendored/requests/packages/urllib3/util/wait.py +164 -0
  170. webull/core/vendored/requests/packages.py +28 -0
  171. webull/core/vendored/requests/sessions.py +750 -0
  172. webull/core/vendored/requests/status_codes.py +105 -0
  173. webull/core/vendored/requests/structures.py +119 -0
  174. webull/core/vendored/requests/utils.py +916 -0
  175. webull/core/vendored/six.py +905 -0
  176. webull/data/__init__.py +3 -0
  177. webull/data/common/__init__.py +0 -0
  178. webull/data/common/category.py +26 -0
  179. webull/data/common/connect_ack.py +29 -0
  180. webull/data/common/direction.py +25 -0
  181. webull/data/common/exchange_code.py +33 -0
  182. webull/data/common/exercise_style.py +22 -0
  183. webull/data/common/expiration_cycle.py +26 -0
  184. webull/data/common/instrument_status.py +23 -0
  185. webull/data/common/option_type.py +20 -0
  186. webull/data/common/subscribe_type.py +22 -0
  187. webull/data/common/timespan.py +29 -0
  188. webull/data/data_client.py +35 -0
  189. webull/data/data_streaming_client.py +89 -0
  190. webull/data/internal/__init__.py +0 -0
  191. webull/data/internal/default_retry_policy.py +84 -0
  192. webull/data/internal/exceptions.py +60 -0
  193. webull/data/internal/quotes_client.py +314 -0
  194. webull/data/internal/quotes_decoder.py +40 -0
  195. webull/data/internal/quotes_payload_decoder.py +35 -0
  196. webull/data/internal/quotes_topic.py +36 -0
  197. webull/data/quotes/__init__.py +0 -0
  198. webull/data/quotes/instrument.py +33 -0
  199. webull/data/quotes/market_data.py +187 -0
  200. webull/data/quotes/market_streaming_data.py +66 -0
  201. webull/data/quotes/subscribe/__init__.py +0 -0
  202. webull/data/quotes/subscribe/ask_bid_result.py +49 -0
  203. webull/data/quotes/subscribe/basic_result.py +45 -0
  204. webull/data/quotes/subscribe/broker_result.py +33 -0
  205. webull/data/quotes/subscribe/message_pb2.py +37 -0
  206. webull/data/quotes/subscribe/order_result.py +30 -0
  207. webull/data/quotes/subscribe/payload_type.py +19 -0
  208. webull/data/quotes/subscribe/quote_decoder.py +28 -0
  209. webull/data/quotes/subscribe/quote_result.py +47 -0
  210. webull/data/quotes/subscribe/snapshot_decoder.py +30 -0
  211. webull/data/quotes/subscribe/snapshot_result.py +69 -0
  212. webull/data/quotes/subscribe/tick_decoder.py +29 -0
  213. webull/data/quotes/subscribe/tick_result.py +47 -0
  214. webull/data/request/__init__.py +0 -0
  215. webull/data/request/get_batch_historical_bars_request.py +43 -0
  216. webull/data/request/get_corp_action_request.py +47 -0
  217. webull/data/request/get_eod_bars_request.py +32 -0
  218. webull/data/request/get_historical_bars_request.py +43 -0
  219. webull/data/request/get_instruments_request.py +30 -0
  220. webull/data/request/get_quotes_request.py +35 -0
  221. webull/data/request/get_snapshot_request.py +38 -0
  222. webull/data/request/get_tick_request.py +37 -0
  223. webull/data/request/subscribe_request.py +43 -0
  224. webull/data/request/unsubscribe_request.py +42 -0
  225. webull/trade/__init__.py +2 -0
  226. webull/trade/common/__init__.py +0 -0
  227. webull/trade/common/account_type.py +22 -0
  228. webull/trade/common/category.py +29 -0
  229. webull/trade/common/combo_ticker_type.py +23 -0
  230. webull/trade/common/combo_type.py +31 -0
  231. webull/trade/common/currency.py +24 -0
  232. webull/trade/common/forbid_reason.py +27 -0
  233. webull/trade/common/instrument_type.py +27 -0
  234. webull/trade/common/markets.py +27 -0
  235. webull/trade/common/order_entrust_type.py +21 -0
  236. webull/trade/common/order_side.py +23 -0
  237. webull/trade/common/order_status.py +25 -0
  238. webull/trade/common/order_tif.py +24 -0
  239. webull/trade/common/order_type.py +30 -0
  240. webull/trade/common/trade_policy.py +22 -0
  241. webull/trade/common/trading_date_type.py +24 -0
  242. webull/trade/common/trailing_type.py +23 -0
  243. webull/trade/events/__init__.py +0 -0
  244. webull/trade/events/default_retry_policy.py +64 -0
  245. webull/trade/events/events_pb2.py +43 -0
  246. webull/trade/events/events_pb2_grpc.py +66 -0
  247. webull/trade/events/signature_composer.py +61 -0
  248. webull/trade/events/types.py +21 -0
  249. webull/trade/request/__init__.py +0 -0
  250. webull/trade/request/cancel_order_request.py +28 -0
  251. webull/trade/request/get_account_balance_request.py +28 -0
  252. webull/trade/request/get_account_positions_request.py +30 -0
  253. webull/trade/request/get_account_profile_request.py +26 -0
  254. webull/trade/request/get_app_subscriptions.py +28 -0
  255. webull/trade/request/get_open_orders_request.py +30 -0
  256. webull/trade/request/get_order_detail_request.py +27 -0
  257. webull/trade/request/get_today_orders_request.py +31 -0
  258. webull/trade/request/get_trade_calendar_request.py +30 -0
  259. webull/trade/request/get_trade_instrument_detail_request.py +24 -0
  260. webull/trade/request/get_trade_security_detail_request.py +42 -0
  261. webull/trade/request/get_tradeable_instruments_request.py +27 -0
  262. webull/trade/request/palce_order_request.py +91 -0
  263. webull/trade/request/place_order_request_v2.py +58 -0
  264. webull/trade/request/replace_order_request.py +73 -0
  265. webull/trade/request/replace_order_request_v2.py +38 -0
  266. webull/trade/request/v2/__init__.py +0 -0
  267. webull/trade/request/v2/cancel_option_request.py +28 -0
  268. webull/trade/request/v2/cancel_order_request.py +28 -0
  269. webull/trade/request/v2/get_account_balance_request.py +28 -0
  270. webull/trade/request/v2/get_account_list.py +23 -0
  271. webull/trade/request/v2/get_account_positions_request.py +24 -0
  272. webull/trade/request/v2/get_order_detail_request.py +26 -0
  273. webull/trade/request/v2/get_order_history_request.py +35 -0
  274. webull/trade/request/v2/palce_order_request.py +87 -0
  275. webull/trade/request/v2/place_option_request.py +64 -0
  276. webull/trade/request/v2/preview_option_request.py +28 -0
  277. webull/trade/request/v2/preview_order_request.py +59 -0
  278. webull/trade/request/v2/replace_option_request.py +28 -0
  279. webull/trade/request/v2/replace_order_request.py +57 -0
  280. webull/trade/trade/__init__.py +0 -0
  281. webull/trade/trade/account_info.py +83 -0
  282. webull/trade/trade/order_operation.py +246 -0
  283. webull/trade/trade/trade_calendar.py +37 -0
  284. webull/trade/trade/trade_instrument.py +72 -0
  285. webull/trade/trade/v2/__init__.py +0 -0
  286. webull/trade/trade/v2/account_info_v2.py +55 -0
  287. webull/trade/trade/v2/order_operation_v2.py +206 -0
  288. webull/trade/trade_client.py +43 -0
  289. webull/trade/trade_events_client.py +233 -0
  290. webull_openapi_python_sdk-1.0.0.dist-info/METADATA +28 -0
  291. webull_openapi_python_sdk-1.0.0.dist-info/RECORD +295 -0
  292. webull_openapi_python_sdk-1.0.0.dist-info/WHEEL +5 -0
  293. webull_openapi_python_sdk-1.0.0.dist-info/licenses/LICENSE +202 -0
  294. webull_openapi_python_sdk-1.0.0.dist-info/licenses/NOTICE +56 -0
  295. webull_openapi_python_sdk-1.0.0.dist-info/top_level.txt +2 -0
@@ -0,0 +1,405 @@
1
+ # Copyright 2022 Webull
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ from __future__ import absolute_import
16
+ import datetime
17
+ import logging
18
+ import os
19
+ import socket
20
+ from socket import error as SocketError, timeout as SocketTimeout
21
+ import warnings
22
+ from .packages import six
23
+ from .packages.six.moves.http_client import HTTPConnection as _HTTPConnection
24
+ from .packages.six.moves.http_client import HTTPException # noqa: F401
25
+
26
+ try: # Compiled with SSL?
27
+ import ssl
28
+ BaseSSLError = ssl.SSLError
29
+ except (ImportError, AttributeError): # Platform-specific: No SSL.
30
+ ssl = None
31
+
32
+ class BaseSSLError(BaseException):
33
+ pass
34
+
35
+
36
+ try: # Python 3:
37
+ # Not a no-op, we're adding this to the namespace so it can be imported.
38
+ ConnectionError = ConnectionError
39
+ except NameError: # Python 2:
40
+ class ConnectionError(Exception):
41
+ pass
42
+
43
+
44
+ from .exceptions import (
45
+ NewConnectionError,
46
+ ConnectTimeoutError,
47
+ SubjectAltNameWarning,
48
+ SystemTimeWarning,
49
+ )
50
+ from .packages.ssl_match_hostname import match_hostname, CertificateError
51
+
52
+ from .util.ssl_ import (
53
+ resolve_cert_reqs,
54
+ resolve_ssl_version,
55
+ assert_fingerprint,
56
+ create_urllib3_context,
57
+ ssl_wrap_socket
58
+ )
59
+
60
+
61
+ from .util import connection
62
+
63
+ from ._collections import HTTPHeaderDict
64
+
65
+ log = logging.getLogger(__name__)
66
+
67
+ port_by_scheme = {
68
+ 'http': 80,
69
+ 'https': 443,
70
+ }
71
+
72
+ # When updating RECENT_DATE, move it to within two years of the current date,
73
+ # and not less than 6 months ago.
74
+ # Example: if Today is 2018-01-01, then RECENT_DATE should be any date on or
75
+ # after 2016-01-01 (today - 2 years) AND before 2017-07-01 (today - 6 months)
76
+ RECENT_DATE = datetime.date(2017, 6, 30)
77
+
78
+
79
+ class DummyConnection(object):
80
+ """Used to detect a failed ConnectionCls import."""
81
+ pass
82
+
83
+
84
+ class HTTPConnection(_HTTPConnection, object):
85
+ """
86
+ Based on httplib.HTTPConnection but provides an extra constructor
87
+ backwards-compatibility layer between older and newer Pythons.
88
+
89
+ Additional keyword parameters are used to configure attributes of the connection.
90
+ Accepted parameters include:
91
+
92
+ - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool`
93
+ - ``source_address``: Set the source address for the current connection.
94
+ - ``socket_options``: Set specific options on the underlying socket. If not specified, then
95
+ defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling
96
+ Nagle's algorithm (sets TCP_NODELAY to 1) unless the connection is behind a proxy.
97
+
98
+ For example, if you wish to enable TCP Keep Alive in addition to the defaults,
99
+ you might pass::
100
+
101
+ HTTPConnection.default_socket_options + [
102
+ (socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1),
103
+ ]
104
+
105
+ Or you may want to disable the defaults by passing an empty list (e.g., ``[]``).
106
+ """
107
+
108
+ default_port = port_by_scheme['http']
109
+
110
+ #: Disable Nagle's algorithm by default.
111
+ #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]``
112
+ default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]
113
+
114
+ #: Whether this connection verifies the host's certificate.
115
+ is_verified = False
116
+
117
+ def __init__(self, *args, **kw):
118
+ if six.PY3: # Python 3
119
+ kw.pop('strict', None)
120
+
121
+ # Pre-set source_address.
122
+ self.source_address = kw.get('source_address')
123
+
124
+ #: The socket options provided by the user. If no options are
125
+ #: provided, we use the default options.
126
+ self.socket_options = kw.pop('socket_options', self.default_socket_options)
127
+
128
+ _HTTPConnection.__init__(self, *args, **kw)
129
+
130
+ @property
131
+ def host(self):
132
+ """
133
+ Getter method to remove any trailing dots that indicate the hostname is an FQDN.
134
+
135
+ In general, SSL certificates don't include the trailing dot indicating a
136
+ fully-qualified domain name, and thus, they don't validate properly when
137
+ checked against a domain name that includes the dot. In addition, some
138
+ servers may not expect to receive the trailing dot when provided.
139
+
140
+ However, the hostname with trailing dot is critical to DNS resolution; doing a
141
+ lookup with the trailing dot will properly only resolve the appropriate FQDN,
142
+ whereas a lookup without a trailing dot will search the system's search domain
143
+ list. Thus, it's important to keep the original host around for use only in
144
+ those cases where it's appropriate (i.e., when doing DNS lookup to establish the
145
+ actual TCP connection across which we're going to send HTTP requests).
146
+ """
147
+ return self._dns_host.rstrip('.')
148
+
149
+ @host.setter
150
+ def host(self, value):
151
+ """
152
+ Setter for the `host` property.
153
+
154
+ We assume that only urllib3 uses the _dns_host attribute; httplib itself
155
+ only uses `host`, and it seems reasonable that other libraries follow suit.
156
+ """
157
+ self._dns_host = value
158
+
159
+ def _new_conn(self):
160
+ """ Establish a socket connection and set nodelay settings on it.
161
+
162
+ :return: New socket connection.
163
+ """
164
+ extra_kw = {}
165
+ if self.source_address:
166
+ extra_kw['source_address'] = self.source_address
167
+
168
+ if self.socket_options:
169
+ extra_kw['socket_options'] = self.socket_options
170
+
171
+ try:
172
+ conn = connection.create_connection(
173
+ (self._dns_host, self.port), self.timeout, **extra_kw)
174
+
175
+ except SocketTimeout:
176
+ raise ConnectTimeoutError(
177
+ self, "Connection to %s timed out. (connect timeout=%s)" %
178
+ (self.host, self.timeout))
179
+
180
+ except SocketError as e:
181
+ raise NewConnectionError(
182
+ self, "Failed to establish a new connection: %s" % e)
183
+
184
+ return conn
185
+
186
+ def _prepare_conn(self, conn):
187
+ self.sock = conn
188
+ if self._tunnel_host:
189
+ # TODO: Fix tunnel so it doesn't depend on self.sock state.
190
+ self._tunnel()
191
+ # Mark this connection as not reusable
192
+ self.auto_open = 0
193
+
194
+ def connect(self):
195
+ conn = self._new_conn()
196
+ self._prepare_conn(conn)
197
+
198
+ def request_chunked(self, method, url, body=None, headers=None):
199
+ """
200
+ Alternative to the common request method, which sends the
201
+ body with chunked encoding and not as one block
202
+ """
203
+ headers = HTTPHeaderDict(headers if headers is not None else {})
204
+ skip_accept_encoding = 'accept-encoding' in headers
205
+ skip_host = 'host' in headers
206
+ self.putrequest(
207
+ method,
208
+ url,
209
+ skip_accept_encoding=skip_accept_encoding,
210
+ skip_host=skip_host
211
+ )
212
+ for header, value in headers.items():
213
+ self.putheader(header, value)
214
+ if 'transfer-encoding' not in headers:
215
+ self.putheader('Transfer-Encoding', 'chunked')
216
+ self.endheaders()
217
+
218
+ if body is not None:
219
+ stringish_types = six.string_types + (bytes,)
220
+ if isinstance(body, stringish_types):
221
+ body = (body,)
222
+ for chunk in body:
223
+ if not chunk:
224
+ continue
225
+ if not isinstance(chunk, bytes):
226
+ chunk = chunk.encode('utf8')
227
+ len_str = hex(len(chunk))[2:]
228
+ self.send(len_str.encode('utf-8'))
229
+ self.send(b'\r\n')
230
+ self.send(chunk)
231
+ self.send(b'\r\n')
232
+
233
+ # After the if clause, to always have a closed body
234
+ self.send(b'0\r\n\r\n')
235
+
236
+
237
+ class HTTPSConnection(HTTPConnection):
238
+ default_port = port_by_scheme['https']
239
+
240
+ ssl_version = None
241
+
242
+ def __init__(self, host, port=None, key_file=None, cert_file=None,
243
+ strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
244
+ ssl_context=None, server_hostname=None, **kw):
245
+
246
+ HTTPConnection.__init__(self, host, port, strict=strict,
247
+ timeout=timeout, **kw)
248
+
249
+ self.key_file = key_file
250
+ self.cert_file = cert_file
251
+ self.ssl_context = ssl_context
252
+ self.server_hostname = server_hostname
253
+
254
+ # Required property for Google AppEngine 1.9.0 which otherwise causes
255
+ # HTTPS requests to go out as HTTP. (See Issue #356)
256
+ self._protocol = 'https'
257
+
258
+ def connect(self):
259
+ conn = self._new_conn()
260
+ self._prepare_conn(conn)
261
+
262
+ if self.ssl_context is None:
263
+ self.ssl_context = create_urllib3_context(
264
+ ssl_version=resolve_ssl_version(None),
265
+ cert_reqs=resolve_cert_reqs(None),
266
+ )
267
+
268
+ self.sock = ssl_wrap_socket(
269
+ sock=conn,
270
+ keyfile=self.key_file,
271
+ certfile=self.cert_file,
272
+ ssl_context=self.ssl_context,
273
+ server_hostname=self.server_hostname
274
+ )
275
+
276
+
277
+ class VerifiedHTTPSConnection(HTTPSConnection):
278
+ """
279
+ Based on httplib.HTTPSConnection but wraps the socket with
280
+ SSL certification.
281
+ """
282
+ cert_reqs = None
283
+ ca_certs = None
284
+ ca_cert_dir = None
285
+ ssl_version = None
286
+ assert_fingerprint = None
287
+
288
+ def set_cert(self, key_file=None, cert_file=None,
289
+ cert_reqs=None, ca_certs=None,
290
+ assert_hostname=None, assert_fingerprint=None,
291
+ ca_cert_dir=None):
292
+ """
293
+ This method should only be called once, before the connection is used.
294
+ """
295
+ # If cert_reqs is not provided, we can try to guess. If the user gave
296
+ # us a cert database, we assume they want to use it: otherwise, if
297
+ # they gave us an SSL Context object we should use whatever is set for
298
+ # it.
299
+ if cert_reqs is None:
300
+ if ca_certs or ca_cert_dir:
301
+ cert_reqs = 'CERT_REQUIRED'
302
+ elif self.ssl_context is not None:
303
+ cert_reqs = self.ssl_context.verify_mode
304
+
305
+ self.key_file = key_file
306
+ self.cert_file = cert_file
307
+ self.cert_reqs = cert_reqs
308
+ self.assert_hostname = assert_hostname
309
+ self.assert_fingerprint = assert_fingerprint
310
+ self.ca_certs = ca_certs and os.path.expanduser(ca_certs)
311
+ self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir)
312
+
313
+ def connect(self):
314
+ # Add certificate verification
315
+ conn = self._new_conn()
316
+ hostname = self.host
317
+
318
+ if self._tunnel_host:
319
+ self.sock = conn
320
+ # Calls self._set_hostport(), so self.host is
321
+ # self._tunnel_host below.
322
+ self._tunnel()
323
+ # Mark this connection as not reusable
324
+ self.auto_open = 0
325
+
326
+ # Override the host with the one we're requesting data from.
327
+ hostname = self._tunnel_host
328
+
329
+ server_hostname = hostname
330
+ if self.server_hostname is not None:
331
+ server_hostname = self.server_hostname
332
+
333
+ is_time_off = datetime.date.today() < RECENT_DATE
334
+ if is_time_off:
335
+ warnings.warn((
336
+ 'System time is way off (before {0}). This will probably '
337
+ 'lead to SSL verification errors').format(RECENT_DATE),
338
+ SystemTimeWarning
339
+ )
340
+
341
+ # Wrap socket using verification with the root certs in
342
+ # trusted_root_certs
343
+ if self.ssl_context is None:
344
+ self.ssl_context = create_urllib3_context(
345
+ ssl_version=resolve_ssl_version(self.ssl_version),
346
+ cert_reqs=resolve_cert_reqs(self.cert_reqs),
347
+ )
348
+
349
+ context = self.ssl_context
350
+ context.verify_mode = resolve_cert_reqs(self.cert_reqs)
351
+ self.sock = ssl_wrap_socket(
352
+ sock=conn,
353
+ keyfile=self.key_file,
354
+ certfile=self.cert_file,
355
+ ca_certs=self.ca_certs,
356
+ ca_cert_dir=self.ca_cert_dir,
357
+ server_hostname=server_hostname,
358
+ ssl_context=context)
359
+
360
+ if self.assert_fingerprint:
361
+ assert_fingerprint(self.sock.getpeercert(binary_form=True),
362
+ self.assert_fingerprint)
363
+ elif context.verify_mode != ssl.CERT_NONE \
364
+ and not getattr(context, 'check_hostname', False) \
365
+ and self.assert_hostname is not False:
366
+ # While urllib3 attempts to always turn off hostname matching from
367
+ # the TLS library, this cannot always be done. So we check whether
368
+ # the TLS Library still thinks it's matching hostnames.
369
+ cert = self.sock.getpeercert()
370
+ if not cert.get('subjectAltName', ()):
371
+ warnings.warn((
372
+ 'Certificate for {0} has no `subjectAltName`, falling back to check for a '
373
+ '`commonName` for now. This feature is being removed by major browsers and '
374
+ 'deprecated by RFC 2818. (See https://github.com/shazow/urllib3/issues/497 '
375
+ 'for details.)'.format(hostname)),
376
+ SubjectAltNameWarning
377
+ )
378
+ _match_hostname(cert, self.assert_hostname or server_hostname)
379
+
380
+ self.is_verified = (
381
+ context.verify_mode == ssl.CERT_REQUIRED or
382
+ self.assert_fingerprint is not None
383
+ )
384
+
385
+
386
+ def _match_hostname(cert, asserted_hostname):
387
+ try:
388
+ match_hostname(cert, asserted_hostname)
389
+ except CertificateError as e:
390
+ log.error(
391
+ 'Certificate did not match expected hostname: %s. '
392
+ 'Certificate: %s', asserted_hostname, cert
393
+ )
394
+ # Add cert to exception and reraise so client code can inspect
395
+ # the cert when catching the exception, if they want to
396
+ e._peer_cert = cert
397
+ raise
398
+
399
+
400
+ if ssl:
401
+ # Make a copy for testing.
402
+ UnverifiedHTTPSConnection = HTTPSConnection
403
+ HTTPSConnection = VerifiedHTTPSConnection
404
+ else:
405
+ HTTPSConnection = DummyConnection