bsd/kern/sys_socket.c

   1 /*
   2  * Copyright (c) 2000-2011 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1990, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)sys_socket.c        8.1 (Berkeley) 6/10/93
  61  */
  62 /*
  63  * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
  64  * support for mandatory and extensible security protections.  This notice
  65  * is included in support of clause 2.2 (b) of the Apple Public License,
  66  * Version 2.0.
  67  */
  68
  69 #include <sys/param.h>
  70 #include <sys/systm.h>
  71 #include <sys/file_internal.h>
  72 #include <sys/event.h>
  73 #include <sys/protosw.h>
  74 #include <sys/socket.h>
  75 #include <sys/socketvar.h>
  76 #include <sys/filio.h>                  /* XXX */
  77 #include <sys/sockio.h>
  78 #include <sys/stat.h>
  79 #include <sys/uio.h>
  80 #include <sys/filedesc.h>
  81 #include <sys/kauth.h>
  82 #include <sys/signalvar.h>
  83 #include <sys/vnode.h>
  84
  85 #include <net/if.h>
  86 #include <net/route.h>
  87
  88 #if CONFIG_MACF
  89 #include <security/mac_framework.h>
  90 #endif
  91
  92 /*
  93  * File operations on sockets.
  94  */
  95 static int soo_read(struct fileproc *, struct uio *, int, vfs_context_t ctx);
  96 static int soo_write(struct fileproc *, struct uio *, int, vfs_context_t ctx);
  97 static int soo_close(struct fileglob *, vfs_context_t ctx);
  98 static int soo_drain(struct fileproc *, vfs_context_t ctx);
  99
 100 /* TODO: these should be in header file */
 101 extern int soo_ioctl(struct fileproc *, u_long, caddr_t, vfs_context_t ctx);
 102 extern int soo_stat(struct socket *, void *, int);
 103 extern int soo_select(struct fileproc *, int, void *, vfs_context_t ctx);
 104 extern int soo_kqfilter(struct fileproc *, struct knote *, vfs_context_t ctx);
 105
 106 struct fileops socketops = {
 107         soo_read, soo_write, soo_ioctl, soo_select, soo_close,
 108         soo_kqfilter, soo_drain
 109 };
 110
 111 /* ARGSUSED */
 112 static int
 113 soo_read(struct fileproc *fp, struct uio *uio, __unused int flags,
 114 #if !CONFIG_MACF_SOCKET
 115         __unused
 116 #endif
 117         vfs_context_t ctx)
 118 {
 119         struct socket *so;
 120         int stat;
 121 #if CONFIG_MACF_SOCKET
 122         int error;
 123 #endif
 124
 125         int (*fsoreceive)(struct socket *so2, struct sockaddr **paddr,
 126             struct uio *uio2, struct mbuf **mp0, struct mbuf **controlp,
 127             int *flagsp);
 128
 129         if ((so = (struct socket *)fp->f_fglob->fg_data) == NULL) {
 130                 /* This is not a valid open file descriptor */
 131                 return (EBADF);
 132         }
 133
 134 #if CONFIG_MACF_SOCKET
 135         error = mac_socket_check_receive(vfs_context_ucred(ctx), so);
 136         if (error)
 137                 return (error);
 138 #endif /* CONFIG_MACF_SOCKET */
 139
 140 //###LD will have to change
 141         fsoreceive = so->so_proto->pr_usrreqs->pru_soreceive;
 142
 143         stat = (*fsoreceive)(so, 0, uio, 0, 0, 0);
 144         return (stat);
 145 }
 146
 147 /* ARGSUSED */
 148 static int
 149 soo_write(struct fileproc *fp, struct uio *uio, __unused int flags,
 150         vfs_context_t ctx)
 151 {
 152         struct socket *so;
 153         int stat;
 154         int (*fsosend)(struct socket *so2, struct sockaddr *addr,
 155             struct uio *uio2, struct mbuf *top, struct mbuf *control,
 156             int flags2);
 157         proc_t procp;
 158
 159 #if CONFIG_MACF_SOCKET
 160         int error;
 161 #endif
 162
 163         if ((so = (struct socket *)fp->f_fglob->fg_data) == NULL) {
 164                 /* This is not a valid open file descriptor */
 165                 return (EBADF);
 166         }
 167
 168 #if CONFIG_MACF_SOCKET
 169         /* JMM - have to fetch the socket's remote addr */
 170         error = mac_socket_check_send(vfs_context_ucred(ctx), so, NULL);
 171         if (error)
 172                 return (error);
 173 #endif /* CONFIG_MACF_SOCKET */
 174
 175         fsosend = so->so_proto->pr_usrreqs->pru_sosend;
 176
 177         stat = (*fsosend)(so, 0, uio, 0, 0, 0);
 178
 179         /* Generation of SIGPIPE can be controlled per socket */
 180         procp = vfs_context_proc(ctx);
 181         if (stat == EPIPE && !(so->so_flags & SOF_NOSIGPIPE))
 182                 psignal(procp, SIGPIPE);
 183
 184         return (stat);
 185 }
 186
 187 __private_extern__ int
 188 soioctl(struct socket *so, u_long cmd, caddr_t data, struct proc *p)
 189 {
 190         int error = 0;
 191         int dropsockref = -1;
 192
 193         socket_lock(so, 1);
 194
 195         /* Call the socket filter's ioctl handler for most ioctls */
 196         if (IOCGROUP(cmd) != 'i' && IOCGROUP(cmd) != 'r') {
 197                 error = sflt_ioctl(so, cmd, data);
 198                 if (error != 0)
 199                         goto out;
 200         }
 201
 202         switch (cmd) {
 203
 204         case FIONBIO:
 205                 if (*(int *)data)
 206                         so->so_state |= SS_NBIO;
 207                 else
 208                         so->so_state &= ~SS_NBIO;
 209
 210                 goto out;
 211
 212         case FIOASYNC:
 213                 if (*(int *)data) {
 214                         so->so_state |= SS_ASYNC;
 215                         so->so_rcv.sb_flags |= SB_ASYNC;
 216                         so->so_snd.sb_flags |= SB_ASYNC;
 217                 } else {
 218                         so->so_state &= ~SS_ASYNC;
 219                         so->so_rcv.sb_flags &= ~SB_ASYNC;
 220                         so->so_snd.sb_flags &= ~SB_ASYNC;
 221                 }
 222                 goto out;
 223
 224         case FIONREAD:
 225                 *(int *)data = so->so_rcv.sb_cc;
 226                 goto out;
 227
 228         case SIOCSPGRP:
 229                 so->so_pgid = *(int *)data;
 230                 goto out;
 231
 232         case SIOCGPGRP:
 233                 *(int *)data = so->so_pgid;
 234                 goto out;
 235
 236         case SIOCATMARK:
 237                 *(int *)data = (so->so_state&SS_RCVATMARK) != 0;
 238                 goto out;
 239
 240         case SIOCSETOT: {
 241                 /*
 242                  * Set socket level options here and then call protocol
 243                  * specific routine.
 244                  */
 245                 struct socket *cloned_so = NULL;
 246                 int cloned_fd = *(int *)data;
 247
 248                 /* let's make sure it's either -1 or a valid file descriptor */
 249                 if (cloned_fd != -1) {
 250                         error = file_socket(cloned_fd, &cloned_so);
 251                         if (error) {
 252                                 goto out;
 253                         }
 254                         dropsockref = cloned_fd;
 255                 }
 256
 257                 /* Always set socket non-blocking for OT */
 258                 so->so_state |= SS_NBIO;
 259                 so->so_options |= SO_DONTTRUNC | SO_WANTMORE;
 260                 so->so_flags |= SOF_NOSIGPIPE | SOF_NPX_SETOPTSHUT;
 261
 262                 if (cloned_so && so != cloned_so) {
 263                         /* Flags options */
 264                         so->so_options |=
 265                             cloned_so->so_options & ~SO_ACCEPTCONN;
 266
 267                         /* SO_LINGER */
 268                         if (so->so_options & SO_LINGER)
 269                                 so->so_linger = cloned_so->so_linger;
 270
 271                         /* SO_SNDBUF, SO_RCVBUF */
 272                         if (cloned_so->so_snd.sb_hiwat > 0) {
 273                                 if (sbreserve(&so->so_snd,
 274                                     cloned_so->so_snd.sb_hiwat) == 0) {
 275                                         error = ENOBUFS;
 276                                         goto out;
 277                                 }
 278                         }
 279                         if (cloned_so->so_rcv.sb_hiwat > 0) {
 280                                 if (sbreserve(&so->so_rcv,
 281                                     cloned_so->so_rcv.sb_hiwat) == 0) {
 282                                         error = ENOBUFS;
 283                                         goto out;
 284                                 }
 285                         }
 286
 287                         /* SO_SNDLOWAT, SO_RCVLOWAT */
 288                         so->so_snd.sb_lowat =
 289                             (cloned_so->so_snd.sb_lowat > so->so_snd.sb_hiwat) ?
 290                             so->so_snd.sb_hiwat : cloned_so->so_snd.sb_lowat;
 291                         so->so_rcv.sb_lowat =
 292                             (cloned_so->so_rcv.sb_lowat > so->so_rcv.sb_hiwat) ?
 293                             so->so_rcv.sb_hiwat : cloned_so->so_rcv.sb_lowat;
 294
 295                         /* SO_SNDTIMEO, SO_RCVTIMEO */
 296                         so->so_snd.sb_timeo = cloned_so->so_snd.sb_timeo;
 297                         so->so_rcv.sb_timeo = cloned_so->so_rcv.sb_timeo;
 298                 }
 299
 300                 error = (*so->so_proto->pr_usrreqs->pru_control)(so, cmd,
 301                     data, 0, p);
 302                 /* Just ignore protocols that do not understand it */
 303                 if (error == EOPNOTSUPP)
 304                         error = 0;
 305
 306                 goto out;
 307         }
 308         }
 309         /*
 310          * Interface/routing/protocol specific ioctls:
 311          * interface and routing ioctls should have a
 312          * different entry since a socket's unnecessary
 313          */
 314         if (IOCGROUP(cmd) == 'i') {
 315                 error = ifioctllocked(so, cmd, data, p);
 316         } else {
 317                 if (IOCGROUP(cmd) == 'r')
 318                         error = rtioctl(cmd, data, p);
 319                 else
 320                         error = (*so->so_proto->pr_usrreqs->pru_control)(so,
 321                             cmd, data, 0, p);
 322         }
 323
 324 out:
 325         if (dropsockref != -1)
 326                 file_drop(dropsockref);
 327         socket_unlock(so, 1);
 328
 329         if (error == EJUSTRETURN)
 330                 error = 0;
 331
 332         return (error);
 333 }
 334
 335 int
 336 soo_ioctl(struct fileproc *fp, u_long cmd, caddr_t data, vfs_context_t ctx)
 337 {
 338         struct socket *so;
 339         int error;
 340         proc_t procp = vfs_context_proc(ctx);
 341
 342         if ((so = (struct socket *)fp->f_fglob->fg_data) == NULL) {
 343                 /* This is not a valid open file descriptor */
 344                 return (EBADF);
 345         }
 346
 347         error = soioctl(so, cmd, data, procp);
 348
 349         if (error == 0 && cmd == SIOCSETOT)
 350                 fp->f_fglob->fg_flag |= FNONBLOCK;
 351
 352         return (error);
 353 }
 354
 355 int
 356 soo_select(struct fileproc *fp, int which, void *wql, vfs_context_t ctx)
 357 {
 358         struct socket *so = (struct socket *)fp->f_fglob->fg_data;
 359         int retnum = 0;
 360         proc_t procp;
 361
 362         if (so == NULL || so == (struct socket *)-1)
 363                 return (0);
 364
 365         procp = vfs_context_proc(ctx);
 366
 367 #if CONFIG_MACF_SOCKET
 368         if (mac_socket_check_select(vfs_context_ucred(ctx), so, which) != 0);
 369                 return (0);
 370 #endif /* CONFIG_MACF_SOCKET */
 371
 372
 373         socket_lock(so, 1);
 374         switch (which) {
 375
 376         case FREAD:
 377                 so->so_rcv.sb_flags |= SB_SEL;
 378                 if (soreadable(so)) {
 379                         retnum = 1;
 380                         so->so_rcv.sb_flags &= ~SB_SEL;
 381                         goto done;
 382                 }
 383                 selrecord(procp, &so->so_rcv.sb_sel, wql);
 384                 break;
 385
 386         case FWRITE:
 387                 so->so_snd.sb_flags |= SB_SEL;
 388                 if (sowriteable(so)) {
 389                         retnum = 1;
 390                         so->so_snd.sb_flags &= ~SB_SEL;
 391                         goto done;
 392                 }
 393                 selrecord(procp, &so->so_snd.sb_sel, wql);
 394                 break;
 395
 396         case 0:
 397                 so->so_rcv.sb_flags |= SB_SEL;
 398                 if (so->so_oobmark || (so->so_state & SS_RCVATMARK)) {
 399                         retnum = 1;
 400                         so->so_rcv.sb_flags &= ~SB_SEL;
 401                         goto done;
 402                 }
 403                 selrecord(procp, &so->so_rcv.sb_sel, wql);
 404                 break;
 405         }
 406
 407 done:
 408         socket_unlock(so, 1);
 409         return (retnum);
 410 }
 411
 412 int
 413 soo_stat(struct socket *so, void *ub, int isstat64)
 414 {
 415         int ret;
 416         /* warning avoidance ; protected by isstat64 */
 417         struct stat *sb = (struct stat *)0;
 418         /* warning avoidance ; protected by isstat64 */
 419         struct stat64 *sb64 = (struct stat64 *)0;
 420
 421 #if CONFIG_MACF_SOCKET
 422         ret = mac_socket_check_stat(kauth_cred_get(), so);
 423         if (ret)
 424                 return (ret);
 425 #endif
 426
 427         if (isstat64 != 0) {
 428                 sb64 = (struct stat64 *)ub;
 429                 bzero((caddr_t)sb64, sizeof (*sb64));
 430         } else {
 431                 sb = (struct stat *)ub;
 432                 bzero((caddr_t)sb, sizeof (*sb));
 433         }
 434
 435         socket_lock(so, 1);
 436         if (isstat64 != 0) {
 437                 sb64->st_mode = S_IFSOCK;
 438                 if ((so->so_state & SS_CANTRCVMORE) == 0 ||
 439                     so->so_rcv.sb_cc != 0)
 440                         sb64->st_mode |= S_IRUSR | S_IRGRP | S_IROTH;
 441                 if ((so->so_state & SS_CANTSENDMORE) == 0)
 442                         sb64->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
 443                 sb64->st_size = so->so_rcv.sb_cc - so->so_rcv.sb_ctl;
 444                 sb64->st_uid = so->so_uid;
 445                 sb64->st_gid = so->so_gid;
 446         } else {
 447                 sb->st_mode = S_IFSOCK;
 448                 if ((so->so_state & SS_CANTRCVMORE) == 0 ||
 449                     so->so_rcv.sb_cc != 0)
 450                         sb->st_mode |= S_IRUSR | S_IRGRP | S_IROTH;
 451                 if ((so->so_state & SS_CANTSENDMORE) == 0)
 452                         sb->st_mode |= S_IWUSR | S_IWGRP | S_IWOTH;
 453                 sb->st_size = so->so_rcv.sb_cc - so->so_rcv.sb_ctl;
 454                 sb->st_uid = so->so_uid;
 455                 sb->st_gid = so->so_gid;
 456         }
 457
 458         ret = (*so->so_proto->pr_usrreqs->pru_sense)(so, ub, isstat64);
 459         socket_unlock(so, 1);
 460         return (ret);
 461 }
 462
 463 /* ARGSUSED */
 464 static int
 465 soo_close(struct fileglob *fg, __unused vfs_context_t ctx)
 466 {
 467         int error = 0;
 468         struct socket *sp;
 469
 470         sp = (struct socket *)fg->fg_data;
 471         fg->fg_data = NULL;
 472
 473         if (sp)
 474                 error = soclose(sp);
 475
 476         return (error);
 477 }
 478
 479 static int
 480 soo_drain(struct fileproc *fp, __unused vfs_context_t ctx)
 481 {
 482         int error = 0;
 483         struct socket *so = (struct socket *)fp->f_fglob->fg_data;
 484
 485         if (so) {
 486                 socket_lock(so, 1);
 487                 so->so_state |= SS_DRAINING;
 488
 489                 wakeup((caddr_t)&so->so_timeo);
 490                 sorwakeup(so);
 491                 sowwakeup(so);
 492
 493                 socket_unlock(so, 1);
 494         }
 495
 496         return (error);
 497 }