python/samba/dbchecker.py

   1 # Samba4 AD database checker
   2 #
   3 # Copyright (C) Andrew Tridgell 2011
   4 # Copyright (C) Matthieu Patou <mat@matws.net> 2011
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 #
  19
  20 import ldb
  21 import samba
  22 import time
  23 from samba import dsdb
  24 from samba import common
  25 from samba.dcerpc import misc
  26 from samba.ndr import ndr_unpack, ndr_pack
  27 from samba.dcerpc import drsblobs
  28 from samba.common import dsdb_Dn
  29 from samba.dcerpc import security
  30 from samba.descriptor import get_wellknown_sds, get_diff_sds
  31 from samba.auth import system_session, admin_session
  32
  33
  34 class dbcheck(object):
  35     """check a SAM database for errors"""
  36
  37     def __init__(self, samdb, samdb_schema=None, verbose=False, fix=False,
  38                  yes=False, quiet=False, in_transaction=False,
  39                  reset_well_known_acls=False):
  40         self.samdb = samdb
  41         self.dict_oid_name = None
  42         self.samdb_schema = (samdb_schema or samdb)
  43         self.verbose = verbose
  44         self.fix = fix
  45         self.yes = yes
  46         self.quiet = quiet
  47         self.remove_all_unknown_attributes = False
  48         self.remove_all_empty_attributes = False
  49         self.fix_all_normalisation = False
  50         self.fix_all_DN_GUIDs = False
  51         self.fix_all_binary_dn = False
  52         self.remove_all_deleted_DN_links = False
  53         self.fix_all_target_mismatch = False
  54         self.fix_all_metadata = False
  55         self.fix_time_metadata = False
  56         self.fix_all_missing_backlinks = False
  57         self.fix_all_orphaned_backlinks = False
  58         self.fix_rmd_flags = False
  59         self.fix_ntsecuritydescriptor = False
  60         self.fix_ntsecuritydescriptor_owner_group = False
  61         self.seize_fsmo_role = False
  62         self.move_to_lost_and_found = False
  63         self.fix_instancetype = False
  64         self.fix_replmetadata_zero_invocationid = False
  65         self.fix_deleted_deleted_objects = False
  66         self.fix_dn = False
  67         self.reset_well_known_acls = reset_well_known_acls
  68         self.reset_all_well_known_acls = False
  69         self.in_transaction = in_transaction
  70         self.infrastructure_dn = ldb.Dn(samdb, "CN=Infrastructure," + samdb.domain_dn())
  71         self.naming_dn = ldb.Dn(samdb, "CN=Partitions,%s" % samdb.get_config_basedn())
  72         self.schema_dn = samdb.get_schema_basedn()
  73         self.rid_dn = ldb.Dn(samdb, "CN=RID Manager$,CN=System," + samdb.domain_dn())
  74         self.ntds_dsa = ldb.Dn(samdb, samdb.get_dsServiceName())
  75         self.class_schemaIDGUID = {}
  76         self.wellknown_sds = get_wellknown_sds(self.samdb)
  77         self.fix_all_missing_objectclass = False
  78
  79         self.name_map = {}
  80         try:
  81             res = samdb.search(base="CN=DnsAdmins,CN=Users,%s" % samdb.domain_dn(), scope=ldb.SCOPE_BASE,
  82                            attrs=["objectSid"])
  83             dnsadmins_sid = ndr_unpack(security.dom_sid, res[0]["objectSid"][0])
  84             self.name_map['DnsAdmins'] = str(dnsadmins_sid)
  85         except ldb.LdbError, (enum, estr):
  86             if enum != ldb.ERR_NO_SUCH_OBJECT:
  87                 raise
  88             pass
  89
  90         self.system_session_info = system_session()
  91         self.admin_session_info = admin_session(None, samdb.get_domain_sid())
  92
  93         res = self.samdb.search(base=self.ntds_dsa, scope=ldb.SCOPE_BASE, attrs=['msDS-hasMasterNCs', 'hasMasterNCs'])
  94         if "msDS-hasMasterNCs" in res[0]:
  95             self.write_ncs = res[0]["msDS-hasMasterNCs"]
  96         else:
  97             # If the Forest Level is less than 2003 then there is no
  98             # msDS-hasMasterNCs, so we fall back to hasMasterNCs
  99             # no need to merge as all the NCs that are in hasMasterNCs must
 100             # also be in msDS-hasMasterNCs (but not the opposite)
 101             if "hasMasterNCs" in res[0]:
 102                 self.write_ncs = res[0]["hasMasterNCs"]
 103             else:
 104                 self.write_ncs = None
 105
 106         res = self.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=['namingContexts'])
 107         try:
 108             ncs = res[0]["namingContexts"]
 109             self.deleted_objects_containers = []
 110             for nc in ncs:
 111                 try:
 112                     dn = self.samdb.get_wellknown_dn(ldb.Dn(self.samdb, nc),
 113                                                      dsdb.DS_GUID_DELETED_OBJECTS_CONTAINER)
 114                     self.deleted_objects_containers.append(dn)
 115                 except KeyError:
 116                     pass
 117         except KeyError:
 118             pass
 119         except IndexError:
 120             pass
 121
 122     def check_database(self, DN=None, scope=ldb.SCOPE_SUBTREE, controls=[], attrs=['*']):
 123         '''perform a database check, returning the number of errors found'''
 124
 125         res = self.samdb.search(base=DN, scope=scope, attrs=['dn'], controls=controls)
 126         self.report('Checking %u objects' % len(res))
 127         error_count = 0
 128
 129         for object in res:
 130             error_count += self.check_object(object.dn, attrs=attrs)
 131
 132         if DN is None:
 133             error_count += self.check_rootdse()
 134
 135         if error_count != 0 and not self.fix:
 136             self.report("Please use --fix to fix these errors")
 137
 138         self.report('Checked %u objects (%u errors)' % (len(res), error_count))
 139         return error_count
 140
 141     def report(self, msg):
 142         '''print a message unless quiet is set'''
 143         if not self.quiet:
 144             print(msg)
 145
 146     def confirm(self, msg, allow_all=False, forced=False):
 147         '''confirm a change'''
 148         if not self.fix:
 149             return False
 150         if self.quiet:
 151             return self.yes
 152         if self.yes:
 153             forced = True
 154         return common.confirm(msg, forced=forced, allow_all=allow_all)
 155
 156     ################################################################
 157     # a local confirm function with support for 'all'
 158     def confirm_all(self, msg, all_attr):
 159         '''confirm a change with support for "all" '''
 160         if not self.fix:
 161             return False
 162         if self.quiet:
 163             return self.yes
 164         if getattr(self, all_attr) == 'NONE':
 165             return False
 166         if getattr(self, all_attr) == 'ALL':
 167             forced = True
 168         else:
 169             forced = self.yes
 170         c = common.confirm(msg, forced=forced, allow_all=True)
 171         if c == 'ALL':
 172             setattr(self, all_attr, 'ALL')
 173             return True
 174         if c == 'NONE':
 175             setattr(self, all_attr, 'NONE')
 176             return False
 177         return c
 178
 179     def do_delete(self, dn, controls, msg):
 180         '''delete dn with optional verbose output'''
 181         if self.verbose:
 182             self.report("delete DN %s" % dn)
 183         try:
 184             controls = controls + ["local_oid:%s:0" % dsdb.DSDB_CONTROL_DBCHECK]
 185             self.samdb.delete(dn, controls=controls)
 186         except Exception, err:
 187             self.report("%s : %s" % (msg, err))
 188             return False
 189         return True
 190
 191     def do_modify(self, m, controls, msg, validate=True):
 192         '''perform a modify with optional verbose output'''
 193         if self.verbose:
 194             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
 195         try:
 196             controls = controls + ["local_oid:%s:0" % dsdb.DSDB_CONTROL_DBCHECK]
 197             self.samdb.modify(m, controls=controls, validate=validate)
 198         except Exception, err:
 199             self.report("%s : %s" % (msg, err))
 200             return False
 201         return True
 202
 203     def do_rename(self, from_dn, to_rdn, to_base, controls, msg):
 204         '''perform a modify with optional verbose output'''
 205         if self.verbose:
 206             self.report("""dn: %s
 207 changeType: modrdn
 208 newrdn: %s
 209 deleteOldRdn: 1
 210 newSuperior: %s""" % (str(from_dn), str(to_rdn), str(to_base)))
 211         try:
 212             to_dn = to_rdn + to_base
 213             controls = controls + ["local_oid:%s:0" % dsdb.DSDB_CONTROL_DBCHECK]
 214             self.samdb.rename(from_dn, to_dn, controls=controls)
 215         except Exception, err:
 216             self.report("%s : %s" % (msg, err))
 217             return False
 218         return True
 219
 220     def err_empty_attribute(self, dn, attrname):
 221         '''fix empty attributes'''
 222         self.report("ERROR: Empty attribute %s in %s" % (attrname, dn))
 223         if not self.confirm_all('Remove empty attribute %s from %s?' % (attrname, dn), 'remove_all_empty_attributes'):
 224             self.report("Not fixing empty attribute %s" % attrname)
 225             return
 226
 227         m = ldb.Message()
 228         m.dn = dn
 229         m[attrname] = ldb.MessageElement('', ldb.FLAG_MOD_DELETE, attrname)
 230         if self.do_modify(m, ["relax:0", "show_recycled:1"],
 231                           "Failed to remove empty attribute %s" % attrname, validate=False):
 232             self.report("Removed empty attribute %s" % attrname)
 233
 234     def err_normalise_mismatch(self, dn, attrname, values):
 235         '''fix attribute normalisation errors'''
 236         self.report("ERROR: Normalisation error for attribute %s in %s" % (attrname, dn))
 237         mod_list = []
 238         for val in values:
 239             normalised = self.samdb.dsdb_normalise_attributes(
 240                 self.samdb_schema, attrname, [val])
 241             if len(normalised) != 1:
 242                 self.report("Unable to normalise value '%s'" % val)
 243                 mod_list.append((val, ''))
 244             elif (normalised[0] != val):
 245                 self.report("value '%s' should be '%s'" % (val, normalised[0]))
 246                 mod_list.append((val, normalised[0]))
 247         if not self.confirm_all('Fix normalisation for %s from %s?' % (attrname, dn), 'fix_all_normalisation'):
 248             self.report("Not fixing attribute %s" % attrname)
 249             return
 250
 251         m = ldb.Message()
 252         m.dn = dn
 253         for i in range(0, len(mod_list)):
 254             (val, nval) = mod_list[i]
 255             m['value_%u' % i] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 256             if nval != '':
 257                 m['normv_%u' % i] = ldb.MessageElement(nval, ldb.FLAG_MOD_ADD,
 258                     attrname)
 259
 260         if self.do_modify(m, ["relax:0", "show_recycled:1"],
 261                           "Failed to normalise attribute %s" % attrname,
 262                           validate=False):
 263             self.report("Normalised attribute %s" % attrname)
 264
 265     def err_normalise_mismatch_replace(self, dn, attrname, values):
 266         '''fix attribute normalisation errors'''
 267         normalised = self.samdb.dsdb_normalise_attributes(self.samdb_schema, attrname, values)
 268         self.report("ERROR: Normalisation error for attribute '%s' in '%s'" % (attrname, dn))
 269         self.report("Values/Order of values do/does not match: %s/%s!" % (values, list(normalised)))
 270         if list(normalised) == values:
 271             return
 272         if not self.confirm_all("Fix normalisation for '%s' from '%s'?" % (attrname, dn), 'fix_all_normalisation'):
 273             self.report("Not fixing attribute '%s'" % attrname)
 274             return
 275
 276         m = ldb.Message()
 277         m.dn = dn
 278         m[attrname] = ldb.MessageElement(normalised, ldb.FLAG_MOD_REPLACE, attrname)
 279
 280         if self.do_modify(m, ["relax:0", "show_recycled:1"],
 281                           "Failed to normalise attribute %s" % attrname,
 282                           validate=False):
 283             self.report("Normalised attribute %s" % attrname)
 284
 285     def is_deleted_objects_dn(self, dsdb_dn):
 286         '''see if a dsdb_Dn is the special Deleted Objects DN'''
 287         return dsdb_dn.prefix == "B:32:%s:" % dsdb.DS_GUID_DELETED_OBJECTS_CONTAINER
 288
 289     def err_missing_objectclass(self, dn):
 290         """handle object without objectclass"""
 291         self.report("ERROR: missing objectclass in object %s.  If you have another working DC, please run 'samba-tool drs replicate --full-sync --local <destinationDC> <sourceDC> %s'" % (dn, self.samdb.get_nc_root(dn)))
 292         if not self.confirm_all("If you cannot re-sync from another DC, do you wish to delete object '%s'?" % dn, 'fix_all_missing_objectclass'):
 293             self.report("Not deleting object with missing objectclass '%s'" % dn)
 294             return
 295         if self.do_delete(dn, ["relax:0"],
 296                           "Failed to remove DN %s" % dn):
 297             self.report("Removed DN %s" % dn)
 298
 299     def err_deleted_dn(self, dn, attrname, val, dsdb_dn, correct_dn):
 300         """handle a DN pointing to a deleted object"""
 301         self.report("ERROR: target DN is deleted for %s in object %s - %s" % (attrname, dn, val))
 302         self.report("Target GUID points at deleted DN %s" % correct_dn)
 303         if not self.confirm_all('Remove DN link?', 'remove_all_deleted_DN_links'):
 304             self.report("Not removing")
 305             return
 306         m = ldb.Message()
 307         m.dn = dn
 308         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 309         if self.do_modify(m, ["show_recycled:1", "local_oid:%s:0" % dsdb.DSDB_CONTROL_DBCHECK],
 310                           "Failed to remove deleted DN attribute %s" % attrname):
 311             self.report("Removed deleted DN on attribute %s" % attrname)
 312
 313     def err_missing_dn_GUID(self, dn, attrname, val, dsdb_dn):
 314         """handle a missing target DN (both GUID and DN string form are missing)"""
 315         # check if its a backlink
 316         linkID = self.samdb_schema.get_linkId_from_lDAPDisplayName(attrname)
 317         if (linkID & 1 == 0) and str(dsdb_dn).find('\\0ADEL') == -1:
 318             self.report("Not removing dangling forward link")
 319             return
 320         self.err_deleted_dn(dn, attrname, val, dsdb_dn, dsdb_dn)
 321
 322     def err_incorrect_dn_GUID(self, dn, attrname, val, dsdb_dn, errstr):
 323         """handle a missing GUID extended DN component"""
 324         self.report("ERROR: %s component for %s in object %s - %s" % (errstr, attrname, dn, val))
 325         controls=["extended_dn:1:1", "show_recycled:1"]
 326         try:
 327             res = self.samdb.search(base=str(dsdb_dn.dn), scope=ldb.SCOPE_BASE,
 328                                     attrs=[], controls=controls)
 329         except ldb.LdbError, (enum, estr):
 330             self.report("unable to find object for DN %s - (%s)" % (dsdb_dn.dn, estr))
 331             self.err_missing_dn_GUID(dn, attrname, val, dsdb_dn)
 332             return
 333         if len(res) == 0:
 334             self.report("unable to find object for DN %s" % dsdb_dn.dn)
 335             self.err_missing_dn_GUID(dn, attrname, val, dsdb_dn)
 336             return
 337         dsdb_dn.dn = res[0].dn
 338
 339         if not self.confirm_all('Change DN to %s?' % str(dsdb_dn), 'fix_all_DN_GUIDs'):
 340             self.report("Not fixing %s" % errstr)
 341             return
 342         m = ldb.Message()
 343         m.dn = dn
 344         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 345         m['new_value'] = ldb.MessageElement(str(dsdb_dn), ldb.FLAG_MOD_ADD, attrname)
 346
 347         if self.do_modify(m, ["show_recycled:1"],
 348                           "Failed to fix %s on attribute %s" % (errstr, attrname)):
 349             self.report("Fixed %s on attribute %s" % (errstr, attrname))
 350
 351     def err_incorrect_binary_dn(self, dn, attrname, val, dsdb_dn, errstr):
 352         """handle an incorrect binary DN component"""
 353         self.report("ERROR: %s binary component for %s in object %s - %s" % (errstr, attrname, dn, val))
 354         controls=["extended_dn:1:1", "show_recycled:1"]
 355
 356         if not self.confirm_all('Change DN to %s?' % str(dsdb_dn), 'fix_all_binary_dn'):
 357             self.report("Not fixing %s" % errstr)
 358             return
 359         m = ldb.Message()
 360         m.dn = dn
 361         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 362         m['new_value'] = ldb.MessageElement(str(dsdb_dn), ldb.FLAG_MOD_ADD, attrname)
 363
 364         if self.do_modify(m, ["show_recycled:1"],
 365                           "Failed to fix %s on attribute %s" % (errstr, attrname)):
 366             self.report("Fixed %s on attribute %s" % (errstr, attrname))
 367
 368     def err_dn_target_mismatch(self, dn, attrname, val, dsdb_dn, correct_dn, errstr):
 369         """handle a DN string being incorrect"""
 370         self.report("ERROR: incorrect DN string component for %s in object %s - %s" % (attrname, dn, val))
 371         dsdb_dn.dn = correct_dn
 372
 373         if not self.confirm_all('Change DN to %s?' % str(dsdb_dn), 'fix_all_target_mismatch'):
 374             self.report("Not fixing %s" % errstr)
 375             return
 376         m = ldb.Message()
 377         m.dn = dn
 378         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 379         m['new_value'] = ldb.MessageElement(str(dsdb_dn), ldb.FLAG_MOD_ADD, attrname)
 380         if self.do_modify(m, ["show_recycled:1"],
 381                           "Failed to fix incorrect DN string on attribute %s" % attrname):
 382             self.report("Fixed incorrect DN string on attribute %s" % (attrname))
 383
 384     def err_unknown_attribute(self, obj, attrname):
 385         '''handle an unknown attribute error'''
 386         self.report("ERROR: unknown attribute '%s' in %s" % (attrname, obj.dn))
 387         if not self.confirm_all('Remove unknown attribute %s' % attrname, 'remove_all_unknown_attributes'):
 388             self.report("Not removing %s" % attrname)
 389             return
 390         m = ldb.Message()
 391         m.dn = obj.dn
 392         m['old_value'] = ldb.MessageElement([], ldb.FLAG_MOD_DELETE, attrname)
 393         if self.do_modify(m, ["relax:0", "show_recycled:1"],
 394                           "Failed to remove unknown attribute %s" % attrname):
 395             self.report("Removed unknown attribute %s" % (attrname))
 396
 397     def err_missing_backlink(self, obj, attrname, val, backlink_name, target_dn):
 398         '''handle a missing backlink value'''
 399         self.report("ERROR: missing backlink attribute '%s' in %s for link %s in %s" % (backlink_name, target_dn, attrname, obj.dn))
 400         if not self.confirm_all('Fix missing backlink %s' % backlink_name, 'fix_all_missing_backlinks'):
 401             self.report("Not fixing missing backlink %s" % backlink_name)
 402             return
 403         m = ldb.Message()
 404         m.dn = obj.dn
 405         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 406         m['new_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_ADD, attrname)
 407         if self.do_modify(m, ["show_recycled:1"],
 408                           "Failed to fix missing backlink %s" % backlink_name):
 409             self.report("Fixed missing backlink %s" % (backlink_name))
 410
 411     def err_incorrect_rmd_flags(self, obj, attrname, revealed_dn):
 412         '''handle a incorrect RMD_FLAGS value'''
 413         rmd_flags = int(revealed_dn.dn.get_extended_component("RMD_FLAGS"))
 414         self.report("ERROR: incorrect RMD_FLAGS value %u for attribute '%s' in %s for link %s" % (rmd_flags, attrname, obj.dn, revealed_dn.dn.extended_str()))
 415         if not self.confirm_all('Fix incorrect RMD_FLAGS %u' % rmd_flags, 'fix_rmd_flags'):
 416             self.report("Not fixing incorrect RMD_FLAGS %u" % rmd_flags)
 417             return
 418         m = ldb.Message()
 419         m.dn = obj.dn
 420         m['old_value'] = ldb.MessageElement(str(revealed_dn), ldb.FLAG_MOD_DELETE, attrname)
 421         if self.do_modify(m, ["show_recycled:1", "reveal_internals:0", "show_deleted:0"],
 422                           "Failed to fix incorrect RMD_FLAGS %u" % rmd_flags):
 423             self.report("Fixed incorrect RMD_FLAGS %u" % (rmd_flags))
 424
 425     def err_orphaned_backlink(self, obj, attrname, val, link_name, target_dn):
 426         '''handle a orphaned backlink value'''
 427         self.report("ERROR: orphaned backlink attribute '%s' in %s for link %s in %s" % (attrname, obj.dn, link_name, target_dn))
 428         if not self.confirm_all('Remove orphaned backlink %s' % link_name, 'fix_all_orphaned_backlinks'):
 429             self.report("Not removing orphaned backlink %s" % link_name)
 430             return
 431         m = ldb.Message()
 432         m.dn = obj.dn
 433         m['value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
 434         if self.do_modify(m, ["show_recycled:1", "relax:0"],
 435                           "Failed to fix orphaned backlink %s" % link_name):
 436             self.report("Fixed orphaned backlink %s" % (link_name))
 437
 438     def err_no_fsmoRoleOwner(self, obj):
 439         '''handle a missing fSMORoleOwner'''
 440         self.report("ERROR: fSMORoleOwner not found for role %s" % (obj.dn))
 441         res = self.samdb.search("",
 442                                 scope=ldb.SCOPE_BASE, attrs=["dsServiceName"])
 443         assert len(res) == 1
 444         serviceName = res[0]["dsServiceName"][0]
 445         if not self.confirm_all('Sieze role %s onto current DC by adding fSMORoleOwner=%s' % (obj.dn, serviceName), 'seize_fsmo_role'):
 446             self.report("Not Siezing role %s onto current DC by adding fSMORoleOwner=%s" % (obj.dn, serviceName))
 447             return
 448         m = ldb.Message()
 449         m.dn = obj.dn
 450         m['value'] = ldb.MessageElement(serviceName, ldb.FLAG_MOD_ADD, 'fSMORoleOwner')
 451         if self.do_modify(m, [],
 452                           "Failed to sieze role %s onto current DC by adding fSMORoleOwner=%s" % (obj.dn, serviceName)):
 453             self.report("Siezed role %s onto current DC by adding fSMORoleOwner=%s" % (obj.dn, serviceName))
 454
 455     def err_missing_parent(self, obj):
 456         '''handle a missing parent'''
 457         self.report("ERROR: parent object not found for %s" % (obj.dn))
 458         if not self.confirm_all('Move object %s into LostAndFound?' % (obj.dn), 'move_to_lost_and_found'):
 459             self.report('Not moving object %s into LostAndFound' % (obj.dn))
 460             return
 461
 462         keep_transaction = True
 463         self.samdb.transaction_start()
 464         try:
 465             nc_root = self.samdb.get_nc_root(obj.dn);
 466             lost_and_found = self.samdb.get_wellknown_dn(nc_root, dsdb.DS_GUID_LOSTANDFOUND_CONTAINER)
 467             new_dn = ldb.Dn(self.samdb, str(obj.dn))
 468             new_dn.remove_base_components(len(new_dn) - 1)
 469             if self.do_rename(obj.dn, new_dn, lost_and_found, ["show_deleted:0", "relax:0"],
 470                               "Failed to rename object %s into lostAndFound at %s" % (obj.dn, new_dn + lost_and_found)):
 471                 self.report("Renamed object %s into lostAndFound at %s" % (obj.dn, new_dn + lost_and_found))
 472
 473                 m = ldb.Message()
 474                 m.dn = obj.dn
 475                 m['lastKnownParent'] = ldb.MessageElement(str(obj.dn.parent()), ldb.FLAG_MOD_REPLACE, 'lastKnownParent')
 476
 477                 if self.do_modify(m, [],
 478                                   "Failed to set lastKnownParent on lostAndFound object at %s" % (new_dn + lost_and_found)):
 479                     self.report("Set lastKnownParent on lostAndFound object at %s" % (new_dn + lost_and_found))
 480                     keep_transaction = True
 481         except:
 482             self.samdb.transaction_cancel()
 483             raise
 484
 485         if keep_transaction:
 486             self.samdb.transaction_commit()
 487         else:
 488             self.samdb.transaction_cancel()
 489
 490     def err_wrong_dn(self, obj, new_dn, rdn_attr, rdn_val, name_val):
 491         '''handle a wrong dn'''
 492
 493         new_rdn = ldb.Dn(self.samdb, str(new_dn))
 494         new_rdn.remove_base_components(len(new_rdn) - 1)
 495         new_parent = new_dn.parent()
 496
 497         attributes = ""
 498         if rdn_val != name_val:
 499             attributes += "%s=%r " % (rdn_attr, rdn_val)
 500         attributes += "name=%r" % (name_val)
 501
 502         self.report("ERROR: wrong dn[%s] %s new_dn[%s]" % (obj.dn, attributes, new_dn))
 503         if not self.confirm_all("Rename %s to %s?" % (obj.dn, new_dn), 'fix_dn'):
 504             self.report("Not renaming %s to %s" % (obj.dn, new_dn))
 505             return
 506
 507         if self.do_rename(obj.dn, new_rdn, new_parent, ["show_recycled:1", "relax:0"],
 508                           "Failed to rename object %s into %s" % (obj.dn, new_dn)):
 509             self.report("Renamed %s into %s" % (obj.dn, new_dn))
 510
 511     def err_wrong_instancetype(self, obj, calculated_instancetype):
 512         '''handle a wrong instanceType'''
 513         self.report("ERROR: wrong instanceType %s on %s, should be %d" % (obj["instanceType"], obj.dn, calculated_instancetype))
 514         if not self.confirm_all('Change instanceType from %s to %d on %s?' % (obj["instanceType"], calculated_instancetype, obj.dn), 'fix_instancetype'):
 515             self.report('Not changing instanceType from %s to %d on %s' % (obj["instanceType"], calculated_instancetype, obj.dn))
 516             return
 517
 518         m = ldb.Message()
 519         m.dn = obj.dn
 520         m['value'] = ldb.MessageElement(str(calculated_instancetype), ldb.FLAG_MOD_REPLACE, 'instanceType')
 521         if self.do_modify(m, ["local_oid:%s:0" % dsdb.DSDB_CONTROL_DBCHECK_MODIFY_RO_REPLICA],
 522                           "Failed to correct missing instanceType on %s by setting instanceType=%d" % (obj.dn, calculated_instancetype)):
 523             self.report("Corrected instancetype on %s by setting instanceType=%d" % (obj.dn, calculated_instancetype))
 524
 525     def find_revealed_link(self, dn, attrname, guid):
 526         '''return a revealed link in an object'''
 527         res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE, attrs=[attrname],
 528                                 controls=["show_deleted:0", "extended_dn:0", "reveal_internals:0"])
 529         syntax_oid = self.samdb_schema.get_syntax_oid_from_lDAPDisplayName(attrname)
 530         for val in res[0][attrname]:
 531             dsdb_dn = dsdb_Dn(self.samdb, val, syntax_oid)
 532             guid2 = dsdb_dn.dn.get_extended_component("GUID")
 533             if guid == guid2:
 534                 return dsdb_dn
 535         return None
 536
 537     def check_dn(self, obj, attrname, syntax_oid):
 538         '''check a DN attribute for correctness'''
 539         error_count = 0
 540         for val in obj[attrname]:
 541             dsdb_dn = dsdb_Dn(self.samdb, val, syntax_oid)
 542
 543             # all DNs should have a GUID component
 544             guid = dsdb_dn.dn.get_extended_component("GUID")
 545             if guid is None:
 546                 error_count += 1
 547                 self.err_incorrect_dn_GUID(obj.dn, attrname, val, dsdb_dn,
 548                     "missing GUID")
 549                 continue
 550
 551             guidstr = str(misc.GUID(guid))
 552
 553             attrs = ['isDeleted']
 554
 555             if (str(attrname).lower() == 'msds-hasinstantiatedncs') and (obj.dn == self.ntds_dsa):
 556                 fixing_msDS_HasInstantiatedNCs = True
 557                 attrs.append("instanceType")
 558             else:
 559                 fixing_msDS_HasInstantiatedNCs = False
 560
 561             linkID = self.samdb_schema.get_linkId_from_lDAPDisplayName(attrname)
 562             reverse_link_name = self.samdb_schema.get_backlink_from_lDAPDisplayName(attrname)
 563             if reverse_link_name is not None:
 564                 attrs.append(reverse_link_name)
 565
 566             # check its the right GUID
 567             try:
 568                 res = self.samdb.search(base="<GUID=%s>" % guidstr, scope=ldb.SCOPE_BASE,
 569                                         attrs=attrs, controls=["extended_dn:1:1", "show_recycled:1"])
 570             except ldb.LdbError, (enum, estr):
 571                 error_count += 1
 572                 self.err_incorrect_dn_GUID(obj.dn, attrname, val, dsdb_dn, "incorrect GUID")
 573                 continue
 574
 575             if fixing_msDS_HasInstantiatedNCs:
 576                 dsdb_dn.prefix = "B:8:%08X:" % int(res[0]['instanceType'][0])
 577                 dsdb_dn.binary = "%08X" % int(res[0]['instanceType'][0])
 578
 579                 if str(dsdb_dn) != val:
 580                     error_count +=1
 581                     self.err_incorrect_binary_dn(obj.dn, attrname, val, dsdb_dn, "incorrect instanceType part of Binary DN")
 582                     continue
 583
 584             # now we have two cases - the source object might or might not be deleted
 585             is_deleted = 'isDeleted' in obj and obj['isDeleted'][0].upper() == 'TRUE'
 586             target_is_deleted = 'isDeleted' in res[0] and res[0]['isDeleted'][0].upper() == 'TRUE'
 587
 588             # the target DN is not allowed to be deleted, unless the target DN is the
 589             # special Deleted Objects container
 590             if target_is_deleted and not is_deleted and not self.is_deleted_objects_dn(dsdb_dn):
 591                 error_count += 1
 592                 self.err_deleted_dn(obj.dn, attrname, val, dsdb_dn, res[0].dn)
 593                 continue
 594
 595             # check the DN matches in string form
 596             if res[0].dn.extended_str() != dsdb_dn.dn.extended_str():
 597                 error_count += 1
 598                 self.err_dn_target_mismatch(obj.dn, attrname, val, dsdb_dn,
 599                                             res[0].dn, "incorrect string version of DN")
 600                 continue
 601
 602             if is_deleted and not target_is_deleted and reverse_link_name is not None:
 603                 revealed_dn = self.find_revealed_link(obj.dn, attrname, guid)
 604                 rmd_flags = revealed_dn.dn.get_extended_component("RMD_FLAGS")
 605                 if rmd_flags is not None and (int(rmd_flags) & 1) == 0:
 606                     # the RMD_FLAGS for this link should be 1, as the target is deleted
 607                     self.err_incorrect_rmd_flags(obj, attrname, revealed_dn)
 608                     continue
 609
 610             # check the reverse_link is correct if there should be one
 611             if reverse_link_name is not None:
 612                 match_count = 0
 613                 if reverse_link_name in res[0]:
 614                     for v in res[0][reverse_link_name]:
 615                         if v == obj.dn.extended_str():
 616                             match_count += 1
 617                 if match_count != 1:
 618                     error_count += 1
 619                     if linkID & 1:
 620                         self.err_orphaned_backlink(obj, attrname, val, reverse_link_name, dsdb_dn.dn)
 621                     else:
 622                         self.err_missing_backlink(obj, attrname, val, reverse_link_name, dsdb_dn.dn)
 623                     continue
 624
 625         return error_count
 626
 627
 628     def get_originating_time(self, val, attid):
 629         '''Read metadata properties and return the originating time for
 630            a given attributeId.
 631
 632            :return: the originating time or 0 if not found
 633         '''
 634
 635         repl = ndr_unpack(drsblobs.replPropertyMetaDataBlob, str(val))
 636         obj = repl.ctr
 637
 638         for o in repl.ctr.array:
 639             if o.attid == attid:
 640                 return o.originating_change_time
 641
 642         return 0
 643
 644     def process_metadata(self, val):
 645         '''Read metadata properties and list attributes in it'''
 646
 647         list_att = []
 648
 649         repl = ndr_unpack(drsblobs.replPropertyMetaDataBlob, str(val))
 650         obj = repl.ctr
 651
 652         for o in repl.ctr.array:
 653             att = self.samdb_schema.get_lDAPDisplayName_by_attid(o.attid)
 654             list_att.append(att.lower())
 655
 656         return list_att
 657
 658
 659     def fix_metadata(self, dn, attr):
 660         '''re-write replPropertyMetaData elements for a single attribute for a
 661         object. This is used to fix missing replPropertyMetaData elements'''
 662         res = self.samdb.search(base = dn, scope=ldb.SCOPE_BASE, attrs = [attr],
 663                                 controls = ["search_options:1:2", "show_recycled:1"])
 664         msg = res[0]
 665         nmsg = ldb.Message()
 666         nmsg.dn = dn
 667         nmsg[attr] = ldb.MessageElement(msg[attr], ldb.FLAG_MOD_REPLACE, attr)
 668         if self.do_modify(nmsg, ["relax:0", "provision:0", "show_recycled:1"],
 669                           "Failed to fix metadata for attribute %s" % attr):
 670             self.report("Fixed metadata for attribute %s" % attr)
 671
 672     def ace_get_effective_inherited_type(self, ace):
 673         if ace.flags & security.SEC_ACE_FLAG_INHERIT_ONLY:
 674             return None
 675
 676         check = False
 677         if ace.type == security.SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT:
 678             check = True
 679         elif ace.type == security.SEC_ACE_TYPE_ACCESS_DENIED_OBJECT:
 680             check = True
 681         elif ace.type == security.SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT:
 682             check = True
 683         elif ace.type == security.SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT:
 684             check = True
 685
 686         if not check:
 687             return None
 688
 689         if not ace.object.flags & security.SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT:
 690             return None
 691
 692         return str(ace.object.inherited_type)
 693
 694     def lookup_class_schemaIDGUID(self, cls):
 695         if cls in self.class_schemaIDGUID:
 696             return self.class_schemaIDGUID[cls]
 697
 698         flt = "(&(ldapDisplayName=%s)(objectClass=classSchema))" % cls
 699         res = self.samdb.search(base=self.schema_dn,
 700                                 expression=flt,
 701                                 attrs=["schemaIDGUID"])
 702         t = str(ndr_unpack(misc.GUID, res[0]["schemaIDGUID"][0]))
 703
 704         self.class_schemaIDGUID[cls] = t
 705         return t
 706
 707     def process_sd(self, dn, obj):
 708         sd_attr = "nTSecurityDescriptor"
 709         sd_val = obj[sd_attr]
 710
 711         sd = ndr_unpack(security.descriptor, str(sd_val))
 712
 713         is_deleted = 'isDeleted' in obj and obj['isDeleted'][0].upper() == 'TRUE'
 714         if is_deleted:
 715             # we don't fix deleted objects
 716             return (sd, None)
 717
 718         sd_clean = security.descriptor()
 719         sd_clean.owner_sid = sd.owner_sid
 720         sd_clean.group_sid = sd.group_sid
 721         sd_clean.type = sd.type
 722         sd_clean.revision = sd.revision
 723
 724         broken = False
 725         last_inherited_type = None
 726
 727         aces = []
 728         if sd.sacl is not None:
 729             aces = sd.sacl.aces
 730         for i in range(0, len(aces)):
 731             ace = aces[i]
 732
 733             if not ace.flags & security.SEC_ACE_FLAG_INHERITED_ACE:
 734                 sd_clean.sacl_add(ace)
 735                 continue
 736
 737             t = self.ace_get_effective_inherited_type(ace)
 738             if t is None:
 739                 continue
 740
 741             if last_inherited_type is not None:
 742                 if t != last_inherited_type:
 743                     # if it inherited from more than
 744                     # one type it's very likely to be broken
 745                     #
 746                     # If not the recalculation will calculate
 747                     # the same result.
 748                     broken = True
 749                 continue
 750
 751             last_inherited_type = t
 752
 753         aces = []
 754         if sd.dacl is not None:
 755             aces = sd.dacl.aces
 756         for i in range(0, len(aces)):
 757             ace = aces[i]
 758
 759             if not ace.flags & security.SEC_ACE_FLAG_INHERITED_ACE:
 760                 sd_clean.dacl_add(ace)
 761                 continue
 762
 763             t = self.ace_get_effective_inherited_type(ace)
 764             if t is None:
 765                 continue
 766
 767             if last_inherited_type is not None:
 768                 if t != last_inherited_type:
 769                     # if it inherited from more than
 770                     # one type it's very likely to be broken
 771                     #
 772                     # If not the recalculation will calculate
 773                     # the same result.
 774                     broken = True
 775                 continue
 776
 777             last_inherited_type = t
 778
 779         if broken:
 780             return (sd_clean, sd)
 781
 782         if last_inherited_type is None:
 783             # ok
 784             return (sd, None)
 785
 786         cls = None
 787         try:
 788             cls = obj["objectClass"][-1]
 789         except KeyError, e:
 790             pass
 791
 792         if cls is None:
 793             res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE,
 794                                     attrs=["isDeleted", "objectClass"],
 795                                     controls=["show_recycled:1"])
 796             o = res[0]
 797             is_deleted = 'isDeleted' in o and o['isDeleted'][0].upper() == 'TRUE'
 798             if is_deleted:
 799                 # we don't fix deleted objects
 800                 return (sd, None)
 801             cls = o["objectClass"][-1]
 802
 803         t = self.lookup_class_schemaIDGUID(cls)
 804
 805         if t != last_inherited_type:
 806             # broken
 807             return (sd_clean, sd)
 808
 809         # ok
 810         return (sd, None)
 811
 812     def err_wrong_sd(self, dn, sd, sd_broken):
 813         '''re-write the SD due to incorrect inherited ACEs'''
 814         sd_attr = "nTSecurityDescriptor"
 815         sd_val = ndr_pack(sd)
 816         sd_flags = security.SECINFO_DACL | security.SECINFO_SACL
 817
 818         if not self.confirm_all('Fix %s on %s?' % (sd_attr, dn), 'fix_ntsecuritydescriptor'):
 819             self.report('Not fixing %s on %s\n' % (sd_attr, dn))
 820             return
 821
 822         nmsg = ldb.Message()
 823         nmsg.dn = dn
 824         nmsg[sd_attr] = ldb.MessageElement(sd_val, ldb.FLAG_MOD_REPLACE, sd_attr)
 825         if self.do_modify(nmsg, ["sd_flags:1:%d" % sd_flags],
 826                           "Failed to fix attribute %s" % sd_attr):
 827             self.report("Fixed attribute '%s' of '%s'\n" % (sd_attr, dn))
 828
 829     def err_wrong_default_sd(self, dn, sd, sd_old, diff):
 830         '''re-write the SD due to not matching the default (optional mode for fixing an incorrect provision)'''
 831         sd_attr = "nTSecurityDescriptor"
 832         sd_val = ndr_pack(sd)
 833         sd_old_val = ndr_pack(sd_old)
 834         sd_flags = security.SECINFO_DACL | security.SECINFO_SACL
 835         if sd.owner_sid is not None:
 836             sd_flags |= security.SECINFO_OWNER
 837         if sd.group_sid is not None:
 838             sd_flags |= security.SECINFO_GROUP
 839
 840         if not self.confirm_all('Reset %s on %s back to provision default?\n%s' % (sd_attr, dn, diff), 'reset_all_well_known_acls'):
 841             self.report('Not resetting %s on %s\n' % (sd_attr, dn))
 842             return
 843
 844         m = ldb.Message()
 845         m.dn = dn
 846         m[sd_attr] = ldb.MessageElement(sd_val, ldb.FLAG_MOD_REPLACE, sd_attr)
 847         if self.do_modify(m, ["sd_flags:1:%d" % sd_flags],
 848                           "Failed to reset attribute %s" % sd_attr):
 849             self.report("Fixed attribute '%s' of '%s'\n" % (sd_attr, dn))
 850
 851     def err_missing_sd_owner(self, dn, sd):
 852         '''re-write the SD due to a missing owner or group'''
 853         sd_attr = "nTSecurityDescriptor"
 854         sd_val = ndr_pack(sd)
 855         sd_flags = security.SECINFO_OWNER | security.SECINFO_GROUP
 856
 857         if not self.confirm_all('Fix missing owner or group in %s on %s?' % (sd_attr, dn), 'fix_ntsecuritydescriptor_owner_group'):
 858             self.report('Not fixing missing owner or group %s on %s\n' % (sd_attr, dn))
 859             return
 860
 861         nmsg = ldb.Message()
 862         nmsg.dn = dn
 863         nmsg[sd_attr] = ldb.MessageElement(sd_val, ldb.FLAG_MOD_REPLACE, sd_attr)
 864
 865         # By setting the session_info to admin_session_info and
 866         # setting the security.SECINFO_OWNER | security.SECINFO_GROUP
 867         # flags we cause the descriptor module to set the correct
 868         # owner and group on the SD, replacing the None/NULL values
 869         # for owner_sid and group_sid currently present.
 870         #
 871         # The admin_session_info matches that used in provision, and
 872         # is the best guess we can make for an existing object that
 873         # hasn't had something specifically set.
 874         #
 875         # This is important for the dns related naming contexts.
 876         self.samdb.set_session_info(self.admin_session_info)
 877         if self.do_modify(nmsg, ["sd_flags:1:%d" % sd_flags],
 878                           "Failed to fix metadata for attribute %s" % sd_attr):
 879             self.report("Fixed attribute '%s' of '%s'\n" % (sd_attr, dn))
 880         self.samdb.set_session_info(self.system_session_info)
 881
 882
 883     def has_replmetadata_zero_invocationid(self, dn, repl_meta_data):
 884         repl = ndr_unpack(drsblobs.replPropertyMetaDataBlob,
 885                           str(repl_meta_data))
 886         ctr = repl.ctr
 887         found = False
 888         for o in ctr.array:
 889             # Search for a zero invocationID
 890             if o.originating_invocation_id != misc.GUID("00000000-0000-0000-0000-000000000000"):
 891                 continue
 892
 893             found = True
 894             self.report('''ERROR: on replPropertyMetaData of %s, the instanceType on attribute 0x%08x,
 895                            version %d changed at %s is 00000000-0000-0000-0000-000000000000,
 896                            but should be non-zero.  Proposed fix is to set to our invocationID (%s).'''
 897                         % (dn, o.attid, o.version,
 898                            time.ctime(samba.nttime2unix(o.originating_change_time)),
 899                            self.samdb.get_invocation_id()))
 900
 901         return found
 902
 903
 904     def err_replmetadata_zero_invocationid(self, dn, attr, repl_meta_data):
 905         repl = ndr_unpack(drsblobs.replPropertyMetaDataBlob,
 906                           str(repl_meta_data))
 907         ctr = repl.ctr
 908         now = samba.unix2nttime(int(time.time()))
 909         found = False
 910         for o in ctr.array:
 911             # Search for a zero invocationID
 912             if o.originating_invocation_id != misc.GUID("00000000-0000-0000-0000-000000000000"):
 913                 continue
 914
 915             found = True
 916             seq = self.samdb.sequence_number(ldb.SEQ_NEXT)
 917             o.version = o.version + 1
 918             o.originating_change_time = now
 919             o.originating_invocation_id = misc.GUID(self.samdb.get_invocation_id())
 920             o.originating_usn = seq
 921             o.local_usn = seq
 922
 923         if found:
 924             replBlob = ndr_pack(repl)
 925             msg = ldb.Message()
 926             msg.dn = dn
 927
 928             if not self.confirm_all('Fix %s on %s by setting originating_invocation_id on some elements to our invocationID %s?'
 929                                     % (attr, dn, self.samdb.get_invocation_id()), 'fix_replmetadata_zero_invocationid'):
 930                 self.report('Not fixing %s on %s\n' % (attr, dn))
 931                 return
 932
 933             nmsg = ldb.Message()
 934             nmsg.dn = dn
 935             nmsg[attr] = ldb.MessageElement(replBlob, ldb.FLAG_MOD_REPLACE, attr)
 936             if self.do_modify(nmsg, ["local_oid:1.3.6.1.4.1.7165.4.3.14:0"],
 937                               "Failed to fix attribute %s" % attr):
 938                 self.report("Fixed attribute '%s' of '%s'\n" % (attr, dn))
 939
 940
 941     def is_deleted_deleted_objects(self, obj):
 942         faulty = False
 943         if "description" not in obj:
 944             self.report("ERROR: description not present on Deleted Objects container %s" % obj.dn)
 945             faulty = True
 946         if "showInAdvancedViewOnly" not in obj:
 947             self.report("ERROR: showInAdvancedViewOnly not present on Deleted Objects container %s" % obj.dn)
 948             faulty = True
 949         if "objectCategory" not in obj:
 950             self.report("ERROR: objectCategory not present on Deleted Objects container %s" % obj.dn)
 951             faulty = True
 952         if "isCriticalSystemObject" not in obj:
 953             self.report("ERROR: isCriticalSystemObject not present on Deleted Objects container %s" % obj.dn)
 954             faulty = True
 955         if "isRecycled" in obj:
 956             self.report("ERROR: isRecycled present on Deleted Objects container %s" % obj.dn)
 957             faulty = True
 958         return faulty
 959
 960
 961     def err_deleted_deleted_objects(self, obj):
 962         nmsg = ldb.Message()
 963         nmsg.dn = dn = obj.dn
 964
 965         if "description" not in obj:
 966             nmsg["description"] = ldb.MessageElement("Container for deleted objects", ldb.FLAG_MOD_REPLACE, "description")
 967         if "showInAdvancedViewOnly" not in obj:
 968             nmsg["showInAdvancedViewOnly"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "showInAdvancedViewOnly")
 969         if "objectCategory" not in obj:
 970             nmsg["objectCategory"] = ldb.MessageElement("CN=Container,%s" % self.schema_dn, ldb.FLAG_MOD_REPLACE, "objectCategory")
 971         if "isCriticalSystemObject" not in obj:
 972             nmsg["isCriticalSystemObject"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "isCriticalSystemObject")
 973         if "isRecycled" in obj:
 974             nmsg["isRecycled"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_DELETE, "isRecycled")
 975
 976         if not self.confirm_all('Fix Deleted Objects container %s by restoring default attributes?'
 977                                 % (dn), 'fix_deleted_deleted_objects'):
 978             self.report('Not fixing missing/incorrect attributes on %s\n' % (dn))
 979             return
 980
 981         if self.do_modify(nmsg, ["relax:0"],
 982                           "Failed to fix Deleted Objects container  %s" % dn):
 983             self.report("Fixed Deleted Objects container '%s'\n" % (dn))
 984
 985
 986     def is_fsmo_role(self, dn):
 987         if dn == self.samdb.domain_dn:
 988             return True
 989         if dn == self.infrastructure_dn:
 990             return True
 991         if dn == self.naming_dn:
 992             return True
 993         if dn == self.schema_dn:
 994             return True
 995         if dn == self.rid_dn:
 996             return True
 997
 998         return False
 999
