szaszm commented on a change in pull request #914:
URL: https://github.com/apache/nifi-minifi-cpp/pull/914#discussion_r497392257
##########
File path: CMakeLists.txt
##########
@@ -245,6 +245,12 @@ if (NOT OPENSSL_OFF)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DOPENSSL_SUPPORT")
endif()
+# libsodium
+include(BundledLibSodium)
+use_bundled_libsodium("${CMAKE_CURRENT_SOURCE_DIR}"
"${CMAKE_CURRENT_BINARY_DIR}")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DSODIUM_STATIC=1")
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DSODIUM_STATIC=1")
Review comment:
This should move to `use_bundled_libsodium` as
`target_compile_definitions`. If it's required on user code, then it should be
public or interface.
```suggestion
```
##########
File path: cmake/BundledLibSodium.cmake
##########
@@ -0,0 +1,95 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+function(use_bundled_libsodium SOURCE_DIR BINARY_DIR)
+ message("Using bundled libsodium")
+
+ # Define patch step
+ if (WIN32)
+ set(PC "${Patch_EXECUTABLE}" -p1 -i
"${SOURCE_DIR}/thirdparty/libsodium/libsodium.patch")
+ endif()
+
+ # Define byproduct
+ if (WIN32)
+ set(BYPRODUCT "lib/sodium.lib")
+ else()
+ set(BYPRODUCT "lib/libsodium.a")
+ endif()
+
+ # Set build options
+ set(LIBSODIUM_BIN_DIR "${BINARY_DIR}/thirdparty/libsodium-install" CACHE
STRING "" FORCE)
+
+ if (WIN32)
+ set(LIBSODIUM_CMAKE_ARGS ${PASSTHROUGH_CMAKE_ARGS}
+ "-DCMAKE_INSTALL_PREFIX=${LIBSODIUM_BIN_DIR}"
+ "-DSODIUM_LIBRARY_MINIMAL=1")
+ endif()
+
+ # Build project
+ set(LIBSODIUM_URL
https://download.libsodium.org/libsodium/releases/libsodium-1.0.18.tar.gz)
+ set(LIBSODIUM_URL_HASH
"SHA256=6f504490b342a4f8a4c4a02fc9b866cbef8622d5df4e5452b46be121e46636c1")
+
+ if (WIN32)
+ ExternalProject_Add(
+ libsodium-external
+ URL ${LIBSODIUM_URL}
+ URL_HASH ${LIBSODIUM_URL_HASH}
+ SOURCE_DIR "${BINARY_DIR}/thirdparty/libsodium-src"
+ LIST_SEPARATOR % # This is needed for passing
semicolon-separated lists
+ CMAKE_ARGS ${LIBSODIUM_CMAKE_ARGS}
+ PATCH_COMMAND ${PC}
+ BUILD_BYPRODUCTS "${LIBSODIUM_BIN_DIR}/${BYPRODUCT}"
+ EXCLUDE_FROM_ALL TRUE
+ )
+ else()
+ set(CONFIGURE_COMMAND ./configure --disable-pie --enable-minimal
"--prefix=${LIBSODIUM_BIN_DIR}")
+
+ ExternalProject_Add(
+ libsodium-external
+ URL ${LIBSODIUM_URL}
+ URL_HASH ${LIBSODIUM_URL_HASH}
+ BUILD_IN_SOURCE true
+ SOURCE_DIR "${BINARY_DIR}/thirdparty/libsodium-src"
+ BUILD_COMMAND make
+ CMAKE_COMMAND ""
+ UPDATE_COMMAND ""
+ INSTALL_COMMAND make install
+ BUILD_BYPRODUCTS "${LIBSODIUM_BIN_DIR}/${BYPRODUCT}"
+ CONFIGURE_COMMAND "${CONFIGURE_COMMAND}"
+ PATCH_COMMAND ""
+ STEP_TARGETS build
+ EXCLUDE_FROM_ALL TRUE
+ )
+ endif()
+
+ # Set variables
+ set(LIBSODIUM_FOUND "YES" CACHE STRING "" FORCE)
+ set(LIBSODIUM_INCLUDE_DIRS "${LIBSODIUM_BIN_DIR}/include" CACHE STRING ""
FORCE)
+ set(LIBSODIUM_LIBRARIES "${LIBSODIUM_BIN_DIR}/${BYPRODUCT}" CACHE STRING
"" FORCE)
+
+ # Set exported variables for FindPackage.cmake
+ set(PASSTHROUGH_VARIABLES ${PASSTHROUGH_VARIABLES}
"-DEXPORTED_LIBSODIUM_INCLUDE_DIRS=${LIBSODIUM_INCLUDE_DIRS}" CACHE STRING ""
FORCE)
+ set(PASSTHROUGH_VARIABLES ${PASSTHROUGH_VARIABLES}
"-DEXPORTED_LIBSODIUM_LIBRARIES=${LIBSODIUM_LIBRARIES}" CACHE STRING "" FORCE)
+
+ # Create imported targets
+ file(MAKE_DIRECTORY ${LIBSODIUM_INCLUDE_DIRS})
+
+ add_library(libsodium STATIC IMPORTED)
+ set_target_properties(libsodium PROPERTIES IMPORTED_LOCATION
"${LIBSODIUM_LIBRARIES}")
+ add_dependencies(libsodium libsodium-external)
+ set_property(TARGET libsodium APPEND PROPERTY
INTERFACE_INCLUDE_DIRECTORIES "${LIBSODIUM_INCLUDE_DIRS}")
Review comment:
```suggestion
target_include_directories(libsodium INTERFACE
"${LIBSODIUM_INCLUDE_DIRS}")
target_compile_definitions(libsodium INTERFACE -DSODIUM_STATIC=1)
```
(the first line is a shorter, more readable equivalent)
##########
File path: encrypt-config/EncryptConfig.cpp
##########
@@ -0,0 +1,150 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "EncryptConfig.h"
+
+#include <sodium.h>
+
+#include <stdexcept>
+
+#include "ConfigFile.h"
+#include "ConfigFileEncryptor.h"
+#include "cxxopts.hpp"
+#include "utils/file/FileUtils.h"
+#include "utils/OptionalUtils.h"
+
+namespace {
+constexpr const char* CONF_DIRECTORY_NAME = "conf";
+constexpr const char* BOOTSTRAP_FILE_NAME = "bootstrap.conf";
+constexpr const char* MINIFI_PROPERTIES_FILE_NAME = "minifi.properties";
+constexpr const char* ENCRYPTION_KEY_PROPERTY_NAME =
"nifi.bootstrap.sensitive.key";
+} // namespace
+
+namespace org {
+namespace apache {
+namespace nifi {
+namespace minifi {
+namespace encrypt_config {
+
+EncryptConfig::EncryptConfig(int argc, char* argv[]) :
minifi_home_(parseMinifiHomeFromTheOptions(argc, argv)) {
+ if (sodium_init() < 0) {
+ throw std::runtime_error{"Could not initialize the libsodium library!"};
+ }
+}
+
+std::string EncryptConfig::parseMinifiHomeFromTheOptions(int argc, char*
argv[]) {
+ cxxopts::Options options("encrypt-config", "Encrypt sensitive minifi
properties");
+ options.add_options()
+ ("h,help", "Shows help")
+ ("m,minifi-home", "The MINIFI_HOME directory",
cxxopts::value<std::string>());
+
+ auto parse_result = options.parse(argc, argv);
+
+ if (parse_result.count("help")) {
+ std::cout << options.help() << '\n';
+ std::exit(0);
+ }
+
+ if (parse_result.count("minifi-home")) {
+ return parse_result["minifi-home"].as<std::string>();
+ } else {
+ throw std::runtime_error{"Required parameter missing: --minifi-home"};
+ }
+}
+
+void EncryptConfig::encryptSensitiveProperties() const {
+ utils::crypto::Bytes encryption_key = getEncryptionKey();
+ encryptSensitiveProperties(encryption_key);
+}
+
+std::string EncryptConfig::bootstrapFilePath() const {
+ return utils::file::FileUtils::concat_path(
+ utils::file::FileUtils::concat_path(minifi_home_, CONF_DIRECTORY_NAME),
+ BOOTSTRAP_FILE_NAME);
+}
+
+std::string EncryptConfig::propertiesFilePath() const {
+ return utils::file::FileUtils::concat_path(
+ utils::file::FileUtils::concat_path(minifi_home_, CONF_DIRECTORY_NAME),
+ MINIFI_PROPERTIES_FILE_NAME);
+}
+
+utils::crypto::Bytes EncryptConfig::getEncryptionKey() const {
+ encrypt_config::ConfigFile
bootstrap_file{std::ifstream{bootstrapFilePath()}};
+ utils::optional<std::string> key_from_bootstrap_file =
bootstrap_file.getValue(ENCRYPTION_KEY_PROPERTY_NAME);
+
+ if (key_from_bootstrap_file && !key_from_bootstrap_file->empty()) {
+ std::string binary_key = hexDecodeAndValidateKey(*key_from_bootstrap_file);
+ std::cout << "Using the existing encryption key found in " <<
bootstrapFilePath() << '\n';
+ return utils::crypto::stringToBytes(binary_key);
+ } else {
+ std::cout << "Generating a new encryption key...\n";
+ utils::crypto::Bytes encryption_key = utils::crypto::generateKey();
+ writeEncryptionKeyToBootstrapFile(encryption_key);
+ std::cout << "Wrote the new encryption key to " << bootstrapFilePath() <<
'\n';
+ return encryption_key;
+ }
+}
+
+std::string EncryptConfig::hexDecodeAndValidateKey(const std::string& key)
const {
+ std::string binary_key = utils::StringUtils::from_hex(key);
Review comment:
This is something that should get a comment above the line so that
future readers are aware of this decision.
##########
File path: encrypt-config/CMakeLists.txt
##########
@@ -0,0 +1,25 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+file(GLOB ENCRYPT_CONFIG_FILES "*.cpp")
+add_executable(encrypt-config "${ENCRYPT_CONFIG_FILES}")
+target_include_directories(encrypt-config PRIVATE ../libminifi/include
../thirdparty/cxxopts/include)
+target_wholearchive_library(encrypt-config minifi)
+target_link_libraries(encrypt-config cxxopts)
Review comment:
Not sure why encrypt-config compiles since it's missing a libsodium
dependency, therefore it shouldn't have the necessary include paths. Anyway, I
suggest adding libsodium here.
```suggestion
target_link_libraries(encrypt-config cxxopts libsodium)
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
