Development/Tutorials/PolicyKit/Introduction - Revision history

Claus chr: ajust to revised templaet

2012-08-27T16:16:54Z

ajust to revised templaet

AnneW at 12:15, 18 July 2012

2012-07-18T12:15:48Z

Neverendingo: Text replace - "" to ""

2011-06-29T20:54:34Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:33:20Z
Text replace - "<code xml>" to "<syntaxhighlight lang="xml">"

				
				
				
				
			
			← Older revision
			Revision as of 20:33, 29 June 2011
			
Line 36:
Line 36:
  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:   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> + <syntaxhighlight lang="xml">
  <?xml version="1.0" encoding="utf-8"?>   <?xml version="1.0" encoding="utf-8"?>
  <!DOCTYPE policyconfig PUBLIC   <!DOCTYPE policyconfig PUBLIC



Drf at 13:01, 12 February 2010
2010-02-12T13:01:08Z


				
				
				
				
			
			← Older revision
			Revision as of 13:01, 12 February 2010
			
Line 14:
Line 14:
  }}   }}
    
− == WARNING: THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD (TUTORIAL WILL BE UPDATED SOON) == + == WARNING: THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD ==
  + The new tutorial series [[Development/Tutorials/KAuth/KAuth_Basics|can be found here]], please use KAuth when developing with KDE: it's easier, more integrated, and portable
    
    



Drf: Obsoleting
2009-09-03T17:35:54Z
Obsoleting

				
				
				
				
			
			← Older revision
			Revision as of 17:35, 3 September 2009
			
Line 13:
Line 13:
  reading=None   reading=None
  }}   }}
  + 
  + == WARNING: THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD (TUTORIAL WILL BE UPDATED SOON) ==
  + 
    
  == What is PolicyKit ==   == What is PolicyKit ==



Tampakrap at 10:11, 15 March 2009
2009-03-15T10:11:27Z


				
				
				
				
			
			← Older revision
			Revision as of 10:11, 15 March 2009
			
Line 91:
Line 91:
    
  == Integrating with the application ==   == Integrating with the application ==
− In the next tutorial, we'll see how to obtain root privileges with an helper, using some of the knowledge we have gathered now + In the [[Development/Tutorials/PolicyKit/Helper_HowTo|next tutorial]], we'll see how to obtain root privileges with an helper, using some of the knowledge we have gathered now



