Important: This example is intended to provide general guidance to IT professionals who are experienced with SSL requirements and configuration. The procedure described in this article is just one of many available methods you can use to generate the required files. The process described here should be treated as an example and not as a recommendation.
When you configure Tableau Server to use Secure Sockets Layer (SSL) encryption, this helps ensure that access to the server is secure and that data sent between Tableau Server and Tableau Desktop is protected.
Generate a key file. Create a Certificate Signing Request (CSR). Send the CSR to a certificate authority (CA) to obtain an SSL certificate. Use the key and certificate to configure Tableau Server to use SSL. A CSR cannot be generated without generating a private key nor can the private key be generated without generating a CSR. In certain web server software platforms like Microsoft IIS, both are generated simultaneously through the server's wizard.
Looking for Tableau Server on Linux? See Example: SSL Certificate - Generate a Key and CSR.
Tableau Server uses Apache, which includes OpenSSL. You can use the OpenSSL toolkit to generate a key file and Certificate Signing Request (CSR) which can then be used to obtain a signed SSL certificate.
Steps to generate a key and CSR
To configure Tableau Server to use SSL, you must have an SSL certificate. To obtain the SSL certificate, complete the steps:
You can find additional information on the SSL FAQ page on the Apache Software Foundation website.
Configure a certificate for multiple domain names
Tableau Server allows SSL for multiple domains. To set up this environment, you need to modify the OpenSSL configuration file, openssl.conf, and configure a Subject Alternative Name (SAN) certificate on Tableau Server. See For SAN certificates: modify the OpenSSL configuration file below.
Set the OpenSSL configuration environment variable (optional)
To avoid using the
-config argument with every use of openssl.exe, you can use the OPENSSL_CONF environment variable to ensure that the correct configuration file is used and all configuration changes made in subsequent procedures in this article produce expected results (for example, you must set the environment variable to add a SAN to your certificate).
Open the Command Prompt as an administrator, and run the following command:
set OPENSSL_CONF=c:Program FilesTableauTableau Serverpackagesapache.<version_code>confopenssl.cnf
Notes:
Generate a key
Generate a key file that you will use to generate a certificate signing request.
Create a certificate signing request to send to a certificate authority
Use the key file you created in the procedure above to generate the certificate signing request (CSR). You send the CSR to a certificate authority (CA) to obtain a signed certificate.
Important: If you want to configure a SAN certificate to use SSL for multiple domains, first complete the steps in For SAN certificates: modify the OpenSSL configuration file below, and then return to here to generate a CSR.
Send the CSR to a certificate authority to obtain an SSL certificate
Send the CSR to a commercial certificate authority (CA) to request the digital certificate. For information, see the Wikipedia article Certificate authority and any related articles that help you decide which CA to use.
Use the key and certificate to configure Tableau Server
When you have both the key and the certificate from the CA, you can configure Tableau Server to use SSL. For the steps, see Configure External SSL.
For SAN certificates: modify the OpenSSL configuration file
In a standard installation of OpenSSL, some features are not enabled by default. To use SSL with multiple domain names, before you generate the CSR, complete these steps to modify the openssl.cnf file.
Additional information
If you prefer to use a different version of OpenSSL, you can download it from Open SSL for Windows.
Thanks for your feedback!There was an error submitting your feedback. Try again or send us a message.
Finding your Private Key on Different Servers or Control Panels
Linux-Based (Apache, Nginx, LightHttpd) Windows Operating Systems Mac OS X Tomcat cPanel WHM Plesk Synology NAS DSM Webmin VestaCP DirectAdmin Webuzo What Is a Private Key?
What Is a Private Key?
Youâve received your SSL Certificate, and now you need to install it.
Firstly, letâs go through some basics. Public Key Infrastructure (PKI) security is about using two unique keys: the Public Key is encrypted within your SSL Certificate, while the Private Key is generated on your server and kept secret.
All the information sent from a browser to a website server is encrypted with the Public Key, and gets decrypted on the server side with the Private Key. Together the key pair keeps communication secured, and one key will not work without the other.
How do I get it?
The Private Key is generated with your Certificate Signing Request (CSR). The CSR is submitted to the Certificate Authority right after you activate your Certificate. The Private Key must be kept safe and secret on your server or device, because later youâll need it for Certificate installation.
Note: all Certificates except Multi-Domains support Private Key generation in your browser. The key is always saved during SSL activation, we never receive this information. Thatâs why itâs important you save and back it up during the process if you use the in-browser automatic generation method. If the Private Key key file is lost, youâll need to reissue your Certificate.
Can I generate a new Private Key for my Certificate if I lose the old one?
Yes. You can generate a new private key and CSR, or use the automatic CSR and key generation during Certificate reissue (this option is available for all Certificates except for the Multi-Domains).
What does the Private Key look like?
It looks like a block of encoded data, starting and ending with headers, such as ââBEGIN RSA PRIVATE KEYââ and ââEND RSA PRIVATE KEYââ. 4k video downloader license key generator.
You may not get to see this code when generating your CSR. Usually, it gets generated in the background with the CSR, and is automatically saved on your server. The system also fills the corresponding field automatically during installation of your Certificate in some control panels, such as cPanel.
The way this works varies depending on your web server, control panel, or any other tools used for CSR generation. Select the one that applies to you in the following section for specific guidance.
Finding your Private Key on Different Servers or Control PanelsLinux-based (Apache, NGINX, LightHttpd)
Normally, the CSR/RSA Private Key pairs on Linux-based operating systems are generated using the OpenSSL cryptographic engine, and saved as files with â.keyâ or â.pemâ extensions on the server.
But no specific extensions are mandatory for text files in Linux, so the key file may have any name and extension, or no extension at all.
If you remember the whole name of the key file or at least part of it, you can use the following command in your console to find the file and its directory:
The slash symbol in this command implies that the search begins from the root directory of the server. This way you have more file options to view. The name of the file in between the single quotation marks should be the part of the name that you remember. To search for the file by extension, enter â*.keyâ to view all the files with the â.keyâ extension on your server.
Tip: often the name of the file corresponds to the domain name it was generated for e.g. âdomain_tld.keyâ or âdomain.tld.pemâ.
Hereâs another useful command that lets you search files by their content:
This command will return the absolute path to the Private Key file if itâs located on your server.
Windows Operating Systems (IIS, Exchange, Small Business server)
Windows servers donât let you view the Private Key in plain text format. When you import your Certificate via MMC or IIS, the Private Key is bound to it automatically if the CSR/Key pair has been generated on the same server.
If you need to obtain the Private Key to install your Certificate on a different server, you can export the key in a password protected PFX (PKCS#12) file. To do that, open the MMC Certificates snap-in tools following these steps:
Win+R >> mmc.exe >> OK >> File >> Add/Remove Snap-in >> Certificates >> Add >> Computer account >> Next >> Local computer >> Finish >> OK
Next, go to Certificate Enrollment Requests >> Certificates (if you havenât completed the Certificate request yet). If youâve done that, youâd select Personal >> Certificates, then right-click the Certificate >> select All Tasks >> Export. The Export wizard will open, and give you instructions. You can find more detailed instructions here.
Once thatâs done, you will see the .pfx file containing your Certificate, CA-Bundle, and Private Key. To extract the key, use this tool. Choose the PKCS12 to PEM option, then upload the file and enter your chosen password.
Mac OS X
The Keychain tool in the Server application of Mac OS X wonât allow you to access the Private Key via the graphic user interface. Instead use the Terminal, by opening /etc/certificates/ directory and clicking the file.
Its name should be something like â*.key.pemâ. And the terminal commands to open the file are: cd /etc/certificates/ , then ls , and sudo nano test.key.pem.
Note: to check if the Private Key matches your Certificate, go here. Then paste the Certificate and the Private Key text codes into the required fields and click Match.
Tomcat
If your Tomcat SSL connector is configured in JSSE style, the Private Key must be in a password-protected keystore file with a .jks or .keystore extension. This file, unlike most other cases, is created before the CSR. To extract the Private Key, youâll need to convert the keystore into a PFX file with the following command:
Tips:
After the PKCS12 file is generated, you can convert it to a PEM file with separated CRT, CA-Bundle and KEY files using this tool. Alternatively, use the following command in the terminal:
âPrivate.keyâ can be replaced with any key file title you like.
cPanel
WHMGenerate Private Key From Csr Keytool
WHM stores your private keys and CSR codes in the SSL Storage Manager menu. On the homepage, click SSL/TLS >> SSL Storage Manager. To view the Private Key, click the magnifier icon next to the relevant key in the Key column.
Plesk
Click Domains >> your domain >> SSL/TLS Certificates. Youâll see a page like the one shown below. The key icon with the message âPrivate key part suppliedâ means there is a matching key on your server.
To get it in plain text format, click the name and scroll down the page until you see the key code. Alternatively, click the green arrow icon on the right. This will download a PEM file, containing your Private Key, Certificate and CA-Bundle files (if they were previously imported to the server). The files can be opened in any text editor, such as Notepad.
Synology NAS DSMGenerate Private Key For Certificate
When generating a CSR in Synology DSM, the Private Key is provided to you in a zip file on the last step. The key code is contained within a server.key file, that can be opened with a text editor, such as Notepad.
Webmin
Webmin works as a graphic user interface (GUI) on top of the command-line interface. There is also a file manager called Filemin, that you can use to browse the server file system and find your Private Key file. Alternatively, go to Others >> Command Shell and run the find or grep command, which you can find in the Linux Operating Systems section above.
VestaCP
Your Private Key needs to be saved during CSR generation, as it will not be available via the graphic user interface.
That said, you may be able to retrieve your Private Key via SSH. It is saved as a temporary file in the â/tmpâ folder. The path to the file will look something like this: â/tmp/tmp.npAnkmWFcu/domain.com.keyâ.
Note: the files in the /tmp directory are deleted every time your server is rebooted, so this is not a safe place to store your Private Key.
To get the path to your key file, use this Linux command:
Where you see âdomain.comâ, replace this with the actual domain name you generated the CSR for.
The path to your key file can also be found using the grep command:
DirectAdmin
In the up-to-date version of DirectAdmin, your Private Key is saved on the server. Access it in the âPaste a pre-generated Certificate and keyâ field during installation.
If that section is empty, it may mean the CSR and key were generated elsewhere, or the key was not saved in DirectAdmin due to a glitch. If a glitch happened, try retrieving the key via SSH. Usually it is saved in this directory:
Generate A Private Key From Csr Key
/usr/local/directadmin/data/users/<user>/domains/<domain>.key
Note: <user> and <domain> are your DirectAdmin details.
Webuzo
On the homepage, find the SSL management section by clicking the Private Keys button. This will display a list of all the Private Keys generated in Webuzo. To see the key code, click the pencil icon to the right under the Option column, as shown in the screenshot below:
Advantages Of Private Key Encryption
To sum up, ways to find your private key fully depend on the interface of the web server where you generate the CSR. If the methods described above did not help you find the private key for your certificate, the only solution would be to generate a new CSR/private key pair and reissue your certificate and to make sure that the key is saved on your server/local computer this time.
Comments are closed.
|
AuthorWrite something about yourself. No need to be fancy, just an overview. Archives
November 2020
Categories |