#!/usr/bin/env python # # KCC topology utilities # # Copyright (C) Dave Craft 2011 # Copyright (C) Jelmer Vernooij 2011 # # 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 . import ldb import uuid from samba import dsdb from samba.dcerpc import ( drsblobs, drsuapi, misc, ) from samba.common import dsdb_Dn from samba.ndr import (ndr_unpack, ndr_pack) class NCType(object): (unknown, schema, domain, config, application) = range(0, 5) class NamingContext(object): """Base class for a naming context. Holds the DN, GUID, SID (if available) and type of the DN. Subclasses may inherit from this and specialize """ def __init__(self, nc_dnstr, nc_guid=None, nc_sid=None): """Instantiate a NamingContext :param nc_dnstr: NC dn string :param nc_guid: NC guid :param nc_sid: NC sid """ self.nc_dnstr = nc_dnstr self.nc_guid = nc_guid self.nc_sid = nc_sid self.nc_type = NCType.unknown def __str__(self): '''Debug dump string output of class''' text = "%s:" % self.__class__.__name__ text = text + "\n\tnc_dnstr=%s" % self.nc_dnstr text = text + "\n\tnc_guid=%s" % str(self.nc_guid) text = text + "\n\tnc_sid=%s" % self.nc_sid text = text + "\n\tnc_type=%s" % self.nc_type return text def is_schema(self): '''Return True if NC is schema''' return self.nc_type == NCType.schema def is_domain(self): '''Return True if NC is domain''' return self.nc_type == NCType.domain def is_application(self): '''Return True if NC is application''' return self.nc_type == NCType.application def is_config(self): '''Return True if NC is config''' return self.nc_type == NCType.config def identify_by_basedn(self, samdb): """Given an NC object, identify what type is is thru the samdb basedn strings and NC sid value """ # We check against schema and config because they # will be the same for all nTDSDSAs in the forest. # That leaves the domain NCs which can be identified # by sid and application NCs as the last identified if self.nc_dnstr == str(samdb.get_schema_basedn()): self.nc_type = NCType.schema elif self.nc_dnstr == str(samdb.get_config_basedn()): self.nc_type = NCType.config elif self.nc_sid is not None: self.nc_type = NCType.domain else: self.nc_type = NCType.application def identify_by_dsa_attr(self, samdb, attr): """Given an NC which has been discovered thru the nTDSDSA database object, determine what type of NC it is (i.e. schema, config, domain, application) via the use of the schema attribute under which the NC was found. :param attr: attr of nTDSDSA object where NC DN appears """ # If the NC is listed under msDS-HasDomainNCs then # this can only be a domain NC and it is our default # domain for this dsa if attr == "msDS-HasDomainNCs": self.nc_type = NCType.domain # If the NC is listed under hasPartialReplicaNCs # this is only a domain NC elif attr == "hasPartialReplicaNCs": self.nc_type = NCType.domain # NCs listed under hasMasterNCs are either # default domain, schema, or config. We # utilize the identify_by_samdb_basedn() to # identify those elif attr == "hasMasterNCs": self.identify_by_basedn(samdb) # Still unknown (unlikely) but for completeness # and for finally identifying application NCs if self.nc_type == NCType.unknown: self.identify_by_basedn(samdb) class NCReplica(NamingContext): """Naming context replica that is relative to a specific DSA. This is a more specific form of NamingContext class (inheriting from that class) and it identifies unique attributes of the DSA's replica for a NC. """ def __init__(self, dsa_dnstr, dsa_guid, nc_dnstr, nc_guid=None, nc_sid=None): """Instantiate a Naming Context Replica :param dsa_guid: GUID of DSA where replica appears :param nc_dnstr: NC dn string :param nc_guid: NC guid :param nc_sid: NC sid """ self.rep_dsa_dnstr = dsa_dnstr self.rep_dsa_guid = dsa_guid self.rep_default = False # replica for DSA's default domain self.rep_partial = False self.rep_ro = False self.rep_instantiated_flags = 0 # RepsFromTo tuples self.rep_repsFrom = [] # The (is present) test is a combination of being # enumerated in (hasMasterNCs or msDS-hasFullReplicaNCs or # hasPartialReplicaNCs) as well as its replica flags found # thru the msDS-HasInstantiatedNCs. If the NC replica meets # the first enumeration test then this flag is set true self.rep_present_criteria_one = False # Call my super class we inherited from NamingContext.__init__(self, nc_dnstr, nc_guid, nc_sid) def __str__(self): '''Debug dump string output of class''' text = "%s:" % self.__class__.__name__ text = text + "\n\tdsa_dnstr=%s" % self.rep_dsa_dnstr text = text + "\n\tdsa_guid=%s" % str(self.rep_dsa_guid) text = text + "\n\tdefault=%s" % self.rep_default text = text + "\n\tro=%s" % self.rep_ro text = text + "\n\tpartial=%s" % self.rep_partial text = text + "\n\tpresent=%s" % self.is_present() for rep in self.rep_repsFrom: text = text + "\n%s" % rep return "%s\n%s" % (NamingContext.__str__(self), text) def set_instantiated_flags(self, flags=None): '''Set or clear NC replica instantiated flags''' if (flags == None): self.rep_instantiated_flags = 0 else: self.rep_instantiated_flags = flags def identify_by_dsa_attr(self, samdb, attr): """Given an NC which has been discovered thru the nTDSDSA database object, determine what type of NC replica it is (i.e. partial, read only, default) :param attr: attr of nTDSDSA object where NC DN appears """ # If the NC was found under hasPartialReplicaNCs # then a partial replica at this dsa if attr == "hasPartialReplicaNCs": self.rep_partial = True self.rep_present_criteria_one = True # If the NC is listed under msDS-HasDomainNCs then # this can only be a domain NC and it is the DSA's # default domain NC elif attr == "msDS-HasDomainNCs": self.rep_default = True # NCs listed under hasMasterNCs are either # default domain, schema, or config. We check # against schema and config because they will be # the same for all nTDSDSAs in the forest. That # leaves the default domain NC remaining which # may be different for each nTDSDSAs (and thus # we don't compare agains this samdb's default # basedn elif attr == "hasMasterNCs": self.rep_present_criteria_one = True if self.nc_dnstr != str(samdb.get_schema_basedn()) and \ self.nc_dnstr != str(samdb.get_config_basedn()): self.rep_default = True # RODC only elif attr == "msDS-hasFullReplicaNCs": self.rep_present_criteria_one = True self.rep_ro = True # Not RODC elif attr == "msDS-hasMasterNCs": self.rep_ro = False # Now use this DSA attribute to identify the naming # context type by calling the super class method # of the same name NamingContext.identify_by_dsa_attr(self, samdb, attr) def is_default(self): """Whether this is a default domain for the dsa that this NC appears on """ return self.rep_default def is_ro(self): '''Return True if NC replica is read only''' return self.rep_ro def is_partial(self): '''Return True if NC replica is partial''' return self.rep_partial def is_present(self): """Given an NC replica which has been discovered thru the nTDSDSA database object and populated with replica flags from the msDS-HasInstantiatedNCs; return whether the NC replica is present (true) or if the IT_NC_GOING flag is set then the NC replica is not present (false) """ if self.rep_present_criteria_one and \ self.rep_instantiated_flags & dsdb.INSTANCE_TYPE_NC_GOING == 0: return True return False def load_repsFrom(self, samdb): """Given an NC replica which has been discovered thru the nTDSDSA database object, load the repsFrom attribute for the local replica. held by my dsa. The repsFrom attribute is not replicated so this attribute is relative only to the local DSA that the samdb exists on """ try: res = samdb.search(base=self.nc_dnstr, scope=ldb.SCOPE_BASE, attrs=[ "repsFrom" ]) except ldb.LdbError, (enum, estr): raise Exception("Unable to find NC for (%s) - (%s)" % (self.nc_dnstr, estr)) msg = res[0] # Possibly no repsFrom if this is a singleton DC if "repsFrom" in msg: for value in msg["repsFrom"]: rep = RepsFromTo(self.nc_dnstr, ndr_unpack(drsblobs.repsFromToBlob, value)) self.rep_repsFrom.append(rep) def commit_repsFrom(self, samdb): """Commit repsFrom to the database""" # XXX - This is not truly correct according to the MS-TECH # docs. To commit a repsFrom we should be using RPCs # IDL_DRSReplicaAdd, IDL_DRSReplicaModify, and # IDL_DRSReplicaDel to affect a repsFrom change. # # Those RPCs are missing in samba, so I'll have to # implement them to get this to more accurately # reflect the reference docs. As of right now this # commit to the database will work as its what the # older KCC also did modify = False newreps = [] for repsFrom in self.rep_repsFrom: # Leave out any to be deleted from # replacement list if repsFrom.to_be_deleted == True: modify = True continue if repsFrom.is_modified(): modify = True newreps.append(ndr_pack(repsFrom.ndr_blob)) # Nothing to do if no reps have been modified or # need to be deleted. Leave database record "as is" if modify == False: return m = ldb.Message() m.dn = ldb.Dn(samdb, self.nc_dnstr) m["repsFrom"] = \ ldb.MessageElement(newreps, ldb.FLAG_MOD_REPLACE, "repsFrom") try: samdb.modify(m) except ldb.LdbError, estr: raise Exception("Could not set repsFrom for (%s) - (%s)" % (self.dsa_dnstr, estr)) def load_fsmo_roles(self, samdb): # XXX - to be implemented return def is_fsmo_role_owner(self, dsa_dnstr): # XXX - to be implemented return False class DirectoryServiceAgent(object): def __init__(self, dsa_dnstr): """Initialize DSA class. Class is subsequently fully populated by calling the load_dsa() method :param dsa_dnstr: DN of the nTDSDSA """ self.dsa_dnstr = dsa_dnstr self.dsa_guid = None self.dsa_ivid = None self.dsa_is_ro = False self.dsa_options = 0 self.dsa_behavior = 0 self.default_dnstr = None # default domain dn string for dsa # NCReplicas for this dsa that are "present" # Indexed by DN string of naming context self.current_rep_table = {} # NCReplicas for this dsa that "should be present" # Indexed by DN string of naming context self.needed_rep_table = {} # NTDSConnections for this dsa. These are current # valid connections that are committed or "to be committed" # in the database. Indexed by DN string of connection self.connect_table = {} def __str__(self): '''Debug dump string output of class''' text = "%s:" % self.__class__.__name__ if self.dsa_dnstr is not None: text = text + "\n\tdsa_dnstr=%s" % self.dsa_dnstr if self.dsa_guid is not None: text = text + "\n\tdsa_guid=%s" % str(self.dsa_guid) if self.dsa_ivid is not None: text = text + "\n\tdsa_ivid=%s" % str(self.dsa_ivid) text = text + "\n\tro=%s" % self.is_ro() text = text + "\n\tgc=%s" % self.is_gc() text = text + "\ncurrent_replica_table:" text = text + "\n%s" % self.dumpstr_current_replica_table() text = text + "\nneeded_replica_table:" text = text + "\n%s" % self.dumpstr_needed_replica_table() text = text + "\nconnect_table:" text = text + "\n%s" % self.dumpstr_connect_table() return text def get_current_replica(self, nc_dnstr): return self.current_rep_table[nc_dnstr] def is_ro(self): '''Returns True if dsa a read only domain controller''' return self.dsa_is_ro def is_gc(self): '''Returns True if dsa hosts a global catalog''' if (self.options & dsdb.DS_NTDSDSA_OPT_IS_GC) != 0: return True return False def is_minimum_behavior(self, version): """Is dsa at minimum windows level greater than or equal to (version) :param version: Windows version to test against (e.g. DS_BEHAVIOR_WIN2008) """ if self.dsa_behavior >= version: return True return False def should_translate_ntdsconn(self): """Whether this allows NTDSConnection translation in its options.""" if (self.options & dsdb.DS_NTDSDSA_OPT_DISABLE_NTDSCONN_XLATE) != 0: return False return True def get_rep_tables(self): """Return DSA current and needed replica tables """ return self.current_rep_table, self.needed_rep_table def get_parent_dnstr(self): """Get the parent DN string of this object.""" head, sep, tail = self.dsa_dnstr.partition(',') return tail def load_dsa(self, samdb): """Load a DSA from the samdb. Prior initialization has given us the DN of the DSA that we are to load. This method initializes all other attributes, including loading the NC replica table for this DSA. """ controls = [ "extended_dn:1:1" ] attrs = ["objectGUID", "invocationID", "options", "msDS-isRODC", "msDS-Behavior-Version"] try: res = samdb.search(base=self.dsa_dnstr, scope=ldb.SCOPE_BASE, attrs=attrs, controls=controls) except ldb.LdbError, (enum, estr): raise Exception("Unable to find nTDSDSA for (%s) - (%s)" % (self.dsa_dnstr, estr)) msg = res[0] self.dsa_guid = misc.GUID(samdb.schema_format_value("objectGUID", msg["objectGUID"][0])) # RODCs don't originate changes and thus have no invocationId, # therefore we must check for existence first if "invocationId" in msg: self.dsa_ivid = misc.GUID(samdb.schema_format_value("objectGUID", msg["invocationId"][0])) if "options" in msg: self.options = int(msg["options"][0]) if "msDS-isRODC" in msg and msg["msDS-isRODC"][0] == "TRUE": self.dsa_is_ro = True else: self.dsa_is_ro = False if "msDS-Behavior-Version" in msg: self.dsa_behavior = int(msg['msDS-Behavior-Version'][0]) # Load the NC replicas that are enumerated on this dsa self.load_current_replica_table(samdb) # Load the nTDSConnection that are enumerated on this dsa self.load_connection_table(samdb) def load_current_replica_table(self, samdb): """Method to load the NC replica's listed for DSA object. This method queries the samdb for (hasMasterNCs, msDS-hasMasterNCs, hasPartialReplicaNCs, msDS-HasDomainNCs, msDS-hasFullReplicaNCs, and msDS-HasInstantiatedNCs) to determine complete list of NC replicas that are enumerated for the DSA. Once a NC replica is loaded it is identified (schema, config, etc) and the other replica attributes (partial, ro, etc) are determined. :param samdb: database to query for DSA replica list """ controls = ["extended_dn:1:1"] ncattrs = [ # not RODC - default, config, schema (old style) "hasMasterNCs", # not RODC - default, config, schema, app NCs "msDS-hasMasterNCs", # domain NC partial replicas "hasPartialReplicaNCs", # default domain NC "msDS-HasDomainNCs", # RODC only - default, config, schema, app NCs "msDS-hasFullReplicaNCs", # Identifies if replica is coming, going, or stable "msDS-HasInstantiatedNCs" ] try: res = samdb.search(base=self.dsa_dnstr, scope=ldb.SCOPE_BASE, attrs=ncattrs, controls=controls) except ldb.LdbError, (enum, estr): raise Exception("Unable to find nTDSDSA NCs for (%s) - (%s)" % (self.dsa_dnstr, estr)) # The table of NCs for the dsa we are searching tmp_table = {} # We should get one response to our query here for # the ntds that we requested if len(res[0]) > 0: # Our response will contain a number of elements including # the dn of the dsa as well as elements for each # attribute (e.g. hasMasterNCs). Each of these elements # is a dictonary list which we retrieve the keys for and # then iterate over them for k in res[0].keys(): if k == "dn": continue # For each attribute type there will be one or more DNs # listed. For instance DCs normally have 3 hasMasterNCs # listed. for value in res[0][k]: # Turn dn into a dsdb_Dn so we can use # its methods to parse the extended pieces. # Note we don't really need the exact sid value # but instead only need to know if its present. dsdn = dsdb_Dn(samdb, value) guid = dsdn.dn.get_extended_component('GUID') sid = dsdn.dn.get_extended_component('SID') flags = dsdn.get_binary_integer() dnstr = str(dsdn.dn) if guid is None: raise Exception("Missing GUID for (%s) - (%s: %s)" % (self.dsa_dnstr, k, value)) guid = misc.GUID(guid) if not dnstr in tmp_table: rep = NCReplica(self.dsa_dnstr, self.dsa_guid, dnstr, guid, sid) tmp_table[dnstr] = rep else: rep = tmp_table[dnstr] if k == "msDS-HasInstantiatedNCs": rep.set_instantiated_flags(flags) continue rep.identify_by_dsa_attr(samdb, k) # if we've identified the default domain NC # then save its DN string if rep.is_default(): self.default_dnstr = dnstr else: raise Exception("No nTDSDSA NCs for (%s)" % self.dsa_dnstr) # Assign our newly built NC replica table to this dsa self.current_rep_table = tmp_table def add_needed_replica(self, rep): """Method to add a NC replica that "should be present" to the needed_rep_table if not already in the table """ if not rep.nc_dnstr in self.needed_rep_table.keys(): self.needed_rep_table[rep.nc_dnstr] = rep def load_connection_table(self, samdb): """Method to load the nTDSConnections listed for DSA object. :param samdb: database to query for DSA connection list """ try: res = samdb.search(base=self.dsa_dnstr, scope=ldb.SCOPE_SUBTREE, expression="(objectClass=nTDSConnection)") except ldb.LdbError, (enum, estr): raise Exception("Unable to find nTDSConnection for (%s) - (%s)" % (self.dsa_dnstr, estr)) for msg in res: dnstr = str(msg.dn) # already loaded if dnstr in self.connect_table.keys(): continue connect = NTDSConnection(dnstr) connect.load_connection(samdb) self.connect_table[dnstr] = connect def commit_connection_table(self, samdb): """Method to commit any uncommitted nTDSConnections that are in our table. These would be identified connections that are marked to be added or deleted :param samdb: database to commit DSA connection list to """ for dnstr, connect in self.connect_table.items(): connect.commit_connection(samdb) def add_connection(self, dnstr, connect): self.connect_table[dnstr] = connect def get_connection_by_from_dnstr(self, from_dnstr): """Scan DSA nTDSConnection table and return connection with a "fromServer" dn string equivalent to method input parameter. :param from_dnstr: search for this from server entry """ for dnstr, connect in self.connect_table.items(): if connect.get_from_dnstr() == from_dnstr: return connect return None def dumpstr_current_replica_table(self): '''Debug dump string output of current replica table''' text="" for k in self.current_rep_table.keys(): if text: text = text + "\n%s" % self.current_rep_table[k] else: text = "%s" % self.current_rep_table[k] return text def dumpstr_needed_replica_table(self): '''Debug dump string output of needed replica table''' text="" for k in self.needed_rep_table.keys(): if text: text = text + "\n%s" % self.needed_rep_table[k] else: text = "%s" % self.needed_rep_table[k] return text def dumpstr_connect_table(self): '''Debug dump string output of connect table''' text="" for k in self.connect_table.keys(): if text: text = text + "\n%s" % self.connect_table[k] else: text = "%s" % self.connect_table[k] return text class NTDSConnection(object): """Class defines a nTDSConnection found under a DSA """ def __init__(self, dnstr): self.dnstr = dnstr self.enabled = False self.committed = False # new connection needs to be committed self.options = 0 self.flags = 0 self.transport_dnstr = None self.transport_guid = None self.from_dnstr = None self.from_guid = None self.schedule = None def __str__(self): '''Debug dump string output of NTDSConnection object''' text = "%s:\n\tdn=%s" % (self.__class__.__name__, self.dnstr) text = text + "\n\tenabled=%s" % self.enabled text = text + "\n\tcommitted=%s" % self.committed text = text + "\n\toptions=0x%08X" % self.options text = text + "\n\tflags=0x%08X" % self.flags text = text + "\n\ttransport_dn=%s" % self.transport_dnstr if self.transport_guid is not None: text = text + "\n\ttransport_guid=%s" % str(self.transport_guid) text = text + "\n\tfrom_dn=%s" % self.from_dnstr text = text + "\n\tfrom_guid=%s" % str(self.from_guid) if self.schedule is not None: text = text + "\n\tschedule.size=%s" % self.schedule.size text = text + "\n\tschedule.bandwidth=%s" % self.schedule.bandwidth text = text + "\n\tschedule.numberOfSchedules=%s" % \ self.schedule.numberOfSchedules for i, header in enumerate(self.schedule.headerArray): text = text + "\n\tschedule.headerArray[%d].type=%d" % \ (i, header.type) text = text + "\n\tschedule.headerArray[%d].offset=%d" % \ (i, header.offset) text = text + "\n\tschedule.dataArray[%d].slots[ " % i for slot in self.schedule.dataArray[i].slots: text = text + "0x%X " % slot text = text + "]" return text def load_connection(self, samdb): """Given a NTDSConnection object with an prior initialization for the object's DN, search for the DN and load attributes from the samdb. """ controls = ["extended_dn:1:1"] attrs = [ "options", "enabledConnection", "schedule", "transportType", "fromServer", "systemFlags" ] try: res = samdb.search(base=self.dnstr, scope=ldb.SCOPE_BASE, attrs=attrs, controls=controls) except ldb.LdbError, (enum, estr): raise Exception("Unable to find nTDSConnection for (%s) - (%s)" % (self.dnstr, estr)) msg = res[0] if "options" in msg: self.options = int(msg["options"][0]) if "enabledConnection" in msg: if msg["enabledConnection"][0].upper().lstrip().rstrip() == "TRUE": self.enabled = True if "systemFlags" in msg: self.flags = int(msg["systemFlags"][0]) if "transportType" in msg: dsdn = dsdb_Dn(samdb, msg["tranportType"][0]) guid = dsdn.dn.get_extended_component('GUID') assert guid is not None self.transport_guid = misc.GUID(guid) self.transport_dnstr = str(dsdn.dn) assert self.transport_dnstr is not None if "schedule" in msg: self.schedule = ndr_unpack(drsblobs.replSchedule, msg["schedule"][0]) if "fromServer" in msg: dsdn = dsdb_Dn(samdb, msg["fromServer"][0]) guid = dsdn.dn.get_extended_component('GUID') assert guid is not None self.from_guid = misc.GUID(guid) self.from_dnstr = str(dsdn.dn) assert self.from_dnstr is not None # Was loaded from database so connection is currently committed self.committed = True def commit_connection(self, samdb): """Given a NTDSConnection object that is not committed in the sam database, perform a commit action. """ # nothing to do if self.committed == True: return # First verify we don't have this entry to ensure nothing # is programatically amiss try: msg = samdb.search(base=self.dnstr, scope=ldb.SCOPE_BASE) found = True except ldb.LdbError, (enum, estr): if enum == ldb.ERR_NO_SUCH_OBJECT: found = False else: raise Exception("Unable to search for (%s) - (%s)" % (self.dnstr, estr)) if found: raise Exception("nTDSConnection for (%s) already exists!" % self.dnstr) if self.enabled: enablestr = "TRUE" else: enablestr = "FALSE" # Prepare a message for adding to the samdb m = ldb.Message() m.dn = ldb.Dn(samdb, self.dnstr) m["objectClass"] = \ ldb.MessageElement("nTDSConnection", ldb.FLAG_MOD_ADD, \ "objectClass") m["showInAdvancedViewOnly"] = \ ldb.MessageElement("TRUE", ldb.FLAG_MOD_ADD, \ "showInAdvancedViewOnly") m["enabledConnection"] = \ ldb.MessageElement(enablestr, ldb.FLAG_MOD_ADD, "enabledConnection") m["fromServer"] = \ ldb.MessageElement(self.from_dnstr, ldb.FLAG_MOD_ADD, "fromServer") m["options"] = \ ldb.MessageElement(str(self.options), ldb.FLAG_MOD_ADD, "options") m["systemFlags"] = \ ldb.MessageElement(str(self.flags), ldb.FLAG_MOD_ADD, "systemFlags") if self.schedule is not None: m["schedule"] = \ ldb.MessageElement(ndr_pack(self.schedule), ldb.FLAG_MOD_ADD, "schedule") try: samdb.add(m) except ldb.LdbError, (enum, estr): raise Exception("Could not add nTDSConnection for (%s) - (%s)" % \ (self.dnstr, estr)) self.committed = True def is_schedule_minimum_once_per_week(self): """Returns True if our schedule includes at least one replication interval within the week. False otherwise """ if self.schedule is None or self.schedule.dataArray[0] is None: return False for slot in self.schedule.dataArray[0].slots: if (slot & 0x0F) != 0x0: return True return False def convert_schedule_to_repltimes(self): """Convert NTDS Connection schedule to replTime schedule. NTDS Connection schedule slots are double the size of the replTime slots but the top portion of the NTDS Connection schedule slot (4 most significant bits in uchar) are unused. The 4 least significant bits have the same (15 minute interval) bit positions as replTimes. We thus pack two elements of the NTDS Connection schedule slots into one element of the replTimes slot If no schedule appears in NTDS Connection then a default of 0x11 is set in each replTimes slot as per behaviour noted in a Windows DC. That default would cause replication within the last 15 minutes of each hour. """ times = [0x11] * 84 for i, slot in enumerate(times): if self.schedule is not None and \ self.schedule.dataArray[0] is not None: slot = (self.schedule.dataArray[0].slots[i*2] & 0xF) << 4 | \ (self.schedule.dataArray[0].slots[i*2] & 0xF) return times def is_rodc_topology(self): """Returns True if NTDS Connection specifies RODC topology only """ if self.options & dsdb.NTDSCONN_OPT_RODC_TOPOLOGY == 0: return False return True def is_enabled(self): """Returns True if NTDS Connection is enabled """ return self.enabled def get_from_dnstr(self): '''Return fromServer dn string attribute''' return self.from_dnstr class Partition(NamingContext): """A naming context discovered thru Partitions DN of the config schema. This is a more specific form of NamingContext class (inheriting from that class) and it identifies unique attributes enumerated in the Partitions such as which nTDSDSAs are cross referenced for replicas """ def __init__(self, partstr): self.partstr = partstr self.rw_location_list = [] self.ro_location_list = [] # We don't have enough info to properly # fill in the naming context yet. We'll get that # fully set up with load_partition(). NamingContext.__init__(self, None) def load_partition(self, samdb): """Given a Partition class object that has been initialized with its partition dn string, load the partition from the sam database, identify the type of the partition (schema, domain, etc) and record the list of nTDSDSAs that appear in the cross reference attributes msDS-NC-Replica-Locations and msDS-NC-RO-Replica-Locations. :param samdb: sam database to load partition from """ controls = ["extended_dn:1:1"] attrs = [ "nCName", "msDS-NC-Replica-Locations", "msDS-NC-RO-Replica-Locations" ] try: res = samdb.search(base=self.partstr, scope=ldb.SCOPE_BASE, attrs=attrs, controls=controls) except ldb.LdbError, (enum, estr): raise Exception("Unable to find partition for (%s) - (%s)" % ( self.partstr, estr)) msg = res[0] for k in msg.keys(): if k == "dn": continue for value in msg[k]: # Turn dn into a dsdb_Dn so we can use # its methods to parse the extended pieces. # Note we don't really need the exact sid value # but instead only need to know if its present. dsdn = dsdb_Dn(samdb, value) guid = dsdn.dn.get_extended_component('GUID') sid = dsdn.dn.get_extended_component('SID') if guid is None: raise Exception("Missing GUID for (%s) - (%s: %s)" % \ (self.partstr, k, value)) guid = misc.GUID(guid) if k == "nCName": self.nc_dnstr = str(dsdn.dn) self.nc_guid = guid self.nc_sid = sid continue if k == "msDS-NC-Replica-Locations": self.rw_location_list.append(str(dsdn.dn)) continue if k == "msDS-NC-RO-Replica-Locations": self.ro_location_list.append(str(dsdn.dn)) continue # Now identify what type of NC this partition # enumerated self.identify_by_basedn(samdb) def should_be_present(self, target_dsa): """Tests whether this partition should have an NC replica on the target dsa. This method returns a tuple of needed=True/False, ro=True/False, partial=True/False :param target_dsa: should NC be present on target dsa """ needed = False ro = False partial = False # If this is the config, schema, or default # domain NC for the target dsa then it should # be present if self.nc_type == NCType.config or \ self.nc_type == NCType.schema or \ (self.nc_type == NCType.domain and self.nc_dnstr == target_dsa.default_dnstr): needed = True # A writable replica of an application NC should be present # if there a cross reference to the target DSA exists. Depending # on whether the DSA is ro we examine which type of cross reference # to look for (msDS-NC-Replica-Locations or # msDS-NC-RO-Replica-Locations if self.nc_type == NCType.application: if target_dsa.is_ro(): if target_dsa.dsa_dnstr in self.ro_location_list: needed = True else: if target_dsa.dsa_dnstr in self.rw_location_list: needed = True # If the target dsa is a gc then a partial replica of a # domain NC (other than the DSAs default domain) should exist # if there is also a cross reference for the DSA if target_dsa.is_gc() and \ self.nc_type == NCType.domain and \ self.nc_dnstr != target_dsa.default_dnstr and \ (target_dsa.dsa_dnstr in self.ro_location_list or target_dsa.dsa_dnstr in self.rw_location_list): needed = True partial = True # partial NCs are always readonly if needed and (target_dsa.is_ro() or partial): ro = True return needed, ro, partial def __str__(self): '''Debug dump string output of class''' text = "%s" % NamingContext.__str__(self) text = text + "\n\tpartdn=%s" % self.partstr for k in self.rw_location_list: text = text + "\n\tmsDS-NC-Replica-Locations=%s" % k for k in self.ro_location_list: text = text + "\n\tmsDS-NC-RO-Replica-Locations=%s" % k return text class Site(object): def __init__(self, site_dnstr): self.site_dnstr = site_dnstr self.site_options = 0 self.dsa_table = {} def load_site(self, samdb): """Loads the NTDS Site Settions options attribute for the site """ ssdn = "CN=NTDS Site Settings,%s" % self.site_dnstr try: res = samdb.search(base=ssdn, scope=ldb.SCOPE_BASE, attrs=["options"]) except ldb.LdbError, (enum, estr): raise Exception("Unable to find site settings for (%s) - (%s)" % (ssdn, estr)) msg = res[0] if "options" in msg: self.site_options = int(msg["options"][0]) self.load_all_dsa(samdb) def load_all_dsa(self, samdb): """Discover all nTDSDSA thru the sites entry and instantiate and load the DSAs. Each dsa is inserted into the dsa_table by dn string. """ try: res = samdb.search(self.site_dnstr, scope=ldb.SCOPE_SUBTREE, expression="(objectClass=nTDSDSA)") except ldb.LdbError, (enum, estr): raise Exception("Unable to find nTDSDSAs - (%s)" % estr) for msg in res: dnstr = str(msg.dn) # already loaded if dnstr in self.dsa_table.keys(): continue dsa = DirectoryServiceAgent(dnstr) dsa.load_dsa(samdb) # Assign this dsa to my dsa table # and index by dsa dn self.dsa_table[dnstr] = dsa def get_dsa_by_guidstr(self, guidstr): for dsa in self.dsa_table.values(): if str(dsa.dsa_guid) == guidstr: return dsa return None def get_dsa(self, dnstr): """Return a previously loaded DSA object by consulting the sites dsa_table for the provided DSA dn string :return: None if DSA doesn't exist """ if dnstr in self.dsa_table.keys(): return self.dsa_table[dnstr] return None def is_intrasite_topology_disabled(self): '''Returns True if intrasite topology is disabled for site''' if (self.site_options & dsdb.DS_NTDSSETTINGS_OPT_IS_AUTO_TOPOLOGY_DISABLED) != 0: return True return False def should_detect_stale(self): '''Returns True if detect stale is enabled for site''' if (self.site_options & dsdb.DS_NTDSSETTINGS_OPT_IS_TOPL_DETECT_STALE_DISABLED) == 0: return True return False def __str__(self): '''Debug dump string output of class''' text = "%s:" % self.__class__.__name__ text = text + "\n\tdn=%s" % self.site_dnstr text = text + "\n\toptions=0x%X" % self.site_options for key, dsa in self.dsa_table.items(): text = text + "\n%s" % dsa return text class GraphNode(object): """A graph node describing a set of edges that should be directed to it. Each edge is a connection for a particular naming context replica directed from another node in the forest to this node. """ def __init__(self, dsa_dnstr, max_node_edges): """Instantiate the graph node according to a DSA dn string :param max_node_edges: maximum number of edges that should ever be directed to the node """ self.max_edges = max_node_edges self.dsa_dnstr = dsa_dnstr self.edge_from = [] def __str__(self): text = "%s:" % self.__class__.__name__ text = text + "\n\tdsa_dnstr=%s" % self.dsa_dnstr text = text + "\n\tmax_edges=%d" % self.max_edges for i, edge in enumerate(self.edge_from): text = text + "\n\tedge_from[%d]=%s" % (i, edge) return text def add_edge_from(self, from_dsa_dnstr): """Add an edge from the dsa to our graph nodes edge from list :param from_dsa_dnstr: the dsa that the edge emanates from """ assert from_dsa_dnstr is not None # No edges from myself to myself if from_dsa_dnstr == self.dsa_dnstr: return False # Only one edge from a particular node if from_dsa_dnstr in self.edge_from: return False # Not too many edges if len(self.edge_from) >= self.max_edges: return False self.edge_from.append(from_dsa_dnstr) return True def add_edges_from_connections(self, dsa): """For each nTDSConnection object associated with a particular DSA, we test if it implies an edge to this graph node (i.e. the "fromServer" attribute). If it does then we add an edge from the server unless we are over the max edges for this graph node :param dsa: dsa with a dnstr equivalent to his graph node """ for dnstr, connect in dsa.connect_table.items(): self.add_edge_from(connect.from_dnstr) def add_connections_from_edges(self, dsa): """For each edge directed to this graph node, ensure there is a corresponding nTDSConnection object in the dsa. """ for edge_dnstr in self.edge_from: connect = dsa.get_connection_by_from_dnstr(edge_dnstr) # For each edge directed to the NC replica that # "should be present" on the local DC, the KCC determines # whether an object c exists such that: # # c is a child of the DC's nTDSDSA object. # c.objectCategory = nTDSConnection # # Given the NC replica ri from which the edge is directed, # c.fromServer is the dsname of the nTDSDSA object of # the DC on which ri "is present". # # c.options does not contain NTDSCONN_OPT_RODC_TOPOLOGY if connect and connect.is_rodc_topology() == False: exists = True else: exists = False # if no such object exists then the KCC adds an object # c with the following attributes if exists: return # Generate a new dnstr for this nTDSConnection dnstr = "CN=%s," % str(uuid.uuid4()) + self.dsa_dnstr connect = NTDSConnection(dnstr) connect.committed = False connect.enabled = True connect.from_dnstr = edge_dnstr connect.options = dsdb.NTDSCONN_OPT_IS_GENERATED connect.flags = dsdb.SYSTEM_FLAG_CONFIG_ALLOW_RENAME + \ dsdb.SYSTEM_FLAG_CONFIG_ALLOW_MOVE # Create schedule. Attribute valuse set according to MS-TECH # intrasite connection creation document connect.schedule = drsblobs.schedule() connect.schedule.size = 188 connect.schedule.bandwidth = 0 connect.schedule.numberOfSchedules = 1 header = drsblobs.scheduleHeader() header.type = 0 header.offset = 20 connect.schedule.headerArray = [ header ] # 168 byte instances of the 0x01 value. The low order 4 bits # of the byte equate to 15 minute intervals within a single hour. # There are 168 bytes because there are 168 hours in a full week # Effectively we are saying to perform replication at the end of # each hour of the week data = drsblobs.scheduleSlots() data.slots = [ 0x01 ] * 168 connect.schedule.dataArray = [ data ] dsa.add_connection(dnstr, connect); def has_sufficient_edges(self): '''Return True if we have met the maximum "from edges" criteria''' if len(self.edge_from) >= self.max_edges: return True return False class Transport(object): """Class defines a Inter-site transport found under Sites """ def __init__(self, dnstr): self.dnstr = dnstr self.options = 0 self.guid = None self.address_attr = None def __str__(self): '''Debug dump string output of Transport object''' text = "%s:\n\tdn=%s" % (self.__class__.__name__, self.dnstr) text = text + "\n\tguid=%s" % str(self.guid) text = text + "\n\toptions=%d" % self.options text = text + "\n\taddress_attr=%s" % self.address_attr return text def load_transport(self, samdb): """Given a Transport object with an prior initialization for the object's DN, search for the DN and load attributes from the samdb. """ attrs = [ "objectGUID", "options", "transportAddressAttribute" ] try: res = samdb.search(base=self.dnstr, scope=ldb.SCOPE_BASE, attrs=attrs) except ldb.LdbError, (enum, estr): raise Exception("Unable to find Transport for (%s) - (%s)" % (self.dnstr, estr)) msg = res[0] self.guid = misc.GUID(samdb.schema_format_value("objectGUID", msg["objectGUID"][0])) if "options" in msg: self.options = int(msg["options"][0]) if "transportAddressAttribute" in msg: self.address_attr = str(msg["transportAddressAttribute"][0]) class RepsFromTo(object): """Class encapsulation of the NDR repsFromToBlob. Removes the necessity of external code having to understand about other_info or manipulation of update flags. """ def __init__(self, nc_dnstr=None, ndr_blob=None): self.__dict__['to_be_deleted'] = False self.__dict__['nc_dnstr'] = nc_dnstr self.__dict__['update_flags'] = 0x0 # WARNING: # # There is a very subtle bug here with python # and our NDR code. If you assign directly to # a NDR produced struct (e.g. t_repsFrom.ctr.other_info) # then a proper python GC reference count is not # maintained. # # To work around this we maintain an internal # reference to "dns_name(x)" and "other_info" elements # of repsFromToBlob. This internal reference # is hidden within this class but it is why you # see statements like this below: # # self.__dict__['ndr_blob'].ctr.other_info = \ # self.__dict__['other_info'] = drsblobs.repsFromTo1OtherInfo() # # That would appear to be a redundant assignment but # it is necessary to hold a proper python GC reference # count. if ndr_blob is None: self.__dict__['ndr_blob'] = drsblobs.repsFromToBlob() self.__dict__['ndr_blob'].version = 0x1 self.__dict__['dns_name1'] = None self.__dict__['dns_name2'] = None self.__dict__['ndr_blob'].ctr.other_info = \ self.__dict__['other_info'] = drsblobs.repsFromTo1OtherInfo() else: self.__dict__['ndr_blob'] = ndr_blob self.__dict__['other_info'] = ndr_blob.ctr.other_info if ndr_blob.version == 0x1: self.__dict__['dns_name1'] = ndr_blob.ctr.other_info.dns_name self.__dict__['dns_name2'] = None else: self.__dict__['dns_name1'] = ndr_blob.ctr.other_info.dns_name1 self.__dict__['dns_name2'] = ndr_blob.ctr.other_info.dns_name2 def __str__(self): '''Debug dump string output of class''' text = "%s:" % self.__class__.__name__ text = text + "\n\tdnstr=%s" % self.nc_dnstr text = text + "\n\tupdate_flags=0x%X" % self.update_flags text = text + "\n\tversion=%d" % self.version text = text + "\n\tsource_dsa_obj_guid=%s" % \ str(self.source_dsa_obj_guid) text = text + "\n\tsource_dsa_invocation_id=%s" % \ str(self.source_dsa_invocation_id) text = text + "\n\ttransport_guid=%s" % \ str(self.transport_guid) text = text + "\n\treplica_flags=0x%X" % \ self.replica_flags text = text + "\n\tconsecutive_sync_failures=%d" % \ self.consecutive_sync_failures text = text + "\n\tlast_success=%s" % \ self.last_success text = text + "\n\tlast_attempt=%s" % \ self.last_attempt text = text + "\n\tdns_name1=%s" % \ str(self.dns_name1) text = text + "\n\tdns_name2=%s" % \ str(self.dns_name2) text = text + "\n\tschedule[ " for slot in self.schedule: text = text + "0x%X " % slot text = text + "]" return text def __setattr__(self, item, value): if item in [ 'schedule', 'replica_flags', 'transport_guid', 'source_dsa_obj_guid', 'source_dsa_invocation_id', 'consecutive_sync_failures', 'last_success', 'last_attempt' ]: setattr(self.__dict__['ndr_blob'].ctr, item, value) elif item in ['dns_name1']: self.__dict__['dns_name1'] = value if self.__dict__['ndr_blob'].version == 0x1: self.__dict__['ndr_blob'].ctr.other_info.dns_name = \ self.__dict__['dns_name1'] else: self.__dict__['ndr_blob'].ctr.other_info.dns_name1 = \ self.__dict__['dns_name1'] elif item in ['dns_name2']: self.__dict__['dns_name2'] = value if self.__dict__['ndr_blob'].version == 0x1: raise AttributeError(item) else: self.__dict__['ndr_blob'].ctr.other_info.dns_name2 = \ self.__dict__['dns_name2'] elif item in ['version']: raise AttributeError, "Attempt to set readonly attribute %s" % item else: raise AttributeError, "Unknown attribute %s" % item if item in ['replica_flags']: self.__dict__['update_flags'] |= drsuapi.DRSUAPI_DRS_UPDATE_FLAGS elif item in ['schedule']: self.__dict__['update_flags'] |= drsuapi.DRSUAPI_DRS_UPDATE_SCHEDULE else: self.__dict__['update_flags'] |= drsuapi.DRSUAPI_DRS_UPDATE_ADDRESS def __getattr__(self, item): """Overload of RepsFromTo attribute retrieval. Allows external code to ignore substructures within the blob """ if item in [ 'schedule', 'replica_flags', 'transport_guid', 'source_dsa_obj_guid', 'source_dsa_invocation_id', 'consecutive_sync_failures', 'last_success', 'last_attempt' ]: return getattr(self.__dict__['ndr_blob'].ctr, item) elif item in ['version']: return self.__dict__['ndr_blob'].version elif item in ['dns_name1']: if self.__dict__['ndr_blob'].version == 0x1: return self.__dict__['ndr_blob'].ctr.other_info.dns_name else: return self.__dict__['ndr_blob'].ctr.other_info.dns_name1 elif item in ['dns_name2']: if self.__dict__['ndr_blob'].version == 0x1: raise AttributeError(item) else: return self.__dict__['ndr_blob'].ctr.other_info.dns_name2 raise AttributeError, "Unknwown attribute %s" % item def is_modified(self): return (self.update_flags != 0x0)