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

webull/core/auth/algorithm/sha_hmac1.py

@@ -0,0 +1,65 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/algorithm/sha_hmac1.py
+which was part of Alibaba Group.
+"""
+
+import hashlib
+import hmac
+
+from webull.core.compat import ensure_string
+from webull.core.compat import ensure_bytes
+from webull.core.compat import b64_encode_bytes
+
+
+def get_sign_string(source, secret):
+    source = ensure_bytes(source)
+    secret = ensure_bytes(secret)
+    h = hmac.new(secret, source, hashlib.sha1)
+    signature = ensure_string(b64_encode_bytes(h.digest()).strip())
+    return signature
+
+
+def get_signer_name():
+    return "HMAC-SHA1"
+
+
+def get_signer_version():
+    return "1.0"
+
+
+def get_signer_type():
+    return ""

webull/core/auth/algorithm/sha_hmac256.py

@@ -0,0 +1,75 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/algorithm/sha_hmac256.py
+which was part of Alibaba Group.
+"""
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import hashes
+from cryptography.hazmat.primitives.asymmetric import padding
+from cryptography.hazmat.primitives.serialization import load_der_private_key
+
+from webull.core.compat import ensure_string
+from webull.core.compat import ensure_bytes
+from webull.core.compat import b64_encode_bytes
+from webull.core.compat import b64_decode_bytes
+
+
+def get_sign_string(source, access_secret):
+    key = load_der_private_key(
+        b64_decode_bytes(ensure_bytes(access_secret)),
+        password=None,
+        backend=default_backend()
+    )
+    signed_bytes = key.sign(
+        ensure_bytes(source),
+        padding.PKCS1v15(),
+        hashes.SHA256()
+    )
+    signed_base64 = b64_encode_bytes(signed_bytes)
+    signature = ensure_string(signed_base64).replace('\n', '')
+    return signature
+
+
+def get_signer_name():
+    return "SHA256withRSA"
+
+
+def get_signer_version():
+    return "1.0"
+
+
+def get_signer_type():
+    return "PRIVATEKEY"

webull/core/auth/composer/default_signature_composer.py

@@ -0,0 +1,125 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/composer/rpc_signature_composer.py
+which was part of Alibaba Group.
+"""
+
+from webull.core.auth.algorithm import sha_hmac1
+from webull.core.exception import error_code
+from webull.core.exception.exceptions import ClientException
+from webull.core.utils import common
+import webull.core.headers as hd
+from webull.core.vendored.six import iteritems
+from webull.core.vendored.six.moves.urllib.parse import quote
+import logging
+logger = logging.getLogger(__name__) 
+
+PARAM_KV_JOIN = "="
+PARAMS_JOIN = "&"
+SECRET_TAILER = "&"
+
+def _refresh_sign_headers(host, headers, app_key_id, signer_spec=sha_hmac1):
+    if not host:
+        raise ClientException(error_code.SDK_INVALID_PARAMETER)
+    sign_headers = {}
+    sign_headers[hd.APP_KEY] = app_key_id
+    sign_headers[hd.TIMESTAMP] = common.get_iso_8601_date()
+    sign_headers[hd.SIGN_VERSION] = signer_spec.get_signer_version()
+    sign_headers[hd.SIGN_ALGORITHM] = signer_spec.get_signer_name()
+    sign_headers[hd.NONCE] = common.get_uuid()
+    headers.update(sign_headers)
+    # DO NOT PUT Host Header in headers object, just put into sign_headers
+    sign_headers[hd.NATIVE_HOST] = host
+    return sign_headers
+
+def _gen_signature(string_to_sign, secret, signer_spec=sha_hmac1):
+    return signer_spec.get_sign_string(string_to_sign, secret + SECRET_TAILER)
+
+def _get_body_string(body_params):
+    if body_params is not None:
+        raw_str = common.json_dumps_compact(body_params)
+        hex_digest = common.md5_hex(raw_str)
+        return hex_digest.upper()
+    else:
+        return None
+
+def _build_sign_string(sign_params, uri, body_string):
+    string_to_sign = ""
+    if uri:
+        string_to_sign = uri
+    sorted_map = sorted(iteritems(sign_params), key=lambda item: item[0])
+    sorted_array = []
+    for (k, v) in sorted_map:
+        sorted_array.append(str(k) + PARAM_KV_JOIN + v)
+    if string_to_sign:
+        string_to_sign = string_to_sign + PARAMS_JOIN + PARAMS_JOIN.join(sorted_array)
+    else:
+        string_to_sign = PARAM_KV_JOIN.join(sorted_array)
+    if body_string:
+        string_to_sign = string_to_sign + PARAMS_JOIN + body_string
+    # All characters except alphabetic characters, digits, -, ., _, ~ will be encoded as %XX.
+    # So remove the default safe char '/' which should be quoted as %20F
+    return quote(string_to_sign, safe='')
+
+def _lower_key_dict(od):
+    lower_key_dict = {}
+    for (k, v) in iteritems(od):
+        lower_key_dict[k.lower()] = v
+    return lower_key_dict
+
+def calc_signature(headers, host, uri, queries, body_params, app_key_id, app_key_secret, signer_spec=sha_hmac1):
+    sign_headers = _refresh_sign_headers(host, headers, app_key_id, signer_spec)
+    logger.debug("sign_headers:%s", sign_headers)
+    sign_params = _lower_key_dict(sign_headers)
+    logger.debug("sign_queries:%s", queries)
+    if queries :
+        for (k, v) in iteritems(queries):
+            cv = sign_params.get(k)
+            if cv is not None:
+                cv = str(cv) + PARAMS_JOIN + str(v)
+            else:
+                cv = str(v)
+            sign_params[k] = cv
+    logger.debug("body:%s", body_params)
+    body_string = _get_body_string(body_params)
+    logger.debug("body_string:%s" % body_string)
+    string_to_sign = _build_sign_string(sign_params, uri, body_string)
+    logger.debug("string_to_sign:%s" % string_to_sign)
+    signature = _gen_signature(string_to_sign, app_key_secret, signer_spec)
+    headers[hd.SIGNATURE] = signature
+    logger.debug("signature:%s", signature)
+    return signature
+

webull/core/auth/credentials.py

@@ -0,0 +1,46 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/credentials.py
+which was part of Alibaba Group.
+"""
+
+
+class AppKeyCredential:
+    def __init__(self, app_key_id, app_key_secret):
+        self.app_key_id = app_key_id
+        self.app_key_secret = app_key_secret

