CraftLDAP

模组

· 作者 Guzio

基于 LDAP 的 Minecraft 白名单模组

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

最新 0.1.0+26.1.1 · 26.1.1 · Fabric

一键开服(送7天)

CraftLDAP

基于 LDAP 的 Minecraft 白名单模组

Craft-什么?

LDAP 是一种跨平台的用户索引系统。它允许使用一套登录名和密码在多个服务中通用,并使您的各种个人数据(如姓名、显示用户名、联系方式(电子邮件和/或电话)、头像等)在这些服务之间共享。

LDAP 的主要用户包括:

  • 自托管极客(即那些会运行自己的 NextCloud、联邦网络服务(Matrix、Mastodon、电子邮件等)、网站、Git 托管等的人),他们希望将自己运行的所有服务更好地整合在一起。
  • 组织机构(如公司、学校、非政府组织、政府机构等),这些机构通常运行多个内部应用程序(例如库存跟踪程序、电子成绩册或投票系统),并与一些外部服务集成(如 Microsoft Teams)。对于这些机构而言,这种形式的集成可以节省数千美元的行政成本(与其每次有人入职或离职时更新多个用户数据库,不如只需更改一个地方)。

因此,本模组旨在服务于:

  • 痴迷于集成与自动化的人(比如 我自己),他们已经运行了自己的自托管技术栈,包括 LDAP,并且绝对 不能忍受 自己精心打造的相互交织的服务集群中,唯独 Minecraft 服务器完全独立存在的情况。
  • 运营自有 Minecraft 服务器的中学/大学等教育机构。这一趋势在新冠疫情期间流行开来(甚至连本模组的作者所在的学校也参与其中,她实际上是该模组背后开发团队的一员——尽管该校使用的是通过微软服务的 OAuth 进行集中登录而非 LDAP,因此其 Minecraft 登录系统围绕一个与该 OAuth 集成的 Discord 机器人构建,这也是为什么本模组直到今天才问世的原因)。据某些 YouTube 视频所示,这一趋势以 微小的规模 似乎仍在持续。如果您是仍坚持这一做法的教育机构(或其他任何机构),并且恰好使用 LDAP 作为学生注册表——请随意使用!(另外,你们可能资金紧张,所以……也许可以考虑赞助?UwU :3)

相反,本模组 不 适用于以下人群:

  • 只需要一种快速简单的方式来同步服务器白名单的人。请查看 WhiteList Sync 2 —— 与运行整个 LDAP 服务器相比,它所需的开销、配置和维护要少得多。
  • 没有 LDAP 服务器并希望借此模组学习如何搭建 LDAP 的人。本模组将是一个极其糟糕的 LDAP 入门教程,因为文档忽略了一些关于整体工作原理的重要部分;它还充斥着大量的技术术语,左一句右一句中间还穿插着对 CurseForge 和 Minecraft 插件的随机吐槽。您最好尝试按照他们的 配置指南 设置像 LLDAP(最简单的 LDAP 服务器)这样的东西,并搭配其官方支持的使用者之一。
  • ……简单来说,如果您必须阅读这个“Craft-什么?”部分才能理解本模组,那么您可能不是它的目标受众。

下载

安装

  • 在执行任何操作之前,请为新的消费者(consumer)准备好你的 LDAP 服务器。 请参阅下面的章节。
  • 配置一个基于 Fabric / Quilt 的 Minecraft 服务器(不支持 Forge/NeoForge(目前还不支持——我可能会稍后在 Architectury 下重写此模组,即当我想自己在 (Neo)Forge 上托管服务器时,或者如果存在某些普遍需求——你可以通过提交 issue 来表明这一点,以支持多加载器),不支持基于插件的方式(暂无计划——出于“意识形态”原因:由于插件加载器通常是争议焦点,一些主要插件加载器的维护者通常表现得有些傲慢(请参考像 Redstoner 那样对 PaperMC 的抱怨(大多数人在职业生涯中至少会发过一次牢骚)了解更多)以及整个“Bukkit 自我毁灭”导致我们陷入分叉地狱的问题;因此,我不太期待支持那个生态系统;与此同时,配合 Lithium、Noisium、ServerCore 和其他几个优化/修复模组,Fabric 在性能方面可以接近甚至超越那些“专业、超快”的服务器后端,但缺少一些优秀的独占插件(例如 WorldGuard),所以我喜欢通过制作模组加载器独占内容来“平衡”这一方程的想法;以及实际原因:我喜欢用 Fabric/Architectury 编程;回到 Bukkit 感觉糟透了)),除非有某些普遍需求——你可以通过提交 issue 来表明这一点),或者是原版 Minecraft(出于显而易见的原因)。不支持客户端,因为没有任何合理的理由让你想在客户端上使用此模组(尽管——概念上——它可以在不修改的情况下在客户端运行;只需更改 JAR 文件中此模组的 fabric.mod.json 内的 side 即可)。该模组针对的是最新的稳定版 Minecraft 版本(在撰写本文时为 1.21.11),但是(以防这个项目像许多项目一样在更新上变得懒惰),我们的 dependencies 指定任何更新的服务器版本也应该可以工作(归功于此模组实际上仅依赖 4 个原版的类,这些类在未来不太可能发生变化,至少就我们对它们的使用而言是这样)。如果你发现某个标记为支持的版本无法工作,请提交 issue。如果你想使用较低版本或快照,你可以使用 Fabric 的依赖覆盖,但后果自负!
  • 将此模组的 JAR 和 FabricAPI 的 JAR(如果是现代 MC 版本且已发布 Quilted FabricAPI 的 JAR,则使用该 JAR;如果没有,Quilt 暂时无法与此模组一起使用,请给他们几个月/几年的时间来赶上)放入服务器的 mods 文件夹中。
  • 启动它!

