TSPC.CONF(5)

NAME
tspc - tspc configuration file

SYNOPSIS
tspc.conf

DESCRIPTION
The tspc(8) is a client program which enables a host to query a tunnel server to establish a tunnel between the host and the server. The tspc configuration file contains information that is read by tspc(8) for specific information about the server and the tunnel to be established.

This file is designed to be human readable and may be edited by any text editor. The file consists of tokens and values, which are separated by the (equal sign). Each Token-Value pair must be on their own line. Values may span more than one line with the help of the start block identifier. The configuration file processor will add all following lines to the token until it finds a single dot "." on the first column of a line (like DATA in SMTP). Here's a usage example of the start block identifier:

multiline=<<
This is the first line, and it will not include '<<' in the line above
This is the second line
aa=bb
The line before will be included as well
This is the last line.
. This is the terminator and will not be included

In this example, the token multiline will contain all lines (including carriage return and line feed) that are between "<<" and ".".

Blank lines are ignored and lines that start with the pound sign are considered as comments.

In this manual square brackets are used to show optional arguments and the vertical line to show mutually exclusive arguments.

The different configuration options are:

tsp_version
    The current version of tspc. The current installation is at version 1.0.0. This variable might look something like this:

    tsp_version=1.0.0

    This variable is MANDATORY.

tsp_dir
    The current directory where tspc programs and templates are located. This variable might look something like this:

    tsp_dir=/usr/local/tsp

    This variable is MANDATORY.

client_v4
    IPv4 address of the client tunnel endpoint. If the host has more than one IPv4 address, it is recommended to manually set this variable with its local IPv4 address as value. If set to auto, it will use the source ip used when communicating with the server. This variable might look something like this:

    client_v4=[nnn].[nnn].[nnn].[nnn]

    client_v4=auto

    Look at the server policies for a list of allowed addresses.

    This variable is MANDATORY.

server
    Name and port number of the tunnel server. This variable is used to specify the TSP server to be queried. An IPv4 address or FQDN (Fully Qualify Domain Name) can be use. The port number is optional. By default, tspc uses 4343 as port value. It is recommended that you never specify the port number as it is not yet registered with the IANA. The syntax is:

    server=host[:port]

    server=tsps1.freenet6.net

    server=tsps1.freenet6.net:4343

    server=192.168.1.1

    server=192.168.1.1:4343

    This variable is MANDATORY

userid
    The userid is used for authentication to the server. By default tspc uses anonymous as the userid. The TSP protocol allows both anonymous and authenticated tunnel setup. Look at the server policies for supported modes and related services and for procedures to register your user name. The syntax is:

    userid=anonymous|user_name

    This variable is MANDATORY.

if_tunnel
    Logical interface name that will be used for the configured tunnel (IPv6 over IPv4). The syntax is:

    if_tunnel=interface-name

    Under FreeBSD

    if_tunnel=gif0

    Under Linux

    if_tunnel=sit0

    This variable is MANDATORY.

template
    This parameter is used to tell which configuration template must be used to configure the tunnel. The configuration template is a script file, located in the template directory of the package, that contains the system commands to be executed for tunnel setup. The parameters are passed the the script file as environment variables. Normally the template parameter is set when the package is built for the specific operating system. Look in the template directory to see which ones are available. The template name must be the file name without the .sh or .bat suffix.

    For example, to use the checktunnel.sh template, which only displays the values passed to the template, you must specify:

    template=checktunnel

    For information on how to create your own template see the template-how-to.txt file.

    This variable is MANDATORY.

dns_server
    This parameter is used to specify the DNS servers that should be used for reverse DNS delagation of the prefix allocated. Syntax is :

    dns_server=fqdn[:fqdn]...

    For example, to use ns1.nowhere.net and ns1.nowhere.net as authoritative NS servers for reverse DNS of the prefix, this line would be used in tspc.con :

    dns_server=ns1.nowhere.net:ns2.nowhere.net

    Never use an IP address as a DNS server name.

    This variable is OPTIONAL.

FILES
/install/dir/bin/tspc.conf
    The file tspc.conf resides in /install/dir/bin.

SEE ALSO
tcpc(8), Freenet6 TSP's Web site: http://tsp.freenet6.net