sys/vfs/devfs/devfs_rules.c

   1 /*
   2  * Copyright (c) 2009 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Alex Hornung <ahornung@gmail.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34 #include <sys/param.h>
  35 #include <sys/systm.h>
  36 #include <sys/kernel.h>
  37 #include <sys/types.h>
  38 #include <sys/param.h>
  39 #include <sys/ioccom.h>
  40 #include <sys/lock.h>
  41 #include <sys/spinlock2.h>
  42 #include <sys/fcntl.h>
  43 #include <sys/device.h>
  44 #include <sys/mount.h>
  45 #include <vfs/devfs/devfs.h>
  46 #include <vfs/devfs/devfs_rules.h>
  47
  48 MALLOC_DECLARE(M_DEVFS);
  49
  50 #if 0
  51 static int WildCmp(const char *w, const char *s);
  52 #endif
  53 static int WildCaseCmp(const char *w, const char *s);
  54 static int wildCmp(const char **mary, int d, const char *w, const char *s);
  55 static int wildCaseCmp(const char **mary, int d, const char *w, const char *s);
  56
  57 static d_open_t      devfs_dev_open;
  58 static d_close_t     devfs_dev_close;
  59 static d_ioctl_t     devfs_dev_ioctl;
  60
  61 static struct devfs_rule *devfs_rule_alloc(struct devfs_rule *);
  62 static void devfs_rule_free(struct devfs_rule *);
  63 static void devfs_rule_insert(struct devfs_rule *);
  64 static void devfs_rule_remove(struct devfs_rule *);
  65 static void devfs_rule_clear(struct devfs_rule *);
  66
  67 static int devfs_rule_checkname(struct devfs_rule *, struct devfs_node *);
  68
  69 static struct objcache  *devfs_rule_cache;
  70 static struct lock              devfs_rule_lock;
  71
  72 static struct objcache_malloc_args devfs_rule_malloc_args = {
  73         sizeof(struct devfs_rule), M_DEVFS };
  74
  75 static cdev_t devfs_dev;
  76 static struct devfs_rule_head devfs_rule_list =
  77                 TAILQ_HEAD_INITIALIZER(devfs_rule_list);
  78
  79 static struct dev_ops devfs_dev_ops = {
  80         { "devfs", 0, 0 },
  81         .d_open = devfs_dev_open,
  82         .d_close = devfs_dev_close,
  83         .d_ioctl = devfs_dev_ioctl
  84 };
  85
  86
  87 static struct devfs_rule *
  88 devfs_rule_alloc(struct devfs_rule *templ)
  89 {
  90         struct devfs_rule *rule;
  91
  92         rule = objcache_get(devfs_rule_cache, M_WAITOK);
  93         memset(rule, 0, sizeof(struct devfs_rule));
  94
  95         if (templ->mntpoint != NULL) {
  96                 rule->mntpoint = kmalloc(templ->mntpointlen+1, M_DEVFS, M_WAITOK);
  97                 copyin(templ->mntpoint, rule->mntpoint, templ->mntpointlen+1);
  98         }
  99
 100         if (templ->name != NULL) {
 101                 rule->name = kmalloc(templ->namlen+1, M_DEVFS, M_WAITOK);
 102                 copyin(templ->name, rule->name, templ->namlen+1);
 103         }
 104
 105         if (templ->linkname != NULL) {
 106                 rule->linkname = kmalloc(templ->linknamlen+1, M_DEVFS, M_WAITOK);
 107                 copyin(templ->linkname, rule->linkname, templ->linknamlen+1);
 108         }
 109
 110         rule->rule_type = templ->rule_type;
 111         rule->dev_type = templ->dev_type;
 112         rule->mode = templ->mode;
 113         rule->uid = templ->uid;
 114         rule->gid = templ->gid;
 115
 116         return rule;
 117 }
 118
 119
 120 static void
 121 devfs_rule_free(struct devfs_rule *rule)
 122 {
 123         if (rule->mntpoint != NULL) {
 124                 kfree(rule->mntpoint, M_DEVFS);
 125         }
 126
 127         if (rule->name != NULL) {
 128                 kfree(rule->name, M_DEVFS);
 129         }
 130
 131         if (rule->linkname != NULL) {
 132                 kfree(rule->linkname, M_DEVFS);
 133         }
 134         objcache_put(devfs_rule_cache, rule);
 135 }
 136
 137
 138 static void
 139 devfs_rule_insert(struct devfs_rule *templ)
 140 {
 141         struct devfs_rule *rule;
 142
 143         rule = devfs_rule_alloc(templ);
 144
 145         lockmgr(&devfs_rule_lock, LK_EXCLUSIVE);
 146         TAILQ_INSERT_TAIL(&devfs_rule_list, rule, link);
 147         lockmgr(&devfs_rule_lock, LK_RELEASE);
 148 }
 149
 150
 151 static void
 152 devfs_rule_remove(struct devfs_rule *rule)
 153 {
 154         TAILQ_REMOVE(&devfs_rule_list, rule, link);
 155         devfs_rule_free(rule);
 156 }
 157
 158
 159 static void
 160 devfs_rule_clear(struct devfs_rule *templ)
 161 {
 162         struct devfs_rule *rule, *rule1, *rule2;
 163
 164         rule = devfs_rule_alloc(templ);
 165
 166         lockmgr(&devfs_rule_lock, LK_EXCLUSIVE);
 167         TAILQ_FOREACH_MUTABLE(rule1, &devfs_rule_list, link, rule2) {
 168                 if ((rule->mntpoint[0] == '*') ||
 169                         ( (rule->mntpointlen == rule1->mntpointlen) &&
 170                           (!memcmp(rule->mntpoint, rule1->mntpoint, rule->mntpointlen)) )) {
 171                         devfs_rule_remove(rule1);
 172                 }
 173         }
 174         lockmgr(&devfs_rule_lock, LK_RELEASE);
 175         devfs_rule_free(rule);
 176 }
 177
 178
 179 int
 180 devfs_rule_reset_node(struct devfs_node *node)
 181 {
 182         node->flags &= ~DEVFS_HIDDEN;
 183
 184         if ((node->node_type == Pdev) && (node->d_dev)) {
 185                 node->uid = node->d_dev->si_uid;
 186                 node->gid = node->d_dev->si_gid;
 187                 node->mode = node->d_dev->si_perms;
 188         }
 189
 190         return 0;
 191 }
 192
 193
 194 int
 195 devfs_rule_check_apply(struct devfs_node *node)
 196 {
 197         struct devfs_rule *rule;
 198         struct mount *mp = node->mp;
 199         int applies = 0;
 200         int locked = 0;
 201
 202         /* Check if it is locked already. if not, we acquire the devfs lock */
 203         if (!(lockstatus(&devfs_rule_lock, curthread)) == LK_EXCLUSIVE) {
 204                 lockmgr(&devfs_rule_lock, LK_EXCLUSIVE);
 205                 locked = 1;
 206         }
 207
 208         TAILQ_FOREACH(rule, &devfs_rule_list, link) {
 209
 210                 /*
 211                  * Skip this rule if it is only intended for jailed mount points
 212                  * and the current mount point isn't jailed
 213                  */
 214                 if ((rule->rule_type & DEVFS_RULE_JAIL) &&
 215                         (!(DEVFS_MNTDATA(mp)->jailed)) )
 216                         continue;
 217
 218                 /*
 219                  * Skip this rule if the mount point specified in the rule doesn't
 220                  * match the mount point of the node
 221                  */
 222                 if ((rule->mntpoint[0] != '*') &&
 223                         ((rule->mntpointlen != DEVFS_MNTDATA(mp)->mntonnamelen) ||
 224                         (memcmp(rule->mntpoint, mp->mnt_stat.f_mntonname, rule->mntpointlen))))
 225                         continue;
 226
 227                 /*
 228                  * Skip this rule if this is a by-type rule and the device flags
 229                  * don't match the specified device type in the rule
 230                  */
 231                 if ((rule->rule_type & DEVFS_RULE_TYPE) &&
 232                         ( (rule->dev_type == 0) || (!dev_is_good(node->d_dev)) ||
 233                           (!(dev_dflags(node->d_dev) & rule->dev_type))) )
 234                         continue;
 235
 236                 /*
 237                  * Skip this rule if this is a by-name rule and the node name
 238                  * doesn't match the wildcard string in the rule
 239                  */
 240                 if ((rule->rule_type & DEVFS_RULE_NAME) &&
 241                         (!devfs_rule_checkname(rule, node)) )
 242                         continue;
 243
 244
 245                 if (rule->rule_type & DEVFS_RULE_HIDE) {
 246                         /*
 247                          * If we should hide the device, we just apply the relevant
 248                          * hide flag to the node and let devfs do the rest in the
 249                          * vnops
 250                          */
 251                         if ((node->d_dir.d_namlen == 5) &&
 252                                 (!memcmp(node->d_dir.d_name, "devfs", 5))) {
 253                                 /*
 254                                  * Magically avoid /dev/devfs from being hidden, so that one
 255                                  * can still use the rule system even after a "* hide".
 256                                  */
 257                                  continue;
 258                         }
 259                         node->flags |= DEVFS_HIDDEN;
 260                         applies = 1;
 261                 } else if (rule->rule_type & DEVFS_RULE_SHOW) {
 262                         /*
 263                          * Show rule just means that the node should not be hidden, so
 264                          * what we do is clear the hide flag from the node.
 265                          */
 266                         node->flags &= ~DEVFS_HIDDEN;
 267                         applies = 1;
 268                 } else if ((rule->rule_type & DEVFS_RULE_LINK) && (node->node_type != Plink)) {
 269                         /*
 270                          * This is a LINK rule, so we tell devfs to create
 271                          * a link with the correct name to this node.
 272                          */
 273                         devfs_alias_create(rule->linkname, node);
 274                         applies = 1;
 275                 } else {
 276                         /*
 277                          * This is a normal ownership/permission rule. We
 278                          * just apply the permissions and ownership and
 279                          * we are done.
 280                          */
 281                         node->mode = rule->mode;
 282                         node->uid = rule->uid;
 283                         node->gid = rule->gid;
 284                         applies = 1;
 285                 }
 286         }
 287
 288         /* If we acquired the lock, we also get rid of it */
 289         if (locked)
 290                 lockmgr(&devfs_rule_lock, LK_RELEASE);
 291
 292         return applies;
 293 }
 294
 295
 296 static int
 297 devfs_rule_checkname(struct devfs_rule *rule, struct devfs_node *node)
 298 {
 299         struct devfs_node *parent = DEVFS_MNTDATA(node->mp)->root_node;
 300         char *path = NULL;
 301         char *name, name_buf[PATH_MAX];
 302         int no_match = 0;
 303
 304         devfs_resolve_name_path(rule->name, name_buf, &path, &name);
 305         parent = devfs_resolve_or_create_path(parent, path, 0);
 306
 307         if (parent == NULL)
 308                 return 0; /* no match */
 309
 310         /* Check if node is a child of the parent we found */
 311         if (node->parent != parent)
 312                 return 0; /* no match */
 313
 314         if (rule->rule_type & DEVFS_RULE_LINK)
 315                 no_match = memcmp(name, node->d_dir.d_name, strlen(name));
 316         else
 317                 no_match = WildCaseCmp(name, node->d_dir.d_name);
 318
 319         return !no_match;
 320 }
 321
 322
 323 static int
 324 devfs_dev_open(struct dev_open_args *ap)
 325 {
 326         /*
 327          * Only allow read-write access.
 328          */
 329         if (((ap->a_oflags & FWRITE) == 0) || ((ap->a_oflags & FREAD) == 0))
 330                 return(EPERM);
 331
 332         /*
 333          * We don't allow nonblocking access.
 334          */
 335         if ((ap->a_oflags & O_NONBLOCK) != 0) {
 336                 devfs_debug(DEVFS_DEBUG_SHOW, "devfs_dev: can't do nonblocking access\n");
 337                 return(ENODEV);
 338         }
 339
 340         return 0;
 341 }
 342
 343
 344 static int
 345 devfs_dev_close(struct dev_close_args *ap)
 346 {
 347         return 0;
 348 }
 349
 350
 351 static int
 352 devfs_dev_ioctl(struct dev_ioctl_args *ap)
 353 {
 354         int error;
 355         struct devfs_rule *rule;
 356         char mntpoint[PATH_MAX+1];
 357
 358         error = 0;
 359         rule = (struct devfs_rule *)ap->a_data;
 360
 361         switch(ap->a_cmd) {
 362         case DEVFS_RULE_ADD:
 363                 devfs_rule_insert(rule);
 364                 break;
 365
 366         case DEVFS_RULE_APPLY:
 367                 copyin(rule->mntpoint, mntpoint, rule->mntpointlen);
 368                 devfs_apply_rules(mntpoint);
 369                 break;
 370
 371         case DEVFS_RULE_CLEAR:
 372                 devfs_rule_clear(rule);
 373                 break;
 374
 375         case DEVFS_RULE_RESET:
 376                 copyin(rule->mntpoint, mntpoint, rule->mntpointlen);
 377                 devfs_reset_rules(mntpoint);
 378                 break;
 379
 380         default:
 381                 error = ENOTTY; /* Inappropriate ioctl for device */
 382                 break;
 383         }
 384
 385         return(error);
 386 }
 387
 388
 389 static void
 390 devfs_dev_init(void *unused)
 391 {
 392         lockinit(&devfs_rule_lock, "devfs_rule lock", 0, 0);
 393
 394     devfs_rule_cache = objcache_create("devfs-rule-cache", 0, 0,
 395                         NULL, NULL, NULL,
 396                         objcache_malloc_alloc,
 397                         objcache_malloc_free,
 398                         &devfs_rule_malloc_args );
 399
 400     devfs_dev = make_dev(&devfs_dev_ops,
 401             0,
 402             UID_ROOT,
 403             GID_WHEEL,
 404             0600,
 405             "devfs");
 406 }
 407
 408
 409 static void
 410 devfs_dev_uninit(void *unused)
 411 {
 412         /* XXX: destroy all rules first */
 413     destroy_dev(devfs_dev);
 414         objcache_destroy(devfs_rule_cache);
 415 }
 416
 417
 418 SYSINIT(devfsdev,SI_SUB_DRIVERS,SI_ORDER_FIRST,devfs_dev_init,NULL)
 419 SYSUNINIT(devfsdev, SI_SUB_DRIVERS,SI_ORDER_FIRST,devfs_dev_uninit, NULL);
 420
 421 #if 0
 422
 423 static int
 424 WildCmp(const char *w, const char *s)
 425 {
 426     int i;
 427     int c;
 428     int slen = strlen(s);
 429     const char **mary;
 430
 431     for (i = c = 0; w[i]; ++i) {
 432         if (w[i] == '*')
 433             ++c;
 434     }
 435     mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
 436     for (i = 0; i < c; ++i)
 437         mary[i] = s + slen;
 438     i = wildCmp(mary, 0, w, s);
 439     kfree(mary, M_DEVFS);
 440     return(i);
 441 }
 442
 443 #endif
 444
 445 static int
 446 WildCaseCmp(const char *w, const char *s)
 447 {
 448     int i;
 449     int c;
 450     int slen = strlen(s);
 451     const char **mary;
 452
 453     for (i = c = 0; w[i]; ++i) {
 454         if (w[i] == '*')
 455             ++c;
 456     }
 457     mary = kmalloc(sizeof(char *) * (c + 1), M_DEVFS, M_WAITOK);
 458     for (i = 0; i < c; ++i)
 459         mary[i] = s + slen;
 460     i = wildCaseCmp(mary, 0, w, s);
 461     kfree(mary, M_DEVFS);
 462     return(i);
 463 }
 464
 465 /*
 466  * WildCmp() - compare wild string to sane string
 467  *
 468  *      Returns 0 on success, -1 on failure.
 469  */
 470 static int
 471 wildCmp(const char **mary, int d, const char *w, const char *s)
 472 {
 473     int i;
 474
 475     /*
 476      * skip fixed portion
 477      */
 478     for (;;) {
 479         switch(*w) {
 480         case '*':
 481             /*
 482              * optimize terminator
 483              */
 484             if (w[1] == 0)
 485                 return(0);
 486             if (w[1] != '?' && w[1] != '*') {
 487                 /*
 488                  * optimize * followed by non-wild
 489                  */
 490                 for (i = 0; s + i < mary[d]; ++i) {
 491                     if (s[i] == w[1] && wildCmp(mary, d + 1, w + 1, s + i) == 0)
 492                         return(0);
 493                 }
 494             } else {
 495                 /*
 496                  * less-optimal
 497                  */
 498                 for (i = 0; s + i < mary[d]; ++i) {
 499                     if (wildCmp(mary, d + 1, w + 1, s + i) == 0)
 500                         return(0);
 501                 }
 502             }
 503             mary[d] = s;
 504             return(-1);
 505         case '?':
 506             if (*s == 0)
 507                 return(-1);
 508             ++w;
 509             ++s;
 510             break;
 511         default:
 512             if (*w != *s)
 513                 return(-1);
 514             if (*w == 0)        /* terminator */
 515                 return(0);
 516             ++w;
 517             ++s;
 518             break;
 519         }
 520     }
 521     /* not reached */
 522     return(-1);
 523 }
 524
 525
 526 /*
 527  * WildCaseCmp() - compare wild string to sane string, case insensitive
 528  *
 529  *      Returns 0 on success, -1 on failure.
 530  */
 531 static int
 532 wildCaseCmp(const char **mary, int d, const char *w, const char *s)
 533 {
 534     int i;
 535
 536     /*
 537      * skip fixed portion
 538      */
 539     for (;;) {
 540         switch(*w) {
 541         case '*':
 542             /*
 543              * optimize terminator
 544              */
 545             if (w[1] == 0)
 546                 return(0);
 547             if (w[1] != '?' && w[1] != '*') {
 548                 /*
 549                  * optimize * followed by non-wild
 550                  */
 551                 for (i = 0; s + i < mary[d]; ++i) {
 552                     if (s[i] == w[1] && wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
 553                         return(0);
 554                 }
 555             } else {
 556                 /*
 557                  * less-optimal
 558                  */
 559                 for (i = 0; s + i < mary[d]; ++i) {
 560                     if (wildCaseCmp(mary, d + 1, w + 1, s + i) == 0)
 561                         return(0);
 562                 }
 563             }
 564             mary[d] = s;
 565             return(-1);
 566         case '?':
 567             if (*s == 0)
 568                 return(-1);
 569             ++w;
 570             ++s;
 571             break;
 572         default:
 573             if (*w != *s) {
 574 #define tolower(x)      ((x >= 'A' && x <= 'Z')?(x+('a'-'A')):(x))
 575                 if (tolower(*w) != tolower(*s))
 576                     return(-1);
 577             }
 578             if (*w == 0)        /* terminator */
 579                 return(0);
 580             ++w;
 581             ++s;
 582             break;
 583         }
 584     }
 585     /* not reached */
 586     return(-1);
 587 }