Add proto services for python clients to use

.dockerignore

@@ -19,6 +19,7 @@
 /.venv_ccf_sandbox/
 /.vscode/
 /3rdparty/
+!/3rdparty/googleapis
 /Dockerfile.*
 /LICENSE
 /Makefile
@@ -36,4 +37,4 @@
 /scripts/
 /scripts/env/
 /workspace/
-requirements.txt
+requirements.txt

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "3rdparty/k6"]
 	path = 3rdparty/k6
 	url = https://github.com/grafana/k6.git
+[submodule "3rdparty/googleapis"]
+	path = 3rdparty/googleapis
+	url = https://github.com/googleapis/googleapis

CMakeLists.txt

@@ -1,5 +1,5 @@
 # Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the
-# MIT license.
+# MIT License.
 
 cmake_minimum_required(VERSION 3.16)
 
@@ -45,16 +45,21 @@ add_ccf_app(
   src/app/leases.cpp
   INCLUDE_DIRS
   "${CMAKE_BINARY_DIR}/proto"
+  "${CMAKE_BINARY_DIR}/proto/google/api"
   "${CCF_DIR}/include/ccf/_private"
   LINK_LIBS_ENCLAVE
   etcd.enclave
   lskvserver.enclave
   status.enclave
+  annotations.enclave
+  http.enclave
   protobuf.enclave
   LINK_LIBS_VIRTUAL
   etcd.virtual
   lskvserver.virtual
   status.virtual
+  annotations.virtual
+  http.virtual
   protobuf.virtual)
 
 if(PUBLIC_MAPS)

Dockerfile.ignore

@@ -1,4 +1,7 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 FROM busybox
 WORKDIR /build-context
 COPY . .
-CMD find .
+CMD find .

Dockerfile.sgx

@@ -1,9 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 # Build
 FROM mcr.microsoft.com/ccf/app/dev:3.0.0-rc1-sgx as builder
 
-COPY CMakeLists.txt oe_sign.conf /src/
-COPY src /src/src/
-COPY proto /src/proto/
+COPY . /src/
 WORKDIR /build
 RUN CC="/opt/oe_lvi/clang-10" CXX="/opt/oe_lvi/clang++-10" cmake -GNinja -DCOMPILE_TARGET=sgx /src && ninja
 

Dockerfile.virtual

@@ -1,9 +1,10 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
 # Build
 FROM mcr.microsoft.com/ccf/app/dev:3.0.0-rc1-virtual as builder
 
-COPY CMakeLists.txt /src/
-COPY src /src/src/
-COPY proto /src/proto/
+COPY . /src/
 WORKDIR /build
 RUN CC=$(command -v clang-10) CXX=$(command -v clang++-10) cmake -GNinja -DCOMPILE_TARGET=virtual /src && ninja
 

Makefile

@@ -1,3 +1,5 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 BUILD=build
 CCF_PREFIX_VIRTUAL=/opt/ccf_virtual
 CCF_PREFIX_SGX=/opt/ccf_sgx
@@ -40,22 +42,22 @@ install-ccf-sgx-unsafe:
 	/opt/ccf_sgx_unsafe/getting_started/setup_vm/run.sh /opt/ccf_sgx_unsafe/getting_started/setup_vm/app-dev.yml  # Install dependencies
 
 .PHONY: build-virtual
-build-virtual:
+build-virtual: .venv protoc-gen-openapi
 	mkdir -p $(BUILD)
-	cd $(BUILD) && CC=$(CC) CXX=$(CXX) cmake -DCOMPILE_TARGET=virtual -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=OFF -DCCF_UNSAFE=OFF -GNinja ..
-	cd $(BUILD) && ninja
+	cd $(BUILD) && CC=$(CC) CXX=$(CXX) cmake -DCOMPILE_TARGET=virtual -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=OFF -DCCF_UNSAFE=OFF -DBUILD_TESTING=ON -DGENERATE_PYTHON=ON -DGENERATE_OPENAPI=ON -GNinja ..
+	. .venv/bin/activate && cd $(BUILD) && ninja
 
 .PHONY: build-virtual-unsafe
-build-virtual-unsafe:
+build-virtual-unsafe: .venv protoc-gen-openapi
 	mkdir -p $(BUILD)
