pyramid.security
¶
Authentication API Functions¶
-
authenticated_userid
(request)[source]¶ Return the userid of the currently authenticated user or
None
if there is no authentication policy in effect or there is no currently authenticated user.
-
unauthenticated_userid
(request)[source]¶ Return an object which represents the claimed (not verified) user id of the credentials present in the request.
None
if there is no authentication policy in effect or there is no user data associated with the current request. This differs fromauthenticated_userid()
, because the effective authentication policy will not ensure that a record associated with the userid exists in persistent storage.
-
effective_principals
(request)[source]¶ Return the list of ‘effective’ principal identifiers for the
request
. This will include the userid of the currently authenticated user if a user is currently authenticated. If no authentication policy is in effect, this will return an empty sequence.
-
forget
(request)[source]¶ Return a sequence of header tuples (e.g.
[('Set-Cookie', 'foo=abc')]
) suitable for ‘forgetting’ the set of credentials possessed by the currently authenticated user. A common usage might look like so within the body of a view function (response
is assumed to be an WebOb -style response object computed previously by the view code):from pyramid.security import forget headers = forget(request) response.headerlist.extend(headers) return response
If no authentication policy is in use, this function will always return an empty sequence.
-
remember
(request, principal, **kw)[source]¶ Return a sequence of header tuples (e.g.
[('Set-Cookie', 'foo=abc')]
) suitable for ‘remembering’ a set of credentials implied by the data passed asprincipal
and*kw
using the current authentication policy. Common usage might look like so within the body of a view function (response
is assumed to be a WebOb -style response object computed previously by the view code):from pyramid.security import remember headers = remember(request, 'chrism', password='123', max_age='86400') response.headerlist.extend(headers) return response
If no authentication policy is in use, this function will always return an empty sequence. If used, the composition and meaning of
**kw
must be agreed upon by the calling code and the effective authentication policy.
Authorization API Functions¶
-
has_permission
(permission, context, request)[source]¶ Provided a permission (a string or unicode object), a context (a resource instance) and a request object, return an instance of
pyramid.security.Allowed
if the permission is granted in this context to the user implied by the request. Return an instance ofpyramid.security.Denied
if this permission is not granted in this context to this user. This function delegates to the current authentication and authorization policies. Returnpyramid.security.Allowed
unconditionally if no authentication policy has been configured in this application.
-
principals_allowed_by_permission
(context, permission)[source]¶ Provided a
context
(a resource object), and apermission
(a string or unicode object), if a authorization policy is in effect, return a sequence of principal ids that possess the permission in thecontext
. If no authorization policy is in effect, this will return a sequence with the single valuepyramid.security.Everyone
(the special principal identifier representing all principals).Note
even if an authorization policy is in effect, some (exotic) authorization policies may not implement the required machinery for this function; those will cause a
NotImplementedError
exception to be raised when this function is invoked.
-
view_execution_permitted
(context, request, name='')[source]¶ If the view specified by
context
andname
is protected by a permission, check the permission associated with the view using the effective authentication/authorization policies and therequest
. Return a boolean result. If no authorization policy is in effect, or if the view is not protected by a permission, returnTrue
.
Constants¶
-
Everyone
¶ The special principal id named ‘Everyone’. This principal id is granted to all requests. Its actual value is the string ‘system.Everyone’.
-
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 authentication policy). Its actual value is the string ‘system.Authenticated’.
-
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 usesALL_PERMISSIONS
might be composed like so:('Deny', 'system.Everyone', ALL_PERMISSIONS)
.
-
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¶
-
Allow
¶ The ACE “action” (the first element in an ACE e.g.
(Allow, Everyone, 'read')
that means allow access. A sequence of ACEs makes up an ACL. It is a string, and it’s actual value is “Allow”.
-
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 it’s actual value is “Deny”.
-
class
ACLDenied
[source]¶ An instance of
ACLDenied
represents that a security check made explicitly against ACL was denied. It evaluates equal to all boolean false types. It also has attributes which indicate which acl, ace, permission, principals, and context were involved in the request. Its __str__ method prints a summary of these attributes for debugging purposes. The same summary is available as themsg
attribute.
-
class
ACLAllowed
[source]¶ An instance of
ACLAllowed
represents that a security check made explicitly against ACL was allowed. It evaluates equal to all boolean true types. It also has attributes which indicate which acl, ace, permission, principals, and context were involved in the request. Its __str__ method prints a summary of these attributes for debugging purposes. The same summary is available as themsg
attribute.