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

fix: file/directory permissions #45

Merged
merged 1 commit into from
Aug 30, 2024
Merged

fix: file/directory permissions #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 16 additions & 16 deletions cmd/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func writeAPI(registry k6registry.Registry, target string) error {
func writeAPIGroupGlobal(registry k6registry.Registry, target string) error {
filename := filepath.Join(target, "registry.schema.json")

if err := os.WriteFile(filename, k6registry.Schema, 0o600); err != nil {
if err := os.WriteFile(filename, k6registry.Schema, permFile); err != nil {
return err
}

Expand All @@ -40,21 +40,21 @@ func writeAPIGroupGlobal(registry k6registry.Registry, target string) error {
return err
}

return os.WriteFile(filename, data, 0o600)
return os.WriteFile(filename, data, permFile)
}

//nolint:forbidigo
func writeAPIGroupModule(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "module")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

for _, ext := range registry {
dir := filepath.Join(base, ext.Module)

if err := os.MkdirAll(dir, 0o750); err != nil {
if err := os.MkdirAll(dir, permDir); err != nil {
return err
}

Expand All @@ -66,7 +66,7 @@ func writeAPIGroupModule(registry k6registry.Registry, target string) error {
return err
}

err = os.WriteFile(filename, b, 0o600)
err = os.WriteFile(filename, b, permFile)
if err != nil {
return err
}
Expand All @@ -79,7 +79,7 @@ func writeAPIGroupModule(registry k6registry.Registry, target string) error {
return err
}

if err = os.WriteFile(filename, data, 0o600); err != nil {
if err = os.WriteFile(filename, data, permFile); err != nil {
return err
}
}
Expand Down Expand Up @@ -107,7 +107,7 @@ func writeAPIGroupSubset(registry k6registry.Registry, target string) error {
func writeAPISubsetProduct(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "product")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

Expand All @@ -131,7 +131,7 @@ func writeAPISubsetProduct(registry k6registry.Registry, target string) error {
return err
}

err = os.WriteFile(filepath.Join(base, string(prod)+".json"), data, 0o600)
err = os.WriteFile(filepath.Join(base, string(prod)+".json"), data, permFile)
if err != nil {
return err
}
Expand All @@ -144,7 +144,7 @@ func writeAPISubsetProduct(registry k6registry.Registry, target string) error {
func writeAPISubsetTier(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "tier")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

Expand All @@ -170,7 +170,7 @@ func writeAPISubsetTier(registry k6registry.Registry, target string) error {
return err
}

err = os.WriteFile(filepath.Join(base, string(tier)+".json"), data, 0o600)
err = os.WriteFile(filepath.Join(base, string(tier)+".json"), data, permFile)
if err != nil {
return err
}
Expand All @@ -183,7 +183,7 @@ func writeAPISubsetTier(registry k6registry.Registry, target string) error {
func writeAPISubsetGrade(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "grade")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

Expand Down Expand Up @@ -213,7 +213,7 @@ func writeAPISubsetGrade(registry k6registry.Registry, target string) error {
return err
}

err = os.WriteFile(filepath.Join(base, string(grade)+".json"), data, 0o600)
err = os.WriteFile(filepath.Join(base, string(grade)+".json"), data, permFile)
if err != nil {
return err
}
Expand All @@ -226,7 +226,7 @@ func writeAPISubsetGrade(registry k6registry.Registry, target string) error {
func writeAPISubsetGradePassing(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "grade", "passing")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

Expand Down Expand Up @@ -262,7 +262,7 @@ func writeAPISubsetGradePassing(registry k6registry.Registry, target string) err
return err
}

err = os.WriteFile(filepath.Join(base, string(grade)+".json"), data, 0o600)
err = os.WriteFile(filepath.Join(base, string(grade)+".json"), data, permFile)
if err != nil {
return err
}
Expand All @@ -275,7 +275,7 @@ func writeAPISubsetGradePassing(registry k6registry.Registry, target string) err
func writeAPISubsetCategory(registry k6registry.Registry, target string) error {
base := filepath.Join(target, "category")

if err := os.MkdirAll(base, 0o750); err != nil {
if err := os.MkdirAll(base, permDir); err != nil {
return err
}

Expand Down Expand Up @@ -303,7 +303,7 @@ func writeAPISubsetCategory(registry k6registry.Registry, target string) error {
return err
}

err = os.WriteFile(filepath.Join(base, string(cat)+".json"), data, 0o600)
err = os.WriteFile(filepath.Join(base, string(cat)+".json"), data, permFile)
if err != nil {
return err
}
Expand Down
8 changes: 7 additions & 1 deletion cmd/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"context"
_ "embed"
"encoding/json"
"io/fs"
"os"

"github.com/spf13/cobra"
Expand Down Expand Up @@ -77,7 +78,7 @@ func New() (*cobra.Command, error) {
//nolint:forbidigo
func run(ctx context.Context, args []string, opts *options) (result error) {
if len(opts.api) != 0 {
if err := os.MkdirAll(opts.api, 0o750); err != nil {
if err := os.MkdirAll(opts.api, permDir); err != nil {
return err
}

Expand Down Expand Up @@ -148,3 +149,8 @@ func run(ctx context.Context, args []string, opts *options) (result error) {

return nil
}

const (
permFile fs.FileMode = 0o644
permDir fs.FileMode = 0o755
)
5 changes: 2 additions & 3 deletions cmd/context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"net/http"
"os"
"path/filepath"
"syscall"
"time"

"github.com/adrg/xdg"
Expand Down Expand Up @@ -46,7 +45,7 @@ func newContext(ctx context.Context, appname string) (context.Context, error) {
return nil, err
}

err = os.MkdirAll(cacheDir, syscall.S_IWUSR|syscall.S_IRUSR|syscall.S_IXUSR) //nolint:forbidigo
err = os.MkdirAll(cacheDir, permDir) //nolint:forbidigo
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -97,7 +96,7 @@ func cacheSubDir(ctx context.Context, subdir string) (string, error) {
}

dir := filepath.Join(base, subdir)
if err := os.MkdirAll(dir, syscall.S_IWUSR|syscall.S_IRUSR|syscall.S_IXUSR); err != nil {
if err := os.MkdirAll(dir, permDir); err != nil {
return "", err
}

Expand Down
4 changes: 2 additions & 2 deletions cmd/lint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func saveCompliance(ctx context.Context, module string, comp *k6lint.Compliance)

filename := filepath.Join(base, module) + ".json"

if err := os.MkdirAll(filepath.Dir(filename), 0o750); err != nil {
if err := os.MkdirAll(filepath.Dir(filename), permDir); err != nil {
return err
}

Expand All @@ -60,7 +60,7 @@ func saveCompliance(ctx context.Context, module string, comp *k6lint.Compliance)
return err
}

return os.WriteFile(filename, data, 0o600)
return os.WriteFile(filename, data, permFile)
}

//nolint:forbidigo
Expand Down
9 changes: 9 additions & 0 deletions releases/v0.1.15.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
k6registry `v0.1.15` is here 🎉!

This is an internal maintenance release.

**Fix file/directory permissions**

`golangci-lint` forces the file permission to be `0o600` and the directory permission to be `0o750`. When k6registry runs as a GitHub action, it runs as the root user, so accessing the generated files from the rest of the workflow is problematic.

In the case of generated files, now the permission set to `0o644`, in the case of a direcotry to `0o755`.
Loading