Prev | Chapter 11. Development Reference | Next

## Groups, Context, Permissions

By Pete Su

OpenACS docs are written by the named authors, and may be edited by OpenACS documentation staff.

### Overview

The OpenACS 5.1.4 Permissions system allows developers and administrators to set access control policies at the object level, that is, any application or system object represented by a row in the `acs_objects` table can be access-controlled via a simple PL/SQL or Tcl interface. The permissions system manages a data model that then allows scripts to check permissions using another simple API call.

Although this may all sound easy and wonderful, no developer or administrator would want to explicitly set access control rights for every user and every object on a site. Therefore, OpenACS 5.1.4 has two auxiliary mechanisms for making this easier: First, the Groups system allows users to be grouped together in flexible ways. Second, the object model defines a notion of object context, which allows applications to group objects together into larger security domains. The rest of this document will talk about each of these parts, and how they fit together with the permissions system.

### Groups

In OpenACS 3.x, the groups system allowed developers and administrators to define simple groupings of users. Each group had a human readable name and unique ID, and there was a single mapping table that mapped users to groups. (The actual data model was more complicated because it contained a meta-data system much like the OpenACS 5.1.4 object type system, but that's not relevant right now.)

The 3.x groups system, while very useful, was limited in few ways. The main limitation: groups could not either contain or include other groups. You could not express the fact that all the members of group A should also be in group B - for example, to model a company with multiple offices. The company should have a main group representing all employees, and each office should have a group representing its employees. Obviously, you'd want every member of an office employee group to automatically be a member of the whole company employee group.

In OpenACS 3.x, you also could not express the fact that group A should itself be a member of group B, without also implying that all of its members are also members of B. This type of relationship also comes up in the real world, though not as often. A good example is an organization like Greenpeace that can have as members both individuals and organizations: although the Sierra Club may be an organization member of Greenpeace, its members are not necessarily members of Greenpeace.

OpenACS 5.1.4 solves both of these modeling problems by introducing a new abstraction called a party. Parties have a recursive definition, and we can illustrate how it works with the following simplified data model. First, we define the `parties` table, where each party has an email address and a URL for contact information.

    create table parties (
        party_id  integer not null references acs_objects(object_id),
        email varchar(100),
        url varchar(100)
    )

Now we define two subtypes of party, one for persons, and one for groups:

    create table groups (
        group_id  not null references parties(party_id),
        group_name varchar(100) not null
    )

    create table persons (
        person_id not null references parties(party_id),
        first_names varchar(100) not null,
        last_name varchar(100) not null
    )

The `users` table is also defined in this data model as a subtype of `person`. It contains many of the basic columns that the old OpenACS 3.x `users` table contained.

Finally, we define two relations, one for group membership and one for group composition. The composition relation allows us to express the fact that every member of group A should also be a member of group B. This relation allows us to define a hierarchy of groups instead of the simple flat groups that 3.x allowed.

The membership relation is much like the mapping we had in 3.x, except that it maps groups to parties instead of groups to users. What this means is that each member of a group is a party rather than just a user. That is, groups consist of members that are either a person or an entire group. This allows us to say that group A should be a member of another group B.

The groups data model is pleasantly recursive. The fact that parties are modeled as being either a person or a group has a lot of power, allowing us to model complex hierarchical groupings of persons and groups that were hard or impossible to model in 3.x.

The full details of the groups data model is beyond the scope of this tutorial - I've just given you what you need to understand how permissions work. For further detail, you can look at Parties in OpenACS 4 or OpenACS 4 Groups Design.

### Permissions

NOTE: Much more detailed information about the permissions system and how to use it is available in the OpenACS Permissions Tediously Explained document.

The permissions data model is actually pretty simple. The data model is a mapping between privileges, parties and objects. We already know what parties and objects are, but we don't know what privileges are.

In OpenACS 5.1.4, a privilege models the right to perform some operation on some object. They are the basic units out of which we build access control policies. For example, in the Unix filesystem we typically implement access control by granting users some combination of read. write or execute privileges on files and directories. In OpenACS 5.1.4, the table of privileges is organized hierarchically so that developers can define privileges that aggregate some set of privileges together. For example, if we have read, write, create and delete privileges, it might be convenient to combine them into a new privilege called "admin". Then if we grant a user this privilege she is automatically granted all the child privileges that the privilege contains. The OpenACS 5.1.4 kernel data model actually defines these privileges as follows:

    begin
     acs_privilege.create_privilege('read');
     acs_privilege.create_privilege('write');
     acs_privilege.create_privilege('create');
     acs_privilege.create_privilege('delete');
     acs_privilege.create_privilege('admin');

     acs_privilege.add_child('admin', 'read');
     acs_privilege.add_child('admin', 'write');
     acs_privilege.add_child('admin', 'create');
     acs_privilege.add_child('admin', 'delete');

     commit;
    end;

To give a user permission to perform a particular operation on a particular object you call `acs_permission.grant_permission` like this:

        acs_permission.grant_permission (
          object_id => some_object_id,
          grantee_id => some_party_id,
          privilege => 'some_privilege_name'
          );

Using just these mechanisms is enough for developers and administrators to effectively define access control for every object in a system. But it would be tedious to explicitly attach permissions to every object individually: in many cases, we'd prefer controlling permissions to large groups of objects in the site, all at once. We use contexts to achieve this goal.

### Object Context

In OpenACS 5.1.4, an object context is a generalization of the scoping mechanism introduced in OpenACS 3.x. "Scoping" and "scope" are terms best explained by example: consider some hypothetical rows in the `address_book` table:

... | `scope` | `user_id` | `group_id` | ...
--- | --- | --- | --- | ---
... | `user` | `123` |  | ...
... | `group` |  | `456` | ...
... | `public` |  |  | ...

The first row represents an entry in User 123's personal address book, the second row represents an entry in User Group 456's shared address book, and the third row represents an entry in the site's public address book.

In this way, the scoping columns identify the security context in which a given object belongs, where each context is either a person or a group of people or the general public (itself a group of people).

In OpenACS 5.1.4, rather than breaking the world into a limited set of scopes, every object lives in a single context. A context is just an another object that represents the security domain to which the object belongs. By convention, if an object A doesn't have any permissions explicitly attached to it, then the system will look at the `context_id` column in `acs_objects` and check the context object there for permissions. Two things control the scope of this search: the structure of the context hierarchy itself, and the value of the `security_inherit_p` flag in each object. If this flag is set to `'t'`, then the automatic search through the context happens, otherwise it does not. You might set this field to `'f'` if you want to override the default permissions in a subtree of some context.

A good example of how to use this hierarchy is in the forums application. With only row-level permissions it is not obvious how to reasonably initialize the access control list when creating a message. At best, we have to explicitly grant various read and write privileges whenever we create a message, which is tedious. In OpenACS 5.1.4, a reasonable thing to do is to create an object representing a forum, and point the `context_id` field of a new message at the forum. Then, suppose we grant every user in the system read-access to this forum. By default, they will automatically have read-access to the new message we just inserted, since the system automatically checks permissions on the message's context. To allow the creator of the message to change the message after it has been posted we grant the user write-access on the message, and we are done.

This mechanism allows developers and administrators to define a hierarchy that matches the structure they need for access control in their application. The following picture shows a typical context hierarchy for a hypothetical site:

A few things to note here. First, the top two contexts in the picture are "magic" in some sense because they are created by default by OpenACS for a specific purpose. The object `default_context` represents the root of the context hierarchy for the entire site. All permission searches walk up the tree to this point and then stop. If you grant permissions on this object, then by default those permissions will hold for every object in the system, regardless of which subsite they happen to live in. The object `security_context_root` has a slightly different role. If some object has no permissions attached to it, and its value for `security_inherit_p` is `'f'`, or `context_id` is null, then we use this context by default.

### Example

At this point, you should either go and download the Notes example code from the package repository, or check it out of the OpenACS CVS repository and add it to your server. The package is called "notes". To check it out from CVS, read the these instructions on how to use anonymous checkouts and then checkout the module `notes`:

The notes code has been modified since this document was written so it is now out of date. See this forum thread.

    % export CVSROOT=:pserver:anonymous@cvs.openacs.org:/cvsroot
    % cvs login # just hit enter when prompted for a password
    % cvs co notes

After you have downloaded the package, look at the `index.tcl` page in the `www` directory. You can also look at the code in your browser. The code should look something like this:

    # main index page for notes.

    ad_page_contract {
       @author you
       @cvs-id $Id$
    } -properties {
      notes:multirow
      context_bar:onevalue
      create_p:onevalue
    }

    set package_id [ad_conn package_id]
    set user_id [ad_conn user_id]

    set context_bar [ad_context_bar]
    set create_p [permission::permission_p \
          -object_id $package_id \
          -privilege create \
          -party_id  $user_id]

    db_multirow notes notes {
      select note_id, owner_id, title, body,
             decode(acs_permission.permission_p(note_id,
                                                :user_id,
                                                'write'),
                    't', 1,
                    'f', 0) as write_p,
             decode(acs_permission.permission_p(note_id,
                                                :user_id,
                                                'admin'),
                    't', 1,
                    'f', 0) as admin_p,
             decode(acs_permission.permission_p(note_id,
                                                :user_id,
                                                'delete'),
                    't', 1,
                    'f', 0) as delete_p
      from notes n, acs_objects o
      where n.note_id = o.object_id
      and o.context_id = :package_id
      and acs_permission.permission_p(note_id, :user_id, 'read') = 't'
      order by creation_date
    }

    ad_return_template

This example shows both the Tcl and PL/SQL APIs for checking permissions. The Tcl proc `permission::permission_p` and the PL/SQL function `acs_permission.permission_p` both return a flag indicating whether the current user has permission to perform the given action. By default, the Tcl procedure extracts the user_id out of the request environment, while the SQL procedure takes it as an argument.

It also shows how we display more complicated items using the template system. The code here creates a multirow data source, i.e. a data source that represents a query returning multiple rows from the database. For each row, we return the ID of the note, the ID of the owner of the note, the title, the body and then three flags that indicate whether the user has write, admin, and delete privileges. Also, the WHERE clause of the query ensures that we only see notes that we are allowed to see.

Next, look at the index.adp. It is pretty complicated. The main part of this page uses a `multiple` template tag. If you want to experiment, you can replace the main body of the `multiple` tag with this:

    <multiple name=notes>
    <td>@notes.title@</td><td>@notes.body</td>
    </multiple>

This will just make a table with one note per row.

Now put the more complex code back. You'll notice a lot of stuff like this:

    <if @notes.write_p@ eq 1>
      <a href=add-edit?note_id=@notes.note_id@>@notes.title@</a>
    </if>
    <else>
      @notes.title@
    </else>

This displays the title of the note as either a link or plain text depending on whether or not we have write privileges on the object. The `if` tag is something that the OpenACS 5.1.4 template system defines for you to support conditional presentation. The templates developer guide provides more information about this.

If you study the rest of the system, you will also notice that the notes application doesn't explicitly attach privileges to the objects it creates. All privileges are inherited from the context of the object which in this case is the package instance. The assumption is that the administrator of the site would create one instance of notes for every user that wants it, and set the permissions on this instance appropriately. In a more advanced version of the application, we could implement a user interface that allowed the user to explicitly attach permissions to notes that she wanted to make public or whatever. But that's beyond the scope of this example.

### Summary

OpenACS 5.1.4 defines three separate mechanisms for specifying access control in applications. The Groups data model allows you to define hierarchical organizations of users and groups of users. The Permissions data model allows you to define a hierarchy of user rights. Finally, the Context hierarchy allows you to define organize default permissions in a hierarchical fashion. A simple PL/SQL or Tcl API is then used to do access control checks in application pages.

In the next section, we'll look at a more complex page for adding and editing notes, and discuss these issues further.

($Id$)

Prev | Home | Next
Using Templates in OpenACS | Up | Writing OpenACS Application Pages

View comments on this page at openacs.org