用法

首先,我们应该解释此模组是如何工作的:每当玩家登录时,它会检查是否有任何 LDAP 用户(在匹配用户指定过滤器的那些用户中,可能是类似 minecraft 组)将该玩家的 Minecraft UUID 作为属性附加。如果找到匹配项,玩家将以该 LDAP 用户的身份登录。如果未找到匹配项,则拒绝玩家的登录尝试。

正如你所见,这是一个极其简单的流程。没有 /login 命令或类似的东西。它本质上就像一个基于 LDAP 的白名单。未来,我们还计划从 LDAP 中提取一些额外属性到 Minecraft(如 OP 权限级别等),并添加一些实用命令(用于实时重载配置、在游戏中检查你自己的 LDAP 用户以及其他一些东西——值得注意的是,出于设计原因,永远不会出现 /login 命令或类似命令,详见下文),但这还有待实现。

在 LDAP 中

  1. 你需要在用户模式中创建一个额外的属性,用于存储用户的 Minecraft UUID。 建议将其命名为 mcuuid,以避免更改默认配置。
  2. 你 REALLY SHOULD(但在技术上不需要,下面会详细说明)至少创建一个新的组,用于 Minecraft 玩家。 如果你托管多个服务器,并且不希望一个服务器的用户与另一个服务器的用户混合在一起,你也可以创建多个组。或者——如果你想独立控制某人是否是 Minecraft 玩家以及他们可以加入哪个服务器——你可以创建一个“总体组”和每个服务器的子组(并调整每个服务器的过滤器(详见下文)以查找两者中的存在)。总体而言,你的分组方式没有限制。只需知道应该有一种明确区分玩家和非玩家的方法(详见下文)。
  3. 为用户提供指定其 Minecraft UUID 的途径。 如果你运行像 LLDAP 这样的服务器,其中有一个 Web UI,任何用户都可以编辑他们的属性,这很简单。只需将你的 mcuuid 属性标记为用户可编辑,并发布一些关于如何将昵称转换为 UUID 的指南(如 NameMC 链接),然后一切就绪。如果你的 LDAP 系统没有提供用户友好的自我编辑方式,那就只能靠自己了。最有可能的是,你已经运行了一些用于 LDAP 管理的额外工具(至少用于头像和密码更改),所以你可能能够扩展它以允许修改一个额外的属性。如果没有(即你明确只允许授权员工更改 LDAP 记录),那么你将需要指示你的员工手动添加用户的 UUID,或者你需要构建一些内部前端来自动化这个过程。该项目提供对 LDAP 的只读访问,这是出于设计考虑(旨在与 LLDAP 兼容,LLDAP 对外部服务是只读的,仅允许通过他们的 WebUI 进行更改),因此不存在——也永远不会存在——像 /login 命令那样从游戏内添加记录的功能。

模组内部配置

首次启动后,会在 [服务器目录]/config/ldap.properties 中生成一个配置文件。其内容应类似于如下所示:

#CraftLDAP 的配置文件。请参阅 Modrinth 页面或 GitHub README 以获取文档。
#[创建日期]
base-dn=ou\=people,dc\=example,dc\=com
bind-dn=cn\=[某个具有读取索引权限的用户],ou\=people,dc\=example,dc\=com
bind-pass=[该用户的密码]
bugreport-url=https\://example.com/
filter=(&(objectclass\=person)(memberOf\=cn\=[某个组],ou\=groups,dc\=example,dc\=com))
host=ldap
ldap-attr-mcuuid=mcuuid
ldap-attr-name=uid
message-error=CraftLDAP 认证过程中出现问题。这**不是你的错**,请将此错误报告给服务器管理员!!!
message-unauthorized=您未被授权在此服务器上游玩。
port=3890

