jaas/command/src/main/java/org/apache/karaf/jaas/command/ModuleAddCommand.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.karaf.jaas.command;

import org.apache.karaf.jaas.command.completers.LoginModuleNameCompleter;
import org.apache.karaf.jaas.config.JaasRealm;
import org.apache.karaf.jaas.config.impl.Config;
import org.apache.karaf.jaas.config.impl.Module;
import org.apache.karaf.jaas.modules.BackingEngine;
import org.apache.karaf.shell.api.action.Argument;
import org.apache.karaf.shell.api.action.Command;
import org.apache.karaf.shell.api.action.Completion;
import org.apache.karaf.shell.api.action.lifecycle.Service;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;

@Command(scope = "jaas", name = "module-add", description = "Add a Login Module")
@Service
public class ModuleAddCommand extends JaasCommandSupport {

    @Argument(index = 0, name = "loginModule", description = "Class Name of Login Module", required = true, multiValued = false)
    @Completion(LoginModuleNameCompleter.class)
    private String loginModule;

    @Argument(index = 1, name = "properties", description = "Pair of Properties (key value)", required = false, multiValued = true)
    private List<String> propertiesList;

    @Override
    protected Object doExecute(BackingEngine engine) throws Exception {
        return null;
    }

    @Override
    public Object execute() throws Exception {
        // Fetch Realm
        JaasRealm realm = (JaasRealm) session.get(JAAS_REALM);

        if (realm == null) {
            System.err.println("No JAAS Realm has been selected");
            throw new IllegalStateException("No JAAS Realm has been selected");
        }
        if (!(realm instanceof Config)) {
            System.err.println("Selected JAAS Realm was not added via jaas:add-realm, only those are supported!");
            throw new IllegalStateException("Selected JAAS Realm was not added via jaas:add-realm, only those are supported!");
        }

        if (!checkIfClassExists(loginModule)) {
            System.err.println("Module class '" + loginModule + "' is unknown!");
            throw new IllegalArgumentException("Module class '" + loginModule + "' is unknown!");
        }
        Module module = createModuleFromCmdParameters(loginModule, propertiesList);

        // Add the Login Module to the current Realm
        List<Module> modulesList = new ArrayList<>(Arrays.asList(((Config) realm).getModules()));
        modulesList.add(module);
        Module[] newModules = modulesList.toArray(new Module[]{});
        ((Config) realm).setModules(newModules);
        return null;
    }

    /**
     * Parses the Command Line Parameters given to create a valid Module and Properties from it.
     * @param loginModule Class Name of the login Module
     * @param propertiesList List of Properties interpreted as "key1 value1 key2 value2"
     * @return Module
     */
    static Module createModuleFromCmdParameters(String loginModule, List<String> propertiesList) {
        // Parse Properties
        if (propertiesList != null && propertiesList.size() > 0 && (propertiesList.size() % 2) == 1) {
            // Properties are uneven... bad
            System.err.println("Properties have to be given as \"key1 value1 key2 value2 ...\" but number of Arguments is uneven!");
            return null;
        }
        Properties properties = new Properties();
        if (propertiesList != null) {
            for (int i = 0; i < propertiesList.size(); i += 2) {
                properties.put(propertiesList.get(i), propertiesList.get(i + 1));
            }
        }
        // Assemble Login Module
        Module module = new Module();
        module.setClassName(loginModule);
        module.setFlags("required");
        module.setOptions(properties);
        return module;
    }

    public String getLoginModule() {
        return loginModule;
    }

    public void setLoginModule(String loginModule) {
        this.loginModule = loginModule;
    }

    public List<String> getPropertiesList() {
        return propertiesList;
    }

    public void setPropertiesList(List<String> propertiesList) {
        this.propertiesList = propertiesList;
    }

    private boolean checkIfClassExists(String loginModule) {
        try {
            this.getClass().getClassLoader().loadClass(loginModule);
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }
}