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.

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

fix panic when os.Stat returns an error besides ErrNotExists #2162

Merged
merged 6 commits into from Aug 17, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 8 additions & 2 deletions cmd/cosign/cli/generate/generate_key_pair.go
Expand Up @@ -18,16 +18,17 @@ package generate
import (
"context"
"crypto"
"errors"
"fmt"
"io"
"os"
"strings"

"github.com/pkg/errors"
"github.com/sigstore/cosign/pkg/cosign/git"
"github.com/sigstore/cosign/pkg/cosign/git/github"
"github.com/sigstore/cosign/pkg/cosign/git/gitlab"

icos "github.com/sigstore/cosign/internal/pkg/cosign"
"github.com/sigstore/cosign/pkg/cosign"
"github.com/sigstore/cosign/pkg/cosign/kubernetes"
"github.com/sigstore/sigstore/pkg/cryptoutils"
Expand Down Expand Up @@ -85,7 +86,12 @@ func GenerateKeyPairCmd(ctx context.Context, kmsVal string, args []string) error
return err
}

if cosign.FileExists("cosign.key") {
fileExists, err := icos.FileExists("cosign.key")
if err != nil {
return fmt.Errorf("error checking if cosign.key exists: %w", err)
cpanato marked this conversation as resolved.
Show resolved Hide resolved
}

if fileExists {
var overwrite string
fmt.Fprint(os.Stderr, "File cosign.key already exists. Overwrite (y/n)? ")
fmt.Scanf("%s", &overwrite)
Expand Down
8 changes: 7 additions & 1 deletion cmd/cosign/cli/importkeypair/import_key_pair.go
Expand Up @@ -21,6 +21,7 @@ import (
"io"
"os"

icos "github.com/sigstore/cosign/internal/pkg/cosign"
"github.com/sigstore/cosign/pkg/cosign"
)

Expand All @@ -36,7 +37,12 @@ func ImportKeyPairCmd(ctx context.Context, keyVal string, args []string) error {
return err
}

if cosign.FileExists("import-cosign.key") {
fileExists, err := icos.FileExists("import-cosign.key")
if err != nil {
return fmt.Errorf("error checking if import-cosign.key exists: %w", err)
}

if fileExists {
var overwrite string
fmt.Fprint(os.Stderr, "File import-cosign.key already exists. Overwrite (y/n)? ")
fmt.Scanf("%s", &overwrite)
Expand Down
28 changes: 28 additions & 0 deletions internal/pkg/cosign/common.go
@@ -0,0 +1,28 @@
// Copyright 2021 The Sigstore Authors.
dsa0x marked this conversation as resolved.
Show resolved Hide resolved
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cosign

import "os"

func FileExists(filename string) (bool, error) {
info, err := os.Stat(filename)
if os.IsNotExist(err) {
return false, nil
}
if err != nil {
return false, err
}
return !info.IsDir(), nil
}
51 changes: 51 additions & 0 deletions internal/pkg/cosign/common_test.go
@@ -0,0 +1,51 @@
//
// Copyright 2022 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cosign

import (
"os"
"testing"
)

func Test_FileExists(t *testing.T) {
tmpFile, err := os.CreateTemp(os.TempDir(), "cosign_test.txt")
if err != nil {
t.Fatal(err)
}

tests := []struct {
name string
path string
exists bool
wantErr bool
}{
{"file exists", tmpFile.Name(), true, false},
{"file does not exist", "testt.txt", false, false},
{"other error e.g cannot access file", "\000x", false, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := FileExists(tt.path)
if (err != nil) != tt.wantErr {
t.Errorf("FileExists() error = %v, wantErr %v", err, tt.wantErr)
return
}
if got != tt.exists {
t.Errorf("FileExists() = %v, want %v", got, tt.exists)
}
})
}
}
9 changes: 0 additions & 9 deletions pkg/cosign/common.go
Expand Up @@ -26,15 +26,6 @@ import (
"golang.org/x/term"
)

// TODO(jason): Move this to an internal package.
func FileExists(filename string) bool {
info, err := os.Stat(filename)
if os.IsNotExist(err) {
return false
}
return !info.IsDir()
}

// ConfirmPrompt prompts the user for confirmation for an action. Supports skipping
// the confirmation prompt when skipConfirmation is set.
// TODO(jason): Move this to an internal package.
Expand Down