Skip to content
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.

Sign up for GitHub

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

show warning for old livemode values #919

Merged
merged 3 commits into from
Aug 2, 2022
Merged

show warning for old livemode values #919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
604108b
show warning for old livemode values
etsai2-stripe Jul 22, 2022
c3f77e1
keep publishable key in config file
etsai2-stripe Jul 22, 2022
29d4352
remove extra new line
etsai2-stripe Jul 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 1 addition & 16 deletions pkg/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,22 +168,7 @@ func (c *Config) InitConfig() {
})

// redact livemode values for existing configs
if err := viper.ReadInConfig(); err == nil {
// if the config file has expires at date, then it is using the new livemode key storage
if viper.IsSet(c.Profile.GetConfigField(LiveModeAPIKeyName)) {
key := viper.GetString(c.Profile.GetConfigField(LiveModeAPIKeyName))
if !IsRedactedAPIKey(key) {
c.Profile.WriteConfigField(LiveModeAPIKeyName, RedactAPIKey(key))
}
}

if viper.IsSet(c.Profile.GetConfigField(LiveModePubKeyName)) {
key := viper.GetString(c.Profile.GetConfigField(LiveModePubKeyName))
if !IsRedactedAPIKey(key) {
c.Profile.WriteConfigField(LiveModePubKeyName, RedactAPIKey(key))
}
}
}
c.Profile.redactAllLivemodeValues()
}

