Skip to content

Commit

Permalink
[add] 更新readme,更新目录结构
Browse files Browse the repository at this point in the history
  • Loading branch information
Jarcis-cy committed Jun 25, 2024
1 parent f53d6f6 commit 210ac0d
Show file tree
Hide file tree
Showing 364 changed files with 964 additions and 62 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ jobs:
git diff --name-only $PREV_SHA $GITHUB_SHA | grep '^poc/' && POC_CHANGED=true || true
if $FINGER_CHANGED && $POC_CHANGED; then
./xlint_linux_amd64 -f "./finger/*.yml" -f "./poc/*.yml" | tee xlint_output
./xlint_linux_amd64 -f "./finger/**/*.yml" -f "./poc/**/*.yml" | tee xlint_output
elif $FINGER_CHANGED; then
./xlint_linux_amd64 -f "./finger/*.yml" | tee xlint_output
./xlint_linux_amd64 -f "./finger/**/*.yml" | tee xlint_output
elif $POC_CHANGED; then
./xlint_linux_amd64 -f "./poc/*.yml" | tee xlint_output
./xlint_linux_amd64 -f "./poc/**/*.yml" | tee xlint_output
fi
- name: Check for lint errors
Expand Down
72 changes: 63 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
## 🎉 欢迎来到插件存储库!🎉

我们为各类插件创建了一个专门的存储库,旨在方便大家共享和使用各种插件。我们会不定期地往这里推送一些新的插件,同时也非常欢迎各位贡献者提交自己的插件,共同丰富这个仓库。
我们为各类插件创建了一个专门的存储库,旨在方便大家共享和使用各种插件。

这里主要收录的是开源的、转化成 xray格式的脚本,以供大家使用。

我们会不定期地往这里推送一些新的插件,同时也希望大家能积极踊跃的优化或者提交插件,共同丰富这个仓库。

[English Version of README](./README_EN.md)

Expand All @@ -10,14 +14,15 @@

- 指纹:推荐使用 xapp 运行
- POC:推荐使用 xpoc 运行
- Group List:其中存放着一些梳理过的指定运行的文件列表,推荐使用xapp、xpoc -g 运行。

## ⚠️ 使用须知

请注意,本仓库中的插件仅经过 xlint 验证,未经过实际靶站的验证,因此这些插件的内容可能并不一定完全可用。我们建议在使用之前自行验证其有效性。

## ✔️ 插件质量

