aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgKeyManager.h
blob: 986e835f72f46f80b8dd4e6a3e4bfbeb62494c51 (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
/**
 * 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/basic/GpgFunctionObject.h"
#include "core/function/gpg/GpgContext.h"
#include "core/typedef/GpgTypedef.h"

namespace GpgFrontend {

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

  /**
   * @brief Sign a key pair(actually a certain uid)
   * @param target target key pair
   * @param uid target
   * @param expires expire date and time of the signature
   * @return if successful
   */
  auto SignKey(const GpgKey& target, KeyArgsList& keys, const QString& uid,
               const std::unique_ptr<QDateTime>& expires) -> bool;

  /**
   * @brief
   *
   * @param key
   * @param signature_id
   * @return true
   * @return false
   */
  auto RevSign(const GpgFrontend::GpgKey& key,
               const GpgFrontend::SignIdArgsListPtr& signature_id) -> bool;

  /**
   * @brief Set the Expire object
   *
   * @param key
   * @param subkey
   * @param expires
   * @return true
   * @return false
   */
  auto SetExpire(const GpgKey& key, std::unique_ptr<GpgSubKey>& subkey,
                 std::unique_ptr<QDateTime>& expires) -> bool;

  /**
   * @brief
   *
   * @return
   */
  auto SetOwnerTrustLevel(const GpgKey& key, int trust_level) -> bool;

  /**
   * @brief
   *
   * @param key
   * @param subkey_index
   * @return true
   * @return false
   */
  auto DeleteSubkey(const GpgKey& key, int subkey_index) -> bool;

  /**
   * @brief
   *
   * @param key
   * @param subkey_index
   * @return true
   * @return false
   */
  auto RevokeSubkey(const GpgKey& key, int subkey_index, int reason_code,
                    const QString& reason_text) -> bool;

 private:
  static auto interactor_cb_fnc(void* handle, const char* status,
                                const char* args, int fd) -> gpgme_error_t;

  using Command = QString;
  using AutomatonState = enum {
    AS_START,
    AS_SELECT,
    AS_COMMAND,
    AS_VALUE,
    AS_REASON_CODE,
    AS_REASON_TEXT,
    AS_REALLY_ULTIMATE,
    AS_SAVE,
    AS_ERROR,
    AS_QUIT,
  };

  struct AutomatonHandelStruct;

  using AutomatonActionHandler =
      std::function<Command(AutomatonHandelStruct&, AutomatonState)>;
  using AutomatonNextStateHandler =
      std::function<AutomatonState(AutomatonState, QString, QString)>;

  struct AutomatonHandelStruct {
    void SetStatus(AutomatonState next_state) { current_state_ = next_state; }
    auto CurrentStatus() -> AutomatonState { return current_state_; }
    void SetHandler(AutomatonNextStateHandler next_state_handler,
                    AutomatonActionHandler action_handler) {
      next_state_handler_ = std::move(next_state_handler);
      action_handler_ = std::move(action_handler);
    }
    auto NextState(QString gpg_status, QString args) -> AutomatonState {
      return next_state_handler_(current_state_, std::move(gpg_status),
                                 std::move(args));
    }
    auto Action() -> Command { return action_handler_(*this, current_state_); }

    void SetSuccess(bool success) { success_ = success; }

    [[nodiscard]] auto Success() const -> bool { return success_; }

    auto KeyFpr() -> QString { return key_fpr_; }

    explicit AutomatonHandelStruct(QString key_fpr)
        : key_fpr_(std::move(key_fpr)) {}

   private:
    AutomatonState current_state_ = AS_START;
    AutomatonNextStateHandler next_state_handler_;
    AutomatonActionHandler action_handler_;
    bool success_ = false;
    QString key_fpr_;
  };

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

}  // namespace GpgFrontend