skyplatform-iam 1.0.3__py3-none-any.whl → 1.1.0__py3-none-any.whl

skyplatform_iam/__init__.py

@@ -21,6 +21,9 @@ __version__ = "1.0.0"
 __author__ = "x9"
 __description__ = "SkyPlatform IAM认证SDK，提供FastAPI中间件和IAM服务连接功能"
 
+# 全局IAM客户端实例
+_global_iam_client = None
+
 # 导出主要类和函数
 __all__ = [
     # 配置
@@ -35,6 +38,7 @@ __all__ = [
     
     # 客户端
     "ConnectAgenterraIam",
+    "get_iam_client",
     
     # 异常
     "SkyPlatformAuthException",
@@ -74,7 +78,7 @@ def create_auth_middleware(config: AuthConfig = None, **kwargs) -> AuthMiddlewar
     return AuthMiddleware(config=config, **kwargs)
 
 
-def setup_auth(app, config: AuthConfig = None):
+def init_skyplatform_iam(app, config: AuthConfig = None):
     """
     一键设置认证中间件的便捷函数
     
@@ -103,4 +107,55 @@ def setup_auth(app, config: AuthConfig = None):
     middleware = AuthMiddleware(app=app, config=config)
     app.add_middleware(AuthMiddleware, config=config)
     
-    return middleware
+    return middleware
+
+
+def get_iam_client(config: AuthConfig = None) -> ConnectAgenterraIam:
+    """
+    获取全局IAM客户端实例
+    
+    Args:
+        config: 认证配置，如果为None则从环境变量创建
+        
+    Returns:
+        ConnectAgenterraIam: IAM客户端实例
+        
+    Note:
+        此函数使用单例模式，确保整个应用中只有一个IAM客户端实例。
+        第一次调用时会创建实例，后续调用会返回同一个实例。
+        如果需要更新配置，可以传入新的config参数。
+        
+    Example:
+        # 使用默认配置（从环境变量）
+        iam_client = get_iam_client()
+        
+        # 使用自定义配置
+        config = AuthConfig(
+            agenterra_iam_host="https://iam.example.com",
+            server_name="my_server",
+            access_key="my_access_key"
+        )
+        iam_client = get_iam_client(config)
+        
+        # 调用IAM服务方法
+        result = iam_client.register(
+            cred_type="username",
+            cred_value="test_user",
+            password="password123"
+        )
+    """
+    global _global_iam_client
+    
+    # 如果传入了新的配置，或者实例不存在，则创建/更新实例
+    if config is not None:
+        if _global_iam_client is None:
+            _global_iam_client = ConnectAgenterraIam(config=config)
+        else:
+            # 重新加载配置
+            _global_iam_client.reload_config(config)
+    elif _global_iam_client is None:
+        # 使用默认配置创建实例
+        default_config = AuthConfig.from_env()
+        _global_iam_client = ConnectAgenterraIam(config=default_config)
+    
+    return _global_iam_client

skyplatform_iam/connect_agenterra_iam.py

@@ -189,7 +189,7 @@ class ConnectAgenterraIam(object):
             self.logger.info(f"[{method_name}] 响应状态码: {response.status_code}")
             self.logger.info(f"[{method_name}] 响应内容解析失败: {str(e)}")
 
-    def register(self, cred_type=None, cred_value=None, password=None, nickname=None, avatar_url=None, 
+    def register(self, cred_type=None, cred_value=None, password=None, nickname=None, avatar_url=None,
                  username=None, phone=None):
         """
         注册用户时，同步至iam
@@ -212,8 +212,9 @@ class ConnectAgenterraIam(object):
         - 失败: 返回False
         """
         method_name = "register"
-        self.logger.info(f"[{method_name}] 开始用户注册 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始用户注册 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
+
         try:
             # 参数映射：支持旧的调用方式
             if cred_type is None and cred_value is None:
@@ -249,10 +250,10 @@ class ConnectAgenterraIam(object):
 
             uri = "/api/v2/service/register"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -272,7 +273,7 @@ class ConnectAgenterraIam(object):
                     self.logger.warning(f"[{method_name}] 用户注册失败 - 响应: {result}")
             else:
                 self.logger.warning(f"[{method_name}] 用户注册失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 注册请求异常: {str(e)}")
@@ -280,7 +281,7 @@ class ConnectAgenterraIam(object):
             return False
 
     def login_with_password(self, cred_type=None, cred_value=None, password=None, ip_address=None, user_agent=None,
-                           username=None):
+                            username=None):
         """
         账号密码登陆时，同步至iam，由iam签发token
 
@@ -296,8 +297,9 @@ class ConnectAgenterraIam(object):
         - password: 用户密码
         """
         method_name = "login_with_password"
-        self.logger.info(f"[{method_name}] 开始密码登录 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始密码登录 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
+
         try:
             # 参数映射：支持旧的调用方式
             if cred_type is None and cred_value is None:
@@ -328,10 +330,10 @@ class ConnectAgenterraIam(object):
 
             uri = "/api/v2/service/login"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -347,7 +349,7 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 密码登录失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 密码登录请求异常: {str(e)}")
@@ -355,7 +357,7 @@ class ConnectAgenterraIam(object):
             return False
 
     def login_without_password(self, cred_type=None, cred_value=None, ip_address=None, user_agent=None,
-                              username=None):
+                               username=None):
         """
         短信验证码登陆时，机机接口请求token
 
@@ -371,8 +373,9 @@ class ConnectAgenterraIam(object):
         返回: response对象或False
         """
         method_name = "login_without_password"
-        self.logger.info(f"[{method_name}] 开始免密登录 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始免密登录 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(str(cred_value))}")
+
         try:
             # 参数映射：支持旧的调用方式
             if cred_type is None and cred_value is None:
@@ -402,10 +405,10 @@ class ConnectAgenterraIam(object):
 
             uri = "/api/v2/service/login_without_password"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -421,7 +424,7 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 免密登录失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 免密登录请求异常: {str(e)}")
@@ -436,7 +439,7 @@ class ConnectAgenterraIam(object):
         """
         method_name = "logout"
         self.logger.info(f"[{method_name}] 开始用户登出 - token: {self._mask_sensitive(token)}")
-        
+
         try:
             body = {
                 "server_name": self.server_name,
@@ -445,7 +448,7 @@ class ConnectAgenterraIam(object):
             }
             uri = "/api/v2/service/logout"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
 
@@ -464,7 +467,7 @@ class ConnectAgenterraIam(object):
                 return True
             else:
                 self.logger.warning(f"[{method_name}] 用户登出失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 登出请求异常: {str(e)}")
@@ -484,8 +487,9 @@ class ConnectAgenterraIam(object):
         - token无效或其他错误: 返回None
         """
         method_name = "verify_token"
-        self.logger.info(f"[{method_name}] 开始token验证 - api: {api}, method: {method}, token: {self._mask_sensitive(token)}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始token验证 - api: {api}, method: {method}, token: {self._mask_sensitive(token)}")
+
         try:
             body = {
                 "server_name": self.server_name,
@@ -497,16 +501,16 @@ class ConnectAgenterraIam(object):
                 "server_sk": server_sk,
             }
             uri = "/api/v2/service/verify"
-            
+
             # 检查agenterra_iam_host是否为None
             if self.agenterra_iam_host is None:
                 raise ValueError("AGENTERRA_IAM_HOST 配置未设置或为空，请确保传入正确的AuthConfig对象")
-                
+
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -530,7 +534,8 @@ class ConnectAgenterraIam(object):
                             "microservice": result.get("microservice"),
                             "is_whitelist": result.get("is_whitelist", False)
                         }
-                        self.logger.info(f"[{method_name}] token验证成功，用户有权限 - user_id: {user_info.get('user_id')}")
+                        self.logger.info(
+                            f"[{method_name}] token验证成功，用户有权限 - user_id: {user_info.get('user_id')}")
                         return user_info
                     else:
                         # token有效但无权限，抛出403异常
@@ -540,7 +545,8 @@ class ConnectAgenterraIam(object):
                             detail=result.get("message", "用户无权限访问此API")
                         )
                 else:
-                    self.logger.warning(f"[{method_name}] token验证失败 - success: {result.get('success')}, valid: {result.get('valid')}")
+                    self.logger.warning(
+                        f"[{method_name}] token验证失败 - success: {result.get('success')}, valid: {result.get('valid')}")
 
             elif response.status_code == 403:
                 result = response.json()
@@ -576,11 +582,11 @@ class ConnectAgenterraIam(object):
         """
         method_name = "reset_password"
         self.logger.info(f"[{method_name}] 开始重置密码 - user_id: {user_id}")
-        
+
         # 记录旧参数格式的使用
         if username or password:
             self.logger.debug(f"[{method_name}] 检测到旧参数格式 - username: {username}")
-        
+
         try:
             # 参数映射：支持旧的调用方式
             if user_id is None and new_password is None:
@@ -599,26 +605,26 @@ class ConnectAgenterraIam(object):
             }
             uri = "/api/v2/service/reset_password"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
                 json=body,
                 verify=False
             )
