ToDo

Team

OAGi

• Primary contact: @Jim Wilson, Jim.Wilson@OAGi.org, +1 816-516-8847

• Secondary contact: @Michael Figura, MFigura@OAGi.org, +1 404-395-8267

NIST

• Score project manager: @Serm Kulvatunyou, Serm@NIST.gov

• Score lead dev: @Oh, Hakju (IntlCtr), Hakju.Oh@NIST.gov

Accedia

• Account manager and PM: @Aleksandar Todorov (Deactivated), aleksandar.todorov@accedia.com

• Primary dev: @Stefani Paunova (Deactivated), stefani.paunova@accedia.com

• Tech consultant: @Georgi Yolovski (Deactivated), georgi.yolovski@accedia.com

Resources (access todo)

Terminology notes

• It is debatable whether multi-tenant is appropriate to describe this feature, but the name has stuck, so we’re using it.

• role is a critical feature of authorization in this requirements document. Auth0 provides the capability to create users, roles, and user-role associations. In this requirements document, we will use role-related terms as follows:

  • Score role: One of the built-in Score roles (Admin+Developer, Admin+End User, Developer, and End User)

  • Auth0 role: A role defined in Auth0

  • tenant: An Auth0 role defined for the purposes of enabling the requirements expressed in the document.

  • role: The meaning could be any of the above depending on the context in which it is used. @Jim Wilson recommends avoiding use of role in favor of one of the three terms above.

• access BIEs refers to creating, editing, viewing, and expressing BIEs (anything with BIEs)

Background

OAGi needs:

1. to enable multiple sets of users to use one Score instance

2. to be able to limit access to BIEs created by one set of users to members of that set, and other select sets as appropriate

Key points informing the design

1. Keep the implementation simple until such time that simple won’t work.

2. The following BIE-development roles/purposes must be supported

   1. OAGi develops BIEs for the public (e.g., SME Express Pack)

   2. OAGi develops BIEs for members only (none yet)

   3. Companies develop BIEs for their company only

   4. Companies develop BIEs for their industry (e.g., MilliporeSigma for the Biopharma industry)

   5. Industry associations or consortiums develop BIEs for their industry (e.g., AgGateway)

3. Except for 2.c., there is little/no risk for a company’s confidential information to be publicly disclosed.

4. In the case of 2.c. for company whose BIE design or documentation is highly sensitive, OAGi should advise them to use an on-prem instance.

5. Each BIE must be “in” a business context.

Design

Identity Provider

OAGi has an Auth0 account and has been using it for #E authentication and authorization. Following are a couple of screen captures that illustrate how it can be configured to support Score multi-tenant.

Open

Figure 1

Open

Figure 2

Multi-tenant Score design

1. This design only affects BIE access. This design would not apply to CC access.

2. Score will use Auth0 for authentication and authorization.

   1. Out of the box, Auth0 supports

      1. Managing users

      2. Managing roles

      3. Managing user-role relationships

3. Only administrators may manage business contexts in Score.

4. Each business context may have zero-to-many roles associated with it (managed only by administrators). See Figure 3.

   1. There are many ways to design the UI to show roles associated with a business context and to add/delete them. Figure 3 is just one example.

   2. The built-in roles will be supported (end user, developer, admin) as Score_End_User, Score_Developer, and Score_Admin roles in Auth0.

   3. Tenant role names in Auth0 will begin with Score_Tenant_ followed by a short name. E.g., Score_Tenant_AgGateway.

5. A user may only access BIEs associated with business contexts that are associated with one of the user’s roles.

Logical process for determining what BIEs to show in the BIE list

See NIST/OAGi Score.

• For each BIE

  • For each of the BIE’s business contexts

    • For each of the business context’s roles

      • Is the user in that role?

        • Yes: Show the BIE in the list.

        • No: Don’t show the BIE in the list

Concrete example

Score roles

Example tenants

Business contexts

• Human Resources

• Agriculture

• Construction

• Entertainment

Users

• Bob

• Mary

• Amy

• Roy

• Matt

• Tess

