chiark / gitweb /
~~-ify changelog
[authbind.git] / 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 So for example an attempt by uid 432
143 to bind to [2620:106:e002:f00f::21]:80
144 would result in authbind calling
145 .I access(2)
146 on, in order,
147 .RS
148 .B /etc/authbind/byport/80
149 .br
150 .B /etc/authbind/byaddr/2620:106:e002:f00f::21,80
151 .br
152 .B /etc/authbind/byaddr/2620:106:e002:f00f:0:0:0:21,80
153 .RE
154 If none of these files exist, authbind will read
155 .RS
156 .B /etc/authbind/byuid/432
157 .RE
158 and search for a line to permit
159 the relevant access; examples of lines which would do so are:
160 .RS
161 .B 2620:106:e002:f00f::21,80
162 .br
163 .B ::/0,80
164 .RE
165 .PP
166 If a read error occurs, or the directory
167 .B /etc/authbind
168 cannot be accessed, then not only will
169 .B bind
170 fail, but an error message will be printed to stderr.  Unrecognised
171 lines in
172 .BI /etc/authbind/byuid/ uid
173 files are silently ignored (as are lines whose
174 .I addr
175 has non-zero bits more than
176 .I length
177 from the top) or where some
178 .I min
179 is larger than
180 .IR max .
181 .PP
182 Authorising binding to ports from 512 to 1023 inclusive is
183 not recommended.  Some protocols (including some versions of NFS)
184 authorise clients by seeing that they are using a port number in this
185 range.  So by authorising a program to be a server for such a port,
186 you are also authorising it to impersonate the whole host for those
187 protocols.  To make sure that this isn't done by accident,
188 if the port number requested is in the range 512-1023, authbind
189 will expect the permission files to have an additional
190 .B !
191 at the start of their leafname.
192 .SH MECHANISM
193 The shared library loaded using
194 .B LD_PRELOAD
195 overrides the
196 .BR bind (2)
197 system call.  When a program invoked via
198 .B authbind
199 calls
200 .B bind
201 to bind a socket to a low-numbered TCP/IP port, and if the program
202 doesn't already have an effective uid of 0, the version of
203 .B bind
204 supposed by
205 .B authbind
206 forks and executes a setuid-root helper program.  For non-TCP/IP
207 sockets, high-numbered ports, or programs which are already root,
208 .B authbind
209 passes the call to the original
210 .BR bind (2)
211 system call, which is found using
212 .BR dlsym (3)
213 with the handle
214 .BR RTLD_NEXT .
215 .PP
216 .SH ERROR HANDLING
217 Usually the normal C error handling mechanisms apply.  If
218 .B authbind
219 cannot find the program it has been asked to execute it will print a
220 message to stderr and exit with code 255.
221 .PP
222 The helper program usually reports back to the shared library with an
223 exit status containing an
224 .B errno
225 value which encodes whether the
226 .B bind
227 was permitted and successful.  This will be returned to the calling
228 program in the usual way.
229 .PP
230 In the case of apparent configuration or other serious errors the
231 library and/or the helper program may cause messages to be printed to
232 the program's stderr, was well as returning -1 from
233 .BR bind .
234 .SH BUGS
235 .B authbind
236 currently only supports IPv4 and IPv6 sockets.
237 Programs which open other kinds
238 of sockets will not benefit from
239 .BR authbind ,
240 but it won't get in their way.
241 .PP
242 The use of
243 .B LD_PRELOAD
244 makes an
245 .B authbind
246 installation specific to a particular C library.  This version is for
247 GNU/Linux libc6 (glibc2).
248 .PP
249 .B authbind
250 may not operate correctly with multithreaded programs.  It is
251 inherently very difficult (if not impossible) to perform the kind of
252 trickery that authbind does while preventing all undesirable
253 interactions between authbind's activities and those of (say) a
254 threading runtime system.
255 .PP
256 It is quite possible that
257 .B authbind
258 and other programs and facilities which use
259 .B LD_PRELOAD
260 may interfere with each other, causing unpredictable behaviour or even
261 core dumps.
262 .B authbind
263 is known sometimes not to work correctly with
264 .BR fakeroot ,
265 for example (even supposing it could be determined what `correctly'
266 means in this context).
267 .PP
268 .B authbind
269 is ineffective with setuid programs, because they do not honour
270 .B LD_PRELOAD
271 references outside the system directories, for security reasons.  (In
272 fact, setuid programs should not honour
273 .B LD_PRELOAD
274 at all.)
275 Of course a setuid-root program does not need
276 .BR authbind ,
277 but it might be useful to apply it to program which are setuid to
278 another user or setgid.  If the author or builder of such a programs
279 wishes it to use authbind they could have it load the
280 .B libauthbind
281 library explicitly rather than via
282 .BR LD_PRELOAD .
283 .PP
284 Some programs may have trouble because
285 .B authbind
286 spawns a child process `under their feet', causing (for example) a
287 .BR fork (2)
288 to happen and
289 .B SIGCHLD
290 signal to be delivered.  Unfortunately the Unix API does not make
291 it possible to deal with this problem in a sane way.
292 .PP
293 The access control configuration scheme is somewhat strange.
294 .SH FILES AND ENVIRONMENT VARIABLES
295 .TP
296 .I /usr/lib/authbind/libauthbind.so.1.0
297 The shared library which
298 .B authbind
299 causes to be loaded using
300 .BR LD_PRELOAD ,
301 and which actually implements the diversion of
302 .BR bind (2)
303 to an external program.
304 .TP
305 .I LD_PRELOAD
306 The variable used by the dynamic linker when starting dynamically
307 linked programs and deciding which shared libraries to load and
308 modifed by the
309 .B authbind
310 program to allow it to override the usual meaning of
311 .BR bind (2) .
312 .TP
313 .I AUTHBIND_LIB
314 If set, forces
315 .B authbind
316 to use its value as the path to the shared library to put in
317 .BR LD_PRELOAD ,
318 instead of the compiled-in value.  In any case, unless
319 .B --deep
320 was specified,
321 .B authbind
322 will set this variable to the name of the library actually added to
323 .BR LD_PRELOAD ,
324 so that the library can find and remove the right entry.
325 .TP
326 .I AUTHBIND_LEVELS
327 This variable is set by
328 .B authbind
329 to the number of levels left from the
330 .B --depth
331 or
332 .B --deep
333 option, minus one.  It is decremented during
334 .B _init
335 by the library on each program call, and the library will remove
336 itself from the
337 .B LD_PRELOAD
338 when it reaches zero.  The special value
339 .B y
340 means
341 .B --deep
342 was specified.
343 .SH SEE ALSO
344 .BR bind (2),
345 .BR authbind\-helper (8),
346 .BR dlsym (3),
347 .BR ld.so (8)
348 .SH AUTHOR
349 .B authbind
350 and this manpage were written by Ian Jackson.  They are
351 Copyright (C)1998,2012
352 by him and released under the GNU General Public Licence; there is NO
353 WARRANTY.  See
354 .B /usr/doc/authbind/copyright
355 and
356 .B /usr/doc/copyright/GPL
357 for details.