SqlMembershipProvider.GetPassword(String, String) メソッド

リファレンス

定義

名前空間:: System.Web.Security

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

SQL Server メンバーシップデータベースから指定のユーザー名のパスワードを返します。

public:
 override System::String ^ GetPassword(System::String ^ username, System::String ^ passwordAnswer);

public override string GetPassword (string username, string passwordAnswer);

override this.GetPassword : string * string -> string

Public Overrides Function GetPassword (username As String, passwordAnswer As String) As String

パラメーター

username: String

パスワードを取得する対象となるユーザー。

passwordAnswer: String

ユーザーのパスワードの解答。

戻り値

String

指定したユーザー名のパスワード。

例外

MembershipPasswordException

passwordAnswer が無効です。

- または -

username で識別されるメンバーシップユーザーはロックされています。

NotSupportedException

EnablePasswordRetrieval が false に設定されます。

ProviderException

username がメンバーシップデータベース内に見つかりません。

- または -

データベースからパスワードを取得しているときにエラーが発生しました。

ArgumentException

パラメーター値の 1 つが最大長を超えています。

- または -

username が空の文字列 ("") であるか、コンマを含んでいるか、または 256 文字を超えています。

- または -

passwordAnswer が空の文字列で RequiresQuestionAndAnswer が true です。

- または -

passwordAnswer が 128 文字を超えています。

- または -

エンコードされた passwordAnswer の長さが 128 文字を超えています。

ArgumentNullException

username が nullです。

- または -

passwordAnswer が null で、RequiresQuestionAndAnswer が true です。

例

次のコード例では、指定したユーザー名のパスワードを取得し、電子メールメッセージでユーザーに送信します。

注意

高レベルのセキュリティを必要とするサイトでは、電子メールを使用してクリアテキストでパスワードを返すのはお勧めしません。セキュリティの高いサイトの場合は、SSL などの暗号化を使用してパスワードを返することをお勧めします。

注意

このサンプルでは、クラスをSqlMembershipProvider使用Membershipして、指定したを Web.config ファイル内のとしてdefaultProvider呼び出します。型SqlMembershipProviderとして既定のプロバイダーにアクセスする必要がある場合は、クラスのプロパティをProvider Membershipキャストできます。特定のプロバイダーの種類として他の構成済みプロバイダーにアクセスするには、クラスのプロパティを使用して構成された名前で Providers アクセスし、特定のプロバイダーの Membership 種類としてキャストします。

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Net.Mail" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

public void Page_Load(object sender, EventArgs args)
{
  if (!Membership.EnablePasswordRetrieval)
  {
    FormsAuthentication.RedirectToLoginPage();
  }

  Msg.Text = "";

  if (!IsPostBack)
  {
    Msg.Text = "Please enter a user name.";
  }
  else
  {
    VerifyUsername();
  }
}


public void VerifyUsername()
{
    MembershipUser user = Membership.GetUser(UsernameTextBox.Text, false);

    if (user == null)
    {
      Msg.Text = "The user name " + Server.HtmlEncode(UsernameTextBox.Text) + " was not found. Please check the value and re-enter.";

      QuestionLabel.Text = "";
      QuestionLabel.Enabled = false;
      AnswerTextBox.Enabled = false;
      EmailPasswordButton.Enabled = false;
    }
    else
    {
      QuestionLabel.Text = user.PasswordQuestion;
      QuestionLabel.Enabled = true;
      AnswerTextBox.Enabled = true;
      EmailPasswordButton.Enabled = true;
    }
}


public void EmailPassword_OnClick(object sender, EventArgs args)
{
  // Note: Returning a password in clear text using email is not recommended for
  // sites that require a high level of security.

  try
  {
    string password = Membership.Provider.GetPassword(UsernameTextBox.Text, AnswerTextBox.Text);
    MembershipUser u = Membership.GetUser(UsernameTextBox.Text);
    EmailPassword(u.Email, password);
    Msg.Text = "Your password was sent via email.";
  }
  catch (MembershipPasswordException e)
  {
    Msg.Text = "The password answer is incorrect. Please check the value and try again.";
  }
  catch (System.Configuration.Provider.ProviderException e)
  {
    Msg.Text = "An error occurred retrieving your password. Please check your values " +
               "and try again.";
  }
}


private void EmailPassword(string email, string password)
{
  try
  {
    MailMessage Message = new MailMessage("administrator", email);
    Message.Subject = "Your Password";
    Message.Body = "Your password is: " + Server.HtmlEncode(password);

    SmtpClient SmtpMail = new SmtpClient("SMTPSERVER");
    SmtpMail.Send(Message);
  }
  catch 
  {
    Msg.Text = "An exception occurred while sending your password. Please try again.";
  }
}

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title>Sample: Retrieve Password</title>
</head>
<body>

<form id="form1" runat="server">
  <h3>Retrieve Password</h3>

  <asp:Label id="Msg" runat="server" ForeColor="maroon" /><br />

  Username: <asp:Textbox id="UsernameTextBox" Columns="30" runat="server" AutoPostBack="true" />
            <asp:RequiredFieldValidator id="UsernameRequiredValidator" runat="server"
                                        ControlToValidate="UsernameTextBox" ForeColor="red"
                                        Display="Static" ErrorMessage="Required" /><br />

  Password Question: <b><asp:Label id="QuestionLabel" runat="server" /></b><br />

  Answer: <asp:TextBox id="AnswerTextBox" Columns="60" runat="server" Enabled="false" />
          <asp:RequiredFieldValidator id="AnswerRequiredValidator" runat="server"
                                      ControlToValidate="AnswerTextBox" ForeColor="red"
                                      Display="Static" ErrorMessage="Required" Enabled="false" /><br />

  <asp:Button id="EmailPasswordButton" Text="Email My Password" 
              OnClick="EmailPassword_OnClick" runat="server" Enabled="false" />

