You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

By default, all the requests to AppServer are sent over HTTP protocol. To configure secure SSL connection, you need to enable SSL for AppServer as described in this section.

For Windows you can enable SSL connection using *.pfx file or Windows Certificate Store. For details, refer to Microsoft Certificate Store description and AppServer SSL parameters description.  For Linux, you can enable SSL connection using *.pem file.

1. Before making any changes, it is recommended to stop AppServer

2. Locate the AppServerX.xml configuration file in the WebSpellChecker installation folder on your server. The default path to AppServerX.xml file is  <WebSpellChecker_Installation_Path>/AppServer/AppServerX.xml

3. Scroll down to the section with parameters responsible for secure connection: <SSL>...</SSL>.

SSL configuration example for Windows:

		<!-- Secure connection -->
        <SSL>
            <EnableSSL>true</EnableSSL>
            <!-- Transport Layer Security (TLS) version. Possible values: TLSV1, TLSV1_1, TLSV1_2. -->
            <TLSVersion>TLSV1_2</TLSVersion>
            <!-- The source of an SSL certificate. Possible values: FILE, STORE. The default value is STORE. -->
            <SSLCertificateSource>STORE</SSLCertificateSource>
            <SSLCertificateStoreSettings>
            <!-- The Common Name represents the server name protected by the SSL certificate (the fully qualified HostName). -->
            <SSLCertificateCommonName></SSLCertificateCommonName>
            <!-- If specified, Windows machine certificate store is used. Otherwise, the user's certificate store is used. The default value  is true. -->
            <SSLCertificateUseMachineStore>true</SSLCertificateUseMachineStore>
			<!-- Possible values: MY (Personal), ROOT (Trusted Root Certification Authorities), TRUST (Enterprise Trust), 
			CA (Intermediate Certification Authorities), USERDS (Active Directory User Object). The default value is MY. -->
			<SSLCertificateStore>MY</SSLCertificateStore>
            </SSLCertificateStoreSettings>
            <SSLCertificateFileSettings>
            <!--Path to PKCS #12 (*.pfx) file containing the certificate and corresponding private key. 
			Path example: C:/Program Files/WebSpellChecker/AppServer/certificate.pfx -->
            <SSLCertificateFile></SSLCertificateFile>
            <SSLCertificatePassword></SSLCertificatePassword>
            </SSLCertificateFileSettings>
        </SSL>

SSL configuration example for Linux:

		<!-- Secure connection -->
		<SSL>
            <EnableSSL>true</EnableSSL>
            <!-- Transport Layer Security (TLS) version. Possible values: TLSV1, TLSV1_1, TLSV1_2. -->
            <TLSVersion>TLSV1_2</TLSVersion>
 			<!-- Path to certificate file (PEM format). Path example: /opt/WSC/AppServer/cert.pem -->
            <SSLCertificateFile></SSLCertificateFile>
            <!-- Path to private key file (PEM format). Path example: /opt/WSC/AppServer/key.pem -->
            <SSLCertificateKeyFile></SSLCertificateKeyFile>
            <SSLCertificatePassword></SSLCertificatePassword>
            <!-- Contains the path to the file or directory containing the CA/root certificates. The default value is empty. -->
            <SSLCertificateAuthorityLocation></SSLCertificateAuthorityLocation>
            <!-- specifies whether the builtin CA certificates from OpenSSL are used. The default value is false. -->
            <SSLCertificateLoadDefaultCA>false</SSLCertificateLoadDefaultCA>
		</SSL>

4. Change the default value for the EnableSSL parameter to true.

<EnableSSL>true</EnableSSL>

5. Specify path to your certificate file (*.pfx or *.pem) in the SSLCertificateFile parameter.

<!--For Linux: path to certificate file (PEM format). Path example: /opt/WSC/AppServer/cert.pem -->
<!--For Windows: path to PKCS #12 (*.pfx) file containing the certificate and corresponding private key. 
Path example: C:/Program Files/WebSpellChecker/AppServer/certificate.pfx -->
<SSLCertificateFile></SSLCertificateFile>
<!--For Linux only. Path to private key file (PEM format). Path example: /opt/WSC/AppServer/key.pem -->
<SSLCertificateKeyFile></SSLCertificateKeyFile>

6. If your SSL certificate is password-protected, type the certificate password in the SSLCertificatePassword tag.

<SSLCertificatePassword>your_certificate_password</SSLCertificatePassword>

7. As soon as the modifications are completed, start AppServer for the changes to take effect.

  • No labels