SqlConnection.ChangePassword メソッド

定義

名前空間:

System.Data.SqlClient

アセンブリ:

System.Data.dll

SQL Server パスワードを変更します。

オーバーロード

ChangePassword(String, SqlCredential, SecureString)	SqlCredential オブジェクトに示されているユーザーの SQL Server パスワードを変更します。
ChangePassword(String, String)	接続文字列に示されているユーザーの SQL Server パスワードを、指定された新しいパスワードに変更します。

ChangePassword(String, SqlCredential, SecureString)

SqlCredential オブジェクトに示されているユーザーの SQL Server パスワードを変更します。

public:
 static void ChangePassword(System::String ^ connectionString, System::Data::SqlClient::SqlCredential ^ credential, System::Security::SecureString ^ newSecurePassword);

public static void ChangePassword (string connectionString, System.Data.SqlClient.SqlCredential credential, System.Security.SecureString newSecurePassword);

static member ChangePassword : string * System.Data.SqlClient.SqlCredential * System.Security.SecureString -> unit

Public Shared Sub ChangePassword (connectionString As String, credential As SqlCredential, newSecurePassword As SecureString)

パラメーター

connectionString

String

サーバーに接続するのに十分な情報を含む接続文字列。 接続文字列では、Integrated Security = true、UserId、または Passwordのいずれかの接続文字列キーワードを使用しないでください。または ContextConnection = true.

credential

SqlCredential

SqlCredential オブジェクト。

newSecurePassword

SecureString

新しいパスワード。 newPassword は読み取り専用である必要があります。 また、パスワードは、サーバーに設定されているパスワード セキュリティ ポリシー (たとえば、特定の文字の最小長と要件) にも準拠している必要があります。

例外

ArgumentException

接続文字列には、UserId、Password、または Integrated Security=trueの任意の組み合わせが含まれています。

-又は-

接続文字列には、Context Connection=trueが含まれています。

-又は-

newSecurePassword (または newPassword) が 128 文字を超える。

-又は-

newSecurePassword (または newPassword) は読み取り専用ではありません。

-又は-

newSecurePassword (または newPassword) は空の文字列です。

ArgumentNullException

パラメーター (connectionString、credential、または newSecurePassword) の 1 つが null です。

こちらもご覧ください

• ADO.NET の概要

ChangePassword(String, String)

接続文字列に示されているユーザーの SQL Server パスワードを、指定された新しいパスワードに変更します。

public:
 static void ChangePassword(System::String ^ connectionString, System::String ^ newPassword);

public static void ChangePassword (string connectionString, string newPassword);

static member ChangePassword : string * string -> unit

Public Shared Sub ChangePassword (connectionString As String, newPassword As String)

パラメーター

connectionString

String

必要なサーバーに接続するのに十分な情報を含む接続文字列。 接続文字列には、ユーザー ID と現在のパスワードが含まれている必要があります。

newPassword

String

設定する新しいパスワード。 このパスワードは、サーバーに設定されているパスワード セキュリティ ポリシー (最小長、特定の文字の要件など) に準拠している必要があります。

例外

ArgumentException

接続文字列には、統合セキュリティを使用するオプションが含まれています。

又は

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

ArgumentNullException

connectionString または newPassword パラメーターが null です。

例

警告

セキュリティで保護されていないパターンであるため、ユーザー名とパスワードを直接指定することはお勧めしません。 可能な場合は、Azure リソースのマネージド ID の 、SQL Server の Windows 認証 など、より安全な認証フローを使用します。

パスワードを変更する簡単な例を次に示します。

class Program {
   static void Main(string[] args) {
      System.Data.SqlClient.SqlConnection.ChangePassword(
        "Data Source=a_server;Initial Catalog=a_database;UID=user;PWD=old_password",
       "new_password");
   }
}

Module Module1
    Sub Main()
