3 # Copyright Andrew Tridgell 2010
4 # Copyright Andrew Bartlett 2017
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from samba.dcerpc import drsuapi, misc, drsblobs
21 from samba.net import Net
22 from samba.ndr import ndr_unpack
23 from samba import dsdb
24 from samba import werror
25 from samba import WERRORError
28 from samba.dcerpc.drsuapi import (DRSUAPI_ATTID_name,
29 DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V8,
30 DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V10)
34 class drsException(Exception):
35 """Base element for drs errors"""
37 def __init__(self, value):
41 return "drsException: " + self.value
44 def drsuapi_connect(server, lp, creds):
45 """Make a DRSUAPI connection to the server.
47 :param server: the name of the server to connect to
48 :param lp: a samba line parameter object
49 :param creds: credential used for the connection
50 :return: A tuple with the drsuapi bind object, the drsuapi handle
51 and the supported extensions.
52 :raise drsException: if the connection fails
55 binding_options = "seal"
56 if lp.log_level() >= 9:
57 binding_options += ",print"
58 binding_string = "ncacn_ip_tcp:%s[%s]" % (server, binding_options)
60 drsuapiBind = drsuapi.drsuapi(binding_string, lp, creds)
61 (drsuapiHandle, bindSupportedExtensions) = drs_DsBind(drsuapiBind)
62 except Exception as e:
63 raise drsException("DRS connection to %s failed: %s" % (server, e))
65 return (drsuapiBind, drsuapiHandle, bindSupportedExtensions)
68 def sendDsReplicaSync(drsuapiBind, drsuapi_handle, source_dsa_guid,
69 naming_context, req_option):
70 """Send DS replica sync request.
72 :param drsuapiBind: a drsuapi Bind object
73 :param drsuapi_handle: a drsuapi handle on the drsuapi connection
74 :param source_dsa_guid: the guid of the source dsa for the replication
75 :param naming_context: the DN of the naming context to replicate
76 :param req_options: replication options for the DsReplicaSync call
77 :raise drsException: if any error occur while sending and receiving the
78 reply for the dsReplicaSync
81 nc = drsuapi.DsReplicaObjectIdentifier()
82 nc.dn = naming_context
84 req1 = drsuapi.DsReplicaSyncRequest1()
85 req1.naming_context = nc
86 req1.options = req_option
87 req1.source_dsa_guid = misc.GUID(source_dsa_guid)
90 drsuapiBind.DsReplicaSync(drsuapi_handle, 1, req1)
91 except Exception as estr:
92 raise drsException("DsReplicaSync failed %s" % estr)
95 def sendRemoveDsServer(drsuapiBind, drsuapi_handle, server_dsa_dn, domain):
96 """Send RemoveDSServer request.
98 :param drsuapiBind: a drsuapi Bind object
99 :param drsuapi_handle: a drsuapi handle on the drsuapi connection
100 :param server_dsa_dn: a DN object of the server's dsa that we want to
102 :param domain: a DN object of the server's domain
103 :raise drsException: if any error occur while sending and receiving the
104 reply for the DsRemoveDSServer
108 req1 = drsuapi.DsRemoveDSServerRequest1()
109 req1.server_dn = str(server_dsa_dn)
110 req1.domain_dn = str(domain)
113 drsuapiBind.DsRemoveDSServer(drsuapi_handle, 1, req1)
114 except Exception as estr:
115 raise drsException("DsRemoveDSServer failed %s" % estr)
119 '''make a DsBind call, returning the binding handle'''
120 bind_info = drsuapi.DsBindInfoCtr()
121 bind_info.length = 28
122 bind_info.info = drsuapi.DsBindInfo28()
123 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_BASE
124 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_ASYNC_REPLICATION
125 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_REMOVEAPI
126 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_MOVEREQ_V2
127 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHG_COMPRESS
128 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V1
129 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_RESTORE_USN_OPTIMIZATION
130 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_KCC_EXECUTE
131 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_ADDENTRY_V2
132 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_LINKED_VALUE_REPLICATION
133 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V2
134 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_INSTANCE_TYPE_NOT_REQ_ON_MOD
135 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_CRYPTO_BIND
136 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GET_REPL_INFO
137 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_STRONG_ENCRYPTION
138 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_DCINFO_V01
139 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_TRANSITIVE_MEMBERSHIP
140 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_ADD_SID_HISTORY
141 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_POST_BETA3
142 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GET_MEMBERSHIPS2
143 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V6
144 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_NONDOMAIN_NCS
145 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V8
146 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V5
147 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V6
148 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_ADDENTRYREPLY_V3
149 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_GETCHGREPLY_V7
150 bind_info.info.supported_extensions |= drsuapi.DRSUAPI_SUPPORTED_EXTENSION_VERIFY_OBJECT
151 (info, handle) = drs.DsBind(misc.GUID(drsuapi.DRSUAPI_DS_BIND_GUID), bind_info)
153 return (handle, info.info.supported_extensions)
156 def drs_get_rodc_partial_attribute_set(samdb):
157 '''get a list of attributes for RODC replication'''
158 partial_attribute_set = drsuapi.DsPartialAttributeSet()
159 partial_attribute_set.version = 1
163 # the exact list of attids we send is quite critical. Note that
164 # we do ask for the secret attributes, but set SPECIAL_SECRET_PROCESSING
166 schema_dn = samdb.get_schema_basedn()
167 res = samdb.search(base=schema_dn, scope=ldb.SCOPE_SUBTREE,
168 expression="objectClass=attributeSchema",
169 attrs=["lDAPDisplayName", "systemFlags",
173 ldap_display_name = str(r["lDAPDisplayName"][0])
174 if "systemFlags" in r:
175 system_flags = r["systemFlags"][0]
176 if (int(system_flags) & (samba.dsdb.DS_FLAG_ATTR_NOT_REPLICATED |
177 samba.dsdb.DS_FLAG_ATTR_IS_CONSTRUCTED)):
179 if "searchFlags" in r:
180 search_flags = r["searchFlags"][0]
181 if (int(search_flags) & samba.dsdb.SEARCH_FLAG_RODC_ATTRIBUTE):
183 attid = samdb.get_attid_from_lDAPDisplayName(ldap_display_name)
184 attids.append(int(attid))
186 # the attids do need to be sorted, or windows doesn't return
187 # all the attributes we need
189 partial_attribute_set.attids = attids
190 partial_attribute_set.num_attids = len(attids)
191 return partial_attribute_set
194 def drs_copy_highwater_mark(hwm, new_hwm):
196 Copies the highwater mark by value, rather than by object reference. (This
197 avoids lingering talloc references to old GetNCChanges reply messages).
199 hwm.tmp_highest_usn = new_hwm.tmp_highest_usn
200 hwm.reserved_usn = new_hwm.reserved_usn
201 hwm.highest_usn = new_hwm.highest_usn
204 class drs_Replicate(object):
205 '''DRS replication calls'''
207 def __init__(self, binding_string, lp, creds, samdb, invocation_id):
208 self.drs = drsuapi.drsuapi(binding_string, lp, creds)
209 (self.drs_handle, self.supports_ext) = drs_DsBind(self.drs)
210 self.net = Net(creds=creds, lp=lp)
212 if not isinstance(invocation_id, misc.GUID):
213 raise RuntimeError("Must supply GUID for invocation_id")
214 if invocation_id == misc.GUID("00000000-0000-0000-0000-000000000000"):
215 raise RuntimeError("Must not set GUID 00000000-0000-0000-0000-000000000000 as invocation_id")
216 self.replication_state = self.net.replicate_init(self.samdb, lp, self.drs, invocation_id)
219 def _should_retry_with_get_tgt(self, error_code, req):
221 # If the error indicates we fail to resolve a target object for a
222 # linked attribute, then we should retry the request with GET_TGT
223 # (if we support it and haven't already tried that)
225 # TODO fix up the below line when we next update werror_err_table.txt
226 # and pull in the new error-code
227 # return (error_code == werror.WERR_DS_DRA_RECYCLED_TARGET and
228 return (error_code == 0x21bf and
229 (req.more_flags & drsuapi.DRSUAPI_DRS_GET_TGT) == 0 and
230 self.supports_ext & DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V10)
232 def process_chunk(self, level, ctr, schema, req_level, req, first_chunk):
233 '''Processes a single chunk of received replication data'''
234 # pass the replication into the py_net.c python bindings for processing
235 self.net.replicate_chunk(self.replication_state, level, ctr,
236 schema=schema, req_level=req_level, req=req)
238 def replicate(self, dn, source_dsa_invocation_id, destination_dsa_guid,
239 schema=False, exop=drsuapi.DRSUAPI_EXOP_NONE, rodc=False,
240 replica_flags=None, full_sync=True, sync_forced=False, more_flags=0):
241 '''replicate a single DN'''
243 # setup for a GetNCChanges call
244 if self.supports_ext & DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V10:
245 req = drsuapi.DsGetNCChangesRequest10()
246 req.more_flags = (more_flags | self.more_flags)
250 req = drsuapi.DsGetNCChangesRequest8()
252 req.destination_dsa_guid = destination_dsa_guid
253 req.source_dsa_invocation_id = source_dsa_invocation_id
254 req.naming_context = drsuapi.DsReplicaObjectIdentifier()
255 req.naming_context.dn = dn
257 # Default to a full replication if we don't find an upToDatenessVector
259 hwm = drsuapi.DsReplicaHighWaterMark()
260 hwm.tmp_highest_usn = 0
265 res = self.samdb.search(base=dn, scope=ldb.SCOPE_BASE,
267 if "repsFrom" in res[0]:
268 for reps_from_packed in res[0]["repsFrom"]:
269 reps_from_obj = ndr_unpack(drsblobs.repsFromToBlob, reps_from_packed)
270 if reps_from_obj.ctr.source_dsa_invocation_id == source_dsa_invocation_id:
271 hwm = reps_from_obj.ctr.highwatermark
273 udv = drsuapi.DsReplicaCursorCtrEx()
279 cursors_v2 = dsdb._dsdb_load_udv_v2(self.samdb,
280 self.samdb.get_default_basedn())
281 for cursor_v2 in cursors_v2:
282 cursor_v1 = drsuapi.DsReplicaCursor()
283 cursor_v1.source_dsa_invocation_id = cursor_v2.source_dsa_invocation_id
284 cursor_v1.highest_usn = cursor_v2.highest_usn
285 cursors_v1.append(cursor_v1)
287 udv.cursors = cursors_v1
288 udv.count = len(cursors_v1)
290 req.highwatermark = hwm
291 req.uptodateness_vector = udv
293 if replica_flags is not None:
294 req.replica_flags = replica_flags
295 elif exop == drsuapi.DRSUAPI_EXOP_REPL_SECRET:
296 req.replica_flags = 0
298 req.replica_flags = (drsuapi.DRSUAPI_DRS_INIT_SYNC |
299 drsuapi.DRSUAPI_DRS_PER_SYNC |
300 drsuapi.DRSUAPI_DRS_GET_ANC |
301 drsuapi.DRSUAPI_DRS_NEVER_SYNCED |
302 drsuapi.DRSUAPI_DRS_GET_ALL_GROUP_MEMBERSHIP)
304 req.replica_flags |= (
305 drsuapi.DRSUAPI_DRS_SPECIAL_SECRET_PROCESSING)
307 req.replica_flags |= drsuapi.DRSUAPI_DRS_WRIT_REP
310 req.replica_flags |= drsuapi.DRSUAPI_DRS_SYNC_FORCED
312 req.max_object_count = 402
313 req.max_ndr_size = 402116
314 req.extended_op = exop
316 req.partial_attribute_set = None
317 req.partial_attribute_set_ex = None
318 req.mapping_ctr.num_mappings = 0
319 req.mapping_ctr.mappings = None
321 if not schema and rodc:
322 req.partial_attribute_set = drs_get_rodc_partial_attribute_set(self.samdb)
324 if not self.supports_ext & DRSUAPI_SUPPORTED_EXTENSION_GETCHGREQ_V8:
326 req5 = drsuapi.DsGetNCChangesRequest5()
329 setattr(req5, a, getattr(req, a))
337 (level, ctr) = self.drs.DsGetNCChanges(self.drs_handle, req_level, req)
338 if ctr.first_object is None and ctr.object_count != 0:
339 raise RuntimeError("DsGetNCChanges: NULL first_object with object_count=%u" % (ctr.object_count))
342 self.process_chunk(level, ctr, schema, req_level, req, first_chunk)
343 except WERRORError as e:
344 # Check if retrying with the GET_TGT flag set might resolve this error
345 if self._should_retry_with_get_tgt(e.args[0], req):
347 print("Missing target object - retrying with DRS_GET_TGT")
348 req.more_flags |= drsuapi.DRSUAPI_DRS_GET_TGT
350 # try sending the request again (this has the side-effect
351 # of causing the DC to restart the replication from scratch)
358 num_objects += ctr.object_count
360 # Cope with servers that do not return level 6, so do not return any links
362 num_links += ctr.linked_attributes_count
363 except AttributeError:
366 if ctr.more_data == 0:
369 # update the request's HWM so we get the next chunk
370 drs_copy_highwater_mark(req.highwatermark, ctr.new_highwatermark)
372 return (num_objects, num_links)
375 # Handles the special case of creating a new clone of a DB, while also renaming
376 # the entire DB's objects on the way through
377 class drs_ReplicateRenamer(drs_Replicate):
378 '''Uses DRS replication to rename the entire DB'''
380 def __init__(self, binding_string, lp, creds, samdb, invocation_id,
381 old_base_dn, new_base_dn):
382 super(drs_ReplicateRenamer, self).__init__(binding_string, lp, creds,
383 samdb, invocation_id)
384 self.old_base_dn = old_base_dn
385 self.new_base_dn = new_base_dn
387 # because we're renaming the DNs, we know we're going to have trouble
388 # resolving link targets. Normally we'd get to the end of replication
389 # only to find we need to retry the whole replication with the GET_TGT
390 # flag set. Always setting the GET_TGT flag avoids this extra work.
391 self.more_flags = drsuapi.DRSUAPI_DRS_GET_TGT
393 def rename_dn(self, dn_str):
394 '''Uses string substitution to replace the base DN'''
395 return re.sub('%s$' % self.old_base_dn, self.new_base_dn, dn_str)
397 def update_name_attr(self, base_obj):
398 '''Updates the 'name' attribute for the base DN object'''
399 for attr in base_obj.attribute_ctr.attributes:
400 if attr.attid == DRSUAPI_ATTID_name:
401 base_dn = ldb.Dn(self.samdb, base_obj.identifier.dn)
402 new_name = base_dn.get_rdn_value()
403 attr.value_ctr.values[0].blob = new_name.encode('utf-16-le')
405 def rename_top_level_object(self, first_obj):
406 '''Renames the first/top-level object in a partition'''
407 old_dn = first_obj.identifier.dn
408 first_obj.identifier.dn = self.rename_dn(first_obj.identifier.dn)
409 print("Renaming partition %s --> %s" % (old_dn,
410 first_obj.identifier.dn))
412 # we also need to fix up the 'name' attribute for the base DN,
413 # otherwise the RDNs won't match
414 if first_obj.identifier.dn == self.new_base_dn:
415 self.update_name_attr(first_obj)
417 def process_chunk(self, level, ctr, schema, req_level, req, first_chunk):
418 '''Processes a single chunk of received replication data'''
420 # we need to rename the NC in every chunk - this gets used in searches
421 # when applying the chunk
422 if ctr.naming_context:
423 ctr.naming_context.dn = self.rename_dn(ctr.naming_context.dn)
425 # rename the first object in each partition. This will cause every
426 # subsequent object in the partiton to be renamed as a side-effect
427 if first_chunk and ctr.object_count != 0:
428 self.rename_top_level_object(ctr.first_object.object)
430 # then do the normal repl processing to apply this chunk to our DB
431 super(drs_ReplicateRenamer, self).process_chunk(level, ctr, schema,