4379
Comment: Add big fat disclaimer about using our cert, and link to it
|
← Revision 50 as of 2022-01-15 06:48:28 ⇥
5426
LetsEncrypt expiration policy circa January 2022
|
Deletions are marked like this. | Additions are marked like this. |
Line 5: | Line 5: |
[[TableOfContents]] | <<TableOfContents>> |
Line 7: | Line 7: |
= Introduction = | {{{#!wiki caution '''Security Precautions''' |
Line 9: | Line 10: |
There are several different options available for providing an SSL certificate to use with us. | At some point, your certificate and private key will need to be stored in afs. Since afs is publicly accessible, you need to take a few precautions to ensure that your data remains private. For all key operations, keep the files in a directory that only you and the admins can read. We provide a script to create such a directory: `/afs/hcoop.net/common/bin/make-secure-directory certificates` }}} |
Line 11: | Line 13: |
The first option is to get a signed certificate from a trusted Certificate Authority ("CA" for short). If you want to make it os that visitors to your website never see an annoying nag dialog box, then this is your best option. | == Introduction == |
Line 13: | Line 15: |
Alternatively, you can provide us with a certificate request ("CSR" for short), and we can provide you with a signed certificate. Please be aware that since our [http://deleuze.hcoop.net/ca/ca.crt CA certificate] is not included by default with any web browsers or operating systems, you won't really gain much benefit from having us sign your cert, except for a nebulous "cool factor" :) . If you want to be sure that the people who browse your website won't be prompted about accepting your SSL certificate, then this is not for you. | There are a few options for acquiring an SSL certificate to use with us. |
Line 15: | Line 17: |
The last option is to make a self-signed certificate. | The first option is to get a signed certificate from a trusted Certificate Authority ("CA" for short). If you want to make it so that visitors to your website never see an annoying nag dialog box, then this is your best option. The easiest way to do this is [[/LetsEncrypt|using letsencrypt]] |
Line 17: | Line 19: |
= Having HCoop provide you with a certificate = | Alternatively, you can generate a self-signed certificate. |
Line 19: | Line 21: |
If you are creating an SSL certificate to use for a web virtual host via DomTool, then you need to create both a key file and a csr file. The csr file is called a "certifcate signing request" (sometimes abbreviated "certificate request"), and you will want to specify that on the SSL form in the HCoop Portal. We'll also need access to your key. | There are several good introductions to SSL and x509 certificates in general if you are unfamiliar with the subject: |
Line 21: | Line 23: |
To create a cerificate request in `file.csr` and a private key in `file.key`, do the following. The certificate should be placed somewhere in your home directory, like "{{{~/certs}}}", for example. | * [[https://www.ssllabs.com/projects/best-practices/index.html|Qualsys SSL Deployment Best Practices]] * [[https://httpd.apache.org/docs/2.4/ssl/ssl_faq.html#aboutcerts|Apache SSL FAQ]] * [[http://www.tldp.org/HOWTO/SSL-Certificates-HOWTO/index.html|The SSL Certificate HOWTO]] == Generating a Key and Certificate Signing Request == If you are creating an SSL certificate to use for a web virtual host via DomTool, then you need to create both a key file and a csr file. The csr file is called a "certificate signing request" (sometimes abbreviated "certificate request"), and you will want to specify that on the SSL form in the HCoop Portal. We'll also need access to your key. Your key ''must be kept private''. You supply the csr to any certification authorities you would like to sign your key, and later combine the certificate given by them with your private key to server a TLS site from our servers. It is highly recommended that you generate a private key specifically for use with HCoop. To create a cerificate request in `file.csr` and a private key in `file.key`, do the following. These files should be readable only by you and the HCoop admins, so be sure to set permissions properly on the directory where you store the certificate request and key. The certificate should be placed somewhere in your home directory, like `~/certificates`. |
Line 24: | Line 36: |
openssl req -newkey rsa:2048 -keyout file.key -out file.csr -nodes | /afs/hcoop.net/common/bin/make-secure-directory ~/certificates cd ~/certificates openssl req -sha256 -newkey rsa:2048 -keyout file.key -out file.csr -nodes |
Line 32: | Line 46: |
* '''Common Name''': This is the domain that goes with the certificate. It can be either a single name (i.e. "yourdomain.org"), or a wildcard domain (like "*.yourdomain.org"). The wildcard domain is used for sharing the same certificate in multiple subdomains of your domain. | * '''Common Name''': This is the domain that goes with the certificate. It can be either a single name (i.e. "yourdomain.org"), or a wildcard domain (like "*.yourdomain.org"). The wildcard domain is used for sharing the same certificate in multiple subdomains of your domain. Most CAs will not sign wildcard certificates. |
Line 37: | Line 51: |
These files should be readable only by you and the HCoop admins, so be sure to set permissions properly on the directory where you store the certificate request and key. Now you're ready to follow the rest of the instructions on [:../:the previous page]. | == Signing the Key == |
Line 39: | Line 53: |
When we process your request, we will: | === Using a Trusted CA === |
Line 41: | Line 55: |
* Sign the certificate request as a Certificate Authority (CA). * Place a complimentary copy of the resulting certificate in the same directory as the certificate request, with a ".crt" extension. * Concatenate the signed request with your key. * Place the result in {{{/etc/apache2/ssl/user/yourdomain.org.pem}}}. * Grant you Domtool permissions so that you can use this certificate at location {{{/etc/apache2/ssl/user/yourdomain.org.pem}}} in your Domtool configuration. |
There are several options available. By far the largest providers are [[https://www.verisign.com/|VeriSign]] and [[https://www.thawte.com/|Thawte]]. Several members seem to like [[https://gandi.net|Gandi]]. We make no specific recommendations concerning which CA to choose: just make certain that their root CA certificates are included with the majority of web browsers. |
Line 47: | Line 57: |
This allows you to import a single [http://deleuze.hcoop.net/ca/ca.crt CA certificate] (click on the link to install), which avoids the "certificate confirmation" dialog box when you browse one of our websites (or one of our member websites). Be aware that '''we are not in any way recommending that you do this'''; it is solely for the sake of convenience that we provide this option. | [[https://letsencrypt.org/|Letencrypt]] offers free SSL certificates (but must be renewed every 60 days). |
Line 49: | Line 59: |
= Making a self-signed .pem file = | === Self-Signing === |
Line 51: | Line 61: |
This is for reference, in case you want to make a self-signed certificate rather than having HCoop sign it. '''DAYS''' indicates the number of days that you want the certificate to be valid. '''FILE''' is the filename of the certificate that will be generated: it should end in ".pem". '''DAYS''' indicates the number of days that you want the certificate to be valid. |
'''FILE''' is the filename of the certificate that will be generated: it should end in ".pem". '''DAYS''' indicates the number of days that you want the certificate to be valid. It is recommended not to sign keys for longer than a year or two. |
Line 56: | Line 64: |
/afs/hcoop.net/common/bin/make-secure-directory ~/certificates cd ~/certificates |
|
Line 58: | Line 68: |
== Installing the Certificate == Now that you have a certificate, we need to install it. Use the [[https://members.hcoop.net/portal/cert|SSL permissions]] page on the portal to request installation of your new certificate. You need to provide us with either: * A `pem` containing your public certificate, private key, and any intermediate certificates (in that order) concatenated together * Your public certificate and private key, both in `pem` format For the latter option, provide both paths in the same form, separated by a space. We will then verify the certificate and install it, providing you with a path that you can use to [[DomTool/Examples#UsingSSL.28HTTPS.29|enable SSL using domtool]]. ---- CategoryMemberManual |
This is the page of the MemberManual that describes how to generate a valid SSL cert.
Contents
Security Precautions
At some point, your certificate and private key will need to be stored in afs. Since afs is publicly accessible, you need to take a few precautions to ensure that your data remains private. For all key operations, keep the files in a directory that only you and the admins can read. We provide a script to create such a directory: /afs/hcoop.net/common/bin/make-secure-directory certificates
Introduction
There are a few options for acquiring an SSL certificate to use with us.
The first option is to get a signed certificate from a trusted Certificate Authority ("CA" for short). If you want to make it so that visitors to your website never see an annoying nag dialog box, then this is your best option. The easiest way to do this is using letsencrypt
Alternatively, you can generate a self-signed certificate.
There are several good introductions to SSL and x509 certificates in general if you are unfamiliar with the subject:
Generating a Key and Certificate Signing Request
If you are creating an SSL certificate to use for a web virtual host via DomTool, then you need to create both a key file and a csr file. The csr file is called a "certificate signing request" (sometimes abbreviated "certificate request"), and you will want to specify that on the SSL form in the HCoop Portal. We'll also need access to your key.
Your key must be kept private. You supply the csr to any certification authorities you would like to sign your key, and later combine the certificate given by them with your private key to server a TLS site from our servers. It is highly recommended that you generate a private key specifically for use with HCoop.
To create a cerificate request in file.csr and a private key in file.key, do the following. These files should be readable only by you and the HCoop admins, so be sure to set permissions properly on the directory where you store the certificate request and key. The certificate should be placed somewhere in your home directory, like ~/certificates.
/afs/hcoop.net/common/bin/make-secure-directory ~/certificates cd ~/certificates openssl req -sha256 -newkey rsa:2048 -keyout file.key -out file.csr -nodes
Here is an explanation of the parameters that you will be asked to provide. Replace yourdomain.org with your domain name.
Country/State/Locality: These are self-explanatory.
Organization Name: This can be anything you want. It is often the full name or description of your organization or website.
Organizational Unit Name: This can be anything you want. It can be left blank.
Common Name: This is the domain that goes with the certificate. It can be either a single name (i.e. "yourdomain.org"), or a wildcard domain (like "*.yourdomain.org"). The wildcard domain is used for sharing the same certificate in multiple subdomains of your domain. Most CAs will not sign wildcard certificates.
Email Address: A valid email address. People often use ca@yourdomain.org.
Challenge Password: Leave blank.
Company Name: This can be anything you want. It can be left blank.
Signing the Key
Using a Trusted CA
There are several options available. By far the largest providers are VeriSign and Thawte. Several members seem to like Gandi. We make no specific recommendations concerning which CA to choose: just make certain that their root CA certificates are included with the majority of web browsers.
Letencrypt offers free SSL certificates (but must be renewed every 60 days).
Self-Signing
FILE is the filename of the certificate that will be generated: it should end in ".pem". DAYS indicates the number of days that you want the certificate to be valid. It is recommended not to sign keys for longer than a year or two.
/afs/hcoop.net/common/bin/make-secure-directory ~/certificates cd ~/certificates openssl req -x509 -newkey rsa:2048 -keyout FILE -out FILE -days DAYS -nodes
Installing the Certificate
Now that you have a certificate, we need to install it.
Use the SSL permissions page on the portal to request installation of your new certificate. You need to provide us with either:
A pem containing your public certificate, private key, and any intermediate certificates (in that order) concatenated together
Your public certificate and private key, both in pem format
For the latter option, provide both paths in the same form, separated by a space.
We will then verify the certificate and install it, providing you with a path that you can use to enable SSL using domtool.