1 # Unix SMB/CIFS implementation.
2 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2010
3 # Copyright (C) Matthias Dieter Wallnoefer 2009
5 # Based on the original in EJS:
6 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
7 # Copyright (C) Giampaolo Lauria <lauria2@yahoo.com> 2011
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."""
30 from samba
import dsdb
, dsdb_dns
31 from samba
.ndr
import ndr_unpack
, ndr_pack
32 from samba
.dcerpc
import drsblobs
, misc
33 from samba
.common
import normalise_int32
35 __docformat__
= "restructuredText"
38 class SamDB(samba
.Ldb
):
39 """The SAM database."""
44 def __init__(self
, url
=None, lp
=None, modules_dir
=None, session_info
=None,
45 credentials
=None, flags
=0, options
=None, global_schema
=True,
46 auto_connect
=True, am_rodc
=None):
50 elif url
is None and lp
is not None:
55 super(SamDB
, self
).__init
__(url
=url
, lp
=lp
, modules_dir
=modules_dir
,
56 session_info
=session_info
, credentials
=credentials
, flags
=flags
,
60 dsdb
._dsdb
_set
_global
_schema
(self
)
62 if am_rodc
is not None:
63 dsdb
._dsdb
_set
_am
_rodc
(self
, am_rodc
)
65 def connect(self
, url
=None, flags
=0, options
=None):
66 '''connect to the database'''
67 if self
.lp
is not None and not os
.path
.exists(url
):
68 url
= self
.lp
.private_path(url
)
71 super(SamDB
, self
).connect(url
=url
, flags
=flags
,
75 '''return True if we are an RODC'''
76 return dsdb
._am
_rodc
(self
)
79 '''return True if we are an PDC emulator'''
80 return dsdb
._am
_pdc
(self
)
83 '''return the domain DN'''
84 return str(self
.get_default_basedn())
86 def disable_account(self
, search_filter
):
87 """Disables an account
89 :param search_filter: LDAP filter to find the user (eg
93 flags
= samba
.dsdb
.UF_ACCOUNTDISABLE
94 self
.toggle_userAccountFlags(search_filter
, flags
, on
=True)
96 def enable_account(self
, search_filter
):
99 :param search_filter: LDAP filter to find the user (eg
103 flags
= samba
.dsdb
.UF_ACCOUNTDISABLE | samba
.dsdb
.UF_PASSWD_NOTREQD
104 self
.toggle_userAccountFlags(search_filter
, flags
, on
=False)
106 def toggle_userAccountFlags(self
, search_filter
, flags
, flags_str
=None,
107 on
=True, strict
=False):
108 """Toggle_userAccountFlags
110 :param search_filter: LDAP filter to find the user (eg
112 :param flags: samba.dsdb.UF_* flags
113 :param on: on=True (default) => set, on=False => unset
114 :param strict: strict=False (default) ignore if no action is needed
115 strict=True raises an Exception if...
117 res
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
118 expression
=search_filter
, attrs
=["userAccountControl"])
120 raise Exception("Unable to find account where '%s'" % search_filter
)
121 assert(len(res
) == 1)
122 account_dn
= res
[0].dn
124 old_uac
= int(res
[0]["userAccountControl"][0])
126 if strict
and (old_uac
& flags
):
127 error
= "Account flag(s) '%s' already set" % flags_str
128 raise Exception(error
)
130 new_uac
= old_uac | flags
132 if strict
and not (old_uac
& flags
):
133 error
= "Account flag(s) '%s' already unset" % flags_str
134 raise Exception(error
)
136 new_uac
= old_uac
& ~flags
138 if old_uac
== new_uac
:
144 delete: userAccountControl
145 userAccountControl: %u
146 add: userAccountControl
147 userAccountControl: %u
148 """ % (account_dn
, old_uac
, new_uac
)
149 self
.modify_ldif(mod
)
151 def force_password_change_at_next_login(self
, search_filter
):
152 """Forces a password change at next login
154 :param search_filter: LDAP filter to find the user (eg
157 res
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
158 expression
=search_filter
, attrs
=[])
160 raise Exception('Unable to find user "%s"' % search_filter
)
161 assert(len(res
) == 1)
170 self
.modify_ldif(mod
)
172 def newgroup(self
, groupname
, groupou
=None, grouptype
=None,
173 description
=None, mailaddress
=None, notes
=None, sd
=None,
174 gidnumber
=None, nisdomain
=None):
175 """Adds a new group with additional parameters
177 :param groupname: Name of the new group
178 :param grouptype: Type of the new group
179 :param description: Description of the new group
180 :param mailaddress: Email address of the new group
181 :param notes: Notes of the new group
182 :param gidnumber: GID Number of the new group
183 :param nisdomain: NIS Domain Name of the new group
184 :param sd: security descriptor of the object
187 group_dn
= "CN=%s,%s,%s" % (groupname
, (groupou
or "CN=Users"), self
.domain_dn())
189 # The new user record. Note the reliance on the SAMLDB module which
190 # fills in the default informations
191 ldbmessage
= {"dn": group_dn
,
192 "sAMAccountName": groupname
,
193 "objectClass": "group"}
195 if grouptype
is not None:
196 ldbmessage
["groupType"] = normalise_int32(grouptype
)
198 if description
is not None:
199 ldbmessage
["description"] = description
201 if mailaddress
is not None:
202 ldbmessage
["mail"] = mailaddress
204 if notes
is not None:
205 ldbmessage
["info"] = notes
207 if gidnumber
is not None:
208 ldbmessage
["gidNumber"] = normalise_int32(gidnumber
)
210 if nisdomain
is not None:
211 ldbmessage
["msSFU30Name"] = groupname
212 ldbmessage
["msSFU30NisDomain"] = nisdomain
215 ldbmessage
["nTSecurityDescriptor"] = ndr_pack(sd
)
219 def deletegroup(self
, groupname
):
222 :param groupname: Name of the target group
225 groupfilter
= "(&(sAMAccountName=%s)(objectCategory=%s,%s))" % (ldb
.binary_encode(groupname
), "CN=Group,CN=Schema,CN=Configuration", self
.domain_dn())
226 self
.transaction_start()
228 targetgroup
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
229 expression
=groupfilter
, attrs
=[])
230 if len(targetgroup
) == 0:
231 raise Exception('Unable to find group "%s"' % groupname
)
232 assert(len(targetgroup
) == 1)
233 self
.delete(targetgroup
[0].dn
)
235 self
.transaction_cancel()
238 self
.transaction_commit()
240 def add_remove_group_members(self
, groupname
, members
,
241 add_members_operation
=True):
242 """Adds or removes group members
244 :param groupname: Name of the target group
245 :param members: list of group members
246 :param add_members_operation: Defines if its an add or remove
250 groupfilter
= "(&(sAMAccountName=%s)(objectCategory=%s,%s))" % (
251 ldb
.binary_encode(groupname
), "CN=Group,CN=Schema,CN=Configuration", self
.domain_dn())
253 self
.transaction_start()
255 targetgroup
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
256 expression
=groupfilter
, attrs
=['member'])
257 if len(targetgroup
) == 0:
258 raise Exception('Unable to find group "%s"' % groupname
)
259 assert(len(targetgroup
) == 1)
263 addtargettogroup
= """
266 """ % (str(targetgroup
[0].dn
))
268 for member
in members
:
269 targetmember
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
270 expression
="(|(sAMAccountName=%s)(CN=%s))" % (
271 ldb
.binary_encode(member
), ldb
.binary_encode(member
)), attrs
=[])
273 if len(targetmember
) != 1:
274 raise Exception('Unable to find "%s". Operation cancelled.' % member
)
276 if add_members_operation
is True and (targetgroup
[0].get('member') is None or str(targetmember
[0].dn
) not in targetgroup
[0]['member']):
278 addtargettogroup
+= """add: member
280 """ % (str(targetmember
[0].dn
))
282 elif add_members_operation
is False and (targetgroup
[0].get('member') is not None and str(targetmember
[0].dn
) in targetgroup
[0]['member']):
284 addtargettogroup
+= """delete: member
286 """ % (str(targetmember
[0].dn
))
289 self
.modify_ldif(addtargettogroup
)
292 self
.transaction_cancel()
295 self
.transaction_commit()
297 def newuser(self
, username
, password
,
298 force_password_change_at_next_login_req
=False,
299 useusernameascn
=False, userou
=None, surname
=None, givenname
=None,
300 initials
=None, profilepath
=None, scriptpath
=None, homedrive
=None,
301 homedirectory
=None, jobtitle
=None, department
=None, company
=None,
302 description
=None, mailaddress
=None, internetaddress
=None,
303 telephonenumber
=None, physicaldeliveryoffice
=None, sd
=None,
304 setpassword
=True, uidnumber
=None, gidnumber
=None, gecos
=None,
305 loginshell
=None, uid
=None, nisdomain
=None, unixhome
=None):
306 """Adds a new user with additional parameters
308 :param username: Name of the new user
309 :param password: Password for the new user
310 :param force_password_change_at_next_login_req: Force password change
311 :param useusernameascn: Use username as cn rather that firstname +
313 :param userou: Object container (without domainDN postfix) for new user
314 :param surname: Surname of the new user
315 :param givenname: First name of the new user
316 :param initials: Initials of the new user
317 :param profilepath: Profile path of the new user
318 :param scriptpath: Logon script path of the new user
319 :param homedrive: Home drive of the new user
320 :param homedirectory: Home directory of the new user
321 :param jobtitle: Job title of the new user
322 :param department: Department of the new user
323 :param company: Company of the new user
324 :param description: of the new user
325 :param mailaddress: Email address of the new user
326 :param internetaddress: Home page of the new user
327 :param telephonenumber: Phone number of the new user
328 :param physicaldeliveryoffice: Office location of the new user
329 :param sd: security descriptor of the object
330 :param setpassword: optionally disable password reset
331 :param uidnumber: RFC2307 Unix numeric UID of the new user
332 :param gidnumber: RFC2307 Unix primary GID of the new user
333 :param gecos: RFC2307 Unix GECOS field of the new user
334 :param loginshell: RFC2307 Unix login shell of the new user
335 :param uid: RFC2307 Unix username of the new user
336 :param nisdomain: RFC2307 Unix NIS domain of the new user
337 :param unixhome: RFC2307 Unix home directory of the new user
341 if givenname
is not None:
342 displayname
+= givenname
344 if initials
is not None:
345 displayname
+= ' %s.' % initials
347 if surname
is not None:
348 displayname
+= ' %s' % surname
351 if useusernameascn
is None and displayname
is not "":
354 user_dn
= "CN=%s,%s,%s" % (cn
, (userou
or "CN=Users"), self
.domain_dn())
356 dnsdomain
= ldb
.Dn(self
, self
.domain_dn()).canonical_str().replace("/", "")
357 user_principal_name
= "%s@%s" % (username
, dnsdomain
)
358 # The new user record. Note the reliance on the SAMLDB module which
359 # fills in the default informations
360 ldbmessage
= {"dn": user_dn
,
361 "sAMAccountName": username
,
362 "userPrincipalName": user_principal_name
,
363 "objectClass": "user"}
365 if surname
is not None:
366 ldbmessage
["sn"] = surname
368 if givenname
is not None:
369 ldbmessage
["givenName"] = givenname
371 if displayname
is not "":
372 ldbmessage
["displayName"] = displayname
373 ldbmessage
["name"] = displayname
375 if initials
is not None:
376 ldbmessage
["initials"] = '%s.' % initials
378 if profilepath
is not None:
379 ldbmessage
["profilePath"] = profilepath
381 if scriptpath
is not None:
382 ldbmessage
["scriptPath"] = scriptpath
384 if homedrive
is not None:
385 ldbmessage
["homeDrive"] = homedrive
387 if homedirectory
is not None:
388 ldbmessage
["homeDirectory"] = homedirectory
390 if jobtitle
is not None:
391 ldbmessage
["title"] = jobtitle
393 if department
is not None:
394 ldbmessage
["department"] = department
396 if company
is not None:
397 ldbmessage
["company"] = company
399 if description
is not None:
400 ldbmessage
["description"] = description
402 if mailaddress
is not None:
403 ldbmessage
["mail"] = mailaddress
405 if internetaddress
is not None:
406 ldbmessage
["wWWHomePage"] = internetaddress
408 if telephonenumber
is not None:
409 ldbmessage
["telephoneNumber"] = telephonenumber
411 if physicaldeliveryoffice
is not None:
412 ldbmessage
["physicalDeliveryOfficeName"] = physicaldeliveryoffice
415 ldbmessage
["nTSecurityDescriptor"] = ndr_pack(sd
)
418 if any(map(lambda b
: b
is not None, (uid
, uidnumber
, gidnumber
, gecos
,
419 loginshell
, nisdomain
, unixhome
))):
420 ldbmessage2
= ldb
.Message()
421 ldbmessage2
.dn
= ldb
.Dn(self
, user_dn
)
423 ldbmessage2
["uid"] = ldb
.MessageElement(str(uid
), ldb
.FLAG_MOD_REPLACE
, 'uid')
424 if uidnumber
is not None:
425 ldbmessage2
["uidNumber"] = ldb
.MessageElement(str(uidnumber
), ldb
.FLAG_MOD_REPLACE
, 'uidNumber')
426 if gidnumber
is not None:
427 ldbmessage2
["gidNumber"] = ldb
.MessageElement(str(gidnumber
), ldb
.FLAG_MOD_REPLACE
, 'gidNumber')
428 if gecos
is not None:
429 ldbmessage2
["gecos"] = ldb
.MessageElement(str(gecos
), ldb
.FLAG_MOD_REPLACE
, 'gecos')
430 if loginshell
is not None:
431 ldbmessage2
["loginShell"] = ldb
.MessageElement(str(loginshell
), ldb
.FLAG_MOD_REPLACE
, 'loginShell')
432 if unixhome
is not None:
433 ldbmessage2
["unixHomeDirectory"] = ldb
.MessageElement(
434 str(unixhome
), ldb
.FLAG_MOD_REPLACE
, 'unixHomeDirectory')
435 if nisdomain
is not None:
436 ldbmessage2
["msSFU30NisDomain"] = ldb
.MessageElement(
437 str(nisdomain
), ldb
.FLAG_MOD_REPLACE
, 'msSFU30NisDomain')
438 ldbmessage2
["msSFU30Name"] = ldb
.MessageElement(
439 str(username
), ldb
.FLAG_MOD_REPLACE
, 'msSFU30Name')
440 ldbmessage2
["unixUserPassword"] = ldb
.MessageElement(
441 'ABCD!efgh12345$67890', ldb
.FLAG_MOD_REPLACE
,
444 self
.transaction_start()
448 self
.modify(ldbmessage2
)
450 # Sets the password for it
452 self
.setpassword("(samAccountName=%s)" % ldb
.binary_encode(username
), password
,
453 force_password_change_at_next_login_req
)
455 self
.transaction_cancel()
458 self
.transaction_commit()
461 def deleteuser(self
, username
):
464 :param username: Name of the target user
467 filter = "(&(sAMAccountName=%s)(objectCategory=%s,%s))" % (ldb
.binary_encode(username
), "CN=Person,CN=Schema,CN=Configuration", self
.domain_dn())
468 self
.transaction_start()
470 target
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
471 expression
=filter, attrs
=[])
473 raise Exception('Unable to find user "%s"' % username
)
474 assert(len(target
) == 1)
475 self
.delete(target
[0].dn
)
477 self
.transaction_cancel()
480 self
.transaction_commit()
482 def setpassword(self
, search_filter
, password
,
483 force_change_at_next_login
=False, username
=None):
484 """Sets the password for a user
486 :param search_filter: LDAP filter to find the user (eg
488 :param password: Password for the user
489 :param force_change_at_next_login: Force password change
491 self
.transaction_start()
493 res
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
494 expression
=search_filter
, attrs
=[])
496 raise Exception('Unable to find user "%s"' % (username
or search_filter
))
498 raise Exception('Matched %u multiple users with filter "%s"' % (len(res
), search_filter
))
500 pw
= unicode('"' + password
+ '"', 'utf-8').encode('utf-16-le')
506 """ % (user_dn
, base64
.b64encode(pw
))
508 self
.modify_ldif(setpw
)
510 if force_change_at_next_login
:
511 self
.force_password_change_at_next_login(
512 "(distinguishedName=" + str(user_dn
) + ")")
514 # modify the userAccountControl to remove the disabled bit
515 self
.enable_account(search_filter
)
517 self
.transaction_cancel()
520 self
.transaction_commit()
522 def setexpiry(self
, search_filter
, expiry_seconds
, no_expiry_req
=False):
523 """Sets the account expiry for a user
525 :param search_filter: LDAP filter to find the user (eg
527 :param expiry_seconds: expiry time from now in seconds
528 :param no_expiry_req: if set, then don't expire password
530 self
.transaction_start()
532 res
= self
.search(base
=self
.domain_dn(), scope
=ldb
.SCOPE_SUBTREE
,
533 expression
=search_filter
,
534 attrs
=["userAccountControl", "accountExpires"])
536 raise Exception('Unable to find user "%s"' % search_filter
)
537 assert(len(res
) == 1)
540 userAccountControl
= int(res
[0]["userAccountControl"][0])
541 accountExpires
= int(res
[0]["accountExpires"][0])
543 userAccountControl
= userAccountControl |
0x10000
546 userAccountControl
= userAccountControl
& ~
0x10000
547 accountExpires
= samba
.unix2nttime(expiry_seconds
+ int(time
.time()))
552 replace: userAccountControl
553 userAccountControl: %u
554 replace: accountExpires
556 """ % (user_dn
, userAccountControl
, accountExpires
)
558 self
.modify_ldif(setexp
)
560 self
.transaction_cancel()
563 self
.transaction_commit()
565 def set_domain_sid(self
, sid
):
566 """Change the domain SID used by this LDB.
568 :param sid: The new domain sid to use.
570 dsdb
._samdb
_set
_domain
_sid
(self
, sid
)
572 def get_domain_sid(self
):
573 """Read the domain SID used by this LDB. """
574 return dsdb
._samdb
_get
_domain
_sid
(self
)
576 domain_sid
= property(get_domain_sid
, set_domain_sid
,
577 "SID for the domain")
579 def set_invocation_id(self
, invocation_id
):
580 """Set the invocation id for this SamDB handle.
582 :param invocation_id: GUID of the invocation id.
584 dsdb
._dsdb
_set
_ntds
_invocation
_id
(self
, invocation_id
)
586 def get_invocation_id(self
):
587 """Get the invocation_id id"""
588 return dsdb
._samdb
_ntds
_invocation
_id
(self
)
590 invocation_id
= property(get_invocation_id
, set_invocation_id
,
591 "Invocation ID GUID")
593 def get_oid_from_attid(self
, attid
):
594 return dsdb
._dsdb
_get
_oid
_from
_attid
(self
, attid
)
596 def get_attid_from_lDAPDisplayName(self
, ldap_display_name
,
598 '''return the attribute ID for a LDAP attribute as an integer as found in DRSUAPI'''
599 return dsdb
._dsdb
_get
_attid
_from
_lDAPDisplayName
(self
,
600 ldap_display_name
, is_schema_nc
)
602 def get_syntax_oid_from_lDAPDisplayName(self
, ldap_display_name
):
603 '''return the syntax OID for a LDAP attribute as a string'''
604 return dsdb
._dsdb
_get
_syntax
_oid
_from
_lDAPDisplayName
(self
, ldap_display_name
)
606 def get_systemFlags_from_lDAPDisplayName(self
, ldap_display_name
):
607 '''return the systemFlags for a LDAP attribute as a integer'''
608 return dsdb
._dsdb
_get
_systemFlags
_from
_lDAPDisplayName
(self
, ldap_display_name
)
610 def get_linkId_from_lDAPDisplayName(self
, ldap_display_name
):
611 '''return the linkID for a LDAP attribute as a integer'''
612 return dsdb
._dsdb
_get
_linkId
_from
_lDAPDisplayName
(self
, ldap_display_name
)
614 def get_lDAPDisplayName_by_attid(self
, attid
):
615 '''return the lDAPDisplayName from an integer DRS attribute ID'''
616 return dsdb
._dsdb
_get
_lDAPDisplayName
_by
_attid
(self
, attid
)
618 def get_backlink_from_lDAPDisplayName(self
, ldap_display_name
):
619 '''return the attribute name of the corresponding backlink from the name
620 of a forward link attribute. If there is no backlink return None'''
621 return dsdb
._dsdb
_get
_backlink
_from
_lDAPDisplayName
(self
, ldap_display_name
)
623 def set_ntds_settings_dn(self
, ntds_settings_dn
):
624 """Set the NTDS Settings DN, as would be returned on the dsServiceName
627 This allows the DN to be set before the database fully exists
629 :param ntds_settings_dn: The new DN to use
631 dsdb
._samdb
_set
_ntds
_settings
_dn
(self
, ntds_settings_dn
)
633 def get_ntds_GUID(self
):
634 """Get the NTDS objectGUID"""
635 return dsdb
._samdb
_ntds
_objectGUID
(self
)
637 def server_site_name(self
):
638 """Get the server site name"""
639 return dsdb
._samdb
_server
_site
_name
(self
)
641 def host_dns_name(self
):
642 """return the DNS name of this host"""
643 res
= self
.search(base
='', scope
=ldb
.SCOPE_BASE
, attrs
=['dNSHostName'])
644 return res
[0]['dNSHostName'][0]
646 def domain_dns_name(self
):
647 """return the DNS name of the domain root"""
648 domain_dn
= self
.get_default_basedn()
649 return domain_dn
.canonical_str().split('/')[0]
651 def forest_dns_name(self
):
652 """return the DNS name of the forest root"""
653 forest_dn
= self
.get_root_basedn()
654 return forest_dn
.canonical_str().split('/')[0]
656 def load_partition_usn(self
, base_dn
):
657 return dsdb
._dsdb
_load
_partition
_usn
(self
, base_dn
)
659 def set_schema(self
, schema
, write_indices_and_attributes
=True):
660 self
.set_schema_from_ldb(schema
.ldb
, write_indices_and_attributes
=write_indices_and_attributes
)
662 def set_schema_from_ldb(self
, ldb_conn
, write_indices_and_attributes
=True):
663 dsdb
._dsdb
_set
_schema
_from
_ldb
(self
, ldb_conn
, write_indices_and_attributes
)
665 def dsdb_DsReplicaAttribute(self
, ldb
, ldap_display_name
, ldif_elements
):
666 '''convert a list of attribute values to a DRSUAPI DsReplicaAttribute'''
667 return dsdb
._dsdb
_DsReplicaAttribute
(ldb
, ldap_display_name
, ldif_elements
)
669 def dsdb_normalise_attributes(self
, ldb
, ldap_display_name
, ldif_elements
):
670 '''normalise a list of attribute values'''
671 return dsdb
._dsdb
_normalise
_attributes
(ldb
, ldap_display_name
, ldif_elements
)
673 def get_attribute_from_attid(self
, attid
):
674 """ Get from an attid the associated attribute
676 :param attid: The attribute id for searched attribute
677 :return: The name of the attribute associated with this id
679 if len(self
.hash_oid_name
.keys()) == 0:
680 self
._populate
_oid
_attid
()
681 if self
.hash_oid_name
.has_key(self
.get_oid_from_attid(attid
)):
682 return self
.hash_oid_name
[self
.get_oid_from_attid(attid
)]
686 def _populate_oid_attid(self
):
687 """Populate the hash hash_oid_name.
689 This hash contains the oid of the attribute as a key and
690 its display name as a value
692 self
.hash_oid_name
= {}
693 res
= self
.search(expression
="objectClass=attributeSchema",
694 controls
=["search_options:1:2"],
695 attrs
=["attributeID",
699 strDisplay
= str(e
.get("lDAPDisplayName"))
700 self
.hash_oid_name
[str(e
.get("attributeID"))] = strDisplay
702 def get_attribute_replmetadata_version(self
, dn
, att
):
703 """Get the version field trom the replPropertyMetaData for
706 :param dn: The on which we want to get the version
707 :param att: The name of the attribute
708 :return: The value of the version field in the replPropertyMetaData
709 for the given attribute. None if the attribute is not replicated
712 res
= self
.search(expression
="distinguishedName=%s" % dn
,
713 scope
=ldb
.SCOPE_SUBTREE
,
714 controls
=["search_options:1:2"],
715 attrs
=["replPropertyMetaData"])
719 repl
= ndr_unpack(drsblobs
.replPropertyMetaDataBlob
,
720 str(res
[0]["replPropertyMetaData"]))
722 if len(self
.hash_oid_name
.keys()) == 0:
723 self
._populate
_oid
_attid
()
725 # Search for Description
726 att_oid
= self
.get_oid_from_attid(o
.attid
)
727 if self
.hash_oid_name
.has_key(att_oid
) and\
728 att
.lower() == self
.hash_oid_name
[att_oid
].lower():
732 def set_attribute_replmetadata_version(self
, dn
, att
, value
,
733 addifnotexist
=False):
734 res
= self
.search(expression
="distinguishedName=%s" % dn
,
735 scope
=ldb
.SCOPE_SUBTREE
,
736 controls
=["search_options:1:2"],
737 attrs
=["replPropertyMetaData"])
741 repl
= ndr_unpack(drsblobs
.replPropertyMetaDataBlob
,
742 str(res
[0]["replPropertyMetaData"]))
744 now
= samba
.unix2nttime(int(time
.time()))
746 if len(self
.hash_oid_name
.keys()) == 0:
747 self
._populate
_oid
_attid
()
749 # Search for Description
750 att_oid
= self
.get_oid_from_attid(o
.attid
)
751 if self
.hash_oid_name
.has_key(att_oid
) and\
752 att
.lower() == self
.hash_oid_name
[att_oid
].lower():
754 seq
= self
.sequence_number(ldb
.SEQ_NEXT
)
756 o
.originating_change_time
= now
757 o
.originating_invocation_id
= misc
.GUID(self
.get_invocation_id())
758 o
.originating_usn
= seq
761 if not found
and addifnotexist
and len(ctr
.array
) >0:
762 o2
= drsblobs
.replPropertyMetaData1()
764 att_oid
= self
.get_oid_from_attid(o2
.attid
)
765 seq
= self
.sequence_number(ldb
.SEQ_NEXT
)
767 o2
.originating_change_time
= now
768 o2
.originating_invocation_id
= misc
.GUID(self
.get_invocation_id())
769 o2
.originating_usn
= seq
774 ctr
.count
= ctr
.count
+ 1
778 replBlob
= ndr_pack(repl
)
781 msg
["replPropertyMetaData"] = ldb
.MessageElement(replBlob
,
782 ldb
.FLAG_MOD_REPLACE
,
783 "replPropertyMetaData")
784 self
.modify(msg
, ["local_oid:1.3.6.1.4.1.7165.4.3.14:0"])
786 def write_prefixes_from_schema(self
):
787 dsdb
._dsdb
_write
_prefixes
_from
_schema
_to
_ldb
(self
)
789 def get_partitions_dn(self
):
790 return dsdb
._dsdb
_get
_partitions
_dn
(self
)
792 def get_nc_root(self
, dn
):
793 return dsdb
._dsdb
_get
_nc
_root
(self
, dn
)
795 def get_wellknown_dn(self
, nc_root
, wkguid
):
796 h_nc
= self
.hash_well_known
.get(str(nc_root
))
799 dn
= h_nc
.get(wkguid
)
801 dn
= dsdb
._dsdb
_get
_wellknown
_dn
(self
, nc_root
, wkguid
)
805 self
.hash_well_known
[str(nc_root
)] = {}
806 h_nc
= self
.hash_well_known
[str(nc_root
)]
810 def set_minPwdAge(self
, value
):
812 m
.dn
= ldb
.Dn(self
, self
.domain_dn())
813 m
["minPwdAge"] = ldb
.MessageElement(value
, ldb
.FLAG_MOD_REPLACE
, "minPwdAge")
816 def get_minPwdAge(self
):
817 res
= self
.search(self
.domain_dn(), scope
=ldb
.SCOPE_BASE
, attrs
=["minPwdAge"])
820 elif not "minPwdAge" in res
[0]:
823 return res
[0]["minPwdAge"][0]
825 def set_minPwdLength(self
, value
):
827 m
.dn
= ldb
.Dn(self
, self
.domain_dn())
828 m
["minPwdLength"] = ldb
.MessageElement(value
, ldb
.FLAG_MOD_REPLACE
, "minPwdLength")
831 def get_minPwdLength(self
):
832 res
= self
.search(self
.domain_dn(), scope
=ldb
.SCOPE_BASE
, attrs
=["minPwdLength"])
835 elif not "minPwdLength" in res
[0]:
838 return res
[0]["minPwdLength"][0]
840 def set_pwdProperties(self
, value
):
842 m
.dn
= ldb
.Dn(self
, self
.domain_dn())
843 m
["pwdProperties"] = ldb
.MessageElement(value
, ldb
.FLAG_MOD_REPLACE
, "pwdProperties")
846 def get_pwdProperties(self
):
847 res
= self
.search(self
.domain_dn(), scope
=ldb
.SCOPE_BASE
, attrs
=["pwdProperties"])
850 elif not "pwdProperties" in res
[0]:
853 return res
[0]["pwdProperties"][0]
855 def set_dsheuristics(self
, dsheuristics
):
857 m
.dn
= ldb
.Dn(self
, "CN=Directory Service,CN=Windows NT,CN=Services,%s"
858 % self
.get_config_basedn().get_linearized())
859 if dsheuristics
is not None:
860 m
["dSHeuristics"] = ldb
.MessageElement(dsheuristics
,
861 ldb
.FLAG_MOD_REPLACE
, "dSHeuristics")
863 m
["dSHeuristics"] = ldb
.MessageElement([], ldb
.FLAG_MOD_DELETE
,
867 def get_dsheuristics(self
):
868 res
= self
.search("CN=Directory Service,CN=Windows NT,CN=Services,%s"
869 % self
.get_config_basedn().get_linearized(),
870 scope
=ldb
.SCOPE_BASE
, attrs
=["dSHeuristics"])
873 elif "dSHeuristics" in res
[0]:
874 dsheuristics
= res
[0]["dSHeuristics"][0]
880 def create_ou(self
, ou_dn
, description
=None, name
=None, sd
=None):
881 """Creates an organizationalUnit object
882 :param ou_dn: dn of the new object
883 :param description: description attribute
884 :param name: name atttribute
885 :param sd: security descriptor of the object, can be
886 an SDDL string or security.descriptor type
889 "objectClass": "organizationalUnit"}
892 m
["description"] = description
897 m
["nTSecurityDescriptor"] = ndr_pack(sd
)
900 def sequence_number(self
, seq_type
):
901 """Returns the value of the sequence number according to the requested type
902 :param seq_type: type of sequence number
904 self
.transaction_start()
906 seq
= super(SamDB
, self
).sequence_number(seq_type
)
908 self
.transaction_cancel()
911 self
.transaction_commit()
914 def get_dsServiceName(self
):
915 '''get the NTDS DN from the rootDSE'''
916 res
= self
.search(base
="", scope
=ldb
.SCOPE_BASE
, attrs
=["dsServiceName"])
917 return res
[0]["dsServiceName"][0]
919 def get_serverName(self
):
920 '''get the server DN from the rootDSE'''
921 res
= self
.search(base
="", scope
=ldb
.SCOPE_BASE
, attrs
=["serverName"])
922 return res
[0]["serverName"][0]
924 def dns_lookup(self
, dns_name
):
925 '''Do a DNS lookup in the database, returns the NDR database structures'''
926 return dsdb_dns
.lookup(self
, dns_name
)
928 def dns_extract(self
, el
):
929 '''Return the NDR database structures from a dnsRecord element'''
930 return dsdb_dns
.extract(el
)
932 def dns_replace(self
, dns_name
, new_records
):
933 '''Do a DNS modification on the database, sets the NDR database
934 structures on a DNS name
936 return dsdb_dns
.replace(self
, dns_name
, new_records
)
938 def dns_replace_by_dn(self
, dn
, new_records
):
939 '''Do a DNS modification on the database, sets the NDR database
940 structures on a LDB DN
942 This routine is important because if the last record on the DN
943 is removed, this routine will put a tombstone in the record.
945 return dsdb_dns
.replace_by_dn(self
, dn
, new_records
)