Configure a secure MID Web Server extension

Xanadu IT Operations Management

Release

xanadu

ft:locale

en-US

ft:publication_title

Xanadu IT Operations Management

ft:clusterId

itom

bundleId

itom

workflow

Technology

Configure a secure MID Web Server extension

Release version: Xanadu

Updated August 1, 2024

1 minute to read

Configure a TLS listener for extra security and encryption of data transferred to and from the MID Web Server extension. Access both a private key and a certificate (or certificate chain) from a Java keystore to use during the TLS handshake where the MID Web Server and the client acknowledge each other.

Before you begin

Role required: agent_client_collector_admin

Procedure

Navigate to MID Server > Extensions > MID Web Server.
Select New.
In the Authentication Type field, select an authentication type to be used.
- Keybased – See Configure key-based MID Web Server authentication
- Basic – Standard username/password authentication
- API key – See Configure MID Web Server API key authentication
- mTLS – See MID Web Server and agent mTLS Authentication

Select either the MID unified keystore or the web server keystore.

The MID Web Server unified keystore is the most efficient option. If you want to enable backward compatibility and the ability to store keypairs in an additional keystore, use the Web server keystore (which allows you to use the MID unified keystore as well).

Option	Description
MID unified keystore	Select the Use MID Unified Keystore check box Enter an alias name in the Keystore Certificate Alias field or leave the field empty to use the keystore's default alias. For more information, see the Install custom certificates in the MID Server unified key store section in MID Server unified key store. Important: Leaving the Keystore Certificate Alias field empty causes connecting clients to skip certificate verification. Instead, the MID Server uses its own self-signed certificate.
Web server keystore	Clear the Use MID Unified Keystore check box. Specify an alias name in the Keystore Certificate Alias field or leave the field empty if you have a single alias in that keystore. If the password to the private key of the required alias is different from the keystore password, specify the alias in the Keystore Key Password field. Enter the keystore password in the Keystore Password field.

Option

Description

MID unified keystore

Select the Use MID Unified Keystore check box
Enter an alias name in the Keystore Certificate Alias field or leave the field empty to use the keystore's default alias.
For more information, see the Install custom certificates in the MID Server unified key store section in MID Server unified key store.
Important:
Leaving the Keystore Certificate Alias field empty causes connecting clients to skip certificate verification. Instead, the MID Server uses its own self-signed certificate.

Web server keystore

Clear the Use MID Unified Keystore check box.
Specify an alias name in the Keystore Certificate Alias field or leave the field empty if you have a single alias in that keystore.
If the password to the private key of the required alias is different from the keystore password, specify the alias in the Keystore Key Password field.
Enter the keystore password in the Keystore Password field.