diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/authentication.rst | 14 | ||||
| -rw-r--r-- | docs/api/authorization.rst | 11 | ||||
| -rw-r--r-- | docs/api/security.rst | 27 | ||||
| -rw-r--r-- | docs/api/traversal.rst | 3 | ||||
| -rw-r--r-- | docs/api/view.rst | 2 |
5 files changed, 36 insertions, 21 deletions
diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst new file mode 100644 index 000000000..f51eeb302 --- /dev/null +++ b/docs/api/authentication.rst @@ -0,0 +1,14 @@ +:mod:`repoze.bfg.authentication` +================================ + +.. automodule:: repoze.bfg.authentication + +.. _authentication_policies_api_section: + +Authentication Policies +~~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: RepozeWho1AuthenticationPolicy + +.. autoclass:: RemoteUserAuthenticationPolicy + diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst new file mode 100644 index 000000000..e44b1e293 --- /dev/null +++ b/docs/api/authorization.rst @@ -0,0 +1,11 @@ +:mod:`repoze.bfg.authorization` +=============================== + +.. automodule:: repoze.bfg.authorization + +.. _authorization_policies_api_section: + +Authorization Policies +~~~~~~~~~~~~~~~~~~~~~~ + +.. autoclass:: ACLAuthorizationPolicy diff --git a/docs/api/security.rst b/docs/api/security.rst index 5990f1809..77b60f5d0 100644 --- a/docs/api/security.rst +++ b/docs/api/security.rst @@ -8,14 +8,21 @@ API Functions ~~~~~~~~~~~~~ -.. autofunction:: authenticated_userid +.. autofunction:: authenticated_userid(context, request) -.. autofunction:: effective_principals +.. autofunction:: effective_principals(context, request) .. autofunction:: has_permission .. autofunction:: principals_allowed_by_permission +.. autofunction:: forget + +.. autofunction:: remember + +.. autofunction:: view_execution_permitted + + Constants ~~~~~~~~~ @@ -29,8 +36,8 @@ Constants The special principal id named 'Authenticated'. This principal id is granted to all requests which contain any other non-Everyone - principal id (according to the security policy). Its actual value - is the string 'system.Authenticated'. + principal id (according to the :term:`authentication policy`). + Its actual value is the string 'system.Authenticated'. .. attribute:: ALL_PERMISSIONS @@ -73,15 +80,3 @@ Return Values .. autoclass:: Allowed :members: -.. _security_policies_api_section: - -Security Policies -~~~~~~~~~~~~~~~~~ - -.. autofunction:: WhoACLSecurityPolicy - -.. autofunction:: WhoInheritingACLSecurityPolicy - -.. autofunction:: RemoteUserACLSecurityPolicy - -.. autofunction:: RemoteUserInheritingACLSecurityPolicy diff --git a/docs/api/traversal.rst b/docs/api/traversal.rst index 2f57fd3aa..4b7ac41f5 100644 --- a/docs/api/traversal.rst +++ b/docs/api/traversal.rst @@ -21,9 +21,6 @@ .. autofunction:: traverse -.. note:: A function named ``model_url`` used to be present in this - module. It was moved to :ref:`url_module` in version 0.6.1. - Secondary APIs ~~~~~~~~~~~~~~ diff --git a/docs/api/view.rst b/docs/api/view.rst index 3b34b7e22..40c69d24b 100644 --- a/docs/api/view.rst +++ b/docs/api/view.rst @@ -13,8 +13,6 @@ .. autofunction:: is_response - .. autofunction:: view_execution_permitted - .. autoclass:: bfg_view :members: |
