--- /dev/null
+# Samba4 Forest update checker
+#
+# Copyright (C) Andrew Bartlett <abarlet@samba.org> 2017
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+import re
+import ldb
+import samba
+import time
+from base64 import b64decode
+from samba import dsdb
+from samba import common
+from samba import sd_utils
+from samba.dcerpc import misc
+from samba.dcerpc import drsuapi
+from samba.ndr import ndr_unpack, ndr_pack
+from samba.dcerpc import drsblobs
+from samba.common import dsdb_Dn
+from samba.dcerpc import security
+from samba.dcerpc.security import SECINFO_DACL
+from samba.descriptor import get_wellknown_sds, get_diff_sds
+from samba.auth import system_session, admin_session
+from samba.netcmd import CommandError
+from samba.netcmd.fsmo import get_fsmo_roleowner
+from samba.provision.common import setup_path
+from samba.dsdb import (
+ DS_DOMAIN_FUNCTION_2008,
+ DS_DOMAIN_FUNCTION_2008_R2,
+ DS_DOMAIN_FUNCTION_2012,
+ DS_DOMAIN_FUNCTION_2012_R2,
+ DS_DOMAIN_FUNCTION_2016,
+)
+
+MIN_UPDATE = 45
+MAX_UPDATE = 135
+
+update_map = {
+ # Windows Server 2012 - version 11
+ 84: "4664e973-cb20-4def-b3d5-559d6fe123e0",
+ 85: "2972d92d-a07a-44ac-9cb0-bf243356f345",
+ 86: "09a49cb3-6c54-4b83-ab20-8370838ba149",
+ 87: "77283e65-ce02-4dc3-8c1e-bf99b22527c2",
+ 88: "0afb7f53-96bd-404b-a659-89e65c269420",
+ 89: "c7f717ef-fdbe-4b4b-8dfc-fa8b839fbcfa",
+ 90: "00232167-f3a4-43c6-b503-9acb7a81b01c",
+ 91: "73a9515b-511c-44d2-822b-444a33d3bd33",
+ 92: "e0c60003-2ed7-4fd3-8659-7655a7e79397",
+ 93: "ed0c8cca-80ab-4b6b-ac5a-59b1d317e11f",
+ 94: "b6a6c19a-afc9-476b-8994-61f5b14b3f05",
+ 95: "defc28cd-6cb6-4479-8bcb-aabfb41e9713",
+ 96: "d6bd96d4-e66b-4a38-9c6b-e976ff58c56d",
+ 97: "bb8efc40-3090-4fa2-8a3f-7cd1d380e695",
+ 98: "2d6abe1b-4326-489e-920c-76d5337d2dc5",
+ 99: "6b13dfb5-cecc-4fb8-b28d-0505cea24175",
+ 100: "92e73422-c68b-46c9-b0d5-b55f9c741410",
+ 101: "c0ad80b4-8e84-4cc4-9163-2f84649bcc42",
+ 102: "992fe1d0-6591-4f24-a163-c820fcb7f308",
+ 103: "ede85f96-7061-47bf-b11b-0c0d999595b5",
+ 104: "ee0f3271-eb51-414a-bdac-8f9ba6397a39",
+ 105: "587d52e0-507e-440e-9d67-e6129f33bb68",
+ 106: "ce24f0f6-237e-43d6-ac04-1e918ab04aac",
+ 107: "7f77d431-dd6a-434f-ae4d-ce82928e498f",
+ 108: "ba14e1f6-7cd1-4739-804f-57d0ea74edf4",
+ 109: "156ffa2a-e07c-46fb-a5c4-fbd84a4e5cce",
+ 110: "7771d7dd-2231-4470-aa74-84a6f56fc3b6",
+ 111: "49b2ae86-839a-4ea0-81fe-9171c1b98e83",
+ 112: "1b1de989-57ec-4e96-b933-8279a8119da4",
+ 113: "281c63f0-2c9a-4cce-9256-a238c23c0db9",
+ 114: "4c47881a-f15a-4f6c-9f49-2742f7a11f4b",
+ 115: "2aea2dc6-d1d3-4f0c-9994-66c1da21de0f",
+ 116: "ae78240c-43b9-499e-ae65-2b6e0f0e202a",
+ 117: "261b5bba-3438-4d5c-a3e9-7b871e5f57f0",
+ 118: "3fb79c05-8ea1-438c-8c7a-81f213aa61c2",
+ 119: "0b2be39a-d463-4c23-8290-32186759d3b1",
+ 120: "f0842b44-bc03-46a1-a860-006e8527fccd",
+ 121: "93efec15-4dd9-4850-bc86-a1f2c8e2ebb9",
+ 122: "9e108d96-672f-40f0-b6bd-69ee1f0b7ac4",
+ 123: "1e269508-f862-4c4a-b01f-420d26c4ff8c",
+ 125: "e1ab17ed-5efb-4691-ad2d-0424592c5755",
+ 126: "0e848bd4-7c70-48f2-b8fc-00fbaa82e360",
+ 127: "016f23f7-077d-41fa-a356-de7cfdb01797",
+ 128: "49c140db-2de3-44c2-a99a-bab2e6d2ba81",
+ 129: "e0b11c80-62c5-47f7-ad0d-3734a71b8312",
+ 130: "2ada1a2d-b02f-4731-b4fe-59f955e24f71",
+ # Windows Server 2012 R2 - version 15
+ 131: "b83818c1-01a6-4f39-91b7-a3bb581c3ae3",
+ 132: "bbbb9db0-4009-4368-8c40-6674e980d3c3",
+ 133: "f754861c-3692-4a7b-b2c2-d0fa28ed0b0b",
+ 134: "d32f499f-3026-4af0-a5bd-13fe5a331bd2",
+ 135: "38618886-98ee-4e42-8cf1-d9a2cd9edf8b",
+ # Windows Server 2016 - version 16
+ 136: "328092FB-16E7-4453-9AB8-7592DB56E9C4",
+ 137: "3A1C887F-DF0A-489F-B3F2-2D0409095F6E",
+ 138: "232E831F-F988-4444-8E3E-8A352E2FD411",
+ 139: "DDDDCF0C-BEC9-4A5A-AE86-3CFE6CC6E110",
+ 140: "A0A45AAC-5550-42DF-BB6A-3CC5C46B52F2",
+ 141: "3E7645F3-3EA5-4567-B35A-87630449C70C",
+ 142: "E634067B-E2C4-4D79-B6E8-73C619324D5E"
+}
+
+functional_level_to_max_update = {
+ DS_DOMAIN_FUNCTION_2008: 78,
+ DS_DOMAIN_FUNCTION_2008_R2: 83,
+ DS_DOMAIN_FUNCTION_2012: 130,
+ DS_DOMAIN_FUNCTION_2012_R2: 135,
+ DS_DOMAIN_FUNCTION_2016: 142,
+}
+
+functional_level_to_version = {
+ DS_DOMAIN_FUNCTION_2008: 2,
+ DS_DOMAIN_FUNCTION_2008_R2: 5,
+ DS_DOMAIN_FUNCTION_2012: 11,
+ DS_DOMAIN_FUNCTION_2012_R2: 15,
+ DS_DOMAIN_FUNCTION_2016: 16,
+}
+
+# Documentation says that this update was deprecated
+missing_updates = [124]
+
+
+class ForestUpdateException(Exception):
+ pass
+
+
+class ForestUpdate(object):
+ """Check and update a SAM database for forest updates"""
+
+ def __init__(self, samdb, verbose=False, fix=False,
+ add_update_container=True):
+ """
+ :param samdb: LDB database
+ :param verbose: Show the ldif changes
+ :param fix: Apply the update if the container is missing
+ :param add_update_container: Add the container at the end of the change
+ :raise ForestUpdateException:
+ """
+ from samba.ms_forest_updates_markdown import read_ms_markdown
+
+ self.samdb = samdb
+ self.fix = fix
+ self.verbose = verbose
+ self.add_update_container = add_update_container
+ # TODO In future we should check for inconsistencies when it claims it has been done
+ self.check_update_applied = False
+
+ self.config_dn = self.samdb.get_config_basedn()
+ self.domain_dn = self.samdb.domain_dn()
+ self.schema_dn = self.samdb.get_schema_basedn()
+
+ self.sd_utils = sd_utils.SDUtils(samdb)
+ self.domain_sid = security.dom_sid(samdb.get_domain_sid())
+
+ self.forestupdate_container = self.samdb.get_config_basedn()
+ if not self.forestupdate_container.add_child("CN=Operations,CN=ForestUpdates"):
+ raise ForestUpdateException("Failed to add forest update container child")
+
+ self.revision_object = self.samdb.get_config_basedn()
+ if not self.revision_object.add_child("CN=ActiveDirectoryUpdate,CN=ForestUpdates"):
+ raise ForestUpdateException("Failed to add revision object child")
+
+ # Store the result of parsing the markdown in a dictionary
+ self.stored_ldif = {}
+ read_ms_markdown(setup_path("adprep/WindowsServerDocs/Forest-Wide-Updates.md"),
+ out_dict=self.stored_ldif)
+
+ def check_updates_functional_level(self, functional_level,
+ old_functional_level=None,
+ update_revision=False):
+ """
+ Apply all updates for a given old and new functional level
+ :param functional_level: constant
+ :param old_functional_level: constant
+ :param update_revision: modify the stored version
+ :raise ForestUpdateException:
+ """
+ res = self.samdb.search(base=self.revision_object,
+ attrs=["revision"], scope=ldb.SCOPE_BASE)
+
+ expected_update = functional_level_to_max_update[functional_level]
+
+ if old_functional_level:
+ min_update = functional_level_to_max_update[old_functional_level]
+ min_update += 1
+ else:
+ min_update = MIN_UPDATE
+
+ self.check_updates_range(min_update, expected_update)
+
+ expected_version = functional_level_to_version[functional_level]
+ found_version = int(res[0]['revision'][0])
+ if update_revision and found_version < expected_version:
+ if not self.fix:
+ raise ForestUpdateException("Revision is not high enough. Fix is set to False."
+ "\nExpected: %dGot: %d" % (expected_version,
+ found_version))
+ self.samdb.modify_ldif("""dn: %s
+changetype: modify
+replace: revision
+revision: %d
+ """ % (str(self.revision_object), expected_version))
+
+ def check_updates_iterator(self, iterator):
+ """
+ Apply a list of updates which must be within the valid range of updates
+ :param iterator: Iterable specifying integer update numbers to apply
+ :raise ForestUpdateException:
+ """
+ for op in iterator:
+ if op < MIN_UPDATE or op > MAX_UPDATE:
+ raise ForestUpdateException("Update number invalid.")
+
+ if 84 <= op <= 87:
+ self.operation_ldif(op)
+ elif 91 <= op <= 126:
+ self.operation_ldif(op)
+ elif 131 <= op <= 134:
+ self.operation_ldif(op)
+ else:
+ # No LDIF file exists for the change
+ getattr(self, "operation_%d" % op)(op)
+
+ def check_updates_range(self, start=0, end=0):
+ """
+ Apply a range of updates which must be within the valid range of updates
+ :param start: integer update to begin
+ :param end: integer update to end (inclusive)
+ :raise ForestUpdateException:
+ """
+ op = start
+ if start < MIN_UPDATE or start > end or end > MAX_UPDATE:
+ raise ForestUpdateException("Update number invalid.")
+ while op <= end:
+ if op in missing_updates:
+ pass
+ elif 84 <= op <= 87:
+ self.operation_ldif(op)
+ elif 91 <= op <= 126:
+ self.operation_ldif(op)
+ elif 131 <= op <= 134:
+ self.operation_ldif(op)
+ else:
+ # No LDIF file exists for the change
+ getattr(self, "operation_%d" % op)(op)
+
+ op += 1
+
+ def update_exists(self, op):
+ """
+ :param op: Integer update number
+ :return: True if update exists else False
+ """
+ try:
+ res = self.samdb.search(base=self.forestupdate_container,
+ expression="(CN=%s)" % update_map[op])
+ except ldb.LdbError:
+ return False
+
+ return len(res) == 1
+
+ def update_add(self, op):
+ """
+ Add the corresponding container object for the given update
+ :param op: Integer update
+ """
+ self.samdb.add_ldif("""dn: CN=%s,%s
+objectClass: container
+""" % (update_map[op], str(self.forestupdate_container)))
+
+ def operation_ldif(self, op):
+ if self.update_exists(op):
+ # Assume we have applied it (we have no double checks for these)
+ return True
+
+ ldif = self.stored_ldif[update_map[op]]
+
+ sub_ldif = samba.substitute_var(ldif, {"CONFIG_DN":
+ str(self.config_dn),
+ "FOREST_ROOT_DOMAIN":
+ str(self.domain_dn),
+ "SCHEMA_DN":
+ str(self.schema_dn)})
+ if self.verbose:
+ print "UPDATE (LDIF) ------ OPERATION %d" % op
+ print sub_ldif
+
+ self.samdb.modify_ldif(sub_ldif)
+ if self.add_update_container:
+ self.update_add(op)
+
+ def insert_ace_into_dacl(self, dn, existing_sddl, ace):
+ """
+ Add an ACE to a DACL, checking if it already exists with a simple string search.
+
+ :param dn: DN to modify
+ :param existing_sddl: existing sddl as string
+ :param ace: string ace to insert
+ :return: True if modified else False
+ """
+ index = existing_sddl.rfind("S:")
+ if index != -1:
+ new_sddl = existing_sddl[:index] + ace + existing_sddl[index:]
+ else:
+ # Insert it at the end if no S: section
+ new_sddl = existing_sddl + ace
+
+ if ace in existing_sddl:
+ return False
+
+ self.sd_utils.modify_sd_on_dn(dn, new_sddl,
+ controls=["sd_flags:1:%d" % SECINFO_DACL])
+
+ return True
+
+ def insert_ace_into_string(self, dn, ace, attr):
+ """
+ Insert an ACE into a string attribute like defaultSecurityDescriptor.
+ This also checks if it already exists using a simple string search.
+
+ :param dn: DN to modify
+ :param ace: string ace to insert
+ :param attr: attribute to modify
+ :return: True if modified else False
+ """
+ msg = self.samdb.search(base=dn,
+ attrs=[attr],
+ controls=["search_options:1:2"])
+
+ assert len(msg) == 1
+ existing_sddl = msg[0][attr][0]
+ index = existing_sddl.rfind("S:")
+ if index != -1:
+ new_sddl = existing_sddl[:index] + ace + existing_sddl[index:]
+ else:
+ # Insert it at the end if no S: section
+ new_sddl = existing_sddl + ace
+
+ if ace in existing_sddl:
+ return False
+
+ m = ldb.Message()
+ m.dn = dn
+ m[attr] = ldb.MessageElement(new_sddl, ldb.FLAG_MOD_REPLACE,
+ attr)
+
+ self.samdb.modify(m, controls=["relax:0"])
+
+ return True
+
+ def raise_if_not_fix(self, op):
+ """
+ Raises an exception if not set to fix.
+ :param op: Integer operation
+ :raise ForestUpdateException:
+ """
+ if not self.fix:
+ raise ForestUpdateException("Missing operation %d. Fix is currently set to False" % op)
+
+ #
+ # Created a new object CN=Sam-Domain in the Schema partition
+ #
+ # Created the following access control entry (ACE) to grant Write Property
+ # to Principal Self on the object: ...
+ #
+ def operation_88(self, op):
+ if self.update_exists(op):
+ return
+ self.raise_if_not_fix(op)
+
+ ace = "(OA;CIIO;WP;ea1b7b93-5e48-46d5-bc6c-4df4fda78a35;bf967a86-0de6-11d0-a285-00aa003049e2;PS)"
+
+ schema_dn = ldb.Dn(self.samdb, "CN=Sam-Domain,%s" % str(self.schema_dn))
+
+ self.insert_ace_into_string(schema_dn, ace,
+ attr="defaultSecurityDescriptor")
+
+ res = self.samdb.search(expression="(objectClass=samDomain)",
+ attrs=["nTSecurityDescriptor"],
+ controls=["search_options:1:2"])
+ for msg in res:
+ existing_sd = ndr_unpack(security.descriptor, msg["nTSecurityDescriptor"][0])
+ existing_sddl = existing_sd.as_sddl(self.domain_sid)
+
+ self.insert_ace_into_dacl(msg.dn, existing_sddl, ace)
+
+ if self.add_update_container:
+ self.update_add(op)
+
+ #
+ # Created a new object CN=Domain-DNS in the Schema partition
+ #
+ # Created the following access control entry (ACE) to grant Write Property
+ # to Principal Self on the object: ...
+ #
+ def operation_89(self, op):
+ if self.update_exists(op):
+ return
+ self.raise_if_not_fix(op)
+
+ ace = "(OA;CIIO;WP;ea1b7b93-5e48-46d5-bc6c-4df4fda78a35;bf967a86-0de6-11d0-a285-00aa003049e2;PS)"
+
+ schema_dn = ldb.Dn(self.samdb, "CN=Domain-DNS,%s" % str(self.schema_dn))
+ self.insert_ace_into_string(schema_dn, ace,
+ attr="defaultSecurityDescriptor")
+
+ res = self.samdb.search(expression="(objectClass=domainDNS)",
+ attrs=["nTSecurityDescriptor"],
+ controls=["search_options:1:2",
+ "sd_flags:1:%d" % SECINFO_DACL])
+
+ for msg in res:
+ existing_sd = ndr_unpack(security.descriptor, msg["nTSecurityDescriptor"][0])
+ existing_sddl = existing_sd.as_sddl(self.domain_sid)
+
+ self.insert_ace_into_dacl(msg.dn, existing_sddl, ace)
+
+ if self.add_update_container:
+ self.update_add(op)
+
+ # Update display specifiers
+ def operation_90(self, op):
+ if self.add_update_container and not self.update_exists(op):
+ self.update_add(op)
+
+ # Update display specifiers
+ def operation_127(self, op):
+ if self.add_update_container and not self.update_exists(op):
+ self.update_add(op)
+
+ # Update appears to already be applied in documentation
+ def operation_128(self, op):
+ if self.add_update_container and not self.update_exists(op):
+ self.update_add(op)
+
+ # Grant ACE (OA;CIOI;RPWP;3f78c3e5-f79a-46bd-a0b8-9d18116ddc79;;PS) to samDomain
+ def operation_129(self, op):
+ if self.update_exists(op):
+ return
+ self.raise_if_not_fix(op)
+
+ ace = "(OA;CIOI;RPWP;3f78c3e5-f79a-46bd-a0b8-9d18116ddc79;;PS)"
+
+ schema_dn = ldb.Dn(self.samdb, "CN=Sam-Domain,%s" % str(self.schema_dn))
+ self.insert_ace_into_string(schema_dn, ace,
+ attr='defaultSecurityDescriptor')
+
+ res = self.samdb.search(expression="(objectClass=samDomain)",
+ attrs=["nTSecurityDescriptor"],
+ controls=["search_options:1:2"])
+ for msg in res:
+ existing_sd = ndr_unpack(security.descriptor, msg["nTSecurityDescriptor"][0])
+ existing_sddl = existing_sd.as_sddl(self.domain_sid)
+
+ self.insert_ace_into_dacl(msg.dn, existing_sddl, ace)
+
+ if self.add_update_container:
+ self.update_add(op)
+
+ # Grant ACE (OA;CIOI;RPWP;3f78c3e5-f79a-46bd-a0b8-9d18116ddc79;;PS) to domainDNS
+ def operation_130(self, op):
+ if self.update_exists(op):
+ return
+ self.raise_if_not_fix(op)
+
+ ace = "(OA;CIOI;RPWP;3f78c3e5-f79a-46bd-a0b8-9d18116ddc79;;PS)"
+
+ schema_dn = ldb.Dn(self.samdb, "CN=Domain-DNS,%s" % str(self.schema_dn))
+ self.insert_ace_into_string(schema_dn, ace,
+ attr='defaultSecurityDescriptor')
+
+ res = self.samdb.search(expression="(objectClass=domainDNS)",
+ attrs=["nTSecurityDescriptor"],
+ controls=["search_options:1:2"])
+
+ for msg in res:
+ existing_sd = ndr_unpack(security.descriptor, msg["nTSecurityDescriptor"][0])
+ existing_sddl = existing_sd.as_sddl(self.domain_sid)
+
+ self.insert_ace_into_dacl(msg.dn, existing_sddl, ace)
+
+ if self.add_update_container:
+ self.update_add(op)
+
+ # Set msDS-ClaimIsValueSpaceRestricted on ad://ext/AuthenticationSilo to FALSE
+ def operation_135(self, op):
+ if self.update_exists(op):
+ return
+ self.raise_if_not_fix(op)
+
+ self.samdb.modify_ldif("""dn: CN=ad://ext/AuthenticationSilo,CN=Claim Types,CN=Claims Configuration,CN=Services,%s
+changetype: modify
+replace: msDS-ClaimIsValueSpaceRestricted
+msDS-ClaimIsValueSpaceRestricted: FALSE
+""" % self.config_dn,
+ controls=["relax:0", "provision:0"])
+
+ if self.add_update_container:
+ self.update_add(op)
+