plasma-framework/authorizationmanager.h

/*
 * Copyright 2009 by Rob Scheepmaker <r.scheepmaker@student.utwente.nl>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

#ifndef PLASMA_AUTHORIZATIONMANAGER_H
#define PLASMA_AUTHORIZATIONMANAGER_H

#include "plasma_export.h"

#include <QtCore/QObject>

class QString;
class KUrl;

namespace Plasma
{

class AuthorizationInterface;
class AuthorizationManagerPrivate;
class ServiceAccessJob;
class ServiceJob;

/**
 * @class AuthorizationManager plasma/authorizationmanager.h <Plasma/AccessManager>
 *
 * @short Allows authorization of access to plasma services.
 *
 * This is the class where every message to or from another machine passes through. 
 * It's responsibilities are:
 * - creating/keeping a public/private key pair for message signing.
 * - signing and verifying signatures.
 * - testing whether or not the sender is allowed to access the requested resource by testing the
 *   request to a set of rules.
 * - allowing the shell the shell to respond to a remote request that doesn't match any of the 
 *   rules that are in effect.
 * Besides internal use in libplasma, the only moment you'll need to access this class is when you
 * implement a plasma shell. 
 *
 * @since 4.4?
 */
class PLASMA_EXPORT AuthorizationManager : public QObject
{
    Q_OBJECT
    public:
        enum AuthorizationPolicy {
            DenyAll= 0,  /** < Don't allow any incoming connections */
            TrustedOnly= 1, /**< Standard PIN pairing for untrusted connections */
            PinPairing= 2, /** < Only allow connections from trusted machines */
            Custom= 256 /** < Specify a custom AuthorizationInterface */
        };

        /**
         * Singleton pattern accessor.
         */
        static AuthorizationManager *self();

        /**
         * Set a policy used for authorizing incoming connections. You can either use one of the
         * included policies, Default is to deny all incoming connections.
         */
        void setAuthorizationPolicy(AuthorizationPolicy policy);

        /**
         * Register an implementation of AuthorizationInterface. Use this to make your shell
         * handle authorization requests.
         */
        void setAuthorizationInterface(AuthorizationInterface *interface);

    Q_SIGNALS:
        /**
         * fires when the AuthorizationManager is ready for accesssing remote plasmoids, meaning the
         * private key has been unlocked by the user.
         */
        void readyForRemoteAccess();

    private:
        AuthorizationManager();
        ~AuthorizationManager();

        AuthorizationManagerPrivate *const d;

        Q_PRIVATE_SLOT(d, void loadRules())
        Q_PRIVATE_SLOT(d, void slotWalletOpened())

        friend class AuthorizationManagerPrivate;
        friend class AuthorizationManagerSingleton;
        friend class AuthorizationRule;
        friend class Applet;
        friend class DataEngine;
        friend class GetSource;
        friend class Credentials;
        friend class PackagePrivate;
        friend class PlasmoidServiceJob;
        friend class RemoteService;
        friend class RemoteServiceJob;
        friend class ServiceProvider;
};
} // Plasma namespace

#endif