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