tccli 3.0.1215.1__py2.py3-none-any.whl → 3.0.1217.1__py2.py3-none-any.whl

tccli/__init__.py

@@ -1 +1 @@
-__version__ = '3.0.1215.1'
+__version__ = '3.0.1217.1'

tccli/argparser.py

@@ -58,7 +58,7 @@ class BaseArgParser(argparse.ArgumentParser):
     def parse_known_args(self, args=None, namespace=None):
         parsed, remaining = super(BaseArgParser, self).parse_known_args(args, namespace)
         terminal_encoding = getattr(sys.stdin, 'encoding', 'utf-8')
-        if terminal_encoding is None:
+        if terminal_encoding is None or terminal_encoding == 'cp65001':
             terminal_encoding = 'utf-8'
         for arg, value in vars(parsed).items():
             if isinstance(value, six.binary_type):

tccli/command.py

@@ -7,7 +7,7 @@ import tccli.services as Services
 import tccli.options_define as Options_define
 from collections import OrderedDict
 
-from tccli import oauth
+from tccli import credentials
 from tccli.utils import Utils
 from tccli.argument import CLIArgument, CustomArgument, ListArgument, BooleanArgument
 from tccli.exceptions import UnknownArgumentError
@@ -291,7 +291,7 @@ class ActionCommand(BaseCommand):
             action_parameters = self.cli_unfold_argument.build_action_parameters(parsed_args)
         else:
             action_parameters = self._build_action_parameters(parsed_args, self.argument_map)
-        oauth.maybe_refresh_credential(parsed_globals.profile if parsed_globals.profile else "default")
+        credentials.maybe_refresh_credential(parsed_globals.profile if parsed_globals.profile else "default")
         return self._action_caller(action_parameters, vars(parsed_globals))
 
     def create_help_command(self):

tccli/configure.py

@@ -230,6 +230,50 @@ class ConfigureSetCommand(BasicConfigure):
             self._init_configure(profile_name + '.credential', cred)
 
 
+class ConfigureSetRootDomainCommand(BasicConfigure):
+    NAME = 'set-root-domain'
+    DESCRIPTION = 'Set the root domain name for all endpoints.'
+    USEAGE = 'tccli configure set-root-domain [root-domain-value] [--profile profile-name]'
+    AVAILABLECONFIG = "[cvm, cbs ...].endpoint: service [cvm cbs ...] access point root domain name"
+    EXAMPLES = "$ tccli configure set-root-domain internal.tencentcloudapi.com --profile test"
+    ARG_TABLE = [
+        {'name': 'varname',
+         'help_text': 'The name of the root domain value to set.',
+         'action': 'store',
+         'nargs': '+',
+         'cli_type_name': 'string',
+         'positional_arg': True},
+    ]
+
+    def __init__(self):
+        super(ConfigureSetRootDomainCommand, self).__init__()
+
+    def _run_main(self, args, parsed_globals):
+        var_value = args.varname
+        if len(var_value) != 1:
+            raise ParamError("Unexpected format\n"
+                             "Expected input format：\n\n"
+                             "   $tccli configure set-root-domain internal.tencentcloudapi.com\n")
+        profile_name = self._get_profile_name(parsed_globals)
+        profile_name = profile_name + '.configure'
+
+        conf_data = {}
+        is_exist, config_path = self._profile_existed(profile_name)
+        if is_exist:
+            conf_data = Utils.load_json_msg(config_path)
+        if profile_name.endswith(".configure"):
+            for mod in self._cli_data.get_available_services().keys():
+                if mod not in conf_data:
+                    conf_data[mod] = {}
+                    conf_data[mod]["endpoint"] = "%s.tencentcloudapi.com" % mod
+                if mod != 'autoscaling':
+                    conf_data[mod]["endpoint"] = "%s.%s" % (mod, var_value[0])
+                else:
+                    conf_data[mod]["endpoint"] = "as.%s" % var_value[0]
+                conf_data[mod]["version"] = self._cli_data.get_available_services()[mod][0]
+        Utils.dump_json_msg(config_path, conf_data)
+
+
 class ConfigureGetCommand(BasicConfigure):
     NAME = 'get'
     DESCRIPTION = "get your profile(eg:SecretId, SecretKey, Region)."
@@ -342,7 +386,8 @@ class ConfigureCommand(BasicConfigure):
         {'name': 'list', 'command_class': ConfigureListCommand},
         {'name': 'get', 'command_class': ConfigureGetCommand},
         {'name': 'set', 'command_class': ConfigureSetCommand},
