teler-waf 项目安装与使用教程

teler-waf 项目安装与使用教程

teler-waf teler-waf is a Go HTTP middleware that provides teler IDS functionality. 项目地址: https://gitcode.com/gh_mirrors/te/teler-waf

1. 项目目录结构及介绍

teler-waf/
├── cmd/
│   └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── middleware/
│   │   └── teler.go
│   └── utils/
│       └── helpers.go
├── pkg/
│   ├── detection/
│   │   └── rules.go
│   └── logging/
│       └── logger.go
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件 main.go。
• config/: 包含项目的配置文件 config.yaml。
• internal/: 包含项目的内部逻辑代码。
  • middleware/: 包含 HTTP 中间件的实现，如 teler.go。
  • utils/: 包含项目中使用的工具函数，如 helpers.go。
• pkg/: 包含项目的公共包。
  • detection/: 包含威胁检测规则的实现，如 rules.go。
  • logging/: 包含日志记录的实现，如 logger.go。
• go.mod 和 go.sum: Go 模块依赖文件。
• README.md: 项目说明文档。

2. 项目启动文件介绍

cmd/main.go

main.go 是项目的启动文件，负责初始化配置、加载中间件并启动 HTTP 服务器。以下是 main.go 的主要内容：

package main

import (
    "github.com/teler-sh/teler-waf"
    "log"
    "net/http"
)

func main() {
    // 初始化 teler WAF
    waf := teler.New()

    // 创建 HTTP 处理器
    handler := waf.Handler(http.DefaultServeMux)

    // 启动 HTTP 服务器
    log.Fatal(http.ListenAndServe(":8080", handler))
}

启动步骤

1. 初始化 teler WAF: 使用 teler.New() 创建一个新的 teler WAF 实例。
2. 创建 HTTP 处理器: 使用 waf.Handler() 方法将 teler WAF 中间件应用到默认的 HTTP 处理器。
3. 启动 HTTP 服务器: 使用 http.ListenAndServe() 启动 HTTP 服务器，监听端口 8080。

3. 项目配置文件介绍

config/config.yaml

config.yaml 是 teler WAF 的配置文件，用于配置各种安全规则和行为。以下是一个示例配置文件：

# teler WAF 配置文件

# 威胁排除规则
excludes:
  - rule: "SQL Injection"
  - rule: "XSS"

# 日志配置
logging:
  level: "info"
  output: "stdout"

# 检测规则
detection:
  rules:
    - name: "SQL Injection"
      pattern: ".*(SELECT|INSERT|UPDATE|DELETE).*"
    - name: "XSS"
      pattern: ".*(<script>|</script>).*"

配置项介绍

• excludes: 定义需要排除的威胁检测规则。
• logging: 配置日志记录的级别和输出方式。
• detection: 定义具体的威胁检测规则，包括规则名称和匹配模式。

通过配置文件，用户可以根据自己的需求定制 teler WAF 的行为，以更好地保护本地 Web 服务。

teler-waf teler-waf is a Go HTTP middleware that provides teler IDS functionality. 项目地址: https://gitcode.com/gh_mirrors/te/teler-waf