System.Data.SqlClient.SqlConnection.ChangePassword(
        "Data Source=a_server;Initial Catalog=a_database;UID=user;PWD=old_password",
       "new_password")
    End Sub
End Module

次のコンソール アプリケーションは、現在のパスワードの有効期限が切れたためにユーザーのパスワードを変更する場合の問題を示しています。

using System;
using System.Data;
using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            DemonstrateChangePassword();
        }
        catch (Exception ex)
        {
            Console.WriteLine("Error: " + ex.Message);
        }
        Console.WriteLine("Press ENTER to continue...");
        Console.ReadLine();
    }

    private static void DemonstrateChangePassword()
    {
        // Retrieve the connection string. In a production application,
        // this string should not be contained within the source code.
        string connectionString = GetConnectionString();

        using (SqlConnection cnn = new SqlConnection())
        {
            for (int i = 0; i <= 1; i++)
            {
                // Run this loop at most two times. If the first attempt fails,
                // the code checks the Number property of the SqlException object.
                // If that contains the special values 18487 or 18488, the code
                // attempts to set the user's password to a new value.
                // Assuming this succeeds, the second pass through
                // successfully opens the connection.
                // If not, the exception handler catches the exception.
                try
                {
                    cnn.ConnectionString = connectionString;
                    cnn.Open();
                    // Once this succeeds, just get out of the loop.
                    // No need to try again if the connection is already open.
                    break;
                }
                catch (SqlException ex)
                {
                    if (i == 0 && ((ex.Number == 18487) || (ex.Number == 18488)))
                    {
                        // You must reset the password.
                        connectionString =
                            ModifyConnectionString(connectionString,
                            GetNewPassword());
                    }
                    else
                    {
                        // Bubble all other SqlException occurrences
                        // back up to the caller.
                        throw;
                    }
                }
            }
            SqlCommand cmd = new SqlCommand(
                "SELECT ProductID, Name FROM Product", cnn);
            // Use the connection and command here...
        }
    }

    private static string ModifyConnectionString(
        string connectionString, string NewPassword)
    {

        // Use the SqlConnectionStringBuilder class to modify the
        // password portion of the connection string.
        SqlConnectionStringBuilder builder =
            new SqlConnectionStringBuilder(connectionString);
        builder.Password = NewPassword;
        return builder.ConnectionString;
    }

    private static string GetNewPassword()
    {
        // In a real application, you might display a modal
        // dialog box to retrieve the new password. The concepts
        // are the same as for this simple console application, however.
        Console.Write("Your password must be reset. Enter a new password: ");
        return Console.ReadLine();
    }

    private static string GetConnectionString()
    {
        // For this demonstration, the connection string must
        // contain both user and password information. In your own
        // application, you might want to retrieve this setting
        // from a config file, or from some other source.

        // In a production application, you would want to
        // display a modal form that could gather user and password
        // information.
        SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(
            "Data Source=(local);Initial Catalog=AdventureWorks");

        Console.Write("Enter your user id: ");
        builder.UserID = Console.ReadLine();
        Console.Write("Enter your password: ");
        builder.Password = Console.ReadLine();

        return builder.ConnectionString;
    }
}

Option Explicit On
Option Strict On

Imports System.Data
Imports System.Data.SqlClient

