...
SecurityUtils is an important class because it shields client code from the complexity of the security implementation (e.g. voters, ACL holders, etc). Below is a class diagram along with the two clients that use SecurityUtils for authorization purposes.
| Panel | |||||
|---|---|---|---|---|---|
| |||||
Access Control Lists
In the Pentaho BI Platform, objects in the solution repository (e.g. files and directories) can be secured using access control lists (ACLs). You can have any number of entries in an ACL--each specifying a different recipient.
...
ACL Entries
An entry in an access control list consists of a recipient, permissions, a reference to the object to which the ACL entry applies, and optionally the parent of the object to which the ACL entry applies. The default ACL entry type in Pentaho is
...
PentahoAclEntry
...
. This class extends
...
AbstractBasicAclEntry Acegi.
Recipients
PentahoAclEntry stores a recipient as an
...
Object
...
. In practice, recipients can be of two types: a
...
String
...
containing a username or a
...
...
containing a granted authority.
...
Permissions
...
PentahoAclEntry
...
stores permissions using
...
...
.
Objects and Parents
...
PentahoAclEntry
...
stores an object (and its parent) as a
...
AclObjectIdentity Acegi.
ACL Holders
An IAclHolder does exactly what its name implies--it holds or contains an access control list. An ACL is implemented in the platform using a
...
java.util.List
...
. Inside this list are implementations of
...
...
Acegi
| title | SecurityUtils along with its major\ !SecurityUtils.png | |||
|---|---|---|---|---|
| align | center!\\ \\ {null}\h2. Access Control Lists In the Pentaho BI Platform, objects in the solution repository (e.g. files and directories) can be secured using [access control lists | |||
| Panel | ||||
| ||||
| Panel | ||||
| Panel | ||||
|
...
Solution Repository Objects
Once you have a container for an ACL, how is it associated with objects in the solution repository? That is where the interface IAclSolutionFile comes in. This interface extends IAclHolder and is implemented by com.pentaho.repository.dbbased.solution.RepositoryFile. RepositoryFile also implements AclObjectIdentity. So not only does a RepositoryFile store an ACL (since it implements IAclHolder), it also is a securable object (since it implements AclObjectIdentity).
Persistence
The Pentaho BI Platform uses Hibernate for reading and writing to the db-based repository. The PRO_FILES table contains solution repository objects while the PRO_ACLS_LIST table contains ACL entries associated with those objects. Below are (incomplete) listings of the columns of each of these tables.
PRO_FILES Table
FILE_ID | PARENT | FILENAME | FULLPATH | DATA | DIRECTORY | LASTMODIFIED |
FILE_ID is the primary key. PARENT is a reference (by file id) to the object's parent. DIRECTORY is a boolean that is true if this object is a directory and false if this object is a file.
PRO_ACLS_LIST Table
ACL_ID | ACL_MASK | RECIPIENT |
Technically, rows in this table represent ACL entries, not ACLs. An ACL for an object can be created by querying for all rows sharing the same ACL_ID. ACL_ID is a foreign key that references PRO_FILES.FILE_ID. ACL_MASK is the decimal representation of the bit mask that represents the permissions in this ACL entry. And RECIPIENT is the username or granted authority that is the recipient of this ACL entry.
Voters
For every domain object, there is exactly one access control list. Add to that a user that wants to perform some operation on that object and that adds up to three inputs: a recipient, an operation, and an ACL. But what makes the "access granted" or "access denied" decision given these three pieces of information? The answer to that question is an IAclVoter. An instance of IAclVoter contains an all-important hasAccess method. It takes the three aforementioned inputs and returns a boolean result: true meaning access granted and false meaning access denied. An ACL voter is a singleton; there is only one instance per Java virtual machine. It is specified in pentaho.xml.
One might ask: How many ways can a voter arrive at a decision? Assume that user sally has the following granted authorities: ROLE_DEV and ROLE_MGR. Also assume that the ACL for a particular object contains the following entries: (sally, read), (ROLE_DEV, readwrite). Both ACL entries are applicable to sally since the first specifies sally (and she is sally) and the second specifies ROLE_DEV (and she has been granted the ROLE_DEV authority). Should the voter grant or deny a request to write to the object associated with this ACL? This is where extensibility of the voting system comes in. The Pentaho BI Platform provides multiple implementations of IAclVoter that each make different decisions in this situation! As the user of the platform, you decide how access decisions are made through your choice of IAclVoter. For more information about IAclVoter implementations, see 12. IAclVoter Node.
| Panel | ||||
|---|---|---|---|---|
| ||||
| Panel | ||||
| Panel | ||||
|
ACL Management
| Anchor | ||||
|---|---|---|---|---|
|
...
| Panel | ||||
|---|---|---|---|---|
| ||||
| Panel | ||||
| ||||
In the sample page above, the tree on the left represents all of the solution repository objects in your solution repository. You can set permissions on any level in the solution repository object tree. Setting permissions on lower level objects in the tree overrides permission settings higher in the tree. Conversely, if you set a permission on a solution repository object that has children, and the children do not have specific permissions set, they inherit the permissions settings from their parent. So, for example, if you set Execute permissions for JoeUser on the analysis object, then the query1.xaction object inherits that Execute permission; however, if you then set Create and Execute permission on the query1.xaction for JoeUser, these permissions are honored for that object, but other children of the analysis object would still only have their parent's (analysis) Execute permission.
...