Watchtower 项目教程

1. 项目的目录结构及介绍

Watchtower 项目的目录结构如下：

watchtower/
├── doc/
│   └── ...
├── examples/
│   └── ...
├── lib/
│   └── ...
├── signatures/
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── INSTALL.md
├── LICENSE
├── README.md
├── Rakefile
├── config.rb
└── watchtower

目录介绍：

• doc/：包含项目的文档文件。
• examples/：包含示例文件，展示如何使用 Watchtower。
• lib/：包含项目的核心库文件。
• signatures/：包含用于静态代码分析的签名文件。
• test/：包含项目的测试文件。
• .gitignore：Git 忽略文件配置。
• INSTALL.md：安装指南。
• LICENSE：项目许可证文件。
• README.md：项目介绍和使用说明。
• Rakefile：Rake 构建文件。
• config.rb：项目的配置文件。
• watchtower：项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 watchtower，它是一个可执行文件，用于启动 Watchtower 静态代码分析工具。该文件负责加载配置、执行扫描并生成报告。

使用方法：

./watchtower -s /app/path/to/scan -p 'The Project Name' -o html > /path/to/report/file.html

• -s：指定要扫描的项目路径或远程 URL。
• -p：指定项目名称。
• -o：指定输出格式（如 html、csv、xml 等）。

3. 项目的配置文件介绍

项目的配置文件是 config.rb，它包含了 Watchtower 的各种配置选项，主要用于控制扫描行为和报告生成。

配置文件内容：

# 配置文件示例
$configs = {
  :ftype_ext => {
    'php' => ['php', 'php5', 'phtml'],
    'python' => ['py']
  },
  :signatures => [
    'signatures/php.rb',
    'signatures/python.rb'
  ]
}

$signatures = {
  :php => {
    :dangerous_functions => [
      Signature.new([:literal => 'base64_decode(']),
      Signature.new([:literal => 'eval(']),
      Signature.new([:literal => 'exec('])
    ]
  },
  :python => {
    :dangerous_functions => [
      Signature.new([:literal => 'exec(']),
      Signature.new([:literal => 'eval('])
    ]
  }
}

配置项介绍：

• ftype_ext：定义不同编程语言的文件扩展名。
• signatures：定义不同编程语言的签名文件路径。
• $signatures：定义具体的签名规则，包括危险函数等。

通过修改 config.rb 文件，可以自定义 Watchtower 的扫描行为和报告格式。