[openssh.git] / uidswap.c

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 * Code for uid-swapping.
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#include "includes.h"
RCSID("$OpenBSD: uidswap.c,v 1.24 2003/05/29 16:58:45 deraadt Exp $");

#include "log.h"
#include "uidswap.h"
#include "xmalloc.h"

/*
 * Note: all these functions must work in all of the following cases:
 *    1. euid=0, ruid=0
 *    2. euid=0, ruid!=0
 *    3. euid!=0, ruid!=0
 * Additionally, they must work regardless of whether the system has
 * POSIX saved uids or not.
 */

#if defined(_POSIX_SAVED_IDS) && !defined(BROKEN_SAVED_UIDS)
/* Lets assume that posix saved ids also work with seteuid, even though that
   is not part of the posix specification. */
#define SAVED_IDS_WORK_WITH_SETEUID
/* Saved effective uid. */
static uid_t 	saved_euid = 0;
static gid_t	saved_egid = 0;
#endif

/* Saved effective uid. */
static int	privileged = 0;
static int	temporarily_use_uid_effective = 0;
static gid_t	*saved_egroups = NULL, *user_groups = NULL;
static int	saved_egroupslen = -1, user_groupslen = -1;

/*
 * Temporarily changes to the given uid.  If the effective user
 * id is not root, this does nothing.  This call cannot be nested.
 */
void
temporarily_use_uid(struct passwd *pw)
{
	/* Save the current euid, and egroups. */
#ifdef SAVED_IDS_WORK_WITH_SETEUID
	saved_euid = geteuid();
	saved_egid = getegid();
	debug("temporarily_use_uid: %u/%u (e=%u/%u)",
	    (u_int)pw->pw_uid, (u_int)pw->pw_gid,
	    (u_int)saved_euid, (u_int)saved_egid);
#ifndef HAVE_CYGWIN
	if (saved_euid != 0) {
		privileged = 0;
		return;
	}
#endif
#else
	if (geteuid() != 0) {
		privileged = 0;
		return;
	}
#endif /* SAVED_IDS_WORK_WITH_SETEUID */

	privileged = 1;
	temporarily_use_uid_effective = 1;

	saved_egroupslen = getgroups(0, NULL);
	if (saved_egroupslen < 0)
		fatal("getgroups: %.100s", strerror(errno));
	if (saved_egroupslen > 0) {
		saved_egroups = xrealloc(saved_egroups,
		    saved_egroupslen * sizeof(gid_t));
		if (getgroups(saved_egroupslen, saved_egroups) < 0)
			fatal("getgroups: %.100s", strerror(errno));
	} else { /* saved_egroupslen == 0 */
		if (saved_egroups != NULL)
			xfree(saved_egroups);
	}

	/* set and save the user's groups */
	if (user_groupslen == -1) {
		if (initgroups(pw->pw_name, pw->pw_gid) < 0)
			fatal("initgroups: %s: %.100s", pw->pw_name,
			    strerror(errno));

		user_groupslen = getgroups(0, NULL);
		if (user_groupslen < 0)
			fatal("getgroups: %.100s", strerror(errno));
		if (user_groupslen > 0) {
			user_groups = xrealloc(user_groups,
			    user_groupslen * sizeof(gid_t));
			if (getgroups(user_groupslen, user_groups) < 0)
				fatal("getgroups: %.100s", strerror(errno));
		} else { /* user_groupslen == 0 */
			if (user_groups)
				xfree(user_groups);
		}
	}
	/* Set the effective uid to the given (unprivileged) uid. */
	if (setgroups(user_groupslen, user_groups) < 0)
		fatal("setgroups: %.100s", strerror(errno));
#ifndef SAVED_IDS_WORK_WITH_SETEUID
	/* Propagate the privileged gid to all of our gids. */
	if (setgid(getegid()) < 0)
		debug("setgid %u: %.100s", (u_int) getegid(), strerror(errno));
	/* Propagate the privileged uid to all of our uids. */
	if (setuid(geteuid()) < 0)
		debug("setuid %u: %.100s", (u_int) geteuid(), strerror(errno));
#endif /* SAVED_IDS_WORK_WITH_SETEUID */
	if (setegid(pw->pw_gid) < 0)
		fatal("setegid %u: %.100s", (u_int)pw->pw_gid,
		    strerror(errno));
	if (seteuid(pw->pw_uid) == -1)
		fatal("seteuid %u: %.100s", (u_int)pw->pw_uid,
		    strerror(errno));
}

