configcrypt 1.0.0__py3-none-any.whl

configcrypt/__init__.py

@@ -0,0 +1,34 @@
+"""
+KeyVault - 文件级加密工具
+
+提供CLI、GUI和Python Library三种使用方式的跨平台文件加密解决方案。
+"""
+
+__version__ = "0.1.0"
+__author__ = "KeyVault Team"
+
+# 导出主要API
+from configcrypt.core.vault import Vault, VaultAPI
+from configcrypt.core.exceptions import (
+    KeyVaultError,
+    EncryptionError,
+    DecryptionError,
+    InvalidTokenError,
+    KeychainError,
+    ParseError,
+    EditorNotFoundError,
+    PasswordValidationError,
+)
+
+__all__ = [
+    "Vault",
+    "VaultAPI",
+    "KeyVaultError",
+    "EncryptionError",
+    "DecryptionError",
+    "InvalidTokenError",
+    "KeychainError",
+    "ParseError",
+    "EditorNotFoundError",
+    "PasswordValidationError",
+]

configcrypt/cli/__init__.py

@@ -0,0 +1,9 @@
+"""
+KeyVault CLI模块
+
+提供命令行界面功能,包括文件加密、解密、密码管理等命令。
+"""
+
+from configcrypt.cli.commands import cli, main
+
+__all__ = ["cli", "main"]

configcrypt/cli/commands.py

@@ -0,0 +1,388 @@
+"""
+KeyVault CLI命令实现
+
+使用click实现命令行界面
+"""
+
+import sys
+from pathlib import Path
+import click
+
+from configcrypt.core.vault import Vault
+from configcrypt.core.keychain_store import KeychainStore
+from configcrypt.core.editor_launcher import EditorLauncher
+from configcrypt.core.exceptions import (
+    EncryptionError,
+    DecryptionError,
+    InvalidTokenError,
+    KeychainError,
+    EditorNotFoundError
+)
+
+
+def _calculate_password_strength(password: str) -> str:
+    """
+    计算密码强度
+    
+    强度等级:
+    - 弱: 长度<8 或 只包含字母/数字
+    - 中: 长度>=8 且 包含字母+数字
+    - 强: 长度>=12 且 包含字母+数字+特殊字符
+    
+    Args:
+        password: 密码字符串
+        
+    Returns:
+        "弱"、"中"或"强"
+    """
+    if len(password) < 8:
+        return "弱"
+    
+    has_letter = any(c.isalpha() for c in password)
+    has_digit = any(c.isdigit() for c in password)
+    has_special = any(not c.isalnum() for c in password)
+    
+    if len(password) >= 12 and has_letter and has_digit and has_special:
+        return "强"
+    elif len(password) >= 8 and has_letter and has_digit:
+        return "中"
+    else:
+        return "弱"
+
+
+@click.group()
+def cli():
+    """KeyVault - 文件级加密工具
+    
+    安全地加密和解密敏感配置文件
+    """
+    pass
+
+
+@cli.command()
+def init():
+    """初始化KeyVault，设置主密码"""
+    click.echo("🔐 KeyVault 初始化")
+    click.echo("=" * 50)
+    
+    keychain = KeychainStore()
+    
+    # 检查Keychain是否可用
+    if not keychain.is_available():
+        click.echo("❌ 错误: 系统Keychain不可用")
+        click.echo("请确保您的系统支持密码存储功能")
+        sys.exit(1)
+    
+    # 检查是否已有密码
+    existing_password = keychain.get_password()
+    if existing_password:
+        click.echo("⚠️  警告: 已存在主密码")
+        if not click.confirm("是否要重新设置主密码？", default=False):
+            click.echo("操作已取消")
+            sys.exit(0)
+    
+    # 输入新密码
+    while True:
+        password = click.prompt(
+            "请输入主密码",
+            hide_input=True,
+            confirmation_prompt=True
+        )
+        
+        # 验证密码长度
+        if len(password) < 8:
+            click.echo("❌ 密码长度至少为8个字符，请重新输入")
+            continue
+        
+        # 显示密码强度
+        strength = _calculate_password_strength(password)
+        click.echo(f"密码强度: {strength}")
+        
+        # 如果密码较弱，询问是否继续
+        if strength == "弱":
+            if not click.confirm("密码强度较弱，是否继续？", default=False):
+                continue
+        
+        break
+    
+    # 保存密码到Keychain
+    try:
+        keychain.save_password(password)
+        click.echo("✅ 主密码已成功保存到系统Keychain")
+        click.echo("\n现在您可以使用以下命令:")
+        click.echo("  kv encrypt <file>  - 加密文件")
+        click.echo("  kv decrypt <file>  - 解密文件")
+    except KeychainError as e:
+        click.echo(f"❌ 保存密码失败: {e}")
+        sys.exit(1)
+
+
+@cli.command()
+@click.argument('file', type=click.Path(exists=True, path_type=Path))
+@click.option(
+    '--out',
+    type=click.Path(path_type=Path),
+    help='输出文件路径（默认: 原文件名.enc）'
+)
+@click.option(
+    '--keep',
+    is_flag=True,
+    help='保留源文件（默认会删除）'
+)
+def encrypt(file, out, keep):
+    """加密文件
+    
+    FILE: 要加密的文件路径
+    """
+    keychain = KeychainStore()
+    vault = Vault(keychain_store=keychain)
+    
+    try:
+        # 检查输出文件是否已存在
+        output_path = out if out else Path(str(file) + '.enc')
+        if output_path.exists():
+            if not click.confirm(f"输出文件 {output_path} 已存在，是否覆盖？", default=False):
+                click.echo("操作已取消")
+                sys.exit(0)
+            # 删除已存在的文件以便加密
+            output_path.unlink()
+        
+        # 加密文件
+        delete_source = not keep
+        encrypted_path = vault.encrypt_file(
+            file,
+            output_path=out,
+            delete_source=delete_source
+        )
+        
+        # 显示成功消息
+        click.echo(f"✅ 文件已成功加密")
+        click.echo(f"📁 输出文件: {encrypted_path}")
+        
+        if delete_source:
+            click.echo(f"🗑️  源文件已删除: {file}")
+        else:
+            click.echo(f"📄 源文件保留: {file}")
+            
+    except FileNotFoundError as e:
+        click.echo(f"❌ 错误: {e}")
+        sys.exit(1)
+    except EncryptionError as e:
+        if "未找到保存的密码" in str(e):
+            click.echo("❌ 错误: 未找到主密码")
+            click.echo("请先运行 'kv init' 初始化并设置主密码")
+        elif "输出文件已存在" in str(e):
+            click.echo(f"❌ 错误: {e}")
+            click.echo("提示: 使用 --out 选项指定不同的输出路径")
+        else:
+            click.echo(f"❌ 加密失败: {e}")
+        sys.exit(1)
+    except PermissionError as e:
+        click.echo(f"❌ 权限错误: {e}")
+        sys.exit(1)
+    except Exception as e:
+        click.echo(f"❌ 未知错误: {e}")
+        sys.exit(1)
+
+
+@cli.command()
+@click.argument('file', type=click.Path(exists=True, path_type=Path))
+@click.option(
+    '--out',
+    type=click.Path(path_type=Path),
+    help='输出文件路径（默认: 移除.enc扩展名）'
+)
+@click.option(
+    '--open',
+    'open_editor',
+    is_flag=True,
+    help='解密后立即用编辑器打开文件'
+)
+@click.option(
+    '--editor',
+    type=str,
+    help='指定编辑器命令（配合--open使用）'
+)
+def decrypt(file, out, open_editor, editor):
+    """解密文件
+    
+    FILE: 要解密的文件路径
+    """
+    keychain = KeychainStore()
+    vault = Vault(keychain_store=keychain)
+    
+    try:
+        # 检查输出文件是否已存在
+        if out and Path(out).exists():
+            if not click.confirm(f"输出文件 {out} 已存在，是否覆盖？", default=False):
+                click.echo("操作已取消")
+                sys.exit(0)
+            # 删除已存在的文件以便解密
+            Path(out).unlink()
+        
+        # 解密文件
+        decrypted_path = vault.decrypt_file(
+            file,
+            output_path=out
+        )
+        
+        # 显示成功消息
+        click.echo(f"✅ 文件已成功解密")
+        click.echo(f"📁 输出文件: {decrypted_path}")
+        
+        # 如果指定了--open选项，打开编辑器
+        if open_editor:
+            try:
+                launcher = EditorLauncher()
+                launcher.open_file(decrypted_path, editor_command=editor)
+                click.echo(f"📝 已用编辑器打开文件")
+            except EditorNotFoundError as e:
+                click.echo(f"⚠️  警告: {e}")
+                click.echo("提示: 使用 --editor 选项指定编辑器命令")
+                click.echo("示例: kv decrypt file.enc --open --editor nano")
+        
+    except FileNotFoundError as e:
+        click.echo(f"❌ 错误: {e}")
+        sys.exit(1)
+    except InvalidTokenError:
+        click.echo("❌ 解密失败: 密码错误或文件已损坏/被篡改")
+        click.echo("提示: 请确认:")
+        click.echo("  1. 主密码是否正确（运行 'kv init' 重新设置）")
+        click.echo("  2. 文件是否完整且未被修改")
+        sys.exit(1)
+    except DecryptionError as e:
+        if "未找到保存的密码" in str(e):
+            click.echo("❌ 错误: 未找到主密码")
+            click.echo("请先运行 'kv init' 初始化并设置主密码")
+        elif "输出文件已存在" in str(e):
+            click.echo(f"❌ 错误: {e}")
+            click.echo("提示: 使用 --out 选项指定不同的输出路径")
+        else:
+            click.echo(f"❌ 解密失败: {e}")
+        sys.exit(1)
+    except PermissionError as e:
+        click.echo(f"❌ 权限错误: {e}")
+        sys.exit(1)
+    except Exception as e:
+        click.echo(f"❌ 未知错误: {e}")
+        sys.exit(1)
+
+
+@cli.command()
+def status():
+    """显示KeyVault状态信息"""
+    click.echo("🔐 KeyVault 状态")
+    click.echo("=" * 50)
+    
+    keychain = KeychainStore()
+    
+    # 检查Keychain可用性
+    if not keychain.is_available():
+        click.echo("❌ Keychain状态: 不可用")
+        click.echo("⚠️  警告: 系统Keychain不可用，无法使用KeyVault")
+        sys.exit(1)
+    else:
+        click.echo("✅ Keychain状态: 可用")
+    
+    # 检查主密码是否已设置
+    password = keychain.get_password()
+    if password:
+        click.echo("✅ 主密码: 已设置")
+        click.echo(f"   密码强度: {_calculate_password_strength(password)}")
+    else:
+        click.echo("❌ 主密码: 未设置")
+        click.echo("提示: 运行 'kv init' 设置主密码")
+    
+    click.echo("\n可用命令:")
+    click.echo("  kv init              - 初始化/重置主密码")
+    click.echo("  kv encrypt <file>    - 加密文件")
+    click.echo("  kv decrypt <file>    - 解密文件")
+    click.echo("  kv reset-password    - 修改主密码")
+    click.echo("  kv status            - 显示状态信息")
+
+
+@cli.command('reset-password')
+def reset_password():
+    """修改主密码
+    
+    验证旧密码后设置新密码
+    """
+    click.echo("🔐 修改主密码")
+    click.echo("=" * 50)
+    
+    keychain = KeychainStore()
+    vault = Vault(keychain_store=keychain)
+    
+    # 检查Keychain是否可用
+    if not keychain.is_available():
+        click.echo("❌ 错误: 系统Keychain不可用")
+        sys.exit(1)
+    
+    # 检查是否已有密码
+    old_password = keychain.get_password()
+    if not old_password:
+        click.echo("❌ 错误: 未找到主密码")
+        click.echo("请先运行 'kv init' 初始化并设置主密码")
+        sys.exit(1)
+    
+    # 验证旧密码
+    click.echo("请先验证当前主密码")
+    input_old_password = click.prompt("当前主密码", hide_input=True)
+    
+    if input_old_password != old_password:
+        click.echo("❌ 错误: 当前密码不正确")
+        sys.exit(1)
+    
+    click.echo("✅ 密码验证成功")
+    click.echo()
+    
+    # 输入新密码
+    click.echo("请设置新的主密码")
+    while True:
+        new_password = click.prompt(
+            "新主密码",
+            hide_input=True,
+            confirmation_prompt=True
+        )
+        
+        # 验证密码长度
+        if len(new_password) < 8:
+            click.echo("❌ 密码长度至少为8个字符，请重新输入")
+            continue
+        
+        # 不允许使用相同的密码
+        if new_password == old_password:
+            click.echo("❌ 新密码不能与旧密码相同，请重新输入")
+            continue
+        
+        # 显示密码强度
+        strength = _calculate_password_strength(new_password)
+        click.echo(f"密码强度: {strength}")
+        
+        # 如果密码较弱，询问是否继续
+        if strength == "弱":
+            if not click.confirm("密码强度较弱，是否继续？", default=False):
+                continue
+        
+        break
+    
+    # 保存新密码
+    try:
+        keychain.save_password(new_password)
+        click.echo("✅ 主密码已成功更新")
+        click.echo("\n⚠️  重要提示:")
+        click.echo("  - 所有已加密的文件仍使用旧密码加密")
+        click.echo("  - 新密码仅用于加密新文件")
+        click.echo("  - 若要使用新密码，需重新加密旧文件")
+    except KeychainError as e:
+        click.echo(f"❌ 保存密码失败: {e}")
+        sys.exit(1)
+
+
+def main():
+    """CLI入口点"""
+    cli()
+
+
+if __name__ == '__main__':
+    main()

