s4-provision Add support for fixing the DC rid to a particular value
[idra/samba.git] / source4 / scripting / python / samba / upgrade.py
index a6bd07df58dd29189910fc72a5fc42388ef813f0..351581c6eecd26ff3ab7596f347e4a0683dc2b9b 100644 (file)
@@ -1,28 +1,38 @@
-#!/usr/bin/python
+# backend code for upgrading from Samba3
+# Copyright Jelmer Vernooij 2005-2007
 #
-#      backend code for upgrading from Samba3
-#      Copyright Jelmer Vernooij 2005-2007
-#      Released under the GNU GPL v3 or later
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """Support code for upgrading from Samba 3 to Samba 4."""
 
-from provision import findnss, provision
+__docformat__ = "restructuredText"
+
 import grp
+import ldb
+import time
 import pwd
-import uuid
-import registry
-
-# Where prefix is any of:
-# - HKLM
-#   HKU
-#   HKCR
-#   HKPD
-#   HKPT
-#
 
-def upgrade_sam_policy(policy,dn):
-    ldif = """
+from samba import Ldb, registry
+from samba.param import LoadParm
+from samba.provision import provision, FILL_FULL
+from samba.samba3 import passdb
+from samba.samba3 import param as s3param
+
+def import_sam_policy(samldb, policy, dn):
+    """Import a Samba 3 policy database."""
+    samldb.modify_ldif("""
 dn: %s
 changetype: modify
 replace: minPwdLength
@@ -36,129 +46,141 @@ samba3UserMustLogonToChangePassword: %d
 samba3BadLockoutMinutes: %d
 samba3DisconnectTime: %d
 
-""" % (dn, policy.min_password_length, 
+""" % (dn, policy.min_password_length,
     policy.password_history, policy.minimum_password_age,
     policy.maximum_password_age, policy.lockout_duration,
     policy.reset_count_minutes, policy.user_must_logon_to_change_password,
-    policy.bad_lockout_minutes, policy.disconnect_time)
-    
-    return ldif
+    policy.bad_lockout_minutes, policy.disconnect_time))
 
-def upgrade_sam_account(ldb,acc,domaindn,domainsid):
-    """Upgrade a SAM account."""
+
+def import_sam_account(samldb,acc,domaindn,domainsid):
+    """Import a Samba 3 SAM account.
+
+    :param samldb: Samba 4 SAM Database handle
+    :param acc: Samba 3 account
+    :param domaindn: Domain DN
+    :param domainsid: Domain SID."""
     if acc.nt_username is None or acc.nt_username == "":
         acc.nt_username = acc.username
 
     if acc.fullname is None:
-        acc.fullname = pwd.getpwnam(acc.fullname)[4]
-
-    acc.fullname = acc.fullname.split(",")[0]
+        try:
+            acc.fullname = pwd.getpwnam(acc.username)[4].split(",")[0]
+        except KeyError:
+            pass
 
     if acc.fullname is None:
         acc.fullname = acc.username
-    
+
     assert acc.fullname is not None
     assert acc.nt_username is not None
 
