2 # Unix SMB/CIFS implementation.
3 # backend code for provisioning a Samba4 server
5 # Copyright (C) Jelmer Vernooij <jelmer@samba.org> 2007-2012
6 # Copyright (C) Andrew Bartlett <abartlet@samba.org> 2008-2009
7 # Copyright (C) Oliver Liebel <oliver@itc.li> 2008-2009
9 # Based on the original in EJS:
10 # Copyright (C) Andrew Tridgell <tridge@samba.org> 2005
12 # This program is free software; you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation; either version 3 of the License, or
15 # (at your option) any later version.
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License
23 # along with this program. If not, see <http://www.gnu.org/licenses/>.
26 """Functions for setting up a Samba configuration."""
28 __docformat__ = "restructuredText"
30 from base64 import b64encode
45 from samba.auth import system_session, admin_session
47 from samba.samba3 import smbd
48 from samba.dsdb import DS_DOMAIN_FUNCTION_2000
52 check_all_substituted,
53 is_valid_netbios_char,
59 from samba.dcerpc import security, misc
60 from samba.dcerpc.misc import (
64 from samba.dsdb import (
65 DS_DOMAIN_FUNCTION_2003,
66 DS_DOMAIN_FUNCTION_2008_R2,
69 from samba.idmap import IDmapDB
70 from samba.ms_display_specifiers import read_ms_ldif
71 from samba.ntacls import setntacl, dsacl2fsacl
72 from samba.ndr import ndr_pack, ndr_unpack
73 from samba.provision.backend import (
79 from samba.provision.descriptor import (
80 get_config_descriptor,
83 from samba.provision.common import (
88 from samba.provision.sambadns import (
90 create_dns_update_list
95 from samba.schema import Schema
96 from samba.samdb import SamDB
97 from samba.dbchecker import dbcheck
100 DEFAULT_POLICY_GUID = "31B2F340-016D-11D2-945F-00C04FB984F9"
101 DEFAULT_DC_POLICY_GUID = "6AC1786C-016F-11D2-945F-00C04fB984F9"
102 DEFAULTSITE = "Default-First-Site-Name"
103 LAST_PROVISION_USN_ATTRIBUTE = "lastProvisionUSN"
106 class ProvisionPaths(object):
109 self.shareconf = None
120 self.dns_keytab = None
123 self.private_dir = None
124 self.state_dir = None
125 self.phpldapadminconfig = None
128 class ProvisionNames(object):
135 self.ldapmanagerdn = None
136 self.dnsdomain = None
138 self.netbiosname = None
144 def find_provision_key_parameters(samdb, secretsdb, idmapdb, paths, smbconf, lp):
145 """Get key provision parameters (realm, domain, ...) from a given provision
147 :param samdb: An LDB object connected to the sam.ldb file
148 :param secretsdb: An LDB object connected to the secrets.ldb file
149 :param idmapdb: An LDB object connected to the idmap.ldb file
150 :param paths: A list of path to provision object
151 :param smbconf: Path to the smb.conf file
152 :param lp: A LoadParm object
153 :return: A list of key provision parameters
155 names = ProvisionNames()
156 names.adminpass = None
158 # NT domain, kerberos realm, root dn, domain dn, domain dns name
159 names.domain = string.upper(lp.get("workgroup"))
160 names.realm = lp.get("realm")
161 names.dnsdomain = names.realm.lower()
162 basedn = samba.dn_from_dns_name(names.dnsdomain)
163 names.realm = string.upper(names.realm)
165 # Get the netbiosname first (could be obtained from smb.conf in theory)
166 res = secretsdb.search(expression="(flatname=%s)" %
167 names.domain,base="CN=Primary Domains",
168 scope=ldb.SCOPE_SUBTREE, attrs=["sAMAccountName"])
169 names.netbiosname = str(res[0]["sAMAccountName"]).replace("$","")
171 names.smbconf = smbconf
173 # That's a bit simplistic but it's ok as long as we have only 3
175 current = samdb.search(expression="(objectClass=*)",
176 base="", scope=ldb.SCOPE_BASE,
177 attrs=["defaultNamingContext", "schemaNamingContext",
178 "configurationNamingContext","rootDomainNamingContext"])
180 names.configdn = current[0]["configurationNamingContext"]
181 configdn = str(names.configdn)
182 names.schemadn = current[0]["schemaNamingContext"]
183 if not (ldb.Dn(samdb, basedn) == (ldb.Dn(samdb,
184 current[0]["defaultNamingContext"][0]))):
185 raise ProvisioningError(("basedn in %s (%s) and from %s (%s)"
186 "is not the same ..." % (paths.samdb,
187 str(current[0]["defaultNamingContext"][0]),
188 paths.smbconf, basedn)))
190 names.domaindn=current[0]["defaultNamingContext"]
191 names.rootdn=current[0]["rootDomainNamingContext"]
193 res3 = samdb.search(expression="(objectClass=site)",
194 base="CN=Sites," + configdn, scope=ldb.SCOPE_ONELEVEL, attrs=["cn"])
195 names.sitename = str(res3[0]["cn"])
197 # dns hostname and server dn
198 res4 = samdb.search(expression="(CN=%s)" % names.netbiosname,
199 base="OU=Domain Controllers,%s" % basedn,
200 scope=ldb.SCOPE_ONELEVEL, attrs=["dNSHostName"])
201 names.hostname = str(res4[0]["dNSHostName"]).replace("." + names.dnsdomain,"")
203 server_res = samdb.search(expression="serverReference=%s" % res4[0].dn,
204 attrs=[], base=configdn)
205 names.serverdn = server_res[0].dn
207 # invocation id/objectguid
208 res5 = samdb.search(expression="(objectClass=*)",
209 base="CN=NTDS Settings,%s" % str(names.serverdn), scope=ldb.SCOPE_BASE,
210 attrs=["invocationID", "objectGUID"])
211 names.invocation = str(ndr_unpack(misc.GUID, res5[0]["invocationId"][0]))
212 names.ntdsguid = str(ndr_unpack(misc.GUID, res5[0]["objectGUID"][0]))
215 res6 = samdb.search(expression="(objectClass=*)", base=basedn,
216 scope=ldb.SCOPE_BASE, attrs=["objectGUID",
217 "objectSid","msDS-Behavior-Version" ])
218 names.domainguid = str(ndr_unpack(misc.GUID, res6[0]["objectGUID"][0]))
219 names.domainsid = ndr_unpack( security.dom_sid, res6[0]["objectSid"][0])
220 if res6[0].get("msDS-Behavior-Version") is None or \
221 int(res6[0]["msDS-Behavior-Version"][0]) < DS_DOMAIN_FUNCTION_2000:
222 names.domainlevel = DS_DOMAIN_FUNCTION_2000
224 names.domainlevel = int(res6[0]["msDS-Behavior-Version"][0])
227 res7 = samdb.search(expression="(displayName=Default Domain Policy)",
228 base="CN=Policies,CN=System," + basedn,
229 scope=ldb.SCOPE_ONELEVEL, attrs=["cn","displayName"])
230 names.policyid = str(res7[0]["cn"]).replace("{","").replace("}","")
232 res8 = samdb.search(expression="(displayName=Default Domain Controllers"
234 base="CN=Policies,CN=System," + basedn,
235 scope=ldb.SCOPE_ONELEVEL, attrs=["cn","displayName"])
237 names.policyid_dc = str(res8[0]["cn"]).replace("{","").replace("}","")
239 names.policyid_dc = None
240 res9 = idmapdb.search(expression="(cn=%s)" %
241 (security.SID_BUILTIN_ADMINISTRATORS),
244 names.wheel_gid = res9[0]["xidNumber"]
246 raise ProvisioningError("Unable to find uid/gid for Domain Admins rid")
250 def update_provision_usn(samdb, low, high, id, replace=False):
251 """Update the field provisionUSN in sam.ldb
253 This field is used to track range of USN modified by provision and
255 This value is used afterward by next provision to figure out if
256 the field have been modified since last provision.
258 :param samdb: An LDB object connect to sam.ldb
259 :param low: The lowest USN modified by this upgrade
260 :param high: The highest USN modified by this upgrade
261 :param id: The invocation id of the samba's dc
262 :param replace: A boolean indicating if the range should replace any
263 existing one or appended (default)
268 entry = samdb.search(base="@PROVISION",
269 scope=ldb.SCOPE_BASE,
270 attrs=[LAST_PROVISION_USN_ATTRIBUTE, "dn"])
271 for e in entry[0][LAST_PROVISION_USN_ATTRIBUTE]:
272 if not re.search(';', e):
273 e = "%s;%s" % (e, id)
276 tab.append("%s-%s;%s" % (low, high, id))
277 delta = ldb.Message()
278 delta.dn = ldb.Dn(samdb, "@PROVISION")
279 delta[LAST_PROVISION_USN_ATTRIBUTE] = ldb.MessageElement(tab,
280 ldb.FLAG_MOD_REPLACE, LAST_PROVISION_USN_ATTRIBUTE)
281 entry = samdb.search(expression='provisionnerID=*',
282 base="@PROVISION", scope=ldb.SCOPE_BASE,
283 attrs=["provisionnerID"])
284 if len(entry) == 0 or len(entry[0]) == 0:
285 delta["provisionnerID"] = ldb.MessageElement(id, ldb.FLAG_MOD_ADD, "provisionnerID")
289 def set_provision_usn(samdb, low, high, id):
290 """Set the field provisionUSN in sam.ldb
291 This field is used to track range of USN modified by provision and
293 This value is used afterward by next provision to figure out if
294 the field have been modified since last provision.
296 :param samdb: An LDB object connect to sam.ldb
297 :param low: The lowest USN modified by this upgrade
298 :param high: The highest USN modified by this upgrade
299 :param id: The invocationId of the provision"""
302 tab.append("%s-%s;%s" % (low, high, id))
304 delta = ldb.Message()
305 delta.dn = ldb.Dn(samdb, "@PROVISION")
306 delta[LAST_PROVISION_USN_ATTRIBUTE] = ldb.MessageElement(tab,
307 ldb.FLAG_MOD_ADD, LAST_PROVISION_USN_ATTRIBUTE)
311 def get_max_usn(samdb,basedn):
312 """ This function return the biggest USN present in the provision
314 :param samdb: A LDB object pointing to the sam.ldb
315 :param basedn: A string containing the base DN of the provision
317 :return: The biggest USN in the provision"""
319 res = samdb.search(expression="objectClass=*",base=basedn,
320 scope=ldb.SCOPE_SUBTREE,attrs=["uSNChanged"],
321 controls=["search_options:1:2",
322 "server_sort:1:1:uSNChanged",
323 "paged_results:1:1"])
324 return res[0]["uSNChanged"]
327 def get_last_provision_usn(sam):
328 """Get USNs ranges modified by a provision or an upgradeprovision
330 :param sam: An LDB object pointing to the sam.ldb
331 :return: a dictionnary which keys are invocation id and values are an array
332 of integer representing the different ranges
335 entry = sam.search(expression="%s=*" % LAST_PROVISION_USN_ATTRIBUTE,
336 base="@PROVISION", scope=ldb.SCOPE_BASE,
337 attrs=[LAST_PROVISION_USN_ATTRIBUTE, "provisionnerID"])
338 except ldb.LdbError, (ecode, emsg):
339 if ecode == ldb.ERR_NO_SUCH_OBJECT:
346 if entry[0].get("provisionnerID"):
347 for e in entry[0]["provisionnerID"]:
349 for r in entry[0][LAST_PROVISION_USN_ATTRIBUTE]:
350 tab1 = str(r).split(';')
355 if (len(myids) > 0 and id not in myids):
357 tab2 = p.split(tab1[0])
358 if range.get(id) == None:
360 range[id].append(tab2[0])
361 range[id].append(tab2[1])
367 class ProvisionResult(object):
368 """Result of a provision.
370 :ivar server_role: The server role
371 :ivar paths: ProvisionPaths instance
372 :ivar domaindn: The domain dn, as string
376 self.server_role = None
383 self.domainsid = None
384 self.adminpass_generated = None
385 self.adminpass = None
386 self.backend_result = None
388 def report_logger(self, logger):
389 """Report this provision result to a logger."""
391 "Once the above files are installed, your Samba4 server will "
393 if self.adminpass_generated:
394 logger.info("Admin password: %s", self.adminpass)
395 logger.info("Server Role: %s", self.server_role)
396 logger.info("Hostname: %s", self.names.hostname)
397 logger.info("NetBIOS Domain: %s", self.names.domain)
398 logger.info("DNS Domain: %s", self.names.dnsdomain)
399 logger.info("DOMAIN SID: %s", self.domainsid)
401 if self.paths.phpldapadminconfig is not None:
403 "A phpLDAPadmin configuration file suitable for administering "
404 "the Samba 4 LDAP server has been created in %s.",
405 self.paths.phpldapadminconfig)
407 if self.backend_result:
408 self.backend_result.report_logger(logger)
411 def check_install(lp, session_info, credentials):
412 """Check whether the current install seems ok.
414 :param lp: Loadparm context
415 :param session_info: Session information
416 :param credentials: Credentials
418 if lp.get("realm") == "":
419 raise Exception("Realm empty")
420 samdb = Ldb(lp.samdb_url(), session_info=session_info,
421 credentials=credentials, lp=lp)
422 if len(samdb.search("(cn=Administrator)")) != 1:
423 raise ProvisioningError("No administrator account found")
426 def findnss(nssfn, names):
427 """Find a user or group from a list of possibilities.
429 :param nssfn: NSS Function to try (should raise KeyError if not found)
430 :param names: Names to check.
431 :return: Value return by first names list.
438 raise KeyError("Unable to find user/group in %r" % names)
441 findnss_uid = lambda names: findnss(pwd.getpwnam, names)[2]
442 findnss_gid = lambda names: findnss(grp.getgrnam, names)[2]
445 def provision_paths_from_lp(lp, dnsdomain):
446 """Set the default paths for provisioning.
448 :param lp: Loadparm context.
449 :param dnsdomain: DNS Domain name
451 paths = ProvisionPaths()
452 paths.private_dir = lp.get("private dir")
453 paths.state_dir = lp.get("state directory")
455 # This is stored without path prefix for the "privateKeytab" attribute in
456 # "secrets_dns.ldif".
457 paths.dns_keytab = "dns.keytab"
458 paths.keytab = "secrets.keytab"
460 paths.shareconf = os.path.join(paths.private_dir, "share.ldb")
461 paths.samdb = os.path.join(paths.private_dir, "sam.ldb")
462 paths.idmapdb = os.path.join(paths.private_dir, "idmap.ldb")
463 paths.secrets = os.path.join(paths.private_dir, "secrets.ldb")
464 paths.privilege = os.path.join(paths.private_dir, "privilege.ldb")
465 paths.dns = os.path.join(paths.private_dir, "dns", dnsdomain + ".zone")
466 paths.dns_update_list = os.path.join(paths.private_dir, "dns_update_list")
467 paths.spn_update_list = os.path.join(paths.private_dir, "spn_update_list")
468 paths.namedconf = os.path.join(paths.private_dir, "named.conf")
469 paths.namedconf_update = os.path.join(paths.private_dir, "named.conf.update")
470 paths.namedtxt = os.path.join(paths.private_dir, "named.txt")
471 paths.krb5conf = os.path.join(paths.private_dir, "krb5.conf")
472 paths.winsdb = os.path.join(paths.private_dir, "wins.ldb")
473 paths.s4_ldapi_path = os.path.join(paths.private_dir, "ldapi")
474 paths.phpldapadminconfig = os.path.join(paths.private_dir,
475 "phpldapadmin-config.php")
476 paths.hklm = "hklm.ldb"
477 paths.hkcr = "hkcr.ldb"
478 paths.hkcu = "hkcu.ldb"
479 paths.hku = "hku.ldb"
480 paths.hkpd = "hkpd.ldb"
481 paths.hkpt = "hkpt.ldb"
482 paths.sysvol = lp.get("path", "sysvol")
483 paths.netlogon = lp.get("path", "netlogon")
484 paths.smbconf = lp.configfile
488 def determine_netbios_name(hostname):
489 """Determine a netbios name from a hostname."""
490 # remove forbidden chars and force the length to be <16
491 netbiosname = "".join([x for x in hostname if is_valid_netbios_char(x)])
492 return netbiosname[:MAX_NETBIOS_NAME_LEN].upper()
495 def guess_names(lp=None, hostname=None, domain=None, dnsdomain=None,
496 serverrole=None, rootdn=None, domaindn=None, configdn=None,
497 schemadn=None, serverdn=None, sitename=None):
498 """Guess configuration settings to use."""
501 hostname = socket.gethostname().split(".")[0]
503 netbiosname = lp.get("netbios name")
504 if netbiosname is None:
505 netbiosname = determine_netbios_name(hostname)
506 netbiosname = netbiosname.upper()
507 if not valid_netbios_name(netbiosname):
508 raise InvalidNetbiosName(netbiosname)
510 if dnsdomain is None:
511 dnsdomain = lp.get("realm")
512 if dnsdomain is None or dnsdomain == "":
513 raise ProvisioningError("guess_names: 'realm' not specified in supplied %s!", lp.configfile)
515 dnsdomain = dnsdomain.lower()
517 if serverrole is None:
518 serverrole = lp.get("server role")
519 if serverrole is None:
520 raise ProvisioningError("guess_names: 'server role' not specified in supplied %s!" % lp.configfile)
522 serverrole = serverrole.lower()
524 realm = dnsdomain.upper()
526 if lp.get("realm") == "":
527 raise ProvisioningError("guess_names: 'realm =' was not specified in supplied %s. Please remove the smb.conf file and let provision generate it" % lp.configfile)
529 if lp.get("realm").upper() != realm:
530 raise ProvisioningError("guess_names: 'realm=%s' in %s must match chosen realm '%s'! Please remove the smb.conf file and let provision generate it" % (lp.get("realm").upper(), realm, lp.configfile))
532 if lp.get("server role").lower() != serverrole:
533 raise ProvisioningError("guess_names: 'server role=%s' in %s must match chosen server role '%s'! Please remove the smb.conf file and let provision generate it" % (lp.get("server role"), lp.configfile, serverrole))
535 if serverrole == "active directory domain controller":
537 # This will, for better or worse, default to 'WORKGROUP'
538 domain = lp.get("workgroup")
539 domain = domain.upper()
541 if lp.get("workgroup").upper() != domain:
542 raise ProvisioningError("guess_names: Workgroup '%s' in smb.conf must match chosen domain '%s'! Please remove the %s file and let provision generate it" % (lp.get("workgroup").upper(), domain, lp.configfile))
545 domaindn = samba.dn_from_dns_name(dnsdomain)
547 if domain == netbiosname:
548 raise ProvisioningError("guess_names: Domain '%s' must not be equal to short host name '%s'!" % (domain, netbiosname))
552 domaindn = "DC=" + netbiosname
554 if not valid_netbios_name(domain):
555 raise InvalidNetbiosName(domain)
557 if hostname.upper() == realm:
558 raise ProvisioningError("guess_names: Realm '%s' must not be equal to hostname '%s'!" % (realm, hostname))
559 if netbiosname.upper() == realm:
560 raise ProvisioningError("guess_names: Realm '%s' must not be equal to netbios hostname '%s'!" % (realm, netbiosname))
562 raise ProvisioningError("guess_names: Realm '%s' must not be equal to short domain name '%s'!" % (realm, domain))
568 configdn = "CN=Configuration," + rootdn
570 schemadn = "CN=Schema," + configdn
573 sitename = DEFAULTSITE
575 names = ProvisionNames()
576 names.rootdn = rootdn
577 names.domaindn = domaindn
578 names.configdn = configdn
579 names.schemadn = schemadn
580 names.ldapmanagerdn = "CN=Manager," + rootdn
581 names.dnsdomain = dnsdomain
582 names.domain = domain
584 names.netbiosname = netbiosname
585 names.hostname = hostname
586 names.sitename = sitename
587 names.serverdn = "CN=%s,CN=Servers,CN=%s,CN=Sites,%s" % (
588 netbiosname, sitename, configdn)
593 def make_smbconf(smbconf, hostname, domain, realm, targetdir,
594 serverrole=None, eadb=False, use_ntvfs=False, lp=None,
596 """Create a new smb.conf file based on a couple of basic settings.
598 assert smbconf is not None
601 hostname = socket.gethostname().split(".")[0]
603 netbiosname = determine_netbios_name(hostname)
605 if serverrole is None:
606 serverrole = "standalone server"
608 assert domain is not None
609 domain = domain.upper()
611 assert realm is not None
612 realm = realm.upper()
615 "passdb backend": "samba4",
616 "netbios name": netbiosname,
619 "server role": serverrole,
623 lp = samba.param.LoadParm()
624 #Load non-existent file
625 if os.path.exists(smbconf):
628 if global_param is not None:
629 for ent in global_param:
630 if global_param[ent] is not None:
631 global_settings[ent] = " ".join(global_param[ent])
633 if targetdir is not None:
634 global_settings["private dir"] = os.path.abspath(os.path.join(targetdir, "private"))
635 global_settings["lock dir"] = os.path.abspath(targetdir)
636 global_settings["state directory"] = os.path.abspath(os.path.join(targetdir, "state"))
637 global_settings["cache directory"] = os.path.abspath(os.path.join(targetdir, "cache"))
639 lp.set("lock dir", os.path.abspath(targetdir))
640 lp.set("state directory", global_settings["state directory"])
641 lp.set("cache directory", global_settings["cache directory"])
644 if use_ntvfs and not lp.get("posix:eadb"):
645 if targetdir is not None:
646 privdir = os.path.join(targetdir, "private")
648 privdir = lp.get("private dir")
649 lp.set("posix:eadb", os.path.abspath(os.path.join(privdir, "eadb.tdb")))
650 elif not use_ntvfs and not lp.get("xattr_tdb:file"):
651 if targetdir is not None:
652 statedir = os.path.join(targetdir, "state")
654 statedir = lp.get("state directory")
655 lp.set("xattr_tdb:file", os.path.abspath(os.path.join(statedir, "xattr.tdb")))
658 if serverrole == "active directory domain controller":
659 shares["sysvol"] = os.path.join(lp.get("state directory"), "sysvol")
660 shares["netlogon"] = os.path.join(shares["sysvol"], realm.lower(),
663 f = open(smbconf, 'w')
665 f.write("[globals]\n")
666 for key, val in global_settings.iteritems():
667 f.write("\t%s = %s\n" % (key, val))
670 for name, path in shares.iteritems():
671 f.write("[%s]\n" % name)
672 f.write("\tpath = %s\n" % path)
673 f.write("\tread only = no\n")
677 # reload the smb.conf
680 # and dump it without any values that are the default
681 # this ensures that any smb.conf parameters that were set
682 # on the provision/join command line are set in the resulting smb.conf
683 f = open(smbconf, mode='w')
690 def setup_name_mappings(idmap, sid, root_uid, nobody_uid,
691 users_gid, wheel_gid):
692 """setup reasonable name mappings for sam names to unix names.
694 :param samdb: SamDB object.
695 :param idmap: IDmap db object.
696 :param sid: The domain sid.
697 :param domaindn: The domain DN.
698 :param root_uid: uid of the UNIX root user.
699 :param nobody_uid: uid of the UNIX nobody user.
700 :param users_gid: gid of the UNIX users group.
701 :param wheel_gid: gid of the UNIX wheel group.
703 idmap.setup_name_mapping("S-1-5-7", idmap.TYPE_UID, nobody_uid)
704 idmap.setup_name_mapping("S-1-5-32-544", idmap.TYPE_GID, wheel_gid)
706 idmap.setup_name_mapping(sid + "-500", idmap.TYPE_UID, root_uid)
707 idmap.setup_name_mapping(sid + "-513", idmap.TYPE_GID, users_gid)
710 def setup_samdb_partitions(samdb_path, logger, lp, session_info,
711 provision_backend, names, schema, serverrole,
713 """Setup the partitions for the SAM database.
715 Alternatively, provision() may call this, and then populate the database.
717 :note: This will wipe the Sam Database!
719 :note: This function always removes the local SAM LDB file. The erase
720 parameter controls whether to erase the existing data, which
721 may not be stored locally but in LDAP.
724 assert session_info is not None
726 # We use options=["modules:"] to stop the modules loading - we
727 # just want to wipe and re-initialise the database, not start it up
730 os.unlink(samdb_path)
734 samdb = Ldb(url=samdb_path, session_info=session_info,
735 lp=lp, options=["modules:"])
737 ldap_backend_line = "# No LDAP backend"
738 if provision_backend.type != "ldb":
739 ldap_backend_line = "ldapBackend: %s" % provision_backend.ldap_uri
741 samdb.transaction_start()
743 logger.info("Setting up sam.ldb partitions and settings")
744 setup_add_ldif(samdb, setup_path("provision_partitions.ldif"), {
745 "LDAP_BACKEND_LINE": ldap_backend_line
749 setup_add_ldif(samdb, setup_path("provision_init.ldif"), {
750 "BACKEND_TYPE": provision_backend.type,
751 "SERVER_ROLE": serverrole
754 logger.info("Setting up sam.ldb rootDSE")
755 setup_samdb_rootdse(samdb, names)
757 samdb.transaction_cancel()
760 samdb.transaction_commit()
763 def secretsdb_self_join(secretsdb, domain,
764 netbiosname, machinepass, domainsid=None,
765 realm=None, dnsdomain=None,
767 key_version_number=1,
768 secure_channel_type=SEC_CHAN_WKSTA):
769 """Add domain join-specific bits to a secrets database.
771 :param secretsdb: Ldb Handle to the secrets database
772 :param machinepass: Machine password
774 attrs = ["whenChanged",
781 if realm is not None:
782 if dnsdomain is None:
783 dnsdomain = realm.lower()
784 dnsname = '%s.%s' % (netbiosname.lower(), dnsdomain.lower())
787 shortname = netbiosname.lower()
789 # We don't need to set msg["flatname"] here, because rdn_name will handle
790 # it, and it causes problems for modifies anyway
791 msg = ldb.Message(ldb.Dn(secretsdb, "flatname=%s,cn=Primary Domains" % domain))
792 msg["secureChannelType"] = [str(secure_channel_type)]
793 msg["objectClass"] = ["top", "primaryDomain"]
794 if dnsname is not None:
795 msg["objectClass"] = ["top", "primaryDomain", "kerberosSecret"]
796 msg["realm"] = [realm]
797 msg["saltPrincipal"] = ["host/%s@%s" % (dnsname, realm.upper())]
798 msg["msDS-KeyVersionNumber"] = [str(key_version_number)]
799 msg["privateKeytab"] = ["secrets.keytab"]
801 msg["secret"] = [machinepass]
802 msg["samAccountName"] = ["%s$" % netbiosname]
803 msg["secureChannelType"] = [str(secure_channel_type)]
804 if domainsid is not None:
805 msg["objectSid"] = [ndr_pack(domainsid)]
807 # This complex expression tries to ensure that we don't have more
808 # than one record for this SID, realm or netbios domain at a time,
809 # but we don't delete the old record that we are about to modify,
810 # because that would delete the keytab and previous password.
811 res = secretsdb.search(base="cn=Primary Domains", attrs=attrs,
812 expression=("(&(|(flatname=%s)(realm=%s)(objectSid=%s))(objectclass=primaryDomain)(!(distinguishedName=%s)))" % (domain, realm, str(domainsid), str(msg.dn))),
813 scope=ldb.SCOPE_ONELEVEL)
816 secretsdb.delete(del_msg.dn)
818 res = secretsdb.search(base=msg.dn, attrs=attrs, scope=ldb.SCOPE_BASE)
821 msg["priorSecret"] = [res[0]["secret"][0]]
822 msg["priorWhenChanged"] = [res[0]["whenChanged"][0]]
825 msg["privateKeytab"] = [res[0]["privateKeytab"][0]]
830 msg["krb5Keytab"] = [res[0]["krb5Keytab"][0]]
836 msg[el].set_flags(ldb.FLAG_MOD_REPLACE)
837 secretsdb.modify(msg)
838 secretsdb.rename(res[0].dn, msg.dn)
840 spn = [ 'HOST/%s' % shortname ]
841 if secure_channel_type == SEC_CHAN_BDC and dnsname is not None:
842 # we are a domain controller then we add servicePrincipalName
843 # entries for the keytab code to update.
844 spn.extend([ 'HOST/%s' % dnsname ])
845 msg["servicePrincipalName"] = spn
850 def setup_secretsdb(paths, session_info, backend_credentials, lp):
851 """Setup the secrets database.
853 :note: This function does not handle exceptions and transaction on purpose,
854 it's up to the caller to do this job.
856 :param path: Path to the secrets database.
857 :param session_info: Session info.
858 :param credentials: Credentials
859 :param lp: Loadparm context
860 :return: LDB handle for the created secrets database
862 if os.path.exists(paths.secrets):
863 os.unlink(paths.secrets)
865 keytab_path = os.path.join(paths.private_dir, paths.keytab)
866 if os.path.exists(keytab_path):
867 os.unlink(keytab_path)
869 dns_keytab_path = os.path.join(paths.private_dir, paths.dns_keytab)
870 if os.path.exists(dns_keytab_path):
871 os.unlink(dns_keytab_path)
875 secrets_ldb = Ldb(path, session_info=session_info, lp=lp)
877 secrets_ldb.load_ldif_file_add(setup_path("secrets_init.ldif"))
878 secrets_ldb = Ldb(path, session_info=session_info, lp=lp)
879 secrets_ldb.transaction_start()
881 secrets_ldb.load_ldif_file_add(setup_path("secrets.ldif"))
883 if (backend_credentials is not None and
884 backend_credentials.authentication_requested()):
885 if backend_credentials.get_bind_dn() is not None:
886 setup_add_ldif(secrets_ldb,
887 setup_path("secrets_simple_ldap.ldif"), {
888 "LDAPMANAGERDN": backend_credentials.get_bind_dn(),
889 "LDAPMANAGERPASS_B64": b64encode(backend_credentials.get_password())
892 setup_add_ldif(secrets_ldb,
893 setup_path("secrets_sasl_ldap.ldif"), {
894 "LDAPADMINUSER": backend_credentials.get_username(),
895 "LDAPADMINREALM": backend_credentials.get_realm(),
896 "LDAPADMINPASS_B64": b64encode(backend_credentials.get_password())
899 secrets_ldb.transaction_cancel()
904 def setup_privileges(path, session_info, lp):
905 """Setup the privileges database.
907 :param path: Path to the privileges database.
908 :param session_info: Session info.
909 :param credentials: Credentials
910 :param lp: Loadparm context
911 :return: LDB handle for the created secrets database
913 if os.path.exists(path):
915 privilege_ldb = Ldb(path, session_info=session_info, lp=lp)
916 privilege_ldb.erase()
917 privilege_ldb.load_ldif_file_add(setup_path("provision_privilege.ldif"))
920 def setup_registry(path, session_info, lp):
921 """Setup the registry.
923 :param path: Path to the registry database
924 :param session_info: Session information
925 :param credentials: Credentials
926 :param lp: Loadparm context
928 reg = samba.registry.Registry()
929 hive = samba.registry.open_ldb(path, session_info=session_info, lp_ctx=lp)
930 reg.mount_hive(hive, samba.registry.HKEY_LOCAL_MACHINE)
931 provision_reg = setup_path("provision.reg")
932 assert os.path.exists(provision_reg)
933 reg.diff_apply(provision_reg)
936 def setup_idmapdb(path, session_info, lp):
937 """Setup the idmap database.
939 :param path: path to the idmap database
940 :param session_info: Session information
941 :param credentials: Credentials
942 :param lp: Loadparm context
944 if os.path.exists(path):
947 idmap_ldb = IDmapDB(path, session_info=session_info, lp=lp)
949 idmap_ldb.load_ldif_file_add(setup_path("idmap_init.ldif"))
953 def setup_samdb_rootdse(samdb, names):
954 """Setup the SamDB rootdse.
956 :param samdb: Sam Database handle
958 setup_add_ldif(samdb, setup_path("provision_rootdse_add.ldif"), {
959 "SCHEMADN": names.schemadn,
960 "DOMAINDN": names.domaindn,
961 "ROOTDN" : names.rootdn,
962 "CONFIGDN": names.configdn,
963 "SERVERDN": names.serverdn,
967 def setup_self_join(samdb, admin_session_info, names, fill, machinepass,
968 dnspass, domainsid, next_rid, invocationid, policyguid, policyguid_dc,
969 domainControllerFunctionality, ntdsguid=None, dc_rid=None):
970 """Join a host to its own domain."""
971 assert isinstance(invocationid, str)
972 if ntdsguid is not None:
973 ntdsguid_line = "objectGUID: %s\n"%ntdsguid
980 setup_add_ldif(samdb, setup_path("provision_self_join.ldif"), {
981 "CONFIGDN": names.configdn,
982 "SCHEMADN": names.schemadn,
983 "DOMAINDN": names.domaindn,
984 "SERVERDN": names.serverdn,
985 "INVOCATIONID": invocationid,
986 "NETBIOSNAME": names.netbiosname,
987 "DNSNAME": "%s.%s" % (names.hostname, names.dnsdomain),
988 "MACHINEPASS_B64": b64encode(machinepass.encode('utf-16-le')),
989 "DOMAINSID": str(domainsid),
990 "DCRID": str(dc_rid),
991 "SAMBA_VERSION_STRING": version,
992 "NTDSGUID": ntdsguid_line,
993 "DOMAIN_CONTROLLER_FUNCTIONALITY": str(
994 domainControllerFunctionality),
995 "RIDALLOCATIONSTART": str(next_rid + 100),
996 "RIDALLOCATIONEND": str(next_rid + 100 + 499)})
998 setup_add_ldif(samdb, setup_path("provision_group_policy.ldif"), {
999 "POLICYGUID": policyguid,
1000 "POLICYGUID_DC": policyguid_dc,
1001 "DNSDOMAIN": names.dnsdomain,
1002 "DOMAINDN": names.domaindn})
1004 # If we are setting up a subdomain, then this has been replicated in, so we
1005 # don't need to add it
1006 if fill == FILL_FULL:
1007 setup_add_ldif(samdb, setup_path("provision_self_join_config.ldif"), {
1008 "CONFIGDN": names.configdn,
1009 "SCHEMADN": names.schemadn,
1010 "DOMAINDN": names.domaindn,
1011 "SERVERDN": names.serverdn,
1012 "INVOCATIONID": invocationid,
1013 "NETBIOSNAME": names.netbiosname,
1014 "DNSNAME": "%s.%s" % (names.hostname, names.dnsdomain),
1015 "MACHINEPASS_B64": b64encode(machinepass.encode('utf-16-le')),
1016 "DOMAINSID": str(domainsid),
1017 "DCRID": str(dc_rid),
1018 "SAMBA_VERSION_STRING": version,
1019 "NTDSGUID": ntdsguid_line,
1020 "DOMAIN_CONTROLLER_FUNCTIONALITY": str(
1021 domainControllerFunctionality)})
1023 # Setup fSMORoleOwner entries to point at the newly created DC entry
1024 setup_modify_ldif(samdb,
1025 setup_path("provision_self_join_modify_config.ldif"), {
1026 "CONFIGDN": names.configdn,
1027 "SCHEMADN": names.schemadn,
1028 "DEFAULTSITE": names.sitename,
1029 "NETBIOSNAME": names.netbiosname,
1030 "SERVERDN": names.serverdn,
1033 system_session_info = system_session()
1034 samdb.set_session_info(system_session_info)
1035 # Setup fSMORoleOwner entries to point at the newly created DC entry to
1036 # modify a serverReference under cn=config when we are a subdomain, we must
1037 # be system due to ACLs
1038 setup_modify_ldif(samdb, setup_path("provision_self_join_modify.ldif"), {
1039 "DOMAINDN": names.domaindn,
1040 "SERVERDN": names.serverdn,
1041 "NETBIOSNAME": names.netbiosname,
1044 samdb.set_session_info(admin_session_info)
1046 # This is Samba4 specific and should be replaced by the correct
1047 # DNS AD-style setup
1048 setup_add_ldif(samdb, setup_path("provision_dns_add_samba.ldif"), {
1049 "DNSDOMAIN": names.dnsdomain,
1050 "DOMAINDN": names.domaindn,
1051 "DNSPASS_B64": b64encode(dnspass.encode('utf-16-le')),
1052 "HOSTNAME" : names.hostname,
1053 "DNSNAME" : '%s.%s' % (
1054 names.netbiosname.lower(), names.dnsdomain.lower())
1058 def getpolicypath(sysvolpath, dnsdomain, guid):
1059 """Return the physical path of policy given its guid.
1061 :param sysvolpath: Path to the sysvol folder
1062 :param dnsdomain: DNS name of the AD domain
1063 :param guid: The GUID of the policy
1064 :return: A string with the complete path to the policy folder
1067 guid = "{%s}" % guid
1068 policy_path = os.path.join(sysvolpath, dnsdomain, "Policies", guid)
1072 def create_gpo_struct(policy_path):
1073 if not os.path.exists(policy_path):
1074 os.makedirs(policy_path, 0775)
1075 f = open(os.path.join(policy_path, "GPT.INI"), 'w')
1077 f.write("[General]\r\nVersion=0")
1080 p = os.path.join(policy_path, "MACHINE")
1081 if not os.path.exists(p):
1082 os.makedirs(p, 0775)
1083 p = os.path.join(policy_path, "USER")
1084 if not os.path.exists(p):
1085 os.makedirs(p, 0775)
1088 def create_default_gpo(sysvolpath, dnsdomain, policyguid, policyguid_dc):
1089 """Create the default GPO for a domain
1091 :param sysvolpath: Physical path for the sysvol folder
1092 :param dnsdomain: DNS domain name of the AD domain
1093 :param policyguid: GUID of the default domain policy
1094 :param policyguid_dc: GUID of the default domain controler policy
1096 policy_path = getpolicypath(sysvolpath,dnsdomain,policyguid)
1097 create_gpo_struct(policy_path)
1099 policy_path = getpolicypath(sysvolpath,dnsdomain,policyguid_dc)
1100 create_gpo_struct(policy_path)
1103 def setup_samdb(path, session_info, provision_backend, lp, names,
1104 logger, fill, serverrole, schema, am_rodc=False):
1105 """Setup a complete SAM Database.
1107 :note: This will wipe the main SAM database file!
1110 # Also wipes the database
1111 setup_samdb_partitions(path, logger=logger, lp=lp,
1112 provision_backend=provision_backend, session_info=session_info,
1113 names=names, serverrole=serverrole, schema=schema)
1115 # Load the database, but don's load the global schema and don't connect
1117 samdb = SamDB(session_info=session_info, url=None, auto_connect=False,
1118 credentials=provision_backend.credentials, lp=lp,
1119 global_schema=False, am_rodc=am_rodc)
1121 logger.info("Pre-loading the Samba 4 and AD schema")
1123 # Load the schema from the one we computed earlier
1124 samdb.set_schema(schema)
1126 # Set the NTDS settings DN manually - in order to have it already around
1127 # before the provisioned tree exists and we connect
1128 samdb.set_ntds_settings_dn("CN=NTDS Settings,%s" % names.serverdn)
1130 # And now we can connect to the DB - the schema won't be loaded from the
1137 def fill_samdb(samdb, lp, names,
1138 logger, domainsid, domainguid, policyguid, policyguid_dc, fill,
1139 adminpass, krbtgtpass, machinepass, invocationid, dnspass, ntdsguid,
1140 serverrole, am_rodc=False, dom_for_fun_level=None, schema=None,
1141 next_rid=None, dc_rid=None):
1143 if next_rid is None:
1146 # Provision does not make much sense values larger than 1000000000
1147 # as the upper range of the rIDAvailablePool is 1073741823 and
1148 # we don't want to create a domain that cannot allocate rids.
1149 if next_rid < 1000 or next_rid > 1000000000:
1150 error = "You want to run SAMBA 4 with a next_rid of %u, " % (next_rid)
1151 error += "the valid range is %u-%u. The default is %u." % (
1152 1000, 1000000000, 1000)
1153 raise ProvisioningError(error)
1155 # ATTENTION: Do NOT change these default values without discussion with the
1156 # team and/or release manager. They have a big impact on the whole program!
1157 domainControllerFunctionality = DS_DOMAIN_FUNCTION_2008_R2
1159 if dom_for_fun_level is None:
1160 dom_for_fun_level = DS_DOMAIN_FUNCTION_2003
1162 if dom_for_fun_level > domainControllerFunctionality:
1163 raise ProvisioningError("You want to run SAMBA 4 on a domain and forest function level which itself is higher than its actual DC function level (2008_R2). This won't work!")
1165 domainFunctionality = dom_for_fun_level
1166 forestFunctionality = dom_for_fun_level
1168 # Set the NTDS settings DN manually - in order to have it already around
1169 # before the provisioned tree exists and we connect
1170 samdb.set_ntds_settings_dn("CN=NTDS Settings,%s" % names.serverdn)
1172 samdb.transaction_start()
1174 # Set the domain functionality levels onto the database.
1175 # Various module (the password_hash module in particular) need
1176 # to know what level of AD we are emulating.
1178 # These will be fixed into the database via the database
1179 # modifictions below, but we need them set from the start.
1180 samdb.set_opaque_integer("domainFunctionality", domainFunctionality)
1181 samdb.set_opaque_integer("forestFunctionality", forestFunctionality)
1182 samdb.set_opaque_integer("domainControllerFunctionality",
1183 domainControllerFunctionality)
1185 samdb.set_domain_sid(str(domainsid))
1186 samdb.set_invocation_id(invocationid)
1188 logger.info("Adding DomainDN: %s" % names.domaindn)
1190 # impersonate domain admin
1191 admin_session_info = admin_session(lp, str(domainsid))
1192 samdb.set_session_info(admin_session_info)
1193 if domainguid is not None:
1194 domainguid_line = "objectGUID: %s\n-" % domainguid
1196 domainguid_line = ""
1198 descr = b64encode(get_domain_descriptor(domainsid))
1199 setup_add_ldif(samdb, setup_path("provision_basedn.ldif"), {
1200 "DOMAINDN": names.domaindn,
1201 "DOMAINSID": str(domainsid),
1202 "DESCRIPTOR": descr,
1203 "DOMAINGUID": domainguid_line
1206 setup_modify_ldif(samdb, setup_path("provision_basedn_modify.ldif"), {
1207 "DOMAINDN": names.domaindn,
1208 "CREATTIME": str(samba.unix2nttime(int(time.time()))),
1209 "NEXTRID": str(next_rid),
1210 "DEFAULTSITE": names.sitename,
1211 "CONFIGDN": names.configdn,
1212 "POLICYGUID": policyguid,
1213 "DOMAIN_FUNCTIONALITY": str(domainFunctionality),
1214 "SAMBA_VERSION_STRING": version
1217 # If we are setting up a subdomain, then this has been replicated in, so we don't need to add it
1218 if fill == FILL_FULL:
1219 logger.info("Adding configuration container")
1220 descr = b64encode(get_config_descriptor(domainsid))
1221 setup_add_ldif(samdb, setup_path("provision_configuration_basedn.ldif"), {
1222 "CONFIGDN": names.configdn,
1223 "DESCRIPTOR": descr,
1226 # The LDIF here was created when the Schema object was constructed
1227 logger.info("Setting up sam.ldb schema")
1228 samdb.add_ldif(schema.schema_dn_add, controls=["relax:0"])
1229 samdb.modify_ldif(schema.schema_dn_modify)
1230 samdb.write_prefixes_from_schema()
1231 samdb.add_ldif(schema.schema_data, controls=["relax:0"])
1232 setup_add_ldif(samdb, setup_path("aggregate_schema.ldif"),
1233 {"SCHEMADN": names.schemadn})
1235 # Now register this container in the root of the forest
1236 msg = ldb.Message(ldb.Dn(samdb, names.domaindn))
1237 msg["subRefs"] = ldb.MessageElement(names.configdn , ldb.FLAG_MOD_ADD,
1241 samdb.transaction_cancel()
1244 samdb.transaction_commit()
1246 samdb.transaction_start()
1248 samdb.invocation_id = invocationid
1250 # If we are setting up a subdomain, then this has been replicated in, so we don't need to add it
1251 if fill == FILL_FULL:
1252 logger.info("Setting up sam.ldb configuration data")
1253 setup_add_ldif(samdb, setup_path("provision_configuration.ldif"), {
1254 "CONFIGDN": names.configdn,
1255 "NETBIOSNAME": names.netbiosname,
1256 "DEFAULTSITE": names.sitename,
1257 "DNSDOMAIN": names.dnsdomain,
1258 "DOMAIN": names.domain,
1259 "SCHEMADN": names.schemadn,
1260 "DOMAINDN": names.domaindn,
1261 "SERVERDN": names.serverdn,
1262 "FOREST_FUNCTIONALITY": str(forestFunctionality),
1263 "DOMAIN_FUNCTIONALITY": str(domainFunctionality),
1266 logger.info("Setting up display specifiers")
1267 display_specifiers_ldif = read_ms_ldif(
1268 setup_path('display-specifiers/DisplaySpecifiers-Win2k8R2.txt'))
1269 display_specifiers_ldif = substitute_var(display_specifiers_ldif,
1270 {"CONFIGDN": names.configdn})
1271 check_all_substituted(display_specifiers_ldif)
1272 samdb.add_ldif(display_specifiers_ldif)
1274 logger.info("Adding users container")
1275 setup_add_ldif(samdb, setup_path("provision_users_add.ldif"), {
1276 "DOMAINDN": names.domaindn})
1277 logger.info("Modifying users container")
1278 setup_modify_ldif(samdb, setup_path("provision_users_modify.ldif"), {
1279 "DOMAINDN": names.domaindn})
1280 logger.info("Adding computers container")
1281 setup_add_ldif(samdb, setup_path("provision_computers_add.ldif"), {
1282 "DOMAINDN": names.domaindn})
1283 logger.info("Modifying computers container")
1284 setup_modify_ldif(samdb,
1285 setup_path("provision_computers_modify.ldif"), {
1286 "DOMAINDN": names.domaindn})
1287 logger.info("Setting up sam.ldb data")
1288 setup_add_ldif(samdb, setup_path("provision.ldif"), {
1289 "CREATTIME": str(samba.unix2nttime(int(time.time()))),
1290 "DOMAINDN": names.domaindn,
1291 "NETBIOSNAME": names.netbiosname,
1292 "DEFAULTSITE": names.sitename,
1293 "CONFIGDN": names.configdn,
1294 "SERVERDN": names.serverdn,
1295 "RIDAVAILABLESTART": str(next_rid + 600),
1296 "POLICYGUID_DC": policyguid_dc
1299 # If we are setting up a subdomain, then this has been replicated in, so we don't need to add it
1300 if fill == FILL_FULL:
1301 setup_modify_ldif(samdb,
1302 setup_path("provision_configuration_references.ldif"), {
1303 "CONFIGDN": names.configdn,
1304 "SCHEMADN": names.schemadn})
1306 logger.info("Setting up well known security principals")
1307 setup_add_ldif(samdb, setup_path("provision_well_known_sec_princ.ldif"), {
1308 "CONFIGDN": names.configdn,
1311 if fill == FILL_FULL or fill == FILL_SUBDOMAIN:
1312 setup_modify_ldif(samdb,
1313 setup_path("provision_basedn_references.ldif"),
1314 {"DOMAINDN": names.domaindn})
1316 logger.info("Setting up sam.ldb users and groups")
1317 setup_add_ldif(samdb, setup_path("provision_users.ldif"), {
1318 "DOMAINDN": names.domaindn,
1319 "DOMAINSID": str(domainsid),
1320 "ADMINPASS_B64": b64encode(adminpass.encode('utf-16-le')),
1321 "KRBTGTPASS_B64": b64encode(krbtgtpass.encode('utf-16-le'))
1324 logger.info("Setting up self join")
1325 setup_self_join(samdb, admin_session_info, names=names, fill=fill,
1326 invocationid=invocationid,
1328 machinepass=machinepass,
1329 domainsid=domainsid,
1332 policyguid=policyguid,
1333 policyguid_dc=policyguid_dc,
1334 domainControllerFunctionality=domainControllerFunctionality,
1337 ntds_dn = "CN=NTDS Settings,%s" % names.serverdn
1338 names.ntdsguid = samdb.searchone(basedn=ntds_dn,
1339 attribute="objectGUID", expression="", scope=ldb.SCOPE_BASE)
1340 assert isinstance(names.ntdsguid, str)
1342 samdb.transaction_cancel()
1345 samdb.transaction_commit()
1350 FILL_SUBDOMAIN = "SUBDOMAIN"
1351 FILL_NT4SYNC = "NT4SYNC"
1353 SYSVOL_ACL = "O:LAG:BAD:P(A;OICI;0x001f01ff;;;BA)(A;OICI;0x001200a9;;;SO)(A;OICI;0x001f01ff;;;SY)(A;OICI;0x001200a9;;;AU)"
1354 POLICIES_ACL = "O:LAG:BAD:P(A;OICI;0x001f01ff;;;BA)(A;OICI;0x001200a9;;;SO)(A;OICI;0x001f01ff;;;SY)(A;OICI;0x001200a9;;;AU)(A;OICI;0x001301bf;;;PA)"
1357 def set_dir_acl(path, acl, lp, domsid):
1358 setntacl(lp, path, acl, domsid)
1359 for root, dirs, files in os.walk(path, topdown=False):
1361 setntacl(lp, os.path.join(root, name), acl, domsid)
1363 setntacl(lp, os.path.join(root, name), acl, domsid)
1366 def set_gpos_acl(sysvol, dnsdomain, domainsid, domaindn, samdb, lp):
1367 """Set ACL on the sysvol/<dnsname>/Policies folder and the policy
1370 :param sysvol: Physical path for the sysvol folder
1371 :param dnsdomain: The DNS name of the domain
1372 :param domainsid: The SID of the domain
1373 :param domaindn: The DN of the domain (ie. DC=...)
1374 :param samdb: An LDB object on the SAM db
1375 :param lp: an LP object
1378 # Set ACL for GPO root folder
1379 root_policy_path = os.path.join(sysvol, dnsdomain, "Policies")
1380 setntacl(lp, root_policy_path, POLICIES_ACL, str(domainsid))
1382 res = samdb.search(base="CN=Policies,CN=System,%s"%(domaindn),
1383 attrs=["cn", "nTSecurityDescriptor"],
1384 expression="", scope=ldb.SCOPE_ONELEVEL)
1387 acl = ndr_unpack(security.descriptor,
1388 str(policy["nTSecurityDescriptor"])).as_sddl()
1389 policy_path = getpolicypath(sysvol, dnsdomain, str(policy["cn"]))
1390 set_dir_acl(policy_path, dsacl2fsacl(acl, str(domainsid)), lp,
1394 def setsysvolacl(samdb, netlogon, sysvol, gid, domainsid, dnsdomain, domaindn,
1396 """Set the ACL for the sysvol share and the subfolders
1398 :param samdb: An LDB object on the SAM db
1399 :param netlogon: Physical path for the netlogon folder
1400 :param sysvol: Physical path for the sysvol folder
1401 :param gid: The GID of the "Domain adminstrators" group
1402 :param domainsid: The SID of the domain
1403 :param dnsdomain: The DNS name of the domain
1404 :param domaindn: The DN of the domain (ie. DC=...)
1408 os.chown(sysvol, -1, gid)
1414 # Set the SYSVOL_ACL on the sysvol folder and subfolder (first level)
1415 setntacl(lp,sysvol, SYSVOL_ACL, str(domainsid))
1416 for root, dirs, files in os.walk(sysvol, topdown=False):
1419 os.chown(os.path.join(root, name), -1, gid)
1420 setntacl(lp, os.path.join(root, name), SYSVOL_ACL, str(domainsid))
1423 os.chown(os.path.join(root, name), -1, gid)
1424 setntacl(lp, os.path.join(root, name), SYSVOL_ACL, str(domainsid))
1426 # Set acls on Policy folder and policies folders
1427 set_gpos_acl(sysvol, dnsdomain, domainsid, domaindn, samdb, lp)
1430 def interface_ips_v4(lp):
1431 '''return only IPv4 IPs'''
1432 ips = samba.interface_ips(lp, False)
1435 if i.find(':') == -1:
1439 def interface_ips_v6(lp, linklocal=False):
1440 '''return only IPv6 IPs'''
1441 ips = samba.interface_ips(lp, False)
1444 if i.find(':') != -1 and (linklocal or i.find('%') == -1):
1449 def provision_fill(samdb, secrets_ldb, logger, names, paths,
1450 domainsid, schema=None,
1451 targetdir=None, samdb_fill=FILL_FULL,
1452 hostip=None, hostip6=None,
1453 next_rid=1000, dc_rid=None, adminpass=None, krbtgtpass=None,
1454 domainguid=None, policyguid=None, policyguid_dc=None,
1455 invocationid=None, machinepass=None, ntdsguid=None,
1456 dns_backend=None, dnspass=None,
1457 serverrole=None, dom_for_fun_level=None,
1458 am_rodc=False, lp=None):
1459 # create/adapt the group policy GUIDs
1460 # Default GUID for default policy are described at
1461 # "How Core Group Policy Works"
1462 # http://technet.microsoft.com/en-us/library/cc784268%28WS.10%29.aspx
1463 if policyguid is None:
1464 policyguid = DEFAULT_POLICY_GUID
1465 policyguid = policyguid.upper()
1466 if policyguid_dc is None:
1467 policyguid_dc = DEFAULT_DC_POLICY_GUID
1468 policyguid_dc = policyguid_dc.upper()
1470 if invocationid is None:
1471 invocationid = str(uuid.uuid4())
1473 if krbtgtpass is None:
1474 krbtgtpass = samba.generate_random_password(128, 255)
1475 if machinepass is None:
1476 machinepass = samba.generate_random_password(128, 255)
1478 dnspass = samba.generate_random_password(128, 255)
1480 samdb = fill_samdb(samdb, lp, names, logger=logger,
1481 domainsid=domainsid, schema=schema, domainguid=domainguid,
1482 policyguid=policyguid, policyguid_dc=policyguid_dc,
1483 fill=samdb_fill, adminpass=adminpass, krbtgtpass=krbtgtpass,
1484 invocationid=invocationid, machinepass=machinepass,
1485 dnspass=dnspass, ntdsguid=ntdsguid, serverrole=serverrole,
1486 dom_for_fun_level=dom_for_fun_level, am_rodc=am_rodc,
1487 next_rid=next_rid, dc_rid=dc_rid)
1489 if serverrole == "active directory domain controller":
1490 # Set up group policies (domain policy and domain controller
1492 create_default_gpo(paths.sysvol, names.dnsdomain, policyguid,
1494 setsysvolacl(samdb, paths.netlogon, paths.sysvol, paths.wheel_gid,
1495 domainsid, names.dnsdomain, names.domaindn, lp)
1497 secretsdb_self_join(secrets_ldb, domain=names.domain,
1498 realm=names.realm, dnsdomain=names.dnsdomain,
1499 netbiosname=names.netbiosname, domainsid=domainsid,
1500 machinepass=machinepass, secure_channel_type=SEC_CHAN_BDC)
1502 # Now set up the right msDS-SupportedEncryptionTypes into the DB
1503 # In future, this might be determined from some configuration
1504 kerberos_enctypes = str(ENC_ALL_TYPES)
1507 msg = ldb.Message(ldb.Dn(samdb,
1508 samdb.searchone("distinguishedName",
1509 expression="samAccountName=%s$" % names.netbiosname,
1510 scope=ldb.SCOPE_SUBTREE)))
1511 msg["msDS-SupportedEncryptionTypes"] = ldb.MessageElement(
1512 elements=kerberos_enctypes, flags=ldb.FLAG_MOD_REPLACE,
1513 name="msDS-SupportedEncryptionTypes")
1515 except ldb.LdbError, (enum, estr):
1516 if enum != ldb.ERR_NO_SUCH_ATTRIBUTE:
1517 # It might be that this attribute does not exist in this schema
1520 setup_ad_dns(samdb, secrets_ldb, domainsid, names, paths, lp, logger,
1521 hostip=hostip, hostip6=hostip6, dns_backend=dns_backend,
1522 dnspass=dnspass, os_level=dom_for_fun_level,
1523 targetdir=targetdir, site=DEFAULTSITE)
1525 domainguid = samdb.searchone(basedn=samdb.get_default_basedn(),
1526 attribute="objectGUID")
1527 assert isinstance(domainguid, str)
1529 lastProvisionUSNs = get_last_provision_usn(samdb)
1530 maxUSN = get_max_usn(samdb, str(names.rootdn))
1531 if lastProvisionUSNs is not None:
1532 update_provision_usn(samdb, 0, maxUSN, invocationid, 1)
1534 set_provision_usn(samdb, 0, maxUSN, invocationid)
1536 logger.info("Setting up sam.ldb rootDSE marking as synchronized")
1537 setup_modify_ldif(samdb, setup_path("provision_rootdse_modify.ldif"),
1538 { 'NTDSGUID' : names.ntdsguid })
1540 # fix any dangling GUIDs from the provision
1541 logger.info("Fixing provision GUIDs")
1542 chk = dbcheck(samdb, samdb_schema=samdb, verbose=False, fix=True, yes=True,
1544 samdb.transaction_start()
1546 # a small number of GUIDs are missing because of ordering issues in the
1548 for schema_obj in ['CN=Domain', 'CN=Organizational-Person', 'CN=Contact', 'CN=inetOrgPerson']:
1549 chk.check_database(DN="%s,%s" % (schema_obj, names.schemadn),
1550 scope=ldb.SCOPE_BASE, attrs=['defaultObjectCategory'])
1551 chk.check_database(DN="CN=IP Security,CN=System,%s" % names.domaindn,
1552 scope=ldb.SCOPE_ONELEVEL,
1553 attrs=['ipsecOwnersReference',
1554 'ipsecFilterReference',
1555 'ipsecISAKMPReference',
1556 'ipsecNegotiationPolicyReference',
1557 'ipsecNFAReference'])
1559 samdb.transaction_cancel()
1562 samdb.transaction_commit()
1566 "ROLE_STANDALONE": "standalone server",
1567 "ROLE_DOMAIN_MEMBER": "member server",
1568 "ROLE_DOMAIN_BDC": "active directory domain controller",
1569 "ROLE_DOMAIN_PDC": "active directory domain controller",
1570 "dc": "active directory domain controller",
1571 "member": "member server",
1572 "domain controller": "active directory domain controller",
1573 "active directory domain controller": "active directory domain controller",
1574 "member server": "member server",
1575 "standalone": "standalone server",
1576 "standalone server": "standalone server",
1580 def sanitize_server_role(role):
1581 """Sanitize a server role name.
1583 :param role: Server role
1584 :raise ValueError: If the role can not be interpreted
1585 :return: Sanitized server role (one of "member server",
1586 "active directory domain controller", "standalone server")
1589 return _ROLES_MAP[role]
1591 raise ValueError(role)
1594 def provision(logger, session_info, credentials, smbconf=None,
1595 targetdir=None, samdb_fill=FILL_FULL, realm=None, rootdn=None,
1596 domaindn=None, schemadn=None, configdn=None, serverdn=None,
1597 domain=None, hostname=None, hostip=None, hostip6=None, domainsid=None,
1598 next_rid=1000, dc_rid=None, adminpass=None, ldapadminpass=None, krbtgtpass=None,
1599 domainguid=None, policyguid=None, policyguid_dc=None,
1600 dns_backend=None, dnspass=None,
1601 invocationid=None, machinepass=None, ntdsguid=None,
1602 root=None, nobody=None, users=None, wheel=None, backup=None, aci=None,
1603 serverrole=None, dom_for_fun_level=None,
1604 backend_type=None, sitename=None,
1605 ol_mmr_urls=None, ol_olc=None, slapd_path="/bin/false",
1606 useeadb=False, am_rodc=False,
1607 lp=None, use_ntvfs=False,
1611 :note: caution, this wipes all existing data!
1615 serverrole = sanitize_server_role(serverrole)
1617 raise ProvisioningError('server role (%s) should be one of "active directory domain controller", "member server", "standalone server"' % serverrole)
1619 if ldapadminpass is None:
1620 # Make a new, random password between Samba and it's LDAP server
1621 ldapadminpass = samba.generate_random_password(128, 255)
1623 if backend_type is None:
1624 backend_type = "ldb"
1626 if domainsid is None:
1627 domainsid = security.random_sid()
1629 domainsid = security.dom_sid(domainsid)
1631 root_uid = findnss_uid([root or "root"])
1632 nobody_uid = findnss_uid([nobody or "nobody"])
1633 users_gid = findnss_gid([users or "users", 'users', 'other', 'staff'])
1635 wheel_gid = findnss_gid(["wheel", "adm"])
1637 wheel_gid = findnss_gid([wheel])
1639 bind_gid = findnss_gid(["bind", "named"])
1643 if targetdir is not None:
1644 smbconf = os.path.join(targetdir, "etc", "smb.conf")
1645 elif smbconf is None:
1646 smbconf = samba.param.default_path()
1647 if not os.path.exists(os.path.dirname(smbconf)):
1648 os.makedirs(os.path.dirname(smbconf))
1650 server_services = []
1653 global_param["idmap_ldb:use rfc2307"] = ["yes"]
1655 if dns_backend == "SAMBA_INTERNAL":
1656 server_services.append("+dns")
1659 server_services.append("+smb")
1660 server_services.append("-s3fs")
1661 global_param["dcerpc endpoint servers"] = ["+winreg", "+srvsvc"]
1663 if len(server_services) > 0:
1664 global_param["server services"] = server_services
1666 # only install a new smb.conf if there isn't one there already
1667 if os.path.exists(smbconf):
1668 # if Samba Team members can't figure out the weird errors
1669 # loading an empty smb.conf gives, then we need to be smarter.
1670 # Pretend it just didn't exist --abartlet
1671 f = open(smbconf, 'r')
1673 data = f.read().lstrip()
1676 if data is None or data == "":
1677 make_smbconf(smbconf, hostname, domain, realm,
1678 targetdir, serverrole=serverrole,
1679 eadb=useeadb, use_ntvfs=use_ntvfs,
1680 lp=lp, global_param=global_param)
1682 make_smbconf(smbconf, hostname, domain, realm, targetdir,
1683 serverrole=serverrole,
1684 eadb=useeadb, use_ntvfs=use_ntvfs, lp=lp, global_param=global_param)
1687 lp = samba.param.LoadParm()
1689 names = guess_names(lp=lp, hostname=hostname, domain=domain,
1690 dnsdomain=realm, serverrole=serverrole, domaindn=domaindn,
1691 configdn=configdn, schemadn=schemadn, serverdn=serverdn,
1692 sitename=sitename, rootdn=rootdn)
1693 paths = provision_paths_from_lp(lp, names.dnsdomain)
1695 paths.bind_gid = bind_gid
1696 paths.wheel_gid = wheel_gid
1699 logger.info("Looking up IPv4 addresses")
1700 hostips = interface_ips_v4(lp)
1701 if len(hostips) > 0:
1703 if len(hostips) > 1:
1704 logger.warning("More than one IPv4 address found. Using %s",
1706 if hostip == "127.0.0.1":
1709 logger.warning("No IPv4 address will be assigned")
1712 logger.info("Looking up IPv6 addresses")
1713 hostips = interface_ips_v6(lp, linklocal=False)
1715 hostip6 = hostips[0]
1716 if len(hostips) > 1:
1717 logger.warning("More than one IPv6 address found. Using %s", hostip6)
1719 logger.warning("No IPv6 address will be assigned")
1721 names.hostip = hostip
1722 names.hostip6 = hostip6
1724 if serverrole is None:
1725 serverrole = lp.get("server role")
1727 if not os.path.exists(paths.private_dir):
1728 os.mkdir(paths.private_dir)
1729 if not os.path.exists(os.path.join(paths.private_dir, "tls")):
1730 os.mkdir(os.path.join(paths.private_dir, "tls"))
1731 if not os.path.exists(paths.state_dir):
1732 os.mkdir(paths.state_dir)
1734 if paths.sysvol and not os.path.exists(paths.sysvol):
1735 os.makedirs(paths.sysvol, 0775)
1737 if not use_ntvfs and serverrole == "active directory domain controller":
1738 if paths.sysvol is None:
1739 raise MissingShareError("sysvol", paths.smbconf)
1741 file = tempfile.NamedTemporaryFile(dir=os.path.abspath(paths.sysvol))
1744 smbd.set_simple_acl(file.name, root_uid, wheel_gid)
1746 raise ProvisioningError("Your filesystem or build does not support posix ACLs, s3fs is unworkable in this mode")
1750 ldapi_url = "ldapi://%s" % urllib.quote(paths.s4_ldapi_path, safe="")
1752 schema = Schema(domainsid, invocationid=invocationid,
1753 schemadn=names.schemadn)
1755 if backend_type == "ldb":
1756 provision_backend = LDBBackend(backend_type, paths=paths,
1757 lp=lp, credentials=credentials,
1758 names=names, logger=logger)
1759 elif backend_type == "existing":
1760 # If support for this is ever added back, then the URI will need to be specified again
1761 provision_backend = ExistingBackend(backend_type, paths=paths,
1762 lp=lp, credentials=credentials,
1763 names=names, logger=logger,
1764 ldap_backend_forced_uri=None)
1765 elif backend_type == "fedora-ds":
1766 provision_backend = FDSBackend(backend_type, paths=paths,
1767 lp=lp, credentials=credentials,
1768 names=names, logger=logger, domainsid=domainsid,
1769 schema=schema, hostname=hostname, ldapadminpass=ldapadminpass,
1770 slapd_path=slapd_path,
1772 elif backend_type == "openldap":
1773 provision_backend = OpenLDAPBackend(backend_type, paths=paths,
1774 lp=lp, credentials=credentials,
1775 names=names, logger=logger, domainsid=domainsid,
1776 schema=schema, hostname=hostname, ldapadminpass=ldapadminpass,
1777 slapd_path=slapd_path, ol_mmr_urls=ol_mmr_urls)
1779 raise ValueError("Unknown LDAP backend type selected")
1781 provision_backend.init()
1782 provision_backend.start()
1784 # only install a new shares config db if there is none
1785 if not os.path.exists(paths.shareconf):
1786 logger.info("Setting up share.ldb")
1787 share_ldb = Ldb(paths.shareconf, session_info=session_info, lp=lp)
1788 share_ldb.load_ldif_file_add(setup_path("share.ldif"))
1790 logger.info("Setting up secrets.ldb")
1791 secrets_ldb = setup_secretsdb(paths,
1792 session_info=session_info,
1793 backend_credentials=provision_backend.secrets_credentials, lp=lp)
1796 logger.info("Setting up the registry")
1797 setup_registry(paths.hklm, session_info, lp=lp)
1799 logger.info("Setting up the privileges database")
1800 setup_privileges(paths.privilege, session_info, lp=lp)
1802 logger.info("Setting up idmap db")
1803 idmap = setup_idmapdb(paths.idmapdb, session_info=session_info, lp=lp)
1805 setup_name_mappings(idmap, sid=str(domainsid),
1806 root_uid=root_uid, nobody_uid=nobody_uid,
1807 users_gid=users_gid, wheel_gid=wheel_gid)
1809 logger.info("Setting up SAM db")
1810 samdb = setup_samdb(paths.samdb, session_info,
1811 provision_backend, lp, names, logger=logger,
1812 serverrole=serverrole,
1813 schema=schema, fill=samdb_fill, am_rodc=am_rodc)
1815 if serverrole == "active directory domain controller":
1816 if paths.netlogon is None:
1817 raise MissingShareError("netlogon", paths.smbconf)
1819 if paths.sysvol is None:
1820 raise MissingShareError("sysvol", paths.smbconf)
1822 if not os.path.isdir(paths.netlogon):
1823 os.makedirs(paths.netlogon, 0755)
1825 if adminpass is None:
1826 adminpass = samba.generate_random_password(12, 32)
1827 adminpass_generated = True
1829 adminpass_generated = False
1831 if samdb_fill == FILL_FULL:
1832 provision_fill(samdb, secrets_ldb, logger, names, paths,
1833 schema=schema, targetdir=targetdir, samdb_fill=samdb_fill,
1834 hostip=hostip, hostip6=hostip6, domainsid=domainsid,
1835 next_rid=next_rid, dc_rid=dc_rid, adminpass=adminpass,
1836 krbtgtpass=krbtgtpass, domainguid=domainguid,
1837 policyguid=policyguid, policyguid_dc=policyguid_dc,
1838 invocationid=invocationid, machinepass=machinepass,
1839 ntdsguid=ntdsguid, dns_backend=dns_backend,
1840 dnspass=dnspass, serverrole=serverrole,
1841 dom_for_fun_level=dom_for_fun_level, am_rodc=am_rodc,
1844 create_krb5_conf(paths.krb5conf,
1845 dnsdomain=names.dnsdomain, hostname=names.hostname,
1847 logger.info("A Kerberos configuration suitable for Samba 4 has been "
1848 "generated at %s", paths.krb5conf)
1850 if serverrole == "active directory domain controller":
1851 create_dns_update_list(lp, logger, paths)
1853 backend_result = provision_backend.post_setup()
1854 provision_backend.shutdown()
1856 create_phpldapadmin_config(paths.phpldapadminconfig,
1859 secrets_ldb.transaction_cancel()
1862 # Now commit the secrets.ldb to disk
1863 secrets_ldb.transaction_commit()
1865 # the commit creates the dns.keytab, now chown it
1866 dns_keytab_path = os.path.join(paths.private_dir, paths.dns_keytab)
1867 if os.path.isfile(dns_keytab_path) and paths.bind_gid is not None:
1869 os.chmod(dns_keytab_path, 0640)
1870 os.chown(dns_keytab_path, -1, paths.bind_gid)
1872 if not os.environ.has_key('SAMBA_SELFTEST'):
1873 logger.info("Failed to chown %s to bind gid %u",
1874 dns_keytab_path, paths.bind_gid)
1876 result = ProvisionResult()
1877 result.server_role = serverrole
1878 result.domaindn = domaindn
1879 result.paths = paths
1880 result.names = names
1882 result.samdb = samdb
1883 result.idmap = idmap
1884 result.domainsid = str(domainsid)
1886 if samdb_fill == FILL_FULL:
1887 result.adminpass_generated = adminpass_generated
1888 result.adminpass = adminpass
1890 result.adminpass_generated = False
1891 result.adminpass = None
1893 result.backend_result = backend_result
1898 def provision_become_dc(smbconf=None, targetdir=None,
1899 realm=None, rootdn=None, domaindn=None, schemadn=None, configdn=None,
1900 serverdn=None, domain=None, hostname=None, domainsid=None,
1901 adminpass=None, krbtgtpass=None, domainguid=None, policyguid=None,
1902 policyguid_dc=None, invocationid=None, machinepass=None, dnspass=None,
1903 dns_backend=None, root=None, nobody=None, users=None, wheel=None,
1904 backup=None, serverrole=None, ldap_backend=None,
1905 ldap_backend_type=None, sitename=None, debuglevel=1):
1907 logger = logging.getLogger("provision")
1908 samba.set_debug_level(debuglevel)
1910 res = provision(logger, system_session(), None,
1911 smbconf=smbconf, targetdir=targetdir, samdb_fill=FILL_DRS,
1912 realm=realm, rootdn=rootdn, domaindn=domaindn, schemadn=schemadn,
1913 configdn=configdn, serverdn=serverdn, domain=domain,
1914 hostname=hostname, hostip=None, domainsid=domainsid,
1915 machinepass=machinepass, serverrole="active directory domain controller",
1916 sitename=sitename, dns_backend=dns_backend, dnspass=dnspass)
1917 res.lp.set("debuglevel", str(debuglevel))
1921 def create_phpldapadmin_config(path, ldapi_uri):
1922 """Create a PHP LDAP admin configuration file.
1924 :param path: Path to write the configuration to.
1926 setup_file(setup_path("phpldapadmin-config.php"), path,
1927 {"S4_LDAPI_URI": ldapi_uri})
1930 def create_krb5_conf(path, dnsdomain, hostname, realm):
1931 """Write out a file containing zone statements suitable for inclusion in a
1932 named.conf file (including GSS-TSIG configuration).
1934 :param path: Path of the new named.conf file.
1935 :param dnsdomain: DNS Domain name
1936 :param hostname: Local hostname
1937 :param realm: Realm name
1939 setup_file(setup_path("krb5.conf"), path, {
1940 "DNSDOMAIN": dnsdomain,
1941 "HOSTNAME": hostname,
1946 class ProvisioningError(Exception):
1947 """A generic provision error."""
1949 def __init__(self, value):
1953 return "ProvisioningError: " + self.value
1956 class InvalidNetbiosName(Exception):
1957 """A specified name was not a valid NetBIOS name."""
1959 def __init__(self, name):
1960 super(InvalidNetbiosName, self).__init__(
1961 "The name '%r' is not a valid NetBIOS name" % name)
1964 class MissingShareError(ProvisioningError):
1966 def __init__(self, name, smbconf):
1967 super(MissingShareError, self).__init__(
1968 "Existing smb.conf does not have a [%s] share, but you are "
1969 "configuring a DC. Please remove %s or add the share manually." %