8bf75d776e0fff9ebdcaa299b7b01c93214c43ad
[ira/wip.git] / source / scripting / python / samba / upgrade.py
1 #!/usr/bin/python
2 #
3 #       backend code for upgrading from Samba3
4 #       Copyright Jelmer Vernooij 2005-2007
5 #       Released under the GNU GPL v3 or later
6 #
7
8 """Support code for upgrading from Samba 3 to Samba 4."""
9
10 from provision import findnss, provision, FILL_DRS
11 import grp
12 import ldb
13 import time
14 import pwd
15 import uuid
16 import registry
17 from samba import Ldb
18 from samba.samdb import SamDB
19
20 def import_sam_policy(samldb, samba3_policy, domaindn):
21     samldb.modify_ldif("""
22 dn: %s
23 changetype: modify
24 replace: minPwdLength
25 minPwdLength: %d
26 pwdHistoryLength: %d
27 minPwdAge: %d
28 maxPwdAge: %d
29 lockoutDuration: %d
30 samba3ResetCountMinutes: %d
31 samba3UserMustLogonToChangePassword: %d
32 samba3BadLockoutMinutes: %d
33 samba3DisconnectTime: %d
34
35 """ % (dn, policy.min_password_length, 
36     policy.password_history, policy.minimum_password_age,
37     policy.maximum_password_age, policy.lockout_duration,
38     policy.reset_count_minutes, policy.user_must_logon_to_change_password,
39     policy.bad_lockout_minutes, policy.disconnect_time))
40
41
42 def import_sam_account(samldb,acc,domaindn,domainsid):
43     """Import a Samba 3 SAM account.
44     
45     :param samldb: Samba 4 SAM Database handle
46     :param acc: Samba 3 account
47     :param domaindn: Domain DN
48     :param domainsid: Domain SID."""
49     if acc.nt_username is None or acc.nt_username == "":
50         acc.nt_username = acc.username
51
52     if acc.fullname is None:
53         try:
54             acc.fullname = pwd.getpwnam(acc.username)[4].split(",")[0]
55         except KeyError:
56             pass
57
58     if acc.fullname is None:
59         acc.fullname = acc.username
60     
61     assert acc.fullname is not None
62     assert acc.nt_username is not None
63
64     samldb.add({
65         "dn": "cn=%s,%s" % (acc.fullname, domaindn),
66         "objectClass": ["top", "user"],
67         "lastLogon": str(acc.logon_time),
68         "lastLogoff": str(acc.logoff_time),
69         "unixName": acc.username,
70         "sAMAccountName": acc.nt_username,
71         "cn": acc.nt_username,
72         "description": acc.acct_desc,
73         "primaryGroupID": str(acc.group_rid),
74         "badPwdcount": str(acc.bad_password_count),
75         "logonCount": str(acc.logon_count),
76         "samba3Domain": acc.domain,
77         "samba3DirDrive": acc.dir_drive,
78         "samba3MungedDial": acc.munged_dial,
79         "samba3Homedir": acc.homedir, 
80         "samba3LogonScript": acc.logon_script, 
81         "samba3ProfilePath": acc.profile_path,
82         "samba3Workstations": acc.workstations,
83         "samba3KickOffTime": str(acc.kickoff_time),
84         "samba3BadPwdTime": str(acc.bad_password_time),
85         "samba3PassLastSetTime": str(acc.pass_last_set_time),
86         "samba3PassCanChangeTime": str(acc.pass_can_change_time),
87         "samba3PassMustChangeTime": str(acc.pass_must_change_time),
88         "objectSid": "%s-%d" % (domainsid, acc.user_rid),
89         "lmPwdHash:": acc.lm_password,
90         "ntPwdHash:": acc.nt_password,
91         })
92
93
94 def import_sam_group(samldb, sid, gid, sid_name_use, nt_name, comment, domaindn):
95     """Upgrade a SAM group.
96     
97     :param samldb: SAM database.
98     :param gid: Group GID
99     :param sid_name_use: SID name use
100     :param nt_name: NT Group Name
101     :param comment: NT Group Comment
102     :param domaindn: Domain DN
103     """
104
105     if sid_name_use == 5: # Well-known group
106         return None
107
108     if nt_name in ("Domain Guests", "Domain Users", "Domain Admins"):
109         return None
110     
111     if gid == -1:
112         gr = grp.getgrnam(nt_name)
113     else:
114         gr = grp.getgrgid(gid)
115
116     if gr is None:
117         unixname = "UNKNOWN"
118     else:
119         unixname = gr.gr_name
120
121     assert unixname is not None
122     
123     samldb.add({
124         "dn": "cn=%s,%s" % (nt_name, domaindn),
125         "objectClass": ["top", "group"],
126         "description": comment,
127         "cn": nt_name, 
128         "objectSid": sid,
129         "unixName": unixname,
130         "samba3SidNameUse": str(sid_name_use)
131         })
132
133
134 def import_idmap(samdb,samba3_idmap,domaindn):
135     """Import idmap data.
136
137     :param samdb: SamDB handle.
138     :param samba3_idmap: Samba 3 IDMAP database to import from
139     :param domaindn: Domain DN.
140     """
141     samdb.add({
142         "dn": domaindn,
143         "userHwm": str(samba3_idmap.get_user_hwm()),
144         "groupHwm": str(samba3_idmap.get_group_hwm())})
145
146     for uid in samba3_idmap.uids():
147         samdb.add({"dn": "SID=%s,%s" % (samba3_idmap.get_user_sid(uid), domaindn),
148                           "SID": samba3_idmap.get_user_sid(uid),
149                           "type": "user",
150                           "unixID": str(uid)})
151
152     for gid in samba3_idmap.uids():
153         samdb.add({"dn": "SID=%s,%s" % (samba3_idmap.get_group_sid(gid), domaindn),
154                           "SID": samba3_idmap.get_group_sid(gid),
155                           "type": "group",
156                           "unixID": str(gid)})
157
158
159 def import_wins(samba4_winsdb, samba3_winsdb):
160     """Import settings from a Samba3 WINS database.
161     
162     :param samba4_winsdb: WINS database to import to
163     :param samba3_winsdb: WINS database to import from
164     """
165     version_id = 0
166
167     for (name, (ttl, ips, nb_flags)) in samba3_winsdb.items():
168         version_id+=1
169
170         type = int(name.split("#", 1)[1], 16)
171
172         if type == 0x1C:
173             rType = 0x2
174         elif type & 0x80:
175             if len(ips) > 1:
176                 rType = 0x2
177             else:
178                 rType = 0x1
179         else:
180             if len(ips) > 1:
181                 rType = 0x3
182             else:
183                 rType = 0x0
184
185         if ttl > time.time():
186             rState = 0x0 # active
187         else:
188             rState = 0x1 # released
189
190         nType = ((nb_flags & 0x60)>>5)
191
192         samba4_winsdb.add({"dn": "name=%s,type=0x%s" % tuple(name.split("#")),
193                            "type": name.split("#")[1],
194                            "name": name.split("#")[0],
195                            "objectClass": "winsRecord",
196                            "recordType": str(rType),
197                            "recordState": str(rState),
198                            "nodeType": str(nType),
199                            "expireTime": ldb.timestring(ttl),
200                            "isStatic": "0",
201                            "versionID": str(version_id),
202                            "address": ips})
203
204     samba4_winsdb.add({"dn": "CN=VERSION",
205                        "objectClass": "winsMaxVersion",
206                        "maxVersion": str(version_id)})
207
208 def upgrade_provision(samba3, setup_dir, message, credentials, session_info, lp, paths):
209     oldconf = samba3.get_conf()
210
211     if oldconf.get("domain logons") == "True":
212         serverrole = "domain controller"
213     else:
214         if oldconf.get("security") == "user":
215             serverrole = "standalone"
216         else:
217             serverrole = "member server"
218
219     lp.set("server role", serverrole)
220     domainname = oldconf.get("workgroup")
221     if domainname:
222         domainname = str(domainname)
223     lp.set("workgroup", domainname)
224     realm = oldconf.get("realm")
225     netbiosname = oldconf.get("netbios name")
226
227     secrets_db = samba3.get_secrets_db()
228     
229     if domainname is None:
230         domainname = secrets_db.domains()[0]
231         message("No domain specified in smb.conf file, assuming '%s'" % domainname)
232     
233     if realm is None:
234         realm = domainname.lower()
235         message("No realm specified in smb.conf file, assuming '%s'\n" % realm)
236     lp.set("realm", realm)
237
238     domainguid = secrets_db.get_domain_guid(domainname)
239     domainsid = secrets_db.get_sid(domainname)
240     if domainsid is None:
241         message("Can't find domain secrets for '%s'; using random SID\n" % domainname)
242     
243     if netbiosname is not None:
244         machinepass = secrets_db.get_machine_password(netbiosname)
245     else:
246         machinepass = None
247     
248     domaindn = provision(lp=lp, setup_dir=setup_dir, message=message, 
249                          samdb_fill=FILL_DRS, paths=paths, session_info=session_info, 
250                          credentials=credentials, realm=realm, 
251                          domain=domainname, domainsid=domainsid, domainguid=domainguid, 
252                          machinepass=machinepass, serverrole=serverrole)
253
254     samdb = SamDB(paths.samdb, credentials=credentials, lp=lp, session_info=session_info)
255
256     import_wins(Ldb(paths.winsdb), samba3.get_wins_db())
257
258     # FIXME: import_registry(registry.Registry(), samba3.get_registry())
259
260     # FIXME: import_idmap(samdb,samba3.get_idmap_db(),domaindn)
261     
262     groupdb = samba3.get_groupmapping_db()
263     for sid in groupdb.groupsids():
264         (gid, sid_name_use, nt_name, comment) = groupdb.get_group(sid)
265         # FIXME: import_sam_group(samdb, sid, gid, sid_name_use, nt_name, comment, domaindn)
266
267     # FIXME: Aliases
268
269     passdb = samba3.get_sam_db()
270     for name in passdb:
271         user = passdb[name]
272         #FIXME: import_sam_account(samdb, user, domaindn, domainsid)
273
274     if hasattr(passdb, 'ldap_url'):
275         message("Enabling Samba3 LDAP mappings for SAM database")
276
277         enable_samba3sam(samdb, passdb.ldap_url)
278
279
280 def enable_samba3sam(samdb, ldapurl):
281     """Enable Samba 3 LDAP URL database.
282
283     :param samdb: SAM Database.
284     :param ldapurl: Samba 3 LDAP URL
285     """
286     samdb.modify_ldif("""
287 dn: @MODULES
288 changetype: modify
289 replace: @LIST
290 @LIST: samldb,operational,objectguid,rdn_name,samba3sam
291 """)
292
293     samdb.add({"dn": "@MAP=samba3sam", "@MAP_URL": ldapurl})
294
295
296 smbconf_keep = [
297     "dos charset", 
298     "unix charset",
299     "display charset",
300     "comment",
301     "path",
302     "directory",
303     "workgroup",
304     "realm",
305     "netbios name",
306     "netbios aliases",
307     "netbios scope",
308     "server string",
309     "interfaces",
310     "bind interfaces only",
311     "security",
312     "auth methods",
313     "encrypt passwords",
314     "null passwords",
315     "obey pam restrictions",
316     "password server",
317     "smb passwd file",
318     "private dir",
319     "passwd chat",
320     "password level",
321     "lanman auth",
322     "ntlm auth",
323     "client NTLMv2 auth",
324     "client lanman auth",
325     "client plaintext auth",
326     "read only",
327     "hosts allow",
328     "hosts deny",
329     "log level",
330     "debuglevel",
331     "log file",
332     "smb ports",
333     "large readwrite",
334     "max protocol",
335     "min protocol",
336     "unicode",
337     "read raw",
338     "write raw",
339     "disable netbios",
340     "nt status support",
341     "announce version",
342     "announce as",
343     "max mux",
344     "max xmit",
345     "name resolve order",
346     "max wins ttl",
347     "min wins ttl",
348     "time server",
349     "unix extensions",
350     "use spnego",
351     "server signing",
352     "client signing",
353     "max connections",
354     "paranoid server security",
355     "socket options",
356     "strict sync",
357     "max print jobs",
358     "printable",
359     "print ok",
360     "printer name",
361     "printer",
362     "map system",
363     "map hidden",
364     "map archive",
365     "preferred master",
366     "prefered master",
367     "local master",
368     "browseable",
369     "browsable",
370     "wins server",
371     "wins support",
372     "csc policy",
373     "strict locking",
374     "preload",
375     "auto services",
376     "lock dir",
377     "lock directory",
378     "pid directory",
379     "socket address",
380     "copy",
381     "include",
382     "available",
383     "volume",
384     "fstype",
385     "panic action",
386     "msdfs root",
387     "host msdfs",
388     "winbind separator"]
389
390 def upgrade_smbconf(oldconf,mark):
391     """Remove configuration variables not present in Samba4
392
393     :param oldconf: Old configuration structure
394     :param mark: Whether removed configuration variables should be 
395         kept in the new configuration as "samba3:<name>"
396     """
397     data = oldconf.data()
398     newconf = param_init()
399
400     for s in data:
401         for p in data[s]:
402             keep = False
403             for k in smbconf_keep:
404                 if smbconf_keep[k] == p:
405                     keep = True
406                     break
407
408             if keep:
409                 newconf.set(s, p, oldconf.get(s, p))
410             elif mark:
411                 newconf.set(s, "samba3:"+p, oldconf.get(s,p))
412
413     return newconf
414
415 SAMBA3_PREDEF_NAMES = {
416         'HKLM': registry.HKEY_LOCAL_MACHINE,
417 }
418
419 def import_registry(samba4_registry, samba3_regdb):
420     """Import a Samba 3 registry database into the Samba 4 registry.
421
422     :param samba4_registry: Samba 4 registry handle.
423     :param samba3_regdb: Samba 3 registry database handle.
424     """
425     def ensure_key_exists(keypath):
426         (predef_name, keypath) = keypath.split("/", 1)
427         predef_id = SAMBA3_PREDEF_NAMES[predef_name]
428         keypath = keypath.replace("/", "\\")
429         return samba4_registry.create_key(predef_id, keypath)
430
431     for key in samba3_regdb.keys():
432         key_handle = ensure_key_exists(key)
433         for subkey in samba3_regdb.subkeys(key):
434             ensure_key_exists(subkey)
435         for (value_name, (value_type, value_data)) in samba3_regdb.values(key).items():
436             key_handle.set_value(value_name, value_type, value_data)
437
438