Skip to content

Latest commit

 

History

History
237 lines (157 loc) · 10.7 KB

README.md

File metadata and controls

237 lines (157 loc) · 10.7 KB
Raw

Sample to extend SAP Cloud for Customer with user propagation via XSUAA

Overview

This sample demonstrates how a user propagation flow can be achieved when extending SAP Cloud for Customer(C4C) using SAP BTP, Kyma runtime.

It uses XSUAA with user federation via SAP IAS. However, any external identity provider would also work as long as it supports SAML 2.0.

The JWT token received in Kyma needs to be exchanged for an OAuth2 token that can be authenticated by SAP Cloud for Customer. For this purpose, the Destination Service is used.

Flow

Flow

  1. User signs in to C4C with a single ID and password (SSO).
  2. C4C redirects the user to IAS for authentication.
  3. User signs in to IAS.
  4. User is signed in to C4C with SAML bearer assertion.
  5. User accesses the Frontend App and is redirected by the App Proxy to authenticate against XSUAA which creates a session for the user containing the bearer token.
  6. After authentication the user is redirected to the frontend.
  7. The Frontend App makes an API call to the HTTP Bin app to display the headers.
  8. The user creates a task on the Frontend App.
  9. The Microservice/Function API receives the user's Token and does the token exchange via the Destination Service. The Destination Service calls C4C and performs the OAuth2 SAML bearer assertion flow.
  10. Microservice/Function makes a call to C4C with the OAuth2 token it got from the Destination Service.

Prerequisites

  • SAP BTP, Kyma runtime instance
  • SAP Cloud for Customer tenant
  • SAP Identity Authentication Service tenant
  • OAuth 2.0-based authentication between IAS, SAP BTP, and C4C requires the same user ID to exist in both IAS and C4C.

Steps

  • Setup C4C Single sign-on
  • Create Trust Between SCP and IAS
  • Setup the User Propagation
  • Modify User Identifier
  • Create XSUAA instance
  • Deploy httpbin Application
  • Deploy c4c-extension Application
  • Deploy Angular Frontend App
  • Deploy Auth Proxy Application

Configuration

C4C Single sign-on

Set up single sign-on (SSO) using IAS with C4C. Refer to the official documentation for details.

Create Trust Between SCP and IAS

Full details can be found at help.sap.com

  • In your Identity Authentication service (IAS) tenant download the SAML Metadata file by choosing the menu option Applications & Resources -> Tenant Settings -> SAML 2.0 Configuration. Choose the option to Download Metadata File.
  • In your SAP BTP Subaccount choose the menu option Security -> Trust Configuration. Choose the option New Trust Configuration and upload the file downloaded from your IAS tenant in the previous step.
  • In your SAP BTP Subaccount choose the menu option Security -> Trust Configuration. Choose the option SAML Metadata to download the SCP metadata.
  • In your Identity Authentication service (IAS) tenant choose the menu option Applications & Resources -> Applications. Choose Add, provide a name and save the application.
  • In the IAS application choose SAML 2.0 Configuration. Choose the option Browse and provide the SAML Metadata file downloaded from SCP. Save the changes.
  • In the IAS application choose Subject Name Identifier and set the basic attribute to use the field which would map to the C4C user. Save the changes.

User propagation

Configure user propagation between C4C and Kyma runtime.

This blog was used as a reference. It was written for Neo, but some steps are also applicable for Kyma runtime.

You will end up creating a Destination Service in SAP BTP. It will be later on used by the microservice to do the token exchange.

  • Download the Trust certificate from Subaccount --> Destinations --> Download Trust. download-trust

  • Log on to your C4C system as an administrator. Go to ADMINISTRATOR --> Common Tasks. Choose Configure OAuth 2.0 Identity Provider and select New OAuth2.0 Provider.

    • Get the issuing entity name from the certificate. You can use OpenSSL to view certificate details.

      openssl x509 -in {cert path} -text -noout

    • Upload the certificate. new-oauth2-provider

  • Register an Oauth2 Client in C4C. register-oauth-client

  • Create a destination in SAP BTP. Under your subaccount, go to Connectivity --> Destinations. http-destination

    Configure these additional properties:

    scope                      : UIWC:CC_HOME
x_user_token.jwks_uri      : Provide URI of the JSON web key set

Identifier used by the Destination Service to get the token

The Destination Service uses whatever is specified in the userIdSource property. If not specified, it would require either user_name or email depending upon the nameIdFormat In this example, user_name is mapped to the Login name attribute.

