The Azure Artifacts Credential Provider automates the acquisition of credentials needed to restore NuGet packages as part of your .NET development workflow. It integrates with MSBuild, dotnet, and NuGet(.exe) and works on Windows, Mac, and Linux. Any time you want to use packages from an Azure Artifacts feed, the Credential Provider will automatically acquire and securely store a token on behalf of the NuGet client you're using.
Install Visual Studio version 15.9-preview1 or later to get the required version of msbuild (15.8.166.59604 or later).
NuGet(.exe) on the command line version 4.8.0.5385 or later is required. The recommended NuGet version is 5.5.x or later as it has some important bug fixes related to cancellations and timeouts.
dotnet SDK version 2.1.400 or later is required on Windows. The recommended dotnet version is 3.1.200 or later as it has some important bug fixes related to cancellations and timeouts.
If you are using dotnet or nuget, you can use the Azure Artifact Credential Provider by adding it to NuGet's plugin search path. This section contains both manual and scripted instructions for doing so.
Dotnet needs the netcore version to be installed. NuGet and MSBuild need the netfx version to be installed.
- To install netcore, run
installcredprovider.ps1- e.g.
iex "& { $(irm https://aka.ms/install-artifacts-credprovider.ps1) }"
- e.g.
- To install both netfx and netcore, run
installcredprovider.ps1 -AddNetfx. The netfx version is needed for nuget.exe.- e.g.
iex "& { $(irm https://aka.ms/install-artifacts-credprovider.ps1) } -AddNetfx"
- e.g.
- Download the latest release of Microsoft.NuGet.CredentialProvider.zip
- Unzip the file
- Copy the
netcore(andnetfxfor nuget.exe) directory from the extracted archive to$env:UserProfile\.nuget\plugins(%UserProfile%/.nuget/plugins/)
Using the above is recommended, but as per NuGet's plugin discovery rules, alternatively you can install the credential provider to a location you prefer, and then set the environment variable NUGET_PLUGIN_PATHS to the .exe of the credential provider found in plugins\netfx\CredentialProvider.Microsoft\CredentialProvider.Microsoft.exe. For example, $env:NUGET_PLUGIN_PATHS="my-alternative-location\CredentialProvider.Microsoft.exe". Note that if you are using both nuget and dotnet, this environment variable is not recommended due to this issue: NuGet/Home#8151
- e.g.
wget -qO- https://aka.ms/install-artifacts-credprovider.sh | bash
- Download the latest release of Microsoft.NuGet.CredentialProvider.tar.gz
- Untar the file
- Copy the
netcore(and 'netfx' for msbuild /t:restore command) directory from the extracted archive to$HOME/.nuget/plugins
Using the above is recommended, but as per NuGet's plugin discovery rules, alternatively you can install the credential provider to a location you prefer, and then set the environment variable NUGET_PLUGIN_PATHS to the .dll of the credential provider found in plugins\netcore\CredentialProvider.Microsoft\CredentialProvider.Microsoft.dll. For example, $env:NUGET_PLUGIN_PATHS="my-alternative-location\CredentialProvider.Microsoft.dll".
- MSBuild in Visual Studio Developer Command Prompt with Visual Studio 15.9+
- Azure DevOps Pipelines NuGetAuthenticate task
- Azure DevOps Pipelines NuGet task, NuGetCommandV2 version 2.145.3+ (Azure DevOps Server 2019 Update 1+)
Because the Credential Provider is a NuGet plugin, it is most commonly used indirectly, by performing a NuGet operation that requires authentication using dotnet, nuget, or msbuild.
The first time you perform an operation that requires authentication using dotnet, you must either use the --interactive flag to allow dotnet to prompt you for credentials, or provide them via an environment variable.
If you're running interactively navigate to your project directory and run:
dotnet restore --interactiveOnce you've successfully acquired a token, you can run authenticated commands without the --interactive flag for the lifespan of the token which is saved in the session token cache location.
The nuget client will prompt for authentication when you run a restore and it does not find credential in the session token cache location. By default, it will attempt to open a dialog for authentication and will fall back to console input if that fails.
nuget restoreWhen using Windows and you are already signed in to Azure DevOps, Windows Integrated Authentication may be used to get automatically authenticated as the signed in user.
The first time you perform an operation that requires authentication using msbuild, you must use the /p:nugetInteractive=true switch to allow msbuild to prompt you for credentials. For example, to restore packages, navigate to your project or solution directory and run:
msbuild /t:restore /p:nugetInteractive=trueOnce you've successfully acquired a token, you can run authenticated commands without the /p:nugetInteractive=true switch.
Use the NuGet Authenticate task before running NuGet, dotnet or MSBuild commands that need authentication.
If you're running the command as part of an automated build on an unattended build agent outside of Azure DevOps Pipelines, you can supply an access token directly using the VSS_NUGET_EXTERNAL_FEED_ENDPOINTS environment variable. The use of Personal Access Tokens is recommended. You may need to restart the agent service or the computer before the environment variables are available to the agent.
Managing NuGet credentials in Docker scenarios
The Azure Artifacts Credential Provider may not be necessary for an on-premises Azure DevOps Server on Windows. If the credential provider is needed, it cannot acquire credentials interactively, therefore, the VSS_NUGET_EXTERNAL_FEED_ENDPOINTS environment variable must be used as an alternative. Supply a Personal Access Token directly using the VSS_NUGET_EXTERNAL_FEED_ENDPOINTS environment variable.
From Azure DevOps Server 2020 RC1 forward, the NuGet Authenticate task can be used in Pipelines.
The Credential Provider will save session tokens in the following locations:
- Windows:
$env:UserProfile\AppData\Local\MicrosoftCredentialProvider - Linux/MAC:
$HOME/.local/share/MicrosoftCredentialProvider/
The Credential Provider accepts a set of environment variables. Not all of them we recommend using in production, but these two are considered safe.
NUGET_CREDENTIALPROVIDER_SESSIONTOKENCACHE_ENABLED: Controls whether or not the session token is saved to disk. If false, the Credential Provider will prompt for auth every time.VSS_NUGET_EXTERNAL_FEED_ENDPOINTS: Json that contains an array of service endpoints, usernames and access tokens to authenticate endpoints in nuget.config. Example:
{"endpointCredentials": [{"endpoint":"http://example.index.json", "username":"optional", "password":"accesstoken"}]}The windows plugin, delivered in the netfx folder of Microsoft.NuGet.CredentialProvider.zip, ships a stand-alone executable that will acquire credentials. This program will place the credentials in the same location that the .dll would if it were called by nuget.exe, dotnet.exe, or msbuild.exe. The stand-alone executable will also print the available command options, environment variables, and credential storage locations. This information is reproduced here:
C:\> .\CredentialProvider.Microsoft.exe -h
Command-line v0.1.17: .\CredentialProvider.Microsoft.exe -h
The Azure Artifacts credential provider can be used to aquire credentials for Azure Artifacts.
Note: The Azure Artifacts Credential Provider is mainly intended for use via integrations with development tools such as .NET Core and nuget.exe.
While it can be used via this CLI in "stand-alone mode", please pay special attention to certain options such as -IsRetry below.
Failing to do so may result in obtaining invalid credentials.
Usage - CredentialProvider.Microsoft -options
GlobalOption Description
Plugin (-P) Used by nuget to run the credential helper in plugin mode
Uri (-U) The package source URI for which credentials will be filled
NonInteractive (-N) If present and true, providers will not issue interactive prompts
IsRetry (-I) If false / unset, INVALID CREDENTIALS MAY BE RETURNED. The caller is required to validate returned credentials themselves, and if invalid, should call the credential provider again with -IsRetry set. If true, the
credential provider will obtain new credentials instead of returning potentially invalid credentials from the cache.
Verbosity (-V) Display this amount of detail in the output [Default='Information']
Debug
Verbose
Information
Minimal
Warning
Error
RedactPassword (-R) Prevents writing the password to standard output (for troubleshooting purposes)
Help (-?, -h) Prints this help message
CanShowDialog (-C) If true, user can be prompted with credentials through UI, if false, device flow must be used
OutputFormat (-F) In standalone mode, format the results for human readability or as JSON. If JSON is selected, then logging (which may include Device Code instructions) will be logged to standard error instead of standard output.
HumanReadable
Json
List of Environment Variables
The following is a list of environment variables that can be used to modify the
behavior of the credential provider. They may be used for workarounds but their
use is not supported. Use at your own risk.
Log Path
NUGET_CREDENTIALPROVIDER_LOG_PATH
Absolute path to a log file where the provider will write log messages.
Session Token Cache Enabled
NUGET_CREDENTIALPROVIDER_SESSIONTOKENCACHE_ENABLED
Boolean to enable/disable the Session Token cache.
ADAL Authority
NUGET_CREDENTIALPROVIDER_ADAL_AUTHORITY
Set to override the authority used when fetching an ADAL token.
e.g. https://login.microsoftonline.com
ADAL Token File Cache Enabled
NUGET_CREDENTIALPROVIDER_ADAL_FILECACHE_ENABLED
Boolean to enable/disable the ADAL token cache. Disabled by default.
PPE ADAL Hosts
NUGET_CREDENTIALPROVIDER_ADAL_PPEHOSTS
Semi-colon separated list of hosts that should use the PPE environment
when fetching ADAL tokens. Should only be used for testing/development
environments such as DevFabric.
Supported Hosts
NUGET_CREDENTIALPROVIDER_VSTS_HOSTS
Semi-colon separated list of hosts that the ADAL provider supports.
Session Token Time Validity
NUGET_CREDENTIALPROVIDER_VSTS_SESSIONTIMEMINUTES
Time in minutes the generated Session Tokens will be valid for.
The default for Personal Access Tokens is 90 days.
The default for JWT (self-describing) tokens is 4 hours.
The maximum allowed validity period for JWT tokens is 24 hours.
Token Type
NUGET_CREDENTIALPROVIDER_VSTS_TOKENTYPE
Specify 'Compact' to generate a Personal Access Token, which may
have a long validity period as it can easily be revoked from the UI,
and sends a notification mail on creation.
Specify 'SelfDescribing' to generate a shorter-lived JWT token,
which does not appear in any UI or notifications
and is more difficult to revoke.
By default PATs are generated rather than JWTs,
unless authentication can be performed non-interactively.
Build Provider URI Prefixes
VSS_NUGET_URI_PREFIXES
Semi-colon separated list of hosts the build provider supports.
Build Provider Access Token
VSS_NUGET_ACCESSTOKEN
The Personal Access Token that will be returned as credentials by
the build provider.
Build Provider Service Endpoint Json
VSS_NUGET_EXTERNAL_FEED_ENDPOINTS
Json that contains an array of service endpoints, usernames and
access tokens to authenticate endpoints in nuget.config.
Example: {"endpointCredentials": [{"endpoint":"http://example.index.json",
"username":"optional", "password":"accesstoken"}]}
Cache Location
The Credential Provider uses the following paths to cache credentials. If
deleted, the credential provider will re-create them but any credentials
will need to be provided again.
ADAL Token Cache
C:\Users\someuser\AppData\Local\MicrosoftCredentialProvider\ADALTokenCache.dat
Session Token Cache
C:\Users\someuser\AppData\Local\MicrosoftCredentialProvider\SessionTokenCache.dat
Windows Integrated Authentication
NUGET_CREDENTIALPROVIDER_WINDOWSINTEGRATEDAUTHENTICATION_ENABLED
Boolean to enable/disable using silent Windows Integrated Authentication
to authenticate as the logged-in user. Enabled by default.
Device Flow Authentication Timeout
NUGET_CREDENTIALPROVIDER_VSTS_DEVICEFLOWTIMEOUTSECONDS
Device Flow authentication timeout in seconds. Default is 90 seconds.
NuGet workarounds
NUGET_CREDENTIALPROVIDER_FORCE_CANSHOWDIALOG_TO
Set to "true" or "false" to override any other sources of the
CanShowDialog parameter
How do I know the cred provider is installed correctly? / I'm still getting username/password prompt after installing
This means that either nuget/dotnet was unable to find the cred provider from NuGet's plugin search path, or the cred provider failed to authenticate so the client defaulted to the username/password prompt. Verify the cred provider is correctly installed by checking it exists in the nuget/plugins folder in your user profile (Refer to the setup docs). If using nuget.exe and used the install script to install the cred provider, please make sure you ran it with -AddNetfx.
Run the nuget.exe/dotnet command with detailed verbosity to see more cred provider logs that may help debugging (nuget.exe -verbosity detailed, dotnet --verbosity detailed).
Run the credential provider directly with the following command: C:\Users\<user>\.nuget\plugins\netfx\CredentialProvider.Microsoft\CredentialProvider.Microsoft.exe -I -V Verbose -U "https://pkgs.dev.azure.com/{organization}/{project-if-feed-is-project-scoped}/_packaging/{feed}/nuget/v3/index.json". Check you have the right permissions from the feed permissions.
In an Azure DevOps Pipeline, verify you have set the right permissions for the pipeline by following the docs.
This project welcomes contributions and suggestions; see CONTRIBUTING for more information. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.