-	cd $(BUILD) && CC=$(CC) CXX=$(CXX) cmake -DCOMPILE_TARGET=virtual -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=ON -DCCF_UNSAFE=ON -GNinja ..
-	cd $(BUILD) && ninja
+	cd $(BUILD) && CC=$(CC) CXX=$(CXX) cmake -DCOMPILE_TARGET=virtual -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=ON -DCCF_UNSAFE=ON -DBUILD_TESTING=ON -DGENERATE_PYTHON=ON -DGENERATE_OPENAPI=ON -GNinja ..
+	. .venv/bin/activate && cd $(BUILD) && ninja
 
 .PHONY: build-sgx
-build-sgx:
+build-sgx: .venv protoc-gen-openapi
 	mkdir -p $(BUILD)
-	cd $(BUILD) && CC=$(OE_CC) CXX=$(OE_CXX) cmake -DCOMPILE_TARGET=sgx -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=OFF -DCCF_UNSAFE=OFF -GNinja ..
-	cd $(BUILD) && ninja
+	cd $(BUILD) && CC=$(OE_CC) CXX=$(OE_CXX) cmake -DCOMPILE_TARGET=sgx -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DVERBOSE_LOGGING=OFF -DCCF_UNSAFE=OFF -DBUILD_TESTING=ON -DGENERATE_PYTHON=ON -DGENERATE_OPENAPI=ON -GNinja ..
+	. .venv/bin/activate && cd $(BUILD) && ninja
 
 .PHONY: build-docker-virtual
 build-docker-virtual:
@@ -115,6 +117,10 @@ patched-k6:
 	cp -r 3rdparty/k6 $(BUILD)/3rdparty/.
 	git apply --directory=$(BUILD)/3rdparty/k6 patches/k6-micro.diff
 
+.PHONY: protoc-gen-openapi
+protoc-gen-openapi:
+	go install github.com/google/gnostic/cmd/[email protected]
+
 $(BIN_DIR)/benchmark: patched-etcd
 	cd $(BUILD)/3rdparty/etcd && go build -buildvcs=false ./tools/benchmark
 	mkdir -p $(BIN_DIR)

README.md

@@ -45,7 +45,7 @@ Builds `build/liblskv.virtual.so`.
 Alternatively, it is possible to build a runtime image of this application via docker:
 
 ```bash
-$ docker build -t lskv-virtual -f Dockerfile.virtual .
+$ make build-docker-virtual
 ```
 
 ### SGX (attested)
@@ -64,7 +64,7 @@ Builds `build/liblskv.enclave.so.signed`.
 Alternatively, it is possible to build a runtime image of this application via docker:
 
 ```bash
-$ docker build -t lskv-sgx -f Dockerfile.sgx .
+$ make build-docker-sgx
 ```
 
 ## Build options
@@ -119,17 +119,21 @@ Or, for an SGX-enabled application: `$ make run-sgx` or `$ /opt/ccf_sgx/bin/sand
 
 ### With docker in Virtual mode
 
+**Note**: A Docker image following the latest changes on the `main` branch is available as `ccfmsrc.azurecr.io/public/lskv:latest-virtual`.
+
 ```bash
-$ docker run --name lskv -it --rm lskv-virtual
+$ docker run --name ccfmsrc.azurecr.io/public/lskv:latest-virtual -it --rm lskv-virtual
 ...
 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
 ```
 
 ### With docker in SGX mode
 
+**Note**: A Docker image following the latest changes on the `main` branch is available as `ccfmsrc.azurecr.io/public/lskv:latest-sgx`.
+
 ```bash
-$ docker run --name lskv -it --rm --device /dev/sgx_enclave:/dev/sgx_enclave --device /dev/sgx_provision:/dev/sgx_provision -v /dev/sgx:/dev/sgx lskv-sgx
+$ docker run --name ccfmsrc.azurecr.io/public/lskv:latest-sgx -it --rm --device /dev/sgx_enclave:/dev/sgx_enclave --device /dev/sgx_provision:/dev/sgx_provision -v /dev/sgx:/dev/sgx lskv-sgx
 ...
 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
@@ -138,6 +142,7 @@ $ docker run --name lskv -it --rm --device /dev/sgx_enclave:/dev/sgx_enclave --d
 ## Interacting with the store
 
 **Note**: When running with Docker extra setup steps are currently required before interacting with the store as below, see [Running a CCF Service](https://microsoft.github.io/CCF/main/operations/start_network.html#opening-a-network-to-users).
+The [`lskv_cluster.py`](./benchmark/lskv_cluster.py) may also be useful for setting up a local docker cluster.
 
 ### etcdctl (gRPC API)
 

benchmark/k6.js

@@ -1,3 +1,5 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
 import { check } from "k6";
 import http from "k6/http";
 

cgmanifest.json

@@ -27,6 +27,15 @@
           "commitHash": "2fe2dd32b3827eeeeb3959aff63a6b402aab0a5a"
         }
       }