assertion-atributes

Create XSUAA Instance

  1. Within the Kyma console open the namespace dev
  2. Choose Service Management -> Catalog.
  3. Choose the service Authorization & Trust Management
  4. Choose Add
  5. Choose the Plan application
  6. Choose Add parameters and provide the object after adjusting it to your needs.

To specify use of only IAS authentication provide the Origin Key shown in the Trust Configuration list within SCP for the value of allowedproviders, otherwise this property can be omitted to allow either XSUAA or IAS users.

{
  "oauth2-configuration": {
    "allowedproviders": ["<origin key>"],
    "redirect-uris": [
      "https://c4c-user-prop-xsuaa.<cluster domain>/oauth/callback"
    ]
  },
  "xsappname": "c4c-user-prop-xsuaa"
}

For a complete list of parameters visit Application Security Descriptor Configuration Syntax

  1. Once the instance is provisioned choose the option Create Credentials
  2. Under the Credentials tab choose the Secret which should display the instance secret in a dialog. Choose Decode to view the values. These will be needed if running the sample locally.

Deploy httpbin Application

httpbin is a service that returns all the request headers to the /headers endpoint.

It is used for demonstrating and verifying that the token is forwarded from the API Gateway to the microservice.

  • Deploy httpbin.

    kubectl -n dev apply -f https://raw.githubusercontent.com/istio/istio/master/samples/httpbin/httpbin.yaml

Deploy c4c-extension Application

The c4c-extension c4c-extension Application microservice implements the extension logic and performs the user propagation.

  • It receives the JWT token that is forwarded from the App Auth Proxy.
  • The token is used to do a token exchange via the Destination Service.
  • A call is made to C4C to create a task with the exchanged token that contains the user context.
  • The task is created with the logged-in user as the processor, not a static user.

Setup

  • Create a Destination Service instance in the Kyma Service Catalog. This will be used to get the credentials to make the call to the Destination Service.

    create instance

  • Create credentials for the instance.

    kyma destination service instance

  • Deploy the extension with user propagation.

    • Update DESTINATION_NAME in deployment.yaml with the name of the destination created in SAP BTP.

    • Deploy the extension.

        kubectl -n dev apply -f k8s/c4c-extension/deployment.yaml

  • Bind the extension to the Destination Service instance. bind instance

Deploy Angular Frontend App

This App simulates the SSO flow and makes API calls to the extensions deployed to the Kyma runtime.

The app makes a call to the httpbin service to the /headers URI path. The httpbin service replies with all the HTTP headers received.

angular home

It makes another call to create a C4C task for the logged-in user.

angular create c4c task

  • Deploy the app:

    kubectl -n dev apply -f k8s/frontend/angular-app.yaml

Deploy Auth Proxy Application

The App Auth Proxy provides serverside authentication/authorization using the OIDC configuration provided by xsuaa. Due to the trust setup between SCP and IAS, IAS can be used to authenticate and provide a user store.

  1. Within ./k8s/auth-proxy/configmap.yaml adjust the cluster-domain value of the redirect_uri to match the domain of the Kyma runtime and then apply the ConfigMap:

    kubectl -n dev apply -f ./k8s/auth-proxy/configmap.yaml

  2. Get the name of the xsuaa ServiceInstance:

    kubectl -n dev get serviceinstances

    For example:

    | NAME                   | CLASS                     | PLAN        | STATUS | AGE |
| ---------------------- | ------------------------- | ----------- | ------ | --- |
| **_xsuaa-showy-yard_** | ClusterServiceClass/xsuaa | application | Ready  | 63m |

  3. Within ./k8s/auth-proxy/deployment.yaml adjust the value of <Service Instance Name> to the XSUAA service instance name and the apply the Deployment:

    kubectl -n dev apply -f ./k8s/auth-proxy/deployment.yaml

  4. Apply the APIRule:

    kubectl -n dev apply -f ./k8s/auth-proxy/apirule.yaml

  5. Access the app at https://c4c-user-prop-xsuaa.{kyma-cluster-domain}

Takeaways

  • It is possible to build in the Kyma runtime the extensions and flows that require user propagation. This feature has been requested by various customers.
  • Although the sample is built for SAP Cloud for Customer, a similar approach can be applied to other SAP Solutions, such as SuccessFactors.
  • The approach requires an extension to build the logic required to fetch the token.
  • The flow does not make the call via Application Gateway but directly calls the SAP Cloud For Customer APIs with the token it got from the Destination Service.