https://github.com/masa-finance/tee-worker
Masa Jobserver running in a TEE enclave
https://github.com/masa-finance/tee-worker
Last synced: 4 months ago
JSON representation
Masa Jobserver running in a TEE enclave
- Host: GitHub
- URL: https://github.com/masa-finance/tee-worker
- Owner: masa-finance
- License: apache-2.0
- Created: 2024-10-23T17:51:36.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-01-22T18:45:39.000Z (4 months ago)
- Last Synced: 2025-01-22T19:37:12.584Z (4 months ago)
- Language: Go
- Homepage:
- Size: 94.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tee-worker
Tee-worker is the Masa component to scrape data from a secure TEE enclave. It uses the [ego](https://github.com/edgelesssys/ego) framework to build, run and sign the binary.
Want to help in development? check the [DEVELOPMENT.md](DEVELOPMENT.md) file.
## Requirements
- Docker
## Run
To run the tee-worker, use docker with our images. Our images have signed binaries which are allowed to be part of the network:
```bash
docker run --device /dev/sgx_enclave --device /dev/sgx_provision --net host --rm -v $(PWD)/.masa:/home/masa -ti masaengineering/tee-worker:main
```
## Container images
All tagged images are available here: https://hub.docker.com/r/masaengineering/tee-worker/tags
- Images with `latest` tag are the latest releases
- Every branch has a corresponding image with the branch name (e.g. `main`)
### Docker compose
There is an example docker compose file to run the container with the appropriate environment variables.
```bash
docker-compose up
```
## API
The tee-worker exposes a simple http API to submit jobs, retrieve results, and decrypt the results.
```bash
SIG=$(curl localhost:8080/job/generate -H "Content-Type: application/json" -d '{ "type": "webscraper", "arguments": { "url": "google" } }')
### Submitting jobs
curl localhost:8080/job/add -H "Content-Type: application/json" -d '{ "encrypted_job": "'$SIG'" }'
### Jobs results
result=$(curl localhost:8080/job/status/b678ff77-118d-4a7a-a6ea-190eb850c28a)
### Decrypt job results
curl localhost:8080/job/result -H "Content-Type: application/json" -d '{ "encrypted_result": "'$result'", "encrypted_request": "'$SIG'" }'
```
### Golang client
It is available a simple golang client to interact with the API:
```golang
import(
. "github.com/masa-finance/tee-worker/pkg/client"
"github.com/masa-finance/tee-worker/api/types"
)
func main() {
clientInstance := NewClient(server.URL)
// Step 1: Create the job request
job := types.Job{
Type: "web-scraper",
Arguments: map[string]interface{}{
"url": "https://google.com",
"depth": 1,
},
}
// Step 2: Get a Job signature. Send the signature somewhere to be executed, or execute it locally (see below)
jobSignature, err := clientInstance.CreateJobSignature(job)
// Step 3: Submit the job signature for execution ( can be done locally or remotely )
jobResult, err := clientInstance.SubmitJob(jobSignature)
// Step 4a: Get the job result (decrypted)
result, err := jobResult.GetDecrypted(jobSignature)
// Alternatively, you can get the encrypted result and decrypt it later
// Note: this can be forwarded to another party to decrypt the result
// Step 4b.1: Get the job result (encrypted)
encryptedResult, err := jobResult.Get()
// Step 4b.2: Decrypt the result
decryptedResult, err := clientInstance.Decrypt(jobSignature, encryptedResult)
}
```