NuGet 資格情報プロバイダーを使用した Visual Studio でのフィードの認証

NuGet Visual Studio Extension 3.6 以降では、資格情報プロバイダーがサポートされています。このプロバイダーを使用すると、NuGet で認証済みフィードを操作できます。 Visual Studio 用の NuGet 資格情報プロバイダーをインストールすると、必要に応じて、認証されたフィードの資格情報が NuGet Visual Studio 拡張機能によって自動的に取得および更新されます。

サンプル実装は、VsCredentialProvider サンプル にあります。

Visual Studio 内で、NuGet は内部 VsCredentialProviderImporter を使用し、プラグイン資格情報プロバイダーもスキャンします。 これらのプラグイン資格情報プロバイダーは、IVsCredentialProviderの種類の MEF エクスポートとして検出可能である必要があります。

Visual Studio の 4.8 以降の NuGet では、新しいクロスプラットフォーム認証プラグインもサポートされていますが、パフォーマンス上の理由から推奨されるアプローチではありません。

Visual Studio 用の NuGet 資格情報プロバイダーの作成

NuGet Visual Studio Extension 3.6 以降では、資格情報の取得に使用される内部 CredentialService が実装されています。 CredentialService には、組み込みの資格情報プロバイダーとプラグイン資格情報プロバイダーの一覧があります。 各プロバイダーは順番に試され、資格情報が無事取得されるまで続けます。

資格情報の取得中、資格情報サービスは次の順序で資格情報プロバイダーを試し、資格情報が取得されるとすぐに停止します。

1. 資格情報は、(組み込みの SettingsCredentialProviderを使用して) NuGet 構成ファイルからフェッチされます。
2. Visual Studio 資格情報プロバイダーは順番に試されます。
3. すべての NuGet クロス プラットフォーム資格情報プロバイダーを順番に使用してみてください。
4. 資格情報がまだ取得されていない場合は、標準の基本認証ダイアログを使用して資格情報の入力を求められます。

IVsCredentialProvider.GetCredentialsAsync の実装

Visual Studio 用の NuGet 資格情報プロバイダーを作成するには、IVsCredentialProvider の種類を実装するパブリック MEF エクスポートを公開し、以下に示す原則に従う Visual Studio 拡張機能を作成します。

public interface IVsCredentialProvider
{
    Task<ICredentials> GetCredentialsAsync(
        Uri uri,
        IWebProxy proxy,
        bool isProxyRequest,
        bool isRetry,
        bool nonInteractive,
        CancellationToken cancellationToken);
}

サンプル実装は、VsCredentialProvider サンプル にあります。

Visual Studio 用の各 NuGet 資格情報プロバイダーは、次の手順を実行する必要があります。

1. 資格情報の取得を開始する前に、対象の URI の資格情報を提供できるかどうかを判断します。 プロバイダーがターゲット ソースの資格情報を指定できない場合は、nullを返す必要があります。
2. プロバイダーが対象 URI の要求を処理するが、資格情報を指定できない場合は、例外をスローする必要があります。

Visual Studio 用のカスタム NuGet 資格情報プロバイダーは、NuGet.VisualStudio パッケージで使用できる IVsCredentialProvider インターフェイスを実装する必要があります。

GetCredentialAsync

戻り値: System.Net.ICredentials インターフェイスを実装する資格情報オブジェクト。