From 733c6d31ac034d1c08fda9fa625cb460f6c61495 Mon Sep 17 00:00:00 2001
From: Daniel Lyubomirov <daniel.lyubomirov@vereign.com>
Date: Thu, 18 Jun 2020 09:27:22 +0300
Subject: [PATCH] Code review fixes
---
cpp/CMakeLists.txt | 5 +----
cpp/README.md | 7 ++++++-
cpp/include/vereign/vereign.h | 2 ++
cpp/src/vereign/vereign.cc | 2 ++
cpp/vendor/CMakeLists.txt | 4 ----
5 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt
index b714770..abf9b75 100644
--- a/cpp/CMakeLists.txt
+++ b/cpp/CMakeLists.txt
@@ -1,12 +1,9 @@
cmake_minimum_required (VERSION 3.16.5)
-if(WIN32)
- set(CMAKE_IGNORE_PATH "C:/Strawberry/c/bin")
-endif()
-
project (vereign)
# Options
+# FIXME: Add options docs in the README.md
option(VEREIGN_USE_LLD "Use the lld linker" OFF)
option(VEREIGN_USE_PRECOMPILED_HEADERS "Use precompiled headers" OFF)
option(VEREIGN_USE_TIME_TRACE "Use compilation profiler" OFF)
diff --git a/cpp/README.md b/cpp/README.md
index f682d80..4678658 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -2,7 +2,10 @@
## Overview
-TODO
+Vereign C++ Client Library allows for digitally signing emails and documents, data encryption,
+and key-based authentication.
+
+FIXME: Add more info about the software architecture.
## Build
@@ -82,5 +85,7 @@ You can also look at C++ usage example in the C API integration test
The gRPC APIs are located here [https://code.vereign.com/code/vcl-proto/-/tree/master/proto%2Fvereign%2Fclient_library](https://code.vereign.com/code/vcl-proto/-/tree/master/proto%2Fvereign%2Fclient_library).
+FIXME: Add sample integration - for example for C#.
+
TODO: Add more documentation/reference; instructions to generate doxygen reference.
diff --git a/cpp/include/vereign/vereign.h b/cpp/include/vereign/vereign.h
index ab8ac98..c450bd8 100644
--- a/cpp/include/vereign/vereign.h
+++ b/cpp/include/vereign/vereign.h
@@ -68,6 +68,7 @@ PUBLIC_API const char* vereign_error_message(vereign_error* err);
*/
typedef struct vereign_service vereign_service;
+// FIXME: generate SSL keys for gRPC communication.
/**
* Creates ::vereign_service object and starts the gRPC API.
*
@@ -93,6 +94,7 @@ PUBLIC_API vereign_service* vereign_service_start(
const char* listen_address,
const char* vereign_host,
const char* vereign_port,
+ // FIXME: public_key must come from a storage internally.
const char* public_key,
vereign_error** err
);
diff --git a/cpp/src/vereign/vereign.cc b/cpp/src/vereign/vereign.cc
index 842dedc..5bbc7e9 100644
--- a/cpp/src/vereign/vereign.cc
+++ b/cpp/src/vereign/vereign.cc
@@ -22,10 +22,12 @@ struct vereign_service {
std::unique_ptr<vereign::grpc::Server> impl;
};
+// FIXME: generate SSL keys for gRPC communication.
auto vereign_service_start(
const char* listen_address,
const char* vereign_host,
const char* vereign_port,
+ // FIXME: public_key must come from a storage internally.
const char* public_key,
vereign_error** err
) -> vereign_service* {
diff --git a/cpp/vendor/CMakeLists.txt b/cpp/vendor/CMakeLists.txt
index 3f64020..7d4cb21 100644
--- a/cpp/vendor/CMakeLists.txt
+++ b/cpp/vendor/CMakeLists.txt
@@ -1,9 +1,5 @@
cmake_minimum_required (VERSION 3.16.5)
-if (WIN32)
- set(CMAKE_IGNORE_PATH "C:/Strawberry/c/bin")
-endif()
-
project (vereign-vendor)
if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
--
GitLab