/*
 * Restores to the original (privileged) uid.
 */
void
restore_uid(void)
{
	/* it's a no-op unless privileged */
	if (!privileged) {
		debug("restore_uid: (unprivileged)");
		return;
	}
	if (!temporarily_use_uid_effective)
		fatal("restore_uid: temporarily_use_uid not effective");

#ifdef SAVED_IDS_WORK_WITH_SETEUID
	debug("restore_uid: %u/%u", (u_int)saved_euid, (u_int)saved_egid);
	/* Set the effective uid back to the saved privileged uid. */
	if (seteuid(saved_euid) < 0)
		fatal("seteuid %u: %.100s", (u_int)saved_euid, strerror(errno));
	if (setegid(saved_egid) < 0)
		fatal("setegid %u: %.100s", (u_int)saved_egid, strerror(errno));
#else /* SAVED_IDS_WORK_WITH_SETEUID */
	/*
	 * We are unable to restore the real uid to its unprivileged value.
	 * Propagate the real uid (usually more privileged) to effective uid
	 * as well.
	 */
	setuid(getuid());
	setgid(getgid());
#endif /* SAVED_IDS_WORK_WITH_SETEUID */

	if (setgroups(saved_egroupslen, saved_egroups) < 0)
		fatal("setgroups: %.100s", strerror(errno));
	temporarily_use_uid_effective = 0;
}

/*
 * Permanently sets all uids to the given uid.  This cannot be
 * called while temporarily_use_uid is effective.
 */
