Differential D21564 Diff 59957 src/util/externalcommand_authagent.h

Changeset View

Standalone View

src/util/externalcommand_authagent.h

This file was added.

1		/*************************************************************************
2		* Copyright (C) 2019 by Shubham <shubham.jangra@kdemail.net> *
3		* *
4		* This program is free software; you can redistribute it and/or *
5		* modify it under the terms of the GNU General Public License as *
6		* published by the Free Software Foundation; either version 3 of *
7		* the License, or (at your option) any later version. *
8		* *
9		* This program is distributed in the hope that it will be useful, *
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of *
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12		* GNU General Public License for more details. *
13		* *
14		* You should have received a copy of the GNU General Public License *
15		* along with this program. If not, see <http://www.gnu.org/licenses/>.*
16		*************************************************************************/
17
18		#ifndef EXTERNALCOMMAND_AUTHAGENT_H
19		#define EXTERNALCOMMAND_AUTHAGENT_H
20
21		#include <PolkitQt1/Agent/Listener>
22		#include <PolkitQt1/Agent/Session>
23		#include <PolkitQt1/Authority>
24		#include <PolkitQt1/Details>
	stikonasUnsubmitted Done #include <PolkitQt1/Agent/Listener> stikonas: #include <PolkitQt1/Agent/Listener>
25		#include <PolkitQt1/Identity>
26
27		using namespace PolkitQt1;
28
29		/** An Authentication agent/listener class.
30
31		This class implements the Listener class
32		of PolkitQt1. It is used to spawn a fresh
33		authentication agent which can be used to
34		authenticate privileged actions.
35
36		@author Shubham <shubham.jangra@kdemail.net>
37		*/
38		class Listener : public Agent::Listener
39		{
40		Q_OBJECT
41		Q_DISABLE_COPY(Listener)
42		public:
43		/**
44		* \brief Constructor of Listener class
45		*/
46		Listener(QObject *parent = nullptr);
47
48		/**
49		* \brief Destructor of Listener class
50		*/
51		~Listener() override;
52
53		public Q_SLOTS:
54		/**
55		* \brief Registers an Authentication agent.
56		*
57		* \param subject caller subject
58		* \param locale the locale of the authentication agent
59		* \param objectPath the object path for the authentication agent
60		*
61		* \return \c true if the Authentication agent has been successfully registered
62		* \c false if the Authentication agent registration failed
63		*/
64		bool registerListener(const Subject &subject, const QString &locale, const QString &objectPath);
65
66		/**
67		* Unregisters an Authentication agent.
68		*
69		* \param subject caller subject
70		* \param objectPath the object path for the Authentication agent
71		*
72		* \return \c true if the Authentication agent has been successfully unregistered
73		* \c false if the Authentication agent unregistration failed
74		*/
75		bool unregisterListener(const Subject &subject, const QString &objectPath);
76
77		/**
78		* \brief Initiate authentication for the action
79		*
80		* This method will be called on a registered authentication agent when the user owning
81		* the session needs to prove they are one of the identities listed in \p identities.
82		*
83		* \param actionId The action to authenticate for
84		* \param message The message to present to the user
85		* \param iconName The name of the icon which is representing the action
86		* \param details Details describing the action
87		* \param cookie The cookie for the authentication request
88		* \param identities A list of Identity object that the user can choose to authenticate as
89		* \param result This AsyncResult MUST be completed by using complete() method when the
90		* authentication is done.
91		*/
92		void initiateAuthentication(const QString &actionId,
93		const QString &message,
94		const QString &iconName,
95		const PolkitQt1::Details &details,
96		const QString &cookie,
97		const Identity::List &identities,
98		Agent::AsyncResult *result) override;
99
100		/**
101		* \brief Cancels an authentication request from the polkit daemon.
102		*/
103		void cancelAuthentication() override;
104
105		/**
106		* \brief Checks for authorization of the subject.
107		*
108		* \param actionId the Id of the action in question
109		* \param subject subject that the action is authorized for (e.g. unix process)
110		* \param flag flags that influences the authorization checking
111		*
112		*/
113		Authority::Result checkAuthorization(const QString &actionId,
114		const Subject &subject,
115		Authority::AuthorizationFlags flag = Authority::AllowUserInteraction) const;
116
117		/**
118		* \return the code of last error
119		*/
120		Authority::ErrorCode pollError() const;
121
122		/**
123		* \brief Provide response that \p identity successfully authenticated for the authentication request identified by \p cookie.
124		*
125		* \param cookie The cookie passed to the authentication agent from the authority.
126		* \param identity The identity that was authenticated.
127		*
128		* \return \c true if authority acknowledged the call, \c false if error is set.
129		*
130		*/
131		bool userSuccessfullyAuthenticated(const QString &cookie, const PolkitQt1::Identity &identity);
132
133		/**
134		* \brief Function for setting the response given by the user.
135		*
136		* \param response Response from the user, typically a password
137		*/
138		void setResponse(const QString &response);
139
140		/**
141		* \brief Function for providing response to requests received via request signal.
142		*
143		* \param request Request to enter the password from the authentication agent.
144		*/
145		void request(const QString &request, bool echo = false);
146
147		/**
148		* \brief Function for marking the completion of the authentication process.
149		* \brief Either the subject is granted permissions or rejected.
150		*
151		* \param gainedAuthorization Whether privileges have been gained by the user.
152		*/
153		void completed(bool gainedAuthorization = false);
154
155		/**
156		* \brief Function for showing the error code and error which may have occured during authentication.
157		*
158		* \param error Error message shown on the console
159		*/
160		void showError(const QString &error);
161
162		/**
163		* \brief Function for providing information.
164		*
165		* \param info Information to be shown to the user.
166		*/
167		void showInfo(const QString &info) const;
168
169		private:
170		Agent::Session *m_authenticationSession;
171		bool m_agentRegistered;
172		};
173
174		#endif // EXTERNALCOMMAND_AUTHAGENT_H
175