DeployedScriptAuthenticatorFactory.java
/*
* Copyright 2019 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.authentication.authenticators.browser;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.keycloak.Config;
import org.keycloak.authentication.AuthenticationFlowContext;
import org.keycloak.authentication.Authenticator;
import org.keycloak.common.Profile;
import org.keycloak.deployment.DeployedConfigurationsManager;
import org.keycloak.models.AuthenticatorConfigModel;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.models.utils.KeycloakModelUtils;
import org.keycloak.models.utils.PostMigrationEvent;
import org.keycloak.provider.ProviderConfigProperty;
import org.keycloak.provider.ProviderEvent;
import org.keycloak.representations.provider.ScriptProviderMetadata;
/**
* @author <a href="mailto:psilva@redhat.com">Pedro Igor</a>
*/
public final class DeployedScriptAuthenticatorFactory extends ScriptBasedAuthenticatorFactory {
private ScriptProviderMetadata metadata;
private AuthenticatorConfigModel model;
private List<ProviderConfigProperty> configProperties;
private Authenticator authenticator = new ScriptBasedAuthenticator() {
@Override
protected AuthenticatorConfigModel getAuthenticatorConfig(AuthenticationFlowContext context) {
return model;
}
};
public DeployedScriptAuthenticatorFactory(ScriptProviderMetadata metadata) {
this.metadata = metadata;
}
public DeployedScriptAuthenticatorFactory() {
// for reflection
}
@Override
public Authenticator create(KeycloakSession session) {
return authenticator;
}
@Override
public String getId() {
return metadata.getId();
}
@Override
public boolean isUserSetupAllowed() {
return false;
}
@Override
public String getDisplayType() {
return model.getAlias();
}
@Override
public String getHelpText() {
return model.getAlias();
}
@Override
public boolean isSupported() {
return Profile.isFeatureEnabled(Profile.Feature.SCRIPTS);
}
@Override
public void init(Config.Scope config) {
model = createModel(metadata);
configProperties = super.getConfigProperties();
}
@Override
public void postInit(KeycloakSessionFactory factory) {
KeycloakModelUtils.runJobInTransaction(factory, session -> {
new DeployedConfigurationsManager(session).registerDeployedAuthenticatorConfig(model);
});
}
@Override
public List<ProviderConfigProperty> getConfigProperties() {
return configProperties;
}
@Override
public AuthenticatorConfigModel getConfig() {
return model;
}
public void setMetadata(ScriptProviderMetadata metadata) {
this.metadata = metadata;
}
public ScriptProviderMetadata getMetadata() {
return metadata;
}
private AuthenticatorConfigModel createModel(ScriptProviderMetadata metadata) {
AuthenticatorConfigModel model = new AuthenticatorConfigModel();
model.setId(metadata.getId());
model.setAlias(sanitizeString(metadata.getName()));
Map<String, String> config = new HashMap<>();
model.setConfig(config);
config.put("scriptName", metadata.getName());
config.put("scriptCode", metadata.getCode());
config.put("scriptDescription", metadata.getDescription());
return model;
}
private String sanitizeString(String value) {
return value.replace('/', '-').replace('.', '-');
}
}