Store CLI token in OS system keychain#1191
Draft
michael-webster wants to merge 3 commits intodevelopfrom
Draft
Conversation
Uses github.com/zalando/go-keyring to store the API token in the OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service) under the service name "com.circleci.cli" keyed by host URL. Existing tokens in ~/.circleci/cli.yml are silently migrated to the keychain on first load. Falls back to the YAML token when the keychain is unavailable (CI/headless environments).
6 tasks
added 2 commits
March 12, 2026 16:05
- Split .goreleaser.yml into two builds: darwin (CGO_ENABLED=1) and linux/windows (CGO_ENABLED=0) so the darwin keychain integration can link against Apple Security.framework - Move deploy and deploy-test jobs to the mac executor so goreleaser builds darwin natively with CGO available - Extract docker image build/push into a new deploy-docker job on the Linux executor (macOS executor has no Docker support) - Extract install-go-mac and install-goreleaser-mac as reusable commands - Remove CGO_ENABLED=0 from the mac executor (goreleaser sets it per-build)
On macOS CI runners the Security framework blocks indefinitely waiting for user authorisation when a keychain item is read or written. Add settings/keychain_mock_init.go (build tag: keychain_mock) which calls keyring.MockInit() in init() so all keychain calls use an in-memory store instead of the OS keychain. Pass -tags=keychain_mock to every gexec.Build call so the subprocess CLI binary used in cmd tests always gets the mock backend.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
github.com/zalando/go-keyringto store the API token in the OS keychain (macOS Keychain, Windows Credential Manager, Linux Secret Service) under the service namecom.circleci.clikeyed by host URL~/.circleci/cli.ymlare silently migrated to the keychain on firstLoadFromDiskcallCIRCLECI_CLI_TOKENenv var still overrides everythingkeyring.Get("com.circleci.cli", "https://circleci.com")Test plan
go test ./settings/...passes (useskeyring.MockInit()in tests)go build ./...passescircleci setup→ token appears in macOS Keychain Access undercom.circleci.cli~/.circleci/cli.ymlhas blanktoken:field after setupcircleci whoami)