configcrypt/core/__init__.py

@@ -0,0 +1,36 @@
+"""
+KeyVault Core模块
+
+包含核心加密引擎、密钥管理、格式解析等核心功能。
+"""
+
+from configcrypt.core.vault import Vault, VaultAPI
+from configcrypt.core.keychain_store import KeychainStore
+from configcrypt.core.format_parser import FormatParser
+from configcrypt.core.editor_launcher import EditorLauncher
+from configcrypt.core.exceptions import (
+    KeyVaultError,
+    EncryptionError,
+    DecryptionError,
+    InvalidTokenError,
+    KeychainError,
+    ParseError,
+    EditorNotFoundError,
+    PasswordValidationError,
+)
+
+__all__ = [
+    "Vault",
+    "VaultAPI",
+    "KeychainStore",
+    "FormatParser",
+    "EditorLauncher",
+    "KeyVaultError",
+    "EncryptionError",
+    "DecryptionError",
+    "InvalidTokenError",
+    "KeychainError",
+    "ParseError",
+    "EditorNotFoundError",
+    "PasswordValidationError",
+]

configcrypt/core/editor_launcher.py

@@ -0,0 +1,116 @@
+"""
+EditorLauncher 编辑器启动模块
+
+跨平台编辑器启动器，支持Windows、macOS和Linux系统
+"""
+
+import os
+import sys
+import shutil
+import subprocess
+from pathlib import Path
+from typing import Optional, List
+
+from .exceptions import EditorNotFoundError
+
+
+class EditorLauncher:
+    """跨平台编辑器启动器"""
+    
+    # 各平台默认编辑器列表（优先级从高到低）
+    DEFAULT_EDITORS = {
+        'win32': ['code', 'notepad++', 'notepad', 'start'],  # start 使用 Windows 默认程序
+        'darwin': ['code', 'subl', 'open'],
+        'linux': ['code', 'gedit', 'nano', 'vim']
+    }
+    
+    def open_file(
+        self,
+        file_path: Path,
+        editor_command: Optional[str] = None
+    ) -> None:
+        """
+        打开文件编辑
+        
+        优先级:
+        1. editor_command参数
+        2. $EDITOR环境变量
+        3. 平台默认编辑器列表
+        
+        Args:
+            file_path: 要打开的文件路径
+            editor_command: 指定的编辑器命令
+            
+        Raises:
+            EditorNotFoundError: 无可用编辑器
+        """
+        # 优先使用指定的编辑器
+        if editor_command:
+            if self._try_open(editor_command, file_path):
+                return
+            raise EditorNotFoundError(f"指定的编辑器不可用: {editor_command}")
+        
+        # 尝试 $EDITOR 环境变量
+        editor_env = os.environ.get('EDITOR')
+        if editor_env and self._try_open(editor_env, file_path):
+            return
+        
+        # 尝试平台默认编辑器
+        platform = sys.platform
+        editor_list = self.DEFAULT_EDITORS.get(platform, [])
+        for editor in editor_list:
+            if self._try_open(editor, file_path):
+                return
+        
+        raise EditorNotFoundError("未找到可用的编辑器")
+    
+    def _try_open(self, editor: str, file_path: Path) -> bool:
+        """
+        尝试用指定编辑器打开文件
+        
+        Args:
+            editor: 编辑器命令（可能包含参数）
+            file_path: 要打开的文件路径
+            
+        Returns:
+            成功返回True，失败返回False
+        """
+        # 特殊处理：Windows 的 notepad 和 macOS 的 open 命令
+        editor_parts = editor.split()
+        editor_name = editor_parts[0]
+        
+        # Windows 特殊处理
+        if sys.platform == 'win32':
+            if editor_name == 'notepad':
+                # notepad 是 Windows 内置命令，不需要检查 which
+                try:
+                    subprocess.Popen(['notepad.exe', str(file_path)])
+                    return True
+                except Exception:
+                    return False
+            elif editor_name == 'start':
+                # 使用 Windows 默认程序打开
+                try:
+                    os.startfile(str(file_path))
+                    return True
+                except Exception:
+                    return False
+        
+        # macOS 特殊处理
+        if sys.platform == 'darwin' and editor_name == 'open':
+            try:
+                subprocess.Popen([*editor_parts, str(file_path)])
+                return True
+            except Exception:
+                return False
+        
+        # 检查编辑器是否存在（普通编辑器）
+        if not shutil.which(editor_name):
+            return False
+        
+        try:
+            # 使用subprocess.Popen非阻塞启动
+            subprocess.Popen([*editor_parts, str(file_path)])
+            return True
+        except Exception:
+            return False

configcrypt/core/exceptions.py

@@ -0,0 +1,45 @@
+"""
+KeyVault 异常定义模块
+
+定义所有KeyVault相关的异常类型。
+"""
+
+
+class KeyVaultError(Exception):
+    """所有KeyVault异常的基类"""
+    pass
+
+
+class EncryptionError(KeyVaultError):
+    """加密操作失败"""
+    pass
+
+
+class DecryptionError(KeyVaultError):
+    """解密操作失败（密码错误或通用解密错误）"""
+    pass
+
+
+class InvalidTokenError(DecryptionError):
+    """文件完整性校验失败（文件被篡改）"""
+    pass
+
+
+class KeychainError(KeyVaultError):
+    """Keychain操作失败"""
+    pass
+
+
+class ParseError(KeyVaultError):
+    """配置文件格式解析失败"""
+    pass
+
+
+class EditorNotFoundError(KeyVaultError):
+    """未找到可用的编辑器"""
+    pass
+
+
+class PasswordValidationError(KeyVaultError):
+    """密码不符合安全要求"""
+    pass