Provided by: tspc_2.1.1-8ubuntu2_i386 bug
 

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 spe‐
      cific 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.
 
      The different configuration options are:
 
      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.
 
      auth_method
        Authentication method: auth_method=any|digest-md5|anonymous|plain
 
        any is the preferred one. The most secure mechanism common to the
        client and the broker will be used.
 
        digest-md5 sends the username in clear, but not the password.
 
        plain sends both username and password in clear.
 
        anonymous sends no username and no password.
 
        Default: any
 
      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 chooses the source
        ip used when communicating with the server. This variable might look
        something like this:
 
        client_v4=a.b.c.d
 
        client_v4=auto
 
        Default: any
 
      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 sup‐
        ported modes and related services and for procedures to register your
        user name. The syntax is:
 
        userid=anonymous|user_name
 
        This variable is MANDATORY.
 
      passwd
        passwd=your_password
 
        Leave empty if userid=anonymous
 
      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 used. The port number is optional. Default
        TSP port is 3653.
 
        server=host[:port]
 
        server=broker.freenet6.net
 
        server=192.168.1.1:3653
 
        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 to the script file as environment variables. Normally the tem‐
        plate parameter is set when the package is built for the specific oper‐
        ating 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.
 
        template=linux
 
        This variable is MANDATORY.
 
      retry_delay
        The retry_delay option is used to set the number of seconds to sleep
        before retrying tunnel request to tsp server after request failure. It
        will retry until success. Set it to 0 if you don’t want to retry.
 
        Default: 30
 
      tunnel_mode
        Tunnel encapsulation mode:
 
        tunnel_mode can take the following values
 
        "v6v4"  request an IPv6 in IPv4 tunnel
 
        "v6udpv4" request an IPv6 in UDP in IPv4 tunnel (for clients behind a
        NAT) This type of tunnel is supported under Linux, FreeBSD and Windows.
 
        "v6anyv4"   Let the broker choose the tunnel mode appropriate for my
        client with v6anyv4, the broker will discover if the client is behind a
        NAT or not and will offer to the TSP client the correct tunnel mode.
 
        Default: v6anyv4
 
      if_tunnel_v6v4
        Logical interface name that will be used for the configured tunnel
        (IPv6 over IPv4). The syntax is:
 
        if_tunnel_v6v4=name
 
        Under *BSD: gif0
 
        Under Linux: sit0
 
        Under Windows: 2
 
        This variable is MANDATORY.
 
      if_tunnel_v6udpv4
        Logical interface name that will be used for v6udpv4 tunnels (IPv6 over
        UDPv4). The syntax is:
 
        if_tunnel_v6udpv4=name
 
        Under FreeBSD: tun1
 
        Under Linux: tun
 
        Under Windows: tunv6
 
      proxy_client
        proxy_client indicates that this client acts as a TSP proxy for some
        remote client tunnel endpoint machine. It is set to "yes" if the
        machine running the tsp client requests a tunnel for another machine.
        (e.g: cisco template).  This must be used with a static IPv4 address in
        client_v4 variable.
 
        NOTE: proxy_client=yes is incompatible with tunnel_mode=v6udpv4
 
        Default: no
 
      keepalive
        keepalive indicates that this client will send keepalives to keep the
        tunnel active and detect inactive tunnel (if no response from server).
        When a tunnel is detected inactive, the TSP client automatically recon‐
        nects to the server.  keepalive_interval is a suggestion from the TSP
        client to the broker for the interval between two keepalive messages.
        The broker may impose a different interval value to the client if the
        interval value is too low.
 
        keepalive=yes
 
        Default: yes
 
      keepalive_interval
 
        keepalive_interval=30
 
        Default: 30
 
      host_type
        In order to configure the machine as a router, a prefix must be
        requested and an interface must be specified.  The prefix will be
        advertised on that interface.
 
        host_type=host|router
 
        Default: host
 
      prefixlen
        prefixlen specifies the required prefix length for the TSP client net‐
        work. Valid values are 64 or 48. 64 is for one link. 48 is for a whole
        enterprise network (65K links).
 
        Default: 48
 
      if_prefix
        if_prefix is the name of the OS interface that will be configured with
        the first /64 of the received prefix from the broker and the router
        advertisement daemon is started to advertise that prefix on the if_pre‐
        fix interface.
 
      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 authorita‐
        tive NS servers for reverse DNS of the prefix, this line would be used
        in tspc.conf:
 
        dns_server=ns1.nowhere.net:ns2.nowhere.net
 
        Never use an IP address as a DNS server name.
 

FILES

      /install/dir/bin/tspc.conf
      /install/dir/bin/tspc.conf.sample
      tcpc(8),
 
      Hexago Web site: http://www.hexago.com