source4/scripting/python/samba/__init__.py

   1 #!/usr/bin/env python
   2
   3 # Unix SMB/CIFS implementation.
   4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
   5 #
   6 # Based on the original in EJS:
   7 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
   8 #
   9 # This program is free software; you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # This program is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 #
  22
  23 """Samba 4."""
  24
  25 __docformat__ = "restructuredText"
  26
  27 import os
  28 import sys
  29
  30 def in_source_tree():
  31     """Check whether the script is being run from the source dir. """
  32     return os.path.exists("%s/../../../selftest/skip" % os.path.dirname(__file__))
  33
  34
  35 # When running, in-tree, make sure bin/python is in the PYTHONPATH
  36 if in_source_tree():
  37     srcdir = "%s/../../.." % os.path.dirname(__file__)
  38     sys.path.append("%s/bin/python" % srcdir)
  39     default_ldb_modules_dir = "%s/bin/modules/ldb" % srcdir
  40 else:
  41     default_ldb_modules_dir = None
  42
  43
  44 import ldb
  45 from samba._ldb import Ldb as _Ldb
  46
  47 class Ldb(_Ldb):
  48     """Simple Samba-specific LDB subclass that takes care
  49     of setting up the modules dir, credentials pointers, etc.
  50
  51     Please note that this is intended to be for all Samba LDB files,
  52     not necessarily the Sam database. For Sam-specific helper
  53     functions see samdb.py.
  54     """
  55
  56     def __init__(self, url=None, lp=None, modules_dir=None, session_info=None,
  57                  credentials=None, flags=0, options=None):
  58         """Opens a Samba Ldb file.
  59
  60         :param url: Optional LDB URL to open
  61         :param lp: Optional loadparm object
  62         :param modules_dir: Optional modules directory
  63         :param session_info: Optional session information
  64         :param credentials: Optional credentials, defaults to anonymous.
  65         :param flags: Optional LDB flags
  66         :param options: Additional options (optional)
  67
  68         This is different from a regular Ldb file in that the Samba-specific
  69         modules-dir is used by default and that credentials and session_info
  70         can be passed through (required by some modules).
  71         """
  72
  73         if modules_dir is not None:
  74             self.set_modules_dir(modules_dir)
  75         elif default_ldb_modules_dir is not None:
  76             self.set_modules_dir(default_ldb_modules_dir)
  77         elif lp is not None:
  78             self.set_modules_dir(os.path.join(lp.get("modules dir"), "ldb"))
  79
  80         if session_info is not None:
  81             self.set_session_info(session_info)
  82
  83         if credentials is not None:
  84             self.set_credentials(credentials)
  85
  86         if lp is not None:
  87             self.set_loadparm(lp)
  88
  89         # This must be done before we load the schema, as these handlers for
  90         # objectSid and objectGUID etc must take precedence over the 'binary
  91         # attribute' declaration in the schema
  92         self.register_samba_handlers()
  93
  94         # TODO set debug
  95         def msg(l, text):
  96             print text
  97         #self.set_debug(msg)
  98
  99         self.set_utf8_casefold()
 100
 101         # Allow admins to force non-sync ldb for all databases
 102         if lp is not None:
 103             nosync_p = lp.get("nosync", "ldb")
 104             if nosync_p is not None and nosync_p == True:
 105                 flags |= ldb.FLG_NOSYNC
 106
 107         self.set_create_perms(0600)
 108
 109         if url is not None:
 110             self.connect(url, flags, options)
 111
 112     def searchone(self, attribute, basedn=None, expression=None,
 113                   scope=ldb.SCOPE_BASE):
 114         """Search for one attribute as a string.
 115
 116         :param basedn: BaseDN for the search.
 117         :param attribute: Name of the attribute
 118         :param expression: Optional search expression.
 119         :param scope: Search scope (defaults to base).
 120         :return: Value of attribute as a string or None if it wasn't found.
 121         """
 122         res = self.search(basedn, scope, expression, [attribute])
 123         if len(res) != 1 or res[0][attribute] is None:
 124             return None
 125         values = set(res[0][attribute])
 126         assert len(values) == 1
 127         return self.schema_format_value(attribute, values.pop())
 128
 129     def erase_users_computers(self, dn):
 130         """Erases user and computer objects from our AD.
 131
 132         This is needed since the 'samldb' module denies the deletion of primary
 133         groups. Therefore all groups shouldn't be primary somewhere anymore.
 134         """
 135
 136         try:
 137             res = self.search(base=dn, scope=ldb.SCOPE_SUBTREE, attrs=[],
 138                       expression="(|(objectclass=user)(objectclass=computer))")
 139         except ldb.LdbError, (errno, _):
 140             if errno == ldb.ERR_NO_SUCH_OBJECT:
 141                 # Ignore no such object errors
 142                 return
 143             else:
 144                 raise
 145
 146         try:
 147             for msg in res:
 148                 self.delete(msg.dn, ["relax:0"])
 149         except ldb.LdbError, (errno, _):
 150             if errno != ldb.ERR_NO_SUCH_OBJECT:
 151                 # Ignore no such object errors
 152                 raise
 153
 154     def erase_except_schema_controlled(self):
 155         """Erase this ldb.
 156
 157         :note: Removes all records, except those that are controlled by
 158             Samba4's schema.
 159         """
 160
 161         basedn = ""
 162
 163         # Try to delete user/computer accounts to allow deletion of groups
 164         self.erase_users_computers(basedn)
 165
 166         # Delete the 'visible' records, and the invisble 'deleted' records (if this DB supports it)
 167         for msg in self.search(basedn, ldb.SCOPE_SUBTREE,
 168                        "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
 169                        [], controls=["show_deleted:0", "show_recycled:0"]):
 170             try:
 171                 self.delete(msg.dn, ["relax:0"])
 172             except ldb.LdbError, (errno, _):
 173                 if errno != ldb.ERR_NO_SUCH_OBJECT:
 174                     # Ignore no such object errors
 175                     raise
 176
 177         res = self.search(basedn, ldb.SCOPE_SUBTREE,
 178             "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))", [], controls=["show_deleted:0", "show_recycled:0"])
 179         assert len(res) == 0
 180
 181         # delete the specials
 182         for attr in ["@SUBCLASSES", "@MODULES",
 183                      "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
 184             try:
 185                 self.delete(attr, ["relax:0"])
 186             except ldb.LdbError, (errno, _):
 187                 if errno != ldb.ERR_NO_SUCH_OBJECT:
 188                     # Ignore missing dn errors
 189                     raise
 190
 191     def erase(self):
 192         """Erase this ldb, removing all records."""
 193         self.erase_except_schema_controlled()
 194
 195         # delete the specials
 196         for attr in ["@INDEXLIST", "@ATTRIBUTES"]:
 197             try:
 198                 self.delete(attr, ["relax:0"])
 199             except ldb.LdbError, (errno, _):
 200                 if errno != ldb.ERR_NO_SUCH_OBJECT:
 201                     # Ignore missing dn errors
 202                     raise
 203
 204     def load_ldif_file_add(self, ldif_path):
 205         """Load a LDIF file.
 206
 207         :param ldif_path: Path to LDIF file.
 208         """
 209         self.add_ldif(open(ldif_path, 'r').read())
 210
 211     def add_ldif(self, ldif, controls=None):
 212         """Add data based on a LDIF string.
 213
 214         :param ldif: LDIF text.
 215         """
 216         for changetype, msg in self.parse_ldif(ldif):
 217             assert changetype == ldb.CHANGETYPE_NONE
 218             self.add(msg, controls)
 219
 220     def modify_ldif(self, ldif, controls=None):
 221         """Modify database based on a LDIF string.
 222
 223         :param ldif: LDIF text.
 224         """
 225         for changetype, msg in self.parse_ldif(ldif):
 226             if changetype == ldb.CHANGETYPE_ADD:
 227                 self.add(msg, controls)
 228             else:
 229                 self.modify(msg, controls)
 230
 231
 232 def substitute_var(text, values):
 233     """Substitute strings of the form ${NAME} in str, replacing
 234     with substitutions from values.
 235
 236     :param text: Text in which to subsitute.
 237     :param values: Dictionary with keys and values.
 238     """
 239
 240     for (name, value) in values.items():
 241         assert isinstance(name, str), "%r is not a string" % name
 242         assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
 243         text = text.replace("${%s}" % name, value)
 244
 245     return text
 246
 247
 248 def check_all_substituted(text):
 249     """Check that all substitution variables in a string have been replaced.
 250
 251     If not, raise an exception.
 252
 253     :param text: The text to search for substitution variables
 254     """
 255     if not "${" in text:
 256         return
 257
 258     var_start = text.find("${")
 259     var_end = text.find("}", var_start)
 260
 261     raise Exception("Not all variables substituted: %s" %
 262         text[var_start:var_end+1])
 263
 264
 265 def read_and_sub_file(file_name, subst_vars):
 266     """Read a file and sub in variables found in it
 267
 268     :param file_name: File to be read (typically from setup directory)
 269      param subst_vars: Optional variables to subsitute in the file.
 270     """
 271     data = open(file_name, 'r').read()
 272     if subst_vars is not None:
 273         data = substitute_var(data, subst_vars)
 274         check_all_substituted(data)
 275     return data
 276
 277
 278 def setup_file(template, fname, subst_vars=None):
 279     """Setup a file in the private dir.
 280
 281     :param template: Path of the template file.
 282     :param fname: Path of the file to create.
 283     :param subst_vars: Substitution variables.
 284     """
 285     if os.path.exists(fname):
 286         os.unlink(fname)
 287
 288     data = read_and_sub_file(template, subst_vars)
 289     f = open(fname, 'w')
 290     try:
 291         f.write(data)
 292     finally:
 293         f.close()
 294
 295
 296 def valid_netbios_name(name):
 297     """Check whether a name is valid as a NetBIOS name. """
 298     # See crh's book (1.4.1.1)
 299     if len(name) > 15:
 300         return False
 301     for x in name:
 302         if not x.isalnum() and not x in " !#$%&'()-.@^_{}~":
 303             return False
 304     return True
 305
 306
 307 def import_bundled_package(modulename, location):
 308     """Import the bundled version of a package.
 309
 310     :note: This should only be called if the system version of the package
 311         is not adequate.
 312
 313     :param modulename: Module name to import
 314     :param location: Location to add to sys.path (can be relative to
 315         ${srcdir}/lib)
 316     """
 317     if in_source_tree():
 318         sys.path.insert(0,
 319             os.path.join(os.path.dirname(__file__),
 320                          "../../../../lib", location))
 321         __import__(modulename)
 322     else:
 323         sys.modules[modulename] = __import__(
 324             "samba.external.%s" % modulename, fromlist=["samba.external"])
 325
 326
 327 def force_bundled_package(packagename, location):
 328     """Forcibly use the bundled package.
 329
 330     This will first unload the system module and then load the bundled one.
 331
 332     :param packagename: The package name
 333     :param location: Location to add to sys.path (can be relative to
 334         ${srcdir}/lib)
 335     """
 336     for m in sys.modules.keys():
 337         if m.startswith("%s." % packagename):
 338             del sys.modules[m]
 339     import_bundled_package(packagename, location)
 340
 341
 342 def ensure_external_module(modulename, location):
 343     """Add a location to sys.path if an external dependency can't be found.
 344
 345     :param modulename: Module name to import
 346     :param location: Location to add to sys.path (can be relative to
 347         ${srcdir}/lib)
 348     """
 349     try:
 350         __import__(modulename)
 351     except ImportError:
 352         import_bundled_package(modulename, location)
 353
 354
 355 from samba import _glue
 356 version = _glue.version
 357 interface_ips = _glue.interface_ips
 358 set_debug_level = _glue.set_debug_level
 359 get_debug_level = _glue.get_debug_level
 360 unix2nttime = _glue.unix2nttime
 361 nttime2string = _glue.nttime2string
 362 nttime2unix = _glue.nttime2unix
 363 unix2nttime = _glue.unix2nttime
 364 generate_random_password = _glue.generate_random_password