/** * Copyright (C) 2021-2024 Saturneric * * This file is part of GpgFrontend. * * GpgFrontend is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * GpgFrontend is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with GpgFrontend. If not, see . * * The initial version of the source code is inherited from * the gpg4usb project, which is under GPL-3.0-or-later. * * All the source code of GpgFrontend was modified and released by * Saturneric starting on May 12, 2021. * * SPDX-License-Identifier: GPL-3.0-or-later * */ #include "GpgKeyManager.h" #include "core/GpgModel.h" #include "core/function/gpg/GpgBasicOperator.h" #include "core/function/gpg/GpgKeyGetter.h" #include "core/utils/GpgUtils.h" GpgFrontend::GpgKeyManager::GpgKeyManager(int channel) : SingletonFunctionObject(channel) {} auto GpgFrontend::GpgKeyManager::interactor_cb_fnc(void* handle, const char* status, const char* args, int fd) -> gpgme_error_t { auto* handle_struct = static_cast(handle); QString status_s = status; QString args_s = args; if (status_s == "KEY_CONSIDERED") { auto tokens = QString(args).split(' '); if (tokens.empty() || tokens[0] != handle_struct->KeyFpr()) { LOG_W() << "handle struct key fpr " << handle_struct->KeyFpr() << "mismatch token: " << tokens[0] << ", exit..."; return -1; } return 0; } if (status_s == "GOT_IT" || status_s.isEmpty()) { FLOG_D("gpg reply is GOT_IT, continue..."); return 0; } LOG_D() << "current state" << handle_struct->CurrentStatus() << "gpg status: " << status_s << ", args: " << args_s; AutomatonState next_state = handle_struct->NextState(status_s, args_s); if (next_state == AS_ERROR) { FLOG_D("handle struct next state caught error, abort..."); return -1; } LOG_D() << "next state" << next_state; if (next_state == AS_SAVE) { handle_struct->SetSuccess(true); } // set state and preform action handle_struct->SetStatus(next_state); Command cmd = handle_struct->Action(); LOG_D() << "next action, cmd:" << cmd; if (!cmd.isEmpty()) { auto btye_array = cmd.toUtf8(); gpgme_io_write(fd, btye_array, btye_array.size()); gpgme_io_write(fd, "\n", 1); } else if (status_s == "GET_LINE") { // avoid trapping in this state return GPG_ERR_FALSE; } return 0; } auto GpgFrontend::GpgKeyManager::SignKey( const GpgFrontend::GpgKey& target, GpgFrontend::KeyArgsList& keys, const QString& uid, const std::unique_ptr& expires) -> bool { GpgBasicOperator::GetInstance(GetChannel()).SetSigners(keys, true); unsigned int flags = 0; unsigned int expires_time_t = 0; if (expires == nullptr) { flags |= GPGME_KEYSIGN_NOEXPIRE; } else { expires_time_t = expires->toSecsSinceEpoch(); } auto err = CheckGpgError( gpgme_op_keysign(ctx_.DefaultContext(), static_cast(target), uid.toUtf8(), expires_time_t, flags)); return CheckGpgError(err) == GPG_ERR_NO_ERROR; } auto GpgFrontend::GpgKeyManager::RevSign( const GpgFrontend::GpgKey& key, const GpgFrontend::SignIdArgsListPtr& signature_id) -> bool { auto& key_getter = GpgKeyGetter::GetInstance(GetChannel()); for (const auto& sign_id : *signature_id) { auto signing_key = key_getter.GetKey(sign_id.first); assert(signing_key.IsGood()); auto err = CheckGpgError( gpgme_op_revsig(ctx_.DefaultContext(), gpgme_key_t(key), gpgme_key_t(signing_key), sign_id.second.toUtf8(), 0)); if (CheckGpgError(err) != GPG_ERR_NO_ERROR) return false; } return true; } auto GpgFrontend::GpgKeyManager::SetExpire( const GpgFrontend::GpgKey& key, std::unique_ptr& subkey, std::unique_ptr& expires) -> bool { unsigned long expires_time = 0; if (expires != nullptr) expires_time = expires->toSecsSinceEpoch(); const char* sub_fprs = nullptr; if (subkey != nullptr) sub_fprs = subkey->GetFingerprint().toUtf8(); auto err = CheckGpgError(gpgme_op_setexpire(ctx_.DefaultContext(), static_cast(key), expires_time, sub_fprs, 0)); return CheckGpgError(err) == GPG_ERR_NO_ERROR; } auto GpgFrontend::GpgKeyManager::SetOwnerTrustLevel(const GpgKey& key, int trust_level) -> bool { if (trust_level < 1 || trust_level > 5) { FLOG_W("illegal owner trust level: %d", trust_level); } AutomatonNextStateHandler next_state_handler = [](AutomatonState state, QString status, QString args) { auto tokens = args.split(' '); switch (state) { case AS_START: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_COMMAND; } return AS_ERROR; case AS_COMMAND: if (status == "GET_LINE" && args == "edit_ownertrust.value") { return AS_VALUE; } return AS_ERROR; case AS_VALUE: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_BOOL" && args == "edit_ownertrust.set_ultimate.okay") { return AS_REALLY_ULTIMATE; } return AS_ERROR; case AS_REALLY_ULTIMATE: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } return AS_ERROR; case AS_QUIT: if (status == "GET_BOOL" && args == "keyedit.save.okay") { return AS_SAVE; } return AS_ERROR; case AS_ERROR: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } return AS_ERROR; default: return AS_ERROR; }; }; AutomatonActionHandler action_handler = [trust_level](AutomatonHandelStruct& handler, AutomatonState state) { switch (state) { case AS_COMMAND: return QString("trust"); case AS_VALUE: handler.SetSuccess(true); return QString::number(trust_level); case AS_REALLY_ULTIMATE: handler.SetSuccess(true); return QString("Y"); case AS_QUIT: return QString("quit"); case AS_SAVE: handler.SetSuccess(true); return QString("Y"); case AS_START: case AS_ERROR: return QString(""); default: return QString(""); } return QString(""); }; auto key_fpr = key.GetFingerprint(); AutomatonHandelStruct handel_struct(key_fpr); handel_struct.SetHandler(next_state_handler, action_handler); GpgData data_out; auto err = gpgme_op_interact(ctx_.DefaultContext(), static_cast(key), 0, GpgKeyManager::interactor_cb_fnc, static_cast(&handel_struct), data_out); return CheckGpgError(err) == GPG_ERR_NO_ERROR && handel_struct.Success(); } auto GpgFrontend::GpgKeyManager::DeleteSubkey(const GpgKey& key, int subkey_index) -> bool { if (subkey_index < 0 || subkey_index >= key.GetSubKeys()->size()) { LOG_W() << "illegal subkey index: " << subkey_index; } AutomatonNextStateHandler next_state_handler = [](AutomatonState state, QString status, QString args) { auto tokens = args.split(' '); switch (state) { case AS_START: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_SELECT; } return AS_ERROR; case AS_SELECT: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_COMMAND; } return AS_ERROR; case AS_COMMAND: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_BOOL" && args == "keyedit.remove.subkey.okay") { return AS_REALLY_ULTIMATE; } return AS_ERROR; case AS_REALLY_ULTIMATE: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } return AS_ERROR; case AS_QUIT: if (status == "GET_BOOL" && args == "keyedit.save.okay") { return AS_SAVE; } return AS_ERROR; case AS_ERROR: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } return AS_ERROR; default: return AS_ERROR; }; }; AutomatonActionHandler action_handler = [subkey_index](AutomatonHandelStruct& handler, AutomatonState state) { switch (state) { case AS_SELECT: return QString("key %1").arg(subkey_index); case AS_COMMAND: return QString("delkey"); case AS_REALLY_ULTIMATE: handler.SetSuccess(true); return QString("Y"); case AS_QUIT: return QString("quit"); case AS_SAVE: handler.SetSuccess(true); return QString("Y"); case AS_START: case AS_ERROR: return QString(""); default: return QString(""); } return QString(""); }; auto key_fpr = key.GetFingerprint(); AutomatonHandelStruct handel_struct(key_fpr); handel_struct.SetHandler(next_state_handler, action_handler); GpgData data_out; auto err = gpgme_op_interact(ctx_.DefaultContext(), static_cast(key), 0, GpgKeyManager::interactor_cb_fnc, static_cast(&handel_struct), data_out); return CheckGpgError(err) == GPG_ERR_NO_ERROR && handel_struct.Success(); } auto GpgFrontend::GpgKeyManager::RevokeSubkey( const GpgKey& key, int subkey_index, int reason_code, const QString& reason_text) -> bool { if (subkey_index < 0 || subkey_index >= key.GetSubKeys()->size()) { LOG_W() << "illegal subkey index: " << subkey_index; } // dealing with reason text #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 4) auto reason_text_lines = GpgFrontend::SecureCreateSharedObject>( reason_text.split('\n', Qt::SkipEmptyParts).toVector()); #else auto reason_text_lines = GpgFrontend::SecureCreateSharedObject>( reason_text.split('\n', Qt::SkipEmptyParts).toVector()); #endif AutomatonNextStateHandler next_state_handler = [](AutomatonState state, QString status, QString args) { auto tokens = args.split(' '); switch (state) { case AS_START: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_SELECT; } return AS_ERROR; case AS_SELECT: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_COMMAND; } return AS_ERROR; case AS_COMMAND: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_BOOL" && args == "keyedit.revoke.subkey.okay") { return AS_REALLY_ULTIMATE; } return AS_ERROR; case AS_REASON_CODE: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_LINE" && args == "ask_revocation_reason.text") { return AS_REASON_TEXT; } return AS_ERROR; case AS_REASON_TEXT: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_LINE" && args == "ask_revocation_reason.text") { return AS_REASON_TEXT; } else if (status == "GET_BOOL" && args == "ask_revocation_reason.okay") { return AS_REALLY_ULTIMATE; } return AS_ERROR; case AS_REALLY_ULTIMATE: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } else if (status == "GET_LINE" && args == "ask_revocation_reason.code") { return AS_REASON_CODE; } return AS_ERROR; case AS_QUIT: if (status == "GET_BOOL" && args == "keyedit.save.okay") { return AS_SAVE; } return AS_ERROR; case AS_ERROR: if (status == "GET_LINE" && args == "keyedit.prompt") { return AS_QUIT; } return AS_ERROR; default: return AS_ERROR; }; }; AutomatonActionHandler action_handler = [subkey_index, reason_code, reason_text_lines]( AutomatonHandelStruct& handler, AutomatonState state) { switch (state) { case AS_SELECT: return QString("key %1").arg(subkey_index); case AS_COMMAND: return QString("revkey"); case AS_REASON_CODE: return QString::number(reason_code); case AS_REASON_TEXT: return reason_text_lines->isEmpty() ? QString("") : QString(reason_text_lines->takeFirst().toUtf8()); case AS_REALLY_ULTIMATE: return QString("Y"); case AS_QUIT: return QString("quit"); case AS_SAVE: handler.SetSuccess(true); return QString("Y"); case AS_START: case AS_ERROR: return QString(""); default: return QString(""); } return QString(""); }; auto key_fpr = key.GetFingerprint(); AutomatonHandelStruct handel_struct(key_fpr); handel_struct.SetHandler(next_state_handler, action_handler); GpgData data_out; auto err = gpgme_op_interact(ctx_.DefaultContext(), static_cast(key), 0, GpgKeyManager::interactor_cb_fnc, static_cast(&handel_struct), data_out); return CheckGpgError(err) == GPG_ERR_NO_ERROR && handel_struct.Success(); }