path: root/src/main/java/com/it_jaros/jscanner/Scanner.java

package com.it_jaros.jscanner;

import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.NoSuchFileException;
import java.nio.file.Path;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.locks.LockSupport;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class Scanner {

    private final Counter counter = new Counter();
    private final ProgressBar progressBar = new ProgressBar();
    private final Semaphore socketLimit;
    private final int timeoutInMillis;
    private final long delayInNanos;
    private final int maxWorkersPerHost;
    private final int maxHostsLimit;
    private final boolean disableOnlineCheck;

    public Scanner(int socketLimit, int timeoutInMillis, int delayInMillis, int maxWorkersPerHost, int maxHostsLimit, boolean disableOnlineCheck) {
        this.timeoutInMillis = timeoutInMillis;
        this.delayInNanos = TimeUnit.MILLISECONDS.toNanos(Math.max(0, delayInMillis));
        this.socketLimit = new Semaphore(socketLimit);
        this.maxWorkersPerHost = maxWorkersPerHost;
        this.maxHostsLimit = maxHostsLimit;
        this.disableOnlineCheck = disableOnlineCheck;
    }

    public List<ScanResult> scan(ScanOptions options) {
        if (options.hostsFile() != null) {
            return scanHosts(options.hostsFile(), options.ports());
        }
        return scanHosts(options.hostsArgv(), options.ports());
    }

    public List<ScanResult> scanHosts(String sourceFile, String ports) {
        try (BufferedReader reader = Files.newBufferedReader(Path.of(sourceFile))) {
            return scanHosts(reader.lines(), ports);
        } catch (FileNotFoundException | NoSuchFileException e) {
            System.out.printf("Could not open file %s%n", sourceFile);
        } catch (IOException e) {
            System.out.printf("Error while trying to read hosts: %s -> %s %n", e.getClass().getSimpleName(), e.getMessage());
        }

        return List.of();
    }

    public List<ScanResult> scanHosts(List<String> hostsArgv, String ports) {
        try (Stream<String> stream = hostsArgv.stream()) {
            return scanHosts(stream, ports);
        } catch (IOException e) {
            System.out.printf("Error while trying to read hosts: %s -> %s %n", e.getClass().getSimpleName(), e.getMessage());
        }

        return List.of();
    }

    public List<ScanResult> scanHosts(Stream<String> hosts, String ports) throws IOException {
        List<ScanResult> results = new ArrayList<>();
        progressBar.start();
        try (ExecutorService executor = Executors.newVirtualThreadPerTaskExecutor()) {
            CompletionService<ScanResult> completionService = new ExecutorCompletionService<>(executor);
            Queue<String> hostsInQueue = hosts.collect(Collectors.toCollection(ArrayDeque::new));

            int hostsToProcess = hostsInQueue.size();
            int activeHostWorkers = 0;
            while (hostsToProcess > 0) {
                // process queue
                while (!hostsInQueue.isEmpty() && activeHostWorkers <= maxHostsLimit) {
                    activeHostWorkers++;
                    final String host = hostsInQueue.poll();
                    completionService.submit(() -> scanHost(host, ports));
                }

                try {
                    Future<ScanResult> finishedHost = completionService.poll(10, TimeUnit.MILLISECONDS);
                    if (finishedHost == null) {
                        continue;
                    }
                    activeHostWorkers--;
                    hostsToProcess--;
                    results.add(finishedHost.get());
                } catch (InterruptedException e) {
                    Thread.currentThread().interrupt();
                } catch (ExecutionException e) {
                    System.out.printf("%s -> %s%n", e.getClass().getSimpleName(), e.getMessage());
                }
            }
        }

        progressBar.stop();
        System.out.println("--------------------");
        System.out.println("Finished scan!");
        System.out.println("Stats:");
        System.out.println("Peak concurrent connects: " + counter.max());
        System.out.println("--------------------");
        return results;
    }

    private ScanResult scanHost(String host, String ports) {
        PortRange portRange = new PortRange(ports);
        AtomicLong portSlotFactory = new AtomicLong(System.nanoTime());
        BitSet openPorts = new BitSet(PortRange.MAX_PORT);
        BitSet filteredPorts = new BitSet(PortRange.MAX_PORT);
        HashMap<Integer, ServiceType> bannerRecognition = new HashMap<>();

        // Give progressbar the current progress object which is then updated in the sub virtual threads
        Progress progress = new Progress(host, portRange.getTotal(), new AtomicInteger(), new AtomicInteger(), new AtomicInteger());
        progressBar.submit(progress);

        if (!disableOnlineCheck && !checkHostOnline(host)) {
            // Visually show that this host is basically done
            progress.done().set(progress.total());
            return new ScanResult(host, openPorts, filteredPorts, bannerRecognition);
        }

        try (ExecutorService executor = Executors.newVirtualThreadPerTaskExecutor()) {
            CompletionService<PortResult> completionService = new ExecutorCompletionService<>(executor);
            List<Throwable> errors = new ArrayList<>();
            int activePerHostWorkers = 0;
            int portsToProcess = portRange.getTotal();
            while (portsToProcess > 0) {
                while (portRange.hasNext() && activePerHostWorkers <= maxWorkersPerHost) {
                    activePerHostWorkers++;
                    final int currentPort = portRange.next();
                    completionService.submit(() -> {
                        waitForSlot(portSlotFactory);
                        return checkPort(host, currentPort);
                    });
                }

                try {
                    Future<PortResult> f = completionService.poll(10, TimeUnit.MILLISECONDS);
                    if (f == null) {
                        continue;
                    }
                    activePerHostWorkers--;
                    portsToProcess--;
                    progress.done().incrementAndGet();

                    // bitset is not thread-safe, so it is set
                    // outside the other virtual threads that update progress
                    PortResult portResult = f.get();
                    switch (portResult.getState()) {
                        case OPEN -> {
                            openPorts.set(portResult.getPort());
                            bannerRecognition.put(portResult.getPort(), ServiceDetector.detect(portResult.getBanner()));
                        }
                        case FILTERED -> filteredPorts.set(portResult.getPort());
                    }
                } catch (InterruptedException ignored) {
                    Thread.currentThread().interrupt();
                } catch (ExecutionException e) {
                    errors.add(e);
                }
            }

            if (!errors.isEmpty()) {
                System.out.printf("Errors happened during scan of host %s%nErrors:%s -> %s", host, errors.size(), errors);
            }
        }

        return new ScanResult(host, openPorts, filteredPorts, bannerRecognition);
    }

    private boolean checkHostOnline(String host) {
        try {
            return InetAddress.getByName(host).isReachable(timeoutInMillis);
        } catch (IOException e) {
            // something went wrong
        }

        return false;
    }

    private void waitForSlot(AtomicLong scanSlotFactory) {
        if (delayInNanos > 0) {
            long slot = scanSlotFactory.getAndAdd(delayInNanos);
            long wait = slot - System.nanoTime();
            if (wait > 0)
                LockSupport.parkNanos(wait);
        }
    }

    private PortResult checkPort(String host, int port) {
        socketLimit.acquireUninterruptibly();
        counter.inc();
        PortResult result = new PortResult();
        result.setPort(port);
        result.setState(PortState.UNKNOWN);
        try (Socket socket = new Socket()) {
            socket.connect(new InetSocketAddress(host, port), timeoutInMillis);
            result.setBanner(getBanner(socket));
            result.setState(PortState.OPEN);
        } catch (SocketTimeoutException ignored) {
            result.setState(PortState.FILTERED);
        } catch (ConnectException ignored) {
            result.setState(PortState.CLOSED);
        } catch (IOException ignored) {
            // NoRouteToHostException: this can be safely ignored because the port is closed if a host is unreachable
            // Will happen a lot when scanning for open ports, so not needed
        } finally {
            counter.dec();
            socketLimit.release();
        }

        return result;
    }

    private String getBanner(Socket socket) {
        int READ_BUFFER_SIZE = 1024;
        byte[] buffer = new byte[READ_BUFFER_SIZE];
        try (InputStream input = socket.getInputStream()) {
            socket.setSoTimeout(timeoutInMillis);
            int bytesRead = input.read(buffer);
            if (bytesRead <= 0) {
                return null;
            }
            return new String(buffer, 0, bytesRead, StandardCharsets.UTF_8).trim();
        } catch (IOException e) {
            // we ignore this failure
        }
        return null;
    }
}