willdurand / nmap Goto Github PK

View Code? Open in Web Editor NEW

156.0 19.0 57.0 44 KB

nmap is a PHP wrapper for Nmap.

License: MIT License

PHP 100.00%

nmap's Introduction

nmap

nmap is a PHP wrapper for Nmap, a free security scanner for network exploration.

Usage

use Nmap\Nmap;

$hosts = Nmap::create()->scan([ 'williamdurand.fr' ]);

$ports = $hosts->getOpenPorts();

You can specify the ports you want to scan:

$nmap = new Nmap();

$nmap->scan([ 'williamdurand.fr' ], [ 21, 22, 80 ]);

OS detection and Service Info are disabled by default, if you want to enable them, use the enableOsDetection() and/or enableServiceInfo() methods:

$nmap
    ->enableOsDetection()
    ->scan([ 'williamdurand.fr' ]);

$nmap
    ->enableServiceInfo()
    ->scan([ 'williamdurand.fr' ]);

// Fluent interface!
$nmap
    ->enableOsDetection()
    ->enableServiceInfo()
    ->scan([ 'williamdurand.fr' ]);

Turn the verbose mode by using the enableVerbose() method:

$nmap
    ->enableVerbose()
    ->scan([ 'williamdurand.fr' ]);

For some reasons, you might want to disable port scan, that is why nmap provides a disablePortScan() method:

$nmap
    ->disablePortScan()
    ->scan([ 'williamdurand.fr' ]);

You can also disable the reverse DNS resolution with disableReverseDNS():

$nmap
    ->disableReverseDNS()
    ->scan([ 'williamdurand.fr' ]);

You can define the process timeout (default to 60 seconds) with setTimeout():

$nmap
    ->setTimeout(120)
    ->scan([ 'williamdurand.fr' ]);

Installation

The recommended way to install nmap is through Composer:

{
    "require": {
        "willdurand/nmap": "@stable"
    }
}

Or:

composer require willdurand/nmap

Protip: you should browse the willdurand/nmap page to choose a stable version to use, avoid the @stable meta constraint.

License

nmap is released under the MIT License. See the bundled LICENSE file for details.

nmap's People

Contributors

Stargazers

Watchers

nmap's Issues

Timeout on larger scans

great project so far!

I only have 1 little issue that when i run scans on hosts with a lot of ports i exceed the 60 second default timeout in the ProcessExecutor.php

My suggestion in Nmap.php add $timeout = 60 when initializing the class and passing that on to the ->execute($command, $timeout) method.

Inside the processExecutor create the new Process() like this:

$process = new Process($command,NULL,NULL,NULL,$timeout);

If you want to i could probably sent a pull request or something

greetings
loeken

Change parseOutputFile to public

What do you think about setting this method to public ? It could be very usefull if you have existing reports of nmap to parse.

Of course somes changes are needed for example in constructor and scan function but it's not a big deal and it could be a nice improvement.

Can only install one of: symfony/process[v2.8.0, v3.0.6].

I'm trying to use nmap in laravel 5.2. symfony/process v3.0.6 already installed as dependency for laravel 5.2.
nmap require synfony/process ~2.0 . I can't use nmap because dependency conflict problem.

Failed to execute "nmap"

Hello,

I receive the following error:
FatalErrorException in Nmap.php line 62:
Call to a member function execute() on null

However, if I change line 62 of Nmap.php from this:

if ($executor->execute($this->executable) !== 0) {

to this:

if ($this->executor->execute($this->executable) !== 0) {

I seem to get past it. Unfortunately, I then get this error:
RuntimeException in ProcessExecutor.php line 32:
Failed to execute "nmap"

It seems as though the nmap command is not being built up. If I "hard code" the $executable variable on line 55 of Nmap.php to an actual nmap command, for instance....

    public function __construct(ProcessExecutor $executor = null, $outputFile = null, $executable = 'nmap 10.0.0.254')

I DO get what seems to be good data back.

Here is how I'm building up my Nmap object:

    public function nmapScan()
    {

        $hosts = \Nmap\Nmap::create()->enableVerbose()->scan([ 'myhost.mydomain.com' ]);

        $ports = $hosts->getOpenPorts();
                // dd($hosts);
        // dd($ports);

    }

Am I using this incorrectly? It seems to completely disregard the host I'm telling it to scan, and unless I "hard code" the hostname into line 55 of Nmap.php, it fails because it's trying to execute 'nmap' alone with only prints the command help information.

If I can provide other/more data, I will be happy to. Sorry if this isn't the prescribed way to submit this issue. I'm new to pull requests and issue tracking on github, so if I should do this differently, just let me know and I'll be happy to.

Thanks for what looks like a really awesome package! Any help you can provide will be greatly appreciated.

Oh, and this is being used in a Laravel 5.1 project. My test box is running PHP 5.5.20.

OS Not Detecting

I am using
Laravel: 5.8
PHP Version: 7.2.22
willdurand/nmap: dev-master

I am unable to detect the OS where I can detect with normal nmap terminal command line
please look into the screenshot

A way to detect if nmap is installed on system

It would be really nice if library would notify you if package nmap is missing on system. I installed this library on system and it took me quite a while to detect what was the problem. The nmap package was missing on system and because of that this library did not work.

Could this kind of detection be added on install (maybe in composer)?

how scan for os detect ?

PHP Fatal error: Uncaught exception 'RuntimeException' with message 'Failed to execute "nmap -O -oX '/tmp/output.xml' 'xxx.xxx.eu'" TCP/IP fingerprinting (for OS scan) requires root privileges.

how to for do this scan?

Uncaught Error: Class 'Nmap' not found

Hey! Hey! Hey!
i just wanted to try nmap, but php doesn't find the class "Nmap".
i installed nmap via "composer require willdurand/nmap" successfully.
I created the following script:
test.php:
`<?php

require DIR . '/vendor/autoload.php';

$nmap = new Nmap();
//$nmap->scan([ 'williamdurand.fr' ], [ 21, 22, 80 ]);
//$hosts = Nmap::create()->scan([ 'williamdurand.fr' ]);
//$ports = $hosts->getOpenPorts();
//echo $ports;

?>
`

and my error output:
PHP Fatal error: Uncaught Error: Class 'Nmap' not found in /var/www/start/nmap/test.php

Where's my mistake?

yii2 command use

Hi,

how to use nap classes ?

use willdurant\nmap\Nmap;

gives a file not found error.
Thanks

Future of this project

@willdurand:

I just installed dev-master (laravel 5.8|php 7.3) and it works. However I get these 2 warnings below.

PHP Deprecated: Passing a command as string when creating a "Symfony/Component/Process/Process" instance is deprecated since Symfony 4.2, pass it as an array of its arguments instead, or use the "Process::fromShellCommandline()" constructor if you need features provided by the shell. in ...vendor/symfony/process/Process.php on line 147
PHP Deprecated: Passing a command as string when creating a "Symfony/Component/Process/Process" instance is deprecated since Symfony 4.2, pass it as an array of its arguments instead, or use the "Process::fromShellCommandline()" constructor if you need features provided by the shell. in ...vendor/symfony/process/Process.php on line 147

I'm not sure if you want to drop support for older symfony/process or you want to somehow figure out the symfony/process version? I wasn't aware that I have write access to this repo, I made my own little fork over at github.com/repat/nmap but would be willing to maintain this instead if that's ok? (Also accidentally clicked a merge button the wrong way, but it's cleaned up ;-) - that's how I found out)

So for symfony/process ^4.0 to work without warnings, we have to pass the arguments as an array as you can see here:

https://github.com/repat/nmap/blob/master/src/Nmap/Nmap.php#L104

I would now:

Create version 0.6.0 with the warnings
Drop support for symfony/process 2.X, only support ^3.4 (see below, 2.X is not supported anyway)
Pass arguments as array because that's how it's done in ^3.4 and ^4.0
Port over some of the changes I made (PSR4/PHPunit)
Create version 0.7.0
Delete my repo and maintain this (we actively use it)

Let me know what you think :-)

Allow to configure port ranges

Nmap is not working in laravel

Failed to execute "nmap -h"
'nmap' is not recognized as an internal or external command,
operable program or batch file.

(1/1) RuntimeExceptionFailed to execute "nmap -h"'nmap' is not recognized as an internal or external command,operable program or batch file.

in ProcessExecutor.php line 31
at ProcessExecutor->execute('nmap -h')in Nmap.php line 62
at Nmap->__construct()in Nmap.php line 45
at Nmap::create()in UserController.php line 22
at UserController->index()
at call_user_func_array(array(object(UserController), 'index'), array())in Controller.php line 55
at Controller->callAction('index', array())in ControllerDispatcher.php line 44

Symfony 5 support

Hello,

Would be possible adding Symfony 5 support too, please, in the same way we have support for Symfony 2, 3, and 4?

Alternatively, maybe is worth "clean up" the unmaintained versions and just keep support for Symfony 4 and 5?

Cheers,

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.