Mmalek: Fixed link to Polkit-qt documentation
2009-03-14T10:20:20Z
Fixed link to Polkit-qt documentation

				
				
				
				
			
			← Older revision
			Revision as of 10:20, 14 March 2009
			
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 D-Bus (have a look at the D-Bus 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 D-Bus (have a look at the D-Bus tutorial series for that) can make your workflow better.
    
    



Drf: Finishing the page
2009-03-09T21:44:14Z
Finishing the page

				
				
				
				
			
			← Older revision
			Revision as of 21:44, 9 March 2009
			
Line 67:
Line 67:
  *# auth_self if authentication as the current user is required   *# auth_self if authentication as the current user is required
  *# auth_admin if authentication as an administrator is required   *# auth_admin if authentication as an administrator is required
− You can also append: + * You can also append to those:
  *# _keep_session if you want the auth to be retained for the whole session   *# _keep_session if you want the auth to be retained for the whole session
  *# _keep_always if you want the auth to be retained indefinitely   *# _keep_always if you want the auth to be retained indefinitely
  *# _one_shot if you want the auth to be valid for performing the action just a single time   *# _one_shot if you want the auth to be valid for performing the action just a single time
  + * So, for example, auth_admin_one_shot will make the authentication as an administrator required to perform the action, and the authentication will be revoked after having performed the action
  + 
  + This is a very simple overview on .policy files that should be enough for most needs, should you need some more information, you can consult PolicyKit reference manual.
  + 
  + == How to use Polkit-qt ==
  + Polkit-qt is splitted into 2 libraries, one for working without GUI interaction (-core), and one for working with it (-gui). It also includes some nice additions to make working with helpers easier, as you will see in the next tutorial. Let's see how to use Polkit-qt
  + 
  + === FindPolkitQt.cmake ===
  + You will find this file into polkit-qt source. This file not only defines the dbus_add_activation_system_service macro, that will be extremely useful later, but also lets you find and link against -core, -gui or both.
  + 
  + === Polkit-qt-core ===
  + Polkit-qt-core is composed by Auth and Context. The first is a namespace that lets you easily obtain and check for authorizations, while Context lets you retrieve informations about PolicyKit context. Please refer to polkit-qt docs for more details.
  + 
  + === Polkit-qt-gui ===
  + Polkit-qt-core is composed by Action, ActionButton and ActionButtons. They are simply wrappers around QAction and QAbstractButton that let you integrate those two elements with a PolicyKit action. The library will take care not only of obtaining and notify you upon authorization, but also to change the GUI elements (text, icon, etc...) accordingly to the result PolicyKit streams to you.
  + 
  + === More reference ===
  + The api docs for Polkit-qt are really detailed and a strongly advised read. Even if in the next tutorial we'll show you how to use Polkit-qt in the most common case, having some more knowledge on it will surely help you in advanced uses.
  + 
  + == Integrating with the application ==
  + In the next tutorial, we'll see how to obtain root privileges with an helper, using some of the knowledge we have gathered now



Dhaumann: DBus > D-Bus where appropriate
2009-03-09T21:32:10Z
DBus > D-Bus where appropriate

				
				
				
				
			
			← Older revision
			Revision as of 21:32, 9 March 2009
			
Line 7:
Line 7:
  name=Introduction to PolicyKit|   name=Introduction to PolicyKit|
    
− pre=[[Development/Tutorials/D-Bus/Autostart_Services|DBus activation]], Basic DBus knowledge, Basic polkit-qt knowledge| + pre=[[Development/Tutorials/D-Bus/Autostart_Services|D-Bus activation]], Basic D-Bus knowledge, Basic polkit-qt knowledge|
    
  next=[[Development/Tutorials/PolicyKit/Helper_HowTo|Using the caller-helper model to perform actions as root]]|     next=[[Development/Tutorials/PolicyKit/Helper_HowTo|Using the caller-helper model to perform actions as root]]|  
Line 15:
Line 15:
    
  == What is PolicyKit ==   == 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 + PolicyKit is an authentication system, that lets developers set a policy on specific actions. It works in strict correlation with D-Bus and ConsoleKit, and it is really useful in cases where you need to perform privileged actions
    
  == Who is this tutorial for? ==   == Who is this tutorial for? ==
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 D-Bus (have a look at the D-Bus tutorial series for that) can make your workflow better.

@@ Line 61: / Line 61: @@
    </action>
 </policyconfig>
-</code>
+</syntaxhighlight>
 Let's see how we wrote it:

@@ Line 13: / Line 13: @@
 }}
-{{Remember|3=WARNING|1=THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD}}
+{{Remember|2=WARNING|1=THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD}}
 The new tutorial series [[Development/Tutorials/KAuth/KAuth_Basics|can be found here]], please use KAuth when developing with KDE: it's easier, more integrated, and portable

← Older revision		Revision as of 13:01, 12 February 2010
Line 14:		Line 14:
	}}		}}

−	== WARNING: THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD ~~(TUTORIAL WILL BE UPDATED SOON)~~ ==	+	== WARNING: THIS TUTORIAL IS OBSOLETE. PLEASE USE THE NEW KAUTH FRAMEWORK INSTEAD ==
		+	The new tutorial series [[Development/Tutorials/KAuth/KAuth_Basics\|can be found here]], please use KAuth when developing with KDE: it's easier, more integrated, and portable

← Older revision		Revision as of 10:11, 15 March 2009
Line 91:		Line 91:

	== Integrating with the application ==		== Integrating with the application ==
−	In the next tutorial, we'll see how to obtain root privileges with an helper, using some of the knowledge we have gathered now	+	In the [[Development/Tutorials/PolicyKit/Helper_HowTo\|next tutorial]], we'll see how to obtain root privileges with an helper, using some of the knowledge we have gathered now

← Older revision		Revision as of 10:20, 14 March 2009
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 D-Bus (have a look at the D-Bus 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 D-Bus (have a look at the D-Bus tutorial series for that) can make your workflow better.