2 * Unix SMB/CIFS implementation.
3 * Samba-internal work in progress Python binding for libsmbclient
5 * Copyright (C) Volker Lendecke 2012
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "libsmb/libsmb.h"
24 #include "libcli/security/security.h"
25 #include "system/select.h"
26 #include "source4/libcli/util/pyerrors.h"
27 #include "auth/credentials/pycredentials.h"
30 static PyTypeObject
*get_pytype(const char *module
, const char *type
)
35 mod
= PyImport_ImportModule(module
);
37 PyErr_Format(PyExc_RuntimeError
,
38 "Unable to import %s to check type %s",
42 result
= (PyTypeObject
*)PyObject_GetAttrString(mod
, type
);
45 PyErr_Format(PyExc_RuntimeError
,
46 "Unable to find type %s in module %s",
54 * We're using "const char **" for keywords,
55 * PyArg_ParseTupleAndKeywords expects a "char **". Confine the
56 * inevitable warnings to just one place.
58 static int ParseTupleAndKeywords(PyObject
*args
, PyObject
*kw
,
59 const char *format
, const char **keywords
,
64 va_start(a
, keywords
);
65 ret
= PyArg_VaParseTupleAndKeywords(args
, kw
, format
,
66 (char **)keywords
, a
);
75 struct cli_state
*cli
;
76 struct tevent_context
*ev
;
77 struct py_cli_thread
*thread_state
;
84 struct py_cli_thread
{
87 * Pipe to make the poll thread wake up in our destructor, so
88 * that we can exit and join the thread.
91 struct tevent_fd
*shutdown_fde
;
96 * Thread state to release the GIL during the poll(2) syscall
98 PyThreadState
*py_threadstate
;
101 static void *py_cli_state_poll_thread(void *private_data
)
103 struct py_cli_state
*self
= (struct py_cli_state
*)private_data
;
104 struct py_cli_thread
*t
= self
->thread_state
;
105 PyGILState_STATE gstate
;
107 gstate
= PyGILState_Ensure();
109 while (!t
->do_shutdown
) {
111 ret
= tevent_loop_once(self
->ev
);
114 PyGILState_Release(gstate
);
118 static void py_cli_state_trace_callback(enum tevent_trace_point point
,
121 struct py_cli_state
*self
= (struct py_cli_state
*)private_data
;
122 struct py_cli_thread
*t
= self
->thread_state
;
125 case TEVENT_TRACE_BEFORE_WAIT
:
126 assert(t
->py_threadstate
== NULL
);
127 t
->py_threadstate
= PyEval_SaveThread();
129 case TEVENT_TRACE_AFTER_WAIT
:
130 assert(t
->py_threadstate
!= NULL
);
131 PyEval_RestoreThread(t
->py_threadstate
);
132 t
->py_threadstate
= NULL
;
139 static void py_cli_state_shutdown_handler(struct tevent_context
*ev
,
140 struct tevent_fd
*fde
,
144 struct py_cli_state
*self
= (struct py_cli_state
*)private_data
;
145 struct py_cli_thread
*t
= self
->thread_state
;
147 if ((flags
& TEVENT_FD_READ
) == 0) {
150 TALLOC_FREE(t
->shutdown_fde
);
151 t
->do_shutdown
= true;
154 static int py_cli_thread_destructor(struct py_cli_thread
*t
)
162 * This will wake the poll thread from the poll(2)
164 written
= write(t
->shutdown_pipe
[1], &c
, 1);
165 } while ((written
== -1) && (errno
== EINTR
));
168 * Allow the poll thread to do its own cleanup under the GIL
170 Py_BEGIN_ALLOW_THREADS
171 ret
= pthread_join(t
->id
, NULL
);
175 if (t
->shutdown_pipe
[0] != -1) {
176 close(t
->shutdown_pipe
[0]);
177 t
->shutdown_pipe
[0] = -1;
179 if (t
->shutdown_pipe
[1] != -1) {
180 close(t
->shutdown_pipe
[1]);
181 t
->shutdown_pipe
[1] = -1;
186 static bool py_cli_state_setup_ev(struct py_cli_state
*self
)
188 struct py_cli_thread
*t
= NULL
;
191 self
->ev
= tevent_context_init_byname(NULL
, "poll_mt");
192 if (self
->ev
== NULL
) {
195 tevent_set_trace_callback(self
->ev
, py_cli_state_trace_callback
, self
);
197 self
->thread_state
= talloc_zero(NULL
, struct py_cli_thread
);
198 if (self
->thread_state
== NULL
) {
201 t
= self
->thread_state
;
203 ret
= pipe(t
->shutdown_pipe
);
207 t
->shutdown_fde
= tevent_add_fd(
208 self
->ev
, self
->ev
, t
->shutdown_pipe
[0], TEVENT_FD_READ
,
209 py_cli_state_shutdown_handler
, self
);
210 if (t
->shutdown_fde
== NULL
) {
214 PyEval_InitThreads();
216 ret
= pthread_create(&t
->id
, NULL
, py_cli_state_poll_thread
, self
);
220 talloc_set_destructor(self
->thread_state
, py_cli_thread_destructor
);
225 TALLOC_FREE(t
->shutdown_fde
);
227 if (t
->shutdown_pipe
[0] != -1) {
228 close(t
->shutdown_pipe
[0]);
229 t
->shutdown_pipe
[0] = -1;
231 if (t
->shutdown_pipe
[1] != -1) {
232 close(t
->shutdown_pipe
[1]);
233 t
->shutdown_pipe
[1] = -1;
237 TALLOC_FREE(self
->thread_state
);
238 TALLOC_FREE(self
->ev
);
242 struct py_tevent_cond
{
243 pthread_mutex_t mutex
;
248 static void py_tevent_signalme(struct tevent_req
*req
);
250 static int py_tevent_cond_wait(struct py_tevent_cond
*cond
)
254 result
= pthread_mutex_init(&cond
->mutex
, NULL
);
258 result
= pthread_cond_init(&cond
->cond
, NULL
);
263 result
= pthread_mutex_lock(&cond
->mutex
);
268 cond
->is_done
= false;
270 while (!cond
->is_done
) {
272 Py_BEGIN_ALLOW_THREADS
273 result
= pthread_cond_wait(&cond
->cond
, &cond
->mutex
);
282 ret
= pthread_mutex_unlock(&cond
->mutex
);
285 ret
= pthread_cond_destroy(&cond
->cond
);
288 ret
= pthread_mutex_destroy(&cond
->mutex
);
294 static int py_tevent_req_wait(struct tevent_context
*ev
,
295 struct tevent_req
*req
)
297 struct py_tevent_cond cond
;
298 tevent_req_set_callback(req
, py_tevent_signalme
, &cond
);
299 return py_tevent_cond_wait(&cond
);
302 static void py_tevent_cond_signal(struct py_tevent_cond
*cond
)
306 ret
= pthread_mutex_lock(&cond
->mutex
);
309 cond
->is_done
= true;
311 ret
= pthread_cond_signal(&cond
->cond
);
313 ret
= pthread_mutex_unlock(&cond
->mutex
);
317 static void py_tevent_signalme(struct tevent_req
*req
)
319 struct py_tevent_cond
*cond
= (struct py_tevent_cond
*)
320 tevent_req_callback_data_void(req
);
322 py_tevent_cond_signal(cond
);
327 static bool py_cli_state_setup_ev(struct py_cli_state
*self
)
329 self
->ev
= tevent_context_init(NULL
);
330 return (self
->ev
!= NULL
);
333 static int py_tevent_req_wait(struct tevent_context
*ev
,
334 struct tevent_req
*req
)
336 while (tevent_req_is_in_progress(req
)) {
339 ret
= tevent_loop_once(ev
);
349 static bool py_tevent_req_wait_exc(struct tevent_context
*ev
,
350 struct tevent_req
*req
)
358 ret
= py_tevent_req_wait(ev
, req
);
362 PyErr_SetFromErrno(PyExc_RuntimeError
);
368 static PyObject
*py_cli_state_new(PyTypeObject
*type
, PyObject
*args
,
371 struct py_cli_state
*self
;
373 self
= (struct py_cli_state
*)type
->tp_alloc(type
, 0);
379 self
->thread_state
= NULL
;
380 return (PyObject
*)self
;
383 static int py_cli_state_init(struct py_cli_state
*self
, PyObject
*args
,
389 struct cli_credentials
*cli_creds
;
392 static const char *kwlist
[] = {
393 "host", "share", "credentials", NULL
396 PyTypeObject
*py_type_Credentials
= get_pytype(
397 "samba.credentials", "Credentials");
398 if (py_type_Credentials
== NULL
) {
402 ret
= ParseTupleAndKeywords(
403 args
, kwds
, "ss|O!", kwlist
,
404 &host
, &share
, py_type_Credentials
, &creds
);
406 Py_DECREF(py_type_Credentials
);
412 if (!py_cli_state_setup_ev(self
)) {
416 cli_creds
= cli_credentials_from_py_object(creds
);
417 if (cli_creds
== NULL
) {
418 PyErr_SetString(PyExc_TypeError
, "Expected credentials");
422 status
= cli_full_connection(
423 &self
->cli
, "myname", host
, NULL
, 0, share
, "?????",
424 cli_credentials_get_username(cli_creds
),
425 cli_credentials_get_domain(cli_creds
),
426 cli_credentials_get_password(cli_creds
),
428 if (!NT_STATUS_IS_OK(status
)) {
429 PyErr_SetNTSTATUS(status
);
435 static void py_cli_state_dealloc(struct py_cli_state
*self
)
437 TALLOC_FREE(self
->thread_state
);
438 TALLOC_FREE(self
->ev
);
440 if (self
->cli
!= NULL
) {
441 cli_shutdown(self
->cli
);
444 self
->ob_type
->tp_free((PyObject
*)self
);
447 static PyObject
*py_cli_create(struct py_cli_state
*self
, PyObject
*args
,
451 unsigned CreateFlags
= 0;
452 unsigned DesiredAccess
= FILE_GENERIC_READ
;
453 unsigned FileAttributes
= 0;
454 unsigned ShareAccess
= 0;
455 unsigned CreateDisposition
= FILE_OPEN
;
456 unsigned CreateOptions
= 0;
457 unsigned SecurityFlags
= 0;
459 struct tevent_req
*req
;
462 static const char *kwlist
[] = {
463 "Name", "CreateFlags", "DesiredAccess", "FileAttributes",
464 "ShareAccess", "CreateDisposition", "CreateOptions",
465 "SecurityFlags", NULL
};
467 if (!ParseTupleAndKeywords(
468 args
, kwds
, "s|IIIIIII", kwlist
,
469 &fname
, &CreateFlags
, &DesiredAccess
, &FileAttributes
,
470 &ShareAccess
, &CreateDisposition
, &CreateOptions
,
475 req
= cli_ntcreate_send(NULL
, self
->ev
, self
->cli
, fname
, CreateFlags
,
476 DesiredAccess
, FileAttributes
, ShareAccess
,
477 CreateDisposition
, CreateOptions
,
479 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
482 status
= cli_ntcreate_recv(req
, &fnum
);
485 if (!NT_STATUS_IS_OK(status
)) {
486 PyErr_SetNTSTATUS(status
);
489 return Py_BuildValue("I", (unsigned)fnum
);
492 static PyObject
*py_cli_close(struct py_cli_state
*self
, PyObject
*args
)
494 struct tevent_req
*req
;
498 if (!PyArg_ParseTuple(args
, "i", &fnum
)) {
502 req
= cli_close_send(NULL
, self
->ev
, self
->cli
, fnum
);
503 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
506 status
= cli_close_recv(req
);
509 if (!NT_STATUS_IS_OK(status
)) {
510 PyErr_SetNTSTATUS(status
);
517 static PyObject
*py_cli_write(struct py_cli_state
*self
, PyObject
*args
,
524 unsigned long long offset
;
525 struct tevent_req
*req
;
529 static const char *kwlist
[] = {
530 "fnum", "buffer", "offset", "mode", NULL
};
532 if (!ParseTupleAndKeywords(
533 args
, kwds
, "Is#K|I", kwlist
,
534 &fnum
, &buf
, &buflen
, &offset
, &mode
)) {
538 req
= cli_write_andx_send(NULL
, self
->ev
, self
->cli
, fnum
, mode
,
539 (uint8_t *)buf
, offset
, buflen
);
540 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
543 status
= cli_write_andx_recv(req
, &written
);
546 if (!NT_STATUS_IS_OK(status
)) {
547 PyErr_SetNTSTATUS(status
);
550 return Py_BuildValue("K", (unsigned long long)written
);
553 static PyObject
*py_cli_read(struct py_cli_state
*self
, PyObject
*args
,
557 unsigned long long offset
;
559 struct tevent_req
*req
;
565 static const char *kwlist
[] = {
566 "fnum", "offset", "size", NULL
};
568 if (!ParseTupleAndKeywords(
569 args
, kwds
, "IKI", kwlist
, &fnum
, &offset
,
574 req
= cli_read_andx_send(NULL
, self
->ev
, self
->cli
, fnum
,
576 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
579 status
= cli_read_andx_recv(req
, &buflen
, &buf
);
581 if (!NT_STATUS_IS_OK(status
)) {
583 PyErr_SetNTSTATUS(status
);
586 result
= Py_BuildValue("s#", (char *)buf
, (int)buflen
);
591 static PyObject
*py_cli_ftruncate(struct py_cli_state
*self
, PyObject
*args
,
595 unsigned long long size
;
596 struct tevent_req
*req
;
599 static const char *kwlist
[] = {
600 "fnum", "size", NULL
};
602 if (!ParseTupleAndKeywords(
603 args
, kwds
, "IK", kwlist
, &fnum
, &size
)) {
607 req
= cli_ftruncate_send(NULL
, self
->ev
, self
->cli
, fnum
, size
);
608 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
611 status
= cli_ftruncate_recv(req
);
614 if (!NT_STATUS_IS_OK(status
)) {
615 PyErr_SetNTSTATUS(status
);
622 static PyObject
*py_cli_delete_on_close(struct py_cli_state
*self
,
627 struct tevent_req
*req
;
630 static const char *kwlist
[] = {
631 "fnum", "flag", NULL
};
633 if (!ParseTupleAndKeywords(
634 args
, kwds
, "II", kwlist
, &fnum
, &flag
)) {
638 req
= cli_nt_delete_on_close_send(NULL
, self
->ev
, self
->cli
, fnum
,
640 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
643 status
= cli_nt_delete_on_close_recv(req
);
646 if (!NT_STATUS_IS_OK(status
)) {
647 PyErr_SetNTSTATUS(status
);
654 static PyObject
*py_cli_list(struct py_cli_state
*self
,
660 FILE_ATTRIBUTE_DIRECTORY
|
661 FILE_ATTRIBUTE_SYSTEM
|
662 FILE_ATTRIBUTE_HIDDEN
;
663 unsigned info_level
= SMB_FIND_FILE_BOTH_DIRECTORY_INFO
;
664 struct tevent_req
*req
;
666 struct file_info
*finfos
;
667 size_t i
, num_finfos
;
670 const char *kwlist
[] = {
671 "mask", "attribute", "info_level", NULL
674 if (!ParseTupleAndKeywords(
675 args
, kwds
, "s|II", kwlist
,
676 &mask
, &attribute
, &info_level
)) {
680 req
= cli_list_send(NULL
, self
->ev
, self
->cli
, mask
, attribute
,
682 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
685 status
= cli_list_recv(req
, NULL
, &finfos
, &num_finfos
);
688 if (!NT_STATUS_IS_OK(status
)) {
689 PyErr_SetNTSTATUS(status
);
693 result
= Py_BuildValue("[]");
694 if (result
== NULL
) {
698 for (i
=0; i
<num_finfos
; i
++) {
699 struct file_info
*finfo
= &finfos
[i
];
703 file
= Py_BuildValue(
706 "mode", (int)finfo
->mode
);
712 ret
= PyList_Append(result
, file
);
722 static PyMethodDef py_cli_state_methods
[] = {
723 { "create", (PyCFunction
)py_cli_create
, METH_VARARGS
|METH_KEYWORDS
,
725 { "close", (PyCFunction
)py_cli_close
, METH_VARARGS
,
726 "Close a file handle" },
727 { "write", (PyCFunction
)py_cli_write
, METH_VARARGS
|METH_KEYWORDS
,
728 "Write to a file handle" },
729 { "read", (PyCFunction
)py_cli_read
, METH_VARARGS
|METH_KEYWORDS
,
730 "Read from a file handle" },
731 { "truncate", (PyCFunction
)py_cli_ftruncate
,
732 METH_VARARGS
|METH_KEYWORDS
,
734 { "delete_on_close", (PyCFunction
)py_cli_delete_on_close
,
735 METH_VARARGS
|METH_KEYWORDS
,
736 "Set/Reset the delete on close flag" },
737 { "readdir", (PyCFunction
)py_cli_list
,
738 METH_VARARGS
|METH_KEYWORDS
,
739 "List a directory" },
740 { NULL
, NULL
, 0, NULL
}
743 static PyTypeObject py_cli_state_type
= {
744 PyObject_HEAD_INIT(NULL
)
745 .tp_name
= "libsmb_samba_internal.Conn",
746 .tp_basicsize
= sizeof(struct py_cli_state
),
747 .tp_flags
= Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
,
748 .tp_doc
= "libsmb connection",
749 .tp_new
= py_cli_state_new
,
750 .tp_init
= (initproc
)py_cli_state_init
,
751 .tp_dealloc
= (destructor
)py_cli_state_dealloc
,
752 .tp_methods
= py_cli_state_methods
,
755 static PyMethodDef py_libsmb_methods
[] = {
759 void initlibsmb_samba_internal(void);
760 void initlibsmb_samba_internal(void)
766 m
= Py_InitModule3("libsmb_samba_internal", py_libsmb_methods
,
769 if (PyType_Ready(&py_cli_state_type
) < 0) {
772 Py_INCREF(&py_cli_state_type
);
773 PyModule_AddObject(m
, "Conn", (PyObject
*)&py_cli_state_type
);