You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/07/01 14:07:22 UTC
[GitHub] [nifi-minifi-cpp] lordgamez commented on a change in pull request #1123: MINIFICPP-1579 Add config file checksums to the heartbeat
lordgamez commented on a change in pull request #1123:
URL: https://github.com/apache/nifi-minifi-cpp/pull/1123#discussion_r662312593
##########
File path: libminifi/src/utils/ChecksumCalculator.cpp
##########
@@ -0,0 +1,98 @@
+/**
+ * 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 "utils/ChecksumCalculator.h"
+
+#include <fstream>
+
+#include "sodium/crypto_hash_sha256.h"
+#include "utils/file/FileUtils.h"
+#include "utils/StringUtils.h"
+
+namespace {
+
+const std::string AGENT_IDENTIFIER_KEY = "nifi.c2.agent.identifier=";
+
+}
+
+namespace org {
+namespace apache {
+namespace nifi {
+namespace minifi {
+namespace utils {
+
+constexpr const char* ChecksumCalculator::CHECKSUM_TYPE;
+constexpr size_t ChecksumCalculator::LENGTH_OF_HASH_IN_BYTES;
+
+void ChecksumCalculator::setFileLocation(const std::string& file_location) {
+ file_location_ = file_location;
+ file_name_ = utils::file::get_child_path(file_location);
+}
+
+std::string ChecksumCalculator::getFileName() const {
+ if (!file_name_) {
+ throw std::logic_error("File name not set in ChecksumCalculator!");
+ }
+ return *file_name_;
+}
+
+std::string ChecksumCalculator::getChecksum() {
+ if (!file_location_) {
+ throw std::logic_error("File location not set in ChecksumCalculator!");
+ }
+ if (!checksum_) {
+ checksum_ = computeChecksum(*file_location_);
+ }
+ return *checksum_;
+}
+
+std::string ChecksumCalculator::computeChecksum(const std::string& file_location) {
+ using org::apache::nifi::minifi::utils::StringUtils;
+
+ std::ifstream input_file{file_location, std::ios::in | std::ios::binary};
+ if (!input_file.is_open()) {
+ throw std::runtime_error(StringUtils::join_pack("Could not open config file '", file_location, "' to compute the checksum: ", std::strerror(errno)));
+ }
+
+ crypto_hash_sha256_state state;
+ crypto_hash_sha256_init(&state);
+
+ std::string line;
+ while (std::getline(input_file, line)) {
+ if (StringUtils::startsWith(line, AGENT_IDENTIFIER_KEY)) {
Review comment:
I think we should add a comment in the code as well why this is not included in the checksum calculation.
##########
File path: libminifi/test/unit/ChecksumCalculatorTests.cpp
##########
@@ -0,0 +1,101 @@
+/**
+ * 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 <numeric>
+
+#include "../TestBase.h"
+#include "utils/TestUtils.h"
+#include "utils/ChecksumCalculator.h"
+
+namespace {
+ constexpr const char* CHECKSUM_FOR_ONE_LINE_OF_TEXT = "e26d1a9f3c3cb9f55e797ce1c9b15e89b4a23d4a301d92da23e684c8a25bf641";
+ constexpr const char* CHECKSUM_FOR_TWO_LINES_OF_TEXT = "7614d0e3b10a3ae41fd50130aa8b83c1bd1248fb6dcfc25cb135665ea3c4f8c8";
+}
+
+TEST_CASE("ChecksumCalculator can calculate the checksum, which is equal to sha256sum", "[ChecksumCalculator]") {
+ TestController test_controller;
+ std::string test_dir = utils::createTempDir(&test_controller);
+ std::string file_location = utils::putFileToDir(test_dir, "simple.txt", "one line of text\n");
+
+ REQUIRE(std::string{utils::ChecksumCalculator::CHECKSUM_TYPE} == std::string{"SHA256"});
+ REQUIRE(utils::ChecksumCalculator::LENGTH_OF_HASH_IN_BYTES == 32);
+
+ utils::ChecksumCalculator checksum_calculator;
+ checksum_calculator.setFileLocation(file_location);
+ REQUIRE(checksum_calculator.getChecksum() == CHECKSUM_FOR_ONE_LINE_OF_TEXT);
+}
+
+TEST_CASE("On Windows text files, the checksum calculated is also the same as sha256sum", "[ChecksumCalculator]") {
+ TestController test_controller;
+ std::string test_dir = utils::createTempDir(&test_controller);
+ std::string file_location = utils::putFileToDir(test_dir, "simple.txt", "one line of text\r\n");
+
+ utils::ChecksumCalculator checksum_calculator;
+ checksum_calculator.setFileLocation(file_location);
+ REQUIRE(checksum_calculator.getChecksum() == "94fc46c62ef6cc5b45cbad9fd53116cfb15a80960a9b311c1c27e5b5265ad4b4");
+}
+
+TEST_CASE("The checksum can be reset and recomputed", "[ChecksumCalculator]") {
+ TestController test_controller;
+ std::string test_dir = utils::createTempDir(&test_controller);
+ std::string file_location = utils::putFileToDir(test_dir, "simple.txt", "one line of text\n");
+
+ utils::ChecksumCalculator checksum_calculator;
+ checksum_calculator.setFileLocation(file_location);
+ REQUIRE(checksum_calculator.getChecksum() == CHECKSUM_FOR_ONE_LINE_OF_TEXT);
+
+ std::ofstream append_to_file(file_location, std::ios::binary | std::ios::app);
+ append_to_file << "another line of text\n";
+ append_to_file.close();
+
+ REQUIRE(checksum_calculator.getChecksum() == CHECKSUM_FOR_ONE_LINE_OF_TEXT); // not updated, needs to be notified
+
+ checksum_calculator.invalidateChecksum();
+ REQUIRE(checksum_calculator.getChecksum() == CHECKSUM_FOR_TWO_LINES_OF_TEXT); // now it is updated
+}
+
+TEST_CASE("Checksums can be computed for binary (eg. encrypted) files, too", "[ChecksumCalculator]") {
+ TestController test_controller;
+ std::string test_dir = utils::createTempDir(&test_controller);
+ std::string binary_data(size_t{256}, '\0');
+ std::iota(binary_data.begin(), binary_data.end(), 'x');
+ std::string file_location = utils::putFileToDir(test_dir, "simple.txt", binary_data);
+
+ utils::ChecksumCalculator checksum_calculator;
+ checksum_calculator.setFileLocation(file_location);
+ REQUIRE(checksum_calculator.getChecksum() == "bdec77160c394c067419735de757e4daa1c4679ea45e82a33fa8f706eed87709");
+}
+
+TEST_CASE("The agent identifier is excluded from the checksum", "[ChecksumCalculator]") {
+ TestController test_controller;
+ std::string test_dir = utils::createTempDir(&test_controller);
+ std::string file_location_1 = utils::putFileToDir(test_dir, "agent_one.txt",
+ "nifi.c2.agent.class=Test\n"
+ "nifi.c2.agent.identifier=Test-111\n"
+ "nifi.c2.agent.heartbeat.period=10000\n");
+ std::string file_location_2 = utils::putFileToDir(test_dir, "agent_two.txt",
+ "nifi.c2.agent.class=Test\n"
+ "nifi.c2.agent.identifier=Test-222\n"
+ "nifi.c2.agent.heartbeat.period=10000\n");
+
+ utils::ChecksumCalculator checksum_calculator_1;
+ checksum_calculator_1.setFileLocation(file_location_1);
+ utils::ChecksumCalculator checksum_calculator_2;
+ checksum_calculator_2.setFileLocation(file_location_2);
+
+ REQUIRE(checksum_calculator_1.getChecksum() == checksum_calculator_2.getChecksum());
+}
Review comment:
Some additional simple tests could be added for error cases of `getChecksum` and `getFileName` if the file location is not set.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org