aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgAutomatonHandler.cpp
blob: 656bb0182f67972e9b6f0fca808a6d8605a8e3ff (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
/**
 * 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
 *
 */

#include "GpgAutomatonHandler.h"

#include "core/model/GpgData.h"
#include "core/model/GpgKey.h"
#include "core/utils/GpgUtils.h"

namespace GpgFrontend {

GpgAutomatonHandler::GpgAutomatonHandler(int channel)
    : SingletonFunctionObject<GpgAutomatonHandler>(channel) {}

auto InteratorCbFunc(void* handle, const char* status, const char* args,
                     int fd) -> gpgme_error_t {
  auto* handle_struct = static_cast<AutomatonHandelStruct*>(handle);
  QString status_s = status;
  QString args_s = args;

  if (status_s == "KEY_CONSIDERED") {
    auto tokens = QString(args).split(' ');

    if (handle_struct->KeyFpr().isEmpty()) return 0;

    if (tokens.empty() || tokens[0] != handle_struct->KeyFpr()) {
      LOG_W() << "handle struct key fpr: " << handle_struct->KeyFpr()
              << "mismatch token: " << tokens[0] << ", exit...";

      return -1;
    }

    return 0;
  }

  if (status_s == "CARDCTRL") {
    auto tokens = QString(args).split(' ');

    if (handle_struct->SerialNumber().isEmpty()) return 0;

    if (tokens.empty() || tokens[0] != handle_struct->SerialNumber()) {
      LOG_W() << "handle struct serial number: "
              << handle_struct->SerialNumber()
              << "mismatch token: " << tokens[0] << ", exit...";

      return -1;
    }

    return 0;
  }

  if (status_s == "GOT_IT" || status_s.isEmpty()) {
    FLOG_D("gpg reply is GOT_IT, continue...");
    return 0;
  }

  LOG_D() << "current state" << handle_struct->CurrentStatus()
          << "gpg status: " << status_s << ", args: " << args_s;

  handle_struct->SetPromptStatus(status_s, args_s);

  AutomatonState next_state = handle_struct->NextState(status_s, args_s);
  if (next_state == GpgAutomatonHandler::kAS_ERROR) {
    FLOG_D("handle struct next state caught error, abort...");
    return -1;
  }
  LOG_D() << "next state" << next_state;

  if (next_state == GpgAutomatonHandler::kAS_SAVE) {
    handle_struct->SetSuccess(true);
  }

  // set state and preform action
  handle_struct->SetStatus(next_state);
  GpgAutomatonHandler::Command cmd = handle_struct->Action();

  LOG_D() << "next action, cmd:" << cmd;

  if (!cmd.isEmpty()) {
    auto btye_array = cmd.toUtf8();
    gpgme_io_write(fd, btye_array, btye_array.size());
    gpgme_io_write(fd, "\n", 1);
  } else if (status_s.startsWith("GET_")) {
    // avoid trapping in this state
    return GPG_ERR_FALSE;
  }

  return 0;
}

auto DoInteractImpl(GpgContext& ctx_, const GpgKeyPtr& key, bool card_edit,
                    const QString& id,
                    AutomatonNextStateHandler next_state_handler,
                    AutomatonActionHandler action_handler, int flags) -> bool {
  gpgme_key_t p_key = key == nullptr ? nullptr : static_cast<gpgme_key_t>(*key);

  AutomatonHandelStruct handel_struct(card_edit, id);
  handel_struct.SetHandler(std::move(next_state_handler),
                           std::move(action_handler));

  GpgData data_out;

  auto err =
      gpgme_op_interact(ctx_.DefaultContext(), p_key, flags, InteratorCbFunc,
                        static_cast<void*>(&handel_struct), data_out);
  return CheckGpgError(err) == GPG_ERR_NO_ERROR && handel_struct.Success();
}

auto GpgAutomatonHandler::DoInteract(
    const GpgKeyPtr& key, AutomatonNextStateHandler next_state_handler,
    AutomatonActionHandler action_handler, int flags) -> bool {
  assert(key != nullptr);
  if (key == nullptr) return false;
  return DoInteractImpl(ctx_, key, false, key->ID(),
                        std::move(next_state_handler),
                        std::move(action_handler), flags);
}

auto GpgAutomatonHandler::DoCardInteract(
    const QString& serial_number, AutomatonNextStateHandler next_state_handler,
    AutomatonActionHandler action_handler) -> bool {
  return DoInteractImpl(ctx_, nullptr, true, serial_number,
                        std::move(next_state_handler),
                        std::move(action_handler), GPGME_INTERACT_CARD);
}

auto GpgAutomatonHandler::AutomatonHandelStruct::NextState(
    QString gpg_status, QString args) -> AutomatonState {
  return next_state_handler_(current_state_, std::move(gpg_status),
                             std::move(args));
}

void GpgAutomatonHandler::AutomatonHandelStruct::SetHandler(
    AutomatonNextStateHandler next_state_handler,
    AutomatonActionHandler action_handler) {
  next_state_handler_ = std::move(next_state_handler);
  action_handler_ = std::move(action_handler);
}

auto GpgAutomatonHandler::AutomatonHandelStruct::CurrentStatus() const
    -> AutomatonState {
  return current_state_;
}

void GpgAutomatonHandler::AutomatonHandelStruct::SetStatus(
    AutomatonState next_state) {
  current_state_ = next_state;
}

auto GpgAutomatonHandler::AutomatonHandelStruct::Action() -> Command {
  return action_handler_(*this, current_state_);
}

void GpgAutomatonHandler::AutomatonHandelStruct::SetSuccess(bool success) {
  success_ = success;
}

auto GpgAutomatonHandler::AutomatonHandelStruct::Success() const -> bool {
  return success_;
}
auto GpgAutomatonHandler::AutomatonHandelStruct::KeyFpr() const -> QString {
  return card_edit_ ? "" : id_;
}

GpgAutomatonHandler::AutomatonHandelStruct::AutomatonHandelStruct(
    bool card_edit, QString id)
    : card_edit_(card_edit), id_(std::move(id)) {}

auto GpgAutomatonHandler::AutomatonHandelStruct::PromptStatus() const
    -> std::tuple<QString, QString> {
  return {prompt_status_, prompt_args_};
}

void GpgAutomatonHandler::AutomatonHandelStruct::SetPromptStatus(QString status,
                                                                 QString args) {
  prompt_status_ = std::move(status);
  prompt_args_ = std::move(args);
}

auto GpgAutomatonHandler::AutomatonHandelStruct::SerialNumber() const
    -> QString {
  return card_edit_ ? id_ : "";
}
}  // namespace GpgFrontend