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(32, 40)
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_options = "seal"
237 if ctx.lp.get("log level") >= 5:
238 binding_options += ",print"
239 binding_string = "ncacn_ip_tcp:%s[%s]" % (ctx.server, binding_options)
240 ctx.drsuapi = drsuapi.drsuapi(binding_string, ctx.lp, ctx.creds)
241 (ctx.drsuapi_handle, ctx.bind_supported_extensions) = drs_utils.drs_DsBind(ctx.drsuapi)
243 def create_tmp_samdb(ctx):
244 '''create a temporary samdb object for schema queries'''
245 def setup_path(file):
246 return os.path.join(ctx.setup_dir, file)
247 ctx.tmp_schema = Schema(setup_path, security.dom_sid(ctx.domsid),
248 schemadn=ctx.schema_dn)
249 ctx.tmp_samdb = SamDB(session_info=system_session(), url=None, auto_connect=False,
250 credentials=ctx.creds, lp=ctx.lp, global_schema=False,
252 ctx.tmp_samdb.set_schema(ctx.tmp_schema)
254 def build_DsReplicaAttribute(ctx, attrname, attrvalue):
255 '''build a DsReplicaAttributeCtr object'''
256 r = drsuapi.DsReplicaAttribute()
257 r.attid = ctx.tmp_samdb.get_attid_from_lDAPDisplayName(attrname)
261 def DsAddEntry(ctx, rec):
262 '''add a record via the DRSUAPI DsAddEntry call'''
263 if ctx.drsuapi is None:
264 ctx.drsuapi_connect()
265 if ctx.tmp_samdb is None:
266 ctx.create_tmp_samdb()
268 id = drsuapi.DsReplicaObjectIdentifier()
275 if not isinstance(rec[a], list):
279 rattr = ctx.tmp_samdb.dsdb_DsReplicaAttribute(ctx.tmp_samdb, a, v)
282 attribute_ctr = drsuapi.DsReplicaAttributeCtr()
283 attribute_ctr.num_attributes = len(attrs)
284 attribute_ctr.attributes = attrs
286 object = drsuapi.DsReplicaObject()
287 object.identifier = id
288 object.attribute_ctr = attribute_ctr
290 first_object = drsuapi.DsReplicaObjectListItem()
291 first_object.object = object
293 req2 = drsuapi.DsAddEntryRequest2()
294 req2.first_object = first_object
296 (level, ctr) = ctx.drsuapi.DsAddEntry(ctx.drsuapi_handle, 2, req2)
299 def join_add_objects(ctx):
300 '''add the various objects needed for the join'''
301 print "Adding %s" % ctx.acct_dn
304 "objectClass": "computer",
305 "displayname": ctx.samname,
306 "samaccountname" : ctx.samname,
307 "userAccountControl" : str(ctx.userAccountControl),
308 "dnshostname" : ctx.dnshostname}
309 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2008:
310 rec['msDS-SupportedEncryptionTypes'] = str(samba.dsdb.ENC_ALL_TYPES)
312 rec["managedby"] = ctx.managedby
313 if ctx.never_reveal_sid:
314 rec["msDS-NeverRevealGroup"] = ctx.never_reveal_sid
316 rec["msDS-RevealOnDemandGroup"] = ctx.reveal_sid
320 ctx.add_krbtgt_account()
322 print "Adding %s" % ctx.server_dn
325 "objectclass" : "server",
326 "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_RENAME |
327 samba.dsdb.SYSTEM_FLAG_CONFIG_ALLOW_LIMITED_MOVE |
328 samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
329 "serverReference" : ctx.acct_dn,
330 "dnsHostName" : ctx.dnshostname}
333 # FIXME: the partition (NC) assignment has to be made dynamic
334 print "Adding %s" % ctx.ntds_dn
337 "objectclass" : "nTDSDSA",
338 "systemFlags" : str(samba.dsdb.SYSTEM_FLAG_DISALLOW_MOVE_ON_DELETE),
339 "dMDLocation" : ctx.schema_dn}
341 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2008:
342 rec["msDS-Behavior-Version"] = str(ctx.behavior_version)
344 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2003:
345 rec["msDS-HasDomainNCs"] = ctx.base_dn
348 rec["objectCategory"] = "CN=NTDS-DSA-RO,%s" % ctx.schema_dn
349 rec["msDS-HasFullReplicaNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
350 rec["options"] = "37"
351 ctx.samdb.add(rec, ["rodc_join:1:1"])
353 rec["objectCategory"] = "CN=NTDS-DSA,%s" % ctx.schema_dn
354 rec["HasMasterNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
355 if ctx.behavior_version >= samba.dsdb.DS_DOMAIN_FUNCTION_2003:
356 rec["msDS-HasMasterNCs"] = [ ctx.base_dn, ctx.config_dn, ctx.schema_dn ]
358 rec["invocationId"] = ndr_pack(misc.GUID(str(uuid.uuid4())))
361 # find the GUID of our NTDS DN
362 res = ctx.samdb.search(base=ctx.ntds_dn, scope=ldb.SCOPE_BASE, attrs=["objectGUID"])
363 ctx.ntds_guid = misc.GUID(ctx.samdb.schema_format_value("objectGUID", res[0]["objectGUID"][0]))
365 if ctx.connection_dn is not None:
366 print "Adding %s" % ctx.connection_dn
368 "dn" : ctx.connection_dn,
369 "objectclass" : "nTDSConnection",
370 "enabledconnection" : "TRUE",
372 "fromServer" : ctx.dc_ntds_dn}
376 print "Adding %s" % ctx.topology_dn
378 "dn" : ctx.topology_dn,
379 "objectclass" : "msDFSR-Member",
380 "msDFSR-ComputerReference" : ctx.acct_dn,
381 "serverReference" : ctx.ntds_dn}
384 print "Adding SPNs to %s" % ctx.acct_dn
386 m.dn = ldb.Dn(ctx.samdb, ctx.acct_dn)
387 for i in range(len(ctx.SPNs)):
388 ctx.SPNs[i] = ctx.SPNs[i].replace("$NTDSGUID", str(ctx.ntds_guid))
389 m["servicePrincipalName"] = ldb.MessageElement(ctx.SPNs,
391 "servicePrincipalName")
394 print "Setting account password for %s" % ctx.samname
395 ctx.samdb.setpassword("(&(objectClass=user)(sAMAccountName=%s))" % ctx.samname,
397 force_change_at_next_login=False,
398 username=ctx.samname)
399 res = ctx.samdb.search(base=ctx.acct_dn, scope=ldb.SCOPE_BASE, attrs=["msDS-keyVersionNumber"])
400 ctx.key_version_number = int(res[0]["msDS-keyVersionNumber"][0])
403 def join_provision(ctx):
404 '''provision the local SAM'''
406 print "Calling bare provision"
408 logger = logging.getLogger("provision")
409 logger.addHandler(logging.StreamHandler(sys.stdout))
410 smbconf = ctx.lp.configfile
412 presult = provision(ctx.setup_dir, logger, system_session(), None,
413 smbconf=smbconf, targetdir=ctx.targetdir, samdb_fill=FILL_DRS,
414 realm=ctx.realm, rootdn=ctx.root_dn, domaindn=ctx.base_dn,
415 schemadn=ctx.schema_dn,
416 configdn=ctx.config_dn,
417 serverdn=ctx.server_dn, domain=ctx.domain_name,
418 hostname=ctx.myname, domainsid=ctx.domsid,
419 machinepass=ctx.acct_pass, serverrole="domain controller",
420 sitename=ctx.site, lp=ctx.lp)
421 print "Provision OK for domain DN %s" % presult.domaindn
422 ctx.local_samdb = presult.samdb
424 ctx.paths = presult.paths
427 def join_replicate(ctx):
428 '''replicate the SAM'''
430 print "Starting replication"
431 ctx.local_samdb.transaction_start()
433 source_dsa_invocation_id = misc.GUID(ctx.samdb.get_invocation_id())
434 destination_dsa_guid = ctx.ntds_guid
437 repl_creds = Credentials()
438 repl_creds.guess(ctx.lp)
439 repl_creds.set_kerberos_state(DONT_USE_KERBEROS)
440 repl_creds.set_username(ctx.samname)
441 repl_creds.set_password(ctx.acct_pass)
443 repl_creds = ctx.creds
445 binding_options = "seal"
446 if ctx.lp.get("debug level") >= 5:
447 binding_options += ",print"
448 repl = drs_utils.drs_Replicate("ncacn_ip_tcp:%s[%s]" % (ctx.server, binding_options),
449 ctx.lp, repl_creds, ctx.local_samdb)
451 repl.replicate(ctx.schema_dn, source_dsa_invocation_id, destination_dsa_guid,
452 schema=True, rodc=ctx.RODC,
453 replica_flags=ctx.replica_flags)
454 repl.replicate(ctx.config_dn, source_dsa_invocation_id, destination_dsa_guid,
455 rodc=ctx.RODC, replica_flags=ctx.replica_flags)
456 repl.replicate(ctx.base_dn, source_dsa_invocation_id, destination_dsa_guid,
457 rodc=ctx.RODC, replica_flags=ctx.replica_flags)
459 repl.replicate(ctx.acct_dn, source_dsa_invocation_id, destination_dsa_guid,
460 exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET, rodc=True)
461 repl.replicate(ctx.new_krbtgt_dn, source_dsa_invocation_id, destination_dsa_guid,
462 exop=drsuapi.DRSUAPI_EXOP_REPL_SECRET, rodc=True)
464 print "Committing SAM database"
465 ctx.local_samdb.transaction_commit()
468 def join_finalise(ctx):
469 '''finalise the join, mark us synchronised and setup secrets db'''
471 print "Setting isSynchronized"
473 m.dn = ldb.Dn(ctx.samdb, '@ROOTDSE')
474 m["isSynchronized"] = ldb.MessageElement("TRUE", ldb.FLAG_MOD_REPLACE, "isSynchronized")
477 secrets_ldb = Ldb(ctx.paths.secrets, session_info=system_session(), lp=ctx.lp)
479 print "Setting up secrets database"
480 secretsdb_self_join(secrets_ldb, domain=ctx.domain_name,
482 dnsdomain=ctx.dnsdomain,
483 netbiosname=ctx.myname,
484 domainsid=security.dom_sid(ctx.domsid),
485 machinepass=ctx.acct_pass,
486 secure_channel_type=ctx.secure_channel_type,
487 key_version_number=ctx.key_version_number)
490 ctx.cleanup_old_join()
492 ctx.join_add_objects()
497 print "Join failed - cleaning up"
498 ctx.cleanup_old_join()
502 def join_RODC(server=None, creds=None, lp=None, site=None, netbios_name=None,
503 targetdir=None, domain=None):
506 ctx = dc_join(server, creds, lp, site, netbios_name, targetdir, domain)
508 ctx.krbtgt_dn = "CN=krbtgt_%s,CN=Users,%s" % (ctx.myname, ctx.base_dn)
510 # setup some defaults for accounts that should be replicated to this RODC
511 ctx.never_reveal_sid = [ "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_DENY),
512 "<SID=%s>" % security.SID_BUILTIN_ADMINISTRATORS,
513 "<SID=%s>" % security.SID_BUILTIN_SERVER_OPERATORS,
514 "<SID=%s>" % security.SID_BUILTIN_BACKUP_OPERATORS,
515 "<SID=%s>" % security.SID_BUILTIN_ACCOUNT_OPERATORS ]
516 ctx.reveal_sid = "<SID=%s-%s>" % (ctx.domsid, security.DOMAIN_RID_RODC_ALLOW)
518 mysid = ctx.get_mysid()
519 admin_dn = "<SID=%s>" % mysid
520 ctx.managedby = admin_dn
522 ctx.userAccountControl = (samba.dsdb.UF_WORKSTATION_TRUST_ACCOUNT |
523 samba.dsdb.UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION |
524 samba.dsdb.UF_PARTIAL_SECRETS_ACCOUNT)
526 ctx.SPNs.extend([ "RestrictedKrbHost/%s" % ctx.myname,
527 "RestrictedKrbHost/%s" % ctx.dnshostname ])
529 ctx.connection_dn = "CN=RODC Connection (FRS),%s" % ctx.ntds_dn
530 ctx.secure_channel_type = misc.SEC_CHAN_RODC
532 ctx.replica_flags = (drsuapi.DRSUAPI_DRS_INIT_SYNC |
533 drsuapi.DRSUAPI_DRS_PER_SYNC |
534 drsuapi.DRSUAPI_DRS_GET_ANC |
535 drsuapi.DRSUAPI_DRS_NEVER_SYNCED |
536 drsuapi.DRSUAPI_DRS_SPECIAL_SECRET_PROCESSING)
540 print "Joined domain %s (SID %s) as an RODC" % (ctx.domain_name, ctx.domsid)
543 def join_DC(server=None, creds=None, lp=None, site=None, netbios_name=None,
544 targetdir=None, domain=None):
546 ctx = dc_join(server, creds, lp, site, netbios_name, targetdir, domain)
548 ctx.userAccountControl = samba.dsdb.UF_SERVER_TRUST_ACCOUNT | samba.dsdb.UF_TRUSTED_FOR_DELEGATION
550 ctx.SPNs.append('E3514235-4B06-11D1-AB04-00C04FC2DCD2/$NTDSGUID/%s' % ctx.dnsdomain)
551 ctx.secure_channel_type = misc.SEC_CHAN_BDC
553 ctx.replica_flags = (drsuapi.DRSUAPI_DRS_WRIT_REP |
554 drsuapi.DRSUAPI_DRS_INIT_SYNC |
555 drsuapi.DRSUAPI_DRS_PER_SYNC |
556 drsuapi.DRSUAPI_DRS_FULL_SYNC_IN_PROGRESS |
557 drsuapi.DRSUAPI_DRS_NEVER_SYNCED)
560 print "Joined domain %s (SID %s) as a DC" % (ctx.domain_name, ctx.domsid)