|
@@ -1,11 +1,7 @@
|
|
|
-<p align="center">
|
|
|
- <a href="./README.md">English</a> |
|
|
|
- <a href="./README_CN.md">中文</a>
|
|
|
-</p>
|
|
|
-<h1 align="center">SafeLine - The Best WAF For Community</h1>
|
|
|
+<h1 align="center">SafeLine, The Best WAF For Webmaster</h1>
|
|
|
|
|
|
<p align="center">
|
|
|
- <img src="https://raw.githubusercontent.com/chaitin/SafeLine/main/documents/static/images/403.svg" width="120">
|
|
|
+ <img src="https://raw.githubusercontent.com/chaitin/SafeLine/main/documents/static/images/403.svg" width="160">
|
|
|
</p>
|
|
|
<br>
|
|
|
<p align="center">
|
|
@@ -17,109 +13,128 @@
|
|
|
</p>
|
|
|
|
|
|
<p align="center">
|
|
|
- <a href="https://waf-ce.chaitin.cn/">Home Page</a> |
|
|
|
- <a href="https://demo.waf-ce.chaitin.cn:9443/dashboard">Online Demo</a> |
|
|
|
- <a href="https://waf-ce.chaitin.cn/posts/guide_introduction">Documents</a>
|
|
|
+ <a target="_blank" href="https://waf.chaitin.com/">Home</a> |
|
|
|
+ <a target="_blank" href="https://demo.waf.chaitin.com:9443/dashboard">Demo</a> |
|
|
|
+ <a target="_blank" href="https://docs.waf.chaitin.com/">Docs</a> |
|
|
|
+ <a target="_blank" href="https://discord.gg/wyshSVuvxC">Discord</a> |
|
|
|
+ <a href="./README_CN.md">中文版</a>
|
|
|
</p>
|
|
|
|
|
|
-A simple, easy-to-use, and powerful free WAF. Based on the industry-leading semantic engine detection technology, it serves as a reverse proxy access to protect your website.
|
|
|
+SafeLine is a simple, lightweight, locally deployable WAF, it is the best waf for webmaster.
|
|
|
+
|
|
|
+It serves as a reverse proxy access to protect your website from network attacks that including OWASP attacks, zero-day attacks, web crawlers, vulnerability scanning, vulnerability exploit, http flood and so on.
|
|
|
|
|
|
- Cumulative installations exceed **130,000** units
|
|
|
- Protecting websites over **1,000,000**
|
|
|
- Processing HTTP requests over **30,000,000,000** times per day
|
|
|
- Intercepting attacks over **50,000,000** times per day
|
|
|
|
|
|
-The core detection capability is driven by intelligent semantic analysis algorithms, tailored for the community, keep hackers away from you.
|
|
|
-
|
|
|
<img src="./images/safeline_en.png" />
|
|
|
|
|
|
-<h4 align="center">Related Repo</h4>
|
|
|
-<p align="center">
|
|
|
- <a href="https://github.com/chaitin/yanshi">Automaton Generator</a> |
|
|
|
- <a href="https://github.com/chaitin/safeline-open-platform">Lua Plugin</a> |
|
|
|
- <a href="https://github.com/chaitin/lua-resty-t1k">T1K Protocol</a> |
|
|
|
- <a href="https://github.com/chaitin/blazehttp">WAF Test Tool</a>
|
|
|
-</p>
|
|
|
|
|
|
-## Features
|
|
|
+## Installation
|
|
|
|
|
|
-#### Convenience
|
|
|
+> Recommended
|
|
|
|
|
|
-Adopting containerized deployment, installation can be completed with one command at zero cost. Security configurations are ready to use out of the box, requiring no manual maintenance and enabling secure and effortless management.
|
|
|
+Use the following command to start the automated installation of SafeLine. (This process requires root privileges)
|
|
|
|
|
|
-#### Security
|
|
|
+```bash
|
|
|
+bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)"
|
|
|
+```
|
|
|
|
|
|
-Pioneering industry-leading intelligent semantic analysis algorithms for precise detection, low false positives, and resistance to circumvention. Unconstrained by rules, the semantic analysis algorithm equips users to confidently confront unknown 0day attack features.
|
|
|
+After the command is executed, it means the installation is successfully. Please go to "Use Web UI" directly.
|
|
|
|
|
|
-#### High Performance
|
|
|
|
|
|
-Ruleless engine, linear security detection algorithm, with an average request detection latency at the millisecond level. Strong concurrency capability, effortlessly detecting 2000+ TPS on a single core; with sufficient hardware, there is no upper limit to the supported traffic scale.
|
|
|
+## Mannually Deploy
|
|
|
|
|
|
-#### High Availability
|
|
|
+to see [Documentation](https://docs.waf.chaitin.com/en/toturials/install)
|
|
|
|
|
|
-The traffic processing engine is developed based on Nginx, guaranteeing both performance and stability. It incorporates a comprehensive health check mechanism, ensuring a service availability of up to 99.99%.
|
|
|
+## Use Web UI
|
|
|
|
|
|
+Open the web console page `https://<safeline-ip>:9443/` in the browser, then you will see below.
|
|
|
|
|
|
-## 🚀 Get Started
|
|
|
+
|
|
|
|
|
|
-### Environment
|
|
|
+Execute the following command to get administrator account
|
|
|
|
|
|
-- Operating System: Linux
|
|
|
-- Instruction Architecture: x86_64
|
|
|
-- Software Dependencies: Docker version 20.10.6 or higher
|
|
|
-- Software Dependencies: Docker Compose version 2.0.0 or higher
|
|
|
-- Minimum Environment: 1 core CPU / 1 GB memory / 10 GB disk
|
|
|
+```bash
|
|
|
+docker exec safeline-mgt /app/mgt-cli reset-admin --once
|
|
|
+```
|
|
|
|
|
|
-### Setup
|
|
|
+After the command is successfully executed, you will see the following content
|
|
|
|
|
|
-```
|
|
|
-bash -c "$(curl -fsSLk https://waf-ce.chaitin.cn/release/latest/setup.sh)"
|
|
|
+> Please must remember this content
|
|
|
+
|
|
|
+```text
|
|
|
+[SafeLine] Initial username:admin
|
|
|
+[SafeLine] Initial password:**********
|
|
|
+[SafeLine] Done
|
|
|
```
|
|
|
|
|
|
-> for information for <a href="https://waf-ce.chaitin.cn/posts/guide_install">安装雷池</a>
|
|
|
+Enter the password in the previous step and you will successfully logged into SafeLine.
|
|
|
|
|
|
-## 🕹️ use SafeLine
|
|
|
+## Core Capabilities
|
|
|
|
|
|
-### Login
|
|
|
+#### Defenses For OWASP Attacks
|
|
|
|
|
|
-After opening the backend management page in the browser at `https://<IP-or-HOSTNAME>:9443`, follow the on-screen instructions to scan the QR code using an authentication app that supports TOTP, and then enter the dynamic password to log in.
|
|
|
+SafeLine use as an important tool to defense against OWASP Top 10 Attack, such as SQL injection, XSS, Insecure deserialization etc.
|
|
|
|
|
|
-
|
|
|
+#### Defenses For 0-Day Attacks
|
|
|
|
|
|
-### Settings
|
|
|
+SafeLine use intelligent rule-free detection algorithm to against 0-Day attacks with unknown attack signatures.
|
|
|
|
|
|
-SafeLine is accessed in reverse proxy mode, receiving traffic before the web server, detecting and cleaning attack behavior in the traffic, and then forwarding the cleaned traffic to the web server.
|
|
|
+#### Proactive Bot defense
|
|
|
|
|
|
-
|
|
|
+SafeLine uses advanced algorithms to send capthcha challenge for suspicious users to against automated robot attacks.
|
|
|
|
|
|
-<font color=grey>💡 TIPS: After adding, executing `curl -H "Host: <domain>" http://<IP-or-HOSTNAME>:<port>` should be able to get the response of the website.
|
|
|
+#### In-Browser Code Encryption
|
|
|
|
|
|
-### test
|
|
|
+SafeLine can dynamically encrypt and obfuscate static code in the browser (such as HTML, JavaScript) to against reverse engineering.
|
|
|
|
|
|
-Use the following step to simulate hacker attack and see how effective the protection of the SafeLine is.
|
|
|
+#### Web Authentication
|
|
|
|
|
|
-- access `http://<IP-or-HOSTNAME>:<PORT>/?id=1%20AND%201=1`
|
|
|
-- access `http://<IP-or-HOSTNAME>:<PORT>/?a=<script>alert(1)</script>`
|
|
|
+SafeLine prompting the user for authentication to web apps that lacks valid authentication credentials, Illegal users will be blocked.
|
|
|
|
|
|
-
|
|
|
+#### Web Access Control List
|
|
|
|
|
|
-> more test for <a href="https://waf-ce.chaitin.cn/posts/guide_test">测试防护效果</a>
|
|
|
+SafeLine offering fine-grained control over traffic allows you to define a set of rules that determine which requests are allowed or denied.
|
|
|
|
|
|
-### FAQ
|
|
|
+## Features
|
|
|
+
|
|
|
+#### Easy To Use
|
|
|
+
|
|
|
+Deployed by Docker, one command can complete the installation, and you can get started at 0 cost.
|
|
|
+
|
|
|
+The security configuration is ready to use, no manual maintenance is required, and safe lying management can be achieved.
|
|
|
+
|
|
|
+#### High Security Efficacy
|
|
|
+
|
|
|
+The first intelligent semantic analysis algorithm in the industry, accurate detection, low false alarm, and difficult to bypass.
|
|
|
+
|
|
|
+The semantic analysis algorithm has no rules, and you are no longer at a loss when facing 0-day attacks with unknown features.
|
|
|
+
|
|
|
+#### High Performance
|
|
|
|
|
|
-- [SETUP](https://waf-ce.chaitin.cn/posts/faq_install)
|
|
|
-- [LOGIN](https://waf-ce.chaitin.cn/posts/faq_login)
|
|
|
-- [PROXY](https://waf-ce.chaitin.cn/posts/faq_access)
|
|
|
-- [SETTINGS](https://waf-ce.chaitin.cn/posts/faq_config)
|
|
|
-- [OTHERS](https://waf-ce.chaitin.cn/posts/faq_other)
|
|
|
+Ruleless engine, linear security detection algorithm, average request detection delay at 1 millisecond level.
|
|
|
|
|
|
-## 🏘️ Talk Group
|
|
|
+Strong concurrency, single core easily detects 2000+ TPS, as long as the hardware is strong enough, there is no upper limit to the traffic scale that can be supported.
|
|
|
|
|
|
-1. Bug feedback and feature suggestions can be directly submitted through GitHub Issues.
|
|
|
-2. Join <a target="_blank" href="https://discord.gg/wyshSVuvxC">SafeLine Discord</a> for more discussions.
|
|
|
+#### High Availability
|
|
|
+
|
|
|
+The traffic processing engine is developed based on Nginx, and both performance and stability can be guaranteed.
|
|
|
+
|
|
|
+Built-in complete health check mechanism, service availability is as high as 99.99%.
|
|
|
|
|
|
## Star History <a name="star-history"></a>
|
|
|
|
|
|
<a href="https://github.com/chaitin/safeline/stargazers">
|
|
|
<img width="500" alt="Star History Chart" src="https://api.star-history.com/svg?repos=chaitin/safeline&type=Date">
|
|
|
</a>
|
|
|
+
|
|
|
+## Related Repo
|
|
|
+<p >
|
|
|
+ <a href="https://github.com/chaitin/yanshi">Automaton Generator</a> |
|
|
|
+ <a href="https://github.com/chaitin/safeline-open-platform">Lua Plugin</a> |
|
|
|
+ <a href="https://github.com/chaitin/lua-resty-t1k">T1K Protocol</a> |
|
|
|
+ <a href="https://github.com/chaitin/blazehttp">WAF Test Tool</a>
|
|
|
+</p>
|