Index: openacs-4/packages/acs-core-docs/www/permissions.html =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/permissions.html,v diff -u -N -r1.40 -r1.41 --- openacs-4/packages/acs-core-docs/www/permissions.html 16 Feb 2005 00:21:03 -0000 1.40 +++ openacs-4/packages/acs-core-docs/www/permissions.html 4 Jun 2006 00:45:24 -0000 1.41 @@ -1,8 +1,9 @@ -Groups, Context, Permissions

Groups, Context, Permissions

By Pete Su

+ +Groups, Context, Permissions

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.2.0d1 Permissions system allows developers and administrators to +The OpenACS 5.2.3b1 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 @@ -13,7 +14,7 @@ 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.2.0d1 has two auxiliary mechanisms for making this +site. Therefore, OpenACS 5.2.3b1 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 @@ -25,7 +26,7 @@ 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.2.0d1 object type system, +contained a meta-data system much like the OpenACS 5.2.3b1 object type system, but that's not relevant right now.)

The 3.x groups system, while very useful, was limited in few ways. The @@ -47,7 +48,7 @@ member of Greenpeace, its members are not necessarily members of Greenpeace.

-OpenACS 5.2.0d1 solves both of these modeling problems by introducing a new +OpenACS 5.2.3b1 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 @@ -113,18 +114,18 @@ already know what parties and objects are, but we don't know what privileges are.

-In OpenACS 5.2.0d1, a privilege models the right to perform some operation on +In OpenACS 5.2.3b1, 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.2.0d1, +read. write or execute privileges on files and directories. In OpenACS 5.2.3b1, 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 +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.2.0d1 kernel data model actually defines these +contains. The OpenACS 5.2.3b1 kernel data model actually defines these privileges as follows:

 
@@ -164,8 +165,8 @@
 permissions to large groups of objects in the site, all at once. We
 use contexts to achieve this goal.
 

Object Context

-In OpenACS 5.2.0d1, an object context is a generalization of the scoping -mechanism introduced in OpenACS 3.x. "Scoping" and "scope" are terms best +In OpenACS 5.2.3b1, 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:

...scopeuser_idgroup_id...
...user123...
...group456...
...public...

@@ -179,7 +180,7 @@ person or a group of people or the general public (itself a group of people).

-In OpenACS 5.2.0d1, rather than breaking the world into a limited set of scopes, +In OpenACS 5.2.3b1, 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 @@ -196,7 +197,7 @@ 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.2.0d1, +privileges whenever we create a message, which is tedious. In OpenACS 5.2.3b1, 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 @@ -210,9 +211,9 @@ 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 +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 @@ -227,7 +228,7 @@ 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 +"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
@@ -329,7 +330,7 @@
 

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.2.0d1 template system +The if tag is something that the OpenACS 5.2.3b1 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 @@ -343,7 +344,7 @@ permissions to notes that she wanted to make public or whatever. But that's beyond the scope of this example.

Summary

-OpenACS 5.2.0d1 defines three separate mechanisms for specifying access control +OpenACS 5.2.3b1 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,