From e47e7f457a6143dda28f9dd1674c53b1ece67f9d Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 17 Feb 2019 12:23:27 -0800 Subject: Add `security policy` and `identity` to glossary. Also mark authn/authz as deprecatd. --- docs/glossary.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index cd472a660..8a1d27734 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -306,6 +306,16 @@ Glossary a principal, but this is not strictly necessary in custom policies that define their principals differently. + identity + An identity is an opaque identifier of the user associated with the + current request. + + security policy + A security policy in :app:`Pyramid` terms is a bit of code which has an + API which identifies the user associated with the current request (perhaps + via a cookie or ``Authorization`` header) and determines whether or not + that user is permitted to access the requested resource. + authorization policy An authorization policy in :app:`Pyramid` terms is a bit of code which has an API which determines whether or not the @@ -313,11 +323,19 @@ Glossary associated with a permission, based on the information found on the :term:`context` resource. + .. deprecated:: 2.0 + Authorization policies have been deprecated in favor of a + :term:`security policy`. + authentication policy An authentication policy in :app:`Pyramid` terms is a bit of code which has an API which determines the current :term:`principal` (or principals) associated with a request. + .. deprecated:: 2.0 + Authentication policies have been deprecated in favor of a + :term:`security policy`. + WSGI `Web Server Gateway Interface `_. This is a Python standard for connecting web applications to web servers, -- cgit v1.2.3 From 4c95ccd5e9b9657165f6ba061ee795fc4a5fcd30 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 12 May 2019 12:13:26 -0700 Subject: Narrative docs WIP --- docs/glossary.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 8a1d27734..5d374e0ec 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -307,8 +307,9 @@ Glossary define their principals differently. identity - An identity is an opaque identifier of the user associated with the - current request. + An identity is an object identify the user associated with the + current request. The identity can be any object, but should implement a + ``__str__`` method for logging and debugging purposes. security policy A security policy in :app:`Pyramid` terms is a bit of code which has an -- cgit v1.2.3 From d2d20b92158088e7d646393733092e67120058f0 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Sun, 21 Jul 2019 09:20:44 -0700 Subject: Un-deprecate authenticated_userid. --- docs/glossary.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 5d374e0ec..b850f6e3e 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -298,18 +298,14 @@ Glossary foo` and `group bar`. userid - A *userid* is a string used to identify and authenticate - a real-world user or client. A userid is supplied to an - :term:`authentication policy` in order to discover the user's - :term:`principals `. In the authentication policies which - :app:`Pyramid` provides, the default behavior returns the user's userid as - a principal, but this is not strictly necessary in custom policies that - define their principals differently. + A *userid* is the string representation of an :term:`identity`. Just like + the identity, it should identify the user associated with the current + request. Oftentimes this is the ID of the user object in a database. identity An identity is an object identify the user associated with the current request. The identity can be any object, but should implement a - ``__str__`` method for logging and debugging purposes. + ``__str__`` method that outputs a corresponding :term:`userid`. security policy A security policy in :app:`Pyramid` terms is a bit of code which has an -- cgit v1.2.3 From cdb26610782176955cd8cfb0b3c3e242ca819f74 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Mon, 26 Aug 2019 15:25:53 -0700 Subject: Doc fix via @mmerickel Co-Authored-By: Michael Merickel --- docs/glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index b850f6e3e..36272f08c 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -303,7 +303,7 @@ Glossary request. Oftentimes this is the ID of the user object in a database. identity - An identity is an object identify the user associated with the + An identity is an object identifying the user associated with the current request. The identity can be any object, but should implement a ``__str__`` method that outputs a corresponding :term:`userid`. -- cgit v1.2.3