org.glassfish.admingui.common.handlers.SecurityHandler Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2009-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2018-2019] [Payara Foundation and/or its affiliates]
package org.glassfish.admingui.common.handlers;
import com.sun.enterprise.universal.xml.MiniXmlParser.JvmOption;
import com.sun.jsftemplating.annotation.Handler;
import com.sun.jsftemplating.annotation.HandlerInput;
import com.sun.jsftemplating.annotation.HandlerOutput;
import com.sun.jsftemplating.layout.descriptors.handler.HandlerContext;
import java.net.URLEncoder;
import java.util.*;
import java.util.logging.Level;
import static org.glassfish.admingui.common.handlers.InstanceHandler.JVM_OPTION;
import static org.glassfish.admingui.common.handlers.InstanceHandler.MAX_VERSION;
import static org.glassfish.admingui.common.handlers.InstanceHandler.MIN_VERSION;
import static org.glassfish.admingui.common.handlers.InstanceHandler.TARGET;
import org.glassfish.admingui.common.util.GuiUtil;
import org.glassfish.admingui.common.util.RestResponse;
import org.glassfish.admingui.common.util.RestUtil;
/**
*
* @author anilam
*/
public class SecurityHandler {
/**
* This handler returns the a Map for storing the attributes for realm creation.
* @param handlerCtx The HandlerContext.
*/
@Handler(id="getRealmAttrForCreate",
output={
@HandlerOutput(name="attrMap", type=Map.class),
@HandlerOutput(name="classnameOption", type=String.class),
@HandlerOutput(name="realmClasses", type=List.class),
@HandlerOutput(name="properties", type=List.class)})
public static void getRealmAttrForCreate(HandlerContext handlerCtx) {
handlerCtx.setOutputValue("realmClasses", realmClassList);
handlerCtx.setOutputValue("classnameOption", "predefine");
Map attrMap = new HashMap();
attrMap.put("fileJaax", "fileRealm");
attrMap.put("ldapJaax", "ldapRealm" );
attrMap.put("solarisJaax", "solarisRealm");
attrMap.put("jdbcJaax", "jdbcRealm");
attrMap.put("predefinedClassname", Boolean.TRUE);
attrMap.put("createNew", true);
handlerCtx.setOutputValue("attrMap", attrMap);
handlerCtx.setOutputValue("properties", new ArrayList());
}
/**
*
This handler returns the a Map for storing the attributes for editing a realm.
* This can be used by either the node agent realm or the realm in configuration-Security-realm
* @param handlerCtx The HandlerContext.
*/
@Handler(id="getRealmAttrForEdit",
input={
@HandlerInput(name="endpoint", type=String.class)},
output={
@HandlerOutput(name="attrMap", type=Map.class),
@HandlerOutput(name="classnameOption", type=String.class),
@HandlerOutput(name="realmClasses", type=List.class),
@HandlerOutput(name="properties", type=List.class)})
public static void getRealmAttrForEdit(HandlerContext handlerCtx) {
String endpoint = (String) handlerCtx.getInputValue("endpoint");
HashMap realmMap = (HashMap) RestUtil.getEntityAttrs(endpoint, "entity");
HashMap responseMap = (HashMap) RestUtil.restRequest(endpoint + "/property.json", null, "GET", null, false);
HashMap propsMap = (HashMap) ((Map) responseMap.get("data")).get("extraProperties");
ArrayList propList = (ArrayList) propsMap.get("properties");
HashMap origProps = new HashMap();
for (HashMap prop : propList) {
origProps.put(prop.get("name"), prop.get("value"));
}
Map attrMap = new HashMap();
attrMap.put("Name", (String) realmMap.get("name"));
attrMap.put("fileJaax", "fileRealm");
attrMap.put("ldapJaax", "ldapRealm" );
attrMap.put("solarisJaax", "solarisRealm");
attrMap.put("jdbcJaax", "jdbcRealm");
String classname = (String) realmMap.get("classname");
if (realmClassList.contains(classname)){
handlerCtx.setOutputValue("classnameOption", "predefine");
attrMap.put("predefinedClassname", Boolean.TRUE);
attrMap.put("classname", classname);
List props = getChildrenMapForTableList(propList, "property", skipRealmPropsList);
handlerCtx.setOutputValue("properties", props);
if(classname.indexOf("FileRealm")!= -1){
attrMap.put("file", origProps.get("file"));
attrMap.put("fileJaax", origProps.get("jaas-context"));
attrMap.put("fileAsGroups", origProps.get("assign-groups"));
}else
if(classname.indexOf("LDAPRealm")!= -1){
attrMap.put("ldapJaax", origProps.get("jaas-context"));
attrMap.put("ldapAsGroups", origProps.get("assign-groups"));
attrMap.put("directory", origProps.get("directory"));
attrMap.put("baseDn", origProps.get("base-dn"));
}else
if(classname.indexOf("SolarisRealm")!= -1){
attrMap.put("solarisJaax", origProps.get("jaas-context"));
attrMap.put("solarisAsGroups", origProps.get("assign-groups"));
}else
if(classname.indexOf("PamRealm")!= -1){
attrMap.put("pamJaax", origProps.get("jaas-context"));
}else
if(classname.indexOf("JDBCRealm")!= -1){
attrMap.put("jdbcJaax", origProps.get("jaas-context"));
attrMap.put("jdbcAsGroups", origProps.get("assign-groups"));
attrMap.put("datasourceJndi", origProps.get("datasource-jndi"));
attrMap.put("userTable", origProps.get("user-table"));
attrMap.put("userNameColumn", origProps.get("user-name-column"));
attrMap.put("passwordColumn", origProps.get("password-column"));
attrMap.put("groupTable", origProps.get("group-table"));
attrMap.put("groupTableUserName", origProps.get("group-table-user-name-column"));
attrMap.put("groupNameColumn", origProps.get("group-name-column"));
attrMap.put("dbUser", origProps.get("db-user"));
attrMap.put("dbPassword", origProps.get("db-password"));
attrMap.put("digestAlgorithm", origProps.get("digest-algorithm"));
attrMap.put("pswdEncAlgorithm", origProps.get("digestrealm-password-enc-algorithm"));
attrMap.put("encoding", origProps.get("encoding"));
attrMap.put("charset", origProps.get("charset"));
}else
if(classname.indexOf("CertificateRealm")!= -1){
attrMap.put("certAsGroups", origProps.get("assign-groups"));
}
}else{
//Custom realm class
handlerCtx.setOutputValue("classnameOption", "input");
attrMap.put("predefinedClassname", Boolean.FALSE);
attrMap.put("classnameInput", classname);
attrMap.put("classname", classname);
List props = getChildrenMapForTableList(propList, "property", null);
handlerCtx.setOutputValue("properties", props);
}
handlerCtx.setOutputValue("attrMap", attrMap);
handlerCtx.setOutputValue("realmClasses", realmClassList);
}
public static List getChildrenMapForTableList(List propList, String childType, List skipList){
boolean hasSkip = true;
if (skipList == null ){
hasSkip = false;
}
List result = new ArrayList();
if (propList != null) {
for(HashMap oneMap: propList){
HashMap oneRow = new HashMap();
String name = (String) oneMap.get("name");
if (hasSkip && skipList.contains(name)){
continue;
}
oneRow.put("selected", false);
oneRow.put("name", name);
oneRow.put("value", oneMap.get("value"));
oneRow.put("description", oneMap.get("description"));
result.add(oneRow);
}
}
return result;
}
public static List getListfromMap(HashMap props) {
List result = new ArrayList();
Iterator it = props.entrySet().iterator();
while(it.hasNext()) {
Map.Entry m =(Map.Entry)it.next();
HashMap oneRow = new HashMap();
oneRow.put("selected", false);
oneRow.put("Name", m.getKey());
oneRow.put("Value", m.getValue());
oneRow.put("Description", "");
result.add(oneRow);
}
return result;
}
@Handler(id="saveRealm",
input={
@HandlerInput(name="endpoint", type=String.class),
@HandlerInput(name="classnameOption", type=String.class),
@HandlerInput(name="attrMap", type=Map.class),
@HandlerInput(name="edit", type=Boolean.class, required=true),
@HandlerInput(name="contentType", type=String.class, required=false),
@HandlerInput(name="propList", type=List.class)
},
output={
@HandlerOutput(name="newPropList", type=List.class)
})
public static void saveRealm(HandlerContext handlerCtx) {
String option = (String) handlerCtx.getInputValue("classnameOption");
List> propListOrig = (List)handlerCtx.getInputValue("propList");
PropertyList propList = PropertyList.fromList(propListOrig);
Map attrMap = (Map)handlerCtx.getInputValue("attrMap");
Boolean edit = (Boolean) handlerCtx.getInputValue("edit");
if (attrMap == null) {
attrMap = new HashMap();
}
String classname;
try{
if(option.equals("predefine")){
classname = attrMap.get("classname");
if(classname.indexOf("FileRealm")!= -1){
propList.put( "file", attrMap, "file");
propList.put( "jaas-context", attrMap, "fileJaax");
propList.put( "assign-groups", attrMap, "fileAsGroups");
}else
if(classname.indexOf("LDAPRealm")!= -1){
propList.put( "jaas-context", attrMap, "ldapJaax");
propList.put( "base-dn", attrMap, "baseDn");
propList.put( "directory", attrMap, "directory");
propList.put( "assign-groups", attrMap, "ldapAsGroups");
}else
if(classname.indexOf("SolarisRealm")!= -1){
propList.put( "jaas-context", attrMap, "solarisJaax");
propList.put( "assign-groups", attrMap, "solarisAsGroups");
}else
if(classname.indexOf("PamRealm")!= -1){
propList.put( "jaas-context", attrMap, "pamJaax");
}else
if(classname.indexOf("JDBCRealm")!= -1){
propList.put( "jaas-context", attrMap, "jdbcJaax");
propList.put( "datasource-jndi", attrMap, "datasourceJndi");
propList.put( "user-table", attrMap, "userTable");
propList.put( "user-name-column", attrMap, "userNameColumn");
propList.put( "password-column", attrMap, "passwordColumn");
propList.put( "group-table", attrMap, "groupTable");
propList.put( "group-table-user-name-column", attrMap, "groupTableUserName");
propList.put( "group-name-column", attrMap, "groupNameColumn");
propList.put( "db-user", attrMap, "dbUser");
propList.put( "db-password", attrMap, "dbPassword");
propList.put( "digest-algorithm", attrMap, "digestAlgorithm");
propList.put( "digestrealm-password-enc-algorithm", attrMap, "pswdEncAlgorithm");
propList.put( "encoding", attrMap, "encoding");
propList.put( "charset", attrMap, "charset");
propList.put( "assign-groups", attrMap, "jdbcAsGroups");
}else {
if(classname.indexOf("CertificateRealm")!= -1){
propList.put( "assign-groups", attrMap, "certAsGroups");
}
}
} else {
classname = attrMap.get("classnameInput");
}
//for edit case, only properties will be changed since we don't allow classname change.
//return the prop list so it can continue processing in the .jsf
if (edit){
handlerCtx.setOutputValue("newPropList", propList.toList());
return;
}
Map cMap = new HashMap();
cMap.put("name", attrMap.get("Name"));
cMap.put("classname", classname);
cMap.put(TARGET, attrMap.get(TARGET));
if (Boolean.parseBoolean(attrMap.get("registerLoginModule"))) {
propList.put("jaas-context", attrMap, "loginModuleJaax");
cMap.put("login-module", attrMap.get("loginModuleClass"));
}
cMap.put("property", propList.toParamValue());
String endpoint = (String) handlerCtx.getInputValue("endpoint");
endpoint = endpoint + "/auth-realm";
RestUtil.restRequest(endpoint, cMap, "post", handlerCtx, false);
}catch(Exception ex){
GuiUtil.handleException(handlerCtx, ex);
}
}
static public void putOptional(Map attrMap, List propList, String propName, String key)
{
Map oneProp = new HashMap();
oneProp.put("name", propName);
String value = attrMap.get(key);
if (GuiUtil.isEmpty(value))
return;
oneProp.put("value", attrMap.get(key));
propList.add(oneProp);
}
/* Handler for Group/User managemenet */
/**
* This handler update's user info.
* Input value: "Realm" -- Type: java.lang.String
* Output value: "UserId" -- Type: java.lang.String
* Output value: "GroupList" -- Type: java.lang.String
* Output value: "Password" -- Type: java.lang.String
* @param handlerCtx The HandlerContext.
*/
@Handler(id="saveUser",
input={
@HandlerInput(name="Realm", type=String.class, required=true),
@HandlerInput(name="configName", type=String.class, required=true),
@HandlerInput(name="UserId", type=String.class, required=true),
@HandlerInput(name="GroupList", type=String.class, required=true),
@HandlerInput(name="Password", type=String.class, required=true),
@HandlerInput(name="CreateNew", type=String.class, required=true)})
public static void saveUser(HandlerContext handlerCtx) {
char[] password = null;
try {
String realmName = (String) handlerCtx.getInputValue("Realm");
String configName = (String) handlerCtx.getInputValue("configName");
String grouplist = (String)handlerCtx.getInputValue("GroupList");
password = ((String)handlerCtx.getInputValue("Password")).toCharArray();
String userid = (String)handlerCtx.getInputValue("UserId");
String createNew = (String)handlerCtx.getInputValue("CreateNew");
if (password == null) {
password = "".toCharArray();
}
// before save user synchronize realm, for the case if keyfile is changed
String tmpEP = GuiUtil.getSessionValue("REST_URL") + "/configs/config/"
+ configName + "/synchronize-realm-from-config";
HashMap attrs = new HashMap<>();
attrs.put("id", configName);
attrs.put("realmName", realmName);
RestUtil.restRequest(tmpEP, attrs, "POST", handlerCtx, false);
String endpoint = GuiUtil.getSessionValue("REST_URL") + "/configs/config/" + configName + "/security-service/auth-realm/" + realmName ;
if (Boolean.valueOf(createNew)) {
endpoint = endpoint + "/create-user?target=" + configName;
}else{
endpoint = endpoint + "/update-user?target=" + configName;
}
attrs = new HashMap<>();
attrs.put("id", userid);
// Converting the password back to string as this is passed directly as payload in REST request
attrs.put("userpassword", new String(password));
attrs.put("target", configName);
if (grouplist != null && grouplist.contains(",")) {
grouplist = grouplist.replace(',', ':');
}
List grpList = new ArrayList();
if (grouplist != null) {
grpList.add(grouplist);
}
attrs.put("groups", grpList);
RestUtil.restRequest(endpoint, attrs, "POST", null, true, true );
} catch(Exception ex) {
GuiUtil.handleException(handlerCtx, ex);
}
finally {
if (password != null) {
Arrays.fill(password, ' ');
}
}
}
/**
* This handler returns the attribute values in the
* Edit Manage User Password Page.
* Input value: "Realm" -- Type: java.lang.String
* Output value: "UserId" -- Type: java.lang.String
* Output value: "GroupList" -- Type: java.lang.String
* @param handlerCtx The HandlerContext.
*/
@Handler(id="getUserInfo",
input={
@HandlerInput(name="Realm", type=String.class, required=true),
@HandlerInput(name="configName", type=String.class, required=true),
@HandlerInput(name="User", type=String.class, required=true)},
output={
@HandlerOutput(name="GroupList", type=String.class)})
public static void getUserInfo(HandlerContext handlerCtx) {
String realmName = (String) handlerCtx.getInputValue("Realm");
String userName = (String) handlerCtx.getInputValue("User");
String configName = (String) handlerCtx.getInputValue("configName");
handlerCtx.setOutputValue("GroupList", getGroupNames(realmName, userName, configName, handlerCtx) );
}
/**
* This handler returns the list of file users for specified realm.
* @param handlerCtx The HandlerContext.
*/
@Handler(id="getFileUsers",
input={
@HandlerInput(name="Realm", type=String.class, required=true),
@HandlerInput(name="configName", type=String.class, required=true)},
output={
@HandlerOutput(name="result", type=java.util.List.class)}
)
public static void getFileUsers(HandlerContext handlerCtx){
String realmName = (String) handlerCtx.getInputValue("Realm");
String configName = (String) handlerCtx.getInputValue("configName");
List result = new ArrayList();
try{
String endpoint = GuiUtil.getSessionValue("REST_URL") + "/configs/config/" + configName +
"/security-service/auth-realm/" + realmName + "/list-users.json?target=" + configName;
Map responseMap = RestUtil.restRequest(endpoint, null, "get", handlerCtx, false);
responseMap = (Map) responseMap.get("data");
List children = (List) responseMap.get("children");
if(children != null) {
Map map = null;
for (HashMap child : children) {
map = new HashMap();
String name = (String) child.get("message");
map.put("users", name);
map.put("groups", getGroupNames( realmName, name, configName, handlerCtx));
map.put("selected", false);
result.add(map);
}
}
}catch(Exception ex){
GuiUtil.handleException(handlerCtx, ex);
}
handlerCtx.setOutputValue("result", result);
}
/**
* This handler removes users for specified realm.
* @param handlerCtx The HandlerContext.
*/
@Handler(id="removeUser",
input={
@HandlerInput(name="Realm", type=String.class, required=true),
@HandlerInput(name="configName", type=String.class, required=true),
@HandlerInput(name="selectedRows", type=List.class, required=true)},
output={
@HandlerOutput(name="result", type=java.util.List.class)}
)
public static void removeUser(HandlerContext handlerCtx){
String error = null;
String realmName = (String) handlerCtx.getInputValue("Realm");
String configName = (String) handlerCtx.getInputValue("configName");
try{
List obj = (List) handlerCtx.getInputValue("selectedRows");
List