s4:samdb.py - "setpassword" - performs password sets using the "unicodePwd" attribute
[kamenim/samba.git] / source4 / scripting / python / samba / samdb.py
index 0dcea72ad77fae256b68819eaef0bd1bf78d4f84..f810926710d2a72849c87cdf65d5cc3e64b579ca 100644 (file)
@@ -1,7 +1,7 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
 # Unix SMB/CIFS implementation.
-# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
+# Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2010
 # Copyright (C) Matthias Dieter Wallnoefer 2009
 #
 # Based on the original in EJS:
@@ -26,8 +26,6 @@
 import dsdb
 import samba
 import ldb
-from samba.idmap import IDmapDB
-import pwd
 import time
 import base64
 
@@ -37,9 +35,12 @@ class SamDB(samba.Ldb):
     """The SAM database."""
 
     def __init__(self, url=None, lp=None, modules_dir=None, session_info=None,
-                 credentials=None, flags=0, options=None, global_schema=True):
+                 credentials=None, flags=0, options=None, global_schema=True,
+                 auto_connect=True, am_rodc=False):
         self.lp = lp
-        if url is None:
+        if not auto_connect:
+            url = None
+        elif url is None and lp is not None:
             url = lp.get("sam database")
 
         super(SamDB, self).__init__(url=url, lp=lp, modules_dir=modules_dir,
@@ -47,10 +48,15 @@ class SamDB(samba.Ldb):
                 options=options)
 
         if global_schema:
-            dsdb.dsdb_set_global_schema(self)
+            dsdb._dsdb_set_global_schema(self)
+
+        dsdb._dsdb_set_am_rodc(self, am_rodc)
 
     def connect(self, url=None, flags=0, options=None):
-        super(SamDB, self).connect(url=self.lp.private_path(url), flags=flags,
+        if self.lp is not None:
+            url = self.lp.private_path(url)
+
+        super(SamDB, self).connect(url=url, flags=flags,
                 options=options)
 
     def domain_dn(self):
@@ -104,61 +110,235 @@ pwdLastSet: 0
 """ % (user_dn)
         self.modify_ldif(mod)
 
-    def newuser(self, username, unixname, password,
-                force_password_change_at_next_login_req=False):
-        """Adds a new user
+    def newgroup(self, groupname, groupou=None, grouptype=None,
+                 description=None, mailaddress=None, notes=None):
+        """Adds a new group with additional parameters
+
+        :param groupname: Name of the new group
+        :param grouptype: Type of the new group
+        :param description: Description of the new group
+        :param mailaddress: Email address of the new group
+        :param notes: Notes of the new group
+        """
+
+        group_dn = "CN=%s,%s,%s" % (groupname, (groupou or "CN=Users"), self.domain_dn())
+
+        # The new user record. Note the reliance on the SAMLDB module which
+        # fills in the default informations
+        ldbmessage = {"dn": group_dn,
+            "sAMAccountName": groupname,
+            "objectClass": "group"}
+
+        if grouptype is not None:
+            ldbmessage["groupType"] = "%d" % grouptype
+
+        if description is not None:
+            ldbmessage["description"] = description
+
+        if mailaddress is not None:
+            ldbmessage["mail"] = mailaddress
+
+        if notes is not None:
+            ldbmessage["info"] = notes
+
+        self.add(ldbmessage)
+
+    def deletegroup(self, groupname):
+        """Deletes a group
+
+        :param groupname: Name of the target group
+        """
+
+        groupfilter = "(&(sAMAccountName=%s)(objectCategory=%s,%s))" % (groupname, "CN=Group,CN=Schema,CN=Configuration", self.domain_dn())
+        self.transaction_start()
+        try:
+            targetgroup = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                               expression=groupfilter, attrs=[])
+            if len(targetgroup) == 0:
+                raise Exception('Unable to find group "%s"' % groupname)
+            assert(len(targetgroup) == 1)
+            self.delete(targetgroup[0].dn);
+        except:
+            self.transaction_cancel()
+            raise
+        else:
+            self.transaction_commit()
+
+    def add_remove_group_members(self, groupname, listofmembers,
+                                  add_members_operation=True):
+        """Adds or removes group members
+
+        :param groupname: Name of the target group
+        :param listofmembers: Comma-separated list of group members
+        :param add_members_operation: Defines if its an add or remove operation
+        """
+
+        groupfilter = "(&(sAMAccountName=%s)(objectCategory=%s,%s))" % (groupname, "CN=Group,CN=Schema,CN=Configuration", self.domain_dn())
+        groupmembers = listofmembers.split(',')
+
+        self.transaction_start()
+        try:
+            targetgroup = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                               expression=groupfilter, attrs=['member'])
+            if len(targetgroup) == 0:
+                raise Exception('Unable to find group "%s"' % groupname)
+            assert(len(targetgroup) == 1)
+
+            modified = False
+
+            addtargettogroup = """
+dn: %s
+changetype: modify
+""" % (str(targetgroup[0].dn))
+
+            for member in groupmembers:
+                targetmember = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
+                                    expression="(|(sAMAccountName=%s)(CN=%s))" % (member, member), attrs=[])
+
+                if len(targetmember) != 1:
+                   continue
+
+                if add_members_operation is True and (targetgroup[0].get('member') is None or str(targetmember[0].dn) not in targetgroup[0]['member']):
+                   modified = True
+                   addtargettogroup += """add: member
+member: %s
+""" % (str(targetmember[0].dn))
+
+                elif add_members_operation is False and (targetgroup[0].get('member') is not None and str(targetmember[0].dn) in targetgroup[0]['member']):
+                   modified = True
+                   addtargettogroup += """delete: member
+member: %s
+""" % (str(targetmember[0].dn))
+
+            if modified is True:
+               self.modify_ldif(addtargettogroup)
+
+        except:
+            self.transaction_cancel()
+            raise
+        else:
+            self.transaction_commit()
+
+    def newuser(self, username, password,
+                force_password_change_at_next_login_req=False,
+                useusernameascn=False, userou=None, surname=None, givenname=None, initials=None,
+                profilepath=None, scriptpath=None, homedrive=None, homedirectory=None,
+                jobtitle=None, department=None, company=None, description=None,
+                mailaddress=None, internetaddress=None, telephonenumber=None,
+                physicaldeliveryoffice=None):
+        """Adds a new user with additional parameters
 
-        Note: This call adds also the ID mapping for winbind; therefore it works
-        *only* on SAMBA 4.
-        
         :param username: Name of the new user
-        :param unixname: Name of the unix user to map to
         :param password: Password for the new user
         :param force_password_change_at_next_login_req: Force password change
+        :param useusernameascn: Use username as cn rather that firstname + initials + lastname
+        :param userou: Object container (without domainDN postfix) for new user
+        :param surname: Surname of the new user
+        :param givenname: First name of the new user
+        :param initials: Initials of the new user
+        :param profilepath: Profile path of the new user
+        :param scriptpath: Logon script path of the new user
+        :param homedrive: Home drive of the new user
+        :param homedirectory: Home directory of the new user
+        :param jobtitle: Job title of the new user
+        :param department: Department of the new user
+        :param company: Company of the new user
+        :param description: of the new user
+        :param mailaddress: Email address of the new user
+        :param internetaddress: Home page of the new user
+        :param telephonenumber: Phone number of the new user
+        :param physicaldeliveryoffice: Office location of the new user
         """
