|
Packit |
d7e8d0 |
/*
|
|
Packit |
d7e8d0 |
signkeyjob.h
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
This file is part of qgpgme, the Qt API binding for gpgme
|
|
Packit |
d7e8d0 |
Copyright (c) 2008 Klarälvdalens Datakonsult AB
|
|
Packit |
d7e8d0 |
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
|
|
Packit |
d7e8d0 |
Software engineering by Intevation GmbH
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
QGpgME is free software; you can redistribute it and/or
|
|
Packit |
d7e8d0 |
modify it under the terms of the GNU General Public License as
|
|
Packit |
d7e8d0 |
published by the Free Software Foundation; either version 2 of the
|
|
Packit |
d7e8d0 |
License, or (at your option) any later version.
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
QGpgME is distributed in the hope that it will be useful,
|
|
Packit |
d7e8d0 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
d7e8d0 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit |
d7e8d0 |
General Public License for more details.
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
You should have received a copy of the GNU General Public License
|
|
Packit |
d7e8d0 |
along with this program; if not, write to the Free Software
|
|
Packit |
d7e8d0 |
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
In addition, as a special exception, the copyright holders give
|
|
Packit |
d7e8d0 |
permission to link the code of this program with any edition of
|
|
Packit |
d7e8d0 |
the Qt library by Trolltech AS, Norway (or with modified versions
|
|
Packit |
d7e8d0 |
of Qt that use the same license as Qt), and distribute linked
|
|
Packit |
d7e8d0 |
combinations including the two. You must obey the GNU General
|
|
Packit |
d7e8d0 |
Public License in all respects for all of the code used other than
|
|
Packit |
d7e8d0 |
Qt. If you modify this file, you may extend this exception to
|
|
Packit |
d7e8d0 |
your version of the file, but you are not obligated to do so. If
|
|
Packit |
d7e8d0 |
you do not wish to do so, delete this exception statement from
|
|
Packit |
d7e8d0 |
your version.
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
#ifndef __KLEO_SIGNKEYJOB_H__
|
|
Packit |
d7e8d0 |
#define __KLEO_SIGNKEYJOB_H__
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
#include "job.h"
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
#include <vector>
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
namespace GpgME
|
|
Packit |
d7e8d0 |
{
|
|
Packit |
d7e8d0 |
class Error;
|
|
Packit |
d7e8d0 |
class Key;
|
|
Packit |
d7e8d0 |
}
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
namespace QGpgME
|
|
Packit |
d7e8d0 |
{
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
@short An abstract base class to sign keys asynchronously
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
To use a SignKeyJob, first obtain an instance from the
|
|
Packit |
d7e8d0 |
CryptoBackend implementation, connect the progress() and result()
|
|
Packit |
d7e8d0 |
signals to suitable slots and then start the job with a call
|
|
Packit |
d7e8d0 |
to start(). This call might fail, in which case the ChangeExpiryJob
|
|
Packit |
d7e8d0 |
instance will have scheduled it's own destruction with a call to
|
|
Packit |
d7e8d0 |
QObject::deleteLater().
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
After result() is emitted, the SignKeyJob will schedule it's own
|
|
Packit |
d7e8d0 |
destruction by calling QObject::deleteLater().
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
class QGPGME_EXPORT SignKeyJob : public Job
|
|
Packit |
d7e8d0 |
{
|
|
Packit |
d7e8d0 |
Q_OBJECT
|
|
Packit |
d7e8d0 |
protected:
|
|
Packit |
d7e8d0 |
explicit SignKeyJob(QObject *parent);
|
|
Packit |
d7e8d0 |
public:
|
|
Packit |
d7e8d0 |
~SignKeyJob();
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
Starts the key signing operation. \a key is the key to sign.
|
|
Packit |
d7e8d0 |
@param keyToSign the key to be signed
|
|
Packit |
d7e8d0 |
@param idsToSign the user IDs to sign
|
|
Packit |
d7e8d0 |
@param signingKey the secret key to use for signing
|
|
Packit |
d7e8d0 |
@param option the signing mode, either local or exportable
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual GpgME::Error start(const GpgME::Key &keyToSign) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
* If explicitly specified, only the listed user IDs will be signed. Otherwise all user IDs
|
|
Packit |
d7e8d0 |
* are signed.
|
|
Packit |
d7e8d0 |
* @param list of user ID indexes (of the key to be signed).
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual void setUserIDsToSign(const std::vector<unsigned int> &idsToSign) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
* sets the check level
|
|
Packit |
d7e8d0 |
* @param the check level, ranges from 0 (no claim) and 3 (extensively checked),
|
|
Packit |
d7e8d0 |
* default is 0
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual void setCheckLevel(unsigned int checkLevel) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
* sets whether the signature should be exportable, or local only.
|
|
Packit |
d7e8d0 |
* default is local.
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual void setExportable(bool exportable) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
* sets an alternate signing key
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual void setSigningKey(const GpgME::Key &key) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
/**
|
|
Packit |
d7e8d0 |
* if set, the created signature won't be revocable. By default signatures
|
|
Packit |
d7e8d0 |
* can be revoked.
|
|
Packit |
d7e8d0 |
*/
|
|
Packit |
d7e8d0 |
virtual void setNonRevocable(bool nonRevocable) = 0;
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
Q_SIGNALS:
|
|
Packit |
d7e8d0 |
void result(const GpgME::Error &result, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
|
|
Packit |
d7e8d0 |
};
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
}
|
|
Packit |
d7e8d0 |
|
|
Packit |
d7e8d0 |
#endif // __KLEO_SIGNKEYJOB_H__
|