如何修改Kong认证插件返回的Realm名称？

Kong的key-auth、basic-auth等认证插件默认返回的WWW-Authenticate头里，realm参数值为kong，官方文档确实没有提供直接修改该值的配置项，但可以通过以下两种方式实现自定义：

方法一：使用response-transformer插件修改响应头 #

利用Kong自带的response-transformer插件，直接替换响应头内容：

1. 为目标服务或路由启用response-transformer插件

2. 配置插件的replace规则，针对WWW-Authenticate头设置自定义值：

   • 若为basic-auth插件，设置替换值为Basic realm="你的自定义内容"
   • 若为key-auth插件，设置替换值为Key realm="你的自定义内容"

   示例配置（通过Kong Admin API）：

   curl -X POST http://kong-admin:8001/services/{service-name}/plugins \
     -d name=response-transformer \
     -d config.replace.headers[WWW-Authenticate]="Basic realm=\"MyAPI\""
   

方法二：编写自定义Lua插件统一处理 #

如果需要对所有认证插件统一修改realm值，自定义Lua插件更灵活：

1. 创建一个简单的Lua插件文件（比如custom-realm.lua）：

   local plugin = {
     PRIORITY = 900, -- 优先级低于认证插件，确保在认证逻辑后执行
     VERSION = "0.1",
   }
   
   function plugin:header_filter(conf)
     local auth_header = kong.response.get_header("WWW-Authenticate")
     if auth_header then
       -- 替换所有realm="kong"的内容为自定义值
       local modified_header = auth_header:gsub('realm="kong"', 'realm="' .. conf.custom_realm .. '"')
       kong.response.set_header("WWW-Authenticate", modified_header)
     end
   end
   
   return plugin
   

2. 将插件文件放到Kong的插件目录（通常为/usr/local/share/lua/5.1/kong/plugins/custom-realm/）
3. 在kong.conf中添加plugins=bundled,custom-realm启用插件
4. 为服务或路由配置该插件，设置custom_realm参数：

   curl -X POST http://kong-admin:8001/services/{service-name}/plugins \
     -d name=custom-realm \
     -d config.custom_realm="MyAPI"
   

注意：两种方式都需要确保配置的规则匹配对应认证插件的WWW-Authenticate头格式，避免替换失效。

内容的提问来源于stack exchange，提问作者user2311578