接続文字列と構成ファイル

[アーティクル]
10/15/2024

接続文字列をアプリケーションのコードに組み込むと、セキュリティ上の脆弱性やメンテナンスの問題を引き起こす可能性があります。アプリケーションのソースコード内にコンパイルされた暗号化されていない接続文字列は、Ildasm.exe (IL 逆アセンブラー) ツールを使用して参照することができます。さらに、接続文字列が変わるたびにアプリケーションを再コンパイルする必要性が生じます。そのため、接続文字列はアプリケーション構成ファイルに保存することをお勧めします。

重要

Microsoft では、使用可能な最も安全な認証フローを使用することをお勧めします。 Azure SQL に接続する場合は、Azure リソースの管理 ID が推奨される認証方法です。

アプリケーション構成ファイル

アプリケーション構成ファイルには、特定のアプリケーションに固有の設定が格納されます。たとえば、ASP.NET アプリケーションには少なくとも 1 つの web.config ファイルが存在するほか、Windows アプリケーションにも必要に応じて app.config ファイルを割り当てることができます。構成ファイルの名前と場所はアプリケーションのホストによって異なりますが、どの構成ファイルにも共通の要素があります。

`connectionStrings` セクション

接続文字列は、アプリケーション構成ファイルのconnectionStrings 要素の configuration セクションにキーと値のペアとして格納できます。子要素には、add、clear、および remove が存在します。

次の構成ファイルフラグメントは、接続文字列を格納するためのスキーマと構文の例を示しています。 name 属性は、実行時に取得する接続文字列を一意に識別するための名前です。 providerName は、machine.config ファイルに登録された .NET Framework データプロバイダーの不変名です。

<?xml version='1.0' encoding='utf-8'?>
  <configuration>
    <connectionStrings>
      <clear />
      <add name="Name"
       providerName="System.Data.ProviderName"
       connectionString="Valid Connection String;" />
    </connectionStrings>
  </configuration>

Note

構成ファイルに接続文字列の一部を保存しておき、DbConnectionStringBuilder クラスを使用して実行時に補完できます。接続文字列の要素を事前に知ることができない場合や、機密情報を構成ファイルに保存したくない場合には有効な手段です。詳細については、「接続文字列ビルダー」をご覧ください。

外部構成ファイルを使用する

外部構成ファイルとは、単一のセクションから成る、構成ファイルのフラグメントを含んだ独立したファイルを言います。外部構成ファイルは、メインの構成ファイルによって参照されます。 connectionStrings セクションを物理的に分かれたファイルに保存できるため、アプリケーションの配置後に接続文字列を編集する場合に有効な手段です。たとえば、構成ファイルに修正が加えられた場合、ASP.NET の標準的な動作ではアプリケーションドメインが再起動され、その結果、状態情報が失われてしまいます。しかし、外部構成ファイルに対する修正であればアプリケーションの再起動は伴いません。外部構成ファイルは ASP.NET だけでなく、Windows アプリケーションでも使用できます。また、ファイルのアクセスセキュリティや権限を使用して、外部構成ファイルへのアクセスを制限することもできます。実行時における外部構成ファイルの使用は透過的であり、特殊なコーディングも不要です。

外部構成ファイルに接続文字列を保存するには、connectionStrings セクションだけを含んだファイルを別途作成します。それ以外の要素、セクション、または属性は含めないでください。外部構成ファイルの構文の例を次に示します。

<connectionStrings>
  <add name="Name"
   providerName="System.Data.ProviderName"
   connectionString="Valid Connection String;" />
</connectionStrings>

外部ファイルの完全修飾名および場所は、メインのアプリケーション構成ファイルの configSource 属性で指定します。この例では、connections.config という名前の外部構成ファイルを参照しています。

<?xml version='1.0' encoding='utf-8'?>
<configuration>
    <connectionStrings configSource="connections.config"/>
</configuration>

接続文字列の実行時の取得

.NET Framework 2.0 では、System.Configuration 名前空間に新しいクラスが導入され、実行時に簡単に構成ファイルから接続文字列を取得できるようになりました。プログラムから名前またはプロバイダー名を使用して接続文字列を取得できます。

Note

connectionStrings セクションは、machine.config ファイルにも存在します。このセクションには、Visual Studio によって使用される接続文字列が格納されます。 Windows アプリケーションの app.config ファイルからプロバイダー名で接続文字列を取得した場合、まず machine.config 内の接続文字列が読み込まれ、その後、app.config のエントリが読み込まれます。connectionStrings 要素の直後に clear を追加すると、継承されたすべての参照がメモリ内のデータ構造から削除され、ローカルの app.config ファイルに定義されている接続文字列だけが考慮されます。

構成クラスの使用

.NET Framework 2.0 以降では、ローカルコンピューター上の構成ファイルで作業するときに、非推奨とされた ConfigurationSettings クラスに代わって ConfigurationManager を使用します。 ASP.NET 構成ファイルでの作業では、WebConfigurationManager を使用します。 Web サーバー上の構成ファイルを扱うことを目的に設計され、system.web など、構成ファイルのセクションにプログラムからアクセスできます。

Note

実行時に構成ファイルにアクセスするには、呼び出し元に権限を付与する必要があります。必要な権限は、アプリケーションの種類、構成ファイル、格納場所などによって異なります。詳細については、ASP.NET アプリケーションの場合は「WebConfigurationManager」、Windows アプリケーションの場合は「ConfigurationManager」を参照してください。

ConnectionStringSettingsCollection を使用すると、アプリケーション構成ファイルから接続文字列を取得できます。このコレクションには、それぞれが connectionStrings セクションの単一のエントリを表す一連の ConnectionStringSettings オブジェクトが格納されます。個々のプロパティは接続文字列の属性にマップされており、名前またはプロバイダー名を指定することによって接続文字列を取得できます。

プロパティ	説明
Name	接続文字列の名前。 name 属性にマップされています。
ProviderName	プロバイダーの完全修飾名。 providerName 属性にマップされています。
ConnectionString	接続文字列。 connectionString 属性にマップされています。

例: すべての接続文字列を一覧表示する

この例では、ConnectionStringSettingsCollection を反復処理しながら、ConnectionStringSettings.Name、ConnectionStringSettings.ProviderName、ConnectionStringSettings.ConnectionString の各プロパティをコンソールウィンドウに表示します。

Note

プロジェクトの種類によっては System.Configuration.dll がインクルードされていない場合があります。構成クラスを使用する場合は、必要に応じて参照設定するようにしてください。特定のアプリケーションの構成ファイルの名前と場所は、アプリケーションの種類やホストしているプロセスによって異なります。

using System.Configuration;

static class Program
{
    static void Main()
    {
        GetConnectionStrings();
        Console.ReadLine();
    }

    static void GetConnectionStrings()
    {
        ConnectionStringSettingsCollection settings =
            ConfigurationManager.ConnectionStrings;

        foreach (ConnectionStringSettings cs in settings)
        {
            Console.WriteLine(cs.Name);
            Console.WriteLine(cs.ProviderName);
            Console.WriteLine(cs.ConnectionString);
        }
    }
}

Imports System.Configuration

Class Program
    Shared Sub Main()
        GetConnectionStrings()
        Console.ReadLine()
    End Sub

    Private Shared Sub GetConnectionStrings()

        Dim settings As ConnectionStringSettingsCollection = _
            ConfigurationManager.ConnectionStrings

        If Not settings Is Nothing Then
            For Each cs As ConnectionStringSettings In settings
                Console.WriteLine(cs.Name)
                Console.WriteLine(cs.ProviderName)
                Console.WriteLine(cs.ConnectionString)
            Next
        End If
    End Sub
End Class

例: 接続文字列を名前で取得する

次の例では、接続文字列の名前を指定することによって、接続文字列を構成ファイルから取得する方法を説明します。このコードでは、指定された入力パラメーターと ConnectionStringSettings の名前とを照合することによって、ConnectionStrings オブジェクトを作成します。一致する名前が見つからなかった場合は null (Visual Basic の場合は Nothing) が返されます。

// Retrieves a connection string by name.
// Returns null if the name is not found.
static string? GetConnectionStringByName(string name)
{
    // Look for the name in the connectionStrings section.
    ConnectionStringSettings? settings =
        ConfigurationManager.ConnectionStrings[name];

    // If found, return the connection string (otherwise return null)
    return settings?.ConnectionString;
}

' Retrieves a connection string by name.
' Returns Nothing if the name is not found.
Private Shared Function GetConnectionStringByName( _
    ByVal name As String) As String

    ' Assume failure
    Dim returnValue As String = Nothing

    ' Look for the name in the connectionStrings section.
    Dim settings As ConnectionStringSettings = _
       ConfigurationManager.ConnectionStrings(name)

    ' If found, return the connection string.
    If Not settings Is Nothing Then
        returnValue = settings.ConnectionString
    End If

    Return returnValue
End Function

例: 接続文字列をプロバイダー名で取得する

