source4/librpc/rpc/pyrpc.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2008
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <Python.h>
  21 #include "includes.h"
  22 #include <structmember.h>
  23 #include "librpc/rpc/pyrpc.h"
  24 #include "librpc/rpc/dcerpc.h"
  25 #include "lib/events/events.h"
  26 #include "param/pyparam.h"
  27 #include "auth/credentials/pycredentials.h"
  28
  29 static void PyErr_SetDCERPCStatus(struct dcerpc_pipe *p, NTSTATUS status);
  30
  31 static PyObject *py_dcerpc_run_function(dcerpc_InterfaceObject *iface,
  32                                         const struct PyNdrRpcMethodDef *md,
  33                                         PyObject *args, PyObject *kwargs)
  34 {
  35         TALLOC_CTX *mem_ctx;
  36         NTSTATUS status;
  37         void *r;
  38         PyObject *result = Py_None;
  39
  40         if (md->pack_in_data == NULL || md->unpack_out_data == NULL) {
  41                 PyErr_SetString(PyExc_NotImplementedError, "No marshalling code available yet");
  42                 return NULL;
  43         }
  44
  45         mem_ctx = talloc_new(NULL);
  46         if (mem_ctx == NULL) {
  47                 PyErr_NoMemory();
  48                 return NULL;
  49         }
  50
  51         r = talloc_zero_size(mem_ctx, md->table->calls[md->opnum].struct_size);
  52         if (r == NULL) {
  53                 PyErr_NoMemory();
  54                 return NULL;
  55         }
  56
  57         if (!md->pack_in_data(args, kwargs, r)) {
  58                 talloc_free(mem_ctx);
  59                 return NULL;
  60         }
  61
  62         status = md->call(iface->binding_handle, mem_ctx, r);
  63         if (!NT_STATUS_IS_OK(status)) {
  64                 PyErr_SetDCERPCStatus(iface->pipe, status);
  65                 talloc_free(mem_ctx);
  66                 return NULL;
  67         }
  68
  69         result = md->unpack_out_data(r);
  70
  71         talloc_free(mem_ctx);
  72         return result;
  73 }
  74
  75 static PyObject *py_dcerpc_call_wrapper(PyObject *self, PyObject *args, void *wrapped, PyObject *kwargs)
  76 {
  77         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
  78         const struct PyNdrRpcMethodDef *md = (const struct PyNdrRpcMethodDef *)wrapped;
  79
  80         return py_dcerpc_run_function(iface, md, args, kwargs);
  81 }
  82
  83
  84 bool PyInterface_AddNdrRpcMethods(PyTypeObject *ifacetype, const struct PyNdrRpcMethodDef *mds)
  85 {
  86         int i;
  87         for (i = 0; mds[i].name; i++) {
  88                 PyObject *ret;
  89                 struct wrapperbase *wb = (struct wrapperbase *)calloc(sizeof(struct wrapperbase), 1);
  90
  91                 wb->name = discard_const_p(char, mds[i].name);
  92                 wb->flags = PyWrapperFlag_KEYWORDS;
  93                 wb->wrapper = (wrapperfunc)py_dcerpc_call_wrapper;
  94                 wb->doc = discard_const_p(char, mds[i].doc);
  95
  96                 ret = PyDescr_NewWrapper(ifacetype, wb, discard_const_p(void, &mds[i]));
  97
  98                 PyDict_SetItemString(ifacetype->tp_dict, mds[i].name,
  99                                      (PyObject *)ret);
 100         }
 101
 102         return true;
 103 }
 104
 105 static bool PyString_AsGUID(PyObject *object, struct GUID *uuid)
 106 {
 107         NTSTATUS status;
 108         status = GUID_from_string(PyString_AsString(object), uuid);
 109         if (NT_STATUS_IS_ERR(status)) {
 110                 PyErr_SetNTSTATUS(status);
 111                 return false;
 112         }
 113         return true;
 114 }
 115
 116 static bool ndr_syntax_from_py_object(PyObject *object, struct ndr_syntax_id *syntax_id)
 117 {
 118         ZERO_STRUCTP(syntax_id);
 119
 120         if (PyString_Check(object)) {
 121                 return PyString_AsGUID(object, &syntax_id->uuid);
 122         } else if (PyTuple_Check(object)) {
 123                 if (PyTuple_Size(object) < 1 || PyTuple_Size(object) > 2) {
 124                         PyErr_SetString(PyExc_ValueError, "Syntax ID tuple has invalid size");
 125                         return false;
 126                 }
 127
 128                 if (!PyString_Check(PyTuple_GetItem(object, 0))) {
 129                         PyErr_SetString(PyExc_ValueError, "Expected GUID as first element in tuple");
 130                         return false;
 131                 }
 132
 133                 if (!PyString_AsGUID(PyTuple_GetItem(object, 0), &syntax_id->uuid))
 134                         return false;
 135
 136                 if (!PyInt_Check(PyTuple_GetItem(object, 1))) {
 137                         PyErr_SetString(PyExc_ValueError, "Expected version as second element in tuple");
 138                         return false;
 139                 }
 140
 141                 syntax_id->if_version = PyInt_AsLong(PyTuple_GetItem(object, 1));
 142                 return true;
 143         }
 144
 145         PyErr_SetString(PyExc_TypeError, "Expected UUID or syntax id tuple");
 146         return false;
 147 }
 148
 149 static PyObject *py_iface_server_name(PyObject *obj, void *closure)
 150 {
 151         const char *server_name;
 152         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
 153
 154         server_name = dcerpc_server_name(iface->pipe);
 155         if (server_name == NULL)
 156                 Py_RETURN_NONE;
 157
 158         return PyString_FromString(server_name);
 159 }
 160
 161 static PyObject *py_ndr_syntax_id(struct ndr_syntax_id *syntax_id)
 162 {
 163         PyObject *ret;
 164         char *uuid_str;
 165
 166         uuid_str = GUID_string(NULL, &syntax_id->uuid);
 167         if (uuid_str == NULL)
 168                 return NULL;
 169
 170         ret = Py_BuildValue("(s,i)", uuid_str, syntax_id->if_version);
 171
 172         talloc_free(uuid_str);
 173
 174         return ret;
 175 }
 176
 177 static PyObject *py_iface_abstract_syntax(PyObject *obj, void *closure)
 178 {
 179         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
 180
 181         return py_ndr_syntax_id(&iface->pipe->syntax);
 182 }
 183
 184 static PyObject *py_iface_transfer_syntax(PyObject *obj, void *closure)
 185 {
 186         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
 187
 188         return py_ndr_syntax_id(&iface->pipe->transfer_syntax);
 189 }
 190
 191 static PyGetSetDef dcerpc_interface_getsetters[] = {
 192         { discard_const_p(char, "server_name"), py_iface_server_name, NULL,
 193           discard_const_p(char, "name of the server, if connected over SMB") },
 194         { discard_const_p(char, "abstract_syntax"), py_iface_abstract_syntax, NULL,
 195           discard_const_p(char, "syntax id of the abstract syntax") },
 196         { discard_const_p(char, "transfer_syntax"), py_iface_transfer_syntax, NULL,
 197           discard_const_p(char, "syntax id of the transfersyntax") },
 198         { NULL }
 199 };
 200
 201 static PyMemberDef dcerpc_interface_members[] = {
 202         { discard_const_p(char, "request_timeout"), T_INT,
 203           offsetof(struct dcerpc_pipe, request_timeout), 0,
 204           discard_const_p(char, "request timeout, in seconds") },
 205         { NULL }
 206 };
 207
 208 static void PyErr_SetDCERPCStatus(struct dcerpc_pipe *p, NTSTATUS status)
 209 {
 210         if (p != NULL && NT_STATUS_EQUAL(status, NT_STATUS_NET_WRITE_FAULT)) {
 211                 const char *errstr = dcerpc_errstr(NULL, p->last_fault_code);
 212                 PyErr_SetObject(PyExc_RuntimeError,
 213                         Py_BuildValue("(i,s)", p->last_fault_code,
 214                                       errstr));
 215         } else {
 216                 PyErr_SetNTSTATUS(status);
 217         }
 218 }
 219
 220 static PyObject *py_iface_request(PyObject *self, PyObject *args, PyObject *kwargs)
 221 {
 222         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
 223         int opnum;
 224         DATA_BLOB data_in, data_out;
 225         NTSTATUS status;
 226         char *in_data;
 227         int in_length;
 228         PyObject *ret;
 229         PyObject *object = NULL;
 230         struct GUID object_guid;
 231         TALLOC_CTX *mem_ctx = talloc_new(NULL);
 232         const char *kwnames[] = { "opnum", "data", "object", NULL };
 233
 234         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "is#|O:request",
 235                 discard_const_p(char *, kwnames), &opnum, &in_data, &in_length, &object)) {
 236                 return NULL;
 237         }
 238
 239         data_in.data = (uint8_t *)talloc_memdup(mem_ctx, in_data, in_length);
 240         data_in.length = in_length;
 241
 242         ZERO_STRUCT(data_out);
 243
 244         if (object != NULL && !PyString_AsGUID(object, &object_guid)) {
 245                 return NULL;
 246         }
 247
 248         status = dcerpc_request(iface->pipe, object?&object_guid:NULL,
 249                                 opnum, mem_ctx, &data_in, &data_out);
 250
 251         if (!NT_STATUS_IS_OK(status)) {
 252                 PyErr_SetDCERPCStatus(iface->pipe, status);
 253                 talloc_free(mem_ctx);
 254                 return NULL;
 255         }
 256
 257         ret = PyString_FromStringAndSize((char *)data_out.data, data_out.length);
 258
 259         talloc_free(mem_ctx);
 260         return ret;
 261 }
 262
 263 static PyObject *py_iface_alter_context(PyObject *self, PyObject *args, PyObject *kwargs)
 264 {
 265         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
 266         NTSTATUS status;
 267         const char *kwnames[] = { "abstract_syntax", "transfer_syntax", NULL };
 268         PyObject *py_abstract_syntax = Py_None, *py_transfer_syntax = Py_None;
 269         struct ndr_syntax_id abstract_syntax, transfer_syntax;
 270
 271         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:alter_context",
 272                 discard_const_p(char *, kwnames), &py_abstract_syntax,
 273                 &py_transfer_syntax)) {
 274                 return NULL;
 275         }
 276
 277         if (!ndr_syntax_from_py_object(py_abstract_syntax, &abstract_syntax))
 278                 return NULL;
 279
 280         if (py_transfer_syntax == Py_None) {
 281                 transfer_syntax = ndr_transfer_syntax;
 282         } else {
 283                 if (!ndr_syntax_from_py_object(py_transfer_syntax,
 284                                                &transfer_syntax))
 285                         return NULL;
 286         }
 287
 288         status = dcerpc_alter_context(iface->pipe, iface->pipe, &abstract_syntax,
 289                                       &transfer_syntax);
 290
 291         if (!NT_STATUS_IS_OK(status)) {
 292                 PyErr_SetDCERPCStatus(iface->pipe, status);
 293                 return NULL;
 294         }
 295
 296         Py_RETURN_NONE;
 297 }
 298
 299 PyObject *py_dcerpc_interface_init_helper(PyTypeObject *type, PyObject *args, PyObject *kwargs, const struct ndr_interface_table *table)
 300 {
 301         dcerpc_InterfaceObject *ret;
 302         const char *binding_string;
 303         struct cli_credentials *credentials;
 304         struct loadparm_context *lp_ctx = NULL;
 305         PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None, *py_basis = Py_None;
 306         TALLOC_CTX *mem_ctx = NULL;
 307         struct tevent_context *event_ctx;
 308         NTSTATUS status;
 309
 310         const char *kwnames[] = {
 311                 "binding", "lp_ctx", "credentials", "basis_connection", NULL
 312         };
 313
 314         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "s|OOO:samr", discard_const_p(char *, kwnames), &binding_string, &py_lp_ctx, &py_credentials, &py_basis)) {
 315                 return NULL;
 316         }
 317
 318         lp_ctx = lp_from_py_object(NULL, py_lp_ctx); /* FIXME: leaky */
 319         if (lp_ctx == NULL) {
 320                 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
 321                 return NULL;
 322         }
 323
 324         status = dcerpc_init(lp_ctx);
 325         if (!NT_STATUS_IS_OK(status)) {
 326                 PyErr_SetNTSTATUS(status);
 327                 return NULL;
 328         }
 329         credentials = cli_credentials_from_py_object(py_credentials);
 330         if (credentials == NULL) {
 331                 PyErr_SetString(PyExc_TypeError, "Expected credentials");
 332                 return NULL;
 333         }
 334         ret = PyObject_New(dcerpc_InterfaceObject, type);
 335
 336         event_ctx = event_context_init(mem_ctx);
 337
 338         if (py_basis != Py_None) {
 339                 struct dcerpc_pipe *base_pipe;
 340
 341                 if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {
 342                         PyErr_SetString(PyExc_ValueError, "basis_connection must be a DCE/RPC connection");
 343                         talloc_free(mem_ctx);
 344                         return NULL;
 345                 }
 346
 347                 base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;
 348
 349                 status = dcerpc_secondary_context(base_pipe, &ret->pipe, table);
 350         } else {
 351                 status = dcerpc_pipe_connect(event_ctx, &ret->pipe, binding_string,
 352                              table, credentials, event_ctx, lp_ctx);
 353         }
 354         if (NT_STATUS_IS_ERR(status)) {
 355                 PyErr_SetNTSTATUS(status);
 356                 talloc_free(mem_ctx);
 357                 return NULL;
 358         }
 359
 360         ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;
 361         ret->binding_handle = ret->pipe->binding_handle;
 362         return (PyObject *)ret;
 363 }
 364
 365 static PyMethodDef dcerpc_interface_methods[] = {
 366         { "request", (PyCFunction)py_iface_request, METH_VARARGS|METH_KEYWORDS, "S.request(opnum, data, object=None) -> data\nMake a raw request" },
 367         { "alter_context", (PyCFunction)py_iface_alter_context, METH_VARARGS|METH_KEYWORDS, "S.alter_context(syntax)\nChange to a different interface" },
 368         { NULL, NULL, 0, NULL },
 369 };
 370
 371
 372 static void dcerpc_interface_dealloc(PyObject* self)
 373 {
 374         dcerpc_InterfaceObject *interface = (dcerpc_InterfaceObject *)self;
 375         talloc_free(interface->pipe);
 376         PyObject_Del(self);
 377 }
 378
 379 static PyObject *dcerpc_interface_new(PyTypeObject *self, PyObject *args, PyObject *kwargs)
 380 {
 381         dcerpc_InterfaceObject *ret;
 382         const char *binding_string;
 383         struct cli_credentials *credentials;
 384         struct loadparm_context *lp_ctx = NULL;
 385         PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None;
 386         TALLOC_CTX *mem_ctx = NULL;
 387         struct tevent_context *event_ctx;
 388         NTSTATUS status;
 389
 390         PyObject *syntax, *py_basis = Py_None;
 391         const char *kwnames[] = {
 392                 "binding", "syntax", "lp_ctx", "credentials", "basis_connection", NULL
 393         };
 394         struct ndr_interface_table *table;
 395
 396         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|OOO:connect", discard_const_p(char *, kwnames), &binding_string, &syntax, &py_lp_ctx, &py_credentials, &py_basis)) {
 397                 return NULL;
 398         }
 399
 400         lp_ctx = lp_from_py_object(NULL, py_lp_ctx); /* FIXME: leaky */
 401         if (lp_ctx == NULL) {
 402                 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
 403                 return NULL;
 404         }
 405
 406         credentials = cli_credentials_from_py_object(py_credentials);
 407         if (credentials == NULL) {
 408                 PyErr_SetString(PyExc_TypeError, "Expected credentials");
 409                 return NULL;
 410         }
 411         ret = PyObject_New(dcerpc_InterfaceObject, &dcerpc_InterfaceType);
 412
 413         event_ctx = s4_event_context_init(mem_ctx);
 414
 415         /* Create a dummy interface table struct. TODO: In the future, we should rather just allow
 416          * connecting without requiring an interface table.
 417          */
 418
 419         table = talloc_zero(mem_ctx, struct ndr_interface_table);
 420
 421         if (table == NULL) {
 422                 PyErr_SetString(PyExc_MemoryError, "Allocating interface table");
 423                 return NULL;
 424         }
 425
 426         if (!ndr_syntax_from_py_object(syntax, &table->syntax_id)) {
 427                 return NULL;
 428         }
 429
 430         ret->pipe = NULL;
 431         ret->binding_handle = NULL;
 432
 433         if (py_basis != Py_None) {
 434                 struct dcerpc_pipe *base_pipe;
 435
 436                 if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {
 437                         PyErr_SetString(PyExc_ValueError, "basis_connection must be a DCE/RPC connection");
 438                         talloc_free(mem_ctx);
 439                         return NULL;
 440                 }
 441
 442                 base_pipe = ((dcerpc_InterfaceObject *)py_basis)->pipe;
 443
 444                 status = dcerpc_secondary_context(base_pipe, &ret->pipe,
 445                                      table);
 446                 ret->pipe = talloc_steal(NULL, ret->pipe);
 447         } else {
 448                 status = dcerpc_pipe_connect(NULL, &ret->pipe, binding_string,
 449                              table, credentials, event_ctx, lp_ctx);
 450         }
 451
 452         if (!NT_STATUS_IS_OK(status)) {
 453                 PyErr_SetDCERPCStatus(ret->pipe, status);
 454                 talloc_free(mem_ctx);
 455                 return NULL;
 456         }
 457         ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;
 458         ret->binding_handle = ret->pipe->binding_handle;
 459         return (PyObject *)ret;
 460 }
 461
 462 PyTypeObject dcerpc_InterfaceType = {
 463         PyObject_HEAD_INIT(NULL) 0,
 464         .tp_name = "dcerpc.ClientConnection",
 465         .tp_basicsize = sizeof(dcerpc_InterfaceObject),
 466         .tp_dealloc = dcerpc_interface_dealloc,
 467         .tp_getset = dcerpc_interface_getsetters,
 468         .tp_members = dcerpc_interface_members,
 469         .tp_methods = dcerpc_interface_methods,
 470         .tp_doc = "ClientConnection(binding, syntax, lp_ctx=None, credentials=None) -> connection\n"
 471 "\n"
 472 "binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\n"
 473 "syntax should be a tuple with a GUID and version number of an interface\n"
 474 "lp_ctx should be a path to a smb.conf file or a param.LoadParm object\n"
 475 "credentials should be a credentials.Credentials object.\n\n",
 476         .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 477         .tp_new = dcerpc_interface_new,
 478 };
 479
 480 void initbase(void)
 481 {
 482         PyObject *m;
 483
 484         if (PyType_Ready(&dcerpc_InterfaceType) < 0)
 485                 return;
 486
 487         m = Py_InitModule3("base", NULL, "DCE/RPC protocol implementation");
 488         if (m == NULL)
 489                 return;
 490
 491         Py_INCREF((PyObject *)&dcerpc_InterfaceType);
 492         PyModule_AddObject(m, "ClientConnection", (PyObject *)&dcerpc_InterfaceType);
 493 }