Skip to main content

Grok-like configuration for Zope security components

Project description

This package provides basic elements for defining Zope permissions and security checkers without ZCML.

Setting up

This package is essentially set up like the grokcore.component package, please refer to its documentation for details. The only additional ZCML line you will need is:

<include package="" file="meta.zcml" />

Put this somewhere near the top of your root ZCML file but below the line where you include grokcore.component’s configuration.

Defining permissions

In grokcore.component, various components are defined (and automatically registered) by subclassing from certain baseclasses. The same applies to defining permissions with as well:


class EditContent('mypkg.EditContent')

This defines a permission with the ID mypkg.EditContent. You must always specify this ID explicitly. In addition, you can also give the permission a human-readable title and description. This is useful when your application provides lists of permissions somewhere and you don’t want to bother users with deciphering the dotted IDs:


class EditContent('mypkg.EditContent')'Edit content')'Anyone who has this permission may '
                                  'modify content in the application.')

Defining checkers for components provides some means for defining checkers for components:

  • which can be used either as a class-level directive to set a permission for a whole component, or as a decorator to set a permission for a function or method.

  • protect_getattr and protect_setattr, available from, which take a class, an attribute name and a permission as arguments and define Zope security checkers for getting or setting a particular attribute on instance of said class.

With these, you can build grokkers for components that need security declarations. For instance, the grokcore.view package uses them to define a grokker that makes security declarations for views:

class ViewSecurityGrokker(martian.ClassGrokker):
    martian.directive(, name='permission')

    def execute(self, factory, config, permission, **kw):
        for method_name in zope.publisher.interfaces.browser.IBrowserPage:
                discriminator=('protectName', factory, method_name),
                args=(factory, method_name, permission),
        return True

With such a grokker, it is possible to protect views like so:

class Edit(grokcore.view.View):

Note how we can simply pass a permission class to the require directive. Alternatively, you can pass the permission ID:

class Edit(grokcore.view.View):'mypkg.EditContent')

If you wanted to be able to define permissions for individual class methods rather than the whole class, you would simply base your grokker on martian.MethodGrokker rather than ClassGrokker. The actual mechanics of defining a checker are the same.

Please note that does not yet provide directives that allow you to specify permissions for simple attribute access (read and write).

API overview


Base class for defining permissions. Use the name directive to define the mandatory permission ID. Optionally use the title and description directives to give the permission human-readable information.


Special permission that can be referred to whenever a component should not be protected by a permission at all (public access).


declares that the use of a particular component (when used as a class-level directive) or a method (when used as a method decorator) requires a certain permission. The argument can either be a permission class (subclass of Permission) or a permission ID.

In addition, the package exposes the grokcore.component API.


1.1 (2009-07-03)

  • Changed the default permissions from zope.Public to grok.View.


1.0 (2008-08-03)

  • Created in July 2008 by factoring security-related components, grokkers and directives out of Grok.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (13.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page