-            
+
             # 记录响应信息
             self._log_response(method_name, response)
-            
+
             if response.status_code == 200:
                 self.logger.info(f"[{method_name}] 密码重置成功")
                 return True
             else:
                 self.logger.warning(f"[{method_name}] 密码重置失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 重置密码请求异常: {str(e)}")
@@ -636,7 +642,7 @@ class ConnectAgenterraIam(object):
         """
         method_name = "refresh_token"
         self.logger.info(f"[{method_name}] 开始刷新令牌 - refresh_token: {self._mask_sensitive(refresh_token)}")
-        
+
         try:
             body = {
                 "server_name": self.server_name,
@@ -645,10 +651,10 @@ class ConnectAgenterraIam(object):
             }
             uri = "/api/v2/service/refresh_token"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -664,7 +670,7 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 令牌刷新失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 刷新令牌请求异常: {str(e)}")
@@ -683,7 +689,7 @@ class ConnectAgenterraIam(object):
         """
         method_name = "assign_role_to_user"
         self.logger.info(f"[{method_name}] 开始角色分配 - user_id: {user_id}, role_id: {role_id}")
-        
+
         try:
             body = {
                 "server_name": self.server_name,
@@ -693,10 +699,10 @@ class ConnectAgenterraIam(object):
             }
             uri = "/api/v2/service/assign_role"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -712,7 +718,7 @@ class ConnectAgenterraIam(object):
                 return True
             else:
                 self.logger.warning(f"[{method_name}] 角色分配失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 角色分配请求异常: {str(e)}")
