rhertogh/yii2-security.txt

一个用于服务 .well-known/security.txt 的 Yii2 扩展

安装: 240

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:yii2-extension

1.0.0-alpha2 2024-08-19 19:02 UTC

This package is auto-updated.

Last update: 2024-09-19 19:07:33 UTC


README

Latest Stable Version build Status Code Coverage Scrutinizer Code Quality GitHub

一个用于服务 .well-known/security.txt 的 Yii2 扩展
RFC 9116: 帮助安全漏洞披露的文件格式。
您可以在以下位置查看生成的示例 这里

📑 内容

🐣 入门

要求

  • 最低要求的 PHP 版本是 8.1(兼容性测试直到包括 PHP 8.3)。
  • 最低要求的 Yii 版本是 2.0.49。

安装

安装此扩展的首选方式是通过 composer

composer require rhertogh/yii2-security.txt

完整的安装和配置细节可以在 docs 中的 安装 Yii2 security.txt 下找到。

🏎️ 测试驾驶

您可以使用 Docker 运行本地预览实例。

docker run --rm -p 82:80 --name Yii2SecurityTxt ghcr.io/rhertogh/yii2-securitytxt:master

容器启动后,您可以在 localhost:82 访问示例服务器。

提示:主机上的端口号由 -p 参数的第一部分指定。如果需要,可以更改它(例如,-p 88:80)。

要访问 Docker 容器的 CLI,您可以运行

docker container exec -it Yii2SecurityTxt bash

📖 文档

文档中有两个主要部分

🔮 常见问题解答

常见问题解答可以在以下位置找到 这里

📜 版本控制 & 变更日志

Yii2 security.txt 项目遵循 语义版本控制 2.0
请参阅 变更日志 了解版本历史和升级到新版本的 升级说明

🔎 报告安全问题

如果您发现了安全问题,请直接 联系我们。请不要使用问题跟踪器或在公共场合讨论它,因为这会带来更多的损害而不是帮助。

请注意,作为一个非商业开源项目,我们无法支付赏金。

📂 目录结构

docker/     Docker container definition
docs/       Documentation (for both usage and development)
sample/     Sample app for the server
src/        Yii2SecurityTxt source
tests/      Codeception unit and functional tests

🚀 贡献

Yii2SecurityTxt 扩展是 开源的。您可以通过以下方式帮助:

感谢您的贡献!

🎉 鸣谢

✒️ 许可证

Yii2SecurityTxt 扩展是免费软件。它根据 Apache 许可协议发布。请参阅LICENSE.md获取更多信息。