Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / lib / libtacplus / tacplus.conf.5
CommitLineData
984263bc
MD
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: src/lib/libtacplus/tacplus.conf.5,v 1.3.2.3 2001/12/17 10:08:32 ru Exp $
1de703da 26.\" $DragonFly: src/lib/libtacplus/tacplus.conf.5,v 1.2 2003/06/17 04:26:51 dillon Exp $
984263bc
MD
27.\"
28.Dd July 29, 1998
29.Dt TACPLUS.CONF 5
30.Os
31.Sh NAME
32.Nm tacplus.conf
33.Nd TACACS+ client configuration file
34.Sh SYNOPSIS
35.Pa /etc/tacplus.conf
36.Sh DESCRIPTION
37.Nm
38contains the information necessary to configure the TACACS+ client
39library. It is parsed by
40.Fn tac_config
41(see
42.Xr libtacplus 3 ) .
43The file contains one or more lines of text, each describing a
44single TACACS+ server which is to be used by the library. Leading
45white space is ignored, as are empty lines and lines containing
46only comments.
47.Pp
48A TACACS+ server is described by two to four fields on a line. The
49fields are separated by white space. The
50.Ql #
51character at the beginning of a field begins a comment, which extends
52to the end of the line. A field may be enclosed in double quotes,
53in which case it may contain white space and/or begin with the
54.Ql #
55character. Within a quoted string, the double quote character can
56be represented by
57.Ql \e\&" ,
58and the backslash can be represented by
59.Ql \e\e .
60No other escape sequences are supported.
61.Pp
62The first field specifies
63the server host, either as a fully qualified domain name or as a
64dotted-quad IP address. The host may optionally be followed by a
65.Ql \&:
66and a numeric port number, without intervening white space. If the
67port specification is omitted, it defaults to 49, the standard TACACS+
68port.
69.Pp
70The second field contains the shared secret, which should be known
71only to the client and server hosts. It is an arbitrary string
72of characters, though it must be enclosed in double quotes if it
73contains white space or is empty. An empty secret disables the
74normal encryption mechanism, causing all data to cross the network in
75cleartext.
76.Pp
77The third field contains a decimal integer specifying the timeout
78in seconds for communicating with the server. The timeout applies
79separately to each connect, write, and read operation. If this field
80is omitted, it defaults to 3 seconds.
81.Pp
82The optional fourth field may contain the string
83.Ql single-connection .
84If this option is included, the library will attempt to negotiate
85with the server to keep the TCP connection open for multiple
86sessions. Some older TACACS+ servers become confused if this option
87is specified.
88.Pp
89Up to 10 TACACS+ servers may be specified. The servers are tried in
90order, until a valid response is received or the list is exhausted.
91.Pp
92The standard location for this file is
93.Pa /etc/tacplus.conf .
94An alternate pathname may be specified in the call to
95.Fn tac_config
96(see
97.Xr libtacplus 3 ) .
98Since the file contains sensitive information in the form of the
99shared secrets, it should not be readable except by root.
100.Sh FILES
101.Pa /etc/tacplus.conf
102.Sh EXAMPLES
103.Bd -literal
104# A simple entry using all the defaults:
105tacserver.domain.com OurLittleSecret
106
107# A server using a non-standard port, with an increased timeout and
108# the "single-connection" option.
109auth.domain.com:4333 "Don't tell!!" 15 single-connection
110
111# A server specified by its IP address:
112192.168.27.81 $X*#..38947ax-+=
113.Ed
114.Sh SEE ALSO
115.Xr libtacplus 3
116.Sh AUTHORS
117This documentation was written by
118.An John Polstra ,
119and donated to the
120.Fx
121project by Juniper Networks, Inc.