Securing Portal using HTTPS

Securing BizDataX Portal using HTTPS can be preformed manually, using this guide.

Table of contents
Acquiring SSL certificate
BizDataX Portal API configuration
BizDataX Portal UI configuration
BizDataX Designer configuration

Acquiring an SSL certificate

An SSL certificate can be generally acquired in one of two ways:

  • Importing certificate signed by a certificate authority
  • Generating self-signed certificate

To generate self-signed certificate open Internet Information Services (IIS) Manager and select appropriate server connection. In the central menu navigate to IIS feature group and double click on Server Certificates feature. On the right side menu click Create Self-Signed Certificate... and input a user-friendly name such as bdxportal.ekobit.corp.

Configure BizDataX Portal API

For BizDataX Portal to work properly with HTTPS protocol API needs to be manually configured using steps provided below.

1. Internet Information Services (IIS) Manager configuration

Open Internet Information Services (IIS) Manager, select appropriate server connection and expand Sites list.

  • Select site BizDataX Portal API
  • On the right side menu, click Bindings... -> Add...
  • Set and confirm options as follows:
    • Type - HTTPS
    • Port - any port
    • SSL Certificate - previously acquired certificate
  • On the Bindings... menu select default HTTP binding and remove it
  • Click on the new HTTPS binding and select Edit...
    • Set Port to 9001, confirm and close all dialogs
  • Navigate to IIS feature group in the central menu and double click on SSL Settings feature
  • Check Require SSL checkbox

2. BizDataX Portal Web.config configuration

Locate the Web.config file in BizDataX Portal install location. Default path is C:\Inetpub\BizDataXPortal\API\Web.config. Change keys as follows:

  • Navigate to <configuration/> section
    • Navigate to <appSettings/>
    • Replace
      <add key="cors:origins" value="http://localhost:9000"/>
      
      with
      <add key="cors:origins" value="https://localhost:9000"/>
      
    • Save and close file
    • Navigate to <system.serviceModel/> -> <bindings/> -> <basicHttpBinding/>
    • Replace
      <binding name="servicesBinding" maxBufferPoolSize="2000000000" maxBufferSize="2000000000" maxReceivedMessageSize="2000000000">
          <security mode="TransportCredentialOnly">
              <transport clientCredentialType="Windows"/>
          </security>
      </binding>
      
      with
      <binding name="servicesBinding" maxBufferPoolSize="2000000000" maxBufferSize="2000000000" maxReceivedMessageSize="2000000000">
          <security mode="Transport">
              <transport clientCredentialType="Windows"/>
          </security>
      </binding>
      
    • Save and close file

3. BizDataX Portal AppSettings.config configuration

Locate the AppSettings.config file in BizDataX Portal install location. Default path is C:\Inetpub\BizDataXPortal\API\AppSettings.config. Change keys as follows:

  • Navigate to <appSettings/> section
  • Replace
    <add key="PortalApiUrl" value="http://localhost:9001"/>
    
    with
    <add key="PortalApiUrl" value="https://localhost:9001"/>
    
  • Save and close file

Configure BizDataX Portal UI

For BizDataX Portal to work properly with HTTPS protocol UI also needs to be manually configured using steps provided below.

1. Internet Information Services (IIS) Manager configuration

Open Internet Information Services (IIS) Manager, select appropriate server connection and expand Sites list.

  • Select site BizDataX Portal UI
  • On the right side menu, click Bindings... -> Add...
  • Set and confirm options as follows:
    • Type - HTTPS
    • Port - any port
    • SSL Certificate - previously acquired certificate
  • On the Bindings... menu select default HTTP binding and remove it
  • Click on the new HTTPS binding and select Edit...
    • Set Port to 9001, confirm and close all dialogs
  • Navigate to IIS feature group in the central menu and double click on SSL Settings feature
  • Check Require SSL checkbox

2. BizDataX Portal config.production.json configuration

Locate the config.production.json file in BizDataX Portal install location. Default path is C:\Inetpub\BizDataXPortal\UI\config\config.production.json. Change keys as follows:

  • Replace
    "apiUrl": "http://localhost:9001"
    
    with
    "apiUrl": "https://localhost:9001"
    
  • Save and close file

Configure BizDataX Designer

For BizDataX Designer to work properly with BizDataX Portal its configuration needs to be manually updated as well. To configure it open Microsoft Visual Studio.

  • Select Tools -> Options -> BizDataX
  • Locate BizDataX Portal configuration group
  • Change Web API URL setting from
    http://localhost:9001
    
    to
    https://localhost:9001
    
  • Save and close dialog