2 Unix SMB/CIFS implementation.
4 Copyright (C) Amitay Isaacs 2011
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "param/param.h"
25 #include "param/pyparam.h"
26 #include "system/dir.h"
27 #include "system/filesys.h"
28 #include "lib/events/events.h"
29 #include "auth/credentials/credentials.h"
30 #include "auth/credentials/pycredentials.h"
31 #include "auth/gensec/gensec.h"
32 #include "libcli/libcli.h"
33 #include "libcli/raw/libcliraw.h"
34 #include "libcli/raw/raw_proto.h"
35 #include "libcli/resolve/resolve.h"
36 #include "libcli/util/pyerrors.h"
37 #include "libcli/smb_composite/smb_composite.h"
38 #include "libcli/security/security_descriptor.h"
39 #include "librpc/rpc/pyrpc_util.h"
41 static PyTypeObject PySMB
;
45 struct smb_private_data
{
46 struct loadparm_context
*lp_ctx
;
47 struct cli_credentials
*creds
;
48 struct tevent_context
*ev_ctx
;
49 struct smbcli_tree
*tree
;
52 static void dos_format(char *s
)
54 string_replace(s
, '/', '\\');
59 * Connect to SMB share using smb_full_connection
61 static NTSTATUS
do_smb_connect(TALLOC_CTX
*mem_ctx
, struct smb_private_data
*spdata
,
62 const char *hostname
, const char *service
, struct smbcli_tree
**tree
)
64 struct smbcli_state
*smb_state
;
66 struct smbcli_options options
;
67 struct smbcli_session_options session_options
;
73 smb_state
= smbcli_state_init(mem_ctx
);
75 lpcfg_smbcli_options(spdata
->lp_ctx
, &options
);
76 lpcfg_smbcli_session_options(spdata
->lp_ctx
, &session_options
);
78 status
= smbcli_full_connection(mem_ctx
, &smb_state
, hostname
,
79 lpcfg_smb_ports(spdata
->lp_ctx
),
82 lpcfg_socket_options(spdata
->lp_ctx
),
84 lpcfg_resolve_context(spdata
->lp_ctx
),
88 lpcfg_gensec_settings(mem_ctx
, spdata
->lp_ctx
));
90 if (NT_STATUS_IS_OK(status
)) {
91 *tree
= smb_state
->tree
;
99 * Read SMB file and return the contents of the file as python string
101 static PyObject
* py_smb_loadfile(PyObject
*self
, PyObject
*args
)
103 struct smb_composite_loadfile io
;
104 const char *filename
;
106 struct smb_private_data
*spdata
;
108 if (!PyArg_ParseTuple(args
, "s:loadfile", &filename
)) {
114 io
.in
.fname
= filename
;
116 spdata
= pytalloc_get_ptr(self
);
117 status
= smb_composite_loadfile(spdata
->tree
, pytalloc_get_mem_ctx(self
), &io
);
118 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
120 return Py_BuildValue("s#", io
.out
.data
, io
.out
.size
);
124 * Create a SMB file with given string as the contents
126 static PyObject
* py_smb_savefile(PyObject
*self
, PyObject
*args
)
128 struct smb_composite_savefile io
;
129 const char *filename
;
132 struct smb_private_data
*spdata
;
134 if (!PyArg_ParseTuple(args
, "ss:savefile", &filename
, &data
)) {
138 io
.in
.fname
= filename
;
139 io
.in
.data
= (unsigned char *)data
;
140 io
.in
.size
= strlen(data
);
142 spdata
= pytalloc_get_ptr(self
);
143 status
= smb_composite_savefile(spdata
->tree
, &io
);
144 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
150 * Callback function to accumulate directory contents in a python list
152 static void py_smb_list_callback(struct clilist_file_info
*f
, const char *mask
, void *state
)
154 PyObject
*py_dirlist
;
157 if(!ISDOT(f
->name
) && !ISDOTDOT(f
->name
)) {
158 py_dirlist
= (PyObject
*)state
;
162 PyDict_SetItemString(dict
, "name", PyString_FromString(f
->name
));
164 /* Windows does not always return short_name */
166 PyDict_SetItemString(dict
, "short_name", PyString_FromString(f
->short_name
));
168 PyDict_SetItemString(dict
, "short_name", Py_None
);
171 PyDict_SetItemString(dict
, "size", PyLong_FromUnsignedLongLong(f
->size
));
172 PyDict_SetItemString(dict
, "attrib", PyInt_FromLong(f
->attrib
));
173 PyDict_SetItemString(dict
, "mtime", PyInt_FromLong(f
->mtime
));
175 PyList_Append(py_dirlist
, dict
);
181 * List the directory contents for specified directory (Ignore '.' and '..' dirs)
183 static PyObject
*py_smb_list(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
185 struct smb_private_data
*spdata
;
186 PyObject
*py_dirlist
;
187 const char *kwnames
[] = { "directory", "mask", "attribs", NULL
};
189 char *user_mask
= NULL
;
191 uint16_t attribute
= FILE_ATTRIBUTE_SYSTEM
| FILE_ATTRIBUTE_DIRECTORY
192 | FILE_ATTRIBUTE_ARCHIVE
;
194 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "z|sH:list",
195 discard_const_p(char *, kwnames
),
196 &base_dir
, &user_mask
, &attribute
)) {
200 if (user_mask
== NULL
) {
201 mask
= talloc_asprintf(pytalloc_get_mem_ctx(self
), "%s\\*", base_dir
);
203 mask
= talloc_asprintf(pytalloc_get_mem_ctx(self
), "%s\\%s", base_dir
, user_mask
);
207 spdata
= pytalloc_get_ptr(self
);
209 if((py_dirlist
= PyList_New(0)) == NULL
) {
214 smbcli_list(spdata
->tree
, mask
, attribute
, py_smb_list_callback
, (void *)py_dirlist
);
224 static PyObject
*py_smb_mkdir(PyObject
*self
, PyObject
*args
)
228 struct smb_private_data
*spdata
;
230 if (!PyArg_ParseTuple(args
, "s:mkdir", &dirname
)) {
234 spdata
= pytalloc_get_ptr(self
);
235 status
= smbcli_mkdir(spdata
->tree
, dirname
);
236 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
244 static PyObject
*py_smb_rmdir(PyObject
*self
, PyObject
*args
)
248 struct smb_private_data
*spdata
;
250 if (!PyArg_ParseTuple(args
, "s:rmdir", &dirname
)) {
254 spdata
= pytalloc_get_ptr(self
);
255 status
= smbcli_rmdir(spdata
->tree
, dirname
);
256 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
262 * Remove a directory and all its contents
264 static PyObject
*py_smb_deltree(PyObject
*self
, PyObject
*args
)
268 struct smb_private_data
*spdata
;
270 if (!PyArg_ParseTuple(args
, "s:deltree", &dirname
)) {
274 spdata
= pytalloc_get_ptr(self
);
275 status
= smbcli_deltree(spdata
->tree
, dirname
);
284 * Check existence of a path
286 static PyObject
*py_smb_chkpath(PyObject
*self
, PyObject
*args
)
290 struct smb_private_data
*spdata
;
292 if (!PyArg_ParseTuple(args
, "s:chkpath", &path
)) {
296 spdata
= pytalloc_get_ptr(self
);
297 status
= smbcli_chkpath(spdata
->tree
, path
);
299 if (NT_STATUS_IS_OK(status
)) {
307 * Read ACL on a given file/directory as a security descriptor object
309 static PyObject
*py_smb_getacl(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
313 union smb_fileinfo fio
;
314 struct smb_private_data
*spdata
;
315 const char *filename
;
317 int access_mask
= SEC_FLAG_MAXIMUM_ALLOWED
;
320 if (!PyArg_ParseTuple(args
, "s|Ii:get_acl", &filename
, &sinfo
, &access_mask
)) {
326 spdata
= pytalloc_get_ptr(self
);
328 io
.generic
.level
= RAW_OPEN_NTCREATEX
;
329 io
.ntcreatex
.in
.root_fid
.fnum
= 0;
330 io
.ntcreatex
.in
.flags
= 0;
331 io
.ntcreatex
.in
.access_mask
= access_mask
;
332 io
.ntcreatex
.in
.create_options
= 0;
333 io
.ntcreatex
.in
.file_attr
= FILE_ATTRIBUTE_NORMAL
;
334 io
.ntcreatex
.in
.share_access
= NTCREATEX_SHARE_ACCESS_READ
|
335 NTCREATEX_SHARE_ACCESS_WRITE
;
336 io
.ntcreatex
.in
.alloc_size
= 0;
337 io
.ntcreatex
.in
.open_disposition
= NTCREATEX_DISP_OPEN
;
338 io
.ntcreatex
.in
.impersonation
= NTCREATEX_IMPERSONATION_ANONYMOUS
;
339 io
.ntcreatex
.in
.security_flags
= 0;
340 io
.ntcreatex
.in
.fname
= filename
;
342 status
= smb_raw_open(spdata
->tree
, pytalloc_get_mem_ctx(self
), &io
);
343 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
345 fnum
= io
.ntcreatex
.out
.file
.fnum
;
349 fio
.query_secdesc
.level
= RAW_FILEINFO_SEC_DESC
;
350 fio
.query_secdesc
.in
.file
.fnum
= fnum
;
352 fio
.query_secdesc
.in
.secinfo_flags
= sinfo
;
354 fio
.query_secdesc
.in
.secinfo_flags
= SECINFO_OWNER
|
357 SECINFO_PROTECTED_DACL
|
358 SECINFO_UNPROTECTED_DACL
|
360 SECINFO_PROTECTED_SACL
|
361 SECINFO_UNPROTECTED_SACL
;
363 status
= smb_raw_query_secdesc(spdata
->tree
, pytalloc_get_mem_ctx(self
), &fio
);
364 smbcli_close(spdata
->tree
, fnum
);
366 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
368 return py_return_ndr_struct("samba.dcerpc.security", "descriptor",
369 pytalloc_get_mem_ctx(self
), fio
.query_secdesc
.out
.sd
);
373 * Set ACL on file/directory using given security descriptor object
375 static PyObject
*py_smb_setacl(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
379 union smb_setfileinfo fio
;
380 struct smb_private_data
*spdata
;
381 const char *filename
;
383 struct security_descriptor
*sd
;
387 if (!PyArg_ParseTuple(args
, "sO|I:get_acl", &filename
, &py_sd
, &sinfo
)) {
391 spdata
= pytalloc_get_ptr(self
);
393 sd
= pytalloc_get_type(py_sd
, struct security_descriptor
);
395 PyErr_Format(PyExc_TypeError
,
396 "Expected dcerpc.security.descriptor as argument, got %s",
397 talloc_get_name(pytalloc_get_ptr(py_sd
)));
403 spdata
= pytalloc_get_ptr(self
);
405 io
.generic
.level
= RAW_OPEN_NTCREATEX
;
406 io
.ntcreatex
.in
.root_fid
.fnum
= 0;
407 io
.ntcreatex
.in
.flags
= 0;
408 io
.ntcreatex
.in
.access_mask
= SEC_FLAG_MAXIMUM_ALLOWED
;
409 io
.ntcreatex
.in
.create_options
= 0;
410 io
.ntcreatex
.in
.file_attr
= FILE_ATTRIBUTE_NORMAL
;
411 io
.ntcreatex
.in
.share_access
= NTCREATEX_SHARE_ACCESS_READ
|
412 NTCREATEX_SHARE_ACCESS_WRITE
;
413 io
.ntcreatex
.in
.alloc_size
= 0;
414 io
.ntcreatex
.in
.open_disposition
= NTCREATEX_DISP_OPEN
;
415 io
.ntcreatex
.in
.impersonation
= NTCREATEX_IMPERSONATION_ANONYMOUS
;
416 io
.ntcreatex
.in
.security_flags
= 0;
417 io
.ntcreatex
.in
.fname
= filename
;
419 status
= smb_raw_open(spdata
->tree
, pytalloc_get_mem_ctx(self
), &io
);
420 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
422 fnum
= io
.ntcreatex
.out
.file
.fnum
;
426 fio
.set_secdesc
.level
= RAW_SFILEINFO_SEC_DESC
;
427 fio
.set_secdesc
.in
.file
.fnum
= fnum
;
429 fio
.set_secdesc
.in
.secinfo_flags
= sinfo
;
431 fio
.set_secdesc
.in
.secinfo_flags
= SECINFO_OWNER
|
434 SECINFO_PROTECTED_DACL
|
435 SECINFO_UNPROTECTED_DACL
|
437 SECINFO_PROTECTED_SACL
|
438 SECINFO_UNPROTECTED_SACL
;
440 fio
.set_secdesc
.in
.sd
= sd
;
442 status
= smb_raw_set_secdesc(spdata
->tree
, &fio
);
443 smbcli_close(spdata
->tree
, fnum
);
445 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
451 * Open the file with the parameters passed in and return an object if OK
453 static PyObject
*py_open_file(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
457 struct smb_private_data
*spdata
;
458 const char *filename
;
459 uint32_t access_mask
= SEC_FLAG_MAXIMUM_ALLOWED
;
460 uint32_t share_access
= NTCREATEX_SHARE_ACCESS_READ
|
461 NTCREATEX_SHARE_ACCESS_WRITE
;
462 uint32_t open_disposition
= NTCREATEX_DISP_OPEN
;
463 uint32_t create_options
= 0;
467 if (!PyArg_ParseTuple(args
, "s|iiii:open_file",
478 spdata
= pytalloc_get_ptr(self
);
480 mem_ctx
= talloc_new(NULL
);
482 io
.generic
.level
= RAW_OPEN_NTCREATEX
;
483 io
.ntcreatex
.in
.root_fid
.fnum
= 0;
484 io
.ntcreatex
.in
.flags
= 0;
485 io
.ntcreatex
.in
.access_mask
= access_mask
;
486 io
.ntcreatex
.in
.create_options
= create_options
;
487 io
.ntcreatex
.in
.file_attr
= FILE_ATTRIBUTE_NORMAL
;
488 io
.ntcreatex
.in
.share_access
= share_access
;
489 io
.ntcreatex
.in
.alloc_size
= 0;
490 io
.ntcreatex
.in
.open_disposition
= open_disposition
;
491 io
.ntcreatex
.in
.impersonation
= NTCREATEX_IMPERSONATION_ANONYMOUS
;
492 io
.ntcreatex
.in
.security_flags
= 0;
493 io
.ntcreatex
.in
.fname
= filename
;
495 status
= smb_raw_open(spdata
->tree
, mem_ctx
, &io
);
496 talloc_free(mem_ctx
);
498 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
500 fnum
= io
.ntcreatex
.out
.file
.fnum
;
502 return Py_BuildValue("i", fnum
);
506 * Close the file based on the fnum passed in
508 static PyObject
*py_close_file(PyObject
*self
, PyObject
*args
, PyObject
*kwargs
)
510 struct smb_private_data
*spdata
;
513 if (!PyArg_ParseTuple(args
, "i:close_file", &fnum
)) {
517 spdata
= pytalloc_get_ptr(self
);
520 * Should check the status ...
522 smbcli_close(spdata
->tree
, fnum
);
527 static PyMethodDef py_smb_methods
[] = {
528 { "loadfile", py_smb_loadfile
, METH_VARARGS
,
529 "loadfile(path) -> file contents as a string\n\n \
530 Read contents of a file." },
531 { "savefile", py_smb_savefile
, METH_VARARGS
,
532 "savefile(path, str) -> None\n\n \
533 Write string str to file." },
534 { "list", (PyCFunction
)py_smb_list
, METH_VARARGS
|METH_KEYWORDS
,
535 "list(path) -> directory contents as a dictionary\n\n \
536 List contents of a directory. The keys are, \n \
537 \tname: Long name of the directory item\n \
538 \tshort_name: Short name of the directory item\n \
539 \tsize: File size in bytes\n \
540 \tattrib: Attributes\n \
541 \tmtime: Modification time\n" },
542 { "mkdir", py_smb_mkdir
, METH_VARARGS
,
543 "mkdir(path) -> None\n\n \
544 Create a directory." },
545 { "rmdir", py_smb_rmdir
, METH_VARARGS
,
546 "rmdir(path) -> None\n\n \
547 Delete a directory." },
548 { "deltree", py_smb_deltree
, METH_VARARGS
,
549 "deltree(path) -> None\n\n \
550 Delete a directory and all its contents." },
551 { "chkpath", py_smb_chkpath
, METH_VARARGS
,
552 "chkpath(path) -> True or False\n\n \
553 Return true if path exists, false otherwise." },
554 { "get_acl", (PyCFunction
)py_smb_getacl
, METH_VARARGS
,
555 "get_acl(path[, security_info=0]) -> security_descriptor object\n\n \
556 Get security descriptor for file." },
557 { "set_acl", (PyCFunction
)py_smb_setacl
, METH_VARARGS
,
558 "set_acl(path, security_descriptor[, security_info=0]) -> None\n\n \
559 Set security descriptor for file." },
560 { "open_file", (PyCFunction
)py_open_file
, METH_VARARGS
,
561 "open_file(path, access_mask[, share_access[, open_disposition[, create_options]]] -> fnum\n\n \
562 Open a file. Throws NTSTATUS exceptions on errors." },
563 { "close_file", (PyCFunction
)py_close_file
, METH_VARARGS
,
564 "close_file(fnum) -> None\n\n \
565 Close the file based on fnum."},
569 static PyObject
*py_smb_new(PyTypeObject
*type
, PyObject
*args
, PyObject
*kwargs
)
571 PyObject
*py_creds
= Py_None
;
572 PyObject
*py_lp
= Py_None
;
573 const char *kwnames
[] = { "hostname", "service", "creds", "lp", NULL
};
574 const char *hostname
= NULL
;
575 const char *service
= NULL
;
577 struct smb_private_data
*spdata
;
579 TALLOC_CTX
*frame
= NULL
;
581 if (!PyArg_ParseTupleAndKeywords(args
, kwargs
, "zz|OO",
582 discard_const_p(char *, kwnames
),
583 &hostname
, &service
, &py_creds
, &py_lp
)) {
587 frame
= talloc_stackframe();
589 spdata
= talloc_zero(frame
, struct smb_private_data
);
590 if (spdata
== NULL
) {
596 spdata
->lp_ctx
= lpcfg_from_py_object(spdata
, py_lp
);
597 if (spdata
->lp_ctx
== NULL
) {
601 spdata
->creds
= PyCredentials_AsCliCredentials(py_creds
);
602 spdata
->ev_ctx
= s4_event_context_init(spdata
);
603 if (spdata
->ev_ctx
== NULL
) {
609 status
= do_smb_connect(spdata
, spdata
, hostname
, service
, &spdata
->tree
);
610 PyErr_NTSTATUS_IS_ERR_RAISE(status
);
611 if (spdata
->tree
== NULL
) {
616 smb
= pytalloc_steal(type
, spdata
);
621 static PyTypeObject PySMB
= {
622 .tp_name
= "smb.SMB",
623 .tp_new
= py_smb_new
,
624 .tp_flags
= Py_TPFLAGS_DEFAULT
,
625 .tp_methods
= py_smb_methods
,
626 .tp_doc
= "SMB(hostname, service[, creds[, lp]]) -> SMB connection object\n",
634 if (pytalloc_BaseObject_PyType_Ready(&PySMB
) < 0) {
638 m
= Py_InitModule3("smb", NULL
, "SMB File I/O support");
644 PyModule_AddObject(m
, "SMB", (PyObject
*)&PySMB
);
646 #define ADD_FLAGS(val) PyModule_AddObject(m, #val, PyInt_FromLong(val))
648 ADD_FLAGS(FILE_ATTRIBUTE_READONLY
);
649 ADD_FLAGS(FILE_ATTRIBUTE_HIDDEN
);
650 ADD_FLAGS(FILE_ATTRIBUTE_SYSTEM
);
651 ADD_FLAGS(FILE_ATTRIBUTE_VOLUME
);
652 ADD_FLAGS(FILE_ATTRIBUTE_DIRECTORY
);
653 ADD_FLAGS(FILE_ATTRIBUTE_ARCHIVE
);
654 ADD_FLAGS(FILE_ATTRIBUTE_DEVICE
);
655 ADD_FLAGS(FILE_ATTRIBUTE_NORMAL
);
656 ADD_FLAGS(FILE_ATTRIBUTE_TEMPORARY
);
657 ADD_FLAGS(FILE_ATTRIBUTE_SPARSE
);
658 ADD_FLAGS(FILE_ATTRIBUTE_REPARSE_POINT
);
659 ADD_FLAGS(FILE_ATTRIBUTE_COMPRESSED
);
660 ADD_FLAGS(FILE_ATTRIBUTE_OFFLINE
);
661 ADD_FLAGS(FILE_ATTRIBUTE_NONINDEXED
);
662 ADD_FLAGS(FILE_ATTRIBUTE_ENCRYPTED
);
663 ADD_FLAGS(FILE_ATTRIBUTE_ALL_MASK
);