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

Jump to bottom

Ignore invalid key files in keystore directory. #4700

Merged
merged 4 commits into from
Feb 15, 2018
Merged

Ignore invalid key files in keystore directory. #4700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4bbaa2a
Modified keystore to ignore invalid key files inside the keystore dir…
matrushka Feb 14, 2018
23e1179
Removing the tmp directory after the TestInvalidKeyFiles test.
matrushka Feb 14, 2018
40aeea6
Added logging for ignored keyfiles in keystore.List and minor improve…
matrushka Feb 14, 2018
e338cdf
Handling requested changes.
matrushka Feb 14, 2018
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
25 changes: 24 additions & 1 deletion keystore/keystore.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ import (
"path/filepath"
"strings"

logging "gx/ipfs/QmRb5jh8z2E8hMGN2tkvs1yHynUanqnZ3UeKwgN1i9P1F8/go-log"
ci "gx/ipfs/QmaPbCnUMBohSGo3KnxEa2bHqyJVVeEEcwtqJAYxerieBo/go-libp2p-crypto"
)

var log = logging.Logger("keystore")

// Keystore provides a key management interface
type Keystore interface {
// Has returns whether or not a key exist in the Keystore
Expand Down Expand Up @@ -77,6 +80,10 @@ func (ks *FSKeystore) Has(name string) (bool, error) {
return false, err
}

if err := validateName(name); err != nil {
return false, err
}

return true, nil
}

Expand Down Expand Up @@ -149,5 +156,21 @@ func (ks *FSKeystore) List() ([]string, error) {
return nil, err
}

return dir.Readdirnames(0)
dirs, err := dir.Readdirnames(0)
if err != nil {
return nil, err
}

list := make([]string, 0, len(dirs))

for _, name := range dirs {
err := validateName(name)
if err == nil {
list = append(list, name)
} else {
log.Warningf("Ignoring the invalid keyfile: %s", name)
}
}

return list, nil
}
60 changes: 60 additions & 0 deletions keystore/keystore_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"fmt"
"io/ioutil"
"math/rand"
"os"
"path/filepath"
"sort"
"testing"

Expand Down Expand Up @@ -143,6 +145,64 @@ func TestKeystoreBasics(t *testing.T) {
}
}

func TestInvalidKeyFiles(t *testing.T) {
tdir, err := ioutil.TempDir("", "keystore-test")

if err != nil {
t.Fatal(err)
}

Copy link
Member

Choose a reason for hiding this comment

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

defer os.RemoveAll(tdir)

defer os.RemoveAll(tdir)

ks, err := NewFSKeystore(tdir)
if err != nil {
t.Fatal(err)
}

key := privKeyOrFatal(t)

bytes, err := key.Bytes()
if err != nil {
t.Fatal(err)
}

err = ioutil.WriteFile(filepath.Join(ks.dir, "valid"), bytes, 0644)
if err != nil {
t.Fatal(err)
}

err = ioutil.WriteFile(filepath.Join(ks.dir, ".invalid"), bytes, 0644)
if err != nil {
t.Fatal(err)
}

l, err := ks.List()
if err != nil {
t.Fatal(err)
}

sort.Strings(l)
if len(l) != 1 {
t.Fatal("wrong entry count")
}

if l[0] != "valid" {
t.Fatal("wrong entries listed")
}

exist, err := ks.Has("valid")
if !exist {
t.Fatal("should know it has a key named valid")
}
if err != nil {
t.Fatal(err)
}

if exist, err = ks.Has(".invalid"); err == nil {
t.Fatal("shouldnt be able to put a key with a 'hidden' name")
}
}

func TestNonExistingKey(t *testing.T) {
tdir, err := ioutil.TempDir("", "keystore-test")
if err != nil {
Expand Down