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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
<Type Name="AuthenticationManager" FullName="System.Net.AuthenticationManager" FullNameSP="System_Net_AuthenticationManager" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public AuthenticationManager extends System.Object" />
<TypeSignature Language="C#" Value="public class AuthenticationManager" />
<MemberOfLibrary>Networking</MemberOfLibrary>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
<AssemblyVersion>1.0.x.x</AssemblyVersion>
<AssemblyCulture>none</AssemblyCulture>
<Attributes>
<Attribute>
<AttributeName>CLSCompliantAttribute(true)</AttributeName>
<Excluded>0</Excluded>
</Attribute>
</Attributes>
</AssemblyInfo>
<ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
<Docs>
<summary>
<para>Manages the authentication modules called during the client authentication
process.</para>
</summary>
<remarks>
<para>The <see cref="T:System.Net.AuthenticationManager" /> class manages
authentication modules that are responsible for client authentication.
<block subset="none" type="note">The <see cref="T:System.Net.AuthenticationManager" /> is called by <see cref="T:System.Net.WebRequest" /> instances to provide information
that is sent to servers to authenticate the client. The authentication process
may consist of requests to an authentication server separate from the resource
server, as well as any other activities required to properly authenticate a
client.</block></para>
<para>The <see cref="T:System.Net.AuthenticationManager" />
queries registered authentication modules by calling the <see cref="M:System.Net.IAuthenticationModule.Authenticate(System.String,System.Net.WebRequest,System.Net.ICredentials)" qualify="true" /> method for each module. The
first authentication module that returns a <see cref="T:System.Net.Authorization" /> instance is used to authenticate the request. An authentication module, which can be any object that
implements the <see cref="T:System.Net.IAuthenticationModule" /> interface, is registered using the <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" />
method. Authentication modules are called in the order in which they are registered.</para>
<para>Applications typically do not access this type directly;
it provides authentication services for the <see cref="T:System.Net.WebRequest" /> type.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Authenticate">
<MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.Authorization Authenticate(string challenge, class System.Net.WebRequest request, class System.Net.ICredentials credentials)" />
<MemberSignature Language="C#" Value="public static Authorization Authenticate(string challenge, WebRequest request, ICredentials credentials);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.Authorization</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="challenge" Type="System.String" />
<Parameter Name="request" Type="System.Net.WebRequest" />
<Parameter Name="credentials" Type="System.Net.ICredentials" />
</Parameters>
<Docs>
<summary>
<para> Calls registered authentication modules to find a module that
responds to the specified authentication challenge.</para>
</summary>
<param name="challenge">A <see cref="T:System.String" /> containing the challenge returned by an Internet host. The content of this string is determined by the authentication protocol(s) used by the server that issued the challenge.</param>
<param name="request">The <see cref="T:System.Net.WebRequest" /> that received <paramref name="challenge" /> .</param>
<param name="credentials">The <see cref="T:System.Net.ICredentials" /> associated with <paramref name="request" />. <block subset="none" type="note">The <see cref="P:System.Net.WebRequest.Credentials" /> property of <paramref name="request" /> is used to supply this argument.</block></param>
<returns>
<para> A <see cref="T:System.Net.Authorization" /> instance containing the response from the
authentication module, or <see langword="null" /> if no authentication module
responded to the challenge.</para>
<para> Applications do not call this method; it is called by
<see cref="T:System.Net.WebRequest" />
instances.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<paramref name="challenge " />, <paramref name="request " />, or <paramref name="credentials " /> is <see langword="null" />.</exception>
<remarks>
<para>The <see cref="M:System.Net.AuthenticationManager.Authenticate(System.String,System.Net.WebRequest,System.Net.ICredentials)" /> method invokes the <see cref="M:System.Net.IAuthenticationModule.Authenticate(System.String,System.Net.WebRequest,System.Net.ICredentials)" qualify="true" /> method of each
registered authentication module until one of the modules returns a <see cref="T:System.Net.Authorization" />
instance. Authentication modules are called in the order in which they were registered via
the <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" />
method.</para>
<para>
<block subset="none" type="note">The <see cref="P:System.Net.Authorization.Message" /> property of the object returned by
this method contains the
client's response to the server challenge contained in <paramref name="challenge" />
. </block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="PreAuthenticate">
<MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.Authorization PreAuthenticate(class System.Net.WebRequest request, class System.Net.ICredentials credentials)" />
<MemberSignature Language="C#" Value="public static Authorization PreAuthenticate(WebRequest request, ICredentials credentials);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Net.Authorization</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="System.Net.WebRequest" />
<Parameter Name="credentials" Type="System.Net.ICredentials" />
</Parameters>
<Docs>
<summary>
<para>Attempts to obtain a <see cref="T:System.Net.Authorization" />
instance used to initiate client authentication.</para>
</summary>
<param name="request">A <see cref="T:System.Net.WebRequest" /> containing a request for access to a resource.</param>
<param name="credentials">The <see cref="T:System.Net.ICredentials" /> associated with <paramref name="request" /> .</param>
<returns>
<para> A <see cref="T:System.Net.Authorization" /> instance if an authentication module can provide
authentication information to be sent with <paramref name="request" /> ;
otherwise, <see langword="null" />. If <paramref name="credentials" />
is <see langword="null" />, this method returns <see langword="null" />.</para>
</returns>
<exception cref="T:System.ArgumentNullException">
<para>
<paramref name="request " />is <see langword="null." /></para>
</exception>
<remarks>
<para>The <see cref="M:System.Net.AuthenticationManager.PreAuthenticate(System.Net.WebRequest,System.Net.ICredentials)" /> method invokes the <see cref="M:System.Net.IAuthenticationModule.PreAuthenticate(System.Net.WebRequest,System.Net.ICredentials)" qualify="true" /> method of each registered
authentication module until one of the modules returns a <see cref="T:System.Net.Authorization" />
instance. Authentication modules are called in the order in which they were
registered via the <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" /> method.</para>
<para>
<block subset="none" type="note">The <see cref="T:System.Net.Authorization" /> instance contains the
information that will be
sent by a client to initiate authentication instead of waiting for the server to
request it. Authentication modules that support preauthentication allow clients
to improve server efficiency by avoiding extra round trips caused by
authentication challenges.</block>
</para>
<para>
<block subset="none" type="note">If an authorization module supports preauthentication
of requests, its <see cref="P:System.Net.IAuthenticationModule.CanPreAuthenticate" qualify="true" />
property returns <see langword="true" />. Note that
preauthentication requires that an authentication of the client has already
occurred. The information obtained from the initial authentication is used to
provide the <see cref="P:System.Net.Authorization.Message" /> that is
sent to the server as an authentication header in
<paramref name="request" /> .</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Register">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void Register(class System.Net.IAuthenticationModule authenticationModule)" />
<MemberSignature Language="C#" Value="public static void Register(IAuthenticationModule authenticationModule);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationModule" Type="System.Net.IAuthenticationModule" />
</Parameters>
<Docs>
<summary>
<para> Adds an authentication module to the list of registered
authentication modules managed by the authentication manager.</para>
</summary>
<param name="authenticationModule">The <see cref="T:System.Net.IAuthenticationModule" /> to register.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="authenticationModule " /> is <see langword="null" />.</exception>
<remarks>
<para>The <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" /> method adds an authentication
module to the end of the list of modules managed by the authentication manager.
Each registered module is required to have a
unique <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" />. If a module with the same
<see cref="P:System.Net.IAuthenticationModule.AuthenticationType" /> is already registered, this method removes the
registered module, and adds <paramref name="authenticationModule" /> to the end of the
list. <block subset="none" type="note">Authentication
modules are called in
the order in which they were added to the list.</block></para>
<para>
<block subset="none" type="note">To remove a module,
call one of the <see cref="M:System.Net.AuthenticationManager.Unregister(System.Net.IAuthenticationModule)" />
methods.</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Unregister">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void Unregister(class System.Net.IAuthenticationModule authenticationModule)" />
<MemberSignature Language="C#" Value="public static void Unregister(IAuthenticationModule authenticationModule);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationModule" Type="System.Net.IAuthenticationModule" />
</Parameters>
<Docs>
<summary>
<para> Removes the specified authentication module from the list of registered modules.</para>
</summary>
<param name="authenticationModule">The <see cref="T:System.Net.IAuthenticationModule" /> module to remove.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="authenticationModule " /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">
<paramref name="authenticationModule " />is not a registered authentication module.</exception>
<remarks>
<para>
<block subset="none" type="note">To add an authentication module to
the list of registered modules, call the <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" />
method.</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Unregister">
<MemberSignature Language="ILASM" Value=".method public hidebysig static void Unregister(string authenticationScheme)" />
<MemberSignature Language="C#" Value="public static void Unregister(string authenticationScheme);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Removes the authentication module with the specified
authentication type from the list of registered modules.</para>
</summary>
<param name="authenticationScheme">A <see cref="T:System.String" /> containing the authentication type of the module to remove.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="authenticationScheme " /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">There is no registered module with the <paramref name="authenticationScheme " /> authentication type.</exception>
<remarks>
<para>The <paramref name="authenticationScheme" /> is required to match
the value returned by the <see cref="P:System.Net.IAuthenticationModule.AuthenticationType" /> property of a registered authentication module.</para>
<para>
<block subset="none" type="note">To add an authentication module to
the list of registered modules, call the <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" />
method.</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="RegisteredModules">
<MemberSignature Language="ILASM" Value=".property class System.Collections.IEnumerator RegisteredModules { public hidebysig static specialname class System.Collections.IEnumerator get_RegisteredModules() }" />
<MemberSignature Language="C#" Value="public static IEnumerator RegisteredModules { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets a list of registered authentication modules.
</para>
</summary>
<value>
<para>A <see cref="T:System.Collections.IEnumerator" /> that
provides access to the list of registered
authentication modules.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>
<block subset="none" type="note">The <see cref="M:System.Net.AuthenticationManager.Register(System.Net.IAuthenticationModule)" /> method adds modules to the
list of registered authentication modules, and the <see cref="M:System.Net.AuthenticationManager.Unregister(System.Net.IAuthenticationModule)" /> method removes modules from
it.</block>
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|
