ClaimsPrincipal and ClaimsIdentity type proxies hide properties on derived types

[JamesNK]

Description

A PR to improve debugging claims debugging added type proxies for ClaimsPrincipal and ClaimsIdentity: #86424

These types aren't sealed, and WindowsPrincipal and WindowsIdentity inherit from them and add new properties. For example, WindowsPrincipal.DeviceClaims. These properties are hidden by the type proxies.

Two possible solutions:

1. Remove type proxies. The proxies improve the display of some IEnumerable<Claims> properties, which I believe could be replaced by placing DebuggerDisplayAttribute on those properties. I haven't seen DebuggerDisplayAttribute used on properties before, but its attribute usage allows it.
2. Add type proxies for WindowsPrincipal and WindowsIdentity. This would improve debugging of these types, but anyone else who inherits from the base claim types and adds new properties will still have them hidden.

Reproduction Steps

Create WindowsPrinicipal and debug.

Expected behavior

WindowsPrinicipal.DeviceClaims is visible in the default debugging view.

Actual behavior

Only ClaimsPrinicipal properties are visible in the default debugging view.

Regression?

Yes. These properties were visible by default when debugging .NET 7.

Known Workarounds

No response

Configuration

No response

Other information

No response

[JamesNK]

Should this be fixed in .NET 8 RC2?

[ghost]

Tagging subscribers to this area: @dotnet/area-system-security, @bartonjs, @vcsjones
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

A PR to improve debugging claims debugging added type proxies for ClaimsPrincipal and ClaimsIdentity: #86424

These types aren't sealed, and WindowsPrincipal and WindowsIdentity inherit from them and add new properties. For example, WindowsPrincipal.DeviceClaims. These properties are hidden by the type proxies.

Two possible solutions:

1. Remove type proxies. The proxies improve the display of some IEnumerable<Claims> properties, which I believe could be replaced by placing DebuggerDisplayAttribute on those properties. I haven't seen DebuggerDisplayAttribute used on properties before, but its attribute usage allows it.
2. Add type proxies for WindowsPrincipal and WindowsIdentity. This would improve debugging of these types, but anyone else who inherits from the base claim types and adds new properties will still have them hidden.

Reproduction Steps

Create WindowsPrinicipal and debug.

Expected behavior

WindowsPrinicipal.DeviceClaims is visible in the default debugging view.

Actual behavior

Only ClaimsPrinicipal properties are visible in the default debugging view.

Regression?

Yes. These properties were visible by default when debugging .NET 7.

Known Workarounds

No response

Configuration

No response

Other information

No response

Author:	JamesNK
Assignees:	-
Labels:	area-System.Security, untriaged
Milestone:	-

[vcsjones]

2. Add type proxies for WindowsPrincipal and WindowsIdentity. This would improve debugging of these types, but anyone else who inherits from the base claim types and adds new properties will still have them hidden.

As a point of reference, looking across GitHub, I can see a number of places where 3rd parties are deriving from this type.

My vote would be a fix that benefits all folks that derive from these types.

[JamesNK]

1. Remove type proxies. The proxies improve the display of some IEnumerable<Claims> properties, which I believe could be replaced by placing DebuggerDisplayAttribute on those properties. I haven't seen DebuggerDisplayAttribute used on properties before, but its attribute usage allows it.

Unfortunately, this doesn't work. There is a bug in Roslyn: dotnet/roslyn#4134

I don't see a good way to make IEnumerable + yield play well with the debugger. A tactical solution could be to change ClaimsPricinpial.Claims to create a List<Claim> and return that. If there are multiple identities with claims then a list will allocate slightly more than yield, but one identity is the typical use case.

Longer term, a way to make IEnumerable + yield show up well with the debugger should be investigated.

[jozkee]

Removing the proxies and add DebuiggerDisplay to the Claims property after dotnet/roslyn#4134 gets fixed (if ever) seems best to me.

create a List and return that

Not sure if it's worth to add allocations for debugging purposes. cc @bartonjs