2011-04-29 15:18:35 +02:00
|
|
|
/*
|
|
|
|
* Copyright (C) 2010 by Diego '[Po]lentino' Casella <polentino911@gmail.com>
|
|
|
|
*
|
|
|
|
* This program 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.
|
|
|
|
*
|
|
|
|
* This program 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.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef AUTHENTICATION_H
|
|
|
|
#define AUTHENTICATION_H
|
|
|
|
|
|
|
|
#include <plasma/plasma_export.h>
|
|
|
|
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
#include <QtCore/QDateTime>
|
|
|
|
|
|
|
|
#include <kurl.h>
|
|
|
|
|
|
|
|
#include <plasma.h>
|
|
|
|
|
|
|
|
class QStringList;
|
|
|
|
class QString;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Global namespace for Signing library
|
|
|
|
*/
|
|
|
|
namespace Plasma
|
|
|
|
{
|
|
|
|
|
2011-05-26 16:02:56 +02:00
|
|
|
class Package;
|
2011-04-29 15:18:35 +02:00
|
|
|
class SigningPrivate;
|
|
|
|
|
|
|
|
/**
|
2011-05-24 12:05:06 +02:00
|
|
|
* A class to manage authentication based on cryptographic signatures.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
2011-05-24 12:40:38 +02:00
|
|
|
* The Signing class is used to get the trust level of a set of files, or package, such
|
|
|
|
* as a scripted plasmoid by performing a check between the signature shipped with it,
|
|
|
|
* and the PGP keys found in the user keystore.
|
|
|
|
*
|
|
|
|
* If the keystore is empty, this class will take charge of populating it with the
|
|
|
|
* pre-shipped keys.
|
|
|
|
*
|
2011-04-29 15:18:35 +02:00
|
|
|
* It also performs handy operations, such as populating the local keystore with the keys shipped
|
|
|
|
* by default with KDE/linux distro, and notify the application which is using it about changes on the
|
|
|
|
* local keystore or in the keys folder.
|
|
|
|
*
|
|
|
|
* Example of usage:
|
|
|
|
* @code
|
|
|
|
*
|
|
|
|
* Plasma::Signing *m_auth = new Plasma::Signing(); // the constructor takes care of loading and spltting the keys
|
|
|
|
* // loaded by the default keystore.
|
|
|
|
*
|
|
|
|
* // If you want to specify a different keystore, simply put its relative path as argument:
|
|
|
|
* Plasma::Signing *m_auth = new Plasma::Signing(keystoreFullPath);
|
|
|
|
*
|
|
|
|
* // Now, supposed to previously saved in plasmoidPath and signaturePath the paths of the plasmoid and signature to check; then
|
|
|
|
* QString signer = m_auth->signerOf(plasmoidPath, signaturePath); // Returns the the hash of the signer key, if the file and
|
|
|
|
* // the signature have been successfully verified
|
|
|
|
*
|
|
|
|
* // If the signature is in the same folder of the file, you can also omit its path; the library will automatically load the
|
|
|
|
* // signature named plasmoidPath plus the ".asc" file extension.
|
|
|
|
* QString signer = m_auth->signerOf(plasmoidPath);
|
|
|
|
*
|
|
|
|
* // If you need to know the authentication level associated with a specific signer, simply call:
|
|
|
|
* Plasma::TrustLevel level = m_auth->trustLevelOf(signer)
|
|
|
|
*
|
|
|
|
* // If you need more details about a key with a given keyID, you have to call:
|
|
|
|
* QString info = m_auth->descriptiveString(keyID);
|
|
|
|
*
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* @author Diego '[Po]lentino' Casella <polentino911@gmail.com>
|
|
|
|
*/
|
|
|
|
class PLASMA_EXPORT Signing : public QObject
|
|
|
|
{
|
|
|
|
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
* Default constructor.
|
|
|
|
* It takes charge of loading the KDE keys, splitting the keys found in the default keystore (or in the one
|
|
|
|
* specified by @param keystorePath).
|
|
|
|
*
|
|
|
|
* @param keystorePath a default QString that denotes the full path of the keystore being used for the authentication
|
|
|
|
* process. Note that once selected, you can't change it.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
Signing(const QString &keystorePath = 0);
|
|
|
|
~Signing();
|
|
|
|
|
|
|
|
/**
|
2011-05-26 13:19:41 +02:00
|
|
|
* Returns a list of all the key IDs processed by this Signing object that match the
|
|
|
|
* requested TrustLevel.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
|
|
|
* @param trustLevel the TrustLevel we want to
|
|
|
|
* @return the QStringList with all the ID of the matching keys, or an empty one otherwise
|
|
|
|
*/
|
|
|
|
QStringList keysByTrustLevel(TrustLevel trustLevel) const;
|
|
|
|
|
|
|
|
/**
|
2011-05-26 13:19:41 +02:00
|
|
|
* Return the TrustLevel associated with the key passed as parameter to the function.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
|
|
|
* @param keyID the key we want to retrieve its trust level
|
|
|
|
* @return the TrustLevel value
|
|
|
|
*/
|
|
|
|
TrustLevel trustLevelOf(const QString &keyID) const;
|
|
|
|
|
2011-05-26 16:02:56 +02:00
|
|
|
/**
|
|
|
|
* Tests for a successful match between the object and signature files, referenced by their
|
|
|
|
* absolute path. The signature path is optional and, if not specified, the function will
|
|
|
|
* automatically try to retrieve it by appending the string ".sig" to the package path.
|
|
|
|
*
|
|
|
|
* @param package a Plasma::Package object representing the package to be tested
|
|
|
|
*
|
|
|
|
* @return The signer's unique key id, or an empty string if a signer was not found.
|
|
|
|
* Failure can be due to the signature not matching or the signature file missing.
|
|
|
|
* On success, this information can then be used with trustLevelOf and/or
|
|
|
|
* descriptiveString to get more information on the key.
|
|
|
|
*/
|
|
|
|
QString signerOf(const Package &package) const;
|
|
|
|
|
2011-04-29 15:18:35 +02:00
|
|
|
/**
|
2011-05-24 12:40:38 +02:00
|
|
|
* Tests for a successful match between the object and signature files, referenced by their
|
2011-04-29 15:18:35 +02:00
|
|
|
* absolute path. The signature path is optional and, if not specified, the function will
|
2011-05-26 15:12:56 +02:00
|
|
|
* automatically try to retrieve it by appending the string ".sig" to the package path.
|
|
|
|
*
|
|
|
|
* The signature should be a "detached signature" for correct results.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
2011-05-26 13:37:44 +02:00
|
|
|
* @arg package the full path of the package we want to test
|
|
|
|
* @arg signature optional path for the signature file
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
2011-05-26 13:19:41 +02:00
|
|
|
* @return The signer's unique key id, or an empty string if a signer was not found.
|
|
|
|
* Failure can be due to the signature not matching or the signature file missing.
|
2011-05-26 16:02:56 +02:00
|
|
|
* On success, this information can then be used with trustLevelOf and/or
|
2011-05-26 13:19:41 +02:00
|
|
|
* descriptiveString to get more information on the key.
|
2011-04-29 15:18:35 +02:00
|
|
|
*/
|
2012-03-11 10:28:36 +01:00
|
|
|
QString signerOf(const QUrl &package, const QUrl &signature = QUrl()) const ;
|
2011-04-29 15:18:35 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return the QString path of the keystore being used.
|
|
|
|
*/
|
|
|
|
QString keyStorePath() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Method used to retrieve additional informations about the key passed as parameter to the function.
|
|
|
|
*
|
|
|
|
* @arg keyID the string containing the hash of the key we want to retrive the informations.
|
|
|
|
*
|
|
|
|
* @return a QString object containing the name, the email and the comment (if any) referenced by the
|
|
|
|
* id passed as argument to the function.
|
|
|
|
*/
|
|
|
|
QString descriptiveString(const QString &keyID) const;
|
|
|
|
|
|
|
|
Q_SIGNALS:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Emitted when a new key is added from the trusted keys folder. Applications should connect
|
2011-05-24 12:05:06 +02:00
|
|
|
* to this signal in order to update the trust level of the associated signed objects.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
|
|
|
* @param keyId the key added
|
|
|
|
*/
|
|
|
|
void keyAdded(const QString &keyId);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Emitted when a new key is removed from the trusted keys folder. Applications should connect
|
2011-05-24 12:05:06 +02:00
|
|
|
* to this signal in order to update the trust level of the associated signed objects.
|
2011-04-29 15:18:35 +02:00
|
|
|
*
|
|
|
|
* @param keyID the key removed
|
|
|
|
*/
|
|
|
|
void keyRemoved(const QString &keyId);
|
|
|
|
|
|
|
|
private:
|
2011-05-24 11:52:11 +02:00
|
|
|
Q_PRIVATE_SLOT(d, void processKeystore(const QString &path));
|
|
|
|
Q_PRIVATE_SLOT(d, void keyAdded(const QString &path));
|
|
|
|
Q_PRIVATE_SLOT(d, void keyRemoved(const QString &path));
|
2011-04-29 15:18:35 +02:00
|
|
|
SigningPrivate * const d;
|
|
|
|
friend class SigningPrivate;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // end Plasma namespace
|
|
|
|
|
|
|
|
#endif // AUTHENTICATION_H
|