Merge pull request #3465 from luhn/security-policy

Security policy implementation

4 files changed, 39 insertions, 18 deletions

diff --git a/docs/api/authentication.rst b/docs/api/authentication.rst
index 57f32327a..f3a25ee64 100644
--- a/docs/api/authentication.rst
+++ b/docs/api/authentication.rst
@@ -3,10 +3,30 @@
 :mod:`pyramid.authentication`
 --------------------------------
 
+Helper Classes
+~~~~~~~~~~~~~~
+
+.. automodule:: pyramid.authentication
+
+  .. autoclass:: SessionAuthenticationHelper
+     :members:
+
+  .. autoclass:: AuthTktCookieHelper
+     :members:
+
+Helper Functions
+~~~~~~~~~~~~~~~~
+
+  .. autofunction:: extract_http_basic_credentials
+
+  .. autoclass:: HTTPBasicCredentials
+     :members:
+
 Authentication Policies
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-.. automodule:: pyramid.authentication
+Authentication policies have been deprecated by the new security system.  See
+:ref:`upgrading_auth` for more information.
 
   .. autoclass:: AuthTktAuthenticationPolicy
      :members:
@@ -27,17 +47,3 @@ Authentication Policies
   .. autoclass:: RepozeWho1AuthenticationPolicy
      :members:
      :inherited-members:
-
-Helper Classes
-~~~~~~~~~~~~~~
-
-  .. autoclass:: AuthTktCookieHelper
-     :members:
-
-  .. autoclass:: HTTPBasicCredentials
-     :members:
-
-Helper Functions
-~~~~~~~~~~~~~~~~
-
-  .. autofunction:: extract_http_basic_credentials
diff --git a/docs/api/authorization.rst b/docs/api/authorization.rst
index 5f5435b94..c6b3d090e 100644
--- a/docs/api/authorization.rst
+++ b/docs/api/authorization.rst
@@ -5,5 +5,8 @@
 
 .. automodule:: pyramid.authorization
 
+  .. autoclass:: ACLHelper
+      :members:
+
   .. autoclass:: ACLAuthorizationPolicy
 
diff --git a/docs/api/config.rst b/docs/api/config.rst
index 4fe0e855d..a925f42d9 100644
--- a/docs/api/config.rst
+++ b/docs/api/config.rst
@@ -35,6 +35,7 @@
 
   :methodcategory:`Using Security`
 
+     .. automethod:: set_security_policy
      .. automethod:: set_authentication_policy
      .. automethod:: set_authorization_policy
      .. automethod:: set_default_csrf_options
diff --git a/docs/api/request.rst b/docs/api/request.rst
index e7b2edc9a..8e0f77b87 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -166,7 +166,11 @@
 
    .. attribute:: authenticated_userid
 
-      .. versionadded:: 1.5
+      .. deprecated:: 2.0
+
+          ``authenticated_userid`` has been replaced by
+          :attr:`authenticated_identity` in the new security system.  See
+          :ref:`upgrading_auth` for more information.
 
       A property which returns the :term:`userid` of the currently
       authenticated user or ``None`` if there is no :term:`authentication
@@ -178,7 +182,11 @@
 
    .. attribute:: unauthenticated_userid
 
-      .. versionadded:: 1.5
+      .. deprecated:: 2.0
+
+          ``unauthenticated_userid`` has been replaced by
+          :attr:`authenticated_identity` in the new security system.  See
+          :ref:`upgrading_auth` for more information.
 
       A property which returns a value which represents the *claimed* (not
       verified) :term:`userid` of the credentials present in the
@@ -193,7 +201,10 @@
 
    .. attribute:: effective_principals
 
-      .. versionadded:: 1.5
+      .. deprecated:: 2.0
+
+          The new security policy has removed the concept of principals.  See
+          :ref:`upgrading_auth` for more information.
 
       A property which returns the list of 'effective' :term:`principal`
       identifiers for this request.  This list typically includes the