[lttng-tools.git] / src / common / runas.c

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _GNU_SOURCE
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/wait.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
#include <sched.h>
#include <sys/signal.h>

#include <common/error.h>
#include <common/compat/mman.h>
#include <common/compat/clone.h>

#include "runas.h"

#define RUNAS_CHILD_STACK_SIZE	10485760

#ifndef MAP_STACK
#define MAP_STACK		0
#endif

#ifdef __FreeBSD__
/* FreeBSD MAP_STACK always return -ENOMEM */
#define LTTNG_MAP_STACK		0
#else
#define LTTNG_MAP_STACK		MAP_STACK
#endif

#ifndef MAP_GROWSDOWN
#define MAP_GROWSDOWN		0
#endif

#ifndef MAP_ANONYMOUS
#define MAP_ANONYMOUS		MAP_ANON
#endif

struct run_as_data {
	int (*cmd)(void *data);
	void *data;
	uid_t uid;
	gid_t gid;
	int retval_pipe;
};

struct run_as_mkdir_data {
	const char *path;
	mode_t mode;
};

struct run_as_open_data {
	const char *path;
	int flags;
	mode_t mode;
};

/*
 * Create recursively directory using the FULL path.
 */
static
int _mkdir_recursive(void *_data)
{
	struct run_as_mkdir_data *data = _data;
	const char *path;
	char *p, tmp[PATH_MAX];
	struct stat statbuf;
	mode_t mode;
	size_t len;
	int ret;

	path = data->path;
	mode = data->mode;

	ret = snprintf(tmp, sizeof(tmp), "%s", path);
	if (ret < 0) {
		PERROR("snprintf mkdir");
		goto error;
	}

	len = ret;
	if (tmp[len - 1] == '/') {
		tmp[len - 1] = 0;
	}

	for (p = tmp + 1; *p; p++) {
		if (*p == '/') {
			*p = 0;
			ret = stat(tmp, &statbuf);
			if (ret < 0) {
				ret = mkdir(tmp, mode);
				if (ret < 0) {
					if (!(errno == EEXIST)) {
						PERROR("mkdir recursive");
						ret = -errno;
						goto error;
					}
				}
			}
			*p = '/';
		}
	}

	ret = mkdir(tmp, mode);
	if (ret < 0) {
		if (!(errno == EEXIST)) {
			PERROR("mkdir recursive last piece");
			ret = -errno;
		} else {
			ret = 0;
		}
	}

error:
	return ret;
}

static
int _mkdir(void *_data)
{
	struct run_as_mkdir_data *data = _data;
	return mkdir(data->path, data->mode);
}

static
int _open(void *_data)
{
	struct run_as_open_data *data = _data;
	return open(data->path, data->flags, data->mode);
}

static
int child_run_as(void *_data)
{
	int ret;
	struct run_as_data *data = _data;
	ssize_t writelen;
	size_t writeleft, index;
	union {
		int i;
		char c[sizeof(int)];
	} sendret;

	/*
	 * Child: it is safe to drop egid and euid while sharing the
	 * file descriptors with the parent process, since we do not
	 * drop "uid": therefore, the user we are dropping egid/euid to
	 * cannot attach to this process with, e.g. ptrace, nor map this
	 * process memory.
	 */
	if (data->gid != getegid()) {
		ret = setegid(data->gid);
		if (ret < 0) {
			PERROR("setegid");
			return EXIT_FAILURE;
		}
	}
	if (data->uid != geteuid()) {
		ret = seteuid(data->uid);
		if (ret < 0) {
			PERROR("seteuid");
			return EXIT_FAILURE;
		}
	}
	/*
	 * Also set umask to 0 for mkdir executable bit.
	 */
	umask(0);
	sendret.i = (*data->cmd)(data->data);
	/* send back return value */
	writeleft = sizeof(sendret);
	index = 0;
	do {
		writelen = write(data->retval_pipe, &sendret.c[index],
				writeleft);
		if (writelen < 0) {
			PERROR("write");
			return EXIT_FAILURE;
		}
		writeleft -= writelen;
		index += writelen;
	} while (writeleft > 0);
	return EXIT_SUCCESS;
}