-    ldif = """dn: cn=%s,%s
-objectClass: top
-objectClass: user
-lastLogon: %d
-lastLogoff: %d
-unixName: %s
-sAMAccountName: %s
-cn: %s
-description: %s
-primaryGroupID: %d
-badPwdcount: %d
-logonCount: %d
-samba3Domain: %s
-samba3DirDrive: %s
-samba3MungedDial: %s
-samba3Homedir: %s
-samba3LogonScript: %s
-samba3ProfilePath: %s
-samba3Workstations: %s
-samba3KickOffTime: %d
-samba3BadPwdTime: %d
-samba3PassLastSetTime: %d
-samba3PassCanChangeTime: %d
-samba3PassMustChangeTime: %d
-objectSid: %s-%d
-lmPwdHash:: %s
-ntPwdHash:: %s
-
-""" % (ldb.dn_escape(acc.fullname), domaindn, acc.logon_time, acc.logoff_time, acc.username, acc.nt_username, acc.nt_username, 
-acc.acct_desc, acc.group_rid, acc.bad_password_count, acc.logon_count,
-acc.domain, acc.dir_drive, acc.munged_dial, acc.homedir, acc.logon_script, 
-acc.profile_path, acc.workstations, acc.kickoff_time, acc.bad_password_time, 
-acc.pass_last_set_time, acc.pass_can_change_time, acc.pass_must_change_time, domainsid, acc.user_rid,
-    ldb.encode(acc.lm_pw), ldb.encode(acc.nt_pw))
-
-    return ldif
-
-def upgrade_sam_group(group,domaindn):
-    """Upgrade a SAM group."""
-    if group.sid_name_use == 5: # Well-known group
+    samldb.add({
+        "dn": "cn=%s,%s" % (acc.fullname, domaindn),
+        "objectClass": ["top", "user"],
+        "lastLogon": str(acc.logon_time),
+        "lastLogoff": str(acc.logoff_time),
+        "unixName": acc.username,
+        "sAMAccountName": acc.nt_username,
+        "cn": acc.nt_username,
+        "description": acc.acct_desc,
+        "primaryGroupID": str(acc.group_rid),
+        "badPwdcount": str(acc.bad_password_count),
+        "logonCount": str(acc.logon_count),
+        "samba3Domain": acc.domain,
+        "samba3DirDrive": acc.dir_drive,
+        "samba3MungedDial": acc.munged_dial,
+        "samba3Homedir": acc.homedir,
+        "samba3LogonScript": acc.logon_script,
+        "samba3ProfilePath": acc.profile_path,
+        "samba3Workstations": acc.workstations,
+        "samba3KickOffTime": str(acc.kickoff_time),
+        "samba3BadPwdTime": str(acc.bad_password_time),
+        "samba3PassLastSetTime": str(acc.pass_last_set_time),
+        "samba3PassCanChangeTime": str(acc.pass_can_change_time),
+        "samba3PassMustChangeTime": str(acc.pass_must_change_time),
+        "objectSid": "%s-%d" % (domainsid, acc.user_rid),
+        "lmPwdHash:": acc.lm_password,
+        "ntPwdHash:": acc.nt_password,
+        })
+
+
+def import_sam_group(samldb, sid, gid, sid_name_use, nt_name, comment, domaindn):
+    """Upgrade a SAM group.
+
+    :param samldb: SAM database.
+    :param gid: Group GID
+    :param sid_name_use: SID name use
+    :param nt_name: NT Group Name
+    :param comment: NT Group Comment
+    :param domaindn: Domain DN
+    """
+
+    if sid_name_use == 5: # Well-known group
         return None
 
-    if group.nt_name in ("Domain Guests", "Domain Users", "Domain Admins"):
+    if nt_name in ("Domain Guests", "Domain Users", "Domain Admins"):
         return None
-    
-    if group.gid == -1:
-        gr = grp.getgrnam(grp.nt_name)
+
+    if gid == -1:
+        gr = grp.getgrnam(nt_name)
     else:
-        gr = grp.getgrgid(grp.gid)
+        gr = grp.getgrgid(gid)
 
     if gr is None:
-        group.unixname = "UNKNOWN"
+        unixname = "UNKNOWN"
     else:
-        group.unixname = gr.gr_name
-
-    assert group.unixname is not None
-    
-    ldif = """dn: cn=%s,%s
-objectClass: top
-objectClass: group
-description: %s
-cn: %s
-objectSid: %s
-unixName: %s
-samba3SidNameUse: %d
-""" % (group.nt_name, domaindn, 
-group.comment, group.nt_name, group.sid, group.unixname, group.sid_name_use)
-
-    return ldif
-
-def import_idmap(samba4_idmap,samba3_idmap,domaindn):
-    samba4_idmap.add({
+        unixname = gr.gr_name
+
+    assert unixname is not None
+
+    samldb.add({
+        "dn": "cn=%s,%s" % (nt_name, domaindn),
+        "objectClass": ["top", "group"],
+        "description": comment,
+        "cn": nt_name,
+        "objectSid": sid,
+        "unixName": unixname,
+        "samba3SidNameUse": str(sid_name_use)
+        })
+
+
+def import_idmap(samdb,samba3_idmap,domaindn):
+    """Import idmap data.
+
+    :param samdb: SamDB handle.
+    :param samba3_idmap: Samba 3 IDMAP database to import from
+    :param domaindn: Domain DN.
+    """
+    samdb.add({
         "dn": domaindn,
         "userHwm": str(samba3_idmap.get_user_hwm()),
         "groupHwm": str(samba3_idmap.get_group_hwm())})
 
     for uid in samba3_idmap.uids():
-        samba4_idmap.add({"dn": "SID=%s,%s" % (samba3_idmap.get_user_sid(uid), domaindn),
+        samdb.add({"dn": "SID=%s,%s" % (samba3_idmap.get_user_sid(uid), domaindn),
                           "SID": samba3_idmap.get_user_sid(uid),
                           "type": "user",
                           "unixID": str(uid)})
 
     for gid in samba3_idmap.uids():
-        samba4_idmap.add({"dn": "SID=%s,%s" % (samba3_idmap.get_group_sid(gid), domaindn),
+        samdb.add({"dn": "SID=%s,%s" % (samba3_idmap.get_group_sid(gid), domaindn),
                           "SID": samba3_idmap.get_group_sid(gid),
                           "type": "group",
                           "unixID": str(gid)})
 
 
 def import_wins(samba4_winsdb, samba3_winsdb):
-    """Import settings from a Samba3 WINS database."""
+    """Import settings from a Samba3 WINS database.
+
+    :param samba4_winsdb: WINS database to import to
+    :param samba3_winsdb: WINS database to import from
+    """
     version_id = 0
-    import time
 
     for (name, (ttl, ips, nb_flags)) in samba3_winsdb.items():
         version_id+=1
 
-        numIPs = len(e.ips)
-
         type = int(name.split("#", 1)[1], 16)
 
         if type == 0x1C:
@@ -181,68 +203,41 @@ def import_wins(samba4_winsdb, samba3_winsdb):
 
         nType = ((nb_flags & 0x60)>>5)
 
-        samba4_winsdb.add({"dn": "name=%s,type=0x%s" % name.split("#"),
+        samba4_winsdb.add({"dn": "name=%s,type=0x%s" % tuple(name.split("#")),
                            "type": name.split("#")[1],
                            "name": name.split("#")[0],
                            "objectClass": "winsRecord",
                            "recordType": str(rType),
                            "recordState": str(rState),
                            "nodeType": str(nType),
-                           "expireTime": ldb.ldaptime(ttl),
+                           "expireTime": ldb.timestring(ttl),
                            "isStatic": "0",
                            "versionID": str(version_id),
                            "address": ips})
 
-    samba4_winsdb.add({"dn": "CN=VERSION",
+    samba4_winsdb.add({"dn": "cn=VERSION",
+                       "cn": "VERSION",
                        "objectClass": "winsMaxVersion",
                        "maxVersion": str(version_id)})
 
-def upgrade_provision(samba3, setup_dir, message, credentials, session_info, lp, paths):
-    oldconf = samba3.get_conf()
+def enable_samba3sam(samdb, ldapurl):
+    """Enable Samba 3 LDAP URL database.
 
-    if oldconf.get("domain logons") == "True":
-        serverrole = "domain controller"
-    else:
-        if oldconf.get("security") == "user":
-            serverrole = "standalone"
-        else:
-            serverrole = "member server"
+    :param samdb: SAM Database.
+    :param ldapurl: Samba 3 LDAP URL
+    """
+    samdb.modify_ldif("""
+dn: @MODULES
+changetype: modify
+replace: @LIST
+@LIST: samldb,operational,objectguid,rdn_name,samba3sam
+""")
 
-    lp.set("server role", serverrole)
-    domainname = oldconf.get("workgroup")
-    if domainname:
-        domainname = str(domainname)
-    lp.set("workgroup", domainname)
-    realm = oldconf.get("realm")
-    netbiosname = oldconf.get("netbios name")
+    samdb.add({"dn": "@MAP=samba3sam", "@MAP_URL": ldapurl})
 
-    secrets_db = samba3.get_secrets_db()
-    
-    if domainname is None:
-        domainname = secrets_db.domains()[0]
-        message("No domain specified in smb.conf file, assuming '%s'" % domainname)
-    
-    if realm is None:
-        realm = domainname.lower()
-        message("No realm specified in smb.conf file, assuming '%s'\n" % realm)
-    lp.set("realm", realm)
-
-    domainguid = secrets_db.get_domain_guid(domainname)
-    domainsid = secrets_db.get_sid(domainname)
-    if domainsid is None:
-        message("Can't find domain secrets for '%s'; using random SID\n" % domainname)
-    
-    if netbiosname is not None:
-        machinepass = secrets_db.get_machine_password(netbiosname)
-    else:
-        machinepass = None
-    
-    provision(lp=lp, setup_dir=setup_dir, message=message, blank=True, ldapbackend=None, paths=paths, session_info=session_info, 
-              credentials=credentials, realm=realm, domain=domainname, 
-              domainsid=domainsid, domainguid=domainguid, machinepass=machinepass, serverrole=serverrole)
 
 smbconf_keep = [
-    "dos charset", 
+    "dos charset",
     "unix charset",
     "display charset",
     "comment",
@@ -286,8 +281,6 @@ smbconf_keep = [
     "write raw",
     "disable netbios",
     "nt status support",
-    "announce version",
-    "announce as",
     "max mux",
     "max xmit",
     "name resolve order",
@@ -339,11 +332,11 @@ def upgrade_smbconf(oldconf,mark):
     """Remove configuration variables not present in Samba4
 
     :param oldconf: Old configuration structure
-    :param mark: Whether removed configuration variables should be 
+    :param mark: Whether removed configuration variables should be
         kept in the new configuration as "samba3:<name>"
     """
     data = oldconf.data()
-    newconf = param_init()
+    newconf = LoadParm()
 
     for s in data:
         for p in data[s]:
@@ -384,85 +377,120 @@ def import_registry(samba4_registry, samba3_regdb):
             key_handle.set_value(value_name, value_type, value_data)
 
 
-def upgrade(subobj, samba3, message, paths, session_info, credentials):
-    ret = 0
-    samdb = Ldb(paths.samdb, session_info=session_info, credentials=credentials)
+def upgrade_from_samba3(samba3, logger, session_info, smbconf, targetdir):
+    """Upgrade from samba3 database to samba4 AD database
+    """
 
-    message("Writing configuration")
-    newconf = upgrade_smbconf(samba3.configuration,True)
-    newconf.save(paths.smbconf)
+    # Read samba3 smb.conf
+    oldconf = s3param.get_context();
+    oldconf.load(smbconf)
 
-    message("Importing account policies")
-    samdb.modify_ldif(upgrade_sam_policy(samba3,subobj.BASEDN))
-    regdb = Ldb(paths.hklm)
+    if oldconf.get("domain logons"):
+        serverrole = "domain controller"
+    else:
+        if oldconf.get("security") == "user":
+            serverrole = "standalone"
+        else:
+            serverrole = "member server"
 
-    regdb.modify("""
-dn: value=RefusePasswordChange,key=Parameters,key=Netlogon,key=Services,key=CurrentControlSet,key=System,HIVE=NONE
-replace: type
-type: 4
-replace: data
-data: %d
-""" % policy.refuse_machine_password_change)
+    domainname = oldconf.get("workgroup")
+    realm = oldconf.get("realm")
+    netbiosname = oldconf.get("netbios name")
 
-    message("Importing users")
-    for account in samba3.samaccounts:
-        msg = "... " + account.username
-        ldif = upgrade_sam_account(samdb, accounts,subobj.BASEDN,subobj.DOMAINSID)
-        try:
-            samdb.add(ldif)
-        except LdbError, e:
-            # FIXME: Ignore 'Record exists' errors
-            msg += "... error: " + str(e)
-            ret += 1; 
-        message(msg)
-
-    message("Importing groups")
-    for mapping in samba3.groupmappings:
-        msg = "... " + mapping.nt_name
-        ldif = upgrade_sam_group(mapping, subobj.BASEDN)
-        if ldif is not None:
-            try:
-                samdb.add(ldif)
-            except LdbError, e:
-                # FIXME: Ignore 'Record exists' errors
-                msg += "... error: " + str(e)
-                ret += 1
-        message(msg)
-
-    message("Importing WINS data")
-    winsdb = Ldb(paths.winsdb)
-    ldb_erase(winsdb)
-
-    ldif = upgrade_wins(samba3)
-    winsdb.add(ldif)
-
-    # figure out ldapurl, if applicable
-    ldapurl = None
-    pdb = samba3.configuration.get_list("passdb backend")
-    if pdb is not None:
-        for backend in pdb:
-            if len(backend) >= 7 and backend[0:7] == "ldapsam":
-                ldapurl = backend[7:]
-
-    # URL was not specified in passdb backend but ldap /is/ used
-    if ldapurl == "":
-        ldapurl = "ldap://%s" % samba3.configuration.get("ldap server")
-
-    # Enable samba3sam module if original passdb backend was ldap
-    if ldapurl is not None:
-        message("Enabling Samba3 LDAP mappings for SAM database")
-
-        enable_samba3sam(samdb)
-
-    return ret
-
-
-def enable_samba3sam(samdb):
-    samdb.modify("""
-dn: @MODULES
-changetype: modify
-replace: @LIST
-@LIST: samldb,operational,objectguid,rdn_name,samba3sam
-""")
+    # secrets db
+    secrets_db = samba3.get_secrets_db()
 
-    samdb.add({"dn": "@MAP=samba3sam", "@MAP_URL": ldapurl})
+    if not domainname:
+        domainname = secrets_db.domains()[0]
+        logger.warning("No domain specified in smb.conf file, assuming '%s'",
+                domainname)
+
+    if not realm:
+        if oldconf.get("domain logons"):
+            logger.warning("No realm specified in smb.conf file and being a DC. That upgrade path doesn't work! Please add a 'realm' directive to your old smb.conf to let us know which one you want to use (generally it's the upcased DNS domainname).")
+            return
+        else:
+            realm = domainname.upper()
+            logger.warning("No realm specified in smb.conf file, assuming '%s'",
+                    realm)
+
+    # Find machine account and password
+    machinepass = None
+    machinerid = None
+    machinesid = None
+    next_rid = 1000
+
+    try:
+        machinepass = secrets_db.get_machine_password(netbiosname)
+    except:
+        pass
+
+    # We must close the direct pytdb database before the C code loads it
+    secrets_db.close()
+
+    # We must load the group mapping into memory before the passdb code touches it
+    groupdb = samba3.get_groupmapping_db()
+    for sid in groupdb.groupsids():
+        (gid, sid_name_use, nt_name, comment) = groupdb.get_group(sid)
+        # FIXME: import_sam_group(samdb, sid, gid, sid_name_use, nt_name, comment, domaindn)
+    groupdb.close()
+
+    passdb.set_secrets_dir(samba3.libdir)
+
+    try:
+        domainsid = str(passdb.get_global_sam_sid())
+    except:
+        pass
+
+    try:
+        machineacct = old_passdb.getsampwnam('%s$' % netbiosname)
+        machinesid, machinerid = machineacct.user_sid.split()
+    except:
+        pass
+
+    if domainsid is None:
+        logger.warning("Can't find domain secrets for '%s'; using random SID",
+            domainname)
+
+    # Import users from old passdb backend
+    old_passdb = passdb.PDB(oldconf.get('passdb backend'))
+    userlist = old_passdb.search_users(0)
+    userdata = {}
+    for entry in userlist:
+        if machinerid and machinerid == entry['rid']:
+            continue
+        username = entry['account_name']
+        if entry['rid'] < 1000:
+            print("Skipping wellknown rid=%d (for username=%s)\n" % (entry['rid'], username))
+            continue
+        if entry['rid'] >= next_rid:
+            next_rid = entry['rid'] + 1
+        
+        userdata[username] = old_passdb.getsampwnam(username)
+
+    # Do full provision
+    result = provision(logger, session_info, None,
+                       targetdir=targetdir, realm=realm, domain=domainname,
+                       domainsid=domainsid, next_rid=next_rid,
+                       dc_rid=machinerid,
+                       hostname=netbiosname, machinepass=machinepass,
+                       serverrole=serverrole, samdb_fill=FILL_FULL)
+
+    import_wins(Ldb(result.paths.winsdb), samba3.get_wins_db())
+
+    # FIXME: import_registry(registry.Registry(), samba3.get_registry())
+
+    # FIXME: import_idmap(samdb,samba3.get_idmap_db(),domaindn)
+
+    # FIXME: Aliases
+
+    # Export users to samba4 backend
+    new_smbconf = result.lp.configfile
+    newconf = s3param.get_context()
+    newconf.load(new_smbconf)
+
+    new_passdb = passdb.PDB('samba4')
+
+    for username in userdata:
+        print "adding user %s" % username
+        new_passdb.add_sam_account(userdata[username])