-        self.transaction_start()
-        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,
-                "objectClass": "user"})
+        displayname = "";
+        if givenname is not None:
+            displayname += givenname
 
-            # Sets the password for it
-            self.setpassword("(dn=" + user_dn + ")", password,
-              force_password_change_at_next_login_req)
+        if initials is not None:
+            displayname += ' %s.' % initials
+
+        if surname is not None:
+            displayname += ' %s' % surname
+
+        cn = username
+        if useusernameascn is None and displayname is not "":
+            cn = displayname
+
+        user_dn = "CN=%s,%s,%s" % (cn, (userou or "CN=Users"), self.domain_dn())
+
+        # The new user record. Note the reliance on the SAMLDB module which
+        # fills in the default informations
+        ldbmessage = {"dn": user_dn,
+            "sAMAccountName": username,
+            "objectClass": "user"}
+
+        if surname is not None:
+            ldbmessage["sn"] = surname
+
+        if givenname is not None:
+            ldbmessage["givenName"] = givenname
+
+        if displayname is not "":
+            ldbmessage["displayName"] = displayname
+            ldbmessage["name"] = displayname
+
+        if initials is not None:
+            ldbmessage["initials"] = '%s.' % initials
+
+        if profilepath is not None:
+            ldbmessage["profilePath"] = profilepath
+
+        if scriptpath is not None:
+            ldbmessage["scriptPath"] = scriptpath
+
+        if homedrive is not None:
+            ldbmessage["homeDrive"] = homedrive
+
+        if homedirectory is not None:
+            ldbmessage["homeDirectory"] = homedirectory
+
+        if jobtitle is not None:
+            ldbmessage["title"] = jobtitle
+
+        if department is not None:
+            ldbmessage["department"] = department
 
-            # Gets the user SID (for the account mapping setup)
-            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)
+        if company is not None:
+            ldbmessage["company"] = company
 
-                user = pwd.getpwnam(unixname)
+        if description is not None:
+            ldbmessage["description"] = description
 
-                # setup ID mapping for this UID
-                idmap.setup_name_mapping(user_sid, idmap.TYPE_UID, user[2])
+        if mailaddress is not None:
+            ldbmessage["mail"] = mailaddress
 
