Skip to content

Hardening and scaling

This page collects what you need to run InfoConnect Hub in production: security hardening, authentication and access control, availability and scaling, and monitoring.

You can configure most of the Hub through the Admin API. A few hardening steps must be done directly on the Hub instance. After the Hub is configured, it communicates with external services and IBM i through the Functional API endpoints. For the full list of endpoints, see the API Reference.

Security hardening

By default, the Hub has predefined credentials, an HTTP listener and no IBM i connection. The default Basic Auth credentials are:

  • Admin API: user ID Admin, password Password.
  • Functional API: user ID User, password Password@123.

If you start the Hub with the distribution start scripts, the user IDs and passwords are the values that you enter in the first-launch credentials wizard. They are stored in start-scripts/config/.env.

To authenticate through an OAuth provider instead of Basic Auth, use the authorization server. See OAuth Configuration Guide.

An evaluation setup usually has only basic security settings and a non-secure IBM i connection. Complete this checklist early in the evaluation:

  • Configure HTTPS for the API / HTTP listener (see Setting up HTTPS).
  • Configure a TLS connection to IBM i.
  • Change the encryption key for sensitive properties (see Changing the encryption key).
  • Encrypt all credentials and other sensitive API properties with the Admin encryption API.
  • Change the default user IDs and passwords of the Admin API and the Functional API (see Changing the default user ID and password).
  • Change the MCP credentials mcpUser / mcpUserPassword (mcp / mcp by default) in the MCP and UI configurations, and the users and client secret of the authorization server if you use it.
  • Restrict access to the APIs to allowed source IP addresses, and add rate limiting and other security policies, at the network, load balancer or API gateway level. The Hub has no built-in IP allow-list; the RPA Hub has one.

In the following sections, <project-folder> is the Hub module folder that contains the config and executable-jars folders. It is <hub-home>/info-connect-hub in the distribution archive and /opt/info-connect-hub on an AWS Marketplace instance.

Setting up HTTPS

To enable HTTPS, create a keystore with a certificate and configure the Hub to use it. This example uses a self-signed certificate.

  1. Generate a self-signed certificate with the Java keytool command. The command asks several questions and creates the keystore file ssl-server.jks in the directory where you run it:

    keytool -genkey -alias selfsigned_localhost_sslserver -keyalg RSA -keysize 2048 -validity 700 -keypass changeit -storepass changeit -keystore ssl-server.jks
    
  2. Optional: list the content of the keystore:

    keytool -list -keystore ssl-server.jks
    
  3. Copy the keystore file into <project-folder>/config.

  4. Add the following entries to <project-folder>/config/application.properties:

    server.ssl.key-alias=selfsigned_localhost_sslserver
    server.ssl.key-store-password=changeit
    server.ssl.key-store=file:./info-connect-hub/config/ssl-server.jks
    server.ssl.key-store-provider=SUN
    server.ssl.key-store-type=JKS
    

    The start scripts run the modules from <hub-home>, so give the key store path relative to <hub-home> or as an absolute path.

    To store the keystore password in encrypted form, put the encrypted value in ENC():

    server.ssl.key-store-password=ENC(encrypted-value)
    
  5. Update the modules that call the Hub. In the UI configuration, set infoconnect.hub.secure=true, infoconnect.hub.truststore.path and infoconnect.hub.truststore.pass. In the MCP configuration, set hub.url to the HTTPS URL of the Hub.

  6. Restart the Hub.

Encrypting secrets

Passwords, keys and other secrets in connection and Data Flow definitions must be encrypted values. Encrypt them with the Admin API of the Hub. The call needs the credentials of an administrator.

  1. Send the plain values in one request. Each key of the JSON object is a name of your choice:

    POST http://<host>:8080/admin/encryption
    Content-Type: application/json
    
    {
      "password": "my-plain-password",
      "secretKey": "my-plain-secret"
    }
    
  2. The response contains the encrypted values under the same keys:

    {
      "password": "<encrypted-password>",
      "secretKey": "<encrypted-secret>"
    }
    
  3. Use the encrypted value in the definition, for example in password of a connection or in the secret fields of sinkTypeProperties of a Data Flow. Paste it as it is, without ENC(...). In application.properties, wrap it in ENC(...) instead, see Changing the default user ID and password.

