switch_root.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. /* vi: set sw=4 ts=4: */
  2. /*
  3. * Copyright 2005 Rob Landley <rob@landley.net>
  4. *
  5. * Switch from rootfs to another filesystem as the root of the mount tree.
  6. *
  7. * Licensed under GPLv2, see file LICENSE in this source tree.
  8. */
  9. //config:config SWITCH_ROOT
  10. //config: bool "switch_root (5.7 kb)"
  11. //config: default y
  12. //config: help
  13. //config: The switch_root utility is used from initramfs to select a new
  14. //config: root device. Under initramfs, you have to use this instead of
  15. //config: pivot_root. (Stop reading here if you don't care why.)
  16. //config:
  17. //config: Booting with initramfs extracts a gzipped cpio archive into rootfs
  18. //config: (which is a variant of ramfs/tmpfs). Because rootfs can't be moved
  19. //config: or unmounted*, pivot_root will not work from initramfs. Instead,
  20. //config: switch_root deletes everything out of rootfs (including itself),
  21. //config: does a mount --move that overmounts rootfs with the new root, and
  22. //config: then execs the specified init program.
  23. //config:
  24. //config: * Because the Linux kernel uses rootfs internally as the starting
  25. //config: and ending point for searching through the kernel's doubly linked
  26. //config: list of active mount points. That's why.
  27. //config:
  28. // RUN_INIT config item is in klibc-utils
  29. //applet:IF_SWITCH_ROOT(APPLET(switch_root, BB_DIR_SBIN, BB_SUID_DROP))
  30. // APPLET_ODDNAME:name main location suid_type help
  31. //applet:IF_RUN_INIT( APPLET_ODDNAME(run-init, switch_root, BB_DIR_SBIN, BB_SUID_DROP, run_init))
  32. //kbuild:lib-$(CONFIG_SWITCH_ROOT) += switch_root.o
  33. //kbuild:lib-$(CONFIG_RUN_INIT) += switch_root.o
  34. #include <sys/vfs.h>
  35. #include <sys/mount.h>
  36. #if ENABLE_RUN_INIT
  37. # include <sys/prctl.h>
  38. # ifndef PR_CAPBSET_READ
  39. # define PR_CAPBSET_READ 23
  40. # endif
  41. # ifndef PR_CAPBSET_DROP
  42. # define PR_CAPBSET_DROP 24
  43. # endif
  44. # include <linux/capability.h>
  45. // #include <sys/capability.h>
  46. // This header is in libcap, but the functions are in libc.
  47. // Comment in the header says this above capset/capget:
  48. /* system calls - look to libc for function to system call mapping */
  49. extern int capset(cap_user_header_t header, cap_user_data_t data);
  50. extern int capget(cap_user_header_t header, const cap_user_data_t data);
  51. // so for bbox, let's just repeat the declarations.
  52. // This way, libcap needs not be installed in build environment.
  53. #endif
  54. #include "libbb.h"
  55. // Make up for header deficiencies
  56. #ifndef RAMFS_MAGIC
  57. # define RAMFS_MAGIC ((unsigned)0x858458f6)
  58. #endif
  59. #ifndef TMPFS_MAGIC
  60. # define TMPFS_MAGIC ((unsigned)0x01021994)
  61. #endif
  62. #ifndef MS_MOVE
  63. # define MS_MOVE 8192
  64. #endif
  65. static void delete_contents(const char *directory, dev_t rootdev);
  66. static int FAST_FUNC rmrf(const char *directory, struct dirent *d, void *rootdevp)
  67. {
  68. char *newdir = concat_subpath_file(directory, d->d_name);
  69. if (newdir) { // not . or ..
  70. // Recurse to delete contents
  71. delete_contents(newdir, *(dev_t*)rootdevp);
  72. free(newdir);
  73. }
  74. return 0;
  75. }
  76. // Recursively delete contents of rootfs
  77. static void delete_contents(const char *directory, dev_t rootdev)
  78. {
  79. struct stat st;
  80. // Don't descend into other filesystems
  81. if (lstat(directory, &st) || st.st_dev != rootdev)
  82. return;
  83. // Recursively delete the contents of directories
  84. if (S_ISDIR(st.st_mode)) {
  85. iterate_on_dir(directory, rmrf, &rootdev);
  86. } else {
  87. // It wasn't a directory, zap it
  88. unlink(directory);
  89. }
  90. }
  91. #if ENABLE_RUN_INIT
  92. DEFINE_STRUCT_CAPS;
  93. static void drop_capset(int cap_idx)
  94. {
  95. struct caps caps;
  96. getcaps(&caps);
  97. caps.data[CAP_TO_INDEX(cap_idx)].inheritable &= ~CAP_TO_MASK(cap_idx);
  98. if (capset(&caps.header, caps.data) != 0)
  99. bb_simple_perror_msg_and_die("capset");
  100. }
  101. static void drop_bounding_set(int cap_idx)
  102. {
  103. int ret;
  104. ret = prctl(PR_CAPBSET_READ, cap_idx, 0, 0, 0);
  105. if (ret < 0)
  106. bb_perror_msg_and_die("prctl: %s", "PR_CAPBSET_READ");
  107. if (ret == 1) {
  108. ret = prctl(PR_CAPBSET_DROP, cap_idx, 0, 0, 0);
  109. if (ret != 0)
  110. bb_perror_msg_and_die("prctl: %s", "PR_CAPBSET_DROP");
  111. }
  112. }
  113. static void drop_usermodehelper(const char *filename, int cap_idx)
  114. {
  115. unsigned lo, hi;
  116. char buf[sizeof(int)*3 * 2 + 8];
  117. int fd;
  118. int ret;
  119. ret = open_read_close(filename, buf, sizeof(buf) - 1);
  120. if (ret < 0)
  121. return; /* assuming files do not exist */
  122. buf[ret] = '\0';
  123. ret = sscanf(buf, "%u %u", &lo, &hi);
  124. if (ret != 2)
  125. bb_perror_msg_and_die("can't parse file '%s'", filename);
  126. if (cap_idx < 32)
  127. lo &= ~(1 << cap_idx);
  128. else
  129. hi &= ~(1 << (cap_idx - 32));
  130. fd = xopen(filename, O_WRONLY);
  131. fdprintf(fd, "%u %u", lo, hi);
  132. close(fd);
  133. }
  134. static void drop_capabilities(char *string)
  135. {
  136. char *cap;
  137. cap = strtok_r(string, ",", &string);
  138. while (cap) {
  139. unsigned cap_idx;
  140. cap_idx = cap_name_to_number(cap);
  141. drop_usermodehelper("/proc/sys/kernel/usermodehelper/bset", cap_idx);
  142. drop_usermodehelper("/proc/sys/kernel/usermodehelper/inheritable", cap_idx);
  143. drop_bounding_set(cap_idx);
  144. drop_capset(cap_idx);
  145. bb_error_msg("dropped capability: %s", cap);
  146. cap = strtok_r(NULL, ",", &string);
  147. }
  148. }
  149. #endif
  150. int switch_root_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
  151. int switch_root_main(int argc UNUSED_PARAM, char **argv)
  152. {
  153. char *newroot, *console = NULL;
  154. struct stat st;
  155. struct statfs stfs;
  156. unsigned dry_run = 0;
  157. dev_t rootdev;
  158. // Parse args. '+': stop at first non-option
  159. if (ENABLE_SWITCH_ROOT && (!ENABLE_RUN_INIT || applet_name[0] == 's')) {
  160. //usage:#define switch_root_trivial_usage
  161. //usage: "[-c CONSOLE_DEV] NEW_ROOT NEW_INIT [ARGS]"
  162. //usage:#define switch_root_full_usage "\n\n"
  163. //usage: "Free initramfs and switch to another root fs:\n"
  164. //usage: "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n"
  165. //usage: "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n"
  166. //usage: "\n -c DEV Reopen stdio to DEV after switch"
  167. getopt32(argv, "^+"
  168. "c:"
  169. "\0" "-2" /* minimum 2 args */,
  170. &console
  171. );
  172. } else {
  173. #if ENABLE_RUN_INIT
  174. //usage:#define run_init_trivial_usage
  175. //usage: "[-d CAP,CAP...] [-n] [-c CONSOLE_DEV] NEW_ROOT NEW_INIT [ARGS]"
  176. //usage:#define run_init_full_usage "\n\n"
  177. //usage: "Free initramfs and switch to another root fs:\n"
  178. //usage: "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n"
  179. //usage: "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n"
  180. //usage: "\n -c DEV Reopen stdio to DEV after switch"
  181. //usage: "\n -d CAPS Drop capabilities"
  182. //usage: "\n -n Dry run"
  183. char *cap_list = NULL;
  184. dry_run = getopt32(argv, "^+"
  185. "c:d:n"
  186. "\0" "-2" /* minimum 2 args */,
  187. &console,
  188. &cap_list
  189. );
  190. dry_run >>= 2; // -n
  191. if (cap_list)
  192. drop_capabilities(cap_list);
  193. #endif
  194. }
  195. argv += optind;
  196. newroot = *argv++;
  197. // Change to new root directory and verify it's a different fs
  198. xchdir(newroot);
  199. xstat("/", &st);
  200. rootdev = st.st_dev;
  201. xstat(".", &st);
  202. if (st.st_dev == rootdev) {
  203. // Show usage, it says new root must be a mountpoint
  204. bb_show_usage();
  205. }
  206. if (!dry_run && getpid() != 1) {
  207. // Show usage, it says we must be PID 1
  208. bb_show_usage();
  209. }
  210. // Additional sanity checks: we're about to rm -rf /, so be REALLY SURE
  211. // we mean it. I could make this a CONFIG option, but I would get email
  212. // from all the people who WILL destroy their filesystems.
  213. if (stat("/init", &st) != 0 || !S_ISREG(st.st_mode)) {
  214. bb_error_msg_and_die("'%s' is not a regular file", "/init");
  215. }
  216. statfs("/", &stfs); // this never fails
  217. if ((unsigned)stfs.f_type != RAMFS_MAGIC
  218. && (unsigned)stfs.f_type != TMPFS_MAGIC
  219. ) {
  220. bb_simple_error_msg_and_die("root filesystem is not ramfs/tmpfs");
  221. }
  222. if (!dry_run) {
  223. // Zap everything out of rootdev
  224. delete_contents("/", rootdev);
  225. // Overmount / with newdir and chroot into it
  226. if (mount(".", "/", NULL, MS_MOVE, NULL)) {
  227. // For example, fails when newroot is not a mountpoint
  228. bb_simple_perror_msg_and_die("error moving root");
  229. }
  230. }
  231. xchroot(".");
  232. // The chdir is needed to recalculate "." and ".." links
  233. /*xchdir("/"); - done in xchroot */
  234. // If a new console specified, redirect stdin/stdout/stderr to it
  235. if (console) {
  236. int fd = open_or_warn(console, O_RDWR);
  237. if (fd >= 0) {
  238. xmove_fd(fd, 0);
  239. xdup2(0, 1);
  240. xdup2(0, 2);
  241. }
  242. }
  243. if (dry_run) {
  244. // Does NEW_INIT look like it can be executed?
  245. //xstat(argv[0], &st);
  246. //if (!S_ISREG(st.st_mode))
  247. // bb_perror_msg_and_die("'%s' is not a regular file", argv[0]);
  248. if (access(argv[0], X_OK) == 0)
  249. return 0;
  250. } else {
  251. // Exec NEW_INIT
  252. execv(argv[0], argv);
  253. }
  254. bb_perror_msg_and_die("can't execute '%s'", argv[0]);
  255. }
  256. /*
  257. From: Rob Landley <rob@landley.net>
  258. Date: Tue, Jun 16, 2009 at 7:47 PM
  259. Subject: Re: switch_root...
  260. ...
  261. ...
  262. ...
  263. If you're _not_ running out of init_ramfs (if for example you're using initrd
  264. instead), you probably shouldn't use switch_root because it's the wrong tool.
  265. Basically what the sucker does is something like the following shell script:
  266. find / -xdev | xargs rm -rf
  267. cd "$1"
  268. shift
  269. mount --move . /
  270. exec chroot . "$@"
  271. There are a couple reasons that won't work as a shell script:
  272. 1) If you delete the commands out of your $PATH, your shell scripts can't run
  273. more commands, but you can't start using dynamically linked _new_ commands
  274. until after you do the chroot because the path to the dynamic linker is wrong.
  275. So there's a step that needs to be sort of atomic but can't be as a shell
  276. script. (You can work around this with static linking or very carefully laid
  277. out paths and sequencing, but it's brittle, ugly, and non-obvious.)
  278. 2) The "find | rm" bit will actually delete everything because the mount points
  279. still show up (even if their contents don't), and rm -rf will then happily zap
  280. that. So the first line is an oversimplification of what you need to do _not_
  281. to descend into other filesystems and delete their contents.
  282. The reason we do this is to free up memory, by the way. Since initramfs is a
  283. ramfs, deleting its contents frees up the memory it uses. (We leave it with
  284. one remaining dentry for the new mount point, but that's ok.)
  285. Note that you cannot ever umount rootfs, for approximately the same reason you
  286. can't kill PID 1. The kernel tracks mount points as a doubly linked list, and
  287. the pointer to the start/end of that list always points to an entry that's
  288. known to be there (rootfs), so it never has to worry about moving that pointer
  289. and it never has to worry about the list being empty. (Back around 2.6.13
  290. there _was_ a bug that let you umount rootfs, and the system locked hard the
  291. instant you did so endlessly looping to find the end of the mount list and
  292. never stopping. They fixed it.)
  293. Oh, and the reason we mount --move _and_ do the chroot is due to the way "/"
  294. works. Each process has two special symlinks, ".", and "/". Each of them
  295. points to the dentry of a directory, and give you a location paths can start
  296. from. (Historically ".." was also special, because you could enter a
  297. directory via a symlink so backing out to the directory you came from doesn't
  298. necessarily mean the one physically above where "." points to. These days I
  299. think it's just handed off to the filesystem.)
  300. Anyway, path resolution starts with "." or "/" (although the "./" at the start
  301. of the path may be implicit), meaning it's relative to one of those two
  302. directories. Your current directory, and your current root directory. The
  303. chdir() syscall changes where "." points to, and the chroot() syscall changes
  304. where "/" points to. (Again, both are per-process which is why chroot only
  305. affects your current process and its child processes.)
  306. Note that chroot() does _not_ change where "." points to, and back before they
  307. put crazy security checks into the kernel your current directory could be
  308. somewhere you could no longer access after the chroot. (The command line
  309. chroot does a cd as well, the chroot _syscall_ is what I'm talking about.)
  310. The reason mounting something new over / has no obvious effect is the same
  311. reason mounting something over your current directory has no obvious effect:
  312. the . and / links aren't recalculated after a mount, so they still point to
  313. the same dentry they did before, even if that dentry is no longer accessible
  314. by other means. Note that "cd ." is a NOP, and "chroot /" is a nop; both look
  315. up the cached dentry and set it right back. They don't re-parse any paths,
  316. because they're what all paths your process uses would be relative to.
  317. That's why the careful sequencing above: we cd into the new mount point before
  318. we do the mount --move. Moving the mount point would otherwise make it
  319. totally inaccessible to us because cd-ing to the old path wouldn't give it to
  320. us anymore, and cd "/" just gives us the cached dentry from when the process
  321. was created (in this case the old initramfs one). But the "." symlink gives
  322. us the dentry of the filesystem we just moved, so we can then "chroot ." to
  323. copy that dentry to "/" and get the new filesystem. If we _didn't_ save that
  324. dentry in "." we couldn't get it back after the mount --move.
  325. (Yes, this is all screwy and I had to email questions to Linus Torvalds to get
  326. it straight myself. I keep meaning to write up a "how mount actually works"
  327. document someday...)
  328. */