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"
29 def _in_source_tree():
30 """Check whether the script is being run from the source dir. """
31 return os
.path
.exists("%s/../../../selftest/skip" % os
.path
.dirname(__file__
))
34 # 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
48 """Simple Samba-specific LDB subclass that takes care
49 of setting up the modules dir, credentials pointers, etc.
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.
55 def __init__(self
, url
=None, lp
=None, modules_dir
=None, session_info
=None,
56 credentials
=None, flags
=0, options
=None):
57 """Opens a Samba Ldb file.
59 :param url: Optional LDB URL to open
60 :param lp: Optional loadparm object
61 :param modules_dir: Optional modules directory
62 :param session_info: Optional session information
63 :param credentials: Optional credentials, defaults to anonymous.
64 :param flags: Optional LDB flags
65 :param options: Additional options (optional)
67 This is different from a regular Ldb file in that the Samba-specific
68 modules-dir is used by default and that credentials and session_info
69 can be passed through (required by some modules).
72 if modules_dir
is not None:
73 self
.set_modules_dir(modules_dir
)
74 elif default_ldb_modules_dir
is not None:
75 self
.set_modules_dir(default_ldb_modules_dir
)
77 self
.set_modules_dir(os
.path
.join(lp
.get("modules dir"), "ldb"))
79 if session_info
is not None:
80 self
.set_session_info(session_info
)
82 if credentials
is not None:
83 self
.set_credentials(credentials
)
88 # This must be done before we load the schema, as these handlers for
89 # objectSid and objectGUID etc must take precedence over the 'binary
90 # attribute' declaration in the schema
91 glue
.ldb_register_samba_handlers(self
)
98 glue
.ldb_set_utf8_casefold(self
)
100 # Allow admins to force non-sync ldb for all databases
102 nosync_p
= lp
.get("nosync", "ldb")
103 if nosync_p
is not None and nosync_p
== true
:
106 self
.set_create_perms()
109 self
.connect(url
, flags
, options
)
111 def set_session_info(self
, session_info
):
112 glue
.ldb_set_session_info(self
, session_info
)
114 def set_credentials(self
, credentials
):
115 glue
.ldb_set_credentials(self
, credentials
)
117 def set_loadparm(self
, lp_ctx
):
118 glue
.ldb_set_loadparm(self
, lp_ctx
)
120 def set_create_perms(self
, perms
=0600):
121 # we usually want Samba databases to be private. If we later find we
122 # need one public, we will have to change this here
123 super(Ldb
, self
).set_create_perms(perms
)
125 def searchone(self
, attribute
, basedn
=None, expression
=None,
126 scope
=ldb
.SCOPE_BASE
):
127 """Search for one attribute as a string.
129 :param basedn: BaseDN for the search.
130 :param attribute: Name of the attribute
131 :param expression: Optional search expression.
132 :param scope: Search scope (defaults to base).
133 :return: Value of attribute as a string or None if it wasn't found.
135 res
= self
.search(basedn
, scope
, expression
, [attribute
])
136 if len(res
) != 1 or res
[0][attribute
] is None:
138 values
= set(res
[0][attribute
])
139 assert len(values
) == 1
140 return self
.schema_format_value(attribute
, values
.pop())
142 def erase_users_computers(self
, dn
):
143 """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."""
146 res
= self
.search(base
=dn
, scope
=ldb
.SCOPE_SUBTREE
, attrs
=[],
147 expression
="(|(objectclass=user)(objectclass=computer))")
148 except ldb
.LdbError
, (ldb
.ERR_NO_SUCH_OBJECT
, _
):
149 # Ignore no such object errors
156 except ldb
.LdbError
, (ldb
.ERR_NO_SUCH_OBJECT
, _
):
157 # Ignore no such object errors
160 def erase_except_schema_controlled(self
):
161 """Erase this ldb, removing all records, except those that are controlled by Samba4's schema."""
165 # Try to delete user/computer accounts to allow deletion of groups
166 self
.erase_users_computers(basedn
)
168 # Delete the 'visible' records, and the invisble 'deleted' records (if this DB supports it)
169 for msg
in self
.search(basedn
, ldb
.SCOPE_SUBTREE
,
170 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
171 [], controls
=["show_deleted:0"]):
174 except ldb
.LdbError
, (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
, (ldb
.ERR_NO_SUCH_OBJECT
, _
):
189 # Ignore missing dn errors
193 """Erase this ldb, removing all records."""
195 self
.erase_except_schema_controlled()
197 # delete the specials
198 for attr
in ["@INDEXLIST", "@ATTRIBUTES"]:
201 except ldb
.LdbError
, (ldb
.ERR_NO_SUCH_OBJECT
, _
):
202 # Ignore missing dn errors
205 def erase_partitions(self
):
206 """Erase an ldb, removing all records."""
208 def erase_recursive(self
, dn
):
210 res
= self
.search(base
=dn
, scope
=ldb
.SCOPE_ONELEVEL
, attrs
=[],
211 controls
=["show_deleted:0"])
212 except ldb
.LdbError
, (ldb
.ERR_NO_SUCH_OBJECT
, _
):
213 # Ignore no such object errors
218 erase_recursive(self
, msg
.dn
)
222 except ldb
.LdbError
, (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
):
254 """Modify database based on a LDIF string.
256 :param ldif: LDIF text.
258 for changetype
, msg
in self
.parse_ldif(ldif
):
261 def set_domain_sid(self
, sid
):
262 """Change the domain SID used by this LDB.
264 :param sid: The new domain sid to use.
266 glue
.samdb_set_domain_sid(self
, sid
)
268 def domain_sid(self
):
269 """Read the domain SID used by this LDB.
272 glue
.samdb_get_domain_sid(self
)
274 def set_schema_from_ldif(self
, pf
, df
):
275 glue
.dsdb_set_schema_from_ldif(self
, pf
, df
)
277 def set_schema_from_ldb(self
, ldb
):
278 glue
.dsdb_set_schema_from_ldb(self
, ldb
)
280 def write_prefixes_from_schema(self
):
281 glue
.dsdb_write_prefixes_from_schema_to_ldb(self
)
283 def convert_schema_to_openldap(self
, target
, mapping
):
284 return glue
.dsdb_convert_schema_to_openldap(self
, target
, mapping
)
286 def set_invocation_id(self
, invocation_id
):
287 """Set the invocation id for this SamDB handle.
289 :param invocation_id: GUID of the invocation id.
291 glue
.dsdb_set_ntds_invocation_id(self
, invocation_id
)
293 def set_opaque_integer(self
, name
, value
):
294 """Set an integer as an opaque (a flag or other value) value on the database
296 :param name: The name for the opaque value
297 :param value: The integer value
299 glue
.dsdb_set_opaque_integer(self
, name
, value
)
302 def substitute_var(text
, values
):
303 """substitute strings of the form ${NAME} in str, replacing
304 with substitutions from subobj.
306 :param text: Text in which to subsitute.
307 :param values: Dictionary with keys and values.
310 for (name
, value
) in values
.items():
311 assert isinstance(name
, str), "%r is not a string" % name
312 assert isinstance(value
, str), "Value %r for %s is not a string" % (value
, name
)
313 text
= text
.replace("${%s}" % name
, value
)
318 def check_all_substituted(text
):
319 """Make sure that all substitution variables in a string have been replaced.
320 If not, raise an exception.
322 :param text: The text to search for substitution variables
327 var_start
= text
.find("${")
328 var_end
= text
.find("}", var_start
)
330 raise Exception("Not all variables substituted: %s" % text
[var_start
:var_end
+1])
333 def read_and_sub_file(file, subst_vars
):
334 """Read a file and sub in variables found in it
336 :param file: File to be read (typically from setup directory)
337 param subst_vars: Optional variables to subsitute in the file.
339 data
= open(file, 'r').read()
340 if subst_vars
is not None:
341 data
= substitute_var(data
, subst_vars
)
342 check_all_substituted(data
)
346 def setup_file(template
, fname
, subst_vars
=None):
347 """Setup a file in the private dir.
349 :param template: Path of the template file.
350 :param fname: Path of the file to create.
351 :param subst_vars: Substitution variables.
355 if os
.path
.exists(f
):
358 data
= read_and_sub_file(template
, subst_vars
)
359 open(f
, 'w').write(data
)
362 def valid_netbios_name(name
):
363 """Check whether a name is valid as a NetBIOS name. """
364 # See crh's book (1.4.1.1)
368 if not x
.isalnum() and not x
in " !#$%&'()-.@^_{}~":
373 def dom_sid_to_rid(sid_str
):
374 """Converts a domain SID to the relative RID.
376 :param sid_str: The domain SID formatted as string
379 return glue
.dom_sid_to_rid(sid_str
)
382 version
= glue
.version
384 # "userAccountControl" flags
385 UF_NORMAL_ACCOUNT
= glue
.UF_NORMAL_ACCOUNT
386 UF_TEMP_DUPLICATE_ACCOUNT
= glue
.UF_TEMP_DUPLICATE_ACCOUNT
387 UF_SERVER_TRUST_ACCOUNT
= glue
.UF_SERVER_TRUST_ACCOUNT
388 UF_WORKSTATION_TRUST_ACCOUNT
= glue
.UF_WORKSTATION_TRUST_ACCOUNT
389 UF_INTERDOMAIN_TRUST_ACCOUNT
= glue
.UF_INTERDOMAIN_TRUST_ACCOUNT
390 UF_PASSWD_NOTREQD
= glue
.UF_PASSWD_NOTREQD
391 UF_ACCOUNTDISABLE
= glue
.UF_ACCOUNTDISABLE
394 GTYPE_SECURITY_BUILTIN_LOCAL_GROUP
= glue
.GTYPE_SECURITY_BUILTIN_LOCAL_GROUP
395 GTYPE_SECURITY_GLOBAL_GROUP
= glue
.GTYPE_SECURITY_GLOBAL_GROUP
396 GTYPE_SECURITY_DOMAIN_LOCAL_GROUP
= glue
.GTYPE_SECURITY_DOMAIN_LOCAL_GROUP
397 GTYPE_SECURITY_UNIVERSAL_GROUP
= glue
.GTYPE_SECURITY_UNIVERSAL_GROUP
398 GTYPE_DISTRIBUTION_GLOBAL_GROUP
= glue
.GTYPE_DISTRIBUTION_GLOBAL_GROUP
399 GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP
= glue
.GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP
400 GTYPE_DISTRIBUTION_UNIVERSAL_GROUP
= glue
.GTYPE_DISTRIBUTION_UNIVERSAL_GROUP
402 # "sAMAccountType" flags
403 ATYPE_NORMAL_ACCOUNT
= glue
.ATYPE_NORMAL_ACCOUNT
404 ATYPE_WORKSTATION_TRUST
= glue
.ATYPE_WORKSTATION_TRUST
405 ATYPE_INTERDOMAIN_TRUST
= glue
.ATYPE_INTERDOMAIN_TRUST
406 ATYPE_SECURITY_GLOBAL_GROUP
= glue
.ATYPE_SECURITY_GLOBAL_GROUP
407 ATYPE_SECURITY_LOCAL_GROUP
= glue
.ATYPE_SECURITY_LOCAL_GROUP
408 ATYPE_SECURITY_UNIVERSAL_GROUP
= glue
.ATYPE_SECURITY_UNIVERSAL_GROUP
409 ATYPE_DISTRIBUTION_GLOBAL_GROUP
= glue
.ATYPE_DISTRIBUTION_GLOBAL_GROUP
410 ATYPE_DISTRIBUTION_LOCAL_GROUP
= glue
.ATYPE_DISTRIBUTION_LOCAL_GROUP
411 ATYPE_DISTRIBUTION_UNIVERSAL_GROUP
= glue
.ATYPE_DISTRIBUTION_UNIVERSAL_GROUP
413 # "domainFunctionality", "forestFunctionality" flags in the rootDSE */
414 DS_DOMAIN_FUNCTION_2000
= glue
.DS_DOMAIN_FUNCTION_2000
415 DS_DOMAIN_FUNCTION_2003_MIXED
= glue
.DS_DOMAIN_FUNCTION_2003_MIXED
416 DS_DOMAIN_FUNCTION_2003
= glue
.DS_DOMAIN_FUNCTION_2003
417 DS_DOMAIN_FUNCTION_2008
= glue
.DS_DOMAIN_FUNCTION_2008
418 DS_DOMAIN_FUNCTION_2008_R2
= glue
.DS_DOMAIN_FUNCTION_2008_R2
420 # "domainControllerFunctionality" flags in the rootDSE */
421 DS_DC_FUNCTION_2000
= glue
.DS_DC_FUNCTION_2000
422 DS_DC_FUNCTION_2003
= glue
.DS_DC_FUNCTION_2003
423 DS_DC_FUNCTION_2008
= glue
.DS_DC_FUNCTION_2008
424 DS_DC_FUNCTION_2008_R2
= glue
.DS_DC_FUNCTION_2008_R2