Serializing a .Net Core ClaimsIdentity with claims causes PlatformNotSupportedException

[nd-srogers]

I am in the process of upgrading my application to use .Net Core 2 and .NetStandard. In several areas I am serializing a ClaimsIdentity for logging and transmission purposes.

Whenever I try to serialize a ClaimsIdentity that contains at least one claim, I get a PlatformNotSupportedException. I suspect this is due to the Binary Serialization changes introduced in .Net Core 2 (https://github.com/dotnet/corefx/issues/23415). This appears to have been addressed previously (#1404) however I am still getting this error in 11.0.2.

Using a decompiler, the error occurs in the OnSerializingMethod method in ClaimsIdentity, and only occurs when the identity has 1 or more claims attached:

[OnSerializing]
private void OnSerializingMethod(StreamingContext context)
{
    if (this is ISerializable)
    {
        return;
    }

    _serializedNameType = _nameClaimType;
    _serializedRoleType = _roleClaimType;
    if (_instanceClaims != null && _instanceClaims.Count > 0)
    {
        throw new PlatformNotSupportedException(SR.PlatformNotSupported_Serialization); // BinaryFormatter would be needed
    }
}

Source/destination types

System.Security.Claims.ClaimsIdentity

Expected behavior

A fully serialized object with all claims intact.

Actual behavior

PlatformNotSupportedException: This instance contains state that cannot be serialized and deserialized on this platform.

Steps to reproduce

var identity = new ClaimsIdentity();
identity.AddClaim(new Claim("test", "test"));
var serializedIdentity = JsonConvert.SerializeObject(identity);

[JamesNK]

That looks like the expected behavior of ClaimsIdentity. Raise it with the corefx team.

[vikpai]

did we get a resolution for this?

[tb-mtg]

Was this resolved?

[EngRajabi]

This issue has not been resolved.
.net core 3.1

[ronaldpschutte]

in .Net 5 this still is a problem

[alkanyunus]

Still a problem

[Misiu]

in .Net 6 this is still an issue

System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation.
 ---> System.PlatformNotSupportedException: This instance contains state that cannot be serialized and deserialized on this platform.
   at System.Security.Claims.ClaimsPrincipal.OnSerializingMethod(StreamingContext context)

[Sergey-PrudentDev]

Annoyingly only solution seems to be to create DTOs

[senglory]

Experiencing the same issue (net 7.0). What's the fix?

[andreyshiryaev]

@senglory @Misiu

I had the same problem.
And I found that sometimes google does not return family_name and when i removed the code userClaims.FindFirstValue(ClaimTypes.Surname).?Value my application starts works fine