source4/scripting/bin/samba_downgrade_db

   1 #!/usr/bin/python3
   2 #
   3 # Unix SMB/CIFS implementation.
   4 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2019
   5 #
   6 # Downgrade a database from 4.11 format to 4.7 format. 4.7 Format will
   7 # run on any version of Samba AD, and Samba will repack/reconfigure the
   8 # database if necessary.
   9 #
  10 # This program is free software; you can redistribute it and/or modify
  11 # it under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 3 of the License, or
  13 # (at your option) any later version.
  14 #
  15 # This program is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 # GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License
  21 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 import optparse
  23 import sys
  24
  25 # Find right directory when running from source tree
  26 sys.path.insert(0, "bin/python")
  27
  28
  29 import samba
  30 import ldb
  31 import urllib
  32 import os
  33 from samba import getopt as options
  34 from samba.samdb import SamDB
  35 from samba.dbchecker import dbcheck
  36 from samba.credentials import Credentials
  37 parser = optparse.OptionParser("samba_downgrade_db")
  38 sambaopts = options.SambaOptions(parser)
  39 parser.add_option_group(options.VersionOptions(parser))
  40 parser.add_option("-H", "--URL", help="LDB URL for database",
  41                   type=str, metavar="URL", dest="H")
  42 opts, args = parser.parse_args()
  43
  44 if len(args) != 0:
  45     parser.print_usage()
  46     sys.exit(1)
  47
  48 lp_ctx = sambaopts.get_loadparm()
  49
  50 if opts.H is None:
  51     url = lp_ctx.private_path("sam.ldb")
  52 else:
  53     url = opts.H
  54
  55 samdb = ldb.Ldb(url=url,
  56                 flags=ldb.FLG_DONT_CREATE_DB,
  57                 options=["modules:"])
  58
  59 partitions = samdb.search(base="@PARTITION",
  60                           scope=ldb.SCOPE_BASE,
  61                           attrs=["backendStore", "partition"])
  62
  63 backend = str(partitions[0].get('backendStore', 'tdb'))
  64
  65 if backend == "mdb":
  66     samdb = None
  67     options = ["pack_format_override=%d" % ldb.PACKING_FORMAT]
  68     # We can't remove GUID indexes from LMDB in case there are very
  69     # long DNs, so we just move down the pack format, which also removes
  70     # references to ORDERED_INTEGER in @ATTRIBUTES.
  71
  72     # Reopen the DB with pack_format_override set
  73     samdb = SamDB(url=url,
  74                   flags=ldb.FLG_DONT_CREATE_DB,
  75                   lp=lp_ctx,
  76                   options=options)
  77     samdb.transaction_start()
  78     samdb.transaction_commit()
  79     print("Your database has been downgraded to LDB pack format version %0x (v1)." % ldb.PACKING_FORMAT)
  80
  81     print("NOTE: Any use of a Samba 4.11 tool that modifies the DB will "
  82           "auto-upgrade back to pack format version %0x (v2)" %
  83           ldb.PACKING_FORMAT_V2)
  84     exit(0);
  85
  86 # This is needed to force the @ATTRIBUTES and @INDEXLIST to be correct
  87 lp_ctx.set("dsdb:guid index", "false")
  88
  89 modmsg = ldb.Message()
  90 modmsg.dn = ldb.Dn(samdb, '@INDEXLIST')
  91 modmsg.add(ldb.MessageElement(
  92     elements=[],
  93     flags=ldb.FLAG_MOD_REPLACE,
  94     name='@IDXGUID'))
  95 modmsg.add(ldb.MessageElement(
  96     elements=[],
  97     flags=ldb.FLAG_MOD_REPLACE,
  98     name='@IDX_DN_GUID'))
  99
 100 samdb.transaction_start()
 101 samdb.modify(modmsg)
 102
 103 privatedir = os.path.dirname(url)
 104
 105 dbs = []
 106 for part in partitions[0]['partition']:
 107     dbname = str(part).split(":")[1]
 108     dbpath = os.path.join(privatedir, dbname)
 109     if os.path.isfile(dbpath):
 110         dbpath = "ldb://" + dbpath
 111     db = ldb.Ldb(url=dbpath,
 112                  options=["modules:"],
 113                  flags=ldb.FLG_DONT_CREATE_DB)
 114     db.transaction_start()
 115     db.modify(modmsg)
 116     dbs.append(db)
 117
 118 for db in dbs:
 119     db.transaction_commit()
 120
 121 samdb.transaction_commit()
 122
 123 print("Re-opening with the full DB stack")
 124 samdb = SamDB(url=url,
 125               flags=ldb.FLG_DONT_CREATE_DB,
 126               lp=lp_ctx)
 127 print("Re-triggering another re-index")
 128 chk = dbcheck(samdb)
 129
 130 chk.reindex_database()
 131
 132 print("Your database has been downgraded to DN-based index values.")
 133
 134 print("NOTE: Any use of a Samba 4.8 or later tool including ldbsearch will "
 135       "auto-upgrade back to GUID index mode")