Add plugin for manage self-service ACIs

This is just a thin wrapper around the aci plugin, controlling what
types of ACIs can be added.

Right now only ACIs in the basedn can be managed with this plugin.

ticket 531

1 files changed, 192 insertions, 0 deletions

diff --git a/ipalib/plugins/selfservice.py b/ipalib/plugins/selfservice.py
new file mode 100644
index 000000000..6d34715ad
--- /dev/null
+++ b/ipalib/plugins/selfservice.py
@@ -0,0 +1,192 @@
+# Authors:
+#   Rob Crittenden <rcritten@redhat.com>
+#
+# Copyright (C) 2010  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; version 2 only
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+"""
+Self-Service Permissions
+
+A permission enables fine-grained delegation of permissions. Access Control
+Rules, or instructions (ACIs), grant permission to permissions to perform
+given tasks such as adding a user, modifying a group, etc.
+
+A Self-Service permission defines what an object can change in its own entry.
+
+
+EXAMPLES:
+
+ Add a self-service rule to allow users to manage their address:
+   ipa selfservice-add --permissions=write --attrs=street,postalCode,l,c,st "User's manage their own address"
+
+ When managing the list of attributes you need to include all attributes
+ in the list, including existing ones. Add telephoneNumber to the list:
+   ipa selfservice-mod --attrs=street,postalCode,l,c,st,telephoneNumber "User's manage their own address"
+
+ Display our updated rule:
+   ipa selfservice-show "User's manage their own address"
+
+ Delete a rule:
+   ipa selfservice-del "User's manage their own address"
+"""
+
+import copy
+from ipalib import api, _, ngettext
+from ipalib import Flag, Str, List
+from ipalib.request import context
+from ipalib import api, crud, errors
+from ipalib import output
+from ipalib import Object, Command
+
+def is_selfservice(aciname):
+    """
+    Determine if the ACI is a Self-Service ACI and raise an exception if it
+    isn't.
+
+    Return the result if it is a self-service ACI.
+    """
+    result = api.Command['aci_show'](aciname)['result']
+    if 'selfaci' not in result or result['selfaci'] == False:
+        raise errors.NotFound(reason=_('Self-service permission \'%(permission)s\' not found') % dict(permission=aciname))
+    return result
+
+class selfservice(Object):
+    """
+    Selfservice object.
+    """
+
+    label = _('Permissions')
+
+    takes_params = (
+        Str('aciname',
+            cli_name='name',
+            label=_('Self-Service name'),
+            doc=_('Self-Service name'),
+            primary_key=True,
+        ),
+        List('permissions?',
+            cli_name='permissions',
+            label=_('Permissions'),
+            doc=_('Comma-separated list of permissions to grant ' \
+                '(read, write). Default is write.'),
+        ),
+        List('attrs',
+            cli_name='attrs',
+            label=_('Attributes'),
+            doc=_('Comma-separated list of attributes'),
+        ),
+    )
+
+api.register(selfservice)
+
+
+class selfservice_add(crud.Create):
+    """
+    Add a new selfservice permission.
+    """
+
+    msg_summary = _('Added selfservice "%(value)s"')
+
+    def execute(self, aciname, **kw):
+        if not 'permissions' in kw:
+            kw['permissions'] = (u'write',)
+        kw['selfaci'] = True
+        result = api.Command['aci_add'](aciname, **kw)['result']
+
+        return dict(
+            result=result,
+            value=aciname,
+        )
+
+api.register(selfservice_add)
+
+
+class selfservice_del(crud.Delete):
+    """
+    Delete a selfservice.
+    """
+
+    has_output = output.standard_delete
+    msg_summary = _('Deleted selfservice "%(value)s"')
+
+    def execute(self, aciname, **kw):
+        is_selfservice(aciname)
+        result = api.Command['aci_del'](aciname, **kw)
+        return dict(
+            result=True,
+            value=aciname,
+        )
+
+api.register(selfservice_del)
+
+
+class selfservice_mod(crud.Update):
+    """
+    Modify a selfservice.
+    """
+
+    msg_summary = _('Modified selfservice "%(value)s"')
+
+    def execute(self, aciname, **kw):
+        is_selfservice(aciname)
+        result = api.Command['aci_mod'](aciname, **kw)['result']
+        return dict(
+            result=result,
+            value=aciname,
+        )
+
+api.register(selfservice_mod)
+
+
+class selfservice_find(crud.Search):
+    """
+    Search for selfservices.
+    """
+
+    msg_summary = ngettext(
+        '%(count)d selfservice matched', '%(count)d selfservices matched'
+    )
+
+    def execute(self, term, **kw):
+        kw['selfaci'] = True
+        result = api.Command['aci_find'](term, **kw)['result']
+
+        return dict(
+            result=result,
+            count=len(result),
+            truncated=False,
+        )
+
+api.register(selfservice_find)
+
+
+class selfservice_show(crud.Retrieve):
+    """
+    Display information about a selfservice.
+    """
+    has_output_params = (
+        Str('aci',
+            label=_('ACI'),
+        ),
+    )
+
+    def execute(self, aciname, **kw):
+        result = is_selfservice(aciname)
+        return dict(
+            result=result,
+            value=aciname,
+        )
+
+api.register(selfservice_show)