libcli/nbt/pynbt.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright © 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 "python/py3compat.h"
  23 #include "libcli/util/pyerrors.h"
  24 #include "python/modules.h"
  25 #include "../libcli/nbt/libnbt.h"
  26 #include "lib/events/events.h"
  27
  28 void initnetbios(void);
  29
  30 extern PyTypeObject nbt_node_Type;
  31
  32 typedef struct {
  33         PyObject_HEAD
  34         TALLOC_CTX *mem_ctx;
  35         struct nbt_name_socket *socket;
  36 } nbt_node_Object;
  37
  38 static void py_nbt_node_dealloc(nbt_node_Object *self)
  39 {
  40         talloc_free(self->mem_ctx);
  41         Py_TYPE(self)->tp_free(self);
  42 }
  43
  44 static PyObject *py_nbt_node_init(PyTypeObject *self, PyObject *args, PyObject *kwargs)
  45 {
  46         struct tevent_context *ev;
  47         nbt_node_Object *ret = PyObject_New(nbt_node_Object, &nbt_node_Type);
  48
  49         ret->mem_ctx = talloc_new(NULL);
  50         if (ret->mem_ctx == NULL)
  51                 return NULL;
  52
  53         ev = s4_event_context_init(ret->mem_ctx);
  54         ret->socket = nbt_name_socket_init(ret->mem_ctx, ev);
  55         return (PyObject *)ret;
  56 }
  57
  58 static bool PyObject_AsDestinationTuple(PyObject *obj, const char **dest_addr, uint16_t *dest_port)
  59 {
  60         if (PyStr_Check(obj) || PyUnicode_Check(obj)) {
  61                 *dest_addr = PyStr_AsString(obj);
  62                 *dest_port = NBT_NAME_SERVICE_PORT;
  63                 return true;
  64         }
  65
  66         if (PyTuple_Check(obj)) {
  67                 if (PyTuple_Size(obj) < 1) {
  68                         PyErr_SetString(PyExc_TypeError, "Destination tuple size invalid");
  69                         return false;
  70                 }
  71
  72                 if (!(PyStr_Check(PyTuple_GetItem(obj, 0)) || PyUnicode_Check(PyTuple_GetItem(obj, 0)))) {
  73                         PyErr_SetString(PyExc_TypeError, "Destination tuple first element not string");
  74                         return false;
  75                 }
  76
  77                 *dest_addr = PyStr_AsString(obj);
  78
  79                 if (PyTuple_Size(obj) == 1) {
  80                         *dest_port = NBT_NAME_SERVICE_PORT;
  81                         return true;
  82                 } else if (PyInt_Check(PyTuple_GetItem(obj, 1))) {
  83                         *dest_port = PyInt_AsLong(PyTuple_GetItem(obj, 1));
  84                         return true;
  85                 } else {
  86                         PyErr_SetString(PyExc_TypeError, "Destination tuple second element not a port");
  87                         return false;
  88                 }
  89         }
  90
  91         PyErr_SetString(PyExc_TypeError, "Destination tuple second element not a port");
  92         return false;
  93 }
  94
  95 static bool PyObject_AsNBTName(PyObject *obj, struct nbt_name_socket *name_socket, struct nbt_name *name)
  96 {
  97         if (PyTuple_Check(obj)) {
  98                 if (PyTuple_Size(obj) == 2) {
  99                         name->name = PyStr_AsString(PyTuple_GetItem(obj, 0));
 100                         if (name->name == NULL) {
 101                                 goto err;
 102                         }
 103                         name->type = PyInt_AsLong(PyTuple_GetItem(obj, 1));
 104                         if (name->type == -1 && PyErr_Occurred()) {
 105                                 goto err;
 106                         }
 107                         name->scope = NULL;
 108                         return true;
 109                 } else if (PyTuple_Size(obj) == 3) {
 110                         name->name = PyStr_AsString(PyTuple_GetItem(obj, 0));
 111                         if (name->name == NULL) {
 112                                 goto err;
 113                         }
 114                         name->scope = PyStr_AsString(PyTuple_GetItem(obj, 1));
 115                         if (name->scope == NULL) {
 116                                 goto err;
 117                         }
 118                         name->type = PyInt_AsLong(PyTuple_GetItem(obj, 2));
 119                         if (name->type == -1 && PyErr_Occurred()) {
 120                                 goto err;
 121                         }
 122                         return true;
 123                 } else {
 124                         PyErr_SetString(PyExc_TypeError, "Invalid tuple size");
 125                         return false;
 126                 }
 127         }
 128
 129         if (PyStr_Check(obj) || PyUnicode_Check(obj)) {
 130                 /* FIXME: Parse string to be able to interpret things like RHONWYN<02> ? */
 131                 name->name = PyStr_AsString(obj);
 132                 if (name->name == NULL) {
 133                         goto err;
 134                 }
 135                 name->scope = NULL;
 136                 name->type = 0;
 137                 return true;
 138         }
 139 err:
 140         PyErr_SetString(PyExc_TypeError, "Invalid type for object");
 141         return false;
 142 }
 143
 144 static PyObject *PyObject_FromNBTName(struct nbt_name_socket *name_socket,
 145                                       struct nbt_name *name)
 146 {
 147         if (name->scope) {
 148                 return Py_BuildValue("(ssi)", name->name, name->scope, name->type);
 149         } else {
 150                 return Py_BuildValue("(si)", name->name, name->type);
 151         }
 152 }
 153
 154 static PyObject *py_nbt_name_query(PyObject *self, PyObject *args, PyObject *kwargs)
 155 {
 156         nbt_node_Object *node = (nbt_node_Object *)self;
 157         PyObject *ret, *reply_addrs, *py_dest, *py_name;
 158         struct nbt_name_query io;
 159         NTSTATUS status;
 160         int i;
 161
 162         const char *kwnames[] = { "name", "dest", "broadcast", "wins", "timeout",
 163                                   "retries", NULL };
 164         io.in.broadcast = true;
 165         io.in.wins_lookup = false;
 166         io.in.timeout = 0;
 167         io.in.retries = 3;
 168
 169         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|bbii:query_name",
 170                                          discard_const_p(char *, kwnames),
 171                                          &py_name, &py_dest,
 172                                          &io.in.broadcast, &io.in.wins_lookup,
 173                                          &io.in.timeout, &io.in.retries)) {
 174                 return NULL;
 175         }
 176
 177         if (!PyObject_AsDestinationTuple(py_dest, &io.in.dest_addr, &io.in.dest_port))
 178                 return NULL;
 179
 180         if (!PyObject_AsNBTName(py_name, node->socket, &io.in.name))
 181                 return NULL;
 182
 183         status = nbt_name_query(node->socket, NULL, &io);
 184
 185         if (NT_STATUS_IS_ERR(status)) {
 186                 PyErr_SetNTSTATUS(status);
 187                 return NULL;
 188         }
 189
 190         ret = PyTuple_New(3);
 191         if (ret == NULL)
 192                 return NULL;
 193         PyTuple_SetItem(ret, 0, PyStr_FromString(io.out.reply_from));
 194
 195         py_name = PyObject_FromNBTName(node->socket, &io.out.name);
 196         if (py_name == NULL)
 197                 return NULL;
 198
 199         PyTuple_SetItem(ret, 1, py_name);
 200
 201         reply_addrs = PyList_New(io.out.num_addrs);
 202         if (reply_addrs == NULL) {
 203                 Py_DECREF(ret);
 204                 return NULL;
 205         }
 206
 207         for (i = 0; i < io.out.num_addrs; i++) {
 208                 PyList_SetItem(reply_addrs, i, PyStr_FromString(io.out.reply_addrs[i]));
 209         }
 210
 211         PyTuple_SetItem(ret, 2, reply_addrs);
 212         return ret;
 213 }
 214
 215 static PyObject *py_nbt_name_status(PyObject *self, PyObject *args, PyObject *kwargs)
 216 {
 217         nbt_node_Object *node = (nbt_node_Object *)self;
 218         PyObject *ret, *py_dest, *py_name, *py_names;
 219         struct nbt_name_status io;
 220         int i;
 221         NTSTATUS status;
 222
 223         const char *kwnames[] = { "name", "dest", "timeout", "retries", NULL };
 224
 225         io.in.timeout = 0;
 226         io.in.retries = 0;
 227
 228         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO|ii:name_status",
 229                                          discard_const_p(char *, kwnames),
 230                                          &py_name, &py_dest,
 231                                          &io.in.timeout, &io.in.retries)) {
 232                 return NULL;
 233         }
 234
 235         if (!PyObject_AsDestinationTuple(py_dest, &io.in.dest_addr, &io.in.dest_port))
 236                 return NULL;
 237
 238         if (!PyObject_AsNBTName(py_name, node->socket, &io.in.name))
 239                 return NULL;
 240
 241         status = nbt_name_status(node->socket, NULL, &io);
 242
 243         if (NT_STATUS_IS_ERR(status)) {
 244                 PyErr_SetNTSTATUS(status);
 245                 return NULL;
 246         }
 247
 248         ret = PyTuple_New(3);
 249         if (ret == NULL)
 250                 return NULL;
 251         PyTuple_SetItem(ret, 0, PyStr_FromString(io.out.reply_from));
 252
 253         py_name = PyObject_FromNBTName(node->socket, &io.out.name);
 254         if (py_name == NULL)
 255                 return NULL;
 256
 257         PyTuple_SetItem(ret, 1, py_name);
 258
 259         py_names = PyList_New(io.out.status.num_names);
 260
 261         for (i = 0; i < io.out.status.num_names; i++) {
 262                 PyList_SetItem(py_names, i, Py_BuildValue("(sii)",
 263                                 io.out.status.names[i].name,
 264                                 io.out.status.names[i].nb_flags,
 265                                 io.out.status.names[i].type));
 266         }
 267
 268         PyTuple_SetItem(ret, 2, py_names);
 269
 270         return ret;
 271 }
 272
 273 static PyObject *py_nbt_name_register(PyObject *self, PyObject *args, PyObject *kwargs)
 274 {
 275         nbt_node_Object *node = (nbt_node_Object *)self;
 276         PyObject *ret, *py_dest, *py_name;
 277         struct nbt_name_register io;
 278         NTSTATUS status;
 279
 280         const char *kwnames[] = { "name", "address", "dest", "register_demand", "broadcast",
 281                                   "multi_homed", "ttl", "timeout", "retries", NULL };
 282
 283         io.in.broadcast = true;
 284         io.in.multi_homed = true;
 285         io.in.register_demand = true;
 286         io.in.ttl = 0;
 287         io.in.timeout = 0;
 288         io.in.retries = 0;
 289
 290         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OsO|bbbiii:query_name",
 291                                          discard_const_p(char *, kwnames),
 292                                          &py_name, &io.in.address, &py_dest,
 293                                          &io.in.register_demand,
 294                                          &io.in.broadcast, &io.in.multi_homed,
 295                                          &io.in.ttl, &io.in.timeout, &io.in.retries)) {
 296                 return NULL;
 297         }
 298
 299         if (!PyObject_AsDestinationTuple(py_dest, &io.in.dest_addr, &io.in.dest_port))
 300                 return NULL;
 301
 302         if (!PyObject_AsNBTName(py_name, node->socket, &io.in.name))
 303                 return NULL;
 304
 305         status = nbt_name_register(node->socket, NULL, &io);
 306
 307         if (NT_STATUS_IS_ERR(status)) {
 308                 PyErr_SetNTSTATUS(status);
 309                 return NULL;
 310         }
 311
 312         ret = PyTuple_New(4);
 313         if (ret == NULL)
 314                 return NULL;
 315         PyTuple_SetItem(ret, 0, PyStr_FromString(io.out.reply_from));
 316
 317         py_name = PyObject_FromNBTName(node->socket, &io.out.name);
 318         if (py_name == NULL)
 319                 return NULL;
 320
 321         PyTuple_SetItem(ret, 1, py_name);
 322
 323         PyTuple_SetItem(ret, 2, PyStr_FromString(io.out.reply_addr));
 324
 325         PyTuple_SetItem(ret, 3, PyInt_FromLong(io.out.rcode));
 326
 327         return ret;
 328 }
 329
 330 static PyObject *py_nbt_name_refresh(PyObject *self, PyObject *args, PyObject *kwargs)
 331 {
 332         nbt_node_Object *node = (nbt_node_Object *)self;
 333         PyObject *ret, *py_dest, *py_name;
 334         struct nbt_name_refresh io;
 335         NTSTATUS status;
 336
 337         const char *kwnames[] = { "name", "address", "dest", "nb_flags", "broadcast",
 338                                   "ttl", "timeout", "retries", NULL };
 339
 340         io.in.broadcast = true;
 341         io.in.nb_flags = 0;
 342         io.in.ttl = 0;
 343         io.in.timeout = 0;
 344         io.in.retries = 0;
 345
 346         if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OsO|ibiii:query_name",
 347                                          discard_const_p(char *, kwnames),
 348                                          &py_name, &io.in.address, &py_dest,
 349                                          &io.in.nb_flags,
 350                                          &io.in.broadcast,
 351                                          &io.in.ttl, &io.in.timeout, &io.in.retries)) {
 352                 return NULL;
 353         }
 354
 355         if (!PyObject_AsDestinationTuple(py_dest, &io.in.dest_addr, &io.in.dest_port))
 356                 return NULL;
 357
 358         if (!PyObject_AsNBTName(py_name, node->socket, &io.in.name))
 359                 return NULL;
 360
 361         status = nbt_name_refresh(node->socket, NULL, &io);
 362
 363         if (NT_STATUS_IS_ERR(status)) {
 364                 PyErr_SetNTSTATUS(status);
 365                 return NULL;
 366         }
 367
 368         ret = PyTuple_New(3);
 369         if (ret == NULL)
 370                 return NULL;
 371         PyTuple_SetItem(ret, 0, PyStr_FromString(io.out.reply_from));
 372
 373         py_name = PyObject_FromNBTName(node->socket, &io.out.name);
 374         if (py_name == NULL)
 375                 return NULL;
 376
 377         PyTuple_SetItem(ret, 1, py_name);
 378
 379         PyTuple_SetItem(ret, 2, PyStr_FromString(io.out.reply_addr));
 380
 381         PyTuple_SetItem(ret, 3, PyInt_FromLong(io.out.rcode));
 382
 383         return ret;
 384 }
 385
 386 static PyObject *py_nbt_name_release(PyObject *self, PyObject *args, PyObject *kwargs)
 387 {
 388         Py_RETURN_NONE; /* FIXME */
 389 }
 390
 391 static PyMethodDef py_nbt_methods[] = {
 392         { "query_name", PY_DISCARD_FUNC_SIG(PyCFunction, py_nbt_name_query),
 393                 METH_VARARGS|METH_KEYWORDS,
 394                 "S.query_name(name, dest, broadcast=True, wins=False, timeout=0, retries=3) -> (reply_from, name, reply_addr)\n"
 395                 "Query for a NetBIOS name" },
 396         { "register_name", PY_DISCARD_FUNC_SIG(PyCFunction,
 397                                                py_nbt_name_register),
 398                 METH_VARARGS|METH_KEYWORDS,
 399                 "S.register_name(name, address, dest, register_demand=True, broadcast=True, multi_homed=True, ttl=0, timeout=0, retries=0) -> (reply_from, name, reply_addr, rcode)\n"
 400                 "Register a new name" },
 401         { "release_name", PY_DISCARD_FUNC_SIG(PyCFunction, py_nbt_name_release),
 402                 METH_VARARGS|METH_KEYWORDS, "S.release_name(name, address, dest, nb_flags=0, broadcast=true, timeout=0, retries=3) -> (reply_from, name, reply_addr, rcode)\n"
 403                 "release a previously registered name" },
 404         { "refresh_name", PY_DISCARD_FUNC_SIG(PyCFunction, py_nbt_name_refresh),
 405                 METH_VARARGS|METH_KEYWORDS, "S.refresh_name(name, address, dest, nb_flags=0, broadcast=True, ttl=0, timeout=0, retries=0) -> (reply_from, name, reply_addr, rcode)\n"
 406                 "release a previously registered name" },
 407         { "name_status", PY_DISCARD_FUNC_SIG(PyCFunction, py_nbt_name_status),
 408                 METH_VARARGS|METH_KEYWORDS,
 409                 "S.name_status(name, dest, timeout=0, retries=0) -> (reply_from, name, status)\n"
 410                 "Find the status of a name" },
 411
 412         { NULL }
 413 };
 414
 415 PyTypeObject nbt_node_Type = {
 416         PyVarObject_HEAD_INIT(NULL, 0)
 417         .tp_name = "netbios.Node",
 418         .tp_basicsize = sizeof(nbt_node_Object),
 419         .tp_flags = Py_TPFLAGS_DEFAULT|Py_TPFLAGS_BASETYPE,
 420         .tp_new = py_nbt_node_init,
 421         .tp_dealloc = (destructor)py_nbt_node_dealloc,
 422         .tp_methods = py_nbt_methods,
 423         .tp_doc = "Node()\n"
 424                   "Create a new NetBIOS node\n"
 425 };
 426
 427 static struct PyModuleDef moduledef = {
 428     PyModuleDef_HEAD_INIT,
 429     .m_name = "netbios",
 430     .m_doc = "NetBIOS over TCP/IP support",
 431     .m_size = -1,
 432     .m_methods = NULL,
 433 };
 434
 435 MODULE_INIT_FUNC(netbios)
 436 {
 437         PyObject *mod = NULL;
 438         if (PyType_Ready(&nbt_node_Type) < 0)
 439                 return mod;
 440
 441         mod = PyModule_Create(&moduledef);
 442
 443
 444         Py_INCREF((PyObject *)&nbt_node_Type);
 445         PyModule_AddObject(mod, "Node", (PyObject *)&nbt_node_Type);
 446         return mod;
 447 }