Using Encrypted Connections
TigerGraph supports secure data-in-flight communication, using SSL/TLS encryption protocol. This applies to any outward-facing channel, including GSQL clients, RESTPP endpoints, and the GraphStudio web interface. When SSL/TLS is enabled, HTTPS takes the place of HTTP for RESTPP and GraphStudio connections.
You should have basic knowledge about how SSL works:
- What the SSL certificate and key are used for
- That a SSL certificate is bound to a domain
- How a SSL certificate chain works
A good primer on SSL is available to
TigerGraph uses the Nginx web server, so SSL configuration makes use of some built-in support in Nginx.
Step 1. Obtain a SSL Certificate
The two main options for obtaining a SSL Certificate are to generate your own self-signed certificate or to purchase a certificate from a trusted Certificate Authority. Regardless of which method you choose, your certificate should be chained to a trusted root certificate embedded in your browser. The options and details for producing a trusted SSL certificate are beyond the scope of this document. The focus of this document is how to use a configure your TigerGraph system to use the certificate to enable SSL.
Option 1: Using a Certificate From A Trusted Agent
First, obtain a SSL certificate from a trusted agent of your choice. Certificate vendors will provide clear instructions for ordering a certificate and then for installing it on your system.
Then you can configure the certificate with
gadmin –configure ssl
Option 2: Create a Self-Signed Certificate
There are multiple ways to create a self-signed certificate. One example is shown below.
For simplicity, the method below will use the root certificate directly as the HTTPS server certificate. This method is satisfactory for testing but should not be used for a production system.
In the example below, the Common Name value should be your server hostname, since HTTPS certificates are bound to domain names.
Change the Certificate Permission
For security reasons, the certifiactes can only be used with permission
600 or less
Step 2: Configure SSL with gadmin
With the self-signed certificate successfully generated, you can configure it with gadmin, so that all the HTTP traffic will be protected with SSL.
After saving the settings, apply the configuration settings.
Then restart the external-facing services: gsql, nginx, and vis.
Testing Your SSL Connection
Now you may test the connection.
A direct curl request to the server will fail due to certificate verification failure:
In v1.2, the default TCP/IP port for Nginx has changed from 44240 to 14240, to avoid possible port conflicts with Zookeeper.
You may use the -k option to turn off the verification, but it is
and not recommended.
To successfully make requests with curl, you will need to specify the certificate by using the –cacert parameter: