Skip to content

Fix path traversal vulnerabilities in update-readme tool #40

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

Closed
wants to merge 1 commit into from
Closed

Fix path traversal vulnerabilities in update-readme tool #40

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
39 changes: 37 additions & 2 deletions internal/tools/update-readme/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"maps"
"os"
"path/filepath"
"slices"
"strings"

Expand All @@ -25,7 +26,12 @@ func (o *OpenShift) IsOpenShift(ctx context.Context) bool {
var _ internalk8s.Openshift = (*OpenShift)(nil)

func main() {
readme, err := os.ReadFile(os.Args[1])
readmePath, err := resolveReadmePath(os.Args[1:])
if err != nil {
panic(err)
}

readme, err := os.ReadFile(readmePath)
if err != nil {
panic(err)
}
Expand Down Expand Up @@ -81,11 +87,40 @@ func main() {
toolsetTools.String(),
)

if err := os.WriteFile(os.Args[1], []byte(updated), 0o644); err != nil {
if err := os.WriteFile(readmePath, []byte(updated), 0o644); err != nil {
panic(err)
}
}

func resolveReadmePath(args []string) (string, error) {
var requested string
switch len(args) {
case 0:
requested = "README.md"
case 1:
requested = args[0]
default:
return "", fmt.Errorf("Error: Provide at most one README.md argument")
}

cleanPath := filepath.Clean(requested)
if cleanPath != "README.md" {
return "", fmt.Errorf("Error: This tool can only update the repository root README.md")
}

repoRoot, err := os.Getwd()
if err != nil {
return "", fmt.Errorf("determine working directory: %w", err)
}

absoluteRepoRoot, err := filepath.Abs(repoRoot)
if err != nil {
return "", fmt.Errorf("resolve working directory: %w", err)
}

return filepath.Join(absoluteRepoRoot, "README.md"), nil
}

func replaceBetweenMarkers(content, startMarker, endMarker, replacement string) string {
startIdx := strings.Index(content, startMarker)
if startIdx == -1 {
Expand Down