aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgBasicOperator.h
diff options
context:
space:
mode:
authorSaturneric <[email protected]>2022-02-06 05:29:01 +0000
committerSaturneric <[email protected]>2022-02-06 05:29:01 +0000
commita2d75efab5dca4e9a9721afef61cad0f62d4825f (patch)
treee2d9647e68d7ef9f47cfe3e6b3100ef8aed076f8 /src/core/function/gpg/GpgBasicOperator.h
parent<chore>(project, ci): Make the Windows platform pass the compilation (diff)
downloadGpgFrontend-a2d75efab5dca4e9a9721afef61cad0f62d4825f.tar.gz
GpgFrontend-a2d75efab5dca4e9a9721afef61cad0f62d4825f.zip
<refactor>(core, ui): Adjust the core code directory structure.
Diffstat (limited to 'src/core/function/gpg/GpgBasicOperator.h')
-rw-r--r--src/core/function/gpg/GpgBasicOperator.h179
1 files changed, 179 insertions, 0 deletions
diff --git a/src/core/function/gpg/GpgBasicOperator.h b/src/core/function/gpg/GpgBasicOperator.h
new file mode 100644
index 00000000..9b9d9f63
--- /dev/null
+++ b/src/core/function/gpg/GpgBasicOperator.h
@@ -0,0 +1,179 @@
+/**
+ * Copyright (C) 2021 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 <https://www.gnu.org/licenses/>.
+ *
+ * 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<[email protected]> starting on May 12, 2021.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ */
+
+#ifndef GPGFRONTEND_ZH_CN_TS_BASICOPERATOR_H
+#define GPGFRONTEND_ZH_CN_TS_BASICOPERATOR_H
+
+#include "core/GpgConstants.h"
+#include "core/GpgContext.h"
+#include "core/GpgFunctionObject.h"
+#include "core/GpgModel.h"
+
+namespace GpgFrontend {
+
+/**
+ * @brief Basic operation collection
+ *
+ */
+class GpgBasicOperator : public SingletonFunctionObject<GpgBasicOperator> {
+ public:
+ /**
+ * @brief Construct a new Basic Operator object
+ *
+ * @param channel Channel corresponding to the context
+ */
+ explicit GpgBasicOperator(
+ int channel = SingletonFunctionObject::GetDefaultChannel())
+ : SingletonFunctionObject<GpgBasicOperator>(channel) {}
+
+ /**
+ * @brief Call the interface provided by gpgme for encryption operation
+ *
+ * All incoming data pointers out_buffer will be replaced with new valid
+ * values
+ *
+ * @param keys list of public keys
+ * @param in_buffer data that needs to be encrypted
+ * @param out_buffer encrypted data
+ * @param result the result of the operation
+ * @return error code
+ */
+ gpg_error_t Encrypt(KeyListPtr keys, BypeArrayRef in_buffer,
+ ByteArrayPtr& out_buffer, GpgEncrResult& result);
+
+ /**
+ * @brief Call the interface provided by GPGME to symmetrical encryption
+ *
+ * @param in_buffer Data for encryption
+ * @param out_buffer Encrypted data
+ * @param result Encrypted results
+ * @return gpg_error_t
+ */
+ gpg_error_t EncryptSymmetric(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
+ GpgEncrResult& result);
+
+ /**
+ *
+ * @brief Call the interface provided by gpgme to perform encryption and
+ * signature operations at the same time.
+ *
+ * @param keys List of public keys
+ * @param signers Private key for signatures
+ * @param in_buffer Data for operation
+ * @param out_buffer Encrypted data
+ * @param encr_result Encrypted results
+ * @param sign_result Signature result
+ * @return
+ */
+ gpgme_error_t EncryptSign(KeyListPtr keys, KeyListPtr signers,
+ BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
+ GpgEncrResult& encr_result,
+ GpgSignResult& sign_result);
+
+ /**
+ * @brief Call the interface provided by gpgme for decryption operation
+ *
+ * @param in_buffer data that needs to be decrypted
+ * @param out_buffer decrypted data
+ * @param result the result of the operation
+ * @return error code
+ */
+ gpgme_error_t Decrypt(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
+ GpgDecrResult& result);
+
+ /**
+ * @brief Call the interface provided by gpgme to perform decryption and
+ * verification operations at the same time.
+ *
+ * @param in_buffer data to be manipulated
+ * @param out_buffer data resulting from decryption operation
+ * @param decrypt_result the result of the decrypting operation
+ * @param verify_result the result of the verifying operation
+ * @return error code
+ */
+ gpgme_error_t DecryptVerify(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
+ GpgDecrResult& decrypt_result,
+ GpgVerifyResult& verify_result);
+
+ /**
+ * @brief Call the interface provided by gpgme for verification operation
+ *
+ * @param in_buffer data that needs to be verified
+ * @param out_buffer verified data
+ * @param result the result of the operation
+ * @return error code
+ */
+ gpgme_error_t Verify(BypeArrayRef in_buffer, ByteArrayPtr& sig_buffer,
+ GpgVerifyResult& result) const;
+
+ /**
+ * @brief Call the interface provided by gpgme for signing operation
+ *
+ * The signing modes are as follows:
+ * `GPGME_SIG_MODE_NORMAL'
+ * A normal signature is made, the output includes the plaintext and the
+ * signature.
+ * `GPGME_SIG_MODE_DETACH'
+ * A detached signature is made.
+ * `GPGME_SIG_MODE_CLEAR'
+ * A clear text signature is made. The ASCII armor and text mode settings
+ * of the context are ignored.
+ *
+ * @param signers private keys for signing operations
+ * @param in_buffer data that needs to be signed
+ * @param out_buffer verified data
+ * @param mode signing mode
+ * @param result the result of the operation
+ * @return error code
+ */
+ gpg_error_t Sign(KeyListPtr signers, BypeArrayRef in_buffer,
+ ByteArrayPtr& out_buffer, gpgme_sig_mode_t mode,
+ GpgSignResult& result);
+
+ /**
+ * @brief Set the private key for signatures, this operation is a global
+ * operation.
+ *
+ * @param keys
+ */
+ void SetSigners(KeyArgsList& signers);
+
+ /**
+ * @brief Get a global signature private keys that has been set.
+ *
+ * @return Intelligent pointer pointing to the private key list
+ */
+ std::unique_ptr<KeyArgsList> GetSigners();
+
+ private:
+ GpgContext& ctx_ = GpgContext::GetInstance(
+ SingletonFunctionObject::GetChannel()); ///< Corresponding context
+};
+} // namespace GpgFrontend
+
+#endif // GPGFRONTEND_ZH_CN_TS_BASICOPERATOR_H