zmap-mark-ii/src/ziterate.c

247 lines
6.5 KiB
C

/*
* ZMap Copyright 2023 Regents of the University of Michigan
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*/
/*
* ZIterate is a simple utility that will iteratate over the IPv4
* space in a pseudo-random fashion, utilizing the sharding capabilities * of
* ZMap.
*/
#define _GNU_SOURCE
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include <assert.h>
#include <unistd.h>
#include "../lib/includes.h"
#include "../lib/blocklist.h"
#include "../lib/logger.h"
#include "../lib/random.h"
#include "../lib/util.h"
#include "../lib/xalloc.h"
#include "iterator.h"
#include "ports.h"
#include "state.h"
#include "validate.h"
#include "zitopt.h"
struct zit_conf {
char *blocklist_filename;
char *allowlist_filename;
char **destination_cidrs;
int destination_cidrs_len;
char *log_filename;
int check_duplicates;
int ignore_errors;
int verbosity;
int disable_syslog;
// sharding options
uint16_t shard_num;
uint16_t total_shards;
uint64_t seed;
aesrand_t *aes;
uint32_t max_hosts;
};
#define SET_BOOL(DST, ARG) \
{ \
if (args.ARG##_given) { \
(DST) = 1; \
}; \
}
int main(int argc, char **argv)
{
struct zit_conf conf;
memset(&conf, 0, sizeof(struct zit_conf));
conf.verbosity = 3;
conf.ignore_errors = 0;
struct gengetopt_args_info args;
struct cmdline_parser_params *params;
params = cmdline_parser_params_create();
assert(params);
params->initialize = 1;
params->override = 0;
params->check_required = 0;
if (cmdline_parser_ext(argc, argv, &args, params) != 0) {
exit(EXIT_SUCCESS);
}
// Handle help text and version
if (args.help_given) {
cmdline_parser_print_help();
exit(EXIT_SUCCESS);
}
if (args.version_given) {
cmdline_parser_print_version();
exit(EXIT_SUCCESS);
}
// Set the log file and metadata file
if (args.log_file_given) {
conf.log_filename = strdup(args.log_file_arg);
}
if (args.verbosity_given) {
conf.verbosity = args.verbosity_arg;
}
// Read the boolean flags
SET_BOOL(conf.ignore_errors, ignore_blocklist_errors);
SET_BOOL(conf.disable_syslog, disable_syslog);
// initialize logging
FILE *logfile = stderr;
if (conf.log_filename) {
logfile = fopen(conf.log_filename, "w");
if (!logfile) {
fprintf(
stderr,
"FATAL: unable to open specified logfile (%s)\n",
conf.log_filename);
exit(1);
}
}
if (log_init(logfile, conf.verbosity, !conf.disable_syslog,
"ziterate")) {
fprintf(stderr, "FATAL: unable able to initialize logging\n");
exit(1);
}
// Blocklist and allowlist
if (args.blocklist_file_given) {
conf.blocklist_filename = strdup(args.blocklist_file_arg);
}
if (args.allowlist_file_given) {
conf.allowlist_filename = strdup(args.allowlist_file_arg);
}
conf.destination_cidrs = args.inputs;
conf.destination_cidrs_len = args.inputs_num;
// max targets
if (args.max_targets_given) {
conf.max_hosts = parse_max_hosts(args.max_targets_arg);
}
// sanity check blocklist file
if (conf.blocklist_filename) {
log_debug("ziterate", "blocklist file at %s to be used",
conf.blocklist_filename);
} else {
log_debug("ziterate", "no blocklist file specified");
}
if (conf.blocklist_filename &&
access(conf.blocklist_filename, R_OK) == -1) {
log_fatal("ziterate",
"unable to read specified blocklist file (%s)",
conf.blocklist_filename);
}
// sanity check allowlist file
if (conf.allowlist_filename) {
log_debug("ziterate", "allowlist file at %s to be used",
conf.allowlist_filename);
} else {
log_debug("ziterate", "no allowlist file specified");
}
if (conf.allowlist_filename &&
access(conf.allowlist_filename, R_OK) == -1) {
log_fatal("ziterate",
"unable to read specified allowlist file (%s)",
conf.allowlist_filename);
}
// parse blocklist and allowlist
if (blocklist_init(conf.allowlist_filename, conf.blocklist_filename,
conf.destination_cidrs, conf.destination_cidrs_len,
NULL, 0, conf.ignore_errors)) {
log_fatal("ziterate",
"unable to initialize blocklist / allowlist");
}
// Set up sharding
conf.shard_num = 0;
conf.total_shards = 1;
if ((args.shard_given || args.shards_given) && !args.seed_given) {
log_fatal("ziterate",
"Need to specify seed if sharding a scan");
}
if (args.shard_given ^ args.shards_given) {
log_fatal(
"ziterate",
"Need to specify both shard number and total number of shards");
}
if (args.shard_given) {
enforce_range("shard", args.shard_arg, 0, 65534);
conf.shard_num = args.shard_arg;
}
if (args.shards_given) {
enforce_range("shards", args.shards_arg, 1, 65535);
conf.total_shards = args.shards_arg;
}
if (conf.shard_num >= conf.total_shards) {
log_fatal("ziterate",
"With %hhu total shards, shard number (%hhu)"
" must be in range [0, %hhu)",
conf.total_shards, conf.shard_num, conf.total_shards);
}
log_debug(
"ziterate",
"Initializing sharding (%d shards, shard number %d, seed %llu)",
conf.total_shards, conf.shard_num, conf.seed);
// Check for a random seed
if (args.seed_given) {
conf.seed = args.seed_arg;
} else {
if (!random_bytes(&conf.seed, sizeof(uint64_t))) {
log_fatal("ziterate", "unable to generate random bytes "
"needed for seed");
}
}
zconf.aes = aesrand_init_from_seed(conf.seed);
zconf.ports = xmalloc(sizeof(struct port_conf));
if (args.target_ports_given) {
parse_ports(args.target_ports_arg, zconf.ports);
} else {
zconf.ports->port_count = 1;
}
uint64_t num_addrs = blocklist_count_allowed();
if (zconf.list_of_ips_filename) {
log_debug("send",
"forcing max group size for compatibility with -I");
num_addrs = 0xFFFFFFFF;
}
iterator_t *it = iterator_init(1, conf.shard_num, conf.total_shards,
num_addrs, zconf.ports->port_count);
shard_t *shard = get_shard(it, 0);
target_t current = shard_get_cur_target(shard);
for (uint32_t count = 0; current.ip; ++count) {
if (conf.max_hosts && count >= conf.max_hosts) {
break;
}
struct in_addr next_ip;
next_ip.s_addr = current.ip;
if (current.port) {
printf("%s,%u\n", inet_ntoa(next_ip), current.port);
} else {
printf("%s\n", inet_ntoa(next_ip));
}
current = shard_get_next_target(shard);
}
return EXIT_SUCCESS;
}