cargo-teaclave

README

cargo-teaclave

A cargo plugin serves to ease developing apps with the teaclave-sgx-sdk project.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• cmake 3.10+
• cargo 1.44.0-nightly (6e07d2dfb 2020-03-31)
• go 1.14+

Install

go get -u -v github.com/sammyne/cargo-teaclave

# please update ~/.cargo/bin/ to your $CARGO_HOME if you have customized it
mv $(go env GOPATH)/bin/cargo-teaclave ~/.cargo/bin/

Run

cargo teaclave

Just follow the hint shown as

teaclave helps to plays with apps written with teaclave-sgx-sdk

Usage:
  teaclave [command]

Available Commands:
  help        Help about any command
  test        test a given teaclave-sgx-sdk-ported crate

Flags:
  -h, --help   help for teaclave

Use "teaclave [command] --help" for more information about a command.

Examples

example	description
test-hello-world	test a teaclave-sgx-sdk-ported crate

Recommend

During our daily development with teaclave-sgx-sdk, we found it requires rigirous setting for its SGX SDK. It takes non-trivial works to set up the SGX SDK and rust toolchain. Therefore, it's recommended to just develop within the environment packaged by the official docker container (e.g. baiduxlab/sgx-rust:1804-1.1.2 if you're playing with teaclave-sgx-sdk@v1.1.2).

References

• README-Template

Documentation

Overview

Copyright © 2020 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.