Skip to content

Latest commit

 

History

History
215 lines (155 loc) · 8.41 KB

local_https_setup.md

File metadata and controls

215 lines (155 loc) · 8.41 KB
Raw

Configure environment to run MMT over HTTPS locally, to be able to authenticate with Launchpad

Nginx

MMT Servers use Nginx, so this is the preferred method

When running MMT with Launchpad Authentication, MMT should be configured to run at https://mmt.localtest.earthdata.nasa.gov. The url will need to be configured to redirect to localhost:3000:

  1. Modify /etc/hosts Append 'mmt.localtest.earthdata.nasa.gov' to the 127.0.0.1 localhost line

    127.0.0.1 localhost mmt.localtest.earthdata.nasa.gov

  2. Install Nginx

    brew install nginx

  3. Generate the self-signed certificate (see references below) a. Create the Certificate Configuration File From inside a new certificates directory you create:

    sudo nano mmt.localtest.earthdata.nasa.gov.conf

    Paste the following into the configuration file:

    [ req ]
default_bits        = 2048
default_keyfile     = server-key.pem
distinguished_name  = subject
req_extensions      = req_ext
x509_extensions     = x509_ext
string_mask         = utf8only

[ subject ]
countryName                 = Country Name (2 letter code)
countryName_default         = US
stateOrProvinceName         = State or Province Name (full name)
stateOrProvinceName_default = DC
localityName                = Locality Name (eg, city)
localityName_default        = Washington
organizationName            = Organization Name (eg, company)
organizationName_default    = NASA
commonName                  = Common Name (e.g. server FQDN or YOUR name)
commonName_default          = MMT
emailAddress                = Email Address
emailAddress_default        = test@example.com

[ x509_ext ]
subjectKeyIdentifier   = hash
authorityKeyIdentifier = keyid,issuer
basicConstraints       = CA:FALSE
keyUsage               = digitalSignature, keyEncipherment
subjectAltName         = @alternate_names
nsComment              = "OpenSSL Generated Certificate"

[ req_ext ]
subjectKeyIdentifier = hash
basicConstraints     = CA:FALSE
keyUsage             = digitalSignature, keyEncipherment
subjectAltName       = @alternate_names
nsComment            = "OpenSSL Generated Certificate"

[ alternate_names ]
DNS.1   = mmt.localtest.earthdata.nasa.gov
DNS.2   = localhost:3000

b. Create the self signed Certificate

`openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout mmt.localtest.earthdata.nasa.gov.key -out mmt.localtest.earthdata.nasa.gov.crt`

when prompted with questions for the certificate, leave them blank so information from the configuration file will be used by default

c. Copy the Certificate Key Pair to the nginx folder

    sudo cp mmt.localtest.earthdata.nasa.gov.crt /usr/local/etc/nginx/mmt.localtest.earthdata.nasa.gov.crt
    sudo cp mmt.localtest.earthdata.nasa.gov.key /usr/local/etc/nginx/mmt.localtest.earthdata.nasa.gov.key

  1. Add the certificate to Mac OSX Keychain a. Open the certificate in Keychain Access

    open /usr/local/etc/nginx/mmt.localtest.earthdata.nasa.gov.crt

b. Ensure the certificate is added to the System keychain

c. Ensure the certificate is trusted:
Double click on the certificate
Open the Trust section
For the dropdown next to 'When using this certificate' choose 'Always Trust'
You may need to enter your password to make these changes
  1. Update the Nginx Configuration File to load the certificate key pair and handle the url redirect, and also replicate the buffer size config in our deployment environments Add the following to the nginx.conf file (/usr/local/etc/nginx/nginx.conf):
