The Gateway Network General Settings set the basic rules for the system. By default, these settings are lenient to allow for easy setup, but can be set for security.
|Enabled||Uncheck this checkbox to disable using the Gateway Network on this Ignition.|
|Require SSL||If true, only connections that use SSL to encrypt traffic will be allowed. This setting only applies to incoming connections. Default is true.|
|Require Two Way Auth|
Enforces two-way SSL authentication. If true, you will need to install the remote machine's certificate on this machine, in addition to manual approval of this machine's certificate on the remote machine.
If you check this setting, you will need to provide the remote machine's certificate. To do this, manually export a certificate from the remote machine's metro keystore, located in <installdir>/webserver/metro-keystore. Default keystore password is metro, and the alias is metro-key. Then place the certificate on the local machine, in data/certificates/gateway_network.
|Send Buffer Limit||The number of outstanding messages that can be waiting for acknowledgement at a time. Default is 5.|
|Receive Queue Limit||If there is too much traffic on the Gateway Network, then it can tell Agents to stop sending messages for a specified amount of time. This setting is the number of received messages that can be held until they are processed by the local system. When this capacity is exceeded, the calling side will wait until capacity is available. Default is 100.|
|Receive Threads||The maximum number of threads that can be used to process incoming messages. Default is 5.|
By default, the security level for incoming connections is set to “Unrestricted”, meaning that every remote machine that attempts to connect to the local machine will be accepted without question. You have several options to control security from the Gateway Network settings. Note that these settings are independent of SSL mode, which is detailed below. To change security settings, go to the Gateway Webpage and navigate to Config -> Networking -> Gateway Network and select the General Settings tab.
|Allow Incoming Connections||Uncheck this checkbox to disable all remote machines from being able to establish an incoming connection. To establish any connections with remote machines, you will need to create outgoing connections from this machine. Default is true.|
Dictates what connections are allowed. Options as follows:
|Specified List||Connections with an ID in this list are automatically allowed if the security mode is set to SpecifiedList. Separate Gateway names with a comma.|
|Allow Proxying||If enabled, this Gateway will be allowed to act as a proxy, and forward requests between Gateways that do not have direct connections.|
Gateway Network Connection Example
To establish a basic communication link between two Gateways, first log into the Gateway where you want to establish the outgoing connection.
For this example, we're going to use an SSL connection.
- On the Gateway Webpage, navigate to Config -> Networking -> Gateway Network.
- Click on the Outgoing Connections tab. Click the Create new Outgoing Gateway Connection link.
In the Host field, enter the network address of the remote server.
In the Port field, enter the SSL port used by the remote server. By default, this is set to 8060 (which is defined /data/gateway.xml).
This port is different from the default SSL port an Ignition Gateway would use when communicating to a client (default port 8043).
Check the Use SSL checkbox.
- Use the default settings in the Ping section and Timeouts section of the page.
Click the Create New Outgoing Gateway Connection button at the bottom of the page.
You'll see a confirmation message that the connection was created.
At this point, your Gateway transmitted its certificate to the connected Gateway, but the incoming connection is not yet allowed. The Gateway’s connection will not show up under the Incoming Connections tab until after the certificate has been approved.
Log into the other Gateway.
Click on the Incoming Connections tab. The first Gateway’s certificate should be present. The certificate Common Name field holds the network address of the machine that transmitted the certificate. The Serial field holds a numeric string that is automatically generated when the certificate is created, and is unique to every certificate.
- Click the approve button to accept the certificate. You'll see a confirmation message. Click the Confirm button.
Outgoing and incoming connections can be deleted for cases when the connection no longer exists on the other side.
- To delete a connection, navigate to Config -> Networking -> Gateway Network.
- Click on either the Outgoing Connections tab or the Incoming Connections tab.
- Click More, and then select Delete next to the connection. Note that for incoming connections, if a remote machine is still connected to the local machine with an outgoing connection, a new incoming connection will be created after deletion. For these cases, you must log into the remote Gateway and delete the outgoing connection. Then you can delete the local incoming connection.
Certificates and SSL
When a remote machine establishes an incoming connection, its Gateway server name is transmitted and appears in the Server Name field under Gateway Network -> Incoming Connections. However, there no identity authentication is performed when the connection is created. The local system accepts the remote system id without question. To perform identity authentication on a connection, you must use Secure Socket Layer (SSL) and certificates. By default, SSL is enabled.
Requiring a Certificate
To require all incoming Gateways to use SSL, navigate to Config -> Networking -> Gateway Network.
Select the General Settings tab, and check the Require SSL checkbox.
Click the Save Changes button.
Denying a Certificate
You can deny a certificate under the Certificates tab by clicking the deny link to the right of the certificate. The connection that has been using that certificate will not longer be allowed to connect. You can delete certificates that are no longer in use. Keep in mind that if you delete a certificate, and a remote machine is still using that certificate, it will reappear on the Certificates page. In this case, you must navigate to the remote Gateway and delete its outgoing connection. Then you can permanently delete the certificate from the Certificates page.
Gateway Network Diagnostics
The Diagnostics tab on the Gateway Network Settings page gives you insight to the Gateway and and remote server response times.
- To test the response time of a remote server, select the server name from the Server dropdown list.
- Click the Submit button.
- The results will be displayed indicating if the call to the remote server was successful, what the response time was, and if there were any errors.