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