• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • kdecore
  • auth
AuthBackend.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2008 Nicola Gigante <nicola.gigante@gmail.com>
3* Copyright (C) 2009-2010 Dario Freddi <drf@kde.org>
4*
5* This program is free software; you can redistribute it and/or modify
6* it under the terms of the GNU Lesser General Public License as published by
7* the Free Software Foundation; either version 2.1 of the License, or
8* (at your option) any later version.
9*
10* This program is distributed in the hope that it will be useful,
11* but WITHOUT ANY WARRANTY; without even the implied warranty of
12* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13* GNU General Public License for more details.
14*
15* You should have received a copy of the GNU Lesser General Public License
16* along with this program; if not, write to the
17* Free Software Foundation, Inc.,
18* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA .
19*/
20
21#ifndef AUTH_BACKEND_H
22#define AUTH_BACKEND_H
23
24#include <QObject>
25
26#include "kauthaction.h"
27
28namespace KAuth
29{
30
31class AuthBackend : public QObject
32{
33 Q_OBJECT
34 Q_DISABLE_COPY(AuthBackend)
35
36public:
37 enum Capability {
38 NoCapability = 0,
39 AuthorizeFromClientCapability = 1,
40 AuthorizeFromHelperCapability = 2,
41 CheckActionExistenceCapability = 4,
42 PreAuthActionCapability = 8
43 };
44 Q_DECLARE_FLAGS(Capabilities, Capability)
45
46 enum ExtraCallerIDVerificationMethod {
47 NoExtraCallerIDVerificationMethod,
48 VerifyAgainstDBusServiceName,
49 VerifyAgainstDBusServicePid,
50 };
51
52 AuthBackend();
53 virtual ~AuthBackend();
54 virtual void setupAction(const QString &action) = 0;
55 virtual void preAuthAction(const QString &action, QWidget *parent);
56 virtual Action::AuthStatus authorizeAction(const QString &action) = 0;
57 virtual Action::AuthStatus actionStatus(const QString &action) = 0;
58 virtual QByteArray callerID() const = 0;
59 virtual ExtraCallerIDVerificationMethod extraCallerIDVerificationMethod() const;
60 virtual bool isCallerAuthorized(const QString &action, QByteArray callerID) = 0;
61 virtual bool actionExists(const QString &action);
62
63 Capabilities capabilities() const;
64
65protected:
66 void setCapabilities(Capabilities capabilities);
67
68Q_SIGNALS:
69 void actionStatusChanged(const QString &action, Action::AuthStatus status);
70
71private:
72 class Private;
73 Private * const d;
74};
75
76} // namespace Auth
77
78Q_DECLARE_INTERFACE(KAuth::AuthBackend, "org.kde.auth.AuthBackend/0.1")
79Q_DECLARE_OPERATORS_FOR_FLAGS(KAuth::AuthBackend::Capabilities)
80
81#endif
KAuth::Action::AuthStatus
AuthStatus
The three values returned by authorization methods.
Definition: kauthaction.h:78
KAuth::AuthBackend
Definition: AuthBackend.h:32
KAuth::AuthBackend::setCapabilities
void setCapabilities(Capabilities capabilities)
Definition: AuthBackend.cpp:52
KAuth::AuthBackend::actionStatus
virtual Action::AuthStatus actionStatus(const QString &action)=0
KAuth::AuthBackend::authorizeAction
virtual Action::AuthStatus authorizeAction(const QString &action)=0
KAuth::AuthBackend::AuthBackend
AuthBackend()
Definition: AuthBackend.cpp:35
KAuth::AuthBackend::extraCallerIDVerificationMethod
virtual ExtraCallerIDVerificationMethod extraCallerIDVerificationMethod() const
Definition: AuthBackend.cpp:57
KAuth::AuthBackend::ExtraCallerIDVerificationMethod
ExtraCallerIDVerificationMethod
Definition: AuthBackend.h:46
KAuth::AuthBackend::VerifyAgainstDBusServiceName
@ VerifyAgainstDBusServiceName
Definition: AuthBackend.h:48
KAuth::AuthBackend::VerifyAgainstDBusServicePid
@ VerifyAgainstDBusServicePid
Definition: AuthBackend.h:49
KAuth::AuthBackend::NoExtraCallerIDVerificationMethod
@ NoExtraCallerIDVerificationMethod
Definition: AuthBackend.h:47
KAuth::AuthBackend::actionStatusChanged
void actionStatusChanged(const QString &action, Action::AuthStatus status)
KAuth::AuthBackend::callerID
virtual QByteArray callerID() const =0
KAuth::AuthBackend::~AuthBackend
virtual ~AuthBackend()
Definition: AuthBackend.cpp:42
KAuth::AuthBackend::preAuthAction
virtual void preAuthAction(const QString &action, QWidget *parent)
Definition: AuthBackend.cpp:68
KAuth::AuthBackend::isCallerAuthorized
virtual bool isCallerAuthorized(const QString &action, QByteArray callerID)=0
KAuth::AuthBackend::actionExists
virtual bool actionExists(const QString &action)
Definition: AuthBackend.cpp:62
KAuth::AuthBackend::capabilities
Capabilities capabilities() const
Definition: AuthBackend.cpp:47
KAuth::AuthBackend::setupAction
virtual void setupAction(const QString &action)=0
KAuth::AuthBackend::Capability
Capability
Definition: AuthBackend.h:37
KAuth::AuthBackend::NoCapability
@ NoCapability
Definition: AuthBackend.h:38
KAuth::AuthBackend::PreAuthActionCapability
@ PreAuthActionCapability
Definition: AuthBackend.h:42
KAuth::AuthBackend::AuthorizeFromHelperCapability
@ AuthorizeFromHelperCapability
Definition: AuthBackend.h:40
KAuth::AuthBackend::AuthorizeFromClientCapability
@ AuthorizeFromClientCapability
Definition: AuthBackend.h:39
KAuth::AuthBackend::CheckActionExistenceCapability
@ CheckActionExistenceCapability
Definition: AuthBackend.h:41
QObject
QString
kauthaction.h
KAuth
Definition: AuthBackend.cpp:24
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal