SYSLIB0001: UTF-7 エンコードは安全ではない

  • [アーティクル]

UTF-7 エンコードがアプリケーション間で広く使用されることはなくなりました。多くの仕様では、現在インターチェンジでの使用が禁止されています。 また、UTF-7 でエンコードされたデータの使用を予測していないアプリケーションでは、攻撃ベクトルとして使用されることもあります。 Microsoft では、System.Text.UTF7Encoding の使用に対して警告が行われます。エラー検出が提供されないためです。

そのため、.NET 5 以降では、次の API は古い形式としてマークさていれます。 これらの API を使用すると、コンパイル時に警告 SYSLIB0001 が生成されます。

回避策

  • 独自のプロトコルまたはファイル形式内で Encoding.UTF7 または UTF7Encoding を使用している場合:

    Encoding.UTF8 または UTF8Encoding の使用に切り替えます。 UTF-8 は業界標準であり、各言語、オペレーティング システム、およびランタイム間で広くサポートされています。 UTF-8 を使用すると、将来のコードの保守が容易になり、エコシステムの他の部分との相互運用性が高まります。

  • Encoding インスタンスを Encoding.UTF7 と比較している場合:

    代わりに、既知の UTF-7 コード ページ (65000) に対してチェックを実行することを検討してください。 コード ページと比較することによって、警告を回避し、一部のエッジ ケースを処理することもできます。たとえば、他のユーザーが new UTF7Encoding() を呼び出した場合や、型をサブクラス化した場合などです。

    void DoSomething(Encoding enc)
{
    // Don't perform the check this way.
    // It produces a warning and misses some edge cases.
    if (enc == Encoding.UTF7)
    {
        // Encoding is UTF-7.
    }

    // Instead, perform the check this way.
    if (enc != null && enc.CodePage == 65000)
    {
        // Encoding is UTF-7.
    }
}

警告を抑制する

古い API を使う必要がある場合は、コードまたはプロジェクト ファイルで警告を抑制することができます。

単一の違反だけを抑制するには、ソース ファイルにプリプロセッサ ディレクティブを追加して警告を無効にしてから、再度有効にします。

// Disable the warning.
#pragma warning disable SYSLIB0001

// Code that uses obsolete API.
// ...

// Re-enable the warning.
#pragma warning restore SYSLIB0001

プロジェクトですべての SYSLIB0001 警告を抑制するには、プロジェクト ファイルに <NoWarn> プロパティを追加します。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
   ...
   <NoWarn>$(NoWarn);SYSLIB0001</NoWarn>
  </PropertyGroup>
</Project>

詳細については、「警告を表示しない」を参照してください。

関連項目