xref: /freebsd/lib/libtacplus/tacplus.conf.5 (revision b52b9d56d4e96089873a75f9e29062eec19fabba)
1.\" Copyright 1998 Juniper Networks, Inc.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd July 29, 1998
28.Dt TACPLUS.CONF 5
29.Os
30.Sh NAME
31.Nm tacplus.conf
32.Nd TACACS+ client configuration file
33.Sh SYNOPSIS
34.Pa /etc/tacplus.conf
35.Sh DESCRIPTION
36.Nm
37contains the information necessary to configure the TACACS+ client
38library.  It is parsed by
39.Fn tac_config
40(see
41.Xr libtacplus 3 ) .
42The file contains one or more lines of text, each describing a
43single TACACS+ server which is to be used by the library.  Leading
44white space is ignored, as are empty lines and lines containing
45only comments.
46.Pp
47A TACACS+ server is described by two to four fields on a line.  The
48fields are separated by white space.  The
49.Ql #
50character at the beginning of a field begins a comment, which extends
51to the end of the line.  A field may be enclosed in double quotes,
52in which case it may contain white space and/or begin with the
53.Ql #
54character.  Within a quoted string, the double quote character can
55be represented by
56.Ql \e\&" ,
57and the backslash can be represented by
58.Ql \e\e .
59No other escape sequences are supported.
60.Pp
61The first field specifies
62the server host, either as a fully qualified domain name or as a
63dotted-quad IP address.  The host may optionally be followed by a
64.Ql \&:
65and a numeric port number, without intervening white space.  If the
66port specification is omitted, it defaults to 49, the standard TACACS+
67port.
68.Pp
69The second field contains the shared secret, which should be known
70only to the client and server hosts.  It is an arbitrary string
71of characters, though it must be enclosed in double quotes if it
72contains white space or is empty.  An empty secret disables the
73normal encryption mechanism, causing all data to cross the network in
74cleartext.
75.Pp
76The third field contains a decimal integer specifying the timeout
77in seconds for communicating with the server.  The timeout applies
78separately to each connect, write, and read operation.  If this field
79is omitted, it defaults to 3 seconds.
80.Pp
81The optional fourth field may contain the string
82.Ql single-connection .
83If this option is included, the library will attempt to negotiate
84with the server to keep the TCP connection open for multiple
85sessions.  Some older TACACS+ servers become confused if this option
86is specified.
87.Pp
88Up to 10 TACACS+ servers may be specified.  The servers are tried in
89order, until a valid response is received or the list is exhausted.
90.Pp
91The standard location for this file is
92.Pa /etc/tacplus.conf .
93An alternate pathname may be specified in the call to
94.Fn tac_config
95(see
96.Xr libtacplus 3 ) .
97Since the file contains sensitive information in the form of the
98shared secrets, it should not be readable except by root.
99.Sh FILES
100.Pa /etc/tacplus.conf
101.Sh EXAMPLES
102.Bd -literal
103# A simple entry using all the defaults:
104tacserver.domain.com	OurLittleSecret
105
106# A server using a non-standard port, with an increased timeout and
107# the "single-connection" option.
108auth.domain.com:4333	"Don't tell!!"	15	single-connection
109
110# A server specified by its IP address:
111192.168.27.81		$X*#..38947ax-+=
112.Ed
113.Sh SEE ALSO
114.Xr libtacplus 3
115.Sh AUTHORS
116This documentation was written by
117.An John Polstra ,
118and donated to the
119.Fx
120project by Juniper Networks, Inc.
121