1000     def calculate_instancetype(self, dn):
1001         instancetype = 0
1002         nc_root = self.samdb.get_nc_root(dn)
1003         if dn == nc_root:
1004             instancetype |= dsdb.INSTANCE_TYPE_IS_NC_HEAD
1005             try:
1006                 self.samdb.search(base=dn.parent(), scope=ldb.SCOPE_BASE, attrs=[], controls=["show_recycled:1"])
1007             except ldb.LdbError, (enum, estr):
1008                 if enum != ldb.ERR_NO_SUCH_OBJECT:
1009                     raise
1010             else:
1011                 instancetype |= dsdb.INSTANCE_TYPE_NC_ABOVE
1012
1013         if self.write_ncs is not None and str(nc_root) in self.write_ncs:
1014             instancetype |= dsdb.INSTANCE_TYPE_WRITE
1015
1016         return instancetype
1017
1018     def get_wellknown_sd(self, dn):
1019         for [sd_dn, descriptor_fn] in self.wellknown_sds:
1020             if dn == sd_dn:
1021                 domain_sid = security.dom_sid(self.samdb.get_domain_sid())
1022                 return ndr_unpack(security.descriptor,
1023                                   descriptor_fn(domain_sid,
1024                                                 name_map=self.name_map))
1025
1026         raise KeyError
1027
1028     def check_object(self, dn, attrs=['*']):
1029         '''check one object'''
1030         if self.verbose:
1031             self.report("Checking object %s" % dn)
1032         if "dn" in map(str.lower, attrs):
1033             attrs.append("name")
1034         if "distinguishedname" in map(str.lower, attrs):
1035             attrs.append("name")
1036         if str(dn.get_rdn_name()).lower() in map(str.lower, attrs):
1037             attrs.append("name")
1038         if 'name' in map(str.lower, attrs):
1039             attrs.append(dn.get_rdn_name())
1040             attrs.append("isDeleted")
1041             attrs.append("systemFlags")
1042         if '*' in attrs:
1043             attrs.append("replPropertyMetaData")
1044
1045         try:
1046             sd_flags = 0
1047             sd_flags |= security.SECINFO_OWNER
1048             sd_flags |= security.SECINFO_GROUP
1049             sd_flags |= security.SECINFO_DACL
1050             sd_flags |= security.SECINFO_SACL
1051
1052             res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE,
1053                                     controls=[
1054                                         "extended_dn:1:1",
1055                                         "show_recycled:1",
1056                                         "show_deleted:1",
1057                                         "sd_flags:1:%d" % sd_flags,
1058                                     ],
1059                                     attrs=attrs)
1060         except ldb.LdbError, (enum, estr):
1061             if enum == ldb.ERR_NO_SUCH_OBJECT:
1062                 if self.in_transaction:
1063                     self.report("ERROR: Object %s disappeared during check" % dn)
1064                     return 1
1065                 return 0
1066             raise
1067         if len(res) != 1:
1068             self.report("ERROR: Object %s failed to load during check" % dn)
1069             return 1
1070         obj = res[0]
1071         error_count = 0
1072         list_attrs_from_md = []
1073         list_attrs_seen = []
1074         got_repl_property_meta_data = False
1075         got_objectclass = False
1076
1077         nc_dn = self.samdb.get_nc_root(obj.dn)
1078         try:
1079             deleted_objects_dn = self.samdb.get_wellknown_dn(nc_dn,
1080                                                  samba.dsdb.DS_GUID_DELETED_OBJECTS_CONTAINER)
1081         except KeyError, e:
1082             deleted_objects_dn = ldb.Dn(self.samdb, "CN=Deleted Objects,%s" % nc_dn)
1083
1084         object_rdn_attr = None
1085         object_rdn_val = None
1086         name_val = None
1087         isDeleted = False
1088         systemFlags = 0
1089
1090         for attrname in obj:
1091             if attrname == 'dn':
1092                 continue
1093
1094             if str(attrname).lower() == 'objectclass':
1095                 got_objectclass = True
1096
1097             if str(attrname).lower() == "name":
1098                 if len(obj[attrname]) != 1:
1099                     error_count += 1
1100                     self.report("ERROR: Not fixing num_values(%d) for '%s' on '%s'" %
1101                                 (len(obj[attrname]), attrname, str(obj.dn)))
1102                 else:
1103                     name_val = obj[attrname][0]
1104
1105             if str(attrname).lower() == str(obj.dn.get_rdn_name()).lower():
1106                 object_rdn_attr = attrname
1107                 if len(obj[attrname]) != 1:
1108                     error_count += 1
1109                     self.report("ERROR: Not fixing num_values(%d) for '%s' on '%s'" %
1110                                 (len(obj[attrname]), attrname, str(obj.dn)))
1111                 else:
1112                     object_rdn_val = obj[attrname][0]
1113
1114             if str(attrname).lower() == 'isdeleted':
1115                 if obj[attrname][0] != "FALSE":
1116                     isDeleted = True
1117
1118             if str(attrname).lower() == 'systemflags':
1119                 systemFlags = int(obj[attrname][0])
1120
1121             if str(attrname).lower() == 'replpropertymetadata':
1122                 if self.has_replmetadata_zero_invocationid(dn, obj[attrname]):
1123                     error_count += 1
1124                     self.err_replmetadata_zero_invocationid(dn, attrname, obj[attrname])
1125                     # We don't continue, as we may also have other fixes for this attribute
1126                     # based on what other attributes we see.
1127
1128                 list_attrs_from_md = self.process_metadata(obj[attrname])
1129                 got_repl_property_meta_data = True
1130                 continue
1131
1132             if str(attrname).lower() == 'ntsecuritydescriptor':
1133                 (sd, sd_broken) = self.process_sd(dn, obj)
1134                 if sd_broken is not None:
1135                     self.err_wrong_sd(dn, sd, sd_broken)
1136                     error_count += 1
1137                     continue
1138
1139                 if sd.owner_sid is None or sd.group_sid is None:
1140                     self.err_missing_sd_owner(dn, sd)
1141                     error_count += 1
1142                     continue
1143
1144                 if self.reset_well_known_acls:
1145                     try:
1146                         well_known_sd = self.get_wellknown_sd(dn)
1147                     except KeyError:
1148                         continue
1149
1150                     current_sd = ndr_unpack(security.descriptor,
1151                                             str(obj[attrname][0]))
1152
1153                     diff = get_diff_sds(well_known_sd, current_sd, security.dom_sid(self.samdb.get_domain_sid()))
1154                     if diff != "":
1155                         self.err_wrong_default_sd(dn, well_known_sd, current_sd, diff)
1156                         error_count += 1
1157                         continue
1158                 continue
1159
1160             if str(attrname).lower() == 'objectclass':
1161                 normalised = self.samdb.dsdb_normalise_attributes(self.samdb_schema, attrname, list(obj[attrname]))
1162                 if list(normalised) != list(obj[attrname]):
1163                     self.err_normalise_mismatch_replace(dn, attrname, list(obj[attrname]))
1164                     error_count += 1
1165                 continue
1166
1167             # check for empty attributes
1168             for val in obj[attrname]:
1169                 if val == '':
1170                     self.err_empty_attribute(dn, attrname)
1171                     error_count += 1
1172                     continue
1173
1174             # get the syntax oid for the attribute, so we can can have
1175             # special handling for some specific attribute types
1176             try:
1177                 syntax_oid = self.samdb_schema.get_syntax_oid_from_lDAPDisplayName(attrname)
1178             except Exception, msg:
1179                 self.err_unknown_attribute(obj, attrname)
1180                 error_count += 1
1181                 continue
1182
1183             flag = self.samdb_schema.get_systemFlags_from_lDAPDisplayName(attrname)
1184             if (not flag & dsdb.DS_FLAG_ATTR_NOT_REPLICATED
1185                 and not flag & dsdb.DS_FLAG_ATTR_IS_CONSTRUCTED
1186                 and not self.samdb_schema.get_linkId_from_lDAPDisplayName(attrname)):
1187                 list_attrs_seen.append(str(attrname).lower())
1188
1189             if syntax_oid in [ dsdb.DSDB_SYNTAX_BINARY_DN, dsdb.DSDB_SYNTAX_OR_NAME,
1190                                dsdb.DSDB_SYNTAX_STRING_DN, ldb.SYNTAX_DN ]:
1191                 # it's some form of DN, do specialised checking on those
1192                 error_count += self.check_dn(obj, attrname, syntax_oid)
1193
1194             # check for incorrectly normalised attributes
1195             for val in obj[attrname]:
1196                 normalised = self.samdb.dsdb_normalise_attributes(self.samdb_schema, attrname, [val])
1197                 if len(normalised) != 1 or normalised[0] != val:
1198                     self.err_normalise_mismatch(dn, attrname, obj[attrname])
1199                     error_count += 1
1200                     break
1201
1202             if str(attrname).lower() == "instancetype":
1203                 calculated_instancetype = self.calculate_instancetype(dn)
1204                 if len(obj["instanceType"]) != 1 or obj["instanceType"][0] != str(calculated_instancetype):
1205                     error_count += 1
1206                     self.err_wrong_instancetype(obj, calculated_instancetype)
1207
1208         if not got_objectclass and ("*" in attrs or "objectclass" in map(str.lower, attrs)):
1209             error_count += 1
1210             self.err_missing_objectclass(dn)
1211
1212         if ("*" in attrs or "name" in map(str.lower, attrs)):
1213             if name_val is None:
1214                 error_count += 1
1215                 self.report("ERROR: Not fixing missing 'name' on '%s'" % (str(obj.dn)))
1216             if object_rdn_attr is None:
1217                 error_count += 1
1218                 self.report("ERROR: Not fixing missing '%s' on '%s'" % (obj.dn.get_rdn_name(), str(obj.dn)))
1219
1220         if name_val is not None:
1221             parent_dn = None
1222             if isDeleted:
1223                 if not (systemFlags & samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE):
1224                     parent_dn = deleted_objects_dn
1225             if parent_dn is None:
1226                 parent_dn = obj.dn.parent()
1227             expected_dn = ldb.Dn(self.samdb, "RDN=RDN,%s" % (parent_dn))
1228             expected_dn.set_component(0, obj.dn.get_rdn_name(), name_val)
1229
1230             if obj.dn == deleted_objects_dn:
1231                 expected_dn = obj.dn
1232
1233             if expected_dn != obj.dn:
1234                 error_count += 1
1235                 self.err_wrong_dn(obj, expected_dn, object_rdn_attr, object_rdn_val, name_val)
1236             elif obj.dn.get_rdn_value() != object_rdn_val:
1237                 error_count += 1
1238                 self.report("ERROR: Not fixing %s=%r on '%s'" % (object_rdn_attr, object_rdn_val, str(obj.dn)))
1239
1240         show_dn = True
1241         if got_repl_property_meta_data:
1242             if obj.dn == deleted_objects_dn:
1243                 isDeletedAttId = 131120
1244                 # It's 29/12/9999 at 23:59:59 UTC as specified in MS-ADTS 7.1.1.4.2 Deleted Objects Container
1245
1246                 expectedTimeDo = 2650466015990000000
1247                 originating = self.get_originating_time(obj["replPropertyMetaData"], isDeletedAttId)
1248                 if originating != expectedTimeDo:
1249                     if self.confirm_all("Fix isDeleted originating_change_time on '%s'" % str(dn), 'fix_time_metadata'):
1250                         nmsg = ldb.Message()
1251                         nmsg.dn = dn
1252                         nmsg["isDeleted"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "isDeleted")
1253                         error_count += 1
1254                         self.samdb.modify(nmsg, controls=["provision:0"])
1255
1256                     else:
1257                         self.report("Not fixing isDeleted originating_change_time on '%s'" % str(dn))
1258             for att in list_attrs_seen:
1259                 if not att in list_attrs_from_md:
1260                     if show_dn:
1261                         self.report("On object %s" % dn)
1262                         show_dn = False
1263                     error_count += 1
1264                     self.report("ERROR: Attribute %s not present in replication metadata" % att)
1265                     if not self.confirm_all("Fix missing replPropertyMetaData element '%s'" % att, 'fix_all_metadata'):
1266                         self.report("Not fixing missing replPropertyMetaData element '%s'" % att)
1267                         continue
1268                     self.fix_metadata(dn, att)
1269
1270         if self.is_fsmo_role(dn):
1271             if "fSMORoleOwner" not in obj and ("*" in attrs or "fsmoroleowner" in map(str.lower, attrs)):
1272                 self.err_no_fsmoRoleOwner(obj)
1273                 error_count += 1
1274
1275         try:
1276             if dn != self.samdb.get_root_basedn():
1277                 res = self.samdb.search(base=dn.parent(), scope=ldb.SCOPE_BASE,
1278                                         controls=["show_recycled:1", "show_deleted:1"])
1279         except ldb.LdbError, (enum, estr):
1280             if enum == ldb.ERR_NO_SUCH_OBJECT:
1281                 self.err_missing_parent(obj)
1282                 error_count += 1
1283             else:
1284                 raise
1285
1286         if dn in self.deleted_objects_containers and '*' in attrs:
1287             if self.is_deleted_deleted_objects(obj):
1288                 self.err_deleted_deleted_objects(obj)
1289                 error_count += 1
1290
1291         return error_count
1292
1293     ################################################################
1294     # check special @ROOTDSE attributes
1295     def check_rootdse(self):
1296         '''check the @ROOTDSE special object'''
1297         dn = ldb.Dn(self.samdb, '@ROOTDSE')
1298         if self.verbose:
1299             self.report("Checking object %s" % dn)
1300         res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE)
1301         if len(res) != 1:
1302             self.report("Object %s disappeared during check" % dn)
1303             return 1
1304         obj = res[0]
1305         error_count = 0
1306
1307         # check that the dsServiceName is in GUID form
1308         if not 'dsServiceName' in obj:
1309             self.report('ERROR: dsServiceName missing in @ROOTDSE')
1310             return error_count+1
1311
1312         if not obj['dsServiceName'][0].startswith('<GUID='):
1313             self.report('ERROR: dsServiceName not in GUID form in @ROOTDSE')
1314             error_count += 1
1315             if not self.confirm('Change dsServiceName to GUID form?'):
1316                 return error_count
1317             res = self.samdb.search(base=ldb.Dn(self.samdb, obj['dsServiceName'][0]),
1318                                     scope=ldb.SCOPE_BASE, attrs=['objectGUID'])
1319             guid_str = str(ndr_unpack(misc.GUID, res[0]['objectGUID'][0]))
1320             m = ldb.Message()
1321             m.dn = dn
1322             m['dsServiceName'] = ldb.MessageElement("<GUID=%s>" % guid_str,
1323                                                     ldb.FLAG_MOD_REPLACE, 'dsServiceName')
1324             if self.do_modify(m, [], "Failed to change dsServiceName to GUID form", validate=False):
1325                 self.report("Changed dsServiceName to GUID form")
1326         return error_count
1327
1328
1329     ###############################################
1330     # re-index the database
1331     def reindex_database(self):
1332         '''re-index the whole database'''
1333         m = ldb.Message()
1334         m.dn = ldb.Dn(self.samdb, "@ATTRIBUTES")
1335         m['add']    = ldb.MessageElement('NONE', ldb.FLAG_MOD_ADD, 'force_reindex')
1336         m['delete'] = ldb.MessageElement('NONE', ldb.FLAG_MOD_DELETE, 'force_reindex')
1337         return self.do_modify(m, [], 're-indexed database', validate=False)
1338
1339     ###############################################
1340     # reset @MODULES
1341     def reset_modules(self):
1342         '''reset @MODULES to that needed for current sam.ldb (to read a very old database)'''
1343         m = ldb.Message()
1344         m.dn = ldb.Dn(self.samdb, "@MODULES")
1345         m['@LIST'] = ldb.MessageElement('samba_dsdb', ldb.FLAG_MOD_REPLACE, '@LIST')
1346         return self.do_modify(m, [], 'reset @MODULES on database', validate=False)