In the last chapter we built authentication
into our wiki. We also went one step further and used the request.identity
object to perform some explicit authorization
checks. This is fine for a lot of applications, but Pyramid
provides some facilities for cleaning this up and decoupling the constraints from the view function itself.
We will implement access control with the following steps:
- Update the
security policy
to break down theidentity
into a list ofprincipals <principal>
(security.py
). - Utilize the
pyramid.authorization.ACLHelper
to support a per-context mapping of principals to permissions (security.py
). - Add new
resource
definitions that will be used as thecontext
for the wiki pages (routes.py
). - Add an
ACL
to each resource (routes.py
). - Replace the inline checks on the views with
permission
declarations (views/default.py
).
A principal
is a level of abstraction on top of the raw identity
that describes the user in terms of its capabilities, roles, or other identifiers that are easier to generalize. The permissions are then written against the principals without focusing on the exact user involved.
Pyramid
defines two builtin principals used in every application: pyramid.authorization.Everyone
and pyramid.authorization.Authenticated
. On top of these we have already mentioned the required principals for this application in the original design. The user has two possible roles: editor
or basic
. These will be prefixed by the string role:
to avoid clashing with any other types of principals.
Open the file tutorial/security.py
and edit it as follows:
src/authorization/tutorial/security.py
Only the highlighted lines need to be added.
Note that the role comes from the User
object. We also add the user.id
as a principal for when we want to allow that exact user to edit pages which they have created.
We're using the pyramid.authorization.ACLHelper
, which will suffice for most applications. It uses the context
to define the mapping between a principal
and permission
for the current request via the __acl__
method or attribute.
The permits
method completes our implementation of the pyramid.interfaces.ISecurityPolicy
interface and enables our application to use pyramid.request.Request.has_permission
and the permission=
constraint on views.
Resources and context are the hidden gems of Pyramid
. You've made it!
Every URL in a web application represents a resource
(the "R" in Uniform Resource Locator). Often the resource is something in your data model, but it could also be an abstraction over many models.
Our wiki has two resources:
- A
NewPage
. Represents a potentialPage
that does not exist. Any logged-in user, having either role ofbasic
oreditor
, can create pages. - A
PageResource
. Represents aPage
that is to be viewed or edited.editor
users, as well as the original creator of thePage
, may edit thePageResource
. Anyone may view it.
Note
The wiki data model is simple enough that the PageResource
is mostly redundant with our models.Page
SQLAlchemy class. It is completely valid to combine these into one class. However, for this tutorial, they are explicitly separated to make clear the distinction between the parts about which Pyramid
cares versus application-defined objects.
There are many ways to define these resources, and they can even be grouped into collections with a hierarchy. However, we're keeping it simple here!
Open the file tutorial/routes.py
and edit the following lines:
src/authorization/tutorial/routes.py
The highlighted lines need to be edited or added.
The NewPage
class has an __acl__
on it that returns a list of mappings from principal
to permission
. This defines who can do what with that resource
. In our case we want to allow only those users with the principals of either role:editor
or role:basic
to have the create
permission:
src/authorization/tutorial/routes.py
The NewPage
is loaded as the context
of the add_page
route by declaring a factory
on the route:
src/authorization/tutorial/routes.py
The PageResource
class defines the ACL
for a Page
. It uses an actual Page
object to determine who can do what to the page.
src/authorization/tutorial/routes.py
The PageResource
is loaded as the context
of the view_page
and edit_page
routes by declaring a factory
on the routes:
src/authorization/tutorial/routes.py
At this point we've modified our application to load the PageResource
, including the actual Page
model in the page_factory
. The PageResource
is now the context
for all view_page
and edit_page
views. Similarly the NewPage
will be the context for the add_page
view.
Open the file tutorial/views/default.py
.
First, you can drop a few imports that are no longer necessary:
src/authorization/tutorial/views/default.py
Edit the view_page
view to declare the view
permission, and remove the explicit checks within the view:
src/authorization/tutorial/views/default.py
The work of loading the page has already been done in the factory, so we can just pull the page
object out of the PageResource
, loaded as request.context
. Our factory also guarantees we will have a Page
, as it raises the HTTPNotFound
exception if no Page
exists, again simplifying the view logic.
Edit the edit_page
view to declare the edit
permission:
src/authorization/tutorial/views/default.py
Edit the add_page
view to declare the create
permission:
src/authorization/tutorial/views/default.py
Note the pagename
here is pulled off of the context instead of request.matchdict
. The factory has done a lot of work for us to hide the actual route pattern.
The ACLs defined on each resource
are used by the security
policy
to determine if any principal
is allowed to have some permission
. If this check fails (for example, the user is not logged in) then an HTTPForbidden
exception will be raised automatically. Thus we're able to drop those exceptions and checks from the views themselves. Rather we've defined them in terms of operations on a resource.
The final tutorial/views/default.py
should look like the following:
src/authorization/tutorial/views/default.py
We can finally examine our application in a browser (See wiki2-start-the-application
). Launch a browser and visit each of the following URLs, checking that the result is as expected:
- http://localhost:6543/ invokes the
view_wiki
view. This always redirects to theview_page
view of theFrontPage
page object. It is executable by any user. http://localhost:6543/login invokes the
login
view, and a login form will be displayed. On every page, there is a "Login" link in the upper right corner while the user is not authenticated, else it is a "Logout" link when the user is authenticated.Supplying the credentials with either the username
editor
and passwordeditor
, or usernamebasic
and passwordbasic
, will authenticate the user and grant access for that group.After logging in (as a result of hitting an edit or add page and submitting valid credentials), we will see a "Logout" link in the upper right hand corner. When we click it, we are logged out, redirected back to the front page, and a "Login" link is shown in the upper right hand corner.
- http://localhost:6543/FrontPage invokes the
view_page
view of theFrontPage
page object. - http://localhost:6543/FrontPage/edit_page invokes the
edit_page
view for theFrontPage
page object. It is executable by only theeditor
user. If a different user invokes it, then the "403 Forbidden" page will be displayed. If an anonymous user invokes it, then a login form will be displayed. - http://localhost:6543/add_page/SomePageName invokes the
add_page
view for a page. If the page already exists, then it redirects the user to theedit_page
view for the page object. It is executable by either theeditor
orbasic
user. If an anonymous user invokes it, then a login form will be displayed. - http://localhost:6543/SomePageName/edit_page invokes the
edit_page
view for an existing page, or generates an error if the page does not exist. It is editable by thebasic
user if the page was created by that user in the previous step. If instead the page was created by theeditor
user, then the login page should be shown for thebasic
user.