Module Module1
    Sub Main()
        Try
            DemonstrateChangePassword()
        Catch ex As Exception
            Console.WriteLine("Error: " & ex.Message)
        End Try
        Console.WriteLine("Press ENTER to continue...")
        Console.ReadLine()
    End Sub

    Private Sub DemonstrateChangePassword()
        Dim connectionString As String = GetConnectionString()
        Using cnn As New SqlConnection()
            For i As Integer = 0 To 1
                ' Run this loop at most two times. If the first attempt fails, 
                ' the code checks the Number property of the SqlException object.
                ' If that contains the special values 18487 or 18488, the code 
                ' attempts to set the user's password to a new value. 
                ' Assuming this succeeds, the second pass through 
                ' successfully opens the connection.
                ' If not, the exception handler catches the exception.
                Try
                    cnn.ConnectionString = connectionString
                    cnn.Open()
                    ' Once this succeeds, just get out of the loop.
                    ' No need to try again if the connection is already open.
                    Exit For

                Catch ex As SqlException _
                 When (i = 0 And (ex.Number = 18487 Or ex.Number = 18488))
                    ' You must reset the password.
                    connectionString = ModifyConnectionString( _
                     connectionString, GetNewPassword())

                Catch ex As SqlException
                    ' Bubble all other SqlException occurrences
                    ' back up to the caller.
                    Throw
                End Try
            Next
            Dim cmd As New SqlCommand("SELECT ProductID, Name FROM Product", cnn)
            ' Use the connection and command here...
        End Using
    End Sub

    Private Function ModifyConnectionString( _
     ByVal connectionString As String, ByVal NewPassword As String) As String

        ' Use the SqlConnectionStringBuilder class to modify the
        ' password portion of the connection string. 
        Dim builder As New SqlConnectionStringBuilder(connectionString)
        builder.Password = NewPassword
        Return builder.ConnectionString
    End Function

    Private Function GetNewPassword() As String
        ' In a real application, you might display a modal
        ' dialog box to retrieve the new password. The concepts
        ' are the same as for this simple console application, however.
        Console.Write("Your password must be reset. Enter a new password: ")
        Return Console.ReadLine()
    End Function

    Private Function GetConnectionString() As String
        ' For this demonstration, the connection string must
        ' contain both user and password information. In your own
        ' application, you might want to retrieve this setting
        ' from a config file, or from some other source.

        ' In a production application, you would want to 
        ' display a modal form that could gather user and password
        ' information.
        Dim builder As New SqlConnectionStringBuilder( _
         "Data Source=(local);Initial Catalog=AdventureWorks")

        Console.Write("Enter your user id: ")
        builder.UserID = Console.ReadLine()
        Console.Write("Enter your password: ")
        builder.Password = Console.ReadLine()

        Return builder.ConnectionString
    End Function
End Module

注釈

Windows Server で SQL Server を使用している場合は、クライアント アプリケーションが現在のパスワードと新しいパスワードの両方を指定して既存のパスワードを変更できるようにする機能を利用できます。 アプリケーションは、古いパスワードの有効期限が切れている場合に、初期ログイン時にユーザーに新しいパスワードを求めるなどの機能を実装でき、管理者の介入なしにこの操作を完了できます。

警告

セキュリティで保護されていないパターンであるため、ユーザー名とパスワードを直接指定することはお勧めしません。 可能な場合は、Azure リソースのマネージド ID の 、SQL Server の Windows 認証 など、より安全な認証フローを使用します。

ChangePassword メソッドは、指定された connectionString パラメーターで指定されたユーザーの SQL Server パスワードを、newPassword パラメーターで指定された値に変更します。 接続文字列に統合セキュリティのオプション ("Integrated Security=True" または同等のオプション) が含まれている場合は、例外がスローされます。

パスワードの有効期限が切れたことを確認するには、Open メソッドを呼び出すと、SqlExceptionが発生します。 接続文字列に含まれるパスワードをリセットする必要があることを示すために、例外の Number プロパティには状態値 18487 または 18488 が含まれています。 最初の値 (18487) はパスワードの有効期限が切れたことを示し、2 番目の値 (18488) はログイン前にパスワードをリセットする必要があることを示します。

このメソッドは、サーバーへの独自の接続を開き、パスワードの変更を要求し、完了するとすぐに接続を閉じます。 この接続は、SQL Server 接続プールから取得されたり、SQL Server 接続プールに返されたりしません。

こちらもご覧ください

• 接続文字列 (ADO.NET)
• データ ソースへの接続 (ADO.NET)
• .NET Framework Data Provider for SQL Server の使用
• ADO.NET の概要