summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2020-01-14 00:02:04 -0600
committerMichael Merickel <michael@merickel.org>2020-01-14 00:25:06 -0600
commitf486795cb4a92784fa1082bd69bebd84bf6d1366 (patch)
treeddff9350d413babcf320c6ef873d3adeb8823b40 /docs/api
parent8b6efc3cfbf9accc6bf2a009e124dee2b3c04840 (diff)
downloadpyramid-f486795cb4a92784fa1082bd69bebd84bf6d1366.tar.gz
pyramid-f486795cb4a92784fa1082bd69bebd84bf6d1366.tar.bz2
pyramid-f486795cb4a92784fa1082bd69bebd84bf6d1366.zip
update changelog and docs
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/authorization.rst43
-rw-r--r--docs/api/security.rst46
2 files changed, 82 insertions, 7 deletions
diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst
index c6b3d090e..fac47490a 100644
--- a/docs/api/authorization.rst
+++ b/docs/api/authorization.rst
@@ -10,3 +10,46 @@
.. autoclass:: ACLAuthorizationPolicy
+Constants
+---------
+
+.. attribute:: Everyone
+
+ The special principal id named 'Everyone'. This principal id is
+ granted to all requests. Its actual value is the string
+ 'system.Everyone'.
+
+.. attribute:: Authenticated
+
+ 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 :term:`authentication policy`).
+ Its actual value is the string 'system.Authenticated'.
+
+.. attribute:: ALL_PERMISSIONS
+
+ An object that can be used as the ``permission`` member of an ACE
+ which matches all permissions unconditionally. For example, an
+ ACE that uses ``ALL_PERMISSIONS`` might be composed like so:
+ ``('Deny', 'system.Everyone', ALL_PERMISSIONS)``.
+
+.. attribute:: DENY_ALL
+
+ A convenience shorthand ACE that defines ``('Deny',
+ 'system.Everyone', ALL_PERMISSIONS)``. This is often used as the
+ last ACE in an ACL in systems that use an "inheriting" security
+ policy, representing the concept "don't inherit any other ACEs".
+
+Return Values
+-------------
+
+.. autoclass:: ACLDenied
+ :members: msg
+
+ .. automethod:: __new__
+
+.. autoclass:: ACLAllowed
+ :members: msg
+
+ .. automethod:: __new__
+
diff --git a/docs/api/security.rst b/docs/api/security.rst
index edb66472e..3350f8207 100644
--- a/docs/api/security.rst
+++ b/docs/api/security.rst
@@ -10,7 +10,7 @@ Authentication API Functions
.. autofunction:: forget
-.. autofunction:: remember(request, userid, **kwargs)
+.. autofunction:: remember
Authorization API Functions
---------------------------
@@ -22,12 +22,24 @@ Authorization API Functions
Constants
---------
+.. attribute:: NO_PERMISSION_REQUIRED
+
+ A special permission which indicates that the view should always
+ be executable by entirely anonymous users, regardless of the
+ default permission, bypassing any :term:`authorization policy`
+ that may be in effect. Its actual value is the string
+ '__no_permission_required__'.
+
.. attribute:: Everyone
The special principal id named 'Everyone'. This principal id is
granted to all requests. Its actual value is the string
'system.Everyone'.
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.Everyone`.
+
.. attribute:: Authenticated
The special principal id named 'Authenticated'. This principal id
@@ -35,6 +47,10 @@ Constants
principal id (according to the :term:`authentication policy`).
Its actual value is the string 'system.Authenticated'.
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.Authenticated`.
+
.. attribute:: ALL_PERMISSIONS
An object that can be used as the ``permission`` member of an ACE
@@ -42,6 +58,10 @@ Constants
ACE that uses ``ALL_PERMISSIONS`` might be composed like so:
``('Deny', 'system.Everyone', ALL_PERMISSIONS)``.
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.ALL_PERMISSIONS`.
+
.. attribute:: DENY_ALL
A convenience shorthand ACE that defines ``('Deny',
@@ -49,13 +69,9 @@ Constants
last ACE in an ACL in systems that use an "inheriting" security
policy, representing the concept "don't inherit any other ACEs".
-.. attribute:: NO_PERMISSION_REQUIRED
+ .. deprecated:: 2.0
- A special permission which indicates that the view should always
- be executable by entirely anonymous users, regardless of the
- default permission, bypassing any :term:`authorization policy`
- that may be in effect. Its actual value is the string
- '__no_permission_required__'.
+ Moved to :data:`pyramid.authorization.DENY_ALL`.
Return Values
-------------
@@ -66,12 +82,20 @@ Return Values
'read')`` that means allow access. A sequence of ACEs makes up an
ACL. It is a string, and its actual value is "Allow".
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.Allow`.
+
.. attribute:: Deny
The ACE "action" (the first element in an ACE e.g. ``(Deny,
'george', 'read')`` that means deny access. A sequence of ACEs
makes up an ACL. It is a string, and its actual value is "Deny".
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.Deny`.
+
.. autoclass:: Denied
:members: msg
@@ -85,10 +109,18 @@ Return Values
.. autoclass:: ACLDenied
:members: msg
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.ACLDenied`.
+
.. automethod:: __new__
.. autoclass:: ACLAllowed
:members: msg
+ .. deprecated:: 2.0
+
+ Moved to :data:`pyramid.authorization.ACLAllowed`.
+
.. automethod:: __new__