pytbox 0.0.9__py3-none-any.whl → 0.1.1__py3-none-any.whl

pytbox/categraf/jinja2/input.snmp/ruijie_interface.toml.j2

@@ -0,0 +1,96 @@
+{% for instance in instances %}
+{% for agent, detail in instance.items() %}
+[[instances]]
+agents = [
+    "udp://{{agent}}"
+]
+{% if detail.version == 2 %}
+version = {{detail.version}}
+community = "{{detail.community}}"
+{% endif %}
+{% if detail.version == 3 %}
+version = {{detail.version}}
+sec_name = "{{detail.sec_name}}"
+auth_protocol = "{{detail.auth_protocol}}"
+auth_password = "{{detail.auth_password}}"
+priv_protocol = "{{detail.priv_protocol}}"
+priv_password = "{{detail.priv_password}}"
+sec_level = "{{detail.sec_level}}"
+{% endif %}
+timeout = "5s"
+retries = 3
+path = ["/usr/share/snmp/mibs"]
+translator = "gosmi"
+max_repetitions = 50
+
+[[instances.field]]
+name = "sysName"
+oid = "1.3.6.1.2.1.1.5.0"
+is_tag = true
+
+[[instances.table]]
+name = "interface"
+inherit_tags = ["sysName"]
+index_as_tag = true
+
+[[instances.table.field]]
+name = "ifIndex"
+oid = "1.3.6.1.2.1.2.2.1.1"
+is_tag = true
+
+[[instances.table.field]]
+name = "ifName"
+oid = "1.3.6.1.2.1.31.1.1.1.1"
+is_tag = true
+
+[[instances.table.field]]
+name = "ifDescr"
+oid = "1.3.6.1.2.1.2.2.1.2"
+is_tag = true
+
+[[instances.table.field]]
+name = "ifSpeed"
+oid = "1.3.6.1.2.1.2.2.1.5"
+# is_tag = true
+
+[[instances.table.field]]
+name = "ifAdminStatus"
+oid = "1.3.6.1.2.1.2.2.1.7"
+# is_tag = true
+
+[[instances.table.field]]
+name = "ifOperStatus"
+oid = "1.3.6.1.2.1.2.2.1.8"
+# is_tag = true
+
+[[instances.table.field]]
+name = "ifInDiscards"
+oid = "1.3.6.1.2.1.2.2.1.13"
+
+[[instances.table.field]]
+name = "ifInErrors"
+oid = "1.3.6.1.2.1.2.2.1.14"
+
+[[instances.table.field]]
+name = "ifOutDiscards"
+oid = "1.3.6.1.2.1.2.2.1.19"
+
+[[instances.table.field]]
+name = "ifOutErrors"
+oid = "1.3.6.1.2.1.2.2.1.20"
+
+[[instances.table.field]]
+name = "ifAlias"
+oid = "1.3.6.1.2.1.31.1.1.1.18"
+is_tag = true
+
+[[instances.table.field]]
+name = "ifHCInOctets"
+oid = "1.3.6.1.2.1.31.1.1.1.6"
+
+[[instances.table.field]]
+name = "ifHCOutOctets"
+oid = "1.3.6.1.2.1.31.1.1.1.10"
+
+{% endfor %}
+{% endfor %}

pytbox/categraf/jinja2/input.snmp/ruijie_system.toml.j2

@@ -0,0 +1,41 @@
+{% for instance in instances %}
+{% for agent, detail in instance.items() %}
+[[instances]]
+agents = [
+    "udp://{{agent}}"
+]
+{% if detail.version == 2 %}
+version = {{detail.version}}
+community = "{{detail.community}}"
+{% endif %}
+{% if detail.version == 3 %}
+version = {{detail.version}}
+sec_name = "{{detail.sec_name}}"
+auth_protocol = "{{detail.auth_protocol}}"
+auth_password = "{{detail.auth_password}}"
+priv_protocol = "{{detail.priv_protocol}}"
+priv_password = "{{detail.priv_password}}"
+sec_level = "{{detail.sec_level}}"
+{% endif %}
+timeout = "5s"
+retries = 3
+path = ["/usr/share/snmp/mibs"]
+translator = "gosmi"
+max_repetitions = 50
+
+[[instances.field]]
+name = "sysName"
+oid = "1.3.6.1.2.1.1.5.0"
+is_tag = true
+
+[[instances.field]]
+oid = "1.3.6.1.2.1.1.1.0"
+name = "sysDescr"
+is_tag = true
+
+[[instances.field]]
+oid = "1.3.6.1.2.1.1.3.0"
+name = "sysUpTime"
+conversion = "float(2)"
+{% endfor %}
+{% endfor %}