各字段说明如下:

  1. base-dn:我也不知道它具体是做什么的。 上述值(即 ou=people,dc=example,dc=com,其中 example.com 需替换为你自己的域名,例如 guziohub.ovh -> ou=people,dc=guziohub,dc=ovh)直接取自 LLDAP 文档,并且对 Matrix、UnboundID(即 CraftLDAP 内部使用的库)和 Nextcloud 均有效。只需更新域名即可,但请注意任何 = 符号都必须进行转义,如上文所示使用 \=,这样就能正常工作。否则,如果你是足够高级的 LDAP 管理员,了解 Base DN 的工作原理,并出于某种原因在自己的服务器上更改了此行为,那你应该也知道如何在此处进行相应更新。
  2. bind-dn 是你的“服务登录凭据”。如果你有一个名为 admin 且能读取所有其他 LDAP 用户的用户(或者一个名为 minecraftservice 且能读取所有与 Minecraft 相关的用户的账户),而你的域名为 guziohub.ovh 或 someuniversity.gov,那么你应该按以下方式指定:cn=admin,ou=people,dc=guziohub,dc=ovh 或 cn=minecraftservice,ou=people,dc=someuniversity,dc=gov。请记住 = 需要转义,因此实际写入时应为:cn\=admin,ou\=people,dc\=guziohub,dc\=ovh 或 cn\=minecraftservice,ou\=people,dc\=someuniversity,dc\=gov
  3. bind-pass 是上述 bind-dn 中指定用户的密码。然而请注意,直接将明文密码粘贴进去并不被视为最佳的安全实践。强烈建议采用某种形式的密钥管理方案。 实现这一点的一种方法是使用 这个 Docker 镜像 运行你的服务器,并遵循其关于 环境变量替换 的指南。
  4. bugreport-url 是一个有效的 URI(记得像上面那样对 : 进行转义),当客户端因 CraftLDAP 错误导致登录被拒绝时,该 URL 会被传递给客户端。你不应该将其指向 CraftLDAP 本身——请让用户先向你提交问题反馈,因为很可能出现的问题是由你的配置引起的。即使并非如此,这种错误对我们来说毫无意义,因为所有“有价值”的日志都在你的服务器上。因此,即使错误确实由 CraftLDAP 直接引起,也应该首先向你报告,只有当你调试陷入困境或在 CraftLDAP 中发现 bug 时,你才应向我们要开 Issue,并提供比普通用户更多的信息。请注意,尽管客户端期望接收此数据字段,但目前它们并未在 UI 中渲染它。人们可能会预期在断开连接界面看到一个“报告 Bug”按钮之类的功能,但目前似乎并非如此。也许这是为了未来的更新而提前添加的,我也不确定。
  5. filter、ldap-attr-mcuuid 和 ldap-attr-name 将在稍后介绍,因为理解它们之间的关系需要特别小心。
  6. host 和 port 共同构成了你的 LDAP 服务器的 URI。例如,如果可以通过 ldap://example.com:3890 访问——那么 host 将是 example.com,端口将是 3890。port 必须是一个数字,而 host 可以是公共域名(例如 example.com)、本地域名(例如 ldap ——默认值)或 IP 地址。
  7. message-error 是在客户端因 CraftLDAP 错误导致登录被拒绝时发送给客户端的消息。适用与 bugreport-url 相同的“规则”(即让他们向你报告,而不是向我们报告)。
  8. message-unauthorized 是在客户端因登录尝试失败且其 UUID 未在你的 LDAP 服务器上的任何用户中找到关联时发送给客户端的消息。

过滤器详解

你的 LDAP 服务器上可能有很多用户。其中一些可能并不是 Minecraft 玩家——因此,他们显然没有 Minecraft UUID。这对 CraftLDAP 来说非常糟糕,因为它要求通过 ldap-attr-mcuuid(此字段持有你的 Minecraft UUID 属性名称,例如上文所述的 mcuuid)和 ldap-attr-name(此字段持有某个属性的名称,每当有人成功加入服务器时,该属性的值会打印到服务器控制台;默认为 uid,这是 LLDAP 上的登录属性,但你也可以将其设置为你自己 LDAP 服务器的登录值,甚至不使用登录验证,而是依赖显示名称等) 指定的属性在其扫描遍历的所有 LDAP 用户中都存在。解决方案是什么?我们确保它永远不会扫描那些可能不具备这些属性的用户!