static
int run_as_clone(int (*cmd)(void *data), void *data, uid_t uid, gid_t gid)
{
	struct run_as_data run_as_data;
	int ret = 0;
	int status;
	pid_t pid;
	int retval_pipe[2];
	ssize_t readlen, readleft, index;
	void *child_stack;
	union {
		int i;
		char c[sizeof(int)];
	} retval;

	/*
	 * If we are non-root, we can only deal with our own uid.
	 */
	if (geteuid() != 0) {
		if (uid != geteuid()) {
			ERR("Client (%d)/Server (%d) UID mismatch (and sessiond is not root)",
				uid, geteuid());
			return -EPERM;
		}
	}

	ret = pipe(retval_pipe);
	if (ret < 0) {
		PERROR("pipe");
		retval.i = ret;
		goto end;
	}
	run_as_data.data = data;
	run_as_data.cmd = cmd;
	run_as_data.uid = uid;
	run_as_data.gid = gid;
	run_as_data.retval_pipe = retval_pipe[1];	/* write end */
	child_stack = mmap(NULL, RUNAS_CHILD_STACK_SIZE,
		PROT_WRITE | PROT_READ,
		MAP_PRIVATE | MAP_GROWSDOWN | MAP_ANONYMOUS | LTTNG_MAP_STACK,
		-1, 0);
	if (child_stack == MAP_FAILED) {
		PERROR("mmap");
		retval.i = -ENOMEM;
		goto close_pipe;
	}
	/*
	 * Pointing to the middle of the stack to support architectures
	 * where the stack grows up (HPPA).
	 */
	pid = lttng_clone_files(child_run_as, child_stack + (RUNAS_CHILD_STACK_SIZE / 2),
		&run_as_data);
	if (pid < 0) {
		PERROR("clone");
		retval.i = pid;
		goto unmap_stack;
	}
	/* receive return value */
	readleft = sizeof(retval);
	index = 0;
	do {
		readlen = read(retval_pipe[0], &retval.c[index], readleft);
		if (readlen < 0) {
			PERROR("read");
			ret = -1;
			break;
		}
		readleft -= readlen;
		index += readlen;
	} while (readleft > 0);

	/*
	 * Parent: wait for child to return, in which case the
	 * shared memory map will have been created.
	 */
	pid = waitpid(pid, &status, 0);
	if (pid < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
		PERROR("wait");
		retval.i = -1;
	}
unmap_stack:
	ret = munmap(child_stack, RUNAS_CHILD_STACK_SIZE);
	if (ret < 0) {
		PERROR("munmap");
		retval.i = ret;
	}
close_pipe:
	ret = close(retval_pipe[0]);
	if (ret) {
		PERROR("close");
	}
	ret = close(retval_pipe[1]);
	if (ret) {
		PERROR("close");
	}
end:
	return retval.i;
}

/*
 * To be used on setups where gdb has issues debugging programs using
 * clone/rfork. Note that this is for debuging ONLY, and should not be
 * considered secure.
 */
static
int run_as_noclone(int (*cmd)(void *data), void *data, uid_t uid, gid_t gid)
{
	return cmd(data);
}

static
int run_as(int (*cmd)(void *data), void *data, uid_t uid, gid_t gid)
{
	if (!getenv("LTTNG_DEBUG_NOCLONE")) {
		int ret;

		DBG("Using run_as_clone");
		pthread_mutex_lock(&lttng_libc_state_lock);
		ret = run_as_clone(cmd, data, uid, gid);
		pthread_mutex_unlock(&lttng_libc_state_lock);
		return ret;
	} else {
		DBG("Using run_as_noclone");
		return run_as_noclone(cmd, data, uid, gid);
	}
}

int run_as_mkdir_recursive(const char *path, mode_t mode, uid_t uid, gid_t gid)
{
	struct run_as_mkdir_data data;

	DBG3("mkdir() recursive %s with mode %d for uid %d and gid %d",
			path, mode, uid, gid);
	data.path = path;
	data.mode = mode;
	return run_as(_mkdir_recursive, &data, uid, gid);
}

int run_as_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid)
{
	struct run_as_mkdir_data data;

	DBG3("mkdir() %s with mode %d for uid %d and gid %d",
			path, mode, uid, gid);
	data.path = path;
	data.mode = mode;
	return run_as(_mkdir, &data, uid, gid);
}

/*
 * Note: open_run_as is currently not working. We'd need to pass the fd
 * opened in the child to the parent.
 */
int run_as_open(const char *path, int flags, mode_t mode, uid_t uid, gid_t gid)
{
	struct run_as_open_data data;

	DBG3("open() %s with flags %X mode %d for uid %d and gid %d",
			path, flags, mode, uid, gid);
	data.path = path;
	data.flags = flags;
	data.mode = mode;
	return run_as(_open, &data, uid, gid);
}
Commit	Line	Data
60b6c79c MD	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
d14d33bf AM	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License, version 2 only,
	7	* as published by the Free Software Foundation.
