python/samba/netcmd/fsmo.py

   1 # Changes a FSMO role owner
   2 #
   3 # Copyright Nadezhda Ivanova 2009
   4 # Copyright Jelmer Vernooij 2009
   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 samba
  21 import samba.getopt as options
  22 import ldb
  23 from ldb import LdbError
  24 from samba.dcerpc import drsuapi, misc
  25 from samba.auth import system_session
  26 from samba.netcmd import (
  27     Command,
  28     CommandError,
  29     SuperCommand,
  30     Option,
  31     )
  32 from samba.samdb import SamDB
  33
  34 def get_fsmo_roleowner(samdb, roledn, role):
  35     """Gets the owner of an FSMO role
  36
  37     :param roledn: The DN of the FSMO role
  38     :param role: The FSMO role
  39     """
  40     try:
  41         res = samdb.search(roledn,
  42                            scope=ldb.SCOPE_BASE, attrs=["fSMORoleOwner"])
  43     except LdbError, (num, msg):
  44         if num == ldb.ERR_NO_SUCH_OBJECT:
  45             return "* The '%s' role is not present in this domain" % role
  46         raise
  47
  48     if 'fSMORoleOwner' in res[0]:
  49         master_owner = res[0]["fSMORoleOwner"][0]
  50         return master_owner
  51     else:
  52         master_owner = "* The '%s' role does not have an FSMO roleowner" % role
  53         return master_owner
  54
  55
  56 def transfer_dns_role(outf, sambaopts, credopts, role, samdb):
  57     """Transfer dns FSMO role. """
  58
  59     if role == "domaindns":
  60         domain_dn = samdb.domain_dn()
  61         role_object = "CN=Infrastructure,DC=DomainDnsZones," + domain_dn
  62     elif role == "forestdns":
  63         forest_dn = samba.dn_from_dns_name(samdb.forest_dns_name())
  64         role_object = "CN=Infrastructure,DC=ForestDnsZones," + forest_dn
  65
  66     res = samdb.search(role_object,
  67                        attrs=["fSMORoleOwner"],
  68                        scope=ldb.SCOPE_BASE,
  69                        controls=["extended_dn:1:1"])
  70
  71     if 'fSMORoleOwner' in res[0]:
  72         try:
  73             master_guid = str(misc.GUID(ldb.Dn(samdb,
  74                               res[0]['fSMORoleOwner'][0])
  75                               .get_extended_component('GUID')))
  76             master_owner = str(ldb.Dn(samdb, res[0]['fSMORoleOwner'][0]))
  77         except LdbError, (num, msg):
  78             raise CommandError("No GUID found in naming master DN %s : %s \n" %
  79                                (res[0]['fSMORoleOwner'][0], msg))
  80     else:
  81         outf.write("* The '%s' role does not have an FSMO roleowner\n" % role)
  82         return False
  83
  84     if role == "domaindns":
  85         master_dns_name = '%s._msdcs.%s' % (master_guid,
  86                                             samdb.domain_dns_name())
  87         new_dns_name = '%s._msdcs.%s' % (samdb.get_ntds_GUID(),
  88                                          samdb.domain_dns_name())
  89     elif role == "forestdns":
  90         master_dns_name = '%s._msdcs.%s' % (master_guid,
  91                                             samdb.forest_dns_name())
  92         new_dns_name = '%s._msdcs.%s' % (samdb.get_ntds_GUID(),
  93                                          samdb.forest_dns_name())
  94
  95     new_owner = samdb.get_dsServiceName()
  96
  97     if master_dns_name != new_dns_name:
  98         lp = sambaopts.get_loadparm()
  99         creds = credopts.get_credentials(lp, fallback_machine=True)
 100         samdb = SamDB(url="ldap://%s" % (master_dns_name),
 101                       session_info=system_session(),
 102                       credentials=creds, lp=lp)
 103
 104         m = ldb.Message()
 105         m.dn = ldb.Dn(samdb, role_object)
 106         m["fSMORoleOwner"] = ldb.MessageElement(master_owner,
 107                                                 ldb.FLAG_MOD_DELETE,
 108                                                 "fSMORoleOwner")
 109
 110         try:
 111             samdb.modify(m)
 112         except LdbError, (num, msg):
 113             raise CommandError("Failed to delete role '%s': %s" %
 114                                (role, msg))
 115
 116         m = ldb.Message()
 117         m.dn = ldb.Dn(samdb, role_object)
 118         m["fSMORoleOwner"]= ldb.MessageElement(new_owner,
 119                                                ldb.FLAG_MOD_ADD,
 120                                                "fSMORoleOwner")
 121         try:
 122             samdb.modify(m)
 123         except LdbError, (num, msg):
 124             raise CommandError("Failed to add role '%s': %s" % (role, msg))
 125
 126         try:
 127             connection = samba.drs_utils.drsuapi_connect(samdb.host_dns_name(),
 128                                                          lp, creds)
 129         except samba.drs_utils.drsException, e:
 130             raise CommandError("Drsuapi Connect failed", e)
 131
 132         try:
 133             drsuapi_connection = connection[0]
 134             drsuapi_handle = connection[1]
 135             req_options = drsuapi.DRSUAPI_DRS_WRIT_REP
 136             NC = role_object[18:]
 137             samba.drs_utils.sendDsReplicaSync(drsuapi_connection,
 138                                               drsuapi_handle,
 139                                               master_guid,
 140                                               NC, req_options)
 141         except samba.drs_utils.drsException, estr:
 142             raise CommandError("Replication failed", estr)
 143
 144         outf.write("FSMO transfer of '%s' role successful\n" % role)
 145         return True
 146     else:
 147         outf.write("This DC already has the '%s' FSMO role\n" % role)
 148         return False
 149
 150 def transfer_role(outf, role, samdb):
 151     """Transfer standard FSMO role. """
 152
 153     domain_dn = samdb.domain_dn()
 154     rid_dn = "CN=RID Manager$,CN=System," + domain_dn
 155     naming_dn = "CN=Partitions,%s" % samdb.get_config_basedn()
 156     infrastructure_dn = "CN=Infrastructure," + domain_dn
 157     schema_dn = str(samdb.get_schema_basedn())
 158     new_owner = samdb.get_dsServiceName()
 159     m = ldb.Message()
 160     m.dn = ldb.Dn(samdb, "")
 161     if role == "rid":
 162         master_owner = get_fsmo_roleowner(samdb, rid_dn, role)
 163         m["becomeRidMaster"]= ldb.MessageElement(
 164             "1", ldb.FLAG_MOD_REPLACE,
 165             "becomeRidMaster")
 166     elif role == "pdc":
 167         master_owner = get_fsmo_roleowner(samdb, domain_dn, role)
 168
 169         res = samdb.search(domain_dn,
 170                            scope=ldb.SCOPE_BASE, attrs=["objectSid"])
 171         assert len(res) == 1
 172         sid = res[0]["objectSid"][0]
 173         m["becomePdc"]= ldb.MessageElement(
 174             sid, ldb.FLAG_MOD_REPLACE,
 175             "becomePdc")
 176     elif role == "naming":
 177         master_owner = get_fsmo_roleowner(samdb, naming_dn, role)
 178         m["becomeDomainMaster"]= ldb.MessageElement(
 179             "1", ldb.FLAG_MOD_REPLACE,
 180             "becomeDomainMaster")
 181     elif role == "infrastructure":
 182         master_owner = get_fsmo_roleowner(samdb, infrastructure_dn, role)
 183         m["becomeInfrastructureMaster"]= ldb.MessageElement(
 184             "1", ldb.FLAG_MOD_REPLACE,
 185             "becomeInfrastructureMaster")
 186     elif role == "schema":
 187         master_owner = get_fsmo_roleowner(samdb, schema_dn, role)
 188         m["becomeSchemaMaster"]= ldb.MessageElement(
 189             "1", ldb.FLAG_MOD_REPLACE,
 190             "becomeSchemaMaster")
 191     else:
 192         raise CommandError("Invalid FSMO role.")
 193
 194     if not '*' in master_owner:
 195         if master_owner != new_owner:
 196             try:
 197                 samdb.modify(m)
 198             except LdbError, (num, msg):
 199                 raise CommandError("Transfer of '%s' role failed: %s" %
 200                                    (role, msg))
 201
 202             outf.write("FSMO transfer of '%s' role successful\n" % role)
 203             return True
 204         else:
 205             outf.write("This DC already has the '%s' FSMO role\n" % role)
 206             return False
 207     else:
 208         outf.write("%s\n" % master_owner)
 209         return False
 210
 211 class cmd_fsmo_seize(Command):
 212     """Seize the role."""
 213
 214     synopsis = "%prog [options]"
 215
 216     takes_optiongroups = {
 217         "sambaopts": options.SambaOptions,
 218         "credopts": options.CredentialsOptions,
 219         "versionopts": options.VersionOptions,
 220         }
 221
 222     takes_options = [
 223         Option("-H", "--URL", help="LDB URL for database or target server",
 224                type=str, metavar="URL", dest="H"),
 225         Option("--force",
 226                help="Force seizing of role without attempting to transfer.",
 227                action="store_true"),
 228         Option("--role", type="choice", choices=["rid", "pdc", "infrastructure",
 229                "schema", "naming", "domaindns", "forestdns", "all"],
 230                help="""The FSMO role to seize or transfer.\n
 231 rid=RidAllocationMasterRole\n
 232 schema=SchemaMasterRole\n
 233 pdc=PdcEmulationMasterRole\n
 234 naming=DomainNamingMasterRole\n
 235 infrastructure=InfrastructureMasterRole\n
 236 domaindns=DomainDnsZonesMasterRole\n
 237 forestdns=ForestDnsZonesMasterRole\n
 238 all=all of the above\n
 239 You must provide an Admin user and password."""),
 240         ]
 241
 242     takes_args = []
 243
 244     def seize_role(self, role, samdb, force):
 245         """Seize standard fsmo role. """
 246
 247         serviceName = samdb.get_dsServiceName()
 248         domain_dn = samdb.domain_dn()
 249         self.infrastructure_dn = "CN=Infrastructure," + domain_dn
 250         self.naming_dn = "CN=Partitions,%s" % samdb.get_config_basedn()
 251         self.schema_dn = str(samdb.get_schema_basedn())
 252         self.rid_dn = "CN=RID Manager$,CN=System," + domain_dn
 253
 254         m = ldb.Message()
 255         if role == "rid":
 256             m.dn = ldb.Dn(samdb, self.rid_dn)
 257         elif role == "pdc":
 258             m.dn = ldb.Dn(samdb, domain_dn)
 259         elif role == "naming":
 260             m.dn = ldb.Dn(samdb, self.naming_dn)
 261         elif role == "infrastructure":
 262             m.dn = ldb.Dn(samdb, self.infrastructure_dn)
 263         elif role == "schema":
 264             m.dn = ldb.Dn(samdb, self.schema_dn)
 265         else:
 266             raise CommandError("Invalid FSMO role.")
 267         #first try to transfer to avoid problem if the owner is still active
 268         seize = False
 269         master_owner = get_fsmo_roleowner(samdb, m.dn, role)
 270         if not '*' in master_owner:
 271             # if there is a different owner
 272             if master_owner != serviceName:
 273                 # if --force isn't given, attempt transfer
 274                 if force is None:
 275                     self.message("Attempting transfer...")
 276                     try:
 277                         transfer_role(self.outf, role, samdb)
 278                     except:
 279                         #transfer failed, use the big axe...
 280                         seize = True
 281                         self.message("Transfer unsuccessful, seizing...")
 282                     else:
 283                         self.message("Transfer successful, not seizing role")
 284                         return True
 285             else:
 286                 self.outf.write("This DC already has the '%s' FSMO role\n" %
 287                                 role)
 288                 return False
 289         else:
 290             seize = True
 291
 292         if force is not None or seize == True:
 293             self.message("Seizing %s FSMO role..." % role)
 294             m["fSMORoleOwner"]= ldb.MessageElement(
 295                 serviceName, ldb.FLAG_MOD_REPLACE,
 296                 "fSMORoleOwner")
 297             try:
 298                 samdb.modify(m)
 299             except LdbError, (num, msg):
 300                 raise CommandError("Failed to seize '%s' role: %s" %
 301                                    (role, msg))
 302             self.outf.write("FSMO seize of '%s' role successful\n" % role)
 303             return True
 304
 305     def seize_dns_role(self, role, samdb, credopts, sambaopts,
 306                        versionopts, force):
 307         """Seize DNS FSMO role. """
 308
 309         serviceName = samdb.get_dsServiceName()
 310         domain_dn = samdb.domain_dn()
 311         forest_dn = samba.dn_from_dns_name(samdb.forest_dns_name())
 312         self.domaindns_dn = "CN=Infrastructure,DC=DomainDnsZones," + domain_dn
 313         self.forestdns_dn = "CN=Infrastructure,DC=ForestDnsZones," + forest_dn
 314
 315         m = ldb.Message()
 316         if role == "domaindns":
 317             m.dn = ldb.Dn(samdb, self.domaindns_dn)
 318         elif role == "forestdns":
 319             m.dn = ldb.Dn(samdb, self.forestdns_dn)
 320         else:
 321             raise CommandError("Invalid FSMO role.")
 322         #first try to transfer to avoid problem if the owner is still active
 323         seize = False
 324         master_owner = get_fsmo_roleowner(samdb, m.dn, role)
 325         if not '*' in master_owner:
 326             # if there is a different owner
 327             if master_owner != serviceName:
 328                 # if --force isn't given, attempt transfer
 329                 if force is None:
 330                     self.message("Attempting transfer...")
 331                     try:
 332                         transfer_dns_role(self.outf, sambaopts, credopts, role,
 333                                           samdb)
 334                     except:
 335                         #transfer failed, use the big axe...
 336                         seize = True
 337                         self.message("Transfer unsuccessful, seizing...")
 338                     else:
 339                         self.message("Transfer successful, not seizing role\n")
 340                         return True
 341             else:
 342                 self.outf.write("This DC already has the '%s' FSMO role\n" %
 343                                 role)
 344                 return False
 345         else:
 346             seize = True
 347
 348         if force is not None or seize == True:
 349             self.message("Seizing %s FSMO role..." % role)
 350             m["fSMORoleOwner"]= ldb.MessageElement(
 351                 serviceName, ldb.FLAG_MOD_REPLACE,
 352                 "fSMORoleOwner")
 353             try:
 354                 samdb.modify(m)
 355             except LdbError, (num, msg):
 356                 raise CommandError("Failed to seize '%s' role: %s" %
 357                                    (role, msg))
 358             self.outf.write("FSMO seize of '%s' role successful\n" % role)
 359             return True
 360
 361
 362     def run(self, force=None, H=None, role=None,
 363             credopts=None, sambaopts=None, versionopts=None):
 364
 365         lp = sambaopts.get_loadparm()
 366         creds = credopts.get_credentials(lp, fallback_machine=True)
 367
 368         samdb = SamDB(url=H, session_info=system_session(),
 369                       credentials=creds, lp=lp)
 370
 371         if role == "all":
 372             self.seize_role("rid", samdb, force)
 373             self.seize_role("pdc", samdb, force)
 374             self.seize_role("naming", samdb, force)
 375             self.seize_role("infrastructure", samdb, force)
 376             self.seize_role("schema", samdb, force)
 377             self.seize_dns_role("domaindns", samdb, credopts, sambaopts,
 378                                 versionopts, force)
 379             self.seize_dns_role("forestdns", samdb, credopts, sambaopts,
 380                                 versionopts, force)
 381         else:
 382             if role == "domaindns" or role == "forestdns":
 383                 self.seize_dns_role(role, samdb, credopts, sambaopts,
 384                                     versionopts, force)
 385             else:
 386                 self.seize_role(role, samdb, force)
 387
 388
 389 class cmd_fsmo_show(Command):
 390     """Show the roles."""
 391
 392     synopsis = "%prog [options]"
 393
 394     takes_optiongroups = {
 395         "sambaopts": options.SambaOptions,
 396         "credopts": options.CredentialsOptions,
 397         "versionopts": options.VersionOptions,
 398         }
 399
 400     takes_options = [
 401         Option("-H", "--URL", help="LDB URL for database or target server",
 402                type=str, metavar="URL", dest="H"),
 403         ]
 404
 405     takes_args = []
 406
 407     def run(self, H=None, credopts=None, sambaopts=None, versionopts=None):
 408         lp = sambaopts.get_loadparm()
 409         creds = credopts.get_credentials(lp, fallback_machine=True)
 410
 411         samdb = SamDB(url=H, session_info=system_session(),
 412             credentials=creds, lp=lp)
 413
 414         domain_dn = samdb.domain_dn()
 415         forest_dn = samba.dn_from_dns_name(samdb.forest_dns_name())
 416         infrastructure_dn = "CN=Infrastructure," + domain_dn
 417         naming_dn = "CN=Partitions,%s" % samdb.get_config_basedn()
 418         schema_dn = samdb.get_schema_basedn()
 419         rid_dn = "CN=RID Manager$,CN=System," + domain_dn
 420         domaindns_dn = "CN=Infrastructure,DC=DomainDnsZones," + domain_dn
 421         forestdns_dn = "CN=Infrastructure,DC=ForestDnsZones," + forest_dn
 422
 423         infrastructureMaster = get_fsmo_roleowner(samdb, infrastructure_dn,
 424                                                   "infrastructure")
 425         pdcEmulator = get_fsmo_roleowner(samdb, domain_dn, "pdc")
 426         namingMaster = get_fsmo_roleowner(samdb, naming_dn, "naming")
 427         schemaMaster = get_fsmo_roleowner(samdb, schema_dn, "schema")
 428         ridMaster = get_fsmo_roleowner(samdb, rid_dn, "rid")
 429         domaindnszonesMaster = get_fsmo_roleowner(samdb, domaindns_dn,
 430                                                   "domaindns")
 431         forestdnszonesMaster = get_fsmo_roleowner(samdb, forestdns_dn,
 432                                                   "forestdns")
 433
 434         self.message("SchemaMasterRole owner: " + schemaMaster)
 435         self.message("InfrastructureMasterRole owner: " + infrastructureMaster)
 436         self.message("RidAllocationMasterRole owner: " + ridMaster)
 437         self.message("PdcEmulationMasterRole owner: " + pdcEmulator)
 438         self.message("DomainNamingMasterRole owner: " + namingMaster)
 439         self.message("DomainDnsZonesMasterRole owner: " + domaindnszonesMaster)
 440         self.message("ForestDnsZonesMasterRole owner: " + forestdnszonesMaster)
 441
 442 class cmd_fsmo_transfer(Command):
 443     """Transfer the role."""
 444
 445     synopsis = "%prog [options]"
 446
 447     takes_optiongroups = {
 448         "sambaopts": options.SambaOptions,
 449         "credopts": options.CredentialsOptions,
 450         "versionopts": options.VersionOptions,
 451         }
 452
 453     takes_options = [
 454         Option("-H", "--URL", help="LDB URL for database or target server",
 455                type=str, metavar="URL", dest="H"),
 456         Option("--role", type="choice", choices=["rid", "pdc", "infrastructure",
 457                "schema", "naming", "domaindns", "forestdns", "all"],
 458                help="""The FSMO role to seize or transfer.\n
 459 rid=RidAllocationMasterRole\n
 460 schema=SchemaMasterRole\n
 461 pdc=PdcEmulationMasterRole\n
 462 naming=DomainNamingMasterRole\n
 463 infrastructure=InfrastructureMasterRole\n
 464 domaindns=DomainDnsZonesMasterRole\n
 465 forestdns=ForestDnsZonesMasterRole\n
 466 all=all of the above\n
 467 You must provide an Admin user and password."""),
 468         ]
 469
 470     takes_args = []
 471
 472     def run(self, force=None, H=None, role=None,
 473             credopts=None, sambaopts=None, versionopts=None):
 474
 475         lp = sambaopts.get_loadparm()
 476         creds = credopts.get_credentials(lp, fallback_machine=True)
 477
 478         samdb = SamDB(url=H, session_info=system_session(),
 479                       credentials=creds, lp=lp)
 480
 481         if role == "all":
 482             transfer_role(self.outf, "rid", samdb)
 483             transfer_role(self.outf, "pdc", samdb)
 484             transfer_role(self.outf, "naming", samdb)
 485             transfer_role(self.outf, "infrastructure", samdb)
 486             transfer_role(self.outf, "schema", samdb)
 487             transfer_dns_role(self.outf, sambaopts, credopts,
 488                               "domaindns", samdb)
 489             transfer_dns_role(self.outf, sambaopts, credopts, "forestdns",
 490                               samdb)
 491         else:
 492             if role == "domaindns" or role == "forestdns":
 493                 transfer_dns_role(self.outf, sambaopts, credopts, role, samdb)
 494             else:
 495                 transfer_role(self.outf, role, samdb)
 496
 497
 498 class cmd_fsmo(SuperCommand):
 499     """Flexible Single Master Operations (FSMO) roles management."""
 500
 501     subcommands = {}
 502     subcommands["seize"] = cmd_fsmo_seize()
 503     subcommands["show"] = cmd_fsmo_show()
 504     subcommands["transfer"] = cmd_fsmo_transfer()