diff options
| author | Karl O. Pinc <kop@meme.com> | 2014-08-12 22:10:03 -0500 |
|---|---|---|
| committer | Karl O. Pinc <kop@meme.com> | 2014-08-12 22:10:03 -0500 |
| commit | c7afe4e43ab19a5e8274988fe8dd004c04c160a1 (patch) | |
| tree | df74716d3cbb042d0c28e2625206c2d1ae92a496 /docs | |
| parent | 81719b800cfea1c6fd68427ea1d9c0a2f3e6c1dd (diff) | |
| download | pyramid-c7afe4e43ab19a5e8274988fe8dd004c04c160a1.tar.gz pyramid-c7afe4e43ab19a5e8274988fe8dd004c04c160a1.tar.bz2 pyramid-c7afe4e43ab19a5e8274988fe8dd004c04c160a1.zip | |
Security: Change "principal" argument in security.remember() to "userid".
Make the change througout the authentication policies, etc. as well.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/narr/security.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/narr/security.rst b/docs/narr/security.rst index 57d7ac38f..16718cfa4 100644 --- a/docs/narr/security.rst +++ b/docs/narr/security.rst @@ -104,9 +104,9 @@ For example: The above configuration enables a policy which compares the value of an "auth ticket" cookie passed in the request's environment which contains a reference -to a single :term:`principal` against the principals present in any -:term:`ACL` found in the resource tree when attempting to call some -:term:`view`. +to a single :term:`userid` and matches that userid's principals against the +principals present in any :term:`ACL` found in the resource tree when +attempting to call some :term:`view`. While it is possible to mix and match different authentication and authorization policies, it is an error to configure a Pyramid application @@ -616,11 +616,11 @@ that implements the following interface: as ``pyramid.security.Everyone`` and ``pyramid.security.Authenticated``. """ - def remember(self, request, principal, **kw): + def remember(self, request, userid, **kw): """ Return a set of headers suitable for 'remembering' the - principal named ``principal`` when set in a response. An - individual authentication policy and its consumers can decide - on the composition and meaning of **kw. """ + userid named ``userid`` when set in a response. An + individual authentication policy and its consumers can + decide on the composition and meaning of **kw. """ def forget(self, request): """ Return a set of headers suitable for 'forgetting' the |
