blob: eeae2f391a7671c200f28a73934aa04da5d30024 [file] [log] [blame]
landley13bab2f2006-09-27 00:45:05 -04001/* Toybox infrastructure.
2 *
3 * Copyright 2006 Rob Landley <rob@landley.net>
landley13bab2f2006-09-27 00:45:05 -04004 */
5
landleyc5621502006-09-28 17:18:51 -04006#include "toys.h"
7
Rob Landley90afbad2015-04-17 02:46:11 -05008#ifndef TOYBOX_VERSION
Rob Landleyd2893d82016-02-02 11:12:05 -06009#define TOYBOX_VERSION "0.7.0"
Rob Landley90afbad2015-04-17 02:46:11 -050010#endif
Rob Landleyad602aa2015-04-05 19:23:36 -050011
Rob Landleyf2311a42006-11-04 17:45:18 -050012// Populate toy_list[].
landleyc5621502006-09-28 17:18:51 -040013
Rob Landleya6d696b2007-01-31 13:31:19 -050014#undef NEWTOY
15#undef OLDTOY
16#define NEWTOY(name, opts, flags) {#name, name##_main, opts, flags},
Rob Landleyf3e56f42014-12-31 21:30:59 -060017#define OLDTOY(name, oldname, flags) \
18 {#name, oldname##_main, OPTSTR_##oldname, flags},
Rob Landleya6d696b2007-01-31 13:31:19 -050019
landleyc5621502006-09-28 17:18:51 -040020struct toy_list toy_list[] = {
Rob Landley55928b12008-01-19 17:43:27 -060021#include "generated/newtoys.h"
landleyc5621502006-09-28 17:18:51 -040022};
23
Rob Landley933919c2013-04-21 12:15:59 -050024// global context for this command.
landleyc5621502006-09-28 17:18:51 -040025
26struct toy_context toys;
Rob Landleyb1aaba12008-01-20 17:25:44 -060027union global_union this;
Rob Landley8fdcfdb2013-09-03 17:56:28 -050028char toybuf[4096], libbuf[4096];
landleyc5621502006-09-28 17:18:51 -040029
landley4f344e32006-10-05 16:18:03 -040030struct toy_list *toy_find(char *name)
landley13bab2f2006-09-27 00:45:05 -040031{
Rob Landley7aa651a2012-11-13 17:14:08 -060032 int top, bottom, middle;
landley13bab2f2006-09-27 00:45:05 -040033
Rob Landleydc1af182014-09-27 19:58:18 -050034 if (!CFG_TOYBOX) return 0;
35
Rob Landley7aa651a2012-11-13 17:14:08 -060036 // If the name starts with "toybox" accept that as a match. Otherwise
37 // skip the first entry, which is out of order.
landley13bab2f2006-09-27 00:45:05 -040038
Rob Landley7aa651a2012-11-13 17:14:08 -060039 if (!strncmp(name,"toybox",6)) return toy_list;
40 bottom = 1;
landley13bab2f2006-09-27 00:45:05 -040041
Rob Landley933919c2013-04-21 12:15:59 -050042 // Binary search to find this command.
landley13bab2f2006-09-27 00:45:05 -040043
Rob Landley7aa651a2012-11-13 17:14:08 -060044 top = ARRAY_LEN(toy_list)-1;
45 for (;;) {
46 int result;
Rob Landley2c226852007-11-15 18:30:30 -060047
Rob Landley7aa651a2012-11-13 17:14:08 -060048 middle = (top+bottom)/2;
49 if (middle<bottom || middle>top) return NULL;
50 result = strcmp(name,toy_list[middle].name);
51 if (!result) return toy_list+middle;
52 if (result<0) top=--middle;
53 else bottom = ++middle;
54 }
landley13bab2f2006-09-27 00:45:05 -040055}
56
Rob Landleyfc2224b2007-06-01 14:31:45 -040057// Figure out whether or not anything is using the option parsing logic,
58// because the compiler can't figure out whether or not to optimize it away
Rob Landley8f8c5042012-01-14 23:28:15 -060059// on its' own. NEED_OPTIONS becomes a constant allowing if() to optimize
60// stuff out via dead code elimination.
Rob Landleyfc2224b2007-06-01 14:31:45 -040061
62#undef NEWTOY
63#undef OLDTOY
64#define NEWTOY(name, opts, flags) opts ||
Rob Landleyf3e56f42014-12-31 21:30:59 -060065#define OLDTOY(name, oldname, flags) OPTSTR_##oldname ||
Rob Landley4307a7b2007-06-07 15:20:26 -040066static const int NEED_OPTIONS =
Rob Landley55928b12008-01-19 17:43:27 -060067#include "generated/newtoys.h"
Rob Landleyfc2224b2007-06-01 14:31:45 -0400680; // Ends the opts || opts || opts...
69
Rob Landley3b51a072015-09-27 09:03:41 -050070// Setup toybox global state for this command.
Rob Landleybb504f32013-07-19 02:03:02 -050071static void toy_singleinit(struct toy_list *which, char *argv[])
72{
73 toys.which = which;
74 toys.argv = argv;
75
Rob Landley9b14cb6b2014-09-20 17:51:23 -050076 if (CFG_TOYBOX_I18N) setlocale(LC_ALL, "C"+!!(which->flags & TOYFLAG_LOCALE));
Rob Landleyfc497612014-06-21 13:03:42 -050077
Rob Landleybb504f32013-07-19 02:03:02 -050078 if (CFG_TOYBOX_HELP_DASHDASH && argv[1] && !strcmp(argv[1], "--help")) {
Rob Landleydc1af182014-09-27 19:58:18 -050079 if (CFG_TOYBOX && toys.which == toy_list && toys.argv[2])
Rob Landley5f805332013-08-21 03:03:47 -050080 if (!(toys.which = toy_find(toys.argv[2]))) return;
Rob Landleye5354ca2015-09-11 16:35:14 -050081 show_help(stdout);
Rob Landleybb504f32013-07-19 02:03:02 -050082 xexit();
83 }
84
85 if (NEED_OPTIONS && which->options) get_optflags();
86 else {
87 toys.optargs = argv+1;
Rob Landley3b51a072015-09-27 09:03:41 -050088 for (toys.optc = 0; toys.optargs[toys.optc]; toys.optc++);
Rob Landleybb504f32013-07-19 02:03:02 -050089 }
90 toys.old_umask = umask(0);
91 if (!(which->flags & TOYFLAG_UMASK)) umask(toys.old_umask);
Rob Landley1bc52242014-05-21 07:24:16 -050092 toys.signalfd--;
Rob Landley90b200c2014-06-11 22:13:28 -050093 toys.toycount = ARRAY_LEN(toy_list);
Rob Landleybb504f32013-07-19 02:03:02 -050094}
95
Rob Landley3b51a072015-09-27 09:03:41 -050096// Full init needed by multiplexer or reentrant calls, calls singleinit at end
landleycd9dfc32006-10-18 18:38:16 -040097void toy_init(struct toy_list *which, char *argv[])
98{
Rob Landleyca311f12016-01-30 16:28:13 -060099 void *oldwhich = toys.which;
100
Rob Landley7aa651a2012-11-13 17:14:08 -0600101 // Drop permissions for non-suid commands.
Rob Landleye0377fb2010-01-05 12:17:05 -0600102
Rob Landley7aa651a2012-11-13 17:14:08 -0600103 if (CFG_TOYBOX_SUID) {
Rob Landleyca311f12016-01-30 16:28:13 -0600104 if (!toys.which) toys.which = toy_list;
105
Rob Landley7aa651a2012-11-13 17:14:08 -0600106 uid_t uid = getuid(), euid = geteuid();
Rob Landleye0377fb2010-01-05 12:17:05 -0600107
Rob Landley7aa651a2012-11-13 17:14:08 -0600108 if (!(which->flags & TOYFLAG_STAYROOT)) {
Rob Landley5c87c142014-08-31 11:58:39 -0500109 if (uid != euid) {
Patrick Ohly62b53ed2016-02-09 16:43:35 +0100110 if (setuid(uid)) perror_exit("setuid %d->%d", euid, uid); // drop root
Rob Landleyca311f12016-01-30 16:28:13 -0600111 euid = uid;
112 toys.wasroot++;
Rob Landley5c87c142014-08-31 11:58:39 -0500113 }
Rob Landleybf1e70f2012-12-27 17:09:17 -0600114 } else if (CFG_TOYBOX_DEBUG && uid && which != toy_list)
115 error_msg("Not installed suid root");
Rob Landleye0377fb2010-01-05 12:17:05 -0600116
Rob Landleye5354ca2015-09-11 16:35:14 -0500117 if ((which->flags & TOYFLAG_NEEDROOT) && euid) help_exit("Not root");
Rob Landley7aa651a2012-11-13 17:14:08 -0600118 }
Rob Landleye0377fb2010-01-05 12:17:05 -0600119
Rob Landleycaf39c22012-11-16 00:35:46 -0600120 // Free old toys contents (to be reentrant), but leave rebound if any
Rob Landley3b51a072015-09-27 09:03:41 -0500121 // don't blank old optargs if our new argc lives in the old optargs.
122 if (argv<toys.optargs || argv>toys.optargs+toys.optc) free(toys.optargs);
Rob Landleycaf39c22012-11-16 00:35:46 -0600123 memset(&toys, 0, offsetof(struct toy_context, rebound));
Rob Landleyca311f12016-01-30 16:28:13 -0600124 if (oldwhich) memset(&this, 0, sizeof(this));
landleycd9dfc32006-10-18 18:38:16 -0400125
Rob Landley3b51a072015-09-27 09:03:41 -0500126 // Continue to portion of init needed by standalone commands
Rob Landleybb504f32013-07-19 02:03:02 -0500127 toy_singleinit(which, argv);
landleycd9dfc32006-10-18 18:38:16 -0400128}
129
Rob Landley8f8c5042012-01-14 23:28:15 -0600130// Like exec() but runs an internal toybox command instead of another file.
Rob Landleyc6705af2014-09-09 23:42:25 -0500131// Only returns if it can't run command internally, otherwise exit() when done.
landley4f344e32006-10-05 16:18:03 -0400132void toy_exec(char *argv[])
133{
Rob Landley7aa651a2012-11-13 17:14:08 -0600134 struct toy_list *which;
Rob Landleyb841cd22007-06-01 13:41:24 -0400135
Rob Landley3b51a072015-09-27 09:03:41 -0500136 // Return if we can't find it (which includes no multiplexer case),
137 if (!(which = toy_find(*argv))) return;
Rob Landleyc6705af2014-09-09 23:42:25 -0500138
Rob Landley3b51a072015-09-27 09:03:41 -0500139 // Return if stack depth getting noticeable (proxy for leaked heap, etc).
Rob Landley869da8c2016-05-07 00:21:34 -0500140
141 // Compiler writers have decided subtracting char * is undefined behavior,
142 // so convert to integers. (LP64 says sizeof(long)==sizeof(pointer).)
Rob Landley4e756d72016-05-10 03:26:02 -0500143 if (!CFG_TOYBOX_NORECURSE)
144 if (toys.stacktop && labs((long)toys.stacktop-(long)&which)>6000) return;
Rob Landley3b51a072015-09-27 09:03:41 -0500145
146 // Return if we need to re-exec to acquire root via suid bit.
Rob Landleyca311f12016-01-30 16:28:13 -0600147 if (toys.which && (which->flags&TOYFLAG_ROOTONLY) && toys.wasroot) return;
Rob Landley7c5ed1c2015-02-15 15:27:43 -0600148
Rob Landleyc6705af2014-09-09 23:42:25 -0500149 // Run command
Rob Landley7aa651a2012-11-13 17:14:08 -0600150 toy_init(which, argv);
Rob Landley5f805332013-08-21 03:03:47 -0500151 if (toys.which) toys.which->toy_main();
Rob Landley953722e2013-06-30 15:58:24 -0500152 xexit();
landley4f344e32006-10-05 16:18:03 -0400153}
154
Rob Landley8f8c5042012-01-14 23:28:15 -0600155// Multiplexer command, first argument is command to run, rest are args to that.
156// If first argument starts with - output list of command install paths.
Rob Landleyefda21c2007-11-29 18:14:37 -0600157void toybox_main(void)
landley4f344e32006-10-05 16:18:03 -0400158{
Rob Landley7aa651a2012-11-13 17:14:08 -0600159 static char *toy_paths[]={"usr/","bin/","sbin/",0};
160 int i, len = 0;
landley4f344e32006-10-05 16:18:03 -0400161
Rob Landley3b51a072015-09-27 09:03:41 -0500162 // fast path: try to exec immediately.
163 // (Leave toys.which null to disable suid return logic.)
164 if (toys.argv[1]) toy_exec(toys.argv+1);
165
166 // For early error reporting
Rob Landley6c624482012-11-18 18:52:19 -0600167 toys.which = toy_list;
Rob Landley3b51a072015-09-27 09:03:41 -0500168
Rob Landley7aa651a2012-11-13 17:14:08 -0600169 if (toys.argv[1]) {
Rob Landleye7acb472015-04-07 11:54:36 -0500170 if (!strcmp("--version", toys.argv[1])) {
171 xputs(TOYBOX_VERSION);
172 xexit();
173 }
Rob Landley68986472015-08-06 07:37:23 -0500174 if (toys.argv[1][0] != '-') {
175 toys.exitval = 127;
176 error_exit("Unknown command %s", toys.argv[1]);
177 }
Rob Landley7aa651a2012-11-13 17:14:08 -0600178 }
landley4f344e32006-10-05 16:18:03 -0400179
Rob Landley933919c2013-04-21 12:15:59 -0500180 // Output list of command.
Rob Landleye7acb472015-04-07 11:54:36 -0500181 for (i=1; i<ARRAY_LEN(toy_list); i++) {
Rob Landley7aa651a2012-11-13 17:14:08 -0600182 int fl = toy_list[i].flags;
183 if (fl & TOYMASK_LOCATION) {
184 if (toys.argv[1]) {
185 int j;
186 for (j=0; toy_paths[j]; j++)
187 if (fl & (1<<j)) len += printf("%s", toy_paths[j]);
188 }
Rob Landleyd3f335d2014-10-26 12:56:41 -0500189 len += printf("%s",toy_list[i].name);
190 if (++len > 65) len = 0;
191 xputc(len ? ' ' : '\n');
Rob Landley7aa651a2012-11-13 17:14:08 -0600192 }
193 }
194 xputc('\n');
landley4f344e32006-10-05 16:18:03 -0400195}
196
landley13bab2f2006-09-27 00:45:05 -0400197int main(int argc, char *argv[])
198{
Rob Landley3b51a072015-09-27 09:03:41 -0500199 if (!*argv) return 127;
200
201 // Snapshot stack location so we can detect recursion depth later.
202 // This is its own block so probe doesn't permanently consume stack.
203 else {
204 int stack;
205
206 toys.stacktop = &stack;
207 }
Rob Landleycb49c302016-04-10 14:35:51 -0500208 *argv = getbasename(*argv);
Rob Landley3b51a072015-09-27 09:03:41 -0500209
210 // If nommu can't fork, special reentry path.
211 // Use !stacktop to signal "vfork happened", both before and after xexec()
212 if (!CFG_TOYBOX_FORK) {
213 if (0x80 & **argv) {
214 **argv &= 0x7f;
215 toys.stacktop = 0;
216 }
217 }
Rob Landleye7c09542015-04-30 15:11:34 -0500218
Rob Landleyd04dc1f2013-08-30 01:53:31 -0500219 if (CFG_TOYBOX) {
Rob Landleybb504f32013-07-19 02:03:02 -0500220 // Call the multiplexer, adjusting this argv[] to be its' argv[1].
221 // (It will adjust it back before calling toy_exec().)
222 toys.argv = argv-1;
223 toybox_main();
224 } else {
225 // a single toybox command built standalone with no multiplexer
226 toy_singleinit(toy_list, argv);
227 toy_list->toy_main();
Rob Landleybb504f32013-07-19 02:03:02 -0500228 }
229
Rob Landleyaad492f2015-01-03 16:25:36 -0600230 xexit();
landley13bab2f2006-09-27 00:45:05 -0400231}