pytbox/mail/alimail.py

@@ -0,0 +1,129 @@
+#!/usr/bin/env python3
+
+from typing import Literal
+from datetime import datetime, timedelta
+
+import requests
+
+
+
+class AliMail:
+    def __init__(self, email_address: str=None, client_id: str=None, client_secret: str=None):
+        
+        self.email_address = email_address
+        self.client_id = auth['username']
+        self.client_secret = auth['password']
+        self.base_url = "https://alimail-cn.aliyuncs.com/v2"
+        self.headers = {
+                "Content-Type": "application/json",
+                "Authorization": f"bearer {self._get_access_token()}"
+            }
+        
+    def _get_access_token(self):
+        current_time = datetime.now()
+        # stored_token = mongo_alimail_token.find_one({"token_type": "bearer"})
+        if stored_token and stored_token.get('expiration_time'):
+            expiration_time = stored_token['expiration_time']
+            if current_time < expiration_time:
+                return stored_token['access_token']
+            else:
+                return self._get_access_token_by_request()
+        else:
+            return self._get_access_token_by_request()
+    
+    def _get_access_token_by_request(self):
+        '''
+        https://mailhelp.aliyun.com/openapi/index.html#/markdown/authorization.md
+
+        Raises:
+            ValueError: _description_
+
+        Returns:
+            _type_: _description_
+        '''
+        # 定义接口URL
+        interface_url = "https://alimail-cn.aliyuncs.com/oauth2/v2.0/token"
+        # 设置请求头，指定内容类型
+        headers = {'Content-Type': 'application/x-www-form-urlencoded'}
+        # 准备请求数据
+        data = {
+            "grant_type": "client_credentials",
+            "client_id": self.client_id,
+            "client_secret": self.client_secret
+        }
+        try:
+            response = requests.post(interface_url, headers=headers, data=data, timeout=3)
+            response_json = response.json()
+            current_time = datetime.now()
+            data = {
+                'token_type': response_json["token_type"],
+                'access_token': response_json["access_token"],
+                'expires_in':  response_json["expires_in"],
+                'expiration_time': current_time + timedelta(seconds=response_json["expires_in"])
+            }
+            mongo_alimail_token.update_one(
+                {"token_type": "bearer"},
+                {"$set": data},
+                upsert=True
+            )
+            return data.get("access_token")
+        except requests.RequestException as e:
+            # 处理请求失败异常
+            print(f"请求失败：{e}")
+        except (KeyError, ValueError) as e:
+            # 处理解析响应失败异常
+            print(f"解析响应失败： {e}")
+
+    def list_mail_folders(self):
+        response = requests.get(
+            url=f"{self.base_url}/users/{self.email_address}/mailFolders",
+            headers=self.headers
+        )
+        return response.json().get('folders')
+
+    def query_folder_id(self, folder_name: Literal['inbox']='inbox'):
+        folders = self.list_mail_folders()
+        for folder in folders:
+            if folder.get('displayName') == folder_name:
+                return folder.get('id')
+        return None
+
+    def get_mail_detail(self, mail_id: str):
+        params = {
+            "$select": "body,toRecipients,internetMessageId,internetMessageHeaders"
+        }
+        response = requests.get(
+            url=f"{self.base_url}/users/{self.email_address}/messages/{mail_id}",
+            headers=self.headers,
+            params=params,
+            timeout=3
+        )
+        return response.json().get('message')
+
+    def list_mail(self, folder_name: str='inbox', size: int=100):
+        folder_id = self.query_folder_id(folder_name=folder_name)
+        params = {
+            "size": size,
+            # "$select": "toRecipients"
+        }
+        response = requests.get(
+            url=f"{self.base_url}/users/{self.email_address}/mailFolders/{folder_id}/messages",
+            headers=self.headers,
+            params=params,
+            timeout=3
+        )
+        messages = response.json().get("messages")
+        for message in messages:
+            mail_id = message.get("id")
+            detail = self.get_mail_detail(mail_id=mail_id)
+            message.update(detail)
+            yield message
+        
+
+if __name__ == '__main__':
+    ali_mail = AliMail()
+    # print(ali_mail.query_folder_id())
+    # for i in ali_mail.list_mail(size=1):
+    #     print(i)
+    # print(ali_mail.access_token)
+    print(ali_mail.get_mail_detail(mail_id='DzzzzzzMeuY'))

