aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgKeyOpera.h
blob: 0b91f88a1bf6be93536b223e6e36f2fa156d03df (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
/**
 * 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 <functional>

#include "core/function/gpg/GpgContext.h"
#include "core/function/gpg/GpgKeyGetter.h"
#include "core/typedef/GpgTypedef.h"

namespace GpgFrontend {
/**
 * @brief
 *
 */
class KeyGenerateInfo;

/**
 * @brief
 *
 */
class GPGFRONTEND_CORE_EXPORT GpgKeyOpera
    : public SingletonFunctionObject<GpgKeyOpera> {
 public:
  /**
   * @brief Construct a new Gpg Key Opera object
   *
   * @param channel
   */
  explicit GpgKeyOpera(
      int channel = SingletonFunctionObject::GetDefaultChannel());

  /**
   * @brief
   *
   * @param key_ids
   */
  void DeleteKeys(const GpgAbstractKeyPtrList& keys);

  /**
   * @brief
   *
   * @param key_id
   */
  void DeleteKey(const GpgAbstractKeyPtr& key_id);

  /**
   * @brief Set the Expire object
   *
   * @param key
   * @param subkey_fpr
   * @param expires
   * @return GpgError
   */
  auto SetExpire(const GpgKeyPtr& key, const SubkeyId& subkey_fpr,
                 std::unique_ptr<QDateTime>& expires) -> GpgError;

  /**
   * @brief
   *
   * @param key
   * @param output_file_name
   */
  void GenerateRevokeCert(const GpgKeyPtr& key, const QString& output_path,
                          int revocation_reason_code,
                          const QString& revocation_reason_text);

  /**
   * @brief
   *
   * @param key
   * @return GpgFrontend::GpgError
   */
  void ModifyPassword(const GpgKeyPtr& key, const GpgOperationCallback&);

  /**
   * @brief
   *
   * @param key
   * @param tofu_policy
   * @return GpgFrontend::GpgError
   */
  auto ModifyTOFUPolicy(const GpgKeyPtr& key,
                        gpgme_tofu_policy_t tofu_policy) -> GpgError;
  /**
   * @brief
   *
   * @param params
   * @param result
   * @return GpgFrontend::GpgError
   */
  void GenerateKey(const QSharedPointer<KeyGenerateInfo>&,
                   const GpgOperationCallback&);

  /**
   * @brief
   *
   * @param params
   */
  auto GenerateKeySync(const QSharedPointer<KeyGenerateInfo>& params)
      -> std::tuple<GpgError, DataObjectPtr>;

  /**
   * @brief
   *
   * @param key
   * @param params
   * @return GpgFrontend::GpgError
   */
  void GenerateSubkey(const GpgKeyPtr& key,
                      const QSharedPointer<KeyGenerateInfo>& params,
                      const GpgOperationCallback&);

  /**
   * @brief
   *
   * @param key
   * @param params
   */
  auto GenerateSubkeySync(const GpgKeyPtr& key,
                          const QSharedPointer<KeyGenerateInfo>& params)
      -> std::tuple<GpgError, DataObjectPtr>;

  /**
   * @brief
   *
   * @param params
   * @param subkey_params
   * @param callback
   */
  void GenerateKeyWithSubkey(const QSharedPointer<KeyGenerateInfo>& p_params,
                             const QSharedPointer<KeyGenerateInfo>& s_params,
                             const GpgOperationCallback& callback);

  /**
   * @brief
   *
   * @param params
   * @param subkey_params
   * @param callback
   */
  auto GenerateKeyWithSubkeySync(
      const QSharedPointer<KeyGenerateInfo>& p_params,
      const QSharedPointer<KeyGenerateInfo>& s_params)
      -> std::tuple<GpgError, DataObjectPtr>;

  /**
   * @brief
   *
   * @param key
   * @param adsk
   */
  void AddADSK(const GpgKeyPtr& key, const GpgSubKey& adsk,
               const GpgOperationCallback&);

  /**
   * @brief
   *
   * @param key
   * @param adsk
   * @return GpgError
   */
  auto AddADSKSync(const GpgKeyPtr& key, const GpgSubKey& adsk)
      -> std::tuple<GpgError, DataObjectPtr>;

 private:
  GpgContext& ctx_ =
      GpgContext::GetInstance(SingletonFunctionObject::GetChannel());  ///<

  GpgKeyGetter& key_getter_ =
      GpgKeyGetter::GetInstance(SingletonFunctionObject::GetChannel());  ///<
};
}  // namespace GpgFrontend