// EditConfig opens the configuration file in the default editor.
Expand Down
51 changes: 24 additions & 27 deletions pkg/config/profile.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,8 @@ func (p *Profile) GetAPIKey(livemode bool) (string, error) {
key = viper.GetString(p.GetConfigField(TestModeAPIKeyName))
}
} else {
key, err = p.RetrieveLivemodeValue(LiveModeAPIKeyName)
p.redactAllLivemodeValues()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would the values already be redacted by this point? Is this call defensive?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes its a defensive check in case user manually edits the config tom file again

key, err = p.retrieveLivemodeValue(LiveModeAPIKeyName)
if err != nil {
return "", err
}
Expand All @@ -162,7 +163,7 @@ func (p *Profile) GetExpiresAt(livemode bool) (time.Time, error) {
var err error

if livemode {
timeString, err = p.RetrieveLivemodeValue(LiveModeKeyExpiresAtName)
timeString, err = p.retrieveLivemodeValue(LiveModeKeyExpiresAtName)
if err != nil {
return time.Time{}, err
}
Expand All @@ -183,30 +184,30 @@ func (p *Profile) GetExpiresAt(livemode bool) (time.Time, error) {

// GetPublishableKey returns the publishable key for the user
func (p *Profile) GetPublishableKey(livemode bool) (string, error) {
var fieldID string
var key string
var err error

if livemode {
key, err = p.RetrieveLivemodeValue(LiveModePubKeyName)
if err != nil {
return "", err
}
fieldID = LiveModePubKeyName
} else {
// test mode
if err := viper.ReadInConfig(); err == nil {
if viper.IsSet(p.GetConfigField("publishable_key")) {
p.RegisterAlias(TestModePubKeyName, "publishable_key")
}
// there is a bug with viper.GetStringMapString when the key name is too long, which makes
// `config --list --project-name <project_name>` unable to read the project specific config
if viper.IsSet(p.GetConfigField("test_mode_publishable_key")) {
p.RegisterAlias(TestModePubKeyName, "test_mode_publishable_key")
}

key = viper.GetString(p.GetConfigField(TestModePubKeyName))
fieldID = TestModePubKeyName

if viper.IsSet(p.GetConfigField("publishable_key")) {
p.RegisterAlias(TestModePubKeyName, "publishable_key")
}
// there is a bug with viper.GetStringMapString when the key name is too long, which makes
// `config --list --project-name <project_name>` unable to read the project specific config
if viper.IsSet(p.GetConfigField("test_mode_publishable_key")) {
p.RegisterAlias(TestModePubKeyName, "test_mode_publishable_key")
}
}

err := viper.ReadInConfig()
if err != nil {
return "", err
}

key = viper.GetString(p.GetConfigField(fieldID))
if key != "" {
return key, nil
}
Expand Down Expand Up @@ -258,7 +259,7 @@ func (p *Profile) DeleteConfigField(field string) error {

// delete livemode redacted values from config and full values from keyring
if field == LiveModeAPIKeyName || field == LiveModePubKeyName || field == LiveModeKeyExpiresAtName {
p.DeleteLivemodeValue(field)
p.deleteLivemodeValue(field)
}

return p.writeProfile(v)
Expand All @@ -284,16 +285,12 @@ func (p *Profile) writeProfile(runtimeViper *viper.Viper) error {
runtimeViper.Set(p.GetConfigField(LiveModeKeyExpiresAtName), expiresAt)

// store actual key in secure keyring
p.storeLivemodeValue(LiveModeAPIKeyName, strings.TrimSpace(p.LiveModeAPIKey), "Live mode API key")
p.storeLivemodeValue(LiveModeKeyExpiresAtName, expiresAt, "Live mode API key expirary")
p.saveLivemodeValue(LiveModeAPIKeyName, strings.TrimSpace(p.LiveModeAPIKey), "Live mode API key")
p.saveLivemodeValue(LiveModeKeyExpiresAtName, expiresAt, "Live mode API key expirary")
}

if p.LiveModePublishableKey != "" {
// store redacted key in config
runtimeViper.Set(p.GetConfigField(LiveModePubKeyName), RedactAPIKey(strings.TrimSpace(p.LiveModePublishableKey)))

// store actual key in secure keyring
p.storeLivemodeValue(LiveModePubKeyName, strings.TrimSpace(p.LiveModePublishableKey), "Live mode publishable key")
runtimeViper.Set(p.GetConfigField(LiveModePubKeyName), strings.TrimSpace(p.LiveModePublishableKey))
}

if p.TestModeAPIKey != "" {
Expand Down
39 changes: 31 additions & 8 deletions pkg/config/profile_livemode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
package config

import (
"fmt"
"os"
"strings"

"github.com/99designs/keyring"
"github.com/spf13/viper"

"github.com/stripe/stripe-cli/pkg/ansi"
"github.com/stripe/stripe-cli/pkg/validators"
)

Expand All @@ -17,8 +21,8 @@ const KeyValidInDays = 90
// KeyRing ...
var KeyRing keyring.Keyring

// storeLivemodeValue
func (p *Profile) storeLivemodeValue(field, value, description string) {
// saveLivemodeValue saves livemode value of given key in keyring
func (p *Profile) saveLivemodeValue(field, value, description string) {
fieldID := p.GetConfigField(field)
_ = KeyRing.Set(keyring.Item{
Key: fieldID,
Expand All @@ -28,8 +32,8 @@ func (p *Profile) storeLivemodeValue(field, value, description string) {
})
}

// RetrieveLivemodeValue ...
func (p *Profile) RetrieveLivemodeValue(key string) (string, error) {
// retrieveLivemodeValue retrieves livemode value of given key in keyring
func (p *Profile) retrieveLivemodeValue(key string) (string, error) {
fieldID := p.GetConfigField(key)
existingKeys, err := KeyRing.Keys()
if err != nil {
Expand All @@ -46,8 +50,8 @@ func (p *Profile) RetrieveLivemodeValue(key string) (string, error) {
return "", validators.ErrAPIKeyNotConfigured
}

// DeleteLivemodeValue ...
func (p *Profile) DeleteLivemodeValue(key string) error {
// deleteLivemodeValue deletes livemode value of given key in keyring
func (p *Profile) deleteLivemodeValue(key string) error {
fieldID := p.GetConfigField(key)
existingKeys, err := KeyRing.Keys()
if err != nil {
Expand All @@ -62,6 +66,25 @@ func (p *Profile) DeleteLivemodeValue(key string) error {
return nil
}

// redactAllLivemodeValues redacts all livemode values in the local config file
func (p *Profile) redactAllLivemodeValues() {
color := ansi.Color(os.Stdout)

if err := viper.ReadInConfig(); err == nil {
// if the config file has expires at date, then it is using the new livemode key storage
if viper.IsSet(p.GetConfigField(LiveModeAPIKeyName)) {
key := viper.GetString(p.GetConfigField(LiveModeAPIKeyName))
if !isRedactedAPIKey(key) {
fmt.Println(color.Yellow(`
(!) Livemode value found for the field '` + LiveModeAPIKeyName + `' in your config file.
Livemode values from the config file will be redacted and will not be used.`))

p.WriteConfigField(LiveModeAPIKeyName, RedactAPIKey(key))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we redact LiveModePubKeyName too?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i did that at first but tomer said we should leave out publishable key since its public facing, which makes sense

}
}
}
}

// RedactAPIKey returns a redacted version of API keys. The first 8 and last 4
// characters are not redacted, everything else is replaced by "*" characters.
//
Expand All @@ -76,8 +99,8 @@ func RedactAPIKey(apiKey string) string {
return b.String()
}

// IsRedactedAPIKey ...
func IsRedactedAPIKey(apiKey string) bool {
// isRedactedAPIKey checks if the input string is a refacted api key
func isRedactedAPIKey(apiKey string) bool {
keyParts := strings.Split(apiKey, "_")
if len(keyParts) < 3 {
return false
Expand Down