1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/**
* Copyright (C) 2021 Saturneric <[email protected]>
*
* 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
*
*/
#pragma once
#include "core/function/basic/GpgFunctionObject.h"
#include "core/function/gpg/GpgContext.h"
#include "core/function/result_analyse/GpgResultAnalyse.h"
#include "core/typedef/CoreTypedef.h"
#include "core/typedef/GpgTypedef.h"
namespace GpgFrontend {
/**
* @brief Basic operation collection
*
*/
class GPGFRONTEND_CORE_EXPORT 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());
/**
* @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
*/
auto Encrypt(KeyListPtr keys, BypeArrayRef in_buffer,
ByteArrayPtr& out_buffer, GpgEncrResult& result) -> gpg_error_t;
/**
* @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
*/
auto EncryptSymmetric(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
GpgEncrResult& result) -> gpg_error_t;
/**
*
* @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
*/
auto EncryptSign(KeyListPtr keys, KeyListPtr signers, BypeArrayRef in_buffer,
ByteArrayPtr& out_buffer, GpgEncrResult& encr_result,
GpgSignResult& sign_result) -> gpgme_error_t;
/**
* @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
*/
auto Decrypt(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
GpgDecrResult& result) -> gpgme_error_t;
/**
* @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
*/
auto DecryptVerify(BypeArrayRef in_buffer, ByteArrayPtr& out_buffer,
GpgDecrResult& decrypt_result,
GpgVerifyResult& verify_result) -> gpgme_error_t;
/**
* @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
*/
auto Verify(BypeArrayRef in_buffer, ByteArrayPtr& sig_buffer,
GpgVerifyResult& result) const -> gpgme_error_t;
/**
* @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
*/
auto Sign(KeyListPtr signers, BypeArrayRef in_buffer,
ByteArrayPtr& out_buffer, gpgme_sig_mode_t mode,
GpgSignResult& result) -> gpg_error_t;
/**
* @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
*/
auto GetSigners() -> std::unique_ptr<KeyArgsList>;
private:
GpgContext& ctx_ = GpgContext::GetInstance(
SingletonFunctionObject::GetChannel()); ///< Corresponding context
};
} // namespace GpgFrontend
|
