WSO2 APIM 4.0.0自定义JWT生成失效求助

问题背景 #

基于WSO2 APIM 4.0.0官方文档实现自定义JWT Claims，已完成以下操作但自定义字段（如name、lastname）未出现在JWT中：

• 创建CustomGatewayJWTGenerator、CustomJWTGenerator自定义Java类
• 生成jar包并放置在WSO2_HOME/repository/components/lib目录
• 配置deployment.toml及api-manager.xml后重启服务器
• 已尝试官方示例库中的代码示例，问题依旧

一、配置文件验证 #

1. deployment.toml 核心配置检查 #

确保已正确指定自定义JWT生成器的全类名，且开启JWT传递：

[apim.gateway.jwt]
enable = true
generator_impl = "com.your.package.CustomGatewayJWTGenerator"
enable_outbound_auth_header = true

注：4.0.0版本优先读取deployment.toml配置，需避免与api-manager.xml配置冲突

2. api-manager.xml 冗余配置确认 #

检查<APIKeyValidator>节点下的配置，确保无冲突设置：

<APIKeyValidator>
    <JWTGeneratorImpl>com.your.package.CustomJWTGenerator</JWTGeneratorImpl>
    <EnableTokenGeneration>true</EnableTokenGeneration>
</APIKeyValidator>

二、代码与部署正确性检查 #

1. 自定义类实现验证 #

• 确保CustomGatewayJWTGenerator继承自AbstractGatewayJWTGenerator，并重写populateCustomClaims方法添加自定义字段：

@Override
public Map<String, Object> populateCustomClaims(TokenValidationContext validationContext, Map<String, Object> claims) {
    // 从用户属性中获取真实值，示例仅作演示
    User user = validationContext.getEndUser();
    claims.put("name", user.getClaimValue("http://wso2.org/claims/givenname"));
    claims.put("lastname", user.getClaimValue("http://wso2.org/claims/lastname"));
    return claims;
}

• 检查代码是否存在空指针异常，避免因用户属性缺失导致JWT生成失败

2. Jar包部署验证 #

• 确认jar包放置在WSO2_HOME/repository/components/lib（而非dropins目录，4.0.0版本lib目录优先级更高）
• 重启服务器后，查看wso2carbon.log，确认无ClassNotFoundException或类加载失败日志
• 若存在依赖冲突，检查repository/components/plugins目录是否有重复的第三方jar

三、API与订阅配置检查 #

1. API级别JWT开关 #

发布API时，在Runtime Configurations > Endpoint Security中确认已开启Enable JWT选项

2. 令牌与用户属性验证 #

• 使用订阅密钥调用API，检查请求头是否包含X-JWT-Assertion字段
• 通过https://<APIM_HOST>:9443/oauth2/userinfo端点验证用户令牌是否包含name、lastname等属性

四、调试与日志排查 #

1. 启用JWT生成调试日志 #

在deployment.toml中添加日志配置：

[logger.jwt-generator]
level = "DEBUG"
appenderRefs = ["CONSOLE", "CARBON_LOGFILE"]

[loggers]
loggers = ["jwt-generator"]

重启后查看wso2carbon.log，确认自定义字段是否被添加到JWT Claims中

2. JWT解码验证 #

复制X-JWT-Assertion中的JWT字符串，使用JWT解码工具查看Claims结构，确认自定义字段是否存在

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