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");
76 status = create_conn_struct_tos(NULL,
81 PyErr_NTSTATUS_IS_ERR_RAISE(status);
83 /* Ignore read-only and share restrictions */
84 c->conn->read_only = false;
85 c->conn->share_access = SEC_RIGHTS_FILE_ALL;
87 /* Provided by libreplace if not present. Always mallocs. */
88 cwd = get_current_dir_name();
94 cwd_fname.base_name = cwd;
96 * We need to call vfs_ChDir() to initialize
97 * conn->cwd_fsp correctly. Change directory
98 * to current directory (so no change for process).
100 ret = vfs_ChDir(c->conn, &cwd_fname);
102 status = map_nt_error_from_unix(errno);
104 PyErr_NTSTATUS_IS_ERR_RAISE(status);
112 static int set_sys_acl_conn(const char *fname,
113 SMB_ACL_TYPE_T acltype,
114 SMB_ACL_T theacl, connection_struct *conn)
117 struct smb_filename *smb_fname = NULL;
119 TALLOC_CTX *frame = talloc_stackframe();
121 smb_fname = synthetic_smb_fname_split(frame,
123 lp_posix_pathnames());
124 if (smb_fname == NULL) {
129 ret = SMB_VFS_SYS_ACL_SET_FILE( conn, smb_fname, acltype, theacl);
136 static NTSTATUS init_files_struct(TALLOC_CTX *mem_ctx,
138 struct connection_struct *conn,
140 struct files_struct **_fsp)
142 struct smb_filename *smb_fname = NULL;
145 struct files_struct *fsp;
147 fsp = talloc_zero(mem_ctx, struct files_struct);
149 return NT_STATUS_NO_MEMORY;
151 fsp->fh = talloc(fsp, struct fd_handle);
152 if (fsp->fh == NULL) {
153 return NT_STATUS_NO_MEMORY;
157 smb_fname = synthetic_smb_fname_split(fsp,
159 lp_posix_pathnames());
160 if (smb_fname == NULL) {
161 return NT_STATUS_NO_MEMORY;
164 fsp->fsp_name = smb_fname;
167 * we want total control over the permissions on created files,
168 * so set our umask to 0 (this matters if flags contains O_CREAT)
170 saved_umask = umask(0);
172 fsp->fh->fd = SMB_VFS_OPEN(conn, smb_fname, fsp, flags, 00644);
176 if (fsp->fh->fd == -1) {
179 return NT_STATUS_OBJECT_NAME_NOT_FOUND;
181 return NT_STATUS_INVALID_PARAMETER;
184 ret = SMB_VFS_FSTAT(fsp, &smb_fname->st);
186 /* If we have an fd, this stat should succeed. */
187 DEBUG(0,("Error doing fstat on open file %s (%s)\n",
188 smb_fname_str_dbg(smb_fname),
190 return map_nt_error_from_unix(errno);
193 fsp->file_id = vfs_file_id_from_sbuf(conn, &smb_fname->st);
194 fsp->vuid = UID_FIELD_INVALID;
196 fsp->can_lock = True;
197 fsp->can_read = True;
198 fsp->can_write = True;
199 fsp->print_file = NULL;
200 fsp->modified = False;
201 fsp->sent_oplock_break = NO_BREAK_SENT;
202 fsp->is_directory = S_ISDIR(smb_fname->st.st_ex_mode);
209 static NTSTATUS set_nt_acl_conn(const char *fname,
210 uint32_t security_info_sent, const struct security_descriptor *sd,
211 connection_struct *conn)
213 TALLOC_CTX *frame = talloc_stackframe();
214 struct files_struct *fsp = NULL;
215 NTSTATUS status = NT_STATUS_OK;
217 /* first, try to open it as a file with flag O_RDWR */
218 status = init_files_struct(frame,
223 if (!NT_STATUS_IS_OK(status) && errno == EISDIR) {
224 /* if fail, try to open as dir */
225 status = init_files_struct(frame,
232 if (!NT_STATUS_IS_OK(status)) {
233 DBG_ERR("init_files_struct failed: %s\n",
242 status = SMB_VFS_FSET_NT_ACL(fsp, security_info_sent, sd);
243 if (!NT_STATUS_IS_OK(status)) {
244 DEBUG(0,("set_nt_acl_no_snum: fset_nt_acl returned %s.\n", nt_errstr(status)));
253 static NTSTATUS get_nt_acl_conn(TALLOC_CTX *mem_ctx,
255 connection_struct *conn,
256 uint32_t security_info_wanted,
257 struct security_descriptor **sd)
259 TALLOC_CTX *frame = talloc_stackframe();
261 struct smb_filename *smb_fname = synthetic_smb_fname(talloc_tos(),
265 lp_posix_pathnames() ?
266 SMB_FILENAME_POSIX_PATH : 0);
268 if (smb_fname == NULL) {
270 return NT_STATUS_NO_MEMORY;
273 status = SMB_VFS_GET_NT_ACL(conn,
275 security_info_wanted,
278 if (!NT_STATUS_IS_OK(status)) {
279 DEBUG(0,("get_nt_acl_conn: get_nt_acl returned %s.\n", nt_errstr(status)));
287 static int set_acl_entry_perms(SMB_ACL_ENTRY_T entry, mode_t perm_mask)
289 SMB_ACL_PERMSET_T perms = NULL;
291 if (sys_acl_get_permset(entry, &perms) != 0) {
295 if (sys_acl_clear_perms(perms) != 0) {
299 if ((perm_mask & SMB_ACL_READ) != 0 &&
300 sys_acl_add_perm(perms, SMB_ACL_READ) != 0) {
304 if ((perm_mask & SMB_ACL_WRITE) != 0 &&
305 sys_acl_add_perm(perms, SMB_ACL_WRITE) != 0) {
309 if ((perm_mask & SMB_ACL_EXECUTE) != 0 &&
310 sys_acl_add_perm(perms, SMB_ACL_EXECUTE) != 0) {
314 if (sys_acl_set_permset(entry, perms) != 0) {
321 static SMB_ACL_T make_simple_acl(TALLOC_CTX *mem_ctx,
325 mode_t mode = SMB_ACL_READ|SMB_ACL_WRITE|SMB_ACL_EXECUTE;
327 mode_t mode_user = (chmod_mode & 0700) >> 6;
328 mode_t mode_group = (chmod_mode & 070) >> 3;
329 mode_t mode_other = chmod_mode & 07;
330 SMB_ACL_ENTRY_T entry;
331 SMB_ACL_T acl = sys_acl_init(mem_ctx);
337 if (sys_acl_create_entry(&acl, &entry) != 0) {
342 if (sys_acl_set_tag_type(entry, SMB_ACL_USER_OBJ) != 0) {
347 if (set_acl_entry_perms(entry, mode_user) != 0) {
352 if (sys_acl_create_entry(&acl, &entry) != 0) {
357 if (sys_acl_set_tag_type(entry, SMB_ACL_GROUP_OBJ) != 0) {
362 if (set_acl_entry_perms(entry, mode_group) != 0) {
367 if (sys_acl_create_entry(&acl, &entry) != 0) {
372 if (sys_acl_set_tag_type(entry, SMB_ACL_OTHER) != 0) {
377 if (set_acl_entry_perms(entry, mode_other) != 0) {
383 if (sys_acl_create_entry(&acl, &entry) != 0) {
388 if (sys_acl_set_tag_type(entry, SMB_ACL_GROUP) != 0) {
393 if (sys_acl_set_qualifier(entry, &gid) != 0) {
398 if (set_acl_entry_perms(entry, mode_group) != 0) {
404 if (sys_acl_create_entry(&acl, &entry) != 0) {
409 if (sys_acl_set_tag_type(entry, SMB_ACL_MASK) != 0) {
414 if (set_acl_entry_perms(entry, mode) != 0) {
423 set a simple ACL on a file, as a test
425 static PyObject *py_smbd_set_simple_acl(PyObject *self, PyObject *args, PyObject *kwargs)
427 const char * const kwnames[] = {
435 char *fname, *service = NULL;
436 PyObject *py_session = Py_None;
437 struct auth_session_info *session_info = NULL;
442 connection_struct *conn;
444 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siO|iz",
445 discard_const_p(char *, kwnames),
453 if (!py_check_dcerpc_type(py_session,
458 session_info = pytalloc_get_type(py_session,
459 struct auth_session_info);
460 if (session_info == NULL) {
461 PyErr_Format(PyExc_TypeError,
462 "Expected auth_session_info for session_info argument got %s",
463 pytalloc_get_name(py_session));
467 frame = talloc_stackframe();
469 acl = make_simple_acl(frame, gid, mode);
475 conn = get_conn_tos(service, session_info);
481 ret = set_sys_acl_conn(fname, SMB_ACL_TYPE_ACCESS, acl, conn);
486 return PyErr_SetFromErrno(PyExc_OSError);
497 static PyObject *py_smbd_chown(PyObject *self, PyObject *args, PyObject *kwargs)
499 const char * const kwnames[] = {
507 connection_struct *conn;
510 char *fname, *service = NULL;
511 PyObject *py_session = Py_None;
512 struct auth_session_info *session_info = NULL;
515 struct files_struct *fsp = NULL;
517 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siiO|z",
518 discard_const_p(char *, kwnames),
526 if (!py_check_dcerpc_type(py_session,
531 session_info = pytalloc_get_type(py_session,
532 struct auth_session_info);
533 if (session_info == NULL) {
534 PyErr_Format(PyExc_TypeError,
535 "Expected auth_session_info for session_info argument got %s",
536 pytalloc_get_name(py_session));
540 frame = talloc_stackframe();
542 conn = get_conn_tos(service, session_info);
548 /* first, try to open it as a file with flag O_RDWR */
549 status = init_files_struct(frame,
554 if (!NT_STATUS_IS_OK(status) && errno == EISDIR) {
555 /* if fail, try to open as dir */
556 status = init_files_struct(frame,
563 if (!NT_STATUS_IS_OK(status)) {
564 DBG_ERR("init_files_struct failed: %s\n",
571 * The following macro raises a python
572 * error then returns NULL.
574 PyErr_NTSTATUS_IS_ERR_RAISE(status);
577 ret = SMB_VFS_FCHOWN(fsp, uid, gid);
579 int saved_errno = errno;
583 return PyErr_SetFromErrno(PyExc_OSError);
595 static PyObject *py_smbd_unlink(PyObject *self, PyObject *args, PyObject *kwargs)
597 const char * const kwnames[] = {
603 connection_struct *conn;
605 struct smb_filename *smb_fname = NULL;
606 PyObject *py_session = Py_None;
607 struct auth_session_info *session_info = NULL;
608 char *fname, *service = NULL;
611 frame = talloc_stackframe();
613 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|z",
614 discard_const_p(char *, kwnames),
622 if (!py_check_dcerpc_type(py_session,
628 session_info = pytalloc_get_type(py_session,
629 struct auth_session_info);
630 if (session_info == NULL) {
631 PyErr_Format(PyExc_TypeError,
632 "Expected auth_session_info for session_info argument got %s",
633 pytalloc_get_name(py_session));
638 conn = get_conn_tos(service, session_info);
644 smb_fname = synthetic_smb_fname_split(frame,
646 lp_posix_pathnames());
647 if (smb_fname == NULL) {
649 return PyErr_NoMemory();
652 ret = SMB_VFS_UNLINKAT(conn,
659 return PyErr_SetFromErrno(PyExc_OSError);
668 check if we have ACL support
670 static PyObject *py_smbd_have_posix_acls(PyObject *self,
671 PyObject *Py_UNUSED(ignored))
673 #ifdef HAVE_POSIX_ACLS
674 return PyBool_FromLong(true);
676 return PyBool_FromLong(false);
681 set the NT ACL on a file
683 static PyObject *py_smbd_set_nt_acl(PyObject *self, PyObject *args, PyObject *kwargs)
685 const char * const kwnames[] = {
687 "security_info_sent",
695 char *fname, *service = NULL;
696 int security_info_sent;
698 struct security_descriptor *sd;
699 PyObject *py_session = Py_None;
700 struct auth_session_info *session_info = NULL;
701 connection_struct *conn;
704 frame = talloc_stackframe();
706 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siOO|z",
707 discard_const_p(char *, kwnames),
717 if (!py_check_dcerpc_type(py_sd, "samba.dcerpc.security", "descriptor")) {
722 if (!py_check_dcerpc_type(py_session,
728 session_info = pytalloc_get_type(py_session,
729 struct auth_session_info);
730 if (session_info == NULL) {
731 PyErr_Format(PyExc_TypeError,
732 "Expected auth_session_info for session_info argument got %s",
733 pytalloc_get_name(py_session));
737 conn = get_conn_tos(service, session_info);
743 sd = pytalloc_get_type(py_sd, struct security_descriptor);
745 status = set_nt_acl_conn(fname, security_info_sent, sd, conn);
747 PyErr_NTSTATUS_IS_ERR_RAISE(status);
753 Return the NT ACL on a file
755 static PyObject *py_smbd_get_nt_acl(PyObject *self, PyObject *args, PyObject *kwargs)
757 const char * const kwnames[] = {
759 "security_info_wanted",
764 char *fname, *service = NULL;
765 int security_info_wanted;
767 struct security_descriptor *sd;
768 TALLOC_CTX *frame = talloc_stackframe();
769 PyObject *py_session = Py_None;
770 struct auth_session_info *session_info = NULL;
771 connection_struct *conn;
775 ret = PyArg_ParseTupleAndKeywords(args,
778 discard_const_p(char *, kwnames),
780 &security_info_wanted,
788 if (py_session != Py_None) {
789 if (!py_check_dcerpc_type(py_session,
795 session_info = pytalloc_get_type(py_session,
796 struct auth_session_info);
800 "Expected auth_session_info for "
801 "session_info argument got %s",
802 pytalloc_get_name(py_session));
807 conn = get_conn_tos(service, session_info);
813 status = get_nt_acl_conn(frame, fname, conn, security_info_wanted, &sd);
814 PyErr_NTSTATUS_IS_ERR_RAISE(status);
816 py_sd = py_return_ndr_struct("samba.dcerpc.security", "descriptor", sd, sd);
824 set the posix (or similar) ACL on a file
826 static PyObject *py_smbd_set_sys_acl(PyObject *self, PyObject *args, PyObject *kwargs)
828 const char * const kwnames[] = {
835 TALLOC_CTX *frame = talloc_stackframe();
837 char *fname, *service = NULL;
839 struct smb_acl_t *acl;
841 connection_struct *conn;
843 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "siO|z",
844 discard_const_p(char *, kwnames),
853 if (!py_check_dcerpc_type(py_acl, "samba.dcerpc.smb_acl", "t")) {
858 conn = get_conn_tos(service, NULL);
864 acl = pytalloc_get_type(py_acl, struct smb_acl_t);
866 ret = set_sys_acl_conn(fname, acl_type, acl, conn);
870 return PyErr_SetFromErrno(PyExc_OSError);
878 Return the posix (or similar) ACL on a file
880 static PyObject *py_smbd_get_sys_acl(PyObject *self, PyObject *args, PyObject *kwargs)
882 const char * const kwnames[] = {
890 struct smb_acl_t *acl;
892 TALLOC_CTX *frame = talloc_stackframe();
893 connection_struct *conn;
894 char *service = NULL;
895 struct smb_filename *smb_fname = NULL;
897 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "si|z",
898 discard_const_p(char *, kwnames),
906 conn = get_conn_tos(service, NULL);
912 smb_fname = synthetic_smb_fname_split(frame,
914 lp_posix_pathnames());
915 if (smb_fname == NULL) {
919 acl = SMB_VFS_SYS_ACL_GET_FILE( conn, smb_fname, acl_type, frame);
922 return PyErr_SetFromErrno(PyExc_OSError);
925 py_acl = py_return_ndr_struct("samba.dcerpc.smb_acl", "t", acl, acl);
932 static PyObject *py_smbd_mkdir(PyObject *self, PyObject *args, PyObject *kwargs)
934 const char * const kwnames[] = {
939 char *fname, *service = NULL;
940 TALLOC_CTX *frame = talloc_stackframe();
941 struct connection_struct *conn = NULL;
942 struct smb_filename *smb_fname = NULL;
946 if (!PyArg_ParseTupleAndKeywords(args,
949 discard_const_p(char *,
957 conn = get_conn_tos(service, NULL);
963 smb_fname = synthetic_smb_fname(talloc_tos(),
967 lp_posix_pathnames() ?
968 SMB_FILENAME_POSIX_PATH : 0);
970 if (smb_fname == NULL) {
975 /* we want total control over the permissions on created files,
976 so set our umask to 0 */
977 saved_umask = umask(0);
979 ret = SMB_VFS_MKDIRAT(conn,
987 DBG_ERR("mkdirat error=%d (%s)\n", errno, strerror(errno));
1000 static PyObject *py_smbd_create_file(PyObject *self, PyObject *args, PyObject *kwargs)
1002 const char * const kwnames[] = {
1007 char *fname, *service = NULL;
1008 TALLOC_CTX *frame = talloc_stackframe();
1009 struct connection_struct *conn = NULL;
1010 struct files_struct *fsp = NULL;
1013 if (!PyArg_ParseTupleAndKeywords(args,
1016 discard_const_p(char *,
1024 conn = get_conn_tos(service, NULL);
1030 status = init_files_struct(frame,
1033 O_CREAT|O_EXCL|O_RDWR,
1035 if (!NT_STATUS_IS_OK(status)) {
1036 DBG_ERR("init_files_struct failed: %s\n",
1045 static PyMethodDef py_smbd_methods[] = {
1046 { "have_posix_acls",
1047 (PyCFunction)py_smbd_have_posix_acls, METH_NOARGS,
1050 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_simple_acl),
1051 METH_VARARGS|METH_KEYWORDS,
1054 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_nt_acl),
1055 METH_VARARGS|METH_KEYWORDS,
1058 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_get_nt_acl),
1059 METH_VARARGS|METH_KEYWORDS,
1062 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_get_sys_acl),
1063 METH_VARARGS|METH_KEYWORDS,
1066 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_set_sys_acl),
1067 METH_VARARGS|METH_KEYWORDS,
1070 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_chown),
1071 METH_VARARGS|METH_KEYWORDS,
1074 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_unlink),
1075 METH_VARARGS|METH_KEYWORDS,
1078 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_mkdir),
1079 METH_VARARGS|METH_KEYWORDS,
1082 PY_DISCARD_FUNC_SIG(PyCFunction, py_smbd_create_file),
1083 METH_VARARGS|METH_KEYWORDS,
1088 void initsmbd(void);
1090 static struct PyModuleDef moduledef = {
1091 PyModuleDef_HEAD_INIT,
1093 .m_doc = "Python bindings for the smbd file server.",
1095 .m_methods = py_smbd_methods,
1098 MODULE_INIT_FUNC(smbd)
1102 m = PyModule_Create(&moduledef);