GpgFrontend Project
A Free, Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP(pgp) Crypto Tool.
GpgFrontend::GpgKeyManager Class Reference
Inheritance diagram for GpgFrontend::GpgKeyManager:
Inheritance graph
Collaboration diagram for GpgFrontend::GpgKeyManager:
Collaboration graph

Classes

struct  AutomatonHandelStruct
 

Public Member Functions

 GpgKeyManager (int channel=SingletonFunctionObject::GetDefaultChannel())
 Construct a new Gpg Key Manager object. More...
 
auto SignKey (const GpgKey &target, KeyArgsList &keys, const QString &uid, const std::unique_ptr< QDateTime > &expires) -> bool
 Sign a key pair(actually a certain uid) More...
 
auto RevSign (const GpgFrontend::GpgKey &key, const GpgFrontend::SignIdArgsListPtr &signature_id) -> bool
 
auto SetExpire (const GpgKey &key, std::unique_ptr< GpgSubKey > &subkey, std::unique_ptr< QDateTime > &expires) -> bool
 Set the Expire object. More...
 
auto SetOwnerTrustLevel (const GpgKey &key, int trust_level) -> bool
 
- Public Member Functions inherited from GpgFrontend::SingletonFunctionObject< GpgKeyManager >
 SingletonFunctionObject (const SingletonFunctionObject< GpgKeyManager > &)=delete
 prohibit copy
 
 SingletonFunctionObject (GpgKeyManager &&)=delete
 Construct a new Singleton Function Object object.
 
 SingletonFunctionObject (const GpgKeyManager &)=delete
 Construct a new Singleton Function Object object.
 
auto operator= (const SingletonFunctionObject< GpgKeyManager > &) -> SingletonFunctionObject &=delete
 prohibit copy More...
 
void operator= (const GpgKeyManager &)=delete
 
auto GetChannel () const -> int
 Get the Channel object. More...
 
- Public Member Functions inherited from GpgFrontend::ChannelObject
 ChannelObject () noexcept
 Construct a new Default Channel Object object.
 
virtual ~ChannelObject () noexcept
 Destroy the Channel Object object.
 
 ChannelObject (int channel, QString type)
 Construct a new Channel Object object. More...
 
auto GetChannel () const -> int
 Get the Channel object. More...
 
void SetChannel (int channel)
 Set the Channel object. More...
 

Private Types

using Command = QString
 
using AutomatonState = enum { AS_START, AS_COMMAND, AS_VALUE, AS_REALLY_ULTIMATE, AS_SAVE, AS_ERROR, AS_QUIT, }
 
using AutomatonActionHandler = std::function< Command(AutomatonHandelStruct &, AutomatonState)>
 
using AutomatonNextStateHandler = std::function< AutomatonState(AutomatonState, QString, QString)>
 

Static Private Member Functions

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

Private Attributes

GpgContextctx_
 

Additional Inherited Members

- Static Public Member Functions inherited from GpgFrontend::SingletonFunctionObject< GpgKeyManager >
static auto GetInstance (int channel=GpgFrontend::kGpgFrontendDefaultChannel) -> GpgKeyManager &
 Get the Instance object. More...
 
static auto CreateInstance (int channel, const std::function< ChannelObjectPtr(void)> &factory) -> GpgKeyManager &
 Create a Instance object. More...
 
static void ReleaseChannel (int channel)
 
static auto GetDefaultChannel () -> int
 Get the Default Channel object. More...
 
static auto GetAllChannelId () -> std::vector< int >
 Get all the channel ids. More...
 
- Static Public Member Functions inherited from GpgFrontend::ChannelObject
static auto GetDefaultChannel () -> int
 Get the Default Channel object. More...
 
- Protected Member Functions inherited from GpgFrontend::SingletonFunctionObject< GpgKeyManager >
 SingletonFunctionObject ()=default
 Construct a new Singleton Function Object object.
 
 SingletonFunctionObject (int channel)
 Construct a new Singleton Function Object object. More...
 
virtual ~SingletonFunctionObject ()=default
 Destroy the Singleton Function Object object.
 

Constructor & Destructor Documentation

◆ GpgKeyManager()

GpgFrontend::GpgKeyManager::GpgKeyManager ( int  channel = SingletonFunctionObject::GetDefaultChannel())
explicit

Construct a new Gpg Key Manager object.

Parameters
channelCopyright (C) 2021 Saturneric eric@.nosp@m.bktu.nosp@m.s.com

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 eric@.nosp@m.bktu.nosp@m.s.com starting on May 12, 2021.

SPDX-License-Identifier: GPL-3.0-or-later

Member Function Documentation

◆ RevSign()

auto GpgFrontend::GpgKeyManager::RevSign ( const GpgFrontend::GpgKey key,
const GpgFrontend::SignIdArgsListPtr &  signature_id 
) -> bool
Parameters
key
signature_id
Returns
true
false

References GpgFrontend::CheckGpgError(), and GpgFrontend::SingletonFunctionObject< GpgKeyGetter >::GetInstance().

◆ SetExpire()

auto GpgFrontend::GpgKeyManager::SetExpire ( const GpgKey key,
std::unique_ptr< GpgSubKey > &  subkey,
std::unique_ptr< QDateTime > &  expires 
) -> bool

Set the Expire object.

Parameters
key
subkey
expires
Returns
true
false

References GpgFrontend::CheckGpgError().

◆ SetOwnerTrustLevel()

auto GpgFrontend::GpgKeyManager::SetOwnerTrustLevel ( const GpgKey key,
int  trust_level 
) -> bool
Returns

References GpgFrontend::CheckGpgError().

◆ SignKey()

auto GpgFrontend::GpgKeyManager::SignKey ( const GpgKey target,
GpgFrontend::KeyArgsList &  keys,
const QString &  uid,
const std::unique_ptr< QDateTime > &  expires 
) -> bool

Sign a key pair(actually a certain uid)

Parameters
targettarget key pair
uidtarget
expiresexpire date and time of the signature
Returns
if successful

References GpgFrontend::CheckGpgError(), and GpgFrontend::SingletonFunctionObject< GpgBasicOperator >::GetInstance().

Member Data Documentation

◆ ctx_

GpgContext& GpgFrontend::GpgKeyManager::ctx_
private
Initial value:
=
auto GetChannel() const -> int
Get the Channel object.
Definition: GpgFunctionObject.h:140
static auto GetInstance(int channel=GpgFrontend::kGpgFrontendDefaultChannel) -> GpgContext &
Get the Instance object.
Definition: GpgFunctionObject.h:80

The documentation for this class was generated from the following files: