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", help="LDB URL for database or target server", type=str),
 123         Option("--quiet", help="Be quiet", action="store_true"),
 124         Option("--forest", type="choice", choices=["2003", "2008", "2008_R2"],
 125             help="The forest function level (2003 | 2008 | 2008_R2)"),
 126             ]
 127
 128     takes_args = ["subcommand"]
 129
 130     def run(self, subcommand, H=None, forest=None, domain=None, quiet=False,
 131             credopts=None, sambaopts=None, versionopts=None):
 132         lp = sambaopts.get_loadparm()
 133         creds = credopts.get_credentials(lp, fallback_machine=True)
 134
 135         samdb = SamDB(url=H, session_info=system_session(),
 136             credentials=creds, lp=lp)
 137
 138         domain_dn = samdb.domain_dn()
 139
 140         res_forest = samdb.search("CN=Partitions,CN=Configuration," + domain_dn,
 141           scope=ldb.SCOPE_BASE, attrs=["msDS-Behavior-Version"])
 142         assert len(res_forest) == 1
 143
 144         res_domain = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
 145           attrs=["msDS-Behavior-Version", "nTMixedDomain"])
 146         assert len(res_domain) == 1
 147
 148         res_dc_s = samdb.search("CN=Sites,CN=Configuration," + domain_dn,
 149           scope=ldb.SCOPE_SUBTREE, expression="(objectClass=nTDSDSA)",
 150           attrs=["msDS-Behavior-Version"])
 151         assert len(res_dc_s) >= 1
 152
 153         try:
 154             level_forest = int(res_forest[0]["msDS-Behavior-Version"][0])
 155             level_domain = int(res_domain[0]["msDS-Behavior-Version"][0])
 156             level_domain_mixed = int(res_domain[0]["nTMixedDomain"][0])
 157
 158             min_level_dc = int(res_dc_s[0]["msDS-Behavior-Version"][0]) # Init value
 159             for msg in res_dc_s:
 160                 if int(msg["msDS-Behavior-Version"][0]) < min_level_dc:
 161                     min_level_dc = int(msg["msDS-Behavior-Version"][0])
 162
 163             if level_forest < 0 or level_domain < 0:
 164                 raise CommandError("Domain and/or forest function level(s) is/are invalid. Correct them or reprovision!")
 165             if min_level_dc < 0:
 166                 raise CommandError("Lowest function level of a DC is invalid. Correct this or reprovision!")
 167             if level_forest > level_domain:
 168                 raise CommandError("Forest function level is higher than the domain level(s). Correct this or reprovision!")
 169             if level_domain > min_level_dc:
 170                 raise CommandError("Domain function level is higher than the lowest function level of a DC. Correct this or reprovision!")
 171
 172         except KeyError:
 173             raise CommandError("Could not retrieve the actual domain, forest level and/or lowest DC function level!")
 174
 175         if subcommand == "show":
 176             self.message("Domain and forest function level for domain '%s'" % domain_dn)
 177             if level_forest == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 178                 self.message("\nATTENTION: You run SAMBA 4 on a forest function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
 179             if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 180                 self.message("\nATTENTION: You run SAMBA 4 on a domain function level lower than Windows 2000 (Native). This isn't supported! Please raise!")
 181             if min_level_dc == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 182                 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)!")
 183
 184             self.message("")
 185
 186             if level_forest == DS_DOMAIN_FUNCTION_2000:
 187                 outstr = "2000"
 188             elif level_forest == DS_DOMAIN_FUNCTION_2003_MIXED:
 189                 outstr = "2003 with mixed domains/interim (NT4 DC support)"
 190             elif level_forest == DS_DOMAIN_FUNCTION_2003:
 191                 outstr = "2003"
 192             elif level_forest == DS_DOMAIN_FUNCTION_2008:
 193                 outstr = "2008"
 194             elif level_forest == DS_DOMAIN_FUNCTION_2008_R2:
 195                 outstr = "2008 R2"
 196             else:
 197                 outstr = "higher than 2008 R2"
 198             self.message("Forest function level: (Windows) " + outstr)
 199
 200             if level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed != 0:
 201                 outstr = "2000 mixed (NT4 DC support)"
 202             elif level_domain == DS_DOMAIN_FUNCTION_2000 and level_domain_mixed == 0:
 203                 outstr = "2000"
 204             elif level_domain == DS_DOMAIN_FUNCTION_2003_MIXED:
 205                 outstr = "2003 with mixed domains/interim (NT4 DC support)"
 206             elif level_domain == DS_DOMAIN_FUNCTION_2003:
 207                 outstr = "2003"
 208             elif level_domain == DS_DOMAIN_FUNCTION_2008:
 209                 outstr = "2008"
 210             elif level_domain == DS_DOMAIN_FUNCTION_2008_R2:
 211                 outstr = "2008 R2"
 212             else:
 213                 outstr = "higher than 2008 R2"
 214             self.message("Lowest function level of a DC: (Windows) " + outstr)
 215
 216         elif subcommand == "raise":
 217             msgs = []
 218
 219             if domain is not None:
 220                 if domain == "2003":
 221                     new_level_domain = DS_DOMAIN_FUNCTION_2003
 222                 elif domain == "2008":
 223                     new_level_domain = DS_DOMAIN_FUNCTION_2008
 224                 elif domain == "2008_R2":
 225                     new_level_domain = DS_DOMAIN_FUNCTION_2008_R2
 226
 227                 if new_level_domain <= level_domain and level_domain_mixed == 0:
 228                     raise CommandError("Domain function level can't be smaller equal to the actual one!")
 229
 230                 if new_level_domain > min_level_dc:
 231                     raise CommandError("Domain function level can't be higher than the lowest function level of a DC!")
 232
 233                 # Deactivate mixed/interim domain support
 234                 if level_domain_mixed != 0:
 235                     # Directly on the base DN
 236                     m = ldb.Message()
 237                     m.dn = ldb.Dn(samdb, domain_dn)
 238                     m["nTMixedDomain"] = ldb.MessageElement("0",
 239                       ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
 240                     samdb.modify(m)
 241                     # Under partitions
 242                     m = ldb.Message()
 243                     m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup")
 244                       + ",CN=Partitions,CN=Configuration," + domain_dn)
 245                     m["nTMixedDomain"] = ldb.MessageElement("0",
 246                       ldb.FLAG_MOD_REPLACE, "nTMixedDomain")
 247                     try:
 248                         samdb.modify(m)
 249                     except ldb.LdbError, (enum, emsg):
 250                         if enum != ldb.ERR_UNWILLING_TO_PERFORM:
 251                             raise
 252
 253                 # Directly on the base DN
 254                 m = ldb.Message()
 255                 m.dn = ldb.Dn(samdb, domain_dn)
 256                 m["msDS-Behavior-Version"]= ldb.MessageElement(                                                                                             str(new_level_domain), ldb.FLAG_MOD_REPLACE,
 257                             "msDS-Behavior-Version")
 258                 samdb.modify(m)
 259                 # Under partitions
 260                 m = ldb.Message()
 261                 m.dn = ldb.Dn(samdb, "CN=" + lp.get("workgroup")
 262                   + ",CN=Partitions,CN=Configuration," + domain_dn)
 263                 m["msDS-Behavior-Version"]= ldb.MessageElement(
 264                   str(new_level_domain), ldb.FLAG_MOD_REPLACE,
 265                           "msDS-Behavior-Version")
 266                 try:
 267                     samdb.modify(m)
 268                 except ldb.LdbError, (enum, emsg):
 269                     if enum != ldb.ERR_UNWILLING_TO_PERFORM:
 270                         raise
 271
 272                 level_domain = new_level_domain
 273                 msgs.append("Domain function level changed!")
 274
 275             if forest is not None:
 276                 if forest == "2003":
 277                     new_level_forest = DS_DOMAIN_FUNCTION_2003
 278                 elif forest == "2008":
 279                     new_level_forest = DS_DOMAIN_FUNCTION_2008
 280                 elif forest == "2008_R2":
 281                     new_level_forest = DS_DOMAIN_FUNCTION_2008_R2
 282                 if new_level_forest <= level_forest:
 283                     raise CommandError("Forest function level can't be smaller equal to the actual one!")
 284                 if new_level_forest > level_domain:
 285                     raise CommandError("Forest function level can't be higher than the domain function level(s). Please raise it/them first!")
 286                 m = ldb.Message()
 287                 m.dn = ldb.Dn(samdb, "CN=Partitions,CN=Configuration,"
 288                   + domain_dn)
 289                 m["msDS-Behavior-Version"]= ldb.MessageElement(
 290                   str(new_level_forest), ldb.FLAG_MOD_REPLACE,
 291                           "msDS-Behavior-Version")
 292                 samdb.modify(m)
 293                 msgs.append("Forest function level changed!")
 294             msgs.append("All changes applied successfully!")
 295             self.message("\n".join(msgs))
 296         else:
 297             raise CommandError("Wrong argument '%s'!" % subcommand)
 298
 299
 300
 301 class cmd_domain_machinepassword(Command):
 302     """Gets a machine password out of our SAM"""
 303
 304     synopsis = "%prog domain machinepassword <accountname>"
 305
 306     takes_args = ["secret"]
 307
 308     def run(self, secret, sambaopts=None, credopts=None, versionopts=None):
 309         lp = sambaopts.get_loadparm()
 310         creds = credopts.get_credentials(lp, fallback_machine=True)
 311         name = lp.get("secrets database")
 312         path = lp.get("private dir")
 313         url = os.path.join(path, name)
 314         if not os.path.exists(url):
 315             raise CommandError("secret database not found at %s " % url)
 316         secretsdb = Ldb(url=url, session_info=system_session(),
 317             credentials=creds, lp=lp)
 318         result = secretsdb.search(attrs=["secret"],
 319             expression="(&(objectclass=primaryDomain)(samaccountname=%s))" % secret)
 320
 321         if len(result) != 1:
 322             raise CommandError("search returned %d records, expected 1" % len(result))
 323
 324         self.outf.write("%s\n" % result[0]["secret"])
 325
 326
 327
 328 class cmd_domain_passwordsettings(Command):
 329     """Sets password settings
 330
 331     Password complexity, history length, minimum password length, the minimum
 332     and maximum password age) on a Samba4 server.
 333     """
 334
 335     synopsis = "%prog domain passwordsettings (show | set <options>)"
 336
 337     takes_options = [
 338         Option("-H", help="LDB URL for database or target server", type=str),
 339         Option("--quiet", help="Be quiet", action="store_true"),
 340         Option("--complexity", type="choice", choices=["on","off","default"],
 341           help="The password complexity (on | off | default). Default is 'on'"),
 342         Option("--store-plaintext", type="choice", choices=["on","off","default"],
 343           help="Store plaintext passwords where account have 'store passwords with reversible encryption' set (on | off | default). Default is 'off'"),
 344         Option("--history-length",
 345           help="The password history length (<integer> | default).  Default is 24.", type=str),
 346         Option("--min-pwd-length",
 347           help="The minimum password length (<integer> | default).  Default is 7.", type=str),
 348         Option("--min-pwd-age",
 349           help="The minimum password age (<integer in days> | default).  Default is 1.", type=str),
 350         Option("--max-pwd-age",
 351           help="The maximum password age (<integer in days> | default).  Default is 43.", type=str),
 352           ]
 353
 354     takes_args = ["subcommand"]
 355
 356     def run(self, subcommand, H=None, min_pwd_age=None, max_pwd_age=None,
 357             quiet=False, complexity=None, store_plaintext=None, history_length=None,
 358             min_pwd_length=None, credopts=None, sambaopts=None,
 359             versionopts=None):
 360         lp = sambaopts.get_loadparm()
 361         creds = credopts.get_credentials(lp)
 362
 363         samdb = SamDB(url=H, session_info=system_session(),
 364             credentials=creds, lp=lp)
 365
 366         domain_dn = samdb.domain_dn()
 367         res = samdb.search(domain_dn, scope=ldb.SCOPE_BASE,
 368           attrs=["pwdProperties", "pwdHistoryLength", "minPwdLength",
 369                  "minPwdAge", "maxPwdAge"])
 370         assert(len(res) == 1)
 371         try:
 372             pwd_props = int(res[0]["pwdProperties"][0])
 373             pwd_hist_len = int(res[0]["pwdHistoryLength"][0])
 374             cur_min_pwd_len = int(res[0]["minPwdLength"][0])
 375             # ticks -> days
 376             cur_min_pwd_age = int(abs(int(res[0]["minPwdAge"][0])) / (1e7 * 60 * 60 * 24))
 377             cur_max_pwd_age = int(abs(int(res[0]["maxPwdAge"][0])) / (1e7 * 60 * 60 * 24))
 378         except Exception, e:
 379             raise CommandError("Could not retrieve password properties!", e)
 380
 381         if subcommand == "show":
 382             self.message("Password informations for domain '%s'" % domain_dn)
 383             self.message("")
 384             if pwd_props & DOMAIN_PASSWORD_COMPLEX != 0:
 385                 self.message("Password complexity: on")
 386             else:
 387                 self.message("Password complexity: off")
 388             if pwd_props & DOMAIN_PASSWORD_STORE_CLEARTEXT != 0:
 389                 self.message("Store plaintext passwords: on")
 390             else:
 391                 self.message("Store plaintext passwords: off")
 392             self.message("Password history length: %d" % pwd_hist_len)
 393             self.message("Minimum password length: %d" % cur_min_pwd_len)
 394             self.message("Minimum password age (days): %d" % cur_min_pwd_age)
 395             self.message("Maximum password age (days): %d" % cur_max_pwd_age)
 396         elif subcommand == "set":
 397             msgs = []
 398             m = ldb.Message()
 399             m.dn = ldb.Dn(samdb, domain_dn)
 400
 401             if complexity is not None:
 402                 if complexity == "on" or complexity == "default":
 403                     pwd_props = pwd_props | DOMAIN_PASSWORD_COMPLEX
 404                     msgs.append("Password complexity activated!")
 405                 elif complexity == "off":
 406                     pwd_props = pwd_props & (~DOMAIN_PASSWORD_COMPLEX)
 407                     msgs.append("Password complexity deactivated!")
 408
 409             if store_plaintext is not None:
 410                 if store_plaintext == "on" or store_plaintext == "default":
 411                     pwd_props = pwd_props | DOMAIN_PASSWORD_STORE_CLEARTEXT
 412                     msgs.append("Plaintext password storage for changed passwords activated!")
 413                 elif store_plaintext == "off":
 414                     pwd_props = pwd_props & (~DOMAIN_PASSWORD_STORE_CLEARTEXT)
 415                     msgs.append("Plaintext password storage for changed passwords deactivated!")
 416
 417             if complexity is not None or store_plaintext is not None:
 418                 m["pwdProperties"] = ldb.MessageElement(str(pwd_props),
 419                   ldb.FLAG_MOD_REPLACE, "pwdProperties")
 420
 421             if history_length is not None:
 422                 if history_length == "default":
 423                     pwd_hist_len = 24
 424                 else:
 425                     pwd_hist_len = int(history_length)
 426
 427                 if pwd_hist_len < 0 or pwd_hist_len > 24:
 428                     raise CommandError("Password history length must be in the range of 0 to 24!")
 429
 430                 m["pwdHistoryLength"] = ldb.MessageElement(str(pwd_hist_len),
 431                   ldb.FLAG_MOD_REPLACE, "pwdHistoryLength")
 432                 msgs.append("Password history length changed!")
 433
 434             if min_pwd_length is not None:
 435                 if min_pwd_length == "default":
 436                     min_pwd_len = 7
 437                 else:
 438                     min_pwd_len = int(min_pwd_length)
 439
 440                 if min_pwd_len < 0 or min_pwd_len > 14:
 441                     raise CommandError("Minimum password length must be in the range of 0 to 14!")
 442
 443                 m["minPwdLength"] = ldb.MessageElement(str(min_pwd_len),
 444                   ldb.FLAG_MOD_REPLACE, "minPwdLength")
 445                 msgs.append("Minimum password length changed!")
 446
 447             if min_pwd_age is not None:
 448                 if min_pwd_age == "default":
 449                     min_pwd_age = 1
 450                 else:
 451                     min_pwd_age = int(min_pwd_age)
 452
 453                 if min_pwd_age < 0 or min_pwd_age > 998:
 454                     raise CommandError("Minimum password age must be in the range of 0 to 998!")
 455
 456                 # days -> ticks
 457                 min_pwd_age_ticks = -int(min_pwd_age * (24 * 60 * 60 * 1e7))
 458
 459                 m["minPwdAge"] = ldb.MessageElement(str(min_pwd_age_ticks),
 460                   ldb.FLAG_MOD_REPLACE, "minPwdAge")
 461                 msgs.append("Minimum password age changed!")
 462
 463             if max_pwd_age is not None:
 464                 if max_pwd_age == "default":
 465                     max_pwd_age = 43
 466                 else:
 467                     max_pwd_age = int(max_pwd_age)
 468
 469                 if max_pwd_age < 0 or max_pwd_age > 999:
 470                     raise CommandError("Maximum password age must be in the range of 0 to 999!")
 471
 472                 # days -> ticks
 473                 max_pwd_age_ticks = -int(max_pwd_age * (24 * 60 * 60 * 1e7))
 474
 475                 m["maxPwdAge"] = ldb.MessageElement(str(max_pwd_age_ticks),
 476                   ldb.FLAG_MOD_REPLACE, "maxPwdAge")
 477                 msgs.append("Maximum password age changed!")
 478
 479             if max_pwd_age > 0 and min_pwd_age >= max_pwd_age:
 480                 raise CommandError("Maximum password age (%d) must be greater than minimum password age (%d)!" % (max_pwd_age, min_pwd_age))
 481
 482             samdb.modify(m)
 483             msgs.append("All changes applied successfully!")
 484             self.message("\n".join(msgs))
 485         else:
 486             raise CommandError("Wrong argument '%s'!" % subcommand)
 487
 488
 489
 490 class cmd_domain(SuperCommand):
 491     """Domain management"""
 492
 493     subcommands = {}
 494     subcommands["exportkeytab"] = cmd_domain_export_keytab()
 495     subcommands["join"] = cmd_domain_join()
 496     subcommands["level"] = cmd_domain_level()
 497     subcommands["machinepassword"] = cmd_domain_machinepassword()
 498     subcommands["passwordsettings"] = cmd_domain_passwordsettings()