Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Security

- the config file, which stores the API token, is now saved with owner-only
permissions, and files left world-readable by older versions are tightened on
the next save

### Fixed

- shell completion no longer crashes with an index-out-of-range panic when
Expand Down
12 changes: 10 additions & 2 deletions pkg/cmdutil/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,19 @@ func (*config) Save() error {
}

dir := path.Join(home, ".config", "clockify-cli")
_ = os.MkdirAll(dir, os.ModePerm)
if err := os.MkdirAll(dir, 0o700); err != nil {
return err
}
filename = path.Join(dir, ".clockify-cli.yaml")
}

return viper.WriteConfigAs(filename)
// the file holds the api token, keep it owner-only even when it was
// created world-readable by an older version
viper.SetConfigPermissions(0o600)
if err := viper.WriteConfigAs(filename); err != nil {
return err
}
return os.Chmod(filename, 0o600)
}

func configFunc() func() (c Config) {
Expand Down
46 changes: 46 additions & 0 deletions pkg/cmdutil/config_save_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
package cmdutil_test

import (
"os"
"path/filepath"
"testing"

"github.com/mitchellh/go-homedir"
"github.com/spf13/viper"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"github.com/lucassabreu/clockify-cli/pkg/cmdutil"
)

func TestSaveUsesOwnerOnlyPermissions(t *testing.T) {
home := t.TempDir()
t.Setenv("HOME", home)
t.Cleanup(homedir.Reset)
homedir.Reset()
t.Cleanup(func() { viper.SetConfigFile("") })
viper.SetConfigFile("")

config := cmdutil.NewFactory(cmdutil.Version{}).Config()
config.SetString(cmdutil.CONF_TOKEN, "a token")
require.NoError(t, config.Save())

dir := filepath.Join(home, ".config", "clockify-cli")
filename := filepath.Join(dir, ".clockify-cli.yaml")

dirInfo, err := os.Stat(dir)
require.NoError(t, err)
assert.Equal(t, os.FileMode(0o700), dirInfo.Mode().Perm())

fileInfo, err := os.Stat(filename)
require.NoError(t, err)
assert.Equal(t, os.FileMode(0o600), fileInfo.Mode().Perm())

// a file left world-readable by an older version gets tightened on save
require.NoError(t, os.Chmod(filename, 0o644))
require.NoError(t, config.Save())

fileInfo, err = os.Stat(filename)
require.NoError(t, err)
assert.Equal(t, os.FileMode(0o600), fileInfo.Mode().Perm())
}
Loading