com.sun.enterprise.admin.cli.cluster.SetupSshKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cluster-cli Show documentation
There is a newer version: 8.0.0-JDK17-M9
/*
 * Copyright (c) 2022, 2025 Contributors to the Eclipse Foundation
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.admin.cli.cluster;

import jakarta.inject.Inject;

import java.io.Console;
import java.io.File;
import java.util.Arrays;
import java.util.logging.Level;

import org.glassfish.api.Param;
import org.glassfish.api.admin.CommandException;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.cluster.ssh.launcher.SSHKeyInstaller;
import org.glassfish.cluster.ssh.launcher.SSHLauncher;
import org.glassfish.cluster.ssh.util.SSHUtil;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Globals;
import org.jvnet.hk2.annotations.Service;

/**
 *  This is a local command that distributes the SSH public key to remote node(s)
 *
 */
@Service(name = "setup-ssh")
@PerLookup
@ExecuteOn({RuntimeType.DAS})
public final class SetupSshKey extends NativeRemoteCommandsBase {
    @Param(name = "sshuser", optional = true, defaultValue = "${user.name}")
    private String user;
    @Param(optional = true, defaultValue = "22", name = "sshport")
    int port;
    @Param(optional = true)
    String sshkeyfile;
    @Param(optional = true)
    private String sshpublickeyfile;
    @Param(optional = true, defaultValue = "false")
    private boolean generatekey;
    @Inject
    private ServiceLocator habitat;


    @Override
    protected void validate() throws CommandException {
        super.validate();
        Globals.setDefaultHabitat(habitat);

        if (sshkeyfile == null) {
            // if user hasn't specified a key file and there is no key file at default
            // location, then generate one
            final File existingKey = SSHUtil.getExistingKeyFile();
            if (existingKey == null) {
                sshkeyfile = SSHUtil.getDefaultKeyFile().getAbsolutePath();
                if (promptForKeyGeneration()) {
                    generatekey = true;
                }
            } else {
                // there is a key that requires to be distributed, hence need password
                promptPass = true;
                sshkeyfile = existingKey.getAbsolutePath();
                if (SSHUtil.isEncryptedKey(existingKey)) {
                    sshkeypassphrase = getSSHPassphrase(false);
                }
            }
        } else {
            final File keyFile = new File(sshkeyfile);
            SSHUtil.validateKeyFile(keyFile);
            promptPass = true;
            if (SSHUtil.isEncryptedKey(keyFile)) {
                sshkeypassphrase = getSSHPassphrase(false);
            }
        }

        if (sshpublickeyfile != null) {
            SSHUtil.validateKeyFile(new File(sshpublickeyfile));
        }
    }


    @Override
    protected int executeCommand() throws CommandException {
        String previousPassword = null;
        boolean status = false;
        for (String node : hosts) {
            final File keyFile = sshkeyfile == null ? null : new File(sshkeyfile);
            final SSHLauncher sshL = new SSHLauncher(getRemoteUser(), node, getRemotePort(), sshpassword, keyFile,
                sshkeypassphrase);
            if (generatekey || promptPass) {
                // prompt for password iff required
                if (keyFile != null || SSHUtil.getExistingKeyFile() != null) {
                    if (sshL.checkConnection()) {
                        logger.info(Strings.get("SSHAlreadySetup", getRemoteUser(), node));
                        continue;
                    }
                }
                if (previousPassword != null) {
                    status = sshL.checkPasswordAuth();
                }
                if (!status) {
                    sshpassword = getSSHPassword(node);
                    previousPassword = sshpassword;
                }
            }

            try {
                SSHKeyInstaller installer = new SSHKeyInstaller(sshL);
                File pubKeyFile = sshpublickeyfile == null ? null : new File(sshpublickeyfile);
                installer.setupKey(node, pubKeyFile, generatekey, sshpassword);
            } catch (Exception e) {
                logger.log(Level.SEVERE, "SSH key setup failed: ", e);
                throw new CommandException(Strings.get("KeySetupFailed", e.getMessage()), e);
            }

            if (!sshL.checkConnection()) {
                throw new CommandException(Strings.get("ConnFailed"));
            }
        }
        return SUCCESS;
    }

    /**
     * Prompt for key generation
     */
    private boolean promptForKeyGeneration() {
        if (generatekey) {
            return true;
        }

        if (!programOpts.isInteractive()) {
            return false;
        }

        Console cons = System.console();

        if (cons != null) {
            String val = null;
            do {
                cons.printf("%s", Strings.get("GenerateKeyPairPrompt", getRemoteUser(), Arrays.toString(hosts)));
                val = cons.readLine();
                if (val != null && (val.equalsIgnoreCase("yes") || val.equalsIgnoreCase("y"))) {
                    if (logger.isLoggable(Level.FINER)) {
                        logger.finer("Generate key!");
                    }
                    return true;
                } else if (val != null && (val.equalsIgnoreCase("no") || val.equalsIgnoreCase("n"))) {
                    break;
                }
            }
            while (val != null && !isValidAnswer(val));
        }
        return false;
    }

    @Override String getRawRemoteUser() {
        return user;
    }

    @Override
    int getRawRemotePort() {
        return port;
    }

    @Override
    String getSshKeyFile() {
        return sshkeyfile;
    }
}