1GOGOC.CONF(5) BSD File Formats Manual GOGOC.CONF(5)
2
4 gogoc.conf — gogoCLIENT Configuration File
5
7 The gogoCLIENT gogoc(8) is a client program which enables a host to query
8 a tunnel server to establish a tunnel between the host and the server
9 using the TSP protocol. The gogoc configuration file contains information
10 that is read by gogoc(8) for specific details regarding the server and
11 the tunnel to be established.
12
14 This file is designed to be human readable and may be edited with any
15 text editor. The file consists of tokens and values, which are separated
16 by the equal sign. Each "Token=Value" pair must be on their own line.
17 The different configuration directives(or options) are grouped in the
19 following sections:
20
22 userid The userid is used for authentication with the server. The TSP
23 protocol supports both anonymous and authenticated tunnels.
24 Refer to the server policies for supported modes and related
25 Services, as well as for how to register your user name. The
26 syntax to use is given below:
27 userid=user_name
29 This variable is MANDATORY if you are using an authenticated
31 tunnel. Leave empty if you are using anonymous access.
32 passwd passwd=your_password
34 Leave empty if you are using anonymous access.
36 server Name and port number of the tunnel server. This variable is
38 used to specify the gogoSERVER to be queried. An IPv4 or IPv6
39 address or FQDN (Fully Qualified Domain Name) can be used. The
40 port number is optional. The default TSP port is 3653.
41 server=host[:port]
43 server=broker.freenet6.net
45 server=192.168.1.1:3653
47 This variable is MANDATORY.
49 auth_method
51 The tunnel negotiation authentication method. If you are using
52 anonymous access, enter `anonymous' here. Otherwise, choose one
53 of the following authentication methods: any|digest-md5|pass‐
54 dss-3des-1|plain
55 anonymous sends no username or password.
57 any is the preferred one. The most secure mechanism common to
59 the client and the broker will be used.
60 digest-md5 sends the username in clear text, but not the pass‐
62 word.
63 passdss-3des-1 sends the username in clear text, but not the
65 password.
66 plain sends both username and password in clear text.
68 Default: any
70
72 host_type
73 Set the value of this directive to `router' to configure the
74 machine as a router. By doing so, you will be given a prefix to
75 advertise on a local interface.
76 host_type=host|router
78 Default: host
80 prefixlen
82 prefixlen specifies the required prefix length for the gogo‐
83 CLIENT network. Valid values range from 0 to 64; however, val‐
84 ues are usually between 48 and 64.
85 Default: 64
87 if_prefix
89 if_prefix is the name of the OS interface that will be config‐
90 ured with the first /64 of the received prefix from the broker.
91 The router advertisement daemon is started to advertise this
92 prefix on the if_prefix interface.
93 dns_server
95 This directive specifies the DNS servers that should be used
96 for reverse DNS delegation of the prefix allocated.
97 Syntax is:
99 dns_server=fqdn[:fqdn]...
101 For example, to set ns1.example.net and ns2.example.net as
103 authoritative DNS servers for reverse DNS of the prefix, this
104 line would be used in gogoc.conf:
105 dns_server=ns1.example.net:ns2.example.net
107 NOTE: Never use an IP address as a DNS server name.
109
111 tunnel_mode
112 The tunnel encapsulation mode. It can take the following val‐
113 ues:
114 v6anyv4 This mode lets the broker determine whether or not the
116 gogoCLIENT is behind a NAT. The broker will then inform the
117 gogoCLIENT which tunnel mode to use: v6v4 or v6udpv4.
118 v6v4 Explicitly requests an IPv6-in-IPv4 tunnel.
120 v6udpv4 Explicitly requests an IPv6-in-UDP-IPv4 tunnel (for
122 clients behind a NAT). This type of tunnel is supported under
123 Linux, FreeBSD and Windows.
124 v4v6 Explicitly requests an IPv4-in-IPv6 tunnel (for dual-stack
126 transition mechanism).
127 Default: v6anyv4
129 auto_retry_connect
131 This directive is used when a keepalive timeout or similar
132 error occurred, resulting in a loss of connectivity with the
133 tunnel endpoint. If you wish the gogoCLIENT to re-establish
134 connectivity with tunnel endpoint when such an error occurs,
135 set this variable to `yes'.
136 auto_retry_connect=yes|no
138 Default: yes
140 retry_delay
142 The retry_delay directive is used to set the number of seconds
143 to sleep before reattempting to establish a tunnel with the
144 gogoSERVER. It will retry until it succeeds, unless you have
145 set the auto_retry_connect variable to `no'.
146 Default: 30
148 keepalive
150 keepalive indicates that this client will send keepalive pack‐
151 ets to maintain tunnel activity and detect inactive tunnels (if
152 no response is received from the server). This directive must
153 be set to `yes' when using v6udpv4 tunnels to keep the NAT
154 entry active.
155 keepalive=yes|no
157 Default: yes
159 keepalive_interval
161 The keepalive_interval is a suggestion from the gogoCLIENT to
162 the broker for the interval to wait between sending keepalive
163 messages. The broker may impose a different interval value to
164 the client if the suggested value is too low.
165 keepalive_interval=30
167 Default: 30
169 if_tunnel_v6v4
171 The logical interface name that will be used for the configured
172 tunnel (IPv6 over IPv4). The syntax is:
173 if_tunnel_v6v4=name
175 Under *BSD: gif0
177 Under Linux: sit0
179 Under Windows: 2
181 This variable is MANDATORY.
183 if_tunnel_v6udpv4
185 The logical interface name that will be used for v6udpv4 tun‐
186 nels (IPv6 over UDPv4). The syntax is:
187 if_tunnel_v6udpv4=name
189 Under FreeBSD: tun1
191 Under Linux: tun
193 Under Windows: tunv6
195 if_tunnel_v4v6
197 The logical interface name that will be used for v4v6 tunnels
198 (IPv4 over IPv6). The syntax is:
199 if_tunnel_v4v6=name
201 gogoc_dir
203 The directory where the gogoCLIENT program is installed. Bina‐
204 ries, manual pages, this configuration file and templates are
205 all located in this directory. This variable may resemble the
206 following:
207 gogoc_dir=/usr/local/gogoc
209 This variable is MANDATORY.
211 template This directive indicates which configuration template must be
213 used when configuring the tunnel. The configuration template is
214 a script file, located in the template directory of the pack‐
215 age, that contains the system commands to be executed for tun‐
216 nel setup. The directives are passed to the script file as
217 environment variables. The template directive is normally set
218 when the package is built for the specific operating system.
219 View the contents of the template directory to learn which ones
220 are available. The template name must be the file name without
221 the .sh or .cmd suffix.
222 template=linux
224 This variable is MANDATORY.
226 proxy_client
228 The proxy_client directive indicates that this client acts as a
229 TSP proxy for a remote client tunnel endpoint machine. It is
230 set to `yes' if the machine running the gogoCLIENT requests a
231 tunnel for another machine. (e.g.: cisco template). This
232 directive must be used in conjunction with a static IPv4
233 address assigned to the client_v4 variable.
234 NOTE: proxy_client=yes is incompatible with tunnel_mode=v6udpv4
236 Default: no
238 client_v4
240 The IPv4 address of the client tunnel endpoint. If the host has
241 more than one IPv4 address, it is recommended to manually set
242 this variable with its local IPv4 address as the value. If set
243 to auto, it chooses the source IP address used when communicat‐
244 ing with the server. This variable may resemble the following:
245 client_v4=auto|a.b.c.d
247 Default: auto
249 client_v6
251 This directive is similar te client_v4, except that this one is
252 for users that have enabled IPv4 in IPv6 encapsulation (i.e.,
253 DSTM).
254 client_v6=auto|XX:XX::XX:XX
256 Default: auto
258 broker_list
260 The 'broker_list' directive specifies the name of the file
261 where the broker list received during broker redirection will
262 be saved.
263 Default: tsp-broker-list.txt
265 last_server
267 The 'last_server' directive specifies the name of the file
268 where the address of the last broker to which a connection was
269 successfully established will be saved.
270 Default: tsp-last-server.txt
272 always_use_same_server
274 The value of the 'always_use_same_server' directive determines
275 whether the client should always try to connect to the broker
276 specified by the 'last_server' directive (if any).
277 Default: no
279
281 log_file This directive is used to specify the quantity of information
282 that will be logged to the file. Values range inclusively from
283 0 (no logging) to 3 (full logging).
284 Default: 0
286 log_stderr
288 This directive is used to specify the quantity of information
289 that will be logged to the standard error device. Values range
290 inclusively from 0 (no logging) to 3 (full logging).
291 Default: 1
293 log_console
295 This directive is used to specify the quantity of information
296 that will be logged to the console. Values range inclusively
297 from 0 (no logging) to 3 (full logging).
298 Default: 0
300 log_syslog
302 This directive is used to specify the quantity of information
303 that will be logged to the syslog. Values range inclusively
304 from 0 (no logging) to 3 (full logging).
305 Default: 0
307 log_filename
309 When logging to file is requested via the 'log_file' directive,
310 the name and path of the file to use may be specified using the
311 'log_filename' directive.
312 log_filename=[/path/to/the/]file
314 Default: gogoc.log
316 log_rotation
318 When logging to file is requested via the 'log_file' directive,
319 log file rotation may be enabled using the 'log_rotation'
320 directive.
321 When enabled, the contents of the log file will be moved to a
323 backup file just before it reaches the maximum log file size
324 specified via the
325 `log_rotation_size' directive.
326 The name of the backup file is the name of the original log
328 file with `.<timestamp>' inserted before the file extension. If
329 the file does not have an extension, `.<timestamp>' is appended
330 to the name of the original log file. The timestamp specifies
331 when the rotation occurred.
332 After the contents of the log file have been moved to the
334 backup file, the original file is cleared, and logging resumes
335 at the beginning of the file.
336 log_rotation=yes|no
338 Default: yes
340 log_rotation_size
342 The `log_rotation_size' directive specifies the maximum size a
343 log file may reach before rotation occurs (if rotation has been
344 enabled via the `log_rotation' directive).
345 The value is expressed in kilobytes.
347 log_rotation_size=16|32|128|1024
349 Default value: 32
351 log_rotation_delete
353 The `log_rotation_delete' directive specifies that the log file
354 will be recycled on rotation. No backup log files will be kept.
355 (if rotation has been enabled via the 'log_rotation' direc‐
356 tive).
357 log_rotation_delete=yes|no
359 Default: no
361 syslog_facility
363 When logging to syslog is requested using the `log' directive,
364 the facility to use may be specified using the `syslog_facil‐
365 ity' directive.
366 Valid values are USER, and LOCAL[0-7].
368 syslog_facility=FACILITY
370 Default: USER
372
374 <gogoc_dir>/bin/gogoc.conf
375 <gogoc_dir>/bin/gogoc.conf.sample
376
378 gogoc(8)
379 Freenet6 Web site: http://www.go6.net
381 gogo6 Web site: http://www.gogo6.com
3834.2 Berkeley Distribution May 7, 2007 4.2 Berkeley Distribution