void
permanently_set_uid(struct passwd *pw)
{
	uid_t old_uid = getuid();
	gid_t old_gid = getgid();

	if (temporarily_use_uid_effective)
		fatal("permanently_set_uid: temporarily_use_uid effective");
	debug("permanently_set_uid: %u/%u", (u_int)pw->pw_uid,
	    (u_int)pw->pw_gid);

#if defined(HAVE_SETRESGID) && !defined(BROKEN_SETRESGID)
	if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) < 0)
		fatal("setresgid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
#elif defined(HAVE_SETREGID) && !defined(BROKEN_SETREGID)
	if (setregid(pw->pw_gid, pw->pw_gid) < 0)
		fatal("setregid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
#else
	if (setegid(pw->pw_gid) < 0)
		fatal("setegid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
	if (setgid(pw->pw_gid) < 0)
		fatal("setgid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
#endif

#if defined(HAVE_SETRESUID) && !defined(BROKEN_SETRESUID)
	if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) < 0)
		fatal("setresuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
#elif defined(HAVE_SETREUID) && !defined(BROKEN_SETREUID)
	if (setreuid(pw->pw_uid, pw->pw_uid) < 0)
		fatal("setreuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
#else
# ifndef SETEUID_BREAKS_SETUID
	if (seteuid(pw->pw_uid) < 0)
		fatal("seteuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
# endif
	if (setuid(pw->pw_uid) < 0)
		fatal("setuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
#endif

#ifndef HAVE_CYGWIN
	/* Try restoration of GID if changed (test clearing of saved gid) */
	if (old_gid != pw->pw_gid && pw->pw_uid != 0 &&
	    (setgid(old_gid) != -1 || setegid(old_gid) != -1))
		fatal("%s: was able to restore old [e]gid", __func__);
#endif

	/* Verify GID drop was successful */
	if (getgid() != pw->pw_gid || getegid() != pw->pw_gid) {
		fatal("%s: egid incorrect gid:%u egid:%u (should be %u)",
		    __func__, (u_int)getgid(), (u_int)getegid(),
		    (u_int)pw->pw_gid);
	}

#ifndef HAVE_CYGWIN
	/* Try restoration of UID if changed (test clearing of saved uid) */
	if (old_uid != pw->pw_uid &&
	    (setuid(old_uid) != -1 || seteuid(old_uid) != -1))
		fatal("%s: was able to restore old [e]uid", __func__);
#endif

	/* Verify UID drop was successful */
	if (getuid() != pw->pw_uid || geteuid() != pw->pw_uid) {
		fatal("%s: euid incorrect uid:%u euid:%u (should be %u)",
		    __func__, (u_int)getuid(), (u_int)geteuid(),
		    (u_int)pw->pw_uid);
	}
}
Commit	Line	Data
8efc0c15	1	/*
5260325f	2	* Author: Tatu Ylonen <ylo@cs.hut.fi>
	3	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	4	* All rights reserved
5260325f	5	* Code for uid-swapping.
bcbf86ec	6	*
	7	* As far as I am concerned, the code I have written for this software
	8	* can be used freely for any purpose. Any derived versions of this
	9	* software must be clearly marked as such, and if the derived work is
	10	* incompatible with the protocol description in the RFC file, it must be
	11	* called by a name other than "ssh" or "Secure Shell".
5260325f	12	*/
8efc0c15	13
8efc0c15	14	#include "includes.h"
fa5120a0	15	RCSID("$OpenBSD: uidswap.c,v 1.24 2003/05/29 16:58:45 deraadt Exp $");
8efc0c15	16
42f11eb2	17	#include "log.h"
8efc0c15	18	#include "uidswap.h"
13dff404	19	#include "xmalloc.h"
8efc0c15	20
5260325f	21	/*
	22	* Note: all these functions must work in all of the following cases:
	23	* 1. euid=0, ruid=0
	24	* 2. euid=0, ruid!=0
	25	* 3. euid!=0, ruid!=0
	26	* Additionally, they must work regardless of whether the system has
	27	* POSIX saved uids or not.
	28	*/
8efc0c15	29
0096ac62	30	#if defined(_POSIX_SAVED_IDS) && !defined(BROKEN_SAVED_UIDS)
8efc0c15	31	/* Lets assume that posix saved ids also work with seteuid, even though that
8efc0c15	32	is not part of the posix specification. */
0096ac62	33	#define SAVED_IDS_WORK_WITH_SETEUID
	34	/* Saved effective uid. */
	35	static uid_t saved_euid = 0;
	36	static gid_t saved_egid = 0;
	37	#endif
f8252c48	38
8efc0c15	39	/* Saved effective uid. */
63bd8c36	40	static int privileged = 0;
63bd8c36	41	static int temporarily_use_uid_effective = 0;
13dff404	42	static gid_t saved_egroups = NULL, user_groups = NULL;
63bd8c36	43	static int saved_egroupslen = -1, user_groupslen = -1;
f8252c48	44
5260325f	45	/*
	46	* Temporarily changes to the given uid. If the effective user
	47	* id is not root, this does nothing. This call cannot be nested.
	48	*/
6ae2364d	49	void
63bd8c36	50	temporarily_use_uid(struct passwd *pw)
8efc0c15	51	{
f8252c48	52	/* Save the current euid, and egroups. */
0096ac62	53	#ifdef SAVED_IDS_WORK_WITH_SETEUID
f8252c48	54	saved_euid = geteuid();
0096ac62	55	saved_egid = getegid();
0df3a240	56	debug("temporarily_use_uid: %u/%u (e=%u/%u)",
	57	(u_int)pw->pw_uid, (u_int)pw->pw_gid,
	58	(u_int)saved_euid, (u_int)saved_egid);
c2736f7f	59	#ifndef HAVE_CYGWIN
f8252c48	60	if (saved_euid != 0) {
	61	privileged = 0;
	62	return;
	63	}
c2736f7f	64	#endif
0096ac62	65	#else
	66	if (geteuid() != 0) {
	67	privileged = 0;
	68	return;
	69	}
	70	#endif /* SAVED_IDS_WORK_WITH_SETEUID */
	71
f8252c48	72	privileged = 1;
f8252c48	73	temporarily_use_uid_effective = 1;
13dff404	74
13dff404	75	saved_egroupslen = getgroups(0, NULL);
f8252c48	76	if (saved_egroupslen < 0)
f8252c48	77	fatal("getgroups: %.100s", strerror(errno));
13dff404	78	if (saved_egroupslen > 0) {
	79	saved_egroups = xrealloc(saved_egroups,
	80	saved_egroupslen * sizeof(gid_t));
	81	if (getgroups(saved_egroupslen, saved_egroups) < 0)
	82	fatal("getgroups: %.100s", strerror(errno));
	83	} else { /* saved_egroupslen == 0 */
972fc531	84	if (saved_egroups != NULL)
13dff404	85	xfree(saved_egroups);
13dff404	86	}
f8252c48	87
	88	/* set and save the user's groups */
	89	if (user_groupslen == -1) {
	90	if (initgroups(pw->pw_name, pw->pw_gid) < 0)
	91	fatal("initgroups: %s: %.100s", pw->pw_name,
	92	strerror(errno));
13dff404	93
13dff404	94	user_groupslen = getgroups(0, NULL);
f8252c48	95	if (user_groupslen < 0)
f8252c48	96	fatal("getgroups: %.100s", strerror(errno));
13dff404	97	if (user_groupslen > 0) {
	98	user_groups = xrealloc(user_groups,
	99	user_groupslen * sizeof(gid_t));
	100	if (getgroups(user_groupslen, user_groups) < 0)
	101	fatal("getgroups: %.100s", strerror(errno));
	102	} else { /* user_groupslen == 0 */
	103	if (user_groups)
	104	xfree(user_groups);
	105	}
f8252c48	106	}
f8252c48	107	/* Set the effective uid to the given (unprivileged) uid. */
d98d029a	108	if (setgroups(user_groupslen, user_groups) < 0)
63bd8c36	109	fatal("setgroups: %.100s", strerror(errno));
0096ac62	110	#ifndef SAVED_IDS_WORK_WITH_SETEUID
	111	/* Propagate the privileged gid to all of our gids. */
	112	if (setgid(getegid()) < 0)
	113	debug("setgid %u: %.100s", (u_int) getegid(), strerror(errno));
	114	/* Propagate the privileged uid to all of our uids. */
	115	if (setuid(geteuid()) < 0)
	116	debug("setuid %u: %.100s", (u_int) geteuid(), strerror(errno));
	117	#endif /* SAVED_IDS_WORK_WITH_SETEUID */
d98d029a	118	if (setegid(pw->pw_gid) < 0)
caa49784	119	fatal("setegid %u: %.100s", (u_int)pw->pw_gid,
f8252c48	120	strerror(errno));
f8252c48	121	if (seteuid(pw->pw_uid) == -1)
caa49784	122	fatal("seteuid %u: %.100s", (u_int)pw->pw_uid,
f8252c48	123	strerror(errno));
8efc0c15	124	}
f8252c48	125
5260325f	126	/*
a3626e12	127	* Restores to the original (privileged) uid.
5260325f	128	*/
6ae2364d	129	void
1e3b8b07	130	restore_uid(void)
8efc0c15	131	{
63bd8c36	132	/* it's a no-op unless privileged */
0df3a240	133	if (!privileged) {
0df3a240	134	debug("restore_uid: (unprivileged)");
63bd8c36	135	return;
0df3a240	136	}
63bd8c36	137	if (!temporarily_use_uid_effective)
63bd8c36	138	fatal("restore_uid: temporarily_use_uid not effective");
0096ac62	139
0096ac62	140	#ifdef SAVED_IDS_WORK_WITH_SETEUID
13979d47	141	debug("restore_uid: %u/%u", (u_int)saved_euid, (u_int)saved_egid);
a3626e12	142	/* Set the effective uid back to the saved privileged uid. */
5260325f	143	if (seteuid(saved_euid) < 0)
caa49784	144	fatal("seteuid %u: %.100s", (u_int)saved_euid, strerror(errno));
0096ac62	145	if (setegid(saved_egid) < 0)
caa49784	146	fatal("setegid %u: %.100s", (u_int)saved_egid, strerror(errno));
0096ac62	147	#else /* SAVED_IDS_WORK_WITH_SETEUID */
	148	/*
	149	* We are unable to restore the real uid to its unprivileged value.
	150	* Propagate the real uid (usually more privileged) to effective uid
	151	* as well.
	152	*/
	153	setuid(getuid());
	154	setgid(getgid());
	155	#endif /* SAVED_IDS_WORK_WITH_SETEUID */
	156
d98d029a	157	if (setgroups(saved_egroupslen, saved_egroups) < 0)
63bd8c36	158	fatal("setgroups: %.100s", strerror(errno));
63bd8c36	159	temporarily_use_uid_effective = 0;
8efc0c15	160	}
8efc0c15	161
5260325f	162	/*
	163	* Permanently sets all uids to the given uid. This cannot be
	164	* called while temporarily_use_uid is effective.
	165	*/
6ae2364d	166	void
63bd8c36	167	permanently_set_uid(struct passwd *pw)
8efc0c15	168	{
688eed4a	169	uid_t old_uid = getuid();
	170	gid_t old_gid = getgid();
	171
63bd8c36	172	if (temporarily_use_uid_effective)
95f20fe8	173	fatal("permanently_set_uid: temporarily_use_uid effective");
0df3a240	174	debug("permanently_set_uid: %u/%u", (u_int)pw->pw_uid,
0df3a240	175	(u_int)pw->pw_gid);
688eed4a	176
9a3fe0e2	177	#if defined(HAVE_SETRESGID) && !defined(BROKEN_SETRESGID)
688eed4a	178	if (setresgid(pw->pw_gid, pw->pw_gid, pw->pw_gid) < 0)
688eed4a	179	fatal("setresgid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
3b8dff69	180	#elif defined(HAVE_SETREGID) && !defined(BROKEN_SETREGID)
688eed4a	181	if (setregid(pw->pw_gid, pw->pw_gid) < 0)
	182	fatal("setregid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
	183	#else
fa5120a0	184	if (setegid(pw->pw_gid) < 0)
fa5120a0	185	fatal("setegid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
63bd8c36	186	if (setgid(pw->pw_gid) < 0)
caa49784	187	fatal("setgid %u: %.100s", (u_int)pw->pw_gid, strerror(errno));
688eed4a	188	#endif
688eed4a	189
9a3fe0e2	190	#if defined(HAVE_SETRESUID) && !defined(BROKEN_SETRESUID)
688eed4a	191	if (setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid) < 0)
688eed4a	192	fatal("setresuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
3b8dff69	193	#elif defined(HAVE_SETREUID) && !defined(BROKEN_SETREUID)
f5db6a03	194	if (setreuid(pw->pw_uid, pw->pw_uid) < 0)
f5db6a03	195	fatal("setreuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
688eed4a	196	#else
688eed4a	197	# ifndef SETEUID_BREAKS_SETUID
fa5120a0	198	if (seteuid(pw->pw_uid) < 0)
fa5120a0	199	fatal("seteuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
688eed4a	200	# endif
a3626e12	201	if (setuid(pw->pw_uid) < 0)
caa49784	202	fatal("setuid %u: %.100s", (u_int)pw->pw_uid, strerror(errno));
688eed4a	203	#endif
688eed4a	204
8f817407	205	#ifndef HAVE_CYGWIN
688eed4a	206	/* Try restoration of GID if changed (test clearing of saved gid) */
8f817407	207	if (old_gid != pw->pw_gid && pw->pw_uid != 0 &&
688eed4a	208	(setgid(old_gid) != -1 \|\| setegid(old_gid) != -1))
f5db6a03	209	fatal("%s: was able to restore old [e]gid", __func__);
8f817407	210	#endif
688eed4a	211
	212	/* Verify GID drop was successful */
	213	if (getgid() != pw->pw_gid \|\| getegid() != pw->pw_gid) {
aff51935	214	fatal("%s: egid incorrect gid:%u egid:%u (should be %u)",
aff51935	215	__func__, (u_int)getgid(), (u_int)getegid(),
688eed4a	216	(u_int)pw->pw_gid);
	217	}
	218
51e7d820	219	#ifndef HAVE_CYGWIN
688eed4a	220	/* Try restoration of UID if changed (test clearing of saved uid) */
aff51935	221	if (old_uid != pw->pw_uid &&
688eed4a	222	(setuid(old_uid) != -1 \|\| seteuid(old_uid) != -1))
f5db6a03	223	fatal("%s: was able to restore old [e]uid", __func__);
51e7d820	224	#endif
688eed4a	225
	226	/* Verify UID drop was successful */
	227	if (getuid() != pw->pw_uid \|\| geteuid() != pw->pw_uid) {
aff51935	228	fatal("%s: euid incorrect uid:%u euid:%u (should be %u)",
aff51935	229	__func__, (u_int)getuid(), (u_int)geteuid(),
688eed4a	230	(u_int)pw->pw_uid);
688eed4a	231	}
8efc0c15	232	}