2 Unix SMB/CIFS implementation.
4 a pass-thru NTVFS module to setup a security context using unix
7 Copyright (C) Andrew Tridgell 2004
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "system/filesys.h"
25 #include "system/passwd.h"
26 #include "auth/auth.h"
27 #include "ntvfs/ntvfs.h"
28 #include "libcli/wbclient/wbclient.h"
29 #define TEVENT_DEPRECATED
32 #if defined(UID_WRAPPER)
33 #if !defined(UID_WRAPPER_REPLACE) && !defined(UID_WRAPPER_NOT_REPLACE)
34 #define UID_WRAPPER_REPLACE
35 #include "../uid_wrapper/uid_wrapper.h"
38 #define uwrap_enabled() 0
42 struct unixuid_private {
43 struct wbc_context *wbc_ctx;
44 struct unix_sec_ctx *last_sec_ctx;
45 struct security_token *last_token;
58 pull the current security context into a unix_sec_ctx
60 static struct unix_sec_ctx *save_unix_security(TALLOC_CTX *mem_ctx)
62 struct unix_sec_ctx *sec = talloc(mem_ctx, struct unix_sec_ctx);
68 sec->ngroups = getgroups(0, NULL);
69 if (sec->ngroups == -1) {
73 sec->groups = talloc_array(sec, gid_t, sec->ngroups);
74 if (sec->groups == NULL) {
79 if (getgroups(sec->ngroups, sec->groups) != sec->ngroups) {
88 set the current security context from a unix_sec_ctx
90 static NTSTATUS set_unix_security(struct unix_sec_ctx *sec)
94 if (setgroups(sec->ngroups, sec->groups) != 0) {
95 return NT_STATUS_ACCESS_DENIED;
97 if (setegid(sec->gid) != 0) {
98 return NT_STATUS_ACCESS_DENIED;
100 if (seteuid(sec->uid) != 0) {
101 return NT_STATUS_ACCESS_DENIED;
106 static int unixuid_nesting_level;
109 called at the start and end of a tevent nesting loop. Needs to save/restore
110 unix security context
112 static int unixuid_event_nesting_hook(struct tevent_context *ev,
117 const char *location)
119 struct unix_sec_ctx *sec_ctx;
121 if (unixuid_nesting_level == 0) {
122 /* we don't need to do anything unless we are nested
123 inside of a call in this module */
128 sec_ctx = save_unix_security(ev);
129 if (sec_ctx == NULL) {
130 DEBUG(0,("%s: Failed to save security context\n", location));
133 *(struct unix_sec_ctx **)stack_ptr = sec_ctx;
134 if (seteuid(0) != 0 || setegid(0) != 0) {
135 DEBUG(0,("%s: Failed to change to root\n", location));
139 /* called when we come out of a nesting level */
142 sec_ctx = *(struct unix_sec_ctx **)stack_ptr;
143 if (sec_ctx == NULL) {
144 /* this happens the first time this function
145 is called, as we install the hook while
146 inside an event in unixuid_connect() */
150 sec_ctx = talloc_get_type_abort(sec_ctx, struct unix_sec_ctx);
151 status = set_unix_security(sec_ctx);
152 talloc_free(sec_ctx);
153 if (!NT_STATUS_IS_OK(status)) {
154 DEBUG(0,("%s: Failed to revert security context (%s)\n",
155 location, nt_errstr(status)));
165 form a unix_sec_ctx from the current security_token
167 static NTSTATUS nt_token_to_unix_security(struct ntvfs_module_context *ntvfs,
168 struct ntvfs_request *req,
169 struct security_token *token,
170 struct unix_sec_ctx **sec)
172 struct unixuid_private *priv = ntvfs->private_data;
176 struct composite_context *ctx;
177 *sec = talloc(req, struct unix_sec_ctx);
179 /* we can't do unix security without a user and group */
180 if (token->num_sids < 2) {
181 return NT_STATUS_ACCESS_DENIED;
184 ids = talloc_array(req, struct id_map, token->num_sids);
185 NT_STATUS_HAVE_NO_MEMORY(ids);
187 ids[0].unixid = NULL;
188 ids[0].sid = token->user_sid;
189 ids[0].status = ID_UNKNOWN;
191 ids[1].unixid = NULL;
192 ids[1].sid = token->group_sid;
193 ids[1].status = ID_UNKNOWN;
195 (*sec)->ngroups = token->num_sids - 2;
196 (*sec)->groups = talloc_array(*sec, gid_t, (*sec)->ngroups);
197 NT_STATUS_HAVE_NO_MEMORY((*sec)->groups);
199 for (i=0;i<(*sec)->ngroups;i++) {
200 ids[i+2].unixid = NULL;
201 ids[i+2].sid = token->sids[i+2];
202 ids[i+2].status = ID_UNKNOWN;
205 ctx = wbc_sids_to_xids_send(priv->wbc_ctx, ids, token->num_sids, ids);
206 NT_STATUS_HAVE_NO_MEMORY(ctx);
208 status = wbc_sids_to_xids_recv(ctx, &ids);
209 NT_STATUS_NOT_OK_RETURN(status);
211 if (ids[0].unixid->type == ID_TYPE_BOTH ||
212 ids[0].unixid->type == ID_TYPE_UID) {
213 (*sec)->uid = ids[0].unixid->id;
215 return NT_STATUS_INVALID_SID;
218 if (ids[1].unixid->type == ID_TYPE_BOTH ||
219 ids[1].unixid->type == ID_TYPE_GID) {
220 (*sec)->gid = ids[1].unixid->id;
222 return NT_STATUS_INVALID_SID;
225 for (i=0;i<(*sec)->ngroups;i++) {
226 if (ids[i+2].unixid->type == ID_TYPE_BOTH ||
227 ids[i+2].unixid->type == ID_TYPE_GID) {
228 (*sec)->groups[i] = ids[i+2].unixid->id;
230 return NT_STATUS_INVALID_SID;
238 setup our unix security context according to the session authentication info
240 static NTSTATUS unixuid_setup_security(struct ntvfs_module_context *ntvfs,
241 struct ntvfs_request *req, struct unix_sec_ctx **sec)
243 struct unixuid_private *priv = ntvfs->private_data;
244 struct security_token *token;
245 struct unix_sec_ctx *newsec;
248 /* If we are asked to set up, but have not had a successful
249 * session setup or tree connect, then these may not be filled
250 * in. ACCESS_DENIED is the right error code here */
251 if (req->session_info == NULL || priv == NULL) {
252 return NT_STATUS_ACCESS_DENIED;
255 token = req->session_info->security_token;
257 *sec = save_unix_security(ntvfs);
259 return NT_STATUS_NO_MEMORY;
262 if (token == priv->last_token) {
263 newsec = priv->last_sec_ctx;
265 status = nt_token_to_unix_security(ntvfs, req, token, &newsec);
266 if (!NT_STATUS_IS_OK(status)) {
270 if (priv->last_sec_ctx) {
271 talloc_free(priv->last_sec_ctx);
273 priv->last_sec_ctx = newsec;
274 priv->last_token = token;
275 talloc_steal(priv, newsec);
278 status = set_unix_security(newsec);
279 if (!NT_STATUS_IS_OK(status)) {
288 this pass through macro operates on request contexts
290 #define PASS_THRU_REQ(ntvfs, req, op, args) do { \
292 struct unix_sec_ctx *sec; \
293 status = unixuid_setup_security(ntvfs, req, &sec); \
294 NT_STATUS_NOT_OK_RETURN(status); \
295 unixuid_nesting_level++; \
296 status = ntvfs_next_##op args; \
297 unixuid_nesting_level--; \
298 status2 = set_unix_security(sec); \
300 if (!NT_STATUS_IS_OK(status2)) smb_panic("Unable to reset security context"); \
306 connect to a share - used when a tree_connect operation comes in.
308 static NTSTATUS unixuid_connect(struct ntvfs_module_context *ntvfs,
309 struct ntvfs_request *req, union smb_tcon *tcon)
311 struct unixuid_private *priv;
314 priv = talloc(ntvfs, struct unixuid_private);
316 return NT_STATUS_NO_MEMORY;
319 priv->wbc_ctx = wbc_init(priv, ntvfs->ctx->msg_ctx,
320 ntvfs->ctx->event_ctx);
321 if (priv->wbc_ctx == NULL) {
323 return NT_STATUS_INTERNAL_ERROR;
326 priv->last_sec_ctx = NULL;
327 priv->last_token = NULL;
328 ntvfs->private_data = priv;
330 tevent_loop_set_nesting_hook(ntvfs->ctx->event_ctx,
331 unixuid_event_nesting_hook,
332 &unixuid_nesting_level);
334 /* we don't use PASS_THRU_REQ here, as the connect operation runs with
335 root privileges. This allows the backends to setup any database
336 links they might need during the connect. */
337 status = ntvfs_next_connect(ntvfs, req, tcon);
343 disconnect from a share
345 static NTSTATUS unixuid_disconnect(struct ntvfs_module_context *ntvfs)
347 struct unixuid_private *priv = ntvfs->private_data;
351 ntvfs->private_data = NULL;
353 status = ntvfs_next_disconnect(ntvfs);
362 static NTSTATUS unixuid_unlink(struct ntvfs_module_context *ntvfs,
363 struct ntvfs_request *req,
364 union smb_unlink *unl)
368 PASS_THRU_REQ(ntvfs, req, unlink, (ntvfs, req, unl));
376 static NTSTATUS unixuid_ioctl(struct ntvfs_module_context *ntvfs,
377 struct ntvfs_request *req, union smb_ioctl *io)
381 PASS_THRU_REQ(ntvfs, req, ioctl, (ntvfs, req, io));
387 check if a directory exists
389 static NTSTATUS unixuid_chkpath(struct ntvfs_module_context *ntvfs,
390 struct ntvfs_request *req,
391 union smb_chkpath *cp)
395 PASS_THRU_REQ(ntvfs, req, chkpath, (ntvfs, req, cp));
401 return info on a pathname
403 static NTSTATUS unixuid_qpathinfo(struct ntvfs_module_context *ntvfs,
404 struct ntvfs_request *req, union smb_fileinfo *info)
408 PASS_THRU_REQ(ntvfs, req, qpathinfo, (ntvfs, req, info));
414 query info on a open file
416 static NTSTATUS unixuid_qfileinfo(struct ntvfs_module_context *ntvfs,
417 struct ntvfs_request *req, union smb_fileinfo *info)
421 PASS_THRU_REQ(ntvfs, req, qfileinfo, (ntvfs, req, info));
428 set info on a pathname
430 static NTSTATUS unixuid_setpathinfo(struct ntvfs_module_context *ntvfs,
431 struct ntvfs_request *req, union smb_setfileinfo *st)
435 PASS_THRU_REQ(ntvfs, req, setpathinfo, (ntvfs, req, st));
443 static NTSTATUS unixuid_open(struct ntvfs_module_context *ntvfs,
444 struct ntvfs_request *req, union smb_open *io)
448 PASS_THRU_REQ(ntvfs, req, open, (ntvfs, req, io));
456 static NTSTATUS unixuid_mkdir(struct ntvfs_module_context *ntvfs,
457 struct ntvfs_request *req, union smb_mkdir *md)
461 PASS_THRU_REQ(ntvfs, req, mkdir, (ntvfs, req, md));
469 static NTSTATUS unixuid_rmdir(struct ntvfs_module_context *ntvfs,
470 struct ntvfs_request *req, struct smb_rmdir *rd)
474 PASS_THRU_REQ(ntvfs, req, rmdir, (ntvfs, req, rd));
480 rename a set of files
482 static NTSTATUS unixuid_rename(struct ntvfs_module_context *ntvfs,
483 struct ntvfs_request *req, union smb_rename *ren)
487 PASS_THRU_REQ(ntvfs, req, rename, (ntvfs, req, ren));
495 static NTSTATUS unixuid_copy(struct ntvfs_module_context *ntvfs,
496 struct ntvfs_request *req, struct smb_copy *cp)
500 PASS_THRU_REQ(ntvfs, req, copy, (ntvfs, req, cp));
508 static NTSTATUS unixuid_read(struct ntvfs_module_context *ntvfs,
509 struct ntvfs_request *req, union smb_read *rd)
513 PASS_THRU_REQ(ntvfs, req, read, (ntvfs, req, rd));
521 static NTSTATUS unixuid_write(struct ntvfs_module_context *ntvfs,
522 struct ntvfs_request *req, union smb_write *wr)
526 PASS_THRU_REQ(ntvfs, req, write, (ntvfs, req, wr));
534 static NTSTATUS unixuid_seek(struct ntvfs_module_context *ntvfs,
535 struct ntvfs_request *req,
540 PASS_THRU_REQ(ntvfs, req, seek, (ntvfs, req, io));
548 static NTSTATUS unixuid_flush(struct ntvfs_module_context *ntvfs,
549 struct ntvfs_request *req,
554 PASS_THRU_REQ(ntvfs, req, flush, (ntvfs, req, io));
562 static NTSTATUS unixuid_close(struct ntvfs_module_context *ntvfs,
563 struct ntvfs_request *req, union smb_close *io)
567 PASS_THRU_REQ(ntvfs, req, close, (ntvfs, req, io));
575 static NTSTATUS unixuid_exit(struct ntvfs_module_context *ntvfs,
576 struct ntvfs_request *req)
580 PASS_THRU_REQ(ntvfs, req, exit, (ntvfs, req));
586 logoff - closing files
588 static NTSTATUS unixuid_logoff(struct ntvfs_module_context *ntvfs,
589 struct ntvfs_request *req)
591 struct unixuid_private *priv = ntvfs->private_data;
594 PASS_THRU_REQ(ntvfs, req, logoff, (ntvfs, req));
596 priv->last_token = NULL;
604 static NTSTATUS unixuid_async_setup(struct ntvfs_module_context *ntvfs,
605 struct ntvfs_request *req,
610 PASS_THRU_REQ(ntvfs, req, async_setup, (ntvfs, req, private_data));
616 cancel an async request
618 static NTSTATUS unixuid_cancel(struct ntvfs_module_context *ntvfs,
619 struct ntvfs_request *req)
623 PASS_THRU_REQ(ntvfs, req, cancel, (ntvfs, req));
631 static NTSTATUS unixuid_notify(struct ntvfs_module_context *ntvfs,
632 struct ntvfs_request *req, union smb_notify *info)
636 PASS_THRU_REQ(ntvfs, req, notify, (ntvfs, req, info));
644 static NTSTATUS unixuid_lock(struct ntvfs_module_context *ntvfs,
645 struct ntvfs_request *req, union smb_lock *lck)
649 PASS_THRU_REQ(ntvfs, req, lock, (ntvfs, req, lck));
655 set info on a open file
657 static NTSTATUS unixuid_setfileinfo(struct ntvfs_module_context *ntvfs,
658 struct ntvfs_request *req,
659 union smb_setfileinfo *info)
663 PASS_THRU_REQ(ntvfs, req, setfileinfo, (ntvfs, req, info));
670 return filesystem space info
672 static NTSTATUS unixuid_fsinfo(struct ntvfs_module_context *ntvfs,
673 struct ntvfs_request *req, union smb_fsinfo *fs)
677 PASS_THRU_REQ(ntvfs, req, fsinfo, (ntvfs, req, fs));
683 return print queue info
685 static NTSTATUS unixuid_lpq(struct ntvfs_module_context *ntvfs,
686 struct ntvfs_request *req, union smb_lpq *lpq)
690 PASS_THRU_REQ(ntvfs, req, lpq, (ntvfs, req, lpq));
696 list files in a directory matching a wildcard pattern
698 static NTSTATUS unixuid_search_first(struct ntvfs_module_context *ntvfs,
699 struct ntvfs_request *req, union smb_search_first *io,
700 void *search_private,
701 bool (*callback)(void *, const union smb_search_data *))
705 PASS_THRU_REQ(ntvfs, req, search_first, (ntvfs, req, io, search_private, callback));
710 /* continue a search */
711 static NTSTATUS unixuid_search_next(struct ntvfs_module_context *ntvfs,
712 struct ntvfs_request *req, union smb_search_next *io,
713 void *search_private,
714 bool (*callback)(void *, const union smb_search_data *))
718 PASS_THRU_REQ(ntvfs, req, search_next, (ntvfs, req, io, search_private, callback));
724 static NTSTATUS unixuid_search_close(struct ntvfs_module_context *ntvfs,
725 struct ntvfs_request *req, union smb_search_close *io)
729 PASS_THRU_REQ(ntvfs, req, search_close, (ntvfs, req, io));
734 /* SMBtrans - not used on file shares */
735 static NTSTATUS unixuid_trans(struct ntvfs_module_context *ntvfs,
736 struct ntvfs_request *req, struct smb_trans2 *trans2)
740 PASS_THRU_REQ(ntvfs, req, trans, (ntvfs, req, trans2));
746 initialise the unixuid backend, registering ourselves with the ntvfs subsystem
748 NTSTATUS ntvfs_unixuid_init(void)
751 struct ntvfs_ops ops;
752 NTVFS_CURRENT_CRITICAL_SIZES(vers);
756 /* fill in all the operations */
757 ops.connect = unixuid_connect;
758 ops.disconnect = unixuid_disconnect;
759 ops.unlink = unixuid_unlink;
760 ops.chkpath = unixuid_chkpath;
761 ops.qpathinfo = unixuid_qpathinfo;
762 ops.setpathinfo = unixuid_setpathinfo;
763 ops.open = unixuid_open;
764 ops.mkdir = unixuid_mkdir;
765 ops.rmdir = unixuid_rmdir;
766 ops.rename = unixuid_rename;
767 ops.copy = unixuid_copy;
768 ops.ioctl = unixuid_ioctl;
769 ops.read = unixuid_read;
770 ops.write = unixuid_write;
771 ops.seek = unixuid_seek;
772 ops.flush = unixuid_flush;
773 ops.close = unixuid_close;
774 ops.exit = unixuid_exit;
775 ops.lock = unixuid_lock;
776 ops.setfileinfo = unixuid_setfileinfo;
777 ops.qfileinfo = unixuid_qfileinfo;
778 ops.fsinfo = unixuid_fsinfo;
779 ops.lpq = unixuid_lpq;
780 ops.search_first = unixuid_search_first;
781 ops.search_next = unixuid_search_next;
782 ops.search_close = unixuid_search_close;
783 ops.trans = unixuid_trans;
784 ops.logoff = unixuid_logoff;
785 ops.async_setup = unixuid_async_setup;
786 ops.cancel = unixuid_cancel;
787 ops.notify = unixuid_notify;
789 ops.name = "unixuid";
791 /* we register under all 3 backend types, as we are not type specific */
792 ops.type = NTVFS_DISK;
793 ret = ntvfs_register(&ops, &vers);
794 if (!NT_STATUS_IS_OK(ret)) goto failed;
796 ops.type = NTVFS_PRINT;
797 ret = ntvfs_register(&ops, &vers);
798 if (!NT_STATUS_IS_OK(ret)) goto failed;
800 ops.type = NTVFS_IPC;
801 ret = ntvfs_register(&ops, &vers);
802 if (!NT_STATUS_IS_OK(ret)) goto failed;