qt: Allow changing expiration date of primary key and all subkeys

* lang/qt/src/Makefile.am (qgpgme_sources): Add changeexpiryjob.cpp.
* lang/qt/src/changeexpiryjob.cpp: New.
* lang/qt/src/changeexpiryjob.h (enum ChangeExpiryJob::Option,
typedef ChangeExpiryJob::Options, ChangeExpiryJob::setOptions,
ChangeExpiryJob::options): New.
* lang/qt/src/qgpgmechangeexpiryjob.cpp (change_expiry): Update the
expiration date of primary key and/or some/all subkeys.
(QGpgMEChangeExpiryJob::start): Add options to call of change_expiry.
(ChangeExpiryJob::start): Moved implementation to changeexpiryjob.cpp.
--

Additionally, to the default behavior (update expiration of primary
key if no subkeys are specified resp. update expiration of specified
subkeys) it is now possible to update the expiration of the primary key
_and_ the specified/all subkeys.

GnuPG-bug-id: 4717
This commit is contained in:
Ingo Klöcker 2021-06-25 15:06:51 +02:00
parent 3503816570
commit 144d580607
4 changed files with 113 additions and 10 deletions

View File

@ -40,7 +40,7 @@ qgpgme_sources = \
qgpgmekeyformailboxjob.cpp qgpgme_debug.cpp \ qgpgmekeyformailboxjob.cpp qgpgme_debug.cpp \
qgpgmetofupolicyjob.cpp qgpgmequickjob.cpp \ qgpgmetofupolicyjob.cpp qgpgmequickjob.cpp \
defaultkeygenerationjob.cpp qgpgmewkspublishjob.cpp \ defaultkeygenerationjob.cpp qgpgmewkspublishjob.cpp \
qgpgmegpgcardjob.cpp \ qgpgmegpgcardjob.cpp changeexpiryjob.cpp \
dn.cpp cryptoconfig.cpp dn.cpp cryptoconfig.cpp
# If you add one here make sure that you also add one in camelcase # If you add one here make sure that you also add one in camelcase

View File

@ -0,0 +1,76 @@
/*
changeexpiryjob.cpp
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2021 g10 Code GmbH
Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
QGpgME 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 2 of the
License, or (at your option) any later version.
QGpgME 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "changeexpiryjob.h"
#include "job_p.h"
#include <context.h>
using namespace GpgME;
using namespace QGpgME;
namespace
{
struct ChangeExpiryJobPrivate : public JobPrivate
{
ChangeExpiryJobPrivate()
{
}
~ChangeExpiryJobPrivate() override = default;
ChangeExpiryJob::Options m_options = ChangeExpiryJob::Default;
};
}
void ChangeExpiryJob::setOptions(ChangeExpiryJob::Options options)
{
auto d = jobPrivate<ChangeExpiryJobPrivate>(this);
d->m_options = options;
}
ChangeExpiryJob::Options ChangeExpiryJob::options() const
{
auto d = jobPrivate<ChangeExpiryJobPrivate>(this);
return d->m_options;
}
/* For ABI compat not pure virtual. */
Error ChangeExpiryJob::start(const Key &, const QDateTime &, const std::vector<Subkey> &)
{
return {};
}

View File

