Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Familiarity with your own systems systems.
  • Sufficient access rights to install and configure software.
  • No fear of the command line (although a healthy respect is always good).

Method

 There are a couple of differences between Debian and Red Hat derived systems which are highlighted below. Other distros will be similar.

...

  1. Install Squid. Most repositories include it, but you can also get binaries from https://wiki.squid-cache.org/SquidFaq/BinaryPackages

  2. Navigate to your install directory (/etc/squid)

  3. Create a password 

    1. > htpasswd -c squid_passwd

    2. Note Make a note of the username and password for later - you will need to tell OpenAthens what they are

  4. Edit squid.conf taking care to use the correct auth_param line for your distro.

    Code Block
    languagebash
    # Prevent X-Forwarded-For being overwritten by Squid
    forwarded_for transparent
     
    # Setup ACLs for OpenAthens
    auth_param basic program /usr/lib64/squid/basic_ncsa_auth /etc/squid/squid_passwd # RHEL / CentOS based distros
    # auth_param basic program /usr/lib/squid/basic_ncsa_auth /etc/squid/squid_passwd # Debian / Ubuntu based distros
    auth_param basic realm proxy
    acl authenticated proxy_auth REQUIRED
     
    # Allow authenticated access
    http_access allow authenticated
     
    # Deny all other access to this proxy
    http_access deny all
  5. Start Squid and set it to autostart according to your OS

  6. ipaddress<squids_ip_address>:3128 should now show an error page generated by Squid

...

You want to make sure that the inbound connection is limited to OpenAthens and this is secured using an X.509 client certificate. The process is a little different depending on which flavour of Linux you are using. whether you are using a Debian based distro such as Ubuntu because . 

Table of Contents
minLevel4

...

    • xxx.xxx.xxx.xxx is the external IP address of your Squid instance. Remove ALL any and all http_port directives, leaving only the https_port directive
    • server.pem is your server's certificate. This needs to be from a valid certification authority or Let's Encrypt. We'll need a copy alongside the username and password you set up earlier. Our service desk will be able to advise on secure ways to transfer the information to us. 
    • openathens-client.pem is the public key of the OpenAthens service and will ensure access is restricted. You can download it from https://proxy.openathens.net/tls/openathens-client.pem
    • (Put both certificates in the /etc/squid/ssl_cert folder)

...

    • allow TCP inbound to port 3128 on this server from any source IP address (the connection from us can come from multiple IPs)
    • allow outbound traffic on standard HTTP ports (80 and 443)

9. Securely pass our service desk the username and password you set up in step 3 and a copy of your server.pem certificate. 

Debian based such as Ubuntu

At the time of writing the Squid package supplied by Debian is not compiled with the -enable-ssl flag which means the https_port configuration directive is not available and a little more work is required. Since you can't use a simple configuration directive you need to front Squid with something such as stunnel (https://www.stunnel.org/).  

7.  >apt-get install stunnel4

8. Create /etc/stunnel/stunnel.conf:

Code Block
pid=/var/run/stunnel4/pid
setuid = stunnel4
setgid = nogroup
 
[squid-tls]
accept  = xxx.xxx.xxx.xxx:3128
#Don't need to expose squid directly to the internet.
connect = 127.0.0.1:3129
cert = /etc/stunnel/server.pem
CAfile=/etc/stunnel/openathens-client.pem
verify = 4

...

Code Block
http_port 127.0.0.1:3129

10. Set your firewall rules to

    • allow TCP inbound to port 3128 on this server from any source IP address (the connection from us can come from multiple IPs)
    • allow outbound traffic on standard HTTP ports (80 and 443)

11. Securely pass our service desk the username and password you set up in step 3 and a copy of your server.pem certificate. 


...


It is possible to set up squid in a multi-tennant mode - e.g. if different parts of your organisation or consortium have different scopes and need to present a different IP address depending on where in your organisation the user sits. Instructions for this are available from our service desk.

...