webull/core/auth/signers/app_key_signer.py

@@ -0,0 +1,72 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/signers/access_key_signer.py
+which was part of Alibaba Group.
+"""
+
+import logging
+from webull.core.auth.signers.signer import Signer
+
+logger = logging.getLogger(__name__) 
+
+class AppKeySigner(Signer):
+    def __init__(self, app_key_credential):
+        self._credential = app_key_credential
+
+    def sign(self, request):
+        cred = self._credential
+        host = request.get_endpoint()
+        header = request.get_signed_header(host, cred.app_key_id, cred.app_key_secret)
+        return header

webull/core/auth/signers/signer.py

@@ -0,0 +1,48 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/signers/signer.py
+which was part of Alibaba Group.
+"""
+
+from abc import ABCMeta, abstractmethod
+from webull.core.vendored.six import with_metaclass
+
+class Signer(with_metaclass(ABCMeta, object)):
+    @abstractmethod
+    def sign(self, request):
+        pass

webull/core/auth/signers/signer_factory.py

@@ -0,0 +1,58 @@
+# Copyright 2022 Webull
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# 	http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# coding=utf-8
+
+"""
+This file borrowed some of its methods from a  modified fork of the
+https://github.com/aliyun/aliyun-openapi-python-sdk/blob/master/aliyun-python-sdk-core/aliyunsdkcore/auth/signers/signer_factory.py
+which was part of Alibaba Group.
+"""
+
+import os
+from webull.core.auth import credentials
+from webull.core.auth.signers import app_key_signer
+from webull.core.exception import exceptions, error_code
+
+class SignerFactory(object):
+    @staticmethod
+    def get_signer(credential):
+        if credential.get('app_key') is not None and credential.get('app_secret') is not None:
+            ak_cred = credentials.AppKeyCredential(credential.get('app_key'), credential.get('app_secret'))
+            return app_key_signer.AppKeySigner(ak_cred)
+        elif os.environ.get('WEBULL_APP_KEY_ID') is not None \
+            and os.environ.get('WEBULL_APP_KEY_SECRET') is not None:
+                ak_cred = credentials.AppKeyCredential(os.environ.get('WEBULL_APP_KEY_ID'), os.environ.get('WEBULL_APP_KEY_SECRET'))
+                return app_key_signer.AppKeySigner(ak_cred)
+        else:
+            raise exceptions.ClientException(error_code.SDK_INVALID_CREDENTIAL)