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"
29 static PyTypeObject *get_pytype(const char *module, const char *type)
34 mod = PyImport_ImportModule(module);
36 PyErr_Format(PyExc_RuntimeError,
37 "Unable to import %s to check type %s",
41 result = (PyTypeObject *)PyObject_GetAttrString(mod, type);
44 PyErr_Format(PyExc_RuntimeError,
45 "Unable to find type %s in module %s",
56 struct cli_state *cli;
57 struct tevent_context *ev;
58 struct py_cli_thread *thread_state;
65 struct py_cli_thread {
68 * Pipe to make the poll thread wake up in our destructor, so
69 * that we can exit and join the thread.
72 struct tevent_fd *shutdown_fde;
77 * Thread state to release the GIL during the poll(2) syscall
79 PyThreadState *py_threadstate;
82 static void *py_cli_state_poll_thread(void *private_data)
84 struct py_cli_state *self = (struct py_cli_state *)private_data;
85 struct py_cli_thread *t = self->thread_state;
86 PyGILState_STATE gstate;
88 gstate = PyGILState_Ensure();
90 while (!t->do_shutdown) {
92 ret = tevent_loop_once(self->ev);
95 PyGILState_Release(gstate);
99 static void py_cli_state_trace_callback(enum tevent_trace_point point,
102 struct py_cli_state *self = (struct py_cli_state *)private_data;
103 struct py_cli_thread *t = self->thread_state;
106 case TEVENT_TRACE_BEFORE_WAIT:
107 assert(t->py_threadstate == NULL);
108 t->py_threadstate = PyEval_SaveThread();
110 case TEVENT_TRACE_AFTER_WAIT:
111 assert(t->py_threadstate != NULL);
112 PyEval_RestoreThread(t->py_threadstate);
113 t->py_threadstate = NULL;
120 static void py_cli_state_shutdown_handler(struct tevent_context *ev,
121 struct tevent_fd *fde,
125 struct py_cli_state *self = (struct py_cli_state *)private_data;
126 struct py_cli_thread *t = self->thread_state;
128 if ((flags & TEVENT_FD_READ) == 0) {
131 TALLOC_FREE(t->shutdown_fde);
132 t->do_shutdown = true;
135 static int py_cli_thread_destructor(struct py_cli_thread *t)
143 * This will wake the poll thread from the poll(2)
145 written = write(t->shutdown_pipe[1], &c, 1);
146 } while ((written == -1) && (errno == EINTR));
149 * Allow the poll thread to do its own cleanup under the GIL
151 Py_BEGIN_ALLOW_THREADS
152 ret = pthread_join(t->id, NULL);
156 if (t->shutdown_pipe[0] != -1) {
157 close(t->shutdown_pipe[0]);
158 t->shutdown_pipe[0] = -1;
160 if (t->shutdown_pipe[1] != -1) {
161 close(t->shutdown_pipe[1]);
162 t->shutdown_pipe[1] = -1;
167 static bool py_cli_state_setup_ev(struct py_cli_state *self)
169 struct py_cli_thread *t = NULL;
172 self->ev = tevent_context_init_byname(NULL, "poll_mt");
173 if (self->ev == NULL) {
176 tevent_set_trace_callback(self->ev, py_cli_state_trace_callback, self);
178 self->thread_state = talloc_zero(NULL, struct py_cli_thread);
179 if (self->thread_state == NULL) {
182 t = self->thread_state;
184 ret = pipe(t->shutdown_pipe);
188 t->shutdown_fde = tevent_add_fd(
189 self->ev, self->ev, t->shutdown_pipe[0], TEVENT_FD_READ,
190 py_cli_state_shutdown_handler, self);
191 if (t->shutdown_fde == NULL) {
195 PyEval_InitThreads();
197 ret = pthread_create(&t->id, NULL, py_cli_state_poll_thread, self);
201 talloc_set_destructor(self->thread_state, py_cli_thread_destructor);
206 TALLOC_FREE(t->shutdown_fde);
208 if (t->shutdown_pipe[0] != -1) {
209 close(t->shutdown_pipe[0]);
210 t->shutdown_pipe[0] = -1;
212 if (t->shutdown_pipe[1] != -1) {
213 close(t->shutdown_pipe[1]);
214 t->shutdown_pipe[1] = -1;
219 TALLOC_FREE(self->thread_state);
220 TALLOC_FREE(self->ev);
224 struct py_tevent_cond {
225 pthread_mutex_t mutex;
230 static void py_tevent_signalme(struct tevent_req *req);
232 static int py_tevent_req_wait(struct tevent_context *ev,
233 struct tevent_req *req)
235 struct py_tevent_cond cond;
238 result = pthread_mutex_init(&cond.mutex, NULL);
242 result = pthread_cond_init(&cond.cond, NULL);
247 cond.is_done = false;
248 tevent_req_set_callback(req, py_tevent_signalme, &cond);
250 result = pthread_mutex_lock(&cond.mutex);
255 while (!cond.is_done) {
257 Py_BEGIN_ALLOW_THREADS
258 result = pthread_cond_wait(&cond.cond, &cond.mutex);
267 ret = pthread_mutex_unlock(&cond.mutex);
270 ret = pthread_cond_destroy(&cond.cond);
273 ret = pthread_mutex_destroy(&cond.mutex);
279 static void py_tevent_signalme(struct tevent_req *req)
281 struct py_tevent_cond *cond = (struct py_tevent_cond *)
282 tevent_req_callback_data_void(req);
285 ret = pthread_mutex_lock(&cond->mutex);
288 cond->is_done = true;
290 ret = pthread_cond_signal(&cond->cond);
292 ret = pthread_mutex_unlock(&cond->mutex);
298 static bool py_cli_state_setup_ev(struct py_cli_state *self)
300 self->ev = tevent_context_init(NULL);
301 return (self->ev != NULL);
304 static int py_tevent_req_wait(struct tevent_context *ev,
305 struct tevent_req *req)
307 while (tevent_req_is_in_progress(req)) {
310 ret = tevent_loop_once(ev);
320 static PyObject *py_cli_state_new(PyTypeObject *type, PyObject *args,
323 struct py_cli_state *self;
325 self = (struct py_cli_state *)type->tp_alloc(type, 0);
331 self->thread_state = NULL;
332 return (PyObject *)self;
335 static int py_cli_state_init(struct py_cli_state *self, PyObject *args,
341 struct cli_credentials *cli_creds;
344 static const char *kwlist[] = {
345 "host", "share", "credentials", NULL
348 PyTypeObject *py_type_Credentials = get_pytype(
349 "samba.credentials", "Credentials");
350 if (py_type_Credentials == NULL) {
354 ret = PyArg_ParseTupleAndKeywords(
355 args, kwds, "ss|O!", (char **)kwlist,
356 &host, &share, py_type_Credentials, &creds);
358 Py_DECREF(py_type_Credentials);
364 if (!py_cli_state_setup_ev(self)) {
368 cli_creds = cli_credentials_from_py_object(creds);
369 if (cli_creds == NULL) {
370 PyErr_SetString(PyExc_TypeError, "Expected credentials");
374 status = cli_full_connection(
375 &self->cli, "myname", host, NULL, 0, share, "?????",
376 cli_credentials_get_username(cli_creds),
377 cli_credentials_get_domain(cli_creds),
378 cli_credentials_get_password(cli_creds),
380 if (!NT_STATUS_IS_OK(status)) {
381 PyErr_SetNTSTATUS(status);
387 static void py_cli_state_dealloc(struct py_cli_state *self)
389 TALLOC_FREE(self->thread_state);
390 TALLOC_FREE(self->ev);
392 if (self->cli != NULL) {
393 cli_shutdown(self->cli);
396 self->ob_type->tp_free((PyObject *)self);
399 static bool py_tevent_req_wait_exc(struct tevent_context *ev,
400 struct tevent_req *req)
408 ret = py_tevent_req_wait(ev, req);
412 PyErr_SetFromErrno(PyExc_RuntimeError);
418 static PyObject *py_cli_create(struct py_cli_state *self, PyObject *args,
422 unsigned CreateFlags = 0;
423 unsigned DesiredAccess = FILE_GENERIC_READ;
424 unsigned FileAttributes = 0;
425 unsigned ShareAccess = 0;
426 unsigned CreateDisposition = FILE_OPEN;
427 unsigned CreateOptions = 0;
428 unsigned SecurityFlags = 0;
430 struct tevent_req *req;
433 static const char *kwlist[] = {
434 "Name", "CreateFlags", "DesiredAccess", "FileAttributes",
435 "ShareAccess", "CreateDisposition", "CreateOptions",
436 "SecurityFlags", NULL };
438 if (!PyArg_ParseTupleAndKeywords(
439 args, kwds, "s|IIIIIII", (char **)kwlist,
440 &fname, &CreateFlags, &DesiredAccess, &FileAttributes,
441 &ShareAccess, &CreateDisposition, &CreateOptions,
446 req = cli_ntcreate_send(NULL, self->ev, self->cli, fname, CreateFlags,
447 DesiredAccess, FileAttributes, ShareAccess,
448 CreateDisposition, CreateOptions,
450 if (!py_tevent_req_wait_exc(self->ev, req)) {
453 status = cli_ntcreate_recv(req, &fnum);
456 if (!NT_STATUS_IS_OK(status)) {
457 PyErr_SetNTSTATUS(status);
460 return Py_BuildValue("I", (unsigned)fnum);
463 static PyObject *py_cli_close(struct py_cli_state *self, PyObject *args)
465 struct tevent_req *req;
469 if (!PyArg_ParseTuple(args, "i", &fnum)) {
473 req = cli_close_send(NULL, self->ev, self->cli, fnum);
474 if (!py_tevent_req_wait_exc(self->ev, req)) {
477 status = cli_close_recv(req);
480 if (!NT_STATUS_IS_OK(status)) {
481 PyErr_SetNTSTATUS(status);
488 static PyObject *py_cli_write(struct py_cli_state *self, PyObject *args,
495 unsigned long long offset;
496 struct tevent_req *req;
500 static const char *kwlist[] = {
501 "fnum", "buffer", "offset", "mode", NULL };
503 if (!PyArg_ParseTupleAndKeywords(
504 args, kwds, "Is#K|I", (char **)kwlist,
505 &fnum, &buf, &buflen, &offset, &mode)) {
509 req = cli_write_andx_send(NULL, self->ev, self->cli, fnum, mode,
510 (uint8_t *)buf, offset, buflen);
511 if (!py_tevent_req_wait_exc(self->ev, req)) {
514 status = cli_write_andx_recv(req, &written);
517 if (!NT_STATUS_IS_OK(status)) {
518 PyErr_SetNTSTATUS(status);
521 return Py_BuildValue("K", (unsigned long long)written);
524 static PyObject *py_cli_read(struct py_cli_state *self, PyObject *args,
528 unsigned long long offset;
530 struct tevent_req *req;
536 static const char *kwlist[] = {
537 "fnum", "offset", "size", NULL };
539 if (!PyArg_ParseTupleAndKeywords(
540 args, kwds, "IKI", (char **)kwlist, &fnum, &offset,
545 req = cli_read_andx_send(NULL, self->ev, self->cli, fnum,
547 if (!py_tevent_req_wait_exc(self->ev, req)) {
550 status = cli_read_andx_recv(req, &buflen, &buf);
552 if (!NT_STATUS_IS_OK(status)) {
554 PyErr_SetNTSTATUS(status);
557 result = Py_BuildValue("s#", (char *)buf, (int)buflen);
562 static PyObject *py_cli_ftruncate(struct py_cli_state *self, PyObject *args,
566 unsigned long long size;
567 struct tevent_req *req;
570 static const char *kwlist[] = {
571 "fnum", "size", NULL };
573 if (!PyArg_ParseTupleAndKeywords(
574 args, kwds, "IK", (char **)kwlist, &fnum, &size)) {
578 req = cli_ftruncate_send(NULL, self->ev, self->cli, fnum, size);
579 if (!py_tevent_req_wait_exc(self->ev, req)) {
582 status = cli_ftruncate_recv(req);
585 if (!NT_STATUS_IS_OK(status)) {
586 PyErr_SetNTSTATUS(status);
593 static PyObject *py_cli_delete_on_close(struct py_cli_state *self,
598 struct tevent_req *req;
601 static const char *kwlist[] = {
602 "fnum", "flag", NULL };
604 if (!PyArg_ParseTupleAndKeywords(
605 args, kwds, "II", (char **)kwlist, &fnum, &flag)) {
609 req = cli_nt_delete_on_close_send(NULL, self->ev, self->cli, fnum,
611 if (!py_tevent_req_wait_exc(self->ev, req)) {
614 status = cli_nt_delete_on_close_recv(req);
617 if (!NT_STATUS_IS_OK(status)) {
618 PyErr_SetNTSTATUS(status);
625 static PyMethodDef py_cli_state_methods[] = {
626 { "create", (PyCFunction)py_cli_create, METH_VARARGS|METH_KEYWORDS,
628 { "close", (PyCFunction)py_cli_close, METH_VARARGS,
629 "Close a file handle" },
630 { "write", (PyCFunction)py_cli_write, METH_VARARGS|METH_KEYWORDS,
631 "Write to a file handle" },
632 { "read", (PyCFunction)py_cli_read, METH_VARARGS|METH_KEYWORDS,
633 "Read from a file handle" },
634 { "truncate", (PyCFunction)py_cli_ftruncate,
635 METH_VARARGS|METH_KEYWORDS,
637 { "delete_on_close", (PyCFunction)py_cli_delete_on_close,
638 METH_VARARGS|METH_KEYWORDS,
639 "Set/Reset the delete on close flag" },
640 { NULL, NULL, 0, NULL }
643 static PyTypeObject py_cli_state_type = {
644 PyObject_HEAD_INIT(NULL)
645 .tp_name = "libsmb_samba_internal.Conn",
646 .tp_basicsize = sizeof(struct py_cli_state),
647 .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
648 .tp_doc = "libsmb connection",
649 .tp_new = py_cli_state_new,
650 .tp_init = (initproc)py_cli_state_init,
651 .tp_dealloc = (destructor)py_cli_state_dealloc,
652 .tp_methods = py_cli_state_methods,
655 static PyMethodDef py_libsmb_methods[] = {
659 void initlibsmb_samba_internal(void);
660 void initlibsmb_samba_internal(void)
666 m = Py_InitModule3("libsmb_samba_internal", py_libsmb_methods,
669 if (PyType_Ready(&py_cli_state_type) < 0) {
672 Py_INCREF(&py_cli_state_type);
673 PyModule_AddObject(m, "Conn", (PyObject *)&py_cli_state_type);