{"id":13640501,"url":"https://github.com/edgelesssys/edgelessrt","last_synced_at":"2025-06-18T11:41:00.328Z","repository":{"id":37834177,"uuid":"267045750","full_name":"edgelesssys/edgelessrt","owner":"edgelesssys","description":"Edgeless RT is an SDK and a runtime for Intel SGX. It combines top-notch Go support with simplicity, robustness and a small TCB. Developing confidential microservices has never been easier! C++17 and Rust (experimental) are also supported.","archived":false,"fork":false,"pushed_at":"2025-05-09T15:17:43.000Z","size":99200,"stargazers_count":138,"open_issues_count":5,"forks_count":18,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-05-09T16:23:10.192Z","etag":null,"topics":["confidential-computing","confidential-microservices","enclave","golang","intel-sgx","rust","sgx","trusted-execution-environment"],"latest_commit_sha":null,"homepage":"https://edgeless.systems","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edgelesssys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-26T13:09:17.000Z","updated_at":"2025-05-09T15:17:45.000Z","dependencies_parsed_at":"2023-01-25T12:31:16.102Z","dependency_job_id":"d030b199-517b-4ba2-aeb6-b25a7c369280","html_url":"https://github.com/edgelesssys/edgelessrt","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"purl":"pkg:github/edgelesssys/edgelessrt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgelesssys%2Fedgelessrt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgelesssys%2Fedgelessrt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgelesssys%2Fedgelessrt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgelesssys%2Fedgelessrt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edgelesssys","download_url":"https://codeload.github.com/edgelesssys/edgelessrt/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgelesssys%2Fedgelessrt/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260546308,"owners_count":23025914,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["confidential-computing","confidential-microservices","enclave","golang","intel-sgx","rust","sgx","trusted-execution-environment"],"created_at":"2024-08-02T01:01:11.830Z","updated_at":"2025-06-18T11:40:55.311Z","avatar_url":"https://github.com/edgelesssys.png","language":"C++","funding_links":[],"categories":["Runtime Framework","SDK"],"sub_categories":["Library OSes and SDKs"],"readme":"# Edgeless RT\n\n![ERT logo](docs/ert_logo.svg)\n\n[![Unit Tests][unit-tests-badge]][unit-tests]\n[![GitHub license][license-badge]](LICENSE)\n[![Discord Chat][discord-badge]][discord]\n\n[Edgeless RT](https://edgeless.systems) is an SDK for Trusted Execution Environments (TEE) built on top of [Open Enclave](https://github.com/openenclave/openenclave). It adds support for modern programming languages (in particular Go) and facilitates the porting of existing applications.\nCurrently, hardware-wise, Edgeless RT focuses on [Intel SGX](https://software.intel.com/en-us/sgx). Support for other TEEs will follow as it becomes available in Open Enclave.\n\nKey features of Edgeless RT are:\n\n* Comprehensive support for Go, most existing code runs without changes\n  * Preferably use [EGo](https://github.com/edgelesssys/ego) to build confidential Go apps.\n  * Use Edgeless RT if you need more control, e.g., you may want to link some Go code to your C++ app.\n* Extended C/C++ support\n  * More libc and POSIX functions\n  * More C++17 STL\n  * pthread and std::thread\n  * libstdc++ for better compatibility with existing code\n* Seamless integration with [MarbleRun](https://github.com/edgelesssys/marblerun) to create distributed confidential applications\n* Experimental support for Rust\n\n## Quick Start\n\nIf you're on Ubuntu 20.04, 22.04, or 24.04 (experimental) and don't want to build the SDK yourself, you can install the binary release:\n\n```bash\nsudo mkdir -p /etc/apt/keyrings\nwget -qO- https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo tee /etc/apt/keyrings/intel-sgx-keyring.asc \u003e /dev/null\necho \"deb [signed-by=/etc/apt/keyrings/intel-sgx-keyring.asc arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu $(lsb_release -cs) main\" | sudo tee /etc/apt/sources.list.d/intel-sgx.list\nsudo apt update\nERT_DEB=edgelessrt_0.4.9_amd64_ubuntu-$(lsb_release -rs).deb\nwget https://github.com/edgelesssys/edgelessrt/releases/download/v0.4.9/$ERT_DEB\nsudo apt install ./$ERT_DEB build-essential cmake libssl-dev\n```\n\nThen proceed with [Use](#use).\n\n## Build\n\nOn Ubuntu 20.04 or 22.04, build with:\n\n```bash\nsudo apt install build-essential clang-11 cmake gdb libssl-dev ninja-build\nmkdir build\ncd build\ncmake -GNinja ..\nninja\n```\n\nOn Ubuntu 24.04 (experimental), use `clang-14` instead of `clang-11`.\n\nTo set a custom installation path (default: `/opt/edgelessrt`), add, e.g., `-DCMAKE_INSTALL_PREFIX=~/edgelessrt-install`.\n\n## SGX packages\n\nTo run your applications in SGX mode, install these packages:\n\n```bash\nsudo mkdir -p /etc/apt/keyrings\nwget -qO- https://download.01.org/intel-sgx/sgx_repo/ubuntu/intel-sgx-deb.key | sudo tee /etc/apt/keyrings/intel-sgx-keyring.asc \u003e /dev/null\necho \"deb [signed-by=/etc/apt/keyrings/intel-sgx-keyring.asc arch=amd64] https://download.01.org/intel-sgx/sgx_repo/ubuntu $(lsb_release -cs) main\" | sudo tee /etc/apt/sources.list.d/intel-sgx.list\nsudo apt update\nsudo apt install libsgx-dcap-ql libsgx-enclave-common libsgx-launch\n```\n\n## Test\n\nAfter building, run the following command in the build directory to confirm everything works as expected:\n\n```bash\nctest\n```\n\nIn simulation mode run this command instead:\n\n```bash\nOE_SIMULATION=1 ctest\n```\n\n## Install\n\nFrom the build directory run:\n\n```bash\nninja install\n```\n\nOr if you do not have write permissions for the installation path:\n\n```bash\nsudo ninja install\n```\n\n## Use\n\nTo use the SDK you need to source the `openenclaverc` file to setup environment variables:\n\n```bash\n. /opt/edgelessrt/share/openenclave/openenclaverc\n```\n\nNow you are ready to build applications with Edgeless RT! To start, check out the [samples](samples).\n\nAlso see the [C API documentation](https://edgelesssys.github.io/edgelessrt) and/or the [Go API documentation](https://pkg.go.dev/github.com/edgelesssys/ego).\n\n## Debug\n\n### Logging\n\nSet the environment variable `OE_LOG_LEVEL` to `NONE`, `FATAL`, `ERROR` (default), `WARNING`, `INFO`, or `VERBOSE` to increase or decrease the log level. Set `OE_LOG_DETAILED=1` to enrich the log output with timestamps, thread ids, and stacktrace-like error propagations.\n\n### gdb\n\n![debugging with vscode](docs/go_debugging_vscode.gif)\n\nYou can use Open Enclave's `oegdb` to debug enclave code built with Edgeless RT. `oegdb` is automatically installed with Edgeless RT. It also supports Go enclaves.\n\n`oegdb` works great with Visual Studio Code (vscode). For example, use the following configuration to debug the in-enclave Go code from our [HashiCorp Vault sample](samples/vault) in vscode:\n\n```json\n{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"name\": \"(oegdb) Launch\",\n      \"miDebuggerPath\": \"/opt/edgelessrt/bin/oegdb\",\n      \"type\": \"cppdbg\",\n      \"request\": \"launch\",\n      \"program\": \"/opt/edgelessrt/bin/erthost\",\n      \"args\": [\"enclave.signed\",\"server\",\"-dev\"],\n      \"stopAtEntry\": false,\n      \"cwd\": \"${workspaceFolder}/samples/vault/build/\",\n      \"environment\": [],\n      \"externalConsole\": false,\n      \"MIMode\": \"gdb\",\n      \"setupCommands\": [\n          {\n              \"description\": \"Enable pretty-printing for gdb\",\n              \"text\": \"-enable-pretty-printing\",\n              \"ignoreFailures\": true\n          },\n          {\n              \"text\": \"handle SIGILL nostop\"\n          }\n      ]\n    }\n  ]\n}\n```\n\n## Contribute\n\nRead [CONTRIBUTING.md](CONTRIBUTING.md) for information on issue reporting, code guidelines, and our PR process.\n\n\u003c!-- refs --\u003e\n[unit-tests]: https://github.com/edgelesssys/edgelessrt/actions\n[unit-tests-badge]: https://github.com/edgelesssys/edgelessrt/workflows/Unit%20Tests/badge.svg\n[license-badge]: https://img.shields.io/github/license/edgelesssys/edgelessrt\n[discord]: https://discord.gg/rH8QTH56JN\n[discord-badge]: https://img.shields.io/badge/chat-on%20Discord-blue\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgelesssys%2Fedgelessrt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedgelesssys%2Fedgelessrt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgelesssys%2Fedgelessrt/lists"}