1 # Unix SMB/CIFS implementation.
2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007
4 # This program is free software; you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation; either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 """Support for reading Samba 3 data files."""
20 __docformat__ = "restructuredText"
22 REGISTRY_VALUE_PREFIX = "SAMBA_REGVAL"
23 REGISTRY_DB_VERSION = 1
30 import param as s3param
33 def fetch_uint32(tdb, key):
39 return struct.unpack("<L", data)[0]
42 def fetch_int32(tdb, key):
48 return struct.unpack("<l", data)[0]
51 class TdbDatabase(object):
52 """Simple Samba 3 TDB database reader."""
53 def __init__(self, file):
56 :param file: Path of the file to open (appending "2" if TDB2 enabled).
58 if tdb.__version__.startswith("2"):
59 self.tdb = tdb.Tdb(file + "2", flags=os.O_RDONLY)
61 self.tdb = tdb.Tdb(file, flags=os.O_RDONLY)
64 def _check_version(self):
68 """Close resources associated with this object."""
72 class Registry(TdbDatabase):
73 """Simple read-only support for reading the Samba3 registry.
75 :note: This object uses the same syntax for registry key paths as
76 Samba 3. This particular format uses forward slashes for key path
77 separators and abbreviations for the predefined key names.
78 e.g.: HKLM/Software/Bar.
81 """Return the number of keys."""
82 return len(self.keys())
85 """Return list with all the keys."""
86 return [k.rstrip("\x00") for k in self.tdb.iterkeys() if not k.startswith(REGISTRY_VALUE_PREFIX)]
88 def subkeys(self, key):
89 """Retrieve the subkeys for the specified key.
92 :return: list with key names
94 data = self.tdb.get("%s\x00" % key)
97 (num, ) = struct.unpack("<L", data[0:4])
98 keys = data[4:].split("\0")
101 assert len(keys) == num
104 def values(self, key):
105 """Return a dictionary with the values set for a specific key.
107 :param key: Key to retrieve values for.
108 :return: Dictionary with value names as key, tuple with type and
110 data = self.tdb.get("%s/%s\x00" % (REGISTRY_VALUE_PREFIX, key))
114 (num, ) = struct.unpack("<L", data[0:4])
118 (name, data) = data.split("\0", 1)
120 (type, ) = struct.unpack("<L", data[0:4])
122 (value_len, ) = struct.unpack("<L", data[0:4])
125 ret[name] = (type, data[:value_len])
126 data = data[value_len:]
131 # High water mark keys
132 IDMAP_HWM_GROUP = "GROUP HWM\0"
133 IDMAP_HWM_USER = "USER HWM\0"
135 IDMAP_GROUP_PREFIX = "GID "
136 IDMAP_USER_PREFIX = "UID "
138 # idmap version determines auto-conversion
141 class IdmapDatabase(TdbDatabase):
142 """Samba 3 ID map database reader."""
143 def _check_version(self):
144 assert fetch_int32(self.tdb, "IDMAP_VERSION\0") == IDMAP_VERSION_V2
147 """Retrieve a list of all ids in this database."""
148 for k in self.tdb.iterkeys():
149 if k.startswith(IDMAP_USER_PREFIX):
150 yield k.rstrip("\0").split(" ")
151 if k.startswith(IDMAP_GROUP_PREFIX):
152 yield k.rstrip("\0").split(" ")
155 """Retrieve a list of all uids in this database."""
156 for k in self.tdb.iterkeys():
157 if k.startswith(IDMAP_USER_PREFIX):
158 yield int(k[len(IDMAP_USER_PREFIX):].rstrip("\0"))
161 """Retrieve a list of all gids in this database."""
162 for k in self.tdb.iterkeys():
163 if k.startswith(IDMAP_GROUP_PREFIX):
164 yield int(k[len(IDMAP_GROUP_PREFIX):].rstrip("\0"))
166 def get_sid(self, xid, id_type):
167 """Retrive SID associated with a particular id and type.
169 :param xid: UID or GID to retrive SID for.
170 :param id_type: Type of id specified - 'UID' or 'GID'
172 data = self.tdb.get("%s %s\0" % (id_type, str(xid)))
175 return data.rstrip("\0")
177 def get_user_sid(self, uid):
178 """Retrieve the SID associated with a particular uid.
180 :param uid: UID to retrieve SID for.
181 :return: A SID or None if no mapping was found.
183 data = self.tdb.get("%s%d\0" % (IDMAP_USER_PREFIX, uid))
186 return data.rstrip("\0")
188 def get_group_sid(self, gid):
189 data = self.tdb.get("%s%d\0" % (IDMAP_GROUP_PREFIX, gid))
192 return data.rstrip("\0")
194 def get_user_hwm(self):
195 """Obtain the user high-water mark."""
196 return fetch_uint32(self.tdb, IDMAP_HWM_USER)
198 def get_group_hwm(self):
199 """Obtain the group high-water mark."""
200 return fetch_uint32(self.tdb, IDMAP_HWM_GROUP)
203 class SecretsDatabase(TdbDatabase):
204 """Samba 3 Secrets database reader."""
205 def get_auth_password(self):
206 return self.tdb.get("SECRETS/AUTH_PASSWORD")
208 def get_auth_domain(self):
209 return self.tdb.get("SECRETS/AUTH_DOMAIN")
211 def get_auth_user(self):
212 return self.tdb.get("SECRETS/AUTH_USER")
214 def get_domain_guid(self, host):
215 return self.tdb.get("SECRETS/DOMGUID/%s" % host)
218 for k in self.tdb.iterkeys():
219 if k.startswith("SECRETS/LDAP_BIND_PW/"):
220 yield k[len("SECRETS/LDAP_BIND_PW/"):].rstrip("\0")
223 """Iterate over domains in this database.
225 :return: Iterator over the names of domains in this database.
227 for k in self.tdb.iterkeys():
228 if k.startswith("SECRETS/SID/"):
229 yield k[len("SECRETS/SID/"):].rstrip("\0")
231 def get_ldap_bind_pw(self, host):
232 return self.tdb.get("SECRETS/LDAP_BIND_PW/%s" % host)
234 def get_afs_keyfile(self, host):
235 return self.tdb.get("SECRETS/AFS_KEYFILE/%s" % host)
237 def get_machine_sec_channel_type(self, host):
238 return fetch_uint32(self.tdb, "SECRETS/MACHINE_SEC_CHANNEL_TYPE/%s" % host)
240 def get_machine_last_change_time(self, host):
241 return fetch_uint32(self.tdb, "SECRETS/MACHINE_LAST_CHANGE_TIME/%s" % host)
243 def get_machine_password(self, host):
244 return self.tdb.get("SECRETS/MACHINE_PASSWORD/%s" % host)
246 def get_machine_acc(self, host):
247 return self.tdb.get("SECRETS/$MACHINE.ACC/%s" % host)
249 def get_domtrust_acc(self, host):
250 return self.tdb.get("SECRETS/$DOMTRUST.ACC/%s" % host)
252 def trusted_domains(self):
253 for k in self.tdb.iterkeys():
254 if k.startswith("SECRETS/$DOMTRUST.ACC/"):
255 yield k[len("SECRETS/$DOMTRUST.ACC/"):].rstrip("\0")
257 def get_random_seed(self):
258 return self.tdb.get("INFO/random_seed")
260 def get_sid(self, host):
261 return self.tdb.get("SECRETS/SID/%s" % host.upper())
264 SHARE_DATABASE_VERSION_V1 = 1
265 SHARE_DATABASE_VERSION_V2 = 2
267 class ShareInfoDatabase(TdbDatabase):
268 """Samba 3 Share Info database reader."""
269 def _check_version(self):
270 assert fetch_int32(self.tdb, "INFO/version\0") in (SHARE_DATABASE_VERSION_V1, SHARE_DATABASE_VERSION_V2)
272 def get_secdesc(self, name):
273 """Obtain the security descriptor on a particular share.
275 :param name: Name of the share
277 secdesc = self.tdb.get("SECDESC/%s" % name)
278 # FIXME: Run ndr_pull_security_descriptor
282 class Shares(object):
283 """Container for share objects."""
284 def __init__(self, lp, shareinfo):
286 self.shareinfo = shareinfo
289 """Number of shares."""
290 return len(self.lp) - 1
293 """Iterate over the share names."""
294 return self.lp.__iter__()
297 def shellsplit(text):
298 """Very simple shell-like line splitting.
300 :param text: Text to split.
301 :return: List with parts of the line as strings.
308 inquotes = not inquotes
309 elif c in ("\t", "\n", " ") and not inquotes:
319 class WinsDatabase(object):
320 """Samba 3 WINS database reader."""
321 def __init__(self, file):
324 assert f.readline().rstrip("\n") == "VERSION 1 0"
325 for l in f.readlines():
326 if l[0] == "#": # skip comments
328 entries = shellsplit(l.rstrip("\n"))
330 ttl = int(entries[1])
333 while "." in entries[i]:
334 ips.append(entries[i])
336 nb_flags = int(entries[i][:-1], 16)
337 assert not name in self.entries, "Name %s exists twice" % name
338 self.entries[name] = (ttl, ips, nb_flags)
341 def __getitem__(self, name):
342 return self.entries[name]
345 return len(self.entries)
348 return iter(self.entries)
351 """Return the entries in this WINS database."""
352 return self.entries.items()
354 def close(self): # for consistency
358 class Samba3(object):
359 """Samba 3 configuration and state data reader."""
360 def __init__(self, smbconfpath, s3_lp_ctx=None):
361 """Open the configuration and data for a Samba 3 installation.
363 :param smbconfpath: Path to the smb.conf file.
364 :param s3_lp_ctx: Samba3 Loadparm context
366 self.smbconfpath = smbconfpath
370 self.lp = s3param.get_context()
371 self.lp.load(smbconfpath)
373 def statedir_path(self, path):
374 if path[0] == "/" or path[0] == ".":
376 return os.path.join(self.lp.get("state directory"), path)
378 def privatedir_path(self, path):
379 if path[0] == "/" or path[0] == ".":
381 return os.path.join(self.lp.get("private dir"), path)
386 def get_sam_db(self):
387 return passdb.PDB(self.lp.get('passdb backend'))
389 def get_registry(self):
390 return Registry(self.statedir_path("registry.tdb"))
392 def get_secrets_db(self):
393 return SecretsDatabase(self.privatedir_path("secrets.tdb"))
395 def get_shareinfo_db(self):
396 return ShareInfoDatabase(self.statedir_path("share_info.tdb"))
398 def get_idmap_db(self):
399 return IdmapDatabase(self.statedir_path("winbindd_idmap.tdb"))
401 def get_wins_db(self):
402 return WinsDatabase(self.statedir_path("wins.dat"))
404 def get_shares(self):
405 return Shares(self.get_conf(), self.get_shareinfo_db())