-
Notifications
You must be signed in to change notification settings - Fork 1
feat: improve secret-ref UX and docs for profiles #110
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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,35 @@ | ||
| //go:build darwin | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "fmt" | ||
| "os/exec" | ||
| "strings" | ||
| ) | ||
|
|
||
| var execCommandContext = exec.CommandContext | ||
|
|
||
| func saveSecretToNativeStore(ctx context.Context, service, account, value string) error { | ||
| cmd := execCommandContext(ctx, "security", "add-generic-password", "-U", "-s", service, "-a", account, "-w", value) | ||
| var stderr bytes.Buffer | ||
| cmd.Stderr = &stderr | ||
| if err := cmd.Run(); err != nil { | ||
| msg := strings.TrimSpace(stderr.String()) | ||
| if msg == "" { | ||
| msg = err.Error() | ||
| } | ||
| return fmt.Errorf("save secret in macOS keychain failed: %s", msg) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func nativeSecretExists(ctx context.Context, service, account string) (bool, error) { | ||
| cmd := execCommandContext(ctx, "security", "find-generic-password", "-s", service, "-a", account, "-w") | ||
| if err := cmd.Run(); err != nil { | ||
| return false, nil | ||
| } | ||
|
rmanibus marked this conversation as resolved.
|
||
| return true, nil | ||
|
rmanibus marked this conversation as resolved.
|
||
| } | ||
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,101 @@ | ||
| //go:build darwin | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "os/exec" | ||
| "reflect" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestSaveSecretToNativeStore_Success(t *testing.T) { | ||
| orig := execCommandContext | ||
| defer func() { execCommandContext = orig }() | ||
|
|
||
| var gotName string | ||
| var gotArgs []string | ||
| execCommandContext = func(ctx context.Context, name string, args ...string) *exec.Cmd { | ||
| gotName = name | ||
| gotArgs = append([]string{}, args...) | ||
| return exec.CommandContext(ctx, "sh", "-c", "exit 0") | ||
| } | ||
|
|
||
| err := saveSecretToNativeStore(context.Background(), "cloudstic/store/prod", "password", "super-secret") | ||
| if err != nil { | ||
| t.Fatalf("saveSecretToNativeStore: %v", err) | ||
| } | ||
| if gotName != "security" { | ||
| t.Fatalf("command name=%q want security", gotName) | ||
| } | ||
| wantArgs := []string{"add-generic-password", "-U", "-s", "cloudstic/store/prod", "-a", "password", "-w", "super-secret"} | ||
| if !reflect.DeepEqual(gotArgs, wantArgs) { | ||
| t.Fatalf("command args=%v want=%v", gotArgs, wantArgs) | ||
| } | ||
| } | ||
|
|
||
| func TestSaveSecretToNativeStore_Failure(t *testing.T) { | ||
| orig := execCommandContext | ||
| defer func() { execCommandContext = orig }() | ||
|
|
||
| execCommandContext = func(ctx context.Context, name string, args ...string) *exec.Cmd { | ||
| return exec.CommandContext(ctx, "sh", "-c", "echo keychain failed 1>&2; exit 1") | ||
| } | ||
|
|
||
| err := saveSecretToNativeStore(context.Background(), "svc", "acct", "secret") | ||
| if err == nil { | ||
| t.Fatal("expected error") | ||
| } | ||
| if !strings.Contains(err.Error(), "save secret in macOS keychain failed") { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| if !strings.Contains(err.Error(), "keychain failed") { | ||
| t.Fatalf("expected stderr in error: %v", err) | ||
| } | ||
| } | ||
|
|
||
| func TestNativeSecretExists_Success(t *testing.T) { | ||
| orig := execCommandContext | ||
| defer func() { execCommandContext = orig }() | ||
|
|
||
| var gotName string | ||
| var gotArgs []string | ||
| execCommandContext = func(ctx context.Context, name string, args ...string) *exec.Cmd { | ||
| gotName = name | ||
| gotArgs = append([]string{}, args...) | ||
| return exec.CommandContext(ctx, "sh", "-c", "exit 0") | ||
| } | ||
|
|
||
| exists, err := nativeSecretExists(context.Background(), "cloudstic/store/prod", "password") | ||
| if err != nil { | ||
| t.Fatalf("nativeSecretExists: %v", err) | ||
| } | ||
| if !exists { | ||
| t.Fatal("expected exists=true") | ||
| } | ||
| if gotName != "security" { | ||
| t.Fatalf("command name=%q want security", gotName) | ||
| } | ||
| wantArgs := []string{"find-generic-password", "-s", "cloudstic/store/prod", "-a", "password", "-w"} | ||
| if !reflect.DeepEqual(gotArgs, wantArgs) { | ||
| t.Fatalf("command args=%v want=%v", gotArgs, wantArgs) | ||
| } | ||
| } | ||
|
|
||
| func TestNativeSecretExists_NotFound(t *testing.T) { | ||
| orig := execCommandContext | ||
| defer func() { execCommandContext = orig }() | ||
|
|
||
| execCommandContext = func(ctx context.Context, name string, args ...string) *exec.Cmd { | ||
| return exec.CommandContext(ctx, "sh", "-c", "exit 1") | ||
| } | ||
|
|
||
| exists, err := nativeSecretExists(context.Background(), "svc", "acct") | ||
| if err != nil { | ||
| t.Fatalf("nativeSecretExists: %v", err) | ||
| } | ||
| if exists { | ||
| t.Fatal("expected exists=false") | ||
| } | ||
| } |
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,16 @@ | ||
| //go:build !darwin | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| ) | ||
|
|
||
| func saveSecretToNativeStore(_ context.Context, _, _, _ string) error { | ||
| return errors.New("native secret write not supported on this platform") | ||
| } | ||
|
|
||
| func nativeSecretExists(_ context.Context, _, _ string) (bool, error) { | ||
| return false, nil | ||
| } |
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.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.