diff --git a/config/_default/params.toml b/config/_default/params.toml index a845dee1..ea3e2b96 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -7,7 +7,7 @@ titleAddition = "Enterprise-grade open source web application firewall library" description = "OWASP Coraza is an enterprise-grade, open-source, and high-performance Web Application Firewall library ready to protect your beloved applications." # Alert -alert = true +alert = false alertDismissable = true alertText = "Coraza v3 available here!" diff --git a/content/docs/reference/extending.md b/content/docs/reference/extending.md index a21a374d..0defe77b 100644 --- a/content/docs/reference/extending.md +++ b/content/docs/reference/extending.md @@ -97,8 +97,8 @@ Once the action is created, it must be wrapper inside a ```type PluginActionWrap ```go import( - "github.com/corazawaf/coraza/v3/actions" - "github.com/corazawaf/coraza/v3/types" + "github.com/corazawaf/coraza/v3/experimental/plugins/actions" + "github.com/corazawaf/coraza/v3/experimental/plugins/types" ) func init() { @@ -130,7 +130,7 @@ type Transformation = func(input string, tools *Tools) string ```go import ( - "github.com/corazawaf/coraza/v3/transformations" + "github.com/corazawaf/coraza/v3/experimental/plugins/transformations" "strings" ) @@ -184,8 +184,8 @@ Once the operator is created, it must be wrapper inside a ```type PluginOperator ```go import( - "github.com/corazawaf/coraza/v3/operators" - "github.com/corazawaf/coraza/v3/types" + "github.com/corazawaf/coraza/v3/experimental/plugins/operators" + "github.com/corazawaf/coraza/v3/experimental/plugins/types" ) func init() { @@ -207,9 +207,9 @@ There are no special helpers to test plugins but you may use the seclang compile ```go import( - "github.com/jptosso/coraza-waf/v2/seclang" - "github.com/jptosso/coraza-waf/v2/types" - "github.com/jptosso/coraza-waf/v2/transformations" + "github.com/corazawaf/coraza/v3/experimental/plugins/seclang" + "github.com/corazawaf/coraza/v3/experimental/plugins/types" + "github.com/corazawaf/coraza/v3/experimental/plugins/transformations" "strings" "testing" ) @@ -259,7 +259,7 @@ license: apache2 description: Short description to display in plugins.coraza.io # We are using Ruby Gem version syntax: https://guides.rubygems.org/patterns/#pessimistic-version-constraint # The min supported Coraza version, each item represents an AND operator -version: +version: - ">= v1.1" - "< v2" # or ~> that is identical to the previous statements diff --git a/content/docs/tutorials/introduction.md b/content/docs/tutorials/introduction.md index 7fc85677..c8b42798 100644 --- a/content/docs/tutorials/introduction.md +++ b/content/docs/tutorials/introduction.md @@ -38,9 +38,9 @@ Coraza is an open source, enterprise-grade, high performance Web Application Fir Key Features: -* โ‡ฒ **Drop-in** - Coraza is a drop-in alternative to replace Trustwave ModSecurity Engine [(planned to be deprecated on July 1, 2024)](https://www.modsecurity.org/) and supports industry-standard SecLang rule sets. +* โ‡ฒ **Drop-in** - Coraza is an alternative engine that has partial compatibility with ~Trustwave~[OWASP ModSecurity Engine](https://github.com/owasp-modsecurity/modsecurity/) and supports industry-standard SecLang rule sets. -* ๐Ÿ”ฅ **Security** - Coraza runs the [OWASP Core Rule Set (CRS)](https://coreruleset.org) to protect your web applications from a wide range of attacks, including the OWASP Top Ten, with a minimum of false alerts. CRS protects from many common attack categories including SQL Injection (SQLi), Cross Site Scripting (XSS), PHP & Java Code Injection, HTTPoxy, Shellshock, Scripting/Scanner/Bot Detection & Metadata & Error Leakages. +* ๐Ÿ”ฅ **Security** - Coraza runs the [OWASP CRS](https://coreruleset.org) to protect your web applications from a wide range of attacks, including the OWASP Top Ten, with a minimum of false alerts. CRS protects from many common attack categories including SQL Injection (SQLi), Cross Site Scripting (XSS), PHP & Java Code Injection, HTTPoxy, Shellshock, Scripting/Scanner/Bot Detection & Metadata & Error Leakages. * ๐Ÿ”Œ **Extensible** - Coraza is a library at its core, with many integrations to deploy on-premise Web Application Firewall instances. Audit Loggers, persistence engines, operators, actions, create your own functionalities to extend Coraza as much as you want. @@ -48,13 +48,13 @@ Key Features: * ๏นก **Simplicity** - Anyone can understand and modify the Coraza source code. It is easy to extend Coraza with new functionality. -* ๐Ÿ’ฌ **Community** - Coraza is a community project, contributions are accepted and all ideas will be considered. Find contributor guidance in the [CONTRIBUTION](https://github.com/corazawaf/coraza/blob/v2/master/CONTRIBUTING.md) document. +* ๐Ÿ’ฌ **Community** - Coraza is a community project, contributions are accepted and all ideas will be considered. Find contributor guidance in the [CONTRIBUTION](https://github.com/corazawaf/coraza/blob/main/CONTRIBUTING.md) document.
## Integrations -The Coraza Project maintains implementations and plugins for the following servers: +The Coraza Project maintains implementations and plugins for the following servers: * [Caddy Reverse Proxy and Webserver Plugin](https://github.com/corazawaf/coraza-caddy) - stable, needs a maintainer * [Proxy WASM extension](https://github.com/corazawaf/coraza-proxy-wasm) for proxies with proxy-wasm support (e.g. Envoy) - stable, still under development @@ -158,7 +158,7 @@ Contributions are welcome! Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) * [Babiel](https://babiel.com) (supporter) -### Author on Twitter +### Author on Twitter - [@jptosso](https://twitter.com/jptosso)