Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
outlinetrue
stylenone

Tracked as SYNCOPE-119.

Also see [DISCUSS] Dynamic Realms.

This topic dates very early in Syncope's history (the mail thread referenced in the issue mentioned above was started in 2011, even before entering the incubator).

...

The idea is to introduce the concept of realm - widely employed elsewhere as a mean to define security constraints in order to restrict access to shared ' resources'.

Entity changes

  1. Create the new Realm entity, with the following characteristics:
    1. has a name and a parent realm (except for the pre-defined root realm, which is named '/');
    2. will be either leaf or root of a sub-tree of realms;
    3. is uniquely identified by the path from root realm, e.g. /a/b/c identifies the sub-realm 'c' in the sub-tree rooted at 'b', having in turn 'a' as parent realm, directly under root realm;
    4. optionally refers to account or password policies.
  2. Update Rename the Role entity byto Group and
    1. removing remove inheritance;
    2. removing remove references to account or password policies;
    3. remove references to entitlements;
    4. adding add reference to a realm: each role group of a sub- realm will also be role of its parent realm;group of sub-realms (as group is a specialization of any objects);
  3. Rename all ROLE_* entitlements to GROUP_*
  4. Create the new Role entity, with the following characteristics:
    1. has multiple references to entitlements;
    2. has adding multiple reference to realms: selected entitlements will be associated to the given realms (and sub-realms).
  5. Update the User entity by
    1. adding reference to a realm: each user of a sub- realm will also be user of its parent realm.sub-realms (as user is a specialization of any objects);
  6. There won't be global account or password policies any more, but simply account / password policies for the root realm; account and password policies can be optionally defined for a given sub-realm: in this case the resulting policy to be applied will be the composition of all defined policies for ancestor realms up to root realm.

...

beforeafterdescription
 

GET /realms

GET /realms/a/b

list realms starting at given root:
all realms in the former case, realms rooted at /a/b in the latter case
 GET /realms/a/b/cread realm /a/b/c
 POST /realms/a/bcreate realm under /a/b
 PUT /realms/a/b/c/d

update realm /a/b/c/d

 DELETE /realms/a/bdelete realm /a/b (and all sub-realms)
GET /usersGET /users
GET /users;realm=/a/b 
list users under the given realm (e.g. assigned to given realm and related sub-realms):
all users in the former case, users in realm /a/b (all all sub-realms) in the latter case
POST /usersPOST /users
POST /users?realm=/a/b 
create user under the given realm:
root realm in the former case, /a/b in the latter case 
 PUT /users/{userId}?realm=/a/b/{userId}move user with id {userId} under realm /a/b
GET /users/searchGET /users/search
GET /users/search;realm=/a/b/search 
search users under the given realm:
root realm in the former case, /a/b in the latter case
GET /rolesGET /rolesgroups
GET /rolesgroups;realm=/a/b 
see users
POST /roles

POST /rolesgroups
POST /rolesgroups?realm=/a/b

see users
 PUT /roles/groups/{groupId}?realm=/a/b/{roleId}move role group with id {roleIdgroupId} under realm /a/b
GET /roles/searchGET /rolesgroups/search
GET /roles/groups/search;realm=/a/b/search 
see users
GET /roles/{roleId}/parent  
GET /roles/{roleId}/children  

...

The idea is that any user U assigned to a role R, which provides entitlements E1...En for realms Re1...Rek can exercise Ei on entities (users or rolesgroups, depending on the type of Ei) under any Rej or related sub-realms.

About group membership and any relationships (see the related discuss page for details):

  • User U can be member of group G either if U and G are in the same realm, or G is in one of super-realms of the realm of U
  • Any A1 can be in relationship with any A2 either if A1 and A2 are in the same realm, or A2 is in one of super-realms of the realm of A1

The rationale behind such conditions is to allow the definition of common groups and any objects (to enter in relationship with) at the topmost position in the realm tree, so that they can be shared by various realm sub-trees.

Example

Let's rephrase the sample used for current security model:

Let's suppose that we want to implement the following scenario:
Administrator A can create users under realm R5 but not under realm R7, administrator B can update users under realm R6 and R8, administrator C can update roles groups under realm R8.

As default, Syncope will have defined the following entitlements, among others:

  • USER_CREATEUSER_UPDATE,   ROLEGROUP_UPDATE

Here it follows how entitlements should be assigned (via roles) to administrators in order to implement the scenario above:

  • A: USER_CREATE on R5
  • B: USER_UPDATE on R6 and R8
  • C: ROLEGROUP_UPDATE on R8

...

  • R8

...

  • D: ROLE_READ + ROLE_CREATE + ROLE_UPDATE + ROLE_DELETE only on role R (not the whole realm R8)