ANYTUN-CONFIG(8)

πŸ’– ANYTUN-CONFIG(8) πŸ’–

okay bestie, gather round, because we're talking about anytun-config β€” the little anycast tunneling config utility from the anytun family, manual page anytun-config(8). she's not flashy, she's not loud, she just ✨writes routing and connection table entries✨ that anytun-controld can read. that's the whole job. and she does it flawlessly. periodt.


🌸 NAME 🌸

anytun-config β€” anycast tunneling configuration utility


πŸŽ€ SYNOPSIS πŸŽ€

anytun-config
  [ -h|--help ]
  [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]]
  [ -U|--debug ]
  [ -r|--remote-host <hostname|ip> ]
  [ -o|--remote-port <port> ]
  [ -4|--ipv4-only ]
  [ -6|--ipv6-only ]
  [ -R|--route <net>/<prefix length> ]
  [ -m|--mux <mux-id> ]
  [ -w|--window-size <window size> ]
  [ -k|--kd-prf <kd-prf type> ]
  [ -e|--role <role> ]
  [ -E|--passphrase <pass phrase> ]
  [ -K|--key <master key> ]
  [ -A|--salt <master salt> ]

πŸ¦‹ DESCRIPTION πŸ¦‹

so like, anytun-config writes routing/connection table entries. that's it. that's the vibe. those entries get read by anytun-controld later, so think of this as the girl who writes the notes that the other girl actually delivers. πŸ’…


✨ OPTIONS ✨

  • -L, --log <target>:<level>[,<param1>[,<param2>[..]]] β€” adds a log target to the logging system. you can call this multiple times to log to several different targets at once, because why choose one. every target has its own log level, which is a number between 0 and 5 β€” where 0 means logging is disabled and 5 means debug messages are enabled. the file target can be used more than once with different levels. if you don't give a target at the command line, a single target gets added with the config syslog:3,anytun-config,daemon. the supported targets are:
    • syslog β€” log to the syslog daemon, parameters <level>[,<logname>[,<facility>]]
    • file β€” log to file, parameters <level>[,<path>]
    • stdout β€” log to standard output, parameters <level>
    • stderr β€” log to standard error, parameters <level>
  • -U, --debug β€” this one tells Anytun to run in debug mode. it implicitly turns on -D (don't daemonize) and adds a log target configured as stdout:5 (logging at maximum level). in future releases there might be additional output when you supply this option, so stay tuned ig πŸ‘€
  • -r, --remote-host <hostname|ip> β€” specifies the remote tunnel endpoint. for anycast tunnel endpoints you have to use the anycast IP address, no cap. if you don't specify an address, it gets automatically determined after the first data packet arrives. she'll figure it out herself, main character energy. πŸ’…
  • -o, --remote-port <port> β€” the UDP port used for payload data by the remote host (specified with -p on the remote host, jsyk). if you don't specify a port, it's automatically determined after receiving the first data packet. same vibe as above.
  • -4, --ipv4-only β€” resolve to IPv4 addresses only. the default is to resolve both IPv4 and IPv6 addresses.
  • -6, --ipv6-only β€” resolve to IPv6 addresses only. the default is to resolve both IPv4 and IPv6 addresses.
  • -R, --route <net>/<prefix length> β€” add a route to the connection. can be invoked several times, stack 'em up bestie. 🌈
  • -m, --mux <mux-id> β€” the multiplex id to use. default: 0
  • -w, --window-size <window size> β€” sequence window size. so here's the tea: sometimes packets arrive out of order on the receiver side. this option defines the size of a list of received packets' sequence numbers. if, according to this list, a received packet has already been received before, or was transmitted in the past and therefore isn't in the list anymore, that gets interpreted as a replay attack and the packet is dropped. a value of 0 deactivates this list and, as a consequence, also the replay protection that comes from filtering packets by their sequence number. by default the sequence window is disabled, so a window size of 0 is used.
  • -k, --kd-prf <kd-prf type> β€” key derivation pseudo random function. this is the pseudo random function used for calculating the session keys and session salt. possible values:
    • null β€” no random function, keys and salt are set to 0..00
    • aes-ctr β€” AES in counter mode with 128 Bits, the default value
    • aes-ctr-128 β€” AES in counter mode with 128 Bits
    • aes-ctr-192 β€” AES in counter mode with 192 Bits
    • aes-ctr-256 β€” AES in counter mode with 256 Bits
  • -e, --role <role> β€” SATP uses different session keys for inbound and outbound traffic, and the role parameter decides which keys get used for outbound or inbound packets. on both sides of a vpn connection you have to use different roles, no exceptions. possible values are left and right. you may also use alice or server as a replacement for left, and bob or client as a replacement for right. by default left is used.
  • -E, --passphrase <pass phrase> β€” this passphrase is used to generate the master key and master salt. for the master key, the last n bits of the SHA256 digest of the passphrase are used (where n is the length of the master key in bits). the master salt gets generated with the SHA1 digest. you may force a specific key and/or salt by using --key and --salt. 🫢
  • -K, --key <master key> β€” master key to use for key derivation. master key in hexadecimal notation, e.g. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits).
  • -A, --salt <master salt> β€” master salt to use for key derivation. master salt in hexadecimal notation, e.g. 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes).
also -h, --help shows up in the synopsis, bestie. the page lists it there but gives it no description of its own, so that's all we've got on it. πŸ™ˆ

πŸ“ EXAMPLES πŸ“

Add a client with Connection ID (Mux) 12 and add 2 Routes to this client:

# anytun-config -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \
                -R 192.0.2.0/24 -R 192.168.1.1/32 -e server >> routingtable

ate. πŸ”₯


πŸ’€ BUGS πŸ’€

most likely there are some bugs in Anytun, ngl. if you find one, please let the developers know at satp@anytun.org. of course, patches are preferred β€” send the patch, be the hero. πŸ‘‘


πŸ‘‘ SEE ALSO πŸ‘‘

anytun(8), anytun-controld(8), anytun-showtables(8)


πŸ’œ AUTHORS πŸ’œ

Othmar Gsenger <otti@anytun.org> Erwin Nindl <nine@anytun.org> Christian Pointner <equinox@anytun.org>


🌈 RESOURCES 🌈

Main web site: http://www.anytun.org/


πŸŽ€ COPYING πŸŽ€

Copyright (C) 2007-2014 Markus GrΓΌneis, Othmar Gsenger, Erwin Nindl and Christian Pointner. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.


and that's the whole page, bestie 🫢 this was the ANYTUN-CONFIG(8) manual, dated 01/06/2020, and it lives in the ANYTUN-CONFIG(8) section of your man pages forever and ever. go write some routing table entries, you absolute icon. πŸ’–βœ¨

πŸ“¦ where this page comes from