summaryrefslogtreecommitdiff
path: root/README
blob: efc6d2e03e38c5c61c18ba5553e5951fb1a7803f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
ponymap
=======

`ponymap' is an experimental network scanner, not even in the alpha stage yet.

Replacing nmap is not the goal, even though it would be rather very nice to
have a non-copyleft licensed network scanner.

The ultimate purpose of this scanner is bruteforcing hosts and ports in search
of running services of a kind.  It should be very simple and straight-forward
to write your own service detection plugins.

Building and Running
--------------------
Build dependencies: openssl, clang, pkg-config, GNU make, Jansson

If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work
just as good.  But there's no CMake support yet, so I force it in the Makefile.

 $ git clone https://github.com/pjanouch/ponymap.git
 $ make

That is all, no installation is required, or supported for that matter.

First you might want to generate a configuration file:
 $ ./ponymap --write-default-config

After making any necessary edits to the file (there are comments to aid you in
doing that), simply run the appropriate program with no arguments to retrieve
a usage text.

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