pytbox/mail/client.py

@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+
+
+from dataclasses import dataclass
+from typing import Generator, Literal
+
+import yagmail
+from imbox import Imbox
+from imap_tools import MailBox, AND, MailMessageFlags
+from nb_log import get_logger
+
+from src.library.onepassword import my1p
+
+
+log = get_logger('src.library.mail.client')
+
+
+@dataclass
+class MailDetail:
+    """
+    邮件详情数据类。
+    
+    Attributes:
+        uid: 邮件唯一标识符
+        send_from: 发件人邮箱地址
+        send_to: 收件人邮箱地址列表
+        cc: 抄送人邮箱地址列表
+        subject: 邮件主题
+        body_plain: 纯文本正文
+        body_html: HTML格式正文
+        attachment: 附件完整保存路径列表
+    """
+    uid: str=None
+    send_from: str=None
+    send_to: list=None
+    date: str=None
+    cc: list=None
+    subject: str=None
+    body_plain: str=None
+    body_html: str=None
+    attachment: list=None
+    has_attachments: bool=False
+
+
+class MailClient:
+    '''
+    _summary_
+    '''
+    def __init__(self, 
+                 send_mail_address: Literal['service@tyun.cn', 'alert@tyun.cn', 'houmingming@tyun.cn', 'houmdream@163.com', 'houm01@foxmail.com'] = 'service@tyun.cn',
+                 authorization_code: bool=False,
+                 password: str=None
+                ):
+        
+        self.mail_address = send_mail_address
+        
+        if password:
+            self.password = password
+        else:
+            if authorization_code:
+                self.password = my1p.get_item_by_title(title=send_mail_address)['授权码']
+            else:
+                self.password = my1p.get_item_by_title(title=send_mail_address)['password']
+
+        if '163.com' in send_mail_address:
+            self.smtp_address = 'smtp.163.com'
+            self.imap_address = 'imap.163.com'
+            self.imbox_client = self._create_imbox_object(vendor='163')
+        elif 'foxmail.com' in send_mail_address:
+            self.smtp_address = 'smtp.qq.com'
+            self.imap_address = 'imap.qq.com'
+            self.imbox_client = self._create_imbox_object(vendor='qq')
+        else:
+            raise ValueError(f'不支持的邮箱地址: {send_mail_address}')
+
+        self.mailbox = MailBox(self.imap_address).login(self.mail_address, self.password)
+        
+    def _create_imbox_object(self, vendor: Literal['aliyun', 'qq', '163']):
+        return Imbox(self.imap_address,
+                username=self.mail_address,
+                password=self.password,
+                ssl=True,
+                ssl_context=None,
+                starttls=False)
+
+    def send_mail(self, receiver: list=[], cc: list=['houmingming@tyun.cn'], subject: str='', contents: str='', attachments: list=[], tips: str=None):
+        '''
+        _summary_
+
+        Args:
+            receiver (list, optional): _description_. Defaults to [].
+            cc (list, optional): _description_. Defaults to ['houmingming@tyun.cn'].
+            subject (str, optional): _description_. Defaults to ''.
+            contents (str, optional): _description_. Defaults to ''.
+            attachments (list, optional): _description_. Defaults to [].
+        '''
+        email_signature = """
+————————————————————————————————————————
+以专业成就客户 
+钛信（上海）信息科技有限公司
+Tai Xin（ShangHai) Information Technology Co.,Ltd.
+中国上海市浦东新区达尔文路88号半岛科技园21栋2楼
+Tel:400-920-0057
+Web:www.tyun.cn
+————————————————————————————————————————
+信息安全声明：本邮件包含信息归发件人所在组织所有，发件人所在组织对该邮件拥有所有权利。请接收者注意保密，未经发件人书面许可，不得向任何第三方组织和个人透露本邮件所含信息的全部或部分。以上声明仅适用于工作邮件。
+Information Security Notice: The information contained in this mail is solely property of the sender's organization. This mail communication is confidential. Recipients named above are obligated to maintain secrecy and are not permitted to disclose the contents of this communication to others.
+""" 
+        with yagmail.SMTP(user=self.mail_address, password=my1p.get_item_by_title(self.mail_address)['password'], port=465, host=self.smtp_address) as yag:
+            log.info(f'receiver: {receiver}, cc: {cc}, subject: {subject}, contents: {contents}, attachments: {attachments}')
+            try:
+                if tips:
+                    contents = contents + '\n' + '<p style="color: red;">本邮件为系统自动发送, 如有问题, 请联系 houmingming@tyun.cn</p>'
+
+                contents = contents + email_signature
+                yag.send(to=receiver, cc=cc, subject=subject, contents=contents, attachments=attachments)
+                log.info('发送成功!!!')
+                return True
+            except Exception as e:
+                log.error(f'发送失败, 报错: {e}')
+                return False
+
+    def get_mail_list(self, is_read: bool=False) -> Generator:
+        with MailBox(self.imap_address).login(self.mail_address, self.password) as mailbox:
+            for msg in mailbox.fetch(criteria=AND(seen=is_read)):
+                # 处理附件
+                attachment_list = []
+                for att in msg.attachments:
+                    att_dict = {}
+                    att_dict['filename'] = att.filename
+                    att_dict['payload'] = att.payload
+                    att_dict['size'] = att.size
+                    att_dict['content_id'] = att.content_id
+                    att_dict['content_type'] = att.content_type
+                    att_dict['content_disposition'] = att.content_disposition
+                    # att_dict['part'] = att.part
+                    att_dict['size'] = att.size
+                    attachment_list.append(att_dict)
+                
+                if attachment_list:
+                    is_has_attachments = True
+                else:
+                    is_has_attachments = False
+
+                yield MailDetail(
+                    uid=msg.uid,
+                    send_from=msg.from_,
+                    send_to=msg.to,
+                    date=msg.date,
+                    cc=msg.cc,
+                    subject=msg.subject,
+                    body_plain=msg.text,
+                    body_html=msg.html,
+                    has_attachments=is_has_attachments,
+                    attachment=attachment_list
+                )
+
+    def mark_as_read(self, uid):
+        """
+        标记邮件为已读。
+        
+        Args:
+            uid (str): 邮件的唯一标识符
+        """
+        try:
+            # 使用 imap_tools 的 flag 方法标记邮件为已读
+            # 第一个参数是 uid，第二个参数是要设置的标志，第三个参数 True 表示添加标志
+            self.mailbox.flag(uid, [MailMessageFlags.SEEN], True)
+            # log.info(f'标注邮件{uid}为已读')
+        except Exception as e:
+            log.error(f'标记邮件{uid}为已读失败: {e}')
+            raise
+    
+    def delete(self, uid):
+        """
+        删除邮件。
+        
+        Args:
+            uid (str): 邮件的唯一标识符
+        """
+        try:
+            # 使用 imap_tools 的 delete 方法删除邮件
+            self.mailbox.delete(uid)
+            log.info(f'删除邮件{uid}')
+        except Exception as e:
+            log.error(f'删除邮件{uid}失败: {e}')
+            raise
+    
+    def move(self, uid: str, destination_folder: str) -> None:
+        """
+        移动邮件到指定文件夹。
+
+        注意：部分 IMAP 服务商（如 QQ 邮箱）在移动邮件时，实际上是"复制到目标文件夹并从原文件夹删除"，
+        这会导致邮件在原文件夹中消失，表现为"被删除"。但邮件会在目标文件夹中存在，并未彻底丢失。
+
+        Args:
+            uid (str): 邮件的唯一标识符。
+            destination_folder (str): 目标文件夹名称。
+
+        Returns:
+            None
+
+        Raises:
+            Exception: 移动过程中底层 imap 库抛出的异常。
+        """
+        try:
+            # 使用 imap_tools 的 move 方法移动邮件
+            self.mailbox.move(uid, destination_folder)
+            log.info(f'邮件{uid}已移动到{destination_folder}')
+        except Exception as e:
+            log.error(f'移动邮件{uid}到{destination_folder}失败: {e}')
+            raise
+
+if __name__ == '__main__':
+    # ali_mail = MailClient(send_mail_address='houmingming@tyun.cn')
+    # mail = MailClient(send_mail_address='houmingming@tyun.cn')
+    # mail = MailClient(send_mail_address='houmdream@163.com', authorization_code=True)
+    # mail = MailClient(send_mail_address='houm01@foxmail.com', password=my1p.get_item_by_title('QQ'))
+    # 对于阿里云邮箱，使用兼容方法
+    pass
+    # mail.get_mail_list(attachment=True, attachment_path='/tmp')

