From issues-return-104566-apmail-nifi-issues-archive=nifi.apache.org@nifi.apache.org Thu Oct 8 15:45:44 2020 Return-Path: X-Original-To: apmail-nifi-issues-archive@locus.apache.org Delivered-To: apmail-nifi-issues-archive@locus.apache.org Received: from mailroute1-lw-us.apache.org (mailroute1-lw-us.apache.org [207.244.88.153]) by minotaur.apache.org (Postfix) with ESMTP id A96801A876 for ; Thu, 8 Oct 2020 15:45:44 +0000 (UTC) Received: from mail.apache.org (localhost [127.0.0.1]) by mailroute1-lw-us.apache.org (ASF Mail Server at mailroute1-lw-us.apache.org) with SMTP id 5BC721236B7 for ; Thu, 8 Oct 2020 15:45:44 +0000 (UTC) Received: (qmail 80240 invoked by uid 500); 8 Oct 2020 15:45:44 -0000 Delivered-To: apmail-nifi-issues-archive@nifi.apache.org Received: (qmail 80212 invoked by uid 500); 8 Oct 2020 15:45:44 -0000 Mailing-List: contact issues-help@nifi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@nifi.apache.org Delivered-To: mailing list issues@nifi.apache.org Received: (qmail 80202 invoked by uid 99); 8 Oct 2020 15:45:44 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 08 Oct 2020 15:45:44 +0000 From: =?utf-8?q?GitBox?= To: issues@nifi.apache.org Subject: =?utf-8?q?=5BGitHub=5D_=5Bnifi-minifi-cpp=5D_szaszm_commented_on_a_change_in?= =?utf-8?q?_pull_request_=23914=3A_MINIFICPP-1323_Encrypt_sensitive_properti?= =?utf-8?q?es_using_libsodium?= Message-ID: <160217194401.32230.15698926300564929432.asfpy@gitbox.apache.org> Date: Thu, 08 Oct 2020 15:45:44 -0000 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit In-Reply-To: References: szaszm commented on a change in pull request #914: URL: https://github.com/apache/nifi-minifi-cpp/pull/914#discussion_r501824449 ########## File path: encrypt-config/ConfigFile.cpp ########## @@ -0,0 +1,171 @@ +/** + * 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 "ConfigFile.h" + +#include +#include +#include + +#include "utils/StringUtils.h" + +namespace { +constexpr std::array DEFAULT_SENSITIVE_PROPERTIES{"nifi.security.client.pass.phrase", + "nifi.rest.api.password"}; +constexpr const char* ADDITIONAL_SENSITIVE_PROPS_PROPERTY_NAME = "nifi.sensitive.props.additional.keys"; +} // namespace + +namespace org { +namespace apache { +namespace nifi { +namespace minifi { +namespace encrypt_config { + +ConfigLine::ConfigLine(std::string line) : line_(line) { + line = utils::StringUtils::trim(line); + if (line.empty() || line[0] == '#') { return; } + + size_t index_of_first_equals_sign = line.find('='); + if (index_of_first_equals_sign == std::string::npos) { return; } + + std::string key = utils::StringUtils::trim(line.substr(0, index_of_first_equals_sign)); + if (key.empty()) { return; } + + key_ = key; + value_ = utils::StringUtils::trim(line.substr(index_of_first_equals_sign + 1)); +} + +ConfigLine::ConfigLine(std::string key, std::string value) + : line_{utils::StringUtils::join_pack(key, "=", value)}, key_{std::move(key)}, value_{std::move(value)} { +} + +void ConfigLine::updateValue(const std::string& value) { + auto pos = line_.find('='); + if (pos != std::string::npos) { + line_.replace(pos + 1, std::string::npos, value); + value_ = value; + } else { + throw std::invalid_argument{"Cannot update value in config line: it does not contain an = sign!"}; + } +} + +ConfigFile::ConfigFile(std::istream& input_stream) { + std::string line; + while (std::getline(input_stream, line)) { + config_lines_.push_back(ConfigLine{line}); + } +} + +ConfigFile::Lines::const_iterator ConfigFile::findKey(const std::string& key) const { + return std::find_if(config_lines_.cbegin(), config_lines_.cend(), [&key](const ConfigLine& config_line) { + return config_line.getKey() == key; + }); +} + +ConfigFile::Lines::iterator ConfigFile::findKey(const std::string& key) { + return std::find_if(config_lines_.begin(), config_lines_.end(), [&key](const ConfigLine& config_line) { + return config_line.getKey() == key; + }); +} + +bool ConfigFile::hasValue(const std::string& key) const { + const auto it = findKey(key); + return (it != config_lines_.end()); +} + +utils::optional ConfigFile::getValue(const std::string& key) const { + const auto it = findKey(key); + if (it != config_lines_.end()) { + return it->getValue(); + } else { + return utils::nullopt; + } +} + +void ConfigFile::update(const std::string& key, const std::string& value) { + auto it = findKey(key); + if (it != config_lines_.end()) { + it->updateValue(value); + } else { + throw std::invalid_argument{"Key " + key + " not found in the config file!"}; + } +} + +void ConfigFile::insertAfter(const std::string& after_key, const std::string& key, const std::string& value) { + auto it = findKey(after_key); + if (it != config_lines_.end()) { + ++it; + config_lines_.emplace(it, key, value); + } else { + throw std::invalid_argument{"Key " + after_key + " not found in the config file!"}; + } +} + +void ConfigFile::append(const std::string& key, const std::string& value) { + config_lines_.emplace_back(key, value); +} + +int ConfigFile::erase(const std::string& key) { + auto has_this_key = [&key](const ConfigLine& line) { return line.getKey() == key; }; + auto new_end = std::remove_if(config_lines_.begin(), config_lines_.end(), has_this_key); + auto num_removed = std::distance(new_end, config_lines_.end()); + config_lines_.erase(new_end, config_lines_.end()); + return gsl::narrow(num_removed); +} + +void ConfigFile::writeTo(const std::string& file_path) const { + std::ofstream file{file_path}; Review comment: `std::ofstream` doesn't throw on error, just sets error bits by default. This hides errors and causes me as a user to not realize that despite the success output, nothing has changed because I was not running as admin. Luckily its error reporting behavior can be configured. ```suggestion std::ofstream file{file_path}; file.exceptions(std::ios::failbit | std::ios::badbit); ``` ---------------------------------------------------------------- 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: users@infra.apache.org