Development/Tutorials/PolicyKit/Introduction: Difference between revisions

From KDE TechBase
(First save round)
No edit summary
Line 26: Line 26:
Your application does not need very special prerequisites to be integrated with PolicyKit. Console applications or libraries can also link to polkit-qt-core, that doesn't add a dependency to QtGui.
Your application does not need very special prerequisites to be integrated with PolicyKit. Console applications or libraries can also link to polkit-qt-core, that doesn't add a dependency to QtGui.


As a developer, you probably need to read the [[http://api.kde.org/kdesupport-api/kdesupport-apidocs/polkit-qt/html/|Polkit-qt api documentation]], that is a fundamental compound of this tutorial. A fair knowledge of DBus (have a look at the DBus tutorial series for that) can make your workflow better.
As a developer, you probably need to read the [http://api.kde.org/kdesupport-api/kdesupport-apidocs/polkit-qt/html/| Polkit-qt api documentation], that is a fundamental compound of this tutorial. A fair knowledge of DBus (have a look at the DBus tutorial series for that) can make your workflow better.




== Special files used by PolicyKit ==
== Special files used by PolicyKit ==
Before you start diving into PolicyKit integration, you have to know how a .policy file is made. Those files contain a definition of
Before you start diving into PolicyKit integration, you have to know how a .policy file is made. Those files contain a definition of actions carried out by your application that require authorization by PolicyKit. So let's suppose we are creating the application foo that can do action1, that requires authentication as the current user, and action2, that requires authentication as an administrator. Our policy file will be named org.kde.foo.policy and will look like this:
 
<code xml>
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE policyconfig PUBLIC
"-//freedesktop//DTD PolicyKit Policy Configuration 1.0//EN"
"http://www.freedesktop.org/standards/PolicyKit/1.0/policyconfig.dtd">
<policyconfig>
 
  <action id="org.kde.foo.action1">
    <description>Action number one</description>
    <message>Prevents from doing action one</message>
    <defaults>
      <allow_inactive>no</allow_inactive>
      <allow_active>auth_self</allow_active>
    </defaults>
  </action>
 
  <action id="org.kde.foo.action2">
    <description>Action number two</description>
    <message>Prevents from doing action two</message>
    <defaults>
      <allow_inactive>no</allow_inactive>
      <allow_active>auth_admin</allow_active>
    </defaults>
  </action>
</policyconfig>
</code>

Revision as of 21:19, 9 March 2009


Development/Tutorials/PolicyKit/Introduction


Introduction to PolicyKit
Tutorial Series   PolicyKit Tutorial
Previous   DBus activation, Basic DBus knowledge, Basic polkit-qt knowledge
What's Next   Using the caller-helper model to perform actions as root
Further Reading   None

What is PolicyKit

PolicyKit is an authentication system, that lets developers set a policy on specific actions. It works in strict correlation with DBus and ConsoleKit, and it is really useful in cases where you need to perform privileged actions

Who is this tutorial for?

This tutorial is aimed to developers who want their application to perform privileged actions in a secure, consistent and easy way.

PolicyKit and KDE

PolicyKit is closely integrated with KDE starting from version 4.3. In kdebase-workspace we have an authorization manager and an authentication agent. What matters the most, though, is polkit-qt library, in kdesupport, that lets us use the PolicyKit library through a nice Qt-styled API. In this tutorial we will be using it as our main development resource.

Prerequisites

Your application does not need very special prerequisites to be integrated with PolicyKit. Console applications or libraries can also link to polkit-qt-core, that doesn't add a dependency to QtGui.

As a developer, you probably need to read the Polkit-qt api documentation, that is a fundamental compound of this tutorial. A fair knowledge of DBus (have a look at the DBus tutorial series for that) can make your workflow better.


Special files used by PolicyKit

Before you start diving into PolicyKit integration, you have to know how a .policy file is made. Those files contain a definition of actions carried out by your application that require authorization by PolicyKit. So let's suppose we are creating the application foo that can do action1, that requires authentication as the current user, and action2, that requires authentication as an administrator. Our policy file will be named org.kde.foo.policy and will look like this:

<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE policyconfig PUBLIC 

"-//freedesktop//DTD PolicyKit Policy Configuration 1.0//EN"
"http://www.freedesktop.org/standards/PolicyKit/1.0/policyconfig.dtd">

<policyconfig> 

 <action id="org.kde.foo.action1">
   <description>Action number one</description>
   <message>Prevents from doing action one</message>
   <defaults>
     <allow_inactive>no</allow_inactive>
     <allow_active>auth_self</allow_active>
   </defaults>
 </action>

 <action id="org.kde.foo.action2">
   <description>Action number two</description>
   <message>Prevents from doing action two</message>
   <defaults>
     <allow_inactive>no</allow_inactive>
     <allow_active>auth_admin</allow_active>
   </defaults>
 </action>

</policyconfig>

Retrieved from "https://techbase.kde.org/index.php?title=Development/Tutorials/PolicyKit/Introduction&oldid=39321"