@@ -725,7 +731,7 @@ class ConnectAgenterraIam(object):
                 """
         method_name = "get_userinfo_by_token"
         self.logger.info(f"[{method_name}] 开始获取用户信息 - token: {self._mask_sensitive(token)}")
-        
+
         try:
             body = {
                 "server_name": self.server_name,
@@ -734,10 +740,10 @@ class ConnectAgenterraIam(object):
             }
             uri = "/api/v2/service/token"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -753,17 +759,179 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 获取用户信息失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 获取用户信息请求异常: {str(e)}")
             self.logger.error(f"[{method_name}] 异常堆栈: {traceback.format_exc()}")
             return False
 
+    def add_custom_config(self, user_id, config_name, config_value=None):
+        """
+        机机接口：添加用户自定义配置
+
+        为指定用户添加或更新自定义属性配置。
+
+        参数:
+        - user_id: 用户ID
+        - config_name: 配置项名称
+        - config_value: 配置项值（可选）
+
+        返回:
+        - 成功: 返回响应对象
+        - 失败: 返回False
+        """
+        method_name = "add_custom_config"
+        self.logger.info(f"[{method_name}] 开始添加用户自定义配置 - user_id: {user_id}, config_name: {config_name}")
+
+        try:
+            body = {
+                "server_name": self.server_name,
+                "access_key": self.access_key,
+                "user_id": user_id,
+                "config_name": config_name
+            }
+
+            # 添加可选参数
+            if config_value is not None:
+                body["config_value"] = config_value
+
+            uri = "/api/v2/service/add_custom_config"
+            url = self.agenterra_iam_host + uri
+
+            # 记录请求信息
+            self._log_request(method_name, url, self.headers, body)
+
+            response = requests.post(
+                url=url,
+                headers=self.headers,
+                json=body,
+                verify=False
+            )
+
+            # 记录响应信息
+            self._log_response(method_name, response)
+
+            if response.status_code == 200:
+                self.logger.info(f"[{method_name}] 添加用户自定义配置成功")
+                return response
+            else:
+                self.logger.warning(f"[{method_name}] 添加用户自定义配置失败 - 状态码: {response.status_code}")
+
+            return False
+        except Exception as e:
+            self.logger.error(f"[{method_name}] 添加用户自定义配置请求异常: {str(e)}")
+            self.logger.error(f"[{method_name}] 异常堆栈: {traceback.format_exc()}")
+            return False
+
+    def get_custom_configs(self, user_id):
+        """
+        机机接口：获取用户自定义配置
+
+        获取指定用户的所有自定义属性配置。
+
+        参数:
+        - user_id: 用户ID
+
+        返回:
+        - 成功: 返回响应对象
+        - 失败: 返回False
+        """
+        method_name = "get_custom_configs"
+        self.logger.info(f"[{method_name}] 开始获取用户自定义配置 - user_id: {user_id}")
+
+        try:
+            body = {
+                "server_name": self.server_name,
+                "access_key": self.access_key,
+                "user_id": user_id
+            }
+
+            uri = "/api/v2/service/get_custom_configs"
+            url = self.agenterra_iam_host + uri
+
+            # 记录请求信息
+            self._log_request(method_name, url, self.headers, body)
+
+            response = requests.post(
+                url=url,
+                headers=self.headers,
+                json=body,
+                verify=False
+            )
+
+            # 记录响应信息
+            self._log_response(method_name, response)
+
+            if response.status_code == 200:
+                self.logger.info(f"[{method_name}] 获取用户自定义配置成功")
+                return response
+            else:
+                self.logger.warning(f"[{method_name}] 获取用户自定义配置失败 - 状态码: {response.status_code}")
+
+            return False
+        except Exception as e:
+            self.logger.error(f"[{method_name}] 获取用户自定义配置请求异常: {str(e)}")
+            self.logger.error(f"[{method_name}] 异常堆栈: {traceback.format_exc()}")
+            return False
+
+    def delete_custom_config(self, user_id, config_name):
+        """
+        机机接口：删除用户自定义配置
+
+        删除指定用户的指定自定义属性配置。
+
+        参数:
+        - user_id: 用户ID
+        - config_name: 配置项名称
+
+        返回:
+        - 成功: 返回响应对象
+        - 失败: 返回False
+        """
+        method_name = "delete_custom_config"
+        self.logger.info(f"[{method_name}] 开始删除用户自定义配置 - user_id: {user_id}, config_name: {config_name}")
+
+        try:
+            body = {
+                "server_name": self.server_name,
+                "access_key": self.access_key,
+                "user_id": user_id,
+                "config_name": config_name
+            }
+
+            uri = "/api/v2/service/delete_custom_config"
+            url = self.agenterra_iam_host + uri
+
+            # 记录请求信息
+            self._log_request(method_name, url, self.headers, body)
+
+            response = requests.post(
+                url=url,
+                headers=self.headers,
+                json=body,
+                verify=False
+            )
+
+            # 记录响应信息
+            self._log_response(method_name, response)
+
+            if response.status_code == 200:
+                self.logger.info(f"[{method_name}] 删除用户自定义配置成功")
+                return response
+            else:
+                self.logger.warning(f"[{method_name}] 删除用户自定义配置失败 - 状态码: {response.status_code}")
+
+            return False
+        except Exception as e:
+            self.logger.error(f"[{method_name}] 删除用户自定义配置请求异常: {str(e)}")
+            self.logger.error(f"[{method_name}] 异常堆栈: {traceback.format_exc()}")
+            return False
+
     def merge_credential(self, target_user_id, cred_type, cred_value, merge_reason=None):
         """
         机机接口：凭证合并
