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