Enabling Hostname Verification¶
If hostname verification is disabled for your product, the hostnames (that are accessed by a particular client) will not be verified against the hostnames specified in the product's SSL certificate. If hostname verification is enabled, you will be able to configure how hostnames are filtered during the verification process.
Be sure to enable hostname verification for your production environment. This is necessary to avoid security issues in production. See the full list of security recommendations for production environments.
Configuring hostname verification¶
The hostname verification is disabled by default. This is done using the
httpclient.hostnameVerifier properties in the product's startup script (
api-manager.sh for Linux and
api-manager.bat for Windows) as shown below. The product startup script is stored in the
<PRODUCT_HOME>/bin directory. This property will be effective during server startup.
Strict hostname verification
When applying the strict hostname verification, you need to change the configuration in the
site/public/conf/settings.js file of the Publisher and Admin Portal and the
site/public/theme/setting.js file of the Developer Portal.
The values you can use with this
httpclient.hostnameVerifier property are explained below. Note that these values will behave the same as synapse hostname verification options.
DefaultAndLocalhost: This is the value that is enabled, by default. This means that all hostnames, except the ones listed below, will be verified against the hostnames specified in the product's SSL certificate. That is, the following hostnames will be allowed regardless of the server's certificate.
Note that if the wildcard symbol is used to specify a hostname in the SSL certificate (such as *. foo.com ), all the subdomains of *. foo.com are also included. That is a hostname that matches a subdomain of *. foo.com will also be allowed for access.
Strict: When this mode is enabled, hostnames will be strictly verified against the hostname specified in the product's SSL certificate. For example, if "*. foo.com " is specified as the hostname in the certificate, only the hostnames at the same level will be authorized by the server. That is subdomains such as " a.b.foo.com " will not be authorized.
AllowAll: This option turns off hostname verification for the server. Note that this is not recommended in a production setup and should only be used for demonstrations and testing.
Configuring hostname verification for WebSockets¶
WebSocket hostname verification is disabled by default. In order to enable hostname verification for WebSockets the following configuration needs to be added to the
deployment.toml file in
"ws.client.enable.hostname.verification" = true