org.glassfish.cluster.ssh.launcher.JavaSystemJschLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cluster-ssh Show documentation
There is a newer version: 8.0.0-JDK17-M9
/*
 * Copyright (c) 2023, 2025 Contributors to the Eclipse Foundation
 *
 * 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 org.glassfish.cluster.ssh.launcher;

import com.jcraft.jsch.JSch;

import java.lang.System.Logger;
import java.lang.System.Logger.Level;

import org.glassfish.internal.api.RelativePathResolver;

/**
 * JSCH triggers a lot of unimportant messages, which have a lower level than issued by JSCH.
 * For example, for a single SSH connection, it triggers 1 WARNING about adding a host to the list
 * of known hosts, 47 INFO messages, and 6 DEBUG messages. Therefore we decrease their level to
 * match their real severity.
 * 
 * The log levels from JSCH are mapped to these levels in GlassFish:
 * 

 * JSCH DEBUG level -> TRACE level in GlassFish
 * 
JSCH INFO level -> DEBUG level in GlassFish
 * 
JSCH WARN level -> INFO level in GlassFish
 * 
JSCH ERROR level -> WARNING level in GlassFish
 * 
JSCH FATAL level -> ERROR/SEVERE level in GlassFish
 * 
 */
public class JavaSystemJschLogger implements com.jcraft.jsch.Logger {

    private final Logger logger;

    /**
     * The logger name to be used is com.jcraft.jsch
     */
    public JavaSystemJschLogger() {
        this.logger = System.getLogger(JSch.class.getName());
    }

    @Override
    public boolean isEnabled(int jschLevel) {
        return logger.isLoggable(getSystemLoggerLevel(jschLevel));
    }

    @Override
    public void log(int jschLevel, String message) {
        logger.log(getSystemLoggerLevel(jschLevel), message);
    }

    @Override
    public void log(int jschLevel, String message, Throwable cause) {
        if (cause != null) {
            logger.log(getSystemLoggerLevel(jschLevel), message, cause);
        } else {
            logger.log(getSystemLoggerLevel(jschLevel), message);
        }
    }



    /**
     * Return a version of the password that is printable.
     *
     * @param privateValue  password, keyphrase, etc.
     * @return   printable version of password
     */
    public static String maskForLogging(String privateValue) {
        // We only display the password if it is an alias, else
        // we display "".
        String printable = "null";
        if (privateValue != null) {
            if (isPasswordAlias(privateValue)) {
                printable = privateValue;
            } else {
                printable = "";
            }
        }
        return printable;
    }

    private static boolean isPasswordAlias(String alias) {
        // Check if the passed string is specified using the alias syntax
        String aliasName = RelativePathResolver.getAlias(alias);
        return aliasName != null;
    }


    private static Level getSystemLoggerLevel(int jschLevel) {
        switch (jschLevel) {
            case DEBUG:
                return Level.TRACE;
            case INFO:
                return Level.DEBUG;
            case WARN:
                return Level.INFO;
            case ERROR:
                return Level.WARNING;
            case FATAL:
                return Level.ERROR;
            default:
                return Level.TRACE;
        }
    }
}