```
proxy_connect_timeout       600;
proxy_send_timeout          600;
proxy_read_timeout          600;
send_timeout                600;


ssl_certificate /usr/local/etc/nginx/mmt.localtest.earthdata.nasa.gov.crt;
ssl_certificate_key /usr/local/etc/nginx/mmt.localtest.earthdata.nasa.gov.key;

server {
  # increase limit for UVG requests and to match deployed environments
		client_max_body_size 20M;

  listen 443 ssl;
  server_name mmt.localtest.earthdata.nasa.gov;
  ssl on;
  ssl_session_cache shared:SSL:1m;
  ssl_session_timeout 5m;
  ssl_ciphers HIGH:!aNULL:!MD5;
  ssl_prefer_server_ciphers on;
  location / {
    root html;
    index index.html index.htm;

    proxy_pass http://mmt.localtest.earthdata.nasa.gov:3000;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

    proxy_buffers			  32 4k;	# Buffer pool
			proxy_buffer_size	  8k;		  # buffers from pool used for headers
  }
}
```

  1. Start nginx:

    sudo nginx

if nginx is already running you can stop it first with `sudo nginx -s stop`

  1. Run the rails server on the appropriate port:

    rails s

And if you need to stop the server from running, hit Ctrl + C and the server will shutdown.

You should be able to visit MMT at http://localhost:3000 which will redirect you to Launchpad for authentication and back to the https url you added

Apache

Setting up under Apache is much the same as under Nginx. The examples below use the paths as found under a standard Mac system. The primary reason to use Apache is that it already comes with the Mac, less to install. Changes as needed. First create HTTPS certs as described in the Nginx section or in any way you can. Put these files in /private/etc/apache2/ssl/ as shown in the httpd-ssl.conf setting below.

Files

The following files will need to be changed: /etc/hosts, /etc/apache2/httpd.conf, /etc/apache2/extra/httpd-ssl.conf, /etc/apache2/extra/httpd-vhosts.conf

/etc/hosts

Add an alias of localhost to the host file. This will enable you to enter the URL in the browser.

127.0.0.1       localhost       mmt.localtest.earthdata.nasa.gov

Note, on some operating systems, you should make this change while not on a VPN. This file is sometimes swapped out meaning your changes will be lost.

/etc/apache2/httpd.conf

Enable HTTPS and mod_proxy for forwarding to rails. The config file should contain the following lines:

...
LoadModule proxy_module libexec/apache2/mod_proxy.so
LoadModule proxy_http_module libexec/apache2/mod_proxy_http.s
LoadModule ssl_module libexec/apache2/mod_ssl.so
ServerName mmt.localtest.earthdata.nasa.gov
Include /private/etc/apache2/extra/httpd-vhosts.conf
Include /private/etc/apache2/extra/httpd-ssl.conf
...
/etc/apache2/extra/httpd-ssl.conf

Configure HTTPS by making sure the file has the following settings in the default Virtual Host block. This setting defines the default mappings, and may be the only one you need if your not hosting multiple sites on the same development server.

<VirtualHost _default_:443>
	...
	ServerName mmt.localtest.earthdata.nasa.gov:443
	SSLEngine on
	SSLCertificateFile "/private/etc/apache2/ssl/mmt.localtest.earthdata.nasa.gov.crt"
	SSLCertificateKeyFile "/private/etc/apache2/ssl/mmt.localtest.earthdata.nasa.gov.key"
	ProxyPass / http://127.0.0.1:3000
	...
</VirtualHost>
/etc/apache2/extra/httpd-vhosts.conf

Add an entry to the vhost file for the site and use ProxyPass to send the request to rails.

<VirtualHost *:443>
	ServerName mmt.localtest.earthdata.nasa.gov

	SSLEngine on
	SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
	SSLCertificateFile /etc/apache2/ssl/mmt.localtest.earthdata.nasa.gov.crt
	SSLCertificateKeyFile /etc/apache2/ssl/mmt.localtest.earthdata.nasa.gov.key

	RequestHeader set X-Forwarded-Proto https
	ProxyPreserveHost On
	ProxyPass / http://127.0.0.1:3000/
	ProxyPassReverse / http://mmt.localtest.earthdata.nasa.gov/
	ProxyPassReverseCookiePath / /

</VirtualHost>
References for these instructions