- Notifications
You must be signed in to change notification settings - Fork1.1k
feat(cli): add macOS support for session token keyring storage#20613
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
zedkipp wants to merge1 commit intomainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
+236 −70
Draft
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
6 changes: 3 additions & 3 deletionscli/keyring_test.go
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
109 changes: 109 additions & 0 deletionscli/sessionstore/sessionstore_darwin.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| //go:build darwin | ||
| package sessionstore | ||
| import ( | ||
| "encoding/base64" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "os/exec" | ||
| "regexp" | ||
| "strings" | ||
| ) | ||
| const ( | ||
| // defaultServiceName is the service name used in the macOS Keychain | ||
| // for storing Coder CLI session tokens. | ||
| defaultServiceName="coder-v2-credentials" | ||
| // fixedUsername is the fixed username used for all keychain entries. | ||
| // Since our interface only uses service names, we use a constant username. | ||
| fixedUsername="coder-session-token" | ||
| execPathKeychain="/usr/bin/security" | ||
| notFoundStr="could not be found" | ||
| ) | ||
| // operatingSystemKeyring implements keyringProvider for macOS. | ||
| // It is largely adapted from the zalando/go-keyring package. | ||
| typeoperatingSystemKeyringstruct{} | ||
| func (operatingSystemKeyring)Set(service,credentialstring)error { | ||
| // if the added secret has multiple lines or some non ascii, | ||
| // macOS will hex encode it on return. To avoid getting garbage, we | ||
| // encode all passwords | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @ethanndickson what are your thoughts on keeping this base64 encoding/decoding? It's borrowed fromhttps://github.com/zalando/go-keyring/. I don't think we explicitly need it given our token format. | ||
| password:=base64.StdEncoding.EncodeToString([]byte(credential)) | ||
| cmd:=exec.Command(execPathKeychain,"-i") | ||
| stdIn,err:=cmd.StdinPipe() | ||
| iferr!=nil { | ||
| returnerr | ||
| } | ||
| iferr=cmd.Start();err!=nil { | ||
| returnerr | ||
| } | ||
| command:=fmt.Sprintf("add-generic-password -U -s %s -a %s -w %s\n", | ||
| shellEscape(service), | ||
| shellEscape(fixedUsername), | ||
| shellEscape(password)) | ||
| iflen(command)>4096 { | ||
| returnErrSetDataTooBig | ||
| } | ||
| if_,err:=io.WriteString(stdIn,command);err!=nil { | ||
| returnerr | ||
| } | ||
| iferr=stdIn.Close();err!=nil { | ||
| returnerr | ||
| } | ||
| returncmd.Wait() | ||
| } | ||
| func (operatingSystemKeyring)Get(servicestring) ([]byte,error) { | ||
| out,err:=exec.Command( | ||
| execPathKeychain, | ||
| "find-generic-password", | ||
| "-s",service, | ||
| "-wa",fixedUsername).CombinedOutput() | ||
| iferr!=nil { | ||
| ifstrings.Contains(string(out),notFoundStr) { | ||
| returnnil,os.ErrNotExist | ||
| } | ||
| returnnil,err | ||
| } | ||
| trimStr:=strings.TrimSpace(string(out)) | ||
| returnbase64.StdEncoding.DecodeString(trimStr) | ||
| } | ||
| func (operatingSystemKeyring)Delete(servicestring)error { | ||
| out,err:=exec.Command( | ||
| execPathKeychain, | ||
| "delete-generic-password", | ||
| "-s",service, | ||
| "-a",fixedUsername).CombinedOutput() | ||
| ifstrings.Contains(string(out),notFoundStr) { | ||
| returnos.ErrNotExist | ||
| } | ||
| returnerr | ||
| } | ||
| // shellEscape returns a shell-escaped version of the string s. | ||
| // This is adapted from github.com/zalando/go-keyring/internal/shellescape. | ||
| funcshellEscape(sstring)string { | ||
| iflen(s)==0 { | ||
| return"''" | ||
| } | ||
| pattern:=regexp.MustCompile(`[^\w@%+=:,./-]`) | ||
| ifpattern.MatchString(s) { | ||
| return"'"+strings.ReplaceAll(s,"'","'\"'\"'")+"'" | ||
| } | ||
| returns | ||
| } | ||
34 changes: 34 additions & 0 deletionscli/sessionstore/sessionstore_darwin_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| //go:build darwin | ||
| package sessionstore_test | ||
| import ( | ||
| "encoding/base64" | ||
| "os/exec" | ||
| "testing" | ||
| ) | ||
| const ( | ||
| execPathKeychain = "/usr/bin/security" | ||
| fixedUsername = "coder-session-token" | ||
| ) | ||
| func readRawKeychainCredential(t *testing.T, service string) []byte { | ||
| t.Helper() | ||
| out, err := exec.Command( | ||
| execPathKeychain, | ||
| "find-generic-password", | ||
| "-s", service, | ||
| "-wa", fixedUsername).CombinedOutput() | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| dst := make([]byte, base64.StdEncoding.DecodedLen(len(out))) | ||
| n, err := base64.StdEncoding.Decode(dst, out) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| return dst[:n] | ||
| } |
2 changes: 1 addition & 1 deletioncli/sessionstore/sessionstore_other.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| //go:build !windows && !darwin | ||
| package sessionstore | ||
10 changes: 10 additions & 0 deletionscli/sessionstore/sessionstore_other_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| //go:build !windows && !darwin | ||
| package sessionstore_test | ||
| import "testing" | ||
| func readRawKeychainCredential(t *testing.T, _ string) []byte { | ||
| t.Fatal("not implemented") | ||
| return nil | ||
| } |
70 changes: 68 additions & 2 deletionscli/sessionstore/sessionstore_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package sessionstore_test | ||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "net/url" | ||
| @@ -16,6 +17,11 @@ import ( | ||
| "github.com/coder/coder/v2/cli/sessionstore" | ||
| ) | ||
| type storedCredentials map[string]struct { | ||
| CoderURL string `json:"coder_url"` | ||
| APIToken string `json:"api_token"` | ||
| } | ||
ContributorAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. @ethanndickson this is essentially what gets stored as a JSON blob (b64 encoded -see my other comment). Looks like this in my keychain. Any problems/concerns for Coder Desktop on macOS, in terms of future session token sharing? | ||
| // Generate a test service name for use with the OS keyring. It uses a combination | ||
| // of the test name and a nanosecond timestamp to prevent collisions. | ||
| func keyringTestServiceName(t *testing.T) string { | ||
| @@ -26,8 +32,8 @@ func keyringTestServiceName(t *testing.T) string { | ||
| func TestKeyring(t *testing.T) { | ||
| t.Parallel() | ||
| if runtime.GOOS != "windows"&& runtime.GOOS != "darwin"{ | ||
| t.Skip("linuxis not supported yet") | ||
| } | ||
| // This test exercises use of the operating system keyring. As a result, | ||
| @@ -199,6 +205,66 @@ func TestKeyring(t *testing.T) { | ||
| err = backend.Delete(srvURL2) | ||
| require.NoError(t, err) | ||
| }) | ||
| t.Run("StorageFormat", func(t *testing.T) { | ||
| t.Parallel() | ||
| // The storage format must remain consistent to ensure we don't break | ||
| // compatibility with other Coder related applications that may read | ||
| // or decode the same credential. | ||
| const testURL1 = "http://127.0.0.1:1337" | ||
| srv1URL, err := url.Parse(testURL1) | ||
| require.NoError(t, err) | ||
| const testURL2 = "http://127.0.0.1:1338" | ||
| srv2URL, err := url.Parse(testURL2) | ||
| require.NoError(t, err) | ||
| serviceName := keyringTestServiceName(t) | ||
| backend := sessionstore.NewKeyringWithService(serviceName) | ||
| t.Cleanup(func() { | ||
| _ = backend.Delete(srv1URL) | ||
| _ = backend.Delete(srv2URL) | ||
| }) | ||
| // Write token for server 1 | ||
| const token1 = "token-server-1" | ||
| err = backend.Write(srv1URL, token1) | ||
| require.NoError(t, err) | ||
| // Write token for server 2 (should NOT overwrite server 1's token) | ||
| const token2 = "token-server-2" | ||
| err = backend.Write(srv2URL, token2) | ||
| require.NoError(t, err) | ||
| // Verify both credentials are stored in the raw format and can | ||
| // be extracted through the Backend API. | ||
| rawCredential := readRawKeychainCredential(t, serviceName) | ||
| storedCreds := make(storedCredentials) | ||
| err = json.Unmarshal(rawCredential, &storedCreds) | ||
| require.NoError(t, err, "unmarshalling stored credentials") | ||
| // Both credentials should exist | ||
| require.Len(t, storedCreds, 2) | ||
| require.Equal(t, token1, storedCreds[srv1URL.Host].APIToken) | ||
| require.Equal(t, token2, storedCreds[srv2URL.Host].APIToken) | ||
| // Read individual credentials | ||
| token, err := backend.Read(srv1URL) | ||
| require.NoError(t, err) | ||
| require.Equal(t, token1, token) | ||
| token, err = backend.Read(srv2URL) | ||
| require.NoError(t, err) | ||
| require.Equal(t, token2, token) | ||
| // Cleanup | ||
| err = backend.Delete(srv1URL) | ||
| require.NoError(t, err) | ||
| err = backend.Delete(srv2URL) | ||
| require.NoError(t, err) | ||
| }) | ||
| } | ||
| func TestFile(t *testing.T) { | ||
75 changes: 11 additions & 64 deletionscli/sessionstore/sessionstore_windows_test.go
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.