Try Local Setup for AU

WSO2 Open Banking now supports the Consumer Data Standard (CDS). This document guides you through the configurations and troubleshooting that you need to set up the solution in your local environment. 

Prerequisites

Setting up the databases

To start the servers, configure the databases in both the API Manager (WSO2 OB APIM) and the Key Manager (WSO2 OB KM) according to the open banking specification, as follows:

1. Open the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts/startup.properties file and configure the following:

   • Specify the hostnames for the APIM and KM servers.

     # Specify the hostname you want to configure
     APIM_HOSTNAME=localhost
     IAM_HOSTNAME=localhost

   • Configure the databases related properties.

     Database Property	Description
     DB_TYPE	Type of the database you installed DB_TYPE=mysql
     DB_USER	Database user
     DB_PASS	Password set for the database connection
     DB_HOST	Name of the database server
     DB_DRIVER	Configure DB_DRIVER according to the database installed: Mysql JDBC Driver : com.mysql.jdbc.Driver  MSSQL JDBC Driver : com.microsoft.sqlserver.jdbc.SQLServerDriver Oracle JDBC Driver : oracle.jdbc.driver.OracleDriver

     If you are using MSSQL or Oracle, create the following databases before executing the configure-km.sh file.

     • openbank_am_configdb   

     • openbank_apimgt_statsdb

     • openbank_apimgtdb

     • openbank_openbankingdb

     • openbank_govdb

     • openbank_iskm_configdb       

     • openbank_mbstoredb

     • openbank_userdb

2. Go to the <WSO2_OB_KM_HOME>/repository/resources/finance/scripts directory and execute the following command:

   ./configure-km.sh

3. Go to the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts directory and configure the database properties in the startup.properties file, similar to Step 1.

4. Go to the <WSO2_OB_APIM_HOME>/repository/resources/finance/scripts directory and execute the following command:

   ./configure-am.sh

   You have configured the databases in step 1. By running the configure.sh files, you set the database credentials with reference to the configuration files.

Setting up the servers

1. Configure the open-banking specification to deploy the solution according to the AU specification. 

   The <DeployedSpecification> configuration is used to define the deployed specification at runtime. In the following files, update the <DeployedSpecification> value as AU.

• <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml 

• <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml   

2. Configure the authentication web app.

   1. Update the <WSO2_OB_KM_HOME>/repository/conf/identity/application-authentication.xml file with the following configurations:

      <AuthenticationEndpointURL>https://localhost:9446/authenticationendpoint/login.do</AuthenticationEndpointURL>
      <AuthenticationEndpointRetryURL>https://localhost:9446/authenticationendpoint/retry.do</AuthenticationEndpointRetryURL>
      <AuthenticationEndpointMissingClaimsURL>/authenticationendpoint/claims.do</AuthenticationEndpointMissingClaimsURL>

      <AuthenticatorConfig  name="FIDOAuthenticator" enabled="true">
      	<Parameter name="FidoAuth">/authenticationendpoint/fido-auth.jsp</Parameter>
      	<!--Please uncomment the following property and define AppID if you are using proxy configurations-->
      	<!--<Parameter name="AppID">https://localhost</Parameter>-->
      </AuthenticatorConfig>

   2. Update the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file with the following configurations:

      <OpenID>
      	<OpenIDLoginUrl>${carbon.protocol}://${carbon.host}:${carbon.management.port}/authenticationendpoint/openid_login.do
      	</OpenIDLoginUrl>
      </OpenID>

      <OAuth>
      	<OAuth2ConsentPage>${carbon.protocol}://localhost:${carbon.management.port}/ob/authenticationendpoint/oauth2_authz.do</OAuth2ConsentPage>
      	<OAuth2ErrorPage>${carbon.protocol}://localhost:${carbon.management.port}/authenticationendpoint/oauth2_error.do</OAuth2ErrorPage>
      	<OIDCConsentPage>${carbon.protocol}://localhost:${carbon.management.port}/ob/authenticationendpoint/oauth2_consent.do</OIDCConsentPage>
      	<OIDCLogoutConsentPage>${carbon.protocol}://localhost:${carbon.management.port}/authenticationendpoint/oauth2_logout_consent.do</OIDCLogoutConsentPage>
      	<OIDCLogoutPage>${carbon.protocol}://localhost:${carbon.management.port}/authenticationendpoint/oauth2_logout.do</OIDCLogoutPage>
      </OAuth>

      <SSOService>
      	<DefaultLogoutEndpoint>${carbon.protocol}://${carbon.host}:${carbon.management.port}/authenticationendpoint/samlsso_logout.do</DefaultLogoutEndpoint>
      	<NotificationEndpoint>${carbon.protocol}://${carbon.host}:${carbon.management.port}/authenticationendpoint/samlsso_notification.do</NotificationEndpoint>
      </SSOService>

      <PassiveSTS>
      	<RetryURL>${carbon.protocol}://${carbon.host}:${carbon.management.port}/authenticationendpoint/retry.do</RetryURL>
      </PassiveSTS>

