HTTP Basic / IP 认证插件技术文档

本文档旨在帮助用户安装、配置和使用ElasticSearch的HTTP Basic / IP认证插件。以下是详细的安装指南、使用说明和API使用文档。

1. 安装指南

下载与安装

从 GitHub发布页面 下载所需版本的插件，并将其复制到ElasticSearch的plugins/http-basic目录中。

配置

插件安装后，可以在ElasticSearch模块配置文件中对其进行配置。请查看 ElasticSearch配置指南 以及 ElasticSearch目录布局信息 获取更多关于ES安装默认路径的信息。

2. 项目使用说明

本项目为ElasticSearch提供了HTTP基本认证和IP认证的扩展功能。

• HTTP基本认证：基于HTTP协议的基本访问认证机制。
• IP认证：根据客户端IP地址进行认证。

请求/路径时不进行认证，以简化健康检查配置。

请注意，此插件不支持按索引进行配置。

3. 项目API使用文档

配置项

以下是可配置的设置项及其默认值和说明：

设置项	默认值	说明
http.basic.enabled	true	启用或禁用HTTP基本认证
http.basic.user	"admin"	认证用户名
http.basic.password	"admin_pw"	认证密码
http.basic.ipwhitelist	["localhost", "127.0.0.1"]	IP白名单，默认包含本地地址
http.basic.trusted_proxy_chains	[]	可信代理链
http.basic.log	false	是否启用插件日志
http.basic.xforward	""	用于认证的X-Forwarded-For头部

认证流程

• HTTP基本认证：请参考 基本访问认证 文档。
• IP认证：如果请求被认为是可信的，并且其IP地址在白名单中，则认为客户端已通过认证。

配置示例

以下是一个配置示例：

http.basic.log: true
http.basic.user: "some_user"
http.basic.password: "some_password"
http.basic.ipwhitelist: ["3.3.3.3"]
http.basic.xforward: "X-Forwarded-For"
http.basic.trusted_proxy_chains: ["1.1.1.1,2.2.2.2"]

4. 项目安装方式

请参考上述“安装指南”部分，下载所需版本的插件并复制到ElasticSearch的plugins/http-basic目录中。

---

以上文档为ElasticSearch HTTP Basic / IP认证插件的使用提供了详细的指南和说明，希望能帮助您更好地使用和理解这一项目。