lib/libtacplus/libtacplus.3

   1 .\" Copyright (c) 1998, 2001, 2002, 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/libtacplus.3,v 1.3.2.7 2002/10/09 08:50:42 pst Exp $
  26 .\"
  27 .Dd September 2, 1998
  28 .Dt LIBTACPLUS 3
  29 .Os
  30 .Sh NAME
  31 .Nm libtacplus
  32 .Nd TACACS+ client library
  33 .Sh SYNOPSIS
  34 .In taclib.h
  35 .Ft int
  36 .Fn tac_add_server "struct tac_handle *h" "const char *host" "int port" "const char *secret" "int timeout" "int flags"
  37 .Ft void
  38 .Fn tac_clear_avs "struct tac_handle *h"
  39 .Ft void
  40 .Fn tac_close "struct tac_handle *h"
  41 .Ft int
  42 .Fn tac_config "struct tac_handle *h" "const char *path"
  43 .Ft int
  44 .Fn tac_create_authen "struct tac_handle *h" "int action" "int type" "int service"
  45 .Ft int
  46 .Fn tac_create_author "struct tac_handle *h" "int method" "int type" "int service"
  47 .Ft char *
  48 .Fn tac_get_av "struct tac_handle *h" "u_int index"
  49 .Ft char *
  50 .Fn tac_get_av_value "struct tac_handle *h" "const char *attribute"
  51 .Ft void *
  52 .Fn tac_get_data "struct tac_handle *h" "size_t *len"
  53 .Ft char *
  54 .Fn tac_get_msg "struct tac_handle *h"
  55 .Ft struct tac_handle *
  56 .Fn tac_open "void"
  57 .Ft int
  58 .Fn tac_send_authen "struct tac_handle *h"
  59 .Ft int
  60 .Fn tac_send_author "struct tac_handle *h"
  61 .Ft int
  62 .Fn tac_set_av "struct tac_handle *h" "u_int index" "const char *av_pair"
  63 .Ft int
  64 .Fn tac_set_data "struct tac_handle *h" "const void *data" "size_t data_len"
  65 .Ft int
  66 .Fn tac_set_msg "struct tac_handle *h" "const char *msg"
  67 .Ft int
  68 .Fn tac_set_port "struct tac_handle *h" "const char *port"
  69 .Ft int
  70 .Fn tac_set_priv "struct tac_handle *h" "int priv"
  71 .Ft int
  72 .Fn tac_set_rem_addr "struct tac_handle *h" "const char *addr"
  73 .Ft int
  74 .Fn tac_set_user "struct tac_handle *h" "const char *user"
  75 .Ft const char *
  76 .Fn tac_strerror "struct tac_handle *h"
  77 .Sh DESCRIPTION
  78 The
  79 .Nm
  80 library implements the client side of the TACACS+ network access
  81 control protocol.  TACACS+ allows clients to perform authentication,
  82 authorization, and accounting by means of network requests to remote
  83 servers.  This library currently supports only the authentication
  84 and authorization portion of the protocol.
  85 .Sh INITIALIZATION
  86 To use the library, an application must first call
  87 .Fn tac_open
  88 to obtain a
  89 .Va struct tac_handle * ,
  90 which provides context for subsequent operations.
  91 Calls to
  92 .Fn tac_open
  93 always succeed unless insufficient virtual memory is available.  If
  94 the necessary memory cannot be allocated,
  95 .Fn tac_open
  96 returns
  97 .Dv NULL .
  98 .Pp
  99 Before issuing any TACACS+ requests, the library must be made aware
 100 of the servers it can contact.  The easiest way to configure the
 101 library is to call
 102 .Fn tac_config .
 103 .Fn tac_config
 104 causes the library to read a configuration file whose format is
 105 described in
 106 .Xr tacplus.conf 5 .
 107 The pathname of the configuration file is passed as the
 108 .Va file
 109 argument to
 110 .Fn tac_config .
 111 This argument may also be given as
 112 .Dv NULL ,
 113 in which case the standard configuration file
 114 .Pa /etc/tacplus.conf
 115 is used.
 116 .Fn tac_config
 117 returns 0 on success, or -1 if an error occurs.
 118 .Pp
 119 The library can also be configured programmatically by calls to
 120 .Fn tac_add_server .
 121 The
 122 .Va host
 123 parameter specifies the server host, either as a fully qualified
 124 domain name or as a dotted-quad IP address in text form.
 125 The
 126 .Va port
 127 parameter specifies the TCP port to contact on the server.  If
 128 .Va port
 129 is given as 0, the library uses port 49, the standard TACACS+ port.
 130 The shared secret for the server host is passed to the
 131 .Va secret
 132 parameter.  It may be any null-terminated string of bytes.
 133 The timeout for receiving replies from the server is passed to the
 134 .Va timeout
 135 parameter, in units of seconds.
 136 The
 137 .Va flags
 138 parameter is a bit mask of flags to specify various characteristics of
 139 the server.  It may contain:
 140 .Pp
 141 .Bl -tag -width Fl
 142 .It Dv TAC_SRVR_SINGLE_CONNECT
 143 Causes the library to attempt to negotiate single connection mode
 144 when communicating with the server.  In single connection mode, the
 145 original TCP connection is held open for multiple TACACS+ sessions.
 146 Older servers do not support this mode, and some of them become
 147 confused if the client attempts to negotiate it.
 148 .El
 149 .Pp
 150 .Fn tac_add_server
 151 returns 0 on success, or -1 if an error occurs.
 152 .Pp
 153 .Fn tac_add_server
 154 may be called multiple times, and it may be used together with
 155 .Fn tac_config .
 156 At most 10 servers may be specified.
 157 When multiple servers are given, they are tried in round-robin
 158 fashion until a working, accessible server is found.  Once the
 159 library finds such a server, it continues to use it as long as it
 160 works.
 161 .Sh CREATING A TACACS+ AUTHENTICATION REQUEST
 162 To begin constructing a new authentication request, call
 163 .Fn tac_create_authen .
 164 The
 165 .Va action ,
 166 .Va type ,
 167 and
 168 .Va service
 169 arguments must be set to appropriate values as defined in the
 170 TACACS+ protocol specification.  The
 171 .Aq taclib.h
 172 header file contains symbolic constants for these values.
 173 .Sh CREATING A TACACS+ AUTHORIZATION REQUEST
 174 To begin constructing a new authorization request, call
 175 .Fn tac_create_author .
 176 The
 177 .Va method ,
 178 .Va type ,
 179 and
 180 .Va service
 181 arguments must be set to appropriate values as defined in the
 182 TACACS+ protocol specification.  The
 183 .Aq taclib.h
 184 header file contains symbolic constants for these values.
 185 .Sh SETTING OPTIONAL PARAMETERS ON A REQUEST
 186 After creating a request,
 187 various optional parameters may be attached to it through calls to
 188 .Fn tac_set_av ,
 189 .Fn tac_set_data ,
 190 .Fn tac_set_port ,
 191 .Fn tac_set_priv ,
 192 .Fn tac_set_rem_addr ,
 193 and
 194 .Fn tac_set_user .
 195 The library creates its own copies of any strings provided to these
 196 functions, so that it is not necessary for the caller to preserve
 197 them.  By default, each of these parameters is empty except for the
 198 privilege level, which defaults to
 199 .Ql USER
 200 privilege.
 201 .Pp
 202 .Fn tac_set_av
 203 only applies to the context of an authorization request.  The format
 204 for an attribute value pair is defined in the TACACS+ protocol
 205 specification.  The index specified can be any value between 0 and
 206 255 inclusive and indicates the position in the list to place the
 207 attribute value pair.  Calling
 208 .Fn tac_set_av
 209 with same index twice effectively replaces the value at that position.
 210 Use
 211 .Fn tac_clear_avs
 212 to clear all attribute value pairs that may have been set.
 213 .Sh SENDING THE AUTHENTICATION REQUEST AND RECEIVING THE RESPONSE
 214 After the TACACS+ authentication request has been constructed, it is
 215 sent by means of
 216 .Fn tac_send_authen .
 217 This function connects to a server if not already connected, sends
 218 the request, and waits for a reply.  On failure,
 219 .Fn tac_send_authen
 220 returns -1.  Otherwise, it returns the TACACS+ status code and flags,
 221 packed into an integer value.  The status can be extracted using the
 222 macro
 223 .Fn TAC_AUTHEN_STATUS .
 224 Possible status codes, defined in
 225 .Aq taclib.h ,
 226 include:
 227 .Pp
 228 .Bl -item -compact -offset indent
 229 .It
 230 .Dv TAC_AUTHEN_STATUS_PASS
 231 .It
 232 .Dv TAC_AUTHEN_STATUS_FAIL
 233 .It
 234 .Dv TAC_AUTHEN_STATUS_GETDATA
 235 .It
 236 .Dv TAC_AUTHEN_STATUS_GETUSER
 237 .It
 238 .Dv TAC_AUTHEN_STATUS_GETPASS
 239 .It
 240 .Dv TAC_AUTHEN_STATUS_RESTART
 241 .It
 242 .Dv TAC_AUTHEN_STATUS_ERROR
 243 .It
 244 .Dv TAC_AUTHEN_STATUS_FOLLOW
 245 .El
 246 .Pp
 247 The only flag is the no-echo flag, which can be tested using the
 248 macro
 249 .Fn TAC_AUTHEN_NOECHO .
 250 .Sh EXTRACTING INFORMATION FROM THE SERVER'S AUTHENTICATION RESPONSE
 251 An authentication response packet from the server may contain a
 252 server message, a data string, or both.  After a successful call to
 253 .Fn tac_send_authen ,
 254 this information may be retrieved from the response by calling
 255 .Fn tac_get_msg
 256 and
 257 .Fn tac_get_data .
 258 These functions return dynamically-allocated copies of the
 259 information from the packet.  The caller is responsible for freeing
 260 the copies when it no longer needs them.  The data returned from
 261 these functions is guaranteed to be terminated by a null byte.
 262 .Pp
 263 In the case of
 264 .Fn tac_get_data ,
 265 the
 266 .Va len
 267 argument points to a location into which the library will store the
 268 actual length of the received data, not including the null
 269 terminator.  This argument may be given as
 270 .Dv NULL
 271 if the caller is not interested in the length.
 272 .Sh SENDING AUTHENTICATION CONTINUE PACKETS
 273 If
 274 .Fn tac_send_authen
 275 returns a value containing one of the status codes
 276 .Dv TAC_AUTHEN_STATUS_GETDATA ,
 277 .Dv TAC_AUTHEN_STATUS_GETUSER ,
 278 or
 279 .Dv TAC_AUTHEN_STATUS_GETPASS ,
 280 then the client must provide additional information to the server by
 281 means of a TACACS+ CONTINUE packet.  To do so, the application must
 282 first set the packet's user message and/or data fields using
 283 .Fn tac_set_msg
 284 and
 285 .Fn tac_set_data .
 286 The client then sends the CONTINUE packet with
 287 .Fn tac_send_authen .
 288 N.B.,
 289 .Fn tac_create_authen
 290 should
 291 .Em not
 292 be called to construct a CONTINUE packet; it is used only for the
 293 initial authentication request.
 294 .Pp
 295 When it receives the CONTINUE packet, the server may again request
 296 more information by returning
 297 .Dv TAC_AUTHEN_STATUS_GETDATA ,
 298 .Dv TAC_AUTHEN_STATUS_GETUSER ,
 299 or
 300 .Dv TAC_AUTHEN_STATUS_GETPASS .
 301 The application should send further CONTINUEs until some other
 302 status is received from the server.
 303 .Sh SENDING THE AUTHORIZATION REQUEST AND RECEIVING THE RESPONSE
 304 After the TACACS+ authorization request has been constructed, it
 305 is sent by means of
 306 .Fn tac_send_author .
 307 This function connects to a server if not already connected, sends
 308 the request, and waits for a reply.  On failure,
 309 .Fn tac_send_author
 310 returns -1.  Otherwise, it returns the TACACS+ status code and
 311 number of attribute value (AV) pairs received packed into an
 312 integer value.  The status can be extracted using the macro
 313 .Fn TAC_AUTHOR_STATUS .
 314 Possible status codes, defined in
 315 .Aq taclib.h ,
 316 include:
 317 .Pp
 318 .Bl -item -compact -offset indent
 319 .It
 320 .Dv TAC_AUTHOR_STATUS_PASS_ADD
 321 .It
 322 .Dv TAC_AUTHOR_STATUS_PASS_REPL
 323 .It
 324 .Dv TAC_AUTHOR_STATUS_FAIL
 325 .It
 326 .Dv TAC_AUTHOR_STATUS_ERROR
 327 .El
 328 .Pp
 329 The number of AV pairs received is obtained using
 330 .Fn TAC_AUTHEN_AV_COUNT .
 331 .Sh EXTRACTING INFORMATION FROM THE SERVER'S AUTHORIZATION RESPONSE
 332 Like an authentication response packet, an authorization
 333 response packet from the
 334 server may contain a server message, a data string, or both.  Refer
 335 to EXTRACTING INFORMATION FROM THE SERVER'S AUTHENTICATION RESPONSE
 336 for instruction on extraction of those values.
 337 .Pp
 338 An authorization response packet from the server may also contain
 339 attribute value (AV) pairs.  To extract these, use
 340 .Fn tac_get_av
 341 or
 342 .Fn tac_get_av_value .
 343 .Fn tac_get_av
 344 takes the index of the AV pair as it is positioned in the list.
 345 The indexes start at 0 (use
 346 .Fn TAC_AUTHEN_AV_COUNT
 347 on the return value of
 348 .Fn tac_send_author
 349 to get the total number of items in this list).
 350 Alternatively,
 351 .Fn tac_get_av_value
 352 can be used.
 353 .Fn tac_get_av_value
 354 takes the attribute name and returns the
 355 corresponding value only, not the AV pair.  These functions return
 356 dynamically-allocated copies of the information from the packet.
 357 The caller is responsible for freeing the copies when it no longer
 358 needs them.  The data returned from these functions is guaranteed
 359 to be terminated by a null byte.
 360 .Sh OBTAINING ERROR MESSAGES
 361 Those functions which accept a
 362 .Va struct tac_handle *
 363 argument record an error message if they fail.  The error message
 364 can be retrieved by calling
 365 .Fn tac_strerror .
 366 The message text is overwritten on each new error for the given
 367 .Va struct tac_handle * .
 368 Thus the message must be copied if it is to be preserved through
 369 subsequent library calls using the same handle.
 370 .Sh CLEANUP
 371 To free the resources used by the TACACS+ library, call
 372 .Fn tac_close .
 373 .Sh RETURN VALUES
 374 The following functions return a non-negative value on success.  If
 375 they detect an error, they return -1 and record an error message
 376 which can be retrieved using
 377 .Fn tac_strerror .
 378 .Pp
 379 .Bl -item -offset indent -compact
 380 .It
 381 .Fn tac_add_server
 382 .It
 383 .Fn tac_config
 384 .It
 385 .Fn tac_create_authen
 386 .It
 387 .Fn tac_create_author
 388 .It
 389 .Fn tac_send_authen
 390 .It
 391 .Fn tac_send_author
 392 .It
 393 .Fn tac_set_av
 394 .It
 395 .Fn tac_set_data
 396 .It
 397 .Fn tac_set_msg
 398 .It
 399 .Fn tac_set_port
 400 .It
 401 .Fn tac_set_priv
 402 .It
 403 .Fn tac_set_rem_addr
 404 .It
 405 .Fn tac_set_user
 406 .El
 407 .Pp
 408 The following functions return a
 409 .No non- Ns Dv NULL
 410 pointer on success.  If they are unable to allocate sufficient
 411 virtual memory, they return
 412 .Dv NULL
 413 and record an error message which can be retrieved using
 414 .Fn tac_strerror .
 415 .Pp
 416 .Bl -item -offset indent -compact
 417 .It
 418 .Fn tac_get_av
 419 .It
 420 .Fn tac_get_av_pair
 421 .It
 422 .Fn tac_get_data
 423 .It
 424 .Fn tac_get_msg
 425 .El
 426 .Pp
 427 The following functions return a
 428 .No non- Ns Dv NULL
 429 pointer on success.  If they are unable to allocate sufficient
 430 virtual memory, they return
 431 .Dv NULL ,
 432 without recording an error message.
 433 .Pp
 434 .Bl -item -offset indent -compact
 435 .It
 436 .Fn tac_open
 437 .El
 438 .Sh FILES
 439 .Pa /etc/tacplus.conf
 440 .Sh SEE ALSO
 441 .Xr tacplus.conf 5
 442 .Rs
 443 .%A D. Carrel
 444 .%A Lol Grant
 445 .%T The TACACS+ Protocol, Version 1.78
 446 .%O draft-grant-tacacs-02.txt (Internet Draft)
 447 .Re
 448 .Sh AUTHORS
 449 This software was written by
 450 .An John Polstra ,
 451 and
 452 .An Paul Fraley ,
 453 and donated to the
 454 .Fx
 455 project by Juniper Networks, Inc.