Skip to Content

Wiki source code of Security

Version 3.1 by michaely on 2021/09/09 18:02
Show last authors
1 **//On this page~://**
2
3
4
5 {{toc/}}
6
7 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.
8
9 = Securing Servlets =
10
11 Your iSymphony install contains the file **/opt/isymphony3/server/conf/security.xml**. This file contains the security settings for all servlets in the application.
12
13 {{info}}
14 You must restart the iSymphony server process in order for changes to the **security.xml** file to take effect.
15 {{/info}}
16
17 == Servlets ==
18
19 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**
20
21 === communication_manager ===
22
23 Securing the **communication_manager** **SecurityContext** will restrict access to the REST API of the iSymphony Server.
24
25 {{info}}
26 Security is enabled by default on this servlet in order to prevent malicious use of the REST API.
27 {{/info}}
28
29 === client ===
30
31 Securing the **client SecurityContext** will restrict access to the iSymphony Client Interface.
32
33 === administrator ===
34
35 Securing the **administrator SecurityContext** will restrict access to the iSymphony Administration Interface.
36
37 === voicemail ===
38
39 Securing the **voicemail SecurityContext** will restrict access to the Voicemail Agent file server that allows playback of voicemail in the browser.
40
41 === recording ===
42
43 Securing the **recording SecurityContext** will restrict access to the Recording Agent file server that allows playback of recordings in the browser.
44
45 == SSL Keystore ==
46
47 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**.
48
49 {{info}}
50 Keystores must be placed on the top level of the **/opt/isymphony3/server/conf** directory.
51 {{/info}}
52
53 === Creating A Self Signed SSL Keystore ===
54
55 {{note}}
56 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.
57 {{/note}}
58
59 * (((
60 The following method requires the Oracle JDK.
61 )))
62 * (((
63 Run the following command to create your SSL keystore. (% style="line-height: 1.4285715;" %)Follow the prompts to finish creating the keystore.
64
65 {{code language="bash"}}
66 keytool -keystore <filename> -alias <alias> -genkey -keyalg RSA -validity <number of days cert is valid>
67 {{/code}}
68 )))
69
70 == Enabling And Disabling Security Contexts ==
71
72 You can enable and disable entire **Security Contexts** by setting the **enabled** attribute to **true** or **false** in the **SecurityContext** tag. A disabled **Security Context** will apply no restrictions to the servlet despite any of the inner settings.
73
74 == SSL ==
75
76 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**.
77
78 {{info}}
79 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 [[doc:FreePBX Module Administration]] for more information.
80 {{/info}}
81
82 == Realm Authentication ==
83
84 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.
85
86 == IP Access ==
87
88 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.
89
90 === Behavior ===
91
92 * 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.
93 * IPs that are specified in the **BlackList** will never be allowed to access the system.
94 * If no entries are specified in the **WhiteList** or **BlackList** all IPs will have access to the servlet.
95 * If entries exist in the **WhiteList** but not in the **BlackList** only the IPs specified in the **WhiteList** will have access to the servlet.
96
97 {{info}}
98 Both IPv4 and IPv6 IPs can be specified the the IP Access lists.
99 {{/info}}
100
101 {{info}}
102 The IP Access lists support **CIDR** formatting (e.g. 192.168.1.0/24)
103 {{/info}}