-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WindowsSecurityTokenAuthenticator.xml
167 lines (161 loc) · 11.2 KB
/
WindowsSecurityTokenAuthenticator.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<Type Name="WindowsSecurityTokenAuthenticator" FullName="System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator">
<TypeSignature Language="C#" Value="public class WindowsSecurityTokenAuthenticator : System.IdentityModel.Selectors.SecurityTokenAuthenticator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WindowsSecurityTokenAuthenticator extends System.IdentityModel.Selectors.SecurityTokenAuthenticator" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator" />
<TypeSignature Language="VB.NET" Value="Public Class WindowsSecurityTokenAuthenticator
Inherits SecurityTokenAuthenticator" />
<TypeSignature Language="F#" Value="type WindowsSecurityTokenAuthenticator = class
 inherit SecurityTokenAuthenticator" />
<TypeSignature Language="C++ CLI" Value="public ref class WindowsSecurityTokenAuthenticator : System::IdentityModel::Selectors::SecurityTokenAuthenticator" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Selectors.SecurityTokenAuthenticator</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Uses Windows authentication to authenticate the <see cref="T:System.IdentityModel.Tokens.WindowsSecurityToken" /> security token.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator> class to authenticate security tokens that derive from <xref:System.IdentityModel.Tokens.WindowsSecurityToken>.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WindowsSecurityTokenAuthenticator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 WindowsSecurityTokenAuthenticator();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the user is authenticated, claims that identify the Windows groups that a user belongs to are initially added to the <xref:System.IdentityModel.Policy.EvaluationContext.ClaimSets%2A> property and eventually to the <xref:System.IdentityModel.Policy.AuthorizationContext.ClaimSets%2A> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WindowsSecurityTokenAuthenticator (bool includeWindowsGroups);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool includeWindowsGroups) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.#ctor(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (includeWindowsGroups As Boolean)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator : bool -> System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator" Usage="new System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator includeWindowsGroups" />
<MemberSignature Language="C++ CLI" Value="public:
 WindowsSecurityTokenAuthenticator(bool includeWindowsGroups);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="includeWindowsGroups" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="includeWindowsGroups">
<see langword="true" /> to get the groups the Windows user belongs to; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator" /> class by specifying whether the groups that the Windows user belongs to are added to the <see cref="P:System.IdentityModel.Policy.AuthorizationContext.ClaimSets" /> property when the user is authenticated.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanValidateTokenCore">
<MemberSignature Language="C#" Value="protected override bool CanValidateTokenCore (System.IdentityModel.Tokens.SecurityToken token);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool CanValidateTokenCore(class System.IdentityModel.Tokens.SecurityToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.CanValidateTokenCore(System.IdentityModel.Tokens.SecurityToken)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CanValidateTokenCore (token As SecurityToken) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanValidateTokenCore : System.IdentityModel.Tokens.SecurityToken -> bool" Usage="windowsSecurityTokenAuthenticator.CanValidateTokenCore token" />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool CanValidateTokenCore(System::IdentityModel::Tokens::SecurityToken ^ token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
</Parameters>
<Docs>
<param name="token">The <see cref="T:System.IdentityModel.Tokens.SecurityToken" /> to be validated.</param>
<summary>Gets a value indicating whether the specified security token can be validated by this security token authenticator.</summary>
<returns>
<see langword="true" /> when <paramref name="token" /> is a <see cref="T:System.IdentityModel.Tokens.WindowsSecurityToken" /> security token; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.CanValidateTokenCore%2A> method does not authenticate the security token; that is performed by the <xref:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.ValidateTokenCore%2A> method.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ValidateTokenCore">
<MemberSignature Language="C#" Value="protected override System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Policy.IAuthorizationPolicy> ValidateTokenCore (System.IdentityModel.Tokens.SecurityToken token);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.IdentityModel.Policy.IAuthorizationPolicy> ValidateTokenCore(class System.IdentityModel.Tokens.SecurityToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Selectors.WindowsSecurityTokenAuthenticator.ValidateTokenCore(System.IdentityModel.Tokens.SecurityToken)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function ValidateTokenCore (token As SecurityToken) As ReadOnlyCollection(Of IAuthorizationPolicy)" />
<MemberSignature Language="F#" Value="override this.ValidateTokenCore : System.IdentityModel.Tokens.SecurityToken -> System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Policy.IAuthorizationPolicy>" Usage="windowsSecurityTokenAuthenticator.ValidateTokenCore token" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Collections::ObjectModel::ReadOnlyCollection<System::IdentityModel::Policy::IAuthorizationPolicy ^> ^ ValidateTokenCore(System::IdentityModel::Tokens::SecurityToken ^ token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Policy.IAuthorizationPolicy></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
</Parameters>
<Docs>
<param name="token">The <see cref="T:System.IdentityModel.Tokens.SecurityToken" /> to be validated.</param>
<summary>Authenticates the specified security token and returns the set of authorization policies for the security token.</summary>
<returns>A <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> of type <see cref="T:System.IdentityModel.Policy.IAuthorizationPolicy" /> that contains the set of authorization policies in effect for this application.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>