メンバシップ プロバイダの実装

Initialize メソッド

プロバイダの名前および構成設定の NameValueCollection を入力として受け取ります。構成で提供される構成ファイル (Machine.config または Web.config) に指定された実装固有の値およびオプションを含むプロバイダ インスタンスに対してプロパティ値を設定するために使用します。

EnablePasswordReset プロパティ

構成ファイル (Web.config) に指定された Boolean 値。

EnablePasswordReset プロパティは、ユーザーが ResetPassword メソッドを使用して現在のパスワードをランダムに生成された新しいパスワードで上書きできるかどうかを示します。

このプロパティは読み取り専用です。

RequiresQuestionAndAnswer プロパティ

構成ファイル (Web.config) に指定された Boolean 値。

RequiresQuestionAndAnswer プロパティは、ユーザーが GetPassword メソッドを使用してパスワードを取得したり ResetPassword パスワードを使用してパスワードをリセットしたりするために、パスワードの解答を指定する必要があるかどうかを示します。

このプロパティは読み取り専用です。

PasswordFormat プロパティ

構成ファイル (Web.config) に指定された MembershipPasswordFormat 値。

PasswordFormat プロパティは、パスワードの格納形式を示します。パスワードは、Clear、Encrypted、Hashed のいずれかのパスワード形式で格納できます。Clear パスワードはプレーンテキストで格納されます。この形式では、パスワードの格納および取得のパフォーマンスは向上しますが、データ ソースが侵害された場合にパスワードが簡単に読み取られるため、安全性は低くなります。Encrypted パスワードは格納時に暗号化され、パスワードを比較または取得するために復号化できます。この形式では、パスワードを格納および取得するために追加の処理が必要になりますが、データ ソースが侵害されてもパスワードを簡単に特定できないため、安全性が向上します。Hashed パスワードは、データベースへの格納時に一方向のハッシュ アルゴリズムとランダム生成された salt 値を使用してハッシュされます。パスワードの検証では、パスワードはデータベースの salt 値を使用してハッシュされて検査されます。ハッシュされたパスワードは取得できません。

MembershipProvider クラスの EncryptPassword 仮想メソッドおよび DecryptPassword 仮想メソッドを使用してパスワード値を暗号化および復号化するか、または独自の暗号化コードを記述できます。MembershipProvider クラスの EncryptPassword 仮想メソッドおよび DecryptPassword 仮想メソッドを使用する場合、Encrypted パスワードは、構成の machineKey 要素 (ASP.NET 設定スキーマ) に指定されているキー情報を使用して暗号化されます。

このプロパティは読み取り専用です。

PasswordAttemptWindow プロパティ

構成ファイル (Web.config) に指定された Integer 値。

説明については、MaxInvalidPasswordAttempts プロパティの説明を参照してください。

このプロパティは読み取り専用です。

CreateUser メソッド

新しいユーザーの名前、パスワード、および電子メール アドレスを入力として受け取り、アプリケーションの新しいユーザーをデータ ソースに挿入します。CreateUser メソッドは、この新しく作成されたユーザーの情報が設定された MembershipUser オブジェクトを返します。また、CreateUser メソッドは MembershipCreateStatus 値を返す out パラメータも定義します (Visual Basic では、ByRef を使用できます)。この値は、ユーザーが正常に作成されたかどうか、またはユーザーが正常に作成されなかった理由を示します。

MembershipValidatePasswordEventHandler が指定されている場合、CreateUser メソッドは ValidatingPassword イベントを発生させ、イベントの結果に基づいてユーザーの作成操作を続行またはキャンセルします。OnValidatingPassword 仮想メソッドを使用すると、指定した MembershipValidatePasswordEventHandler を実行できます。

DeleteUser メソッド

ユーザーの名前を入力として受け取り、そのユーザーの情報をデータ ソースから削除します。ユーザーが正常に削除された場合、DeleteUser メソッドは true を返します。それ以外の場合は false を返します。ロールやプロファイル情報など、ユーザーに関連する情報も削除されているかどうかを示すために、追加の Boolean パラメータが用意されています。

GetUser メソッド

一意のユーザー ID およびこのユーザーが現在オンラインであることを示すユーザーの LastActivityDate 値を更新するかどうかを示す Boolean 値を入力として受け取ります。GetUser メソッドは、指定されたユーザーに対するデータ ソースの現在値が設定された MembershipUser オブジェクトを返します。該当するユーザー名がデータ ソース内に見つからない場合、GetUser メソッドは null (Visual Basic では Nothing) を返します。

