2 Unix SMB/CIFS implementation.
4 Python interface to DCE/RPC library - utility functions.
6 Copyright (C) 2010 Jelmer Vernooij <jelmer@samba.org>
7 Copyright (C) 2010 Andrew Tridgell <tridge@samba.org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "librpc/rpc/pyrpc_util.h"
26 #include "librpc/rpc/dcerpc.h"
27 #include "librpc/rpc/pyrpc.h"
28 #include "param/pyparam.h"
29 #include "auth/credentials/pycredentials.h"
30 #include "lib/events/events.h"
31 #include "lib/messaging/messaging.h"
32 #include "lib/messaging/irpc.h"
34 bool py_check_dcerpc_type(PyObject *obj, const char *module, const char *type_name)
40 mod = PyImport_ImportModule(module);
43 PyErr_Format(PyExc_RuntimeError, "Unable to import %s to check type %s",
48 type = (PyTypeObject *)PyObject_GetAttrString(mod, type_name);
51 PyErr_Format(PyExc_RuntimeError, "Unable to find type %s in module %s",
56 ret = PyObject_TypeCheck(obj, type);
60 PyErr_Format(PyExc_TypeError, "Expected type %s.%s, got %s",
61 module, type_name, Py_TYPE(obj)->tp_name);
67 connect to a IRPC pipe from python
69 static NTSTATUS pyrpc_irpc_connect(TALLOC_CTX *mem_ctx, const char *irpc_server,
70 const struct ndr_interface_table *table,
71 struct tevent_context *event_ctx,
72 struct loadparm_context *lp_ctx,
73 struct dcerpc_binding_handle **binding_handle)
75 struct imessaging_context *msg;
77 msg = imessaging_client_init(mem_ctx, lp_ctx, event_ctx);
78 NT_STATUS_HAVE_NO_MEMORY(msg);
80 *binding_handle = irpc_binding_handle_by_name(mem_ctx, msg, irpc_server, table);
81 if (*binding_handle == NULL) {
83 return NT_STATUS_INVALID_PIPE_STATE;
87 * Note: this allows nested event loops to happen,
88 * but as there's no top level event loop it's not that critical.
90 dcerpc_binding_handle_set_sync_ev(*binding_handle, event_ctx);
95 PyObject *py_dcerpc_interface_init_helper(PyTypeObject *type, PyObject *args, PyObject *kwargs,
96 const struct ndr_interface_table *table)
98 dcerpc_InterfaceObject *ret;
99 const char *binding_string;
100 PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;
102 unsigned int timeout = (unsigned int)-1;
103 const char *kwnames[] = {
104 "binding", "lp_ctx", "credentials", "timeout", "basis_connection", NULL
107 if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|OOIO:samr", discard_const_p(char *, kwnames), &binding_string, &py_lp_ctx, &py_credentials, &timeout, &py_basis)) {
111 status = dcerpc_init();
112 if (!NT_STATUS_IS_OK(status)) {
113 PyErr_SetNTSTATUS(status);
117 ret = PyObject_New(dcerpc_InterfaceObject, type);
119 ret->binding_handle = NULL;
120 ret->mem_ctx = talloc_new(NULL);
121 if (ret->mem_ctx == NULL) {
126 if (strncmp(binding_string, "irpc:", 5) == 0) {
127 struct tevent_context *event_ctx;
128 struct loadparm_context *lp_ctx;
130 event_ctx = s4_event_context_init(ret->mem_ctx);
131 if (event_ctx == NULL) {
132 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
133 TALLOC_FREE(ret->mem_ctx);
137 lp_ctx = lpcfg_from_py_object(event_ctx, py_lp_ctx);
138 if (lp_ctx == NULL) {
139 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
140 TALLOC_FREE(ret->mem_ctx);
144 status = pyrpc_irpc_connect(ret->mem_ctx, binding_string+5, table,
145 event_ctx, lp_ctx, &ret->binding_handle);
146 if (!NT_STATUS_IS_OK(status)) {
147 PyErr_SetNTSTATUS(status);
148 TALLOC_FREE(ret->mem_ctx);
151 } else if (py_basis != Py_None) {
152 struct dcerpc_pipe *base_pipe;
154 PyTypeObject *ClientConnection_Type;
156 py_base = PyImport_ImportModule("samba.dcerpc.base");
157 if (py_base == NULL) {
158 TALLOC_FREE(ret->mem_ctx);
162 ClientConnection_Type = (PyTypeObject *)PyObject_GetAttrString(py_base, "ClientConnection");
163 if (ClientConnection_Type == NULL) {
164 PyErr_SetNone(PyExc_TypeError);
165 TALLOC_FREE(ret->mem_ctx);
169 if (!PyObject_TypeCheck(py_basis, ClientConnection_Type)) {
170 PyErr_SetString(PyExc_TypeError, "basis_connection must be a DCE/RPC connection");
171 TALLOC_FREE(ret->mem_ctx);
175 base_pipe = talloc_reference(ret->mem_ctx,
176 ((dcerpc_InterfaceObject *)py_basis)->pipe);
177 if (base_pipe == NULL) {
179 TALLOC_FREE(ret->mem_ctx);
183 status = dcerpc_secondary_context(base_pipe, &ret->pipe, table);
184 if (!NT_STATUS_IS_OK(status)) {
185 PyErr_SetNTSTATUS(status);
186 TALLOC_FREE(ret->mem_ctx);
190 ret->pipe = talloc_steal(ret->mem_ctx, ret->pipe);
192 struct tevent_context *event_ctx;
193 struct loadparm_context *lp_ctx;
194 struct cli_credentials *credentials;
196 event_ctx = s4_event_context_init(ret->mem_ctx);
197 if (event_ctx == NULL) {
198 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
199 TALLOC_FREE(ret->mem_ctx);
203 lp_ctx = lpcfg_from_py_object(event_ctx, py_lp_ctx);
204 if (lp_ctx == NULL) {
205 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
206 TALLOC_FREE(ret->mem_ctx);
210 credentials = cli_credentials_from_py_object(py_credentials);
211 if (credentials == NULL) {
212 PyErr_SetString(PyExc_TypeError, "Expected credentials");
213 TALLOC_FREE(ret->mem_ctx);
216 status = dcerpc_pipe_connect(ret->mem_ctx, &ret->pipe, binding_string,
217 table, credentials, event_ctx, lp_ctx);
218 if (!NT_STATUS_IS_OK(status)) {
219 PyErr_SetNTSTATUS(status);
220 TALLOC_FREE(ret->mem_ctx);
225 * the event context is cached under the connection,
226 * so let it be a child of it.
228 talloc_steal(ret->pipe->conn, event_ctx);
232 ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;
233 ret->binding_handle = ret->pipe->binding_handle;
236 /* reset timeout for the handle */
237 if ((timeout != ((unsigned int)-1)) && (ret->binding_handle != NULL)) {
238 dcerpc_binding_handle_set_timeout(ret->binding_handle, timeout);
241 return (PyObject *)ret;
244 static PyObject *py_dcerpc_run_function(dcerpc_InterfaceObject *iface,
245 const struct PyNdrRpcMethodDef *md,
246 PyObject *args, PyObject *kwargs)
251 PyObject *result = Py_None;
253 if (md->pack_in_data == NULL || md->unpack_out_data == NULL) {
254 PyErr_SetString(PyExc_NotImplementedError, "No marshalling code available yet");
258 mem_ctx = talloc_new(NULL);
259 if (mem_ctx == NULL) {
264 r = talloc_zero_size(mem_ctx, md->table->calls[md->opnum].struct_size);
270 if (!md->pack_in_data(args, kwargs, r)) {
271 talloc_free(mem_ctx);
275 status = md->call(iface->binding_handle, mem_ctx, r);
276 if (!NT_STATUS_IS_OK(status)) {
277 PyErr_SetDCERPCStatus(iface->pipe, status);
278 talloc_free(mem_ctx);
282 result = md->unpack_out_data(r);
284 talloc_free(mem_ctx);
288 static PyObject *py_dcerpc_call_wrapper(PyObject *self, PyObject *args, void *wrapped, PyObject *kwargs)
290 dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
291 const struct PyNdrRpcMethodDef *md = (const struct PyNdrRpcMethodDef *)wrapped;
293 return py_dcerpc_run_function(iface, md, args, kwargs);
296 bool PyInterface_AddNdrRpcMethods(PyTypeObject *ifacetype, const struct PyNdrRpcMethodDef *mds)
299 for (i = 0; mds[i].name; i++) {
301 struct wrapperbase *wb = (struct wrapperbase *)calloc(sizeof(struct wrapperbase), 1);
306 wb->name = discard_const_p(char, mds[i].name);
307 wb->flags = PyWrapperFlag_KEYWORDS;
308 wb->wrapper = (wrapperfunc)py_dcerpc_call_wrapper;
309 wb->doc = discard_const_p(char, mds[i].doc);
311 ret = PyDescr_NewWrapper(ifacetype, wb, discard_const_p(void, &mds[i]));
313 PyDict_SetItemString(ifacetype->tp_dict, mds[i].name,
320 PyObject *py_dcerpc_syntax_init_helper(PyTypeObject *type, PyObject *args, PyObject *kwargs,
321 const struct ndr_syntax_id *syntax)
324 struct ndr_syntax_id *obj;
325 const char *kwnames[] = { NULL };
327 if (!PyArg_ParseTupleAndKeywords(args, kwargs, ":abstract_syntax", discard_const_p(char *, kwnames))) {
331 ret = pytalloc_new(struct ndr_syntax_id, type);
336 obj = (struct ndr_syntax_id *)pytalloc_get_ptr(ret);
342 void PyErr_SetDCERPCStatus(struct dcerpc_pipe *p, NTSTATUS status)
344 if (p && NT_STATUS_EQUAL(status, NT_STATUS_NET_WRITE_FAULT)) {
345 status = dcerpc_fault_to_nt_status(p->last_fault_code);
347 PyErr_SetNTSTATUS(status);
352 take a NDR structure that has a type in a python module and return
353 it as a python object
355 r is the NDR structure pointer (a C structure)
357 r_ctx is the context that is a parent of r. It will be referenced by
358 the resulting python object
360 This MUST only be used by objects that are based on pytalloc_Object
361 otherwise the pytalloc_reference_ex() will fail.
363 PyObject *py_return_ndr_struct(const char *module_name, const char *type_name,
364 TALLOC_CTX *r_ctx, void *r)
366 PyTypeObject *py_type;
373 module = PyImport_ImportModule(module_name);
374 if (module == NULL) {
378 py_type = (PyTypeObject *)PyObject_GetAttrString(module, type_name);
379 if (py_type == NULL) {
383 return pytalloc_reference_ex(py_type, r_ctx, r);
386 PyObject *PyString_FromStringOrNULL(const char *str)
391 return PyString_FromString(str);
394 PyObject *pyrpc_import_union(PyTypeObject *type, TALLOC_CTX *mem_ctx, int level,
395 const void *in, const char *typename)
397 static const char *mem_ctx_type = "TALLOC_CTX";
398 PyObject *mem_ctx_obj = NULL;
399 PyObject *in_obj = NULL;
400 PyObject *ret = NULL;
402 mem_ctx_obj = PyCObject_FromVoidPtrAndDesc(mem_ctx,
403 discard_const_p(char, mem_ctx_type),
405 if (mem_ctx_obj == NULL) {
409 in_obj = PyCObject_FromVoidPtrAndDesc(discard_const(in),
410 discard_const_p(char, typename),
412 if (in_obj == NULL) {
413 Py_XDECREF(mem_ctx_obj);
417 ret = PyObject_CallMethod((PyObject *)type,
418 discard_const_p(char, "__import__"),
419 discard_const_p(char, "OiO"),
420 mem_ctx_obj, level, in_obj);
421 Py_XDECREF(mem_ctx_obj);
430 void *pyrpc_export_union(PyTypeObject *type, TALLOC_CTX *mem_ctx, int level,
431 PyObject *in, const char *typename)
433 static const char *mem_ctx_type = "TALLOC_CTX";
434 PyObject *mem_ctx_obj = NULL;
435 PyObject *ret_obj = NULL;
436 const char *ret_desc = NULL;
440 mem_ctx_obj = PyCObject_FromVoidPtrAndDesc(mem_ctx,
441 discard_const_p(char, mem_ctx_type),
443 if (mem_ctx_obj == NULL) {
447 ret_obj = PyObject_CallMethod((PyObject *)type,
448 discard_const_p(char, "__export__"),
449 discard_const_p(char, "OiO"),
450 mem_ctx_obj, level, in);
451 Py_XDECREF(mem_ctx_obj);
452 if (ret_obj == NULL) {
456 if (!PyCObject_Check(ret_obj)) {
458 PyErr_Format(PyExc_TypeError,
459 "New %s.__export__() returned no PyCObject!",
464 ret_desc = (const char *)PyCObject_GetDesc(ret_obj);
465 if (ret_desc == NULL) {
467 PyErr_Format(PyExc_TypeError,
468 "New %s.__export__() returned no PyCObject_GetDesc()!",
473 cmp = strncmp(typename, ret_desc, strlen(typename) + 1);
476 PyErr_Format(PyExc_TypeError,
477 "New %s.__export__() returned PyCObject_GetDesc() != %s!",
478 type->tp_name, typename);
482 ret = PyCObject_AsVoidPtr(ret_obj);