GetDirectorySynchronizationCookie() returns empty cookie

[EvanMulawski]

Description

System.DirectoryServices.DirectorySynchronization.GetDirectorySynchronizationCookie() returns an invalid, 0-byte cookie on net5.0. A valid cookie is returned when running the same code on netcoreapp3.1.

Repro: https://github.com/EvanMulawski/DotNetDirectoryServicesDirSyncIssue

Configuration

• net5.0 (5.0.3)
• Windows 10 64-bit 1909

Regression?

Works in:

• netcoreapp3.1 (3.1.12)
• .NET Framework 4.8

[dotnet-issue-labeler]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[Thomas-Avery]

I am experiencing the same 0-byte cookie problem; however, it seems isolated to the version of System.DirectoryServices not net5.0 vs netcoreapp3.1.

Target Framework	Runtime	System.DirectoryServices NuGet Package Version	Result
netcoreapp3.1	3.1.14	5.0.0	FAIL
netcoreapp3.1	3.1.14	4.7.0	PASS
net5.0	5.0.5	5.0.0	FAIL
net5.0	5.0.5	4.7.0	PASS

[Thomas-Avery]

After some more research it looks like in the past the DirectorySearcher class, in the FindAll() private method, it would set an internal SearchResultCollection searchResult property.

runtime/src/libraries/System.DirectoryServices/src/System/DirectoryServices/DirectorySearcher.cs

Lines 677 to 679 in 60d1224

	SearchResultCollection result = new SearchResultCollection(clonedRoot, resultsHandle, properties, this);
	searchResult = result;
	return result;

This internal searchResult property is what is used to set the DirsyncCookie when you call directorySearcher.DirectorySynchronization.

runtime/src/libraries/System.DirectoryServices/src/System/DirectoryServices/DirectorySearcher.cs

Lines 503 to 508 in eb7ef11

	// if user specifies dirsync search preference and search is executed
	if (directorySynchronizationSpecified && searchResult != null)
	{
	_sync!.ResetDirectorySynchronizationCookie(searchResult.DirsyncCookie);
	}
	return _sync;

Now in the FindAll() code it just returns a new SearchResultCollection without populating the internal searchResult property. Which I believe is the root of the problem.

runtime/src/libraries/System.DirectoryServices/src/System/DirectoryServices/DirectorySearcher.cs

Line 664 in eb7ef11

return new SearchResultCollection(clonedRoot, resultsHandle, properties, this);

[joperezr]

@Thomas-Avery thanks for the great investigation! Have you had a chance to revert that change to again set searchResult property and validate that this fixes the issue you are facing?

[joperezr]

cc: @tquerec @grubioe Do you mind taking a look at this one since it is in S.DS?

[joperezr]

I don't think that we'll get to fix this in 6.0.0 so moving it to 7.0.0 for now.

[arora-kushal]

The same error is happening for:

Target Framework : net 5.0/netcoreapp3.1
Runtime : 5.0.13 (SDK - 5.0.404)
System.DirectoryServices NuGet Package Version: 4.7.0
Result: FAIL

Workaround: I have used FindOne() method, instead of FindAll() to get cookie.

[knoxi]

+1
run into the same on .net 6, had to rollback System.DirectoryServices to 4.7.0 to get it working again

[joperezr]

@knoxi did the workaround provided above by @arora-kushal not work for you?

[knoxi]

@joperezr I didn't tried this one, since I'm not sure if the behavior is still the same when using FindOne() instead of FindAll() because I'm using a query with FindAll(). Maybe I should give it a try.

[hrrrrustic]

This was fixed by #79093, could be closed

[buyaa-n]

Yep, it is fixed and the fix ported to 6.0/7.0

[hrrrrustic]

@buyaa-n I found one more similar issue #59756 that can be closed

[buyaa-n]

Thanks, leaving the issue open for adding a test