+    },
+    {
+      "component": {
+        "type": "git",
+        "git": {
+          "repositoryUrl": "https://github.com/googleapis/googleapis",
+          "commitHash": "da380c77bb87ba0f752baf07605dd1db30e1f7e1"
+        }
+      }
     }
   ],
   "Version": 1

cmake/protobuf.cmake

@@ -0,0 +1,62 @@
+# Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the
+# MIT License.
+
+option(GENERATE_PYTHON "generate python protobuf and grpc bindings" OFF)
+
+function(build_proto proto_file src_dir)
+  message(STATUS "Generating source files from proto file ${proto_file}")
+  get_filename_component(PROTO_DIR ${proto_file} DIRECTORY)
+  get_filename_component(PROTO_NAME ${proto_file} NAME)
+  get_filename_component(PROTO_NAME_WE ${proto_file} NAME_WE)
+
+  # generate cpp protoc files
+  add_custom_command(
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.h
+           ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.cc
+    COMMAND
+      ${PROTOC_BINARY_PATH} --proto_path=${CMAKE_CURRENT_SOURCE_DIR}
+      --proto_path=${CMAKE_SOURCE_DIR}/3rdparty/googleapis
+      --cpp_out=${CMAKE_CURRENT_BINARY_DIR} ${src_dir}/${proto_file}
+    COMMENT "Generate C++ source files from protobuf file ${PROTO_NAME}"
+    DEPENDS ${src_dir}/${proto_file})
+
+  if(${GENERATE_PYTHON})
+    # generate python grpc and protobuf files
+    add_custom_command(
+      OUTPUT
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2.py
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2.pyi
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2_grpc.py
+      COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/build.sh ${src_dir}/${proto_file}
+              ${CMAKE_SOURCE_DIR}/python/lskv/
+      COMMENT "Generate Python source files from protobuf file ${PROTO_NAME}"
+      DEPENDS ${src_dir}/${proto_file} ${CMAKE_CURRENT_SOURCE_DIR}/build.sh)
+    add_custom_target(
+      ${PROTO_NAME_WE}_proto_python ALL
+      DEPENDS
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2.py
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2.pyi
+        ${CMAKE_SOURCE_DIR}/python/lskv/${PROTO_DIR}/${PROTO_NAME_WE}_pb2_grpc.py
+    )
+  endif()
+
+  set(PROTOBUF_INCLUDE_DIR ${CCF_DIR}/include/3rdparty/protobuf/src/)
+
+  if(${COMPILE_TARGET} STREQUAL "virtual")
+    add_host_library(
+      ${PROTO_NAME_WE}.virtual
+      ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.cc
+      ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.h)
+    target_include_directories(
+      ${PROTO_NAME_WE}.virtual PUBLIC ${PROTOBUF_INCLUDE_DIR}
+                                      ${CMAKE_CURRENT_BINARY_DIR})
+  else()
+    add_enclave_library(
+      ${PROTO_NAME_WE}.enclave
+      ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.cc
+      ${CMAKE_CURRENT_BINARY_DIR}/${PROTO_DIR}/${PROTO_NAME_WE}.pb.h)
+    target_include_directories(
+      ${PROTO_NAME_WE}.enclave PUBLIC ${PROTOBUF_INCLUDE_DIR}
+                                      ${CMAKE_CURRENT_BINARY_DIR})
+  endif()
+endfunction()

constitution/actions.js

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 class Action {
   constructor(validate, apply) {
     this.validate = validate;

constitution/apply.js

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 export function apply(proposal, proposalId) {
   const proposed_actions = JSON.parse(proposal)["actions"];
   for (const proposed_action of proposed_actions) {

constitution/resolve.js

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 export function resolve(proposal, proposerId, votes) {
   const memberVoteCount = votes.filter((v) => v.vote).length;
 

constitution/validate.js

@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
 export function validate(input) {
   let proposal = JSON.parse(input);
   let errors = [];

oe_sign.conf

@@ -1,7 +1,9 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
 # Enclave settings:
 NumHeapPages=50000
 NumStackPages=1024
 NumTCS=8
 ProductID=1
 SecurityVersion=1
-# The Debug setting is automatically inserted by sign_app_library in CMake, to build both debuggable and non-debuggable variants
+# The Debug setting is automatically inserted by sign_app_library in CMake, to build both debuggable and non-debuggable variants