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:
106 flags |= ldb.FLG_NOSYNC
108 self.set_create_perms()
111 self.connect(url, flags, options)
113 def set_create_perms(self, perms=0600):
114 # we usually want Samba databases to be private. If we later find we
115 # need one public, we will have to change this here
116 super(Ldb, self).set_create_perms(perms)
118 def searchone(self, attribute, basedn=None, expression=None,
119 scope=ldb.SCOPE_BASE):
120 """Search for one attribute as a string.
122 :param basedn: BaseDN for the search.
123 :param attribute: Name of the attribute
124 :param expression: Optional search expression.
125 :param scope: Search scope (defaults to base).
126 :return: Value of attribute as a string or None if it wasn't found.
128 res = self.search(basedn, scope, expression, [attribute])
129 if len(res) != 1 or res[0][attribute] is None:
131 values = set(res[0][attribute])
132 assert len(values) == 1
133 return self.schema_format_value(attribute, values.pop())
135 def erase_users_computers(self, dn):
136 """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."""
139 res = self.search(base=dn, scope=ldb.SCOPE_SUBTREE, attrs=[],
140 expression="(|(objectclass=user)(objectclass=computer))")
141 except ldb.LdbError, (errno, _):
142 if errno == ldb.ERR_NO_SUCH_OBJECT:
143 # Ignore no such object errors
151 except ldb.LdbError, (errno, _):
152 if errno != ldb.ERR_NO_SUCH_OBJECT:
153 # Ignore no such object errors
156 def erase_except_schema_controlled(self):
157 """Erase this ldb, removing all records, except those that are controlled by Samba4's schema."""
161 # Try to delete user/computer accounts to allow deletion of groups
162 self.erase_users_computers(basedn)
164 # Delete the 'visible' records, and the invisble 'deleted' records (if this DB supports it)
165 for msg in self.search(basedn, ldb.SCOPE_SUBTREE,
166 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
167 [], controls=["show_deleted:0"]):
170 except ldb.LdbError, (errno, _):
171 if errno != ldb.ERR_NO_SUCH_OBJECT:
172 # Ignore no such object errors
175 res = self.search(basedn, ldb.SCOPE_SUBTREE,
176 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
177 [], controls=["show_deleted:0"])
180 # delete the specials
181 for attr in ["@SUBCLASSES", "@MODULES",
182 "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
185 except ldb.LdbError, (errno, _):
186 if errno != ldb.ERR_NO_SUCH_OBJECT:
187 # Ignore missing dn errors
191 """Erase this ldb, removing all records."""
193 self.erase_except_schema_controlled()
195 # delete the specials
196 for attr in ["@INDEXLIST", "@ATTRIBUTES"]:
199 except ldb.LdbError, (errno, _):
200 if errno != ldb.ERR_NO_SUCH_OBJECT:
201 # Ignore missing dn errors
204 def erase_partitions(self):
205 """Erase an ldb, removing all records."""
207 def erase_recursive(self, dn):
209 res = self.search(base=dn, scope=ldb.SCOPE_ONELEVEL, attrs=[],
210 controls=["show_deleted:0"])
211 except ldb.LdbError, (errno, _):
212 if errno == ldb.ERR_NO_SUCH_OBJECT:
213 # Ignore no such object errors
217 erase_recursive(self, msg.dn)
221 except ldb.LdbError, (errno, _):
222 if errno != ldb.ERR_NO_SUCH_OBJECT:
223 # Ignore no such object errors
226 res = self.search("", ldb.SCOPE_BASE, "(objectClass=*)",
229 if not "namingContexts" in res[0]:
231 for basedn in res[0]["namingContexts"]:
232 # Try to delete user/computer accounts to allow deletion of groups
233 self.erase_users_computers(basedn)
234 # Try and erase from the bottom-up in the tree
235 erase_recursive(self, basedn)
237 def load_ldif_file_add(self, ldif_path):
240 :param ldif_path: Path to LDIF file.
242 self.add_ldif(open(ldif_path, 'r').read())
244 def add_ldif(self, ldif, controls=None):
245 """Add data based on a LDIF string.
247 :param ldif: LDIF text.
249 for changetype, msg in self.parse_ldif(ldif):
250 assert changetype == ldb.CHANGETYPE_NONE
251 self.add(msg,controls)
253 def modify_ldif(self, ldif, controls=None):
254 """Modify database based on a LDIF string.
256 :param ldif: LDIF text.
258 for changetype, msg in self.parse_ldif(ldif):
259 if (changetype == ldb.CHANGETYPE_ADD):
260 self.add(msg, controls)
262 self.modify(msg, controls)
264 def set_domain_sid(self, sid):
265 """Change the domain SID used by this LDB.
267 :param sid: The new domain sid to use.
269 dsdb.samdb_set_domain_sid(self, sid)
271 def domain_sid(self):
272 """Read the domain SID used by this LDB.
275 dsdb.samdb_get_domain_sid(self)
277 def set_schema_from_ldif(self, pf, df):
278 _glue.dsdb_set_schema_from_ldif(self, pf, df)
280 def set_schema_from_ldb(self, ldb):
281 _glue.dsdb_set_schema_from_ldb(self, ldb)
283 def write_prefixes_from_schema(self):
284 _glue.dsdb_write_prefixes_from_schema_to_ldb(self)
286 def convert_schema_to_openldap(self, target, mapping):
287 return dsdb.dsdb_convert_schema_to_openldap(self, target, mapping)
289 def set_invocation_id(self, invocation_id):
290 """Set the invocation id for this SamDB handle.
292 :param invocation_id: GUID of the invocation id.
294 dsdb.dsdb_set_ntds_invocation_id(self, invocation_id)
296 def get_invocation_id(self):
297 "Get the invocation_id id"
298 return dsdb.samdb_ntds_invocation_id(self)
300 def get_ntds_GUID(self):
301 "Get the NTDS objectGUID"
302 return dsdb.samdb_ntds_objectGUID(self)
304 def server_site_name(self):
305 "Get the server site name"
306 return dsdb.samdb_server_site_name(self)
309 def substitute_var(text, values):
310 """substitute strings of the form ${NAME} in str, replacing
311 with substitutions from subobj.
313 :param text: Text in which to subsitute.
314 :param values: Dictionary with keys and values.
317 for (name, value) in values.items():
318 assert isinstance(name, str), "%r is not a string" % name
319 assert isinstance(value, str), "Value %r for %s is not a string" % (value, name)
320 text = text.replace("${%s}" % name, value)
325 def check_all_substituted(text):
326 """Make sure that all substitution variables in a string have been replaced.
327 If not, raise an exception.
329 :param text: The text to search for substitution variables
334 var_start = text.find("${")
335 var_end = text.find("}", var_start)
337 raise Exception("Not all variables substituted: %s" % text[var_start:var_end+1])
340 def read_and_sub_file(file, subst_vars):
341 """Read a file and sub in variables found in it
343 :param file: File to be read (typically from setup directory)
344 param subst_vars: Optional variables to subsitute in the file.
346 data = open(file, 'r').read()
347 if subst_vars is not None:
348 data = substitute_var(data, subst_vars)
349 check_all_substituted(data)
353 def setup_file(template, fname, subst_vars=None):
354 """Setup a file in the private dir.
356 :param template: Path of the template file.
357 :param fname: Path of the file to create.
358 :param subst_vars: Substitution variables.
362 if os.path.exists(f):
365 data = read_and_sub_file(template, subst_vars)
366 open(f, 'w').write(data)
369 def valid_netbios_name(name):
370 """Check whether a name is valid as a NetBIOS name. """
371 # See crh's book (1.4.1.1)
375 if not x.isalnum() and not x in " !#$%&'()-.@^_{}~":
380 def ensure_external_module(modulename, location):
381 """Add a location to sys.path if an external dependency can't be found.
383 :param modulename: Module name to import
384 :param location: Location to add to sys.path (can be relative to
388 __import__(modulename)
391 if _in_source_tree():
393 os.path.join(os.path.dirname(__file__),
394 "../../../../lib", location))
395 __import__(modulename)
397 sys.modules[modulename] = __import__(
398 "samba.external.%s" % modulename, fromlist=["samba.external"])
400 version = _glue.version
401 interface_ips = _glue.interface_ips
402 set_debug_level = _glue.set_debug_level
403 unix2nttime = _glue.unix2nttime
404 generate_random_password = _glue.generate_random_password