kdxcxs
/
n2n
mirror of https://github.com/ntop/n2n.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

reworked edge help text (#604)

pull/609/head
Logan oos Even 4 years ago
committed by GitHub
parent
39a71513f4
commit
f352c99255
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 183 additions and 81 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 256
      src/edge.c
  2. 2
      src/n2n.c

256
src/edge.c
View File

@ -117,98 +117,194 @@ static int scan_address (char * ip_addr, size_t addr_size,
/* *************************************************** */ /* *************************************************** */
static void help () { static void help (int level) {
printf("\n");
print_n2n_version(); print_n2n_version();
printf("edge <config file> (see edge.conf)\n" if(level == 0) /* short help */ {
"or\n"
); printf(" basic usage: edge <config file> (see edge.conf)\n"
printf("edge " "\n"
" or edge "
" -c <community name> "
"\n "
" -l <supernode host>:<port> "
"\n "
"[-a <tap IP address>] "
"\n "
#if defined(N2N_CAN_NAME_IFACE) #if defined(N2N_CAN_NAME_IFACE)
"-d <tap device> " "[-d <tap device name>] "
#endif /* #if defined(N2N_CAN_NAME_IFACE) */ "\n "
"-a [static:|dhcp:]<tap IP address>[/nn] " #endif
"-c <community> " "[-k <encryption key>] "
"[-k <encrypt key>]\n" "\n"
" " "\n -h shows a quick reference including all available options"
#ifndef WIN32 "\n --help gives a detailed parameter description"
"[-u <uid> -g <gid>]" "\n man files for n2n, edge, and superndode contain in-depth information"
#endif /* #ifndef WIN32 */ "\n\n");
#ifndef WIN32 } else if(level == 1) /* quick reference */ {
"[-f]"
#endif /* #ifndef WIN32 */ printf(" general usage: edge <config file> (see edge.conf)\n"
"\n"
" or edge "
" -c <community name>"
" -l <supernode host:port>"
"\n "
"[-p <local port>] "
#ifdef __linux__ #ifdef __linux__
"[-T <tos>]" "[-T <type of service>] "
#endif #endif
"[-n cidr:gateway] "
"[-m <MAC address>] "
"-l <supernode host:port>\n"
" "
"[-p <local port>] [-M <mtu>] "
#ifndef __APPLE__ #ifndef __APPLE__
"[-D] " "[-D] "
#endif #endif
"[-r] [-E] [-v] [-i <reg_interval>] [-L <reg_ttl>] [-t <mgmt port>] [-A[<cipher>]] [-H] [-z[<compression algo>]] " "[-S] "
"[-R <rule_str>] " "\n options for under- "
"[-h]\n\n"); "[-i <registration interval>]"
"[-L <registration ttl>]"
"\n lying connection "
"[-k <key>] "
"[-A<cipher>] "
"[-H] "
"[-z<compression>]"
"\n\n tap device and "
"[-a [static:|dhcp:]<tap IP address>[/<cidr suffix>]] "
"\n overlay network "
"[-m <tap MAC address>] "
#if defined(N2N_CAN_NAME_IFACE) #if defined(N2N_CAN_NAME_IFACE)
printf("-d <tap device> | tap device name\n"); "[-d <tap device name>] "
#endif #endif
"\n configuration "
printf("-a [mode:]<address>[/nn] | Interface address and optional subnet (cidr, default /24). For DHCP use '-r -a dhcp:0.0.0.0'\n"); "[-M <tap MTU>] "
printf("-c <community> | n2n community name the edge belongs to.\n"); "[-r] "
printf("-k <encrypt key> | Encryption key (ASCII) - also N2N_KEY=<encrypt key>.\n"); "[-E] "
printf("-l <supernode host:port> | Supernode IP:port\n"); "[-I <edge description>] "
printf("-i <reg_interval> | Registration interval, for NAT hole punching (default 20 seconds)\n"); "\n "
printf("-I <device description> | Annotate the edge's description (hint), identified in the manage port\n"); "[-R <rule string>] "
printf("-L <reg_ttl> | TTL for registration packet when UDP NAT hole punching through supernode (default 0 for not set )\n"); "\n\n local options "
printf("-p <local port> | Fixed local UDP port.\n");
#ifndef WIN32 #ifndef WIN32
printf("-u <UID> | User ID (numeric) to use when privileges are dropped.\n"); "[-f] "
printf("-g <GID> | Group ID (numeric) to use when privileges are dropped.\n"); #endif
#endif /* ifndef WIN32 */ "[-t <management port>] "
"[-v] "
"[-n <cidr:gateway>] "
#ifndef WIN32 #ifndef WIN32
printf("-f | Do not fork and run as a daemon; rather run in foreground.\n"); "\n "
#endif /* #ifndef WIN32 */ "[-u <numerical user id>]"
printf("-m <MAC address> | Fix MAC address for the TAP interface (otherwise it may be random)\n" "[-g <numerical group id>]"
" | eg. -m 01:02:03:04:05:06\n");
printf("-M <mtu> | Specify n2n MTU of edge interface (default %d).\n", DEFAULT_MTU);
#ifndef __APPLE__
printf("-D | Enable PMTU discovery. PMTU discovery can reduce fragmentation but\n"
" | causes connections stall when not properly supported.\n");
#endif #endif
printf("-r | Enable packet forwarding through n2n community.\n"); "\n\n environment "
printf("-A1 | Disable payload encryption. Do not use with key (defaulting to AES then).\n"); "N2N_KEY instead of [-k <key>]"
printf("-A2 ... -A5 or -A | Choose a cipher for payload encryption, requires a key: -A2 = Twofish,\n"); "\n variables "
printf(" | -A3 or -A (deprecated) = AES (default), " "\n "
"-A4 = ChaCha20, "
"-A5 = Speck-CTR.\n"); "\n meaning of the "
printf("-H | Enable full header encryption. Requires supernode with fixed community.\n"); #ifndef __APPLE__
printf("-z1 ... -z2 or -z | Enable compression for outgoing data packets: -z1 or -z = lzo1x" "[-D] enable PMTU discovery"
#ifdef N2N_HAVE_ZSTD
", -z2 = zstd"
#endif #endif
" (default=disabled).\n"); "\n flag options [-S] do not connect p2p, always use supernode"
printf("-E | Accept multicast MAC addresses (default=drop).\n"); "\n [-H] enable header encryption"
printf("-S | Do not connect P2P. Always use the supernode.\n"); "\n [-r] enable packet forwarding through n2n community"
#ifdef __linux__ "\n [-E] accept multicast MAC addresses"
printf("-T <tos> | TOS for packets (e.g. 0x48 for SSH like priority)\n"); #ifndef WIN32
"\n [-f] do not fork but run in foreground"
#endif #endif
printf("-n <cidr:gateway> | Route an IPv4 network via the gw. Use 0.0.0.0/0 for the default gw. Can be set multiple times.\n"); "\n [-v] make more verbose, repeat as required"
printf("-v | Make more verbose. Repeat as required.\n"); "\n "
printf("-R <rule_str> | Drop or accept packets by rules. Can be set multiple times. \n");
printf(" | Rule format: src_ip/len:[b_port,e_port],dst_ip/len:[s_port,e_port],TCP+/-,UDP+/-,ICMP+/- \n"); "\n -h shows this quick reference including all available options"
printf("-t <port> | Management UDP Port (for multiple edges on a machine).\n"); "\n --help gives a detailed parameter description"
"\n man files for n2n, edge, and superndode contain in-depth information"
"\n\n");
printf("\nEnvironment variables:\n"); } else /* long help */ {
printf(" N2N_KEY | Encryption key (ASCII). Not with -k.\n");
printf(" general usage: edge <config file> (see edge.conf)\n"
"\n"
" or edge -c <community name> -l <supernode host:port>\n"
" [further optional command line parameters]\n\n"
);
printf (" OPTIONS FOR THE UNDERLYING NETWORK CONNECTION\n");
printf (" ---------------------------------------------\n\n");
printf(" -c <community> | n2n community name the edge belongs to\n");
printf(" -l <host:port> | supernode ip address or name, and port\n");
printf(" -p <local port> | fixed local UDP port\n");
#ifdef __linux__
printf(" -T <tos> | TOS for packets, e.g. 0x48 for SSH like priority\n");
#endif
#ifndef __APPLE__
printf(" -D | enable PMTU discovery, it can reduce fragmentation but\n"
" | causes connections to stall if not properly supported\n");
#endif
printf(" -S | do not connect p2p, always use the supernode\n");
printf(" -i <reg_interval> | registration interval, for NAT hole punching (default\n"
" | 20 seconds)\n");
printf(" -L <reg_ttl> | TTL for registration packet for NAT hole punching through\n"
" | supernode (default 0 for not set)\n");
printf(" -k <key> | encryption key (ASCII) - also N2N_KEY=<key>\n");
printf(" -A1 | disable payload encryption, do not use with key, defaults\n"
" | to AES then\n");
printf(" -A2 ... -A5 or -A | choose a cipher for payload encryption, requires a key,\n"
" | -A2 = Twofish, -A3 or -A (deprecated) = AES (default),\n"
" | -A4 = ChaCha20, -A5 = Speck-CTR\n");
printf(" -H | use header encryption, supernode needs fixed community\n");
printf(" -z1 ... -z2 or -z | compress outgoing data packets, -z1 or -z lzo1x,\n"
" | "
#ifdef N2N_HAVE_ZSTD
"-z2 = zstd, "
#endif
"disabled by default\n");
printf ("\n");
printf (" TAP DEVICE AND OVERLAY NETWORK CONFIGURATION\n");
printf (" --------------------------------------------\n\n");
printf(" -a [mode]<ip>[/n] | interface address and optional CIDR subnet, default '/24',\n"
" | mode = [static|dhcp]:, for DHCP use '-r -a dhcp:0.0.0.0',\n"
" | edge draws IP address from supernode if no '-a ...' given\n");
printf(" -m <mac> | fixed MAC address for the TAP interface, e.g.\n"
" | '-m 10:20:30:40:50:60', random otherwise\n");
#if defined(N2N_CAN_NAME_IFACE)
printf(" -d <device> | TAP device name\n");
#endif
printf(" -M <mtu> | specify n2n MTU of TAP interface, default %d\n", DEFAULT_MTU);
printf(" -r | enable packet forwarding through n2n community\n");
printf(" -E | accept multicast MAC addresses, drop by default\n");
printf(" -I <description> | annotate the edge's description used for easier\n"
" | identification in management port output\n");
printf(" -R <rule> | drop or accept packets by rules, can be set multiple times\n");
printf(" | rule format: 'src_ip/n:[s_port,e_port],...\n"
" | |on same| ...dst_ip/n:[s_port,e_port],...\n"
" | | line | ...TCP+/-,UDP+/-,ICMP+/-'\n");
printf ("\n");
printf (" LOCAL OPTIONS\n");
printf (" -------------\n\n");
#ifndef WIN32
printf(" -f | do not fork and run as a daemon, rather run in foreground\n");
#endif
printf(" -t <port> | management UDP port, for multiple edges on a machine\n");
printf(" -v | make more verbose, repeat as required\n");
printf(" -n <cidr:gateway> | route an IPv4 network via the gateway, use 0.0.0.0/0 for\n"
" | the default gateway, can be set multiple times\n");
#ifndef WIN32
printf(" -u <UID> | numeric user ID to use when privileges are dropped\n");
printf(" -g <GID> | numeric group ID to use when privileges are dropped\n");
#endif
printf ("\n");
printf (" ENVIRONMENT VARIABLES\n");
printf (" ---------------------\n\n");
printf(" N2N_KEY | encryption key (ASCII), not with '-k ...'\n");
#ifdef WIN32 #ifdef WIN32
printf("\nAvailable TAP adapters:\n"); printf ("\n");
printf (" AVAILABLE TAP ADAPTERS\n");
printf (" ----------------------\n\n");
win_print_available_adapters(); win_print_available_adapters();
#endif #endif
printf ("\n"
"\n -h shows a quick reference including all available options"
"\n --help gives this detailed parameter description"
"\n man files for n2n, edge, and superndode contain in-depth information"
"\n\n");
}
exit(0); exit(0);
} }
@ -494,8 +590,13 @@ static int setOption (int optkey, char *optargument, n2n_tuntap_priv_config_t *e
break; break;
} }
case 'h': /* help */ { case 'h': /* quick reference */ {
help(); help(1);
break;
}
case '@': /* long help */ {
help(2);
break; break;
} }
@ -528,6 +629,7 @@ static int setOption (int optkey, char *optargument, n2n_tuntap_priv_config_t *e
/* *********************************************** */ /* *********************************************** */
static const struct option long_options[] = static const struct option long_options[] =
{ {
{ "community", required_argument, NULL, 'c' }, { "community", required_argument, NULL, 'c' },
@ -535,7 +637,7 @@ static const struct option long_options[] =
{ "tap-device", required_argument, NULL, 'd' }, { "tap-device", required_argument, NULL, 'd' },
{ "euid", required_argument, NULL, 'u' }, { "euid", required_argument, NULL, 'u' },
{ "egid", required_argument, NULL, 'g' }, { "egid", required_argument, NULL, 'g' },
{ "help" , no_argument, NULL, 'h' }, { "help" , no_argument, NULL, '@' }, /* special character '@' to identify long help case */
{ "verbose", no_argument, NULL, 'v' }, { "verbose", no_argument, NULL, 'v' },
{ NULL, 0, NULL, 0 } { NULL, 0, NULL, 0 }
}; };
@ -775,10 +877,10 @@ int main (int argc, char* argv[]) {
} }
if(rc < 0) if(rc < 0)
help(); help(0); /* short help */
if(edge_verify_conf(&conf) != 0) if(edge_verify_conf(&conf) != 0)
help(); help(0); /* short help */
traceEvent(TRACE_NORMAL, "Starting n2n edge %s %s", PACKAGE_VERSION, PACKAGE_BUILDDATE); traceEvent(TRACE_NORMAL, "Starting n2n edge %s %s", PACKAGE_VERSION, PACKAGE_BUILDDATE);

2
src/n2n.c
View File

@ -433,7 +433,7 @@ void print_n2n_version () {
printf("Welcome to n2n v.%s for %s\n" printf("Welcome to n2n v.%s for %s\n"
"Built on %s\n" "Built on %s\n"
"Copyright 2007-2020 - ntop.org and contributors\n\n", "Copyright 2007-2021 - ntop.org and contributors\n\n",
GIT_RELEASE, PACKAGE_OSNAME, PACKAGE_BUILDDATE); GIT_RELEASE, PACKAGE_OSNAME, PACKAGE_BUILDDATE);
} }

Write Preview
Loading…
Cancel
Save