• Ross

BIEs - Business Contexts

Users - Roles

Business Contexts - Roles

BIE Visibility to Users

This table would be computed based on the values in the tables above.

• Mary can access all BIEs because she is in the Score role Admin+Developer. Users in the Score roles Admin+Developer or Admin+End User can see everything.

• Matt can only access BIEs in a business context associated with the ACME Brick tenant.

• Tess can only access BIEs in a business context associated with the AgGateway tenant.

• Ross can only access BIEs in a business context associated with the ACME Brick tenant or the AgGateway tenant, which in this example computes to be all of them.

Analysis about how this change could impact current on-prem users (and existing OAGi instances of Score), assuming we go with the business context (BC) approach

1. There is no difference between being admin or not being admin in term of the BIEs Access. So, it is okay to simply refer to Developer and End User here. But these have to be differentiated in the authentication server.

2. When current instances of Score get upgraded to a multi-tenant version, roles have to be assigned to existing business contexts. Here are to options to keep the current accesses to existing BIEs

   1. Business contexts that have no roles assigned are accessible by any Score role or tenant.

   2. Assume that Developer, Admin+Developer, End User, and Admin+End User can always access all BIEs even though these roles are not associated with business contexts.

   3. All existing business contexts will be assigned all four roles when making upgrade to the multi-tenant version.

   4. Apparently, approach (a) is simpler. And for convenience, we mighty assume (c) as well. I don’t see any issue with that at this point. It means that the current BIEs in OAGi instances will be accessible to all, but that can also be changed later on.

3. About the business contexts, currently anybody can manage business context. If the multi-tenant version restricts this to only Admin Developer or Developer, this can cause an issue with existing customers.

   1. Alternatives are:

      1. Make it an installation option to who can manage the BCs.

      2. Make an inform decision with current users. Maybe this is a best practice to limit BC management to only Developer role.

      3. Change the multi-tenant requirement to “Only Developer can manage BC/Role Assignment”. In other words, everyone is still free to create and manage the BC content itself but only Developer can assign roles to BCs. We have to think about BCs discard function, b/c right now anyone can discard BCs if there is no associated BIE - and this is likely still ok.

   2. Option (iii) seems simplest.

So this seems quite manageable.

Analysis between using Business Context & Role vs. using only Role to control BIE access

Additional things to consider

1. Are all other user roles that are not Developer, Admin Developer, End User, and Admin End User considered subclasses of End User role? In other words, users in these roles inherit behavior of End User, e.g., they cannot create account, they cannot manage developer CCs, they can extend BIEs.

2. Note that if they can extend BIEs, it means that we have to also implement access logic on the CC side where they can manage only end user CCs. However, end user CCs have no BC assigned, so how to we infer access authorization? <serm>I couldn’t think of a nice and simple solution to this. The simplest thing to do, which sounds like a hack, is to do not allow BIE extension for users that are not End User or Admin End User. Another option is to inferred, roles associated with CCs from BIEs they are used in, but some EUCCs may not yet be used in any BIEs. Or we can say that if they are not used yet then only the owner can access it. </serm>. EUCCs logic also have to change in that only EUCCs with the same access authorizations can be used together, but what if the access authorizations change later on. This is getting pretty real complicated.

3. It looks like more sophisticated user role management functionality will need to be implemented in Score. For example, currently a user account cannot have multiple roles, e.g., an account cannot be both Developer and End User. We will still have to implement a user role management logic to do not allow the user account to have these two roles. Or that the user must select a role when he logs in, i.e., he cannot hold multiple roles when logging in. Also I think whether a CC or BIE is a Developer CC/BIE or End User CC/BIE, is inferred from the owner user. If the user can have multiple roles during the session, this logic can be affected.

Implementation

Update database structure

We plan to start the multi-tenancy implementation with the following DB changes:

• Replace the organization column in the app_user table with a foreign key to a new table, called organization, that will be used for the tenants

• Create a mapping table between organizations and business contexts (many-to-many) that will keep track of each tenant’s access to BIEs in a certain business context