/* * Copyright 2016 Red Hat, Inc. and/or its affiliates * and other contributors as indicated by the @author tags. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.keycloak.services.clientregistration.policy.impl; import java.util.LinkedList; import java.util.List; import java.util.stream.Collectors; import org.keycloak.component.ComponentModel; import org.keycloak.models.KeycloakSession; import org.keycloak.models.KeycloakSessionFactory; import org.keycloak.protocol.ProtocolMapper; import org.keycloak.provider.ProviderConfigProperty; import org.keycloak.provider.ProviderFactory; import org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory; import org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy; /** * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a> */ public class ProtocolMappersClientRegistrationPolicyFactory extends AbstractClientRegistrationPolicyFactory { private List<ProviderConfigProperty> configProperties = new LinkedList<>(); public static final String PROVIDER_ID = "allowed-protocol-mappers"; public static final String ALLOWED_PROTOCOL_MAPPER_TYPES = "allowed-protocol-mapper-types"; public static final String CONSENT_REQUIRED_FOR_ALL_MAPPERS = "consent-required-for-all-mappers"; @Override public ClientRegistrationPolicy create(KeycloakSession session, ComponentModel model) { return new ProtocolMappersClientRegistrationPolicy(session, model); } @Override public void postInit(KeycloakSessionFactory factory) { super.postInit(factory); ProviderConfigProperty property; property = new ProviderConfigProperty(); property.setName(ALLOWED_PROTOCOL_MAPPER_TYPES); property.setLabel("allowed-protocol-mappers.label"); property.setHelpText("allowed-protocol-mappers.tooltip"); property.setType(ProviderConfigProperty.MULTIVALUED_LIST_TYPE); property.setOptions(getProtocolMapperFactoryIds()); configProperties.add(property); property = new ProviderConfigProperty(); property.setName(CONSENT_REQUIRED_FOR_ALL_MAPPERS); property.setLabel("consent-required-for-all-mappers.label"); property.setHelpText("consent-required-for-all-mappers.tooltip"); property.setType(ProviderConfigProperty.BOOLEAN_TYPE); property.setDefaultValue("true"); configProperties.add(property); } private List<String> getProtocolMapperFactoryIds() { List<ProviderFactory> protocolMapperFactories = sessionFactory.getProviderFactories(ProtocolMapper.class); return protocolMapperFactories.stream().map((ProviderFactory factory) -> { return factory.getId(); }).collect(Collectors.toList()); } @Override public String getHelpText() { return "When present, it allows to specify whitelist of protocol mapper types, which will be allowed in representation of registered (or updated) client"; } @Override public List<ProviderConfigProperty> getConfigProperties() { return configProperties; } @Override public String getId() { return PROVIDER_ID; } }