JANET IPv6 Tunnel Broker

Help

TSP Client Help | Tunnel Creation Help | Account Creation Help

The information on this page is supplied by Hexago.

TSP Client Help

The Tunnel Setup Protocol (TSP) is a control protocol to establish and maintain static tunnels. The TSP Client is used on the host computer to get the tunnel information from the Migration Broker. Once the information is received, it creates a static tunnel on the host operating system.

The TSP client source code is licensed under the GPL. A commercial license is also available.

For a complete description of the TSP client, see the TSP Client Guide.

Executing the TSP Client

The TSP Client is executed by running or typing the command tspc, which stands for TSP Client program. If your machine is behind a NAT device, a UDP in IPv4 tunnel is negotiated, and the TSP Client program remains in the background to keep the tunnel up. On non-Windows architectures, the program runs in the background. When an IPv6 in IPv4 tunnel is negotiated, the TSP Client program exits after setting up the tunnel.

The tspc program has some arguments to the command line, they are described below:

Argument	Description
-v -vv -vvv	Sets the verbose level and type of debugging information sent to the screen. -vvv gives the most debugging information, such as the TSP XML content.
-i interface_name	Sets the interface name for IPv6 in IPv4 encapsulation.
-u interface_name	Sets the interface name for IPv6 in UDP IPv4 encapsulation.
-s interface_name	Sets the interface name to configure router advertisements of the prefix when the client is a router and has received a prefix.
-f config_filename	Sets the configuration file.
-r number_of_seconds	Sets the retry interval when the TSP connection to the broker is not successful.
-h	Shows the version and list of options.

TSP error codes and troubleshooting

No success: Authentication failed
You do not have the correct userid/password. Make sure the password was copied correctly from the account registration email, with the same lowercase/uppercase. The password has 10 characters and must not be followed by a space.

No common authentication mechanism found
Error is 7: AUTHENTICATION_ERROR
You are trying to connect anonymously on a broker offering authenticated access only. If you are using anonymous mode, make sure the "server" parameter in tspc.conf is set to "anon.freenet6.net". If you are using the authenticated mode, make sure that the server is set to "broker.freenet6.net" and that your account information is configured properly.

310 Server side error
Please verify the status of the Freenet6 servers on the status page. Report this error to the administrator.

506 IPv4 prefix already used for existing tunnel
This happens when requesting a tunnel in anonymous mode after requesting a tunnel in the authenticated mode from the same IPv4 address. Use the authenticated mode.

writing to routing socket: No such process
delete net default: not in table
This is not an error. The TSP Client is trying to remove previously set routes.

General Failure of TAP device

Fri Apr 16 14:07:29 2004 0: CreateFile failed on TAP device: \\.\{192E2338-BFD9-4A95-963A-F2BBD7710008}.tap: General failure (ERROR_GEN_FAILURE) (errno=31)
The TSP Client is already running. Find the open window in which the TSP Client is running and stop it by closing the window.

Socket error

Unable to establish connection with broker
All transports failed, quitting
Error is 2: SOCKET_ERROR
TSP session done
No IPv4 address is available. Verify that an IPv4 address is configured or has been obtained through DHCP using the "ipconfig" command. If the IPv4 address is configured, IPv4 routing to the broker might not be available. Try pinging the IPv4 address of the broker.

Unable to reach the broker

Connecting to server with reliable udp
Using TSP protocol version 2.0.0
Establishing connection with tunnel broker...
Unable to establish connection with broker:3653
If there is an IPv4 firewall between the host and the broker, verify it allows port 3653 UDP and TCP to go through.

TSP Client configuration

The TSP client is configured using a file called tspc.conf. The configuration file is a text file with comments identified by the "#" character. Each statement has the format variable = value, as in rc.conf files in FreeBSD. The file statements are listed below. Many are optional.

Parameter	Default value	Possible values	Description
tsp_version	2.0.0	1.0.0 2.0.0	The highest version of the TSP protocol the TSP client supports. The tunnel broker adapts to the protocol version supported by the TSP client. The v6udpv4 and v6anyv4 tunnel encapsulation modes as well as the keepalive mechanism are available in version 2 and higher. The v2 TSP client also adapts to v1.0 brokers. This value must not be changed by the user
tsp_dir	Current working directory	string	The TSP client directory which contains the template subdirectory for the shell scripts.
auth_method	any	any digest-md5 plain anonymous	The authentication used for the TSP session. Digest-md5 is the most secure, where the passwords are not sent. Plain sends the userid and password. Anonymous sends no userid or password. With any, the TSP client uses the most secure mode based on its capabilities and the broker authentication capabilities. Any is recommended.
client_v4	auto	auto IPv4 address	The IPv4 address used by the TSP client as its tunnel endpoint source address. When auto is used, the TSP client uses the first IPv4 address given by the operating system.
if_source		string	The interface name on the operating system of the TSP client where the IPv4 address is taken for the IPv4 tunnel endpoint source address.
userid	anonymous	anonymous string	The user identification string.
passwd		string	The password for the userid.
template		checktunnel cisco darwin freebsd linux netbsd openbsd solaris windows	The script file used to create the tunnel. The value is the name of the script file (in the template directory) that will be called by the TSP client at the end of the TSP session, to create the tunnel. When compiling the TSP client, the template variable is filled in with the correct value for the operating system the client was compiled on.
server	broker.freenet6.net	[i]ip_address hostname ip_address:port hostname:port[/i]	The IP address or hostname (full domain name when appropriate) of the broker. A TSP port number can be specified.
retry_delay	0	number	When a TSP connection fails, the number of seconds to wse DNS delegation of the prefix.

Web-Based Tunnel Creation Help

The web interface is used to create a script from the information gathered on a form. Most of the information is mandatory, except the prefix fields. A short explanation is given below for each of the fields.

• IPv4 Address
  IPv4 address of the client computer. This field is set by default to auto and need to be changed only when the address cannot be found automatically. This happens in some very specific cases, the first being when the form is not executed on the tunnel endpoint host (for example when a Cisco router is the endpoint). A second case is for a computer having more than one interface (multihomed) and the detected interface is not the correct one. The last case would be for a single user behind a NAT redirecting protocol 41 to the host. In that case, the public address of the NAT must be used.
• Username
  Default value anonymous. Using the default will create an anonymous tunnel (not available on this broker), for which the IPv4 is used to identify the user. If the IPv4 address changes, the IPv6 address would change as well. To keep a permanent IPv6 address and prefix, use an username existing on the broker or create a new one.
• Prefix (optional)
  Request a /48 as an IPv6 prefix.
• Prefix Interface (optional)
  Name of the interface on which the router advertisements will be sent. Usually, this is an interface facing the internal network. For example, it may be eth1 or vr0 in a Linux or BSD environment.
• Operating System
  Operating system of the tunnel endpoint host. This is used to determine which type of script is built.
• Tunnel Interface
  Interface name of the tunnel. It is automatically choose according to the operating system, but may be changed for a specific name. This is useful when defining a named interface or when more than one tunnel is configured on the host. For example, the tunnel interface name would default to sit0 on Linux or tun1 on a FreeBSD host.

Account Creation Help

The web interface provides a way to create automatically a new user on the Migration Broker. A confirmation email containing a generated password is sent to the specified email address.

• Username
  Requested user identification string. It must be less than 64 characters long and be composed of alphanumeric characters only. Letters, both lowercase and uppercase, number and dashes (-) are allowed.
• Email address
  This must be a valid email address. The account creation confirmation and the password will be sent to that address.