</form>

</body>
</html>


<%@ Page Language="VB" %>

<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Net.Mail" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Public Sub Page_Load(ByVal sender As Object, ByVal args As EventArgs)

    If Not Membership.EnablePasswordRetrieval Then
      FormsAuthentication.RedirectToLoginPage()
    End If

    Msg.Text = ""

    If Not IsPostBack Then
      Msg.Text = "Please enter a user name."
    Else
      VerifyUsername()
    End If

  End Sub


  Private Sub VerifyUsername()

    Dim user As MembershipUser = Membership.GetUser(UsernameTextBox.Text, False)

    If user Is Nothing Then
      Msg.Text = "The user name " & Server.HtmlEncode(UsernameTextBox.Text) & " was not found. Please check the value and re-enter."

      QuestionLabel.Text = ""
      QuestionLabel.Enabled = False
      AnswerTextBox.Enabled = False
      EmailPasswordButton.Enabled = False
    Else
      QuestionLabel.Text = user.PasswordQuestion
      QuestionLabel.Enabled = True
      AnswerTextBox.Enabled = True
      EmailPasswordButton.Enabled = True
    End If

  End Sub


  Public Sub EmailPassword_OnClick(ByVal sender As Object, ByVal args As EventArgs)

    ' Note: Returning a password in clear text using email is not recommended for
    ' sites that require a high level of security.

    Try
      Dim password As String = Membership.Provider.GetPassword(UsernameTextBox.Text, AnswerTextBox.Text)
      Dim u As MembershipUser = Membership.GetUser(UsernameTextBox.Text)
      EmailPassword(u.Email, password)
      Msg.Text = "Your password was sent via email."
    Catch e As MembershipPasswordException
      Msg.Text = "The password answer is incorrect. Please check the value and try again."
    Catch e As System.Configuration.Provider.ProviderException
      Msg.Text = "An error occurred retrieving your password. Please check your values " & _
                 "and try again."
    End Try

  End Sub


  Private Sub EmailPassword(ByVal email As String, ByVal password As String)

    Try
      Dim Message As MailMessage = New MailMessage("administrator", email)
      Message.Subject = "Your Password"
      Message.Body = "Your password is: " & Server.HtmlEncode(password)
      
      Dim SmtpMail As SmtpClient = New SmtpClient("SMTPSERVER")
      SmtpMail.Send(Message)
    Catch
      Msg.Text = "An exception occurred while sending your password. Please try again."
    End Try

  End Sub

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
  <title>Sample: Retrieve Password</title>
</head>
<body>
  <form id="form1" runat="server">
    <h3>
      Retrieve Password</h3>
    <asp:Label ID="Msg" runat="server" ForeColor="maroon" /><br />
    Username:
    <asp:TextBox ID="UsernameTextBox" Columns="30" runat="server" AutoPostBack="True" />
    <asp:RequiredFieldValidator ID="UsernameRequiredValidator" runat="server" ControlToValidate="UsernameTextBox"
      ForeColor="red" Display="Static" ErrorMessage="Required" /><br />
    Password Question: <b>
      <asp:Label ID="QuestionLabel" runat="server" /></b><br />
    Answer:
    <asp:TextBox ID="AnswerTextBox" Columns="60" runat="server" Enabled="False" />
    <asp:RequiredFieldValidator ID="AnswerRequiredValidator" runat="server" ControlToValidate="AnswerTextBox"
      ForeColor="red" Display="Static" ErrorMessage="Required" Enabled="False" /><br />
    <asp:Button ID="EmailPasswordButton" Text="Email My Password" OnClick="EmailPassword_OnClick"
      runat="server" Enabled="False" />
  </form>
</body>
</html>

注釈

このメソッドは、クラスによって呼び出され MembershipUser 、ASP.NET アプリケーションの構成ファイル (Web.config) で指定された SQL Server データベースからユーザーのパスワードを取得します。

メソッドに正しくないパスワード応答が指定された GetPassword 場合、無効なパスワード応答の試行を追跡する内部カウンターは 1 ずつインクリメントされます。これにより、ユーザーがロックアウトされ、メソッドの呼び出し UnlockUser によってロック状態がクリアされるまでログオンできなくなる可能性があります。正しいパスワード応答が指定され、ユーザーが現在ロックアウトされていない場合、無効なパスワード応答の試行を追跡する内部カウンターは 0 にリセットされます。詳細については、MaxInvalidPasswordAttempts プロパティおよび PasswordAttemptWindow プロパティを参照してください。

メソッドを GetPassword 直接呼び出すには、クラスのプロパティを使用してインスタンスへの SqlMembershipProvider 参照を Provider 最初に Membership 取得します。

プロパティが PasswordFormat に Hashed設定されている場合、 GetPassword メソッドはパスワードを取得できません。ハッシュされたパスワードは一方向で暗号化され、暗号化を解除することはできません。プロパティが PasswordFormat に設定され、 EnablePasswordRetrieval がにHashedtrueProviderException設定されている場合、はプロバイダーの初期化時にスローされます。

先頭と末尾のスペースは、すべてのパラメーター値からトリミングされます。

適用対象

こちらもご覧ください

ASP.NET メンバーシップの概要

次の方法で共有

SqlMembershipProvider.GetPassword(String, String) メソッド

定義

パラメーター

戻り値

例外

例

注釈

適用対象

こちらもご覧ください

その他のリソース