|
Size: 4707
Comment: stop recommending members have hcoop ign their certs: there really is no value to having us do that any more (or really ever)
|
Size: 5378
Comment: update formatting, docs, link to qualsys docs, make examples clearer, restructure a bit, think this is adequate now and nolonger has to be tagged needswork
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| {{{#!wiki caution '''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` }}} |
|
| Line 11: | Line 17: |
| 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 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 23: |
| * [[http://httpd.apache.org/docs/2.2/ssl/ssl_faq.html#aboutcerts|Apache SSL FAQ]] | * [[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]] |
| Line 20: | Line 27: |
| == 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: {{{ mkdir certificates fs setacl certificates -clear $USER all }}} == Obtaining a Certificate == === Getting a certificate from a trusted CA === There are several options available. By far the largest providers are [[http://www.verisign.com/|VeriSign]] and [[http://www.thawte.com/|Thawte]]. Several members seem to like [[http://gandi.net|Gandi]]. You can also get a basic zero-cost certificate from [[http://startssl.com|StartSSL]]. 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. === Option 2: Having HCoop provide you with a certificate === |
== Generating a Key and Certificate Signing Request == |
| Line 39: | Line 31: |
| 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 "{{{~/certs}}}", for example. | 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 42: | 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 50: | 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 55: | Line 51: |
| === Making a self-signed certificate === | == Signing the Key == |
| Line 57: | Line 53: |
| 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. | === Using a Trusted CA === |
| Line 59: | Line 55: |
| '''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. | 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. [[https://letsencrypt.org/|Letencrypt]] offers free SSL certificates (but must be renewed every 90 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. |
| Line 62: | Line 64: |
| /afs/hcoop.net/common/bin/make-secure-directory ~/certificates cd ~/certificates |
|
| Line 74: | Line 78: |
| For the latter option, provide both paths in the same form, separated by a space. |
|
| Line 77: | Line 83: |
| CategoryNeedsWork CategoryMemberManual | 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 90 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 and private key 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.