5 # Copyright Matthias Dieter Wallnoefer 2009
6 # Copyright Andrew Kroeger 2009
7 # Copyright Jelmer Vernooij 2009
8 # Copyright Giampaolo Lauria 2011
10 # This program is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program. If not, see <http://www.gnu.org/licenses/>.
26 import samba.getopt as options
32 from samba.net import Net, LIBNET_JOIN_AUTOMATIC
34 from samba.join import join_RODC, join_DC, join_subdomain
35 from samba.auth import system_session
36 from samba.samdb import SamDB
37 from samba.dcerpc.samr import DOMAIN_PASSWORD_COMPLEX, DOMAIN_PASSWORD_STORE_CLEARTEXT
38 from samba.netcmd import (
44 from samba.samba3 import Samba3
45 from samba.samba3 import param as s3param
46 from samba.upgrade import upgrade_from_samba3
48 from samba.dsdb import (
49 DS_DOMAIN_FUNCTION_2000,
50 DS_DOMAIN_FUNCTION_2003,
51 DS_DOMAIN_FUNCTION_2003_MIXED,
52 DS_DOMAIN_FUNCTION_2008,
53 DS_DOMAIN_FUNCTION_2008_R2,
56 def get_testparm_var(testparm, smbconf, varname):
57 cmd = "%s -s -l --parameter-name='%s' %s 2>/dev/null" % (testparm, varname, smbconf)
58 output = os.popen(cmd, 'r').readline()
62 class cmd_domain_export_keytab(Command):
63 """Dumps kerberos keys of the domain into a keytab"""
65 synopsis = "%prog <keytab> [options]"
70 takes_args = ["keytab"]
72 def run(self, keytab, credopts=None, sambaopts=None, versionopts=None):
73 lp = sambaopts.get_loadparm()
74 net = Net(None, lp, server=credopts.ipaddress)
75 net.export_keytab(keytab=keytab)
79 class cmd_domain_join(Command):
80 """Joins domain as either member or backup domain controller"""
82 synopsis = "%prog <dnsdomain> [DC|RODC|MEMBER|SUBDOMAIN] [options]"
85 Option("--server", help="DC to join", type=str),
86 Option("--site", help="site to join", type=str),
87 Option("--targetdir", help="where to store provision", type=str),
88 Option("--parent-domain", help="parent domain to create subdomain under", type=str),
89 Option("--domain-critical-only",
90 help="only replicate critical domain objects",
94 takes_args = ["domain", "role?"]
96 def run(self, domain, role=None, sambaopts=None, credopts=None,
97 versionopts=None, server=None, site=None, targetdir=None,
98 domain_critical_only=False, parent_domain=None):
99 lp = sambaopts.get_loadparm()
100 creds = credopts.get_credentials(lp)
101 net = Net(creds, lp, server=credopts.ipaddress)
104 site = "Default-First-Site-Name"
106 netbios_name = lp.get("netbios name")
111 if role is None or role == "MEMBER":
112 (join_password, sid, domain_name) = net.join_member(domain,
114 LIBNET_JOIN_AUTOMATIC)
116 self.outf.write("Joined domain %s (%s)\n" % (domain_name, sid))
119 join_DC(server=server, creds=creds, lp=lp, domain=domain,
120 site=site, netbios_name=netbios_name, targetdir=targetdir,
121 domain_critical_only=domain_critical_only)
124 join_RODC(server=server, creds=creds, lp=lp, domain=domain,
125 site=site, netbios_name=netbios_name, targetdir=targetdir,
126 domain_critical_only=domain_critical_only)
128 elif role == "SUBDOMAIN":
129 netbios_domain = lp.get("workgroup")
130 if parent_domain is None:
131 parent_domain = ".".join(domain.split(".")[1:])
132 join_subdomain(server=server, creds=creds, lp=lp, dnsdomain=domain, parent_domain=parent_domain,
133 site=site, netbios_name=netbios_name, netbios_domain=netbios_domain, targetdir=targetdir)
136 raise CommandError("Invalid role '%s' (possible values: MEMBER, DC, RODC, SUBDOMAIN)" % role)
140 class cmd_domain_level(Command):
141 """Raises domain and forest function levels"""
143 synopsis = "%prog (show|raise <options>) [options]"
146 Option("-H", "--URL", help="LDB URL for database or target server", type=str,
147 metavar="URL", dest="H"),
148 Option("--quiet", help="Be quiet", action="store_true"),
149 Option("--forest-level", type="choice", choices=["2003", "2008", "2008_R2"],
150 help="The forest function level (2003 | 2008 | 2008_R2)"),
151 Option("--domain-level", type="choice", choices=["2003", "2008", "2008_R2"],
152 help="The domain function level (2003 | 2008 | 2008_R2)")
155 takes_args = ["subcommand"]
157 def run(self, subcommand, H=None, forest_level=None, domain_level=None,
158 quiet=False, credopts=None, sambaopts=None, versionopts=None):
159 lp = sambaopts.get_loadparm()
160 creds = credopts.get_credentials(lp, fallback_machine=True)
162 samdb = SamDB(url=H, session_info=system_session(),
163 credentials=creds, lp=lp)
165 domain_dn = samdb.domain_dn()
167 res_forest = samdb.search("CN=Partitions,%s" % samdb.get_config_basedn(),
168 scope=ldb.SCOPE_BASE, attrs=["msDS-Behavior-Version"])
169 assert len(res_forest) == 1
171 res_domain = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
172 attrs=["msDS-Behavior-Version", "nTMixedDomain"])
173 assert len(res_domain) == 1
175 res_dc_s = samdb.search("CN=Sites,%s" % samdb.get_config_basedn(),
176 scope=ldb.SCOPE_SUBTREE, expression="(objectClass=nTDSDSA)",
177 attrs=["msDS-Behavior-Version"])
178 assert len(res_dc_s) >= 1
181 level_forest = int(res_forest[0]["msDS-Behavior-Version"][0])
182 level_domain = int(res_domain[0]["msDS-Behavior-Version"][0])
183 level_domain_mixed = int(res_domain[0]["nTMixedDomain"][0])
185 min_level_dc = int(res_dc_s[0]["msDS-Behavior-Version"][0]) # Init value
187 if int(msg["msDS-Behavior-Version"][0]) < min_level_dc:
188 min_level_dc = int(msg["msDS-Behavior-Version"][0])
190 if level_forest < 0 or level_domain < 0:
191 raise CommandError("Domain and/or forest function level(s) is/are invalid. Correct them or reprovision!")
193 raise CommandError("Lowest function level of a DC is invalid. Correct this or reprovision!")
194 if level_forest > level_domain:
195 raise CommandError("Forest function level is higher than the domain level(s). Correct this or reprovision!")
196 if level_domain > min_level_dc:
197 raise CommandError("Domain function level is higher than the lowest function level of a DC. Correct this or reprovision!")
200 raise CommandError("Could not retrieve the actual domain, forest level and/or lowest DC function level!")
202 if subcommand == "show":
203 self.message("Domain and forest function level for domain '%s'" % domain_dn)
204 if level_forest == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
205 self.message("\nATTENTION: You run SAMBA 4 on a forest function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
206 if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
207 self.message("\nATTENTION: You run SAMBA 4 on a domain function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
208 if min_level_dc == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
209 self.message("\nATTENTION: You run SAMBA 4 on a lowest function level of a DC lower than Windows 2003. This isn't supported! Please step-up or upgrade the concerning DC(s)!")
213 if level_forest == DS_DOMAIN_FUNCTION_2000:
215 elif level_forest == DS_DOMAIN_FUNCTION_2003_MIXED:
216 outstr = "2003 with mixed domains/interim (NT4 DC support)"
217 elif level_forest == DS_DOMAIN_FUNCTION_2003:
219 elif level_forest == DS_DOMAIN_FUNCTION_2008:
221 elif level_forest == DS_DOMAIN_FUNCTION_2008_R2:
224 outstr = "higher than 2008 R2"
225 self.message("Forest function level: (Windows) " + outstr)
227 if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
228 outstr = "2000 mixed (NT4 DC support)"
229 elif level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed == 0:
231 elif level_domain == DS_DOMAIN_FUNCTION_2003_MIXED:
232 outstr = "2003 with mixed domains/interim (NT4 DC support)"
233 elif level_domain == DS_DOMAIN_FUNCTION_2003:
235 elif level_domain == DS_DOMAIN_FUNCTION_2008:
237 elif level_domain == DS_DOMAIN_FUNCTION_2008_R2:
240 outstr = "higher than 2008 R2"
241 self.message("Domain function level: (Windows) " + outstr)
243 if min_level_dc == DS_DOMAIN_FUNCTION_2000:
245 elif min_level_dc == DS_DOMAIN_FUNCTION_2003:
247 elif min_level_dc == DS_DOMAIN_FUNCTION_2008:
249 elif min_level_dc == DS_DOMAIN_FUNCTION_2008_R2:
252 outstr = "higher than 2008 R2"
253 self.message("Lowest function level of a DC: (Windows) " + outstr)
255 elif subcommand == "raise":
258 if domain_level is not None:
259 if domain_level == "2003":
260 new_level_domain = DS_DOMAIN_FUNCTION_2003
261 elif domain_level == "2008":
262 new_level_domain = DS_DOMAIN_FUNCTION_2008
263 elif domain_level == "2008_R2":
264 new_level_domain = DS_DOMAIN_FUNCTION_2008_R2
266 if new_level_domain <= level_domain and level_domain_mixed == 0:
267 raise CommandError("Domain function level can't be smaller than or equal to the actual one!")
269 if new_level_domain > min_level_dc:
270 raise CommandError("Domain function level can't be higher than the lowest function level of a DC!")
272 # Deactivate mixed/interim domain support
273 if level_domain_mixed != 0:
274 # Directly on the base DN
276 m.dn = ldb.Dn(samdb, domain_dn)
277 m["nTMixedDomain"] = ldb.MessageElement("0",
278 ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
282 m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup") + ",CN=Partitions,%s" % ldb.get_config_basedn())
283 m["nTMixedDomain"] = ldb.MessageElement("0",
284 ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
287 except ldb.LdbError, (enum, emsg):
288 if enum != ldb.ERR_UNWILLING_TO_PERFORM:
291 # Directly on the base DN
293 m.dn = ldb.Dn(samdb, domain_dn)
294 m["msDS-Behavior-Version"]= ldb.MessageElement(
295 str(new_level_domain), ldb.FLAG_MOD_REPLACE,
296 "msDS-Behavior-Version")
300 m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup")
301 + ",CN=Partitions,%s" % ldb.get_config_basedn())
302 m["msDS-Behavior-Version"]= ldb.MessageElement(
303 str(new_level_domain), ldb.FLAG_MOD_REPLACE,
304 "msDS-Behavior-Version")
307 except ldb.LdbError, (enum, emsg):
308 if enum != ldb.ERR_UNWILLING_TO_PERFORM:
311 level_domain = new_level_domain
312 msgs.append("Domain function level changed!")
314 if forest_level is not None:
315 if forest_level == "2003":
316 new_level_forest = DS_DOMAIN_FUNCTION_2003
317 elif forest_level == "2008":
318 new_level_forest = DS_DOMAIN_FUNCTION_2008
319 elif forest_level == "2008_R2":
320 new_level_forest = DS_DOMAIN_FUNCTION_2008_R2
321 if new_level_forest <= level_forest:
322 raise CommandError("Forest function level can't be smaller than or equal to the actual one!")
323 if new_level_forest > level_domain:
324 raise CommandError("Forest function level can't be higher than the domain function level(s). Please raise it/them first!")
326 m.dn = ldb.Dn(samdb, "CN=Partitions,%s" % ldb.get_config_basedn())
327 m["msDS-Behavior-Version"]= ldb.MessageElement(
328 str(new_level_forest), ldb.FLAG_MOD_REPLACE,
329 "msDS-Behavior-Version")
331 msgs.append("Forest function level changed!")
332 msgs.append("All changes applied successfully!")
333 self.message("\n".join(msgs))
335 raise CommandError("invalid argument: '%s' (choose from 'show', 'raise')" % subcommand)
339 class cmd_domain_passwordsettings(Command):
340 """Sets password settings
342 Password complexity, history length, minimum password length, the minimum
343 and maximum password age) on a Samba4 server.
346 synopsis = "%prog (show|set <options>) [options]"
349 Option("-H", "--URL", help="LDB URL for database or target server", type=str,
350 metavar="URL", dest="H"),
351 Option("--quiet", help="Be quiet", action="store_true"),
352 Option("--complexity", type="choice", choices=["on","off","default"],
353 help="The password complexity (on | off | default). Default is 'on'"),
354 Option("--store-plaintext", type="choice", choices=["on","off","default"],
355 help="Store plaintext passwords where account have 'store passwords with reversible encryption' set (on | off | default). Default is 'off'"),
356 Option("--history-length",
357 help="The password history length (<integer> | default). Default is 24.", type=str),
358 Option("--min-pwd-length",
359 help="The minimum password length (<integer> | default). Default is 7.", type=str),
360 Option("--min-pwd-age",
361 help="The minimum password age (<integer in days> | default). Default is 1.", type=str),
362 Option("--max-pwd-age",
363 help="The maximum password age (<integer in days> | default). Default is 43.", type=str),
366 takes_args = ["subcommand"]
368 def run(self, subcommand, H=None, min_pwd_age=None, max_pwd_age=None,
369 quiet=False, complexity=None, store_plaintext=None, history_length=None,
370 min_pwd_length=None, credopts=None, sambaopts=None,
372 lp = sambaopts.get_loadparm()
373 creds = credopts.get_credentials(lp)
375 samdb = SamDB(url=H, session_info=system_session(),
376 credentials=creds, lp=lp)
378 domain_dn = samdb.domain_dn()
379 res = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
380 attrs=["pwdProperties", "pwdHistoryLength", "minPwdLength",
381 "minPwdAge", "maxPwdAge"])
382 assert(len(res) == 1)
384 pwd_props = int(res[0]["pwdProperties"][0])
385 pwd_hist_len = int(res[0]["pwdHistoryLength"][0])
386 cur_min_pwd_len = int(res[0]["minPwdLength"][0])
388 cur_min_pwd_age = int(abs(int(res[0]["minPwdAge"][0])) / (1e7 * 60 * 60 * 24))
389 if int(res[0]["maxPwdAge"][0]) == -0x8000000000000000:
392 cur_max_pwd_age = int(abs(int(res[0]["maxPwdAge"][0])) / (1e7 * 60 * 60 * 24))
394 raise CommandError("Could not retrieve password properties!", e)
396 if subcommand == "show":
397 self.message("Password informations for domain '%s'" % domain_dn)
399 if pwd_props & DOMAIN_PASSWORD_COMPLEX != 0:
400 self.message("Password complexity: on")
402 self.message("Password complexity: off")
403 if pwd_props & DOMAIN_PASSWORD_STORE_CLEARTEXT != 0:
404 self.message("Store plaintext passwords: on")
406 self.message("Store plaintext passwords: off")
407 self.message("Password history length: %d" % pwd_hist_len)
408 self.message("Minimum password length: %d" % cur_min_pwd_len)
409 self.message("Minimum password age (days): %d" % cur_min_pwd_age)
410 self.message("Maximum password age (days): %d" % cur_max_pwd_age)
411 elif subcommand == "set":
414 m.dn = ldb.Dn(samdb, domain_dn)
416 if complexity is not None:
417 if complexity == "on" or complexity == "default":
418 pwd_props = pwd_props | DOMAIN_PASSWORD_COMPLEX
419 msgs.append("Password complexity activated!")
420 elif complexity == "off":
421 pwd_props = pwd_props & (~DOMAIN_PASSWORD_COMPLEX)
422 msgs.append("Password complexity deactivated!")
424 if store_plaintext is not None:
425 if store_plaintext == "on" or store_plaintext == "default":
426 pwd_props = pwd_props | DOMAIN_PASSWORD_STORE_CLEARTEXT
427 msgs.append("Plaintext password storage for changed passwords activated!")
428 elif store_plaintext == "off":
429 pwd_props = pwd_props & (~DOMAIN_PASSWORD_STORE_CLEARTEXT)
430 msgs.append("Plaintext password storage for changed passwords deactivated!")
432 if complexity is not None or store_plaintext is not None:
433 m["pwdProperties"] = ldb.MessageElement(str(pwd_props),
434 ldb.FLAG_MOD_REPLACE, "pwdProperties")
436 if history_length is not None:
437 if history_length == "default":
440 pwd_hist_len = int(history_length)
442 if pwd_hist_len < 0 or pwd_hist_len > 24:
443 raise CommandError("Password history length must be in the range of 0 to 24!")
445 m["pwdHistoryLength"] = ldb.MessageElement(str(pwd_hist_len),
446 ldb.FLAG_MOD_REPLACE, "pwdHistoryLength")
447 msgs.append("Password history length changed!")
449 if min_pwd_length is not None:
450 if min_pwd_length == "default":
453 min_pwd_len = int(min_pwd_length)
455 if min_pwd_len < 0 or min_pwd_len > 14:
456 raise CommandError("Minimum password length must be in the range of 0 to 14!")
458 m["minPwdLength"] = ldb.MessageElement(str(min_pwd_len),
459 ldb.FLAG_MOD_REPLACE, "minPwdLength")
460 msgs.append("Minimum password length changed!")
462 if min_pwd_age is not None:
463 if min_pwd_age == "default":
466 min_pwd_age = int(min_pwd_age)
468 if min_pwd_age < 0 or min_pwd_age > 998:
469 raise CommandError("Minimum password age must be in the range of 0 to 998!")
472 min_pwd_age_ticks = -int(min_pwd_age * (24 * 60 * 60 * 1e7))
474 m["minPwdAge"] = ldb.MessageElement(str(min_pwd_age_ticks),
475 ldb.FLAG_MOD_REPLACE, "minPwdAge")
476 msgs.append("Minimum password age changed!")
478 if max_pwd_age is not None:
479 if max_pwd_age == "default":
482 max_pwd_age = int(max_pwd_age)
484 if max_pwd_age < 0 or max_pwd_age > 999:
485 raise CommandError("Maximum password age must be in the range of 0 to 999!")
489 max_pwd_age_ticks = -0x8000000000000000
491 max_pwd_age_ticks = -int(max_pwd_age * (24 * 60 * 60 * 1e7))
493 m["maxPwdAge"] = ldb.MessageElement(str(max_pwd_age_ticks),
494 ldb.FLAG_MOD_REPLACE, "maxPwdAge")
495 msgs.append("Maximum password age changed!")
497 if max_pwd_age > 0 and min_pwd_age >= max_pwd_age:
498 raise CommandError("Maximum password age (%d) must be greater than minimum password age (%d)!" % (max_pwd_age, min_pwd_age))
501 raise CommandError("You must specify at least one option to set. Try --help")
503 msgs.append("All changes applied successfully!")
504 self.message("\n".join(msgs))
506 raise CommandError("Wrong argument '%s'!" % subcommand)
509 class cmd_domain_samba3upgrade(Command):
510 """Upgrade from Samba3 database to Samba4 AD database.
512 Specify either a directory with all samba3 databases and state files (with --dbdir) or
513 samba3 testparm utility (with --testparm).
516 synopsis = "%prog [options] <samba3_smb_conf>"
518 takes_optiongroups = {
519 "sambaopts": options.SambaOptions,
520 "versionopts": options.VersionOptions
524 Option("--dbdir", type="string", metavar="DIR",
525 help="Path to samba3 database directory"),
526 Option("--testparm", type="string", metavar="PATH",
527 help="Path to samba3 testparm utility from the previous installation. This allows the default paths of the previous installation to be followed"),
528 Option("--targetdir", type="string", metavar="DIR",
529 help="Path prefix where the new Samba 4.0 AD domain should be initialised"),
530 Option("--quiet", help="Be quiet", action="store_true"),
531 Option("--use-xattrs", type="choice", choices=["yes","no","auto"], metavar="[yes|no|auto]",
532 help="Define if we should use the native fs capabilities or a tdb file for storing attributes likes ntacl, auto tries to make an inteligent guess based on the user rights and system capabilities", default="auto"),
535 takes_args = ["smbconf"]
537 def run(self, smbconf=None, targetdir=None, dbdir=None, testparm=None,
538 quiet=False, use_xattrs=None, sambaopts=None, versionopts=None):
540 if not os.path.exists(smbconf):
541 raise CommandError("File %s does not exist" % smbconf)
543 if testparm and not os.path.exists(testparm):
544 raise CommandError("Testparm utility %s does not exist" % testparm)
546 if dbdir and not os.path.exists(dbdir):
547 raise CommandError("Directory %s does not exist" % dbdir)
549 if not dbdir and not testparm:
550 raise CommandError("Please specify either dbdir or testparm")
552 logger = self.get_logger()
554 logger.setLevel(logging.WARNING)
556 logger.setLevel(logging.INFO)
558 if dbdir and testparm:
559 logger.warning("both dbdir and testparm specified, ignoring dbdir.")
562 lp = sambaopts.get_loadparm()
564 s3conf = s3param.get_context()
567 s3conf.set("realm", sambaopts.realm)
570 if use_xattrs == "yes":
572 elif use_xattrs == "auto" and not s3conf.get("posix:eadb"):
574 tmpfile = tempfile.NamedTemporaryFile(prefix=os.path.abspath(targetdir))
576 tmpfile = tempfile.NamedTemporaryFile(prefix=os.path.abspath(os.path.dirname(lp.get("private dir"))))
578 samba.ntacls.setntacl(lp, tmpfile.name,
579 "O:S-1-5-32G:S-1-5-32", "S-1-5-32", "native")
582 # FIXME: Don't catch all exceptions here
583 logger.info("You are not root or your system do not support xattr, using tdb backend for attributes. "
584 "If you intend to use this provision in production, rerun the script as root on a system supporting xattrs.")
587 # Set correct default values from dbdir or testparm
590 paths["state directory"] = dbdir
591 paths["private dir"] = dbdir
592 paths["lock directory"] = dbdir
594 paths["state directory"] = get_testparm_var(testparm, smbconf, "state directory")
595 paths["private dir"] = get_testparm_var(testparm, smbconf, "private dir")
596 paths["lock directory"] = get_testparm_var(testparm, smbconf, "lock directory")
597 # "testparm" from Samba 3 < 3.4.x is not aware of the parameter
598 # "state directory", instead make use of "lock directory"
599 if len(paths["state directory"]) == 0:
600 paths["state directory"] = paths["lock directory"]
603 s3conf.set(p, paths[p])
605 # load smb.conf parameters
606 logger.info("Reading smb.conf")
608 samba3 = Samba3(smbconf, s3conf)
610 logger.info("Provisioning")
611 upgrade_from_samba3(samba3, logger, targetdir, session_info=system_session(),
615 class cmd_domain(SuperCommand):
616 """Domain management"""
619 subcommands["exportkeytab"] = cmd_domain_export_keytab()
620 subcommands["join"] = cmd_domain_join()
621 subcommands["level"] = cmd_domain_level()
622 subcommands["passwordsettings"] = cmd_domain_passwordsettings()
623 subcommands["samba3upgrade"] = cmd_domain_samba3upgrade()