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 "lib/events/events.h"
  25 #include "param/pyparam.h"
  26 #include "librpc/rpc/dcerpc.h"
  27 #include "librpc/rpc/pyrpc_util.h"
  28 #include "auth/credentials/pycredentials.h"
  29
  30 void initbase(void);
  31
  32 staticforward PyTypeObject dcerpc_InterfaceType;
  33
  34 static bool PyString_AsGUID(PyObject *object, struct GUID *uuid)
  35 {
  36         NTSTATUS status;
  37         status = GUID_from_string(PyString_AsString(object), uuid);
  38         if (NT_STATUS_IS_ERR(status)) {
  39                 PyErr_SetNTSTATUS(status);
  40                 return false;
  41         }
  42         return true;
  43 }
  44
  45 static bool ndr_syntax_from_py_object(PyObject *object, struct ndr_syntax_id *syntax_id)
  46 {
  47         ZERO_STRUCTP(syntax_id);
  48
  49         if (PyString_Check(object)) {
  50                 return PyString_AsGUID(object, &syntax_id->uuid);
  51         } else if (PyTuple_Check(object)) {
  52                 if (PyTuple_Size(object) < 1 || PyTuple_Size(object) > 2) {
  53                         PyErr_SetString(PyExc_ValueError, "Syntax ID tuple has invalid size");
  54                         return false;
  55                 }
  56
  57                 if (!PyString_Check(PyTuple_GetItem(object, 0))) {
  58                         PyErr_SetString(PyExc_ValueError, "Expected GUID as first element in tuple");
  59                         return false;
  60                 }
  61
  62                 if (!PyString_AsGUID(PyTuple_GetItem(object, 0), &syntax_id->uuid))
  63                         return false;
  64
  65                 if (!PyInt_Check(PyTuple_GetItem(object, 1))) {
  66                         PyErr_SetString(PyExc_ValueError, "Expected version as second element in tuple");
  67                         return false;
  68                 }
  69
  70                 syntax_id->if_version = PyInt_AsLong(PyTuple_GetItem(object, 1));
  71                 return true;
  72         }
  73
  74         PyErr_SetString(PyExc_TypeError, "Expected UUID or syntax id tuple");
  75         return false;
  76 }
  77
  78 static PyObject *py_iface_server_name(PyObject *obj, void *closure)
  79 {
  80         const char *server_name;
  81         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
  82
  83         server_name = dcerpc_server_name(iface->pipe);
  84         if (server_name == NULL)
  85                 Py_RETURN_NONE;
  86
  87         return PyString_FromString(server_name);
  88 }
  89
  90 static PyObject *py_ndr_syntax_id(struct ndr_syntax_id *syntax_id)
  91 {
  92         PyObject *ret;
  93         char *uuid_str;
  94
  95         uuid_str = GUID_string(NULL, &syntax_id->uuid);
  96         if (uuid_str == NULL)
  97                 return NULL;
  98
  99         ret = Py_BuildValue("(s,i)", uuid_str, syntax_id->if_version);
 100
 101         talloc_free(uuid_str);
 102
 103         return ret;
 104 }
 105
 106 static PyObject *py_iface_abstract_syntax(PyObject *obj, void *closure)
 107 {
 108         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
 109
 110         return py_ndr_syntax_id(&iface->pipe->syntax);
 111 }
 112
 113 static PyObject *py_iface_transfer_syntax(PyObject *obj, void *closure)
 114 {
 115         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)obj;
 116
 117         return py_ndr_syntax_id(&iface->pipe->transfer_syntax);
 118 }
 119
 120 static PyGetSetDef dcerpc_interface_getsetters[] = {
 121         { discard_const_p(char, "server_name"), py_iface_server_name, NULL,
 122           discard_const_p(char, "name of the server, if connected over SMB") },
 123         { discard_const_p(char, "abstract_syntax"), py_iface_abstract_syntax, NULL,
 124           discard_const_p(char, "syntax id of the abstract syntax") },
 125         { discard_const_p(char, "transfer_syntax"), py_iface_transfer_syntax, NULL,
 126           discard_const_p(char, "syntax id of the transfersyntax") },
 127         { NULL }
 128 };
 129
 130 static PyMemberDef dcerpc_interface_members[] = {
 131         { discard_const_p(char, "request_timeout"), T_INT,
 132           offsetof(struct dcerpc_pipe, request_timeout), 0,
 133           discard_const_p(char, "request timeout, in seconds") },
 134         { NULL }
 135 };
 136
 137 static PyObject *py_iface_request(PyObject *self, PyObject *args, PyObject *kwargs)
 138 {
 139         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
 140         int opnum;
 141         DATA_BLOB data_in, data_out;
 142         NTSTATUS status;
 143         char *in_data;
 144         int in_length;
 145         PyObject *ret;
 146         PyObject *object = NULL;
 147         struct GUID object_guid;
 148         TALLOC_CTX *mem_ctx = talloc_new(NULL);
 149         uint32_t out_flags = 0;
 150         const char *kwnames[] = { "opnum", "data", "object", NULL };
 151
 152         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "is#|O:request",
 153                 discard_const_p(char *, kwnames), &opnum, &in_data, &in_length, &object)) {
 154                 talloc_free(mem_ctx);
 155                 return NULL;
 156         }
 157
 158         data_in.data = (uint8_t *)talloc_memdup(mem_ctx, in_data, in_length);
 159         data_in.length = in_length;
 160
 161         ZERO_STRUCT(data_out);
 162
 163         if (object != NULL && !PyString_AsGUID(object, &object_guid)) {
 164                 talloc_free(mem_ctx);
 165                 return NULL;
 166         }
 167
 168         status = dcerpc_binding_handle_raw_call(iface->binding_handle,
 169                                                 object?&object_guid:NULL,
 170                                                 opnum,
 171                                                 0, /* in_flags */
 172                                                 data_in.data,
 173                                                 data_in.length,
 174                                                 mem_ctx,
 175                                                 &data_out.data,
 176                                                 &data_out.length,
 177                                                 &out_flags);
 178         if (!NT_STATUS_IS_OK(status)) {
 179                 PyErr_SetDCERPCStatus(iface->pipe, status);
 180                 talloc_free(mem_ctx);
 181                 return NULL;
 182         }
 183
 184         ret = PyString_FromStringAndSize((char *)data_out.data, data_out.length);
 185
 186         talloc_free(mem_ctx);
 187         return ret;
 188 }
 189
 190 static PyObject *py_iface_alter_context(PyObject *self, PyObject *args, PyObject *kwargs)
 191 {
 192         dcerpc_InterfaceObject *iface = (dcerpc_InterfaceObject *)self;
 193         NTSTATUS status;
 194         const char *kwnames[] = { "abstract_syntax", "transfer_syntax", NULL };
 195         PyObject *py_abstract_syntax = Py_None, *py_transfer_syntax = Py_None;
 196         struct ndr_syntax_id abstract_syntax, transfer_syntax;
 197
 198         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|O:alter_context",
 199                 discard_const_p(char *, kwnames), &py_abstract_syntax,
 200                 &py_transfer_syntax)) {
 201                 return NULL;
 202         }
 203
 204         if (!ndr_syntax_from_py_object(py_abstract_syntax, &abstract_syntax))
 205                 return NULL;
 206
 207         if (py_transfer_syntax == Py_None) {
 208                 transfer_syntax = ndr_transfer_syntax;
 209         } else {
 210                 if (!ndr_syntax_from_py_object(py_transfer_syntax,
 211                                                &transfer_syntax))
 212                         return NULL;
 213         }
 214
 215         status = dcerpc_alter_context(iface->pipe, iface->pipe, &abstract_syntax,
 216                                       &transfer_syntax);
 217
 218         if (!NT_STATUS_IS_OK(status)) {
 219                 PyErr_SetDCERPCStatus(iface->pipe, status);
 220                 return NULL;
 221         }
 222
 223         Py_RETURN_NONE;
 224 }
 225
 226 static PyMethodDef dcerpc_interface_methods[] = {
 227         { "request", (PyCFunction)py_iface_request, METH_VARARGS|METH_KEYWORDS, "S.request(opnum, data, object=None) -> data\nMake a raw request" },
 228         { "alter_context", (PyCFunction)py_iface_alter_context, METH_VARARGS|METH_KEYWORDS, "S.alter_context(syntax)\nChange to a different interface" },
 229         { NULL, NULL, 0, NULL },
 230 };
 231
 232 static void dcerpc_interface_dealloc(PyObject* self)
 233 {
 234         dcerpc_InterfaceObject *interface = (dcerpc_InterfaceObject *)self;
 235         talloc_free(interface->mem_ctx);
 236         self->ob_type->tp_free(self);
 237 }
 238
 239 static PyObject *dcerpc_interface_new(PyTypeObject *type, PyObject *args, PyObject *kwargs)
 240 {
 241         dcerpc_InterfaceObject *ret;
 242         const char *binding_string;
 243         struct cli_credentials *credentials;
 244         struct loadparm_context *lp_ctx = NULL;
 245         PyObject *py_lp_ctx = Py_None, *py_credentials = Py_None;
 246         TALLOC_CTX *mem_ctx;
 247         struct tevent_context *event_ctx;
 248         NTSTATUS status;
 249
 250         PyObject *syntax, *py_basis = Py_None;
 251         const char *kwnames[] = {
 252                 "binding", "syntax", "lp_ctx", "credentials", "basis_connection", NULL
 253         };
 254         struct ndr_interface_table *table;
 255
 256         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "sO|OOO:connect", discard_const_p(char *, kwnames), &binding_string, &syntax, &py_lp_ctx, &py_credentials, &py_basis)) {
 257                 return NULL;
 258         }
 259
 260         mem_ctx = talloc_new(NULL);
 261         if (mem_ctx == NULL) {
 262                 PyErr_NoMemory();
 263                 return NULL;
 264         }
 265
 266         lp_ctx = lpcfg_from_py_object(mem_ctx, py_lp_ctx);
 267         if (lp_ctx == NULL) {
 268                 PyErr_SetString(PyExc_TypeError, "Expected loadparm context");
 269                 talloc_free(mem_ctx);
 270                 return NULL;
 271         }
 272
 273         credentials = cli_credentials_from_py_object(py_credentials);
 274         if (credentials == NULL) {
 275                 PyErr_SetString(PyExc_TypeError, "Expected credentials");
 276                 talloc_free(mem_ctx);
 277                 return NULL;
 278         }
 279         ret = PyObject_New(dcerpc_InterfaceObject, type);
 280         ret->mem_ctx = mem_ctx;
 281
 282         event_ctx = s4_event_context_init(ret->mem_ctx);
 283
 284         /* Create a dummy interface table struct. TODO: In the future, we should
 285          * rather just allow connecting without requiring an interface table.
 286          */
 287
 288         table = talloc_zero(ret->mem_ctx, struct ndr_interface_table);
 289
 290         if (table == NULL) {
 291                 PyErr_SetString(PyExc_MemoryError, "Allocating interface table");
 292                 talloc_free(mem_ctx);
 293                 return NULL;
 294         }
 295
 296         if (!ndr_syntax_from_py_object(syntax, &table->syntax_id)) {
 297                 talloc_free(mem_ctx);
 298                 return NULL;
 299         }
 300
 301         ret->pipe = NULL;
 302         ret->binding_handle = NULL;
 303
 304         if (py_basis != Py_None) {
 305                 struct dcerpc_pipe *base_pipe;
 306
 307                 if (!PyObject_TypeCheck(py_basis, &dcerpc_InterfaceType)) {
 308                         PyErr_SetString(PyExc_ValueError, "basis_connection must be a DCE/RPC connection");
 309                         talloc_free(mem_ctx);
 310                         return NULL;
 311                 }
 312
 313                 base_pipe = talloc_reference(ret->mem_ctx,
 314                                          ((dcerpc_InterfaceObject *)py_basis)->pipe);
 315
 316                 status = dcerpc_secondary_context(base_pipe, &ret->pipe, table);
 317
 318                 ret->pipe = talloc_steal(ret->mem_ctx, ret->pipe);
 319         } else {
 320                 status = dcerpc_pipe_connect(ret->mem_ctx, &ret->pipe, binding_string,
 321                              table, credentials, event_ctx, lp_ctx);
 322         }
 323
 324         if (!NT_STATUS_IS_OK(status)) {
 325                 PyErr_SetDCERPCStatus(ret->pipe, status);
 326                 talloc_free(ret->mem_ctx);
 327                 return NULL;
 328         }
 329         ret->pipe->conn->flags |= DCERPC_NDR_REF_ALLOC;
 330         ret->binding_handle = ret->pipe->binding_handle;
 331         return (PyObject *)ret;
 332 }
 333
 334 static PyTypeObject dcerpc_InterfaceType = {
 335         PyObject_HEAD_INIT(NULL) 0,
 336         .tp_name = "dcerpc.ClientConnection",
 337         .tp_basicsize = sizeof(dcerpc_InterfaceObject),
 338         .tp_dealloc = dcerpc_interface_dealloc,
 339         .tp_getset = dcerpc_interface_getsetters,
 340         .tp_members = dcerpc_interface_members,
 341         .tp_methods = dcerpc_interface_methods,
 342         .tp_doc = "ClientConnection(binding, syntax, lp_ctx=None, credentials=None) -> connection\n"
 343 "\n"
 344 "binding should be a DCE/RPC binding string (for example: ncacn_ip_tcp:127.0.0.1)\n"
 345 "syntax should be a tuple with a GUID and version number of an interface\n"
 346 "lp_ctx should be a path to a smb.conf file or a param.LoadParm object\n"
 347 "credentials should be a credentials.Credentials object.\n\n",
 348         .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
 349         .tp_new = dcerpc_interface_new,
 350 };
 351
 352 void initbase(void)
 353 {
 354         PyObject *m;
 355
 356         if (PyType_Ready(&dcerpc_InterfaceType) < 0)
 357                 return;
 358
 359         m = Py_InitModule3("base", NULL, "DCE/RPC protocol implementation");
 360         if (m == NULL)
 361                 return;
 362
 363         Py_INCREF((PyObject *)&dcerpc_InterfaceType);
 364         PyModule_AddObject(m, "ClientConnection", (PyObject *)&dcerpc_InterfaceType);
 365 }