1.\" $NetBSD: bind.2,v 1.19 2002/02/08 01:28:16 ross Exp $ 2.\" 3.\" Copyright (c) 1983, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)bind.2 8.1 (Berkeley) 6/4/93 35.\" 36.Dd October 16, 2001 37.Dt BIND 2 38.Os 39.Sh NAME 40.Nm bind 41.Nd bind a name to a socket 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]sys/socket.h\*[Gt] 46.Ft int 47.Fn bind "int s" "const struct sockaddr *name" "socklen_t namelen" 48.Sh DESCRIPTION 49.Fn bind 50assigns a name to an unnamed socket. 51When a socket is created 52with 53.Xr socket 2 54it exists in a name space (address family) 55but has no name assigned. 56.Fn bind 57requests that 58.Fa name 59be assigned to the socket. 60.Sh NOTES 61Binding a name in the 62.Ux 63domain creates a socket in the file 64system that must be deleted by the caller when it is no longer 65needed (using 66.Xr unlink 2 ) . 67.Pp 68The rules used in name binding vary between communication domains. 69Consult the manual entries in section 4 for detailed information. 70.Sh RETURN VALUES 71If the bind is successful, a 0 value is returned. 72A return value of -1 indicates an error, which is 73further specified in the global 74.Va errno . 75.Sh ERRORS 76The 77.Fn bind 78call will fail if: 79.Bl -tag -width Er 80.It Bq Er EBADF 81.Fa s 82is not a valid descriptor. 83.It Bq Er ENOTSOCK 84.Fa s 85is not a socket. 86.It Bq Er EADDRNOTAVAIL 87The specified address is not available from the local machine. 88.It Bq Er EADDRINUSE 89The specified address is already in use. 90.It Bq Er EINVAL 91The socket is already bound to an address. 92.It Bq Er EINVAL 93The family of the socket and that requested in 94.Fa name-\*[Gt]sa_family 95are not equivalent. 96.It Bq Er EACCES 97The requested address is protected, and the current user 98has inadequate permission to access it. 99.It Bq Er EFAULT 100The 101.Fa name 102parameter is not in a valid part of the user 103address space. 104.El 105.Pp 106The following errors are specific to binding names in the 107.Ux 108domain. 109.Bl -tag -width Er 110.It Bq Er ENOTDIR 111A component of the path prefix is not a directory. 112.It Bq Er ENAMETOOLONG 113A component of a pathname exceeded 114.Dv {NAME_MAX} 115characters, or an entire path name exceeded 116.Dv {PATH_MAX} 117characters. 118.It Bq Er ENOENT 119A prefix component of the path name does not exist. 120.It Bq Er ELOOP 121Too many symbolic links were encountered in translating the pathname. 122.It Bq Er EIO 123An I/O error occurred while making the directory entry or allocating the inode. 124.It Bq Er EROFS 125The name would reside on a read-only file system. 126.It Bq Er EISDIR 127An empty pathname was specified. 128.El 129.Sh SEE ALSO 130.Xr connect 2 , 131.Xr getsockname 2 , 132.Xr listen 2 , 133.Xr socket 2 134.Sh HISTORY 135The 136.Fn bind 137function call appeared in 138.Bx 4.2 . 139.Sh SECURITY CONSIDERATIONS 140.Fn bind 141was changed in 142.Nx 1.4 143to prevent the binding of a socket to the same port as an existing 144socket when all of the following is true: 145.Bl -bullet -compact -offset indent 146.It 147either of the existing or new addresses is 148.Li INADDR_ANY , 149.It 150the uid of the new socket is not root, and 151the uids of the creators of the sockets are different, 152.It 153the address is not a multicast address, and 154.It 155both sockets are not bound to 156.Li INADDR_ANY 157with 158.Li SO_REUSEPORT 159set. 160.El 161.Pp 162This prevents an attack where a user could bind to a port with 163the host's IP address (after setting 164.Li SO_REUSEADDR ) 165and 166.Sq steal 167packets destined for a server that bound to the 168same port with 169.Li INADDR_ANY . 170