aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/function/gpg/GpgContext.h
blob: 57df610cbde9fa0f6bb70e1556e3d2e88e107581 (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
/**
 * 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 <gpgme.h>

#include "core/function/SecureMemoryAllocator.h"
#include "core/function/basic/GpgFunctionObject.h"

namespace GpgFrontend {

/**
 * @brief
 *
 */
struct GpgContextInitArgs {
  QString db_name;  ///<
  QString db_path;  ///<

  bool test_mode = false;                ///<
  bool offline_mode = false;             ///<
  bool auto_import_missing_key = false;  ///<

  bool use_pinentry = false;  ///<
};

enum class GpgComponentType { kGPG_AGENT, kDIRMNGR, kKEYBOXD, kGPG_AGENT_SSH };

/**
 * @brief
 *
 */
class GPGFRONTEND_CORE_EXPORT GpgContext
    : public SingletonFunctionObject<GpgContext> {
 public:
  explicit GpgContext(int channel);

  explicit GpgContext(GpgContextInitArgs args, int channel);

  ~GpgContext();

  /**
   * @brief
   *
   * @return true
   * @return false
   */
  [[nodiscard]] auto Good() const -> bool;

  /**
   * @brief
   *
   * @return gpgme_ctx_t
   */
  auto BinaryContext() -> gpgme_ctx_t;

  /**
   * @brief
   *
   * @return gpgme_ctx_t
   */
  auto DefaultContext() -> gpgme_ctx_t;

  /**
   * @brief
   *
   * @return QString
   */
  [[nodiscard]] auto KeyDBName() const -> QString;

  /**
   * @brief
   *
   * @return QString
   */
  [[nodiscard]] auto HomeDirectory() const -> QString;

  /**
   * @brief
   *
   * @return QString
   */
  [[nodiscard]] auto ComponentDirectory(GpgComponentType) const -> QString;

  /**
   * @brief
   *
   * @return true
   * @return false
   */
  auto RestartGpgAgent() -> bool;

 private:
  class Impl;
  SecureUniquePtr<Impl> p_;
};
}  // namespace GpgFrontend