HTTPS-only and HSTS

From EPrints Documentation
Revision as of 01:14, 21 February 2018 by (Talk | contribs)

Jump to: navigation, search
Manual Sections

HTTPS with EPrints

See the pages in Category Authentication for how to setup up HTTPS on EPrints, for example:

The following is a description of how to configure EPrints so that all content, not just login pages, is served over HTTPS.

Google Best Practices for HTTPS

The following are the best practices specified by Google

  • HSTS Headers on HTTPS
  • No “Mixed Content” warnings/errors
  • Links point to HTTPS locations
  • 301 Redirects from HTTP to HTTPS


To summarize how HSTS works, if a browser (Chrome, Firefix, IE) sees the HSTS header in the HTTPS response, and there are no certificate errors or mixed content warnings or anything (if it is green), then the next time a user of that browser requests the HTTP page of that site, the browser will modify the request from an HTTP to a HTTPS request. The browser will remember that setting for as long as you specify max-age to be. This means that even with HSTS, it is still possible to request and receive content over HTTP. To close that down, a server redirect is necessary, so those browsers that haven’t seen the HSTS header in the past that happen to try to go to HTTP will get that initial redirect to HTTPS.

Implementing HTTPS-only with HSTS on an EPrints repository

Changes to /cfg.d/

Initialize the following variables to be the https URL (i.e., https://YOUR-REPOSITORY-DOMAIN)

 $c->{host} = "YOUR-REPOSITORY-DOMAIN"; 
 $c->{http_url} = 'https://YOUR-REPOSITORY-DOMAIN';
 $c->{http_cgiurl} = 'https://YOUR-REPOSITORY-DOMAIN/cgi';
 $c->{base_url} = "https://$c->{host}";

Changes to /cfg/lang/LANGID/templates/default.xml, and /cfg/lang/LANGID/static/*.XPAGE files

Remove any hard coded links to HTTP
If you have Google Search included as an XPAGE file,
call on the Google API (and any other APIs) using HTTPS.

Changes to Apache config files

Add the HSTS header

Add a new include apache-ssl CONF file to the folder /REPOID/cfg/ that has the HSTS header. The max-age variable is a time in seconds for how long the HSTS settings should be remembered by the browser. 15780000 is six months, which is a long time, you may want to set it to a shorter time while testing.

Header set Strict-Transport-Security "max-age=15780000"

Include this file from the core apache conf file for the secure port (443) in /etc/

A new file is required because generate_apacheconf overwrites any of the conf files that were already being included.

Add 301 redirects to secure port from HTTP (port 80)

By following the instructions above, if you use this patch or are running the latest revision of EPrints on GitHub, /bin/generate_apacheconf will generate an /cfg/apache/REPOID.conf, which automatically redirects HTTP to HTTPS. Otherwise, this can be achieved by modifying /cfg/apache/REPOID.conf to the following, substituting your domain as appropriate:

<VirtualHost *:80>
RedirectPermanent / https://YOUR-REPOSITORY-DOMAIN/