输入过滤器:它们将 LDAP 查询的结果限制为用户的一个子集。 最重要的过滤器是 memberOf,它允许你基于组归属进行过滤。这能确保没有属性设置不全的用户漏网:你可以创建一个 Minecraft 玩家组,并仅将那些属性配置正确的用户加入其中。如果你遵循了 LDAP 使用指南的第 2 步,你应该已经有了该组。要使用它,只需将 [some group] 替换为该组的名称(同时更新 example.com 为你的域名,并注意转义 = 符号——相信你现在已经知道如何操作了)。例如:(&(objectclass\=person)(memberOf\=cn\=minecraft,ou\=groups,dc\=guziohub,dc\=ovh))。

过滤器也可以链式连接以实现极大的灵活性。 此处不详细解释其确切语法(因为这更适合一篇专门的文章),只提供一些思路。例如,在多台服务器设置中可以使用多个组——LDAP 设置指南的第 2 步提供了两种相关概念。你还可以创建一个“主”Minecraft 组和一个 Minecraft 管理员组,在主服务器上过滤任一组的成员,而在开发服务器上仅过滤管理员。或者你可以颠倒关系:依赖 LDAP 中现有的管理员组,并在开发服务器的配置中过滤该组+minecraft,但在生产服务器上仅检查 minecraft。甚至,你可以完全忽略过滤器!只需将两个属性标记为始终必需,而无需为“拥有它们的用户”和“不拥有它们的用户”设置组。也可能存在一种检查给定属性是否存在而非使用组的过滤器方法,但这需要进一步测试。总之,潜力无限!LDAP 过滤器功能强大。

许可证

  • 代码和二进制文件根据 MIT 许可证授权。该二进制文件还嵌入了一个 JAR,其中包含UnboundID LDAP 库,根据 Apache2 许可证授权。
  • 是的,这意味着你可以在整合包中使用此模组(如果……你觉得有必要这样做。出于……某些原因。不,但说真的,除非这是一个特定于私人社区的整合包,且该社区恰好拥有 LDAP 服务器——否则你为什么要这么做呢?)。是的,即使在 Modrinth 之外的整合包中也行——尽管(为了符合 MIT 许可证要求),你需要通过“在衍生作品中包含其许可证”来署名此模组。理想情况下,这应该是一个简单的链接,直接指向你的整合包 README 的许可证脚注中的许可证、作者和模组名称(就像这个脚注一样)——而不是深埋在两层 ZIP 文件中(首先是整合包,然后是模组),即使这在技术上仍算作包含。
  • 不要原样上传(或重新编译+上传,除非进行了重大更改(和/或此模组已被弃用而你希望保持其更新),作为完整分支的一部分)此模组到其他主机,特别是 9Minecraft(包括植入病毒不算作“重大更改”)或 CurseForge。不,CurseForge,我不在乎这在 MIT 下技术上是否合法。如果你拒绝下架任何冒充者,那么让我称这段文字为“具有法律约束力”(因为它技术上在上面写着许可证,所以我们能确定它不如 GitHub 上的 LICESNE 文件或 Modrinth 上链接的许可证有效吗?我的意思是……当然不是(这只是一个解释性脚注),但是——你知道——你能真正确定吗?)然后看看你会怎么做……
  • 徽标灵感来源于LDAP 的官方图标(仅限于“4个 R203G32B38 颜色的三角形相互覆盖”这一方面),但除此之外,CraftLDAP 的徽标是其独立完成的作品(无论是构思上(即:由我决定以特定方式将其像素化、使其尖锐,并为 CraftLDAP 添加 C.L. 首字母)还是执行上,即从头绘制完成),因此它(包括 PNG 和 Krita 源文件形式)根据 CC BY-NC-ND 4.0 许可证授权(抱歉过于严格,如果有人愿意修改它,我们非常乐意将其降低至 CC BY-SA 4.0(这类似于图像的 GPL;为此我还包含了 Krita 源文件),只要你承诺不会利用这些权利假装是我们即可。在这种情况下,商业使用将是任何形式的“冒充”(因为——即使它不会带来直接的经济利益——但它可能会以某种方式提升你在某个平台上的地位,从而导致许可证不允许的“商业优势”)。另外——说到冒充——你不能对任何分支或(尤其是)无关项目重用 CraftLDAP 名称(至少添加一些后缀,或其他什么)。

就是这样!

希望你享受这个愚蠢的小项目 :3

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源