5908b20f8755244ae6e0bf02e32458398ef76f7c
[util-vserver.git] / src / vsh.c
1 /*
2  * Marc E. Fiuczynski <mef@cs.princeton.edu>
3  *
4  * Copyright (c) 2004 The Trustees of Princeton University (Trustees).
5  *
6  * vsh is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2, or (at your option)
9  * any later version.
10  *
11  * vsh is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
14  * License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Poptop; see the file COPYING.  If not, write to the Free
18  * Software Foundation, 59 Temple Place - Suite 330, Boston, MA
19  * 02111-1307, USA.
20  */
21
22 #ifdef HAVE_CONFIG_H
23 #  include <config.h>
24 #endif
25 #include "compat.h"
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <errno.h>
32 #include <pwd.h>
33 #include <unistd.h>
34 #include <syscall.h>
35 #include <sys/syscall.h>
36 #include <asm/unistd.h>
37 #include <sys/mount.h>
38 #include <sys/types.h>
39 #include <sys/stat.h>
40 #include <sys/resource.h>
41 #include <fcntl.h>
42 #include <ctype.h>
43 #include <stdarg.h>
44
45 //--------------------------------------------------------------------
46 #include "vserver.h"
47 #include "planetlab.h"
48
49 #undef CONFIG_VSERVER_LEGACY
50
51 /* Null byte made explicit */
52 #define NULLBYTE_SIZE                    1
53
54 /* Base for all vserver roots for chroot */
55 #define VSERVER_ROOT_BASE       "/vservers"
56
57 static int
58 _PERROR(const char *format, char *file, int line, int _errno, ...)
59 {
60         va_list ap;
61
62         va_start(ap, _errno);
63         fprintf(stderr, "%s:%d: ", file, line);
64         vfprintf(stderr, format, ap);
65         if (_errno)
66                 fprintf(stderr, ": %s (%d)", strerror(_errno), _errno);
67         fputs("\n", stderr);
68         fflush(stderr);
69
70         return _errno;
71 }
72
73 #define PERROR(format, args...) _PERROR(format, __FILE__, __LINE__, errno, ## args)
74
75 /* Change to root:root (before entering new context) */
76 static int setuidgid_root()
77 {
78         if (setgid(0) < 0) {
79                 PERROR("setgid(0)");
80                 return -1;
81         }
82         if (setuid(0) < 0) {
83                 PERROR("setuid(0)");
84                 return -1;
85         }
86         return 0;
87 }
88
89 static void compute_new_root(char *base, char **root, uid_t uid)
90 {
91         int             root_len;
92         struct passwd   *pwd;
93
94         if ((pwd = getpwuid(uid)) == NULL) {
95                 PERROR("getpwuid(%d)", uid);
96                 exit(1);
97         }
98
99         root_len = 
100                 strlen(base) + strlen("/") +
101                 strlen(pwd->pw_name)      + NULLBYTE_SIZE;
102         (*root) = (char *)malloc(root_len);
103         if ((*root) == NULL) {
104                 PERROR("malloc(%d)", root_len);
105                 exit(1);
106         }
107     
108         sprintf((*root), "%s/%s", base, pwd->pw_name);
109         (*root)[root_len - 1] = '\0';
110 }
111
112 /* Example: sandbox_root = /vservers/bnc, relpath = /proc/1 */
113 static int sandbox_file_exists(char *sandbox_root, char *relpath)
114 {
115         struct stat stat_buf;
116         char   *file;
117         int    len, exists = 0;
118
119         len = strlen(sandbox_root) + strlen(relpath) + NULLBYTE_SIZE;
120         if ((file = (char *)malloc(len)) == NULL) {
121                 PERROR("malloc(%d)", len);
122                 exit(1);
123         }
124         sprintf(file, "%s%s", sandbox_root, relpath);
125         file[len - 1] = '\0';
126         if (stat(file, &stat_buf) == 0) {
127                 exists = 1;
128         }
129
130
131         free(file);
132         return exists;
133 }
134
135 static int proc_mounted(char *sandbox_root)
136 {
137         return sandbox_file_exists(sandbox_root, "/proc/1");
138 }
139
140 static int devpts_mounted(char *sandbox_root)
141 {
142         return sandbox_file_exists(sandbox_root, "/dev/pts/0");
143 }
144
145 static void mount_proc(char *sandbox_root)
146 {
147         char        *source = "/proc";
148         char        *target;
149         int         len;
150
151         len = strlen(sandbox_root) + strlen("/") + strlen("proc") + NULLBYTE_SIZE;
152         if ((target = (char *)malloc(len)) == NULL) {
153                 PERROR("malloc(%d)", len);
154                 exit(1);
155         }
156
157         sprintf(target, "%s/proc", sandbox_root);
158         target[len - 1] = '\0';
159         if (!proc_mounted(sandbox_root))
160                 mount(source, target, "proc", MS_BIND | MS_RDONLY, NULL);
161
162         free(target);
163 }
164
165 static void mount_devpts(char *sandbox_root)
166 {
167         char        *source = "/dev/pts";
168         char        *target;
169         int         len;
170     
171         len = strlen(sandbox_root) + strlen("/") + strlen("dev/pts") + NULLBYTE_SIZE;
172         if ((target = (char *)malloc(len)) == NULL) {
173                 PERROR("malloc(%d)", len);
174                 exit(1);
175         }
176
177         sprintf(target, "%s/dev/pts", sandbox_root);
178         target[len - 1] = '\0';
179         if (!devpts_mounted(sandbox_root))
180                 mount(source, target, "devpts", 0, NULL);
181
182         free(target);
183 }
184
185 static int sandbox_chroot(uid_t uid)
186 {
187         char *sandbox_root = NULL;
188
189         compute_new_root(VSERVER_ROOT_BASE,&sandbox_root, uid);
190         mount_proc(sandbox_root);
191         mount_devpts(sandbox_root);
192         if (chroot(sandbox_root) < 0) {
193                 PERROR("chroot(%s)", sandbox_root);
194                 exit(1);
195         }
196         if (chdir("/") < 0) {
197                 PERROR("chdir(/)");
198                 exit(1);
199         }
200         return 0;
201 }
202
203 #define WHITESPACE(buffer,index,len)     \
204   while(isspace((int)buffer[index])) \
205         if (index < len) index++; else goto out;
206
207 struct resources {
208         char *name;
209         unsigned long long *limit;
210 };
211
212 #define VSERVERCONF "/etc/vservers/"
213 static void get_limits(char *context, struct resources *list){
214         FILE *fb;
215         size_t len = strlen(VSERVERCONF) + strlen(context) + strlen(".conf") + NULLBYTE_SIZE;
216         char *conf = (char *)malloc(len);       
217         struct resources *r;
218
219         sprintf(conf, "%s%s.conf", VSERVERCONF, context);
220
221         /* open the conf file for reading */
222         fb = fopen(conf,"r");
223         if (fb != NULL) {
224                 size_t index;
225                 char *buffer = malloc(1000);
226                 char *p;
227
228                 /* the conf file exist */ 
229                 while((p=fgets(buffer,1000-1,fb))!=NULL) {
230                         index = 0;
231                         len = strnlen(buffer,1000);
232                         WHITESPACE(buffer,index,len);
233                         if (buffer[index] == '#') 
234                                 continue;
235
236                         for (r=list; r->name; r++)
237                                 if ((p=strstr(&buffer[index],r->name))!=NULL) {
238                                         /* adjust index into buffer */
239                                         index+= (p-&buffer[index])+strlen(r->name);
240
241                                         /* skip over whitespace */
242                                         WHITESPACE(buffer,index,len);
243
244                                         /* expecting to see = sign */
245                                         if (buffer[index++]!='=') goto out;
246
247                                         /* skip over whitespace */
248                                         WHITESPACE(buffer,index,len);
249
250                                         /* expecting to see a digit for number */
251                                         if (!isdigit((int)buffer[index])) goto out;
252
253                                         *r->limit = atoi(&buffer[index]);
254                                         break;
255                                 }
256                 }
257         out:
258                 free(buffer);
259         } else {
260                 fprintf(stderr,"cannot open %s\n",conf);
261         }
262         free(conf);
263 }
264
265
266 static int sandbox_processes(xid_t ctx, char *context)
267 {
268 #ifdef CONFIG_VSERVER_LEGACY
269         int     flags;
270
271         flags = 0;
272         flags |= 1; /* VX_INFO_LOCK -- cannot request a new vx_id */
273         /* flags |= 4; VX_INFO_NPROC -- limit number of procs in a context */
274
275         (void) vc_new_s_context(ctx, 0, flags);
276
277         /* use legacy dirty hack for capremove */
278         if (vc_new_s_context(VC_SAMECTX, vc_get_insecurebcaps(), flags) == VC_NOCTX) {
279                 PERROR("vc_new_s_context(%u, 0x%16ullx, 0x%08x)",
280                        VC_SAMECTX, vc_get_insecurebcaps(), flags);
281                 exit(1);
282         }
283 #else
284         rspec_t  rspec;
285         unsigned long long cpu = VC_LIM_KEEP;
286         unsigned long long mem = VC_LIM_KEEP;
287         unsigned long long task = VC_LIM_KEEP;
288         unsigned long long cpuguaranteed = 0;
289         struct resources list[] = 
290                 {{"MEMLIMIT", &mem},
291                  {"CPULIMIT", &cpu},
292                  {"CPUGUARANTEED", &cpuguaranteed},
293                  {"TASKLIMIT", &task},
294                  {0,0}};
295
296         get_limits(context,list);
297
298         /* check whether the slice has been disabled */
299         if (!cpu)
300           {
301             fprintf(stderr, "*** this slice has been suspended ***\n");
302             exit(0);
303           }
304
305         (void) (sandbox_chroot(ctx));
306
307         rspec.cpu_share = cpu;
308         rspec.cpu_sched_flags = (VC_VXF_SCHED_HARD |
309                                  (cpuguaranteed ? 0 : VC_VXF_SCHED_SHARE));
310         rspec.mem_limit = mem;
311         rspec.task_limit = task;
312         if (pl_chcontext(ctx, 0, ~vc_get_insecurebcaps(), &rspec))
313           {
314             PERROR("pl_chcontext(%u)", ctx);
315             exit(1);
316           }
317 #endif
318         return 0;
319 }
320
321
322 void runas_slice_user(char *username)
323 {
324         struct passwd pwdd, *pwd = &pwdd, *result;
325         char          *pwdBuffer;
326         char          *home_env, *logname_env, *mail_env, *shell_env, *user_env;
327         int           home_len, logname_len, mail_len, shell_len, user_len;
328         long          pwdBuffer_len;
329         static char   *envp[10];
330
331
332         pwdBuffer_len = sysconf(_SC_GETPW_R_SIZE_MAX);
333         if (pwdBuffer_len == -1) {
334                 PERROR("sysconf(_SC_GETPW_R_SIZE_MAX)");
335                 exit(1);
336         }
337
338         pwdBuffer = (char*)malloc(pwdBuffer_len);
339         if (pwdBuffer == NULL) {
340                 PERROR("malloc(%d)", pwdBuffer_len);
341                 exit(1);
342         }
343
344         errno = 0;
345         if ((getpwnam_r(username,pwd,pwdBuffer,pwdBuffer_len, &result) != 0) || (errno != 0)) {
346                 PERROR("getpwnam_r(%s)", username);
347                 exit(1);
348         }
349
350         if (setgid(pwd->pw_gid) < 0) {
351                 PERROR("setgid(%d)", pwd->pw_gid);
352                 exit(1);
353         }
354
355         if (setuid(pwd->pw_uid) < 0) {
356                 PERROR("setuid(%d)", pwd->pw_uid);
357                 exit(1);
358         }
359
360         if (chdir(pwd->pw_dir) < 0) {
361                 PERROR("chdir(%s)", pwd->pw_dir);
362                 exit(1);
363         }
364
365         home_len    = strlen("HOME=") + strlen(pwd->pw_dir) + NULLBYTE_SIZE;
366         logname_len = strlen("LOGNAME=") + strlen(username) + NULLBYTE_SIZE;
367         mail_len    = strlen("MAIL=/var/spool/mail/") + strlen(username) 
368                 + NULLBYTE_SIZE;
369         shell_len   = strlen("SHELL=") + strlen(pwd->pw_shell) + NULLBYTE_SIZE;
370         user_len    = strlen("USER=") + strlen(username) + NULLBYTE_SIZE;
371
372         home_env    = (char *)malloc(home_len);
373         logname_env = (char *)malloc(logname_len);
374         mail_env    = (char *)malloc(mail_len);
375         shell_env   = (char *)malloc(shell_len);
376         user_env    = (char *)malloc(user_len);
377
378         if ((home_env    == NULL)  || 
379             (logname_env == NULL)  ||
380             (mail_env    == NULL)  ||
381             (shell_env   == NULL)  ||
382             (user_env    == NULL)) {
383                 PERROR("malloc");
384                 exit(1);
385         }
386
387         sprintf(home_env, "HOME=%s", pwd->pw_dir);
388         sprintf(logname_env, "LOGNAME=%s", username);
389         sprintf(mail_env, "MAIL=/var/spool/mail/%s", username);
390         sprintf(shell_env, "SHELL=%s", pwd->pw_shell);
391         sprintf(user_env, "USER=%s", username);
392     
393         home_env[home_len - 1]       = '\0';
394         logname_env[logname_len - 1] = '\0';
395         mail_env[mail_len - 1]       = '\0';
396         shell_env[shell_len - 1]     = '\0';
397         user_env[user_len - 1]       = '\0';
398
399         envp[0] = home_env;
400         envp[1] = logname_env;
401         envp[2] = mail_env;
402         envp[3] = shell_env;
403         envp[4] = user_env;
404         envp[5] = 0;
405
406         if ((putenv(home_env)    < 0) ||
407             (putenv(logname_env) < 0) ||
408             (putenv(mail_env)    < 0) ||
409             (putenv(shell_env)   < 0) ||
410             (putenv(user_env)    < 0)) {
411                 PERROR("vserver: putenv error ");
412                 exit(1);
413         }
414 }
415
416 void slice_enter(char *context)
417 {
418         struct passwd pwdd, *pwd = &pwdd, *result;
419         char          *pwdBuffer;
420         long          pwdBuffer_len;
421         uid_t uid;
422
423         pwdBuffer_len = sysconf(_SC_GETPW_R_SIZE_MAX);
424         if (pwdBuffer_len == -1) {
425                 PERROR("sysconf(_SC_GETPW_R_SIZE_MAX)");
426                 exit(1);
427         }
428
429         pwdBuffer = (char*)malloc(pwdBuffer_len);
430         if (pwdBuffer == NULL) {
431                 PERROR("malloc(%d)", pwdBuffer_len);
432                 exit(1);
433         }
434
435         errno = 0;
436         if ((getpwnam_r(context,pwd,pwdBuffer,pwdBuffer_len, &result) != 0) || (errno != 0)) {
437                 PERROR("getpwnam_r(%s)", context);
438                 exit(2);
439         }
440         uid = pwd->pw_uid;
441
442         if (setuidgid_root() < 0) { /* For chroot, new_s_context */
443                 fprintf(stderr, "vsh: Could not become root, check that SUID flag is set on binary\n");
444                 exit(2);
445         }
446
447 #ifdef CONFIG_VSERVER_LEGACY
448         (void) (sandbox_chroot(uid));
449 #endif
450
451         if (sandbox_processes((xid_t) uid, context) < 0) {
452                 fprintf(stderr, "vsh: Could not change context to %d\n", uid);
453                 exit(2);
454         }
455 }
456
457 //--------------------------------------------------------------------
458
459 #define DEFAULT_SHELL "/bin/sh"
460
461 /* Exit statuses for programs like 'env' that exec other programs.
462    EXIT_FAILURE might not be 1, so use EXIT_FAIL in such programs.  */
463 enum
464 {
465   EXIT_CANNOT_INVOKE = 126,
466   EXIT_ENOENT = 127
467 };
468
469 int main(int argc, char **argv)
470 {
471     struct passwd   pwdd, *pwd = &pwdd, *result;
472     char            *context, *username, *shell, *pwdBuffer;
473     long            pwdBuffer_len;
474     uid_t           uid;
475     int             index, i;
476
477     if (argv[0][0]=='-') 
478       index = 1;
479     else
480       index = 0;
481
482     uid = getuid();
483     if ((pwd = getpwuid(uid)) == NULL) {
484       PERROR("getpwuid(%d)", uid);
485       exit(1);
486     }
487
488     context = (char*)strdup(pwd->pw_name);
489     if (!context) {
490       PERROR("strdup");
491       exit(2);
492     }
493
494     /* enter vserver "context" */
495     slice_enter(context);
496
497     /* Now run as username in this context. Note that for PlanetLab's
498        vserver configuration the context name also happens to be the
499        "default" username within the vserver context.
500     */
501     username = context;
502     runas_slice_user(username);
503
504     /* With the uid/gid appropriately set. Let's figure out what the
505      * shell in the vserver's /etc/passwd is for the given username.
506      */
507
508     pwdBuffer_len = sysconf(_SC_GETPW_R_SIZE_MAX);
509     if (pwdBuffer_len == -1) {
510             PERROR("sysconf(_SC_GETPW_R_SIZE_MAX");
511             exit(1);
512     }
513     pwdBuffer = (char*)malloc(pwdBuffer_len);
514     if (pwdBuffer == NULL) {
515             PERROR("malloc(%d)", pwdBuffer_len);
516             exit(1);
517     }
518
519     errno = 0;
520     if ((getpwnam_r(username,pwd,pwdBuffer,pwdBuffer_len, &result) != 0) || (errno != 0)) {
521         PERROR("getpwnam_r(%s)", username);
522         exit(1);
523     }
524
525     /* Make sure pw->pw_shell is non-NULL.*/
526     if (pwd->pw_shell == NULL || pwd->pw_shell[0] == '\0') {
527       pwd->pw_shell = (char *) DEFAULT_SHELL;
528     }
529
530     shell = (char *)strdup(pwd->pw_shell);
531     if (!shell) {
532       PERROR("strdup");
533       exit(2);
534     }
535
536     /* Check whether 'su' or 'sshd' invoked us as a login shell or
537        not; did this above when testing argv[0]=='-'.
538     */
539     argv[0] = shell;
540     if (index == 1) {
541       char **args;
542       args = (char**)malloc(sizeof(char*)*(argc+2));
543       if (!args) {
544         PERROR("malloc(%d)", sizeof(char*)*(argc+2));
545         exit(1);
546       }
547       args[0] = argv[0];
548       args[1] = "-l";
549       for(i=1;i<argc+1;i++) {
550         args[i+1] = argv[i];
551       }
552       argv = args;
553     }
554     (void) execvp(shell,argv);
555     {
556       int exit_status = (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
557       exit (exit_status);
558     }
559
560     return 0; /* shutup compiler */
561 }