Phishing-Simulation 项目使用文档

1. 项目目录结构及介绍

Phishing-Simulation/
├── README.md
├── requirements.txt
├── setup.py
├── phishing_simulation/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── templates/
│   │   ├── phishing_email.html
│   │   └── phishing_email.txt
│   └── utils/
│       ├── __init__.py
│       ├── email_sender.py
│       └── logger.py
└── tests/
    ├── __init__.py
    ├── test_main.py
    └── test_email_sender.py

目录结构说明

• README.md: 项目介绍文件，包含项目的基本信息和使用说明。
• requirements.txt: 项目依赖文件，列出了项目运行所需的Python包。
• setup.py: 项目的安装脚本，用于安装项目及其依赖。
• phishing_simulation/: 项目的主要代码目录。
  • init.py: 模块初始化文件。
  • main.py: 项目的启动文件，包含主程序入口。
  • config.py: 项目的配置文件，包含各种配置参数。
  • templates/: 存放模拟钓鱼邮件的模板文件。
    • phishing_email.html: HTML格式的钓鱼邮件模板。
    • phishing_email.txt: 纯文本格式的钓鱼邮件模板。
  • utils/: 存放项目中使用的工具函数和类。
    • init.py: 模块初始化文件。
    • email_sender.py: 发送邮件的工具函数。
    • logger.py: 日志记录工具函数。
• tests/: 项目的测试代码目录。
  • init.py: 模块初始化文件。
  • test_main.py: 主程序的测试文件。
  • test_email_sender.py: 邮件发送功能的测试文件。

2. 项目启动文件介绍

main.py

main.py 是项目的启动文件，包含了主程序的入口。以下是该文件的主要内容：

from phishing_simulation.config import Config
from phishing_simulation.utils.email_sender import send_phishing_email
from phishing_simulation.utils.logger import setup_logger

def main():
    config = Config()
    logger = setup_logger(config.log_level)
    logger.info("Starting phishing simulation...")
    
    # 发送钓鱼邮件
    send_phishing_email(config)
    
    logger.info("Phishing simulation completed.")

if __name__ == "__main__":
    main()

主要功能

• 配置加载: 通过 Config 类加载项目的配置参数。
• 日志设置: 使用 setup_logger 函数设置日志记录器。
• 发送钓鱼邮件: 调用 send_phishing_email 函数发送模拟的钓鱼邮件。

3. 项目的配置文件介绍

config.py

config.py 文件包含了项目的各种配置参数，以下是该文件的主要内容：

class Config:
    def __init__(self):
        self.smtp_server = "smtp.example.com"
        self.smtp_port = 587
        self.smtp_username = "your_username"
        self.smtp_password = "your_password"
        self.from_email = "[e-mail]"
        self.to_email = "[e-mail]"
        self.subject = "Important: Your Account Needs Verification"
        self.log_level = "INFO"

配置参数说明

• smtp_server: SMTP服务器地址，用于发送邮件。
• smtp_port: SMTP服务器端口。
• smtp_username: SMTP服务器的用户名。
• smtp_password: SMTP服务器的密码。
• from_email: 发送邮件的地址。
• to_email: 目标邮件地址。
• subject: 邮件主题。
• log_level: 日志记录级别，如 INFO, DEBUG 等。

通过这些配置参数，可以灵活地调整项目的运行环境和行为。