facab8c5a7
This updates the minimal supported version of CMake to 3.16, which in turn enables us to use more CMake features and have a cleaner build system. This is the version that provides most new features and also the one we use in our latest docker image for CI. |
||
|---|---|---|
| .. | ||
| CMakeLists.txt | ||
| constants.proto | ||
| makefile | ||
| README.md | ||
| sec0.proto | ||
| sec1.proto | ||
| session.proto | ||
Protobuf files for implementing protocol communication packets
Protocomm uses Google Protobuf for language, transport and architecture agnostic protocol communication. These proto files define the protocomm packet structure, separated across multiple files:
- contants.proto - Defines the "Status" structure for conveying the success or failure of a single protocomm transaction
- sec0.proto - Defines the Security0 Command and Response packet structures
- sec1.proto - Defines the Security1 Command and Response packet structures
- session.proto - Defines the protocomm transacion packets for session establishment which internally has a Security packet as payload
Note : These proto files are not automatically compiled during the build process.
Compilation
Compilation requires protoc (Protobuf Compiler) and protoc-c (Protobuf C Compiler) installed. Since the generated files are to remain the same, as long as the proto files are not modified, therefore the generated files are already available under components/protocomm/proto-c and components/protocomm/python directories, and thus running cmake / make (and installing the Protobuf compilers) is optional.
If using cmake follow the below steps. If using make, jump to Step 2 directly.
Step 1 (Only for cmake)
When using cmake, first create a build directory and call cmake from inside:
mkdir build
cd build
cmake ..
Step 2
Simply run make to generate the respective C and Python files. The newly created files will overwrite those under components/protocomm/proto-c and components/protocomm/python