This documentation relates to iSymphony 3.5. You can view older documentation on the Older Documentation page

Skip to end of metadata
Go to start of metadata

On this page:

iSymphony opens several ports for communication with the outside world. These ports include the Web Ports used by the server to provide both the Administration and Client web interfaces, the REST API and Voicemail and Recording Agent file servers. The iSymphony server is broken up into several subsections call servlets. Each servlet can have several layers of security activated on them in order to prevent unauthorized access and man in the middle attacks.

Securing Servlets

Your iSymphony install contains the file /opt/isymphony3/server/conf/security.xml. This file contains the security settings for all servlets in the application.

You must restart the iSymphony server process in order for changes to the security.xml file to take effect.


Each servlet in the system has a specific function and enabling security on each one will secure a different piece of the application. Each servlet that can be restricted will have a relative SecurityContext in security.xml


Securing the communication_manager SecurityContext will restrict access to the REST API of the iSymphony Server.

Security is enabled by default on this servlet in order to prevent malicious use of the REST API.


Securing the client SecurityContext will restrict access to the iSymphony Client Interface.


Securing the administrator SecurityContext will restrict access to the iSymphony Administration Interface.


Securing the voicemail SecurityContext will restrict access to the Voicemail Agent file server that allows playback of voicemail in the browser.


Securing the recording SecurityContext will restrict access to the Recording Agent file server that allows playback of recordings in the browser.

SSL Keystore

The SSLKeystore tag in security.xml allows you to define the keystore that contains the SSL certificate to use when SSL is enabled on a particular servlet. You must specify the filename of the keystore, keystorePassword, the keyPassword, and the certAlias.

Keystores must be placed on the top level of the /opt/isymphony3/server/conf directory.

Creating A Self Signed SSL Keystore

If you have SSL enabled on the client or administrator servlet and you are using a self singed certificate the browser will alert the user that they are accessing an unverified location when the attempt to access the iSymphony Client or Administration Interface. In order to prevent this warning you will need to acquire an SSL certificate from a valid authority that is recognized by the your JRE.

  1. The following method requires the Oracle JDK.

  2. Run the following command to create your SSL keystore. Follow the prompts to finish creating the keystore.

    keytool -keystore <filename> -alias <alias> -genkey -keyalg RSA -validity <number of days cert is valid>
  3. Export the generated public key from the keystore by running the following command:

    keytool -export -keystore <keystore file name from step2> -alias <alias> -file <filename>
  4. Import the public key into the java truststore (cacerts) located in the java home directory:

    keytool -import -alias <alias> -file <file from step 3> -keystore $JAVA_HOME/jre/lib/security/cacerts

    The default password for the cacerts truststore is: "changeit". For more information on the keytool please see the Oracle documentation :


    The password and the default access permission of the cacerts truststore should have changed upon installing the SDK. If this was not done already it should be done as the LAST STEP of this process.

Creating a Keystore with Let's Encrypt

This section is a work in progress and will be updated.

Creating a Keystore with The Let's Encrypt module for FreePBX

FreePBX automates the process for obtaining a Let'sEncrypt certificate and utilizes it's own directory structure and file names to place the resulting files (The Certificate, any intermediate Certificate Authority chain and private key) on the filesystem.

First, we must compile and convert the resulting LE certificate chain and private key to PKCS12 format utilizing the OpenSSL binaries:

openssl pkcs12 -export -in /etc/asterisk/keys/<HOSTNAME>/fullchain.pem -inkey /etc/asterisk/keys/<HOSTNAME>/private.pem -name isymphony -out isymphony.pkcs12

Ensure you change the <HOSTNAME> placeholder above to reference the directory name that was created as part of the FreePBX certificate acquisition process.

You can choose the name you would like for the certificate alias and resulting pkcs12 keystore file name (-name and -out parameters). The above is only an example, though works without issue, so feel free to use it if appropriate.

The OpenSSL command will ask you for a password for the exported keystore. Be sure to set one as it is required and empty string passwords are not valid for this process. For this example, we used the password "isymphony". 

Then, you just import the resulting pkcs12 keystore into a newly created Java Keystore supplying the appropriate parameters and set the destination store password and key password:

keytool -importkeystore -deststorepass isymphony -destkeypass isymphony -destkeystore isymphony.jks -srckeystore isymphony.pkcs12 -srcstoretype PKCS12 -alias isymphony

And your new java keystore will be in the resulting file: ./isymphony.jks file.

This file should be copied into the top level directory of your /opt/isymphony3/server/conf (or appropriate installation directory for iSymphony) directory. 

Make iSymphony Aware of the SSLKeystore

Modify /opt/isymphony3/server/conf/security.xml to make iSymphony aware of the keystore by modifying the SSLKeystore XML element with the appropriate values:

<SSLKeystore filename="isymphony.jks" keystorePassword="isymphony" keyPassword="isymphony" certAlias="isymphony" />

Then enabling SSL on each context you would like to utilize SSL (More on this below) and restarting the iSymphonyServerV3 service should complete the configuration.

Enabling And Disabling Security Context

You can enable and disable entire Security Contexts by setting the enabled attribute to true or false in the SecurityContext tag in the /opt/isymphony3/server/conf/security.xml file. A disabled Security Context will apply no restrictions to the servlet despite any of the inner settings.

  1. SSL

You can enable and disable SSL communication encryption on a specific Security Context by setting the enabled attribute in the SSL tag to true or false.

If enabling SSL on the communication_manager servlet and you are using the iSymphony FreePBX module you must modify the module settings to use SSL. See FreePBX Module Administration for more information.

  1. Realm Authentication

You can enable or disable HTTP realm authentication on a specific Security Context by setting the enabled attribute in the RealmAuth tag to true or false. You can add a new HTTP realm authentication user by adding a RealmAuthUser tag to the RealmAuthUsers. You can specify the user's credentials by populating the username and password attributes of the RealmAuthUser tag.

  1. IP Access

You can enable IP access on a specific Security Context by setting the enabled attribute on the IPAccess tag to true or false. The IPAccess restriction will allow or deny connections from specific IP addresses based on the contents of the WhiteList and BlackList in the IPAccess tag.

  1. Behavior

  2. IPs that are specified in the WhiteList will always be allowed to access the system unless the IP is specified in the BlackList as well.
  3. IPs that are specified in the BlackList will never be allowed to access the system.
  4. If no entries are specified in the WhiteList or BlackList all IPs will have access to the servlet.
  5. If entries exist in the WhiteList but not in the BlackList only the IPs specified in the WhiteList will have access to the servlet.

Both IPv4 and IPv6 IPs can be specified the the IP Access lists.

The IP Access lists support CIDR formatting (e.g.