4 # Copyright Andrew Tridgell 2010
5 # Copyright Andrew Bartlett 2010
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.
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.
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/>.
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, drs_utils, dsdb
25 import ldb, samba, sys, os, uuid
26 from samba.ndr import ndr_pack, ndr_unpack, ndr_print
27 from samba.dcerpc import security, drsuapi, misc, netlogon, nbt
28 from samba.credentials import Credentials, DONT_USE_KERBEROS
29 from samba.provision import secretsdb_self_join, provision, FILL_DRS, find_setup_dir
30 from samba.schema import Schema
31 from samba.net import Net
35 # this makes debugging easier
36 talloc.enable_null_tracking()
39 '''perform a DC join'''
41 def __init__(ctx, server=None, creds=None, lp=None, site=None, netbios_name=None,
42 targetdir=None, domain=None):
46 ctx.netbios_name = netbios_name
47 ctx.targetdir = targetdir
49 ctx.creds.set_gensec_features(creds.get_gensec_features() | gensec.FEATURE_SEAL)
50 ctx.net = Net(creds=ctx.creds, lp=ctx.lp)
52 if server is not None:
55 print("Finding a writeable DC for domain '%s'" % domain)
56 ctx.server = ctx.find_dc(domain)
57 print("Found DC %s" % ctx.server)
59 ctx.samdb = SamDB(url="ldap://%s" % ctx.server,
60 session_info=system_session(),
61 credentials=ctx.creds, lp=ctx.lp)
63 ctx.myname = netbios_name
64 ctx.samname = "%s$" % ctx.myname
65 ctx.base_dn = str(ctx.samdb.get_default_basedn())
66 ctx.root_dn = str(ctx.samdb.get_root_basedn())
67 ctx.schema_dn = str(ctx.samdb.get_schema_basedn())
68 ctx.config_dn = str(ctx.samdb.get_config_basedn())
69 ctx.domsid = ctx.samdb.get_domain_sid()
70 ctx.domain_name = ctx.get_domain_name()
72 lp.set("workgroup", ctx.domain_name)
73 print("workgroup is %s" % ctx.domain_name)
75 ctx.dc_ntds_dn = ctx.get_dsServiceName()
76 ctx.dc_dnsHostName = ctx.get_dnsHostName()
77 ctx.behavior_version = ctx.get_behavior_version()
79 ctx.acct_pass = samba.generate_random_password(12, 32)
81 # work out the DNs of all the objects we will be adding
82 ctx.server_dn = "CN=%s,CN=Servers,CN=%s,CN=Sites,%s" % (ctx.myname, ctx.site, ctx.config_dn)
83 ctx.ntds_dn = "CN=NTDS Settings,%s" % ctx.server_dn
84 topology_base = "CN=Topology,CN=Domain System Volume,CN=DFSR-GlobalSettings,CN=System,%s" % ctx.base_dn
85 if ctx.dn_exists(topology_base):
86 ctx.topology_dn = "CN=%s,%s" % (ctx.myname, topology_base)
88 ctx.topology_dn = None
90 ctx.dnsdomain = ldb.Dn(ctx.samdb, ctx.base_dn).canonical_str().split('/')[0]
92 ctx.realm = ctx.dnsdomain
93 lp.set("realm", ctx.realm)
95 print("realm is %s" % ctx.realm)
97 ctx.dnshostname = "%s.%s" % (ctx.myname.lower(), ctx.dnsdomain)
99 ctx.acct_dn = "CN=%s,OU=Domain Controllers,%s" % (ctx.myname, ctx.base_dn)
101 ctx.setup_dir = find_setup_dir()
104 ctx.SPNs = [ "HOST/%s" % ctx.myname,
105 "HOST/%s" % ctx.dnshostname,
106 "GC/%s/%s" % (ctx.dnshostname, ctx.dnsdomain) ]
108 # these elements are optional
109 ctx.never_reveal_sid = None
110 ctx.reveal_sid = None
111 ctx.connection_dn = None
118 def del_noerror(ctx, dn, recursive=False):
121 res = ctx.samdb.search(base=dn, scope=ldb.SCOPE_ONELEVEL, attrs=["dn"])
125 ctx.del_noerror(r.dn, recursive=True)
128 print "Deleted %s" % dn
132 def cleanup_old_join(ctx):
133 '''remove any DNs from a previous join'''
135 # find the krbtgt link
136 print("checking samaccountname")
137 res = ctx.samdb.search(base=ctx.samdb.get_default_basedn(),
138 expression='samAccountName=%s' % ctx.samname,
139 attrs=["msDS-krbTgtLink"])
141 ctx.del_noerror(res[0].dn, recursive=True)
142 if ctx.connection_dn is not None:
143 ctx.del_noerror(ctx.connection_dn)
144 if ctx.krbtgt_dn is not None:
145 ctx.del_noerror(ctx.krbtgt_dn)
146 ctx.del_noerror(ctx.ntds_dn)
147 ctx.del_noerror(ctx.server_dn, recursive=True)
149 ctx.del_noerror(ctx.topology_dn)
151 ctx.new_krbtgt_dn = res[0]["msDS-Krbtgtlink"][0]
152 ctx.del_noerror(ctx.new_krbtgt_dn)
156 def find_dc(ctx, domain):
157 '''find a writeable DC for the given domain'''
159 ctx.cldap_ret = ctx.net.finddc(domain, nbt.NBT_SERVER_LDAP | nbt.NBT_SERVER_DS | nbt.NBT_SERVER_WRITABLE)
160 except Exception, reason:
161 print("Failed to find a writeable DC for domain '%s': %s" % (domain, reason))
163 if ctx.cldap_ret.client_site is not None and ctx.cldap_ret.client_site != "":
164 ctx.site = ctx.cldap_ret.client_site
165 return ctx.cldap_ret.pdc_dns_name
168 def get_dsServiceName(ctx):
169 res = ctx.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dsServiceName"])
170 return res[0]["dsServiceName"][0]
172 def get_behavior_version(ctx):
173 res = ctx.samdb.search(base=ctx.base_dn, scope=ldb.SCOPE_BASE, attrs=["msDS-Behavior-Version"])
174 if "msDS-Behavior-Version" in res[0]:
175 return int(res[0]["msDS-Behavior-Version"][0])
177 return samba.dsdb.DS_DOMAIN_FUNCTION_2000
179 def get_dnsHostName(ctx):
180 res = ctx.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["dnsHostName"])
181 return res[0]["dnsHostName"][0]
183 def get_domain_name(ctx):
184 '''get netbios name of the domain from the partitions record'''
185 partitions_dn = ctx.samdb.get_partitions_dn()
186 res = ctx.samdb.search(base=partitions_dn, scope=ldb.SCOPE_ONELEVEL, attrs=["nETBIOSName"],
187 expression='ncName=%s' % ctx.samdb.get_default_basedn())
188 return res[0]["nETBIOSName"][0]
191 '''get the SID of the connected user. Only works with w2k8 and later,
192 so only used for RODC join'''
193 res = ctx.samdb.search(base="", scope=ldb.SCOPE_BASE, attrs=["tokenGroups"])
194 binsid = res[0]["tokenGroups"][0]
195 return ctx.samdb.schema_format_value("objectSID", binsid)
197 def dn_exists(ctx, dn):
198 '''check if a DN exists'''
200 res = ctx.samdb.search(base=dn, scope=ldb.SCOPE_BASE, attrs=[])
201 except ldb.LdbError, (ERR_NO_SUCH_OBJECT, _):
205 def add_krbtgt_account(ctx):
206 '''RODCs need a special krbtgt account'''
207 print "Adding %s" % ctx.krbtgt_dn
209 "dn" : ctx.krbtgt_dn,
210 "objectclass" : "user",
211 "useraccountcontrol" : str(samba.dsdb.UF_NORMAL_ACCOUNT |
212 samba.dsdb.UF_ACCOUNTDISABLE),
213 "showinadvancedviewonly" : "TRUE",
214 "description" : "krbtgt for %s" % ctx.samname}
215 ctx.samdb.add(rec, ["rodc_join:1:1"])
217 # now we need to search for the samAccountName attribute on the krbtgt DN,
218 # as this will have been magically set to the krbtgt number
219 res = ctx.samdb.search(base=ctx.krbtgt_dn, scope=ldb.SCOPE_BASE, attrs=["samAccountName"])
220 ctx.krbtgt_name = res[0]["samAccountName"][0]
222 print "Got krbtgt_name=%s" % ctx.krbtgt_name
225 m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
226 m["msDS-krbTgtLink"] = ldb.MessageElement(ctx.krbtgt_dn,
227 ldb.FLAG_MOD_REPLACE, "msDS-krbTgtLink")
230 ctx.new_krbtgt_dn = "CN=%s,CN=Users,%s" % (ctx.krbtgt_name, ctx.base_dn)
231 print "Renaming %s to %s" % (ctx.krbtgt_dn, ctx.new_krbtgt_dn)
232 ctx.samdb.rename(ctx.krbtgt_dn, ctx.new_krbtgt_dn)
234 def drsuapi_connect(ctx):
235 '''make a DRSUAPI connection to the server'''
236 binding_string = "ncacn_ip_tcp:%s[seal]" % ctx.server
237 ctx.drsuapi = drsuapi.drsuapi(binding_string, ctx.lp, ctx.creds)
238 (ctx.drsuapi_handle, ctx.bind_supported_extensions) = drs_utils.drs_DsBind(ctx.drsuapi)
240 def create_tmp_samdb(ctx):
241 '''create a temporary samdb object for schema queries'''
242 def setup_path(file):
243 return os.path.join(ctx.setup_dir, file)
244 ctx.tmp_schema = Schema(setup_path, security.dom_sid(ctx.domsid),
245 schemadn=ctx.schema_dn)
246 ctx.tmp_samdb = SamDB(session_info=system_session(), url=None, auto_connect=False,
247 credentials=ctx.creds, lp=ctx.lp, global_schema=False,
249 ctx.tmp_samdb.set_schema(ctx.tmp_schema)
251 def build_DsReplicaAttribute(ctx, attrname, attrvalue):
252 '''build a DsReplicaAttributeCtr object'''
253 r = drsuapi.DsReplicaAttribute()
254 r.attid = ctx.tmp_samdb.get_attid_from_lDAPDisplayName(attrname)
258 def DsAddEntry(ctx, rec):
259 '''add a record via the DRSUAPI DsAddEntry call'''
260 if ctx.drsuapi is None:
261 ctx.drsuapi_connect()
262 if ctx.tmp_samdb is None:
263 ctx.create_tmp_samdb()
265 id = drsuapi.DsReplicaObjectIdentifier()
272 if not isinstance(rec[a], list):
276 rattr = ctx.tmp_samdb.dsdb_DsReplicaAttribute(ctx.tmp_samdb, a, v)
279 attribute_ctr = drsuapi.DsReplicaAttributeCtr()
280 attribute_ctr.num_attributes = len(attrs)
281 attribute_ctr.attributes = attrs
283 object = drsuapi.DsReplicaObject()
284 object.identifier = id
285 object.attribute_ctr = attribute_ctr
287 first_object = drsuapi.DsReplicaObjectListItem()
288 first_object.object = object
290 req2 = drsuapi.DsAddEntryRequest2()
291 req2.first_object = first_object
293 (level, ctr) = ctx.drsuapi.DsAddEntry(ctx.drsuapi_handle, 2, req2)
296 def join_add_objects(ctx):
297 '''add the various objects needed for the join'''
298 print "Adding %s" % ctx.acct_dn
301 "objectClass": "computer",
302 "displayname": ctx.samname,
303 "samaccountname" : ctx.samname,
304 "userAccountControl" : str(ctx.userAccountControl),
305 "dnshostname" : ctx.dnshostname}
306 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2003:
307 rec['msDS-SupportedEncryptionTypes'] = str(samba.dsdb.ENC_ALL_TYPES)
309 rec["managedby"] = ctx.managedby
310 if ctx.never_reveal_sid:
311 rec["msDS-NeverRevealGroup"] = ctx.never_reveal_sid
313 rec["msDS-RevealOnDemandGroup"] = ctx.reveal_sid
317 ctx.add_krbtgt_account()
319 print "Adding %s" % ctx.server_dn
322 "objectclass" : "server",
323 "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_RENAME |
324 samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_LIMITED_MOVE |
325 samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
326 "serverReference" : ctx.acct_dn,
327 "dnsHostName" : ctx.dnshostname}
330 # FIXME: the partition (NC) assignment has to be made dynamic
331 print "Adding %s" % ctx.ntds_dn
334 "objectclass" : "nTDSDSA",
335 "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
336 "dMDLocation" : ctx.schema_dn}
338 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2003:
339 rec["msDS-Behavior-Version"] = str(ctx.behavior_version)
340 rec["msDS-HasDomainNCs"] = ctx.base_dn
343 rec["objectCategory"] = "CN=NTDS-DSA-RO,%s" % ctx.schema_dn
344 rec["msDS-HasFullReplicaNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
345 rec["options"] = "37"
346 ctx.samdb.add(rec, ["rodc_join:1:1"])
348 rec["objectCategory"] = "CN=NTDS-DSA,%s" % ctx.schema_dn
349 rec["HasMasterNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
350 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2003:
351 rec["msDS-HasMasterNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
353 rec["invocationId"] = ndr_pack(misc.GUID(str(uuid.uuid4())))
356 # find the GUID of our NTDS DN
357 res = ctx.samdb.search(base=ctx.ntds_dn, scope=ldb.SCOPE_BASE, attrs=["objectGUID"])
358 ctx.ntds_guid = misc.GUID(ctx.samdb.schema_format_value("objectGUID", res[0]["objectGUID"][0]))
360 if ctx.connection_dn is not None:
361 print "Adding %s" % ctx.connection_dn
363 "dn" : ctx.connection_dn,
364 "objectclass" : "nTDSConnection",
365 "enabledconnection" : "TRUE",
367 "fromServer" : ctx.dc_ntds_dn}
371 print "Adding %s" % ctx.topology_dn
373 "dn" : ctx.topology_dn,
374 "objectclass" : "msDFSR-Member",
375 "msDFSR-ComputerReference" : ctx.acct_dn,
376 "serverReference" : ctx.ntds_dn}
379 print "Adding SPNs to %s" % ctx.acct_dn
381 m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
382 for i in range(len(ctx.SPNs)):
383 ctx.SPNs[i] = ctx.SPNs[i].replace("$NTDSGUID", str(ctx.ntds_guid))
384 m["servicePrincipalName"] = ldb.MessageElement(ctx.SPNs,
386 "servicePrincipalName")
389 print "Setting account password for %s" % ctx.samname
390 ctx.samdb.setpassword("(&(objectClass=user)(sAMAccountName=%s))" % ctx.samname,
392 force_change_at_next_login=False,
393 username=ctx.samname)
394 res = ctx.samdb.search(base=ctx.acct_dn, scope=ldb.SCOPE_BASE, attrs=["msDS-keyVersionNumber"])
395 ctx.key_version_number = int(res[0]["msDS-keyVersionNumber"][0])
398 def join_provision(ctx):
399 '''provision the local SAM'''
401 print "Calling bare provision"
403 logger = logging.getLogger("provision")
404 logger.addHandler(logging.StreamHandler(sys.stdout))
405 smbconf = ctx.lp.configfile
407 presult = provision(ctx.setup_dir, logger, system_session(), None,
408 smbconf=smbconf, targetdir=ctx.targetdir, samdb_fill=FILL_DRS,
409 realm=ctx.realm, rootdn=ctx.root_dn, domaindn=ctx.base_dn,
410 schemadn=ctx.schema_dn,
411 configdn=ctx.config_dn,
412 serverdn=ctx.server_dn, domain=ctx.domain_name,
413 hostname=ctx.myname, domainsid=ctx.domsid,
414 machinepass=ctx.acct_pass, serverrole="domain controller",
416 print "Provision OK for domain DN %s" % presult.domaindn
417 ctx.local_samdb = presult.samdb
419 ctx.paths = presult.paths
422 def join_replicate(ctx):
423 '''replicate the SAM'''
425 print "Starting replication"
426 ctx.local_samdb.transaction_start()
428 source_dsa_invocation_id = misc.GUID(ctx.samdb.get_invocation_id())
429 destination_dsa_guid = ctx.ntds_guid
432 repl_creds = Credentials()
433 repl_creds.guess(ctx.lp)
434 repl_creds.set_kerberos_state(DONT_USE_KERBEROS)
435 repl_creds.set_username(ctx.samname)
436 repl_creds.set_password(ctx.acct_pass)
438 repl_creds = ctx.creds
440 repl = drs_utils.drs_Replicate("ncacn_ip_tcp:%s[seal]" % ctx.server, ctx.lp, repl_creds, ctx.local_samdb)
442 repl.replicate(ctx.schema_dn, source_dsa_invocation_id, destination_dsa_guid,
443 schema=True, rodc=ctx.RODC,
444 replica_flags=ctx.replica_flags)
445 repl.replicate(ctx.config_dn, source_dsa_invocation_id, destination_dsa_guid,
446 rodc=ctx.RODC, replica_flags=ctx.replica_flags)
447 repl.replicate(ctx.base_dn, source_dsa_invocation_id, destination_dsa_guid,
448 rodc=ctx.RODC, replica_flags=ctx.replica_flags)
450 repl.replicate(ctx.acct_dn, source_dsa_invocation_id, destination_dsa_guid,
451 exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET, rodc=True)
452 repl.replicate(ctx.new_krbtgt_dn, source_dsa_invocation_id, destination_dsa_guid,
453 exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET, rodc=True)
455 print "Committing SAM database"
456 ctx.local_samdb.transaction_commit()
459 def join_finalise(ctx):
460 '''finalise the join, mark us synchronised and setup secrets db'''
462 print "Setting isSynchronized"
464 m.dn = ldb.Dn(ctx.samdb, '@ROOTDSE')
465 m["isSynchronized"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "isSynchronized")
468 secrets_ldb = Ldb(ctx.paths.secrets, session_info=system_session(), lp=ctx.lp)
470 print "Setting up secrets database"
471 secretsdb_self_join(secrets_ldb, domain=ctx.domain_name,
473 dnsdomain=ctx.dnsdomain,
474 netbiosname=ctx.myname,
475 domainsid=security.dom_sid(ctx.domsid),
476 machinepass=ctx.acct_pass,
477 secure_channel_type=ctx.secure_channel_type,
478 key_version_number=ctx.key_version_number)
481 ctx.cleanup_old_join()
483 ctx.join_add_objects()
488 print "Join failed - cleaning up"
489 ctx.cleanup_old_join()
493 def join_RODC(server=None, creds=None, lp=None, site=None, netbios_name=None,
494 targetdir=None, domain=None):
497 ctx = dc_join(server, creds, lp, site, netbios_name, targetdir, domain)
499 ctx.krbtgt_dn = "CN=krbtgt_%s,CN=Users,%s" % (ctx.myname, ctx.base_dn)
501 # setup some defaults for accounts that should be replicated to this RODC
502 ctx.never_reveal_sid = [ "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_DENY),
503 "<SID=%s>" % security.SID_BUILTIN_ADMINISTRATORS,
504 "<SID=%s>" % security.SID_BUILTIN_SERVER_OPERATORS,
505 "<SID=%s>" % security.SID_BUILTIN_BACKUP_OPERATORS,
506 "<SID=%s>" % security.SID_BUILTIN_ACCOUNT_OPERATORS ]
507 ctx.reveal_sid = "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_ALLOW)
509 mysid = ctx.get_mysid()
510 admin_dn = "<SID=%s>" % mysid
511 ctx.managedby = admin_dn
513 ctx.userAccountControl = (samba.dsdb.UF_WORKSTATION_TRUST_ACCOUNT |
514 samba.dsdb.UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION |
515 samba.dsdb.UF_PARTIAL_SECRETS_ACCOUNT)
517 ctx.SPNs.extend([ "RestrictedKrbHost/%s" % ctx.myname,
518 "RestrictedKrbHost/%s" % ctx.dnshostname ])
520 ctx.connection_dn = "CN=RODC Connection (FRS),%s" % ctx.ntds_dn
521 ctx.secure_channel_type = misc.SEC_CHAN_RODC
523 ctx.replica_flags = (drsuapi.DRSUAPI_DRS_INIT_SYNC |
524 drsuapi.DRSUAPI_DRS_PER_SYNC |
525 drsuapi.DRSUAPI_DRS_GET_ANC |
526 drsuapi.DRSUAPI_DRS_NEVER_SYNCED |
527 drsuapi.DRSUAPI_DRS_SPECIAL_SECRET_PROCESSING)
531 print "Joined domain %s (SID %s) as an RODC" % (ctx.domain_name, ctx.domsid)
534 def join_DC(server=None, creds=None, lp=None, site=None, netbios_name=None,
535 targetdir=None, domain=None):
537 ctx = dc_join(server, creds, lp, site, netbios_name, targetdir, domain)
539 ctx.userAccountControl = samba.dsdb.UF_SERVER_TRUST_ACCOUNT | samba.dsdb.UF_TRUSTED_FOR_DELEGATION
541 ctx.SPNs.append('E3514235-4B06-11D1-AB04-00C04FC2DCD2/$NTDSGUID/%s' % ctx.dnsdomain)
542 ctx.secure_channel_type = misc.SEC_CHAN_BDC
544 ctx.replica_flags = (drsuapi.DRSUAPI_DRS_WRIT_REP |
545 drsuapi.DRSUAPI_DRS_INIT_SYNC |
546 drsuapi.DRSUAPI_DRS_PER_SYNC |
547 drsuapi.DRSUAPI_DRS_FULL_SYNC_IN_PROGRESS |
548 drsuapi.DRSUAPI_DRS_NEVER_SYNCED)
551 print "Joined domain %s (SID %s) as a DC" % (ctx.domain_name, ctx.domsid)