次の例では、プロバイダーの不変名を System.Data.ProviderName の形式で指定することによって接続文字列を取得する方法を説明します。このコードでは、ConnectionStringSettingsCollection を反復処理し、最初に見つかった ProviderName の接続文字列を返します。プロバイダー名が見つからなかった場合は null (Visual Basic の場合は Nothing) が返されます。

// Retrieve a connection string by specifying the providerName.
// Assumes one connection string per provider in the config file.
static string? GetConnectionStringByProvider(string providerName)
{
    // Get the collection of connection strings.
    ConnectionStringSettingsCollection? settings =
        ConfigurationManager.ConnectionStrings;

    // Walk through the collection and return the first
    // connection string matching the providerName.
    if (settings != null)
    {
        foreach (ConnectionStringSettings cs in settings)
        {
            if (cs.ProviderName == providerName)
            {
                return cs.ConnectionString;
            }
        }
    }
    return null;
}

' Retrieve a connection string by specifying the providerName.
' Assumes one connection string per provider in the config file.
Private Shared Function GetConnectionStringByProvider( _
    ByVal providerName As String) As String

    'Return Nothing on failure.
    Dim returnValue As String = Nothing

    ' Get the collection of connection strings.
    Dim settings As ConnectionStringSettingsCollection = _
        ConfigurationManager.ConnectionStrings

    ' Walk through the collection and return the first 
    ' connection string matching the providerName.
    If Not settings Is Nothing Then
        For Each cs As ConnectionStringSettings In settings
            If cs.ProviderName = providerName Then
                returnValue = cs.ConnectionString
                Exit For
            End If
        Next
    End If

    Return returnValue
End Function

保護された構成を使用して構成ファイルのセクションを暗号化する

ASP.NET 2.0 では、保護構成と呼ばれる、構成ファイルの機密情報を暗号化するための新しい機能が導入されました。保護構成は、主に ASP.NET を想定して設計されたものですが、Windows アプリケーションの構成ファイルセクションを暗号化する目的でも使用できます。

次の構成ファイルフラグメントは、暗号化後の connectionStrings セクションを示しています。 configProtectionProvider には、接続文字列の暗号化と復号化に使用される、保護構成プロバイダーが指定されています。 EncryptedData セクションには暗号文が格納されています。

<connectionStrings configProtectionProvider="DataProtectionConfigurationProvider">
  <EncryptedData>
    <CipherData>
      <CipherValue>AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAH2... </CipherValue>
    </CipherData>
  </EncryptedData>
</connectionStrings>

暗号化された接続文字列は実行時に取得されることになります。このとき、.NET Framework は、指定されたプロバイダーを使用して CipherValue を復号化し、アプリケーションに利用可能な接続文字列を提供します。復号化のプロセスを管理するためのコードを自分で作成する必要はありません。

保護構成プロバイダー

保護構成プロバイダーは、ローカルコンピューターの machine.config ファイルの configProtectedData セクションに登録されます。次のフラグメントを見ると、.NET Framework が備えている 2 つの保護構成プロバイダーが指定されていることがわかります。ここでは、読みやすくするために一部の値を省略しています。

<configProtectedData defaultProvider="RsaProtectedConfigurationProvider">
  <providers>
    <add name="RsaProtectedConfigurationProvider"
      type="System.Configuration.RsaProtectedConfigurationProvider" />
    <add name="DataProtectionConfigurationProvider"
      type="System.Configuration.DpapiProtectedConfigurationProvider" />
  </providers>
</configProtectedData>

別の保護構成プロバイダーが必要な場合は、それを machine.config ファイルに追加することによって構成できます。また、ProtectedConfigurationProvider 抽象基本クラスを継承することで、保護構成プロバイダーを独自に作成することもできます。次の表は、.NET Framework に含まれている 2 つの構成プロバイダーを示しています。

