GoEdgeNode/internal/waf/checkpoints/cc.go

package checkpoints

import (
	"github.com/TeaOSLab/EdgeNode/internal/ttlcache"
	"github.com/TeaOSLab/EdgeNode/internal/waf/requests"
	"github.com/iwind/TeaGo/maps"
	"github.com/iwind/TeaGo/types"
	"regexp"
	"sync"
	"time"
)

// CCCheckpoint ${cc.arg}
// TODO implement more traffic rules
type CCCheckpoint struct {
	Checkpoint

	cache *ttlcache.Cache
	once  sync.Once
}

func (this *CCCheckpoint) Init() {

}

func (this *CCCheckpoint) Start() {
	if this.cache != nil {
		this.cache.Destroy()
	}
	this.cache = ttlcache.NewCache()
}

func (this *CCCheckpoint) RequestValue(req requests.Request, param string, options maps.Map, ruleId int64) (value interface{}, hasRequestBody bool, sysErr error, userErr error) {
	value = 0

	if this.cache == nil {
		this.once.Do(func() {
			this.Start()
		})
		if this.cache == nil {
			return
		}
	}

	periodString, ok := options["period"]
	if !ok {
		return
	}
	period := types.Int64(periodString)
	if period < 1 {
		return
	}

	v, _ := options["userType"]
	userType := types.String(v)

	v, _ = options["userField"]
	userField := types.String(v)

	v, _ = options["userIndex"]
	userIndex := types.Int(v)

	if param == "requests" { // requests
		var key = ""
		switch userType {
		case "ip":
			key = req.WAFRemoteIP()
		case "cookie":
			if len(userField) == 0 {
				key = req.WAFRemoteIP()
			} else {
				cookie, _ := req.WAFRaw().Cookie(userField)
				if cookie != nil {
					v := cookie.Value
					if userIndex > 0 && len(v) > userIndex {
						v = v[userIndex:]
					}
					key = "USER@" + userType + "@" + userField + "@" + v
				}
			}
		case "get":
			if len(userField) == 0 {
				key = req.WAFRemoteIP()
			} else {
				v := req.WAFRaw().URL.Query().Get(userField)
				if userIndex > 0 && len(v) > userIndex {
					v = v[userIndex:]
				}
				key = "USER@" + userType + "@" + userField + "@" + v
			}
		case "post":
			if len(userField) == 0 {
				key = req.WAFRemoteIP()
			} else {
				v := req.WAFRaw().PostFormValue(userField)
				if userIndex > 0 && len(v) > userIndex {
					v = v[userIndex:]
				}
				key = "USER@" + userType + "@" + userField + "@" + v
			}
		case "header":
			if len(userField) == 0 {
				key = req.WAFRemoteIP()
			} else {
				v := req.WAFRaw().Header.Get(userField)
				if userIndex > 0 && len(v) > userIndex {
					v = v[userIndex:]
				}
				key = "USER@" + userType + "@" + userField + "@" + v
			}
		default:
			key = req.WAFRemoteIP()
		}
		if len(key) == 0 {
			key = req.WAFRemoteIP()
		}
		value = this.cache.IncreaseInt64(types.String(ruleId)+"@"+key, int64(1), time.Now().Unix()+period, false)
	}

	return
}

func (this *CCCheckpoint) ResponseValue(req requests.Request, resp *requests.Response, param string, options maps.Map, ruleId int64) (value interface{}, hasRequestBody bool, sysErr error, userErr error) {
	if this.IsRequest() {
		return this.RequestValue(req, param, options, ruleId)
	}
	return
}

func (this *CCCheckpoint) ParamOptions() *ParamOptions {
	option := NewParamOptions()
	option.AddParam("请求数", "requests")
	return option
}

func (this *CCCheckpoint) Options() []OptionInterface {
	options := []OptionInterface{}

	// period
	{
		option := NewFieldOption("统计周期", "period")
		option.Value = "60"
		option.RightLabel = "秒"
		option.Size = 8
		option.MaxLength = 8
		option.Validate = func(value string) (ok bool, message string) {
			if regexp.MustCompile("^\\d+$").MatchString(value) {
				ok = true
				return
			}
			message = "周期需要是一个整数数字"
			return
		}
		options = append(options, option)
	}

	// type
	{
		option := NewOptionsOption("用户识别读取来源", "userType")
		option.Size = 10
		option.SetOptions([]maps.Map{
			{
				"name":  "IP",
				"value": "ip",
			},
			{
				"name":  "Cookie",
				"value": "cookie",
			},
			{
				"name":  "URL参数",
				"value": "get",
			},
			{
				"name":  "POST参数",
				"value": "post",
			},
			{
				"name":  "HTTP Header",
				"value": "header",
			},
		})
		options = append(options, option)
	}

	// user field
	{
		option := NewFieldOption("用户识别字段", "userField")
		option.Comment = "识别用户的唯一性字段，在用户读取来源不是IP时使用"
		options = append(options, option)
	}

	// user value index
	{
		option := NewFieldOption("字段读取位置", "userIndex")
		option.Size = 5
		option.MaxLength = 5
		option.Comment = "读取用户识别字段的位置，从0开始，比如user12345的数字ID 12345的位置就是5，在用户读取来源不是IP时使用"
		options = append(options, option)
	}

	return options
}

func (this *CCCheckpoint) Stop() {
	if this.cache != nil {
		this.cache.Destroy()
		this.cache = nil
	}
}