E.2. Squid Proxy
E.2.1. Installing and Configuring a Squid Proxy
This section explains how to install and configure a Squid proxy to the VM Portal. A Squid proxy server is used as a content accelerator. It caches frequently-viewed content, reducing bandwidth and improving response times.
Configuring a Squid Proxy
Obtain a keypair and certificate for the HTTPS port of the Squid proxy server. You can obtain this keypair the same way that you would obtain a keypair for another SSL/TLS service. The keypair is in the form of two PEM files which contain the private key and the signed certificate. For this procedure, we assume that they are named proxy.key and proxy.cer.
NoteThe keypair and certificate can also be generated using the certificate authority of the engine. If you already have the private key and certificate for the proxy and do not want to generate it with the engine certificate authority, skip to the next step.
Choose a host name for the proxy. Then, choose the other components of the distinguished name of the certificate for the proxy.
NoteIt is good practice to use the same country and same organization name used by the engine itself. Find this information by logging in to the machine where the Manager is installed and running the following command:
openssl x509 -in /etc/pki/ovirt-engine/ca.pem -noout -subject
# openssl x509 -in /etc/pki/ovirt-engine/ca.pem -noout -subject
Copy to Clipboard Copied! This command outputs something like this:
subject= /C=US/O=Example Inc./CN=engine.example.com.81108
subject= /C=US/O=Example Inc./CN=engine.example.com.81108
Copy to Clipboard Copied! The relevant part here is /C=US/O=Example Inc.. Use this to build the complete distinguished name for the certificate for the proxy:
/C=US/O=Example Inc./CN=proxy.example.com
/C=US/O=Example Inc./CN=proxy.example.com
Copy to Clipboard Copied! Log in to the proxy machine and generate a certificate signing request:
openssl req -newkey rsa:2048 -subj '/C=US/O=Example Inc./CN=proxy.example.com' -nodes -keyout proxy.key -out proxy.req
# openssl req -newkey rsa:2048 -subj '/C=US/O=Example Inc./CN=proxy.example.com' -nodes -keyout proxy.key -out proxy.req
Copy to Clipboard Copied! ImportantYou must include the quotes around the distinguished name for the certificate. The
-nodes
option ensures that the private key is not encrypted; this means that you do not need to enter the password to start the proxy server.The command generates two files: proxy.key and proxy.req. proxy.key is the private key. Keep this file safe. proxy.req is the certificate signing request. proxy.req does not require any special protection.
To generate the signed certificate, copy the certificate signing request file from the proxy machine to the Manager machine:
scp proxy.req engine.example.com:/etc/pki/ovirt-engine/requests/.
# scp proxy.req engine.example.com:/etc/pki/ovirt-engine/requests/.
Copy to Clipboard Copied! Log in to the Manager machine and sign the certificate:
/usr/share/ovirt-engine/bin/pki-enroll-request.sh --name=proxy --days=3650 --subject='/C=US/O=Example Inc./CN=proxy.example.com'
# /usr/share/ovirt-engine/bin/pki-enroll-request.sh --name=proxy --days=3650 --subject='/C=US/O=Example Inc./CN=proxy.example.com'
Copy to Clipboard Copied! This signs the certificate and makes it valid for 10 years (3650 days). Set the certificate to expire earlier, if you prefer.
The generated certificate file is available in the directory /etc/pki/ovirt-engine/certs and should be named proxy.cer. On the proxy machine, copy this file from the Manager machine to your current directory:
scp engine.example.com:/etc/pki/ovirt-engine/certs/proxy.cer .
# scp engine.example.com:/etc/pki/ovirt-engine/certs/proxy.cer .
Copy to Clipboard Copied! Ensure both proxy.key and proxy.cer are present on the proxy machine:
ls -l proxy.key proxy.cer
# ls -l proxy.key proxy.cer
Copy to Clipboard Copied! Install the Squid proxy server package on the proxy machine:
yum install squid
# yum install squid
Copy to Clipboard Copied! Move the private key and signed certificate to a place where the proxy can access them, for example to the /etc/squid directory:
cp proxy.key proxy.cer /etc/squid/.
# cp proxy.key proxy.cer /etc/squid/.
Copy to Clipboard Copied! Set permissions so that the
squid
user can read these files:chgrp squid /etc/squid/proxy.* chmod 640 /etc/squid/proxy.*
# chgrp squid /etc/squid/proxy.* # chmod 640 /etc/squid/proxy.*
Copy to Clipboard Copied! The Squid proxy must verify the certificate used by the engine. Copy the Manager certificate to the proxy machine. This example uses the file path /etc/squid:
scp engine.example.com:/etc/pki/ovirt-engine/ca.pem /etc/squid/.
# scp engine.example.com:/etc/pki/ovirt-engine/ca.pem /etc/squid/.
Copy to Clipboard Copied! NoteThe default CA certificate is located in /etc/pki/ovirt-engine/ca.pem on the Manager machine.
Set permissions so that the
squid
user can read the certificate file:chgrp squid /etc/squid/ca.pem chmod 640 /etc/squid/ca.pem
# chgrp squid /etc/squid/ca.pem # chmod 640 /etc/squid/ca.pem
Copy to Clipboard Copied! If SELinux is in enforcing mode, change the context of port 443 using the
semanage
tool to permit Squid to use port 443:yum install policycoreutils-python semanage port -m -p tcp -t http_cache_port_t 443
# yum install policycoreutils-python # semanage port -m -p tcp -t http_cache_port_t 443
Copy to Clipboard Copied! Replace the existing Squid configuration file with the following:
https_port 443 key=/etc/squid/proxy.key cert=/etc/squid/proxy.cer ssl-bump defaultsite=engine.example.com cache_peer engine.example.com parent 443 0 no-query originserver ssl sslcafile=/etc/squid/ca.pem name=engine login=PASSTHRU cache_peer_access engine allow all ssl_bump allow all http_access allow all
https_port 443 key=/etc/squid/proxy.key cert=/etc/squid/proxy.cer ssl-bump defaultsite=engine.example.com cache_peer engine.example.com parent 443 0 no-query originserver ssl sslcafile=/etc/squid/ca.pem name=engine login=PASSTHRU cache_peer_access engine allow all ssl_bump allow all http_access allow all
Copy to Clipboard Copied! Restart the Squid proxy server:
systemctl restart squid.service
# systemctl restart squid.service
Copy to Clipboard Copied!
Squid Proxy in the default configuration will terminate its connection after 15 idle minutes. To increase the amount of time before Squid Proxy terminates its idle connection, adjust the read_timeout
option in squid.conf (for instance read_timeout 10 hours).