3 # Unix SMB/CIFS implementation.
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
6 # Based on the original in EJS:
7 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
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.
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.
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/>.
25 __docformat__ = "restructuredText"
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__))
35 # When running, in-tree, make sure bin/python is in the PYTHONPATH
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
41 default_ldb_modules_dir = None
47 from samba._ldb import Ldb as _Ldb
50 """Simple Samba-specific LDB subclass that takes care
51 of setting up the modules dir, credentials pointers, etc.
53 Please note that this is intended to be for all Samba LDB files,
54 not necessarily the Sam database. For Sam-specific helper
55 functions see samdb.py.
57 def __init__(self, url=None, lp=None, modules_dir=None, session_info=None,
58 credentials=None, flags=0, options=None):
59 """Opens a Samba Ldb file.
61 :param url: Optional LDB URL to open
62 :param lp: Optional loadparm object
63 :param modules_dir: Optional modules directory
64 :param session_info: Optional session information
65 :param credentials: Optional credentials, defaults to anonymous.
66 :param flags: Optional LDB flags
67 :param options: Additional options (optional)
69 This is different from a regular Ldb file in that the Samba-specific
70 modules-dir is used by default and that credentials and session_info
71 can be passed through (required by some modules).
74 if modules_dir is not None:
75 self.set_modules_dir(modules_dir)
76 elif default_ldb_modules_dir is not None:
77 self.set_modules_dir(default_ldb_modules_dir)
79 self.set_modules_dir(os.path.join(lp.get("modules dir"), "ldb"))
81 if session_info is not None:
82 self.set_session_info(session_info)
84 if credentials is not None:
85 self.set_credentials(credentials)
90 # This must be done before we load the schema, as these handlers for
91 # objectSid and objectGUID etc must take precedence over the 'binary
92 # attribute' declaration in the schema
93 self.register_samba_handlers()
100 self.set_utf8_casefold()
102 # Allow admins to force non-sync ldb for all databases
104 nosync_p = lp.get("nosync", "ldb")
105 if nosync_p is not None and nosync_p == True:
108 self.set_create_perms()
111 self.connect(url, flags, options)
113 def set_session_info(self, session_info):
114 glue.ldb_set_session_info(self, session_info)
116 def set_create_perms(self, perms=0600):
117 # we usually want Samba databases to be private. If we later find we
118 # need one public, we will have to change this here
119 super(Ldb, self).set_create_perms(perms)
121 def searchone(self, attribute, basedn=None, expression=None,
122 scope=ldb.SCOPE_BASE):
123 """Search for one attribute as a string.
125 :param basedn: BaseDN for the search.
126 :param attribute: Name of the attribute
127 :param expression: Optional search expression.
128 :param scope: Search scope (defaults to base).
129 :return: Value of attribute as a string or None if it wasn't found.
131 res = self.search(basedn, scope, expression, [attribute])
132 if len(res) != 1 or res[0][attribute] is None:
134 values = set(res[0][attribute])
135 assert len(values) == 1
136 return self.schema_format_value(attribute, values.pop())
138 def erase_users_computers(self, dn):
139 """Erases user and computer objects from our AD. This is needed since the 'samldb' module denies the deletion of primary groups. Therefore all groups shouldn't be primary somewhere anymore."""
142 res = self.search(base=dn, scope=ldb.SCOPE_SUBTREE, attrs=[],
143 expression="(|(objectclass=user)(objectclass=computer))")
144 except ldb.LdbError, (errno, _):
145 if errno == ldb.ERR_NO_SUCH_OBJECT:
146 # Ignore no such object errors
154 except ldb.LdbError, (errno, _):
155 if errno != ldb.ERR_NO_SUCH_OBJECT:
156 # Ignore no such object errors
159 def erase_except_schema_controlled(self):
160 """Erase this ldb, removing all records, except those that are controlled by Samba4's schema."""
164 # Try to delete user/computer accounts to allow deletion of groups
165 self.erase_users_computers(basedn)
167 # Delete the 'visible' records, and the invisble 'deleted' records (if this DB supports it)
168 for msg in self.search(basedn, ldb.SCOPE_SUBTREE,
169 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
170 [], controls=["show_deleted:0"]):
173 except ldb.LdbError, (errno, _):
174 if errno != ldb.ERR_NO_SUCH_OBJECT:
175 # Ignore no such object errors
178 res = self.search(basedn, ldb.SCOPE_SUBTREE,
179 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
180 [], controls=["show_deleted:0"])
183 # delete the specials
184 for attr in ["@SUBCLASSES", "@MODULES",
185 "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
188 except ldb.LdbError, (errno, _):
189 if errno != ldb.ERR_NO_SUCH_OBJECT:
190 # Ignore missing dn errors
194 """Erase this ldb, removing all records."""
196 self.erase_except_schema_controlled()
198 # delete the specials
199 for attr in ["@INDEXLIST", "@ATTRIBUTES"]:
202 except ldb.LdbError, (errno, _):
203 if errno != ldb.ERR_NO_SUCH_OBJECT:
204 # Ignore missing dn errors
207 def erase_partitions(self):
208 """Erase an ldb, removing all records."""
210 def erase_recursive(self, dn):
212 res = self.search(base=dn, scope=ldb.SCOPE_ONELEVEL, attrs=[],
213 controls=["show_deleted:0"])
214 except ldb.LdbError, (errno, _):
215 if errno == ldb.ERR_NO_SUCH_OBJECT:
216 # Ignore no such object errors
220 erase_recursive(self, msg.dn)
224 except ldb.LdbError, (errno, _):
225 if errno != ldb.ERR_NO_SUCH_OBJECT:
226 # Ignore no such object errors
229 res = self.search("", ldb.SCOPE_BASE, "(objectClass=*)",
232 if not "namingContexts" in res[0]:
234 for basedn in res[0]["namingContexts"]:
235 # Try to delete user/computer accounts to allow deletion of groups
236 self.erase_users_computers(basedn)
237 # Try and erase from the bottom-up in the tree
238 erase_recursive(self, basedn)
240 def load_ldif_file_add(self, ldif_path):
243 :param ldif_path: Path to LDIF file.
245 self.add_ldif(open(ldif_path, 'r').read())
247 def add_ldif(self, ldif, controls=None):
248 """Add data based on a LDIF string.
250 :param ldif: LDIF text.
252 for changetype, msg in self.parse_ldif(ldif):
253 assert changetype == ldb.CHANGETYPE_NONE
254 self.add(msg,controls)
256 def modify_ldif(self, ldif, controls=None):
257 """Modify database based on a LDIF string.
259 :param ldif: LDIF text.
261 for changetype, msg in self.parse_ldif(ldif):
262 if (changetype == ldb.CHANGETYPE_ADD):
263 self.add(msg, controls)
265 self.modify(msg, controls)
267 def set_domain_sid(self, sid):
268 """Change the domain SID used by this LDB.
270 :param sid: The new domain sid to use.
272 glue.samdb_set_domain_sid(self, sid)
274 def domain_sid(self):
275 """Read the domain SID used by this LDB.
278 glue.samdb_get_domain_sid(self)
280 def set_schema_from_ldif(self, pf, df):
281 glue.dsdb_set_schema_from_ldif(self, pf, df)
283 def set_schema_from_ldb(self, ldb):
284 glue.dsdb_set_schema_from_ldb(self, ldb)
286 def write_prefixes_from_schema(self):
287 glue.dsdb_write_prefixes_from_schema_to_ldb(self)
289 def convert_schema_to_openldap(self, target, mapping):
290 return dsdb.dsdb_convert_schema_to_openldap(self, target, mapping)
292 def set_invocation_id(self, invocation_id):
293 """Set the invocation id for this SamDB handle.
295 :param invocation_id: GUID of the invocation id.
297 glue.dsdb_set_ntds_invocation_id(self, invocation_id)
299 def get_invocation_id(self):
300 "Get the invocation_id id"
301 return glue.samdb_ntds_invocation_id(self)
303 def get_ntds_GUID(self):
304 "Get the NTDS objectGUID"
305 return glue.samdb_ntds_objectGUID(self)
307 def server_site_name(self):
308 "Get the server site name"
309 return dsdb.samdb_server_site_name(self)
312 def substitute_var(text, values):
313 """substitute strings of the form ${NAME} in str, replacing
314 with substitutions from subobj.
316 :param text: Text in which to subsitute.
317 :param values: Dictionary with keys and values.
320 for (name, value) in values.items():
321 assert isinstance(name, str), "%r is not a string" % name
322 assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
323 text = text.replace("${%s}" % name, value)
328 def check_all_substituted(text):
329 """Make sure that all substitution variables in a string have been replaced.
330 If not, raise an exception.
332 :param text: The text to search for substitution variables
337 var_start = text.find("${")
338 var_end = text.find("}", var_start)
340 raise Exception("Not all variables substituted: %s" % text[var_start:var_end+1])
343 def read_and_sub_file(file, subst_vars):
344 """Read a file and sub in variables found in it
346 :param file: File to be read (typically from setup directory)
347 param subst_vars: Optional variables to subsitute in the file.
349 data = open(file, 'r').read()
350 if subst_vars is not None:
351 data = substitute_var(data, subst_vars)
352 check_all_substituted(data)
356 def setup_file(template, fname, subst_vars=None):
357 """Setup a file in the private dir.
359 :param template: Path of the template file.
360 :param fname: Path of the file to create.
361 :param subst_vars: Substitution variables.
365 if os.path.exists(f):
368 data = read_and_sub_file(template, subst_vars)
369 open(f, 'w').write(data)
372 def valid_netbios_name(name):
373 """Check whether a name is valid as a NetBIOS name. """
374 # See crh's book (1.4.1.1)
378 if not x.isalnum() and not x in " !#$%&'()-.@^_{}~":
383 def ensure_external_module(modulename, location):
384 """Add a location to sys.path if an external dependency can't be found.
386 :param modulename: Module name to import
387 :param location: Location to add to sys.path (can be relative to
391 __import__(modulename)
394 if _in_source_tree():
396 os.path.join(os.path.dirname(__file__),
397 "../../../../lib", location))
398 __import__(modulename)
400 sys.modules[modulename] = __import__(
401 "samba.external.%s" % modulename, fromlist=["samba.external"])
403 version = glue.version
404 interface_ips = glue.interface_ips
405 set_debug_level = glue.set_debug_level
406 unix2nttime = glue.unix2nttime
407 generate_random_password = glue.generate_random_password