s4:samdb.py - Unification of the interfaces
[ira/wip.git] / source4 / scripting / python / samba / samdb.py
index bc3eef7879c50c04566709ef7fd7186d18cdf729..ef2a0b164441ace420f9e923e0f00438e549f6d0 100644 (file)
 """Convenience functions for using the SAM."""
 
 import samba
-import misc
+import glue
 import ldb
+from samba.idmap import IDmapDB
+import pwd
+import time
+import base64
+
+__docformat__ = "restructuredText"
 
 class SamDB(samba.Ldb):
     """The SAM database."""
-    def __init__(self, url=None, session_info=None, credentials=None, 
-                 modules_dir=None, lp=None):
-        """Open the Sam Database.
 
-        :param url: URL of the database.
+    def __init__(self, url=None, lp=None, modules_dir=None, session_info=None,
+                 credentials=None, flags=0, options=None):
+        """Opens the SAM Database
+        For parameter meanings see the super class (samba.Ldb)
         """
-        super(SamDB, self).__init__(session_info=session_info, credentials=credentials,
-                                    modules_dir=modules_dir, lp=lp)
-        assert misc.dsdb_set_global_schema(self) == 0
-        if url:
-            self.connect(url)
-
-    def add_foreign(self, domaindn, sid, desc):
-        """Add a foreign security principle."""
-        add = """
-dn: CN=%s,CN=ForeignSecurityPrincipals,%s
-objectClass: top
-objectClass: foreignSecurityPrincipal
-description: %s
-        """ % (sid, domaindn, desc)
-        # deliberately ignore errors from this, as the records may
-        # already exist
-        for msg in self.parse_ldif(add):
-            self.add(msg[1])
-
-    def enable_account(self, user_dn):
-        """Enable an account.
+
+        self.lp = lp
+        if url is None:
+                url = lp.get("sam database")
+
+        super(SamDB, self).__init__(url=url, lp=lp, modules_dir=modules_dir,
+                session_info=session_info, credentials=credentials, flags=flags,
+                options=options)
+
+        glue.dsdb_set_global_schema(self)
+
+    def connect(self, url=None, flags=0, options=None):
+        super(SamDB, self).connect(url=self.lp.private_path(url), flags=flags,
+                options=options)
+
+    def domain_dn(self):
+        # find the DNs for the domain
+        res = self.search(base="",
+                          scope=ldb.SCOPE_BASE,
+                          expression="(defaultNamingContext=*)",
+                          attrs=["defaultNamingContext"])
+        assert(len(res) == 1 and res[0]["defaultNamingContext"] is not None)
+        return res[0]["defaultNamingContext"][0]
+
+    def enable_account(self, filter):
+        """Enables an account
         
-        :param user_dn: Dn of the account to enable.
+        :param filter: LDAP filter to find the user (eg samccountname=name)
         """
-        res = self.search(user_dn, ldb.SCOPE_BASE, None, ["userAccountControl"])
-        assert len(res) == 1
-        userAccountControl = res[0]["userAccountControl"][0]
-        userAccountControl = int(userAccountControl)
+        res = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                          expression=filter, attrs=["userAccountControl"])
+        assert(len(res) == 1)
+        user_dn = res[0].dn
+
+        userAccountControl = int(res[0]["userAccountControl"][0])
         if (userAccountControl & 0x2):
             userAccountControl = userAccountControl & ~0x2 # remove disabled bit
         if (userAccountControl & 0x20):
@@ -74,9 +87,31 @@ replace: userAccountControl
 userAccountControl: %u
 """ % (user_dn, userAccountControl)
         self.modify_ldif(mod)
+        
+    def force_password_change_at_next_login(self, filter):
+        """Forces a password change at next login
+        
+        :param filter: LDAP filter to find the user (eg samccountname=name)
+        """
+        res = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                          expression=filter, attrs=[])
+        assert(len(res) == 1)
+        user_dn = res[0].dn
 
-    def newuser(self, username, unixname, password):
-        """add a new user record.
+        mod = """
+dn: %s
+changetype: modify
+replace: pwdLastSet
+pwdLastSet: 0
+""" % (user_dn)
+        self.modify_ldif(mod)
+
+    def newuser(self, username, unixname, password, force_password_change_at_next_login=False):
+        """Adds a new user
+
+        Note: This call uses the "userPassword" attribute to set the password.
+        This works correctly on SAMBA 4 DCs and on Windows DCs with
+        "2003 Native" or higer domain function level.
         
         :param username: Name of the new user.
         :param unixname: Name of the unix user to map to.
@@ -84,80 +119,116 @@ userAccountControl: %u
         """
         # connect to the sam 
         self.transaction_start()