-        {'name': 'remove', 'command_class': ConfigureRemoveCommand}
+        {'name': 'remove', 'command_class': ConfigureRemoveCommand},
+        {'name': 'set-root-domain', 'command_class': ConfigureSetRootDomainCommand},
     ]
 
     VALUES_TO_PROMPT = [

tccli/credentials.py

@@ -0,0 +1,25 @@
+import json
+import os
+
+from tccli import oauth, sso
+
+
+def maybe_refresh_credential(profile):
+    try:
+        with open(cred_path_of_profile(profile), "r") as cred_file:
+            cred = json.load(cred_file)
+    except IOError:
+        # file not found, don't check
+        return
+
+    if cred.get("type", "") == "oauth":
+        oauth.maybe_refresh_credential(profile)
+        return
+
+    if cred.get("type", "") == "sso":
+        sso.maybe_refresh_credential(profile)
+        return
+
+
+def cred_path_of_profile(profile):
+    return os.path.join(os.path.expanduser("~"), ".tccli", profile + ".credential")

tccli/main.py

@@ -4,14 +4,18 @@ import _locale
 _locale._getdefaultlocale = (lambda *args: ['zh_CN', 'utf8'])
 
 import io
-import os
 import sys
 import six
-import signal
 from tccli.log import init
 from tencentcloud.common.exception.tencent_cloud_sdk_exception import TencentCloudSDKException
 
 try:
+    # cp65001 is utf-8 on windows platform
+    # python2 doesn't support cp65001 codec
+    if getattr(sys.stdin, 'encoding', 'utf-8') == "cp65001":
+        import codecs
+        codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
+
     reload(sys)  # Python 2.7
     sys.setdefaultencoding('utf8')
 except NameError:

tccli/plugins/sso/__init__.py

@@ -0,0 +1,61 @@
+# encoding: utf-8
+from tccli.plugins.sso.login import login_command_entrypoint
+from tccli.plugins.sso.logout import logout_command_entrypoint
+from tccli.plugins.sso.configure import configure_command_entrypoint
+
+service_name = "sso"
+service_version = "2024-10-14"
+
+_spec = {
+    "metadata": {
+        "serviceShortName": service_name,
+        "apiVersion": service_version,
+        "description": "sso related commands",
+    },
+    "actions": {
+        "configure": {
+            "name": "配置",
+            "document": "configure login url",
+            "input": "configureRequest",
+            "output": "configureResponse",
+            "action_caller": configure_command_entrypoint,
+        },
+        "login": {
+            "name": "登录",
+            "document": "login through sso",
+            "input": "loginRequest",
+            "output": "loginResponse",
+            "action_caller": login_command_entrypoint,
+        },
+        "logout": {
+            "name": "登出",
+            "document": "remove local credential file",
+            "input": "logoutRequest",
+            "output": "logoutResponse",
+            "action_caller": logout_command_entrypoint,
+        },
+    },
+    "objects": {
+        "loginRequest": {"members": []},
+        "loginResponse": {"members": []},
+        "logoutRequest": {"members": []},
+        "logoutResponse": {"members": []},
+        "configureRequest": {"members": [
+            {
+                "name": "url",
+                "member": "string",
+                "type": "string",
+                "required": True,
+                "document": "url for sso authentication",
+            },
+        ]},
+        "configureResponse": {"members": []},
+    },
+    "version": "1.0",
+}
+
+
+def register_service(specs):
+    specs[service_name] = {
+        service_version: _spec,
+    }

tccli/plugins/sso/configs.py

@@ -0,0 +1,4 @@
+# encoding: utf-8
+CLI_URL = "https://cli.cloud.tencent.com/sso"
+SITE = "cn"
+DEFAULT_LANG = "zh-CN"

tccli/plugins/sso/configure.py

@@ -0,0 +1,45 @@
+# coding: utf-8
+import json
+try:
+    from urlparse import urlparse
+except ImportError:
+    from urllib.parse import urlparse
+
+from tccli import sso
+from tccli.plugins.sso import texts, configs
+
+
+def configure_command_entrypoint(args, parsed_globals):
+    language = parsed_globals.get("language")
+    if not language:
+        language = configs.DEFAULT_LANG
+    texts.set_lang(language)
+
+    profile = parsed_globals.get("profile", "default")
+    if not profile:
+        profile = "default"
+
+    cred_data = {}
+    try:
+        with open(sso.cred_path_of_profile(profile), "r") as cred_file:
+            cred_data = json.load(cred_file)
+    except IOError:
+        pass
+
+    if "sso" not in cred_data:
+        cred_data["sso"] = {}
+
+    auth_url = args.get("url")
+    if not auth_url.startswith("http://") and not auth_url.startswith("https://"):
+        auth_url = "https://" + auth_url
+
+    parsed_url = urlparse(auth_url)
+    if not (parsed_url.scheme in ("http", "https") and parsed_url.netloc):
+        print(texts.get("invalid_auth_url") % auth_url)
+        return
+
+    cred_data["sso"]["authUrl"] = auth_url
+    with open(sso.cred_path_of_profile(profile), "w") as cred_file:
+        json.dump(cred_data, cred_file, indent=4)
+
+    print(texts.get("configure_succeed") % auth_url)

tccli/plugins/sso/login.py

@@ -0,0 +1,144 @@
+# coding: utf-8
+import json
+import os.path
+import random
+import string
+import sys
+import time
+import uuid
+import webbrowser
+
+from six.moves.urllib.parse import urlencode
+
+from tccli import sso
+from tccli.plugins.sso import texts, terminal, configs
+from tccli.plugins.sso.texts import get as _
+
+
+def print_message(msg):
+    print(msg)
+    sys.stdout.flush()
+
+
+def login_command_entrypoint(args, parsed_globals):
+    language = parsed_globals.get("language")
+    if not language:
+        language = configs.DEFAULT_LANG
+    texts.set_lang(language)
+
+    profile = parsed_globals.get("profile", "default")
+    if not profile:
+        profile = "default"
+
+    login(profile, language)
+
+
+def login(profile, language):
+    cred_path = sso.cred_path_of_profile(profile)
+    auth_url = ""
+    if os.path.exists(cred_path):
+        with open(cred_path, "r") as cred_file:
+            cred_data = json.load(cred_file)
+            auth_url = cred_data.get("sso", {}).get("authUrl", "")
+
+    if not auth_url:
+        profile_opt = ""
+        if profile != "default":
+            profile_opt = "--profile %s " % profile
+        print_message(_("auth_url_not_configured") % profile_opt)
+        return
+
+    characters = string.ascii_letters + string.digits
+    state = ''.join(random.choice(characters) for x in range(32))
+
+    token = _get_token(auth_url, state, language)
+
+    if token["State"] != state:
+        raise ValueError("invalid state %s" % token["state"])
+
+    print_message("")
+
+    login_token = token["Token"]
+    site = token["Site"]
+    accounts = sso.list_accounts_for_access_assignment(login_token, site)
+    if not accounts:
+        print_message(_("no_account"))
+        return
+
+    idx = terminal.select_from_items(
+        _("account_select_prompt"), ["%s:%s" % (x["Name"], x["Uin"]) for x in accounts], 10)
+    account = accounts[idx]
+    print_message("uin: %s" % account["Uin"])
+    print_message("username: %s" % account["Name"])
+
+    roles = sso.list_role_configurations_for_account(account["Uin"], login_token, site)
+    if not roles:
+        print_message(_("no_role"))
+        return
+
+    idx = terminal.select_from_items(
+        _("role_select_prompt"), [x["RoleConfigurationName"] for x in roles], 10)
+    role = roles[idx]
+    print_message("role: %s" % role["RoleConfigurationName"])
+
+    saml_resp = sso.gen_saml_response(
+        login_token, "RoleSAML", account["Uin"], "", role["RoleConfigurationId"], site)
+
+    token_info = sso.verify_login_skey(login_token, site)
+
+    role_arn = "qcs::cam::uin/%s:roleName/TencentCloudSSO-%s" % (account["Uin"], role["RoleConfigurationName"])
+    principal_arn = "qcs::cam::uin/%s:saml-provider/TencentReservedSSO-%s" % (account["Uin"], token_info["ZoneId"])
+    cred = sso.assume_role_with_saml(
+        saml_resp["SAMLResponse"], principal_arn, role_arn, "ses-%s" % uuid.uuid4(), 7200, site)
+
+    sso_info = {
+        "token": login_token,
+        "uin": account["Uin"],
+        "roleConfigurationId": role["RoleConfigurationId"],
+        "roleConfigurationName": role["RoleConfigurationName"],
+        "zoneId": token_info["ZoneId"],
+        "site": site,
+        "authUrl": auth_url,
+        "expiresAt": int(time.time()) + 3600 * 12,
+    }
+    sso.save_credential(cred, sso_info, profile)
+
+    print_message(_("login_success") % sso.cred_path_of_profile(profile))
+
+
+def _get_token(auth_url, state, language):
+    cli_params = {
+        "lang": language,
+        "site": configs.SITE,
+        "state": state,
+    }
+    cli_query = urlencode(cli_params)
+    cli_url = configs.CLI_URL + "?" + cli_query
+    url_params = {
+        "loginType": "tccli",
+        "callback": cli_url,
+        "state": state,
+    }
+    url_query = urlencode(url_params)
+    auth_url = auth_url + "?" + url_query
+
+    print_message(_("try_login_with_url"))
+    print_message("")
+    print_message(auth_url)
+
+    webbrowser.open(auth_url)
+
+    while True:
+        time.sleep(1)
+
+        login_state = sso.check_login_state(state)
+        if "Error" in login_state:
+            raise ValueError(login_state["Error"])
+
+        if login_state["Status"] == "NotFound":
+            continue
+
+        if login_state["Status"] == "Finished":
+            return login_state["Token"]
+
+        raise ValueError("invalid resp: %s" % login_state)

tccli/plugins/sso/logout.py

@@ -0,0 +1,21 @@
+# coding: utf-8
+import os
+
+from tccli import sso
+from tccli.plugins.sso import texts, configs
+
+
+def logout_command_entrypoint(args, parsed_globals):
+    language = parsed_globals.get("language")
+    if not language:
+        language = configs.DEFAULT_LANG
+    texts.set_lang(language)
+
+    profile = parsed_globals.get("profile", "default")
+    if not profile:
+        profile = "default"
+
+    cred_path = sso.cred_path_of_profile(profile)
+    if os.path.exists(cred_path):
+        os.remove(cred_path)
+    print(texts.get("logout_success") % cred_path)

tccli/plugins/sso/terminal.py

@@ -0,0 +1,161 @@
+# encoding: utf-8
+import math
+import sys
+import os
+from string import ascii_letters, digits, punctuation
+
+_LEFT_ARROW = "LEFT_ARROW"
+_RIGHT_ARROW = "RIGHT_ARROW"
+_UP_ARROW = "UP_ARROW"
+_DOWN_ARROW = "DOWN_ARROW"
+_CTRL_C = "\x03"
+_ENTER = "\r"
+_BACKSPACE = "\x7f"
+_EL = "\033[K"
+_CPL = "\033[F"
+_LIGHTBLUE = "\033[94m"
+_LIGHTBLUE_END = "\033[0m"
+
+_win = os.name == "nt"
+
+
+class Printer(object):
+    def __init__(self):
+        self._n = 0
+
+    def print_lines(self, lines):
+        self.clear()
+        lines = [line + '\n' for line in lines]
+        sys.stdout.writelines(lines)
+        sys.stdout.flush()
+        self._n = len(lines)
+
+    def clear(self):
+        for _ in range(self._n):
+            self.move_up()
+            self.clear_cur_line()
+
+    @staticmethod
+    def clear_cur_line():
+        sys.stdout.write(_EL)
+
+    @staticmethod
+    def move_up():
+        sys.stdout.write(_CPL)
+
+
+def _select_from_items_unix(prompt, items, page_size):
+    p = Printer()
+
+    selection = 0
+    search = ""
+
+    while True:
+        filtered_items = [item for item in items if search in item] if search else items
+
+        page_total = math.ceil(len(filtered_items) / float(page_size))
+        page_num = selection // page_size + 1
+        page_start = page_size * (page_num - 1)
+        page_items = list(filtered_items[page_start: page_start + page_size])
+
+        for i in range(len(page_items)):
+            selection_i = selection % page_size
+            selection_prompt = "*  " if i == selection_i else "   "
+            page_items[i] = selection_prompt + _LIGHTBLUE + page_items[i] + _LIGHTBLUE_END
+
+        page_lines = ["", "%s%s" % (prompt, search), ""] + page_items + ["", "page: %d/%d" % (page_num, page_total)]
+        p.print_lines(page_lines)
+
+        ch = _getch_wrap()
+
+        if ch == _CTRL_C:
+            raise KeyboardInterrupt()
+
+        if ch == _UP_ARROW:
+            selection = max(0, selection - 1)
+        elif ch == _DOWN_ARROW:
+            selection = min(len(filtered_items) - 1, selection + 1)
+        elif ch == _LEFT_ARROW:
+            if selection - page_size >= 0:
+                selection -= page_size
+        elif ch == _RIGHT_ARROW:
+            selection = min(len(filtered_items) - 1, selection + page_size)
+        elif ch == _BACKSPACE:
+            search = search[:len(search) - 1] if search else ""
+            selection = 0
+        elif ch == _ENTER:
+            idx = 0
+            matched = -1
+
+            for item in items:
+                if search in item:
+                    matched += 1
+                if matched == selection:
+                    p.print_lines([])
+                    return idx
+                idx += 1
+
+        elif ch in (ascii_letters + digits + punctuation):
+            search += ch
+            selection = 0
+
+
+def _select_from_items_win(prompt, items, page_size):
+    print("")
+    print("--------------------------------")
+    for i in range(len(items)):
+        print("%d. %s" % (i, items[i]))
+
+    print("--------------------------------")
+    sys.stdout.flush()
+
+    try:
+        input_func = raw_input
+    except NameError:
+        input_func = input
+
+    while True:
+        try:
+            sys.stdout.write(prompt)
+            idx = int(input_func())
+            if 0 <= idx < len(items):
+                return idx
+        except ValueError:
+            pass
+
+
+select_from_items = _select_from_items_win if _win else _select_from_items_unix
+
+if not _win:
+    def getch():
+        import sys
+        import tty
+        import termios
+        fd = sys.stdin.fileno()
+        old = termios.tcgetattr(fd)
+        try:
+            tty.setraw(fd)
+            return sys.stdin.read(1)
+        finally:
+            termios.tcsetattr(fd, termios.TCSADRAIN, old)
+
+
+    def _getch_wrap():
+        ch = getch()
+        if ch == "\x1b":
+            ch1 = getch()
+            if ch1 != "[":
+                raise KeyError(ch1)
+            ch2 = getch()
+            if ch2 == "A":
+                return _UP_ARROW
+            if ch2 == "B":
+                return _DOWN_ARROW
+            if ch2 == "C":
+                return _RIGHT_ARROW
+            if ch2 == "D":
+                return _LEFT_ARROW
+
+            raise KeyError(ch + ch1 + ch2)
+        else:
+            return ch

tccli/plugins/sso/texts.py

@@ -0,0 +1,40 @@
+# encoding: utf-8
+from tccli.plugins.sso import configs
+
+_lang = configs.DEFAULT_LANG
+
+texts = {
+    "zh-CN": {
+        "invalid_auth_url": "输入的 url 不合法: %s",
+        "auth_url_not_configured": "尚未配置 sso url, 使用 `tccli sso configure %s--url https://your-login-domain.com` 来进行配置",
+        "configure_succeed": "url 已配置为 '%s', 接下来可以使用 `tccli sso login` 进行登陆",
+        "try_login_with_url": "在浏览器中转到以下链接, 并根据提示完成登录:",
+        "account_select_prompt": "登录成功, 请选择您的用户: ",
+        "role_select_prompt": "请选择您的角色: ",
+        "login_success": "登录成功, 密钥凭证已被写入: %s",
+        "logout_success": "登出成功, 密钥凭证已被删除: %s",
+        "no_account": "未找到成员账号, 请确认是否同步过 CAM 角色",
+        "no_role": "当前成员账号不存在授权角色",
+    },
+    "en-US": {
+        "invalid_auth_url": "The entered url is invalid: %s",
+        "auth_url_not_configured": "sso url is not configured yet, use `tccli sso configure %s--url https://your-login-domain.com` to configure",
+        "configure_succeed": "The url has been configured as '%s', use `tccli sso login` to log in",
+        "try_login_with_url": "Go to the following link in your browser, and complete the sign-in prompts:",
+        "account_select_prompt": "Login succeed, choose your account: ",
+        "role_select_prompt": "choose your role: ",
+        "login_success": "Login succeed, credential has been written to %s",
+        "logout_success": "Logout succeed, credential has been removed: %s",
+        "no_account": "no account found, please confirm the account is synchronized",
+        "no_role": "no role found in current account",
+    }
+}
+
+
+def set_lang(lang):
+    global _lang
+    _lang = lang
+
+
+def get(key):
+    return texts[_lang][key]

tccli/services/__init__.py

@@ -88,6 +88,9 @@ SERVICE_VERSIONS = {
     "bda": [
         "2020-03-24"
     ],
+    "bh": [
+        "2023-04-18"
+    ],
     "bi": [
         "2022-01-05"
     ],
@@ -236,9 +239,6 @@ SERVICE_VERSIONS = {
     "cpdp": [
         "2019-08-20"
     ],
-    "cr": [
-        "2018-03-21"
-    ],
     "csip": [
         "2022-11-21"
     ],
@@ -401,6 +401,9 @@ SERVICE_VERSIONS = {
     "iecp": [
         "2021-09-14"
     ],
+    "ig": [
+        "2021-05-18"
+    ],
     "iir": [
         "2020-04-17"
     ],