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,125 @@
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
+ """
16
+ NTLM authenticating pool, contributed by erikcederstran
17
+
18
+ Issue #10, see: http://code.google.com/p/urllib3/issues/detail?id=10
19
+ """
20
+ from __future__ import absolute_import
21
+
22
+ from logging import getLogger
23
+ from ntlm import ntlm
24
+
25
+ from .. import HTTPSConnectionPool
26
+ from ..packages.six.moves.http_client import HTTPSConnection
27
+
28
+
29
+ log = getLogger(__name__)
30
+
31
+
32
+ class NTLMConnectionPool(HTTPSConnectionPool):
33
+ """
34
+ Implements an NTLM authentication version of an urllib3 connection pool
35
+ """
36
+
37
+ scheme = 'https'
38
+
39
+ def __init__(self, user, pw, authurl, *args, **kwargs):
40
+ """
41
+ authurl is a random URL on the server that is protected by NTLM.
42
+ user is the Windows user, probably in the DOMAIN\\username format.
43
+ pw is the password for the user.
44
+ """
45
+ super(NTLMConnectionPool, self).__init__(*args, **kwargs)
46
+ self.authurl = authurl
47
+ self.rawuser = user
48
+ user_parts = user.split('\\', 1)
49
+ self.domain = user_parts[0].upper()
50
+ self.user = user_parts[1]
51
+ self.pw = pw
52
+
53
+ def _new_conn(self):
54
+ # Performs the NTLM handshake that secures the connection. The socket
55
+ # must be kept open while requests are performed.
56
+ self.num_connections += 1
57
+ log.debug('Starting NTLM HTTPS connection no. %d: https://%s%s',
58
+ self.num_connections, self.host, self.authurl)
59
+
60
+ headers = {'Connection': 'Keep-Alive'}
61
+ req_header = 'Authorization'
62
+ resp_header = 'www-authenticate'
63
+
64
+ conn = HTTPSConnection(host=self.host, port=self.port)
65
+
66
+ # Send negotiation message
67
+ headers[req_header] = (
68
+ 'NTLM %s' % ntlm.create_NTLM_NEGOTIATE_MESSAGE(self.rawuser))
69
+ log.debug('Request headers: %s', headers)
70
+ conn.request('GET', self.authurl, None, headers)
71
+ res = conn.getresponse()
72
+ reshdr = dict(res.getheaders())
73
+ log.debug('Response status: %s %s', res.status, res.reason)
74
+ log.debug('Response headers: %s', reshdr)
75
+ log.debug('Response data: %s [...]', res.read(100))
76
+
77
+ # Remove the reference to the socket, so that it can not be closed by
78
+ # the response object (we want to keep the socket open)
79
+ res.fp = None
80
+
81
+ # Server should respond with a challenge message
82
+ auth_header_values = reshdr[resp_header].split(', ')
83
+ auth_header_value = None
84
+ for s in auth_header_values:
85
+ if s[:5] == 'NTLM ':
86
+ auth_header_value = s[5:]
87
+ if auth_header_value is None:
88
+ raise Exception('Unexpected %s response header: %s' %
89
+ (resp_header, reshdr[resp_header]))
90
+
91
+ # Send authentication message
92
+ ServerChallenge, NegotiateFlags = \
93
+ ntlm.parse_NTLM_CHALLENGE_MESSAGE(auth_header_value)
94
+ auth_msg = ntlm.create_NTLM_AUTHENTICATE_MESSAGE(ServerChallenge,
95
+ self.user,
96
+ self.domain,
97
+ self.pw,
98
+ NegotiateFlags)
99
+ headers[req_header] = 'NTLM %s' % auth_msg
100
+ log.debug('Request headers: %s', headers)
101
+ conn.request('GET', self.authurl, None, headers)
102
+ res = conn.getresponse()
103
+ log.debug('Response status: %s %s', res.status, res.reason)
104
+ log.debug('Response headers: %s', dict(res.getheaders()))
105
+ log.debug('Response data: %s [...]', res.read()[:100])
106
+ if res.status != 200:
107
+ if res.status == 401:
108
+ raise Exception('Server rejected request: wrong '
109
+ 'username or password')
110
+ raise Exception('Wrong server response: %s %s' %
111
+ (res.status, res.reason))
112
+
113
+ res.fp = None
114
+ log.debug('Connection established')
115
+ return conn
116
+
117
+ def urlopen(self, method, url, body=None, headers=None, retries=3,
118
+ redirect=True, assert_same_host=True):
119
+ if headers is None:
120
+ headers = {}
121
+ headers['Connection'] = 'Keep-Alive'
122
+ return super(NTLMConnectionPool, self).urlopen(method, url, body,
123
+ headers, retries,
124
+ redirect,
125
+ assert_same_host)
@@ -0,0 +1,484 @@
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
+ """
16
+ SSL with SNI_-support for Python 2. Follow these instructions if you would
17
+ like to verify SSL certificates in Python 2. Note, the default libraries do
18
+ *not* do certificate checking; you need to do additional work to validate
19
+ certificates yourself.
20
+
21
+ This needs the following packages installed:
22
+
23
+ * pyOpenSSL (tested with 16.0.0)
24
+ * cryptography (minimum 1.3.4, from pyopenssl)
25
+ * idna (minimum 2.0, from cryptography)
26
+
27
+ However, pyopenssl depends on cryptography, which depends on idna, so while we
28
+ use all three directly here we end up having relatively few packages required.
29
+
30
+ You can install them with the following command:
31
+
32
+ pip install pyopenssl cryptography idna
33
+
34
+ To activate certificate checking, call
35
+ :func:`~urllib3.contrib.pyopenssl.inject_into_urllib3` from your Python code
36
+ before you begin making HTTP requests. This can be done in a ``sitecustomize``
37
+ module, or at any other time before your application begins using ``urllib3``,
38
+ like this::
39
+
40
+ try:
41
+ import urllib3.contrib.pyopenssl
42
+ urllib3.contrib.pyopenssl.inject_into_urllib3()
43
+ except ImportError:
44
+ pass
45
+
46
+ Now you can use :mod:`urllib3` as you normally would, and it will support SNI
47
+ when the required modules are installed.
48
+
49
+ Activating this module also has the positive side effect of disabling SSL/TLS
50
+ compression in Python 2 (see `CRIME attack`_).
51
+
52
+ If you want to configure the default list of supported cipher suites, you can
53
+ set the ``urllib3.contrib.pyopenssl.DEFAULT_SSL_CIPHER_LIST`` variable.
54
+
55
+ .. _sni: https://en.wikipedia.org/wiki/Server_Name_Indication
56
+ .. _crime attack: https://en.wikipedia.org/wiki/CRIME_(security_exploit)
57
+ """
58
+ from __future__ import absolute_import
59
+
60
+ import OpenSSL.SSL
61
+ from cryptography import x509
62
+ from cryptography.hazmat.backends.openssl import backend as openssl_backend
63
+ from cryptography.hazmat.backends.openssl.x509 import _Certificate
64
+
65
+ try:
66
+ from cryptography.x509 import UnsupportedExtension
67
+ except ImportError:
68
+ # UnsupportedExtension is gone in cryptography >= 2.1.0
69
+ class UnsupportedExtension(Exception):
70
+ pass
71
+
72
+ from socket import timeout, error as SocketError
73
+ from io import BytesIO
74
+
75
+ try: # Platform-specific: Python 2
76
+ from socket import _fileobject
77
+ except ImportError: # Platform-specific: Python 3
78
+ _fileobject = None
79
+ from ..packages.backports.makefile import backport_makefile
80
+
81
+ import logging
82
+ import ssl
83
+ from ..packages import six
84
+ import sys
85
+
86
+ from .. import util
87
+
88
+ __all__ = ['inject_into_urllib3', 'extract_from_urllib3']
89
+
90
+ # SNI always works.
91
+ HAS_SNI = True
92
+
93
+ # Map from urllib3 to PyOpenSSL compatible parameter-values.
94
+ _openssl_versions = {
95
+ ssl.PROTOCOL_SSLv23: OpenSSL.SSL.SSLv23_METHOD,
96
+ ssl.PROTOCOL_TLSv1: OpenSSL.SSL.TLSv1_METHOD,
97
+ }
98
+
99
+ if hasattr(ssl, 'PROTOCOL_TLSv1_1') and hasattr(OpenSSL.SSL, 'TLSv1_1_METHOD'):
100
+ _openssl_versions[ssl.PROTOCOL_TLSv1_1] = OpenSSL.SSL.TLSv1_1_METHOD
101
+
102
+ if hasattr(ssl, 'PROTOCOL_TLSv1_2') and hasattr(OpenSSL.SSL, 'TLSv1_2_METHOD'):
103
+ _openssl_versions[ssl.PROTOCOL_TLSv1_2] = OpenSSL.SSL.TLSv1_2_METHOD
104
+
105
+ try:
106
+ _openssl_versions.update({ssl.PROTOCOL_SSLv3: OpenSSL.SSL.SSLv3_METHOD})
107
+ except AttributeError:
108
+ pass
109
+
110
+ _stdlib_to_openssl_verify = {
111
+ ssl.CERT_NONE: OpenSSL.SSL.VERIFY_NONE,
112
+ ssl.CERT_OPTIONAL: OpenSSL.SSL.VERIFY_PEER,
113
+ ssl.CERT_REQUIRED:
114
+ OpenSSL.SSL.VERIFY_PEER + OpenSSL.SSL.VERIFY_FAIL_IF_NO_PEER_CERT,
115
+ }
116
+ _openssl_to_stdlib_verify = dict(
117
+ (v, k) for k, v in _stdlib_to_openssl_verify.items()
118
+ )
119
+
120
+ # OpenSSL will only write 16K at a time
121
+ SSL_WRITE_BLOCKSIZE = 16384
122
+
123
+ orig_util_HAS_SNI = util.HAS_SNI
124
+ orig_util_SSLContext = util.ssl_.SSLContext
125
+
126
+
127
+ log = logging.getLogger(__name__)
128
+
129
+
130
+ def inject_into_urllib3():
131
+ 'Monkey-patch urllib3 with PyOpenSSL-backed SSL-support.'
132
+
133
+ _validate_dependencies_met()
134
+
135
+ util.ssl_.SSLContext = PyOpenSSLContext
136
+ util.HAS_SNI = HAS_SNI
137
+ util.ssl_.HAS_SNI = HAS_SNI
138
+ util.IS_PYOPENSSL = True
139
+ util.ssl_.IS_PYOPENSSL = True
140
+
141
+
142
+ def extract_from_urllib3():
143
+ 'Undo monkey-patching by :func:`inject_into_urllib3`.'
144
+
145
+ util.ssl_.SSLContext = orig_util_SSLContext
146
+ util.HAS_SNI = orig_util_HAS_SNI
147
+ util.ssl_.HAS_SNI = orig_util_HAS_SNI
148
+ util.IS_PYOPENSSL = False
149
+ util.ssl_.IS_PYOPENSSL = False
150
+
151
+
152
+ def _validate_dependencies_met():
153
+ """
154
+ Verifies that PyOpenSSL's package-level dependencies have been met.
155
+ Throws `ImportError` if they are not met.
156
+ """
157
+ # Method added in `cryptography==1.1`; not available in older versions
158
+ from cryptography.x509.extensions import Extensions
159
+ if getattr(Extensions, "get_extension_for_class", None) is None:
160
+ raise ImportError("'cryptography' module missing required functionality. "
161
+ "Try upgrading to v1.3.4 or newer.")
162
+
163
+ # pyOpenSSL 0.14 and above use cryptography for OpenSSL bindings. The _x509
164
+ # attribute is only present on those versions.
165
+ from OpenSSL.crypto import X509
166
+ x509 = X509()
167
+ if getattr(x509, "_x509", None) is None:
168
+ raise ImportError("'pyOpenSSL' module missing required functionality. "
169
+ "Try upgrading to v0.14 or newer.")
170
+
171
+
172
+ def _dnsname_to_stdlib(name):
173
+ """
174
+ Converts a dNSName SubjectAlternativeName field to the form used by the
175
+ standard library on the given Python version.
176
+
177
+ Cryptography produces a dNSName as a unicode string that was idna-decoded
178
+ from ASCII bytes. We need to idna-encode that string to get it back, and
179
+ then on Python 3 we also need to convert to unicode via UTF-8 (the stdlib
180
+ uses PyUnicode_FromStringAndSize on it, which decodes via UTF-8).
181
+
182
+ If the name cannot be idna-encoded then we return None signalling that
183
+ the name given should be skipped.
184
+ """
185
+ def idna_encode(name):
186
+ """
187
+ Borrowed wholesale from the Python Cryptography Project. It turns out
188
+ that we can't just safely call `idna.encode`: it can explode for
189
+ wildcard names. This avoids that problem.
190
+ """
191
+ import idna
192
+
193
+ try:
194
+ for prefix in [u'*.', u'.']:
195
+ if name.startswith(prefix):
196
+ name = name[len(prefix):]
197
+ return prefix.encode('ascii') + idna.encode(name)
198
+ return idna.encode(name)
199
+ except idna.core.IDNAError:
200
+ return None
201
+
202
+ if ':' in name:
203
+ return name
204
+
205
+ name = idna_encode(name)
206
+ if name is None:
207
+ return None
208
+ elif sys.version_info >= (3, 0):
209
+ name = name.decode('utf-8')
210
+ return name
211
+
212
+
213
+ def get_subj_alt_name(peer_cert):
214
+ """
215
+ Given an PyOpenSSL certificate, provides all the subject alternative names.
216
+ """
217
+ # Pass the cert to cryptography, which has much better APIs for this.
218
+ if hasattr(peer_cert, "to_cryptography"):
219
+ cert = peer_cert.to_cryptography()
220
+ else:
221
+ # This is technically using private APIs, but should work across all
222
+ # relevant versions before PyOpenSSL got a proper API for this.
223
+ cert = _Certificate(openssl_backend, peer_cert._x509)
224
+
225
+ # We want to find the SAN extension. Ask Cryptography to locate it (it's
226
+ # faster than looping in Python)
227
+ try:
228
+ ext = cert.extensions.get_extension_for_class(
229
+ x509.SubjectAlternativeName
230
+ ).value
231
+ except x509.ExtensionNotFound:
232
+ # No such extension, return the empty list.
233
+ return []
234
+ except (x509.DuplicateExtension, UnsupportedExtension,
235
+ x509.UnsupportedGeneralNameType, UnicodeError) as e:
236
+ # A problem has been found with the quality of the certificate. Assume
237
+ # no SAN field is present.
238
+ log.warning(
239
+ "A problem was encountered with the certificate that prevented "
240
+ "urllib3 from finding the SubjectAlternativeName field. This can "
241
+ "affect certificate validation. The error was %s",
242
+ e,
243
+ )
244
+ return []
245
+
246
+ # We want to return dNSName and iPAddress fields. We need to cast the IPs
247
+ # back to strings because the match_hostname function wants them as
248
+ # strings.
249
+ # Sadly the DNS names need to be idna encoded and then, on Python 3, UTF-8
250
+ # decoded. This is pretty frustrating, but that's what the standard library
251
+ # does with certificates, and so we need to attempt to do the same.
252
+ # We also want to skip over names which cannot be idna encoded.
253
+ names = [
254
+ ('DNS', name) for name in map(_dnsname_to_stdlib, ext.get_values_for_type(x509.DNSName))
255
+ if name is not None
256
+ ]
257
+ names.extend(
258
+ ('IP Address', str(name))
259
+ for name in ext.get_values_for_type(x509.IPAddress)
260
+ )
261
+
262
+ return names
263
+
264
+
265
+ class WrappedSocket(object):
266
+ '''API-compatibility wrapper for Python OpenSSL's Connection-class.
267
+
268
+ Note: _makefile_refs, _drop() and _reuse() are needed for the garbage
269
+ collector of pypy.
270
+ '''
271
+
272
+ def __init__(self, connection, socket, suppress_ragged_eofs=True):
273
+ self.connection = connection
274
+ self.socket = socket
275
+ self.suppress_ragged_eofs = suppress_ragged_eofs
276
+ self._makefile_refs = 0
277
+ self._closed = False
278
+
279
+ def fileno(self):
280
+ return self.socket.fileno()
281
+
282
+ # Copy-pasted from Python 3.5 source code
283
+ def _decref_socketios(self):
284
+ if self._makefile_refs > 0:
285
+ self._makefile_refs -= 1
286
+ if self._closed:
287
+ self.close()
288
+
289
+ def recv(self, *args, **kwargs):
290
+ try:
291
+ data = self.connection.recv(*args, **kwargs)
292
+ except OpenSSL.SSL.SysCallError as e:
293
+ if self.suppress_ragged_eofs and e.args == (-1, 'Unexpected EOF'):
294
+ return b''
295
+ else:
296
+ raise SocketError(str(e))
297
+ except OpenSSL.SSL.ZeroReturnError:
298
+ if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN:
299
+ return b''
300
+ else:
301
+ raise
302
+ except OpenSSL.SSL.WantReadError:
303
+ if not util.wait_for_read(self.socket, self.socket.gettimeout()):
304
+ raise timeout('The read operation timed out')
305
+ else:
306
+ return self.recv(*args, **kwargs)
307
+ else:
308
+ return data
309
+
310
+ def recv_into(self, *args, **kwargs):
311
+ try:
312
+ return self.connection.recv_into(*args, **kwargs)
313
+ except OpenSSL.SSL.SysCallError as e:
314
+ if self.suppress_ragged_eofs and e.args == (-1, 'Unexpected EOF'):
315
+ return 0
316
+ else:
317
+ raise SocketError(str(e))
318
+ except OpenSSL.SSL.ZeroReturnError:
319
+ if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN:
320
+ return 0
321
+ else:
322
+ raise
323
+ except OpenSSL.SSL.WantReadError:
324
+ if not util.wait_for_read(self.socket, self.socket.gettimeout()):
325
+ raise timeout('The read operation timed out')
326
+ else:
327
+ return self.recv_into(*args, **kwargs)
328
+
329
+ def settimeout(self, timeout):
330
+ return self.socket.settimeout(timeout)
331
+
332
+ def _send_until_done(self, data):
333
+ while True:
334
+ try:
335
+ return self.connection.send(data)
336
+ except OpenSSL.SSL.WantWriteError:
337
+ if not util.wait_for_write(self.socket, self.socket.gettimeout()):
338
+ raise timeout()
339
+ continue
340
+ except OpenSSL.SSL.SysCallError as e:
341
+ raise SocketError(str(e))
342
+
343
+ def sendall(self, data):
344
+ total_sent = 0
345
+ while total_sent < len(data):
346
+ sent = self._send_until_done(data[total_sent:total_sent + SSL_WRITE_BLOCKSIZE])
347
+ total_sent += sent
348
+
349
+ def shutdown(self):
350
+ # FIXME rethrow compatible exceptions should we ever use this
351
+ self.connection.shutdown()
352
+
353
+ def close(self):
354
+ if self._makefile_refs < 1:
355
+ try:
356
+ self._closed = True
357
+ return self.connection.close()
358
+ except OpenSSL.SSL.Error:
359
+ return
360
+ else:
361
+ self._makefile_refs -= 1
362
+
363
+ def getpeercert(self, binary_form=False):
364
+ x509 = self.connection.get_peer_certificate()
365
+
366
+ if not x509:
367
+ return x509
368
+
369
+ if binary_form:
370
+ return OpenSSL.crypto.dump_certificate(
371
+ OpenSSL.crypto.FILETYPE_ASN1,
372
+ x509)
373
+
374
+ return {
375
+ 'subject': (
376
+ (('commonName', x509.get_subject().CN),),
377
+ ),
378
+ 'subjectAltName': get_subj_alt_name(x509)
379
+ }
380
+
381
+ def _reuse(self):
382
+ self._makefile_refs += 1
383
+
384
+ def _drop(self):
385
+ if self._makefile_refs < 1:
386
+ self.close()
387
+ else:
388
+ self._makefile_refs -= 1
389
+
390
+
391
+ if _fileobject: # Platform-specific: Python 2
392
+ def makefile(self, mode, bufsize=-1):
393
+ self._makefile_refs += 1
394
+ return _fileobject(self, mode, bufsize, close=True)
395
+ else: # Platform-specific: Python 3
396
+ makefile = backport_makefile
397
+
398
+ WrappedSocket.makefile = makefile
399
+
400
+
401
+ class PyOpenSSLContext(object):
402
+ """
403
+ I am a wrapper class for the PyOpenSSL ``Context`` object. I am responsible
404
+ for translating the interface of the standard library ``SSLContext`` object
405
+ to calls into PyOpenSSL.
406
+ """
407
+ def __init__(self, protocol):
408
+ self.protocol = _openssl_versions[protocol]
409
+ self._ctx = OpenSSL.SSL.Context(self.protocol)
410
+ self._options = 0
411
+ self.check_hostname = False
412
+
413
+ @property
414
+ def options(self):
415
+ return self._options
416
+
417
+ @options.setter
418
+ def options(self, value):
419
+ self._options = value
420
+ self._ctx.set_options(value)
421
+
422
+ @property
423
+ def verify_mode(self):
424
+ return _openssl_to_stdlib_verify[self._ctx.get_verify_mode()]
425
+
426
+ @verify_mode.setter
427
+ def verify_mode(self, value):
428
+ self._ctx.set_verify(
429
+ _stdlib_to_openssl_verify[value],
430
+ _verify_callback
431
+ )
432
+
433
+ def set_default_verify_paths(self):
434
+ self._ctx.set_default_verify_paths()
435
+
436
+ def set_ciphers(self, ciphers):
437
+ if isinstance(ciphers, six.text_type):
438
+ ciphers = ciphers.encode('utf-8')
439
+ self._ctx.set_cipher_list(ciphers)
440
+
441
+ def load_verify_locations(self, cafile=None, capath=None, cadata=None):
442
+ if cafile is not None:
443
+ cafile = cafile.encode('utf-8')
444
+ if capath is not None:
445
+ capath = capath.encode('utf-8')
446
+ self._ctx.load_verify_locations(cafile, capath)
447
+ if cadata is not None:
448
+ self._ctx.load_verify_locations(BytesIO(cadata))
449
+
450
+ def load_cert_chain(self, certfile, keyfile=None, password=None):
451
+ self._ctx.use_certificate_chain_file(certfile)
452
+ if password is not None:
453
+ self._ctx.set_passwd_cb(lambda max_length, prompt_twice, userdata: password)
454
+ self._ctx.use_privatekey_file(keyfile or certfile)
455
+
456
+ def wrap_socket(self, sock, server_side=False,
457
+ do_handshake_on_connect=True, suppress_ragged_eofs=True,
458
+ server_hostname=None):
459
+ cnx = OpenSSL.SSL.Connection(self._ctx, sock)
460
+
461
+ if isinstance(server_hostname, six.text_type): # Platform-specific: Python 3
462
+ server_hostname = server_hostname.encode('utf-8')
463
+
464
+ if server_hostname is not None:
465
+ cnx.set_tlsext_host_name(server_hostname)
466
+
467
+ cnx.set_connect_state()
468
+
469
+ while True:
470
+ try:
471
+ cnx.do_handshake()
472
+ except OpenSSL.SSL.WantReadError:
473
+ if not util.wait_for_read(sock, sock.gettimeout()):
474
+ raise timeout('select timed out')
475
+ continue
476
+ except OpenSSL.SSL.Error as e:
477
+ raise ssl.SSLError('bad handshake: %r' % e)
478
+ break
479
+
480
+ return WrappedSocket(cnx, sock)
481
+
482
+
483
+ def _verify_callback(cnx, x509, err_no, err_depth, return_code):
484
+ return err_no == 0