Exercise: Defining CDS Restrictions and Roles

Add CAP Role Restrictions to Entities.

1. Open the following file: srv/risk-service.cds.

2. Replace the file content with the following code snippet to add the restrictions.

   Code snippet

   Copy code

   
   using {riskmanagement as rm} from '../db/schema';
   
   @path: 'service/risk'
   service RiskService @(requires: 'authenticated-user') {
       entity Risks @(restrict: [
           {
               grant: 'READ',
               to   : 'RiskViewer'
           },
           {
               grant: [
                   'READ',
                   'WRITE',
                   'UPDATE',
                   'UPSERT',
                   'DELETE'
               ], // Allowing CDS events by explicitly mentioning them
               to   : 'RiskManager'
           }
       ])                      as projection on rm.Risks;
   
       annotate Risks with @odata.draft.enabled;
   
       entity Mitigations @(restrict: [
           {
               grant: 'READ',
               to   : 'RiskViewer'
           },
           {
               grant: '*', // Allow everything using wildcard
               to   : 'RiskManager'
           }
       ])                      as projection on rm.Mitigations;
   
       annotate Mitigations with @odata.draft.enabled;
   
       // BusinessPartner
       @readonly
       entity BusinessPartners as projection on rm.BusinessPartners;
   }
   

   Expand

3. Save the file.

Add mock users for Local Testing.

Note

Since the authorization checks have been added to the CAP model, they apply not only when deployed to the cloud but also for local testing. Therefore, you will need a way to log in to the application locally.

CAP allows you to add local users for testing as part of the cds configuration. For this, you can use the .cdsrc.json file to add the mock users.

Note

The .cdsrc.json file can be used to store project configurations, like in the package.json file. Learn more here¹.

1. In the project, go to the file .cdsrc.json and open it for editing.

2. In the editor, replace its content with the following lines:

   Code snippet

   Copy code

   
   {
    "[development]": {
      "auth": {
       "passport": {
        "strategy": "mock",
        "users": {
          "risk.viewer@tester.sap.com": {
           "password": "initial",
           "ID": "riskviewer",
           "userAttributes": {
             "email": "risk.viewer@tester.sap.com"
           },
           "roles": ["RiskViewer"]
         },
          "risk.manager@tester.sap.com": {
           "password": "initial",
           "ID": "riskmanager",
           "userAttributes": {
             "email": "risk.manager@tester.sap.com"
           },
           "roles": ["RiskManager"]
         }
        }
       }
      }
     }
    }

   Expand

3. Save the file.

   The file defines two users, riskviewer and riskmanager. Let's take a look at the riskmanager example.

   The user is defined by an ID, which can be any identifier for a user. The user has an email, a password parameter, and a roles parameter.

Try to access the application with the mock user.

Note

When accessing the Risks or the Mitigations service in the browser, you get a basic authorization pop-up window, asking for your user and password. Note, that you can not log out easily. For this you would have to restart your browser. You can use both users that you defined in the previous step to log in and see how this works.

1. In the tab with the running application, navigate back to the launchpad.html page.

2. Choose the Risks tile and in the app and choose Go.

3. In the pop-up, enter the Usernameriskmanager.

4. Enter the Passwordinitial.

   

5. You can now access the Risks application.

Platform Simulation

Choose the Start button (shown in the following figure) to open a simulation of the platform. Then follow the step-by-step instructions to add authorizations and mock users.

ExerciseStart Exercise