1.4.5.2

EdgeNode/internal/waf/README.md

@@ -0,0 +1,48 @@
+# WAF
+A basic WAF for TeaWeb.
+
+## Config Constructions
+~~~
+WAF
+  Inbound
+	  Rule Groups
+		Rule Sets
+		  Rules
+			Checkpoint Param <Operator> Value
+  Outbound
+  	  Rule Groups
+  	    ... 				
+~~~
+
+## Apply WAF
+~~~
+Request  -->  WAF  -->   Backends
+			/
+Response  <-- WAF <----		
+~~~
+
+## Coding
+~~~go
+waf := teawaf.NewWAF()
+
+// add rule groups here
+
+err := waf.Init()
+if err != nil {
+	return
+}
+waf.Start()
+
+// match http request
+// (req *http.Request, responseWriter http.ResponseWriter)
+goNext, ruleSet, _ := waf.MatchRequest(req, responseWriter)
+if ruleSet != nil {
+	log.Println("meet rule set:", ruleSet.Name, "action:", ruleSet.Action)
+}
+if !goNext {
+	return
+}
+
+// stop the waf
+// waf.Stop()
+~~~