|
48 | 48 | </Attribute> |
49 | 49 | </Attributes> |
50 | 50 | <Docs> |
51 | | - <summary>Contains an authentication message for an Internet server.</summary> |
52 | | - <remarks> |
53 | | - <format type="text/markdown"><![CDATA[ |
54 | | -
|
55 | | -## Remarks |
56 | | - The <xref:System.Net.AuthenticationManager> returns an instance of the <xref:System.Net.Authorization> class that contains an authentication message. This message is sent to the Internet server to indicate that the client (such as <xref:System.Net.WebRequest> or one of its descendants) is authorized to access the server. |
57 | | -
|
58 | | - The <xref:System.Net.Authorization> instance is created by the authentication module that the <xref:System.Net.AuthenticationManager> designates to handle the request. |
59 | | -
|
60 | | - ]]></format> |
61 | | - </remarks> |
| 51 | + <summary>Contains an authentication message for an internet server.</summary> |
| 52 | + <remarks>To be added.</remarks> |
62 | 53 | <altmember cref="T:System.Net.IAuthenticationModule" /> |
63 | 54 | </Docs> |
64 | 55 | <Members> |
|
115 | 106 | <format type="text/markdown"><![CDATA[ |
116 | 107 |
|
117 | 108 | ## Remarks |
118 | | - The <xref:System.Net.Authorization> instance is created with the <xref:System.Net.Authorization.Message%2A> property set to `token` and the <xref:System.Net.Authorization.Complete%2A> property set to `true`. |
119 | | -
|
120 | | -
|
| 109 | + The <xref:System.Net.Authorization> instance is created with the <xref:System.Net.Authorization.Message> property set to `token` and the <xref:System.Net.Authorization.Complete> property set to `true`. |
121 | 110 |
|
122 | 111 | ## Examples |
123 | | - The following code example shows how to create an <xref:System.Net.Authorization> object. For a complete example, refer to the <xref:System.Net.AuthenticationManager> class. |
124 | | - |
| 112 | + The following code example shows how to create an <xref:System.Net.Authorization> object. |
| 113 | +
|
125 | 114 | :::code language="csharp" source="~/snippets/csharp/System.Net/AuthenticationManager/Overview/custombasicauthentication.cs" id="Snippet3"::: |
126 | 115 | :::code language="vb" source="~/snippets/visualbasic/System.Net/AuthenticationManager/Overview/custombasicauthentication.vb" id="Snippet3"::: |
127 | 116 |
|
|
174 | 163 | <format type="text/markdown"><![CDATA[ |
175 | 164 |
|
176 | 165 | ## Remarks |
177 | | - The <xref:System.Net.Authorization> instance is created with the <xref:System.Net.Authorization.Message%2A> property set to `token` and the <xref:System.Net.Authorization.Complete%2A> property set to `finished`. |
178 | | -
|
179 | | -
|
| 166 | + The <xref:System.Net.Authorization> instance is created with the <xref:System.Net.Authorization.Message> property set to `token` and the <xref:System.Net.Authorization.Complete> property set to `finished`. |
180 | 167 |
|
181 | 168 | ## Examples |
182 | 169 | The following code example creates a new instance of the <xref:System.Net.Authorization> class with the specified authorization message and completion status. |
|
299 | 286 | <format type="text/markdown"><![CDATA[ |
300 | 287 |
|
301 | 288 | ## Remarks |
302 | | - The <xref:System.Net.Authorization.Complete%2A> property is set to `true` when the authentication process between the client and the server is finished. Some authentication modules, such as the Kerberos module, use multiple round trips between the client and server to complete the authentication process. To keep the <xref:System.Net.WebRequest> or descendant that initiated the authentication process from interrupting while authorization is taking place, the authentication module sets the <xref:System.Net.Authorization.Complete%2A> property to `false`. |
303 | | -
|
304 | | -
|
| 289 | + The <xref:System.Net.Authorization.Complete> property is set to `true` when the authentication process between the client and the server is finished. Some authentication modules, such as the Kerberos module, use multiple round trips between the client and server to complete the authentication process. To keep the <xref:System.Net.WebRequest> or descendant that initiated the authentication process from interrupting while authorization is taking place, the authentication module sets the <xref:System.Net.Authorization.Complete> property to `false`. |
305 | 290 |
|
306 | 291 | ## Examples |
307 | | - The following code example uses the <xref:System.Net.Authorization.Complete%2A> property to get the completion status of the authorization. For a complete example, refer to the <xref:System.Net.AuthenticationManager> class. |
| 292 | + The following code example uses the <xref:System.Net.Authorization.Complete> property to get the completion status of the authorization. |
308 | 293 |
|
309 | 294 | :::code language="csharp" source="~/snippets/csharp/System.Net/AuthenticationManager/Overview/custombasicauthentication.cs" id="Snippet5"::: |
310 | 295 | :::code language="vb" source="~/snippets/visualbasic/System.Net/AuthenticationManager/Overview/custombasicauthentication.vb" id="Snippet5"::: |
|
363 | 348 | <format type="text/markdown"><![CDATA[ |
364 | 349 |
|
365 | 350 | ## Remarks |
366 | | - The <xref:System.Net.Authorization.ConnectionGroupId%2A> property is a unique string that associates a connection with a specific authenticating entity. For example, the NTLM authorization module ties the authentication credential information to a specific connection to prevent invalid reuse of the connection. |
367 | | -
|
368 | | -
|
| 351 | + The <xref:System.Net.Authorization.ConnectionGroupId> property is a unique string that associates a connection with a specific authenticating entity. For example, the NTLM authorization module ties the authentication credential information to a specific connection to prevent invalid reuse of the connection. |
369 | 352 |
|
370 | 353 | ## Examples |
371 | | - The following code example uses the <xref:System.Net.Authorization.ConnectionGroupId%2A> property to get the group identifier returned by the server. For a complete example, refer to the <xref:System.Net.AuthenticationManager> class. |
| 354 | + The following code example uses the <xref:System.Net.Authorization.ConnectionGroupId> property to get the group identifier returned by the server. |
372 | 355 |
|
373 | 356 | :::code language="csharp" source="~/snippets/csharp/System.Net/AuthenticationManager/Overview/custombasicauthentication.cs" id="Snippet5"::: |
374 | 357 | :::code language="vb" source="~/snippets/visualbasic/System.Net/AuthenticationManager/Overview/custombasicauthentication.vb" id="Snippet5"::: |
|
426 | 409 | <format type="text/markdown"><![CDATA[ |
427 | 410 |
|
428 | 411 | ## Remarks |
429 | | - The <xref:System.Net.Authorization.Message%2A> property contains the authorization string that the client will return to the server when accessing protected resources. The actual contents of the message are defined by the authentication type the client and server are using. Basic HTTP authentication, for example, uses a different message than Kerberos authentication. |
430 | | -
|
431 | | - When an authentication module supports preauthentication, the <xref:System.Net.Authorization.Message%2A> property is sent with the initial request. |
432 | | -
|
| 412 | + The <xref:System.Net.Authorization.Message> property contains the authorization string that the client will return to the server when accessing protected resources. The actual contents of the message are defined by the authentication type the client and server are using. Basic HTTP authentication, for example, uses a different message than Kerberos authentication. |
433 | 413 |
|
| 414 | + When an authentication module supports preauthentication, the <xref:System.Net.Authorization.Message> property is sent with the initial request. |
434 | 415 |
|
435 | 416 | ## Examples |
436 | | - The following code example uses the <xref:System.Net.Authorization.Message%2A> property to get the message returned to the server in response to an authentication challenge. For a complete example, refer to the <xref:System.Net.AuthenticationManager> class. |
| 417 | + The following code example uses the <xref:System.Net.Authorization.Message> property to get the message returned to the server in response to an authentication challenge. |
437 | 418 |
|
438 | 419 | :::code language="csharp" source="~/snippets/csharp/System.Net/AuthenticationManager/Overview/custombasicauthentication.cs" id="Snippet5"::: |
439 | 420 | :::code language="vb" source="~/snippets/visualbasic/System.Net/AuthenticationManager/Overview/custombasicauthentication.vb" id="Snippet5"::: |
|
484 | 465 | <ReturnType>System.Boolean</ReturnType> |
485 | 466 | </ReturnValue> |
486 | 467 | <Docs> |
487 | | - <summary>Gets or sets a <see cref="T:System.Boolean" /> value that indicates whether mutual authentication occurred.</summary> |
| 468 | + <summary>Gets or sets a value that indicates whether mutual authentication occurred.</summary> |
488 | 469 | <value> |
489 | | - <see langword="true" /> if both client and server were authenticated; otherwise, <see langword="false" />.</value> |
490 | | - <remarks> |
491 | | - <format type="text/markdown"><![CDATA[ |
492 | | -
|
493 | | -## Remarks |
494 | | - This property returns `false` if the authentication has not completed. |
495 | | -
|
496 | | - ]]></format> |
497 | | - </remarks> |
| 470 | + <see langword="true" /> if both client and server were authenticated; <see langword="false" /> if client or server weren't authenticated or if authentication hasn't completed.</value> |
| 471 | + <remarks>To be added.</remarks> |
498 | 472 | </Docs> |
499 | 473 | </Member> |
500 | 474 | <Member MemberName="ProtectionRealm"> |
|
550 | 524 | <format type="text/markdown"><![CDATA[ |
551 | 525 |
|
552 | 526 | ## Remarks |
553 | | - The <xref:System.Net.Authorization.ProtectionRealm%2A> property contains a list of URI prefixes that the <xref:System.Net.Authorization.Message%2A> property can be used to authenticate. <xref:System.Net.WebRequest> and its descendants compare a URI to this list to determine if the <xref:System.Net.Authorization> is valid for a particular URI. |
554 | | -
|
555 | | -
|
| 527 | + The <xref:System.Net.Authorization.ProtectionRealm> property contains a list of URI prefixes that the <xref:System.Net.Authorization.Message> property can be used to authenticate. <xref:System.Net.WebRequest> and its descendants compare a URI to this list to determine if the <xref:System.Net.Authorization> is valid for a particular URI. |
556 | 528 |
|
557 | 529 | ## Examples |
558 | | - The following code example gets or sets the prefix for URIs that can be authenticated with the <xref:System.Net.Authorization.Message%2A> property. |
| 530 | + The following code example gets or sets the prefix for URIs that can be authenticated with the <xref:System.Net.Authorization.Message> property. |
559 | 531 |
|
560 | 532 | :::code language="csharp" source="~/snippets/csharp/System.Net/Authorization/.ctor/authorization_protectionrealm.cs" id="Snippet1"::: |
561 | 533 | :::code language="vb" source="~/snippets/visualbasic/System.Net/Authorization/.ctor/authorization_protectionrealm.vb" id="Snippet1"::: |
|
0 commit comments