authbind.1

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .\" Authors: Ian Jackson
   3 .\"
   4 .\" authbind is Copyright (C) 1998 Ian Jackson
   5 .\"
   6 .\" This program is free software; you can redistribute it and/or modify
   7 .\" it under the terms of the GNU General Public License as published by
   8 .\" the Free Software Foundation; either version 2, or (at your option)
   9 .\" any later version.
  10 .\"
  11 .\" This program is distributed in the hope that it will be useful,
  12 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 .\" GNU General Public License for more details.
  15 .\"
  16 .\" You should have received a copy of the GNU General Public License
  17 .\" along with this program; if not, write to the Free Software Foundation,
  18 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19 .\"
  20 .TH AUTHBIND 1 "30th August 1998" "Debian Project" "Debian Linux manual"
  21 .SH NAME
  22 authbind \- bind sockets to privileged ports without root
  23 .SH SYNOPSIS
  24 .BR authbind
  25 .RI [ options "] " program " [" argument " ...]"
  26 .SH DESCRIPTION
  27 .B authbind
  28 allows a program which does not or should not run as root to bind to
  29 low-numbered ports in a controlled way.
  30 .PP
  31 You must invoke the program using
  32 .BR authbind ".  " authbind
  33 will set up some environment variables, including an
  34 .BR LD_PRELOAD ,
  35 which will allow the program (including any subprocesses it may run)
  36 to bind to low-numbered (<512) ports if the system is configured to
  37 allow this.
  38 .SH OPTIONS
  39 .TP
  40 .B --deep
  41 Normally,
  42 .B authbind
  43 arranges for only the program which it directly invokes to be affected
  44 by its special version of
  45 .BR bind (2).
  46 If you specify
  47 .B --deep
  48 then all programs which that program invokes directly or indirectly
  49 will be affected, so long as they do not unset the environment
  50 variables set up by
  51 .BR authbind .
  52 .TP
  53 .BI --depth " levels"
  54 Causes
  55 .B authbind
  56 to affect programs which are
  57 .I levels
  58 deep in the calling graph.  The default is
  59 .BR "--depth 1" .
  60 .SH ACCESS CONTROL
  61 Access to low numbered ports is controlled by permissions and contents
  62 of files in a configuration area,
  63 .BR /etc/authbind .
  64 .PP
  65 Firstly,
  66 .BI /etc/authbind/byport/ port
  67 is tested.  If this file is accessible for execution to the calling
  68 user, according to
  69 .BR access (2),
  70 then binding to the port is authorised.  If the file can be seen not
  71 to exist (the existence check returns
  72 .BR ENOENT )
  73 then further tests will be used to find authorisation; otherwise,
  74 binding is not authorised, and the
  75 .B bind
  76 call will return with the
  77 .B errno
  78 value from the
  79 .BR access (2)
  80 call, usually
  81 .B EACCES
  82 .RI ( "Permission denied" ).
  83 .PP
  84 Secondly, if that test fails to resolve the matter,
  85 .BI /etc/authbind/byaddr/ addr , port
  86 (any protocol) or failing that
  87 .BI /etc/authbind/byaddr/ addr : port
  88 (IPv4 only)
  89 is tested, in the same manner as above.  Here
  90 .I addr
  91 is as from
  92 .BR inet_ntop ,
  93 and
  94 .I port
  95 is the (local) TCP or UDP port number, expressed as an unsigned
  96 integer in the minimal non-zero number of digits.
  97 .PP
  98 Thirdly, for IPv6 only: since the textual representation from
  99 .B inet_ntop
 100 is complicated to predict, a variant of
 101 .I addr
 102 is also tested which does not use the double colon abbreviation:
 103 each 16-byte chunk expressed in the minimal nonzero number
 104 of hex digits (i.e. with leading zeroes removed), the chunks
 105 being separated by colons as is conventional.
 106 .PP
 107 Fourthly, if the question is still unresolved, the file
 108 .BI /etc/authbind/byuid/ uid
 109 will be opened and read.  If the file does not exist then the binding
 110 is not authorised and
 111 .B bind
 112 will return
 113 .B EPERM
 114 .RI ( "Operation not permitted" ", or " "Not owner" ).
 115 If the file does exist it will be searched for a line of the form
 116 .nf
 117 .IR             addrmin [\fB\-\fR addrmax ]\fB,\fR portmin [\fB\-\fR portmax ]
 118 .IR             addr [\fB/\fR length ]\fB,\fR portmin [\fB\-\fR portmax ]
 119 .IB             addr4 / length : portmin , portmax
 120 .fi
 121 matching the request.
 122 The first form requires that the address lies in the
 123 relevant range (inclusive at both ends).
 124 The second and third forms require that the initial
 125 .I length
 126 bits of
 127 .I addr
 128 match those in the proposed
 129 .B bind
 130 call.  The third form is only available for IPv4 since IPv6 addresses
 131 contain colons.
 132 Addresses in the byuid file can
 133 be in any form acceptable to inet_pton.  In all cases
 134 the proposed port number must lie is in the inclusive range
 135 specified.  If such a line is found then the binding is authorised.
 136 Otherwise it is not, and
 137 .B bind
 138 will fail with
 139 .B ENOENT
 140 .RI ( "No such file or directory" ).
 141 .PP
 142 If a read error occurs, or the directory
 143 .B /etc/authbind
 144 cannot be accessed, then not only will
 145 .B bind
 146 fail, but an error message will be printed to stderr.  Unrecognised
 147 lines in
 148 .BI /etc/authbind/byuid/ uid
 149 files are silently ignored (as are lines whose
 150 .I addr
 151 has non-zero bits more than
 152 .I length
 153 from the top) or where some
 154 .I min
 155 is larger than
 156 .IR max .
 157 .PP
 158 Authorising binding to ports from 512 to 1023 inclusive is
 159 not recommended.  Some protocols (including some versions of NFS)
 160 authorise clients by seeing that they are using a port number in this
 161 range.  So by authorising a program to be a server for such a port,
 162 you are also authorising it to impersonate the whole host for those
 163 protocols.  To make sure that this isn't done by accident,
 164 if the port number requested is in the range 512-1023, authbind
 165 will expect the permission files to have an additional
 166 .B !
 167 at the start of their leafname.
 168 .SH MECHANISM
 169 The shared library loaded using
 170 .B LD_PRELOAD
 171 overrides the
 172 .BR bind (2)
 173 system call.  When a program invoked via
 174 .B authbind
 175 calls
 176 .B bind
 177 to bind a socket to a low-numbered TCP/IP port, and if the program
 178 doesn't already have an effective uid of 0, the version of
 179 .B bind
 180 supposed by
 181 .B authbind
 182 forks and executes a setuid-root helper program.  For non-TCP/IP
 183 sockets, high-numbered ports, or programs which are already root,
 184 .B authbind
 185 passes the call to the original
 186 .BR bind (2)
 187 system call, which is found using
 188 .BR dlsym (3)
 189 with the handle
 190 .BR RTLD_NEXT .
 191 .PP
 192 .SH ERROR HANDLING
 193 Usually the normal C error handling mechanisms apply.  If
 194 .B authbind
 195 cannot find the program it has been asked to execute it will print a
 196 message to stderr and exit with code 255.
 197 .PP
 198 The helper program usually reports back to the shared library with an
 199 exit status containing an
 200 .B errno
 201 value which encodes whether the
 202 .B bind
 203 was permitted and successful.  This will be returned to the calling
 204 program in the usual way.
 205 .PP
 206 In the case of apparent configuration or other serious errors the
 207 library and/or the helper program may cause messages to be printed to
 208 the program's stderr, was well as returning -1 from
 209 .BR bind .
 210 .SH BUGS
 211 .B authbind
 212 currently only supports IPv4 and IPv6 sockets.
 213 Programs which open other kinds
 214 of sockets will not benefit from
 215 .BR authbind ,
 216 but it won't get in their way.
 217 .PP
 218 The use of
 219 .B LD_PRELOAD
 220 makes an
 221 .B authbind
 222 installation specific to a particular C library.  This version is for
 223 GNU/Linux libc6 (glibc2).
 224 .PP
 225 .B authbind
 226 may not operate correctly with multithreaded programs.  It is
 227 inherently very difficult (if not impossible) to perform the kind of
 228 trickery that authbind does while preventing all undesirable
 229 interactions between authbind's activities and those of (say) a
 230 threading runtime system.
 231 .PP
 232 It is quite possible that
 233 .B authbind
 234 and other programs and facilities which use
 235 .B LD_PRELOAD
 236 may interfere with each other, causing unpredictable behaviour or even
 237 core dumps.
 238 .B authbind
 239 is known sometimes not to work correctly with
 240 .BR fakeroot ,
 241 for example (even supposing it could be determined what `correctly'
 242 means in this context).
 243 .PP
 244 .B authbind
 245 is ineffective with setuid programs, because they do not honour
 246 .B LD_PRELOAD
 247 references outside the system directories, for security reasons.  (In
 248 fact, setuid programs should not honour
 249 .B LD_PRELOAD
 250 at all.)
 251 Of course a setuid-root program does not need
 252 .BR authbind ,
 253 but it might be useful to apply it to program which are setuid to
 254 another user or setgid.  If the author or builder of such a programs
 255 wishes it to use authbind they could have it load the
 256 .B libauthbind
 257 library explicitly rather than via
 258 .BR LD_PRELOAD .
 259 .PP
 260 Some programs may have trouble because
 261 .B authbind
 262 spawns a child process `under their feet', causing (for example) a
 263 .BR fork (2)
 264 to happen and
 265 .B SIGCHLD
 266 signal to be delivered.  Unfortunately the Unix API does not make
 267 it possible to deal with this problem in a sane way.
 268 .PP
 269 The access control configuration scheme is somewhat strange.
 270 .SH FILES AND ENVIRONMENT VARIABLES
 271 .TP
 272 .I /usr/lib/authbind/libauthbind.so.1.0
 273 The shared library which
 274 .B authbind
 275 causes to be loaded using
 276 .BR LD_PRELOAD ,
 277 and which actually implements the diversion of
 278 .BR bind (2)
 279 to an external program.
 280 .TP
 281 .I LD_PRELOAD
 282 The variable used by the dynamic linker when starting dynamically
 283 linked programs and deciding which shared libraries to load and
 284 modifed by the
 285 .B authbind
 286 program to allow it to override the usual meaning of
 287 .BR bind (2) .
 288 .TP
 289 .I AUTHBIND_LIB
 290 If set, forces
 291 .B authbind
 292 to use its value as the path to the shared library to put in
 293 .BR LD_PRELOAD ,
 294 instead of the compiled-in value.  In any case, unless
 295 .B --deep
 296 was specified,
 297 .B authbind
 298 will set this variable to the name of the library actually added to
 299 .BR LD_PRELOAD ,
 300 so that the library can find and remove the right entry.
 301 .TP
 302 .I AUTHBIND_LEVELS
 303 This variable is set by
 304 .B authbind
 305 to the number of levels left from the
 306 .B --depth
 307 or
 308 .B --deep
 309 option, minus one.  It is decremented during
 310 .B _init
 311 by the library on each program call, and the library will remove
 312 itself from the
 313 .B LD_PRELOAD
 314 when it reaches zero.  The special value
 315 .B y
 316 means
 317 .B --deep
 318 was specified.
 319 .SH SEE ALSO
 320 .BR bind (2),
 321 .BR authbind\-helper (8),
 322 .BR dlsym (3),
 323 .BR ld.so (8)
 324 .SH AUTHOR
 325 .B authbind
 326 and this manpage were written by Ian Jackson.  They are
 327 Copyright (C)1998,2012
 328 by him and released under the GNU General Public Licence; there is NO
 329 WARRANTY.  See
 330 .B /usr/doc/authbind/copyright
 331 and
 332 .B /usr/doc/copyright/GPL
 333 for details.