pytbox/network/meraki.py

@@ -0,0 +1,169 @@
+#!/usr/bin/env python3
+
+from typing import Any, Literal
+import requests
+from ..utils.response import ReturnResponse
+
+class Meraki:
+    '''
+    Meraki Client
+    '''    
+    def __init__(self, api_key: str=None, organization_id: str=None, timeout: int=10):
+        if not api_key:
+            raise ValueError("api_key is required")
+        if not organization_id:
+            raise ValueError("organization_id is required")
+        self.base_url = 'https://api.meraki.cn/api/v1'
+        self.headers = {
+            "Authorization": f"Bearer {api_key}",
+            "Accept": "application/json"
+        }
+        self.organization_id = organization_id
+        self.timeout = timeout
+
+    def get_networks(self, tags: list[str]=None) -> ReturnResponse:
+        '''
+        https://developer.cisco.com/meraki/api-v1/get-organization-networks/
+
+        Args:
+            tags (list): PROD STG NSO
+
+        Returns:
+            list: _description_
+        '''
+        params = {}
+        if tags:
+            params['tags[]'] = tags
+        
+        r = requests.get(
+            f"{self.base_url}/organizations/{self.organization_id}/networks",
+            headers=self.headers,
+            params=params,
+            timeout=self.timeout
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f"获取到 {len(r.json())} 个网络", data=r.json())
+        return ReturnResponse(code=1, msg=f"获取网络失败: {r.status_code} {r.text}")
+
+    def get_network_id_by_name(self, name: str) -> str | None:
+        '''
+        name 必须是唯一值，否则仅反馈第一个匹配到的 network
+
+        Args:
+            name (str): 网络名称, 是包含的关系, 例如实际 name 是 main office, 传入的 name 可以是 office
+
+        Returns:
+            str | None: 网络ID
+        '''
+        r = self.get_networks()
+        if r.code == 0:
+            for network in r.data:
+                if name in network['name']:
+                    return network['id']
+        return None
+
+    def get_devices(self, network_ids: Any = []) -> ReturnResponse:
+        '''
+        获取设备信息
+        https://developer.cisco.com/meraki/api-v1/get-organization-inventory-devices/
+
+        Args:
+            network_ids (list 或 str, 可选): 可以传入网络ID的列表，也可以直接传入单个网络ID字符串。默认为空列表，表示不指定网络ID。
+
+        Returns:
+            返回示例（部分敏感信息已隐藏）:
+            [
+              {
+                'mac': '00:00:00:00:00:00',
+                'serial': 'Q3AL-****-****',
+                'name': 'OFFICE-AP01',
+                'model': 'MR44',
+                'networkId': 'L_***************0076',
+                'orderNumber': None,
+                'claimedAt': '2025-02-26T02:20:00.853251Z',
+                'tags': ['MR44'],
+                'productType': 'wireless',
+                'countryCode': 'CN',
+                'details': []
+              }
+            ]
+        '''
+        
+        params = {}
+        if network_ids:
+            if isinstance(network_ids, str):
+                params['networkIds[]'] = [network_ids]
+            else:
+                params['networkIds[]'] = network_ids
+            
+        r = requests.get(
+            f"{self.base_url}/organizations/{self.organization_id}/inventory/devices", 
+            headers=self.headers,
+            params=params,
+            timeout=self.timeout
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f"获取到 {len(r.json())} 个设备", data=r.json())
+        return ReturnResponse(code=1, msg=f"获取设备失败: {r.status_code} {r.text}")
+
+    def get_device_detail(self, serial: str) -> ReturnResponse:
+        '''
+        获取指定序列号（serial）的 Meraki 设备详细信息
+
+        Args:
+            serial (str): 设备的序列号
+
+        Returns:
+            ReturnResponse:
+                code: 0 表示成功，1 表示失败，3 表示设备未添加
+                msg: 结果说明
+                data: 设备详细信息，示例（部分敏感信息已隐藏）:
+                {
+                    'lat': 1.1,
+                    'lng': 2.2,
+                    'address': '(1.1, 2.2)',
+                    'serial': 'Q3AL-****-****',
+                    'mac': '00:00:00:00:00:00',
+                    'lanIp': '10.1.1.1',
+                    'tags': ['MR44'],
+                    'url': 'https://n3.meraki.cn/xxx',
+                    'networkId': '00000',
+                    'name': 'OFFICE-AP01',
+                    'details': [],
+                    'model': 'MR44',
+                    'firmware': 'wireless-31-1-6',
+                    'floorPlanId': '00000'
+                }
+        '''
+        r = requests.get(
+            f"{self.base_url}/devices/{serial}",
+            headers=self.headers,
+            timeout=self.timeout
+        )
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f"获取设备详情成功: {r.json()}", data=r.json())
+        elif r.status_code == 404:
+            return ReturnResponse(code=3, msg=f"设备 {serial} 还未添加过", data=None)
+        return ReturnResponse(code=1, msg=f"获取设备详情失败: {r.status_code} - {r.text}", data=None)
+
+    def get_device_availabilities(self, network_id: str=None,
+                                  status: Literal['online', 'offline', 'dormant', 'alerting']=None,
+                                  serial: str=None) -> ReturnResponse:
+        params = {}
+        
+        if status:
+            params["statuses[]"] = status
+        
+        if serial:
+            params["serials[]"] = serial
+        
+        if network_id:
+            params["networkIds[]"] = network_id
+            
+        r = requests.get(
+            url=f"{self.base_url}/organizations/{self.organization_id}/devices/availabilities", 
+            headers=self.headers,
+            params=params,
+            timeout=self.timeout
+        )
+        return ReturnResponse(code=0, msg=f"获取设备健康状态成功", data=r.json())

pytbox/win/ad.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+
+from ldap3 import Server, Connection, ALL, SUBTREE, MODIFY_REPLACE, SUBTREE, MODIFY_ADD, MODIFY_DELETE
+
+
+class ADClient:
+    '''
+    _summary_
+    '''
+    def __init__(self, server, base_dn, username, password):
+        self.server = Server(server, get_info=ALL)
+        self.conn = Connection(self.server, user=username, password=password, auto_bind=True)
+        self.base_dn = base_dn
+
+    def list_user(self):
+        '''
+        查询所有用户
+
+        Yields:
+            dict: 返回的是生成器, 字典类型
+        '''
+        # 搜索过滤条件
+        secarch_filter = '(objectCategory=person)'  # 过滤所有用户
+        # SEARCH_ATTRIBUTES = ['cn', 'sAMAccountName', 'mail', 'userPrincipalName']  # 需要的用户属性
+        search_attributes = ["*"]  # 需要的用户属性
+        # 搜索用户
+        if self.conn.search(search_base=self.base_dn, search_filter=secarch_filter, search_scope=SUBTREE, attributes=search_attributes):
+            for entry in self.conn.entries:
+                yield {k: v[0] if isinstance(v, list) else v for k, v in entry.entry_attributes_as_dict.items()}