v0.4.0

Important

All existing APIs have been moved to oras-go and are now deprecated in oras-credentials-go. For more information, please refer to #80.

Deprecation

• Package credentials is deprecated. Please use oras.land/oras-go/v2/registry/remote/credentials instead.
• Package trace is deprecated. Please use oras.land/oras-go/v2/registry/remote/credentials/trace instead.

Detailed Commits

• build(deps): bump oras.land/oras-go/v2 from 2.2.1 to 2.3.0 by @dependabot in #91
• Add SECURITY.md file by @TerryHowe in #90
• build(deps): bump apache/skywalking-eyes from 0.4.0 to 0.5.0 by @dependabot in #88
• build(deps): bump actions/checkout from 3 to 4 by @dependabot in #94
• feat: Add 'MemoryStore' by @uanid in #92
• deprecate: deprecate all existing APIs by @Wwwsylvia in #96
• chore: enable workflows for release branches by @Wwwsylvia in #98
• build(deps): bump actions/setup-go from 4 to 5 by @dependabot in #103
• build(deps): bump github/codeql-action from 2 to 3 by @dependabot in #104
• build: upgrade the version of oras-go by @wangxiaoxuan273 in #105

New Contributors

• @TerryHowe made their first contribution in #90
• @uanid made their first contribution in #92

Full Changelog: v0.3.0...v0.4.0

v0.3.1

Bug Fixes

• Fix #1: Legacy auth keys (e.g. https://ghcr.io/ instead of ghcr.io) are not supported in config files

Detailed Commits

• chore: enable workflows for release branches (#98) by @Wwwsylvia in #99
• fix: file store to support legacy auth keys in config files by @Wwwsylvia in #100

Full Changelog: v0.3.0...v0.3.1

v0.3.0

New Features

• Introduce package trace that provides mechanisms to trace the execution of credential helper executables.

Detailed Commits

• build(deps): bump oras.land/oras-go/v2 from 2.2.0 to 2.2.1 by @dependabot in #82
• feat: support trace with executables by @wangxiaoxuan273 in #81
• docs: add a brief introduction in README by @Wwwsylvia in #83
• docs: add an example for trace by @wangxiaoxuan273 in #86

Full Changelog: v0.2.0...v0.3.0

v0.2.0

New Features

• Introduce new public APIs and data types:
  • NewDefaultNativeStore() detects the platform-default docker credentials helper and returns a native store
  • DynamicStore is exported for config-file-based stores
  • ServerAddressFromRegistry and ServerAddressFromHostname create the proper keys for credentials store, especially for handling docker.io scenarios
• Introduce a new option DetectDefaultNativeStore in StoreOptions
  • BREAKING CHANGE: The default value of DetectDefaultNativeStore is false, which was equivalently set to true in previous versions. Details can be found in #73

Other Changes

• Remove dependency on github.com/docker/docker-credential-helpers
• Support context cancelling for native stores
• BREAKING CHANGE: NewStore and NewStoreFromDocker returns *DynamicStore instead of Store
• Return more user-friendly error message when invoking docker-credential-desktop.exe in WSL2 while Docker Desktop is not running

Detailed Commits

• feat: add package client, the Program type and its related operations by @wangxiaoxuan273 in #68
• fix: added back handling no credentials error by @wangxiaoxuan273 in #74
• feat!: add NewDefaultNativeStore and DynamicStore.IsAuthConfigured by @Wwwsylvia in #73
• refactor!: rename DetectDefaultCredsStore to DetectDefaultNativeStore by @Wwwsylvia in #75
• feat: expose registry name mapping methods by @wangxiaoxuan273 in #76
• fix: use a better error message on WSL by @wangxiaoxuan273 in #77

Full Changelog: v0.1.1...v0.2.0

v0.1.1

Bug Fixes

• Fix #65: Login to docker.io does not work as expected

Other Changes

• Improve error messages

Detailed Commits

• docs: refine error messages by @Wwwsylvia in #64
• build: bump indirect dependencies by @Wwwsylvia in #66
• build: bump up oras-go to v2.2.0 by @Wwwsylvia in #69

Full Changelog: v0.1.0...v0.1.1

v0.1.0

Features

oras-credentials-go is a registry credential management SDK designed for oras-go. It is based on Docker configuration files and Docker credential helpers.

oras-credentials-go provides the following functionalities:

• A Store interface for retrieving, saving and removing credentials
• A native credentials store that uses a Docker credential helper program to manage credentials
• A file credentials store that uses a Docker-format config file to manage credentials in plaintext:
  • Supports option DisablePut that disables putting credentials in plaintext
• A dynamic credentials store that will dynamically determine which underlying credentials store to use based on the specified Docker-format config file
  • Supports reading from the Docker config file
• Attaching multiple Stores to an existing Store as fallbacks
• Convenient utility methods:
  • Credential(): Return a function for auth.Client.Credential
  • Login(): Validate and store the given credential for the given server address
  • Logout(): Remove the credential for the given server address

Detailed Commits

• chore: add CODEOWNERS and MAINTAINERS by @shizhMSFT in #16
• chore: update README.md by @shizhMSFT in #17
• build: add dependabot by @wangxiaoxuan273 in #22
• build: add makefile by @wangxiaoxuan273 in #21
• build: initialize go mod by @Wwwsylvia in #19
• build: add build.yml by @wangxiaoxuan273 in #23
• build: add license checker workflow by @Wwwsylvia in #20
• build: add CodeQL workflow by @Wwwsylvia in #24
• build: use github url for go module name by @Wwwsylvia in #37
• feat: define Store interface by @Wwwsylvia in #38
• build: enable codecov by @Wwwsylvia in #25
• chore: add badges by @shizhMSFT in #40
• feat: implement native store by @wangxiaoxuan273 in #41
• feat: support login by @wangxiaoxuan273 in #42
• feat: support logout by @wangxiaoxuan273 in #44
• feat: Implement File Store by @Wwwsylvia in #43
• feat: implement StoreWithFallbacks by @wangxiaoxuan273 in #46
• feat: support credential function by @wangxiaoxuan273 in #45
• fix: make Native Store private by @wangxiaoxuan273 in #48
• feat: Support creating store from a config file by @Wwwsylvia in #47
• feat: support creating store from the default Docker config file by @Wwwsylvia in #52
• test: enhance test coverage by @Wwwsylvia in #53
• docs: add examples for Login, Logout and Credential by @wangxiaoxuan273 in #56
• docs: add examples for three store functions by @wangxiaoxuan273 in #54
• docs: add examples for NewStoreFromDocker and NewStoreWithFallbacks by @wangxiaoxuan273 in #55
• fix broken logo link by @FeynmanZhou in #57
• docs: fix broken link in README by @wangxiaoxuan273 in #59
• build(deps): bump oras.land/oras-go/v2 from 2.0.2 to 2.1.0 by @dependabot in #60

New Contributors

• @shizhMSFT made their first contribution in #16
• @wangxiaoxuan273 made their first contribution in #22
• @Wwwsylvia made their first contribution in #19
• @FeynmanZhou made their first contribution in #57
• @dependabot made their first contribution in #60

Full Changelog: https://github.com/oras-project/oras-credentials-go/commits/v0.1.0