/** * 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 * */ #pragma once #include #include "core/function/SecureMemoryAllocator.h" #include "core/function/basic/GpgFunctionObject.h" namespace GpgFrontend { /** * @brief * */ struct GpgContextInitArgs { QString db_name; ///< QString db_path; ///< bool test_mode = false; ///< bool offline_mode = false; ///< bool auto_import_missing_key = false; ///< bool use_pinentry = false; ///< }; enum class GpgComponentType { kGPG_AGENT, kDIRMNGR, kKEYBOXD, kGPG_AGENT_SSH }; /** * @brief * */ class GPGFRONTEND_CORE_EXPORT GpgContext : public SingletonFunctionObject { public: explicit GpgContext(int channel); explicit GpgContext(GpgContextInitArgs args, int channel); ~GpgContext(); /** * @brief * * @return true * @return false */ [[nodiscard]] auto Good() const -> bool; /** * @brief * * @return gpgme_ctx_t */ auto BinaryContext() -> gpgme_ctx_t; /** * @brief * * @return gpgme_ctx_t */ auto DefaultContext() -> gpgme_ctx_t; /** * @brief * * @return QString */ [[nodiscard]] auto KeyDBName() const -> QString; /** * @brief * * @return QString */ [[nodiscard]] auto HomeDirectory() const -> QString; /** * @brief * * @return QString */ [[nodiscard]] auto ComponentDirectory(GpgComponentType) const -> QString; /** * @brief * * @return true * @return false */ auto RestartGpgAgent() -> bool; private: class Impl; SecureUniquePtr p_; }; } // namespace GpgFrontend