aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/utils/GpgUtils.h
blob: f005bbfc5cae2e263e08fbace9bb3d701345bf8a (plain)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/**
 * Copyright (C) 2021-2024 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/model/GpgAbstractKey.h"
#include "core/model/KeyDatabaseInfo.h"
#include "core/struct/settings_object/KeyDatabaseItemSO.h"
#include "core/typedef/CoreTypedef.h"
#include "core/typedef/GpgTypedef.h"

namespace GpgFrontend {

// Error Info Printer

/**
 * @brief
 *
 * @param err
 * @return GpgError
 */
auto GPGFRONTEND_CORE_EXPORT CheckGpgError(GpgError err) -> GpgError;

/**
 * @brief
 *
 * @param gpgmeError
 * @param comment
 * @return GpgError
 */
auto GPGFRONTEND_CORE_EXPORT CheckGpgError(GpgError gpgmeError,
                                           const QString& comment) -> GpgError;

/**
 * @brief
 *
 * @param err
 * @param predict
 * @return gpg_err_code_t
 */
auto GPGFRONTEND_CORE_EXPORT CheckGpgError2ErrCode(
    gpgme_error_t err,
    gpgme_error_t predict = GPG_ERR_NO_ERROR) -> gpg_err_code_t;

/**
 * @brief
 *
 * @param err
 * @return GpgErrorDesc
 */
auto GPGFRONTEND_CORE_EXPORT DescribeGpgErrCode(GpgError err) -> GpgErrorDesc;

// Check

/**
 * @brief
 *
 * @param text
 * @return int
 */
auto GPGFRONTEND_CORE_EXPORT TextIsSigned(BypeArrayRef text) -> int;

/**
 * @brief
 *
 * @param opera
 * @param ascii
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT SetExtensionOfOutputFile(const QString& path,
                                                      GpgOperation opera,
                                                      bool ascii) -> QString;

/**
 * @brief
 *
 * @param path
 * @param opera
 * @param ascii
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT SetExtensionOfOutputFileForArchive(
    const QString& path, GpgOperation opera, bool ascii) -> QString;

/**
 * @brief
 *
 * @param app_path
 * @param path
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT GetCanonicalKeyDatabasePath(
    const QDir& app_path, const QString& path) -> QString;

/**
 * @brief Get the Key Databases By Settings object
 *
 * @return QContainer<KeyDatabaseItemSO>
 */
auto GPGFRONTEND_CORE_EXPORT GetKeyDatabasesBySettings()
    -> QContainer<KeyDatabaseItemSO>;

/**
 * @brief
 *
 * @return QContainer<KeyDatabaseInfo>
 */
auto GPGFRONTEND_CORE_EXPORT GetKeyDatabaseInfoBySettings()
    -> QContainer<KeyDatabaseInfo>;

/**
 * @brief
 *
 * @return QContainer<KeyDatabaseItemSO>
 */
auto GPGFRONTEND_CORE_EXPORT GetGpgKeyDatabaseInfos()
    -> QContainer<KeyDatabaseInfo>;

/**
 * @brief
 *
 * @return QContainer<KeyDatabaseItemSO>
 */
auto GPGFRONTEND_CORE_EXPORT GetGpgKeyDatabaseName(int channel) -> QString;

/**
 * @brief
 *
 * @param channel
 * @param keys
 * @return KeyIdArgsList
 */
auto GPGFRONTEND_CORE_EXPORT ConvertKey2GpgKeyIdList(
    int channel, const GpgAbstractKeyPtrList& keys) -> KeyIdArgsList;

/**
 * @brief
 *
 * @param channel
 * @param keys
 * @return GpgKeyPtrList
 */
auto GPGFRONTEND_CORE_EXPORT ConvertKey2GpgKeyList(
    int channel, const GpgAbstractKeyPtrList& keys) -> GpgKeyPtrList;

/**
 * @brief
 *
 * @param keys
 * @return QContainer<gpgme_key_t>
 */
auto GPGFRONTEND_CORE_EXPORT Convert2RawGpgMEKeyList(
    int channel, const GpgAbstractKeyPtrList& keys) -> QContainer<gpgme_key_t>;

/**
 * @brief
 *
 * @param key
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT GetUsagesByAbstractKey(const GpgAbstractKey* key)
    -> QString;

/**
 * @brief
 *
 * @return GpgKey
 */
auto GPGFRONTEND_CORE_EXPORT GetGpgKeyByGpgAbstractKey(GpgAbstractKey*)
    -> GpgKey;

/**
 * @brief
 *
 * @param id
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT IsKeyGroupID(const KeyId& id) -> bool;

/**
 * @brief
 *
 * @return bool
 */
auto GPGFRONTEND_CORE_EXPORT GpgAgentVersionGreaterThan(int channel,
                                                        const QString&) -> bool;

/**
 * @brief
 *
 * @param channel
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT CheckGpgVersion(int channel,
                                             const QString&) -> bool;

/**
 * @brief
 *
 * @return QString
 */
auto GPGFRONTEND_CORE_EXPORT DecidePinentry() -> QString;
}  // namespace GpgFrontend