プロバイダー	説明
RsaProtectedConfigurationProvider	データの暗号化と復号化には、RSA 暗号化アルゴリズムが使用されます。 RSA アルゴリズムは、公開キー暗号化だけでなく、デジタル署名にも使用されます。 "公開キー" として知られているほか、2 つの異なるキーが使用されることから非対称暗号化と呼ばれる場合もあります。 ASP.NET IIS 登録ツール (Aspnet_regiis.exe) を使用すると、Web.config ファイルのセクションを暗号化したり、暗号化キーを管理したりすることができます。構成ファイルは、その処理時に ASP.NET によって復号化されます。 ASP.NET アプリケーションの ID には、セクションの暗号化と復号化に使用される暗号化キーへの読み取りアクセスが必要です。
DpapiProtectedConfigurationProvider	構成セクションの暗号化に Windows Data Protection API (DPAPI) が使用されます。この API には、Windows の組み込み暗号化サービスが使用され、コンピューター単位またはユーザーアカウント単位の保護を構成できます。コンピューター単位の保護は、同じサーバー上の複数のアプリケーションで情報を共有する必要がある場合に使用します。共有ホスティング環境など、特定のユーザー ID で実行されるサービスには、ユーザーアカウント単位の保護を使用できます。各アプリケーションは、ファイルやデータベースなど、各種リソースへのアクセスが制限された別々の ID で実行されます。

プロバイダー

説明

RsaProtectedConfigurationProvider

データの暗号化と復号化には、RSA 暗号化アルゴリズムが使用されます。 RSA アルゴリズムは、公開キー暗号化だけでなく、デジタル署名にも使用されます。 "公開キー" として知られているほか、2 つの異なるキーが使用されることから非対称暗号化と呼ばれる場合もあります。 ASP.NET IIS 登録ツール (Aspnet_regiis.exe) を使用すると、Web.config ファイルのセクションを暗号化したり、暗号化キーを管理したりすることができます。構成ファイルは、その処理時に ASP.NET によって復号化されます。 ASP.NET アプリケーションの ID には、セクションの暗号化と復号化に使用される暗号化キーへの読み取りアクセスが必要です。

DpapiProtectedConfigurationProvider

構成セクションの暗号化に Windows Data Protection API (DPAPI) が使用されます。この API には、Windows の組み込み暗号化サービスが使用され、コンピューター単位またはユーザーアカウント単位の保護を構成できます。コンピューター単位の保護は、同じサーバー上の複数のアプリケーションで情報を共有する必要がある場合に使用します。共有ホスティング環境など、特定のユーザー ID で実行されるサービスには、ユーザーアカウント単位の保護を使用できます。各アプリケーションは、ファイルやデータベースなど、各種リソースへのアクセスが制限された別々の ID で実行されます。

どちらのプロバイダーも、強力なデータ暗号化機能を備えています。ただし、Web ファームなど、複数のサーバーで、同じ構成ファイルを暗号化して使用する場合、データの暗号化に使用される暗号化キーをエクスポートしたり、それを別のサーバーにインポートしたりできるのは、RsaProtectedConfigurationProvider だけです。詳細については、「保護された構成 RSA キーコンテナのインポートとエクスポート」を参照してください。

構成クラスを使用する

System.Configuration 名前空間には、構成設定をプログラムから行うためのクラスが存在します。 ConfigurationManager クラスは、コンピューター、アプリケーション、ユーザーの各構成ファイルへのアクセスを提供します。 ASP.NET アプリケーションを作成している場合は、同じ機能を持った WebConfigurationManager クラスを使用します。他にも <system.web> の設定など、ASP.NET アプリケーション固有の設定にもアクセスできます。

Note

System.Security.Cryptography 名前空間には、データの暗号化と復号化に関連した補足的なオプションを提供するクラスが存在します。これらのクラスは、保護構成では利用できない暗号化サービスが必要な場合に使用します。これらのクラスは必ずしも純粋なマネージド実装とは限らず、アンマネージド Microsoft CryptoAPI 用のラッパーもあります。

App.config の例

ここでは、Windows アプリケーションの app.config ファイルにある connectionStrings セクションを条件に応じて暗号化したり復号化したりする方法を紹介します。この例に示したプロシージャは、MyApplication.exe など、アプリケーションの名前を引数として受け取ります。その後、app.config ファイルを暗号化して、その実行可能ファイルと同じフォルダーに MyApplication.exe.config という名前でコピーします。

このコードは、OpenExeConfiguration メソッドを使用して app.config ファイルを編集モードで開き、GetSection メソッドを使用して connectionStrings セクションを返します。さらに、IsProtected プロパティをチェックし、セクションがまだ暗号化されていなければ、ProtectSection を呼び出して暗号化します。それ以外の場合は、UnprotectSection メソッドを呼び出してセクションを復号化します。 (接続文字列は、暗号化が行われたコンピューターでのみ復号化できます)。Save メソッドは操作を完了し、変更を保存します。

このコードを実行するには、プロジェクトで System.Configuration.dll に参照を追加する必要があります。

重要

