source4/scripting/python/samba/netcmd/domain.py

   1 #!/usr/bin/env python
   2 #
   3 # domain management
   4 #
   5 # Copyright Matthias Dieter Wallnoefer 2009
   6 # Copyright Andrew Kroeger 2009
   7 # Copyright Jelmer Vernooij 2009
   8 # Copyright Giampaolo Lauria 2011
   9 #
  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.
  14 #
  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.
  19 #
  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/>.
  22 #
  23
  24
  25
  26 import samba.getopt as options
  27 import ldb
  28 import os
  29 from samba import Ldb
  30 from samba.net import Net, LIBNET_JOIN_AUTOMATIC
  31 from samba.dcerpc.misc import SEC_CHAN_WKSTA
  32 from samba.join import join_RODC, join_DC
  33 from samba.auth import system_session
  34 from samba.samdb import SamDB
  35 from samba.dcerpc.samr import DOMAIN_PASSWORD_COMPLEX, DOMAIN_PASSWORD_STORE_CLEARTEXT
  36 from samba.netcmd import (
  37     Command,
  38     CommandError,
  39     SuperCommand,
  40     Option
  41     )
  42
  43 from samba.dsdb import (
  44     DS_DOMAIN_FUNCTION_2000,
  45     DS_DOMAIN_FUNCTION_2003,
  46     DS_DOMAIN_FUNCTION_2003_MIXED,
  47     DS_DOMAIN_FUNCTION_2008,
  48     DS_DOMAIN_FUNCTION_2008_R2,
  49     )
  50
  51
  52
  53 class cmd_domain_export_keytab(Command):
  54     """Dumps kerberos keys of the domain into a keytab"""
  55     synopsis = "%prog domain exportkeytab <keytab>"
  56
  57     takes_options = [
  58         ]
  59
  60     takes_args = ["keytab"]
  61
  62     def run(self, keytab, credopts=None, sambaopts=None, versionopts=None):
  63         lp = sambaopts.get_loadparm()
  64         net = Net(None, lp, server=credopts.ipaddress)
  65         net.export_keytab(keytab=keytab)
  66
  67
  68
  69 class cmd_domain_join(Command):
  70     """Joins domain as either member or backup domain controller [server connection needed]"""
  71
  72     synopsis = "%prog domain join <dnsdomain> [DC | RODC | MEMBER] [options]"
  73
  74     takes_options = [
  75         Option("--server", help="DC to join", type=str),
  76         Option("--site", help="site to join", type=str),
  77         Option("--targetdir", help="where to store provision", type=str),
  78         ]
  79
  80     takes_args = ["domain", "role?"]
  81
  82     def run(self, domain, role=None, sambaopts=None, credopts=None,
  83             versionopts=None, server=None, site=None, targetdir=None):
  84         lp = sambaopts.get_loadparm()
  85         creds = credopts.get_credentials(lp)
  86         net = Net(creds, lp, server=credopts.ipaddress)
  87
  88         if site is None:
  89             site = "Default-First-Site-Name"
  90
  91         netbios_name = lp.get("netbios name")
  92
  93         if not role is None:
  94             role = role.upper()
  95
  96         if role is None or role == "MEMBER":
  97             (join_password, sid, domain_name) = net.join_member(domain,
  98                                                                 netbios_name,
  99                                                                 LIBNET_JOIN_AUTOMATIC)
 100
 101             self.outf.write("Joined domain %s (%s)\n" % (domain_name, sid))
 102             return
 103         elif role == "DC":
 104             join_DC(server=server, creds=creds, lp=lp, domain=domain,
 105                     site=site, netbios_name=netbios_name, targetdir=targetdir)
 106             return
 107         elif role == "RODC":
 108             join_RODC(server=server, creds=creds, lp=lp, domain=domain,
 109                       site=site, netbios_name=netbios_name, targetdir=targetdir)
 110             return
 111         else:
 112             raise CommandError("Invalid role %s (possible values: MEMBER, BDC, RODC)" % role)
 113
 114
 115
 116 class cmd_domain_level(Command):
 117     """Raises domain and forest function levels"""
 118
 119     synopsis = "%prog domain level (show | raise <options>)"
 120
 121     takes_options = [
 122         Option("-H", "--URL", help="LDB URL for database or target server", type=str,
 123                metavar="URL", dest="H"),
 124         Option("--quiet", help="Be quiet", action="store_true"),
 125         Option("--forest", type="choice", choices=["2003", "2008", "2008_R2"],
 126             help="The forest function level (2003 | 2008 | 2008_R2)"),
 127             ]
 128
 129     takes_args = ["subcommand"]
 130
 131     def run(self, subcommand, H=None, forest=None, domain=None, quiet=False,
 132             credopts=None, sambaopts=None, versionopts=None):
 133         lp = sambaopts.get_loadparm()
 134         creds = credopts.get_credentials(lp, fallback_machine=True)
 135
 136         samdb = SamDB(url=H, session_info=system_session(),
 137             credentials=creds, lp=lp)
 138
 139         domain_dn = samdb.domain_dn()
 140
 141         res_forest = samdb.search("CN=Partitions,CN=Configuration," + domain_dn,
 142           scope=ldb.SCOPE_BASE, attrs=["msDS-Behavior-Version"])
 143         assert len(res_forest) == 1
 144
 145         res_domain = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
 146           attrs=["msDS-Behavior-Version", "nTMixedDomain"])
 147         assert len(res_domain) == 1
 148
 149         res_dc_s = samdb.search("CN=Sites,CN=Configuration," + domain_dn,
 150           scope=ldb.SCOPE_SUBTREE, expression="(objectClass=nTDSDSA)",
 151           attrs=["msDS-Behavior-Version"])
 152         assert len(res_dc_s) >= 1
 153
 154         try:
 155             level_forest = int(res_forest[0]["msDS-Behavior-Version"][0])
 156             level_domain = int(res_domain[0]["msDS-Behavior-Version"][0])
 157             level_domain_mixed = int(res_domain[0]["nTMixedDomain"][0])
 158
 159             min_level_dc = int(res_dc_s[0]["msDS-Behavior-Version"][0]) # Init value
 160             for msg in res_dc_s:
 161                 if int(msg["msDS-Behavior-Version"][0]) < min_level_dc:
 162                     min_level_dc = int(msg["msDS-Behavior-Version"][0])
 163
 164             if level_forest < 0 or level_domain < 0:
 165                 raise CommandError("Domain and/or forest function level(s) is/are invalid. Correct them or reprovision!")
 166             if min_level_dc < 0:
 167                 raise CommandError("Lowest function level of a DC is invalid. Correct this or reprovision!")
 168             if level_forest > level_domain:
 169                 raise CommandError("Forest function level is higher than the domain level(s). Correct this or reprovision!")
 170             if level_domain > min_level_dc:
 171                 raise CommandError("Domain function level is higher than the lowest function level of a DC. Correct this or reprovision!")
 172
 173         except KeyError:
 174             raise CommandError("Could not retrieve the actual domain, forest level and/or lowest DC function level!")
 175
 176         if subcommand == "show":
 177             self.message("Domain and forest function level for domain '%s'" % domain_dn)
 178             if level_forest == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 179                 self.message("\nATTENTION: You run SAMBA 4 on a forest function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
 180             if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 181                 self.message("\nATTENTION: You run SAMBA 4 on a domain function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
 182             if min_level_dc == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 183                 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)!")
 184
 185             self.message("")
 186
 187             if level_forest == DS_DOMAIN_FUNCTION_2000:
 188                 outstr = "2000"
 189             elif level_forest == DS_DOMAIN_FUNCTION_2003_MIXED:
 190                 outstr = "2003 with mixed domains/interim (NT4 DC support)"
 191             elif level_forest == DS_DOMAIN_FUNCTION_2003:
 192                 outstr = "2003"
 193             elif level_forest == DS_DOMAIN_FUNCTION_2008:
 194                 outstr = "2008"
 195             elif level_forest == DS_DOMAIN_FUNCTION_2008_R2:
 196                 outstr = "2008 R2"
 197             else:
 198                 outstr = "higher than 2008 R2"
 199             self.message("Forest function level: (Windows) " + outstr)
 200
 201             if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 202                 outstr = "2000 mixed (NT4 DC support)"
 203             elif level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed == 0:
 204                 outstr = "2000"
 205             elif level_domain == DS_DOMAIN_FUNCTION_2003_MIXED:
 206                 outstr = "2003 with mixed domains/interim (NT4 DC support)"
 207             elif level_domain == DS_DOMAIN_FUNCTION_2003:
 208                 outstr = "2003"
 209             elif level_domain == DS_DOMAIN_FUNCTION_2008:
 210                 outstr = "2008"
 211             elif level_domain == DS_DOMAIN_FUNCTION_2008_R2:
 212                 outstr = "2008 R2"
 213             else:
 214                 outstr = "higher than 2008 R2"
 215             self.message("Lowest function level of a DC: (Windows) " + outstr)
 216
 217         elif subcommand == "raise":
 218             msgs = []
 219
 220             if domain is not None:
 221                 if domain == "2003":
 222                     new_level_domain = DS_DOMAIN_FUNCTION_2003
 223                 elif domain == "2008":
 224                     new_level_domain = DS_DOMAIN_FUNCTION_2008
 225                 elif domain == "2008_R2":
 226                     new_level_domain = DS_DOMAIN_FUNCTION_2008_R2
 227
 228                 if new_level_domain <= level_domain and level_domain_mixed == 0:
 229                     raise CommandError("Domain function level can't be smaller equal to the actual one!")
 230
 231                 if new_level_domain > min_level_dc:
 232                     raise CommandError("Domain function level can't be higher than the lowest function level of a DC!")
 233
 234                 # Deactivate mixed/interim domain support
 235                 if level_domain_mixed != 0:
 236                     # Directly on the base DN
 237                     m = ldb.Message()
 238                     m.dn = ldb.Dn(samdb, domain_dn)
 239                     m["nTMixedDomain"] = ldb.MessageElement("0",
 240                       ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
 241                     samdb.modify(m)
 242                     # Under partitions
 243                     m = ldb.Message()
 244                     m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup")
 245                       + ",CN=Partitions,CN=Configuration," + domain_dn)
 246                     m["nTMixedDomain"] = ldb.MessageElement("0",
 247                       ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
 248                     try:
 249                         samdb.modify(m)
 250                     except ldb.LdbError, (enum, emsg):
 251                         if enum != ldb.ERR_UNWILLING_TO_PERFORM:
 252                             raise
 253
 254                 # Directly on the base DN
 255                 m = ldb.Message()
 256                 m.dn = ldb.Dn(samdb, domain_dn)
 257                 m["msDS-Behavior-Version"]= ldb.MessageElement(                                                                                             str(new_level_domain), ldb.FLAG_MOD_REPLACE,
 258                             "msDS-Behavior-Version")
 259                 samdb.modify(m)
 260                 # Under partitions
 261                 m = ldb.Message()
 262                 m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup")
 263                   + ",CN=Partitions,CN=Configuration," + domain_dn)
 264                 m["msDS-Behavior-Version"]= ldb.MessageElement(
 265                   str(new_level_domain), ldb.FLAG_MOD_REPLACE,
 266                           "msDS-Behavior-Version")
 267                 try:
 268                     samdb.modify(m)
 269                 except ldb.LdbError, (enum, emsg):
 270                     if enum != ldb.ERR_UNWILLING_TO_PERFORM:
 271                         raise
 272
 273                 level_domain = new_level_domain
 274                 msgs.append("Domain function level changed!")
 275
 276             if forest is not None:
 277                 if forest == "2003":
 278                     new_level_forest = DS_DOMAIN_FUNCTION_2003
 279                 elif forest == "2008":
 280                     new_level_forest = DS_DOMAIN_FUNCTION_2008
 281                 elif forest == "2008_R2":
 282                     new_level_forest = DS_DOMAIN_FUNCTION_2008_R2
 283                 if new_level_forest <= level_forest:
 284                     raise CommandError("Forest function level can't be smaller equal to the actual one!")
 285                 if new_level_forest > level_domain:
 286                     raise CommandError("Forest function level can't be higher than the domain function level(s). Please raise it/them first!")
 287                 m = ldb.Message()
 288                 m.dn = ldb.Dn(samdb, "CN=Partitions,CN=Configuration,"
 289                   + domain_dn)
 290                 m["msDS-Behavior-Version"]= ldb.MessageElement(
 291                   str(new_level_forest), ldb.FLAG_MOD_REPLACE,
 292                           "msDS-Behavior-Version")
 293                 samdb.modify(m)
 294                 msgs.append("Forest function level changed!")
 295             msgs.append("All changes applied successfully!")
 296             self.message("\n".join(msgs))
 297         else:
 298             raise CommandError("Wrong argument '%s'!" % subcommand)
 299
 300
 301
 302 class cmd_domain_machinepassword(Command):
 303     """Gets a machine password out of our SAM"""
 304
 305     synopsis = "%prog domain machinepassword <accountname>"
 306
 307     takes_args = ["secret"]
 308
 309     def run(self, secret, sambaopts=None, credopts=None, versionopts=None):
 310         lp = sambaopts.get_loadparm()
 311         creds = credopts.get_credentials(lp, fallback_machine=True)
 312         name = lp.get("secrets database")
 313         path = lp.get("private dir")
 314         url = os.path.join(path, name)
 315         if not os.path.exists(url):
 316             raise CommandError("secret database not found at %s " % url)
 317         secretsdb = Ldb(url=url, session_info=system_session(),
 318             credentials=creds, lp=lp)
 319         result = secretsdb.search(attrs=["secret"],
 320             expression="(&(objectclass=primaryDomain)(samaccountname=%s))" % ldb.binary_encode(secret))
 321
 322         if len(result) != 1:
 323             raise CommandError("search returned %d records, expected 1" % len(result))
 324
 325         self.outf.write("%s\n" % result[0]["secret"])
 326
 327
 328
 329 class cmd_domain_passwordsettings(Command):
 330     """Sets password settings
 331
 332     Password complexity, history length, minimum password length, the minimum
 333     and maximum password age) on a Samba4 server.
 334     """
 335
 336     synopsis = "%prog domain passwordsettings (show | set <options>)"
 337
 338     takes_options = [
 339         Option("-H", "--URL", help="LDB URL for database or target server", type=str,
 340                metavar="URL", dest="H"),
 341         Option("--quiet", help="Be quiet", action="store_true"),
 342         Option("--complexity", type="choice", choices=["on","off","default"],
 343           help="The password complexity (on | off | default). Default is 'on'"),
 344         Option("--store-plaintext", type="choice", choices=["on","off","default"],
 345           help="Store plaintext passwords where account have 'store passwords with reversible encryption' set (on | off | default). Default is 'off'"),
 346         Option("--history-length",
 347           help="The password history length (<integer> | default).  Default is 24.", type=str),
 348         Option("--min-pwd-length",
 349           help="The minimum password length (<integer> | default).  Default is 7.", type=str),
 350         Option("--min-pwd-age",
 351           help="The minimum password age (<integer in days> | default).  Default is 1.", type=str),
 352         Option("--max-pwd-age",
 353           help="The maximum password age (<integer in days> | default).  Default is 43.", type=str),
 354           ]
 355
 356     takes_args = ["subcommand"]
 357
 358     def run(self, subcommand, H=None, min_pwd_age=None, max_pwd_age=None,
 359             quiet=False, complexity=None, store_plaintext=None, history_length=None,
 360             min_pwd_length=None, credopts=None, sambaopts=None,
 361             versionopts=None):
 362         lp = sambaopts.get_loadparm()
 363         creds = credopts.get_credentials(lp)
 364
 365         samdb = SamDB(url=H, session_info=system_session(),
 366             credentials=creds, lp=lp)
 367
 368         domain_dn = samdb.domain_dn()
 369         res = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
 370           attrs=["pwdProperties", "pwdHistoryLength", "minPwdLength",
 371                  "minPwdAge", "maxPwdAge"])
 372         assert(len(res) == 1)
 373         try:
 374             pwd_props = int(res[0]["pwdProperties"][0])
 375             pwd_hist_len = int(res[0]["pwdHistoryLength"][0])
 376             cur_min_pwd_len = int(res[0]["minPwdLength"][0])
 377             # ticks -> days
 378             cur_min_pwd_age = int(abs(int(res[0]["minPwdAge"][0])) / (1e7 * 60 * 60 * 24))
 379             cur_max_pwd_age = int(abs(int(res[0]["maxPwdAge"][0])) / (1e7 * 60 * 60 * 24))
 380         except Exception, e:
 381             raise CommandError("Could not retrieve password properties!", e)
 382
 383         if subcommand == "show":
 384             self.message("Password informations for domain '%s'" % domain_dn)
 385             self.message("")
 386             if pwd_props & DOMAIN_PASSWORD_COMPLEX != 0:
 387                 self.message("Password complexity: on")
 388             else:
 389                 self.message("Password complexity: off")
 390             if pwd_props & DOMAIN_PASSWORD_STORE_CLEARTEXT != 0:
 391                 self.message("Store plaintext passwords: on")
 392             else:
 393                 self.message("Store plaintext passwords: off")
 394             self.message("Password history length: %d" % pwd_hist_len)
 395             self.message("Minimum password length: %d" % cur_min_pwd_len)
 396             self.message("Minimum password age (days): %d" % cur_min_pwd_age)
 397             self.message("Maximum password age (days): %d" % cur_max_pwd_age)
 398         elif subcommand == "set":
 399             msgs = []
 400             m = ldb.Message()
 401             m.dn = ldb.Dn(samdb, domain_dn)
 402
 403             if complexity is not None:
 404                 if complexity == "on" or complexity == "default":
 405                     pwd_props = pwd_props | DOMAIN_PASSWORD_COMPLEX
 406                     msgs.append("Password complexity activated!")
 407                 elif complexity == "off":
 408                     pwd_props = pwd_props & (~DOMAIN_PASSWORD_COMPLEX)
 409                     msgs.append("Password complexity deactivated!")
 410
 411             if store_plaintext is not None:
 412                 if store_plaintext == "on" or store_plaintext == "default":
 413                     pwd_props = pwd_props | DOMAIN_PASSWORD_STORE_CLEARTEXT
 414                     msgs.append("Plaintext password storage for changed passwords activated!")
 415                 elif store_plaintext == "off":
 416                     pwd_props = pwd_props & (~DOMAIN_PASSWORD_STORE_CLEARTEXT)
 417                     msgs.append("Plaintext password storage for changed passwords deactivated!")
 418
 419             if complexity is not None or store_plaintext is not None:
 420                 m["pwdProperties"] = ldb.MessageElement(str(pwd_props),
 421                   ldb.FLAG_MOD_REPLACE, "pwdProperties")
 422
 423             if history_length is not None:
 424                 if history_length == "default":
 425                     pwd_hist_len = 24
 426                 else:
 427                     pwd_hist_len = int(history_length)
 428
 429                 if pwd_hist_len < 0 or pwd_hist_len > 24:
 430                     raise CommandError("Password history length must be in the range of 0 to 24!")
 431
 432                 m["pwdHistoryLength"] = ldb.MessageElement(str(pwd_hist_len),
 433                   ldb.FLAG_MOD_REPLACE, "pwdHistoryLength")
 434                 msgs.append("Password history length changed!")
 435
 436             if min_pwd_length is not None:
 437                 if min_pwd_length == "default":
 438                     min_pwd_len = 7
 439                 else:
 440                     min_pwd_len = int(min_pwd_length)
 441
 442                 if min_pwd_len < 0 or min_pwd_len > 14:
 443                     raise CommandError("Minimum password length must be in the range of 0 to 14!")
 444
 445                 m["minPwdLength"] = ldb.MessageElement(str(min_pwd_len),
 446                   ldb.FLAG_MOD_REPLACE, "minPwdLength")
 447                 msgs.append("Minimum password length changed!")
 448
 449             if min_pwd_age is not None:
 450                 if min_pwd_age == "default":
 451                     min_pwd_age = 1
 452                 else:
 453                     min_pwd_age = int(min_pwd_age)
 454
 455                 if min_pwd_age < 0 or min_pwd_age > 998:
 456                     raise CommandError("Minimum password age must be in the range of 0 to 998!")
 457
 458                 # days -> ticks
 459                 min_pwd_age_ticks = -int(min_pwd_age * (24 * 60 * 60 * 1e7))
 460
 461                 m["minPwdAge"] = ldb.MessageElement(str(min_pwd_age_ticks),
 462                   ldb.FLAG_MOD_REPLACE, "minPwdAge")
 463                 msgs.append("Minimum password age changed!")
 464
 465             if max_pwd_age is not None:
 466                 if max_pwd_age == "default":
 467                     max_pwd_age = 43
 468                 else:
 469                     max_pwd_age = int(max_pwd_age)
 470
 471                 if max_pwd_age < 0 or max_pwd_age > 999:
 472                     raise CommandError("Maximum password age must be in the range of 0 to 999!")
 473
 474                 # days -> ticks
 475                 max_pwd_age_ticks = -int(max_pwd_age * (24 * 60 * 60 * 1e7))
 476
 477                 m["maxPwdAge"] = ldb.MessageElement(str(max_pwd_age_ticks),
 478                   ldb.FLAG_MOD_REPLACE, "maxPwdAge")
 479                 msgs.append("Maximum password age changed!")
 480
 481             if max_pwd_age > 0 and min_pwd_age >= max_pwd_age:
 482                 raise CommandError("Maximum password age (%d) must be greater than minimum password age (%d)!" % (max_pwd_age, min_pwd_age))
 483
 484             if len(m) == 0:
 485                 raise CommandError("You must specify at least one option to set. Try --help")
 486             samdb.modify(m)
 487             msgs.append("All changes applied successfully!")
 488             self.message("\n".join(msgs))
 489         else:
 490             raise CommandError("Wrong argument '%s'!" % subcommand)
 491
 492
 493
 494 class cmd_domain(SuperCommand):
 495     """Domain management"""
 496
 497     subcommands = {}
 498     subcommands["exportkeytab"] = cmd_domain_export_keytab()
 499     subcommands["join"] = cmd_domain_join()
 500     subcommands["level"] = cmd_domain_level()
 501     subcommands["machinepassword"] = cmd_domain_machinepassword()
 502     subcommands["passwordsettings"] = cmd_domain_passwordsettings()