keycloak~scope客户端模板的利用

scope为何物？

scope在oauth2中表示授权的范围，另外也可以理解为，根据认证时scope的参数，在构建jwt时，返回更多的信息；比如在keycloak中，你的可选scope(optional scope)中添加了address这个模板，当你通过/auth/realms/{realmId}/protocol/openid-connect/token举行认证时，你的参数scope中出现address，那么在生成的jwt token中，就会出现address这个内容，如图：

这种按需求构建jwt的方法就是client scope最大的作用，下面我们具体来说一下步调。
客户端模板功能汇总

• 在客户端模板中，可以看到所有的模板列表
  
• 可直接为所有新加的客户端添加默认模板（Default Client Scopes）
  
• 可以在模板配置中，选择可选模板，这个功能与认证参数scope配合利用，根据scope参数来扩展jwt token的内容
  
• 通过继承AbstractOIDCProtocolMapper来扩展客户端模板
  

配置客户端模板

模板列表，如图：

默认客户端模板和可选客户端模板

• 默认客户端模板（Default Client Scopes ）
  
• 可选客户端模板（Optional Client Scopes ）
  
• 以上两种模板互斥，即，当一个模板select-user被选择为“默认客户端模板”后，它将会在“可选客户端模板”列表中消散，反之，亦然。
  

可选客户端模板，可以添加address,openid来对原有jwt举行扩展，如图：

认证请求时，添加scope参数，如openid,address等

• openid：在jwt中添加id_token相关信息，即存放用户的基本信息的token。
  
• address:在jwt中添加address属性，通过剖析user_attribute中的street,locality,region等信息，来扩展jwt token。
  

自定义客户端模板

例如，盼望写一个扩展，在token中输出用户昵称，但这个昵称是有业务逻辑的，通过复杂的逻辑计算出一个用户昵称，这时，需要你自定义一个模板

• 定义一个ExtensionNicknameMapper
  

1. public class ExtensionNicknameMapper
2.     extends AbstractOIDCProtocolMapper
3.     implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper {
5.   public static final String CONFIG_NAME = "extensionNickname";//配置里的名称
6.   public static final String PROVIDER_ID = "oidc-extension-nick-name-mapper";
7.   private static final List<ProviderConfigProperty> configProperties = new ArrayList<ProviderConfigProperty>();
8.   private static final String NICKNAME = "nickname";
10.   static {
11.     configProperties.add(createConfigProperty(CONFIG_NAME, "Token申请名", "在jwt中的属性名称，默认nickname"));
12.     OIDCAttributeMapperHelper.addIncludeInTokensConfig(configProperties, ExtensionNicknameMapper.class);
13.   }
15.   protected static ProviderConfigProperty createConfigProperty(String claimName, String label, String help) {
16.     ProviderConfigProperty property = new ProviderConfigProperty();
17.     property.setName(claimName);
18.     property.setLabel(label);
19.     property.setHelpText(help);
20.     property.setType(ProviderConfigProperty.STRING_TYPE);
21.     return property;
22.   }
24.   @Override
25.   protected void setClaim(IDToken token, ProtocolMapperModel mappingModel, UserSessionModel userSession,
26.                           KeycloakSession keycloakSession, ClientSessionContext clientSessionCtx) {
27.   
28.       String nickname="";
29.        // 复杂的业务方法，计算出nickname变量的值
30.       token.setOtherClaims(tokenAttribute, nickname);
31.   }
33.   public List<ProviderConfigProperty> getConfigProperties() {
34.     return configProperties;
35.   }
37.   @Override
38.   public String getId() {
39.     return PROVIDER_ID;
40.   }
42.   @Override
43.   public String getDisplayType() {
44.     return "Extension Nickname";
45.   }
47.   @Override
48.   public String getDisplayCategory() {
49.     return TOKEN_MAPPER_CATEGORY;
50.   }
52.   @Override
53.   public String getHelpText() {
54.     return "Maps Extension Nickname claim.";
55.   }
57. }

复制代码

• 将ExtensionNicknameMapper添加到Jboss的SPI中
  

• /resources/META-INF/services/org.keycloak.protocol.ProtocolMapper文件
  

1. your.package.ExtensionNicknameMapper

复制代码

• 在keycloak管理背景，添加一个新的模板，然后在模板里的mapper选项卡中，添加一个新的mapper中选你的ExtensionNicknameMapper
  
  
  
  

好了，到这里，keycloak的client scope（客户端模板）就介绍完了，盼望对各位有所资助。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。