Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(compute/serve): let wasm-tools fail more gracefully #1160

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

Merged
Integralist merged 1 commit into from
Mar 14, 2024
Merged

fix(compute/serve): let wasm-tools fail more gracefully #1160

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
53 changes: 37 additions & 16 deletions pkg/commands/compute/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,7 @@ func (c *BuildCommand) Exec(in io.Reader, out io.Writer) (err error) {
}
}
if c.MetadataShow {
if err := c.ShowMetadata(wasmtools, out); err != nil {
return err
}
c.ShowMetadata(wasmtools, out)
}
} else {
if !c.Globals.Verbose() {
Expand Down Expand Up @@ -321,7 +319,7 @@ func (c *BuildCommand) Exec(in io.Reader, out io.Writer) (err error) {

// AnnotateWasmBinaryShort annotates the Wasm binary with only the CLI version.
func (c *BuildCommand) AnnotateWasmBinaryShort(wasmtools string, args []string) error {
return c.Globals.ExecuteWasmTools(wasmtools, args)
return c.Globals.ExecuteWasmTools(wasmtools, args, c.Globals)
}

// AnnotateWasmBinaryLong annotates the Wasm binary will all available data.
Expand Down Expand Up @@ -373,16 +371,14 @@ func (c *BuildCommand) AnnotateWasmBinaryLong(wasmtools string, args []string, l

data, err := json.Marshal(dc)
if err != nil {
return err
text.Info(c.Globals.Output, "failed to marshal DataCollection struct into JSON: %s", err)
}

args = append(args, fmt.Sprintf("--processed-by=fastly_data=%s", data))

return c.Globals.ExecuteWasmTools(wasmtools, args)
return c.Globals.ExecuteWasmTools(wasmtools, args, c.Globals)
}

// ShowMetadata displays the metadata attached to the Wasm binary.
func (c *BuildCommand) ShowMetadata(wasmtools string, out io.Writer) error {
func (c *BuildCommand) ShowMetadata(wasmtools string, out io.Writer) {
// gosec flagged this:
// G204 (CWE-78): Subprocess launched with variable
// Disabling as the variables come from trusted sources.
Expand All @@ -391,12 +387,12 @@ func (c *BuildCommand) ShowMetadata(wasmtools string, out io.Writer) error {
command := exec.Command(wasmtools, "metadata", "show", "bin/main.wasm")
wasmtoolsOutput, err := command.Output()
if err != nil {
return fmt.Errorf("failed to execute wasm-tools metadata command: %w", err)
text.Error(out, "failed to execute wasm-tools metadata command: %s\n\n", err)
return
}
text.Info(out, "\nBelow is the metadata attached to the Wasm binary\n\n")
fmt.Fprintln(out, string(wasmtoolsOutput))
text.Break(out)
return nil
}

// includeSourceCode calculates what source code files to include in the final
Expand Down Expand Up @@ -461,27 +457,52 @@ func (c *BuildCommand) PackageName(manifestFilename string) (string, error) {
}

// ExecuteWasmTools calls the wasm-tools binary.
func ExecuteWasmTools(wasmtools string, args []string) error {
func ExecuteWasmTools(wasmtools string, args []string, d *global.Data) error {
errMsg := "failed to annotate binary with metadata: %s\n\n"
// gosec flagged this:
// G204 (CWE-78): Subprocess launched with function call as argument or command arguments
// Disabling as we trust the source of the variable.
// #nosec
// nosemgrep: go.lang.security.audit.dangerous-exec-command.dangerous-exec-command
command := exec.Command(wasmtools, args...)
wasmtoolsOutput, err := command.Output()
if err != nil && d.Verbose() {
text.Info(d.Output, errMsg, err)
}
if len(wasmtoolsOutput) == 0 {
return nil
}

// Make a backup of the original Wasm binary (before being annotated).
originalBin, err := os.ReadFile(binWasmPath)
if err != nil {
return fmt.Errorf("failed to annotate binary with metadata: %w", err)
return err
}
// Ensure the Wasm binary can be executed.

// Overwrite the original Wasm binary with the annotated version.
//
// G302 (CWE-276): Expect file permissions to be 0600 or less
// gosec flagged this:
// Disabling as we want all users to be able to execute this binary.
// #nosec
err = os.WriteFile("bin/main.wasm", wasmtoolsOutput, 0o777)
err = os.WriteFile(binWasmPath, wasmtoolsOutput, 0o777)
if err != nil {
return fmt.Errorf("failed to annotate binary with metadata: %w", err)
if d.Verbose() {
text.Info(d.Output, errMsg, err)
}

// Restore the original Wasm binary.
//
// G302 (CWE-276): Expect file permissions to be 0600 or less
// gosec flagged this:
// Disabling as we want all users to be able to execute this binary.
// #nosec
err = os.WriteFile(binWasmPath, originalBin, 0o777)
if err != nil {
return fmt.Errorf("failed to restore bin/main.wasm: %w", err)
}
}

return nil
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/global/global.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ type Data struct {
// ErrLog provides an interface for recording errors to disk.
ErrLog fsterr.LogInterface
// ExecuteWasmTools is a function that executes the wasm-tools binary.
ExecuteWasmTools func(bin string, args []string) error
ExecuteWasmTools func(bin string, args []string, global *Data) error
// Flags are all the global CLI flags.
Flags Flags
// HTTPClient is a HTTP client.
Expand Down
3 changes: 2 additions & 1 deletion pkg/testutil/args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,10 @@ func MockGlobalData(args []string, stdout io.Writer) *global.Data {
ConfigPath: configPath,
Env: config.Environment{},
ErrLog: errors.Log,
ExecuteWasmTools: func(bin string, args []string) error {
ExecuteWasmTools: func(bin string, args []string, d *global.Data) error {
fmt.Printf("bin: %s\n", bin)
fmt.Printf("args: %#v\n", args)
fmt.Printf("global: %#v\n", d)
return nil
},
HTTPClient: &http.Client{Timeout: time.Second * 5},
Expand Down