GetAllUsers メソッド

データ ソース内のすべてのユーザーの MembershipUser オブジェクトが設定された MembershipUserCollection を返します。

GetAllUsers が返す結果は、pageIndex パラメータおよび pageSize パラメータによって制約されます。pageSize パラメータは、MembershipUserCollection で返す MembershipUser オブジェクトの最大数を指定します。pageIndex パラメータは、結果のどのページを返すかを指定します。1 は最初のページを示します。totalRecords パラメータは、メンバシップ ユーザーの総数に設定される out パラメータです。たとえば、アプリケーションのデータベースに 13 人のユーザーが存在し、pageIndex 値が 2、pageSize が 5 に設定されている場合、返される MembershipUserCollection には 6 番目から 10 番目に返されたユーザーが含まれ、totalRecords は 13 に設定されます。

ResetPassword メソッド

ユーザー名とパスワードの解答を入力として受け取り、指定したユーザーに対して、ランダムな新しいパスワードを生成します。ResetPassword メソッドは、データ ソース内のユーザー情報を新しいパスワード値で更新し、string として新しいパスワードを返します。Membership クラスの GeneratePassword メソッドはランダムなパスワードを生成する場合に便利です。

ResetPassword メソッドを使用すると、任意の操作を実行する前に EnablePasswordReset プロパティが true に設定されます。EnablePasswordReset プロパティが false の場合、NotSupportedException がスローされます。ResetPassword メソッドは RequiresQuestionAndAnswer プロパティの値もチェックします。RequiresQuestionAndAnswer プロパティが true の場合、ResetPassword メソッドは指定した解答パラメータ値とデータ ソースに格納されたパスワードの解答が一致しているかどうかをチェックします。一致しない場合は、MembershipPasswordException がスローされます。

MembershipValidatePasswordEventHandler が指定されている場合、ResetPassword メソッドは ValidatingPassword イベントを発生させて新しく生成されたパスワードを検証し、イベントの結果に基づいてパスワードのリセット操作を続行またはキャンセルします。OnValidatingPassword 仮想メソッドを使用すると、指定した MembershipValidatePasswordEventHandler を実行できます。

GetUserNameByEmail メソッド

電子メール アドレスを入力として受け取り、指定した email パラメータ値とその電子メール アドレスが一致した場合に、データ ソースの最初のユーザー名を返します。

電子メール アドレスが一致するユーザー名が見つからない場合は、空の文字列が返されます。

特定の電子メール アドレスと一致するユーザー名が複数見つかった場合は、最初のユーザー名だけが返されます。

ChangePasswordQuestionAndAnswer メソッド

ユーザー名、パスワード、パスワードの質問、およびパスワードの解答を入力として受け取り、指定されたユーザー名とパスワードが有効な場合、データ ソース内のパスワードの質問と解答を更新します。パスワードの質問と解答が正常に更新された場合、ChangePasswordQuestionAndAnswer メソッドは true を返します。それ以外の場合は false を返します。

指定されたユーザー名およびパスワードが有効でない場合は、false を返します。

FindUsersByEmail メソッド

メンバシップ ユーザーのリストを返します。ユーザー名には、構成済みの ApplicationName に対して指定した emailToMatch と一致するユーザーが表示されます。たとえば、emailToMatch パラメータが "address@example.com" に設定されている場合、"address1@example.com"、"address2@example.com" などの電子メール アドレスを持つユーザーが返されます。データ ソースによっては、ワイルドカードがサポートされます。ユーザーは、ユーザー名のアルファベット順に返されます。

FindUsersByEmail が返す結果は、pageIndex パラメータおよび pageSize パラメータによって制約されます。pageSize パラメータは、MembershipUserCollection コレクションで返す MembershipUser オブジェクトの数を指定します。pageIndex パラメータは、結果のどのページを返すかを指定します。1 は最初のページを示します。totalRecords パラメータは、emailToMatch 値と一致したメンバシップ ユーザーの総数に設定される out パラメータです。たとえば、emailToMatch がユーザー名の一部または完全なユーザー名に一致するユーザーが 13 人見つかったとします。pageIndex の値は 2、pageSize の値は 5 に設定されています。この場合、MembershipUserCollection には 6 番目から 10 番目に返されたユーザーが含まれ、totalRecords は 13 に設定されます。