add symlinks to /usr/local/bin on install

Author: thomasten

CMakeLists.txt

@@ -88,6 +88,15 @@ install(
 install(DIRECTORY ${OpenEnclave_DIR}/../debugger DESTINATION ${CMAKE_INSTALL_LIBDIR}/openenclave)
 install(DIRECTORY _ertgo/ DESTINATION go USE_SOURCE_PERMISSIONS)
 
+if(CMAKE_INSTALL_PREFIX STREQUAL /opt/ego)
+  install(
+    FILES
+    src/symlinks/ego
+    src/symlinks/ego-gdb
+    src/symlinks/ego-go
+    DESTINATION /usr/local/bin)
+endif()
+
 set(CPACK_PACKAGE_CONTACT "contact@edgeless.systems​")
 set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX})
 set(CPACK_DEBIAN_PACKAGE_DEPENDS

README.md

@@ -14,14 +14,14 @@ ego run hello
 ```
 
 ## Quick Start
-If you are on Ubuntu 18.04 and do not want to build EGo from source, you can install the binary release:
+If you are on Ubuntu 18.04 or above and do not want to build EGo from source, you can install the binary release:
 ```bash
 wget -qO- https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo apt-key add
 sudo add-apt-repository 'deb [arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu bionic main'
 wget https://github.com/edgelesssys/ego/releases/download/v0.1.0/ego_0.1.0_amd64.deb
 sudo apt install ./ego_0.1.0_amd64.deb
 ```
-Then proceed with [Use](#use).
+Now you are ready to build applications with EGo! To start, check out the [samples](#samples).
 
 ## Build and Install
 *Prerequisite*: [Edgeless RT](https://github.com/edgelesssys/edgelessrt) is installed and sourced.
@@ -34,14 +34,7 @@ make
 make install
 ```
 
-## Use
-To use EGo, its `bin` directory must be in the PATH:
-```sh
-export PATH="$PATH:/opt/ego/bin"
-```
-Now you are ready to build applications with EGo!
-
-### Samples
+## Samples
 * [helloworld](samples/helloworld) is a minimal example of an enclave application.
 * [remote_attestation](samples/remote_attestation) shows how to do remote attestation in EGo.
 * [vault](samples/vault) demonstrates how to port a Go application exemplified by Hashicorp Vault.

internal/cli/cli.go

@@ -53,3 +53,7 @@ func (c *Cli) run(cmd *exec.Cmd) int {
 	}
 	return c.runner.ExitCode(cmd)
 }
+
+func (c *Cli) getOesignPath() string {
+	return filepath.Join(c.egoPath, "bin", "ego-oesign")
+}

internal/cli/run.go

@@ -17,14 +17,18 @@ func (c *Cli) Run(filename string, args []string) int {
 	enclaves := filepath.Join(c.egoPath, "share", "ego-enclave") + ":" + filename
 	args = append([]string{enclaves}, args...)
 	os.Setenv("EDG_EGO_PREMAIN", "0")
-	cmd := exec.Command("ego-host", args...)
+	cmd := exec.Command(c.getEgoHostPath(), args...)
 	return c.run(cmd)
 }
 
 // Marblerun runs a signed executable as a Marblerun Marble.
 func (c *Cli) Marblerun(filename string) int {
 	enclaves := filepath.Join(c.egoPath, "share", "ego-enclave") + ":" + filename
 	os.Setenv("EDG_EGO_PREMAIN", "1")
-	cmd := exec.Command("ego-host", enclaves)
+	cmd := exec.Command(c.getEgoHostPath(), enclaves)
 	return c.run(cmd)
 }
+
+func (c *Cli) getEgoHostPath() string {
+	return filepath.Join(c.egoPath, "bin", "ego-host")
+}

internal/cli/sign.go

@@ -81,7 +81,7 @@ func (c *Cli) signWithJSON(conf *config) error {
 	c.createDefaultKeypair(conf.Key)
 
 	enclavePath := filepath.Join(c.egoPath, "share", "ego-enclave")
-	cmd := exec.Command("ego-oesign", "sign", "-e", enclavePath, "-c", file.Name(), "-k", conf.Key, "--payload", conf.Exe)
+	cmd := exec.Command(c.getOesignPath(), "sign", "-e", enclavePath, "-c", file.Name(), "-k", conf.Key, "--payload", conf.Exe)
 	out, err := c.runner.CombinedOutput(cmd)
 	if _, ok := err.(*exec.ExitError); ok {
 		return errors.New(string(out))

internal/cli/sign_test.go

@@ -9,6 +9,7 @@ package cli
 import (
 	"errors"
 	"os/exec"
+	"path/filepath"
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
@@ -120,8 +121,9 @@ func (signRunner) Output(cmd *exec.Cmd) ([]byte, error) {
 }
 
 func (s signRunner) CombinedOutput(cmd *exec.Cmd) ([]byte, error) {
-	if !cmp.Equal(cmd.Args[:3], []string{"ego-oesign", "sign", "-e"}) ||
-		!cmp.Equal(cmd.Args[6:], []string{"-k", "keyfile", "--payload", "exefile"}) {
+	if !(filepath.Base(cmd.Path) == "ego-oesign" &&
+		cmp.Equal(cmd.Args[1:3], []string{"sign", "-e"}) &&
+		cmp.Equal(cmd.Args[6:], []string{"-k", "keyfile", "--payload", "exefile"})) {
 		return nil, errors.New("unexpected cmd: " + cmd.Path)
 	}
 	data, err := s.fs.ReadFile(cmd.Args[5])

internal/cli/signerid.go

@@ -21,7 +21,7 @@ type eradump struct {
 }
 
 func (c *Cli) signeridByKey(path string) (string, error) {
-	out, err := c.runner.Output(exec.Command("ego-oesign", "signerid", "-k", path))
+	out, err := c.runner.Output(exec.Command(c.getOesignPath(), "signerid", "-k", path))
 	if err != nil {
 		if err, ok := err.(*exec.ExitError); ok {
 			return "", errors.New(string(err.Stderr))
@@ -32,7 +32,7 @@ func (c *Cli) signeridByKey(path string) (string, error) {
 }
 
 func (c *Cli) readEradumpJSONtoStruct(path string) (*eradump, error) {
-	data, err := c.runner.Output(exec.Command("ego-oesign", "eradump", "-e", path))
+	data, err := c.runner.Output(exec.Command(c.getOesignPath(), "eradump", "-e", path))
 
 	if err != nil {
 		if err, ok := err.(*exec.ExitError); ok {

internal/cli/signerid_test.go

@@ -9,6 +9,7 @@ package cli
 import (
 	"errors"
 	"os/exec"
+	"path/filepath"
 	"testing"
 
 	"github.com/spf13/afero"
@@ -46,7 +47,7 @@ func (signeridRunner) Run(cmd *exec.Cmd) error {
 }
 
 func (signeridRunner) Output(cmd *exec.Cmd) ([]byte, error) {
-	if cmd.Path != "ego-oesign" || len(cmd.Args) != 4 {
+	if filepath.Base(cmd.Path) != "ego-oesign" || len(cmd.Args) != 4 {
 		return nil, errors.New("unexpected cmd")
 	}
 	if cmd.Args[1] == "signerid" && cmd.Args[2] == "-k" {

src/symlinks/ego

@@ -0,0 +1 @@
+/opt/ego/bin/ego

src/symlinks/ego-gdb

@@ -0,0 +1 @@
+/opt/ego/bin/ego-gdb

src/symlinks/ego-go

@@ -0,0 +1 @@
+/opt/ego/bin/ego-go