From 1431f7bdfa0b1325cbbb87b6cfaa2c6afc2f2dc0 Mon Sep 17 00:00:00 2001 From: Michael Merickel Date: Tue, 24 Dec 2019 14:57:50 -0600 Subject: security policy docs and legacy policy improvements - Added `set_security_policy`` to more places in the docs. - Ensure that the authn/authz policies are not used at all if the legacy policy is not in effect to avoid edge cases where the code would skip the security policy and use the authn/authz policy on accident. - Change deprecation warnings in code to reference the docs by name instead of by URL. --- docs/narr/introspector.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs/narr/introspector.rst') diff --git a/docs/narr/introspector.rst b/docs/narr/introspector.rst index 50f4ac736..40002347c 100644 --- a/docs/narr/introspector.rst +++ b/docs/narr/introspector.rst @@ -302,6 +302,16 @@ introspectables in categories not described here. The :class:`pyramid.interfaces.IRoute` object that is used to perform matching and generation for this route. +``security policy`` + + There will be one and only one introspectable in the ``security policy`` category. + It represents a call to the :meth:`pyramid.config.Configurator.set_security_policy` method (or its Configurator constructor equivalent). + It will have the following data: + + ``policy`` + + The policy object (the resolved ``policy`` argument to ``set_security_policy``). + ``authentication policy`` There will be one and only one introspectable in the ``authentication -- cgit v1.2.3