Remote Consent Service UIs

This project provides the consent UIs for the UK Open Banking edition of the Secure API Gateway project. The UK Open Banking specifications require that the resource owner (the bank account holder) must give consent for the resource server (the bank) to share their date with the third party service provider (e.g. the fintec application). These UIs are based on the Open Banking Customer Experience Guidelines and may be used in conjunction with the Open Banking Test Facility Bank and the Open Banking Remote Consent Service to provide a full set of Open Banking compliant consent journeys.

Warning

These UIs are currently functional, but they rely on old versions of 3rd party libraries. They are provided as is for use with test facilities in which there is no sensitive data stored, or as a basis for writing your own UIs. Those wishing to use the Secure API Gateway to protect a production Open Banking system should write their own consent UIs or use the existing consent management system already in place at your organisation.

The UIs maybe updated at some point depending on interest from the community and how important users feel this is.

Dependabot security alerts may be seen for the project here.

Tools

• https://github.com/nvm-sh/nvm (.nvmrc) Node Version Manager

Stack tech versions

engine-strict=true (@See the .npmrc file)

Scope @secureapigateway that allows you to seamlessly use a mix of packages from the public npm registry and one or more private registries

secure-api-gateway-ob-uk-ui

Secure API Gateway User interfaces

Subprojects

Secure API Gateway cli UI package

secure-api-gateway-ob-uk-ui-cli readme

Secure API Gateway common UI package

secure-api-gateway-ob-uk-ui-common readme

Secure API Gateway RCS UI application

• Bank simulation (Resource Consent Service)

secure-api-gateway-ob-uk-ui-rcs readme

Secure API Gateway Swagger UI application

• API documentation

secure-api-gateway-ob-uk-ui-swagger readme

Publish npm package manually

The npm securebanking packages are published in the private forgerock repository, you will need the proper settings per-user config to publish a npm package.

log on in https://maven.forgerock.org/ to get from your profile the encrypted password (base64password)

• Prepare your environment

  # Get the _auth access token
  curl -u${username:base64password} https://maven.forgerock.org/repo/api/npm/auth
  # response
  _auth = ZnJvcGxxxxxxxxxxxxxQ==
  always-auth = true
  email = jorge.sanchez-perez@forgerock.com

• create ~/.npmrc file with the below content

  @secureapigateway:registry=https://maven.forgerock.org/artifactory/api/npm/npm-local/
  //maven.forgerock.org/artifactory/api/npm/npm-local/:_auth="ZnJvcGxxxxxxxxxxxxxQ=="

  Publish a npm package

  We use the scope @secureapigateway and the basic auth to publish the tarball in forgerock npm repository

We need publish only those packages that we need use like as dependencies in other UI projects:

• secure-api-gateway-ob-uk-ui-cli: first change the version in package.json

  cd secure-api-gateway-ob-uk-ui-cli
  npm ci
  npm publish

  check the published package: Forgerock npm

• secure-api-gateway-ob-uk-ui-common: first change the version in package.json

  cd secure-api-gateway-ob-uk-ui-common
  npm ci
  npm build
  npm publish ./dist

  check the published package: Forgerock npm

Troubleshooting

troubleshooting

Using node 14 npm will raise an error when npm install <package> runs because the npm version of node 14 is more restrictive with the peer dependencies and attempt to update the package-lock.json file, this will cause future issues. To build the project properly:

cd ${ui-module}
rm -rf node_modules

npx npm@v6 ci
Need to install the following packages:
  npm@6.14.18
Ok to proceed? (y)

• Bad .npmrc configuration

  npm ERR! code E401
  npm ERR! Incorrect or missing password.

  fix the configuration following the prepare your environment section

• The package version currently exist in the repository

  npm ERR! code E403
  npm ERR! 403 403 Forbidden - PUT https://maven.forgerock.org/artifactory/api/npm/npm-local/@secureapigateway%2fsecure-api-gateway-ob-uk-ui-cli - forbidden

  Change the version in the package.json descriptor and run: npm install, npm ci and npm publish again

Release shared npm packages

Shared npm packages

• secure-api-gateway-ob-uk-ui-common more info
• secure-api-gateway-ob-uk-ui-cli more info

Release the shared packages is the process to delivery a new version of shared packages and this process is delegate to a github action (release.yml)

• Create a new tag with the new version: github UI
• Publish the release: github UI
  • The release action will be triggered and will create the new tarball pack version and publish the tarball to forgerock npm repository.