60b6c79c MD	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d14d33bf	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
60b6c79c MD	12	* more details.
60b6c79c MD	13	*
d14d33bf AM	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
60b6c79c MD	17	*/
	18
	19	#define _GNU_SOURCE
	20	#include <errno.h>
	21	#include <limits.h>
	22	#include <stdio.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25	#include <sys/wait.h>
	26	#include <sys/types.h>
	27	#include <sys/stat.h>
	28	#include <unistd.h>
	29	#include <fcntl.h>
c2b75c49	30	#include <sched.h>
730389d9	31	#include <sys/signal.h>
60b6c79c	32
db758600	33	#include <common/error.h>
730389d9 DG	34	#include <common/compat/mman.h>
730389d9 DG	35	#include <common/compat/clone.h>
60b6c79c	36
0857097f DG	37	#include "runas.h"
0857097f DG	38
e11d277b	39	#define RUNAS_CHILD_STACK_SIZE 10485760
c2b75c49	40
1e4035fc AS	41	#ifndef MAP_STACK
	42	#define MAP_STACK 0
	43	#endif
	44
0756d557 MD	45	#ifdef __FreeBSD__
	46	/* FreeBSD MAP_STACK always return -ENOMEM */
	47	#define LTTNG_MAP_STACK 0
	48	#else
	49	#define LTTNG_MAP_STACK MAP_STACK
059e1d3d MD	50	#endif
059e1d3d MD	51
a5ae566a	52	#ifndef MAP_GROWSDOWN
edb025e8	53	#define MAP_GROWSDOWN 0
a5ae566a MD	54	#endif
	55
	56	#ifndef MAP_ANONYMOUS
	57	#define MAP_ANONYMOUS MAP_ANON
	58	#endif
	59
c2b75c49 MD	60	struct run_as_data {
	61	int (cmd)(void data);
	62	void *data;
	63	uid_t uid;
	64	gid_t gid;
	65	int retval_pipe;
	66	};
	67
e11d277b	68	struct run_as_mkdir_data {
60b6c79c MD	69	const char *path;
	70	mode_t mode;
	71	};
	72
e11d277b	73	struct run_as_open_data {
60b6c79c MD	74	const char *path;
	75	int flags;
	76	mode_t mode;
	77	};
	78
	79	/*
	80	* Create recursively directory using the FULL path.
	81	*/
	82	static
	83	int _mkdir_recursive(void *_data)
	84	{
e11d277b	85	struct run_as_mkdir_data *data = _data;
60b6c79c MD	86	const char *path;
	87	char *p, tmp[PATH_MAX];
	88	struct stat statbuf;
	89	mode_t mode;
	90	size_t len;
	91	int ret;
	92
	93	path = data->path;
	94	mode = data->mode;
	95
	96	ret = snprintf(tmp, sizeof(tmp), "%s", path);
	97	if (ret < 0) {
	98	PERROR("snprintf mkdir");
	99	goto error;
	100	}
	101
	102	len = ret;
	103	if (tmp[len - 1] == '/') {
	104	tmp[len - 1] = 0;
	105	}
	106
	107	for (p = tmp + 1; *p; p++) {
	108	if (*p == '/') {
	109	*p = 0;
	110	ret = stat(tmp, &statbuf);
	111	if (ret < 0) {
	112	ret = mkdir(tmp, mode);
	113	if (ret < 0) {
	114	if (!(errno == EEXIST)) {
	115	PERROR("mkdir recursive");
	116	ret = -errno;
	117	goto error;
	118	}
	119	}
	120	}
	121	*p = '/';
	122	}
	123	}
	124
	125	ret = mkdir(tmp, mode);
	126	if (ret < 0) {
	127	if (!(errno == EEXIST)) {
	128	PERROR("mkdir recursive last piece");
	129	ret = -errno;
	130	} else {
	131	ret = 0;
	132	}
	133	}
	134
	135	error:
	136	return ret;
	137	}
	138
	139	static
	140	int _mkdir(void *_data)
	141	{
e11d277b	142	struct run_as_mkdir_data *data = _data;
60b6c79c MD	143	return mkdir(data->path, data->mode);
	144	}
	145
	146	static
	147	int _open(void *_data)
	148	{
e11d277b	149	struct run_as_open_data *data = _data;
60b6c79c MD	150	return open(data->path, data->flags, data->mode);
	151	}
	152
