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