artifacts-keyring 2.0.0rc2

"Automatically retrieve credentials for Azure Artifacts."

NOTE

'artifacts-keyring' is a relatively thin wrapper around artifacts-credprovider. Make sure to also look at that repository for more information about different scenarios. For example:

• Environment variable to explicitly override tokens
• Safely using credentials in docker

artifacts-keyring

The artifacts-keyring package provides authentication for publishing or consuming Python packages to or from Azure Artifacts feeds within Azure DevOps.

This package is an extension to keyring, which will automatically find and use it once installed.

Both pip and twine will use keyring to find credentials.

Installation

To install this package, run the following pip command:

pip install artifacts-keyring

Usage

Requirements

To use artifacts-keyring to set up authentication between pip/twine and Azure Artifacts, the following requirements must be met:

• pip version 19.2 or higher

• twine version 1.13.0 or higher

• python version 3.9 or higher

  If no matching platform specific .whl is found when running pip install and the sdist is 
  fetched instead, the .NET runtime 8.0.X or later is required. Refer to [here](https://
  learn.microsoft.com/dotnet/core/install/) for installation guideline.
  

macOS requirements

The platform-specific macOS wheels require macOS 11.0 or higher. This is because the bundled MSAL native library (msalruntime.dylib) targets macOS 11.0+, which is encoded into the wheel's platform tag (e.g. macosx_11_0_arm64). pip will only install the platform-specific wheel on macOS 11.0+.

On macOS 10.x, no matching platform-specific wheel will be found and pip will fall back to the source distribution (sdist), which requires a .NET 8 runtime or sdk to be installed separately.

Linux requirements

On Linux, artifacts-keyring is distributed as a source distribution (sdist) that bundles the default (non-platform-specific) .NET 8 artifacts-credential provider. This requires .NET 8 or higher .NET runtime or sdk to be installed.

The bundled MSAL native library (libmsalruntime.so) also requires additional Linux package dependencies. See the MSAL .NET Linux package dependencies for the full list.

See Linux credential provider setup for advanced options to remove the .NET runtime dependency.

Publishing packages to an Azure Artifacts feed

Once artifacts-keyring is installed, to publish a package, use the following twine command, replacing <org_name> and <feed_name> with your own:

twine upload --repository-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/upload <package_wheel_or_other_dist_format>

Installing packages from an Azure Artifacts feed

Once artifacts-keyring is installed, to consume a package, use the following pip command, replacing <org_name> and <feed_name> with your own, and <package_name> with the package you want to install:

pip install <package_name> --index-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/simple

Advanced configuration

The artifacts-keyring package is layered on top of our Azure Artifacts Credential Provider. Check out that link to the GitHub repo for more information on configuration options.

Environment variables

• ARTIFACTS_KEYRING_NONINTERACTIVE_MODE: Controls whether the underlying credential provider can issue interactive prompts.
• ARTIFACTS_KEYRING_VERBOSITY: Sets the verbosity level of the underlying credential provider. Valid values: Debug, Verbose, Information, Minimal, Warning, Error. Defaults to Information. Note: Setting this to Warning or higher will suppress interactive authentication prompts (e.g. device code flow instructions). Use Information or lower when interactive login is needed.
• ARTIFACTS_KEYRING_CREDENTIALPROVIDER_PATH: The full path to the Azure Artifacts Credential Provider executable (e.g. ~/.dotnet/tools/CredentialProvider.Microsoft or ~/.nuget/plugins/netcore/CredentialProvider.Microsoft/CredentialProvider.Microsoft). When set, this path is used instead of the bundled credential provider on all platforms. On Linux, where only a source distribution is available with the non-self-contained .NET 8 credential provider, this variable can be used to point to a self-contained platform-specific binary (e.g. linux-x64) that does not require a .NET runtime, but does require additional linux dependencies. The executable at the provided path must already have the appropriate permissions set (e.g. chmod +x).

Linux credential provider setup

To remove the .NET runtime/sdk dependency for supported Linux platforms, you can install a self-contained version of the Azure Artifacts Credential Provider and its Linux package dependencies separately and point artifacts-keyring to it using the ARTIFACTS_KEYRING_CREDENTIALPROVIDER_PATH environment variable. The self-contained binary still requires the MSAL .NET Linux package dependencies.

Example: Using a self-contained credential provider binary

# Download and install the credential provider using the install script
wget -qO- https://aka.ms/install-artifacts-credprovider.sh | bash

# Point artifacts-keyring to the executable
export ARTIFACTS_KEYRING_CREDENTIALPROVIDER_PATH=~/.nuget/plugins/netcore/CredentialProvider.Microsoft/CredentialProvider.Microsoft

Once set, pip and twine commands work as usual:

pip install <package_name> --index-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/simple

Build Environment Variables

• ARTIFACTS_CREDENTIAL_PROVIDER_RID: Controls whether or not to build with a specific runtime of the self-contained .NET version of the Azure Artifacts Credential Provider.
• ARTIFACTS_CREDENTIAL_PROVIDER_NON_SC: Controls whether or not to build the non-self-contained .NET 8 version of keyring.

Troubleshooting

Enabling credential provider logs

For debug logs of the artifacts-credprovider, enable file logging by setting the ARTIFACTS_CREDENTIALPROVIDER_LOG_PATH environment variable to an absolute path before running pip or twine:

Windows (PowerShell):

$env:ARTIFACTS_CREDENTIALPROVIDER_LOG_PATH = "C:\path\to\credprovider.log"
pip install <package_name> --index-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/simple

Linux/macOS:

export ARTIFACTS_CREDENTIALPROVIDER_LOG_PATH=/path/to/credprovider.log
pip install <package_name> --index-url https://pkgs.dev.azure.com/<org_name>/_packaging/<feed_name>/pypi/simple

Clearing credential caches to force a full token refresh

The credential provider uses two cache layers. To force re-authentication, clear both:

1. Session Token Cache — stores the short-lived token used by pip/twine:

Windows (PowerShell):

Remove-Item "$env:LocalAppData\MicrosoftCredentialProvider\SessionTokenCache.dat" -ErrorAction SilentlyContinue

Linux/macOS:

rm -f ~/.local/share/MicrosoftCredentialProvider/SessionTokenCache.dat

2. MSAL Token Cache — stores the underlying Azure identity token used to acquire new session tokens:

Windows (PowerShell):

Remove-Item -Recurse -Force "$env:LocalAppData\.IdentityService" -ErrorAction SilentlyContinue

Linux/macOS:

rm -rf ~/.local/.IdentityService

3. pip HTTP cache — stores downloaded package metadata and wheels; clearing ensures pip re-fetches from the feed:

pip cache purge

The next pip or twine command should force a token refresh.

Local development

1. Install build dependencies with pip install .
2. For local builds, build the project using python -m build --outdir %DIRECTORY%
3. You can also mimic the CI build using cibuildwheel --platform auto --output-dir %DIRECTORY%
4. Open a new terminal window in %DIRECTORY%, then run pip install ***.whl --force-reinstall

Contributing

This project welcomes contributions and suggestions. 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 [e-mail] with any additional questions or comments.