-        
+
         为第三方服务提供凭证合并功能，处理用户绑定新凭证时的账号合并场景。
         例如用户先用账号密码注册，后续又绑定手机号时的账号合并需求。
 
@@ -773,13 +941,14 @@ class ConnectAgenterraIam(object):
         - cred_value: 要绑定的凭证值
         - merge_reason: 合并原因（可选）
 
-        返回: 
+        返回:
         - 成功: 返回响应对象
         - 失败: 返回False
         """
         method_name = "merge_credential"
-        self.logger.info(f"[{method_name}] 开始凭证合并 - target_user_id: {target_user_id}, cred_type: {cred_type}, cred_value: {self._mask_sensitive(cred_value)}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始凭证合并 - target_user_id: {target_user_id}, cred_type: {cred_type}, cred_value: {self._mask_sensitive(cred_value)}")
+
         try:
             # 验证凭证类型
             if isinstance(cred_type, str):
@@ -800,10 +969,10 @@ class ConnectAgenterraIam(object):
 
             uri = "/api/v2/service/merge_credential"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -819,7 +988,7 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 凭证合并失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 凭证合并请求异常: {str(e)}")
@@ -829,20 +998,21 @@ class ConnectAgenterraIam(object):
     def get_user_by_credential(self, cred_type, cred_value):
         """
         机机接口：通过凭证获取用户信息
-        
+
         为第三方服务提供通过用户名或手机号等认证凭据获取用户信息的功能。
 
         参数:
         - cred_type: 凭证类型 (CredentialTypeEnum: username, email, phone, wechat_openid)
         - cred_value: 凭证值
 
-        返回: 
+        返回:
         - 成功: 返回响应对象
         - 失败: 返回False
         """
         method_name = "get_user_by_credential"
-        self.logger.info(f"[{method_name}] 开始获取用户信息 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(cred_value)}")
-        
+        self.logger.info(
+            f"[{method_name}] 开始获取用户信息 - cred_type: {cred_type}, cred_value: {self._mask_sensitive(cred_value)}")
+
         try:
             # 验证凭证类型
             if isinstance(cred_type, str):
@@ -857,10 +1027,10 @@ class ConnectAgenterraIam(object):
 
             uri = "/api/v2/service/get_user_by_credential"
             url = self.agenterra_iam_host + uri
-            
+
             # 记录请求信息
             self._log_request(method_name, url, self.headers, body)
-            
+
             response = requests.post(
                 url=url,
                 headers=self.headers,
@@ -876,7 +1046,7 @@ class ConnectAgenterraIam(object):
                 return response
             else:
                 self.logger.warning(f"[{method_name}] 获取用户信息失败 - 状态码: {response.status_code}")
-            
+
             return False
         except Exception as e:
             self.logger.error(f"[{method_name}] 获取用户信息请求异常: {str(e)}")