grokcore.security 4.0

设置 grokcore.security

此软件包的设置基本上类似于grokcore.component软件包，请参阅其文档以获取详细信息。您需要的附加ZCML行如下：

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

请将此内容放在根ZCML文件顶部附近，但在包含grokcore.component配置的行下方。

定义权限

在grokcore.component中，通过从某些基类继承来定义（并自动注册）各种组件。同样，使用grokcore.security定义权限也是如此

import grokcore.security

class EditContent(grokcore.security.Permission):
    grokcore.security.name('mypkg.EditContent')

这定义了一个ID为mypkg.EditContent的权限。您必须始终显式指定此ID。此外，您还可以为权限提供一个人类可读的标题和描述。当您的应用程序在某个地方提供权限列表时，这很有用，您不想让用户费心解读点状ID。

import grokcore.security

class EditContent(grokcore.security.Permission):
    grokcore.security.name('mypkg.EditContent')
    grokcore.security.title('Edit content')
    grokcore.security.description('Anyone who has this permission may '
                                  'modify content in the application.')

定义组件的检查器

grokcore.security提供了一些定义组件检查器的手段

• grokcore.security.require(permission)，它可以用作类级别指令来为整个组件设置权限，或者用作装饰器来为函数或方法设置权限。

• 来自grokcore.security.util的protect_getattr和protect_setattr，它们接受一个类、一个属性名和一个权限作为参数，并定义Zope安全检查器以在指定类的实例上获取或设置特定属性。

有了这些，您可以构建需要安全声明的组件的grokkers。例如，grokcore.view软件包使用它们来定义一个grokker，该grokker为视图定义安全声明。

class ViewSecurityGrokker(martian.ClassGrokker):
    martian.component(grokcore.view.View)
    martian.directive(grokcore.security.require, name='permission')

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

有了这样的grokker，可以保护视图如下

class Edit(grokcore.view.View):
    grokcore.security.require(EditContent)

注意我们如何简单地传递一个权限类到require指令。或者，您也可以传递权限ID

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

如果您想能够为单个类方法而不是整个类定义权限，您只需将您的grokker基于martian.MethodGrokker而不是ClassGrokker。定义检查器的实际机制是相同的。

请注意，grokcore.security尚未提供允许您指定简单属性访问权限（读取和写入）的指令。

API概述

权限

定义权限的基类。使用name指令定义必需的权限ID。可选地使用title和description指令提供权限的人类可读信息。

公共

特殊权限，可以在组件不应由权限保护的任何时候引用（公开访问）。

require(permission_class_or_id)

声明，使用特定组件（当作为类级别指令使用时）或方法（当作为方法装饰器使用时）需要一定的权限。参数可以是权限类（Permission 的子类）或权限 ID。

此外，grokcore.security 包暴露了 grokcore.component API。

更改