zope.security 6.0

Zope Security Framework

zope.security

The Security framework provides a generic mechanism to implement security policies on Python objects.

Documentation is available at https://zopesecurity.readthedocs.io/

Changes

6.0 (2023-01-16)

• Remove proxying code for names that no longer exist in Python 3. (#92)

• Drop support for Python 2.7, 3.5, 3.6.

5.8 (2022-11-30)

• The extra untrustedpython now for Python 3, too, installs zope.untrustedpython.

5.7 (2022-11-17)

• Release to rebuild full set of binary wheels.

5.6 (2022-11-16)

• Add support for building arm64 wheels on macOS.

5.5 (2022-11-06)

• Add support for final release of Python 3.11.

5.4 (2022-09-15)

• Disable unsafe math optimizations in C code. See pull request 89.

5.3 (2022-04-27)

• Allow calling bound methods of some built-in objects such as ().__repr__ and {}.__repr__ by default. This worked on Python 2, but raised ForbiddenAttribute on Python 3. See issue 75.

• Remove usage of unittest.makeSuite as it is deprecated in Python 3.11+. See issue 83.

• Add support for Python 3.11 (as of 3.11.0a7).

5.2 (2022-03-10)

• Add support for Python 3.9 and 3.10.

5.1.1 (2020-03-23)

• Ensure all objects have consistent interface resolution orders (if all dependencies are up-to-date). See issue 71.

5.1.0 (2020-02-14)

• Let proxied interfaces be iterated on Python 3. This worked on Python 2, but raised ForbiddenAttribute an Python 3. See zope.interface issue 141.

• Allow to use a common Sphinx version for Python 2 and 3.

5.0.0 (2019-11-11)

• Drop support for Python 3.4.

• Add support for Python 3.8.

• Properly declare dependency on zope.schema >= 4.2.0, introduced in zope.security 4.2.1.

• Fix dict item view iteration on PyPy3 7.x.

4.3.1 (2019-01-03)

• Fix the decimal.Decimal checker, __truediv__ was missing causing ForbiddenAttribute on a ProxyFactory(Decimal('1')) / 1 operation

4.3.0 (2018-08-24)

• Add the interface ISystemPrincipal and make zope.security.management.system_user a regular object that implements this interface. This facilitates providing adapter registrations specifically for the system_user.

4.2.3 (2018-08-09)

• Add support for Python 3.7.

4.2.2 (2018-01-11)

• Make the pure-Python proxy on Python 2 not check permissions for __unicode__ just like the C implementation. Note that __str__ is checked for both implementations on both Python 2 and 3, but if there is no __unicode__ method defined, Python 2’s automatic fallback to __str__ is not checked when unicode is called. See issue 10.

4.2.1 (2017-11-30)

• Fix the default values for Permission fields title and description under Python 2. See issue 48.

• Change the IPermission.id from Text (unicode) to a NativeStringLine. This matches what ZCML creates and what is usually written in source code.

4.2.0 (2017-09-20)

• Fix the extremely rare potential for a crash when the C extensions are in use. See issue 35.

• Fix issue 7: The pure-Python proxy didn’t propagate TypeError from __repr__ and __str__ like the C implementation did.

• Fix issue 27: iteration of zope.interface.providedBy() is now allowed by default on all versions of Python. Previously it only worked on Python 2. Note that providedBy returns unproxied objects for backwards compatibility.

• Fix __length_hint__ of proxied iterator objects. Previously it was ignored.

• Drop support for Python 3.3.

• Enable coveralls.io for coverage measurement and run doctests on all supported Python versions.

• Fix issue 9: iteration of itertools.groupby objects is now allowed by default. In addition, iteration of all the custom iterator types defined in itertools are also allowed by default.

• Simplify the internal _compat.py module now that we only run on newer Python versions. See PR 32.

• Respect PURE_PYTHON at runtime. At build time, always try to build the C extensions on supported platforms, ignoring PURE_PYTHON. See issue 33.

• Fix watching checkers (ZOPE_WATCH_CHECKERS=1) in pure-Python mode. See issue 8.

• Remove unused internal files from tests/.

• Remove zope.security.setup. It was unused and did not work anyway.

• Fix the pure-Python proxy on Python 2 letting __getslice__ and __setslice__ fall through to __getitem__ or __setitem__, respectively, if it raised an error.

• Fix the pure-Python proxy calling a wrapped __getattr__ or __getattribute__ more than once in situations where the C implementation only called it one time (when it raised an AttributeError).

• Reach 100% test coverage and maintain it via automated checks.

4.1.1 (2017-05-17)

• Fix issue 23: iteration of collections.OrderedDict and its various views is now allowed by default on all versions of Python.

• As a further fix for issue 20, iteration of BTree itself is now allowed by default.

4.1.0 (2017-04-24)

• When testing PURE_PYTHON environments under tox, avoid poisoning the user’s global wheel cache.

• Drop support for Python 2.6 and 3.2.

• Add support for Python 3.5 and 3.6.

• Fix issue 20: iteration of pure-Python BTrees.items(), and also creating a list from BTrees.items() on Python 3. The same applies for keys() and values().

4.0.3 (2015-06-02)

• Fix iteration over security proxies in Python 3 using the pure-Python implementation.

4.0.2 (2015-06-02)

• Fix compatibility with zope.proxy 4.1.5 under PyPy.

• Fix the very first call to removeSecurityProxy returning incorrect results if given a proxy under PyPy.

4.0.1 (2014-03-19)

• Add support for Python 3.4.

4.0.0 (2013-07-09)

• Update boostrap.py to version 2.2.

• Bugfix: ZOPE_WATCH_CHECKERS=2 used to incorrectly suppress unauthorized/forbidden warnings.

• Bugfix: ZOPE_WATCH_CHECKERS=1 used to miss most of the checks.

4.0.0b1 (2013-03-11)

• Add support for PyPy.

• Fix extension compilation on windows python 3.x

4.0.0a5 (2013-02-28)

• Undo changes from 4.0.0a4. Instead, zope.untrustedpython is only included during Python 2 installs.

4.0.0a4 (2013-02-28)

• Remove untrustedpython extra again, since we do not want to support zope.untrustedpython in ZTK 2.0. If BBB is really needed, we will create a 3.10.0 release.

4.0.0a3 (2013-02-15)

• Fix test breakage in 4.0.0a2 due to deprecation strategy.

4.0.0a2 (2013-02-15)

• Add back the untrustedpython extra: now pulls in zope.untrustedpython. Restored deprecated backward-compatible imports for zope.security.untrustedpython.{builtins,interpreter,rcompile} (the extra and the imports are to be removed in version 4.1).

4.0.0a1 (2013-02-14)

• Add support for Python 3.2 and 3.3.

• Bring unit test coverage to 100%.

• zope.security.untrustedpython moved to separate project: zope.untrustedpython

• Convert use of assert in non-test code to apprpriate error types:

  • Non-dict’s passed to Checker.__init__.

• Remove dprecattion of zope.security.adapter.TrustedAdapterFactory. Although it has been marked as deprectaed since before Zope3 3.2, current versions of zope.compoent still rely on it.

• Convert doctests to Sphinx documentation in ‘docs’.

• Add setup.py docs alias (installs Sphinx and dependencies).

• Add setup.py dev alias (runs setup.py develop plus installs nose and coverage).

• Make non-doctest tests fully independent of zope.testing.

  Two modules, zope.security.checker and zope.security.management, register cleanups with zope.testing IFF it is importable, but the tests no longer rely on it.

• Enable building extensions without the svn:external of the zope.proxy headers into our include dir.

• Bump zope.proxy dependency to “>= 4.1.0” to enable compilation on Py3k.

• Replace deprecated zope.component.adapts usage with equivalent zope.component.adapter decorator.

• Replace deprecated zope.interface.classProvides usage with equivalent zope.interface.provider decorator.

• Replace deprecated zope.interface.implements usage with equivalent zope.interface.implementer decorator.

• Drop support for Python 2.4 and 2.5.

• Add test convenience helper create_interaction and with interaction().

3.9.0 (2012-12-21)

• Pin zope.proxy >= 4.1.0

• Ship with an included proxy.h header which is compatible with the 4.1.x version ov zope.proxy.

3.8.5 (2012-12-21)

• Ship with an included proxy.h header which is compatible with the supported versions of zope.proxy.

3.8.4 (2012-12-20)

• Pin zope.proxy >= 3.4.2, <4.1dev

3.8.3 (2011-09-24)

• Fix a regression introduced in 3.8.1: zope.location's LocationProxy did not get a security checker if zope.security.decorator was not imported manually. Now zope.security.decorator is imported in zope.security.proxy without re-introducing the circular import fixed in 3.8.1.

3.8.2 (2011-05-24)

• Fix a test that failed on Python 2.7.

3.8.1 (2011-05-03)

• Fix circular import beween zope.security.decorator and zope.security.proxy which led to an ImportError when only importing zope.security.decorator.

3.8.0 (2010-12-14)

• Add tests for our own configure.zcml.

• Add zcml extra dependencies; run related tests only if zope.configuration is available.

• Run tests related to the untrustedpython functionality only if RestrictedPython is available.

3.7.3 (2010-04-30)

• Prefer the standard library’s doctest module to the one from zope.testing.

• Ensure PermissionIdsVocabulary directly provides IVocabularyFactory, even though it might be unnecessary because IVocabularyFactory is provided in ZCML.

• Remove the dependency on the zope.exceptions package: zope.security.checker now imports DuplicationError from zope.exceptions if available, otherwise it defines a package-specific DuplicationError class which inherits from Exception.

3.7.2 (2009-11-10)

• Add compatibility with Python 2.6 abstract base classes.

3.7.1 (2009-08-13)

• Fix for LP bug 181833 (from Gustavo Niemeyer). Before “visiting” a sub-object, a check should be made to ensure the object is still valid. Because garbage collection may involve loops, if you garbage collect an object, it is possible that the actions done on this object may modify the state of other objects. This may cause another round of garbage collection, eventually generating a segfault (see LP bug). The Py_VISIT macro does the necessary checks, so it is used instead of the previous code.

3.7.0 (2009-05-13)

• Make pytz a soft dependency: the checker for pytz.UTC is created / tested only if the package is already present. Run bin/test_pytz to run the tests with pytz on the path.

3.6.3 (2009-03-23)

• Ensure that simple zope.schema’s VocabularyRegistry is used for PermissionVocabulary tests, because it’s replaced implicitly in environments with zope.app.schema installed that makes that tests fail.

• Fix a bug in DecoratedSecurityCheckerDescriptor which made security-wrapping location proxied exception instances throw exceptions on Python 2.5. See https://bugs.launchpad.net/zope3/+bug/251848

3.6.2 (2009-03-14)

• Add zope.i18nmessageid.Message to non-proxied basic types. It’s okay, because messages are immutable. Done previously by zope.app.security.

• Add __name__ and __parent__ attributes to list of available by default. Done previously by zope.app.security.

• Move PermissionsVocabulary and PermissionIdsVocabulary vocabularies to the zope.security.permission module from the zope.app.security package.

• Add zcml permission definitions for most common and useful permissions, like zope.View and zope.ManageContent, as well as for the special zope.Public permission. They are placed in a separate permissions.zcml file, so it can be easily excluded/redefined. They are selected part of permissions moved from zope.app.security and used by many zope.* packages.

• Add addCheckerPublic helper function in zope.security.testing module that registers the “zope.Public” permission as an IPermission utility.

• Add security declarations for the zope.security.permisson.Permission class.

• Improve test coverage.

3.6.1 (2009-03-10)

• Use from imports instead of zope.deferred to avoid circular import problems, thus drop dependency on zope.deferredimport.

• Raise NoInteraction when zope.security.checkPermission is called without interaction being active (LP #301565).

• Don’t define security checkers for deprecated set types from the “sets” module on Python 2.6. It’s discouraged to use them and set and frozenset built-in types should be used instead.

• Change package’s mailng list address to zope-dev at zope.org as zope3-dev at zope.org is now retired.

• Remove old zpkg-related files.

3.6.0 (2009-01-31)

• Install decorated security checker support on LocationProxy from the outside.

• Add support to bootstrap on Jython.

• Move the protectclass module from zope.app.security to this package to reduce the number of dependencies on zope.app.security.

• Move the <module> directive implementation from zope.app.security to this package.

• Move the <class> directive implementation from zope.app.component to this package.

3.5.2 (2008-07-27)

• Make C code compatible with Python 2.5 on 64bit architectures.

3.5.1 (2008-06-04)

• Add frozenset, set, reversed, and sorted to the list of safe builtins.

3.5.0 (2008-03-05)

• Changed title for zope.security.management.system_user to be more presentable.

3.4.3 - (2009/11/26)

• Backport a fix made by Gary Poster to the 3.4 branch: Fix for LP bug 181833 (from Gustavo Niemeyer). Before “visiting” a sub-object, a check should be made to ensure the object is still valid. Because garbage collection may involve loops, if you garbage collect an object, it is possible that the actions done on this object may modify the state of other objects. This may cause another round of garbage collection, eventually generating a segfault (see LP bug). The Py_VISIT macro does the necessary checks, so it is used instead of the previous code.

3.4.2 - (2009/03/23)

• Add dependency on zope.thread to setup.py; without it, the tests were failing.

• Backport a fix made by Albertas Agejevas to the 3.4 branch. He fixed a bug in DecoratedSecurityCheckerDescriptor which made security-wrapping location proxied exception instances throw exceptions on Python 2.5. See https://bugs.launchpad.net/zope3/+bug/251848

3.4.1 - 2008/07/27

• Make C code compatible with Python 2.5 on 64bit architectures.

3.4.0 (2007-10-02)

• Update meta-data.

3.4.0b5 (2007-08-15)

• Fix a circular import in the C implementation.

3.4.0b4 (2007-08-14)

• Improve ugly/brittle ID of zope.security.management.system_user.

3.4.0b3 (2007-08-14)

• Add support for Python 2.5.

• Bug: zope.security.management.system_user wasn’t a valid principal (didn’t provide IPrincipal).

• Bug: Fix inclusion of doctest to use the doctest module from zope.testing. Now tests can be run multiple times without breaking. (#98250)

3.4.0b2 (2007-06-15)

• Bug: Remove stack extraction in newInteraction. When using eggs this is an extremly expensive function. The publisher is now more than 10 times faster when using eggs and about twice as fast with a zope trunk checkout.

3.4.0b1

• Temporarily fixed the hidden (and accidental) dependency on zope.testing to become optional.

Note: The releases between 3.2.0 and 3.4.0b1 where not tracked as an individual package and have been documented in the Zope 3 changelog.

3.2.0 (2006-01-05)

• Corresponds to the verison of the zope.security package shipped as part of the Zope 3.2.0 release.

• Remove deprecated helper functions, proxy.trustedRemoveSecurityProxy and proxy.getProxiedObject.

• Make handling of management.{end,restore}Interaction more careful w.r.t. edge cases.

• Make behavior of canWrite consistent with canAccess: if canAccess does not raise ForbiddenAttribute, then neither will canWrite. See: http://www.zope.org/Collectors/Zope3-dev/506

• Code style / documentation / test fixes.

3.1.0 (2005-10-03)

• Add support for use of the new Python 2.4 datatypes, set and frozenset, within checked code.

• Make the C security proxy depend on the proxy.h header from the zope.proxy package.

• XXX: the spelling of the #include is bizarre! It seems to be related to zpkg-based builds, and should likely be revisited. For the moment, I have linked in the zope.proxy package into our own include directory. See the subversion checkin: http://svn.zope.org/Zope3/?rev=37882&view=rev

• Update checker to avoid re-proxying objects which have and explicit __Security_checker__ assigned.

• Corresponds to the verison of the zope.security package shipped as part of the Zope 3.1.0 release.

• Clarify contract of IChecker to indicate that its check* methods may raise only Forbidden or Unauthorized exceptions.

• Add interfaces, (IPrincipal, IGroupAwarePrincipal, IGroup, and IPermission) specifying contracts of components in the security framework.

• Code style / documentation / test fixes.

3.0.0 (2004-11-07)

• Corresponds to the version of the zope.security package shipped as part of the Zope X3.0.0 release.