1 # Unix SMB/CIFS implementation.
2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
4 # Based on the original in EJS:
5 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 __docformat__
= "restructuredText"
31 def source_tree_topdir():
32 """Return the top level source directory."""
33 paths
= ["../../..", "../../../.."]
35 topdir
= os
.path
.normpath(os
.path
.join(os
.path
.dirname(__file__
), p
))
36 if os
.path
.exists(os
.path
.join(topdir
, 'source4')):
38 raise RuntimeError("unable to find top level source directory")
42 """Return True if we are running from within the samba source tree"""
44 topdir
= source_tree_topdir()
51 from samba
._ldb
import Ldb
as _Ldb
55 """Simple Samba-specific LDB subclass that takes care
56 of setting up the modules dir, credentials pointers, etc.
58 Please note that this is intended to be for all Samba LDB files,
59 not necessarily the Sam database. For Sam-specific helper
60 functions see samdb.py.
63 def __init__(self
, url
=None, lp
=None, modules_dir
=None, session_info
=None,
64 credentials
=None, flags
=0, options
=None):
65 """Opens a Samba Ldb file.
67 :param url: Optional LDB URL to open
68 :param lp: Optional loadparm object
69 :param modules_dir: Optional modules directory
70 :param session_info: Optional session information
71 :param credentials: Optional credentials, defaults to anonymous.
72 :param flags: Optional LDB flags
73 :param options: Additional options (optional)
75 This is different from a regular Ldb file in that the Samba-specific
76 modules-dir is used by default and that credentials and session_info
77 can be passed through (required by some modules).
80 if modules_dir
is not None:
81 self
.set_modules_dir(modules_dir
)
83 self
.set_modules_dir(os
.path
.join(samba
.param
.modules_dir(), "ldb"))
85 if session_info
is not None:
86 self
.set_session_info(session_info
)
88 if credentials
is not None:
89 self
.set_credentials(credentials
)
94 # This must be done before we load the schema, as these handlers for
95 # objectSid and objectGUID etc must take precedence over the 'binary
96 # attribute' declaration in the schema
97 self
.register_samba_handlers()
104 self
.set_utf8_casefold()
106 # Allow admins to force non-sync ldb for all databases
108 nosync_p
= lp
.get("nosync", "ldb")
109 if nosync_p
is not None and nosync_p
:
110 flags |
= ldb
.FLG_NOSYNC
112 self
.set_create_perms(0600)
115 self
.connect(url
, flags
, options
)
117 def searchone(self
, attribute
, basedn
=None, expression
=None,
118 scope
=ldb
.SCOPE_BASE
):
119 """Search for one attribute as a string.
121 :param basedn: BaseDN for the search.
122 :param attribute: Name of the attribute
123 :param expression: Optional search expression.
124 :param scope: Search scope (defaults to base).
125 :return: Value of attribute as a string or None if it wasn't found.
127 res
= self
.search(basedn
, scope
, expression
, [attribute
])
128 if len(res
) != 1 or res
[0][attribute
] is None:
130 values
= set(res
[0][attribute
])
131 assert len(values
) == 1
132 return self
.schema_format_value(attribute
, values
.pop())
134 def erase_users_computers(self
, dn
):
135 """Erases user and computer objects from our AD.
137 This is needed since the 'samldb' module denies the deletion of primary
138 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
153 self
.delete(msg
.dn
, ["relax:0"])
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
):
162 :note: Removes all records, except those that are controlled by
168 # Try to delete user/computer accounts to allow deletion of groups
169 self
.erase_users_computers(basedn
)
171 # Delete the 'visible' records, and the invisble 'deleted' records (if
172 # this DB supports it)
173 for msg
in self
.search(basedn
, ldb
.SCOPE_SUBTREE
,
174 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
175 [], controls
=["show_deleted:0", "show_recycled:0"]):
177 self
.delete(msg
.dn
, ["relax:0"])
178 except ldb
.LdbError
, (errno
, _
):
179 if errno
!= ldb
.ERR_NO_SUCH_OBJECT
:
180 # Ignore no such object errors
183 res
= self
.search(basedn
, ldb
.SCOPE_SUBTREE
,
184 "(&(|(objectclass=*)(distinguishedName=*))(!(distinguishedName=@BASEINFO)))",
185 [], controls
=["show_deleted:0", "show_recycled:0"])
188 # delete the specials
189 for attr
in ["@SUBCLASSES", "@MODULES",
190 "@OPTIONS", "@PARTITION", "@KLUDGEACL"]:
192 self
.delete(attr
, ["relax:0"])
193 except ldb
.LdbError
, (errno
, _
):
194 if errno
!= ldb
.ERR_NO_SUCH_OBJECT
:
195 # Ignore missing dn errors
199 """Erase this ldb, removing all records."""
200 self
.erase_except_schema_controlled()
202 # delete the specials
203 for attr
in ["@INDEXLIST", "@ATTRIBUTES"]:
205 self
.delete(attr
, ["relax:0"])
206 except ldb
.LdbError
, (errno
, _
):
207 if errno
!= ldb
.ERR_NO_SUCH_OBJECT
:
208 # Ignore missing dn errors
211 def load_ldif_file_add(self
, ldif_path
):
214 :param ldif_path: Path to LDIF file.
216 self
.add_ldif(open(ldif_path
, 'r').read())
218 def add_ldif(self
, ldif
, controls
=None):
219 """Add data based on a LDIF string.
221 :param ldif: LDIF text.
223 for changetype
, msg
in self
.parse_ldif(ldif
):
224 assert changetype
== ldb
.CHANGETYPE_NONE
225 self
.add(msg
, controls
)
227 def modify_ldif(self
, ldif
, controls
=None):
228 """Modify database based on a LDIF string.
230 :param ldif: LDIF text.
232 for changetype
, msg
in self
.parse_ldif(ldif
):
233 if changetype
== ldb
.CHANGETYPE_ADD
:
234 self
.add(msg
, controls
)
236 self
.modify(msg
, controls
)
239 def substitute_var(text
, values
):
240 """Substitute strings of the form ${NAME} in str, replacing
241 with substitutions from values.
243 :param text: Text in which to subsitute.
244 :param values: Dictionary with keys and values.
247 for (name
, value
) in values
.items():
248 assert isinstance(name
, str), "%r is not a string" % name
249 assert isinstance(value
, str), "Value %r for %s is not a string" % (value
, name
)
250 text
= text
.replace("${%s}" % name
, value
)
255 def check_all_substituted(text
):
256 """Check that all substitution variables in a string have been replaced.
258 If not, raise an exception.
260 :param text: The text to search for substitution variables
265 var_start
= text
.find("${")
266 var_end
= text
.find("}", var_start
)
268 raise Exception("Not all variables substituted: %s" %
269 text
[var_start
:var_end
+1])
272 def read_and_sub_file(file_name
, subst_vars
):
273 """Read a file and sub in variables found in it
275 :param file_name: File to be read (typically from setup directory)
276 param subst_vars: Optional variables to subsitute in the file.
278 data
= open(file_name
, 'r').read()
279 if subst_vars
is not None:
280 data
= substitute_var(data
, subst_vars
)
281 check_all_substituted(data
)
285 def setup_file(template
, fname
, subst_vars
=None):
286 """Setup a file in the private dir.
288 :param template: Path of the template file.
289 :param fname: Path of the file to create.
290 :param subst_vars: Substitution variables.
292 if os
.path
.exists(fname
):
295 data
= read_and_sub_file(template
, subst_vars
)
302 MAX_NETBIOS_NAME_LEN
= 15
303 def is_valid_netbios_char(c
):
304 return (c
.isalnum() or c
in " !#$%&'()-.@^_{}~")
307 def valid_netbios_name(name
):
308 """Check whether a name is valid as a NetBIOS name. """
309 # See crh's book (1.4.1.1)
310 if len(name
) > MAX_NETBIOS_NAME_LEN
:
313 if not is_valid_netbios_char(x
):
318 def import_bundled_package(modulename
, location
, source_tree_container
,
320 """Import the bundled version of a package.
322 :note: This should only be called if the system version of the package
325 :param modulename: Module name to import
326 :param location: Location to add to sys.path (can be relative to
327 ${srcdir}/${source_tree_container})
328 :param source_tree_container: Directory under source root that
329 contains the bundled third party modules.
330 :param namespace: Namespace to import module from, when not in source tree
333 extra_path
= os
.path
.join(source_tree_topdir(), source_tree_container
,
335 if not extra_path
in sys
.path
:
336 sys
.path
.insert(0, extra_path
)
337 sys
.modules
[modulename
] = __import__(modulename
)
339 sys
.modules
[modulename
] = __import__(
340 "%s.%s" % (namespace
, modulename
), fromlist
=[namespace
])
343 def ensure_third_party_module(modulename
, location
):
344 """Add a location to sys.path if a third party dependency can't be found.
346 :param modulename: Module name to import
347 :param location: Location to add to sys.path (can be relative to
348 ${srcdir}/third_party)
351 __import__(modulename
)
353 import_bundled_package(modulename
, location
,
354 source_tree_container
="third_party",
355 namespace
="samba.third_party")
358 def dn_from_dns_name(dnsdomain
):
359 """return a DN from a DNS name domain/forest root"""
360 return "DC=" + ",DC=".join(dnsdomain
.split("."))
362 def current_unix_time():
363 return int(time
.time())
365 def string_to_byte_array(string
):
366 blob
= [0] * len(string
)
368 for i
in range(len(string
)):
369 blob
[i
] = ord(string
[i
])
373 def arcfour_encrypt(key
, data
):
375 from Crypto
.Cipher
import ARC4
377 return c
.encrypt(data
)
378 except ImportError as e
:
381 from M2Crypto
.RC4
import RC4
383 return c
.update(data
)
384 except ImportError as e
:
386 raise Exception("arcfour_encrypt() requires " +
387 "python*-crypto or python*-m2crypto or m2crypto")
390 version
= _glue
.version
391 interface_ips
= _glue
.interface_ips
392 set_debug_level
= _glue
.set_debug_level
393 get_debug_level
= _glue
.get_debug_level
394 unix2nttime
= _glue
.unix2nttime
395 nttime2string
= _glue
.nttime2string
396 nttime2unix
= _glue
.nttime2unix
397 unix2nttime
= _glue
.unix2nttime
398 generate_random_password
= _glue
.generate_random_password
399 strcasecmp_m
= _glue
.strcasecmp_m
400 strstr_m
= _glue
.strstr_m
401 is_ntvfs_fileserver_built
= _glue
.is_ntvfs_fileserver_built