2 Unix SMB/CIFS implementation.
3 Set NT and POSIX ACLs and other VFS operations from Python
5 Copyrigyt (C) Andrew Bartlett 2012
6 Copyright (C) Jeremy Allison 1994-2009.
7 Copyright (C) Andreas Gruenbacher 2002.
8 Copyright (C) Simo Sorce <idra@samba.org> 2009.
9 Copyright (C) Simo Sorce 2002
10 Copyright (C) Eric Lorimer 2002
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
28 #include "python/py3compat.h"
29 #include "python/modules.h"
30 #include "smbd/smbd.h"
31 #include "libcli/util/pyerrors.h"
32 #include "librpc/rpc/pyrpc_util.h"
34 #include "system/filesys.h"
39 extern const struct generic_mapping file_generic_mapping;
42 #define DBGC_CLASS DBGC_ACLS
45 #define DIRECTORY_FLAGS O_RDONLY|O_DIRECTORY
47 /* POSIX allows us to open a directory with O_RDONLY. */
48 #define DIRECTORY_FLAGS O_RDONLY
52 static connection_struct *get_conn_tos(
54 const struct auth_session_info *session_info)
56 struct conn_struct_tos *c = NULL;
60 struct smb_filename cwd_fname = {0};
63 if (!posix_locking_init(false)) {
69 snum = lp_servicenumber(service);
71 PyErr_SetString(PyExc_RuntimeError, "unknown service");
77 * Make sure that session unix info is filled,
78 * which is required by vfs operations.
80 if (session_info->unix_info == NULL) {
81 PyErr_SetString(PyExc_RuntimeError,
82 "Session unix info not initialized");
85 if (session_info->unix_info->unix_name == NULL) {
86 PyErr_SetString(PyExc_RuntimeError,
87 "Session unix info not available");
91 status = create_conn_struct_tos(NULL,
96 PyErr_NTSTATUS_IS_ERR_RAISE(status);
98 /* Ignore read-only and share restrictions */
99 c->conn->read_only = false;
100 c->conn->share_access = SEC_RIGHTS_FILE_ALL;
102 /* Provided by libreplace if not present. Always mallocs. */
103 cwd = get_current_dir_name();
109 cwd_fname.base_name = cwd;
111 * We need to call vfs_ChDir() to initialize
112 * conn->cwd_fsp correctly. Change directory
113 * to current directory (so no change for process).
115 ret = vfs_ChDir(c->conn, &cwd_fname);
117 status = map_nt_error_from_unix(errno);
119 PyErr_NTSTATUS_IS_ERR_RAISE(status);
127 static int set_sys_acl_conn(const char *fname,
128 SMB_ACL_TYPE_T acltype,
129 SMB_ACL_T theacl, connection_struct *conn)
132 struct smb_filename *smb_fname = NULL;
133 TALLOC_CTX *frame = talloc_stackframe();
136 smb_fname = synthetic_smb_fname_split(frame,
138 lp_posix_pathnames());
139 if (smb_fname == NULL) {
144 ret = vfs_stat(conn, smb_fname);
150 status = openat_pathref_fsp(conn->cwd_fsp, smb_fname);
151 if (!NT_STATUS_IS_OK(status)) {
153 errno = map_errno_from_nt_status(status);
157 ret = SMB_VFS_SYS_ACL_SET_FD(smb_fname->fsp, acltype, theacl);
164 static NTSTATUS init_files_struct(TALLOC_CTX *mem_ctx,
166 struct connection_struct *conn,
168 struct files_struct **_fsp)
170 struct smb_filename *smb_fname = NULL;
174 struct files_struct *fsp;
175 struct files_struct *fspcwd = NULL;
178 fsp = talloc_zero(mem_ctx, struct files_struct);
180 return NT_STATUS_NO_MEMORY;
182 fsp->fh = fd_handle_create(fsp);
183 if (fsp->fh == NULL) {
184 return NT_STATUS_NO_MEMORY;
188 smb_fname = synthetic_smb_fname_split(fsp,
190 lp_posix_pathnames());
191 if (smb_fname == NULL) {
192 return NT_STATUS_NO_MEMORY;
195 fsp->fsp_name = smb_fname;
197 status = vfs_at_fspcwd(fsp, conn, &fspcwd);
198 if (!NT_STATUS_IS_OK(status)) {
203 * we want total control over the permissions on created files,
204 * so set our umask to 0 (this matters if flags contains O_CREAT)
206 saved_umask = umask(0);
208 fd = SMB_VFS_OPENAT(conn,
220 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
222 return NT_STATUS_INVALID_PARAMETER;
226 ret = SMB_VFS_FSTAT(fsp, &smb_fname->st);
228 /* If we have an fd, this stat should succeed. */
229 DEBUG(0,("Error doing fstat on open file %s (%s)\n",
230 smb_fname_str_dbg(smb_fname),
232 return map_nt_error_from_unix(errno);
235 fsp->file_id = vfs_file_id_from_sbuf(conn, &smb_fname->st);
236 fsp->vuid = UID_FIELD_INVALID;
238 fsp->fsp_flags.can_lock = true;
239 fsp->fsp_flags.can_read = true;
240 fsp->fsp_flags.can_write = true;
241 fsp->print_file = NULL;
242 fsp->fsp_flags.modified = false;
243 fsp->sent_oplock_break = NO_BREAK_SENT;
244 fsp->fsp_flags.is_directory = S_ISDIR(smb_fname->st.st_ex_mode);
251 static NTSTATUS set_nt_acl_conn(const char *fname,
252 uint32_t security_info_sent, const struct security_descriptor *sd,
253 connection_struct *conn)
255 TALLOC_CTX *frame = talloc_stackframe();
256 struct files_struct *fsp = NULL;
257 NTSTATUS status = NT_STATUS_OK;
259 /* first, try to open it as a file with flag O_RDWR */
260 status = init_files_struct(frame,
265 if (!NT_STATUS_IS_OK(status) && errno == EISDIR) {
266 /* if fail, try to open as dir */
267 status = init_files_struct(frame,
274 if (!NT_STATUS_IS_OK(status)) {
275 DBG_ERR("init_files_struct failed: %s\n",
284 status = SMB_VFS_FSET_NT_ACL(fsp, security_info_sent, sd);
285 if (!NT_STATUS_IS_OK(status)) {
286 DEBUG(0,("set_nt_acl_no_snum: fset_nt_acl returned %s.\n", nt_errstr(status)));
295 static NTSTATUS get_nt_acl_conn(TALLOC_CTX *mem_ctx,
297 connection_struct *conn,
298 uint32_t security_info_wanted,
299 struct security_descriptor **sd)
301 TALLOC_CTX *frame = talloc_stackframe();
303 struct smb_filename *smb_fname = synthetic_smb_fname(talloc_tos(),
308 lp_posix_pathnames() ?
309 SMB_FILENAME_POSIX_PATH : 0);
311 if (smb_fname == NULL) {
313 return NT_STATUS_NO_MEMORY;
316 status = SMB_VFS_GET_NT_ACL_AT(conn,
319 security_info_wanted,
322 if (!NT_STATUS_IS_OK(status)) {
323 DBG_ERR("get_nt_acl_at returned %s.\n",
332 static int set_acl_entry_perms(SMB_ACL_ENTRY_T entry, mode_t perm_mask)
334 SMB_ACL_PERMSET_T perms = NULL;
336 if (sys_acl_get_permset(entry, &perms) != 0) {
340 if (sys_acl_clear_perms(perms) != 0) {
344 if ((perm_mask & SMB_ACL_READ) != 0 &&
345 sys_acl_add_perm(perms, SMB_ACL_READ) != 0) {
349 if ((perm_mask & SMB_ACL_WRITE) != 0 &&
350 sys_acl_add_perm(perms, SMB_ACL_WRITE) != 0) {
354 if ((perm_mask & SMB_ACL_EXECUTE) != 0 &&
355 sys_acl_add_perm(perms, SMB_ACL_EXECUTE) != 0) {
359 if (sys_acl_set_permset(entry, perms) != 0) {
366 static SMB_ACL_T make_simple_acl(TALLOC_CTX *mem_ctx,
370 mode_t mode = SMB_ACL_READ|SMB_ACL_WRITE|SMB_ACL_EXECUTE;
372 mode_t mode_user = (chmod_mode & 0700) >> 6;
373 mode_t mode_group = (chmod_mode & 070) >> 3;
374 mode_t mode_other = chmod_mode & 07;
375 SMB_ACL_ENTRY_T entry;
376 SMB_ACL_T acl = sys_acl_init(mem_ctx);
382 if (sys_acl_create_entry(&acl, &entry) != 0) {
387 if (sys_acl_set_tag_type(entry, SMB_ACL_USER_OBJ) != 0) {
392 if (set_acl_entry_perms(entry, mode_user) != 0) {
397 if (sys_acl_create_entry(&acl, &entry) != 0) {
402 if (sys_acl_set_tag_type(entry, SMB_ACL_GROUP_OBJ) != 0) {
407 if (set_acl_entry_perms(entry, mode_group) != 0) {
412 if (sys_acl_create_entry(&acl, &entry) != 0) {
417 if (sys_acl_set_tag_type(entry, SMB_ACL_OTHER) != 0) {
422 if (set_acl_entry_perms(entry, mode_other) != 0) {
428 if (sys_acl_create_entry(&acl, &entry) != 0) {
433 if (sys_acl_set_tag_type(entry, SMB_ACL_GROUP) != 0) {
438 if (sys_acl_set_qualifier(entry, &gid) != 0) {
443 if (set_acl_entry_perms(entry, mode_group) != 0) {
449 if (sys_acl_create_entry(&acl, &entry) != 0) {
454 if (sys_acl_set_tag_type(entry, SMB_ACL_MASK) != 0) {
459 if (set_acl_entry_perms(entry, mode) != 0) {
468 set a simple ACL on a file, as a test
470 static PyObject *py_smbd_set_simple_acl(PyObject *self, PyObject *args, PyObject *kwargs)
472 const char * const kwnames[] = {
480 char *fname, *service = NULL;
481 PyObject *py_session = Py_None;
482 struct auth_session_info *session_info = NULL;
487 connection_struct *conn;
489 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siO|iz",
490 discard_const_p(char *, kwnames),
498 if (!py_check_dcerpc_type(py_session,
503 session_info = pytalloc_get_type(py_session,
504 struct auth_session_info);
505 if (session_info == NULL) {
506 PyErr_Format(PyExc_TypeError,
507 "Expected auth_session_info for session_info argument got %s",
508 pytalloc_get_name(py_session));
512 frame = talloc_stackframe();
514 acl = make_simple_acl(frame, gid, mode);
520 conn = get_conn_tos(service, session_info);
526 ret = set_sys_acl_conn(fname, SMB_ACL_TYPE_ACCESS, acl, conn);
531 return PyErr_SetFromErrno(PyExc_OSError);
542 static PyObject *py_smbd_chown(PyObject *self, PyObject *args, PyObject *kwargs)
544 const char * const kwnames[] = {
552 connection_struct *conn;
555 char *fname, *service = NULL;
556 PyObject *py_session = Py_None;
557 struct auth_session_info *session_info = NULL;
560 struct files_struct *fsp = NULL;
562 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siiO|z",
563 discard_const_p(char *, kwnames),
571 if (!py_check_dcerpc_type(py_session,
576 session_info = pytalloc_get_type(py_session,
577 struct auth_session_info);
578 if (session_info == NULL) {
579 PyErr_Format(PyExc_TypeError,
580 "Expected auth_session_info for session_info argument got %s",
581 pytalloc_get_name(py_session));
585 frame = talloc_stackframe();
587 conn = get_conn_tos(service, session_info);
593 /* first, try to open it as a file with flag O_RDWR */
594 status = init_files_struct(frame,
599 if (!NT_STATUS_IS_OK(status) && errno == EISDIR) {
600 /* if fail, try to open as dir */
601 status = init_files_struct(frame,
608 if (!NT_STATUS_IS_OK(status)) {
609 DBG_ERR("init_files_struct failed: %s\n",
616 * The following macro raises a python
617 * error then returns NULL.
619 PyErr_NTSTATUS_IS_ERR_RAISE(status);
622 ret = SMB_VFS_FCHOWN(fsp, uid, gid);
624 int saved_errno = errno;
628 return PyErr_SetFromErrno(PyExc_OSError);
640 static PyObject *py_smbd_unlink(PyObject *self, PyObject *args, PyObject *kwargs)
642 const char * const kwnames[] = {
648 connection_struct *conn;
650 struct smb_filename *smb_fname = NULL;
651 struct smb_filename *parent_fname = NULL;
652 struct smb_filename *at_fname = NULL;
653 PyObject *py_session = Py_None;
654 struct auth_session_info *session_info = NULL;
655 char *fname, *service = NULL;
659 frame = talloc_stackframe();
661 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|z",
662 discard_const_p(char *, kwnames),
670 if (!py_check_dcerpc_type(py_session,
676 session_info = pytalloc_get_type(py_session,
677 struct auth_session_info);
678 if (session_info == NULL) {
679 PyErr_Format(PyExc_TypeError,
680 "Expected auth_session_info for session_info argument got %s",
681 pytalloc_get_name(py_session));
686 conn = get_conn_tos(service, session_info);
692 smb_fname = synthetic_smb_fname_split(frame,
694 lp_posix_pathnames());
695 if (smb_fname == NULL) {
697 return PyErr_NoMemory();
700 status = parent_pathref(frame,
705 if (!NT_STATUS_IS_OK(status)) {
707 return PyErr_NoMemory();
710 ret = SMB_VFS_UNLINKAT(conn,
717 return PyErr_SetFromErrno(PyExc_OSError);
726 check if we have ACL support
728 static PyObject *py_smbd_have_posix_acls(PyObject *self,
729 PyObject *Py_UNUSED(ignored))
731 #ifdef HAVE_POSIX_ACLS
732 return PyBool_FromLong(true);
734 return PyBool_FromLong(false);
739 set the NT ACL on a file
741 static PyObject *py_smbd_set_nt_acl(PyObject *self, PyObject *args, PyObject *kwargs)
743 const char * const kwnames[] = {
745 "security_info_sent",
753 char *fname, *service = NULL;
754 int security_info_sent;
756 struct security_descriptor *sd;
757 PyObject *py_session = Py_None;
758 struct auth_session_info *session_info = NULL;
759 connection_struct *conn;
762 frame = talloc_stackframe();
764 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siOO|z",
765 discard_const_p(char *, kwnames),
775 if (!py_check_dcerpc_type(py_sd, "samba.dcerpc.security", "descriptor")) {
780 if (!py_check_dcerpc_type(py_session,
786 session_info = pytalloc_get_type(py_session,
787 struct auth_session_info);
788 if (session_info == NULL) {
789 PyErr_Format(PyExc_TypeError,
790 "Expected auth_session_info for session_info argument got %s",
791 pytalloc_get_name(py_session));
795 conn = get_conn_tos(service, session_info);
801 sd = pytalloc_get_type(py_sd, struct security_descriptor);
803 status = set_nt_acl_conn(fname, security_info_sent, sd, conn);
805 PyErr_NTSTATUS_IS_ERR_RAISE(status);
811 Return the NT ACL on a file
813 static PyObject *py_smbd_get_nt_acl(PyObject *self, PyObject *args, PyObject *kwargs)
815 const char * const kwnames[] = {
817 "security_info_wanted",
822 char *fname, *service = NULL;
823 int security_info_wanted;
825 struct security_descriptor *sd;
826 TALLOC_CTX *frame = talloc_stackframe();
827 PyObject *py_session = Py_None;
828 struct auth_session_info *session_info = NULL;
829 connection_struct *conn;
833 ret = PyArg_ParseTupleAndKeywords(args,
836 discard_const_p(char *, kwnames),
838 &security_info_wanted,
846 if (!py_check_dcerpc_type(py_session,
852 session_info = pytalloc_get_type(py_session,
853 struct auth_session_info);
854 if (session_info == NULL) {
857 "Expected auth_session_info for "
858 "session_info argument got %s",
859 pytalloc_get_name(py_session));
863 conn = get_conn_tos(service, session_info);
869 status = get_nt_acl_conn(frame, fname, conn, security_info_wanted, &sd);
870 PyErr_NTSTATUS_IS_ERR_RAISE(status);
872 py_sd = py_return_ndr_struct("samba.dcerpc.security", "descriptor", sd, sd);
880 set the posix (or similar) ACL on a file
882 static PyObject *py_smbd_set_sys_acl(PyObject *self, PyObject *args, PyObject *kwargs)
884 const char * const kwnames[] = {
892 TALLOC_CTX *frame = talloc_stackframe();
894 char *fname, *service = NULL;
896 PyObject *py_session = Py_None;
897 struct auth_session_info *session_info = NULL;
898 struct smb_acl_t *acl;
900 connection_struct *conn;
902 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siOO|z",
903 discard_const_p(char *, kwnames),
913 if (!py_check_dcerpc_type(py_acl, "samba.dcerpc.smb_acl", "t")) {
918 if (!py_check_dcerpc_type(py_session,
924 session_info = pytalloc_get_type(py_session,
925 struct auth_session_info);
926 if (session_info == NULL) {
927 PyErr_Format(PyExc_TypeError,
928 "Expected auth_session_info for session_info argument got %s",
929 pytalloc_get_name(py_session));
934 conn = get_conn_tos(service, session_info);
940 acl = pytalloc_get_type(py_acl, struct smb_acl_t);
942 ret = set_sys_acl_conn(fname, acl_type, acl, conn);
946 return PyErr_SetFromErrno(PyExc_OSError);
954 Return the posix (or similar) ACL on a file
956 static PyObject *py_smbd_get_sys_acl(PyObject *self, PyObject *args, PyObject *kwargs)
958 const char * const kwnames[] = {
967 PyObject *py_session = Py_None;
968 struct auth_session_info *session_info = NULL;
969 struct smb_acl_t *acl;
971 TALLOC_CTX *frame = talloc_stackframe();
972 connection_struct *conn;
973 char *service = NULL;
974 struct smb_filename *smb_fname = NULL;
976 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siO|z",
977 discard_const_p(char *, kwnames),
986 if (!py_check_dcerpc_type(py_session,
992 session_info = pytalloc_get_type(py_session,
993 struct auth_session_info);
994 if (session_info == NULL) {
995 PyErr_Format(PyExc_TypeError,
996 "Expected auth_session_info for session_info argument got %s",
997 pytalloc_get_name(py_session));
1002 conn = get_conn_tos(service, session_info);
1008 smb_fname = synthetic_smb_fname_split(frame,
1010 lp_posix_pathnames());
1011 if (smb_fname == NULL) {
1015 acl = SMB_VFS_SYS_ACL_GET_FILE( conn, smb_fname, acl_type, frame);
1018 return PyErr_SetFromErrno(PyExc_OSError);
1021 py_acl = py_return_ndr_struct("samba.dcerpc.smb_acl", "t", acl, acl);
1028 static PyObject *py_smbd_mkdir(PyObject *self, PyObject *args, PyObject *kwargs)
1030 const char * const kwnames[] = {
1036 char *fname, *service = NULL;
1037 PyObject *py_session = Py_None;
1038 struct auth_session_info *session_info = NULL;
1039 TALLOC_CTX *frame = talloc_stackframe();
1040 struct connection_struct *conn = NULL;
1041 struct smb_filename *smb_fname = NULL;
1042 struct smb_filename *parent_fname = NULL;
1043 struct smb_filename *base_name = NULL;
1048 if (!PyArg_ParseTupleAndKeywords(args,
1051 discard_const_p(char *,
1060 if (!py_check_dcerpc_type(py_session,
1061 "samba.dcerpc.auth",
1066 session_info = pytalloc_get_type(py_session,
1067 struct auth_session_info);
1068 if (session_info == NULL) {
1069 PyErr_Format(PyExc_TypeError,
1070 "Expected auth_session_info for session_info argument got %s",
1071 pytalloc_get_name(py_session));
1076 conn = get_conn_tos(service, session_info);
1082 smb_fname = synthetic_smb_fname(talloc_tos(),
1087 lp_posix_pathnames() ?
1088 SMB_FILENAME_POSIX_PATH : 0);
1090 if (smb_fname == NULL) {
1095 status = parent_pathref(talloc_tos(),
1100 if (!NT_STATUS_IS_OK(status)) {
1105 /* we want total control over the permissions on created files,
1106 so set our umask to 0 */
1107 saved_umask = umask(0);
1109 ret = SMB_VFS_MKDIRAT(conn,
1117 DBG_ERR("mkdirat error=%d (%s)\n", errno, strerror(errno));
1128 Create an empty file
1130 static PyObject *py_smbd_create_file(PyObject *self, PyObject *args, PyObject *kwargs)
1132 const char * const kwnames[] = {
1138 char *fname, *service = NULL;
1139 PyObject *py_session = Py_None;
1140 struct auth_session_info *session_info = NULL;
1141 TALLOC_CTX *frame = talloc_stackframe();
1142 struct connection_struct *conn = NULL;
1143 struct files_struct *fsp = NULL;
1146 if (!PyArg_ParseTupleAndKeywords(args,
1149 discard_const_p(char *,
1158 if (!py_check_dcerpc_type(py_session,
1159 "samba.dcerpc.auth",
1164 session_info = pytalloc_get_type(py_session,
1165 struct auth_session_info);
1166 if (session_info == NULL) {
1167 PyErr_Format(PyExc_TypeError,
1168 "Expected auth_session_info for session_info argument got %s",
1169 pytalloc_get_name(py_session));
1174 conn = get_conn_tos(service, session_info);
1180 status = init_files_struct(frame,
1183 O_CREAT|O_EXCL|O_RDWR,
1185 if (!NT_STATUS_IS_OK(status)) {
1186 DBG_ERR("init_files_struct failed: %s\n",
1195 static PyMethodDef py_smbd_methods[] = {
1196 { "have_posix_acls",
1197 (PyCFunction)py_smbd_have_posix_acls, METH_NOARGS,
1200 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_simple_acl),
1201 METH_VARARGS|METH_KEYWORDS,
1204 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_nt_acl),
1205 METH_VARARGS|METH_KEYWORDS,
1208 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_get_nt_acl),
1209 METH_VARARGS|METH_KEYWORDS,
1212 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_get_sys_acl),
1213 METH_VARARGS|METH_KEYWORDS,
1216 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_sys_acl),
1217 METH_VARARGS|METH_KEYWORDS,
1220 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_chown),
1221 METH_VARARGS|METH_KEYWORDS,
1224 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_unlink),
1225 METH_VARARGS|METH_KEYWORDS,
1228 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_mkdir),
1229 METH_VARARGS|METH_KEYWORDS,
1232 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_create_file),
1233 METH_VARARGS|METH_KEYWORDS,
1238 void initsmbd(void);
1240 static struct PyModuleDef moduledef = {
1241 PyModuleDef_HEAD_INIT,
1243 .m_doc = "Python bindings for the smbd file server.",
1245 .m_methods = py_smbd_methods,
1248 MODULE_INIT_FUNC(smbd)
1252 m = PyModule_Create(&moduledef);