c2b75c49 MD	153	static
	154	int child_run_as(void *_data)
	155	{
6775595e	156	int ret;
c2b75c49	157	struct run_as_data *data = _data;
6775595e DG	158	ssize_t writelen;
6775595e DG	159	size_t writeleft, index;
c2b75c49 MD	160	union {
	161	int i;
	162	char c[sizeof(int)];
	163	} sendret;
c2b75c49 MD	164
	165	/*
	166	* Child: it is safe to drop egid and euid while sharing the
	167	* file descriptors with the parent process, since we do not
	168	* drop "uid": therefore, the user we are dropping egid/euid to
	169	* cannot attach to this process with, e.g. ptrace, nor map this
	170	* process memory.
	171	*/
1576d582 MD	172	if (data->gid != getegid()) {
	173	ret = setegid(data->gid);
	174	if (ret < 0) {
4c462e79	175	PERROR("setegid");
6da9f915	176	return EXIT_FAILURE;
1576d582	177	}
c2b75c49	178	}
1576d582 MD	179	if (data->uid != geteuid()) {
	180	ret = seteuid(data->uid);
	181	if (ret < 0) {
4c462e79	182	PERROR("seteuid");
6da9f915	183	return EXIT_FAILURE;
1576d582	184	}
c2b75c49 MD	185	}
	186	/*
	187	* Also set umask to 0 for mkdir executable bit.
	188	*/
	189	umask(0);
	190	sendret.i = (*data->cmd)(data->data);
	191	/* send back return value */
	192	writeleft = sizeof(sendret);
	193	index = 0;
	194	do {
	195	writelen = write(data->retval_pipe, &sendret.c[index],
	196	writeleft);
	197	if (writelen < 0) {
4c462e79	198	PERROR("write");
6da9f915	199	return EXIT_FAILURE;
c2b75c49 MD	200	}
	201	writeleft -= writelen;
	202	index += writelen;
	203	} while (writeleft > 0);
6da9f915	204	return EXIT_SUCCESS;
c2b75c49 MD	205	}
c2b75c49 MD	206
60b6c79c	207	static
2d85a600	208	int run_as_clone(int (cmd)(void data), void *data, uid_t uid, gid_t gid)
60b6c79c	209	{
c2b75c49	210	struct run_as_data run_as_data;
60b6c79c	211	int ret = 0;
c2b75c49	212	int status;
60b6c79c	213	pid_t pid;
c2b75c49 MD	214	int retval_pipe[2];
c2b75c49 MD	215	ssize_t readlen, readleft, index;
d5bd7573	216	void *child_stack;
c2b75c49 MD	217	union {
	218	int i;
	219	char c[sizeof(int)];
	220	} retval;
60b6c79c MD	221
	222	/*
	223	* If we are non-root, we can only deal with our own uid.
	224	*/
	225	if (geteuid() != 0) {
	226	if (uid != geteuid()) {
	227	ERR("Client (%d)/Server (%d) UID mismatch (and sessiond is not root)",
	228	uid, geteuid());
	229	return -EPERM;
	230	}
60b6c79c MD	231	}
60b6c79c MD	232
c2b75c49 MD	233	ret = pipe(retval_pipe);
c2b75c49 MD	234	if (ret < 0) {
4c462e79	235	PERROR("pipe");
def5e0e8	236	retval.i = ret;
60b6c79c	237	goto end;
c2b75c49 MD	238	}
	239	run_as_data.data = data;
	240	run_as_data.cmd = cmd;
	241	run_as_data.uid = uid;
	242	run_as_data.gid = gid;
	243	run_as_data.retval_pipe = retval_pipe[1]; /* write end */
e11d277b	244	child_stack = mmap(NULL, RUNAS_CHILD_STACK_SIZE,
d5bd7573	245	PROT_WRITE \| PROT_READ,
0756d557	246	MAP_PRIVATE \| MAP_GROWSDOWN \| MAP_ANONYMOUS \| LTTNG_MAP_STACK,
d5bd7573 MD	247	-1, 0);
d5bd7573 MD	248	if (child_stack == MAP_FAILED) {
4c462e79	249	PERROR("mmap");
def5e0e8	250	retval.i = -ENOMEM;
d5bd7573 MD	251	goto close_pipe;
	252	}
	253	/*
	254	* Pointing to the middle of the stack to support architectures
	255	* where the stack grows up (HPPA).
	256	*/
89831a74 MD	257	pid = lttng_clone_files(child_run_as, child_stack + (RUNAS_CHILD_STACK_SIZE / 2),
89831a74 MD	258	&run_as_data);
c2b75c49	259	if (pid < 0) {
4c462e79	260	PERROR("clone");
def5e0e8	261	retval.i = pid;
d5bd7573	262	goto unmap_stack;
c2b75c49 MD	263	}
	264	/* receive return value */
	265	readleft = sizeof(retval);
	266	index = 0;
	267	do {
	268	readlen = read(retval_pipe[0], &retval.c[index], readleft);
	269	if (readlen < 0) {
4c462e79	270	PERROR("read");
c2b75c49 MD	271	ret = -1;
c2b75c49 MD	272	break;
60b6c79c	273	}
c2b75c49 MD	274	readleft -= readlen;
	275	index += readlen;
	276	} while (readleft > 0);
	277
	278	/*
	279	* Parent: wait for child to return, in which case the
	280	* shared memory map will have been created.
	281	*/
47fb7563	282	pid = waitpid(pid, &status, 0);
c2b75c49	283	if (pid < 0 \|\| !WIFEXITED(status) \|\| WEXITSTATUS(status) != 0) {
4c462e79	284	PERROR("wait");
def5e0e8	285	retval.i = -1;
60b6c79c	286	}
d5bd7573	287	unmap_stack:
e11d277b	288	ret = munmap(child_stack, RUNAS_CHILD_STACK_SIZE);
d5bd7573	289	if (ret < 0) {
4c462e79	290	PERROR("munmap");
def5e0e8	291	retval.i = ret;
d5bd7573	292	}
c2b75c49	293	close_pipe:
4c462e79 MD	294	ret = close(retval_pipe[0]);
	295	if (ret) {
	296	PERROR("close");
	297	}
	298	ret = close(retval_pipe[1]);
	299	if (ret) {
	300	PERROR("close");
	301	}
60b6c79c	302	end:
c2b75c49	303	return retval.i;
60b6c79c MD	304	}
60b6c79c MD	305
2d85a600 MD	306	/*
	307	* To be used on setups where gdb has issues debugging programs using
	308	* clone/rfork. Note that this is for debuging ONLY, and should not be
	309	* considered secure.
	310	*/
	311	static
	312	int run_as_noclone(int (cmd)(void data), void *data, uid_t uid, gid_t gid)
	313	{
	314	return cmd(data);
	315	}
	316
	317	static
	318	int run_as(int (cmd)(void data), void *data, uid_t uid, gid_t gid)
	319	{
	320	if (!getenv("LTTNG_DEBUG_NOCLONE")) {
9ef70f87 MD	321	int ret;
9ef70f87 MD	322
2d85a600	323	DBG("Using run_as_clone");
9ef70f87 MD	324	pthread_mutex_lock(&lttng_libc_state_lock);
	325	ret = run_as_clone(cmd, data, uid, gid);
	326	pthread_mutex_unlock(&lttng_libc_state_lock);
	327	return ret;
2d85a600 MD	328	} else {
	329	DBG("Using run_as_noclone");
	330	return run_as_noclone(cmd, data, uid, gid);
	331	}
	332	}
	333
