summaryrefslogtreecommitdiff
path: root/source4/scripting
diff options
context:
space:
mode:
authorAndrew Tridgell <tridge@samba.org>2010-11-27 23:48:20 +1100
committerAndrew Tridgell <tridge@samba.org>2010-11-28 00:16:38 +1100
commitd06bf954ba780f915ecff2f450f0c9f4c6b79dc0 (patch)
treeae92be39e68eb43ccc911d4ba463b361790c4701 /source4/scripting
parentf6c2d39d0b7d0f631b26e96abca2982ee404c7fb (diff)
downloadsamba-d06bf954ba780f915ecff2f450f0c9f4c6b79dc0.tar.gz
samba-d06bf954ba780f915ecff2f450f0c9f4c6b79dc0.tar.bz2
samba-d06bf954ba780f915ecff2f450f0c9f4c6b79dc0.zip
s4-samba-tool: added python implementation of samba-tool drs commands
much simpler than the C code, and this brings us one step closer to a python samba-tool
Diffstat (limited to 'source4/scripting')
-rw-r--r--source4/scripting/python/samba/netcmd/drs.py402
1 files changed, 402 insertions, 0 deletions
diff --git a/source4/scripting/python/samba/netcmd/drs.py b/source4/scripting/python/samba/netcmd/drs.py
new file mode 100644
index 0000000000..7c4b1713b1
--- /dev/null
+++ b/source4/scripting/python/samba/netcmd/drs.py
@@ -0,0 +1,402 @@
+#!/usr/bin/env python
+#
+# implement samba_tool drs commands
+#
+# Copyright Andrew Tridgell 2010
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+import samba.getopt as options
+import ldb
+
+from samba.auth import system_session
+from samba.netcmd import (
+ Command,
+ CommandError,
+ Option,
+ SuperCommand,
+ )
+from samba.samdb import SamDB
+from samba import drs_utils, nttime2string, dsdb
+from samba.dcerpc import drsuapi, misc
+
+
+def drsuapi_connect(ctx):
+ '''make a DRSUAPI connection to the server'''
+ binding_options = "seal"
+ if ctx.lp.get("log level") >= 5:
+ binding_options += ",print"
+ binding_string = "ncacn_ip_tcp:%s[%s]" % (ctx.server, binding_options)
+ try:
+ ctx.drsuapi = drsuapi.drsuapi(binding_string, ctx.lp, ctx.creds)
+ (ctx.drsuapi_handle, ctx.bind_supported_extensions) = drs_utils.drs_DsBind(ctx.drsuapi)
+ except Exception, estr:
+ raise CommandError("DRS connection to %s failed - %s" % (ctx.server, estr))
+
+
+def samdb_connect(ctx):
+ '''make a ldap connection to the server'''
+ try:
+ ctx.samdb = SamDB(url="ldap://%s" % ctx.server,
+ session_info=system_session(),
+ credentials=ctx.creds, lp=ctx.lp)
+ except Exception, estr:
+ raise CommandError("LDAP connection to %s failed - %s" % (ctx.server, estr))
+
+
+def drs_errmsg(werr):
+ '''return "was successful" or an error string'''
+ (ecode, estring) = werr
+ if ecode == 0:
+ return "was successful"
+ return "failed, result %u (%s)" % (ecode, estring)
+
+
+def attr_default(msg, attrname, default):
+ '''get an attribute from a ldap msg with a default'''
+ if attrname in msg:
+ return msg[attrname][0]
+ return default
+
+
+def drs_parse_ntds_dn(ntds_dn):
+ '''parse a NTDS DN returning a site and server'''
+ a = ntds_dn.split(',')
+ if a[0] != "CN=NTDS Settings" or a[2] != "CN=Servers" or a[4] != 'CN=Sites':
+ raise RuntimeError("bad NTDS DN %s" % ntds_dn)
+ server = a[1].split('=')[1]
+ site = a[3].split('=')[1]
+ return (site, server)
+
+
+class cmd_drs_showrepl(Command):
+ """show replication status"""
+
+ synopsis = "%prog drs showrepl <DC>"
+
+ takes_optiongroups = {
+ "sambaopts": options.SambaOptions,
+ "versionopts": options.VersionOptions,
+ "credopts": options.CredentialsOptions,
+ }
+
+ takes_args = ["DC"]
+
+ def print_neighbour(self, n):
+ '''print one set of neighbour information'''
+ (site, server) = drs_parse_ntds_dn(n.source_dsa_obj_dn)
+ print("%s" % n.naming_context_dn)
+ print("\t%s\%s via RPC" % (site, server))
+ print("\t\tDSA object GUID: %s" % n.source_dsa_obj_guid)
+ print("\t\tLast attempt @ %s %s" % (nttime2string(n.last_attempt), drs_errmsg(n.result_last_attempt)))
+ print("\t\t%u consecutive failure(s)." % n.consecutive_sync_failures)
+ print("\t\tLast success @ %s" % nttime2string(n.last_success))
+ print("")
+
+ def get_dsServiceName(ctx):
+ '''get the NTDS DN from the rootDSE'''
+ res = ctx.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dsServiceName"])
+ return res[0]["dsServiceName"][0]
+
+ def drsuapi_ReplicaInfo(ctx, info_type):
+ '''call a DsReplicaInfo'''
+
+ req1 = drsuapi.DsReplicaGetInfoRequest1()
+ req1.info_type = info_type
+ try:
+ (info_type, info) = ctx.drsuapi.DsReplicaGetInfo(ctx.drsuapi_handle, 1, req1)
+ except Exception, estr:
+ raise CommandError("DsReplicaGetInfo failed : %s" % estr)
+ return (info_type, info)
+
+
+ def run(self, DC, sambaopts=None,
+ credopts=None, versionopts=None, server=None):
+
+ self.server = DC
+ self.lp = sambaopts.get_loadparm()
+
+ self.creds = credopts.get_credentials(self.lp)
+ if not self.creds.authentication_requested():
+ self.creds.set_machine_account(self.lp)
+
+ drsuapi_connect(self)
+ samdb_connect(self)
+
+ # show domain information
+ ntds_dn = self.get_dsServiceName()
+ server_dns = self.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dnsHostName"])[0]['dnsHostName'][0]
+
+ (site, server) = drs_parse_ntds_dn(ntds_dn)
+ ntds = self.samdb.search(base=ntds_dn, scope=ldb.SCOPE_BASE, attrs=['options', 'objectGUID', 'invocationId'])
+ conn = self.samdb.search(base=ntds_dn, expression="(objectClass=nTDSConnection)")
+
+ print("%s\\%s" % (site, server))
+ print("DSA Options: 0x%08x" % int(ntds[0]["options"][0]))
+ print("DSA object GUID: %s" % self.samdb.schema_format_value("objectGUID", ntds[0]["objectGUID"][0]))
+ print("DSA invocationId: %s\n" % self.samdb.schema_format_value("objectGUID", ntds[0]["invocationId"][0]))
+
+ print("==== INBOUND NEIGHBORS ====\n")
+ (info_type, info) = self.drsuapi_ReplicaInfo(drsuapi.DRSUAPI_DS_REPLICA_INFO_NEIGHBORS)
+ for n in info.array:
+ self.print_neighbour(n)
+
+
+ print("==== OUTBOUND NEIGHBORS ====\n")
+ (info_type, info) = self.drsuapi_ReplicaInfo(drsuapi.DRSUAPI_DS_REPLICA_INFO_REPSTO)
+ for n in info.array:
+ self.print_neighbour(n)
+
+ reasons = ['NTDSCONN_KCC_GC_TOPOLOGY',
+ 'NTDSCONN_KCC_RING_TOPOLOGY',
+ 'NTDSCONN_KCC_MINIMIZE_HOPS_TOPOLOGY',
+ 'NTDSCONN_KCC_STALE_SERVERS_TOPOLOGY',
+ 'NTDSCONN_KCC_OSCILLATING_CONNECTION_TOPOLOGY',
+ 'NTDSCONN_KCC_INTERSITE_GC_TOPOLOGY',
+ 'NTDSCONN_KCC_INTERSITE_TOPOLOGY',
+ 'NTDSCONN_KCC_SERVER_FAILOVER_TOPOLOGY',
+ 'NTDSCONN_KCC_SITE_FAILOVER_TOPOLOGY',
+ 'NTDSCONN_KCC_REDUNDANT_SERVER_TOPOLOGY']
+
+ print("==== KCC CONNECTION OBJECTS ====\n")
+ for c in conn:
+ print("Connection --")
+ print("\tConnection name: %s" % c['name'][0])
+ print("\tEnabled : %s" % attr_default(c, 'enabledConnection', 'TRUE'))
+ print("\tServer DNS name : %s" % server_dns)
+ print("\tServer DN name : %s" % c['fromServer'][0])
+ print("\t\tTransportType: RPC")
+ print("\t\toptions: 0x%08X" % int(attr_default(c, 'options', 0)))
+ if not 'mS-DS-ReplicatesNCReason' in c:
+ print("Warning: No NC replicated for Connection!")
+ continue
+ for r in c['mS-DS-ReplicatesNCReason']:
+ a = str(r).split(':')
+ print("\t\tReplicatesNC: %s" % a[3])
+ print("\t\tReason: 0x%08x" % int(a[2]))
+ for s in reasons:
+ if getattr(dsdb, s, 0) & int(a[2]):
+ print("\t\t\t%s" % s)
+
+
+class cmd_drs_kcc(Command):
+ """trigger knowledge consistency center run"""
+
+ synopsis = "%prog drs kcc <DC>"
+
+ takes_optiongroups = {
+ "sambaopts": options.SambaOptions,
+ "versionopts": options.VersionOptions,
+ "credopts": options.CredentialsOptions,
+ }
+
+ takes_args = ["DC"]
+
+ def run(self, DC, sambaopts=None,
+ credopts=None, versionopts=None, server=None):
+
+ self.server = DC
+ self.lp = sambaopts.get_loadparm()
+
+ self.creds = credopts.get_credentials(self.lp)
+ if not self.creds.authentication_requested():
+ self.creds.set_machine_account(self.lp)
+
+ drsuapi_connect(self)
+
+ req1 = drsuapi.DsExecuteKCC1()
+ try:
+ self.drsuapi.DsExecuteKCC(self.drsuapi_handle, 1, req1)
+ except Exception, (ecode, estr):
+ raise CommandError("DsExecuteKCC failed - %s" % estr)
+ print("Consistency check on %s successful." % DC)
+
+
+
+class cmd_drs_replicate(Command):
+ """replicate a naming context between two DCs"""
+
+ synopsis = "%prog drs replicate <DEST_DC> <SOURCE_DC> <NC>"
+
+ takes_optiongroups = {
+ "sambaopts": options.SambaOptions,
+ "versionopts": options.VersionOptions,
+ "credopts": options.CredentialsOptions,
+ }
+
+ takes_args = ["DEST_DC", "SOURCE_DC", "NC"]
+
+ takes_options = [
+ Option("--add-ref", help="use ADD_REF to add to repsTo on source", action="store_true"),
+ ]
+
+ def run(self, DEST_DC, SOURCE_DC, NC, add_ref=False,
+ sambaopts=None,
+ credopts=None, versionopts=None, server=None):
+
+ self.server = DEST_DC
+ self.lp = sambaopts.get_loadparm()
+
+ self.creds = credopts.get_credentials(self.lp)
+ if not self.creds.authentication_requested():
+ self.creds.set_machine_account(self.lp)
+
+ drsuapi_connect(self)
+ samdb_connect(self)
+
+ # we need to find the NTDS GUID of the source DC
+ msg = self.samdb.search(base=self.samdb.get_config_basedn(),
+ expression="(&(objectCategory=server)(|(name=%s)(dNSHostName=%s)))" % (SOURCE_DC,
+ SOURCE_DC),
+ attrs=[])
+ if len(msg) == 0:
+ raise CommandError("Failed to find source DC %s" % SOURCE_DC)
+ server_dn = msg[0]['dn']
+
+ msg = self.samdb.search(base=server_dn, scope=ldb.SCOPE_ONELEVEL,
+ expression="(|(objectCategory=nTDSDSA)(objectCategory=nTDSDSARO))",
+ attrs=['objectGUID', 'options'])
+ if len(msg) == 0:
+ raise CommandError("Failed to find source NTDS DN %s" % SOURCE_DC)
+ source_dsa_guid = msg[0]['objectGUID'][0]
+ options = int(attr_default(msg, 'options', 0))
+
+ nc = drsuapi.DsReplicaObjectIdentifier()
+ nc.dn = NC
+
+ req1 = drsuapi.DsReplicaSyncRequest1()
+ req1.naming_context = nc;
+ req1.options = 0
+ if not (options & dsdb.DS_NTDSDSA_OPT_DISABLE_OUTBOUND_REPL):
+ req1.options |= drsuapi.DRSUAPI_DRS_WRIT_REP
+ if add_ref:
+ req1.options |= drsuapi.DRSUAPI_DRS_ADD_REF
+ req1.source_dsa_guid = misc.GUID(source_dsa_guid)
+
+ try:
+ self.drsuapi.DsReplicaSync(self.drsuapi_handle, 1, req1)
+ except Exception, (ecode, estr):
+ raise CommandError("DsReplicaSync failed - %s" % estr)
+ print("Replicate from %s to %s was successful." % (SOURCE_DC, DEST_DC))
+
+
+
+class cmd_drs_bind(Command):
+ """show DRS capabilities of a server"""
+
+ synopsis = "%prog drs bind <DC>"
+
+ takes_optiongroups = {
+ "sambaopts": options.SambaOptions,
+ "versionopts": options.VersionOptions,
+ "credopts": options.CredentialsOptions,
+ }
+
+ takes_args = ["DC"]
+
+ def run(self, DC, sambaopts=None,
+ credopts=None, versionopts=None, server=None):
+
+ self.server = DC
+ self.lp = sambaopts.get_loadparm()
+
+ self.creds = credopts.get_credentials(self.lp)
+ if not self.creds.authentication_requested():
+ self.creds.set_machine_account(self.lp)
+
+ drsuapi_connect(self)
+ samdb_connect(self)
+
+ bind_info = drsuapi.DsBindInfoCtr()
+ bind_info.length = 28
+ bind_info.info = drsuapi.DsBindInfo28()
+ (info, handle) = self.drsuapi.DsBind(misc.GUID(drsuapi.DRSUAPI_DS_BIND_GUID), bind_info)
+
+ optmap = [
+ ("DRSUAPI_SUPPORTED_EXTENSION_BASE" , "DRS_EXT_BASE"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_ASYNC_REPLICATION" , "DRS_EXT_ASYNCREPL"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_REMOVEAPI" , "DRS_EXT_REMOVEAPI"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_MOVEREQ_V2" , "DRS_EXT_MOVEREQ_V2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHG_COMPRESS" , "DRS_EXT_GETCHG_DEFLATE"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V1" , "DRS_EXT_DCINFO_V1"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_RESTORE_USN_OPTIMIZATION" , "DRS_EXT_RESTORE_USN_OPTIMIZATION"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_ADDENTRY" , "DRS_EXT_ADDENTRY"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_KCC_EXECUTE" , "DRS_EXT_KCC_EXECUTE"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_ADDENTRY_V2" , "DRS_EXT_ADDENTRY_V2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_LINKED_VALUE_REPLICATION" , "DRS_EXT_LINKED_VALUE_REPLICATION"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V2" , "DRS_EXT_DCINFO_V2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_INSTANCE_TYPE_NOT_REQ_ON_MOD","DRS_EXT_INSTANCE_TYPE_NOT_REQ_ON_MOD"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_CRYPTO_BIND" , "DRS_EXT_CRYPTO_BIND"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GET_REPL_INFO" , "DRS_EXT_GET_REPL_INFO"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_STRONG_ENCRYPTION" , "DRS_EXT_STRONG_ENCRYPTION"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V01" , "DRS_EXT_DCINFO_VFFFFFFFF"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_TRANSITIVE_MEMBERSHIP" , "DRS_EXT_TRANSITIVE_MEMBERSHIP"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_ADD_SID_HISTORY" , "DRS_EXT_ADD_SID_HISTORY"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_POST_BETA3" , "DRS_EXT_POST_BETA3"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V5" , "DRS_EXT_GETCHGREQ_V5"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GET_MEMBERSHIPS2" , "DRS_EXT_GETMEMBERSHIPS2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V6" , "DRS_EXT_GETCHGREQ_V6"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_NONDOMAIN_NCS" , "DRS_EXT_NONDOMAIN_NCS"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V8" , "DRS_EXT_GETCHGREQ_V8"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V5" , "DRS_EXT_GETCHGREPLY_V5"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V6" , "DRS_EXT_GETCHGREPLY_V6"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_ADDENTRYREPLY_V3" , "DRS_EXT_WHISTLER_BETA3"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V7" , "DRS_EXT_WHISTLER_BETA3"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_VERIFY_OBJECT" , "DRS_EXT_WHISTLER_BETA3"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_XPRESS_COMPRESS" , "DRS_EXT_W2K3_DEFLATE"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V10" , "DRS_EXT_GETCHGREQ_V10"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_RESERVED_PART2" , "DRS_EXT_RESERVED_FOR_WIN2K_OR_DOTNET_PART2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_RESERVED_PART3" , "DRS_EXT_RESERVED_FOR_WIN2K_OR_DOTNET_PART3")
+ ]
+
+ optmap_ext = [
+ ("DRSUAPI_SUPPORTED_EXTENSION_ADAM", "DRS_EXT_ADAM"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_LH_BETA2", "DRS_EXT_LH_BETA2"),
+ ("DRSUAPI_SUPPORTED_EXTENSION_RECYCLE_BIN", "DRS_EXT_RECYCLE_BIN")]
+
+ print("Bind to %s succeeded." % DC)
+ print("Extensions supported:")
+ for (opt, str) in optmap:
+ optval = getattr(drsuapi, opt, 0)
+ if info.info.supported_extensions & optval:
+ yesno = "Yes"
+ else:
+ yesno = "No "
+ print(" %-60s: %s (%s)" % (opt, yesno, str))
+
+ if isinstance(info.info, drsuapi.DsBindInfo48):
+ print("\nExtended Extensions supported:")
+ for (opt, str) in optmap_ext:
+ optval = getattr(drsuapi, opt, 0)
+ if info.info.supported_extensions_ext & optval:
+ yesno = "Yes"
+ else:
+ yesno = "No "
+ print(" %-60s: %s (%s)" % (opt, yesno, str))
+
+ print("\nSite GUID: %s" % info.info.site_guid)
+ print("Repl epoch: %u" % info.info.repl_epoch)
+ if isinstance(info.info, drsuapi.DsBindInfo48):
+ print("Forest GUID: %s" % info.info.config_dn_guid)
+
+
+class cmd_drs(SuperCommand):
+ """DRS commands"""
+
+ subcommands = {}
+ subcommands["bind"] = cmd_drs_bind()
+ subcommands["kcc"] = cmd_drs_kcc()
+ subcommands["replicate"] = cmd_drs_replicate()
+ subcommands["showrepl"] = cmd_drs_showrepl()