This article explains how to install a trusted SSL certificate for the web services that run through the EditShare gateway:
| Service | Port | Example URL |
|---|---|---|
| AirFLOW | 8005 | https://flow.mydomain.com:8005 |
| EditShare One | 8008 | https://flow.mydomain.com:8008 |
| FLOW Control | 8009 | https://flow.mydomain.com:8009 |
| FLOW Automation | 8012 | https://flow.mydomain.com:8012 |
| EFS Control | 8086 | https://flow.mydomain.com:8086 |
All five services are configured the same way: each gets its own section in a single file, /etc/editshare/gateway.conf, named after its port number.
Before you start
To improve security and avoid browser warnings, EditShare recommends that you obtain a trusted SSL certificate from a Certification Authority (CA) and install it on the server. Keep the following in mind:
- Use SHA-2 certificates only (SHA-256 or stronger). Do not use SHA-1 certificates. The SHA-1 algorithm has serious known vulnerabilities and browsers treat these certificates as insecure.
- Plan for renewal. Certificates usually need to be renewed every 1–3 years. When you renew, replace the files and restart the services as described below.
- Protect the private key. Keep the private key file safe and never share it with anybody.
-
Use a host name, not an IP address. The certificate must be issued for the DNS host name of the server (for example,
flow.mydomain.com). This is the certificate's Common Name (CN). Certification Authorities do not accept IP addresses as CNs. -
Give the server its own host name. Users must reach the server by a unique, complete host name such as
flow.mydomain.com. Mapping a service to a directory off a domain name (for example,mydomain.com/Airflow) does not work.
A certificate is tied to the host name, not to a port. If all five services run on the same server and users reach them by the same host name, one certificate and key pair can secure all of them. If services run on different servers or under different host names, obtain a certificate (or a multi-name/SAN certificate) that covers each host name.
Some CAs offer SSL certificates free of charge. Read your CA's documentation before purchasing and installing a certificate.
What you need from the CA
You'll need at least two files, and possibly a third:
-
Private key (encryption key), for example
certificate.key -
Certificate file, for example
certificate.crt -
Intermediate (chain) certificate, if your CA provides one, for example
chain.crt. See Adding intermediate (chain) certificates below.
In order to get those files from your CA, you'll need to provide them a CSR. This article explains how to generate a Certificate Signing Request.
The certificate and private key must both be in PEM format:
- The certificate is enclosed between
-----BEGIN CERTIFICATE-----and-----END CERTIFICATE-----. - The private key is enclosed between
-----BEGIN PRIVATE KEY-----and-----END PRIVATE KEY-----.
If your files are in another format, such as DER, ask your certificate provider for a .pem version or convert them with an open-source tool such as OpenSSL. For example:
openssl x509 -inform DER -in certificate.der -out certificate.crt openssl pkey -inform DER -in private.der -out certificate.key
Step 1: Copy the certificate files to the server
-
On the EditShare server, go to the folder
/etc/flow/{companyname}, where{companyname}is the name of your company or organization. If the folder does not exist, create it:sudo mkdir -p /etc/flow/{companyname} - Upload the certificate file, the private key file and, if you have one, the chain certificate to the
/etc/flow/{companyname}folder.
Step 2: Configure the gateway.conf file
- Open
/etc/editshare/gateway.confin a text editor. If the file does not exist, create it. -
Add one section for each service you want to secure. Each section header is the service's port number followed by
.ssl. The example below secures all five services with the same certificate:# EditShare One [8008.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt # FLOW Control [8009.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt # FLOW Automation [8012.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt # EFS Control [8086.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt # AirFLOW [8005.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt disable_http_server=true
Include only the sections for the services you run. If a service uses a different certificate, point itskeyandcertlines at that certificate's files. -
If the private key file is password-protected, add its passphrase to each section that uses it. Without the passphrase, FLOW won't start.
passphrase=SECRET-PASSWORD
- Save the file.
Step 3: Add intermediate (chain) certificates, if needed
Your CA may provide intermediate certificates. These link, or "chain", the certificate the CA issued to you to the root certificate trusted by users' web browsers. If the chain is missing, some browsers and clients will show security warnings even though the certificate itself is valid.
- Make sure the chain file is in
/etc/flow/{companyname}(Step 1). -
In
/etc/editshare/gateway.conf, add achainline to each service section, for example:[8086.ssl] key=/etc/flow/{companyname}/certificate.key cert=/etc/flow/{companyname}/certificate.crt chain=/etc/flow/{companyname}/chain.crt disable_http_server=true
Repeat for 8008, 8009, 8012 and 8005 as needed. - Save the file.
If you run your own PKI infrastructure, point both cert and chain at a full-chain certificate bundle: the server certificate, any intermediates, and the root CA certificate. The order matters: the server certificate must come first.
Step 4: Restart the server
The new configuration takes effect when the server running these services restarts, which interrupts users.
- Choose a time when user activity is low.
- Tell users that which server(s) wo;; be restarted, and that they should save their work and log out.
- Make sure no ingest or transcode jobs are in progress. Check the jobs running in FLOW Automation.
- From the desktop of the appropriate server, launch the "Linux Reboot" icon.
Step 5: Verify the installation
After the reboot, for each service you configured, open its URL in a web browser, using the host name on the certificate (see the table at the top of this article; for example https://flow.mydomain.com:8086 for EFS Control). Confirm that:
- The browser shows the secure-connection (padlock) icon in the address bar.
- No browser security warnings appear.
To check the certificate chain, do either of the following:
- Test the server at https://www.ssllabs.com/ssltest/ (the server must be reachable from the internet).
-
At a command prompt, run the following, replacing
SERVER_HOSTandPORTwith the host name and the service's port:openssl s_client -connect SERVER_HOST:PORT -showcerts
Confirm thatVerify return code: 0 (ok)appears at the end of the response. Repeat for each port.
Troubleshooting
-
Service won't start after the change. There's likely something wrong with the certificate configuration. Also check that the file paths in
gateway.confare correct and the files are in PEM format. - Browser warns that the certificate doesn't match. Make sure you're browsing to the host name on the certificate, not to the server's IP address or a different name.
If you have questions or issues, please reach out to EditShare Support.
Comments
0 comments
Article is closed for comments.