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
|
/**
* 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/result_analyse/GpgResultAnalyse.h"
#include "core/typedef/GpgTypedef.h"
namespace GpgFrontend {
/**
* @brief Executive files related to the basic operations of GPG
*
* @class class: GpgBasicOperator
*/
class GPGFRONTEND_CORE_EXPORT GpgFileOpera {
public:
/**
* @brief Encrypted file with public key
*
* @param keys Used public key
* @param in_path The path where the enter file is located
* @param out_path The path where the output file is located
* @param result Encrypted results
* @param channel Channel in context
* @return unsigned int error code
*/
static void EncryptFile(std::vector<GpgKey> keys, const std::string& in_path,
const std::string& out_path, bool ascii,
const GpgOperationCallback& cb);
/**
* @brief Encrypted file symmetrically (with password)
*
* @param in_path
* @param out_path
* @param result
* @param channel
* @return unsigned int
*/
static void EncryptFileSymmetric(const std::string& in_path,
const std::string& out_path, bool ascii,
const GpgOperationCallback& cb);
/**
* @brief
*
* @param in_path
* @param out_path
* @param result
* @return GpgError
*/
static void DecryptFile(const std::string& in_path,
const std::string& out_path,
const GpgOperationCallback& cb);
/**
* @brief Sign file with private key
*
* @param keys
* @param in_path
* @param out_path
* @param result
* @param channel
* @return GpgError
*/
static auto SignFile(KeyListPtr keys, const std::string& in_path,
const std::string& out_path, GpgSignResult& result,
int channel = kGpgFrontendDefaultChannel) -> GpgError;
/**
* @brief Verify file with public key
*
* @param data_path The path where the enter file is located
* @param sign_path The path where the signature file is located
* @param result Verify results
* @param channel Channel in context
* @return GpgError
*/
static auto VerifyFile(const std::string& data_path,
const std::string& sign_path, GpgVerifyResult& result,
int channel = kGpgFrontendDefaultChannel) -> GpgError;
/**
* @brief Encrypt and sign file with public key and private key
*
* @param keys
* @param signer_keys
* @param in_path
* @param out_path
* @param encr_res
* @param sign_res
* @param channel
* @return GpgError
*/
static auto EncryptSignFile(KeyListPtr keys, KeyListPtr signer_keys,
const std::string& in_path,
const std::string& out_path,
GpgEncrResult& encr_res, GpgSignResult& sign_res,
int channel = kGpgFrontendDefaultChannel)
-> GpgError;
/**
* @brief
*
* @param in_path
* @param out_path
* @param decr_res
* @param verify_res
* @return GpgError
*/
static auto DecryptVerifyFile(const std::string& in_path,
const std::string& out_path,
GpgDecrResult& decr_res,
GpgVerifyResult& verify_res) -> GpgError;
};
} // namespace GpgFrontend
|