io.cloudslang.content.utilities.services.osdetector.NmapOsDetectorService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cs-utilities Show documentation
Java utilities Actions
There is a newer version: 0.1.24
/*
 * (c) Copyright 2017 EntIT Software LLC, a Micro Focus company, L.P.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Apache License v2.0 which accompany this distribution.
 *
 * The Apache License is available 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.
 */
/*
 * (c) Copyright 2017 Hewlett-Packard Enterprise Development Company, L.P.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Apache License v2.0 which accompany this distribution.
 *
 * The Apache License is available at
 * http://www.apache.org/licenses/LICENSE-2.0
 *
*/
package io.cloudslang.content.utilities.services.osdetector;

import io.cloudslang.content.utilities.entities.OperatingSystemDetails;
import io.cloudslang.content.utilities.entities.OsDetectorInputs;
import io.cloudslang.content.utilities.util.ProcessExecutor;
import io.cloudslang.content.utilities.entities.ProcessResponseEntity;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;

import static io.cloudslang.content.httpclient.HttpClientInputs.PROXY_HOST;
import static io.cloudslang.content.httpclient.HttpClientInputs.PROXY_PORT;
import static io.cloudslang.content.utils.OtherUtilities.isValidIpPort;
import static java.lang.Integer.parseInt;
import static java.lang.String.format;
import static org.apache.commons.lang3.StringUtils.contains;
import static org.apache.commons.lang3.StringUtils.isEmpty;
import static org.apache.commons.lang3.StringUtils.isNotEmpty;

/**
 * Created by Tirla Florin-Alin on 24/11/2017.
 **/
public class NmapOsDetectorService implements OperatingSystemDetector {
    private static final String OS_DETAILS = "OS details: ";
    private static final String NMAP = "Nmap";
    private final OsDetectorHelperService osDetectorHelperService;

    public NmapOsDetectorService(OsDetectorHelperService osDetectorHelperService) {
        this.osDetectorHelperService = osDetectorHelperService;
    }

    @Override
    public OperatingSystemDetails detectOs(OsDetectorInputs osDetectorInputs) {
        OperatingSystemDetails operatingSystemDetails = new OperatingSystemDetails();
        List nmapCommandOutput = new ArrayList<>();
        try {
            int timeout = parseInt(osDetectorInputs.getNmapTimeout());

            ProcessResponseEntity responseEntity = new ProcessExecutor().execute(buildNmapCommand(osDetectorInputs), timeout);
            if (responseEntity.isTimeout()) {
                addTimeoutErrorMessage(nmapCommandOutput);
            } else {
                String stdOut = responseEntity.getStdout();
                String stdErrors = responseEntity.getStderr();
                int exitCode = responseEntity.getExitCode();

                if (!isEmpty(stdOut)) {
                    nmapCommandOutput.add(stdOut);
                    String osName = osDetectorHelperService.cropValue(stdOut, OS_DETAILS, System.lineSeparator());
                    operatingSystemDetails.setName(osName);
                    operatingSystemDetails.setFamily(osDetectorHelperService.resolveOsFamily(osName));
                }
                if (!isEmpty(stdErrors)) {
                    nmapCommandOutput.add(stdErrors);
                }
                nmapCommandOutput.add("Execution of Nmap command had exit code: " + exitCode);
            }
        } catch (IOException e) {
            nmapCommandOutput.add("Failed to run Nmap command: " + e.getMessage());
        } catch (InterruptedException e) {
            nmapCommandOutput.add("Execution of Nmap command was canceled.");
        } catch (ExecutionException e) {
            nmapCommandOutput.add("An exception occurred while running the Nmap command: " + e.getMessage());
        } catch (TimeoutException e) {
            addTimeoutErrorMessage(nmapCommandOutput);
        }
        operatingSystemDetails.addCommandOutput(NMAP, nmapCommandOutput);
        return operatingSystemDetails;
    }

    private void addTimeoutErrorMessage(List operatingSystemDetails) {
        operatingSystemDetails.add("The nmap command timed out");
    }

    private String buildNmapCommand(OsDetectorInputs osDetectorInputs) {
        String nmapPath = osDetectorInputs.getNmapPath();

        String nmapArguments = osDetectorInputs.getNmapArguments();
        String proxyHost = osDetectorInputs.getProxyHost();
        if (!contains(nmapArguments, "--proxies") && !contains(nmapArguments, "--proxy") && isNotEmpty(proxyHost)) {
            nmapArguments = appendProxyArgument(nmapArguments, proxyHost, osDetectorInputs.getProxyPort());
        }

        String host = osDetectorInputs.getHost();

        return nmapPath + " " + nmapArguments + " " + host;
    }

    @NotNull
    public String appendProxyArgument(String nmapArguments, String proxyHost, String proxyPort) {
        try {
            URL proxyUrl = new URL(proxyHost);
            if (!isValidIpPort(proxyPort)) {
                throw new IllegalArgumentException(format("The '%s' input does not contain a valid port.", PROXY_PORT));
            }
            nmapArguments += " --proxies " + proxyUrl.getProtocol() + "://" + proxyUrl.getHost() + ":" + proxyPort;
        } catch (MalformedURLException e) {
            throw new IllegalArgumentException(format("The '%s' input does not contain a valid URL: %s.", PROXY_HOST, e.getMessage()));
        }
        return nmapArguments;
    }
}