static void ToggleConfigEncryption(string exeFile)
{
    // Get the application path needed to obtain
    // the application configuration file.

    // Takes the executable file name without the
    // .config extension.
    var exePath = exeFile.Replace(".config", "");

    try
    {
        // Open the configuration file and retrieve
        // the connectionStrings section.
        Configuration config = ConfigurationManager.
            OpenExeConfiguration(exePath);

        var section =
            config.GetSection("connectionStrings")
            as ConnectionStringsSection;

        if (section != null)
        {
            if (section.SectionInformation.IsProtected)
            {
                // Remove encryption.
                section.SectionInformation.UnprotectSection();
            }
            else
            {
                // Encrypt the section.
                section.SectionInformation.ProtectSection(
                    "DataProtectionConfigurationProvider");
            }
        }
        // Save the current configuration.
        config.Save();

        Console.WriteLine("Protected={0}",
            section?.SectionInformation.IsProtected);
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex.Message);
    }
}

Shared Sub ToggleConfigEncryption(ByVal exeConfigName As String)
    ' Takes the executable file name without the
    ' .config extension.
    Try
        ' Open the configuration file and retrieve 
        ' the connectionStrings section.
        Dim config As Configuration = ConfigurationManager. _
            OpenExeConfiguration(exeConfigName)

        Dim section As ConnectionStringsSection = DirectCast( _
            config.GetSection("connectionStrings"), _
            ConnectionStringsSection)

        If section.SectionInformation.IsProtected Then
            ' Remove encryption.
            section.SectionInformation.UnprotectSection()
        Else
            ' Encrypt the section.
            section.SectionInformation.ProtectSection( _
              "DataProtectionConfigurationProvider")
        End If

        ' Save the current configuration.
        config.Save()

        Console.WriteLine("Protected={0}", _
        section.SectionInformation.IsProtected)

    Catch ex As Exception
        Console.WriteLine(ex.Message)
    End Try
End Sub

Web.config の例

この例では、OpenWebConfiguration の WebConfigurationManager メソッドを使用しています。この場合、チルダを使用して、Web.config ファイルの相対パスを指定できます。このコードを実行するには、System.Web.Configuration クラスへの参照が必要です。

static void ToggleWebEncrypt()
{
    // Open the Web.config file.
    Configuration config = WebConfigurationManager.
        OpenWebConfiguration("~");

    // Get the connectionStrings section.
    var section =
        config.GetSection("connectionStrings")
        as ConnectionStringsSection;

    // Toggle encryption.
    if (section.SectionInformation.IsProtected)
    {
        section.SectionInformation.UnprotectSection();
    }
    else
    {
        section.SectionInformation.ProtectSection(
            "DataProtectionConfigurationProvider");
    }

    // Save changes to the Web.config file.
    config.Save();
}

Shared Sub ToggleWebEncrypt()
    ' Open the Web.config file.
    Dim config As Configuration = WebConfigurationManager. _
      OpenWebConfiguration("~")

    ' Get the connectionStrings section.
    Dim section As ConnectionStringsSection = DirectCast( _
        config.GetSection("connectionStrings"), _
        ConnectionStringsSection)

    ' Toggle encryption.
    If section.SectionInformation.IsProtected Then
        section.SectionInformation.UnprotectSection()
    Else
        section.SectionInformation.ProtectSection( _
          "DataProtectionConfigurationProvider")
    End If

    ' Save changes to the Web.config file.
    config.Save()
End Sub

ASP.NET アプリケーションのセキュリティ保護について詳しくは、「ASP.NET Web サイトのセキュリティ保護」をご覧ください。

次の方法で共有

接続文字列と構成ファイル

アプリケーション構成ファイル

`connectionStrings` セクション

外部構成ファイルを使用する

接続文字列の実行時の取得

構成クラスの使用

例: すべての接続文字列を一覧表示する

例: 接続文字列を名前で取得する

例: 接続文字列をプロバイダー名で取得する

保護された構成を使用して構成ファイルのセクションを暗号化する

保護構成プロバイダー

構成クラスを使用する

App.config の例

Web.config の例

関連項目

その他のリソース

次の方法で共有

接続文字列と構成ファイル

アプリケーション構成ファイル

connectionStrings セクション

外部構成ファイルを使用する

接続文字列の実行時の取得

構成クラスの使用

例: すべての接続文字列を一覧表示する

例: 接続文字列を名前で取得する

例: 接続文字列をプロバイダー名で取得する

保護された構成を使用して構成ファイルのセクションを暗号化する

保護構成プロバイダー

構成クラスを使用する

App.config の例

Web.config の例

関連項目

その他のリソース

`connectionStrings` セクション