Filed

插件

· 作者 OshDubh

通过 HTTP 访问服务器文件。需进行身份验证。可通过 API 读取、写入和删除文件。

0 本站下载 0 关注 更新于 9 个月前

最新 0.1.0 · 1.21.11 · Paper / Purpur

一键开服(送7天)

Filed

Filed 是一个 PaperMC 插件,通过 REST API 暴露服务器文件,支持令牌认证和路径白名单。

通过由您的服务器托管的 API 端点读取、创建、删除和修改明确允许的服务器文件。访问受到限制,需要包含您生成的 API 密钥才能发起所有请求。

安装

  1. 将 JAR 文件放入服务器的 plugins/ 目录中
  2. 重启服务器。
  3. 配置 plugins/Filed/config.yml。

配置

示例配置:

port: 9847
maximum_allowed_file_size: 1000000
auth_token_file: "tokens.json"

allowed:
  files:
    - "server.properties"
  directories:
    - "world/stats"
选项 描述
port API 的 HTTP 端口
maximum_allowed_file_size 最大文件大小(字节)
auth_token_file 存储哈希令牌的位置
allowed.files 可访问的确切文件路径
allowed.directories 可访问的目录(及其内容)

路径相对于服务器根目录(即 server.properties 所在的同一目录)。

认证

在游戏中或通过控制台生成令牌:

/filed generate <name>

需要 op 权限。令牌仅显示一次,之后无法检索。

在请求中包含 Bearer <token> 作为 Authorization 头来使用令牌。

API

读取

GET /files?path=<path>&content=<true|false>

文件的示例响应:

{
  "type": "file",
  "path": "server.properties",
  "content": "..."
}

目录的示例响应:[不包含目录及其子目录中的文件]

{
  "type": "directory",
  "path": "world/stats",
  "files": [
    {"type": "file", "path": "player.json", "content": "..."}
  ]
}

设置 content=false 可省略文件内容。

写入

PUT /files?path=<path>
Content-Type: text/plain

<file content>

创建或覆盖文件。父目录必须存在。返回修改后文件的内容。仅允许写入文件。

删除

DELETE /files?path=<path>

在响应中返回已删除文件的内容。仅允许删除文件,不允许删除目录。

健康检查

GET /health

此端点无需授权即可访问,可用于确认 API 端点是否正在运行。如果一切正常,将返回 {"message": "ok"}。

错误

失败的示例响应:

{
  "error": "forbidden",
  "message": "path not allowed by existing configuration rules"
}

所有错误代码及其含义的完整列表:

错误 代码 含义
unauthorized 401 缺少或无效的令牌
forbidden 403 路径不在白名单中或存在符号链接逃逸
not_found 404 文件不存在
invalid_path 400 提供的路径无效
is_directory 400 无法写入/删除目录
parent_not_found 400 父目录不存在(适用于写入操作)
too_large 413 文件大小超出限制

安全性

  • 在执行任何操作之前,路径会被标准化并根据白名单进行检查,以阻止任何 .. 遍历。
  • 解析后超出服务器根目录的符号链接将被拒绝。
  • 令牌在存储前会进行 SHA-256 哈希处理,并仅用于验证访问权限。
  • 可配置的文件大小限制可防止内存耗尽。
  • 不允许子目录遍历。如果请求了一个目录,则仅返回该目录中包含的文件。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源