3 # Unix SMB/CIFS implementation.
4 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2008
6 # Based on the original in EJS:
7 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
9 # This program is free software; you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 """Convenience functions for using the SAM."""
29 class SamDB(samba.Ldb):
30 """The SAM database."""
31 def __init__(self, url=None, session_info=None, credentials=None,
32 modules_dir=None, lp=None):
33 """Open the Sam Database.
35 :param url: URL of the database.
37 super(SamDB, self).__init__(session_info=session_info, credentials=credentials,
38 modules_dir=modules_dir, lp=lp)
39 assert misc.dsdb_set_global_schema(self) == 0
43 def add_foreign(self, domaindn, sid, desc):
44 """Add a foreign security principle."""
46 dn: CN=%s,CN=ForeignSecurityPrincipals,%s
48 objectClass: foreignSecurityPrincipal
50 """ % (sid, domaindn, desc)
51 # deliberately ignore errors from this, as the records may
53 for msg in self.parse_ldif(add):
56 def setup_name_mapping(self, domaindn, sid, unixname):
57 """Setup a mapping between a sam name and a unix name.
59 :param domaindn: DN of the domain.
60 :param sid: SID of the NT-side of the mapping.
61 :param unixname: Unix name to map to.
63 res = self.search(domaindn, ldb.SCOPE_SUBTREE,
64 "objectSid=%s" % sid, ["dn"])
65 assert len(res) == 1, "Failed to find record for objectSid %s" % sid
72 """ % (res[0].dn, unixname)
73 self.modify(self.parse_ldif(mod).next()[1])
75 def enable_account(self, user_dn):
78 :param user_dn: Dn of the account to enable.
80 res = self.search(user_dn, ldb.SCOPE_BASE, None, ["userAccountControl"])
82 userAccountControl = res[0]["userAccountControl"][0]
83 userAccountControl = int(userAccountControl)
84 if (userAccountControl & 0x2):
85 userAccountControl = userAccountControl & ~0x2 # remove disabled bit
86 if (userAccountControl & 0x20):
87 userAccountControl = userAccountControl & ~0x20 # remove 'no password required' bit
92 replace: userAccountControl
93 userAccountControl: %u
94 """ % (user_dn, userAccountControl)
97 def newuser(self, username, unixname, password):
98 """add a new user record.
100 :param username: Name of the new user.
101 :param unixname: Name of the unix user to map to.
102 :param password: Password for the new user
105 self.transaction_start()
107 # find the DNs for the domain and the domain users group
108 res = self.search("", scope=ldb.SCOPE_BASE,
109 expression="(defaultNamingContext=*)",
110 attrs=["defaultNamingContext"])
111 assert(len(res) == 1 and res[0]["defaultNamingContext"] is not None)
112 domain_dn = res[0]["defaultNamingContext"][0]
113 assert(domain_dn is not None)
114 user_dn = "CN=%s,CN=Users,%s" % (username, domain_dn)
117 # the new user record. note the reliance on the samdb module to fill
121 self.add({"dn": user_dn,
122 "sAMAccountName": username,
123 "unixName": unixname,
124 "sambaPassword": password,
125 "objectClass": "user"})
127 # modify the userAccountControl to remove the disabled bit
128 self.enable_account(user_dn)
129 self.transaction_commit()
131 def setpassword(self, filter, password):
132 """Set a password on a user record
134 :param filter: LDAP filter to find the user (eg samccountname=name)
135 :param password: Password for the user
138 self.transaction_start()
140 # find the DNs for the domain
141 res = self.search("", scope=ldb.SCOPE_BASE,
142 expression="(defaultNamingContext=*)",
143 attrs=["defaultNamingContext"])
144 assert(len(res) == 1 and res[0]["defaultNamingContext"] is not None)
145 domain_dn = res[0]["defaultNamingContext"][0]
146 assert(domain_dn is not None)
148 res = self.search(domain_dn, scope=ldb.SCOPE_SUBTREE,
151 assert(len(res) == 1)
157 replace: sambaPassword
159 """ % (user_dn, password)
161 self.modify_ldif(setpw)
163 # modify the userAccountControl to remove the disabled bit
164 self.enable_account(user_dn)
165 self.transaction_commit()
167 def set_domain_sid(self, sid):
168 """Change the domain SID used by this SamDB.
170 :param sid: The new domain sid to use.
172 misc.samdb_set_domain_sid(self, sid)
174 def attach_schema_from_ldif(self, pf, df):
175 misc.dsdb_attach_schema_from_ldif_file(self, pf, df)
177 def set_invocation_id(self, invocation_id):
178 """Set the invocation id for this SamDB handle.
180 :param invocation_id: GUID of the invocation id.
182 misc.dsdb_set_ntds_invocation_id(self, invocation_id)