-            except KeyError:
-                pass
+        if internetaddress is not None:
+            ldbmessage["wWWHomePage"] = internetaddress
+
+        if telephonenumber is not None:
+            ldbmessage["telephoneNumber"] = telephonenumber
+
+        if physicaldeliveryoffice is not None:
+            ldbmessage["physicalDeliveryOfficeName"] = physicaldeliveryoffice
+
+        self.transaction_start()
+        try:
+            self.add(ldbmessage)
+
+            # Sets the password for it
+            self.setpassword("(dn=" + user_dn + ")", password,
+              force_password_change_at_next_login_req)
         except:
             self.transaction_cancel()
             raise
-        self.transaction_commit()
+        else:
+            self.transaction_commit()
 
-    def setpassword(self, filter, password, force_change_at_next_login=False):
+    def setpassword(self, filter, password,
+                    force_change_at_next_login=False,
+                    username=None):
         """Sets the password for a user
         
-        Note: This call uses the "userPassword" attribute to set the password.
-        This works correctly on SAMBA 4 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_change_at_next_login: Force password change
@@ -167,15 +347,17 @@ pwdLastSet: 0
         try:
             res = self.search(base=self.domain_dn(), scope=ldb.SCOPE_SUBTREE,
                               expression=filter, attrs=[])
+            if len(res) == 0:
+                raise Exception('Unable to find user "%s"' % (username or filter))
             assert(len(res) == 1)
             user_dn = res[0].dn
 
             setpw = """
 dn: %s
 changetype: modify
-replace: userPassword
-userPassword:: %s
-""" % (user_dn, base64.b64encode(password))
+replace: unicodePwd
+unicodePwd:: %s
+""" % (user_dn, base64.b64encode(("\"" + password + "\"").encode('utf-16-le')))
 
             self.modify_ldif(setpw)
 
@@ -188,7 +370,8 @@ userPassword:: %s
         except:
             self.transaction_cancel()
             raise
-        self.transaction_commit()
+        else:
+            self.transaction_commit()
 
     def setexpiry(self, filter, expiry_seconds, no_expiry_req=False):
         """Sets the account expiry for a user
@@ -227,31 +410,44 @@ accountExpires: %u
         except:
             self.transaction_cancel()
             raise
-        self.transaction_commit()
+        else:
+            self.transaction_commit()
 
     def set_domain_sid(self, sid):
         """Change the domain SID used by this LDB.
 
         :param sid: The new domain sid to use.
         """
-        dsdb.samdb_set_domain_sid(self, sid)
+        dsdb._samdb_set_domain_sid(self, sid)
 
     def get_domain_sid(self):
         """Read the domain SID used by this LDB.
 
         """
-        dsdb.samdb_get_domain_sid(self)
+        dsdb._samdb_get_domain_sid(self)
 
     def set_invocation_id(self, invocation_id):
         """Set the invocation id for this SamDB handle.
 
         :param invocation_id: GUID of the invocation id.
         """
-        dsdb.dsdb_set_ntds_invocation_id(self, invocation_id)
+        dsdb._dsdb_set_ntds_invocation_id(self, invocation_id)
+
+    def get_oid_from_attid(self, attid):
+        return dsdb._dsdb_get_oid_from_attid(self, attid)
 
     def get_invocation_id(self):
         "Get the invocation_id id"
-        return dsdb.samdb_ntds_invocation_id(self)
+        return dsdb._samdb_ntds_invocation_id(self)
+
+    def set_ntds_settings_dn(self, ntds_settings_dn):
+        """Set the NTDS Settings DN, as would be returned on the dsServiceName rootDSE attribute
+
+        This allows the DN to be set before the database fully exists
+
+        :param ntds_settings_dn: The new DN to use
+        """
+        dsdb._samdb_set_ntds_settings_dn(self, ntds_settings_dn)
 
     invocation_id = property(get_invocation_id, set_invocation_id)
 
@@ -259,8 +455,20 @@ accountExpires: %u
 
     def get_ntds_GUID(self):
         "Get the NTDS objectGUID"
-        return dsdb.samdb_ntds_objectGUID(self)
+        return dsdb._samdb_ntds_objectGUID(self)
 
     def server_site_name(self):
         "Get the server site name"
-        return dsdb.samdb_server_site_name(self)
+        return dsdb._samdb_server_site_name(self)
+
+    def load_partition_usn(self, base_dn):
+        return dsdb._dsdb_load_partition_usn(self, base_dn)
+
+    def set_schema(self, schema):
+        self.set_schema_from_ldb(schema.ldb)
+
+    def set_schema_from_ldb(self, ldb):
+        dsdb._dsdb_set_schema_from_ldb(self, ldb)
+
+    def write_prefixes_from_schema(self):
+        dsdb._dsdb_write_prefixes_from_schema_to_ldb(self)