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 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ActiveDirectoryMembershipProvider" FullName="System.Web.Security.ActiveDirectoryMembershipProvider">
<TypeSignature Language="C#" Value="public class ActiveDirectoryMembershipProvider : System.Web.Security.MembershipProvider" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.Security.MembershipProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This class is used by the <see cref="T:System.Web.Security.Membership" /> and <see cref="T:System.Web.Security.MembershipUser" /> classes to provide membership services for an ASP.NET application using an Active Directory (AD) or Active Directory Application Mode (ADAM) server.</para>
<block subset="none" type="note">
<para>Using an ADAM server requires specific configuration. For more information, see the ADAM Configuration section below.</para>
</block>
<block subset="none" type="note">
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance works only in the full-trust policy default configuration of ASP.NET. In order to use the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance at any partial-trust level, either you must make changes to the appropriate trust policy file for your application or you must create a "sandbox" assembly that is deployed in the GAC.</para>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class requires unrestricted <see cref="T:System.DirectoryServices.DirectoryServicesPermission" /> permission to run. This permission is not added to any of the partial-trust policy files supplied with ASP.NET. Although adding the <see cref="T:System.DirectoryServices.DirectoryServicesPermission" /> permission to a partial-trust policy file will enable use of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class, doing so makes the <see cref="N:System.DirectoryServices" /> namespace classes available to any code running in your ASP.NET pages. This option is not recommended for any Web servers that need to run in a secure, locked-down mode.</para>
<para>As an alternative, you can create a "sandbox" assembly that calls the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class. This assembly can contain either a wrapper class that forwards method calls to the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class or a class that derives from the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class. In either case, the wrapper class must assert unrestricted <see cref="T:System.DirectoryServices.DirectoryServicesPermission" /> permission. Deploy the sandbox assembly in the GAC and mark the assembly with the <see cref="T:System.Security.AllowPartiallyTrustedCallersAttribute" /> (APTCA) attribute. This will enable your partially trusted ASP.NET code to call your wrapper class, and since the wrapper class internally asserts the unrestricted <see cref="T:System.DirectoryServices.DirectoryServicesPermission" /> permission, your wrapper class will be able to successfully call the provider</para>
</block>
<para>You must create a <format type="text/html"><a href="b6ffbb2e-a4d1-410e-8f7e-9755e92c65de">connectionString</a></format> entry in the Web.config file that identifies the Active Directory server, Active Directory domain, or ADAM application partition to use. The provider will only operate at domain scope, or in a subscope within a domain. The following table lists allowed connection strings and the scope used.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Connection string</para>
</term>
<description>
<para>Scope</para>
</description>
</item>
</listheader>
<item>
<term>
<para>LDAP://<domain or server>:[port]</para>
<para>Port number is optional for ADAM and not needed for Active Directory.</para>
</term>
<description>
<para>The provider runs against the specified domain or server. With AD, user creation and deletion is done in the default users container. All other operations, including any search methods, will be rooted at the default naming context for the domain.</para>
<para>If the connection string specifies an Active Directory domain rather than a specific server and the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will always connect to the server with the PDC role for the domain to ensure that password changes take effect and are available when the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ValidateUser(System.String,System.String)" /> method is called.</para>
<para>This connection string is not allowed when using ADAM, and will throw a <see cref="T:System.NotSupportedException" />.</para>
</description>
</item>
<item>
<term>
<para>LDAP://<domain or server>:[port]/<container dn></para>
<para>Port number is optional for ADAM and not needed for Active Directory.</para>
</term>
<description>
<para>The provider runs against the specified domain or server. User creation and deletion is only done in the specified container. All other operations, including any search methods, perform subtree searches rooted at the container.</para>
<para>For ADAM servers, the container specifies the root of an application partition, or a container within an application partition.</para>
<para>We recommend that the connection string define a specific container to improve performance.</para>
</description>
</item>
</list>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance maps directory attributes to <see cref="T:System.Web.Security.ActiveDirectoryMembershipUser" /> properties. Default attributes are used if no attribute mapping is done in the Web.config file. For more information on attribute mappings, see the individual properties in the <see cref="T:System.Web.Security.ActiveDirectoryMembershipUser" /> class documentation.</para>
<para>The following table lists the <see cref="T:System.Web.Security.ActiveDirectoryMembershipUser" /> properties and their default attribute mappings.</para>
<block subset="none" type="note">
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not explicitly check that provider attributes are not mapped to core attributes of the user object in the directory. You must ensure that sensitive information from the directory is not exposed through mapped attributes.</para>
</block>
<list type="table">
<listheader>
<item>
<term>
<para>Property</para>
</term>
<description>
<para>Default directory attribute</para>
</description>
<description>
<para>Can be mapped?</para>
</description>
</item>
</listheader>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.ProviderUserKey" />
</para>
</term>
<description>
<para>securityIdentifier</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.UserName" />
</para>
</term>
<description>
<para>userPrincipalName</para>
</description>
<description>
<para>Yes, but must be either userPrincipalName or sAMAccountName</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.Comment" />
</para>
</term>
<description>
<para>comment</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.CreationDate" />
</para>
</term>
<description>
<para>whenCreated</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.Email" />
</para>
</term>
<description>
<para>mail</para>
</description>
<description>
<para>Yes, but must be a single-valued attribute of type Unicode String.</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.LastActivityDate" />
</para>
</term>
<description>
<para>n/a</para>
</description>
<description>
<para>Not supported by <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" />.</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.LastLoginDate" />
</para>
</term>
<description>
<para>n/a</para>
</description>
<description>
<para>Not supported by <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" />.</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.LastPasswordChangedDate" />
</para>
</term>
<description>
<para>pwdLastSet</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.PasswordQuestion" />
</para>
</term>
<description>
<para>none</para>
</description>
<description>
<para>Yes, but must be a single-valued attribute of type Unicode String.</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.IsApproved" />
</para>
</term>
<description>
<para>User-Account-Control (AD)</para>
<para>mDS-UserAccountDisabled (ADAM)</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.IsLockedOut" />
</para>
</term>
<description>
<para>computed from lockoutTime and the AD lockout duration (AD on Windows 2000)</para>
<para>msDS-User-Account-Control-Computed (AD on Windows Server 2003)</para>
<para>msDS-User-Account-Control-Computed (ADAM)</para>
</description>
<description>
<para>No</para>
</description>
</item>
<item>
<term>
<para> <see cref="P:System.Web.Security.MembershipUser.LastLockoutDate" />
</para>
</term>
<description>
<para>If user is locked out due to too many bad password attempts, the lockout time attribute is returned.</para>
<para>If user is locked out due to too many bad password answer attempts, the value stored in the attribute defined by attributeMapFailedPasswordAnswerLockoutTime is returned.</para>
<para>If user is locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.</para>
<para>If the account is not locked out, return 1/1/1754 for SQL compatibility.</para>
</description>
<description>
<para>No</para>
</description>
</item>
</list>
<para>When both the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresQuestionAndAnswer" /> and <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> properties are true, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class supports password-reset security by requiring the user to answer a predetermined question. To support the question and answer, you must set the following configuration attributes using the <format type="text/html"><a href="8423ec7f-a06d-4606-977e-a46400b2fc18">add Element for providers for membership (ASP.NET Settings Schema)</a></format> in the application configuration file.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Configuration attribute</para>
</term>
<description>
<para>Attribute type</para>
</description>
</item>
</listheader>
<item>
<term>
<para> attributeMapPasswordQuestion
</para>
</term>
<description>
<para>Must be a single-valued attribute of type Unicode String.</para>
</description>
</item>
<item>
<term>
<para> attributeMapPasswordAnswer
</para>
</term>
<description>
<para>Must be a single-valued attribute of type Unicode String.</para>
</description>
</item>
<item>
<term>
<para> attributeMapFailedPasswordAnswerCount
</para>
</term>
<description>
<para>Must be a single-valued attribute of type Integer.</para>
</description>
</item>
<item>
<term>
<para> attributeMapFailedPasswordAnswerTime
</para>
</term>
<description>
<para>Must be a single-valued attribute of type Large Integer/Interval.</para>
</description>
</item>
<item>
<term>
<para> attributeMapFailedPasswordAnswerLockoutTime
</para>
</term>
<description>
<para>Must be a single-valued attribute of type Large Integer/Interval.</para>
</description>
</item>
</list>
<para>For more information on using password-reset security, see the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresQuestionAndAnswer" /> property.</para>
<format type="text/html">
<h2>Active Directory connections</h2>
</format>
<para>When the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class is used to connect to an Active Directory or an Active Directory Application Mode (ADAM) server, the connectionProtection attribute that is set using the <format type="text/html"><a href="8423ec7f-a06d-4606-977e-a46400b2fc18">add Element for providers for membership (ASP.NET Settings Schema)</a></format> in the application configuration file may restrict the types of operations the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class can perform over the connection. The connectionProtection attribute also determines the methods the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will use to create the connection to the Active Directory or ADAM server.</para>
<para>The following table shows the effect of the connectionProtection attribute when connecting to an Active Directory.</para>
<list type="table">
<listheader>
<item>
<term>
<para> connectionProtection setting</para>
</term>
<description>
<para>Effect</para>
</description>
</item>
</listheader>
<item>
<term>
<para> <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />
</para>
</term>
<description>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class will connect to an Active Directory, with these restrictions.</para>
<list type="bullet">
<item>
<para>Any method that sets a password will fail. Active Directory requires a secure connection when changing passwords.</para>
</item>
<item>
<para>You must explicitly set the connectionUsername and connectionPassword attributes using the <format type="text/html"><a href="8423ec7f-a06d-4606-977e-a46400b2fc18">add Element for providers for membership (ASP.NET Settings Schema)</a></format> in the application configuration file; otherwise, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will throw a <see cref="T:System.Configuration.Provider.ProviderException" /> exception.</para>
</item>
</list>
</description>
</item>
<item>
<term>
<para> Secure
</para>
</term>
<description>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class will attempt to connect to Active Directory using SSL. If SSL fails, a second attempt to connect to Active Directory using sign-and-seal will be made. If both attempts fail, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will throw a <see cref="T:System.Configuration.Provider.ProviderException" /> exception. </para>
<para>Both process credentials and explicit credentials are supported.</para>
</description>
</item>
</list>
<para>The following table shows the effect of the connectionProtection attribute when connecting to an ADAM server.</para>
<list type="table">
<listheader>
<item>
<term>
<para> connectionProtection setting </para>
</term>
<description>
<para>Effect</para>
</description>
</item>
</listheader>
<item>
<term>
<para> <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />
</para>
</term>
<description>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class will connect to an ADAM server, with this restriction.</para>
<list type="bullet">
<item>
<para>Any method that sets passwords will fail unless you explicitly configure the ADAM server to allow passwords to be sent and changed over an insecure connection.</para>
</item>
</list>
<para>Both process credentials and explicit credentials are supported.</para>
</description>
</item>
<item>
<term>
<para> Secure
</para>
</term>
<description>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class will attempt to connect to the ADAM server using SSL. If a connection cannot be made, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will throw a <see cref="T:System.Configuration.Provider.ProviderException" /> exception. </para>
<para>Both process credentials and explicit credentials are supported.</para>
</description>
</item>
</list>
<format type="text/html">
<h2>ADAM Configuration</h2>
</format>
<para>When using an ADAM server, the ADAM instance must contain a schema that defines the User class. You can import the User class with an LDIF import of the MS-User.ldf file available in the ADAM install directory. </para>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class will work with an ADAM server configured to use the default network ports. The following table shows the defaults expected for the ADAM server.</para>
<list type="table">
<listheader>
<item>
<term>
<para>connectionProtection setting</para>
</term>
<description>
<para>Expected ADAM port</para>
</description>
</item>
</listheader>
<item>
<term>
<para> <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />
</para>
</term>
<description>
<para>389</para>
</description>
</item>
<item>
<term>
<para> Secure
</para>
</term>
<description>
<para>636</para>
</description>
</item>
</list>
<para>If your ADAM server is not using the default ports, see article Q817583, "Active Directory Services does not request secure authorization over an SSL connection," in the <see cref="http://go.microsoft.com/fwlink/?linkid=37115">Microsoft Knowledge Base</see>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Manages storage of membership information for an ASP.NET application in Active Directory and Active Directory Application Mode servers.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActiveDirectoryMembershipProvider ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> constructor is called by ASP.NET to create an instance of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class as specified in the configuration for the application. This constructor is not intended to be used from your code.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new instance of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ApplicationName">
<MemberSignature Language="C#" Value="public override string ApplicationName { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.ApplicationName" /> property can be set to the name of the ASP.NET application; however, the application name is not used by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class.</para>
<para>Therefore, unlike other <see cref="T:System.Web.Security.MembershipProvider" /> implementations, all ASP.NET applications that access the same Active Directory data store will always share the same user data.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The name of the application using the custom membership provider.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChangePassword">
<MemberSignature Language="C#" Value="public override bool ChangePassword (string username, string oldPwd, string newPwd);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="oldPwd" Type="System.String" />
<Parameter Name="newPwd" Type="System.String" />
</Parameters>
<Docs>
<param name="oldPwd">To be added.</param>
<param name="newPwd">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ChangePassword(System.String,System.String,System.String)" /> method is used to update the user's password in the Active Directory data store. Regardless of the credentials that the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance is configured to use, the provider connects to the Active Directory server using the <paramref name="username" /> and <paramref name="oldPassword" /> parameters as the connection credentials.</para>
<para>If the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the user cannot change his or her password if the account was previously locked because the user made too many attempts to answer the password question. The user will need to wait the number of minutes specified in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property before changing the password.</para>
<para>If the password change succeeds and the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, then the user's bad password answer tracking counters are reset.</para>
<para>The provider finds the user instance to update by performing a subtree search for the user name starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para>To change passwords on an Active Directory server the connectionProtection attribute must be set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.SignAndSeal" />.</para>
<para>When using an ADAM server, the connectionProtection attribute can be set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />, but only if you explicitly configure the ADAM server to allow password change over unsecured connections.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Changes the password for the specified user.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> true if the password was updated successfully; otherwise, false.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the user to update the password for.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChangePasswordQuestionAndAnswer">
<MemberSignature Language="C#" Value="public override bool ChangePasswordQuestionAndAnswer (string username, string password, string newPwdQuestion, string newPwdAnswer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="password" Type="System.String" />
<Parameter Name="newPwdQuestion" Type="System.String" />
<Parameter Name="newPwdAnswer" Type="System.String" />
</Parameters>
<Docs>
<param name="newPwdQuestion">To be added.</param>
<param name="newPwdAnswer">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The method is called by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipUser" /> class to update the password question and answer for a user in the Active Directory membership store. </para>
<para>Requiring a password question and answer provides an additional layer of security when resetting a user's password. When creating a user name, a user can supply a question and answer that can later be used to reset a forgotten password. The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ChangePasswordQuestionAndAnswer(System.String,System.String,System.String,System.String)" /> method updates the password question and answer for a membership user to new values.</para>
<para>In order to use the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ChangePasswordQuestionAndAnswer(System.String,System.String,System.String,System.String)" /> method, you must set these additional attributes in your application's configuration file:</para>
<list type="bullet">
<item>
<para> requiresQuestionAndAnswer must be true.</para>
</item>
<item>
<para> attributeMapPasswordQuestion and attributeMapPasswordAnswer must be mapped to attributes in the Active Directory schema.</para>
</item>
</list>
<para>If the above criteria are not met, a <see cref="T:System.Configuration.Provider.ProviderException" /> is thrown at initialization.</para>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance connects to the Active Directory data store with the credentials provided in the <paramref name="username" /> and <paramref name="password" /> parameters to validate the user name/password combination. The actual update of the question and answer is performed with the configured connection credentials of the provider.</para>
<para>If an incorrect password is supplied to the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ChangePasswordQuestionAndAnswer(System.String,System.String,System.String,System.String)" /> method, the directory server will increment the counters that track invalid password attempts. This can result in the user being locked and unable to log on until either the lock status is cleared by a call to the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.UnlockUser(System.String)" /> method or the locked duration specified in the directory passes. </para>
<para>If the update to the question and answer succeeds and the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the user's bad password answer tracking counters are reset.</para>
<para>The password answer is encrypted using the <see cref="M:System.Web.Security.MembershipProvider.EncryptPassword(System.Byte[])" /> method before it is stored in the Active Directory data store. The encryption key and algorithm are specified by the <format type="text/html"><a href="4b5699a9-bc21-4c4a-85f1-8b3b8ebd2d46">machineKey</a></format> configuration element. The decryption attribute on the <format type="text/html"><a href="4b5699a9-bc21-4c4a-85f1-8b3b8ebd2d46">machineKey</a></format> element must be specified, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not support auto-generated encryption keys.</para>
<para>The maximum length for the password question is 256 characters. The maximum length for the password answer is 128 characters.</para>
<para>Leading and trailing spaces are trimmed from all parameter values except for <paramref name="password" />.</para>
<para>The provider finds the user instance to update by performing a subtree search for the user name starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Updates the password question and answer for a user in the Active Directory store.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> true if the update was successful; otherwise, false. A value of false is also returned if the password is incorrect, the user is locked out, or the user does not exist in the Active Directory data store.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The user to change the password question and answer for.</param>
<param name="password">
<attribution license="cc4" from="Microsoft" modified="false" />The password for the specified user.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateUser">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUser CreateUser (string username, string password, string email, string pwdQuestion, string pwdAnswer, bool isApproved, object providerUserKey, out System.Web.Security.MembershipCreateStatus status);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUser</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="password" Type="System.String" />
<Parameter Name="email" Type="System.String" />
<Parameter Name="pwdQuestion" Type="System.String" />
<Parameter Name="pwdAnswer" Type="System.String" />
<Parameter Name="isApproved" Type="System.Boolean" />
<Parameter Name="providerUserKey" Type="System.Object" />
<Parameter Name="status" Type="System.Web.Security.MembershipCreateStatus&" RefType="out" />
</Parameters>
<Docs>
<param name="username">To be added.</param>
<param name="password">To be added.</param>
<param name="email">To be added.</param>
<param name="pwdQuestion">To be added.</param>
<param name="pwdAnswer">To be added.</param>
<param name="isApproved">To be added.</param>
<param name="providerUserKey">To be added.</param>
<param name="status">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CurrentConnectionProtection">
<MemberSignature Language="C#" Value="public System.Web.Security.ActiveDirectoryConnectionProtection CurrentConnectionProtection { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.ActiveDirectoryConnectionProtection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.CurrentConnectionProtection" /> property indicates the current level of security that the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance is configured to use. The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.CurrentConnectionProtection" /> property is based on the connnectionProtection attribute set with the <format type="text/html"><a href="8423ec7f-a06d-4606-977e-a46400b2fc18">add Element for providers for membership (ASP.NET Settings Schema)</a></format> in the application configuration file.</para>
<para>The connectionProtection attribute can only be set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" /> or <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.SignAndSeal" /> in the configuration file.</para>
<para>See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the current level of security being used to protect communications with the server.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DeleteUser">
<MemberSignature Language="C#" Value="public override bool DeleteUser (string username, bool deleteAllRelatedData);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="deleteAllRelatedData" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.DeleteUser(System.String,System.Boolean)" /> method immediately removes the user identified by the <paramref name="username" /> parameter. Since the Active Directory data store does not store user information in separate areas of the directory, the <paramref name="deleteAllRelatedData" /> parameter is ignored, although it must be set to either true or false when calling the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.DeleteUser(System.String,System.Boolean)" /> method.</para>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class finds the user instance to delete by performing a single-level search for the user name in the users container determined by the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para> <paramref name="username" /> must be 64 characters or less.</para>
<block subset="none" type="note">
<para>You cannot delete users unless the credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "delete child instances" access right.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes a user's membership information from the Active Directory data store.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> true if the user was deleted; otherwise, false if the user was not found in the data store.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the user to delete.</param>
<param name="deleteAllRelatedData">
<attribution license="cc4" from="Microsoft" modified="false" />This parameter is ignored by the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.DeleteUser(System.String,System.Boolean)" /> method. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EnablePasswordReset">
<MemberSignature Language="C#" Value="public override bool EnablePasswordReset { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property indicates whether you can use the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method to reset a user's password. The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is set in your application's configuration file using the enablePasswordReset attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element.</para>
<para>You can only set the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property true when the following <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element settings have been made.</para>
<list type="bullet">
<item>
<para> requiresQuestionAndAnswer must be true.</para>
</item>
<item>
<para>The Active Directory schema must be modified to contain attributes for storing the password question and answer, as well as the three tracking fields for password-answer change attempts.</para>
</item>
<item>
<para> attributeMapPasswordQuestion, attributeMapPasswordAnswer, attributeMapFailedPasswordAnswerCount, attributeMapFailedPasswordAnswerTime, and attributeMapFailedPasswordAnswerLockoutTime must be mapped to attributes in the Active Directory schema.</para>
</item>
</list>
<para>If the above criteria are not met, a <see cref="T:System.Configuration.Provider.ProviderException" /> is thrown at initialization.</para>
<para>When the connection string in the application configuration file specifies an Active Directory domain rather than a specific server, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will always connect to the domain controller that has the PDC role for the domain to ensure that password changes take effect and are available when the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ValidateUser(System.String,System.String)" /> method is called.</para>
<block subset="none" type="note">
<para>Even if the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, you cannot reset user passwords unless the credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "reset password" access right.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance is configured to allow users to reset their passwords.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EnablePasswordRetrieval">
<MemberSignature Language="C#" Value="public override bool EnablePasswordRetrieval { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not support password retrieval. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the user's password can be retrieved from the Active Directory data store. This property always returns false.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="EnableSearchMethods">
<MemberSignature Language="C#" Value="public bool EnableSearchMethods { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Because searching an Active Directory server is potentially resource intensive, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnableSearchMethods" /> property enables you to turn off search-oriented <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> methods. The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnableSearchMethods" /> property is set in your application's configuration file using the enableSearchMethods attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element.</para>
<para>When the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnableSearchMethods" /> property is false, the following methods are not available:</para>
<list type="bullet">
<item>
<para> <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.FindUsersByName(System.String,System.Int32,System.Int32,System.Int32@)" />
</para>
</item>
<item>
<para> <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.FindUsersByEmail(System.String,System.Int32,System.Int32,System.Int32@)" />
</para>
</item>
<item>
<para> <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetAllUsers(System.Int32,System.Int32,System.Int32@)" />
</para>
</item>
</list>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para>We recommend that you do not enable searching on production systems until you have confirmed that the search queries issued by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class do not adversely impact your directory server's performance. Since the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class is designed for a stateless Web environment, it is unable to use the paging optimizations exposed by the underlying <see cref="N:System.DirectoryServices" /> APIs. This means that paging operations during searches against large directories are very expensive and should be avoided. Search operations are always issued against the directory server configured in the connection string, or an automatically selected server in the case of a connection string pointing at a domain. The provider does not use a global catalog for its search methods.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether search-oriented <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> methods are available.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FindUsersByEmail">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUserCollection FindUsersByEmail (string emailToMatch, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUserCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="emailToMatch" Type="System.String" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="emailToMatch">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FindUsersByName">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUserCollection FindUsersByName (string nameToMatch, int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUserCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="nameToMatch" Type="System.String" />
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="nameToMatch">To be added.</param>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GeneratePassword">
<MemberSignature Language="C#" Value="public virtual string GeneratePassword ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GeneratePassword" /> method of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class calls the <see cref="M:System.Web.Security.Membership.GeneratePassword(System.Int32,System.Int32)" /> method of the <see cref="T:System.Web.Security.Membership" /> class to retrieve a random password. The password length is set to the value of the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredPasswordLength" /> property. The password length can never be less than 14.</para>
<para>You can specifically call the <see cref="M:System.Web.Security.Membership.GeneratePassword(System.Int32,System.Int32)" /> method by referencing the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class directly from the Provider property of the <see cref="T:System.Web.Security.Membership" /> class.</para>
<para>The generated password only contains alphanumeric characters and the following punctuation marks: !@#$%^&*()_-+=[{]};:<>|./?. No hidden or non-printable control characters are included in the generated password.</para>
<para>The generated password will contain at least the number of non-alphanumeric characters specified in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredNonAlphanumericCharacters" /> property. The generated password will not be tested with the regular expression in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordStrengthRegularExpression" /> property.</para>
<block subset="none" type="note">
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not generate passwords that match complexity requirements set in the directory. It is possible to generate a random password that fails the password complexity rules set by the directory.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Generates a random password.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A random password.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetAllUsers">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUserCollection GetAllUsers (int pageIndex, int pageSize, out int totalRecords);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUserCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pageIndex" Type="System.Int32" />
<Parameter Name="pageSize" Type="System.Int32" />
<Parameter Name="totalRecords" Type="System.Int32&" RefType="out" />
</Parameters>
<Docs>
<param name="pageIndex">To be added.</param>
<param name="pageSize">To be added.</param>
<param name="totalRecords">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetNumberOfUsersOnline">
<MemberSignature Language="C#" Value="public override int GetNumberOfUsersOnline ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not support returning the number of users online.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Throws a <see cref="T:System.NotSupportedException" /> exception in all cases.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.NotSupportedException" /> in all cases.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetPassword">
<MemberSignature Language="C#" Value="public override string GetPassword (string username, string answer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="answer" Type="System.String" />
</Parameters>
<Docs>
<param name="answer">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not support returning the user's password.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the password of the specified user from the database. The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class does not support this method.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Always throws a <see cref="T:System.NotSupportedException" /> exception.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The user to retrieve the password for.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUser">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUser GetUser (object providerUserKey, bool userIsOnline);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUser</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="providerUserKey" Type="System.Object" />
<Parameter Name="userIsOnline" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetUser(System.String,System.Boolean)" /> method is called by the <see cref="T:System.Web.Security.Membership" /> class to retrieve information on the specified user from the Active Directory data store. </para>
<para>The search looks for a user instance where the objectSID attribute matches the <paramref name="providerUserKey" /> parameter.</para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the membership user information associated with the specified user key.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.Security.MembershipUser" /> instance representing the user specified. If no user is found in the Active Directory data store for the specified <paramref name="providerUserKey" /> value, null is returned.</para>
</returns>
<param name="providerUserKey">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the user.</param>
<param name="userIsOnline">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetUser(System.Object,System.Boolean)" /> method ignores this parameter.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUser">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipUser GetUser (string username, bool userIsOnline);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipUser</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="userIsOnline" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetUser(System.String,System.Boolean)" /> method is called by the <see cref="T:System.Web.Security.Membership" /> class to retrieve information on the specified user from the Active Directory data store. </para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para>Leading and trailing spaces are trimmed from the <paramref name="username" /> parameter value.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the membership user information associated with the specified user name.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.Security.MembershipUser" /> instance representing the user specified. If no user is found in the Active Directory data store for the specified <paramref name="username" /> value, null is returned.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the user to get information for.</param>
<param name="userIsOnline">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetUser(System.String,System.Boolean)" /> method ignores this parameter.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUserNameByEmail">
<MemberSignature Language="C#" Value="public override string GetUserNameByEmail (string email);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="email" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called by the <see cref="T:System.Web.Security.Membership" /> class to retrieve a user name from the Active Directory data store based on the e-mail address for the user.</para>
<para>If more than one user in the membership data store has the same e-mail address, the first user name encountered is returned. You can set the requiresUniqueEmail attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element to true in the application configuration file to ensure that each e-mail address in the database is unique.</para>
<para>Leading and trailing spaces are trimmed from the <paramref name="email" /> parameter value. If the e-mail address is empty after trimming, an <see cref="T:System.ArgumentException" /> is thrown. If the e-mail address is null, all user names in the Active Directory data store are searched, and the first user name is returned.</para>
<para>We recommend that you do not enable searching on production systems until you have confirmed that the search queries issued by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class do not adversely impact your directory server's performance.</para>
<block subset="none" type="note">
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GetUserNameByEmail(System.String)" /> method will run even when the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnableSearchMethods" /> property is false.</para>
</block>
<para>Since the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class is designed for a stateless Web environment, it is unable to use the paging optimizations exposed by the underlying <see cref="N:System.DirectoryServices" /> APIs. This means that paging operations during searches against large directories are very expensive and should be avoided. Search operations are always issued against the directory server configured in the connection string, or an automatically selected server in the case of a connection string pointing at a domain. The provider does not use a global catalog for its search methods.</para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the user name associated with the specified e-mail address.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The user name associated with the specified e-mail address.</para>
</returns>
<param name="email">
<attribution license="cc4" from="Microsoft" modified="false" />The e-mail address to search for.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public override void Initialize (string name, System.Collections.Specialized.NameValueCollection config);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="config" Type="System.Collections.Specialized.NameValueCollection" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method initializes the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> object with the property values specified in the ASP.NET application configuration file (Web.config) and is not intended to be used directly from your code.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance with the property values from the application's configuration files. This method is not intended to be called from your code.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance to initialize.</param>
<param name="config">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.Specialized.NameValueCollection" /> containing the names and values of the configuration options for the membership provider.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MaxInvalidPasswordAttempts">
<MemberSignature Language="C#" Value="public override int MaxInvalidPasswordAttempts { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the user must answer the password question to reset his or her password. The user is allowed a limited number of answer attempts within the time window established by the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property. If the number of password answer attempts is greater than or equal to the value stored in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property, the user is locked out of further attempts for the number of minutes stored in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property.</para>
<block subset="none" type="note">
<para>This property does not control the number of failed logon attempts a user can make before being locked out. The Active Directory server handles failed logon attempts and is not affected by the value of this property.</para>
</block>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property is set in your application's configuration file using the maxInvalidPasswordAttempts attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element. If the property is not set in the application's configuration file, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property is set to the default value of 5.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the number of failed answer attempts a user is allowed for the password-reset question.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MinRequiredNonAlphanumericCharacters">
<MemberSignature Language="C#" Value="public override int MinRequiredNonAlphanumericCharacters { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredNonAlphanumericCharacters" /> property returns the minimum number of special, non-alphanumeric characters that must be entered to create a valid password.</para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredNonAlphanumericCharacters" /> property value is set in the application configuration using the minRequiredNonalphanumericCharacters attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> configuration element.</para>
<para>A non-alphanumeric character is a character for which the <see cref="M:System.Char.IsLetterOrDigit(System.Char)" /> method returns false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the minimum number of special characters that must be present in a valid password.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="MinRequiredPasswordLength">
<MemberSignature Language="C#" Value="public override int MinRequiredPasswordLength { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredPasswordLength" /> property gets the minimum number of characters that must be entered to create a valid password.</para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredPasswordLength" /> property value is set in the application configuration using the minRequiredPasswordLength attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> configuration element.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the minimum length required for a password.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PasswordAnswerAttemptLockoutDuration">
<MemberSignature Language="C#" Value="public int PasswordAnswerAttemptLockoutDuration { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the user must answer the password question to reset his or her password. If the user fails to supply the correct answer a consecutive number of times equal to the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property value within the observation time period specified by the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property, the user is locked out of further attempts for the number of minutes contained in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property.</para>
<block subset="none" type="note">
<para>This property does not set the duration a user is locked out after failing to enter a valid password. The Active Directory server handles failed logon attempts and is not affected by the value of this property. We recommend that the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property be set to the same value as the account lockout duration specified for too many failed logon attempts in the Active Directory configuration. This will present consistent auto-lockout behavior for users regardless of whether they were locked out due to failed logon attempts or to bad password answers.</para>
</block>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property is set in your application's configuration file using the passwordAnswerAttemptLockoutDuration attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element. If the property is not set in the application's configuration file, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property is set to the default value of 30 minutes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Get the length of time for which a user account is locked out after the user makes too many bad password-answer attempts.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PasswordAttemptWindow">
<MemberSignature Language="C#" Value="public override int PasswordAttemptWindow { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property works in conjunction with the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property to help guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. When users are attempting to log in, change their password, or reset their password, only a certain number of consecutive attempts are allowed within a specified time window. The length of the time window is specified by the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property, which identifies the number of minutes allowed between invalid attempts. If the number of consecutive failed attempts a user makes to reset his or her password equals the value stored in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property, and the time elapsed since the last invalid attempt is less than the number of minutes specified for the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property, then the user account s locked out for the number of minutes contained in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property. If the interval between the current failed attempt and the last failed attempt is greater than the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property setting, the current invalid attempt is counted as the first attempt. If a valid password answer is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password-answer attempts is set to zero. If a valid password is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password attempts and the count of invalid password-answer attempts are set to zero.</para>
<para>We recommend that the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property be set to the same value as the account lockout duration that is specified for the maximum number of failed logon attempts in the Active Directory configuration. This will present consistent auto-lockout behavior for users whether they were locked out due to failed logon attempts or to bad password answers.</para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property is set in your application's configuration file using the passwordAttemptWindow attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element. If the property is not set in the application's configuration file, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property is set to the default value of 10 minutes.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the time window during which consecutive failed attempts to provide a valid password or a valid password answer are tracked.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PasswordFormat">
<MemberSignature Language="C#" Value="public override System.Web.Security.MembershipPasswordFormat PasswordFormat { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Web.Security.MembershipPasswordFormat</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> property does not support password retrieval. The behavior of the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> object is the same as other providers working with Hashed passwords.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating the format of passwords in the Active Directory data store.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PasswordStrengthRegularExpression">
<MemberSignature Language="C#" Value="public override string PasswordStrengthRegularExpression { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordStrengthRegularExpression" /> property gets the regular expression used to evaluate password complexity. </para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordStrengthRegularExpression" /> property is not used to validate auto-generated passwords in the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method.</para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordStrengthRegularExpression" /> property is set in the application configuration using the passwordStrengthRegularExpression attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> configuration element.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the regular expression used to evaluate a password.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RequiresQuestionAndAnswer">
<MemberSignature Language="C#" Value="public override bool RequiresQuestionAndAnswer { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresQuestionAndAnswer" /> property is set in your application's configuration file using the requiresQuestionAndAnswer attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element. If the property is not set in the application's configuration file, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresQuestionAndAnswer" /> property is set to the default value of false.</para>
<para>When the requiresQuestionAndAnswer attribute is set to true, you must also set these additional attributes.</para>
<list type="bullet">
<item>
<para> attributeMapPasswordQuestion and attributeMapPasswordAnswer must be mapped to attributes in the Active Directory schema.</para>
</item>
</list>
<para>If the above criteria are not met, a <see cref="T:System.Configuration.Provider.ProviderException" /> is thrown at initialization.</para>
<block subset="none" type="note">
<para>You can require a password question and answer when creating a user, but set the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property to false to prevent users from changing their passwords using the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the membership provider is configured to require a password question and answer when creating a user.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="RequiresUniqueEmail">
<MemberSignature Language="C#" Value="public override bool RequiresUniqueEmail { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresUniqueEmail" /> property is true, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance ensures that the e-mail address is not used by any other user within the current scope when either the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)" /> or <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.UpdateUser(System.Web.Security.MembershipUser)" /> method is called. </para>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresUniqueEmail" /> property is set in your application's configuration file using the requiresUniqueEmail attribute of the <format type="text/html"><a href="b9c1ee8f-33ca-4361-8666-b42a0fe86049">membership</a></format> element. If the property is not set in the application's configuration file, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresUniqueEmail" /> property is set to the default value of false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether an e-mail address stored on the Active Directory server must be unique.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ResetPassword">
<MemberSignature Language="C#" Value="public override string ResetPassword (string username, string answer);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="answer" Type="System.String" />
</Parameters>
<Docs>
<param name="answer">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The method is called by the <see cref="T:System.Web.Security.Membership" /> class to reset the password for a user in the Active Directory data store to a new randomly generated value. The new password is returned.</para>
<block subset="none" type="note">
<para>The random password created by the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method is not guaranteed to pass the regular expression in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordStrengthRegularExpression" /> property. However, the random password will meet the criteria established by the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredPasswordLength" /> and <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MinRequiredNonAlphanumericCharacters" /> properties.</para>
</block>
<para>If an incorrect answer is supplied to the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method, the internal counter that tracks invalid password-answer attempts is incremented by one. This can result in the user being unable to log on until the lock status is cleared by a call to the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.UnlockUser(System.String)" /> method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password attempts is reset to zero. For more information, see the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> and <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> properties.</para>
<para>Leading and trailing spaces are trimmed from all parameter values.</para>
<para>You can call the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method directly by first obtaining a reference to the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance from the <see cref="P:System.Web.Security.Membership.Provider" /> property.</para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para>To set passwords on an Active Directory server, the connectionProtection attribute must be set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.SignAndSeal" />.</para>
<para>When using an ADAM server, the connectionProtection attribute can be set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />, but only if you explicitly configure the ADAM server to allow password changes over unsecured connections.</para>
<block subset="none" type="note">
<para>You cannot reset passwords unless the credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "reset password" access right.</para>
</block>
<para>To reset a password, all of the following conditions must be true:</para>
<list type="bullet">
<item>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property must be set to true.</para>
</item>
<item>
<para>The Active Directory schema must be modified to contain attributes for storing the password question and answer, and the three tracking fields for password answer changes.</para>
</item>
<item>
<para>The attributeMapPasswordQuestion, attributeMapPasswordAnswer, attributMapFailedPasswordAnswerCount, attributeMapFailedPasswordAnswerTime, and attributeMapFailedPasswordAnswerLockedTime attributes must be set in the application configuration file.</para>
</item>
<item>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.RequiresQuestionAndAnswer" /> property must be set to true.</para>
</item>
<item>
<para>The security context for connecting to the Active Directory data store (either the process account or the explicit credentials) must have sufficient privileges to change passwords. The credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "reset password" access right.</para>
</item>
</list>
<block subset="none" type="note">
<para>Security policies set on the Active Directory server may make it impossible for the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ResetPassword(System.String,System.String)" /> method to generate a password that satisfies the policies. The default implementation of the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.GeneratePassword" /> method will generate passwords that satisfy the default password policies on domain controllers running Windows Server 2003 SP1. If the password cannot be reset due to security policies on the Active Directory server, a <see cref="T:System.Configuration.Provider.ProviderException" /> is thrown.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Resets a user's password to a new, automatically generated password.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The new password for the specified user.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The user to reset the password for.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UnlockUser">
<MemberSignature Language="C#" Value="public override bool UnlockUser (string userName);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userName" Type="System.String" />
</Parameters>
<Docs>
<param name="userName">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Users are most commonly locked out and cannot be validated by the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ValidateUser(System.String,System.String)" /> method when the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.MaxInvalidPasswordAttempts" /> property is exceeded within the time specified in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAttemptWindow" /> property or when too many attempts have been made to log on using the wrong password.</para>
<para>If the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, when a user is unlocked the counters for bad passwords are reset.</para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
<para>Leading and trailing spaces are trimmed from the <paramref name="username" /> parameter value.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Clears a lock so that a membership user can be validated.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> true if the membership user was successfully unlocked; otherwise, false. The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.UnlockUser(System.String)" /> method also returns false when the membership user is not found in the data store.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="UpdateUser">
<MemberSignature Language="C#" Value="public override void UpdateUser (System.Web.Security.MembershipUser user);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="user" Type="System.Web.Security.MembershipUser" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called by the <see cref="T:System.Web.Security.Membership" /> class to update user information in the Active Directory data store. The <see cref="P:System.Web.Security.MembershipUser.Email" />, <see cref="P:System.Web.Security.MembershipUser.Comment" />, and <see cref="P:System.Web.Security.MembershipUser.IsApproved" /> property values are updated for the specified membership user. All other properties are ignored.</para>
<para>The maximum length for the <paramref name="username" /> parameter is 256 characters. The maximum length for the <see cref="P:System.Web.Security.MembershipUser.Email" /> property is 256 characters.</para>
<para>The password for a membership user cannot be updated using the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.UpdateUser(System.Web.Security.MembershipUser)" /> method. To update the password for a membership user, use the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ChangePassword(System.String,System.String,System.String)" /> method.</para>
<para>The provider uses a subtree search starting at the search point specified in the connection string. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Updates information about a user in the Active Directory data store.</para>
</summary>
<param name="user">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.Security.MembershipUser" /> instance representing the user to update and the updated information for the user.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ValidateUser">
<MemberSignature Language="C#" Value="public override bool ValidateUser (string username, string password);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="username" Type="System.String" />
<Parameter Name="password" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called by the <see cref="T:System.Web.Security.Membership" /> class to validate user credentials against the Active Directory data store.</para>
<para>If the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true and the supplied credentials are valid, the user's tracking counters for bad password answers are reset.</para>
<para>The <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ValidateUser(System.String,System.String)" /> method may return false when the correct credentials are supplied, under the following circumstances:</para>
<list type="ordered">
<item>
<para>The user account was locked out by the directory server because of too many failed logon attempts. The user will not be able to log on until the directory's lockout duration passes.</para>
</item>
<item>
<para>If the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the user account will be locked if the user supplied a bad password answer too many times. The user's account will unlock after the time specified in the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.PasswordAnswerAttemptLockoutDuration" /> property has passed.</para>
</item>
<item>
<para>The user must exist in the container specified in the connection string. Valid credentials are supplied for a user account located in a different container or in a different domain. The user must exist in the container specified in the connection string.</para>
</item>
</list>
<para>When validating a user, the provider validates the credentials by connecting to the Active Directory data store using the specified user name and password, not the credentials configured in the application configuration file.</para>
<para>However, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will connect to the directory using the configured credentials for the following reasons.</para>
<list type="bullet">
<item>
<para>To confirm that a user exists within the search scope as determined by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance's connection string. The provider uses a subtree search starting at the search point specified in the connection string to determine whether a user exists. The user must exist in the specified container. Credentials that are valid outside the connection string's specified container will not be validated. See the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> class topic for more information about connection strings. </para>
</item>
<item>
<para>If the <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.EnablePasswordReset" /> property is true, the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will use the configured credentials to load the user instance to check whether the user has been locked out because he or she has made too many failed attempts to change the password answer.</para>
</item>
</list>
<block subset="none" type="note">
<para>Connecting to an Active Directory domain controller with the "Guest" account enabled is a potential security threat. All validation attempts made on an Active Directory domain controller with the "Guest" account enabled will succeed. To improve security when using an Active Directory domain controller, you should disable the "Guest" account on the domain controller.</para>
</block>
<para>The <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance will attempt a concurrent bind against Active Directory when one of the following conditions is met:</para>
<list type="bullet">
<item>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.CurrentConnectionProtection" /> property is set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.None" />.</para>
</item>
<item>
<para>The <see cref="P:System.Web.Security.ActiveDirectoryMembershipProvider.CurrentConnectionProtection" /> property is set to <see cref="F:System.Web.Security.ActiveDirectoryConnectionProtection.SignAndSeal" /> and SSL is chosen by the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance to secure the connection.</para>
</item>
</list>
<para>In addition, for a concurrent bind to be made, the following conditions must be true:</para>
<list type="bullet">
<item>
<para>The directory server must be running on Windows Server 2003.</para>
</item>
<item>
<para>The operating system of the Web server running the <see cref="T:System.Web.Security.ActiveDirectoryMembershipProvider" /> instance must support concurrent binds (for example, Windows Server 2003).</para>
</item>
</list>
<para>When a concurrent bind is used, the last logon date for the user is not updated in the directory; therefore, the <see cref="P:System.Web.Security.ActiveDirectoryMembershipUser.LastLoginDate" /> property cannot be relied on.</para>
<para>Leading and trailing spaces are trimmed from the <paramref name="username" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Verifies that the specified user name and password exist in the Active Directory data store.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para> true if the specified <paramref name="username" /> and <paramref name="password" /> are valid; otherwise, false. If the user specified does not exist in the Active Directory data store, the <see cref="M:System.Web.Security.ActiveDirectoryMembershipProvider.ValidateUser(System.String,System.String)" /> method returns false.</para>
</returns>
<param name="username">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the user to validate.</param>
<param name="password">
<attribution license="cc4" from="Microsoft" modified="false" />The password for the specified user.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|