python/pyglue.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
   4    Copyright (C) Matthias Dieter Wallnöfer          2009
   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 "python/py3compat.h"
  22 #include "includes.h"
  23 #include "version.h"
  24 #include "param/pyparam.h"
  25 #include "lib/socket/netif.h"
  26 #include "lib/util/debug.h"
  27
  28 void init_glue(void);
  29 static PyObject *PyExc_NTSTATUSError;
  30 static PyObject *PyExc_WERRORError;
  31 static PyObject *PyExc_HRESULTError;
  32 static PyObject *PyExc_DsExtendedError;
  33
  34 static PyObject *py_generate_random_str(PyObject *self, PyObject *args)
  35 {
  36         int len;
  37         PyObject *ret;
  38         char *retstr;
  39         if (!PyArg_ParseTuple(args, "i", &len))
  40                 return NULL;
  41
  42         retstr = generate_random_str(NULL, len);
  43         ret = PyStr_FromString(retstr);
  44         talloc_free(retstr);
  45         return ret;
  46 }
  47
  48 static PyObject *py_generate_random_password(PyObject *self, PyObject *args)
  49 {
  50         int min, max;
  51         PyObject *ret;
  52         char *retstr;
  53         if (!PyArg_ParseTuple(args, "ii", &min, &max))
  54                 return NULL;
  55
  56         retstr = generate_random_password(NULL, min, max);
  57         if (retstr == NULL) {
  58                 return NULL;
  59         }
  60         ret = PyStr_FromString(retstr);
  61         talloc_free(retstr);
  62         return ret;
  63 }
  64
  65 static PyObject *py_generate_random_machine_password(PyObject *self, PyObject *args)
  66 {
  67         int min, max;
  68         PyObject *ret;
  69         char *retstr;
  70         if (!PyArg_ParseTuple(args, "ii", &min, &max))
  71                 return NULL;
  72
  73         retstr = generate_random_machine_password(NULL, min, max);
  74         if (retstr == NULL) {
  75                 return NULL;
  76         }
  77         ret = PyUnicode_FromString(retstr);
  78         talloc_free(retstr);
  79         return ret;
  80 }
  81
  82 static PyObject *py_check_password_quality(PyObject *self, PyObject *args)
  83 {
  84         char *pass;
  85
  86         if (!PyArg_ParseTuple(args, "s", &pass)) {
  87                 return NULL;
  88         }
  89
  90         return PyBool_FromLong(check_password_quality(pass));
  91 }
  92
  93 static PyObject *py_generate_random_bytes(PyObject *self, PyObject *args)
  94 {
  95         int len;
  96         PyObject *ret;
  97         uint8_t *bytes = NULL;
  98
  99         if (!PyArg_ParseTuple(args, "i", &len))
 100                 return NULL;
 101
 102         bytes = talloc_zero_size(NULL, len);
 103         generate_random_buffer(bytes, len);
 104         ret = PyBytes_FromStringAndSize((const char *)bytes, len);
 105         talloc_free(bytes);
 106         return ret;
 107 }
 108
 109 static PyObject *py_unix2nttime(PyObject *self, PyObject *args)
 110 {
 111         time_t t;
 112         unsigned int _t;
 113         NTTIME nt;
 114
 115         if (!PyArg_ParseTuple(args, "I", &_t)) {
 116                 return NULL;
 117         }
 118         t = _t;
 119
 120         unix_to_nt_time(&nt, t);
 121
 122         return PyLong_FromLongLong((uint64_t)nt);
 123 }
 124
 125 static PyObject *py_nttime2unix(PyObject *self, PyObject *args)
 126 {
 127         time_t t;
 128         NTTIME nt;
 129         if (!PyArg_ParseTuple(args, "K", &nt))
 130                 return NULL;
 131
 132         t = nt_time_to_unix(nt);
 133
 134         return PyInt_FromLong((uint64_t)t);
 135 }
 136
 137 static PyObject *py_nttime2string(PyObject *self, PyObject *args)
 138 {
 139         PyObject *ret;
 140         NTTIME nt;
 141         TALLOC_CTX *tmp_ctx;
 142         const char *string;
 143         if (!PyArg_ParseTuple(args, "K", &nt))
 144                 return NULL;
 145
 146         tmp_ctx = talloc_new(NULL);
 147         if (tmp_ctx == NULL) {
 148                 PyErr_NoMemory();
 149                 return NULL;
 150         }
 151
 152         string = nt_time_string(tmp_ctx, nt);
 153         ret =  PyStr_FromString(string);
 154
 155         talloc_free(tmp_ctx);
 156
 157         return ret;
 158 }
 159
 160 static PyObject *py_set_debug_level(PyObject *self, PyObject *args)
 161 {
 162         unsigned level;
 163         if (!PyArg_ParseTuple(args, "I", &level))
 164                 return NULL;
 165         debuglevel_set(level);
 166         Py_RETURN_NONE;
 167 }
 168
 169 static PyObject *py_get_debug_level(PyObject *self,
 170                 PyObject *Py_UNUSED(ignored))
 171 {
 172         return PyInt_FromLong(debuglevel_get());
 173 }
 174
 175 static PyObject *py_fault_setup(PyObject *self,
 176                 PyObject *Py_UNUSED(ignored))
 177 {
 178         static bool done;
 179         if (!done) {
 180                 fault_setup();
 181                 done = true;
 182         }
 183         Py_RETURN_NONE;
 184 }
 185
 186 static PyObject *py_is_ntvfs_fileserver_built(PyObject *self,
 187                 PyObject *Py_UNUSED(ignored))
 188 {
 189 #ifdef WITH_NTVFS_FILESERVER
 190         Py_RETURN_TRUE;
 191 #else
 192         Py_RETURN_FALSE;
 193 #endif
 194 }
 195
 196 static PyObject *py_is_heimdal_built(PyObject *self,
 197                 PyObject *Py_UNUSED(ignored))
 198 {
 199 #ifdef SAMBA4_USES_HEIMDAL
 200         Py_RETURN_TRUE;
 201 #else
 202         Py_RETURN_FALSE;
 203 #endif
 204 }
 205
 206 /*
 207   return the list of interface IPs we have configured
 208   takes an loadparm context, returns a list of IPs in string form
 209
 210   Does not return addresses on 127.0.0.0/8
 211  */
 212 static PyObject *py_interface_ips(PyObject *self, PyObject *args)
 213 {
 214         PyObject *pylist;
 215         int count;
 216         TALLOC_CTX *tmp_ctx;
 217         PyObject *py_lp_ctx;
 218         struct loadparm_context *lp_ctx;
 219         struct interface *ifaces;
 220         int i, ifcount;
 221         int all_interfaces = 1;
 222
 223         if (!PyArg_ParseTuple(args, "O|i", &py_lp_ctx, &all_interfaces))
 224                 return NULL;
 225
 226         tmp_ctx = talloc_new(NULL);
 227         if (tmp_ctx == NULL) {
 228                 PyErr_NoMemory();
 229                 return NULL;
 230         }
 231
 232         lp_ctx = lpcfg_from_py_object(tmp_ctx, py_lp_ctx);
 233         if (lp_ctx == NULL) {
 234                 talloc_free(tmp_ctx);
 235                 return NULL;
 236         }
 237
 238         load_interface_list(tmp_ctx, lp_ctx, &ifaces);
 239
 240         count = iface_list_count(ifaces);
 241
 242         /* first count how many are not loopback addresses */
 243         for (ifcount = i = 0; i<count; i++) {
 244                 const char *ip = iface_list_n_ip(ifaces, i);
 245
 246                 if (all_interfaces) {
 247                         ifcount++;
 248                         continue;
 249                 }
 250
 251                 if (iface_list_same_net(ip, "127.0.0.1", "255.0.0.0")) {
 252                         continue;
 253                 }
 254
 255                 if (iface_list_same_net(ip, "169.254.0.0", "255.255.0.0")) {
 256                         continue;
 257                 }
 258
 259                 if (iface_list_same_net(ip, "::1", "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")) {
 260                         continue;
 261                 }
 262
 263                 if (iface_list_same_net(ip, "fe80::", "ffff:ffff:ffff:ffff::")) {
 264                         continue;
 265                 }
 266
 267                 ifcount++;
 268         }
 269
 270         pylist = PyList_New(ifcount);
 271         for (ifcount = i = 0; i<count; i++) {
 272                 const char *ip = iface_list_n_ip(ifaces, i);
 273
 274                 if (all_interfaces) {
 275                         PyList_SetItem(pylist, ifcount, PyStr_FromString(ip));
 276                         ifcount++;
 277                         continue;
 278                 }
 279
 280                 if (iface_list_same_net(ip, "127.0.0.1", "255.0.0.0")) {
 281                         continue;
 282                 }
 283
 284                 if (iface_list_same_net(ip, "169.254.0.0", "255.255.0.0")) {
 285                         continue;
 286                 }
 287
 288                 if (iface_list_same_net(ip, "::1", "ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff")) {
 289                         continue;
 290                 }
 291
 292                 if (iface_list_same_net(ip, "fe80::", "ffff:ffff:ffff:ffff::")) {
 293                         continue;
 294                 }
 295
 296                 PyList_SetItem(pylist, ifcount, PyStr_FromString(ip));
 297                 ifcount++;
 298         }
 299         talloc_free(tmp_ctx);
 300         return pylist;
 301 }
 302
 303 static PyObject *py_strcasecmp_m(PyObject *self, PyObject *args)
 304 {
 305         const char *s1 = NULL;
 306         const char *s2 = NULL;
 307         long cmp_result = 0;
 308         if (!PyArg_ParseTuple(args, PYARG_STR_UNI
 309                               PYARG_STR_UNI,
 310                               "utf8", &s1, "utf8", &s2)) {
 311                 return NULL;
 312         }
 313
 314         cmp_result = strcasecmp_m(s1, s2);
 315         PyMem_Free(discard_const_p(char, s1));
 316         PyMem_Free(discard_const_p(char, s2));
 317         return PyInt_FromLong(cmp_result);
 318 }
 319
 320 static PyObject *py_strstr_m(PyObject *self, PyObject *args)
 321 {
 322         const char *s1 = NULL;
 323         const char *s2 = NULL;
 324         char *strstr_ret = NULL;
 325         PyObject *result = NULL;
 326         if (!PyArg_ParseTuple(args, PYARG_STR_UNI
 327                               PYARG_STR_UNI,
 328                               "utf8", &s1, "utf8", &s2))
 329                 return NULL;
 330
 331         strstr_ret = strstr_m(s1, s2);
 332         if (!strstr_ret) {
 333                 PyMem_Free(discard_const_p(char, s1));
 334                 PyMem_Free(discard_const_p(char, s2));
 335                 Py_RETURN_NONE;
 336         }
 337         result = PyUnicode_FromString(strstr_ret);
 338         PyMem_Free(discard_const_p(char, s1));
 339         PyMem_Free(discard_const_p(char, s2));
 340         return result;
 341 }
 342
 343 static PyMethodDef py_misc_methods[] = {
 344         { "generate_random_str", (PyCFunction)py_generate_random_str, METH_VARARGS,
 345                 "generate_random_str(len) -> string\n"
 346                 "Generate random string with specified length." },
 347         { "generate_random_password", (PyCFunction)py_generate_random_password,
 348                 METH_VARARGS, "generate_random_password(min, max) -> string\n"
 349                 "Generate random password (based on printable ascii characters) "
 350                 "with a length >= min and <= max." },
 351         { "generate_random_machine_password", (PyCFunction)py_generate_random_machine_password,
 352                 METH_VARARGS, "generate_random_machine_password(min, max) -> string\n"
 353                 "Generate random password "
 354                 "(based on random utf16 characters converted to utf8 or "
 355                 "random ascii characters if 'unix charset' is not 'utf8')"
 356                 "with a length >= min (at least 14) and <= max (at most 255)." },
 357         { "check_password_quality", (PyCFunction)py_check_password_quality,
 358                 METH_VARARGS, "check_password_quality(pass) -> bool\n"
 359                 "Check password quality against Samba's check_password_quality,"
 360                 "the implementation of Microsoft's rules:"
 361                 "http://msdn.microsoft.com/en-us/subscriptions/cc786468%28v=ws.10%29.aspx"
 362         },
 363         { "unix2nttime", (PyCFunction)py_unix2nttime, METH_VARARGS,
 364                 "unix2nttime(timestamp) -> nttime" },
 365         { "nttime2unix", (PyCFunction)py_nttime2unix, METH_VARARGS,
 366                 "nttime2unix(nttime) -> timestamp" },
 367         { "nttime2string", (PyCFunction)py_nttime2string, METH_VARARGS,
 368                 "nttime2string(nttime) -> string" },
 369         { "set_debug_level", (PyCFunction)py_set_debug_level, METH_VARARGS,
 370                 "set debug level" },
 371         { "get_debug_level", (PyCFunction)py_get_debug_level, METH_NOARGS,
 372                 "get debug level" },
 373         { "fault_setup", (PyCFunction)py_fault_setup, METH_NOARGS,
 374                 "setup the default samba panic handler" },
 375         { "interface_ips", (PyCFunction)py_interface_ips, METH_VARARGS,
 376                 "interface_ips(lp_ctx[, all_interfaces) -> list_of_ifaces\n"
 377                 "\n"
 378                 "get interface IP address list"},
 379         { "strcasecmp_m", (PyCFunction)py_strcasecmp_m, METH_VARARGS,
 380                 "(for testing) compare two strings using Samba's strcasecmp_m()"},
 381         { "strstr_m", (PyCFunction)py_strstr_m, METH_VARARGS,
 382                 "(for testing) find one string in another with Samba's strstr_m()"},
 383         { "is_ntvfs_fileserver_built", (PyCFunction)py_is_ntvfs_fileserver_built, METH_NOARGS,
 384                 "is the NTVFS file server built in this installation?" },
 385         { "is_heimdal_built", (PyCFunction)py_is_heimdal_built, METH_NOARGS,
 386                 "is Samba built with Heimdal Kerberbos?" },
 387         { "generate_random_bytes",
 388                 (PyCFunction)py_generate_random_bytes,
 389                 METH_VARARGS,
 390                 "generate_random_bytes(len) -> bytes\n"
 391                 "Generate random bytes with specified length." },
 392         { NULL }
 393 };
 394
 395 static struct PyModuleDef moduledef = {
 396     PyModuleDef_HEAD_INIT,
 397     .m_name = "_glue",
 398     .m_doc = "Python bindings for miscellaneous Samba functions.",
 399     .m_size = -1,
 400     .m_methods = py_misc_methods,
 401 };
 402
 403 MODULE_INIT_FUNC(_glue)
 404 {
 405         PyObject *m;
 406
 407         debug_setup_talloc_log();
 408
 409         m = PyModule_Create(&moduledef);
 410         if (m == NULL)
 411                 return NULL;
 412
 413         PyModule_AddObject(m, "version",
 414                                            PyStr_FromString(SAMBA_VERSION_STRING));
 415         PyExc_NTSTATUSError = PyErr_NewException(discard_const_p(char, "samba.NTSTATUSError"), PyExc_RuntimeError, NULL);
 416         if (PyExc_NTSTATUSError != NULL) {
 417                 Py_INCREF(PyExc_NTSTATUSError);
 418                 PyModule_AddObject(m, "NTSTATUSError", PyExc_NTSTATUSError);
 419         }
 420
 421         PyExc_WERRORError = PyErr_NewException(discard_const_p(char, "samba.WERRORError"), PyExc_RuntimeError, NULL);
 422         if (PyExc_WERRORError != NULL) {
 423                 Py_INCREF(PyExc_WERRORError);
 424                 PyModule_AddObject(m, "WERRORError", PyExc_WERRORError);
 425         }
 426
 427         PyExc_HRESULTError = PyErr_NewException(discard_const_p(char, "samba.HRESULTError"), PyExc_RuntimeError, NULL);
 428         if (PyExc_HRESULTError != NULL) {
 429                 Py_INCREF(PyExc_HRESULTError);
 430                 PyModule_AddObject(m, "HRESULTError", PyExc_HRESULTError);
 431         }
 432
 433         PyExc_DsExtendedError = PyErr_NewException(discard_const_p(char, "samba.DsExtendedError"), PyExc_RuntimeError, NULL);
 434         if (PyExc_DsExtendedError != NULL) {
 435                 Py_INCREF(PyExc_DsExtendedError);
 436                 PyModule_AddObject(m, "DsExtendedError", PyExc_DsExtendedError);
 437         }
 438
 439         return m;
 440 }
 441