s4 librpc rpc pyrpc: Ensure tevent_context deleted last
[bbaumbach/samba-autobuild/.git] / source4 / librpc / rpc / pyrpc_util.c
1 /*
2    Unix SMB/CIFS implementation.
3
4    Python interface to DCE/RPC library - utility functions.
5
6    Copyright (C) 2010 Jelmer Vernooij <jelmer@samba.org>
7    Copyright (C) 2010 Andrew Tridgell <tridge@samba.org>
8
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.
13
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.
18
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/>.
21 */
22
23 #include <Python.h>
24 #include "python/py3compat.h"
25 #include "includes.h"
26 #include "librpc/rpc/pyrpc_util.h"
27 #include "librpc/rpc/dcerpc.h"
28 #include "librpc/rpc/pyrpc.h"
29 #include "param/pyparam.h"
30 #include "auth/credentials/pycredentials.h"
31 #include "lib/events/events.h"
32 #include "lib/messaging/messaging.h"
33 #include "lib/messaging/irpc.h"
34
35 bool py_check_dcerpc_type(PyObject *obj, const char *module, const char *type_name)
36 {
37         PyObject *mod;
38         PyTypeObject *type;
39         bool ret;
40
41         mod = PyImport_ImportModule(module);
42
43         if (mod == NULL) {
44                 PyErr_Format(PyExc_RuntimeError, "Unable to import %s to check type %s",
45                         module, type_name);
46                 return false;
47         }
48
49         type = (PyTypeObject *)PyObject_GetAttrString(mod, type_name);
50         Py_DECREF(mod);
51         if (type == NULL) {
52                 PyErr_Format(PyExc_RuntimeError, "Unable to find type %s in module %s",
53                         module, type_name);
54                 return false;
55         }
56
57         ret = PyObject_TypeCheck(obj, type);
58         Py_DECREF(type);
59
60         if (!ret)
61                 PyErr_Format(PyExc_TypeError, "Expected type %s.%s, got %s",
62                         module, type_name, Py_TYPE(obj)->tp_name);
63
64         return ret;
65 }
66
67 /*
68   connect to a IRPC pipe from python
69  */
70 static NTSTATUS pyrpc_irpc_connect(TALLOC_CTX *mem_ctx, const char *irpc_server,
71                                    const struct ndr_interface_table *table,
72                                    struct tevent_context *event_ctx,
73                                    struct loadparm_context *lp_ctx,
74                                    struct dcerpc_binding_handle **binding_handle)
75 {
76         struct imessaging_context *msg;
77
78         msg = imessaging_client_init(mem_ctx, lp_ctx, event_ctx);
79         NT_STATUS_HAVE_NO_MEMORY(msg);
80
81         *binding_handle = irpc_binding_handle_by_name(mem_ctx, msg, irpc_server, table);
82         if (*binding_handle == NULL) {
83                 talloc_free(msg);
84                 return NT_STATUS_INVALID_PIPE_STATE;
85         }
86
87         /*
88          * Note: this allows nested event loops to happen,
89          * but as there's no top level event loop it's not that critical.
90          */
91         dcerpc_binding_handle_set_sync_ev(*binding_handle, event_ctx);
92
93         return NT_STATUS_OK;
94 }
95
96 PyObject *py_dcerpc_interface_init_helper(PyTypeObject *type, PyObject *args, PyObject *kwargs,
97                                           const struct ndr_interface_table *table)
98 {
99         dcerpc_InterfaceObject *ret;
100         const char *binding_string;
101         PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;
102         NTSTATUS status;
103         unsigned int timeout = (unsigned int)-1;
104         const char *kwnames[] = {
105                 "binding", "lp_ctx", "credentials", "timeout", "basis_connection", NULL
106         };
107
108         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|OOIO:samr", discard_const_p(char *, kwnames), &binding_string, &py_lp_ctx, &py_credentials, &timeout, &py_basis)) {
109                 return NULL;
110         }
111
112         status = dcerpc_init();
113         if (!NT_STATUS_IS_OK(status)) {
114                 PyErr_SetNTSTATUS(status);
115                 return NULL;
116         }
117
118         ret = PyObject_New(dcerpc_InterfaceObject, type);
119         if (ret == NULL) {
120                 PyErr_NoMemory();
121                 return NULL;
122         }
123
124         ret->pipe = NULL;
125         ret->binding_handle = NULL;
126         ret->ev = NULL;
127         ret->mem_ctx = talloc_new(NULL);
128         if (ret->mem_ctx == NULL) {
129                 PyErr_NoMemory();
130                 return NULL;
131         }
132
133         if (strncmp(binding_string, "irpc:", 5) == 0) {
134                 struct loadparm_context *lp_ctx;
135
136                 ret->ev = s4_event_context_init(ret->mem_ctx);
137                 if (ret->ev == NULL) {
138                         PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
139                         Py_DECREF(ret);
140                         return NULL;
141                 }
142
143                 lp_ctx = lpcfg_from_py_object(ret->ev, py_lp_ctx);
144                 if (lp_ctx == NULL) {
145                         PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
146                         Py_DECREF(ret);
147                         return NULL;
148                 }
149
150                 status = pyrpc_irpc_connect(ret->mem_ctx, binding_string+5, table,
151                                             ret->ev, lp_ctx, &ret->binding_handle);
152                 if (!NT_STATUS_IS_OK(status)) {
153                         PyErr_SetNTSTATUS(status);
154                         Py_DECREF(ret);
155                         return NULL;
156                 }
157         } else if (py_basis != Py_None) {
158                 struct dcerpc_pipe *base_pipe;
159                 PyObject *py_base;
160                 PyTypeObject *ClientConnection_Type;
161
162                 py_base = PyImport_ImportModule("samba.dcerpc.base");
163                 if (py_base == NULL) {
164                         Py_DECREF(ret);
165                         return NULL;
166                 }
167
168                 ClientConnection_Type = (PyTypeObject *)PyObject_GetAttrString(py_base, "ClientConnection");
169                 if (ClientConnection_Type == NULL) {
170                         PyErr_SetNone(PyExc_TypeError);
171                         Py_DECREF(ret);
172                         Py_DECREF(py_base);
173                         return NULL;
174                 }
175
176                 if (!PyObject_TypeCheck(py_basis, ClientConnection_Type)) {
177                         PyErr_SetString(PyExc_TypeError, "basis_connection must be a DCE/RPC connection");
178                         Py_DECREF(ret);
179                         Py_DECREF(py_base);
180                         Py_DECREF(ClientConnection_Type);
181                         return NULL;
182                 }
183
184                 base_pipe = talloc_reference(ret->mem_ctx,
185                                          ((dcerpc_InterfaceObject *)py_basis)->pipe);
186                 if (base_pipe == NULL) {
187                         PyErr_NoMemory();
188                         Py_DECREF(ret);
189                         Py_DECREF(py_base);
190                         Py_DECREF(ClientConnection_Type);
191                         return NULL;
192                 }
193
194                 ret->ev = talloc_reference(
195                         ret->mem_ctx,
196                         ((dcerpc_InterfaceObject *)py_basis)->ev);
197                 if (ret->ev == NULL) {
198                         PyErr_NoMemory();
199                         Py_DECREF(ret);
200                         Py_DECREF(py_base);
201                         Py_DECREF(ClientConnection_Type);
202                         return NULL;
203                 }
204
205                 status = dcerpc_secondary_context(base_pipe, &ret->pipe, table);
206                 if (!NT_STATUS_IS_OK(status)) {
207                         PyErr_SetNTSTATUS(status);
208                         Py_DECREF(ret);
209                         Py_DECREF(py_base);
210                         Py_DECREF(ClientConnection_Type);
211                         return NULL;
212                 }
213
214                 ret->pipe = talloc_steal(ret->mem_ctx, ret->pipe);
215                 Py_XDECREF(ClientConnection_Type);
216                 Py_XDECREF(py_base);
217         } else {
218                 struct loadparm_context *lp_ctx;
219                 struct cli_credentials *credentials;
220
221                 ret->ev = s4_event_context_init(ret->mem_ctx);
222                 if (ret->ev == NULL) {
223                         PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
224                         Py_DECREF(ret);
225                         return NULL;
226                 }
227
228                 lp_ctx = lpcfg_from_py_object(ret->ev, py_lp_ctx);
229                 if (lp_ctx == NULL) {
230                         PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
231                         Py_DECREF(ret);
232                         return NULL;
233                 }
234
235                 credentials = cli_credentials_from_py_object(py_credentials);
236                 if (credentials == NULL) {
237                         PyErr_SetString(PyExc_TypeError, "Expected credentials");
238                         Py_DECREF(ret);
239                         return NULL;
240                 }
241                 status = dcerpc_pipe_connect(ret->mem_ctx, &ret->pipe, binding_string,
242                              table, credentials, ret->ev, lp_ctx);
243                 if (!NT_STATUS_IS_OK(status)) {
244                         PyErr_SetNTSTATUS(status);
245                         Py_DECREF(ret);
246                         return NULL;
247                 }
248         }
249
250         if (ret->pipe) {
251                 ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;
252                 ret->binding_handle = ret->pipe->binding_handle;
253         }
254
255         /* reset timeout for the handle */
256         if ((timeout != ((unsigned int)-1)) && (ret->binding_handle != NULL)) {
257                 dcerpc_binding_handle_set_timeout(ret->binding_handle, timeout);
258         }
259
260         return (PyObject *)ret;
261 }
262
263 static PyObject *py_dcerpc_run_function(dcerpc_InterfaceObject *iface,
264                                         const struct PyNdrRpcMethodDef *md,
265                                         PyObject *args, PyObject *kwargs)
266 {
267         TALLOC_CTX *mem_ctx;
268         NTSTATUS status;
269         void *r;
270         PyObject *result = Py_None;
271
272         if (md->pack_in_data == NULL || md->unpack_out_data == NULL) {
273                 PyErr_SetString(PyExc_NotImplementedError, "No marshalling code available yet");
274                 return NULL;
275         }
276
277         mem_ctx = talloc_new(NULL);
278         if (mem_ctx == NULL) {
279                 PyErr_NoMemory();
280                 return NULL;
281         }
282
283         r = talloc_zero_size(mem_ctx, md->table->calls[md->opnum].struct_size);
284         if (r == NULL) {
285                 PyErr_NoMemory();
286                 return NULL;
287         }
288
289         if (!md->pack_in_data(args, kwargs, r)) {
290                 talloc_free(mem_ctx);
291                 return NULL;
292         }
293
294         status = md->call(iface->binding_handle, mem_ctx, r);
295         if (!NT_STATUS_IS_OK(status)) {
296                 PyErr_SetDCERPCStatus(iface->pipe, status);
297                 talloc_free(mem_ctx);
298                 return NULL;
299         }
300
301         result = md->unpack_out_data(r);
302
303         talloc_free(mem_ctx);
304         return result;
305 }
306
307 static PyObject *py_dcerpc_call_wrapper(PyObject *self, PyObject *args, void *wrapped, PyObject *kwargs)
308 {       
309         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
310         const struct PyNdrRpcMethodDef *md = (const struct PyNdrRpcMethodDef *)wrapped;
311
312         return py_dcerpc_run_function(iface, md, args, kwargs);
313 }
314
315 bool PyInterface_AddNdrRpcMethods(PyTypeObject *ifacetype, const struct PyNdrRpcMethodDef *mds)
316 {
317         int i;
318         for (i = 0; mds[i].name; i++) {
319                 PyObject *ret;
320                 struct wrapperbase *wb = (struct wrapperbase *)calloc(sizeof(struct wrapperbase), 1);
321
322                 if (wb == NULL) {
323                         return false;
324                 }
325                 wb->name = discard_const_p(char, mds[i].name);
326                 wb->flags = PyWrapperFlag_KEYWORDS;
327                 wb->wrapper = (wrapperfunc)py_dcerpc_call_wrapper;
328                 wb->doc = discard_const_p(char, mds[i].doc);
329
330                 ret = PyDescr_NewWrapper(ifacetype, wb, discard_const_p(void, &mds[i]));
331
332                 PyDict_SetItemString(ifacetype->tp_dict, mds[i].name, 
333                                      (PyObject *)ret);
334                 Py_CLEAR(ret);
335         }
336
337         return true;
338 }
339
340 PyObject *py_dcerpc_syntax_init_helper(PyTypeObject *type, PyObject *args, PyObject *kwargs,
341                                        const struct ndr_syntax_id *syntax)
342 {
343         PyObject *ret;
344         struct ndr_syntax_id *obj;
345         const char *kwnames[] = { NULL };
346
347         if (!PyArg_ParseTupleAndKeywords(args, kwargs, ":abstract_syntax", discard_const_p(char *, kwnames))) {
348                 return NULL;
349         }
350
351         ret = pytalloc_new(struct ndr_syntax_id, type);
352         if (ret == NULL) {
353                 return NULL;
354         }
355
356         obj = pytalloc_get_type(ret, struct ndr_syntax_id);
357         *obj = *syntax;
358
359         return ret;
360 }
361
362 void PyErr_SetDCERPCStatus(struct dcerpc_pipe *p, NTSTATUS status)
363 {
364         if (p && NT_STATUS_EQUAL(status, NT_STATUS_NET_WRITE_FAULT)) {
365                 status = dcerpc_fault_to_nt_status(p->last_fault_code);
366         }
367         PyErr_SetNTSTATUS(status);
368 }
369
370
371 /*
372   take a NDR structure that has a type in a python module and return
373   it as a python object
374
375   r is the NDR structure pointer (a C structure)
376
377   r_ctx is the context that is a parent of r. It will be referenced by
378   the resulting python object
379
380   This MUST only be used by objects that are based on pytalloc_Object
381   otherwise the pytalloc_reference_ex() will fail.
382  */
383 PyObject *py_return_ndr_struct(const char *module_name, const char *type_name,
384                                TALLOC_CTX *r_ctx, void *r)
385 {
386         PyTypeObject *py_type;
387         PyObject *module;
388         PyObject *result = NULL;
389
390         if (r == NULL) {
391                 Py_RETURN_NONE;
392         }
393
394         module = PyImport_ImportModule(module_name);
395         if (module == NULL) {
396                 return NULL;
397         }
398
399         py_type = (PyTypeObject *)PyObject_GetAttrString(module, type_name);
400         if (py_type == NULL) {
401                 Py_DECREF(module);
402                 return NULL;
403         }
404
405         result = pytalloc_reference_ex(py_type, r_ctx, r);
406         Py_CLEAR(module);
407         Py_CLEAR(py_type);
408         return result;
409 }
410
411 PyObject *PyString_FromStringOrNULL(const char *str)
412 {
413         if (str == NULL) {
414                 Py_RETURN_NONE;
415         }
416         return PyStr_FromString(str);
417 }
418
419 PyObject *pyrpc_import_union(PyTypeObject *type, TALLOC_CTX *mem_ctx, int level,
420                              const void *in, const char *typename)
421 {
422         PyObject *mem_ctx_obj = NULL;
423         PyObject *in_obj = NULL;
424         PyObject *ret = NULL;
425
426         mem_ctx_obj = pytalloc_GenericObject_reference(mem_ctx);
427         if (mem_ctx_obj == NULL) {
428                 return NULL;
429         }
430
431         in_obj = pytalloc_GenericObject_reference_ex(mem_ctx, discard_const(in));
432         if (in_obj == NULL) {
433                 Py_XDECREF(mem_ctx_obj);
434                 return NULL;
435         }
436
437         ret = PyObject_CallMethod((PyObject *)type,
438                                   discard_const_p(char, "__import__"),
439                                   discard_const_p(char, "OiO"),
440                                   mem_ctx_obj, level, in_obj);
441         Py_XDECREF(mem_ctx_obj);
442         Py_XDECREF(in_obj);
443         if (ret == NULL) {
444                 return NULL;
445         }
446
447         return ret;
448 }
449
450 void *pyrpc_export_union(PyTypeObject *type, TALLOC_CTX *mem_ctx, int level,
451                          PyObject *in, const char *typename)
452 {
453         PyObject *mem_ctx_obj = NULL;
454         PyObject *ret_obj = NULL;
455         void *ret = NULL;
456
457         mem_ctx_obj = pytalloc_GenericObject_reference(mem_ctx);
458         if (mem_ctx_obj == NULL) {
459                 return NULL;
460         }
461
462         ret_obj = PyObject_CallMethod((PyObject *)type,
463                                       discard_const_p(char, "__export__"),
464                                       discard_const_p(char, "OiO"),
465                                       mem_ctx_obj, level, in);
466         Py_XDECREF(mem_ctx_obj);
467         if (ret_obj == NULL) {
468                 return NULL;
469         }
470
471         ret = _pytalloc_get_type(ret_obj, typename);
472         Py_XDECREF(ret_obj);
473         return ret;
474 }
475
476 PyObject *py_dcerpc_ndr_pointer_deref(PyTypeObject *type, PyObject *obj)
477 {
478         if (!PyObject_TypeCheck(obj, type)) {
479                 PyErr_Format(PyExc_TypeError,
480                              "Expected type '%s' but got type '%s'",
481                              (type)->tp_name, Py_TYPE(obj)->tp_name);
482                 return NULL;
483         }
484
485         return PyObject_GetAttrString(obj, discard_const_p(char, "value"));
486 }
487
488 PyObject *py_dcerpc_ndr_pointer_wrap(PyTypeObject *type, PyObject *obj)
489 {
490         PyObject *args = NULL;
491         PyObject *ret_obj = NULL;
492
493         args = PyTuple_New(1);
494         if (args == NULL) {
495                 return NULL;
496         }
497         Py_XINCREF(obj);
498         PyTuple_SetItem(args, 0, obj);
499
500         ret_obj = PyObject_Call((PyObject *)type, args, NULL);
501         Py_XDECREF(args);
502         return ret_obj;
503 }