https://github.com/msantos/embedexe

Run an executable embedded in a Go binary
https://github.com/msantos/embedexe

memfd

Last synced: 4 months ago
JSON representation

Run an executable embedded in a Go binary

• Host: GitHub
• URL: https://github.com/msantos/embedexe
• Owner: msantos
• License: isc
• Created: 2022-12-01T12:26:11.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-14T13:26:29.000Z (almost 2 years ago)
• Last Synced: 2024-11-02T01:07:08.596Z (about 1 year ago)
• Topics: memfd
• Language: Go
• Homepage:
• Size: 43.9 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# embedexe

[![Go Reference](https://pkg.go.dev/badge/codeberg.org/msantos/embedexe.svg)](https://pkg.go.dev/codeberg.org/msantos/embedexe)

Run a program stored in a byte array such as an executable or a directory

of executables embedded in a Go binary.

# LIMITATIONS

* the executable must either be statically linked or the linked libraries

  available on the filesystem

* only works on Linux (but not on ChromeOS/crostini where the W^X policies

  disable executing memfds)

* an embedded executable cannot run another executable embedded in the

  same binary

* an embedded executable cannot use a library embedded in the same binary

# EXAMPLES

* embedexe: [Using a file descriptor path](https://pkg.go.dev/codeberg.org/msantos/embedexe#example-FD.Path)

* embedexe/fdexec: [Using a file descriptor](https://pkg.go.dev/codeberg.org/msantos/embedexe/fdexec#example-Command)

* embedexe/exec: [Using a byte array](https://pkg.go.dev/codeberg.org/msantos/embedexe/exec#example-Command)

* [fsexe](examples/fsexe/main.go): embed a directory of executables

  in a Go binary and run from memory

## Run an embedded executable

```go

// Echotest forks and runs an embedded echo(1).

//

//	cp /bin/echo .

//	go build

//	./echotest hello world

package main

import (

	_ "embed"

	"log"

	"os"

	"codeberg.org/msantos/embedexe/exec"

)

//go:embed echo

var echo []byte

func main() {

	cmd := exec.Command(echo, os.Args[1:]...)

	cmd.Stdout = os.Stdout

	cmd.Stderr = os.Stderr

	if err := cmd.Run(); err != nil {

		log.Fatalln("run:", cmd, err)

	}

}

```