eea9dfc28efd11b7c125264fe512b9738bd4ca89
[kai/samba.git] / source4 / scripting / python / samba / dbchecker.py
1 #!/usr/bin/env python
2 #
3 # Samba4 AD database checker
4 #
5 # Copyright (C) Andrew Tridgell 2011
6 #
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 #
20
21 import ldb
22 from samba import dsdb
23 from samba import common
24 from samba.dcerpc import misc
25
26
27 class dsdb_DN(object):
28     '''a class to manipulate DN components'''
29
30     def __init__(self, samdb, dnstring, syntax_oid):
31         if syntax_oid in [ dsdb.DSDB_SYNTAX_BINARY_DN, dsdb.DSDB_SYNTAX_STRING_DN ]:
32             colons = dnstring.split(':')
33             if len(colons) < 4:
34                 raise Exception("invalid DN prefix")
35             prefix_len = 4 + len(colons[1]) + int(colons[1])
36             self.prefix = dnstring[0:prefix_len]
37             self.dnstring = dnstring[prefix_len:]
38         else:
39             self.dnstring = dnstring
40             self.prefix = ''
41         try:
42             self.dn = ldb.Dn(samdb, self.dnstring)
43         except Exception, msg:
44             print("ERROR: bad DN string '%s'" % self.dnstring)
45             raise
46
47     def __str__(self):
48         return self.prefix + str(self.dn.extended_str(mode=1))
49
50 class dbcheck(object):
51     """check a SAM database for errors"""
52
53     def __init__(self, samdb, samdb_schema=None, verbose=False, fix=False, yes=False, quiet=False):
54         self.samdb = samdb
55         self.samdb_schema = (samdb_schema or samdb)
56         self.verbose = verbose
57         self.fix = fix
58         self.yes = yes
59         self.quiet = quiet
60         self.remove_all_unknown_attributes = False
61         self.remove_all_empty_attributes = False
62         self.fix_all_normalisation = False
63         self.fix_all_DN_GUIDs = False
64         self.remove_all_deleted_DN_links = False
65         self.fix_all_target_mismatch = False
66
67     def check_database(self, DN=None, scope=ldb.SCOPE_SUBTREE, controls=[], attrs=['*']):
68         '''perform a database check, returning the number of errors found'''
69
70         res = self.samdb.search(base=DN, scope=scope, attrs=['dn'], controls=controls)
71         self.report('Checking %u objects' % len(res))
72         error_count = 0
73         for object in res:
74             error_count += self.check_object(object.dn, attrs=attrs)
75         if error_count != 0 and not self.fix:
76             self.report("Please use --fix to fix these errors")
77         self.report('Checked %u objects (%u errors)' % (len(res), error_count))
78
79         return error_count
80
81
82     def report(self, msg):
83         '''print a message unless quiet is set'''
84         if not self.quiet:
85             print(msg)
86
87
88     ################################################################
89     # a local confirm function that obeys the --fix and --yes options
90     def confirm(self, msg, allow_all=False, forced=False):
91         '''confirm a change'''
92         if not self.fix:
93             return False
94         if self.quiet:
95             return self.yes
96         if self.yes:
97             forced = True
98         return common.confirm(msg, forced=forced, allow_all=allow_all)
99
100     ################################################################
101     # a local confirm function with support for 'all'
102     def confirm_all(self, msg, all_attr):
103         '''confirm a change with support for "all" '''
104         if not self.fix:
105             return False
106         if self.quiet:
107             return self.yes
108         if getattr(self, all_attr) == 'NONE':
109             return False
110         if getattr(self, all_attr) == 'ALL':
111             forced = True
112         else:
113             forced = self.yes
114         c = common.confirm(msg, forced=forced, allow_all=True)
115         if c == 'ALL':
116             setattr(self, all_attr, 'ALL')
117             return True
118         if c == 'NONE':
119             setattr(self, all_attr, 'NONE')
120             return True
121         return c
122
123
124     ################################################################
125     # handle empty attributes
126     def err_empty_attribute(self, dn, attrname):
127         '''fix empty attributes'''
128         self.report("ERROR: Empty attribute %s in %s" % (attrname, dn))
129         if not self.confirm_all('Remove empty attribute %s from %s?' % (attrname, dn), 'remove_all_empty_attributes'):
130             self.report("Not fixing empty attribute %s" % attrname)
131             return
132
133         m = ldb.Message()
134         m.dn = dn
135         m[attrname] = ldb.MessageElement('', ldb.FLAG_MOD_DELETE, attrname)
136         if self.verbose:
137             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
138         try:
139             self.samdb.modify(m, controls=["relax:0", "show_deleted:1"], validate=False)
140         except Exception, msg:
141             self.report("Failed to remove empty attribute %s : %s" % (attrname, msg))
142             return
143         self.report("Removed empty attribute %s" % attrname)
144
145
146     ################################################################
147     # handle normalisation mismatches
148     def err_normalise_mismatch(self, dn, attrname, values):
149         '''fix attribute normalisation errors'''
150         self.report("ERROR: Normalisation error for attribute %s in %s" % (attrname, dn))
151         mod_list = []
152         for val in values:
153             normalised = self.samdb.dsdb_normalise_attributes(self.samdb_schema, attrname, [val])
154             if len(normalised) != 1:
155                 self.report("Unable to normalise value '%s'" % val)
156                 mod_list.append((val, ''))
157             elif (normalised[0] != val):
158                 self.report("value '%s' should be '%s'" % (val, normalised[0]))
159                 mod_list.append((val, normalised[0]))
160         if not self.confirm_all('Fix normalisation for %s from %s?' % (attrname, dn), 'fix_all_normalisation'):
161             self.report("Not fixing attribute %s" % attrname)
162             return
163
164         m = ldb.Message()
165         m.dn = dn
166         for i in range(0, len(mod_list)):
167             (val, nval) = mod_list[i]
168             m['value_%u' % i] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
169             if nval != '':
170                 m['normv_%u' % i] = ldb.MessageElement(nval, ldb.FLAG_MOD_ADD, attrname)
171
172         if self.verbose:
173             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
174         try:
175             self.samdb.modify(m, controls=["relax:0", "show_deleted:1"], validate=False)
176         except Exception, msg:
177             self.report("Failed to normalise attribute %s : %s" % (attrname, msg))
178             return
179         self.report("Normalised attribute %s" % attrname)
180
181     def is_deleted_objects_dn(self, dsdb_dn):
182         '''see if a dsdb_DN is the special Deleted Objects DN'''
183         return dsdb_dn.prefix == "B:32:18E2EA80684F11D2B9AA00C04F79F805:"
184
185
186     ################################################################
187     # handle a missing GUID extended DN component
188     def err_incorrect_dn_GUID(self, dn, attrname, val, dsdb_dn, errstr):
189         self.report("ERROR: %s component for %s in object %s - %s" % (errstr, attrname, dn, val))
190         controls=["extended_dn:1:1", "show_deleted:1"]
191         try:
192             res = self.samdb.search(base=str(dsdb_dn.dn), scope=ldb.SCOPE_BASE,
193                                     attrs=[], controls=controls)
194         except ldb.LdbError, (enum, estr):
195             self.report("unable to find object for DN %s - cannot fix (%s)" % (dsdb_dn.dn, estr))
196             return
197         dsdb_dn.dn = res[0].dn
198
199         if not self.confirm_all('Change DN to %s?' % str(dsdb_dn), 'fix_all_DN_GUIDs'):
200             self.report("Not fixing %s" % errstr)
201             return
202         m = ldb.Message()
203         m.dn = dn
204         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
205         m['new_value'] = ldb.MessageElement(str(dsdb_dn), ldb.FLAG_MOD_ADD, attrname)
206         if self.verbose:
207             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
208         try:
209             self.samdb.modify(m, controls=["show_deleted:1"])
210         except Exception, msg:
211             self.report("Failed to fix %s on attribute %s : %s" % (errstr, attrname, msg))
212             return
213         self.report("Fixed %s on attribute %s" % (errstr, attrname))
214
215
216     ################################################################
217     # handle a DN pointing to a deleted object
218     def err_deleted_dn(self, dn, attrname, val, dsdb_dn, correct_dn):
219         self.report("ERROR: target DN is deleted for %s in object %s - %s" % (attrname, dn, val))
220         self.report("Target GUID points at deleted DN %s" % correct_dn)
221         if not self.confirm_all('Remove DN?', 'remove_all_deleted_DN_links'):
222             self.report("Not removing")
223             return
224         m = ldb.Message()
225         m.dn = dn
226         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
227         if self.verbose:
228             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
229         try:
230             self.samdb.modify(m, controls=["show_deleted:1"])
231         except Exception, msg:
232             self.report("Failed to remove deleted DN attribute %s : %s" % (attrname, msg))
233             return
234         self.report("Removed deleted DN on attribute %s" % attrname)
235
236
237     ################################################################
238     # handle a DN string being incorrect
239     def err_dn_target_mismatch(self, dn, attrname, val, dsdb_dn, correct_dn, errstr):
240         self.report("ERROR: incorrect DN string component for %s in object %s - %s" % (attrname, dn, val))
241         dsdb_dn.dn = correct_dn
242
243         if not self.confirm_all('Change DN to %s?' % str(dsdb_dn), 'fix_all_target_mismatch'):
244             self.report("Not fixing %s" % errstr)
245             return
246         m = ldb.Message()
247         m.dn = dn
248         m['old_value'] = ldb.MessageElement(val, ldb.FLAG_MOD_DELETE, attrname)
249         m['new_value'] = ldb.MessageElement(str(dsdb_dn), ldb.FLAG_MOD_ADD, attrname)
250         if self.verbose:
251             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
252         try:
253             self.samdb.modify(m, controls=["show_deleted:1"])
254         except Exception, msg:
255             self.report("Failed to fix incorrect DN string on attribute %s : %s" % (attrname, msg))
256             return
257         self.report("Fixed incorrect DN string on attribute %s" % (attrname))
258
259     ################################################################
260     # handle an unknown attribute error
261     def err_unknown_attribute(self, obj, attrname):
262         '''handle an unknown attribute error'''
263         self.report("ERROR: unknown attribute '%s' in %s" % (attrname, obj.dn))
264         if not self.confirm_all('Remove unknown attribute %s' % attrname, 'remove_all_unknown_attributes'):
265             self.report("Not removing %s" % attrname)
266             return
267         m = ldb.Message()
268         m.dn = obj.dn
269         m['old_value'] = ldb.MessageElement([], ldb.FLAG_MOD_DELETE, attrname)
270         if self.verbose:
271             self.report(self.samdb.write_ldif(m, ldb.CHANGETYPE_MODIFY))
272         try:
273             self.samdb.modify(m, controls=["relax:0", "show_deleted:1"])
274         except Exception, msg:
275             self.report("Failed to remove unknown attribute %s : %s" % (attrname, msg))
276             return
277         self.report("Removed unknown attribute %s" % (attrname))
278
279
280     ################################################################
281     # specialised checking for a dn attribute
282     def check_dn(self, obj, attrname, syntax_oid):
283         '''check a DN attribute for correctness'''
284         error_count = 0
285         for val in obj[attrname]:
286             dsdb_dn = dsdb_DN(self.samdb, val, syntax_oid)
287
288             # all DNs should have a GUID component
289             guid = dsdb_dn.dn.get_extended_component("GUID")
290             if guid is None:
291                 error_count += 1
292                 self.err_incorrect_dn_GUID(obj.dn, attrname, val, dsdb_dn, "missing GUID")
293                 continue
294
295             guidstr = str(misc.GUID(guid))
296
297             # check its the right GUID
298             try:
299                 res = self.samdb.search(base="<GUID=%s>" % guidstr, scope=ldb.SCOPE_BASE,
300                                         attrs=['isDeleted'], controls=["extended_dn:1:1", "show_deleted:1"])
301             except ldb.LdbError, (enum, estr):
302                 error_count += 1
303                 self.err_incorrect_dn_GUID(obj.dn, attrname, val, dsdb_dn, "incorrect GUID")
304                 continue
305
306             # now we have two cases - the source object might or might not be deleted
307             is_deleted = 'isDeleted' in obj and obj['isDeleted'][0].upper() == 'TRUE'
308             target_is_deleted = 'isDeleted' in res[0] and res[0]['isDeleted'][0].upper() == 'TRUE'
309
310             # the target DN is not allowed to be deleted, unless the target DN is the
311             # special Deleted Objects container
312             if target_is_deleted and not is_deleted and not self.is_deleted_objects_dn(dsdb_dn):
313                 error_count += 1
314                 self.err_deleted_dn(obj.dn, attrname, val, dsdb_dn, res[0].dn)
315                 continue
316
317             # check the DN matches in string form
318             if res[0].dn.extended_str() != dsdb_dn.dn.extended_str():
319                 error_count += 1
320                 self.err_dn_target_mismatch(obj.dn, attrname, val, dsdb_dn,
321                                             res[0].dn, "incorrect string version of DN")
322                 continue
323
324         return error_count
325
326
327
328     ################################################################
329     # check one object - calls to individual error handlers above
330     def check_object(self, dn, attrs=['*']):
331         '''check one object'''
332         if self.verbose:
333             self.report("Checking object %s" % dn)
334         res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE,
335                                 controls=["extended_dn:1:1", "show_deleted:1"],
336                                 attrs=attrs)
337         if len(res) != 1:
338             self.report("Object %s disappeared during check" % dn)
339             return 1
340         obj = res[0]
341         error_count = 0
342         for attrname in obj:
343             if attrname == 'dn':
344                 continue
345
346             # check for empty attributes
347             for val in obj[attrname]:
348                 if val == '':
349                     self.err_empty_attribute(dn, attrname)
350                     error_count += 1
351                     continue
352
353             # get the syntax oid for the attribute, so we can can have
354             # special handling for some specific attribute types
355             try:
356                 syntax_oid = self.samdb_schema.get_syntax_oid_from_lDAPDisplayName(attrname)
357             except Exception, msg:
358                 self.err_unknown_attribute(obj, attrname)
359                 error_count += 1
360                 continue
361
362             if syntax_oid in [ dsdb.DSDB_SYNTAX_BINARY_DN, dsdb.DSDB_SYNTAX_OR_NAME,
363                                dsdb.DSDB_SYNTAX_STRING_DN, ldb.LDB_SYNTAX_DN ]:
364                 # it's some form of DN, do specialised checking on those
365                 error_count += self.check_dn(obj, attrname, syntax_oid)
366
367             # check for incorrectly normalised attributes
368             for val in obj[attrname]:
369                 normalised = self.samdb.dsdb_normalise_attributes(self.samdb_schema, attrname, [val])
370                 if len(normalised) != 1 or normalised[0] != val:
371                     self.err_normalise_mismatch(dn, attrname, obj[attrname])
372                     error_count += 1
373                     break
374         return error_count