3. Configure the IDTokenBuilder in the <WSO2_OB_KM_HOME>/repository/conf/identity/identity.xml file as follows:

   <OpenIDConnect>
   	<IDTokenBuilder>com.wso2.finance.open.banking.idtoken.builder.AUIDTokeBuilder</IDTokenBuilder>
   </OpenIDConnect>

4. To enable Request-URI validation, open the <WSO2_OB_KM_HOME>/repository/conf/finance/open-banking.xml file and add the following configurations under the <UK> tag:

   <!-- Validate AccountID with consented accountID in account retrieval -->
   <ValidateAccountIdOnRetrieval>true</ValidateAccountIdOnRetrieval>

5. By default, Enforcement caching is enabled in the solution. To customize them, open the <WSO2_OB_APIM_HOME>/repository/conf/finance/open-banking.xml file and add the following under the <Server> tag:

   <AU>
   	<Enforcement>
   		<Cache>
   			<CacheEnabled>true</CacheEnabled>
   			<ModifiedExpiryMinutes>15</ModifiedExpiryMinutes>
   			<AccessedExpiryMinutes>15</AccessedExpiryMinutes>
   		</Cache>
   	</Enforcement>
   </AU>

6. Add the following Consent Enforcement handler configurations to the <WSO2_OB_APIM_HOME>/repository/resources/api_templates/velocity_template.xml file, below the

   #if($handler.className == "org.wso2.carbon.apimgt.gateway.handlers.ext.APIManagerExtensionHandler") line.

   ##
   ## Start of AU Specification Handlers
   ##
   
   #if($apiObj.additionalProperties.get("ob-spec") == "au")
   <handler class="com.wso2.finance.open.banking.gateway.api.schema.validation.RequestSchemaValidationHandler"/>
   <handler class="com.wso2.finance.open.banking.au.consent.enforcement.AUConsentEnforcementHandler">
       <property name="validationBaseUrl" value="https://localhost:9446/consent/au100"/>
   </handler>
   #end
   
   ##
   ## End of AU Specific Handlers
   ##
   

7. You are now ready to start the Key Manager and API Manager servers. To start the WSO2 OB KM server, go to the <WSO2_OB_KM_HOME>/bin directory and execute the following command:

   ./wso2server.sh -Dsetup

8. Run the following command from the <WSO2_OB_APIM_HOME>/bin directory to start the WSO2 OB APIM server:

   ./wso2server.sh -Dsetup

   Execute the following command against the openbank_openbankingdb database:

   ALTER TABLE OB_CONSENT_METADATA drop foreign key FK_CONSENT_ID_UK_INITIATION;

<AuthenticatorConfig name="SMSOTP" enabled="true">
	<Parameter name="usecase">subjectUri</Parameter>
	<Parameter name="secondaryUserstore">primary</Parameter>
</AuthenticatorConfig>

Configuring users

1. Sign in to the Identity and Access Management console (https://localhost:9446/carbon). Use the default super admin credentials as follows:

   Username: admin@wso2.com

   Password: wso2123

   The above mentioned username and password credentials are used for demo purposes only. It is recommended to change the credentials in a production environment.

2. Create the necessary user accounts as follows:

   • On the Main tab, click Identity > Users and Roles > Add > Add New User.

     

   • Create the following user:

     User	Roles
     mark@gold.com	Internal/creator, Internal/publisher

     

   • Click Next > and assign roles.
     

   • Click Finish.

   Now that you’ve added some users to the system, you can log in as one of them to see how a typical user might work with the WSO2 Open Banking solution.

Configuring APIs

You can configure APIs through the API Publisher by signing in as a user whose role includes Internal/publisher. Follow the steps given below:

1. Sign in to the API Publisher ( https://localhost:9443/publisher) with the credentials for mark@gold.com.

   

2. Click ADD NEW API > I have an existing API. 

   

3. Select the Swagger definition in the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/consumerdatastandards.org.au/1.0.0/consumer-data-standards.yaml file and configure the properties according to the open-banking specification.

   
   Click Start Creating.
4. Click Next: Implement to navigate to the next level.
5. Expand Managed API, and use the table below to select the relevant Endpoint Type from the drop down list.
6. Check Select a message mediation policy to be executed in the message flow under Message Mediation Policies.

7. Click Upload In Flow and select the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/consumerdatastandards.org.au/1.0.0/cds-dynamic-endpoint-insequence-1.0.0.xml file.
   

8. Click Next: Manage to navigate to the next level.

9. Expand Throttling Settings. Under Subscription Tiers, check the option as Unlimited : Allows unlimited requests unless you want to limit the requests.
   

10. Expand API Properties and add the following values as Additional properties:

    Property Name	ob-spec
    Property Value	au

11. Click the + button to save the above values as follows:
    

12. To publish the API click Save & Publish.

Summarized information for configuring APIs

What's Next

Now that you have created the APIs that allow you to initiate payments and access account information, let's try out the flows in WSO2 Open Banking:

• Try Out WSO2 Open Banking AU