xref: /freebsd/lib/libtacplus/tacplus.conf.5 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
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 FreeBSD
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.Xr tac_config 3 .
40The file contains one or more lines of text, each describing a
41single TACACS+ server which is to be used by the library.  Leading
42white space is ignored, as are empty lines and lines containing
43only comments.
44.Pp
45A TACACS+ server is described by two to four fields on a line.  The
46fields are separated by white space.  The
47.Ql #
48character at the beginning of a field begins a comment, which extends
49to the end of the line.  A field may be enclosed in double quotes,
50in which case it may contain white space and/or begin with the
51.Ql #
52character.  Within a quoted string, the double quote character can
53be represented by
54.Ql \e\&" ,
55and the backslash can be represented by
56.Ql \e\e .
57No other escape sequences are supported.
58.Pp
59The first field specifies
60the server host, either as a fully qualified domain name or as a
61dotted-quad IP address.  The host may optionally be followed by a
62.Ql \&:
63and a numeric port number, without intervening white space.  If the
64port specification is omitted, it defaults to 49, the standard TACACS+
65port.
66.Pp
67The second field contains the shared secret, which should be known
68only to the client and server hosts.  It is an arbitrary string
69of characters, though it must be enclosed in double quotes if it
70contains white space or is empty.  An empty secret disables the
71normal encryption mechanism, causing all data to cross the network in
72cleartext.
73.Pp
74The third field contains a decimal integer specifying the timeout
75in seconds for communicating with the server.  The timeout applies
76separately to each connect, write, and read operation.  If this field
77is omitted, it defaults to 3 seconds.
78.Pp
79The optional fourth field may contain the string
80.Ql single-connection .
81If this option is included, the library will attempt to negotiate
82with the server to keep the TCP connection open for multiple
83sessions.  Some older TACACS+ servers become confused if this option
84is specified.
85.Pp
86Up to 10 TACACS+ servers may be specified.  The servers are tried in
87order, until a valid response is received or the list is exhausted.
88.Pp
89The standard location for this file is
90.Pa /etc/tacplus.conf .
91An alternate pathname may be specified in the call to
92.Xr tac_config 3 .
93Since the file contains sensitive information in the form of the
94shared secrets, it should not be readable except by root.
95.Sh FILES
96.Pa /etc/tacplus.conf
97.Sh EXAMPLES
98.Bd -literal
99# A simple entry using all the defaults:
100tacserver.domain.com	OurLittleSecret
101
102# A server using a non-standard port, with an increased timeout and
103# the "single-connection" option.
104auth.domain.com:4333	"Don't tell!!"	15	single-connection
105
106# A server specified by its IP address:
107192.168.27.81		$X*#..38947ax-+=
108.Ed
109.Sh SEE ALSO
110.Xr libtacplus 3
111.Sh AUTHORS
112This documentation was written by
113.An John Polstra ,
114and donated to the FreeBSD project by Juniper Networks, Inc.
115