开源项目OpenWAF的安装与使用文档

乔媚倩June

于 2024-08-09 08:09:42 发布

阅读量807

点赞数 19

本文链接：https://blog.csdn.net/gitblog_00150/article/details/141048684

版权

开源项目OpenWAF的安装与使用文档

OpenWAFWeb security protection system based on openresty项目地址:https://gitcode.com/gh_mirrors/op/OpenWAF

1. 项目目录结构及介绍

当你克隆或者下载了OpenWAF的GitHub仓库之后，其基本目录结构通常如下所示：

OpenWAF/
|-- doc/
|   |-- 示例文档和指南
|-- conf/
|   |-- 存放所有配置文件的地方
|-- src/
|   |-- 包含主要源代码的部分
|-- Makefile
|-- README.md
|-- LICENSE

doc/: 此目录中包含了项目的一些文档和使用指南。
conf/: 此处存放着OpenWAF的所有配置文件，包括但不限于twaf_main.conf, twaf_api.conf, twaf_server.conf, 和 twaf_access_rule.json等关键配置。
src/: 源代码的核心部分，可能包含编译所需的源文件以及其他开发资源。
Makefile: 用于构建项目的脚本文件，可以通过它来进行编译和安装过程。
README.md: 项目的主要入口点，通常提供了关于项目的基本信息、如何构建和运行项目的基本指导。
LICENSE: 描述了该项目使用的许可证类型，对于开源项目至关重要。

2. 项目的启动文件介绍

编译安装

OpenWAF需要与Nginx和Lua一起工作，因此第一步通常是确保你的系统上有适当的环境和依赖。在Linux系统中，你可以使用以下命令来安装必要的软件包:

sudo apt-get update && sudo apt-get install -y build-essential lua5.1 lua-nginx-module libgeoip-dev libncurses5-dev zlib1g-dev openssl libssl-dev

接下来，你需要分别编译和安装Nginx和OpenWAF。首先，从官方网站下载Nginx的最新稳定版源码，解压并进入目录：

wget http://nginx.org/download/nginx-1.19.10.tar.gz
tar zxf nginx-1.19.10.tar.gz
cd nginx-1.19.10

然后，安装必要的Nginx模块：

./configure --prefix=/usr/local/nginx \
            --with-http_stub_status_module \
            --with-http_real_ip_module \
            --add-module=/path/to/lua-nginx-module
make && sudo make install

对于OpenWAF本身，同样遵循类似的流程。首先克隆OpenWAF仓库：

git clone https://github.com/titansec/OpenWAF.git
cd OpenWAF

最后执行Makefile中的install目标完成安装：

make install

启动服务

一旦所有组件都正确安装，你就可以通过启动Nginx服务器开始使用OpenWAF了。这通常只需要运行：

sudo /usr/local/nginx/sbin/nginx

然而，在实际部署中，往往还需要配置systemd服务文件以便更好地管理和控制OpenWAF+Nginx的生命周期。

3. 项目的配置文件介绍

nginx配置文件

在/usr/local/openresty/nginx/conf目录下找到nginx.conf。这是Nginx的基础配置文件，其中包含了所有server blocks和其他全局设置。特别关注如何将OpenWAF集成进来的部分，例如引入twaf_main.conf和twaf_api.conf，这两者位于OpenWAF自身的conf目录中。