Experimental network scanner
Go to file
Přemysl Eric Janouch 68627ddb5e Don't die if the terminal cannot be detected 2015-02-22 20:49:31 +01:00
http-parser@0b43367131 Implement the HTTP plugin 2014-09-21 01:02:16 +02:00
plugins Introduce Lua API version checking 2015-01-21 00:12:41 +01:00
.gitignore Generate a manpage 2014-09-20 18:12:55 +02:00
.gitmodules Implement the HTTP plugin 2014-09-21 01:02:16 +02:00
.travis.yml Travis CI: Try adding Coverity scan 2015-02-14 08:15:27 +01:00
CMakeLists.txt Tiny fixes 2015-02-12 02:33:15 +01:00
LICENSE Rewrite to use CMake 2015-01-17 16:10:12 +01:00
README Add Travis CI configuration 2015-02-08 05:44:02 +01:00
config.h.in Rewrite to use CMake 2015-01-17 16:10:12 +01:00
plugin-api.h Implement a Lua 5.3 plugin loader plugin 2015-01-18 04:14:45 +01:00
ponymap.c Don't die if the terminal cannot be detected 2015-02-22 20:49:31 +01:00
siphash.c Initial commit 2014-09-08 21:40:01 +02:00
siphash.h Initial commit 2014-09-08 21:40:01 +02:00
utils.c Add a useful assertion to the poller 2015-02-21 19:01:21 +01:00

README

ponymap
=======

`ponymap' is an experimental network scanner, of alpha quality so far.

Replacing nmap is not the goal, even though it would be rather very nice to
have a serious network scanner with a permissive license.

The ultimate purpose of this scanner is bruteforcing hosts and ports in search
of running services of a kind.  It should be simple and straight-forward to
either write your own service detection plugins, provided that you're familiar
with writing asynchronous code, or to make changes to the existing ones.

So far there are some problems with reliability, and some clever algorithm to
avoid overloading the network is needed.  Until then, you can use ulimit to cap
the maximum number of concurrent connections.

Building and Running
--------------------
Build dependencies: CMake, pkg-config, help2man, curses, openssl, Jansson,
                    lua = 5.3 (optional)

 $ git clone https://github.com/pjanouch/ponymap.git
 $ git submodule init
 $ git submodule update
 $ mkdir build
 $ cd build
 $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug -DWITH_LUA=NO
 $ make

To install the application, you can do either the usual:
 $ make install

Or you can try telling CMake to make a package for you.  For Debian it is:
 $ cpack -G DEB
 # dpkg -i ponymap-*.deb

Note that for versions of CMake before 2.8.9, you need to prefix cpack with
`fakeroot' or file ownership will end up wrong.

Having the program installed, simply run it with no arguments to retrieve
a usage text.  Have fun scanning.

Author's Notes
--------------
This was quite an interesting project to write and it has taught me a lot about
event loops.  It would be relatively simple to plug in libuv if more robustness
and portability is needed, though.

License
-------
`ponymap' is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which
is included within the package, or, at your option, you may relicense the work
under the MIT or the Modified BSD License, as listed at the following site:

http://www.gnu.org/licenses/license-list.html