@ -71,11 +71,22 @@ namespace QGpgME
class QGPGME_EXPORT ChangeExpiryJob : public Job class QGPGME_EXPORT ChangeExpiryJob : public Job
{ {
Q_OBJECT Q_OBJECT
public:
enum Option {
Default = 0x00,
UpdatePrimaryKey = 0x01,
UpdateAllSubkeys = 0x02,
};
Q_DECLARE_FLAGS(Options, Option)
protected: protected:
explicit ChangeExpiryJob(QObject *parent); explicit ChangeExpiryJob(QObject *parent);
public: public:
~ChangeExpiryJob(); ~ChangeExpiryJob();
void setOptions(Options options);
Options options() const;
/** /**
Starts the change-expiry operation. \a key is the key to change Starts the change-expiry operation. \a key is the key to change
the expiry of. \a expiry is the new expiry time. If \a expiry the expiry of. \a expiry is the new expiry time. If \a expiry
@ -97,6 +108,8 @@ Q_SIGNALS:
void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
}; };
Q_DECLARE_OPERATORS_FOR_FLAGS(ChangeExpiryJob::Options)
} }
#endif // __KLEO_CHANGEEXPIRYJOB_H__ #endif // __KLEO_CHANGEEXPIRYJOB_H__

View File

@ -5,6 +5,8 @@
Copyright (c) 2008 Klarälvdalens Datakonsult AB Copyright (c) 2008 Klarälvdalens Datakonsult AB
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
Software engineering by Intevation GmbH Software engineering by Intevation GmbH
Copyright (c) 2021 g10 Code GmbH
Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
QGpgME is free software; you can redistribute it and/or QGpgME is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as modify it under the terms of the GNU General Public License as
@ -55,14 +57,32 @@ QGpgMEChangeExpiryJob::QGpgMEChangeExpiryJob(Context *context)
QGpgMEChangeExpiryJob::~QGpgMEChangeExpiryJob() {} QGpgMEChangeExpiryJob::~QGpgMEChangeExpiryJob() {}
static QGpgMEChangeExpiryJob::result_type change_expiry(Context *ctx, const Key &key, const QDateTime &expiry, static QGpgMEChangeExpiryJob::result_type change_expiry(Context *ctx, const Key &key, const QDateTime &expiry,
const std::vector<Subkey> &subkeys) const std::vector<Subkey> &subkeys, ChangeExpiryJob::Options options)
{ {
// convert expiry to "seconds from now"; use 1 second from now if expiry is before the current datetime // convert expiry to "seconds from now"; use 1 second from now if expiry is before the current datetime
const unsigned long expires = expiry.isValid() const unsigned long expires = expiry.isValid()
? std::max<qint64>(QDateTime::currentDateTime().secsTo(expiry), 1) ? std::max<qint64>(QDateTime::currentDateTime().secsTo(expiry), 1)
: 0; : 0;
auto err = ctx->setExpire(key, expires, subkeys); // updating the expiration date of the primary key and the subkeys needs to be done in two steps
// because --quick-set-expire does not support updating the expiration date of both at the same time
if (subkeys.empty() || (options & ChangeExpiryJob::UpdatePrimaryKey)) {
// update the expiration date of the primary key
auto err = ctx->setExpire(key, expires);
if (err) {
return std::make_tuple(err, QString(), Error());
}
}
GpgME::Error err;
if (!subkeys.empty()) {
// update the expiration date of the specified subkeys
err = ctx->setExpire(key, expires, subkeys);
} else if (options & ChangeExpiryJob::UpdateAllSubkeys) {
// update the expiration date of all subkeys
err = ctx->setExpire(key, expires, {}, Context::SetExpireAllSubkeys);
}
return std::make_tuple(err, QString(), Error()); return std::make_tuple(err, QString(), Error());
} }
@ -73,13 +93,7 @@ Error QGpgMEChangeExpiryJob::start(const Key &key, const QDateTime &expiry)
Error QGpgMEChangeExpiryJob::start(const Key &key, const QDateTime &expiry, const std::vector<Subkey> &subkeys) Error QGpgMEChangeExpiryJob::start(const Key &key, const QDateTime &expiry, const std::vector<Subkey> &subkeys)
{ {
run(std::bind(&change_expiry, std::placeholders::_1, key, expiry, subkeys)); run(std::bind(&change_expiry, std::placeholders::_1, key, expiry, subkeys, options()));
return Error();
}
/* For ABI compat not pure virtual. */
Error ChangeExpiryJob::start(const Key &, const QDateTime &, const std::vector<Subkey> &)
{
return Error(); return Error();
} }