Skip to content

Commit

Permalink
Readme en (#1704)
Browse files Browse the repository at this point in the history
* [add] 添加英文readme

* [add] 添加英文版免责声明与license

* [update] LICENSE

* [update] LICENSE

* [update] Naturalization

Co-authored-by: luhan.xu <luhan.xu@chaitin.com>
  • Loading branch information
Jarcis-cy and luhan.xu committed Dec 27, 2022
1 parent 4f47fb1 commit 6c33ea2
Show file tree
Hide file tree
Showing 4 changed files with 212 additions and 1 deletion.
18 changes: 18 additions & 0 deletions Disclaimer.md
Expand Up @@ -14,3 +14,21 @@

在安装并使用本工具前,请您**务必审慎阅读、充分理解各条款内容**,限制、免责条款或者其他涉及您重大权益的条款可能会以加粗、加下划线等形式提示您重点注意。
除非您已充分阅读、完全理解并接受本协议所有条款,否则,请您不要安装并使用本工具。您的使用行为或者您以其他任何明示或者默示方式表示接受本协议的,即视为您已阅读并同意本协议的约束。


## Disclaimer

This tool is only for **legally authorized** enterprise security construction behavior, if you need to test the usability of this tool, please build your own target environment.

When using this tool for testing, you should ensure that the behavior complies with local laws and regulations and that sufficient authorization has been obtained. **Do not scan unauthorized targets.**

If you have obtained the License of the software Community Premium Edition and other versions, the rights and interests under the License are for your personal use only. **Reproduction, distribution and dissemination of the License in any form are prohibited.**

It is forbidden to reverse engineer, decompile, and attempt to decipher the source code of the software.

**We reserve the right to hold you legally liable if we find the above prohibited behavior.**

If you have any illegal behavior in the process of using this tool, you need to bear the corresponding consequences by yourself, and we will not bear any legal and joint liability.

Before installing and using the tool, please **be sure to carefully read and fully understand the content of the terms**. Limitations, disclaimers or other terms involving your significant rights and interests may be in bold, underlined and other forms to remind you to pay attention.
Please do not install and use this tool unless you have fully read, fully understand and accept all the terms of this Agreement. Your use of this Agreement or your acceptance of this Agreement by any other express or implied means shall be deemed that you have read and agreed to be bound by this Agreement.
4 changes: 4 additions & 0 deletions LICENSE.md
Expand Up @@ -3,3 +3,7 @@
- 注明集成了本项目(注明方式: 在项目介绍页附上本项目 repo 地址)
- 同意 https://github.com/chaitin/xray/blob/master/Disclaimer.md 免责声明

Anyone is welcome to use this program in any form provided the following conditions are met (Including commercial).

- Indicate the integration of the project (indicate: attach the repo address of the project on the project introduction page)
- Agree to https://github.com/chaitin/xray/blob/master/Disclaimer.md disclaimer
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -14,7 +14,9 @@

![](https://docs.xray.cool/assets/term.svg)

🏠[使用文档](https://docs.xray.cool) ⬇️[下载地址](https://github.com/chaitin/xray/releases)
[**English Version**](./README_EN.md)

🏠[使用文档](https://docs.xray.cool) ⬇️[下载地址](https://github.com/chaitin/xray/releases)

注意:xray 不开源,直接下载构建的二进制文件即可,仓库内主要为社区贡献的 poc,每次 xray 发布将自动打包。

Expand Down
187 changes: 187 additions & 0 deletions README_EN.md
@@ -0,0 +1,187 @@
<h1 align="center">Welcome to xray 👋</h1>
<p>
<img src="https://img.shields.io/github/release/chaitin/xray.svg" />
<img src="https://img.shields.io/github/release-date/chaitin/xray.svg?color=blue&label=update" />
<img src="https://img.shields.io/badge/go report-A+-brightgreen.svg" />
<a href="https://chaitin.github.io/xray/#/">
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
</a>
</p>

> A powerful security assessment tool
### ✨ Demo

![](https://docs.xray.cool/assets/term.svg)

[**中文版本**](./README.md)

🏠[Document](https://docs.xray.cool) ⬇️[Download](https://github.com/chaitin/xray/releases)

Note: xray is not open source, you can download the built binaries directly, and the poc in the repository, which is mainly contributed by the community, will be packaged automatically for each xray release.

## 🚀 Quick use

**Before using the tool, read and agree to the terms especially the disclaimer in the [License](https://github.com/chaitin/xray/blob/master/LICENSE.md). Otherwise, do not install or use the tool.**

1. Use the base basic web crawler scan to scrape and perform vulnerability scanning on the scraped links

```bash
xray webscan --basic-crawler http://example.com --html-output vuln.html
```

2. Use an HTTP proxy for passive scanning

```bash
xray webscan --listen 127.0.0.1:7777 --html-output proxy.html
```
Set the browser http proxy to `http://127.0.0.1:7777` to analyze proxy traffic and scan automatically.

>To scan https traffic, read the `Crawling https Traffic` section below
3. Only a single url is scanned, without crawlers

```bash
xray webscan --url http://example.com/?a=b --html-output single-url.html
```

4. Manually configure the plugins to run this time

By default, all built-in plugins are enabled. You can specify which plugins are enabled for this scan using the following command.

```bash
xray webscan --plugins cmd-injection,sqldet --url http://example.com
xray webscan --plugins cmd-injection,sqldet --listen 127.0.0.1:7777
```

5. Specifying plugin output

You can choose targeted vulnerability and their details of this scan and export a report:

```bash
xray webscan --url http://example.com/?a=b \
--text-output result.txt --json-output result.json --html-output report.html
```

[Sample Report](https://docs.xray.cool/assets/report_example.html)

For other uses, read the documentation: https://docs.xray.cool


## 🛠 Detection module

New detection modules will be added continuously

- XSS vulnerability detection (key: xss)

Semantic analysis is used to detect XSS vulnerabilities


- SQL Injection Detection (key: sqldet)

It supports error injection, Boolean injection, time blind injection, etc


- Command/Code injection detection (key: cmd-injection)

It supports shell command injection, PHP code execution, template injection, etc


- dirscan (key: dirscan)

Detects more than 10 sensitive paths and files, including backup files, temporary files, debug pages, and configuration files


- Path traversal detection (key: path-traversal)

Support for common platforms and encodings


- XML Entity Injection Detection (key: xxe)

Support for echo and reverse platform detection


- POC management (key: phantasm)

Some commonly used POCs are built in by default. Users can build and run POCs based on their needs. Document: https://docs.xray.cool/#/guide/poc


- File upload detection (key: upload)

Support for common back-end languages


- Weak password detection (key: brute-force)

The Community Edition supports the detection of HTTP basic authentication and weak passwords for simple forms, with a built-in dictionary of common user names and passwords


- jsonp detection (key: jsonp)

Detects jsonp interfaces that contain sensitive information that can be read across domains


- ssrf detection (key: ssrf)

ssrf detection module supports common bypass technology and reverse platform detection


- Baseline detection (key: baseline)

Detects low SSL versions, missing or incorrectly added http, and so on


- Redirection detection (key: redirect)

Support HTML meta jump, 30x jump, etc


- CRLF injection (key: crlf-injection)

Detects HTTP header injection and supports parameters for query, body, etc


- Struts2 series vulnerability detection (Premium edition,key: struts)

Detect whether the target website has Struts2 series vulnerabilities, including s2-016, s2-032, s2-045 and other common vulnerabilities


- Thinkphp series vulnerability detection (Premium edition,key: thinkphp)

Detect vulnerabilities in ThinkPHP websites


- ..


## ⚡️ Advanced use

See https://docs.xray.cool/ for the following advanced uses.

- Modifying the configuration file
- Scraping https traffic
- Modifying the http packet sending configuration
- Employing reverse platforms
- ...

## 😘 Contribute POC

See: https://docs.xray.cool/#/guide/contribute

## 📝 Discussion area

Feedback of false positives,false negatives, please don’t hesitate to contact us. Be sure to read https://docs.xray.cool/#/guide/feedback first

If you have a question, you can ask it on GitHub or in the discussion group below

1. GitHub issue: https://github.com/chaitin/xray/issues
2. Wechat official account: Scan the following QR code on wechat and subscribe us

<img src="https://docs.xray.cool/assets/wechat.jpg?cache=_none" height="200px">

3. Wechat group: wechat scan the following QR code to add the group

<img src="https://ctstack-oss.oss-cn-beijing.aliyuncs.com/xray/ctstack-group-qr-code.jpg" height="200px">

4. QQ group: 717365081

0 comments on commit 6c33ea2

Please sign in to comment.