include/applets.src.h

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * applets.h - a listing of all busybox applets.
   4  *
   5  * If you write a new applet, you need to add an entry to this list to make
   6  * busybox aware of it.
   7  */
   8
   9 /*
  10 name  - applet name as it is typed on command line
  11 help  - applet name, converted to C (ether-wake: help = ether_wake)
  12 main  - corresponding <applet>_main to call (bzcat: main = bunzip2)
  13 l     - location to install link to: [/usr]/[s]bin
  14 s     - suid type:
  15         BB_SUID_REQUIRE: will complain if busybox isn't suid
  16         and is run by non-root (applet_main() will not be called at all)
  17         BB_SUID_DROP: will drop suid prior to applet_main()
  18         BB_SUID_MAYBE: neither of the above
  19         (every instance of BB_SUID_REQUIRE and BB_SUID_MAYBE
  20         needs to be justified in comment)
  21         NB: please update FEATURE_SUID help text whenever you add/remove
  22         BB_SUID_REQUIRE or BB_SUID_MAYBE applet.
  23 */
  24
  25 #if defined(PROTOTYPES)
  26 # define APPLET(name,l,s)                    int name##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  27 # define APPLET_ODDNAME(name,main,l,s,help)  int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  28 # define APPLET_NOEXEC(name,main,l,s,help)   int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  29 # define APPLET_NOFORK(name,main,l,s,help)   int main##_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  30
  31 #elif defined(NAME_MAIN)
  32 # define APPLET(name,l,s)                    name name##_main
  33 # define APPLET_ODDNAME(name,main,l,s,help)  name main##_main
  34 # define APPLET_NOEXEC(name,main,l,s,help)   name main##_main
  35 # define APPLET_NOFORK(name,main,l,s,help)   name main##_main
  36
  37 #elif defined(MAKE_USAGE) && ENABLE_FEATURE_VERBOSE_USAGE
  38 # define APPLET(name,l,s)                    MAKE_USAGE(#name, name##_trivial_usage name##_full_usage)
  39 # define APPLET_ODDNAME(name,main,l,s,help)  MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
  40 # define APPLET_NOEXEC(name,main,l,s,help)   MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
  41 # define APPLET_NOFORK(name,main,l,s,help)   MAKE_USAGE(#name, help##_trivial_usage help##_full_usage)
  42
  43 #elif defined(MAKE_USAGE) && !ENABLE_FEATURE_VERBOSE_USAGE
  44 # define APPLET(name,l,s)                    MAKE_USAGE(#name, name##_trivial_usage)
  45 # define APPLET_ODDNAME(name,main,l,s,help)  MAKE_USAGE(#name, help##_trivial_usage)
  46 # define APPLET_NOEXEC(name,main,l,s,help)   MAKE_USAGE(#name, help##_trivial_usage)
  47 # define APPLET_NOFORK(name,main,l,s,help)   MAKE_USAGE(#name, help##_trivial_usage)
  48
  49 #elif defined(MAKE_LINKS)
  50 # define APPLET(name,l,c)                    LINK l name
  51 # define APPLET_ODDNAME(name,main,l,s,help)  LINK l name
  52 # define APPLET_NOEXEC(name,main,l,s,help)   LINK l name
  53 # define APPLET_NOFORK(name,main,l,s,help)   LINK l name
  54
  55 #elif defined(MAKE_SUID)
  56 # define APPLET(name,l,s)                    SUID s l name
  57 # define APPLET_ODDNAME(name,main,l,s,help)  SUID s l name
  58 # define APPLET_NOEXEC(name,main,l,s,help)   SUID s l name
  59 # define APPLET_NOFORK(name,main,l,s,help)   SUID s l name
  60
  61 #else
  62   static struct bb_applet applets[] = { /*    name, main, location, need_suid */
  63 # define APPLET(name,l,s)                    { #name, #name, l, s },
  64 # define APPLET_ODDNAME(name,main,l,s,help)  { #name, #main, l, s },
  65 # define APPLET_NOEXEC(name,main,l,s,help)   { #name, #main, l, s, 1 },
  66 # define APPLET_NOFORK(name,main,l,s,help)   { #name, #main, l, s, 1, 1 },
  67 #endif
  68
  69 #if ENABLE_INSTALL_NO_USR
  70 # define BB_DIR_USR_BIN BB_DIR_BIN
  71 # define BB_DIR_USR_SBIN BB_DIR_SBIN
  72 #endif
  73
  74
  75 INSERT
  76 IF_TEST(APPLET_NOFORK([,  test, BB_DIR_USR_BIN, BB_SUID_DROP, test))
  77 IF_TEST(APPLET_NOFORK([[, test, BB_DIR_USR_BIN, BB_SUID_DROP, test))
  78 IF_ACPID(APPLET(acpid, BB_DIR_SBIN, BB_SUID_DROP))
  79 IF_BASENAME(APPLET_NOFORK(basename, basename, BB_DIR_USR_BIN, BB_SUID_DROP, basename))
  80 IF_BLKID(APPLET(blkid, BB_DIR_SBIN, BB_SUID_DROP))
  81 IF_CAL(APPLET(cal, BB_DIR_USR_BIN, BB_SUID_DROP))
  82 IF_CAT(APPLET_NOFORK(cat, cat, BB_DIR_BIN, BB_SUID_DROP, cat))
  83 IF_CATV(APPLET(catv, BB_DIR_BIN, BB_SUID_DROP))
  84 IF_CHCON(APPLET(chcon, BB_DIR_USR_BIN, BB_SUID_DROP))
  85 IF_CHGRP(APPLET_NOEXEC(chgrp, chgrp, BB_DIR_BIN, BB_SUID_DROP, chgrp))
  86 IF_CHMOD(APPLET_NOEXEC(chmod, chmod, BB_DIR_BIN, BB_SUID_DROP, chmod))
  87 IF_CHOWN(APPLET_NOEXEC(chown, chown, BB_DIR_BIN, BB_SUID_DROP, chown))
  88 IF_CHROOT(APPLET(chroot, BB_DIR_USR_SBIN, BB_SUID_DROP))
  89 IF_CKSUM(APPLET_NOEXEC(cksum, cksum, BB_DIR_USR_BIN, BB_SUID_DROP, cksum))
  90 IF_COMM(APPLET(comm, BB_DIR_USR_BIN, BB_SUID_DROP))
  91 IF_CP(APPLET_NOEXEC(cp, cp, BB_DIR_BIN, BB_SUID_DROP, cp))
  92 IF_CUT(APPLET_NOEXEC(cut, cut, BB_DIR_USR_BIN, BB_SUID_DROP, cut))
  93 IF_DD(APPLET_NOEXEC(dd, dd, BB_DIR_BIN, BB_SUID_DROP, dd))
  94 IF_DF(APPLET(df, BB_DIR_BIN, BB_SUID_DROP))
  95 IF_DHCPRELAY(APPLET(dhcprelay, BB_DIR_USR_SBIN, BB_SUID_DROP))
  96 IF_DIRNAME(APPLET_NOFORK(dirname, dirname, BB_DIR_USR_BIN, BB_SUID_DROP, dirname))
  97 IF_DMESG(APPLET(dmesg, BB_DIR_BIN, BB_SUID_DROP))
  98 IF_DOS2UNIX(APPLET_NOEXEC(dos2unix, dos2unix, BB_DIR_USR_BIN, BB_SUID_DROP, dos2unix))
  99 IF_DU(APPLET(du, BB_DIR_USR_BIN, BB_SUID_DROP))
 100 IF_DUMPLEASES(APPLET(dumpleases, BB_DIR_USR_BIN, BB_SUID_DROP))
 101 //IF_E2FSCK(APPLET(e2fsck, BB_DIR_SBIN, BB_SUID_DROP))
 102 //IF_E2LABEL(APPLET_ODDNAME(e2label, tune2fs, BB_DIR_SBIN, BB_SUID_DROP, e2label))
 103 IF_ECHO(APPLET_NOFORK(echo, echo, BB_DIR_BIN, BB_SUID_DROP, echo))
 104 IF_ENV(APPLET_NOEXEC(env, env, BB_DIR_USR_BIN, BB_SUID_DROP, env))
 105 IF_EXPAND(APPLET(expand, BB_DIR_USR_BIN, BB_SUID_DROP))
 106 IF_EXPR(APPLET(expr, BB_DIR_USR_BIN, BB_SUID_DROP))
 107 IF_FALSE(APPLET_NOFORK(false, false, BB_DIR_BIN, BB_SUID_DROP, false))
 108 IF_FBSET(APPLET(fbset, BB_DIR_USR_SBIN, BB_SUID_DROP))
 109 IF_FDFLUSH(APPLET_ODDNAME(fdflush, freeramdisk, BB_DIR_BIN, BB_SUID_DROP, fdflush))
 110 IF_FDFORMAT(APPLET(fdformat, BB_DIR_USR_SBIN, BB_SUID_DROP))
 111 IF_FDISK(APPLET(fdisk, BB_DIR_SBIN, BB_SUID_DROP))
 112 /* Benefits from suid root: better access to /dev/BLOCKDEVs: */
 113 IF_FINDFS(APPLET(findfs, BB_DIR_SBIN, BB_SUID_MAYBE))
 114 IF_FLOCK(APPLET(flock, BB_DIR_USR_BIN, BB_SUID_DROP))
 115 IF_FOLD(APPLET_NOEXEC(fold, fold, BB_DIR_USR_BIN, BB_SUID_DROP, fold))
 116 IF_FREERAMDISK(APPLET(freeramdisk, BB_DIR_SBIN, BB_SUID_DROP))
 117 //IF_E2FSCK(APPLET_ODDNAME(fsck.ext2, e2fsck, BB_DIR_SBIN, BB_SUID_DROP, fsck_ext2))
 118 //IF_E2FSCK(APPLET_ODDNAME(fsck.ext3, e2fsck, BB_DIR_SBIN, BB_SUID_DROP, fsck_ext3))
 119 IF_FSCK_MINIX(APPLET_ODDNAME(fsck.minix, fsck_minix, BB_DIR_SBIN, BB_SUID_DROP, fsck_minix))
 120 IF_FSYNC(APPLET_NOFORK(fsync, fsync, BB_DIR_BIN, BB_SUID_DROP, fsync))
 121 IF_GETENFORCE(APPLET(getenforce, BB_DIR_USR_SBIN, BB_SUID_DROP))
 122 IF_GETOPT(APPLET(getopt, BB_DIR_BIN, BB_SUID_DROP))
 123 IF_GETSEBOOL(APPLET(getsebool, BB_DIR_USR_SBIN, BB_SUID_DROP))
 124 IF_HD(APPLET_NOEXEC(hd, hexdump, BB_DIR_USR_BIN, BB_SUID_DROP, hd))
 125 IF_HEAD(APPLET_NOEXEC(head, head, BB_DIR_USR_BIN, BB_SUID_DROP, head))
 126 IF_HEXDUMP(APPLET_NOEXEC(hexdump, hexdump, BB_DIR_USR_BIN, BB_SUID_DROP, hexdump))
 127 IF_HWCLOCK(APPLET(hwclock, BB_DIR_SBIN, BB_SUID_DROP))
 128 IF_INSTALL(APPLET(install, BB_DIR_USR_BIN, BB_SUID_DROP))
 129 IF_IPCRM(APPLET(ipcrm, BB_DIR_USR_BIN, BB_SUID_DROP))
 130 IF_IPCS(APPLET(ipcs, BB_DIR_USR_BIN, BB_SUID_DROP))
 131 //IF_LENGTH(APPLET_NOFORK(length, length, BB_DIR_USR_BIN, BB_SUID_DROP, length))
 132 IF_LN(APPLET_NOEXEC(ln, ln, BB_DIR_BIN, BB_SUID_DROP, ln))
 133 IF_LOAD_POLICY(APPLET(load_policy, BB_DIR_USR_SBIN, BB_SUID_DROP))
 134 IF_LOGNAME(APPLET_NOFORK(logname, logname, BB_DIR_USR_BIN, BB_SUID_DROP, logname))
 135 IF_LOSETUP(APPLET(losetup, BB_DIR_SBIN, BB_SUID_DROP))
 136 IF_LS(APPLET_NOEXEC(ls, ls, BB_DIR_BIN, BB_SUID_DROP, ls))
 137 IF_LSPCI(APPLET(lspci, BB_DIR_USR_BIN, BB_SUID_DROP))
 138 IF_LSUSB(APPLET(lsusb, BB_DIR_USR_BIN, BB_SUID_DROP))
 139 IF_MATCHPATHCON(APPLET(matchpathcon, BB_DIR_USR_SBIN, BB_SUID_DROP))
 140 IF_MKDIR(APPLET_NOFORK(mkdir, mkdir, BB_DIR_BIN, BB_SUID_DROP, mkdir))
 141 IF_MKFIFO(APPLET_NOEXEC(mkfifo, mkfifo, BB_DIR_USR_BIN, BB_SUID_DROP, mkfifo))
 142 IF_MKFS_MINIX(APPLET_ODDNAME(mkfs.minix, mkfs_minix, BB_DIR_SBIN, BB_SUID_DROP, mkfs_minix))
 143 IF_MKFS_REISER(APPLET_ODDNAME(mkfs.reiser, mkfs_reiser, BB_DIR_SBIN, BB_SUID_DROP, mkfs_reiser))
 144 IF_MKNOD(APPLET_NOEXEC(mknod, mknod, BB_DIR_BIN, BB_SUID_DROP, mknod))
 145 IF_MKSWAP(APPLET(mkswap, BB_DIR_SBIN, BB_SUID_DROP))
 146 IF_MORE(APPLET(more, BB_DIR_BIN, BB_SUID_DROP))
 147 /* On full-blown systems, requires suid for user mounts.
 148  * But it's not unthinkable to have it available in non-suid flavor on some systems,
 149  * for viewing mount table.
 150  * Therefore we use BB_SUID_MAYBE instead of BB_SUID_REQUIRE: */
 151 IF_MOUNT(APPLET(mount, BB_DIR_BIN, IF_DESKTOP(BB_SUID_MAYBE) IF_NOT_DESKTOP(BB_SUID_DROP)))
 152 IF_MV(APPLET(mv, BB_DIR_BIN, BB_SUID_DROP))
 153 IF_NICE(APPLET(nice, BB_DIR_BIN, BB_SUID_DROP))
 154 IF_NOHUP(APPLET(nohup, BB_DIR_USR_BIN, BB_SUID_DROP))
 155 IF_OD(APPLET(od, BB_DIR_USR_BIN, BB_SUID_DROP))
 156 //IF_PARSE(APPLET(parse, BB_DIR_USR_BIN, BB_SUID_DROP))
 157 IF_PIVOT_ROOT(APPLET(pivot_root, BB_DIR_SBIN, BB_SUID_DROP))
 158 IF_PRINTENV(APPLET_NOFORK(printenv, printenv, BB_DIR_BIN, BB_SUID_DROP, printenv))
 159 IF_PRINTF(APPLET_NOFORK(printf, printf, BB_DIR_USR_BIN, BB_SUID_DROP, printf))
 160 IF_PWD(APPLET_NOFORK(pwd, pwd, BB_DIR_BIN, BB_SUID_DROP, pwd))
 161 IF_RDATE(APPLET(rdate, BB_DIR_USR_SBIN, BB_SUID_DROP))
 162 IF_RDEV(APPLET(rdev, BB_DIR_USR_SBIN, BB_SUID_DROP))
 163 IF_READLINK(APPLET(readlink, BB_DIR_USR_BIN, BB_SUID_DROP))
 164 IF_READPROFILE(APPLET(readprofile, BB_DIR_USR_SBIN, BB_SUID_DROP))
 165 IF_REALPATH(APPLET(realpath, BB_DIR_USR_BIN, BB_SUID_DROP))
 166 IF_RESTORECON(APPLET_ODDNAME(restorecon, setfiles, BB_DIR_SBIN, BB_SUID_DROP, restorecon))
 167 IF_RM(APPLET_NOFORK(rm, rm, BB_DIR_BIN, BB_SUID_DROP, rm))
 168 IF_RMDIR(APPLET_NOFORK(rmdir, rmdir, BB_DIR_BIN, BB_SUID_DROP, rmdir))
 169 IF_RTCWAKE(APPLET(rtcwake, BB_DIR_USR_SBIN, BB_SUID_DROP))
 170 IF_RUNCON(APPLET(runcon, BB_DIR_USR_BIN, BB_SUID_DROP))
 171 IF_SCRIPT(APPLET(script, BB_DIR_USR_BIN, BB_SUID_DROP))
 172 IF_SCRIPTREPLAY(APPLET(scriptreplay, BB_DIR_BIN, BB_SUID_DROP))
 173 IF_SELINUXENABLED(APPLET(selinuxenabled, BB_DIR_USR_SBIN, BB_SUID_DROP))
 174 IF_SEQ(APPLET_NOFORK(seq, seq, BB_DIR_USR_BIN, BB_SUID_DROP, seq))
 175 IF_SESTATUS(APPLET(sestatus, BB_DIR_USR_SBIN, BB_SUID_DROP))
 176 IF_SETENFORCE(APPLET(setenforce, BB_DIR_USR_SBIN, BB_SUID_DROP))
 177 IF_SETFILES(APPLET(setfiles, BB_DIR_SBIN, BB_SUID_DROP))
 178 IF_SETSEBOOL(APPLET(setsebool, BB_DIR_USR_SBIN, BB_SUID_DROP))
 179 /* Do not make this applet NOFORK. It breaks ^C-ing of pauses in shells: */
 180 IF_SLEEP(APPLET(sleep, BB_DIR_BIN, BB_SUID_DROP))
 181 IF_SORT(APPLET_NOEXEC(sort, sort, BB_DIR_USR_BIN, BB_SUID_DROP, sort))
 182 IF_SPLIT(APPLET(split, BB_DIR_USR_BIN, BB_SUID_DROP))
 183 IF_STAT(APPLET(stat, BB_DIR_BIN, BB_SUID_DROP))
 184 IF_STTY(APPLET(stty, BB_DIR_BIN, BB_SUID_DROP))
 185 IF_SUM(APPLET(sum, BB_DIR_USR_BIN, BB_SUID_DROP))
 186 IF_SWITCH_ROOT(APPLET(switch_root, BB_DIR_SBIN, BB_SUID_DROP))
 187 IF_TAC(APPLET_NOEXEC(tac, tac, BB_DIR_USR_BIN, BB_SUID_DROP, tac))
 188 IF_TAIL(APPLET(tail, BB_DIR_USR_BIN, BB_SUID_DROP))
 189 IF_TEE(APPLET(tee, BB_DIR_USR_BIN, BB_SUID_DROP))
 190 IF_TEST(APPLET_NOFORK(test, test, BB_DIR_USR_BIN, BB_SUID_DROP, test))
 191 IF_TR(APPLET(tr, BB_DIR_USR_BIN, BB_SUID_DROP))
 192 IF_TRUE(APPLET_NOFORK(true, true, BB_DIR_BIN, BB_SUID_DROP, true))
 193 IF_TTY(APPLET(tty, BB_DIR_USR_BIN, BB_SUID_DROP))
 194 IF_UDHCPC(APPLET(udhcpc, BB_DIR_SBIN, BB_SUID_DROP))
 195 IF_UDHCPD(APPLET(udhcpd, BB_DIR_USR_SBIN, BB_SUID_DROP))
 196 IF_UMOUNT(APPLET(umount, BB_DIR_BIN, BB_SUID_DROP))
 197 IF_UNAME(APPLET(uname, BB_DIR_BIN, BB_SUID_DROP))
 198 IF_UNEXPAND(APPLET_ODDNAME(unexpand, expand, BB_DIR_USR_BIN, BB_SUID_DROP, unexpand))
 199 IF_UNIQ(APPLET(uniq, BB_DIR_USR_BIN, BB_SUID_DROP))
 200 IF_UNIX2DOS(APPLET_NOEXEC(unix2dos, dos2unix, BB_DIR_USR_BIN, BB_SUID_DROP, unix2dos))
 201 IF_USLEEP(APPLET_NOFORK(usleep, usleep, BB_DIR_BIN, BB_SUID_DROP, usleep))
 202 IF_UUDECODE(APPLET(uudecode, BB_DIR_USR_BIN, BB_SUID_DROP))
 203 IF_UUENCODE(APPLET(uuencode, BB_DIR_USR_BIN, BB_SUID_DROP))
 204 IF_WC(APPLET(wc, BB_DIR_USR_BIN, BB_SUID_DROP))
 205 IF_WHOAMI(APPLET_NOFORK(whoami, whoami, BB_DIR_USR_BIN, BB_SUID_DROP, whoami))
 206 IF_YES(APPLET_NOFORK(yes, yes, BB_DIR_USR_BIN, BB_SUID_DROP, yes))
 207
 208 #if !defined(PROTOTYPES) && !defined(NAME_MAIN) && !defined(MAKE_USAGE) \
 209         && !defined(MAKE_LINKS) && !defined(MAKE_SUID)
 210 };
 211 #endif
 212
 213 #undef APPLET
 214 #undef APPLET_ODDNAME
 215 #undef APPLET_NOEXEC
 216 #undef APPLET_NOFORK