User names and other values that are not secret stay plain. The Hub encrypts with its encryption key, so the values work only on a Hub with the same key. If you change the key, encrypt the secrets again. The RPA Hub has its own encryption endpoint, see RPA Hub user guide.

In the web UI you do not encrypt the values yourself on the Form tab. On the JSON tab, the secrets must already be encrypted.

Changing the encryption key

Before you change the encryption key, make sure that no active connection, poller or encrypted property still uses the old key.

How you change the key depends on how you run the Hub:

  • Distribution start scripts (infoconnect-hub.bat or infoconnect-hub.sh): the credentials wizard asks for the encryption word on the first launch and stores it as ENCRYPTION_WORD in start-scripts/config/.env. To change it later, run the credential update script or edit the .env file, and then restart all modules.
  • Java command: set the key with the -Djasypt.encryptor.password property.
  • Docker, Kubernetes and Cloud Run: set ENCRYPTION_WORD in the stack .env file or the secret.
  • AWS Marketplace: update the -Djasypt.encryptor.password property in the info_connect_hub-3.0.0.conf file in /opt/info-connect-hub/executable-jars.

Restart the Hub after you change the key.

Changing the default user ID and password

The Admin API and the Functional API each have their own user. You can change the credentials with the credential update script or manually.

Warning

The script and the properties set the credentials of the users that the Hub creates on its first start. The users are stored in the Hub metadata database, so after the first start a new password in the properties has no effect, and a new user ID creates an additional user while the old one stays active. To change the password of an existing user, call PUT /admin/users/{username}/password. To remove an old user, call DELETE /admin/users/{username}. See User groups and permissions.

Use the credential update script in <hub-home>/start-scripts:

  • Windows: double-click change-default-creds.bat.
  • Linux and macOS: open a terminal, go to the <hub-home>/start-scripts directory and run:

    bash change-default-creds.sh
    

The script asks you to enter and confirm the new credentials and updates all Hub components.

Manual configuration

  1. Open <project-folder>/config/application.properties.
  2. Find the Basic Authentication section. The user properties apply to the Functional API and the admin properties apply to the Admin API.
  3. To change the user IDs, update userUsername and adminUsername.
  4. To change the passwords, update userPassword and adminPassword.
  5. Optional: store the passwords in encrypted form.

    1. Encrypt the password with the Admin encryption API:

      POST http://<host>:8080/admin/encryption
      
    2. Wrap the encrypted value in ENC(...).

    3. Paste the result into the userPassword or adminPassword property.
  6. Restart the Hub.

Authentication and access control

  • OAuth. Use the authorization server to authenticate with an OAuth provider instead of Basic authentication. See OAuth configuration.
  • User groups and permissions. Assign users to groups and give each group access to specific Program Calls, Data APIs and RPA Calls. The same permissions apply to the generated MCP tools. See User groups and permissions.
  • TLS to IBM i. Use an encrypted connection between the Hub and IBM i. See IBM i TLS connection configuration.

Availability and scaling

Monitoring and recovery

  • Logs. Each module writes an output log and an error log to the log folder. See Log files.
  • Health checks. The Hub and the MCP server provide /actuator/health. The Hub health check reports only that the process is up. It does not check the metadata database or the connection to IBM i. On the MCP server the endpoint requires the MCP credentials unless mcp.auth.type=none. See Health check.
  • Data Flow states. The state of a Data Flow (ACTIVE, INACTIVE, FAILED, INVALID) shows whether it runs. See Data Flow states and errors.
  • Dead letter queue. A Data Flow has DLQ Settings, where you enable a dead letter queue for failed messages. See Data Flows.
  • Log aggregation. The log files are plain files in a known folder, so your standard log shipper can forward them to platforms such as Splunk or the Elastic stack.