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(db
, key
):
39 return struct
.unpack("<L", data
)[0]
42 def fetch_int32(db
, key
):
48 return struct
.unpack("<l", data
)[0]
51 class DbDatabase(object):
52 """Simple Samba 3 TDB database reader."""
53 def __init__(self
, file):
56 :param file: Path of the file to open, appending .tdb or .ntdb.
58 self
.db
= tdb
.Tdb(file + ".tdb", flags
=os
.O_RDONLY
)
61 def _check_version(self
):
65 """Close resources associated with this object."""
69 class Registry(DbDatabase
):
70 """Simple read-only support for reading the Samba3 registry.
72 :note: This object uses the same syntax for registry key paths as
73 Samba 3. This particular format uses forward slashes for key path
74 separators and abbreviations for the predefined key names.
75 e.g.: HKLM/Software/Bar.
78 """Return the number of keys."""
79 return len(self
.keys())
82 """Return list with all the keys."""
83 return [k
.rstrip("\x00") for k
in self
.db
.iterkeys() if not k
.startswith(REGISTRY_VALUE_PREFIX
)]
85 def subkeys(self
, key
):
86 """Retrieve the subkeys for the specified key.
89 :return: list with key names
91 data
= self
.db
.get("%s\x00" % key
)
94 (num
, ) = struct
.unpack("<L", data
[0:4])
95 keys
= data
[4:].split("\0")
98 assert len(keys
) == num
101 def values(self
, key
):
102 """Return a dictionary with the values set for a specific key.
104 :param key: Key to retrieve values for.
105 :return: Dictionary with value names as key, tuple with type and
107 data
= self
.db
.get("%s/%s\x00" % (REGISTRY_VALUE_PREFIX
, key
))
111 (num
, ) = struct
.unpack("<L", data
[0:4])
115 (name
, data
) = data
.split("\0", 1)
117 (type, ) = struct
.unpack("<L", data
[0:4])
119 (value_len
, ) = struct
.unpack("<L", data
[0:4])
122 ret
[name
] = (type, data
[:value_len
])
123 data
= data
[value_len
:]
128 # High water mark keys
129 IDMAP_HWM_GROUP
= "GROUP HWM\0"
130 IDMAP_HWM_USER
= "USER HWM\0"
132 IDMAP_GROUP_PREFIX
= "GID "
133 IDMAP_USER_PREFIX
= "UID "
135 # idmap version determines auto-conversion
138 class IdmapDatabase(DbDatabase
):
139 """Samba 3 ID map database reader."""
141 def _check_version(self
):
142 assert fetch_int32(self
.db
, "IDMAP_VERSION\0") == IDMAP_VERSION_V2
145 """Retrieve a list of all ids in this database."""
146 for k
in self
.db
.iterkeys():
147 if k
.startswith(IDMAP_USER_PREFIX
):
148 yield k
.rstrip("\0").split(" ")
149 if k
.startswith(IDMAP_GROUP_PREFIX
):
150 yield k
.rstrip("\0").split(" ")
153 """Retrieve a list of all uids in this database."""
154 for k
in self
.db
.iterkeys():
155 if k
.startswith(IDMAP_USER_PREFIX
):
156 yield int(k
[len(IDMAP_USER_PREFIX
):].rstrip("\0"))
159 """Retrieve a list of all gids in this database."""
160 for k
in self
.db
.iterkeys():
161 if k
.startswith(IDMAP_GROUP_PREFIX
):
162 yield int(k
[len(IDMAP_GROUP_PREFIX
):].rstrip("\0"))
164 def get_sid(self
, xid
, id_type
):
165 """Retrive SID associated with a particular id and type.
167 :param xid: UID or GID to retrive SID for.
168 :param id_type: Type of id specified - 'UID' or 'GID'
170 data
= self
.db
.get("%s %s\0" % (id_type
, str(xid
)))
173 return data
.rstrip("\0")
175 def get_user_sid(self
, uid
):
176 """Retrieve the SID associated with a particular uid.
178 :param uid: UID to retrieve SID for.
179 :return: A SID or None if no mapping was found.
181 data
= self
.db
.get("%s%d\0" % (IDMAP_USER_PREFIX
, uid
))
184 return data
.rstrip("\0")
186 def get_group_sid(self
, gid
):
187 data
= self
.db
.get("%s%d\0" % (IDMAP_GROUP_PREFIX
, gid
))
190 return data
.rstrip("\0")
192 def get_user_hwm(self
):
193 """Obtain the user high-water mark."""
194 return fetch_uint32(self
.db
, IDMAP_HWM_USER
)
196 def get_group_hwm(self
):
197 """Obtain the group high-water mark."""
198 return fetch_uint32(self
.db
, IDMAP_HWM_GROUP
)
201 class SecretsDatabase(DbDatabase
):
202 """Samba 3 Secrets database reader."""
204 def get_auth_password(self
):
205 return self
.db
.get("SECRETS/AUTH_PASSWORD")
207 def get_auth_domain(self
):
208 return self
.db
.get("SECRETS/AUTH_DOMAIN")
210 def get_auth_user(self
):
211 return self
.db
.get("SECRETS/AUTH_USER")
213 def get_domain_guid(self
, host
):
214 return self
.db
.get("SECRETS/DOMGUID/%s" % host
)
217 for k
in self
.db
.iterkeys():
218 if k
.startswith("SECRETS/LDAP_BIND_PW/"):
219 yield k
[len("SECRETS/LDAP_BIND_PW/"):].rstrip("\0")
222 """Iterate over domains in this database.
224 :return: Iterator over the names of domains in this database.
226 for k
in self
.db
.iterkeys():
227 if k
.startswith("SECRETS/SID/"):
228 yield k
[len("SECRETS/SID/"):].rstrip("\0")
230 def get_ldap_bind_pw(self
, host
):
231 return self
.db
.get("SECRETS/LDAP_BIND_PW/%s" % host
)
233 def get_afs_keyfile(self
, host
):
234 return self
.db
.get("SECRETS/AFS_KEYFILE/%s" % host
)
236 def get_machine_sec_channel_type(self
, host
):
237 return fetch_uint32(self
.db
, "SECRETS/MACHINE_SEC_CHANNEL_TYPE/%s" % host
)
239 def get_machine_last_change_time(self
, host
):
240 return fetch_uint32(self
.db
, "SECRETS/MACHINE_LAST_CHANGE_TIME/%s" % host
)
242 def get_machine_password(self
, host
):
243 return self
.db
.get("SECRETS/MACHINE_PASSWORD/%s" % host
)
245 def get_machine_acc(self
, host
):
246 return self
.db
.get("SECRETS/$MACHINE.ACC/%s" % host
)
248 def get_domtrust_acc(self
, host
):
249 return self
.db
.get("SECRETS/$DOMTRUST.ACC/%s" % host
)
251 def trusted_domains(self
):
252 for k
in self
.db
.iterkeys():
253 if k
.startswith("SECRETS/$DOMTRUST.ACC/"):
254 yield k
[len("SECRETS/$DOMTRUST.ACC/"):].rstrip("\0")
256 def get_random_seed(self
):
257 return self
.db
.get("INFO/random_seed")
259 def get_sid(self
, host
):
260 return self
.db
.get("SECRETS/SID/%s" % host
.upper())
263 SHARE_DATABASE_VERSION_V1
= 1
264 SHARE_DATABASE_VERSION_V2
= 2
267 class ShareInfoDatabase(DbDatabase
):
268 """Samba 3 Share Info database reader."""
270 def _check_version(self
):
271 assert fetch_int32(self
.db
, "INFO/version\0") in (SHARE_DATABASE_VERSION_V1
, SHARE_DATABASE_VERSION_V2
)
273 def get_secdesc(self
, name
):
274 """Obtain the security descriptor on a particular share.
276 :param name: Name of the share
278 secdesc
= self
.db
.get("SECDESC/%s" % name
)
279 # FIXME: Run ndr_pull_security_descriptor
283 class Shares(object):
284 """Container for share objects."""
285 def __init__(self
, lp
, shareinfo
):
287 self
.shareinfo
= shareinfo
290 """Number of shares."""
291 return len(self
.lp
) - 1
294 """Iterate over the share names."""
295 return self
.lp
.__iter
__()
298 def shellsplit(text
):
299 """Very simple shell-like line splitting.
301 :param text: Text to split.
302 :return: List with parts of the line as strings.
309 inquotes
= not inquotes
310 elif c
in ("\t", "\n", " ") and not inquotes
:
321 class WinsDatabase(object):
322 """Samba 3 WINS database reader."""
323 def __init__(self
, file):
326 assert f
.readline().rstrip("\n") == "VERSION 1 0"
327 for l
in f
.readlines():
328 if l
[0] == "#": # skip comments
330 entries
= shellsplit(l
.rstrip("\n"))
332 ttl
= int(entries
[1])
335 while "." in entries
[i
]:
336 ips
.append(entries
[i
])
338 nb_flags
= int(entries
[i
][:-1], 16)
339 assert not name
in self
.entries
, "Name %s exists twice" % name
340 self
.entries
[name
] = (ttl
, ips
, nb_flags
)
343 def __getitem__(self
, name
):
344 return self
.entries
[name
]
347 return len(self
.entries
)
350 return iter(self
.entries
)
353 """Return the entries in this WINS database."""
354 return self
.entries
.items()
356 def close(self
): # for consistency
360 class Samba3(object):
361 """Samba 3 configuration and state data reader."""
363 def __init__(self
, smbconfpath
, s3_lp_ctx
=None):
364 """Open the configuration and data for a Samba 3 installation.
366 :param smbconfpath: Path to the smb.conf file.
367 :param s3_lp_ctx: Samba3 Loadparm context
369 self
.smbconfpath
= smbconfpath
373 self
.lp
= s3param
.get_context()
374 self
.lp
.load(smbconfpath
)
376 def statedir_path(self
, path
):
377 if path
[0] == "/" or path
[0] == ".":
379 return os
.path
.join(self
.lp
.get("state directory"), path
)
381 def privatedir_path(self
, path
):
382 if path
[0] == "/" or path
[0] == ".":
384 return os
.path
.join(self
.lp
.get("private dir"), path
)
389 def get_sam_db(self
):
390 return passdb
.PDB(self
.lp
.get('passdb backend'))
392 def get_registry(self
):
393 return Registry(self
.statedir_path("registry"))
395 def get_secrets_db(self
):
396 return SecretsDatabase(self
.privatedir_path("secrets"))
398 def get_shareinfo_db(self
):
399 return ShareInfoDatabase(self
.statedir_path("share_info"))
401 def get_idmap_db(self
):
402 return IdmapDatabase(self
.statedir_path("winbindd_idmap"))
404 def get_wins_db(self
):
405 return WinsDatabase(self
.statedir_path("wins.dat"))
407 def get_shares(self
):
408 return Shares(self
.get_conf(), self
.get_shareinfo_db())