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_signalme(struct tevent_req
*req
)
304 struct py_tevent_cond
*cond
= (struct py_tevent_cond
*)
305 tevent_req_callback_data_void(req
);
308 ret
= pthread_mutex_lock(&cond
->mutex
);
311 cond
->is_done
= true;
313 ret
= pthread_cond_signal(&cond
->cond
);
315 ret
= pthread_mutex_unlock(&cond
->mutex
);
321 static bool py_cli_state_setup_ev(struct py_cli_state
*self
)
323 self
->ev
= tevent_context_init(NULL
);
324 return (self
->ev
!= NULL
);
327 static int py_tevent_req_wait(struct tevent_context
*ev
,
328 struct tevent_req
*req
)
330 while (tevent_req_is_in_progress(req
)) {
333 ret
= tevent_loop_once(ev
);
343 static bool py_tevent_req_wait_exc(struct tevent_context
*ev
,
344 struct tevent_req
*req
)
352 ret
= py_tevent_req_wait(ev
, req
);
356 PyErr_SetFromErrno(PyExc_RuntimeError
);
362 static PyObject
*py_cli_state_new(PyTypeObject
*type
, PyObject
*args
,
365 struct py_cli_state
*self
;
367 self
= (struct py_cli_state
*)type
->tp_alloc(type
, 0);
373 self
->thread_state
= NULL
;
374 return (PyObject
*)self
;
377 static int py_cli_state_init(struct py_cli_state
*self
, PyObject
*args
,
383 struct cli_credentials
*cli_creds
;
386 static const char *kwlist
[] = {
387 "host", "share", "credentials", NULL
390 PyTypeObject
*py_type_Credentials
= get_pytype(
391 "samba.credentials", "Credentials");
392 if (py_type_Credentials
== NULL
) {
396 ret
= ParseTupleAndKeywords(
397 args
, kwds
, "ss|O!", kwlist
,
398 &host
, &share
, py_type_Credentials
, &creds
);
400 Py_DECREF(py_type_Credentials
);
406 if (!py_cli_state_setup_ev(self
)) {
410 cli_creds
= cli_credentials_from_py_object(creds
);
411 if (cli_creds
== NULL
) {
412 PyErr_SetString(PyExc_TypeError
, "Expected credentials");
416 status
= cli_full_connection(
417 &self
->cli
, "myname", host
, NULL
, 0, share
, "?????",
418 cli_credentials_get_username(cli_creds
),
419 cli_credentials_get_domain(cli_creds
),
420 cli_credentials_get_password(cli_creds
),
422 if (!NT_STATUS_IS_OK(status
)) {
423 PyErr_SetNTSTATUS(status
);
429 static void py_cli_state_dealloc(struct py_cli_state
*self
)
431 TALLOC_FREE(self
->thread_state
);
432 TALLOC_FREE(self
->ev
);
434 if (self
->cli
!= NULL
) {
435 cli_shutdown(self
->cli
);
438 self
->ob_type
->tp_free((PyObject
*)self
);
441 static PyObject
*py_cli_create(struct py_cli_state
*self
, PyObject
*args
,
445 unsigned CreateFlags
= 0;
446 unsigned DesiredAccess
= FILE_GENERIC_READ
;
447 unsigned FileAttributes
= 0;
448 unsigned ShareAccess
= 0;
449 unsigned CreateDisposition
= FILE_OPEN
;
450 unsigned CreateOptions
= 0;
451 unsigned SecurityFlags
= 0;
453 struct tevent_req
*req
;
456 static const char *kwlist
[] = {
457 "Name", "CreateFlags", "DesiredAccess", "FileAttributes",
458 "ShareAccess", "CreateDisposition", "CreateOptions",
459 "SecurityFlags", NULL
};
461 if (!ParseTupleAndKeywords(
462 args
, kwds
, "s|IIIIIII", kwlist
,
463 &fname
, &CreateFlags
, &DesiredAccess
, &FileAttributes
,
464 &ShareAccess
, &CreateDisposition
, &CreateOptions
,
469 req
= cli_ntcreate_send(NULL
, self
->ev
, self
->cli
, fname
, CreateFlags
,
470 DesiredAccess
, FileAttributes
, ShareAccess
,
471 CreateDisposition
, CreateOptions
,
473 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
476 status
= cli_ntcreate_recv(req
, &fnum
);
479 if (!NT_STATUS_IS_OK(status
)) {
480 PyErr_SetNTSTATUS(status
);
483 return Py_BuildValue("I", (unsigned)fnum
);
486 static PyObject
*py_cli_close(struct py_cli_state
*self
, PyObject
*args
)
488 struct tevent_req
*req
;
492 if (!PyArg_ParseTuple(args
, "i", &fnum
)) {
496 req
= cli_close_send(NULL
, self
->ev
, self
->cli
, fnum
);
497 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
500 status
= cli_close_recv(req
);
503 if (!NT_STATUS_IS_OK(status
)) {
504 PyErr_SetNTSTATUS(status
);
511 static PyObject
*py_cli_write(struct py_cli_state
*self
, PyObject
*args
,
518 unsigned long long offset
;
519 struct tevent_req
*req
;
523 static const char *kwlist
[] = {
524 "fnum", "buffer", "offset", "mode", NULL
};
526 if (!ParseTupleAndKeywords(
527 args
, kwds
, "Is#K|I", kwlist
,
528 &fnum
, &buf
, &buflen
, &offset
, &mode
)) {
532 req
= cli_write_andx_send(NULL
, self
->ev
, self
->cli
, fnum
, mode
,
533 (uint8_t *)buf
, offset
, buflen
);
534 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
537 status
= cli_write_andx_recv(req
, &written
);
540 if (!NT_STATUS_IS_OK(status
)) {
541 PyErr_SetNTSTATUS(status
);
544 return Py_BuildValue("K", (unsigned long long)written
);
547 static PyObject
*py_cli_read(struct py_cli_state
*self
, PyObject
*args
,
551 unsigned long long offset
;
553 struct tevent_req
*req
;
559 static const char *kwlist
[] = {
560 "fnum", "offset", "size", NULL
};
562 if (!ParseTupleAndKeywords(
563 args
, kwds
, "IKI", kwlist
, &fnum
, &offset
,
568 req
= cli_read_andx_send(NULL
, self
->ev
, self
->cli
, fnum
,
570 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
573 status
= cli_read_andx_recv(req
, &buflen
, &buf
);
575 if (!NT_STATUS_IS_OK(status
)) {
577 PyErr_SetNTSTATUS(status
);
580 result
= Py_BuildValue("s#", (char *)buf
, (int)buflen
);
585 static PyObject
*py_cli_ftruncate(struct py_cli_state
*self
, PyObject
*args
,
589 unsigned long long size
;
590 struct tevent_req
*req
;
593 static const char *kwlist
[] = {
594 "fnum", "size", NULL
};
596 if (!ParseTupleAndKeywords(
597 args
, kwds
, "IK", kwlist
, &fnum
, &size
)) {
601 req
= cli_ftruncate_send(NULL
, self
->ev
, self
->cli
, fnum
, size
);
602 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
605 status
= cli_ftruncate_recv(req
);
608 if (!NT_STATUS_IS_OK(status
)) {
609 PyErr_SetNTSTATUS(status
);
616 static PyObject
*py_cli_delete_on_close(struct py_cli_state
*self
,
621 struct tevent_req
*req
;
624 static const char *kwlist
[] = {
625 "fnum", "flag", NULL
};
627 if (!ParseTupleAndKeywords(
628 args
, kwds
, "II", kwlist
, &fnum
, &flag
)) {
632 req
= cli_nt_delete_on_close_send(NULL
, self
->ev
, self
->cli
, fnum
,
634 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
637 status
= cli_nt_delete_on_close_recv(req
);
640 if (!NT_STATUS_IS_OK(status
)) {
641 PyErr_SetNTSTATUS(status
);
648 static PyObject
*py_cli_list(struct py_cli_state
*self
,
654 FILE_ATTRIBUTE_DIRECTORY
|
655 FILE_ATTRIBUTE_SYSTEM
|
656 FILE_ATTRIBUTE_HIDDEN
;
657 unsigned info_level
= SMB_FIND_FILE_BOTH_DIRECTORY_INFO
;
658 struct tevent_req
*req
;
660 struct file_info
*finfos
;
661 size_t i
, num_finfos
;
664 const char *kwlist
[] = {
665 "mask", "attribute", "info_level", NULL
668 if (!ParseTupleAndKeywords(
669 args
, kwds
, "s|II", kwlist
,
670 &mask
, &attribute
, &info_level
)) {
674 req
= cli_list_send(NULL
, self
->ev
, self
->cli
, mask
, attribute
,
676 if (!py_tevent_req_wait_exc(self
->ev
, req
)) {
679 status
= cli_list_recv(req
, NULL
, &finfos
, &num_finfos
);
682 if (!NT_STATUS_IS_OK(status
)) {
683 PyErr_SetNTSTATUS(status
);
687 result
= Py_BuildValue("[]");
688 if (result
== NULL
) {
692 for (i
=0; i
<num_finfos
; i
++) {
693 struct file_info
*finfo
= &finfos
[i
];
697 file
= Py_BuildValue(
700 "mode", (int)finfo
->mode
);
706 ret
= PyList_Append(result
, file
);
716 static PyMethodDef py_cli_state_methods
[] = {
717 { "create", (PyCFunction
)py_cli_create
, METH_VARARGS
|METH_KEYWORDS
,
719 { "close", (PyCFunction
)py_cli_close
, METH_VARARGS
,
720 "Close a file handle" },
721 { "write", (PyCFunction
)py_cli_write
, METH_VARARGS
|METH_KEYWORDS
,
722 "Write to a file handle" },
723 { "read", (PyCFunction
)py_cli_read
, METH_VARARGS
|METH_KEYWORDS
,
724 "Read from a file handle" },
725 { "truncate", (PyCFunction
)py_cli_ftruncate
,
726 METH_VARARGS
|METH_KEYWORDS
,
728 { "delete_on_close", (PyCFunction
)py_cli_delete_on_close
,
729 METH_VARARGS
|METH_KEYWORDS
,
730 "Set/Reset the delete on close flag" },
731 { "readdir", (PyCFunction
)py_cli_list
,
732 METH_VARARGS
|METH_KEYWORDS
,
733 "List a directory" },
734 { NULL
, NULL
, 0, NULL
}
737 static PyTypeObject py_cli_state_type
= {
738 PyObject_HEAD_INIT(NULL
)
739 .tp_name
= "libsmb_samba_internal.Conn",
740 .tp_basicsize
= sizeof(struct py_cli_state
),
741 .tp_flags
= Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
,
742 .tp_doc
= "libsmb connection",
743 .tp_new
= py_cli_state_new
,
744 .tp_init
= (initproc
)py_cli_state_init
,
745 .tp_dealloc
= (destructor
)py_cli_state_dealloc
,
746 .tp_methods
= py_cli_state_methods
,
749 static PyMethodDef py_libsmb_methods
[] = {
753 void initlibsmb_samba_internal(void);
754 void initlibsmb_samba_internal(void)
760 m
= Py_InitModule3("libsmb_samba_internal", py_libsmb_methods
,
763 if (PyType_Ready(&py_cli_state_type
) < 0) {
766 Py_INCREF(&py_cli_state_type
);
767 PyModule_AddObject(m
, "Conn", (PyObject
*)&py_cli_state_type
);