authbind-helper.8

   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 .\" $Id$
  21 .\"
  22 .TH AUTHBIND\-HELPER 8 "30th August 1998" "Debian Project" "Debian Linux manual"
  23 .br
  24 .SH NAME
  25 authbind\-helper \- helper program to bind sockets to privileged ports without root
  26 .SH SYNOPSIS
  27 .BI /usr/lib/authbind/helper " addr\-hex port\-hex " < socket
  28 .SH DESCRIPTION
  29 .B helper
  30 is the program used by
  31 .BR libauthbind ,
  32 which is in turn used by
  33 .B authbind
  34 to allow programs which do not or should not run as root to bind to
  35 low-numbered ports in a controlled way.  See
  36 .BR authbind (1).
  37 .PP
  38 It may also be used standalone, i.e. without assistance from
  39 .BR authbind .
  40 Its standard input should be a TCP/IP socket, and it should be passed
  41 two arguments.
  42 .PP
  43 The arguments are the address and port number, respectively, to which
  44 the caller desires that the socket be bound.  They should be hex
  45 strings,
  46 .I without
  47 leading
  48 .BR 0x ,
  49 of exactly the right length (8 and 4 digits, respectively), being
  50 a pairs of hex digits for each byte in the address or port number when
  51 expressed in network byte order.
  52 .PP
  53 .B helper
  54 will not bind to ports 512 and onwards, because programs like
  55 .B rshd
  56 expect these to be used for outgoing connections, so allowing a user
  57 to bind to one of these would open up security hole(s).
  58 .SH EXIT STATUS
  59 .B helper
  60 will exit with code 0 on success.
  61 .PP
  62 If possible,
  63 .B helper
  64 will return an appropriate
  65 .B errno
  66 value as its exit status.  If this is not possible it may exit with
  67 status 255 or with an exit status corresponding to
  68 .B ENOSYS
  69 .RI ( "Function not implemented" ).
  70 .SH ACCESS CONTROL
  71 See
  72 .BR authbind (1)
  73 for details of the access control regime implemented by
  74 .BR helper .
  75 .SH SEE ALSO
  76 .BR authbind (1),
  77 .BR bind (2)
  78 .SH AUTHOR
  79 .B authbind
  80 and this manpage were written by Ian Jackson.  They are
  81 Copyright (C)1998
  82 by him and released under the GNU General Public Licence; there is NO
  83 WARRANTY.  See
  84 .B /usr/doc/authbind/copyright
  85 and
  86 .B /usr/doc/copyright/GPL
  87 for details.