e11d277b	334	int run_as_mkdir_recursive(const char *path, mode_t mode, uid_t uid, gid_t gid)
60b6c79c	335	{
e11d277b	336	struct run_as_mkdir_data data;
60b6c79c MD	337
	338	DBG3("mkdir() recursive %s with mode %d for uid %d and gid %d",
	339	path, mode, uid, gid);
	340	data.path = path;
	341	data.mode = mode;
	342	return run_as(_mkdir_recursive, &data, uid, gid);
	343	}
	344
e11d277b	345	int run_as_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid)
60b6c79c	346	{
e11d277b	347	struct run_as_mkdir_data data;
60b6c79c MD	348
	349	DBG3("mkdir() %s with mode %d for uid %d and gid %d",
	350	path, mode, uid, gid);
	351	data.path = path;
	352	data.mode = mode;
	353	return run_as(_mkdir, &data, uid, gid);
	354	}
	355
	356	/*
	357	* Note: open_run_as is currently not working. We'd need to pass the fd
	358	* opened in the child to the parent.
	359	*/
e11d277b	360	int run_as_open(const char *path, int flags, mode_t mode, uid_t uid, gid_t gid)
60b6c79c	361	{
e11d277b	362	struct run_as_open_data data;
c2b75c49	363
47fb7563 MD	364	DBG3("open() %s with flags %X mode %d for uid %d and gid %d",
47fb7563 MD	365	path, flags, mode, uid, gid);
60b6c79c MD	366	data.path = path;
	367	data.flags = flags;
	368	data.mode = mode;
	369	return run_as(_open, &data, uid, gid);
60b6c79c	370	}