为了确保插件的质量和一致性,我们会在本项目的 [release](https://github.com/chaitin/xray-plugins/releases) 中及时发布最新的 XLint,专门用于 lint 插件。存放在本仓库的插件唯一要求就是通过 XLint 的检查
为了确保插件的质量和一致性,我们会在本项目的 [release](https://github.com/chaitin/xray-plugins/releases) 中及时发布最新的 XLint,专门用于 lint 插件。存放在本仓库的插件唯一要求就是通过 CI 中的 lint 检查

### 使用指南

Expand All @@ -27,28 +32,77 @@ xlint -f "./finger/*"
xlint -f "./finger/*" -f "./poc/*"
```

更多关于插件修复的指南,请参考 [插件修复指南](https://docs.xray.cool/plugins/yaml/Fix)
## 📜 收录标准

## 🎁 贡献奖励
本仓库收录的内容包括:

我们非常感谢每一位插件贡献者的努力!为了表达我们的感谢,我们会不定期地对插件贡献者发放一些周边礼品。如果你有兴趣贡献插件,请随时提交 PR 或联系项目维护者。
1. 插件优化:对现有插件进行优化,或者将不同来源但检测同一产品或漏洞的插件进行优化合并。
2. Group List:提交自用的好用的 Group List。
3. 新的插件。

## 📜 仓库结构
更多关于插件修复的指南,请参考 [插件修复指南](https://docs.xray.cool/plugins/yaml/Fix)

- `finger/`:存放指纹。
- `poc/`:存放 POC。
### 仓库结构

- `finger/`:存放指纹,分为 `web``service` 两个文件夹。
- `manual/`:存放手工编写的指纹。
- `web/`:存放 Web 指纹。
- `service/`:存放服务指纹。
- `xxx/`:存放xxx来源的指纹。
- ...
- `poc/`:存放 POC,按不同来源分类。
- `manual/`:存放手工编写的poc。
- `xxx/`:存放xxx来源的poc。
- ...
- `group/`:存放一些指定运行的文件列表。

> 注意:在提交指纹或 POC 时,应明确具体的来源。如果是自己编写的,可以将其存放到manual文件夹中,如果是指纹,请确保其中包含cpe信息。
>
> 如果某个插件被优化合并了,应将其从原来源的文件夹中移除,并合并到 `finger|poc/manual/web|service` 文件夹中,表示该插件经过人工确认。
提交时请确认仓库中没有同产品或漏洞的插件,避免重复提交。

## 🛠️ 如何贡献

1. **Fork** 本仓库。
2. **Clone** 到本地进行修改。
3. **Commit** 你的更改,并推送到你的 Fork 仓库。
4. 提交 **Pull Request**,我们会尽快审核并合并你的贡献。

### 贡献奖励

> **如果您希望通过提交或者优化指纹获取奖励,请确保您提交或者优化的指纹中包含cpe信息**
#### 积分发放:

| 分类 | 积分 | 说明 |
| --- | --- | --- |
| GroupList提交 | 20-500/个 | 视GroupList的时效性、完整度、可利用度、价值高低等方面综合评定,给予20-500不等的积分奖励 |
| 新插件提交 | 20/个 | 提交符合插件收录标准且包含准确cpe信息的新插件,给予20积分奖励 |
| 插件优化 | 5/个 | 对现有插件进行优化,或者将不同来源但检测同一产品或漏洞的插件进行优化合并,给予5积分奖励 |

#### 奖励兑换:

每季度开放一次奖励兑换窗口

所有本季度积分在500以上的用户均可以进入排名,不同排名奖励如下:

| 名次 | 荣誉证书 | xray高级版 | 周边礼品 | 惊喜奖品 | |
| --- | --- | --- | --- | --- | --- |
| Top1 | 实体荣誉证书 | xray高级版(90天) | xray社区定制周边(5选3) | 京东卡100元 | 奖励不定时更新 |
| Top2-5 | 电子荣誉证书 | xray高级版(60天) | xray社区定制周边(2选5) | 京东卡50元 |
| Top6-10 | 电子荣誉证书 | xray高级版(30天) | xray社区定制周边(1选5) | / |
| Top11-20 | 电子荣誉证书 | xray高级版(15天) | xray社区定制周边指定1款 | / |
| Top21- | 电子荣誉证书 | xray高级版(7天) | / | / |

兑换方式:

成功提交后添加微信群,进群验证github用户名;每个季度结算并公开排名,用户可在社群提示的兑换时间,联系工作人员进行奖励兑换。


## 📞 联系我们

如果你在使用过程中有任何问题或建议,欢迎通过 [xray 仓库](https://github.com/chaitin/xray/issues) 页面进行反馈。
如果你在使用过程中有任何问题或建议,欢迎通过 [xray 仓库](https://github.com/chaitin/xray/issues) 页面进行反馈,或通过[帮助页面](https://docs.xray.cool/help/index)添加微信公众号,加入 xray 社区交流群

感谢你的参与和支持!我们期待与你共同打造一个强大且实用的插件库。

Expand Down
93 changes: 73 additions & 20 deletions README_EN.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
# 🎉 Welcome to the xray-plugins! 🎉
## 🎉 Welcome to the Plugin Repository! 🎉

We have created a dedicated repository for various plugins to facilitate sharing and using different plugins. We will periodically push new plugins here, and we warmly welcome contributors to submit their plugins to enrich this repository together.
We have created a dedicated repository for various plugins, aiming to facilitate the sharing and use of different plugins.

[中文版本](./README.md)
This repository primarily includes open-source scripts converted to the xray format for everyone to use.

## 📂 Plugin File Formats
We will periodically push new plugins here, and we encourage everyone to actively optimize or submit plugins to enrich this repository together.

The plugins in this repository include fingerprints, POCs, and some specific runtime file lists. It is recommended to use the following tools to run these plugins:
[中文版 README](./README.md)

## 📂 Plugin File Format

The plugins in this repository include fingerprints, POCs, and some specific run file lists. We recommend using the following tools to run these plugins:

- Fingerprints: Recommended to run with xapp
- POCs: Recommended to run with xpoc
- Group List: Contains curated lists of specific run files, recommended to run with xapp or xpoc -g.

## ⚠️ Usage Notice

Please note that the plugins in this repository have only been verified with xlint and have not been tested on actual targets. Therefore, the content of these plugins may not be fully usable. We recommend verifying their effectiveness before use.
Please note that the plugins in this repository have only passed xlint validation and have not been tested on actual targets. Therefore, the content of these plugins may not be fully usable. We recommend verifying their effectiveness before use.

## ✔️ Plugin Quality

To ensure the quality and consistency of the plugins, we will promptly release the latest xlint in the [release](https://github.com/chaitin/xray-plugins/releases) section of this project, specifically for linting plugins. The only requirement for plugins stored in this repository is to pass the xlint check.
To ensure the quality and consistency of the plugins, we will promptly release the latest XLint in the [release](https://github.com/chaitin/xray-plugins/releases) section of this project for linting plugins. The only requirement for plugins stored in this repository is to pass the lint check in the CI.

### Usage Guide

Expand All @@ -27,37 +32,85 @@ xlint -f "./finger/*"
xlint -f "./finger/*" -f "./poc/*"
```

## 📜 Inclusion Criteria

The content included in this repository includes:

1. Plugin Optimization: Optimize existing plugins or merge plugins from different sources that detect the same product or vulnerability.
2. Group List: Submit useful personal Group Lists.
3. New Plugins.

For more guidelines on plugin fixes, please refer to [Plugin Fix Guide](https://docs.xray.cool/plugins/yaml/Fix).

## 🎁 Contribution Rewards
### Repository Structure

We greatly appreciate the efforts of every plugin contributor! To express our gratitude, we will occasionally send some peripheral gifts to plugin contributors. If you are interested in contributing plugins, please feel free to submit a PR or contact the project maintainers.
- `finger/`: Stores fingerprints, divided into `web` and `service` folders.
- `manual/`: Stores manually written fingerprints.
- `web/`: Stores web fingerprints.
- `service/`: Stores service fingerprints.
- `xxx/`: Stores fingerprints from xxx source.
- ...
- `poc/`: Stores POCs, categorized by different sources.
- `manual/`: Stores manually written POCs.
- `xxx/`: Stores POCs from xxx source.
- ...
- `group/`: Stores curated run file lists.

## 📜 Repository Structure
> Note: When submitting fingerprints or POCs, the specific source should be clearly stated. If it is self-written, it can be stored in the manual folder. If it is a fingerprint, ensure it contains CPE information.
>
> If a plugin has been optimized and merged, it should be removed from the original source folder and merged into the `finger|poc/manual/web|service` folder, indicating that the plugin has been manually verified.
- `finger/`: Stores fingerprints.
- `poc/`: Stores POCs.
- `group/`: Stores some specific runtime file lists.
Before submission, please ensure there are no duplicate plugins for the same product or vulnerability in the repository.

## 🛠️ How to Contribute

1. **Fork** this repository.
2. **Clone** it locally for modification.
3. **Commit** your changes and push them to your Fork repository.
4. Submit a **Pull Request**, and we will review and merge your contribution as soon as possible.
2. **Clone** it locally to make modifications.
3. **Commit** your changes and push them to your Forked repository.
4. Submit a **Pull Request**. We will review and merge your contributions as soon as possible.

### Contribution Rewards

> **If you wish to receive rewards for submitting or optimizing fingerprints, please ensure that the fingerprints you submit or optimize include CPE information.**
#### Points Distribution:

| Category | Points | Description |
| --- | --- | --- |
| GroupList Submission | 20-500/each | Points awarded based on the timeliness, completeness, usability, and overall value of the GroupList, ranging from 20 to 500 points. |
| New Plugin Submission | 20/each | Submit new plugins that meet the inclusion criteria and include accurate CPE information for 20 points. |
| Plugin Optimization | 5/each | Optimize existing plugins or merge plugins from different sources that detect the same product or vulnerability for 5 points. |

#### Reward Redemption:

The reward redemption window opens once per quarter.

All users with over 500 points in the current quarter can enter the ranking, with different rewards for each rank as follows:

| Rank | Honor Certificate | xray Pro Version | Merchandise | Surprise Prize | |
| --- | --- | --- | --- | --- | --- |
| Top1 | Physical Honor Certificate | xray Pro Version (90 days) | xray Community Custom Merchandise (choose 3 out of 5) | 100 RMB JD Card | Rewards updated periodically |
| Top2-5 | Electronic Honor Certificate | xray Pro Version (60 days) | xray Community Custom Merchandise (choose 2 out of 5) | 50 RMB JD Card |
| Top6-10 | Electronic Honor Certificate | xray Pro Version (30 days) | xray Community Custom Merchandise (choose 1 out of 5) | / |
| Top11-20 | Electronic Honor Certificate | xray Pro Version (15 days) | Specified xray Community Custom Merchandise | / |
| Top21- | Electronic Honor Certificate | xray Pro Version (7 days) | / | / |

Redemption Method:

After successfully submitting, join the WeChat group and verify your GitHub username in the group; points are settled and rankings are made public each quarter. Users can contact staff for reward redemption during the specified redemption time announced in the community.

## 📞 Contact Us

If you have any questions or suggestions during use, please feel free to provide feedback through the [xray repository](https://github.com/chaitin/xray/issues) page.
If you have any questions or suggestions during use, feel free to provide feedback via the [xray repository](https://github.com/chaitin/xray/issues) page, or join the xray community discussion group through the [Help Page](https://docs.xray.cool/help/index) by adding the official WeChat account.

Thank you for your participation and support! We look forward to working with you to build a powerful and practical plugin library.
Thank you for your participation and support! We look forward to working with you to create a powerful and practical plugin library.

---

## 📢 Disclaimer

All content in this repository is for learning and research purposes only. Please do not use it for illegal purposes. We are not responsible for any direct or indirect damages caused by using these plugins.
All content in this repository is for learning and research purposes only. Do not use it for illegal purposes. We are not responsible for any direct or indirect damage caused by the use of these plugins.

## 📄 License
## 📄 Open Source License

This project is released under the [GPL License 3.0](./LICENSE). You are free to use, modify, and distribute this project, but please retain the original author information.
30 changes: 0 additions & 30 deletions finger/Apache-Struts.yml

This file was deleted.

Loading

0 comments on commit 210ac0d

Please sign in to comment.