source4/scripting/python/samba/join.py

   1 #!/usr/bin/env python
   2 #
   3 # python join code
   4 # Copyright Andrew Tridgell 2010
   5 # Copyright Andrew Bartlett 2010
   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 samba.getopt as options
  22 from samba.auth import system_session
  23 from samba.samdb import SamDB
  24 from samba import gensec, Ldb
  25 import ldb, samba, sys
  26 from samba.ndr import ndr_pack, ndr_unpack, ndr_print
  27 from samba.dcerpc import security
  28 from samba.dcerpc import drsuapi, misc, netlogon, nbt
  29 from samba.credentials import Credentials, DONT_USE_KERBEROS
  30 from samba.provision import secretsdb_self_join, provision, FILL_DRS, find_setup_dir
  31 from samba.net import Net
  32 import logging
  33 from samba.drs_utils import drs_Replicate
  34
  35 # this makes debugging easier
  36 samba.talloc_enable_null_tracking()
  37
  38 class join_ctx:
  39     '''hold join context variables'''
  40     pass
  41
  42 def join_rodc(server=None, creds=None, lp=None, site=None, netbios_name=None,
  43               targetdir=None, domain=None):
  44     """join as a RODC"""
  45
  46     def del_noerror(samdb, dn):
  47         try:
  48             samdb.delete(dn)
  49             print "Deleted %s" % dn
  50         except:
  51             pass
  52
  53     def cleanup_old_join(ctx):
  54         '''remove any DNs from a previous join'''
  55         try:
  56             # find the krbtgt link
  57             res = ctx.samdb.search(base=ctx.acct_dn, scope=ldb.SCOPE_BASE, attrs=["msDS-krbTgtLink"])
  58             del_noerror(ctx.samdb, ctx.acct_dn)
  59             del_noerror(ctx.samdb, ctx.connection_dn)
  60             del_noerror(ctx.samdb, ctx.krbtgt_dn)
  61             del_noerror(ctx.samdb, ctx.ntds_dn)
  62             del_noerror(ctx.samdb, ctx.server_dn)
  63             del_noerror(ctx.samdb, ctx.topology_dn)
  64             ctx.new_krbtgt_dn = res[0]["msDS-Krbtgtlink"][0]
  65             del_noerror(ctx.samdb, ctx.new_krbtgt_dn)
  66         except:
  67             pass
  68
  69     def find_dc(ctx, domain):
  70         '''find a writeable DC for the given domain'''
  71         return ctx.net.finddc(domain, nbt.NBT_SERVER_LDAP | nbt.NBT_SERVER_DS | nbt.NBT_SERVER_WRITABLE)
  72
  73
  74     def get_dsServiceName(samdb):
  75         res = samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dsServiceName"])
  76         return res[0]["dsServiceName"][0]
  77
  78     def get_dnsHostName(samdb):
  79         res = samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dnsHostName"])
  80         return res[0]["dnsHostName"][0]
  81
  82     def get_domain_name(samdb):
  83         '''get netbios name of the domain from the partitions record'''
  84         partitions_dn = samdb.get_partitions_dn()
  85         res = samdb.search(base=partitions_dn, scope=ldb.SCOPE_ONELEVEL, attrs=["nETBIOSName"],
  86                            expression='ncName=%s' % samdb.get_default_basedn())
  87         return res[0]["nETBIOSName"][0]
  88
  89     def get_mysid(samdb):
  90         res = samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["tokenGroups"])
  91         binsid = res[0]["tokenGroups"][0]
  92         return samdb.schema_format_value("objectSID", binsid)
  93
  94     def join_add_objects(ctx):
  95         '''add the various objects needed for the join'''
  96         print "Adding %s" % ctx.acct_dn
  97         rec = {
  98             "dn" : ctx.acct_dn,
  99             "objectClass": "computer",
 100             "displayname": ctx.samname,
 101             "samaccountname" : ctx.samname,
 102             "useraccountcontrol" : str(samba.dsdb.UF_WORKSTATION_TRUST_ACCOUNT |
 103                                        samba.dsdb.UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION |
 104                                        samba.dsdb.UF_PARTIAL_SECRETS_ACCOUNT),
 105             "managedby" : ctx.admin_dn,
 106             "dnshostname" : ctx.dnshostname,
 107             "msDS-NeverRevealGroup" : ctx.never_reveal_sid,
 108             "msDS-RevealOnDemandGroup" : ctx.reveal_sid}
 109         ctx.samdb.add(rec)
 110
 111         print "Adding %s" % ctx.krbtgt_dn
 112         rec = {
 113             "dn" : ctx.krbtgt_dn,
 114             "objectclass" : "user",
 115             "useraccountcontrol" : str(samba.dsdb.UF_NORMAL_ACCOUNT |
 116                                        samba.dsdb.UF_ACCOUNTDISABLE),
 117             "showinadvancedviewonly" : "TRUE",
 118             "description" : "tricky account"}
 119         ctx.samdb.add(rec, ["rodc_join:1:1"])
 120
 121         # now we need to search for the samAccountName attribute on the krbtgt DN,
 122         # as this will have been magically set to the krbtgt number
 123         res = ctx.samdb.search(base=ctx.krbtgt_dn, scope=ldb.SCOPE_BASE, attrs=["samAccountName"])
 124         ctx.krbtgt_name = res[0]["samAccountName"][0]
 125
 126         print "Got krbtgt_name=%s" % ctx.krbtgt_name
 127
 128         m = ldb.Message()
 129         m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
 130         m["msDS-krbTgtLink"] = ldb.MessageElement(ctx.krbtgt_dn,
 131                                                   ldb.FLAG_MOD_REPLACE, "msDS-krbTgtLink")
 132         ctx.samdb.modify(m)
 133
 134         ctx.new_krbtgt_dn = "CN=%s,CN=Users,%s" % (ctx.krbtgt_name, ctx.base_dn)
 135         print "Renaming %s to %s" % (ctx.krbtgt_dn, ctx.new_krbtgt_dn)
 136         ctx.samdb.rename(ctx.krbtgt_dn, ctx.new_krbtgt_dn)
 137
 138         print "Adding %s" % ctx.server_dn
 139         rec = {
 140             "dn": ctx.server_dn,
 141             "objectclass" : "server",
 142             "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_RENAME |
 143                                 samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_LIMITED_MOVE |
 144                                 samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
 145             "serverReference" : ctx.acct_dn,
 146             "dnsHostName" : ctx.dnshostname}
 147         ctx.samdb.add(rec)
 148
 149         print "Adding %s" % ctx.ntds_dn
 150         rec = {
 151             "dn" : ctx.ntds_dn,
 152             "objectclass" : "nTDSDSA",
 153             "objectCategory" : "CN=NTDS-DSA-RO,%s" % ctx.schema_dn,
 154             "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
 155             "dMDLocation" : ctx.schema_dn,
 156             "options" : "37",
 157             "msDS-Behavior-Version" : "4",
 158             "msDS-HasDomainNCs" : ctx.base_dn,
 159             "msDS-HasFullReplicaNCs" : [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]}
 160         ctx.samdb.add(rec, ["rodc_join:1:1"])
 161
 162         # find the GUID of our NTDS DN
 163         res = ctx.samdb.search(base=ctx.ntds_dn, scope=ldb.SCOPE_BASE, attrs=["objectGUID"])
 164         ctx.ntds_guid = misc.GUID(ctx.samdb.schema_format_value("objectGUID", res[0]["objectGUID"][0]))
 165
 166         print "Adding %s" % ctx.connection_dn
 167         rec = {
 168             "dn" : ctx.connection_dn,
 169             "objectclass" : "nTDSConnection",
 170             "enabledconnection" : "TRUE",
 171             "options" : "65",
 172             "fromServer" : ctx.dc_ntds_dn}
 173         ctx.samdb.add(rec)
 174
 175         print "Adding %s" % ctx.topology_dn
 176         rec = {
 177             "dn" : ctx.topology_dn,
 178             "objectclass" : "msDFSR-Member",
 179             "msDFSR-ComputerReference" : ctx.acct_dn,
 180             "serverReference" : ctx.ntds_dn}
 181         ctx.samdb.add(rec)
 182
 183         print "Adding HOST SPNs to %s" % ctx.acct_dn
 184         m = ldb.Message()
 185         m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
 186         SPNs = [ "HOST/%s" % ctx.myname,
 187                  "HOST/%s" % ctx.dnshostname ]
 188         m["servicePrincipalName"] = ldb.MessageElement(SPNs,
 189                                                        ldb.FLAG_MOD_ADD,
 190                                                        "servicePrincipalName")
 191         ctx.samdb.modify(m)
 192
 193         print "Adding RestrictedKrbHost SPNs to %s" % ctx.acct_dn
 194         m = ldb.Message()
 195         m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
 196         SPNs = [ "RestrictedKrbHost/%s" % ctx.myname,
 197                  "RestrictedKrbHost/%s" % ctx.dnshostname ]
 198         m["servicePrincipalName"] = ldb.MessageElement(SPNs,
 199                                                        ldb.FLAG_MOD_ADD,
 200                                                        "servicePrincipalName")
 201         ctx.samdb.modify(m)
 202
 203         print "Setting account password for %s" % ctx.samname
 204         ctx.samdb.setpassword("(&(objectClass=user)(sAMAccountName=%s))" % ctx.samname,
 205                               ctx.acct_pass,
 206                               force_change_at_next_login=False,
 207                               username=ctx.samname)
 208
 209
 210     def join_provision(ctx):
 211         '''provision the local SAM'''
 212
 213         print "Calling bare provision"
 214
 215         setup_dir = find_setup_dir()
 216         logger = logging.getLogger("provision")
 217         logger.addHandler(logging.StreamHandler(sys.stdout))
 218         smbconf = lp.configfile
 219
 220         presult = provision(setup_dir, logger, system_session(), None,
 221                             smbconf=smbconf, targetdir=targetdir, samdb_fill=FILL_DRS,
 222                             realm=ctx.realm, rootdn=ctx.root_dn, domaindn=ctx.base_dn,
 223                             schemadn=ctx.schema_dn,
 224                             configdn=ctx.config_dn,
 225                             serverdn=ctx.server_dn, domain=ctx.domain_name,
 226                             hostname=ctx.myname, hostip="127.0.0.1", domainsid=ctx.domsid,
 227                             machinepass=ctx.acct_pass, serverrole="domain controller",
 228                             sitename=ctx.site)
 229         print "Provision OK for domain DN %s" % presult.domaindn
 230         ctx.local_samdb = presult.samdb
 231         ctx.lp          = presult.lp
 232         ctx.paths       = presult.paths
 233
 234
 235     def join_replicate(ctx):
 236         '''replicate the SAM'''
 237
 238         print "Starting replication"
 239         ctx.local_samdb.transaction_start()
 240
 241         source_dsa_invocation_id = misc.GUID(ctx.samdb.get_invocation_id())
 242
 243         acct_creds = Credentials()
 244         acct_creds.guess(ctx.lp)
 245         acct_creds.set_kerberos_state(DONT_USE_KERBEROS)
 246         acct_creds.set_username(ctx.samname)
 247         acct_creds.set_password(ctx.acct_pass)
 248
 249         repl = drs_Replicate("ncacn_ip_tcp:%s[seal]" % ctx.server, ctx.lp, acct_creds, ctx.local_samdb)
 250
 251         repl.replicate(ctx.schema_dn, source_dsa_invocation_id, ctx.ntds_guid, schema=True)
 252         repl.replicate(ctx.config_dn, source_dsa_invocation_id, ctx.ntds_guid)
 253         repl.replicate(ctx.base_dn, source_dsa_invocation_id, ctx.ntds_guid)
 254         repl.replicate(ctx.acct_dn, source_dsa_invocation_id, ctx.ntds_guid, exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET)
 255         repl.replicate(ctx.new_krbtgt_dn, source_dsa_invocation_id, ctx.ntds_guid, exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET)
 256
 257         print "Committing SAM database"
 258         ctx.local_samdb.transaction_commit()
 259
 260
 261     def join_finalise(ctx):
 262         '''finalise the join, mark us synchronised and setup secrets db'''
 263
 264         print "Setting isSynchronized"
 265         m = ldb.Message()
 266         m.dn = ldb.Dn(ctx.samdb, '@ROOTDSE')
 267         m["isSynchronized"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "isSynchronized")
 268         ctx.samdb.modify(m)
 269
 270         secrets_ldb = Ldb(ctx.paths.secrets, session_info=system_session(), lp=ctx.lp)
 271
 272         print "Setting up secrets database"
 273         secretsdb_self_join(secrets_ldb, domain=ctx.domain_name,
 274                             realm=ctx.realm,
 275                             dnsdomain=ctx.dnsdomain,
 276                             netbiosname=ctx.myname,
 277                             domainsid=security.dom_sid(ctx.domsid),
 278                             machinepass=ctx.acct_pass,
 279                             secure_channel_type=misc.SEC_CHAN_RODC)
 280
 281
 282
 283     # main join code
 284     ctx = join_ctx()
 285     ctx.creds = creds
 286     ctx.lp = lp
 287     ctx.site = site
 288     ctx.netbios_name = netbios_name
 289     ctx.targetdir = targetdir
 290
 291     ctx.creds.set_gensec_features(creds.get_gensec_features() | gensec.FEATURE_SEAL)
 292     ctx.net = Net(creds=ctx.creds, lp=ctx.lp)
 293
 294     if server is not None:
 295         ctx.server = server
 296     else:
 297         ctx.server = find_dc(ctx, domain)
 298
 299     ctx.samdb = SamDB(url="ldap://%s" % ctx.server,
 300                       session_info=system_session(),
 301                       credentials=ctx.creds, lp=ctx.lp)
 302
 303     ctx.myname = netbios_name
 304     ctx.samname = "%s$" % ctx.myname
 305     ctx.base_dn = str(ctx.samdb.get_default_basedn())
 306     ctx.root_dn = str(ctx.samdb.get_root_basedn())
 307     ctx.schema_dn = str(ctx.samdb.get_schema_basedn())
 308     ctx.config_dn = str(ctx.samdb.get_config_basedn())
 309     ctx.domsid = ctx.samdb.get_domain_sid()
 310     ctx.domain_name = get_domain_name(ctx.samdb)
 311
 312     ctx.dc_ntds_dn = get_dsServiceName(ctx.samdb)
 313     ctx.dc_dnsHostName = get_dnsHostName(ctx.samdb)
 314     ctx.acct_pass = samba.generate_random_password(12, 32)
 315     ctx.mysid = get_mysid(ctx.samdb)
 316
 317     # work out the DNs of all the objects we will be adding
 318     ctx.admin_dn = "<SID=%s>" % ctx.mysid
 319     ctx.krbtgt_dn = "CN=krbtgt_%s,CN=Users,%s" % (ctx.myname, ctx.base_dn)
 320     ctx.server_dn = "CN=%s,CN=Servers,CN=%s,CN=Sites,%s" % (ctx.myname, ctx.site, ctx.config_dn)
 321     ctx.ntds_dn = "CN=NTDS Settings,%s" % ctx.server_dn
 322     ctx.connection_dn = "CN=RODC Connection (FRS),%s" % ctx.ntds_dn
 323     ctx.topology_dn = "CN=%s,CN=Topology,CN=Domain System Volume,CN=DFSR-GlobalSettings,CN=System,%s" % (ctx.myname, ctx.base_dn)
 324
 325     # setup some defaults for accounts that should be replicated to this RODC
 326     ctx.never_reveal_sid = [ "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_DENY),
 327                              "<SID=%s>" % security.SID_BUILTIN_ADMINISTRATORS,
 328                              "<SID=%s>" % security.SID_BUILTIN_SERVER_OPERATORS,
 329                              "<SID=%s>" % security.SID_BUILTIN_BACKUP_OPERATORS,
 330                              "<SID=%s>" % security.SID_BUILTIN_ACCOUNT_OPERATORS ]
 331     ctx.reveal_sid = "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_ALLOW)
 332
 333     ctx.dnsdomain = ldb.Dn(ctx.samdb, ctx.base_dn).canonical_str().split('/')[0]
 334     ctx.realm = ctx.dnsdomain
 335     ctx.dnshostname = "%s.%s" % (ctx.myname, ctx.dnsdomain)
 336
 337     ctx.acct_dn = "CN=%s,OU=Domain Controllers,%s" % (ctx.myname, ctx.base_dn)
 338
 339     cleanup_old_join(ctx)
 340     try:
 341         join_add_objects(ctx)
 342         join_provision(ctx)
 343         join_replicate(ctx)
 344         join_finalise(ctx)
 345     except:
 346         print "Join failed - cleaning up"
 347         cleanup_old_join(ctx)
 348         raise
 349
 350     print "Joined domain %s (SID %s) as an RODC" % (ctx.domain_name, ctx.domsid)
 351