phantom_token_realm
`phantom_token_realm` 指令定义了在 NGINX 中使用 phantom 令牌时 WWW-Authenticate 头的认证域。
Phantom Token NGINX Module
·
location
语法phantom_token_realm "realm_name";
默认值none
上下文location
参数1
说明
phantom_token_realm 指令是 Phantom Token NGINX Module 的一部分，它通过在 Web 请求中管理访问令牌来增强 API 安全性。通过配置 phantom_token_realm，管理员可以指定将包含在 WWW-Authenticate 头中的认证域，这符合 RFC 6750 中规定的 OAuth 2.0 Bearer Token 规范。
在实际应用中，当设置此指令时，它会配置一个指定的 realm，用于告知客户端所需的认证范围。如果请求因缺乏有效授权而失败，NGINX 服务器会返回 401 Unauthorized 状态，并在响应的 WWW-Authenticate 头中嵌入所定义的 realm。这会告诉客户端需要使用哪个认证域，从而促使客户端在重新尝试请求之前获取相应的令牌。
该指令应与模块内的其他配置结合使用，以确保对访问令牌进行正确的处理和检查。其行为比较简单，主要作为安全上下文的描述标签，但必须与客户端应用程序预期的值正确对齐，才能实现最佳功能。
配置示例
location /api {
phantom_token_realm "mySecureRealm";
phantom_token_enable on;
phantom_token_introspection_endpoint "https://introspection.example.com/";
}⚠
确保 realm 名称不包含可能导致语法无效的特殊字符。
⚠
phantom_token_realm 指令必须在 location 上下文中正确设置；否则可能不会按预期生效。
⚠
注意不能指定多个 realm；请确保设置的 realm 能准确反映您的安全上下文。