zmap-mark-ii/src/ziterate.1.html

131 lines
5.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>ziterate(1) - ZMap IP permutation generation file</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#OPTIONS">OPTIONS</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>ziterate(1)</li>
<li class='tc'>ziterate</li>
<li class='tr'>ziterate(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>ziterate</code> - <span class="man-whatis">ZMap IP permutation generation file</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>ziterate [ -b &lt;blocklist&gt; ] [ -w &lt;allowlist&gt; ] [ OPTIONS... ]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p><em>ZIterate</em> is a network tool that will produce IPv4 addresses in a psuedorandom
order similar to how ZMap generates random addresses to be scanned.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<h3 id="BASIC-OPTIONS">BASIC OPTIONS</h3>
<dl>
<dt> <code>-p</code>, <code>--target-ports=port(s)</code></dt><dd><p> List of TCP/UDP ports and/or port ranges to scan. (e.g., 80,443,100-105).
Use '*' to scan all ports, including port 0. If no port is specified,
ziterate will output only IPs.</p></dd>
<dt> <code>-b</code>, <code>--blocklist-file=path</code></dt><dd><p> File of subnets to exclude, in CIDR notation, one-per line. It is
recommended you use this to exclude RFC 1918 addresses, multicast, IANA
reserved space, and other IANA special-purpose addresses. An example
blocklist file <strong>blocklist.conf</strong> for this purpose.</p></dd>
<dt><code>-w</code>, <code>--allowlist-file=name</code></dt><dd><p>File of subnets to include, in CIDR notation, one-per line. All other
subnets will be excluded.</p></dd>
<dt><code>-l</code>, <code>--log-file=name</code></dt><dd><p>File to log to.</p></dd>
<dt><code>--disable-syslog</code></dt><dd><p>Disable logging messages to syslog.</p></dd>
<dt><code>-v</code>, <code>--verbosity</code></dt><dd><p>Level of log detail (0-5, default=3)</p></dd>
<dt><code>--ignore-blocklist-errors</code></dt><dd><p>Ignore invalid entries in the blocklist. Default is false.</p></dd>
<dt><code>--seed=n</code></dt><dd><p>Seed used to select address permutation.</p></dd>
<dt><code>-n</code>, <code>--max-targets=n</code></dt><dd><p>Cap number of IPs to generate (as a number or a percentage of the address space)</p></dd>
</dl>
<h3 id="SHARDING">SHARDING</h3>
<dl>
<dt><code>--shards=n</code></dt><dd><p>Total number of shards.</p></dd>
<dt><code>--shard=n</code></dt><dd><p>Shard this scan is targeting. Zero indexed.</p></dd>
</dl>
<h3 id="ADDITIONAL-OPTIONS">ADDITIONAL OPTIONS</h3>
<dl>
<dt><code>-h</code>, <code>--help</code></dt><dd><p>Print help text and exit.</p></dd>
<dt><code>-V</code>, <code>--version</code></dt><dd><p>Print version and exit.</p></dd>
</dl>
<ol class='man-decor man-foot man foot'>
<li class='tl'>ZMap</li>
<li class='tc'>September 2023</li>
<li class='tr'>ziterate(1)</li>
</ol>
</div>
</body>
</html>