Skip to content

Commit

Permalink
Delete keychain item on login (#1198)
Browse files Browse the repository at this point in the history
  • Loading branch information
vcheung-stripe committed Jun 6, 2024
1 parent 4876ff1 commit 2e96396
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 0 deletions.
4 changes: 4 additions & 0 deletions pkg/config/profile.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ func (p *Profile) CreateProfile() error {
// Remove all keys under existing profile first
v := p.deleteProfile(viper.GetViper())

if err := p.deleteLivemodeValue(LiveModeAPIKeyName); err != nil {
return err
}

writeErr := p.writeProfile(v)
if writeErr != nil {
return writeErr
Expand Down
123 changes: 123 additions & 0 deletions pkg/config/profile_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"path/filepath"
"testing"

"github.com/99designs/keyring"
"github.com/spf13/viper"
"github.com/stretchr/testify/require"
)
Expand Down Expand Up @@ -243,6 +244,128 @@ func TestExperimentalFieldsEmptyWhenAPIKeyIsOverridden(t *testing.T) {
cleanUp(c.ProfilesFile)
}

func TestLiveModeAPIKeyKeychainItemDeleted(t *testing.T) {
profilesFile := filepath.Join(os.TempDir(), "stripe", "config.toml")
p := Profile{
ProfileName: "test",
DeviceName: "device-before-test",
LiveModeAPIKey: "",
TestModeAPIKey: "sk_test_123",
DisplayName: "display-name-before-test",
}
c := &Config{
Color: "auto",
LogLevel: "info",
Profile: p,
ProfilesFile: profilesFile,
}
c.InitConfig()
KeyRing = keyring.NewArrayKeyring([]keyring.Item{
{
Key: "test.live_mode_api_key",
Data: []byte("rk_live_0000000001"),
},
})

v := viper.New()

v.SetConfigFile(profilesFile)
err := p.writeProfile(v)
require.NoError(t, err)

err = p.CreateProfile()
require.NoError(t, err)

keys, err := KeyRing.Keys()
require.NoError(t, err)
require.Empty(t, keys)

cleanUp(c.ProfilesFile)
}

func TestLiveModeAPIKeyKeychainItemCreated(t *testing.T) {
profilesFile := filepath.Join(os.TempDir(), "stripe", "config.toml")
p := Profile{
ProfileName: "test",
DeviceName: "device-before-test",
LiveModeAPIKey: "rk_live_0000000001",
TestModeAPIKey: "sk_test_123",
DisplayName: "display-name-before-test",
}
c := &Config{
Color: "auto",
LogLevel: "info",
Profile: p,
ProfilesFile: profilesFile,
}
c.InitConfig()
KeyRing = keyring.NewArrayKeyring([]keyring.Item{})

v := viper.New()

v.SetConfigFile(profilesFile)
err := p.writeProfile(v)
require.NoError(t, err)

err = p.CreateProfile()
require.NoError(t, err)

item, err := KeyRing.Get("test.live_mode_api_key")
require.NoError(t, err)
require.Equal(t, keyring.Item{
Key: "test.live_mode_api_key",
Data: []byte("rk_live_0000000001"),
Label: "test.live_mode_api_key",
Description: "Live mode API key",
}, item)

cleanUp(c.ProfilesFile)
}

func TestLiveModeAPIKeyKeychainItemReplaced(t *testing.T) {
profilesFile := filepath.Join(os.TempDir(), "stripe", "config.toml")
p := Profile{
ProfileName: "test",
DeviceName: "device-before-test",
LiveModeAPIKey: "rk_live_0000000002",
TestModeAPIKey: "sk_test_123",
DisplayName: "display-name-before-test",
}
c := &Config{
Color: "auto",
LogLevel: "info",
Profile: p,
ProfilesFile: profilesFile,
}
c.InitConfig()
KeyRing = keyring.NewArrayKeyring([]keyring.Item{
{
Key: "test.live_mode_api_key",
Data: []byte("rk_live_0000000001"),
},
})

v := viper.New()

v.SetConfigFile(profilesFile)
err := p.writeProfile(v)
require.NoError(t, err)

err = p.CreateProfile()
require.NoError(t, err)

item, err := KeyRing.Get("test.live_mode_api_key")
require.NoError(t, err)
require.Equal(t, keyring.Item{
Key: "test.live_mode_api_key",
Data: []byte("rk_live_0000000002"),
Label: "test.live_mode_api_key",
Description: "Live mode API key",
}, item)

cleanUp(c.ProfilesFile)
}

func helperLoadBytes(t *testing.T, name string) []byte {
bytes, err := os.ReadFile(name)
if err != nil {
Expand Down

0 comments on commit 2e96396

Please sign in to comment.