Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/microsoft/ccf-app-template

Template repository for CCF apps
https://github.com/microsoft/ccf-app-template

confidential-computing ledger multiparty trusted-execution-environment

Last synced: 3 months ago
JSON representation

Template repository for CCF apps

Awesome Lists containing this project

README 

        
# CCF App Template [![Open in VSCode](https://img.shields.io/static/v1?label=Open+in&message=VSCode&logo=visualstudiocode&color=007ACC&logoColor=007ACC&labelColor=2C2C32)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/ccf-app-template)



[![CCF App Template CI](https://github.com/microsoft/ccf-app-template/actions/workflows/ci.yml/badge.svg)](https://github.com/microsoft/ccf-app-template/actions/workflows/ci.yml)



Template repository for JavaScript and C++ CCF applications.



Note: For complete sample apps, see https://github.com/microsoft/ccf-app-samples.



## Quickstart



The quickest way to build and run this sample CCF app is to checkout this repository locally in its development container by clicking:

[![Open in VSCode](https://img.shields.io/static/v1?label=Open+in&message=VSCode&logo=visualstudiocode&color=007ACC&logoColor=007ACC&labelColor=2C2C32)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/ccf-app-template)



All dependencies will be automatically installed (takes ~2 mins on first checkout).



Alternatively, you can checkout this repository in a Github codespace: [![Open in Github codespace](https://img.shields.io/static/v1?label=Open+in&message=GitHub+codespace&logo=github&color=2F363D&logoColor=white&labelColor=2C2C32)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=496290904&machine=basicLinux32gb&devcontainer_path=.devcontainer.json&location=WestEurope)



##   JavaScript



CCF apps can be written in JavaScript/TypeScript. This is the quickest way to develop new apps as this does not require any compilation step and the app can be updated on the fly, via [a governance proposal](https://microsoft.github.io/CCF/main/build_apps/js_app_bundle.html#deployment).



The JavaScript sample bundle is located in the [`js/`](js/) directory.



### Run JS app



```bash

$ npm --prefix ./js install

$ npm --prefix ./js run build

$ /opt/ccf_virtual/bin/sandbox.sh --js-app-bundle ./js/dist/

[12:00:00.000] Virtual mode enabled

[12:00:00.000] Starting 1 CCF node...

[12:00:00.000] Started CCF network with the following nodes:

[12:00:00.000]   Node [0] = https://127.0.0.1:8000

[12:00:00.000] You can now issue business transactions to the libjs_generic application

[12:00:00.000] Loaded JS application: ./js/dist/

[12:00:00.000] Keys and certificates have been copied to the common folder: /workspaces/ccf-app-template/workspace/sandbox_common

[12:00:00.000] See https://microsoft.github.io/CCF/main/use_apps/issue_commands.html for more information

[12:00:00.000] Press Ctrl+C to shutdown the network

```



In another terminal:



```bash

$ curl -X POST "https://127.0.0.1:8000/app/log?id=1" --cacert ./workspace/sandbox_common/service_cert.pem -H "Content-Type: application/json" --data '{"msg": "hello world"}'

$ curl "https://127.0.0.1:8000/app/log?id=1" --cacert ./workspace/sandbox_common/service_cert.pem

hello world

```



### Docker



It is possible to build a runtime image of the JavaScript application via docker:



```bash

$ docker build -t ccf-app-template:js-enclave -f docker/ccf_app_js.enclave .

$ docker run --device /dev/sgx_enclave:/dev/sgx_enclave --device /dev/sgx_provision:/dev/sgx_provision -v /dev/sgx:/dev/sgx ccf-app-template:js-enclave

...

2022-01-01T12:00:00.000000Z -0.000 0   [info ] ../src/node/node_state.h:1790        | Network TLS connections now accepted



# Now the CCF service is started and member governance is needed to allow trusted users to interact with the deployed application

```



Or, for the non-SGX (a.k.a. virtual) variant:



```bash

$ docker build -t ccf-app-template:js-virtual -f docker/ccf_app_js.virtual .

$ docker run ccf-app-template:js-virtual

```



#### Network governance



The CCF network is started with one node and one member, you need to execute the following governance steps to initialize the network



- [Activate the network existing member to start a network governance](https://microsoft.github.io/CCF/main/governance/adding_member.html#activating-a-new-member)

- Build the application and [create a deployment proposal](https://microsoft.github.io/CCF/main/build_apps/js_app_bundle.html#deployment)

- Deploy the application proposal, [using governance calls](https://microsoft.github.io/CCF/main/governance/proposals.html#submitting-a-new-proposal)

- Create and submit [an add users proposal](https://microsoft.github.io/CCF/main/governance/open_network.html#adding-users)

- Open the network for users ([using proposal](https://microsoft.github.io/CCF/main/governance/open_network.html#opening-the-network))



### Bare VM



The application can be tested using `cchost` on Linux environment.

To start a test CCF network on a Linux environment, it requires [CCF to be intalled](https://microsoft.github.io/CCF/main/build_apps/install_bin.html) or you can create a CCF-enabled VM using [Creating a Virtual Machine in Azure to run CCF](https://github.com/microsoft/CCF/blob/main/getting_started/azure_vm/README.md)



```bash

# Start the CCF network using the cchost in



# Enclave mode

 /opt/ccf_sgx/bin/cchost --config ./config/cchost_config_enclave_js.json



# Or Virtual mode

/opt/ccf_virtual/bin/cchost --config ./config/cchost_config_virtual_js.json

...



 # Now the CCF network is started and further initialization needed before the interaction with the service

```



The CCF network is started with one node and one member, please follow the [same governance steps as Docker](#network-governance) to initialize the network and check [CCF node config file documentation](https://microsoft.github.io/CCF/main/operations/configuration.html)



### Managed CCF



The application can be tested using [Azure Managed CCF](https://techcommunity.microsoft.com/t5/azure-confidential-computing/microsoft-introduces-preview-of-azure-managed-confidential/ba-p/3648986) `(Pre-release phase)`, you can create Azure Managed CCF service on your subscription, that will give you a ready CCF network



- First, create the network's initial member certificate, please check [Certificates generation](https://microsoft.github.io/CCF/main/governance/adding_member.html)

- Create a new Azure Managed CCF service (the initial member certificate required as input)

- Build the application and [create a deployment proposal](https://microsoft.github.io/CCF/main/build_apps/js_app_bundle.html#deployment)

- Deploy the application proposal, [using governance calls](https://microsoft.github.io/CCF/main/governance/proposals.html#creating-a-proposal)

- Create and submit [an add users proposal](https://microsoft.github.io/CCF/main/governance/proposals.html#creating-a-proposal)



##  C++



CCF apps can also be written in C++. This offers better performance than JavaScript apps but requires a compilation step and a restart of the CCF node for deployment.



The C++ sample app is located in the [`cpp/`](cpp/) directory.



Also check out the [code tour](#code-tour) to get an overview of the C++ app.



### Build C++ app



In the checkout of this repository:



```bash

$ cd cpp/

$ mkdir build && cd build

$ CC="clang-11" CXX="clang++-11" cmake -GNinja ..

$ ninja

$ ls

libccf_app.enclave.so.signed # SGX-enabled application

libccf_app.virtual.so # Virtual application (i.e. insecure!)

```



See [docs](https://microsoft.github.io/CCF/main/build_apps) for complete instructions on how to build a CCF app.



### Run C++ app



```bash

$ /opt/ccf_virtual/bin/sandbox.sh -p ./libccf_app.virtual.so

Setting up Python environment...

Python environment successfully setup

[12:00:00.000] Virtual mode enabled

[12:00:00.000] Starting 1 CCF node...

[12:00:00.000] Started CCF network with the following nodes:

[12:00:00.000]   Node [0] = https://127.0.0.1:8000

[12:00:00.000] You can now issue business transactions to the ./libccf_app.virtual.so application

[12:00:00.000] Keys and certificates have been copied to the common folder: .../ccf-app-template/build/workspace/sandbox_common

[12:00:00.000] See https://microsoft.github.io/CCF/main/use_apps/issue_commands.html for more information

[12:00:00.000] Press Ctrl+C to shutdown the network

```



Or, for an SGX-enabled application (unavailable in development container): `$ /opt/ccf_sgx/bin/sandbox.sh -p ./libccf_app.enclave.so.signed -e release`



### Docker



It is possible to build a runtime image of the C++ application via docker:



```bash

$ docker build -t ccf-app-template:cpp-enclave -f docker/ccf_app_cpp.enclave .

$ docker run --device /dev/sgx_enclave:/dev/sgx_enclave --device /dev/sgx_provision:/dev/sgx_provision -v /dev/sgx:/dev/sgx ccf-app-template:cpp-enclave

...

2022-01-01T12:00:00.000000Z -0.000 0   [info ] ../src/node/node_state.h:1790        | Network TLS connections now accepted

# It is then possible to interact with the service

```



Or, for the non-SGX (a.k.a. virtual) variant:



```bash

$ docker build -t ccf-app-template:cpp-virtual -f docker/ccf_app_cpp.virtual .

$ docker run ccf-app-template:cpp-virtual

```



---



## Dependencies



If this repository is checked out on a bare VM (e.g. [for SGX deployments](https://docs.microsoft.com/en-us/azure/confidential-computing/quick-create-portal)), the dependencies required to build and run the C++ app can be installed as follows:



```bash

$ wget https://github.com/microsoft/CCF/releases/download/ccf-5.0.0/ccf_sgx_5.0.0_amd64.deb

$ sudo dpkg -i ccf_sgx_5.0.0_amd64.deb # Install CCF under /opt/ccf_sgx

$ cat /opt/ccf_sgx/share/VERSION_LONG

ccf-5.0.0

$ /opt/ccf_sgx/getting_started/setup_vm/run.sh /opt/ccf_sgx/getting_started/setup_vm/app-dev.yml # Install dependencies

```



For a non-SGX VM, replace `ccf_sgx` in all the commands above with `ccf_virtual`.



See the [CCF official docs](https://microsoft.github.io/CCF/main/build_apps/install_bin.html#install-ccf) for more info and [Modern JavaScript application development](https://microsoft.github.io/CCF/main/build_apps/js_app_bundle.html).



## Code Tour



In VSCode, a [code tour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) of the C++ app can be started with: Ctrl + P, `> CodeTour: Start Tour`