docker-credential-acr

command module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

ACR Docker Credential Helper

The ACR docker credential helper is an alternative to the existing file store based ACR helper located here which relies on az command line and is not optimised for use in CI environments. Primary use case for this helper is for use with kaniko and other tools running in CI scenarios wishing to push to Azure Container Registry

[!IMPORTANT] This is the maintained continuation of chrismellard/docker-credential-acr-env, which has gone defunct in March of 2023. The focus of this fork is to keep dependencies up-to-date and fix bugs.

How it works

The credential helper sources its configuration from well-known Azure environmental information. It attempts to authenticate firstly via client credentials grant if the following environment config is present

AZURE_CLIENT_ID=<clientID>
AZURE_CLIENT_SECRET=<clientSecret>
AZURE_TENANT_ID=<tenantId>

If the details needed for the client credential grant are not set it will try to find a federated OIDC JWT in the enviroment. To use this set the following values in the enviroment.

AZURE_CLIENT_ID=<clientID>
AZURE_FEDERATED_TOKEN=<federatedJWT>
AZURE_TENANT_ID=<tenantId>

If you use federated OIDC with Azure Workload Identity you don't have to set any ENVs as they will get injected automatically.

If the above are not set then authentication falls back to managed service identities and the MSI endpoint is attempted to be contacted which will work in various Azure contexts such as App Service and Azure Kubernetes Service where the MSI endpoint will authenticate the MSI context the service is running under.

Feature Flags

Flag FF_DOCKER_ACR_AZIDENTITY

Token acquisition goes through go-autorest, which Microsoft retired. Set this flag to true to go through azidentity instead, its successor in the Azure SDK for Go. Defaults to true. Will be deprecated in v1.1.0.

Flag FF_DOCKER_ACR_STRICT_HOST_CHECK

The registry check only looks at whether the parsed host ends in an ACR domain, so it also accepts userinfo, a path, a query, a fragment and percent-escapes. Set this flag to true to only accept input that is exactly the parsed host[:port]. Defaults to true. Will be deprecated in v1.1.0.

Documentation

Overview

Copyright © 2020 Chris Mellard chris.mellard@icloud.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis
internal
pkg

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL