Authentification des flux dans Visual Studio avec des fournisseurs d’informations d’identification NuGet

NuGet Visual Studio Extension 3.6+ prend en charge les fournisseurs d’informations d’identification, qui permettent à NuGet d’utiliser des flux authentifiés. Après avoir installé un fournisseur d’informations d’identification NuGet pour Visual Studio, l’extension NuGet Visual Studio acquiert et actualise automatiquement les informations d’identification pour les flux authentifiés si nécessaire.

Vous trouverez un exemple d’implémentation dans l’exemple VsCredentialProvider.

Dans Visual Studio, NuGet utilise un élément interne VsCredentialProviderImporter qui recherche également les fournisseurs de certificats pour plug-in. Ces fournisseurs d’informations d’identification de plug-in doivent être détectables en tant qu’exportation MEF de type IVsCredentialProvider.

À partir de la version 4.8+ de NuGet, Visual Studio prend également en charge les nouveaux plug-ins d’authentification multiplateforme, mais ils ne sont pas l’approche recommandée pour des raisons de performances.

Note

Les fournisseurs d’informations d’identification NuGet pour Visual Studio doivent être installés en tant qu’extension Visual Studio standard et nécessitent Visual Studio 2017 ou version ultérieure.

Les fournisseurs d'authentification NuGet pour Visual Studio fonctionnent uniquement sur Visual Studio (pas dans dotnet restore ni nuget.exe). Pour les fournisseurs d’informations d’identification avec nuget.exe, consultez nuget.exe Fournisseurs d’informations d’identification. Pour les fournisseurs d’informations d’identification dans dotnet et msbuild, consultez les plug-ins multiplateformes NuGet

Création d’un fournisseur d’informations d’identification NuGet pour Visual Studio

NuGet Visual Studio Extension 3.6+ implémente un CredentialService interne utilisé pour acquérir des informations d’identification. CredentialService contient une liste de fournisseurs d'identifiants intégrés et extensibles. Chaque fournisseur est essayé séquentiellement jusqu’à ce que les informations d’identification soient acquises.

Lors de l’acquisition des informations d’identification, le service d’informations d’identification essaiera les fournisseurs d’informations d’identification dans l’ordre suivant, ce qui s’arrête dès que les informations d’identification sont acquises :

  1. Les informations d’identification seront extraites à l'aide de l'élément intégré des fichiers de configuration NuGet (SettingsCredentialProvider).
  2. Les fournisseurs de crédentiels Visual Studio seront essayés séquentiellement.
  3. Essayez d’utiliser tous les fournisseurs d’informations d’identification multiplateformes NuGet de manière séquentielle.
  4. Si aucune information d’identification n’a encore été acquise, l’utilisateur est invité à entrer des informations d’identification à l’aide d’une boîte de dialogue d’authentification de base standard.

Mise en œuvre de IVsCredentialProvider.GetCredentialsAsync

Pour créer un fournisseur d’informations d’identification NuGet pour Visual Studio, créez une extension Visual Studio qui expose une exportation MEF publique qui implémente le IVsCredentialProvider type et respecte les principes décrits ci-dessous.

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

Vous trouverez un exemple d’implémentation dans l’exemple VsCredentialProvider.

Chaque fournisseur d’informations d’identification NuGet pour Visual Studio doit :

  1. Déterminez s’il peut fournir des informations d’identification pour l’URI ciblé avant de lancer l’acquisition d’informations d’identification. Si le fournisseur ne peut pas fournir d’informations d’identification pour la source ciblée, il doit retourner null.
  2. Si le fournisseur gère les demandes pour l’URI ciblé, mais ne peut pas fournir d’informations d’identification, une exception doit être levée.

Un fournisseur d’informations d’identification NuGet personnalisé pour Visual Studio doit implémenter l’interface IVsCredentialProvider disponible dans le package NuGet.VisualStudio.

GetCredentialAsync

Paramètre d’entrée Descriptif
Uri uri URI source du package pour lequel les informations d’identification sont demandées.
IWebProxy proxy Proxy web à utiliser lors de la communication sur le réseau. Null s’il n’existe aucune authentification proxy configurée.
bool isProxyRequest True si cette demande vise à obtenir les justificatifs d'authentification de proxy. Si l’implémentation n’est pas valide pour l’acquisition d’informations d’identification du proxy, la valeur Null doit être retournée.
bool isRetry True si les informations d’identification ont été demandées précédemment pour cet URI, mais les informations d’identification fournies n’ont pas autorisé l’accès.
bool nonInteractive Si le statut est "vrai", le fournisseur d'identifiants doit supprimer toutes les demandes utilisateur et utiliser les valeurs par défaut à la place.
Jeton d'annulation cancellationToken Ce jeton d’annulation doit être vérifié pour déterminer si l’opération demandant des informations d’identification a été annulée.

Valeur de retour : un objet d'identifiants implémentant l’interface System.Net.ICredentials.