-
-        # find the DNs for the domain and the domain users group
-        res = self.search("", scope=ldb.SCOPE_BASE, 
-                          expression="(defaultNamingContext=*)", 
-                          attrs=["defaultNamingContext"])
-        assert(len(res) == 1 and res[0]["defaultNamingContext"] is not None)
-        domain_dn = res[0]["defaultNamingContext"][0]
-        assert(domain_dn is not None)
-        user_dn = "CN=%s,CN=Users,%s" % (username, domain_dn)
-
-        #
-        #  the new user record. note the reliance on the samdb module to fill
-        #  in a sid, guid etc
-        #
-        #  now the real work
-        self.add({"dn": user_dn, 
-            "sAMAccountName": username,
-            "unixName": unixname,
-            "sambaPassword": password,
-            "objectClass": "user"})
-
-        #  modify the userAccountControl to remove the disabled bit
-        self.enable_account(user_dn)
+        try:
+            user_dn = "CN=%s,CN=Users,%s" % (username, self.domain_dn())
+
+            # The new user record. Note the reliance on the SAMLDB module which
+            # fills in the default informations
+            self.add({"dn": user_dn, 
+                "sAMAccountName": username,
+                "userPassword": password,
+                "objectClass": "user"})
+
+            res = self.search(user_dn, scope=ldb.SCOPE_BASE,
+                              expression="objectclass=*",
+                              attrs=["objectSid"])
+            assert len(res) == 1
+            user_sid = self.schema_format_value("objectSid", res[0]["objectSid"][0])
+            
+            try:
+                idmap = IDmapDB(lp=self.lp)
+
+                user = pwd.getpwnam(unixname)
+
+                # setup ID mapping for this UID
+                idmap.setup_name_mapping(user_sid, idmap.TYPE_UID, user[2])
+
+            except KeyError:
+                pass
+
+            if force_password_change_at_next_login:
+                self.force_password_change_at_next_login("(dn=" + user_dn + ")")
+
+            #  modify the userAccountControl to remove the disabled bit
+            self.enable_account("(dn=" + user_dn + ")")
+        except:
+            self.transaction_cancel()
+            raise
         self.transaction_commit()
 
-    def setpassword(self, filter, password):
-        """Set a password on a user record
+    def setpassword(self, filter, password, force_password_change_at_next_login=False):
+        """Sets the password for a user
         
+        Note: This call uses the "userPassword" attribute to set the password.
+        This works correctly on SAMBA 4 DCs and on Windows DCs with
+        "2003 Native" or higer domain function level.
+
         :param filter: LDAP filter to find the user (eg samccountname=name)
         :param password: Password for the user
+        :param force_password_change_at_next_login: Force password change
         """
-        # connect to the sam 
         self.transaction_start()
+        try:
+            res = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                              expression=filter, attrs=[])
+            assert(len(res) == 1)
+            user_dn = res[0].dn
 
-        # find the DNs for the domain
-        res = self.search("", scope=ldb.SCOPE_BASE, 
-                          expression="(defaultNamingContext=*)", 
-                          attrs=["defaultNamingContext"])
-        assert(len(res) == 1 and res[0]["defaultNamingContext"] is not None)
-        domain_dn = res[0]["defaultNamingContext"][0]
-        assert(domain_dn is not None)
-
-        res = self.search(domain_dn, scope=ldb.SCOPE_SUBTREE, 
-                          expression=filter,
-                          attrs=[])
-        assert(len(res) == 1)
-        user_dn = res[0].dn
-
-        setpw = """
+            setpw = """
 dn: %s
 changetype: modify
-replace: sambaPassword
-sambaPassword: %s
-""" % (user_dn, password)
+replace: userPassword
+userPassword:: %s
+""" % (user_dn, base64.b64encode(password))
 
-        self.modify_ldif(setpw)
+            self.modify_ldif(setpw)
 
-        #  modify the userAccountControl to remove the disabled bit
-        self.enable_account(user_dn)
-        self.transaction_commit()
+            if force_password_change_at_next_login:
+                self.force_password_change_at_next_login(user_dn)
 
-    def set_domain_sid(self, sid):
-        """Change the domain SID used by this SamDB.
+            #  modify the userAccountControl to remove the disabled bit
+            self.enable_account(filter)
+        except:
+            self.transaction_cancel()
+            raise
+        self.transaction_commit()
 
-        :param sid: The new domain sid to use.
+    def setexpiry(self, filter, expiry_seconds, noexpiry=False):
+        """Sets the account expiry for a user
+        
+        :param filter: LDAP filter to find the user (eg samccountname=name)
+        :param expiry_seconds: expiry time from now in seconds
+        :param noexpiry: if set, then don't expire password
         """
-        misc.samdb_set_domain_sid(self, sid)
+        self.transaction_start()
+        try:
+            res = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                              expression=filter,
+                              attrs=["userAccountControl", "accountExpires"])
+            assert len(res) == 1
+            user_dn = res[0].dn
+
+            userAccountControl = int(res[0]["userAccountControl"][0])
+            accountExpires     = int(res[0]["accountExpires"][0])
+            if noexpiry:
+                userAccountControl = userAccountControl | 0x10000
+                accountExpires = 0
+            else:
+                userAccountControl = userAccountControl & ~0x10000
+                accountExpires = glue.unix2nttime(expiry_seconds + int(time.time()))
+
+            setexp = """
+dn: %s
+changetype: modify
+replace: userAccountControl
+userAccountControl: %u
+replace: accountExpires
+accountExpires: %u
+""" % (user_dn, userAccountControl, accountExpires)
 
-    def attach_schema_from_ldif(self, pf, df):
-        misc.dsdb_attach_schema_from_ldif_file(self, pf, df)
+            self.modify_ldif(setexp)
+        except:
+            self.transaction_cancel()
+            raise
+        self.transaction_commit();
 
-    def set_invocation_id(self, invocation_id):
-       """Set the invocation id for this SamDB handle.
-       
-       :param invocation_id: GUID of the invocation id.
-       """
-       misc.dsdb_set_ntds_invocation_id(self, invocation_id)